Interface CfnUserPool.SmsConfigurationProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnUserPool.SmsConfigurationProperty extends
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 IAM role that you provide for your AWS account .


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 SmsConfigurationProperty smsConfigurationProperty = SmsConfigurationProperty.builder()
  • Method Details

    • getExternalId

      @Stability(Stable) @Nullable default String getExternalId()
      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 an ExternalId , the Cognito User Pool uses it when attempting to assume your IAM role. You can also set your roles trust policy to require the ExternalID . 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 uses ExternalId .

    • getSnsCallerArn

      @Stability(Stable) @Nullable default String getSnsCallerArn()
      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 .

    • getSnsRegion

      @Stability(Stable) @Nullable default String getSnsRegion()
      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 .

    • builder

      @Stability(Stable) static CfnUserPool.SmsConfigurationProperty.Builder builder()
      a CfnUserPool.SmsConfigurationProperty.Builder of CfnUserPool.SmsConfigurationProperty