AWS::Cognito::UserPool SmsConfiguration
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.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "ExternalId" :
String
, "SnsCallerArn" :String
}
YAML
ExternalId:
String
SnsCallerArn:String
Properties
ExternalId
-
The external ID is a value. We recommend you use
ExternalId
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 anExternalId
, the Cognito User Pool uses it when attempting to assume your IAM role. You can also set your roles trust policy to require theExternalID
. If you use the Cognito Management Console to create a role for SMS MFA, Cognito creates a role with the required permissions and a trust policy that usesExternalId
.Required: No
Type: String
Update requires: No interruption
SnsCallerArn
-
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.
Required: No
Type: String
Minimum:
20
Maximum:
2048
Pattern:
arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
Update requires: No interruption