Menu
AWS CloudFormation
User Guide (API Version 2010-05-15)

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" : Integer, "UserPoolId" : String, "WriteAttributes" : [ String, ... ] } }

YAML

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

Properties

ClientName

The client name for the user pool client that you want to create.

Required: No

Type: String

Update requires: No interruption

MinLength: 1

MaxLength: 128

ExplicitAuthFlows

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

Required: No

Type: List of Strings

Update requires: No interruption

GenerateSecret

Specifies 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 Strings

Update requires: No interruption

RefreshTokenValidity

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

Required: No

Type: Integer

Update requires: No interruption

UserPoolId

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

Required: Yes

Type: String

Update requires: Replacement

WriteAttributes

The write attributes.

Required: No

Type: List of Strings

Update requires: No interruption

Return Value

Ref

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

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

Fn::GetAtt

Fn::GetAtt returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

ClientSecret

The client secret, as a String.

Name

The name of the user pool client, as a String.

For more information about using Fn::GetAtt, see Fn::GetAtt.