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

Class: Aws::CognitoIdentityProvider::Types::AdminSetUserSettingsRequest

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

Overview

Note:

When passing AdminSetUserSettingsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  mfa_options: [ # required
    {
      delivery_medium: "SMS", # accepts SMS, EMAIL
      attribute_name: "AttributeNameType",
    },
  ],
}

You can use this parameter to set an MFA configuration that uses the SMS delivery medium.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#mfa_options ⇒ Array<Types::MFAOptionType>

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

Returns:

  • (Array<Types::MFAOptionType>) —

    You can use this parameter only to set an SMS configuration that uses SMS for delivery.

#user_pool_id ⇒ String

The ID of the user pool that contains the user that you are setting options for.

Returns:

  • (String) —

    The ID of the user pool that contains the user that you are setting options for.

#username ⇒ String

The user name of the user that you are setting options for.

Returns:

  • (String) —

    The user name of the user that you are setting options for.