You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing UpdateUserPoolRequest as input to an Aws::Client method, you can use a vanilla 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",
  },
  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",
  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",
  },
  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:

Instance Attribute Summary collapse

Instance Attribute Details

#account_recovery_setting ⇒ Types::AccountRecoverySettingType

Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.

Returns:

  • (Types::AccountRecoverySettingType) —

    Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword.

#admin_create_user_config ⇒ Types::AdminCreateUserConfigType

The configuration for AdminCreateUser requests.

Returns:

#auto_verified_attributes ⇒ Array<String>

The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.

Returns:

  • (Array<String>) —

    The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.

#device_configuration ⇒ Types::DeviceConfigurationType

Device configuration.

Returns:

#email_configuration ⇒ Types::EmailConfigurationType

Email configuration.

Returns:

#email_verification_message ⇒ String

The contents of the email verification message.

Returns:

  • (String) —

    The contents of the email verification message.

#email_verification_subject ⇒ String

The subject of the email verification message.

Returns:

  • (String) —

    The subject of the email verification message.

#lambda_config ⇒ Types::LambdaConfigType

The AWS Lambda configuration information from the request to update the user pool.

Returns:

#mfa_configuration ⇒ String

Can be one of the following values:

  • OFF - MFA tokens are not required and cannot be specified during user registration.

  • ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.

  • OPTIONAL - Users have the option when registering to create an MFA token.

    Possible values:

    • OFF
    • ON
    • OPTIONAL

Returns:

  • (String) —

    Can be one of the following values:.

#policies ⇒ Types::UserPoolPolicyType

A container with the policies you wish to update in a user pool.

Returns:

#sms_authentication_message ⇒ String

The contents of the SMS authentication message.

Returns:

  • (String) —

    The contents of the SMS authentication message.

#sms_configuration ⇒ Types::SmsConfigurationType

SMS configuration.

Returns:

#sms_verification_message ⇒ String

A container with information about the SMS verification message.

Returns:

  • (String) —

    A container with information about the SMS verification message.

#user_pool_add_ons ⇒ Types::UserPoolAddOnsType

Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value \"AUDIT\".

Returns:

#user_pool_id ⇒ String

The user pool ID for the user pool you want to update.

Returns:

  • (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. 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>) —

    The tag keys and values to assign to the user pool.

#verification_message_template ⇒ Types::VerificationMessageTemplateType

The template for verification messages.

Returns: