CfnUserPoolClientProps

class aws_cdk.aws_cognito.CfnUserPoolClientProps(*, user_pool_id, allowed_o_auth_flows=None, allowed_o_auth_flows_user_pool_client=None, allowed_o_auth_scopes=None, analytics_configuration=None, callback_ur_ls=None, client_name=None, default_redirect_uri=None, explicit_auth_flows=None, generate_secret=None, logout_ur_ls=None, prevent_user_existence_errors=None, read_attributes=None, refresh_token_validity=None, supported_identity_providers=None, write_attributes=None)

Bases: object

__init__(*, user_pool_id, allowed_o_auth_flows=None, allowed_o_auth_flows_user_pool_client=None, allowed_o_auth_scopes=None, analytics_configuration=None, callback_ur_ls=None, client_name=None, default_redirect_uri=None, explicit_auth_flows=None, generate_secret=None, logout_ur_ls=None, prevent_user_existence_errors=None, read_attributes=None, refresh_token_validity=None, supported_identity_providers=None, write_attributes=None)

Properties for defining a AWS::Cognito::UserPoolClient.

Parameters

  • user_pool_id (str) – AWS::Cognito::UserPoolClient.UserPoolId.

  • allowed_o_auth_flows (Optional[List[str]]) – AWS::Cognito::UserPoolClient.AllowedOAuthFlows.

  • allowed_o_auth_flows_user_pool_client (Union[bool, None, IResolvable]) – AWS::Cognito::UserPoolClient.AllowedOAuthFlowsUserPoolClient.

  • allowed_o_auth_scopes (Optional[List[str]]) – AWS::Cognito::UserPoolClient.AllowedOAuthScopes.

  • analytics_configuration (Union[IResolvable, None, AnalyticsConfigurationProperty]) – AWS::Cognito::UserPoolClient.AnalyticsConfiguration.

  • callback_ur_ls (Optional[List[str]]) – AWS::Cognito::UserPoolClient.CallbackURLs.

  • client_name (Optional[str]) – AWS::Cognito::UserPoolClient.ClientName.

  • default_redirect_uri (Optional[str]) – AWS::Cognito::UserPoolClient.DefaultRedirectURI.

  • explicit_auth_flows (Optional[List[str]]) – AWS::Cognito::UserPoolClient.ExplicitAuthFlows.

  • generate_secret (Union[bool, None, IResolvable]) – AWS::Cognito::UserPoolClient.GenerateSecret.

  • logout_ur_ls (Optional[List[str]]) – AWS::Cognito::UserPoolClient.LogoutURLs.

  • prevent_user_existence_errors (Optional[str]) – AWS::Cognito::UserPoolClient.PreventUserExistenceErrors.

  • read_attributes (Optional[List[str]]) – AWS::Cognito::UserPoolClient.ReadAttributes.

  • refresh_token_validity (Union[int, float, None]) – AWS::Cognito::UserPoolClient.RefreshTokenValidity.

  • supported_identity_providers (Optional[List[str]]) – AWS::Cognito::UserPoolClient.SupportedIdentityProviders.

  • write_attributes (Optional[List[str]]) – AWS::Cognito::UserPoolClient.WriteAttributes.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html

Attributes

allowed_o_auth_flows

AWS::Cognito::UserPoolClient.AllowedOAuthFlows.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-allowedoauthflows

Return type

Optional[List[str]]

allowed_o_auth_flows_user_pool_client

AWS::Cognito::UserPoolClient.AllowedOAuthFlowsUserPoolClient.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-allowedoauthflowsuserpoolclient

Return type

Union[bool, None, IResolvable]

allowed_o_auth_scopes

AWS::Cognito::UserPoolClient.AllowedOAuthScopes.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-allowedoauthscopes

Return type

Optional[List[str]]

analytics_configuration

AWS::Cognito::UserPoolClient.AnalyticsConfiguration.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-analyticsconfiguration

Return type

Union[IResolvable, None, AnalyticsConfigurationProperty]

callback_ur_ls

AWS::Cognito::UserPoolClient.CallbackURLs.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-callbackurls

Return type

Optional[List[str]]

client_name

AWS::Cognito::UserPoolClient.ClientName.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-clientname

Return type

Optional[str]

default_redirect_uri

AWS::Cognito::UserPoolClient.DefaultRedirectURI.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-defaultredirecturi

Return type

Optional[str]

explicit_auth_flows

AWS::Cognito::UserPoolClient.ExplicitAuthFlows.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-explicitauthflows

Return type

Optional[List[str]]

generate_secret

AWS::Cognito::UserPoolClient.GenerateSecret.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-generatesecret

Return type

Union[bool, None, IResolvable]

logout_ur_ls

AWS::Cognito::UserPoolClient.LogoutURLs.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-logouturls

Return type

Optional[List[str]]

prevent_user_existence_errors

AWS::Cognito::UserPoolClient.PreventUserExistenceErrors.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-preventuserexistenceerrors

Return type

Optional[str]

read_attributes

AWS::Cognito::UserPoolClient.ReadAttributes.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-readattributes

Return type

Optional[List[str]]

refresh_token_validity

AWS::Cognito::UserPoolClient.RefreshTokenValidity.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-refreshtokenvalidity

Return type

Union[int, float, None]

supported_identity_providers

AWS::Cognito::UserPoolClient.SupportedIdentityProviders.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-supportedidentityproviders

Return type

Optional[List[str]]

user_pool_id

AWS::Cognito::UserPoolClient.UserPoolId.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-userpoolid

Return type

str

write_attributes

AWS::Cognito::UserPoolClient.WriteAttributes.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-writeattributes

Return type

Optional[List[str]]