Class: Aws::CognitoIdentityProvider::Types::UpdateUserPoolRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Note:

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,
    },
  },
  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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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.

Returns:



10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10143

class UpdateUserPoolRequest < Struct.new(
  :user_pool_id,
  :policies,
  :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.

Returns:



10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10143

class UpdateUserPoolRequest < Struct.new(
  :user_pool_id,
  :policies,
  :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.

Returns:

  • (Array<String>) 


10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10143

class UpdateUserPoolRequest < Struct.new(
  :user_pool_id,
  :policies,
  :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

Device configuration.

Returns:



10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10143

class UpdateUserPoolRequest < Struct.new(
  :user_pool_id,
  :policies,
  :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.

Returns:



10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10143

class UpdateUserPoolRequest < Struct.new(
  :user_pool_id,
  :policies,
  :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

The contents of the email verification message.

Returns:

  • (String) 


10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10143

class UpdateUserPoolRequest < Struct.new(
  :user_pool_id,
  :policies,
  :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

The subject of the email verification message.

Returns:

  • (String) 


10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10143

class UpdateUserPoolRequest < Struct.new(
  :user_pool_id,
  :policies,
  :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.

Returns:



10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10143

class UpdateUserPoolRequest < Struct.new(
  :user_pool_id,
  :policies,
  :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

Returns:

  • (String) 


10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10143

class UpdateUserPoolRequest < Struct.new(
  :user_pool_id,
  :policies,
  :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.

Returns:



10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10143

class UpdateUserPoolRequest < Struct.new(
  :user_pool_id,
  :policies,
  :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.

Returns:

  • (String) 


10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10143

class UpdateUserPoolRequest < Struct.new(
  :user_pool_id,
  :policies,
  :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.

Returns:



10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10143

class UpdateUserPoolRequest < Struct.new(
  :user_pool_id,
  :policies,
  :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

A container with information about the SMS verification message.

Returns:

  • (String) 


10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10143

class UpdateUserPoolRequest < Struct.new(
  :user_pool_id,
  :policies,
  :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 to email addresses and phone numbers].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates

Returns:



10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10143

class UpdateUserPoolRequest < Struct.new(
  :user_pool_id,
  :policies,
  :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”.

Returns:



10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10143

class UpdateUserPoolRequest < Struct.new(
  :user_pool_id,
  :policies,
  :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.

Returns:

  • (String) 


10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10143

class UpdateUserPoolRequest < Struct.new(
  :user_pool_id,
  :policies,
  :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.

Returns:

  • (Hash<String,String>) 


10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10143

class UpdateUserPoolRequest < Struct.new(
  :user_pool_id,
  :policies,
  :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.

Returns:



10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10143

class UpdateUserPoolRequest < Struct.new(
  :user_pool_id,
  :policies,
  :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