Skip to main content
Version: 2.1

ICognitoIdentityProviderSmsConfigurationType

Interface in AWS.CognitoIdentityProvider

Interface for SmsConfigurationType.

Properties​

ExternalId​

property ExternalId: string

An external ID can be used to provide additional security for your IAM role.

You can use an ExternalId with the IAM role used with Amazon Simple Notification Service (SNS) to send SMS messages for your user pool. If you provide an ExternalId, the Amazon Cognito user pool will include it in requests to assume the IAM role.

SnsCallerArn​

property SnsCallerArn: TARN

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) caller.

This is the ARN of an IAM role in your AWS account that Amazon Cognito will use to send SMS messages.

SnsRegion​

property SnsRegion: string

The AWS region to use when calling Amazon Simple Notification Service (SNS).