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

Class: Aws::CognitoIdentityProvider::Types::SmsConfigurationType

Inherits:

Struct

Object
Struct
Aws::CognitoIdentityProvider::Types::SmsConfigurationType

show all

Defined in:: (unknown)

Overview

Note:

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

{
  sns_caller_arn: "ArnType", # required
  external_id: "StringType",
}

The SMS configuration type that includes the settings the Cognito User Pool needs to call for the Amazon SNS service to send an SMS message from your AWS account. The Cognito User Pool makes the request to the Amazon SNS Service by using an AWS IAM role that you provide for your AWS account.

Returned by:

Instance Attribute Summary collapse

#external_id ⇒ String
The external ID is a value that we recommend you use to add security to your IAM role which is used to call Amazon SNS to send SMS messages for your user pool.
#sns_caller_arn ⇒ String
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) caller.

Instance Attribute Details

#external_id ⇒ `String`

The external ID is a value that we recommend you use to add security to your IAM role which is used to call Amazon SNS to send SMS messages for your user pool. If you provide an ExternalId, the Cognito User Pool will include it when attempting to assume your IAM role, so that you can set your roles trust policy to require the ExternalID. If you use the Cognito Management Console to create a role for SMS MFA, Cognito will create a role with the required permissions and a trust policy that demonstrates use of the ExternalId.

Returns:

(String) —
The external ID is a value that we recommend you use to add security to your IAM role which is used to call Amazon SNS to send SMS messages for your user pool.

#sns_caller_arn ⇒ `String`

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) caller. This is the ARN of the IAM role in your AWS account which Cognito will use to send SMS messages.