AWS CloudFormation
User Guide (Version )

AWS::Cognito::UserPoolClient

The AWS::Cognito::UserPoolClient resource creates 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" : { "ClientName" : String, "ExplicitAuthFlows" : [ String, ... ], "GenerateSecret" : Boolean, "ReadAttributes" : [ String, ... ], "RefreshTokenValidity" : Double, "UserPoolId" : String, "WriteAttributes" : [ String, ... ] } }

YAML

Type: AWS::Cognito::UserPoolClient Properties: ClientName: String ExplicitAuthFlows: - String GenerateSecret: Boolean ReadAttributes: - String RefreshTokenValidity: Double UserPoolId: String WriteAttributes: - String

Properties

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

ExplicitAuthFlows

The explicit authentication flows, which can be one of the following: ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or USER_PASSWORD_AUTH.

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

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: Double

Minimum: 0

Maximum: 3650

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.