Package software.amazon.awssdk.services.cognitoidentityprovider.model

Interface SmsMfaConfigType.Builder

All Superinterfaces:

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

Enclosing class:

SmsMfaConfigType

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

Method Summary

Modifier and Type	Method	Description
SmsMfaConfigType.Builder	smsAuthenticationMessage(String smsAuthenticationMessage)	The SMS authentication message that will be sent to users with the code they must sign in with.
default SmsMfaConfigType.Builder	smsConfiguration(Consumer<SmsConfigurationType.Builder> smsConfiguration)	User pool configuration for delivery of SMS messages with Amazon Simple Notification Service.
SmsMfaConfigType.Builder	smsConfiguration(SmsConfigurationType smsConfiguration)	User pool configuration for delivery of SMS messages with Amazon Simple Notification Service.

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

smsAuthenticationMessage

SmsMfaConfigType.Builder smsAuthenticationMessage(String smsAuthenticationMessage)

The SMS authentication message that will be sent to users with the code they must sign in with. The message must contain the {####} placeholder. Your user pool replaces the placeholder with the MFA code. If this parameter isn't provided, your user pool sends a default message.

Parameters:

smsAuthenticationMessage - The SMS authentication message that will be sent to users with the code they must sign in with. The message must contain the {####} placeholder. Your user pool replaces the placeholder with the MFA code. If this parameter isn't provided, your user pool sends a default message.

Returns:

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

smsConfiguration

SmsMfaConfigType.Builder smsConfiguration(SmsConfigurationType smsConfiguration)

User pool configuration for delivery of SMS messages with Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.

You can set SmsConfiguration in CreateUserPool and UpdateUserPool, or in SetUserPoolMfaConfig.

Parameters:

smsConfiguration - User pool configuration for delivery of SMS messages with Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.

You can set SmsConfiguration in CreateUserPool and UpdateUserPool, or in SetUserPoolMfaConfig.

Returns:

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

smsConfiguration

default SmsMfaConfigType.Builder smsConfiguration(Consumer<SmsConfigurationType.Builder> smsConfiguration)

User pool configuration for delivery of SMS messages with Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.

You can set SmsConfiguration in CreateUserPool and UpdateUserPool, or in SetUserPoolMfaConfig.

This is a convenience method that creates an instance of the SmsConfigurationType.Builder avoiding the need to create one manually via SmsConfigurationType.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to smsConfiguration(SmsConfigurationType).

Parameters:

smsConfiguration - a consumer that will call methods on SmsConfigurationType.Builder

Returns:

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

See Also:

smsConfiguration(SmsConfigurationType)