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

Interface SmsConfigurationType.Builder

All Superinterfaces:
Buildable, CopyableBuilder<SmsConfigurationType.Builder,SmsConfigurationType>, SdkBuilder<SmsConfigurationType.Builder,SmsConfigurationType>, SdkPojo
Enclosing class:
SmsConfigurationType
@Mutable @NotThreadSafe public static interface SmsConfigurationType.Builder extends SdkPojo, CopyableBuilder<SmsConfigurationType.Builder,SmsConfigurationType>

  • Method Details

    • snsCallerArn

      SmsConfigurationType.Builder snsCallerArn(String snsCallerArn)

      The Amazon Resource Name (ARN) of the Amazon SNS caller. This is the ARN of the IAM role in your Amazon Web Services account that Amazon Cognito will use to send SMS messages. SMS messages are subject to a spending limit.

      Parameters:
      snsCallerArn - The Amazon Resource Name (ARN) of the Amazon SNS caller. This is the ARN of the IAM role in your Amazon Web Services account that Amazon Cognito will use to send SMS messages. SMS messages are subject to a spending limit.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • externalId

      SmsConfigurationType.Builder externalId(String externalId)

      The external ID provides additional security for your IAM role. You can use an ExternalId with the IAM role that you use with Amazon SNS to send SMS messages for your user pool. If you provide an ExternalId, your Amazon Cognito user pool includes it in the request to assume your IAM role. You can configure the role trust policy to require that Amazon Cognito, and any principal, provide the ExternalID. If you use the Amazon Cognito Management Console to create a role for SMS multi-factor authentication (MFA), Amazon Cognito creates a role with the required permissions and a trust policy that demonstrates use of the ExternalId.

      For more information about the ExternalId of a role, see How to use an external ID when granting access to your Amazon Web Services resources to a third party.

      Parameters:
      externalId - The external ID provides additional security for your IAM role. You can use an ExternalId with the IAM role that you use with Amazon SNS to send SMS messages for your user pool. If you provide an ExternalId, your Amazon Cognito user pool includes it in the request to assume your IAM role. You can configure the role trust policy to require that Amazon Cognito, and any principal, provide the ExternalID. If you use the Amazon Cognito Management Console to create a role for SMS multi-factor authentication (MFA), Amazon Cognito creates a role with the required permissions and a trust policy that demonstrates use of the ExternalId.

      For more information about the ExternalId of a role, see How to use an external ID when granting access to your Amazon Web Services resources to a third party.

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

    • snsRegion

      SmsConfigurationType.Builder snsRegion(String snsRegion)

      The Amazon Web Services 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) Amazon Web Services 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.

      Parameters:
      snsRegion - The Amazon Web Services 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) Amazon Web Services 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:
      Returns a reference to this object so that method calls can be chained together.

    • eumsSms

      SmsConfigurationType.Builder eumsSms(EumsSmsConfigurationType eumsSms)

      The configuration for sending SMS messages through Amazon Web Services End User Messaging SMS, as an alternative to Amazon SNS. In a user pool, provide either the Amazon SNS configuration ( SnsCallerArn) or this configuration, but not both. In Amazon Web Services Regions where Amazon SNS is not available, this configuration is required.

      Parameters:
      eumsSms - The configuration for sending SMS messages through Amazon Web Services End User Messaging SMS, as an alternative to Amazon SNS. In a user pool, provide either the Amazon SNS configuration ( SnsCallerArn) or this configuration, but not both. In Amazon Web Services Regions where Amazon SNS is not available, this configuration is required.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eumsSms

      default SmsConfigurationType.Builder eumsSms(Consumer<EumsSmsConfigurationType.Builder> eumsSms)

      The configuration for sending SMS messages through Amazon Web Services End User Messaging SMS, as an alternative to Amazon SNS. In a user pool, provide either the Amazon SNS configuration ( SnsCallerArn) or this configuration, but not both. In Amazon Web Services Regions where Amazon SNS is not available, this configuration is required.

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

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

      Parameters:
      eumsSms - a consumer that will call methods on EumsSmsConfigurationType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: