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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Note:

When making an API call, you may pass CreateUserPoolRequest data as a hash:

{
  pool_name: "UserPoolNameType", # required
  policies: {
    password_policy: {
      minimum_length: 1,
      require_uppercase: false,
      require_lowercase: false,
      require_numbers: false,
      require_symbols: false,
      temporary_password_validity_days: 1,
    },
  },
  lambda_config: {
    pre_sign_up: "ArnType",
    custom_message: "ArnType",
    post_confirmation: "ArnType",
    pre_authentication: "ArnType",
    post_authentication: "ArnType",
    define_auth_challenge: "ArnType",
    create_auth_challenge: "ArnType",
    verify_auth_challenge_response: "ArnType",
    pre_token_generation: "ArnType",
    user_migration: "ArnType",
    custom_sms_sender: {
      lambda_version: "V1_0", # required, accepts V1_0
      lambda_arn: "ArnType", # required
    },
    custom_email_sender: {
      lambda_version: "V1_0", # required, accepts V1_0
      lambda_arn: "ArnType", # required
    },
    kms_key_id: "ArnType",
  },
  auto_verified_attributes: ["phone_number"], # accepts phone_number, email
  alias_attributes: ["phone_number"], # accepts phone_number, email, preferred_username
  username_attributes: ["phone_number"], # accepts phone_number, email
  sms_verification_message: "SmsVerificationMessageType",
  email_verification_message: "EmailVerificationMessageType",
  email_verification_subject: "EmailVerificationSubjectType",
  verification_message_template: {
    sms_message: "SmsVerificationMessageType",
    email_message: "EmailVerificationMessageType",
    email_subject: "EmailVerificationSubjectType",
    email_message_by_link: "EmailVerificationMessageByLinkType",
    email_subject_by_link: "EmailVerificationSubjectByLinkType",
    default_email_option: "CONFIRM_WITH_LINK", # accepts CONFIRM_WITH_LINK, CONFIRM_WITH_CODE
  },
  sms_authentication_message: "SmsVerificationMessageType",
  mfa_configuration: "OFF", # accepts OFF, ON, OPTIONAL
  device_configuration: {
    challenge_required_on_new_device: false,
    device_only_remembered_on_user_prompt: false,
  },
  email_configuration: {
    source_arn: "ArnType",
    reply_to_email_address: "EmailAddressType",
    email_sending_account: "COGNITO_DEFAULT", # accepts COGNITO_DEFAULT, DEVELOPER
    from: "StringType",
    configuration_set: "SESConfigurationSet",
  },
  sms_configuration: {
    sns_caller_arn: "ArnType", # required
    external_id: "StringType",
    sns_region: "RegionCodeType",
  },
  user_pool_tags: {
    "TagKeysType" => "TagValueType",
  },
  admin_create_user_config: {
    allow_admin_create_user_only: false,
    unused_account_validity_days: 1,
    invite_message_template: {
      sms_message: "SmsVerificationMessageType",
      email_message: "EmailVerificationMessageType",
      email_subject: "EmailVerificationSubjectType",
    },
  },
  schema: [
    {
      name: "CustomAttributeNameType",
      attribute_data_type: "String", # accepts String, Number, DateTime, Boolean
      developer_only_attribute: false,
      mutable: false,
      required: false,
      number_attribute_constraints: {
        min_value: "StringType",
        max_value: "StringType",
      },
      string_attribute_constraints: {
        min_length: "StringType",
        max_length: "StringType",
      },
    },
  ],
  user_pool_add_ons: {
    advanced_security_mode: "OFF", # required, accepts OFF, AUDIT, ENFORCED
  },
  username_configuration: {
    case_sensitive: false, # required
  },
  account_recovery_setting: {
    recovery_mechanisms: [
      {
        priority: 1, # required
        name: "verified_email", # required, accepts verified_email, verified_phone_number, admin_only
      },
    ],
  },
}

Represents the request to create a user pool.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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:



3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3911

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :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,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting)
  SENSITIVE = []
  include Aws::Structure
end

#admin_create_user_config ⇒ Types::AdminCreateUserConfigType

The configuration for `AdminCreateUser` requests.

Returns:



3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3911

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :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,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting)
  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>) 


3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3911

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :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,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting)
  SENSITIVE = []
  include Aws::Structure
end

#auto_verified_attributes ⇒ Array<String>

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

Returns:

  • (Array<String>) 


3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3911

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :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,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting)
  SENSITIVE = []
  include Aws::Structure
end

#device_configuration ⇒ Types::DeviceConfigurationType

The device configuration.

Returns:



3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3911

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :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,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting)
  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:



3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3911

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :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,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting)
  SENSITIVE = []
  include Aws::Structure
end

#email_verification_message ⇒ String

A string representing the email verification message. EmailVerificationMessage is allowed only if [EmailSendingAccount] is DEVELOPER.

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount

Returns:

  • (String) 


3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3911

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :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,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting)
  SENSITIVE = []
  include Aws::Structure
end

#email_verification_subject ⇒ String

A string representing the email verification subject. EmailVerificationSubject is allowed only if [EmailSendingAccount] is DEVELOPER.

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount

Returns:

  • (String) 


3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3911

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :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,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting)
  SENSITIVE = []
  include Aws::Structure
end

#lambda_config ⇒ Types::LambdaConfigType

The Lambda trigger configuration information for the new user pool.

<note markdown=“1”> In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you must make an extra call to add permission for these event sources to invoke your Lambda function.

For more information on using the Lambda API to add permission, see[

AddPermission ][1].

For adding permission using the CLI, see[ add-permission ][2].

</note>

[1]: docs.aws.amazon.com/lambda/latest/dg/API_AddPermission.html [2]: docs.aws.amazon.com/cli/latest/reference/lambda/add-permission.html

Returns:



3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3911

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :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,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting)
  SENSITIVE = []
  include Aws::Structure
end

#mfa_configuration ⇒ String

Specifies MFA configuration details.

Returns:

  • (String) 


3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3911

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :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,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting)
  SENSITIVE = []
  include Aws::Structure
end

#policies ⇒ Types::UserPoolPolicyType

The policies associated with the new user pool.

Returns:



3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3911

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :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,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting)
  SENSITIVE = []
  include Aws::Structure
end

#pool_name ⇒ String

A string used to name the user pool.

Returns:

  • (String) 


3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3911

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :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,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting)
  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:



3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3911

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :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,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting)
  SENSITIVE = []
  include Aws::Structure
end

#sms_authentication_message ⇒ String

A string representing the SMS authentication message.

Returns:

  • (String) 


3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3911

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :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,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting)
  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:



3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3911

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :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,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting)
  SENSITIVE = []
  include Aws::Structure
end

#sms_verification_message ⇒ String

A string representing the SMS verification message.

Returns:

  • (String) 


3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3911

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :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,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting)
  SENSITIVE = []
  include Aws::Structure
end

#user_pool_add_ons ⇒ Types::UserPoolAddOnsType

Enables advanced security risk detection. Set the key `AdvancedSecurityMode` to the value “AUDIT”.

Returns:



3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3911

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :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,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting)
  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>) 


3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3911

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :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,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting)
  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>) 


3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3911

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :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,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting)
  SENSITIVE = []
  include Aws::Structure
end

#username_configuration ⇒ Types::UsernameConfigurationType

Case sensitivity on the username input for the selected sign-in option. For example, when case sensitivity is set to `False`, users can sign in using either “username” or “Username”. This configuration is immutable once it has been set. For more information, see [UsernameConfigurationType].

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

Returns:



3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3911

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :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,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting)
  SENSITIVE = []
  include Aws::Structure
end

#verification_message_template ⇒ Types::VerificationMessageTemplateType

The template for the verification message that the user sees when the app requests permission to access the user's information.

Returns:



3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3911

class CreateUserPoolRequest < Struct.new(
  :pool_name,
  :policies,
  :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,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :schema,
  :user_pool_add_ons,
  :username_configuration,
  :account_recovery_setting)
  SENSITIVE = []
  include Aws::Structure
end