@aws-cdk_aws-cognito-identitypool-alpha.UserPoolAuthenticationProviderProps

interface UserPoolAuthenticationProviderProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Cognito.IdentityPool.Alpha.UserPoolAuthenticationProviderProps
Gogithub.com/aws/aws-cdk-go/awscdkcognitoidentitypoolalpha/v2#UserPoolAuthenticationProviderProps
Javasoftware.amazon.awscdk.services.cognito.identitypool.alpha.UserPoolAuthenticationProviderProps
Pythonaws_cdk.aws_cognito_identitypool_alpha.UserPoolAuthenticationProviderProps
TypeScript (source)@aws-cdk/aws-cognito-identitypool-alpha ยป UserPoolAuthenticationProviderProps

Props for the User Pool Authentication Provider.

Example

declare const identityPool: IdentityPool;
const userPool = new cognito.UserPool(this, 'Pool');
identityPool.addUserPoolAuthentication(new UserPoolAuthenticationProvider({
  userPool,
  disableServerSideTokenCheck: true,
}));

Properties

NameTypeDescription
userPool๐Ÿ”นIUserPoolThe User Pool of the Associated Identity Providers.
disableServerSideTokenCheck?๐Ÿ”นbooleanSetting this to true turns off identity pool checks for this user pool 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.
userPoolClient?๐Ÿ”นIUserPoolClientThe User Pool Client for the provided User Pool.

userPool๐Ÿ”น

Type: IUserPool

The User Pool of the Associated Identity Providers.


disableServerSideTokenCheck?๐Ÿ”น

Type: boolean (optional, default: false)

Setting this to true turns off identity pool checks for this user pool 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.

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitoidentityprovider.html


userPoolClient?๐Ÿ”น

Type: IUserPoolClient (optional, default: A default user pool client will be added to User Pool)

The User Pool Client for the provided User Pool.