Interface CfnUserPool.ISmsConfigurationProperty
User pool configuration for delivery of SMS messages with Amazon Simple Notification Service.
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface CfnUserPool.ISmsConfigurationPropertySyntax (vb)
Public Interface CfnUserPool.ISmsConfigurationPropertyRemarks
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 .
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Cognito;
var smsConfigurationProperty = new SmsConfigurationProperty {
ExternalId = "externalId",
SnsCallerArn = "snsCallerArn",
SnsRegion = "snsRegion"
};Synopsis
Properties
| ExternalId | The external ID provides additional security for your IAM role. |
| SnsCallerArn | The Amazon Resource Name (ARN) of the Amazon SNS caller. |
| SnsRegion | The AWS Region to use with Amazon SNS integration. |
Properties
ExternalId
The external ID provides additional security for your IAM role.
string? ExternalId { get; }Property Value
Remarks
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 an ExternalId , 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 the ExternalID . 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 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 .
SnsCallerArn
The Amazon Resource Name (ARN) of the Amazon SNS caller.
string? SnsCallerArn { get; }Property Value
Remarks
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 .
SnsRegion
The AWS Region to use with Amazon SNS integration.
string? SnsRegion { get; }Property Value
Remarks
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 .