Package software.amazon.awscdk.services.cognito

Class CfnUserPool.SmsConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.CfnUserPool.SmsConfigurationProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnUserPool.SmsConfigurationProperty>

Enclosing interface:

CfnUserPool.SmsConfigurationProperty

@Stability(Stable)
public static final class CfnUserPool.SmsConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnUserPool.SmsConfigurationProperty>

A builder for CfnUserPool.SmsConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnUserPool.SmsConfigurationProperty	build()	Builds the configured instance.
CfnUserPool.SmsConfigurationProperty.Builder	externalId(String externalId)	Sets the value of CfnUserPool.SmsConfigurationProperty.getExternalId()
CfnUserPool.SmsConfigurationProperty.Builder	snsCallerArn(String snsCallerArn)	Sets the value of CfnUserPool.SmsConfigurationProperty.getSnsCallerArn()
CfnUserPool.SmsConfigurationProperty.Builder	snsRegion(String snsRegion)	Sets the value of CfnUserPool.SmsConfigurationProperty.getSnsRegion()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

externalId

@Stability(Stable)
public CfnUserPool.SmsConfigurationProperty.Builder externalId(String externalId)

Sets the value of CfnUserPool.SmsConfigurationProperty.getExternalId()

Parameters:

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 .

Returns:

this

snsCallerArn

@Stability(Stable)
public CfnUserPool.SmsConfigurationProperty.Builder snsCallerArn(String snsCallerArn)

Sets the value of CfnUserPool.SmsConfigurationProperty.getSnsCallerArn()

Parameters:

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 .

Returns:

this

snsRegion

@Stability(Stable)
public CfnUserPool.SmsConfigurationProperty.Builder snsRegion(String snsRegion)

Sets the value of CfnUserPool.SmsConfigurationProperty.getSnsRegion()

Parameters:

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 .

Returns:

this

build

@Stability(Stable)
public CfnUserPool.SmsConfigurationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnUserPool.SmsConfigurationProperty>

Returns:

a new instance of CfnUserPool.SmsConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided