Package software.amazon.awscdk.services.cognito

Interface CfnUserPool.SmsConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPool.SmsConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnUserPool

@Stability(Stable)
public static interface CfnUserPool.SmsConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 SmsConfigurationProperty smsConfigurationProperty = SmsConfigurationProperty.builder()
         .externalId("externalId")
         .snsCallerArn("snsCallerArn")
         .snsRegion("snsRegion")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-smsconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnUserPool.SmsConfigurationProperty.Builder	A builder for CfnUserPool.SmsConfigurationProperty
static final class	CfnUserPool.SmsConfigurationProperty.Jsii$Proxy	An implementation for CfnUserPool.SmsConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnUserPool.SmsConfigurationProperty.Builder	builder()
default String	getExternalId()	The external ID provides additional security for your IAM role.
default String	getSnsCallerArn()	The Amazon Resource Name (ARN) of the Amazon SNS caller.
default String	getSnsRegion()	The AWS Region to use with Amazon SNS integration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getExternalId

@Stability(Stable)
@Nullable
default String getExternalId()

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 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-smsconfiguration.html#cfn-cognito-userpool-smsconfiguration-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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-smsconfiguration.html#cfn-cognito-userpool-smsconfiguration-snscallerarn

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-smsconfiguration.html#cfn-cognito-userpool-smsconfiguration-snsregion

builder

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

Returns:

a CfnUserPool.SmsConfigurationProperty.Builder of CfnUserPool.SmsConfigurationProperty