UserPoolClientOptions

class aws_cdk.aws_cognito.UserPoolClientOptions(*, 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)

Bases: object

__init__(*, 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)

Options to create a UserPoolClient.

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

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

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

  • o_auth (Optional[OAuthSettings]) – 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]) – 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]]) – 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]) – Name of the application client. Default: - cloudformation generated name

stability :stability: experimental

Return type

None

Attributes

auth_flows

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

default :default: - all auth flows disabled

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

Return type

Optional[AuthFlow]

disable_o_auth

Turns off all OAuth interactions for this client.

default :default: false

stability :stability: experimental

Return type

Optional[bool]

generate_secret

Whether to generate a client secret.

default :default: false

stability :stability: experimental

Return type

Optional[bool]

o_auth

OAuth settings for this to client to interact with the app.

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

default :default: - see defaults in OAuthSettings. meaningless if disableOAuth is set.

stability :stability: experimental

Return type

Optional[OAuthSettings]

prevent_user_existence_errors

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 :default: true for new stacks

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

Return type

Optional[bool]

supported_identity_providers

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

default :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 :stability: experimental

Return type

Optional[List[UserPoolClientIdentityProvider]]

user_pool_client_name

Name of the application client.

default :default: - cloudformation generated name

stability :stability: experimental

Return type

Optional[str]