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
show all
Defined in:
gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

A container for information about the user pool type.

Instance Attribute Summary collapse

Instance Attribute Details

#admin_create_user_configTypes::AdminCreateUserConfigType

The configuration for AdminCreateUser requests.



5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5840

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,
  :admin_create_user_config)
  include Aws::Structure
end

#alias_attributesArray<String>

Specifies the attributes that are aliased in a user pool.

Returns:

  • (Array<String>)


5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5840

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,
  :admin_create_user_config)
  include Aws::Structure
end

#auto_verified_attributesArray<String>

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

Returns:

  • (Array<String>)


5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5840

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,
  :admin_create_user_config)
  include Aws::Structure
end

#creation_dateTime

The date the user pool was created.

Returns:

  • (Time)


5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5840

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,
  :admin_create_user_config)
  include Aws::Structure
end

#device_configurationTypes::DeviceConfigurationType

The device configuration.



5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5840

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,
  :admin_create_user_config)
  include Aws::Structure
end

#email_configurationTypes::EmailConfigurationType

The email configuration.



5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5840

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,
  :admin_create_user_config)
  include Aws::Structure
end

#email_configuration_failureString

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

Returns:

  • (String)


5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5840

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,
  :admin_create_user_config)
  include Aws::Structure
end

#email_verification_messageString

The contents of the email verification message.

Returns:

  • (String)


5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5840

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,
  :admin_create_user_config)
  include Aws::Structure
end

#email_verification_subjectString

The subject of the email verification message.

Returns:

  • (String)


5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5840

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,
  :admin_create_user_config)
  include Aws::Structure
end

#estimated_number_of_usersInteger

A number estimating the size of the user pool.

Returns:

  • (Integer)


5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5840

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,
  :admin_create_user_config)
  include Aws::Structure
end

#idString

The ID of the user pool.

Returns:

  • (String)


5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5840

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,
  :admin_create_user_config)
  include Aws::Structure
end

#lambda_configTypes::LambdaConfigType

A container for the AWS Lambda triggers associated with a user pool.



5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5840

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,
  :admin_create_user_config)
  include Aws::Structure
end

#last_modified_dateTime

The date the user pool was last modified.

Returns:

  • (Time)


5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5840

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,
  :admin_create_user_config)
  include Aws::Structure
end

#mfa_configurationString

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)


5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5840

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,
  :admin_create_user_config)
  include Aws::Structure
end

#nameString

The name of the user pool.

Returns:

  • (String)


5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5840

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,
  :admin_create_user_config)
  include Aws::Structure
end

#policiesTypes::UserPoolPolicyType

A container for the policies associated with a user pool.



5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5840

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,
  :admin_create_user_config)
  include Aws::Structure
end

#schema_attributesArray<Types::SchemaAttributeType>

A container with the schema attributes of a user pool.

Returns:



5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5840

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,
  :admin_create_user_config)
  include Aws::Structure
end

#sms_authentication_messageString

The contents of the SMS authentication message.

Returns:

  • (String)


5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5840

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,
  :admin_create_user_config)
  include Aws::Structure
end

#sms_configurationTypes::SmsConfigurationType

The SMS configuration.



5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5840

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,
  :admin_create_user_config)
  include Aws::Structure
end

#sms_configuration_failureString

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

Returns:

  • (String)


5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5840

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,
  :admin_create_user_config)
  include Aws::Structure
end

#sms_verification_messageString

The contents of the SMS verification message.

Returns:

  • (String)


5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5840

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,
  :admin_create_user_config)
  include Aws::Structure
end

#statusString

The status of a user pool.

Returns:

  • (String)


5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5840

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,
  :admin_create_user_config)
  include Aws::Structure
end

#user_pool_tagsHash<String,String>

The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool

Returns:

  • (Hash<String,String>)


5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5840

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,
  :admin_create_user_config)
  include Aws::Structure
end

#username_attributesArray<String>

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

Returns:

  • (Array<String>)


5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5840

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,
  :admin_create_user_config)
  include Aws::Structure
end

#verification_message_templateTypes::VerificationMessageTemplateType

The template for verification messages.



5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5840

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,
  :admin_create_user_config)
  include Aws::Structure
end