AWS::Cognito::UserPool SmsConfiguration
User pool configuration for delivery of SMS messages with Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account.
This data type is a request parameter of CreateUserPool, UpdateUserPool, and SetUserPoolMfaConfig, and a response parameter of CreateUserPool, UpdateUserPool, and GetUserPoolMfaConfig.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "ExternalId" :
String
, "SnsCallerArn" :String
, "SnsRegion" :String
}
YAML
ExternalId:
String
SnsCallerArn:String
SnsRegion:String
Properties
ExternalId
-
The external ID provides additional security for your IAM role. You can use an
ExternalId
with the IAM role that you use with Amazon SNS to send SMS messages for your user pool. If you provide anExternalId
, your Amazon Cognito user pool includes it in the request to assume your IAM role. You can configure the role trust policy to require that Amazon Cognito, and any principal, provide theExternalID
. If you use the Amazon Cognito Management Console to create a role for SMS multi-factor authentication (MFA), Amazon Cognito creates a role with the required permissions and a trust policy that demonstrates use of theExternalId
.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.Required: No
Type: String
Minimum:
0
Maximum:
131072
Update requires: No interruption
SnsCallerArn
-
The Amazon Resource Name (ARN) of the Amazon SNS caller. This is the ARN of the IAM role in your AWS account that Amazon Cognito will use to send SMS messages. SMS messages are subject to a spending limit.
Required: No
Type: String
Pattern:
arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
Minimum:
20
Maximum:
2048
Update requires: No interruption
SnsRegion
-
The AWS Region to use with Amazon SNS integration. You can choose the same Region as your user pool, or a supported Legacy Amazon SNS alternate Region.
Amazon Cognito resources in the Asia Pacific (Seoul) AWS Region must use your Amazon SNS configuration in the Asia Pacific (Tokyo) Region. For more information, see SMS message settings for Amazon Cognito user pools.
Required: No
Type: String
Minimum:
5
Maximum:
32
Update requires: No interruption