Class: Aws::CognitoIdentityProvider::Types::UpdateUserPoolRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::CognitoIdentityProvider::Types::UpdateUserPoolRequest
- Defined in:
- gems/aws-sdk-cognitoidentityprovider/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.
-
#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.
-
#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.
9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9441 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) SENSITIVE = [] include Aws::Structure end |
#admin_create_user_config ⇒ Types::AdminCreateUserConfigType
The configuration for AdminCreateUser
requests.
9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9441 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) SENSITIVE = [] include Aws::Structure end |
#auto_verified_attributes ⇒ Array<String>
The attributes that are automatically verified when Amazon Cognito requests to update user pools.
9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9441 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) 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.
9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9441 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) 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.
DeviceConfiguration
field, you
activate the Amazon Cognito device-remembering feature.
9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9441 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) 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.
9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9441 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) SENSITIVE = [] include Aws::Structure end |
#email_verification_message ⇒ String
This parameter is no longer used. See VerificationMessageTemplateType.
9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9441 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) SENSITIVE = [] include Aws::Structure end |
#email_verification_subject ⇒ String
This parameter is no longer used. See VerificationMessageTemplateType.
9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9441 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) SENSITIVE = [] include Aws::Structure end |
#lambda_config ⇒ Types::LambdaConfigType
The Lambda configuration information from the request to update the user pool.
9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9441 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) 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.
9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9441 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) SENSITIVE = [] include Aws::Structure end |
#policies ⇒ Types::UserPoolPolicyType
A container with the policies you want to update in a user pool.
9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9441 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) SENSITIVE = [] include Aws::Structure end |
#sms_authentication_message ⇒ String
The contents of the SMS authentication message.
9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9441 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) 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.
9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9441 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) SENSITIVE = [] include Aws::Structure end |
#sms_verification_message ⇒ String
This parameter is no longer used. See VerificationMessageTemplateType.
9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9441 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) 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.
9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9441 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) 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.
9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9441 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) SENSITIVE = [] include Aws::Structure end |
#user_pool_id ⇒ String
The user pool ID for the user pool you want to update.
9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9441 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) 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.
9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9441 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) SENSITIVE = [] include Aws::Structure end |
#verification_message_template ⇒ Types::VerificationMessageTemplateType
The template for verification messages.
9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9441 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) SENSITIVE = [] include Aws::Structure end |