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.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#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>
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>
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
The domain prefix, if the user pool has a domain associated with it.
-
#email_configuration ⇒ Types::EmailConfigurationType
The email configuration of your user pool.
-
#email_configuration_failure ⇒ String
Deprecated.
-
#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 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 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_configuration_failure ⇒ String
The reason why the SMS configuration can't 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 a user can use an email address or phone number as a username when they sign up.
-
#username_configuration ⇒ Types::UsernameConfigurationType
Case sensitivity of the username input for the selected sign-in option.
-
#verification_message_template ⇒ Types::VerificationMessageTemplateType
The template for verification messages.
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.
10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10667 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, :username_configuration, :arn, :account_recovery_setting) SENSITIVE = [] include Aws::Structure end |
#admin_create_user_config ⇒ Types::AdminCreateUserConfigType
The configuration for AdminCreateUser
requests.
10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10667 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, :username_configuration, :arn, :account_recovery_setting) SENSITIVE = [] include Aws::Structure end |
#alias_attributes ⇒ Array<String>
The attributes that are aliased in a user pool.
10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10667 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, :username_configuration, :arn, :account_recovery_setting) SENSITIVE = [] include Aws::Structure end |
#arn ⇒ String
The Amazon Resource Name (ARN) for the user pool.
10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10667 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, :username_configuration, :arn, :account_recovery_setting) SENSITIVE = [] include Aws::Structure end |
#auto_verified_attributes ⇒ Array<String>
The attributes that are auto-verified in a user pool.
10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10667 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, :username_configuration, :arn, :account_recovery_setting) SENSITIVE = [] include Aws::Structure end |
#creation_date ⇒ Time
The date the user pool was created.
10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10667 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, :username_configuration, :arn, :account_recovery_setting) SENSITIVE = [] 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. An example of a
custom domain name might be auth.example.com
.
For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10667 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, :username_configuration, :arn, :account_recovery_setting) SENSITIVE = [] include Aws::Structure end |
#device_configuration ⇒ Types::DeviceConfigurationType
The device configuration.
10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10667 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, :username_configuration, :arn, :account_recovery_setting) SENSITIVE = [] include Aws::Structure end |
#domain ⇒ String
The domain prefix, if the user pool has a domain associated with it.
10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10667 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, :username_configuration, :arn, :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 tfrom your user pool.
10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10667 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, :username_configuration, :arn, :account_recovery_setting) SENSITIVE = [] include Aws::Structure end |
#email_configuration_failure ⇒ String
Deprecated. Review error codes from API requests with
EventSource:cognito-idp.amazonaws.com
in CloudTrail for
information about problems with user pool email configuration.
10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10667 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, :username_configuration, :arn, :account_recovery_setting) SENSITIVE = [] include Aws::Structure end |
#email_verification_message ⇒ String
The contents of the email verification message.
10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10667 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, :username_configuration, :arn, :account_recovery_setting) SENSITIVE = [] include Aws::Structure end |
#email_verification_subject ⇒ String
The subject of the email verification message.
10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10667 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, :username_configuration, :arn, :account_recovery_setting) SENSITIVE = [] include Aws::Structure end |
#estimated_number_of_users ⇒ Integer
A number estimating the size of the user pool.
10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10667 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, :username_configuration, :arn, :account_recovery_setting) SENSITIVE = [] include Aws::Structure end |
#id ⇒ String
The ID of the user pool.
10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10667 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, :username_configuration, :arn, :account_recovery_setting) SENSITIVE = [] include Aws::Structure end |
#lambda_config ⇒ Types::LambdaConfigType
The Lambda triggers associated with the user pool.
10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10667 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, :username_configuration, :arn, :account_recovery_setting) SENSITIVE = [] include Aws::Structure end |
#last_modified_date ⇒ Time
The date the user pool was last modified.
10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10667 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, :username_configuration, :arn, :account_recovery_setting) SENSITIVE = [] include Aws::Structure end |
#mfa_configuration ⇒ String
Can be one of the following values:
OFF
- MFA tokens aren't required and can't be specified during user registration.ON
- MFA tokens are required for all user registrations. You can only specify required when you're initially creating a user pool.OPTIONAL
- Users have the option when registering to create an MFA token.
10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10667 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, :username_configuration, :arn, :account_recovery_setting) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The name of the user pool.
10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10667 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, :username_configuration, :arn, :account_recovery_setting) SENSITIVE = [] include Aws::Structure end |
#policies ⇒ Types::UserPoolPolicyType
The policies associated with the user pool.
10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10667 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, :username_configuration, :arn, :account_recovery_setting) SENSITIVE = [] include Aws::Structure end |
#schema_attributes ⇒ Array<Types::SchemaAttributeType>
A container with the schema attributes of a user pool.
10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10667 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, :username_configuration, :arn, :account_recovery_setting) SENSITIVE = [] include Aws::Structure end |
#sms_authentication_message ⇒ String
The contents of the SMS authentication message.
10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10667 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, :username_configuration, :arn, :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.
10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10667 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, :username_configuration, :arn, :account_recovery_setting) SENSITIVE = [] include Aws::Structure end |
#sms_configuration_failure ⇒ String
The reason why the SMS configuration can't send the messages to your users.
This message might include comma-separated values to describe why your SMS configuration can't send messages to user pool end users.
- InvalidSmsRoleAccessPolicyException
The Identity and Access Management role that Amazon Cognito uses to send SMS messages isn't properly configured. For more information, see SmsConfigurationType.
- SNSSandbox
The Amazon Web Services account is in the SNS SMS Sandbox and messages will only reach verified end users. This parameter won’t get populated with SNSSandbox if the IAM user creating the user pool doesn’t have SNS permissions. To learn how to move your Amazon Web Services account out of the sandbox, see Moving out of the SMS sandbox.
10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10667 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, :username_configuration, :arn, :account_recovery_setting) SENSITIVE = [] include Aws::Structure end |
#sms_verification_message ⇒ String
The contents of the SMS verification message.
10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10667 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, :username_configuration, :arn, :account_recovery_setting) SENSITIVE = [] include Aws::Structure end |
#status ⇒ String
The status of a user pool.
10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10667 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, :username_configuration, :arn, :account_recovery_setting) SENSITIVE = [] include Aws::Structure end |
#user_pool_add_ons ⇒ Types::UserPoolAddOnsType
The user pool add-ons.
10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10667 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, :username_configuration, :arn, :account_recovery_setting) SENSITIVE = [] 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.
10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10667 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, :username_configuration, :arn, :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.
10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10667 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, :username_configuration, :arn, :account_recovery_setting) SENSITIVE = [] include Aws::Structure end |
#username_configuration ⇒ Types::UsernameConfigurationType
Case sensitivity of 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.
10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10667 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, :username_configuration, :arn, :account_recovery_setting) SENSITIVE = [] include Aws::Structure end |
#verification_message_template ⇒ Types::VerificationMessageTemplateType
The template for verification messages.
10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10667 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, :username_configuration, :arn, :account_recovery_setting) SENSITIVE = [] include Aws::Structure end |