software.amazon.awssdk.services.cognitoidentityprovider.model

Interface SmsConfigurationType.Builder

All Superinterfaces:

Buildable, CopyableBuilder<SmsConfigurationType.Builder,SmsConfigurationType>, SdkBuilder<SmsConfigurationType.Builder,SmsConfigurationType>, SdkPojo

Enclosing class:

SmsConfigurationType

public static interface SmsConfigurationType.Builder
extends SdkPojo, CopyableBuilder<SmsConfigurationType.Builder,SmsConfigurationType>

Method Summary

Modifier and Type	Method and Description
SmsConfigurationType.Builder	externalId(String externalId) The external ID is a value that we recommend you use to add security to your IAM role which is used to call Amazon SNS to send SMS messages for your user pool.
SmsConfigurationType.Builder	snsCallerArn(String snsCallerArn) The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) caller.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

snsCallerArn

SmsConfigurationType.Builder snsCallerArn(String snsCallerArn)

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) caller. This is the ARN of the IAM role in your AWS account which Cognito will use to send SMS messages.

Parameters:

snsCallerArn - The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) caller. This is the ARN of the IAM role in your AWS account which Cognito will use to send SMS messages.

Returns:

Returns a reference to this object so that method calls can be chained together.

externalId

SmsConfigurationType.Builder externalId(String externalId)

The external ID is a value that we recommend you use 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 will include it when attempting to assume your IAM role, so that you can set your roles trust policy to require the ExternalID. If you use the Cognito Management Console to create a role for SMS MFA, Cognito will create a role with the required permissions and a trust policy that demonstrates use of the ExternalId.

Parameters:

externalId - The external ID is a value that we recommend you use 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 will include it when attempting to assume your IAM role, so that you can set your roles trust policy to require the ExternalID. If you use the Cognito Management Console to create a role for SMS MFA, Cognito will create a role with the required permissions and a trust policy that demonstrates use of the ExternalId.

Returns:

Returns a reference to this object so that method calls can be chained together.