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 message that your user pool sends to users with an MFA code.
default SmsMfaConfigType.Builder	smsConfiguration(Consumer<SmsConfigurationType.Builder> smsConfiguration)	The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service.
SmsMfaConfigType.Builder	smsConfiguration(SmsConfigurationType smsConfiguration)	The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through 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, sdkFields

Method Detail

smsAuthenticationMessage

SmsMfaConfigType.Builder smsAuthenticationMessage(String smsAuthenticationMessage)

The SMS message that your user pool sends to users with an MFA code. The message must contain the {####} placeholder. In the message, Amazon Cognito replaces this placeholder with the code. If you don't provide this parameter, Amazon Cognito sends messages in the default format.

Parameters:

smsAuthenticationMessage - The SMS message that your user pool sends to users with an MFA code. The message must contain the {####} placeholder. In the message, Amazon Cognito replaces this placeholder with the code. If you don't provide this parameter, Amazon Cognito sends messages in the default format.

Returns:

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

smsConfiguration

SmsMfaConfigType.Builder smsConfiguration(SmsConfigurationType smsConfiguration)

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To request Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role that you provide for your Amazon Web Services account.

Parameters:

smsConfiguration - The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To request Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role that you provide for your Amazon Web Services account.

Returns:

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

smsConfiguration

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

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To request Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role that you provide for your Amazon Web Services account.

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)