CfnUserPoolClientProps¶

class aws_cdk.aws_cognito.CfnUserPoolClientProps(*, user_pool_id, access_token_validity=None, 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, id_token_validity=None, logout_ur_ls=None, prevent_user_existence_errors=None, read_attributes=None, refresh_token_validity=None, supported_identity_providers=None, token_validity_units=None, write_attributes=None)¶

Bases: object

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

Parameters

user_pool_id (str) – AWS::Cognito::UserPoolClient.UserPoolId.
access_token_validity (Union[int, float, None]) – AWS::Cognito::UserPoolClient.AccessTokenValidity.
allowed_o_auth_flows (Optional[List[str]]) – AWS::Cognito::UserPoolClient.AllowedOAuthFlows.
allowed_o_auth_flows_user_pool_client (Union[bool, IResolvable, None]) – AWS::Cognito::UserPoolClient.AllowedOAuthFlowsUserPoolClient.
allowed_o_auth_scopes (Optional[List[str]]) – AWS::Cognito::UserPoolClient.AllowedOAuthScopes.
analytics_configuration (Union[IResolvable, AnalyticsConfigurationProperty, None]) – 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, IResolvable, None]) – AWS::Cognito::UserPoolClient.GenerateSecret.
id_token_validity (Union[int, float, None]) – AWS::Cognito::UserPoolClient.IdTokenValidity.
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.
token_validity_units (Union[IResolvable, TokenValidityUnitsProperty, None]) – AWS::Cognito::UserPoolClient.TokenValidityUnits.
write_attributes (Optional[List[str]]) – AWS::Cognito::UserPoolClient.WriteAttributes.

Link

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

Attributes

access_token_validity¶

AWS::Cognito::UserPoolClient.AccessTokenValidity.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-accesstokenvalidity
Return type: Union[int, float, None]

allowed_o_auth_flows¶

AWS::Cognito::UserPoolClient.AllowedOAuthFlows.

Link: 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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-allowedoauthflowsuserpoolclient
Return type: Union[bool, IResolvable, None]

allowed_o_auth_scopes¶

AWS::Cognito::UserPoolClient.AllowedOAuthScopes.

Link: 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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-analyticsconfiguration
Return type: Union[IResolvable, AnalyticsConfigurationProperty, None]

callback_ur_ls¶

AWS::Cognito::UserPoolClient.CallbackURLs.

Link: 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.

Link: 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.

Link: 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.

Link: 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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-generatesecret
Return type: Union[bool, IResolvable, None]

id_token_validity¶

AWS::Cognito::UserPoolClient.IdTokenValidity.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-idtokenvalidity
Return type: Union[int, float, None]

logout_ur_ls¶

AWS::Cognito::UserPoolClient.LogoutURLs.

Link: 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.

Link: 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.

Link: 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.

Link: 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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-supportedidentityproviders
Return type: Optional[List[str]]

token_validity_units¶

AWS::Cognito::UserPoolClient.TokenValidityUnits.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-tokenvalidityunits
Return type: Union[IResolvable, TokenValidityUnitsProperty, None]

user_pool_id¶

AWS::Cognito::UserPoolClient.UserPoolId.

Link: 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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-writeattributes
Return type: Optional[List[str]]