CfnUserPool

class aws_cdk.aws_cognito.CfnUserPool(scope, id, *, 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: aws_cdk.core.CfnResource

A CloudFormation AWS::Cognito::UserPool.

See

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

CloudformationResource

AWS::Cognito::UserPool

Create a new AWS::Cognito::UserPool.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • 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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\." because the \ itself will need to be escaped.

For example:

# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

inspect(inspector)

(experimental) Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Stability

experimental

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Cognito::UserPool'
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]]

attr_arn

Arn

Type

cloudformationAttribute

Return type

str

attr_provider_name

ProviderName

Type

cloudformationAttribute

Return type

str

attr_provider_url

ProviderURL

Type

cloudformationAttribute

Return type

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]]

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

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]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

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]

node

The construct tree node associated with this construct.

Return type

ConstructNode

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]

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

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]

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

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

TagManager

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]

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]

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

AccountRecoverySettingProperty

class CfnUserPool.AccountRecoverySettingProperty(*, recovery_mechanisms=None)

Bases: object

Parameters

recovery_mechanisms (Union[IResolvable, List[Union[IResolvable, RecoveryOptionProperty]], None]) – CfnUserPool.AccountRecoverySettingProperty.RecoveryMechanisms.

See

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

Attributes

recovery_mechanisms

CfnUserPool.AccountRecoverySettingProperty.RecoveryMechanisms.

See

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

Return type

Union[IResolvable, List[Union[IResolvable, RecoveryOptionProperty]], None]

AdminCreateUserConfigProperty

class CfnUserPool.AdminCreateUserConfigProperty(*, allow_admin_create_user_only=None, invite_message_template=None, unused_account_validity_days=None)

Bases: object

Parameters
  • allow_admin_create_user_only (Union[bool, IResolvable, None]) – CfnUserPool.AdminCreateUserConfigProperty.AllowAdminCreateUserOnly.

  • invite_message_template (Union[IResolvable, InviteMessageTemplateProperty, None]) – CfnUserPool.AdminCreateUserConfigProperty.InviteMessageTemplate.

  • unused_account_validity_days (Union[int, float, None]) – CfnUserPool.AdminCreateUserConfigProperty.UnusedAccountValidityDays.

See

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

Attributes

allow_admin_create_user_only

CfnUserPool.AdminCreateUserConfigProperty.AllowAdminCreateUserOnly.

See

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

Return type

Union[bool, IResolvable, None]

invite_message_template

CfnUserPool.AdminCreateUserConfigProperty.InviteMessageTemplate.

See

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

Return type

Union[IResolvable, InviteMessageTemplateProperty, None]

unused_account_validity_days

CfnUserPool.AdminCreateUserConfigProperty.UnusedAccountValidityDays.

See

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

Return type

Union[int, float, None]

DeviceConfigurationProperty

class CfnUserPool.DeviceConfigurationProperty(*, challenge_required_on_new_device=None, device_only_remembered_on_user_prompt=None)

Bases: object

Parameters
  • challenge_required_on_new_device (Union[bool, IResolvable, None]) – CfnUserPool.DeviceConfigurationProperty.ChallengeRequiredOnNewDevice.

  • device_only_remembered_on_user_prompt (Union[bool, IResolvable, None]) – CfnUserPool.DeviceConfigurationProperty.DeviceOnlyRememberedOnUserPrompt.

See

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

Attributes

challenge_required_on_new_device

CfnUserPool.DeviceConfigurationProperty.ChallengeRequiredOnNewDevice.

See

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

Return type

Union[bool, IResolvable, None]

device_only_remembered_on_user_prompt

CfnUserPool.DeviceConfigurationProperty.DeviceOnlyRememberedOnUserPrompt.

See

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

Return type

Union[bool, IResolvable, None]

EmailConfigurationProperty

class CfnUserPool.EmailConfigurationProperty(*, configuration_set=None, email_sending_account=None, from_=None, reply_to_email_address=None, source_arn=None)

Bases: object

Parameters
  • configuration_set (Optional[str]) – CfnUserPool.EmailConfigurationProperty.ConfigurationSet.

  • email_sending_account (Optional[str]) – CfnUserPool.EmailConfigurationProperty.EmailSendingAccount.

  • fromCfnUserPool.EmailConfigurationProperty.From.

  • reply_to_email_address (Optional[str]) – CfnUserPool.EmailConfigurationProperty.ReplyToEmailAddress.

  • source_arn (Optional[str]) – CfnUserPool.EmailConfigurationProperty.SourceArn.

See

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

Attributes

configuration_set

CfnUserPool.EmailConfigurationProperty.ConfigurationSet.

See

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

Return type

Optional[str]

email_sending_account

CfnUserPool.EmailConfigurationProperty.EmailSendingAccount.

See

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

Return type

Optional[str]

from_

CfnUserPool.EmailConfigurationProperty.From.

See

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

Return type

Optional[str]

reply_to_email_address

CfnUserPool.EmailConfigurationProperty.ReplyToEmailAddress.

See

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

Return type

Optional[str]

source_arn

CfnUserPool.EmailConfigurationProperty.SourceArn.

See

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

Return type

Optional[str]

InviteMessageTemplateProperty

class CfnUserPool.InviteMessageTemplateProperty(*, email_message=None, email_subject=None, sms_message=None)

Bases: object

Parameters
  • email_message (Optional[str]) – CfnUserPool.InviteMessageTemplateProperty.EmailMessage.

  • email_subject (Optional[str]) – CfnUserPool.InviteMessageTemplateProperty.EmailSubject.

  • sms_message (Optional[str]) – CfnUserPool.InviteMessageTemplateProperty.SMSMessage.

See

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

Attributes

email_message

CfnUserPool.InviteMessageTemplateProperty.EmailMessage.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-invitemessagetemplate.html#cfn-cognito-userpool-invitemessagetemplate-emailmessage

Return type

Optional[str]

email_subject

CfnUserPool.InviteMessageTemplateProperty.EmailSubject.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-invitemessagetemplate.html#cfn-cognito-userpool-invitemessagetemplate-emailsubject

Return type

Optional[str]

sms_message

CfnUserPool.InviteMessageTemplateProperty.SMSMessage.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-invitemessagetemplate.html#cfn-cognito-userpool-invitemessagetemplate-smsmessage

Return type

Optional[str]

LambdaConfigProperty

class CfnUserPool.LambdaConfigProperty(*, create_auth_challenge=None, custom_message=None, define_auth_challenge=None, post_authentication=None, post_confirmation=None, pre_authentication=None, pre_sign_up=None, pre_token_generation=None, user_migration=None, verify_auth_challenge_response=None)

Bases: object

Parameters
  • create_auth_challenge (Optional[str]) – CfnUserPool.LambdaConfigProperty.CreateAuthChallenge.

  • custom_message (Optional[str]) – CfnUserPool.LambdaConfigProperty.CustomMessage.

  • define_auth_challenge (Optional[str]) – CfnUserPool.LambdaConfigProperty.DefineAuthChallenge.

  • post_authentication (Optional[str]) – CfnUserPool.LambdaConfigProperty.PostAuthentication.

  • post_confirmation (Optional[str]) – CfnUserPool.LambdaConfigProperty.PostConfirmation.

  • pre_authentication (Optional[str]) – CfnUserPool.LambdaConfigProperty.PreAuthentication.

  • pre_sign_up (Optional[str]) – CfnUserPool.LambdaConfigProperty.PreSignUp.

  • pre_token_generation (Optional[str]) – CfnUserPool.LambdaConfigProperty.PreTokenGeneration.

  • user_migration (Optional[str]) – CfnUserPool.LambdaConfigProperty.UserMigration.

  • verify_auth_challenge_response (Optional[str]) – CfnUserPool.LambdaConfigProperty.VerifyAuthChallengeResponse.

See

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

Attributes

create_auth_challenge

CfnUserPool.LambdaConfigProperty.CreateAuthChallenge.

See

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

Return type

Optional[str]

custom_message

CfnUserPool.LambdaConfigProperty.CustomMessage.

See

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

Return type

Optional[str]

define_auth_challenge

CfnUserPool.LambdaConfigProperty.DefineAuthChallenge.

See

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

Return type

Optional[str]

post_authentication

CfnUserPool.LambdaConfigProperty.PostAuthentication.

See

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

Return type

Optional[str]

post_confirmation

CfnUserPool.LambdaConfigProperty.PostConfirmation.

See

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

Return type

Optional[str]

pre_authentication

CfnUserPool.LambdaConfigProperty.PreAuthentication.

See

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

Return type

Optional[str]

pre_sign_up

CfnUserPool.LambdaConfigProperty.PreSignUp.

See

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

Return type

Optional[str]

pre_token_generation

CfnUserPool.LambdaConfigProperty.PreTokenGeneration.

See

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

Return type

Optional[str]

user_migration

CfnUserPool.LambdaConfigProperty.UserMigration.

See

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

Return type

Optional[str]

verify_auth_challenge_response

CfnUserPool.LambdaConfigProperty.VerifyAuthChallengeResponse.

See

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

Return type

Optional[str]

NumberAttributeConstraintsProperty

class CfnUserPool.NumberAttributeConstraintsProperty(*, max_value=None, min_value=None)

Bases: object

Parameters
  • max_value (Optional[str]) – CfnUserPool.NumberAttributeConstraintsProperty.MaxValue.

  • min_value (Optional[str]) – CfnUserPool.NumberAttributeConstraintsProperty.MinValue.

See

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

Attributes

max_value

CfnUserPool.NumberAttributeConstraintsProperty.MaxValue.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-numberattributeconstraints.html#cfn-cognito-userpool-numberattributeconstraints-maxvalue

Return type

Optional[str]

min_value

CfnUserPool.NumberAttributeConstraintsProperty.MinValue.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-numberattributeconstraints.html#cfn-cognito-userpool-numberattributeconstraints-minvalue

Return type

Optional[str]

PasswordPolicyProperty

class CfnUserPool.PasswordPolicyProperty(*, minimum_length=None, require_lowercase=None, require_numbers=None, require_symbols=None, require_uppercase=None, temporary_password_validity_days=None)

Bases: object

Parameters
  • minimum_length (Union[int, float, None]) – CfnUserPool.PasswordPolicyProperty.MinimumLength.

  • require_lowercase (Union[bool, IResolvable, None]) – CfnUserPool.PasswordPolicyProperty.RequireLowercase.

  • require_numbers (Union[bool, IResolvable, None]) – CfnUserPool.PasswordPolicyProperty.RequireNumbers.

  • require_symbols (Union[bool, IResolvable, None]) – CfnUserPool.PasswordPolicyProperty.RequireSymbols.

  • require_uppercase (Union[bool, IResolvable, None]) – CfnUserPool.PasswordPolicyProperty.RequireUppercase.

  • temporary_password_validity_days (Union[int, float, None]) – CfnUserPool.PasswordPolicyProperty.TemporaryPasswordValidityDays.

See

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

Attributes

minimum_length

CfnUserPool.PasswordPolicyProperty.MinimumLength.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-minimumlength

Return type

Union[int, float, None]

require_lowercase

CfnUserPool.PasswordPolicyProperty.RequireLowercase.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-requirelowercase

Return type

Union[bool, IResolvable, None]

require_numbers

CfnUserPool.PasswordPolicyProperty.RequireNumbers.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-requirenumbers

Return type

Union[bool, IResolvable, None]

require_symbols

CfnUserPool.PasswordPolicyProperty.RequireSymbols.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-requiresymbols

Return type

Union[bool, IResolvable, None]

require_uppercase

CfnUserPool.PasswordPolicyProperty.RequireUppercase.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-requireuppercase

Return type

Union[bool, IResolvable, None]

temporary_password_validity_days

CfnUserPool.PasswordPolicyProperty.TemporaryPasswordValidityDays.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-temporarypasswordvaliditydays

Return type

Union[int, float, None]

PoliciesProperty

class CfnUserPool.PoliciesProperty(*, password_policy=None)

Bases: object

Parameters

password_policy (Union[IResolvable, PasswordPolicyProperty, None]) – CfnUserPool.PoliciesProperty.PasswordPolicy.

See

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

Attributes

password_policy

CfnUserPool.PoliciesProperty.PasswordPolicy.

See

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

Return type

Union[IResolvable, PasswordPolicyProperty, None]

RecoveryOptionProperty

class CfnUserPool.RecoveryOptionProperty(*, name=None, priority=None)

Bases: object

Parameters
  • name (Optional[str]) – CfnUserPool.RecoveryOptionProperty.Name.

  • priority (Union[int, float, None]) – CfnUserPool.RecoveryOptionProperty.Priority.

See

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

Attributes

name

CfnUserPool.RecoveryOptionProperty.Name.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-recoveryoption.html#cfn-cognito-userpool-recoveryoption-name

Return type

Optional[str]

priority

CfnUserPool.RecoveryOptionProperty.Priority.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-recoveryoption.html#cfn-cognito-userpool-recoveryoption-priority

Return type

Union[int, float, None]

SchemaAttributeProperty

class CfnUserPool.SchemaAttributeProperty(*, attribute_data_type=None, developer_only_attribute=None, mutable=None, name=None, number_attribute_constraints=None, required=None, string_attribute_constraints=None)

Bases: object

Parameters
  • attribute_data_type (Optional[str]) – CfnUserPool.SchemaAttributeProperty.AttributeDataType.

  • developer_only_attribute (Union[bool, IResolvable, None]) – CfnUserPool.SchemaAttributeProperty.DeveloperOnlyAttribute.

  • mutable (Union[bool, IResolvable, None]) – CfnUserPool.SchemaAttributeProperty.Mutable.

  • name (Optional[str]) – CfnUserPool.SchemaAttributeProperty.Name.

  • number_attribute_constraints (Union[IResolvable, NumberAttributeConstraintsProperty, None]) – CfnUserPool.SchemaAttributeProperty.NumberAttributeConstraints.

  • required (Union[bool, IResolvable, None]) – CfnUserPool.SchemaAttributeProperty.Required.

  • string_attribute_constraints (Union[IResolvable, StringAttributeConstraintsProperty, None]) – CfnUserPool.SchemaAttributeProperty.StringAttributeConstraints.

See

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

Attributes

attribute_data_type

CfnUserPool.SchemaAttributeProperty.AttributeDataType.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-attributedatatype

Return type

Optional[str]

developer_only_attribute

CfnUserPool.SchemaAttributeProperty.DeveloperOnlyAttribute.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-developeronlyattribute

Return type

Union[bool, IResolvable, None]

mutable

CfnUserPool.SchemaAttributeProperty.Mutable.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-mutable

Return type

Union[bool, IResolvable, None]

name

CfnUserPool.SchemaAttributeProperty.Name.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-name

Return type

Optional[str]

number_attribute_constraints

CfnUserPool.SchemaAttributeProperty.NumberAttributeConstraints.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-numberattributeconstraints

Return type

Union[IResolvable, NumberAttributeConstraintsProperty, None]

required

CfnUserPool.SchemaAttributeProperty.Required.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-required

Return type

Union[bool, IResolvable, None]

string_attribute_constraints

CfnUserPool.SchemaAttributeProperty.StringAttributeConstraints.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-stringattributeconstraints

Return type

Union[IResolvable, StringAttributeConstraintsProperty, None]

SmsConfigurationProperty

class CfnUserPool.SmsConfigurationProperty(*, external_id=None, sns_caller_arn=None)

Bases: object

Parameters
  • external_id (Optional[str]) – CfnUserPool.SmsConfigurationProperty.ExternalId.

  • sns_caller_arn (Optional[str]) – CfnUserPool.SmsConfigurationProperty.SnsCallerArn.

See

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

Attributes

external_id

CfnUserPool.SmsConfigurationProperty.ExternalId.

See

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

Return type

Optional[str]

sns_caller_arn

CfnUserPool.SmsConfigurationProperty.SnsCallerArn.

See

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

Return type

Optional[str]

StringAttributeConstraintsProperty

class CfnUserPool.StringAttributeConstraintsProperty(*, max_length=None, min_length=None)

Bases: object

Parameters
  • max_length (Optional[str]) – CfnUserPool.StringAttributeConstraintsProperty.MaxLength.

  • min_length (Optional[str]) – CfnUserPool.StringAttributeConstraintsProperty.MinLength.

See

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

Attributes

max_length

CfnUserPool.StringAttributeConstraintsProperty.MaxLength.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-stringattributeconstraints.html#cfn-cognito-userpool-stringattributeconstraints-maxlength

Return type

Optional[str]

min_length

CfnUserPool.StringAttributeConstraintsProperty.MinLength.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-stringattributeconstraints.html#cfn-cognito-userpool-stringattributeconstraints-minlength

Return type

Optional[str]

UserPoolAddOnsProperty

class CfnUserPool.UserPoolAddOnsProperty(*, advanced_security_mode=None)

Bases: object

Parameters

advanced_security_mode (Optional[str]) – CfnUserPool.UserPoolAddOnsProperty.AdvancedSecurityMode.

See

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

Attributes

advanced_security_mode

CfnUserPool.UserPoolAddOnsProperty.AdvancedSecurityMode.

See

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

Return type

Optional[str]

UsernameConfigurationProperty

class CfnUserPool.UsernameConfigurationProperty(*, case_sensitive=None)

Bases: object

Parameters

case_sensitive (Union[bool, IResolvable, None]) – CfnUserPool.UsernameConfigurationProperty.CaseSensitive.

See

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

Attributes

case_sensitive

CfnUserPool.UsernameConfigurationProperty.CaseSensitive.

See

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

Return type

Union[bool, IResolvable, None]

VerificationMessageTemplateProperty

class CfnUserPool.VerificationMessageTemplateProperty(*, default_email_option=None, email_message=None, email_message_by_link=None, email_subject=None, email_subject_by_link=None, sms_message=None)

Bases: object

Parameters
  • default_email_option (Optional[str]) – CfnUserPool.VerificationMessageTemplateProperty.DefaultEmailOption.

  • email_message (Optional[str]) – CfnUserPool.VerificationMessageTemplateProperty.EmailMessage.

  • email_message_by_link (Optional[str]) – CfnUserPool.VerificationMessageTemplateProperty.EmailMessageByLink.

  • email_subject (Optional[str]) – CfnUserPool.VerificationMessageTemplateProperty.EmailSubject.

  • email_subject_by_link (Optional[str]) – CfnUserPool.VerificationMessageTemplateProperty.EmailSubjectByLink.

  • sms_message (Optional[str]) – CfnUserPool.VerificationMessageTemplateProperty.SmsMessage.

See

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

Attributes

default_email_option

CfnUserPool.VerificationMessageTemplateProperty.DefaultEmailOption.

See

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

Return type

Optional[str]

email_message

CfnUserPool.VerificationMessageTemplateProperty.EmailMessage.

See

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

Return type

Optional[str]

CfnUserPool.VerificationMessageTemplateProperty.EmailMessageByLink.

See

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

Return type

Optional[str]

email_subject

CfnUserPool.VerificationMessageTemplateProperty.EmailSubject.

See

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

Return type

Optional[str]

CfnUserPool.VerificationMessageTemplateProperty.EmailSubjectByLink.

See

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

Return type

Optional[str]

sms_message

CfnUserPool.VerificationMessageTemplateProperty.SmsMessage.

See

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

Return type

Optional[str]