Class: Aws::CognitoIdentityProvider::Types::AdminSetUserSettingsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::CognitoIdentityProvider::Types::AdminSetUserSettingsRequest
- 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.
Constant Summary collapse
- SENSITIVE =
[:username]
Instance Attribute Summary collapse
-
#mfa_options ⇒ 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 whose options you're setting.
-
#username ⇒ String
The username of the user that you want to query or modify.
Instance Attribute Details
#mfa_options ⇒ Array<Types::MFAOptionType>
You can use this parameter only to set an SMS configuration that uses SMS for delivery.
1746 1747 1748 1749 1750 1751 1752 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1746 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.
1746 1747 1748 1749 1750 1751 1752 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1746 class AdminSetUserSettingsRequest < Struct.new( :user_pool_id, :username, :mfa_options) SENSITIVE = [:username] include Aws::Structure end |
#username ⇒ String
The username 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.
1746 1747 1748 1749 1750 1751 1752 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1746 class AdminSetUserSettingsRequest < Struct.new( :user_pool_id, :username, :mfa_options) SENSITIVE = [:username] include Aws::Structure end |