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

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

Overview

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

See Also:

Constant Summary collapse

SENSITIVE = 
[:username]

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:



2248
2249
2250
2251
2252
2253
2254
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2248

class AdminSetUserSettingsRequest < Struct.new(
  :user_pool_id,
  :username,
  :mfa_options)
  SENSITIVE = [:username]
  include Aws::Structure
end

#user_pool_id ⇒ String

The ID of the user pool that contains the user whose options you're setting.

Returns:

  • (String) 


2248
2249
2250
2251
2252
2253
2254
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2248

class AdminSetUserSettingsRequest < Struct.new(
  :user_pool_id,
  :username,
  :mfa_options)
  SENSITIVE = [:username]
  include Aws::Structure
end

#username ⇒ String

The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

Returns:

  • (String) 


2248
2249
2250
2251
2252
2253
2254
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2248

class AdminSetUserSettingsRequest < Struct.new(
  :user_pool_id,
  :username,
  :mfa_options)
  SENSITIVE = [:username]
  include Aws::Structure
end