AWS::Cognito::IdentityPool CognitoIdentityProvider - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::Cognito::IdentityPool CognitoIdentityProvider

CognitoIdentityProvider is a property of the AWS::Cognito::IdentityPool resource that represents an Amazon Cognito user pool and its client ID.

Syntax

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

JSON

{
  "ClientId" : String,
  "ProviderName" : String,
  "ServerSideTokenCheck" : Boolean
}

YAML

  ClientId: String
  ProviderName: String
  ServerSideTokenCheck: Boolean

Properties

ClientId

The client ID for the Amazon Cognito user pool.

Required: Yes

Type: String

Update requires: No interruption

ProviderName

The provider name for an Amazon Cognito user pool. For example: cognito-idp.us-east-2.amazonaws.com/us-east-2_123456789.

Required: Yes

Type: String

Update requires: No interruption

ServerSideTokenCheck

TRUE if server-side token validation is enabled for the identity provider’s token.

After you set the ServerSideTokenCheck to TRUE for an identity pool, that identity pool checks with the integrated user pools to make sure the user has not been globally signed out or deleted before the identity pool provides an OIDC token or Amazon credentials for the user.

If the user is signed out or deleted, the identity pool returns a 400 Not Authorized error.

Required: No

Type: Boolean

Update requires: No interruption