aws-cdk-lib.aws_cognito.CfnIdentityPool.CognitoIdentityProviderProperty

CognitoIdentityProviderProperty Struct

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

Source

Generated code

Type last changed

v2.123.0 · 24 Jan 2024

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';
const cognitoIdentityProviderProperty: cognito.CfnIdentityPool.CognitoIdentityProviderProperty = {
  clientId: 'clientId',
  providerName: 'providerName',

  // the properties below are optional
  serverSideTokenCheck: false,
};

Properties

clientIdstringclient_idstrclientIdStringClientIdstringClientId*stringrequired#

The client ID for the Amazon Cognito user pool.

providerNamestringprovider_namestrproviderNameStringProviderNamestringProviderName*stringrequired#

The provider name for an Amazon Cognito user pool.

For example: cognito-idp.us-east-2.amazonaws.com/us-east-2_123456789 .

serverSideTokenCheck?optionalboolean | IResolvableserver_side_token_check?optionaltyping.Union[bool, IResolvable]serverSideTokenCheck?optionalBooleanServerSideTokenCheck?optionalboolServerSideTokenCheck?optionalinterface{}#

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

notes

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 AWS credentials for the user.

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