UserPoolAuthenticationProviderProps

class aws_cdk.aws_cognito_identitypool_alpha.UserPoolAuthenticationProviderProps(*, user_pool, disable_server_side_token_check=None, user_pool_client=None)

Bases: object

(experimental) Props for the User Pool Authentication Provider.

Parameters:

  • user_pool (IUserPool) – (experimental) The User Pool of the Associated Identity Providers.

  • disable_server_side_token_check (Optional[bool]) – (experimental) 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. Default: false

  • user_pool_client (Optional[IUserPoolClient]) – (experimental) The User Pool Client for the provided User Pool. Default: - A default user pool client will be added to User Pool

Stability:

experimental

ExampleMetadata:

infused

Example:

# identity_pool: IdentityPool

user_pool = cognito.UserPool(self, "Pool")
identity_pool.add_user_pool_authentication(UserPoolAuthenticationProvider(
    user_pool=user_pool,
    disable_server_side_token_check=True
))

Attributes

disable_server_side_token_check

(experimental) 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.

Default:

false

See:

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

Stability:

experimental

user_pool

(experimental) The User Pool of the Associated Identity Providers.

Stability:

experimental

user_pool_client

(experimental) The User Pool Client for the provided User Pool.

Default:

  • A default user pool client will be added to User Pool

Stability:

experimental