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

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 SmsConfigurationType data as a 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#external_idString

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.

For more information about the ExternalId of a role, see How to use an external ID when granting access to your AWS resources to a third party

Returns:

  • (String)


8348
8349
8350
8351
8352
8353
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 8348

class SmsConfigurationType < Struct.new(
  :sns_caller_arn,
  :external_id)
  SENSITIVE = []
  include Aws::Structure
end

#sns_caller_arnString

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. SMS messages are subject to a spending limit.

Returns:

  • (String)


8348
8349
8350
8351
8352
8353
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 8348

class SmsConfigurationType < Struct.new(
  :sns_caller_arn,
  :external_id)
  SENSITIVE = []
  include Aws::Structure
end