Class: Aws::CognitoIdentityProvider::Types::CreateUserPoolRequest

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::CreateUserPoolRequest

Includes:

Structure

Defined in:

lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Represents the request to create a user pool.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #account_recovery_setting ⇒ Types::AccountRecoverySettingType

  The available verified method a user can use to recover their password when they call ‘ForgotPassword`.

• #admin_create_user_config ⇒ Types::AdminCreateUserConfigType

  The configuration for ‘AdminCreateUser` requests.

• #alias_attributes ⇒ Array<String>

  Attributes supported as an alias for this user pool.

• #auto_verified_attributes ⇒ Array<String>

  The attributes to be auto-verified.

• #deletion_protection ⇒ String

  When active, ‘DeletionProtection` prevents accidental deletion of your user pool.

• #device_configuration ⇒ Types::DeviceConfigurationType

  The device-remembering configuration for a user pool.

• #email_configuration ⇒ Types::EmailConfigurationType

  The email configuration of your user pool.

• #email_verification_message ⇒ String

  This parameter is no longer used.

• #email_verification_subject ⇒ String

  This parameter is no longer used.

• #lambda_config ⇒ Types::LambdaConfigType

  A collection of user pool Lambda triggers.

• #mfa_configuration ⇒ String

  Specifies MFA configuration details.

• #policies ⇒ Types::UserPoolPolicyType

  The policies associated with the new user pool.

• #pool_name ⇒ String

  A string used to name the user pool.

• #schema ⇒ Array<Types::SchemaAttributeType>

  An array of schema attributes for the new user pool.

• #sms_authentication_message ⇒ String

  A string representing the SMS authentication message.

• #sms_configuration ⇒ Types::SmsConfigurationType

  The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service.

• #sms_verification_message ⇒ String

  This parameter is no longer used.

• #user_attribute_update_settings ⇒ Types::UserAttributeUpdateSettingsType

  The settings for updates to user attributes.

• #user_pool_add_ons ⇒ Types::UserPoolAddOnsType

  User pool add-ons.

• #user_pool_tags ⇒ Hash<String,String>

  The tag keys and values to assign to the user pool.

• #user_pool_tier ⇒ String

  The user pool [feature plan], or tier.

• #username_attributes ⇒ Array<String>

  Specifies whether a user can use an email address or phone number as a username when they sign up.

• #username_configuration ⇒ Types::UsernameConfigurationType

  Case sensitivity on the username input for the selected sign-in option.

• #verification_message_template ⇒ Types::VerificationMessageTemplateType

  The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.

Instance Attribute Details

#account_recovery_setting ⇒ Types::AccountRecoverySettingType

The available verified method a user can use to recover their password when they call ‘ForgotPassword`. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn’t qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.

Returns:

• (Types::AccountRecoverySettingType)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 4403

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :deletion_protection,
  :lambda_config,
  :auto_verified_attributes,
  :alias_attributes,
  :username_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :user_attribute_update_settings,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting,
  :user_pool_tier)
  SENSITIVE = []
  include Aws::Structure
end

#admin_create_user_config ⇒ Types::AdminCreateUserConfigType

The configuration for ‘AdminCreateUser` requests.

Returns:

• (Types::AdminCreateUserConfigType)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 4403

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :deletion_protection,
  :lambda_config,
  :auto_verified_attributes,
  :alias_attributes,
  :username_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :user_attribute_update_settings,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting,
  :user_pool_tier)
  SENSITIVE = []
  include Aws::Structure
end

#alias_attributes ⇒ Array<String>

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 4403

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :deletion_protection,
  :lambda_config,
  :auto_verified_attributes,
  :alias_attributes,
  :username_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :user_attribute_update_settings,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting,
  :user_pool_tier)
  SENSITIVE = []
  include Aws::Structure
end

#auto_verified_attributes ⇒ Array<String>

The attributes to be auto-verified. Possible values: email, phone_number.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 4403

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :deletion_protection,
  :lambda_config,
  :auto_verified_attributes,
  :alias_attributes,
  :username_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :user_attribute_update_settings,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting,
  :user_pool_tier)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protection ⇒ String

When active, ‘DeletionProtection` prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.

When you try to delete a protected user pool in a ‘DeleteUserPool` API request, Amazon Cognito returns an `InvalidParameterException` error. To delete a protected user pool, send a new `DeleteUserPool` request after you deactivate deletion protection in an `UpdateUserPool` API request.

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 4403

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :deletion_protection,
  :lambda_config,
  :auto_verified_attributes,
  :alias_attributes,
  :username_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :user_attribute_update_settings,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting,
  :user_pool_tier)
  SENSITIVE = []
  include Aws::Structure
end

#device_configuration ⇒ Types::DeviceConfigurationType

The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

<note markdown=“1”> When you provide a value for any ‘DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature.

</note>

Returns:

• (Types::DeviceConfigurationType)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 4403

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :deletion_protection,
  :lambda_config,
  :auto_verified_attributes,
  :alias_attributes,
  :username_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :user_attribute_update_settings,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting,
  :user_pool_tier)
  SENSITIVE = []
  include Aws::Structure
end

#email_configuration ⇒ Types::EmailConfigurationType

The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.

Returns:

• (Types::EmailConfigurationType)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 4403

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :deletion_protection,
  :lambda_config,
  :auto_verified_attributes,
  :alias_attributes,
  :username_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :user_attribute_update_settings,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting,
  :user_pool_tier)
  SENSITIVE = []
  include Aws::Structure
end

#email_verification_message ⇒ String

This parameter is no longer used. See [VerificationMessageTemplateType].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 4403

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :deletion_protection,
  :lambda_config,
  :auto_verified_attributes,
  :alias_attributes,
  :username_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :user_attribute_update_settings,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting,
  :user_pool_tier)
  SENSITIVE = []
  include Aws::Structure
end

#email_verification_subject ⇒ String

This parameter is no longer used. See [VerificationMessageTemplateType].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 4403

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :deletion_protection,
  :lambda_config,
  :auto_verified_attributes,
  :alias_attributes,
  :username_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :user_attribute_update_settings,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting,
  :user_pool_tier)
  SENSITIVE = []
  include Aws::Structure
end

#lambda_config ⇒ Types::LambdaConfigType

A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible stages of authentication operations. Triggers can modify the outcome of the operations that invoked them.

Returns:

• (Types::LambdaConfigType)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 4403

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :deletion_protection,
  :lambda_config,
  :auto_verified_attributes,
  :alias_attributes,
  :username_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :user_attribute_update_settings,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting,
  :user_pool_tier)
  SENSITIVE = []
  include Aws::Structure
end

#mfa_configuration ⇒ String

Specifies MFA configuration details.

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 4403

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :deletion_protection,
  :lambda_config,
  :auto_verified_attributes,
  :alias_attributes,
  :username_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :user_attribute_update_settings,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting,
  :user_pool_tier)
  SENSITIVE = []
  include Aws::Structure
end

#policies ⇒ Types::UserPoolPolicyType

The policies associated with the new user pool.

Returns:

• (Types::UserPoolPolicyType)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 4403

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :deletion_protection,
  :lambda_config,
  :auto_verified_attributes,
  :alias_attributes,
  :username_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :user_attribute_update_settings,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting,
  :user_pool_tier)
  SENSITIVE = []
  include Aws::Structure
end

#pool_name ⇒ String

A string used to name the user pool.

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 4403

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :deletion_protection,
  :lambda_config,
  :auto_verified_attributes,
  :alias_attributes,
  :username_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :user_attribute_update_settings,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting,
  :user_pool_tier)
  SENSITIVE = []
  include Aws::Structure
end

#schema ⇒ Array<Types::SchemaAttributeType>

An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.

Returns:

• (Array<Types::SchemaAttributeType>)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 4403

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :deletion_protection,
  :lambda_config,
  :auto_verified_attributes,
  :alias_attributes,
  :username_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :user_attribute_update_settings,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting,
  :user_pool_tier)
  SENSITIVE = []
  include Aws::Structure
end

#sms_authentication_message ⇒ String

A string representing the SMS authentication message.

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 4403

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :deletion_protection,
  :lambda_config,
  :auto_verified_attributes,
  :alias_attributes,
  :username_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :user_attribute_update_settings,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting,
  :user_pool_tier)
  SENSITIVE = []
  include Aws::Structure
end

#sms_configuration ⇒ Types::SmsConfigurationType

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.

Returns:

• (Types::SmsConfigurationType)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 4403

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :deletion_protection,
  :lambda_config,
  :auto_verified_attributes,
  :alias_attributes,
  :username_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :user_attribute_update_settings,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting,
  :user_pool_tier)
  SENSITIVE = []
  include Aws::Structure
end

#sms_verification_message ⇒ String

This parameter is no longer used. See [VerificationMessageTemplateType].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 4403

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :deletion_protection,
  :lambda_config,
  :auto_verified_attributes,
  :alias_attributes,
  :username_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :user_attribute_update_settings,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting,
  :user_pool_tier)
  SENSITIVE = []
  include Aws::Structure
end

#user_attribute_update_settings ⇒ Types::UserAttributeUpdateSettingsType

The settings for updates to user attributes. These settings include the property ‘AttributesRequireVerificationBeforeUpdate`, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users’ email address and phone number attributes. For more information, see [ Verifying updates to email addresses and phone numbers].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates

Returns:

• (Types::UserAttributeUpdateSettingsType)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 4403

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :deletion_protection,
  :lambda_config,
  :auto_verified_attributes,
  :alias_attributes,
  :username_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :user_attribute_update_settings,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting,
  :user_pool_tier)
  SENSITIVE = []
  include Aws::Structure
end

#user_pool_add_ons ⇒ Types::UserPoolAddOnsType

User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to ‘AUDIT`. To configure automatic security responses to risky traffic to your user pool, set to `ENFORCED`.

For more information, see [Adding advanced security to a user pool].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html

Returns:

• (Types::UserPoolAddOnsType)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 4403

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :deletion_protection,
  :lambda_config,
  :auto_verified_attributes,
  :alias_attributes,
  :username_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :user_attribute_update_settings,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting,
  :user_pool_tier)
  SENSITIVE = []
  include Aws::Structure
end

#user_pool_tags ⇒ Hash<String,String>

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 4403

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :deletion_protection,
  :lambda_config,
  :auto_verified_attributes,
  :alias_attributes,
  :username_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :user_attribute_update_settings,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting,
  :user_pool_tier)
  SENSITIVE = []
  include Aws::Structure
end

#user_pool_tier ⇒ String

The user pool [feature plan], or tier. This parameter determines the eligibility of the user pool for features like managed login, access-token customization, and threat protection. Defaults to ‘ESSENTIALS`.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-sign-in-feature-plans.html

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 4403

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :deletion_protection,
  :lambda_config,
  :auto_verified_attributes,
  :alias_attributes,
  :username_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :user_attribute_update_settings,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting,
  :user_pool_tier)
  SENSITIVE = []
  include Aws::Structure
end

#username_attributes ⇒ Array<String>

Specifies whether a user can use an email address or phone number as a username when they sign up.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 4403

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :deletion_protection,
  :lambda_config,
  :auto_verified_attributes,
  :alias_attributes,
  :username_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :user_attribute_update_settings,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting,
  :user_pool_tier)
  SENSITIVE = []
  include Aws::Structure
end

#username_configuration ⇒ Types::UsernameConfigurationType

Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to ‘False` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username`, `USERNAME`, or `UserName`, or for email, `email@example.com` or `EMaiL@eXamplE.Com`. For most use cases, set case sensitivity to `False` (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.

This configuration is immutable after you set it. For more information, see [UsernameConfigurationType].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html

Returns:

• (Types::UsernameConfigurationType)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 4403

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :deletion_protection,
  :lambda_config,
  :auto_verified_attributes,
  :alias_attributes,
  :username_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :user_attribute_update_settings,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting,
  :user_pool_tier)
  SENSITIVE = []
  include Aws::Structure
end

#verification_message_template ⇒ Types::VerificationMessageTemplateType

The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.

Set the email message type that corresponds to your ‘DefaultEmailOption` selection. For `CONFIRM_WITH_LINK`, specify an `EmailMessageByLink` and leave `EmailMessage` blank. For `CONFIRM_WITH_CODE`, specify an `EmailMessage` and leave `EmailMessageByLink` blank. When you supply both parameters with either choice, Amazon Cognito returns an error.

Returns:

• (Types::VerificationMessageTemplateType)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 4403

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :deletion_protection,
  :lambda_config,
  :auto_verified_attributes,
  :alias_attributes,
  :username_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :user_attribute_update_settings,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting,
  :user_pool_tier)
  SENSITIVE = []
  include Aws::Structure
end