CfnUserPoolProps

class aws_cdk.aws_cognito.CfnUserPoolProps(*, account_recovery_setting=None, admin_create_user_config=None, alias_attributes=None, auto_verified_attributes=None, device_configuration=None, email_configuration=None, email_verification_message=None, email_verification_subject=None, enabled_mfas=None, lambda_config=None, mfa_configuration=None, policies=None, schema=None, sms_authentication_message=None, sms_configuration=None, sms_verification_message=None, username_attributes=None, username_configuration=None, user_pool_add_ons=None, user_pool_name=None, user_pool_tags=None, verification_message_template=None)

Bases: object

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

Parameters
  • account_recovery_setting (Union[IResolvable, AccountRecoverySettingProperty, None]) – AWS::Cognito::UserPool.AccountRecoverySetting.

  • admin_create_user_config (Union[IResolvable, AdminCreateUserConfigProperty, None]) – AWS::Cognito::UserPool.AdminCreateUserConfig.

  • alias_attributes (Optional[List[str]]) – AWS::Cognito::UserPool.AliasAttributes.

  • auto_verified_attributes (Optional[List[str]]) – AWS::Cognito::UserPool.AutoVerifiedAttributes.

  • device_configuration (Union[IResolvable, DeviceConfigurationProperty, None]) – AWS::Cognito::UserPool.DeviceConfiguration.

  • email_configuration (Union[IResolvable, EmailConfigurationProperty, None]) – AWS::Cognito::UserPool.EmailConfiguration.

  • email_verification_message (Optional[str]) – AWS::Cognito::UserPool.EmailVerificationMessage.

  • email_verification_subject (Optional[str]) – AWS::Cognito::UserPool.EmailVerificationSubject.

  • enabled_mfas (Optional[List[str]]) – AWS::Cognito::UserPool.EnabledMfas.

  • lambda_config (Union[IResolvable, LambdaConfigProperty, None]) – AWS::Cognito::UserPool.LambdaConfig.

  • mfa_configuration (Optional[str]) – AWS::Cognito::UserPool.MfaConfiguration.

  • policies (Union[IResolvable, PoliciesProperty, None]) – AWS::Cognito::UserPool.Policies.

  • schema (Union[IResolvable, List[Union[IResolvable, SchemaAttributeProperty]], None]) – AWS::Cognito::UserPool.Schema.

  • sms_authentication_message (Optional[str]) – AWS::Cognito::UserPool.SmsAuthenticationMessage.

  • sms_configuration (Union[IResolvable, SmsConfigurationProperty, None]) – AWS::Cognito::UserPool.SmsConfiguration.

  • sms_verification_message (Optional[str]) – AWS::Cognito::UserPool.SmsVerificationMessage.

  • username_attributes (Optional[List[str]]) – AWS::Cognito::UserPool.UsernameAttributes.

  • username_configuration (Union[IResolvable, UsernameConfigurationProperty, None]) – AWS::Cognito::UserPool.UsernameConfiguration.

  • user_pool_add_ons (Union[IResolvable, UserPoolAddOnsProperty, None]) – AWS::Cognito::UserPool.UserPoolAddOns.

  • user_pool_name (Optional[str]) – AWS::Cognito::UserPool.UserPoolName.

  • user_pool_tags (Optional[Any]) – AWS::Cognito::UserPool.UserPoolTags.

  • verification_message_template (Union[IResolvable, VerificationMessageTemplateProperty, None]) – AWS::Cognito::UserPool.VerificationMessageTemplate.

See

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

Attributes

account_recovery_setting

AWS::Cognito::UserPool.AccountRecoverySetting.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-accountrecoverysetting

Return type

Union[IResolvable, AccountRecoverySettingProperty, None]

admin_create_user_config

AWS::Cognito::UserPool.AdminCreateUserConfig.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-admincreateuserconfig

Return type

Union[IResolvable, AdminCreateUserConfigProperty, None]

alias_attributes

AWS::Cognito::UserPool.AliasAttributes.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-aliasattributes

Return type

Optional[List[str]]

auto_verified_attributes

AWS::Cognito::UserPool.AutoVerifiedAttributes.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-autoverifiedattributes

Return type

Optional[List[str]]

device_configuration

AWS::Cognito::UserPool.DeviceConfiguration.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-deviceconfiguration

Return type

Union[IResolvable, DeviceConfigurationProperty, None]

email_configuration

AWS::Cognito::UserPool.EmailConfiguration.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailconfiguration

Return type

Union[IResolvable, EmailConfigurationProperty, None]

email_verification_message

AWS::Cognito::UserPool.EmailVerificationMessage.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailverificationmessage

Return type

Optional[str]

email_verification_subject

AWS::Cognito::UserPool.EmailVerificationSubject.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailverificationsubject

Return type

Optional[str]

enabled_mfas

AWS::Cognito::UserPool.EnabledMfas.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-enabledmfas

Return type

Optional[List[str]]

lambda_config

AWS::Cognito::UserPool.LambdaConfig.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-lambdaconfig

Return type

Union[IResolvable, LambdaConfigProperty, None]

mfa_configuration

AWS::Cognito::UserPool.MfaConfiguration.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-mfaconfiguration

Return type

Optional[str]

policies

AWS::Cognito::UserPool.Policies.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-policies

Return type

Union[IResolvable, PoliciesProperty, None]

schema

AWS::Cognito::UserPool.Schema.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-schema

Return type

Union[IResolvable, List[Union[IResolvable, SchemaAttributeProperty]], None]

sms_authentication_message

AWS::Cognito::UserPool.SmsAuthenticationMessage.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-smsauthenticationmessage

Return type

Optional[str]

sms_configuration

AWS::Cognito::UserPool.SmsConfiguration.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-smsconfiguration

Return type

Union[IResolvable, SmsConfigurationProperty, None]

sms_verification_message

AWS::Cognito::UserPool.SmsVerificationMessage.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-smsverificationmessage

Return type

Optional[str]

user_pool_add_ons

AWS::Cognito::UserPool.UserPoolAddOns.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userpooladdons

Return type

Union[IResolvable, UserPoolAddOnsProperty, None]

user_pool_name

AWS::Cognito::UserPool.UserPoolName.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userpoolname

Return type

Optional[str]

user_pool_tags

AWS::Cognito::UserPool.UserPoolTags.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userpooltags

Return type

Any

username_attributes

AWS::Cognito::UserPool.UsernameAttributes.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-usernameattributes

Return type

Optional[List[str]]

username_configuration

AWS::Cognito::UserPool.UsernameConfiguration.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-usernameconfiguration

Return type

Union[IResolvable, UsernameConfigurationProperty, None]

verification_message_template

AWS::Cognito::UserPool.VerificationMessageTemplate.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-verificationmessagetemplate

Return type

Union[IResolvable, VerificationMessageTemplateProperty, None]