Class: Aws::CognitoIdentityProvider::Types::UpdateUserPoolRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::CognitoIdentityProvider::Types::UpdateUserPoolRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-cognitoidentityprovider/types.rb
Overview
When making an API call, you may pass UpdateUserPoolRequest data as a hash:
{
user_pool_id: "UserPoolIdType", # required
policies: {
password_policy: {
minimum_length: 1,
require_uppercase: false,
require_lowercase: false,
require_numbers: false,
require_symbols: false,
temporary_password_validity_days: 1,
},
},
deletion_protection: "ACTIVE", # accepts ACTIVE, INACTIVE
lambda_config: {
pre_sign_up: "ArnType",
custom_message: "ArnType",
post_confirmation: "ArnType",
pre_authentication: "ArnType",
post_authentication: "ArnType",
define_auth_challenge: "ArnType",
create_auth_challenge: "ArnType",
verify_auth_challenge_response: "ArnType",
pre_token_generation: "ArnType",
user_migration: "ArnType",
custom_sms_sender: {
lambda_version: "V1_0", # required, accepts V1_0
lambda_arn: "ArnType", # required
},
custom_email_sender: {
lambda_version: "V1_0", # required, accepts V1_0
lambda_arn: "ArnType", # required
},
kms_key_id: "ArnType",
},
auto_verified_attributes: ["phone_number"], # accepts phone_number, email
sms_verification_message: "SmsVerificationMessageType",
email_verification_message: "EmailVerificationMessageType",
email_verification_subject: "EmailVerificationSubjectType",
verification_message_template: {
sms_message: "SmsVerificationMessageType",
email_message: "EmailVerificationMessageType",
email_subject: "EmailVerificationSubjectType",
email_message_by_link: "EmailVerificationMessageByLinkType",
email_subject_by_link: "EmailVerificationSubjectByLinkType",
default_email_option: "CONFIRM_WITH_LINK", # accepts CONFIRM_WITH_LINK, CONFIRM_WITH_CODE
},
sms_authentication_message: "SmsVerificationMessageType",
user_attribute_update_settings: {
attributes_require_verification_before_update: ["phone_number"], # accepts phone_number, email
},
mfa_configuration: "OFF", # accepts OFF, ON, OPTIONAL
device_configuration: {
challenge_required_on_new_device: false,
device_only_remembered_on_user_prompt: false,
},
email_configuration: {
source_arn: "ArnType",
reply_to_email_address: "EmailAddressType",
email_sending_account: "COGNITO_DEFAULT", # accepts COGNITO_DEFAULT, DEVELOPER
from: "StringType",
configuration_set: "SESConfigurationSet",
},
sms_configuration: {
sns_caller_arn: "ArnType", # required
external_id: "StringType",
sns_region: "RegionCodeType",
},
user_pool_tags: {
"TagKeysType" => "TagValueType",
},
admin_create_user_config: {
allow_admin_create_user_only: false,
unused_account_validity_days: 1,
invite_message_template: {
sms_message: "SmsVerificationMessageType",
email_message: "EmailVerificationMessageType",
email_subject: "EmailVerificationSubjectType",
},
},
user_pool_add_ons: {
advanced_security_mode: "OFF", # required, accepts OFF, AUDIT, ENFORCED
},
account_recovery_setting: {
recovery_mechanisms: [
{
priority: 1, # required
name: "verified_email", # required, accepts verified_email, verified_phone_number, admin_only
},
],
},
}
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
Enables advanced security risk detection.
-
#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.
10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10313 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.
10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10313 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.
10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10313 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.
10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10313 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.
<note markdown=“1”> When you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature.
</note>
10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10313 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.
10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10313 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].
10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10313 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].
10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10313 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.
10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10313 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.
[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html
10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10313 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.
10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10313 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.
10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10313 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.
10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10313 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].
10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10313 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].
10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10313 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
Enables advanced security risk detection. Set the key `AdvancedSecurityMode` to the value “AUDIT”.
10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10313 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.
10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10313 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.
10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10313 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.
10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10313 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 |