Class: Aws::CognitoIdentityProvider::Types::SmsMfaConfigType

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

Overview

Note:

When making an API call, you may pass SmsMfaConfigType data as a hash:

{
  sms_authentication_message: "SmsVerificationMessageType",
  sms_configuration: {
    sns_caller_arn: "ArnType", # required
    external_id: "StringType",
    sns_region: "RegionCodeType",
  },
}

The SMS text message multi-factor authentication (MFA) configuration type.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#sms_authentication_messageString

The SMS authentication message that will be sent to users with the code they must sign in. The message must contain the ‘{####\}’ placeholder, which is replaced with the code. If the message isn't included, and default message will be used.

Returns:

  • (String)


8799
8800
8801
8802
8803
8804
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 8799

class SmsMfaConfigType < Struct.new(
  :sms_authentication_message,
  :sms_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#sms_configurationTypes::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 request Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role that you provide for your Amazon Web Services account.



8799
8800
8801
8802
8803
8804
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 8799

class SmsMfaConfigType < Struct.new(
  :sms_authentication_message,
  :sms_configuration)
  SENSITIVE = []
  include Aws::Structure
end