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 Details

    • smsAuthenticationMessage

      SmsMfaConfigType.Builder smsAuthenticationMessage(String smsAuthenticationMessage)

      The SMS authentication message that will be sent to users with the code they must sign in. The message must contain the ‘{####}’ placeholder, which is replaced with the code. If the message isn't included, and default message will be used.

      Parameters:
      smsAuthenticationMessage - The SMS authentication message that will be sent to users with the code they must sign in. The message must contain the ‘{####}’ placeholder, which is replaced with the code. If the message isn't included, and default message will be used.
      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: