AWS::Cognito::UserPoolClient - AWS CloudFormation

AWS::Cognito::UserPoolClient

The AWS::Cognito::UserPoolClient resource specifies an Amazon Cognito user pool client.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::Cognito::UserPoolClient", "Properties" : { "AllowedOAuthFlows" : [ String, ... ], "AllowedOAuthFlowsUserPoolClient" : Boolean, "AllowedOAuthScopes" : [ String, ... ], "AnalyticsConfiguration" : AnalyticsConfiguration, "CallbackURLs" : [ String, ... ], "ClientName" : String, "DefaultRedirectURI" : String, "ExplicitAuthFlows" : [ String, ... ], "GenerateSecret" : Boolean, "LogoutURLs" : [ String, ... ], "PreventUserExistenceErrors" : String, "ReadAttributes" : [ String, ... ], "RefreshTokenValidity" : Integer, "SupportedIdentityProviders" : [ String, ... ], "UserPoolId" : String, "WriteAttributes" : [ String, ... ] } }

YAML

Type: AWS::Cognito::UserPoolClient Properties: AllowedOAuthFlows: - String AllowedOAuthFlowsUserPoolClient: Boolean AllowedOAuthScopes: - String AnalyticsConfiguration: AnalyticsConfiguration CallbackURLs: - String ClientName: String DefaultRedirectURI: String ExplicitAuthFlows: - String GenerateSecret: Boolean LogoutURLs: - String PreventUserExistenceErrors: String ReadAttributes: - String RefreshTokenValidity: Integer SupportedIdentityProviders: - String UserPoolId: String WriteAttributes: - String

Properties

AllowedOAuthFlows

The allowed OAuth flows.

Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.

Set to implicit to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.

Set to client_credentials to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret.

Required: No

Type: List of String

Maximum: 3

Update requires: No interruption

AllowedOAuthFlowsUserPoolClient

Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.

Required: No

Type: Boolean

Update requires: No interruption

AllowedOAuthScopes

The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, openid, and profile. Possible values provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.

Required: No

Type: List of String

Maximum: 50

Update requires: No interruption

AnalyticsConfiguration

The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.

Note

Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which the user pool resides.

Required: No

Type: AnalyticsConfiguration

Update requires: No interruption

CallbackURLs

A list of allowed redirect (callback) URLs for the identity providers.

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

Required: No

Type: List of String

Maximum: 100

Update requires: No interruption

ClientName

The client name for the user pool client you would like to create.

Required: No

Type: String

Minimum: 1

Maximum: 128

Pattern: [\w\s+=,.@-]+

Update requires: No interruption

DefaultRedirectURI

The default redirect URI. Must be in the CallbackURLs list.

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

Required: No

Type: String

Minimum: 1

Maximum: 1024

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Update requires: No interruption

ExplicitAuthFlows

The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.

Valid values include:

  • ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.

  • ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.

  • ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Cognito receives the password in the request instead of using the SRP protocol to verify passwords.

  • ALLOW_USER_SRP_AUTH: Enable SRP based authentication.

  • ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.

Required: No

Type: List of String

Update requires: No interruption

GenerateSecret

Boolean to specify whether you want to generate a secret for the user pool client being created.

Required: No

Type: Boolean

Update requires: Replacement

LogoutURLs

A list of allowed logout URLs for the identity providers.

Required: No

Type: List of String

Maximum: 100

Update requires: No interruption

PreventUserExistenceErrors

Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to ENABLED and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs will return a UserNotFoundException exception if the user does not exist in the user pool.

Required: No

Type: String

Allowed Values: ENABLED | LEGACY

Update requires: No interruption

ReadAttributes

The read attributes.

Required: No

Type: List of String

Update requires: No interruption

RefreshTokenValidity

The time limit, in days, after which the refresh token is no longer valid and cannot be used.

Required: No

Type: Integer

Minimum: 0

Maximum: 3650

Update requires: No interruption

SupportedIdentityProviders

A list of provider names for the identity providers that are supported on this client. The following are supported: COGNITO, Facebook, Google and LoginWithAmazon.

Required: No

Type: List of String

Update requires: No interruption

UserPoolId

The user pool ID for the user pool where you want to create a user pool client.

Required: Yes

Type: String

Minimum: 1

Maximum: 55

Pattern: [\w-]+_[0-9a-zA-Z]+

Update requires: Replacement

WriteAttributes

The user pool attributes that the app client can write to.

If your app client allows users to sign in through an identity provider, this array must include all attributes that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If your app client lacks write access to a mapped attribute, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.

Required: No

Type: List of String

Update requires: No interruption

Return Values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Amazon Cognito user pool client ID, such as 1h57kf5cpq17m0eml12EXAMPLE.

For more information about using the Ref function, see Ref.