UserPoolClient

class aws_cdk.aws_cognito.UserPoolClient(scope, id, *, user_pool, 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: aws_cdk.core.Resource

Define a UserPool App Client.

stability :stability: experimental

__init__(scope, id, *, user_pool, 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)
Parameters

  • scope (Construct) –

  • id (str) –

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

  • 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

Methods

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

node

The construct tree node associated with this construct.

Return type

ConstructNode

o_auth_flows

The OAuth flows enabled for this client.

stability :stability: experimental

Return type

OAuthFlows

stack

The stack in which this resource is defined.

Return type

Stack

user_pool_client_id

Name of the application client.

stability :stability: experimental

Return type

str

user_pool_client_name

The client name that was specified via the userPoolClientName property during initialization, throws an error otherwise.

stability :stability: experimental

Return type

str

Static Methods

classmethod from_user_pool_client_id(scope, id, user_pool_client_id)

Import a user pool client given its id.

Parameters

  • scope (Construct) –

  • id (str) –

  • user_pool_client_id (str) –

stability :stability: experimental

Return type

IUserPoolClient

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool