Package software.amazon.awscdk.services.cognito

Class CfnUserPool.SmsConfigurationProperty.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.cognito.CfnUserPool.SmsConfigurationProperty.Jsii$Proxy
All Implemented Interfaces:
CfnUserPool.SmsConfigurationProperty, software.amazon.jsii.JsiiSerializable
Enclosing interface:
CfnUserPool.SmsConfigurationProperty
@Stability(Stable) @Internal public static final class CfnUserPool.SmsConfigurationProperty.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnUserPool.SmsConfigurationProperty
An implementation for CfnUserPool.SmsConfigurationProperty

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(CfnUserPool.SmsConfigurationProperty.Builder builder)
      Constructor that initializes the object based on literal property values passed by the CfnUserPool.SmsConfigurationProperty.Builder.

  • Method Details

    • getExternalId

      public final String getExternalId()
      Description copied from interface: CfnUserPool.SmsConfigurationProperty
      The external ID is a value.

      We recommend you use ExternalId 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 uses it when attempting to assume your IAM role. You can also set your roles trust policy to require the ExternalID . If you use the Cognito Management Console to create a role for SMS MFA, Cognito creates a role with the required permissions and a trust policy that uses ExternalId .

      Specified by:
      getExternalId in interface CfnUserPool.SmsConfigurationProperty

    • getSnsCallerArn

      public final String getSnsCallerArn()
      Description copied from interface: CfnUserPool.SmsConfigurationProperty
      The Amazon Resource Name (ARN) of the Amazon SNS caller.

      This is the ARN of the IAM role in your AWS account that Amazon Cognito will use to send SMS messages. SMS messages are subject to a spending limit .

      Specified by:
      getSnsCallerArn in interface CfnUserPool.SmsConfigurationProperty

    • getSnsRegion

      public final String getSnsRegion()
      Description copied from interface: CfnUserPool.SmsConfigurationProperty
      The AWS 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) AWS 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 .

      Specified by:
      getSnsRegion in interface CfnUserPool.SmsConfigurationProperty

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object