UserPoolClientProps

class aws_cdk.aws_cognito.UserPoolClientProps(*, auth_flows=None, disable_o_auth=None, generate_secret=None, o_auth=None, prevent_user_existence_errors=None, supported_identity_providers=None, user_pool_client_name=None, user_pool)

Bases: aws_cdk.aws_cognito.UserPoolClientOptions

(experimental) Properties for the UserPoolClient construct.

Parameters
  • auth_flows (Optional[AuthFlow]) – (experimental) The set of OAuth authentication flows to enable on the client. Default: - all auth flows disabled

  • disable_o_auth (Optional[bool]) – (experimental) Turns off all OAuth interactions for this client. Default: false

  • generate_secret (Optional[bool]) – (experimental) Whether to generate a client secret. Default: false

  • o_auth (Optional[OAuthSettings]) – (experimental) OAuth settings for this to client to interact with the app. An error is thrown when this is specified and disableOAuth is set. Default: - see defaults in OAuthSettings. meaningless if disableOAuth is set.

  • prevent_user_existence_errors (Optional[bool]) – (experimental) Whether Cognito returns a UserNotFoundException exception when the user does not exist in the user pool (false), or whether it returns another type of error that doesn’t reveal the user’s absence. Default: true for new stacks

  • supported_identity_providers (Optional[List[UserPoolClientIdentityProvider]]) – (experimental) The list of identity providers that users should be able to use to sign in using this client. Default: - supports all identity providers that are registered with the user pool. If the user pool and/or identity providers are imported, either specify this option explicitly or ensure that the identity providers are registered with the user pool using the UserPool.registerIdentityProvider() API.

  • user_pool_client_name (Optional[str]) – (experimental) Name of the application client. Default: - cloudformation generated name

  • user_pool (IUserPool) – (experimental) The UserPool resource this client will have access to.

Stability

experimental

Attributes

auth_flows

(experimental) The set of OAuth authentication flows to enable on the client.

Default
  • all auth flows disabled

See

https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow.html

Stability

experimental

Return type

Optional[AuthFlow]

disable_o_auth

(experimental) Turns off all OAuth interactions for this client.

Default

false

Stability

experimental

Return type

Optional[bool]

generate_secret

(experimental) Whether to generate a client secret.

Default

false

Stability

experimental

Return type

Optional[bool]

o_auth

(experimental) OAuth settings for this to client to interact with the app.

An error is thrown when this is specified and disableOAuth is set.

Default
  • see defaults in OAuthSettings. meaningless if disableOAuth is set.

Stability

experimental

Return type

Optional[OAuthSettings]

prevent_user_existence_errors

(experimental) Whether Cognito returns a UserNotFoundException exception when the user does not exist in the user pool (false), or whether it returns another type of error that doesn’t reveal the user’s absence.

Default

true for new stacks

See

https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-managing-errors.html

Stability

experimental

Return type

Optional[bool]

supported_identity_providers

(experimental) The list of identity providers that users should be able to use to sign in using this client.

Default

  • supports all identity providers that are registered with the user pool. If the user pool and/or

identity providers are imported, either specify this option explicitly or ensure that the identity providers are registered with the user pool using the UserPool.registerIdentityProvider() API.

Stability

experimental

Return type

Optional[List[UserPoolClientIdentityProvider]]

user_pool

(experimental) The UserPool resource this client will have access to.

Stability

experimental

Return type

IUserPool

user_pool_client_name

(experimental) Name of the application client.

Default
  • cloudformation generated name

Stability

experimental

Return type

Optional[str]