Class: Aws::CognitoIdentityProvider::Types::UpdateUserPoolRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::CognitoIdentityProvider::Types::UpdateUserPoolRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-cognitoidentityprovider/types.rb
Overview
Represents the request to update 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.
-
#auto_verified_attributes ⇒ Array<String>
The attributes that are automatically verified when Amazon Cognito requests to update user pools.
-
#deletion_protection ⇒ String
When active, ‘DeletionProtection` prevents accidental deletion of your user pool.
-
#device_configuration ⇒ Types::DeviceConfigurationType
The device-remembering configuration for a user pool.
-
#email_configuration ⇒ Types::EmailConfigurationType
The email configuration of your user pool.
-
#email_verification_message ⇒ String
This parameter is no longer used.
-
#email_verification_subject ⇒ String
This parameter is no longer used.
-
#lambda_config ⇒ Types::LambdaConfigType
The Lambda configuration information from the request to update the user pool.
-
#mfa_configuration ⇒ String
Possible values include:.
-
#policies ⇒ Types::UserPoolPolicyType
A container with the policies you want to update in a user pool.
-
#pool_name ⇒ String
The updated name of your 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_verification_message ⇒ String
This parameter is no longer used.
-
#user_attribute_update_settings ⇒ Types::UserAttributeUpdateSettingsType
The settings for updates to user attributes.
-
#user_pool_add_ons ⇒ Types::UserPoolAddOnsType
User pool add-ons.
-
#user_pool_id ⇒ String
The user pool ID for the user pool you want to update.
-
#user_pool_tags ⇒ Hash<String,String>
The tag keys and values to assign to the user pool.
-
#user_pool_tier ⇒ String
The user pool [feature plan], or tier.
-
#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.
11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 11604 class UpdateUserPoolRequest < Struct.new( :user_pool_id, :policies, :deletion_protection, :lambda_config, :auto_verified_attributes, :sms_verification_message, :email_verification_message, :email_verification_subject, :verification_message_template, :sms_authentication_message, :user_attribute_update_settings, :mfa_configuration, :device_configuration, :email_configuration, :sms_configuration, :user_pool_tags, :admin_create_user_config, :user_pool_add_ons, :account_recovery_setting, :pool_name, :user_pool_tier) SENSITIVE = [] include Aws::Structure end |
#admin_create_user_config ⇒ Types::AdminCreateUserConfigType
The configuration for ‘AdminCreateUser` requests.
11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 11604 class UpdateUserPoolRequest < Struct.new( :user_pool_id, :policies, :deletion_protection, :lambda_config, :auto_verified_attributes, :sms_verification_message, :email_verification_message, :email_verification_subject, :verification_message_template, :sms_authentication_message, :user_attribute_update_settings, :mfa_configuration, :device_configuration, :email_configuration, :sms_configuration, :user_pool_tags, :admin_create_user_config, :user_pool_add_ons, :account_recovery_setting, :pool_name, :user_pool_tier) SENSITIVE = [] include Aws::Structure end |
#auto_verified_attributes ⇒ Array<String>
The attributes that are automatically verified when Amazon Cognito requests to update user pools.
11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 11604 class UpdateUserPoolRequest < Struct.new( :user_pool_id, :policies, :deletion_protection, :lambda_config, :auto_verified_attributes, :sms_verification_message, :email_verification_message, :email_verification_subject, :verification_message_template, :sms_authentication_message, :user_attribute_update_settings, :mfa_configuration, :device_configuration, :email_configuration, :sms_configuration, :user_pool_tags, :admin_create_user_config, :user_pool_add_ons, :account_recovery_setting, :pool_name, :user_pool_tier) SENSITIVE = [] include Aws::Structure end |
#deletion_protection ⇒ String
When active, ‘DeletionProtection` prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.
When you try to delete a protected user pool in a ‘DeleteUserPool` API request, Amazon Cognito returns an `InvalidParameterException` error. To delete a protected user pool, send a new `DeleteUserPool` request after you deactivate deletion protection in an `UpdateUserPool` API request.
11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 11604 class UpdateUserPoolRequest < Struct.new( :user_pool_id, :policies, :deletion_protection, :lambda_config, :auto_verified_attributes, :sms_verification_message, :email_verification_message, :email_verification_subject, :verification_message_template, :sms_authentication_message, :user_attribute_update_settings, :mfa_configuration, :device_configuration, :email_configuration, :sms_configuration, :user_pool_tags, :admin_create_user_config, :user_pool_add_ons, :account_recovery_setting, :pool_name, :user_pool_tier) SENSITIVE = [] include Aws::Structure end |
#device_configuration ⇒ Types::DeviceConfigurationType
The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
<note markdown=“1”> When you provide a value for any ‘DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature.
</note>
11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 11604 class UpdateUserPoolRequest < Struct.new( :user_pool_id, :policies, :deletion_protection, :lambda_config, :auto_verified_attributes, :sms_verification_message, :email_verification_message, :email_verification_subject, :verification_message_template, :sms_authentication_message, :user_attribute_update_settings, :mfa_configuration, :device_configuration, :email_configuration, :sms_configuration, :user_pool_tags, :admin_create_user_config, :user_pool_add_ons, :account_recovery_setting, :pool_name, :user_pool_tier) SENSITIVE = [] include Aws::Structure end |
#email_configuration ⇒ Types::EmailConfigurationType
The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for email invitation and verification messages from your user pool.
11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 11604 class UpdateUserPoolRequest < Struct.new( :user_pool_id, :policies, :deletion_protection, :lambda_config, :auto_verified_attributes, :sms_verification_message, :email_verification_message, :email_verification_subject, :verification_message_template, :sms_authentication_message, :user_attribute_update_settings, :mfa_configuration, :device_configuration, :email_configuration, :sms_configuration, :user_pool_tags, :admin_create_user_config, :user_pool_add_ons, :account_recovery_setting, :pool_name, :user_pool_tier) SENSITIVE = [] include Aws::Structure end |
#email_verification_message ⇒ String
This parameter is no longer used. See [VerificationMessageTemplateType].
11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 11604 class UpdateUserPoolRequest < Struct.new( :user_pool_id, :policies, :deletion_protection, :lambda_config, :auto_verified_attributes, :sms_verification_message, :email_verification_message, :email_verification_subject, :verification_message_template, :sms_authentication_message, :user_attribute_update_settings, :mfa_configuration, :device_configuration, :email_configuration, :sms_configuration, :user_pool_tags, :admin_create_user_config, :user_pool_add_ons, :account_recovery_setting, :pool_name, :user_pool_tier) SENSITIVE = [] include Aws::Structure end |
#email_verification_subject ⇒ String
This parameter is no longer used. See [VerificationMessageTemplateType].
11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 11604 class UpdateUserPoolRequest < Struct.new( :user_pool_id, :policies, :deletion_protection, :lambda_config, :auto_verified_attributes, :sms_verification_message, :email_verification_message, :email_verification_subject, :verification_message_template, :sms_authentication_message, :user_attribute_update_settings, :mfa_configuration, :device_configuration, :email_configuration, :sms_configuration, :user_pool_tags, :admin_create_user_config, :user_pool_add_ons, :account_recovery_setting, :pool_name, :user_pool_tier) SENSITIVE = [] include Aws::Structure end |
#lambda_config ⇒ Types::LambdaConfigType
The Lambda configuration information from the request to update the user pool.
11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 11604 class UpdateUserPoolRequest < Struct.new( :user_pool_id, :policies, :deletion_protection, :lambda_config, :auto_verified_attributes, :sms_verification_message, :email_verification_message, :email_verification_subject, :verification_message_template, :sms_authentication_message, :user_attribute_update_settings, :mfa_configuration, :device_configuration, :email_configuration, :sms_configuration, :user_pool_tags, :admin_create_user_config, :user_pool_add_ons, :account_recovery_setting, :pool_name, :user_pool_tier) SENSITIVE = [] include Aws::Structure end |
#mfa_configuration ⇒ String
Possible values include:
-
‘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 ON when you’re initially creating a user pool. You can use the [SetUserPoolMfaConfig] API operation to turn MFA “ON” for existing user pools.
-
‘OPTIONAL` - Users have the option when registering to create an MFA token.
[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html
11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 11604 class UpdateUserPoolRequest < Struct.new( :user_pool_id, :policies, :deletion_protection, :lambda_config, :auto_verified_attributes, :sms_verification_message, :email_verification_message, :email_verification_subject, :verification_message_template, :sms_authentication_message, :user_attribute_update_settings, :mfa_configuration, :device_configuration, :email_configuration, :sms_configuration, :user_pool_tags, :admin_create_user_config, :user_pool_add_ons, :account_recovery_setting, :pool_name, :user_pool_tier) SENSITIVE = [] include Aws::Structure end |
#policies ⇒ Types::UserPoolPolicyType
A container with the policies you want to update in a user pool.
11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 11604 class UpdateUserPoolRequest < Struct.new( :user_pool_id, :policies, :deletion_protection, :lambda_config, :auto_verified_attributes, :sms_verification_message, :email_verification_message, :email_verification_subject, :verification_message_template, :sms_authentication_message, :user_attribute_update_settings, :mfa_configuration, :device_configuration, :email_configuration, :sms_configuration, :user_pool_tags, :admin_create_user_config, :user_pool_add_ons, :account_recovery_setting, :pool_name, :user_pool_tier) SENSITIVE = [] include Aws::Structure end |
#pool_name ⇒ String
The updated name of your user pool.
11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 11604 class UpdateUserPoolRequest < Struct.new( :user_pool_id, :policies, :deletion_protection, :lambda_config, :auto_verified_attributes, :sms_verification_message, :email_verification_message, :email_verification_subject, :verification_message_template, :sms_authentication_message, :user_attribute_update_settings, :mfa_configuration, :device_configuration, :email_configuration, :sms_configuration, :user_pool_tags, :admin_create_user_config, :user_pool_add_ons, :account_recovery_setting, :pool_name, :user_pool_tier) SENSITIVE = [] include Aws::Structure end |
#sms_authentication_message ⇒ String
The contents of the SMS authentication message.
11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 11604 class UpdateUserPoolRequest < Struct.new( :user_pool_id, :policies, :deletion_protection, :lambda_config, :auto_verified_attributes, :sms_verification_message, :email_verification_message, :email_verification_subject, :verification_message_template, :sms_authentication_message, :user_attribute_update_settings, :mfa_configuration, :device_configuration, :email_configuration, :sms_configuration, :user_pool_tags, :admin_create_user_config, :user_pool_add_ons, :account_recovery_setting, :pool_name, :user_pool_tier) SENSITIVE = [] include Aws::Structure end |
#sms_configuration ⇒ Types::SmsConfigurationType
The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 11604 class UpdateUserPoolRequest < Struct.new( :user_pool_id, :policies, :deletion_protection, :lambda_config, :auto_verified_attributes, :sms_verification_message, :email_verification_message, :email_verification_subject, :verification_message_template, :sms_authentication_message, :user_attribute_update_settings, :mfa_configuration, :device_configuration, :email_configuration, :sms_configuration, :user_pool_tags, :admin_create_user_config, :user_pool_add_ons, :account_recovery_setting, :pool_name, :user_pool_tier) SENSITIVE = [] include Aws::Structure end |
#sms_verification_message ⇒ String
This parameter is no longer used. See [VerificationMessageTemplateType].
11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 11604 class UpdateUserPoolRequest < Struct.new( :user_pool_id, :policies, :deletion_protection, :lambda_config, :auto_verified_attributes, :sms_verification_message, :email_verification_message, :email_verification_subject, :verification_message_template, :sms_authentication_message, :user_attribute_update_settings, :mfa_configuration, :device_configuration, :email_configuration, :sms_configuration, :user_pool_tags, :admin_create_user_config, :user_pool_add_ons, :account_recovery_setting, :pool_name, :user_pool_tier) SENSITIVE = [] include Aws::Structure end |
#user_attribute_update_settings ⇒ Types::UserAttributeUpdateSettingsType
The settings for updates to user attributes. These settings include the property ‘AttributesRequireVerificationBeforeUpdate`, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users’ email address and phone number attributes. For more information, see [ Verifying updates to email addresses and phone numbers].
11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 11604 class UpdateUserPoolRequest < Struct.new( :user_pool_id, :policies, :deletion_protection, :lambda_config, :auto_verified_attributes, :sms_verification_message, :email_verification_message, :email_verification_subject, :verification_message_template, :sms_authentication_message, :user_attribute_update_settings, :mfa_configuration, :device_configuration, :email_configuration, :sms_configuration, :user_pool_tags, :admin_create_user_config, :user_pool_add_ons, :account_recovery_setting, :pool_name, :user_pool_tier) SENSITIVE = [] include Aws::Structure end |
#user_pool_add_ons ⇒ Types::UserPoolAddOnsType
User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to ‘AUDIT`. To configure automatic security responses to risky traffic to your user pool, set to `ENFORCED`.
For more information, see [Adding advanced security to a user pool].
[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html
11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 11604 class UpdateUserPoolRequest < Struct.new( :user_pool_id, :policies, :deletion_protection, :lambda_config, :auto_verified_attributes, :sms_verification_message, :email_verification_message, :email_verification_subject, :verification_message_template, :sms_authentication_message, :user_attribute_update_settings, :mfa_configuration, :device_configuration, :email_configuration, :sms_configuration, :user_pool_tags, :admin_create_user_config, :user_pool_add_ons, :account_recovery_setting, :pool_name, :user_pool_tier) SENSITIVE = [] include Aws::Structure end |
#user_pool_id ⇒ String
The user pool ID for the user pool you want to update.
11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 11604 class UpdateUserPoolRequest < Struct.new( :user_pool_id, :policies, :deletion_protection, :lambda_config, :auto_verified_attributes, :sms_verification_message, :email_verification_message, :email_verification_subject, :verification_message_template, :sms_authentication_message, :user_attribute_update_settings, :mfa_configuration, :device_configuration, :email_configuration, :sms_configuration, :user_pool_tags, :admin_create_user_config, :user_pool_add_ons, :account_recovery_setting, :pool_name, :user_pool_tier) SENSITIVE = [] include Aws::Structure end |
#user_pool_tags ⇒ Hash<String,String>
The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 11604 class UpdateUserPoolRequest < Struct.new( :user_pool_id, :policies, :deletion_protection, :lambda_config, :auto_verified_attributes, :sms_verification_message, :email_verification_message, :email_verification_subject, :verification_message_template, :sms_authentication_message, :user_attribute_update_settings, :mfa_configuration, :device_configuration, :email_configuration, :sms_configuration, :user_pool_tags, :admin_create_user_config, :user_pool_add_ons, :account_recovery_setting, :pool_name, :user_pool_tier) SENSITIVE = [] include Aws::Structure end |
#user_pool_tier ⇒ String
The user pool [feature plan], or tier. This parameter determines the eligibility of the user pool for features like managed login, access-token customization, and threat protection. Defaults to ‘ESSENTIALS`.
[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-sign-in-feature-plans.html
11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 11604 class UpdateUserPoolRequest < Struct.new( :user_pool_id, :policies, :deletion_protection, :lambda_config, :auto_verified_attributes, :sms_verification_message, :email_verification_message, :email_verification_subject, :verification_message_template, :sms_authentication_message, :user_attribute_update_settings, :mfa_configuration, :device_configuration, :email_configuration, :sms_configuration, :user_pool_tags, :admin_create_user_config, :user_pool_add_ons, :account_recovery_setting, :pool_name, :user_pool_tier) SENSITIVE = [] include Aws::Structure end |
#verification_message_template ⇒ Types::VerificationMessageTemplateType
The template for verification messages.
11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 11604 class UpdateUserPoolRequest < Struct.new( :user_pool_id, :policies, :deletion_protection, :lambda_config, :auto_verified_attributes, :sms_verification_message, :email_verification_message, :email_verification_subject, :verification_message_template, :sms_authentication_message, :user_attribute_update_settings, :mfa_configuration, :device_configuration, :email_configuration, :sms_configuration, :user_pool_tags, :admin_create_user_config, :user_pool_add_ons, :account_recovery_setting, :pool_name, :user_pool_tier) SENSITIVE = [] include Aws::Structure end |