View a markdown version of this page

IssuerConfigurationType - Amazon Cognito User Pools

IssuerConfigurationType

Specifies the issuer configuration for a user pool. Contains settings that determine how tokens are issued and validated.

This data type is a request parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.

Contents

Type

The type of issuer configuration. Determines the token issuing behavior for the user pool.

ORIGINAL

The original issuer configuration for user pools. The issuer URL is hosted in the user pool’s region and provides OIDC endpoints specific to that region.

Original issuers have the format of https://cognito-idp.[region].amazonaws.com/[userPoolId]

UPDATED

Recommended for all user pools, including for multi-Region replication. Updated issuers host the same JWKS content in multiple regions, resulting in improved resilience and efficiency.

Updated issuers have the format of https://issuer-cognito-idp.[region].amazonaws.com/[userPoolId], where region is the primary AWS Region of your user pool.

Type: String

Valid Values: ORIGINAL | UPDATED

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: