public static final class CfnUserPool.SmsConfigurationProperty.Builder
extends java.lang.Object
CfnUserPool.SmsConfigurationProperty
Constructor and Description |
---|
Builder() |
Modifier and Type | Method and Description |
---|---|
CfnUserPool.SmsConfigurationProperty |
build()
Builds the configured instance.
|
CfnUserPool.SmsConfigurationProperty.Builder |
externalId(java.lang.String externalId)
Sets the value of
CfnUserPool.SmsConfigurationProperty.getExternalId() |
CfnUserPool.SmsConfigurationProperty.Builder |
snsCallerArn(java.lang.String snsCallerArn)
Sets the value of
CfnUserPool.SmsConfigurationProperty.getSnsCallerArn() |
CfnUserPool.SmsConfigurationProperty.Builder |
snsRegion(java.lang.String snsRegion)
Sets the value of
CfnUserPool.SmsConfigurationProperty.getSnsRegion() |
public CfnUserPool.SmsConfigurationProperty.Builder externalId(java.lang.String externalId)
CfnUserPool.SmsConfigurationProperty.getExternalId()
externalId
- 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
.this
public CfnUserPool.SmsConfigurationProperty.Builder snsCallerArn(java.lang.String snsCallerArn)
CfnUserPool.SmsConfigurationProperty.getSnsCallerArn()
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 .this
public CfnUserPool.SmsConfigurationProperty.Builder snsRegion(java.lang.String snsRegion)
CfnUserPool.SmsConfigurationProperty.getSnsRegion()
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 .
this
public CfnUserPool.SmsConfigurationProperty build()
CfnUserPool.SmsConfigurationProperty
java.lang.NullPointerException
- if any required attribute was not provided