You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CognitoIdentityProvider::Types::UserPoolType

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::UserPoolType

Defined in:

gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

A container for information about the user pool.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #admin_create_user_config ⇒ Types::AdminCreateUserConfigType

  The configuration for AdminCreateUser requests.

• #alias_attributes ⇒ Array<String>

  Specifies the attributes that are aliased in a user pool.

• #arn ⇒ String

  The Amazon Resource Name (ARN) for the user pool.

• #auto_verified_attributes ⇒ Array<String>

  Specifies the attributes that are auto-verified in a user pool.

• #creation_date ⇒ Time

  The date the user pool was created.

• #custom_domain ⇒ String

  A custom domain name that you provide to Amazon Cognito.

• #device_configuration ⇒ Types::DeviceConfigurationType

  The device configuration.

• #domain ⇒ String

  Holds the domain prefix if the user pool has a domain associated with it.

• #email_configuration ⇒ Types::EmailConfigurationType

  The email configuration.

• #email_configuration_failure ⇒ String

  The reason why the email configuration cannot send the messages to your users.

• #email_verification_message ⇒ String

  The contents of the email verification message.

• #email_verification_subject ⇒ String

  The subject of the email verification message.

• #estimated_number_of_users ⇒ Integer

  A number estimating the size of the user pool.

• #id ⇒ String

  The ID of the user pool.

• #lambda_config ⇒ Types::LambdaConfigType

  The AWS Lambda triggers associated with the user pool.

• #last_modified_date ⇒ Time

  The date the user pool was last modified.

• #mfa_configuration ⇒ String

  Can be one of the following values:.

• #name ⇒ String

  The name of the user pool.

• #policies ⇒ Types::UserPoolPolicyType

  The policies associated with the user pool.

• #schema_attributes ⇒ Array<Types::SchemaAttributeType>

  A container with the schema attributes of a user pool.

• #sms_authentication_message ⇒ String

  The contents of the SMS authentication message.

• #sms_configuration ⇒ Types::SmsConfigurationType

  The SMS configuration.

• #sms_configuration_failure ⇒ String

  The reason why the SMS configuration cannot send the messages to your users.

• #sms_verification_message ⇒ String

  The contents of the SMS verification message.

• #status ⇒ String

  The status of a user pool.

• #user_pool_add_ons ⇒ Types::UserPoolAddOnsType

  The user pool add-ons.

• #user_pool_tags ⇒ Hash<String,String>

  The tags that are assigned to the user pool.

• #username_attributes ⇒ Array<String>

  Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.

• #verification_message_template ⇒ Types::VerificationMessageTemplateType

  The template for verification messages.

Instance Attribute Details

#admin_create_user_config ⇒ Types::AdminCreateUserConfigType

The configuration for AdminCreateUser requests.

Returns:

• (Types::AdminCreateUserConfigType)

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

class UserPoolType < Struct.new(
  :id,
  :name,
  :policies,
  :lambda_config,
  :status,
  :last_modified_date,
  :creation_date,
  :schema_attributes,
  :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,
  :estimated_number_of_users,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :sms_configuration_failure,
  :email_configuration_failure,
  :domain,
  :custom_domain,
  :admin_create_user_config,
  :user_pool_add_ons,
  :arn)
  include Aws::Structure
end

#alias_attributes ⇒ Array<String>

Specifies the attributes that are aliased in a user pool.

Returns:

• (Array<String>)

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

class UserPoolType < Struct.new(
  :id,
  :name,
  :policies,
  :lambda_config,
  :status,
  :last_modified_date,
  :creation_date,
  :schema_attributes,
  :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,
  :estimated_number_of_users,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :sms_configuration_failure,
  :email_configuration_failure,
  :domain,
  :custom_domain,
  :admin_create_user_config,
  :user_pool_add_ons,
  :arn)
  include Aws::Structure
end

#arn ⇒ String

The Amazon Resource Name (ARN) for the user pool.

Returns:

• (String)

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

class UserPoolType < Struct.new(
  :id,
  :name,
  :policies,
  :lambda_config,
  :status,
  :last_modified_date,
  :creation_date,
  :schema_attributes,
  :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,
  :estimated_number_of_users,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :sms_configuration_failure,
  :email_configuration_failure,
  :domain,
  :custom_domain,
  :admin_create_user_config,
  :user_pool_add_ons,
  :arn)
  include Aws::Structure
end

#auto_verified_attributes ⇒ Array<String>

Specifies the attributes that are auto-verified in a user pool.

Returns:

• (Array<String>)

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

class UserPoolType < Struct.new(
  :id,
  :name,
  :policies,
  :lambda_config,
  :status,
  :last_modified_date,
  :creation_date,
  :schema_attributes,
  :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,
  :estimated_number_of_users,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :sms_configuration_failure,
  :email_configuration_failure,
  :domain,
  :custom_domain,
  :admin_create_user_config,
  :user_pool_add_ons,
  :arn)
  include Aws::Structure
end

#creation_date ⇒ Time

The date the user pool was created.

Returns:

• (Time)

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

class UserPoolType < Struct.new(
  :id,
  :name,
  :policies,
  :lambda_config,
  :status,
  :last_modified_date,
  :creation_date,
  :schema_attributes,
  :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,
  :estimated_number_of_users,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :sms_configuration_failure,
  :email_configuration_failure,
  :domain,
  :custom_domain,
  :admin_create_user_config,
  :user_pool_add_ons,
  :arn)
  include Aws::Structure
end

#custom_domain ⇒ String

A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application. For example: auth.example.com.

For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.

Returns:

• (String)

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

class UserPoolType < Struct.new(
  :id,
  :name,
  :policies,
  :lambda_config,
  :status,
  :last_modified_date,
  :creation_date,
  :schema_attributes,
  :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,
  :estimated_number_of_users,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :sms_configuration_failure,
  :email_configuration_failure,
  :domain,
  :custom_domain,
  :admin_create_user_config,
  :user_pool_add_ons,
  :arn)
  include Aws::Structure
end

#device_configuration ⇒ Types::DeviceConfigurationType

The device configuration.

Returns:

• (Types::DeviceConfigurationType)

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

class UserPoolType < Struct.new(
  :id,
  :name,
  :policies,
  :lambda_config,
  :status,
  :last_modified_date,
  :creation_date,
  :schema_attributes,
  :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,
  :estimated_number_of_users,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :sms_configuration_failure,
  :email_configuration_failure,
  :domain,
  :custom_domain,
  :admin_create_user_config,
  :user_pool_add_ons,
  :arn)
  include Aws::Structure
end

#domain ⇒ String

Holds the domain prefix if the user pool has a domain associated with it.

Returns:

• (String)

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

class UserPoolType < Struct.new(
  :id,
  :name,
  :policies,
  :lambda_config,
  :status,
  :last_modified_date,
  :creation_date,
  :schema_attributes,
  :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,
  :estimated_number_of_users,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :sms_configuration_failure,
  :email_configuration_failure,
  :domain,
  :custom_domain,
  :admin_create_user_config,
  :user_pool_add_ons,
  :arn)
  include Aws::Structure
end

#email_configuration ⇒ Types::EmailConfigurationType

The email configuration.

Returns:

• (Types::EmailConfigurationType)

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

class UserPoolType < Struct.new(
  :id,
  :name,
  :policies,
  :lambda_config,
  :status,
  :last_modified_date,
  :creation_date,
  :schema_attributes,
  :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,
  :estimated_number_of_users,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :sms_configuration_failure,
  :email_configuration_failure,
  :domain,
  :custom_domain,
  :admin_create_user_config,
  :user_pool_add_ons,
  :arn)
  include Aws::Structure
end

#email_configuration_failure ⇒ String

The reason why the email configuration cannot send the messages to your users.

Returns:

• (String)

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

class UserPoolType < Struct.new(
  :id,
  :name,
  :policies,
  :lambda_config,
  :status,
  :last_modified_date,
  :creation_date,
  :schema_attributes,
  :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,
  :estimated_number_of_users,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :sms_configuration_failure,
  :email_configuration_failure,
  :domain,
  :custom_domain,
  :admin_create_user_config,
  :user_pool_add_ons,
  :arn)
  include Aws::Structure
end

#email_verification_message ⇒ String

The contents of the email verification message.

Returns:

• (String)

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

class UserPoolType < Struct.new(
  :id,
  :name,
  :policies,
  :lambda_config,
  :status,
  :last_modified_date,
  :creation_date,
  :schema_attributes,
  :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,
  :estimated_number_of_users,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :sms_configuration_failure,
  :email_configuration_failure,
  :domain,
  :custom_domain,
  :admin_create_user_config,
  :user_pool_add_ons,
  :arn)
  include Aws::Structure
end

#email_verification_subject ⇒ String

The subject of the email verification message.

Returns:

• (String)

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

class UserPoolType < Struct.new(
  :id,
  :name,
  :policies,
  :lambda_config,
  :status,
  :last_modified_date,
  :creation_date,
  :schema_attributes,
  :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,
  :estimated_number_of_users,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :sms_configuration_failure,
  :email_configuration_failure,
  :domain,
  :custom_domain,
  :admin_create_user_config,
  :user_pool_add_ons,
  :arn)
  include Aws::Structure
end

#estimated_number_of_users ⇒ Integer

A number estimating the size of the user pool.

Returns:

• (Integer)

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

class UserPoolType < Struct.new(
  :id,
  :name,
  :policies,
  :lambda_config,
  :status,
  :last_modified_date,
  :creation_date,
  :schema_attributes,
  :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,
  :estimated_number_of_users,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :sms_configuration_failure,
  :email_configuration_failure,
  :domain,
  :custom_domain,
  :admin_create_user_config,
  :user_pool_add_ons,
  :arn)
  include Aws::Structure
end

#id ⇒ String

The ID of the user pool.

Returns:

• (String)

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

class UserPoolType < Struct.new(
  :id,
  :name,
  :policies,
  :lambda_config,
  :status,
  :last_modified_date,
  :creation_date,
  :schema_attributes,
  :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,
  :estimated_number_of_users,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :sms_configuration_failure,
  :email_configuration_failure,
  :domain,
  :custom_domain,
  :admin_create_user_config,
  :user_pool_add_ons,
  :arn)
  include Aws::Structure
end

#lambda_config ⇒ Types::LambdaConfigType

The AWS Lambda triggers associated with the user pool.

Returns:

• (Types::LambdaConfigType)

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

class UserPoolType < Struct.new(
  :id,
  :name,
  :policies,
  :lambda_config,
  :status,
  :last_modified_date,
  :creation_date,
  :schema_attributes,
  :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,
  :estimated_number_of_users,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :sms_configuration_failure,
  :email_configuration_failure,
  :domain,
  :custom_domain,
  :admin_create_user_config,
  :user_pool_add_ons,
  :arn)
  include Aws::Structure
end

#last_modified_date ⇒ Time

The date the user pool was last modified.

Returns:

• (Time)

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

class UserPoolType < Struct.new(
  :id,
  :name,
  :policies,
  :lambda_config,
  :status,
  :last_modified_date,
  :creation_date,
  :schema_attributes,
  :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,
  :estimated_number_of_users,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :sms_configuration_failure,
  :email_configuration_failure,
  :domain,
  :custom_domain,
  :admin_create_user_config,
  :user_pool_add_ons,
  :arn)
  include Aws::Structure
end

#mfa_configuration ⇒ String

Can be one of the following values:

• OFF - MFA tokens are not required and cannot be specified during user registration.

• ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.

• OPTIONAL - Users have the option when registering to create an MFA token.

Returns:

• (String)

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

class UserPoolType < Struct.new(
  :id,
  :name,
  :policies,
  :lambda_config,
  :status,
  :last_modified_date,
  :creation_date,
  :schema_attributes,
  :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,
  :estimated_number_of_users,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :sms_configuration_failure,
  :email_configuration_failure,
  :domain,
  :custom_domain,
  :admin_create_user_config,
  :user_pool_add_ons,
  :arn)
  include Aws::Structure
end

#name ⇒ String

The name of the user pool.

Returns:

• (String)

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

class UserPoolType < Struct.new(
  :id,
  :name,
  :policies,
  :lambda_config,
  :status,
  :last_modified_date,
  :creation_date,
  :schema_attributes,
  :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,
  :estimated_number_of_users,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :sms_configuration_failure,
  :email_configuration_failure,
  :domain,
  :custom_domain,
  :admin_create_user_config,
  :user_pool_add_ons,
  :arn)
  include Aws::Structure
end

#policies ⇒ Types::UserPoolPolicyType

The policies associated with the user pool.

Returns:

• (Types::UserPoolPolicyType)

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

class UserPoolType < Struct.new(
  :id,
  :name,
  :policies,
  :lambda_config,
  :status,
  :last_modified_date,
  :creation_date,
  :schema_attributes,
  :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,
  :estimated_number_of_users,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :sms_configuration_failure,
  :email_configuration_failure,
  :domain,
  :custom_domain,
  :admin_create_user_config,
  :user_pool_add_ons,
  :arn)
  include Aws::Structure
end

#schema_attributes ⇒ Array<Types::SchemaAttributeType>

A container with the schema attributes of a user pool.

Returns:

• (Array<Types::SchemaAttributeType>)

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

class UserPoolType < Struct.new(
  :id,
  :name,
  :policies,
  :lambda_config,
  :status,
  :last_modified_date,
  :creation_date,
  :schema_attributes,
  :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,
  :estimated_number_of_users,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :sms_configuration_failure,
  :email_configuration_failure,
  :domain,
  :custom_domain,
  :admin_create_user_config,
  :user_pool_add_ons,
  :arn)
  include Aws::Structure
end

#sms_authentication_message ⇒ String

The contents of the SMS authentication message.

Returns:

• (String)

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

class UserPoolType < Struct.new(
  :id,
  :name,
  :policies,
  :lambda_config,
  :status,
  :last_modified_date,
  :creation_date,
  :schema_attributes,
  :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,
  :estimated_number_of_users,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :sms_configuration_failure,
  :email_configuration_failure,
  :domain,
  :custom_domain,
  :admin_create_user_config,
  :user_pool_add_ons,
  :arn)
  include Aws::Structure
end

#sms_configuration ⇒ Types::SmsConfigurationType

The SMS configuration.

Returns:

• (Types::SmsConfigurationType)

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

class UserPoolType < Struct.new(
  :id,
  :name,
  :policies,
  :lambda_config,
  :status,
  :last_modified_date,
  :creation_date,
  :schema_attributes,
  :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,
  :estimated_number_of_users,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :sms_configuration_failure,
  :email_configuration_failure,
  :domain,
  :custom_domain,
  :admin_create_user_config,
  :user_pool_add_ons,
  :arn)
  include Aws::Structure
end

#sms_configuration_failure ⇒ String

The reason why the SMS configuration cannot send the messages to your users.

Returns:

• (String)

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

class UserPoolType < Struct.new(
  :id,
  :name,
  :policies,
  :lambda_config,
  :status,
  :last_modified_date,
  :creation_date,
  :schema_attributes,
  :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,
  :estimated_number_of_users,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :sms_configuration_failure,
  :email_configuration_failure,
  :domain,
  :custom_domain,
  :admin_create_user_config,
  :user_pool_add_ons,
  :arn)
  include Aws::Structure
end

#sms_verification_message ⇒ String

The contents of the SMS verification message.

Returns:

• (String)

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

class UserPoolType < Struct.new(
  :id,
  :name,
  :policies,
  :lambda_config,
  :status,
  :last_modified_date,
  :creation_date,
  :schema_attributes,
  :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,
  :estimated_number_of_users,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :sms_configuration_failure,
  :email_configuration_failure,
  :domain,
  :custom_domain,
  :admin_create_user_config,
  :user_pool_add_ons,
  :arn)
  include Aws::Structure
end

#status ⇒ String

The status of a user pool.

Returns:

• (String)

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

class UserPoolType < Struct.new(
  :id,
  :name,
  :policies,
  :lambda_config,
  :status,
  :last_modified_date,
  :creation_date,
  :schema_attributes,
  :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,
  :estimated_number_of_users,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :sms_configuration_failure,
  :email_configuration_failure,
  :domain,
  :custom_domain,
  :admin_create_user_config,
  :user_pool_add_ons,
  :arn)
  include Aws::Structure
end

#user_pool_add_ons ⇒ Types::UserPoolAddOnsType

The user pool add-ons.

Returns:

• (Types::UserPoolAddOnsType)

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

class UserPoolType < Struct.new(
  :id,
  :name,
  :policies,
  :lambda_config,
  :status,
  :last_modified_date,
  :creation_date,
  :schema_attributes,
  :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,
  :estimated_number_of_users,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :sms_configuration_failure,
  :email_configuration_failure,
  :domain,
  :custom_domain,
  :admin_create_user_config,
  :user_pool_add_ons,
  :arn)
  include Aws::Structure
end

#user_pool_tags ⇒ Hash<String,String>

The tags that are assigned to the user pool. A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

Returns:

• (Hash<String,String>)

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

class UserPoolType < Struct.new(
  :id,
  :name,
  :policies,
  :lambda_config,
  :status,
  :last_modified_date,
  :creation_date,
  :schema_attributes,
  :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,
  :estimated_number_of_users,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :sms_configuration_failure,
  :email_configuration_failure,
  :domain,
  :custom_domain,
  :admin_create_user_config,
  :user_pool_add_ons,
  :arn)
  include Aws::Structure
end

#username_attributes ⇒ Array<String>

Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.

Returns:

• (Array<String>)

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

class UserPoolType < Struct.new(
  :id,
  :name,
  :policies,
  :lambda_config,
  :status,
  :last_modified_date,
  :creation_date,
  :schema_attributes,
  :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,
  :estimated_number_of_users,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :sms_configuration_failure,
  :email_configuration_failure,
  :domain,
  :custom_domain,
  :admin_create_user_config,
  :user_pool_add_ons,
  :arn)
  include Aws::Structure
end

#verification_message_template ⇒ Types::VerificationMessageTemplateType

The template for verification messages.

Returns:

• (Types::VerificationMessageTemplateType)

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

class UserPoolType < Struct.new(
  :id,
  :name,
  :policies,
  :lambda_config,
  :status,
  :last_modified_date,
  :creation_date,
  :schema_attributes,
  :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,
  :estimated_number_of_users,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :sms_configuration_failure,
  :email_configuration_failure,
  :domain,
  :custom_domain,
  :admin_create_user_config,
  :user_pool_add_ons,
  :arn)
  include Aws::Structure
end