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

Class EumsSmsConfigurationType

java.lang.Object
software.amazon.awssdk.services.cognitoidentityprovider.model.EumsSmsConfigurationType
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<EumsSmsConfigurationType.Builder,EumsSmsConfigurationType>
@Generated("software.amazon.awssdk:codegen") public final class EumsSmsConfigurationType extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EumsSmsConfigurationType.Builder,EumsSmsConfigurationType>

The configuration that Amazon Cognito uses to send SMS messages through Amazon Web Services End User Messaging SMS. Provide this structure in the EumsSms member of SmsConfigurationType to use Amazon Web Services End User Messaging SMS instead of Amazon SNS.

See Also:

  • Method Details

    • callerArn

      public final String callerArn()

      The ARN of the IAM role that Amazon Cognito assumes to send SMS messages through Amazon Web Services End User Messaging SMS. The role must grant permission to call the sms-voice:SendTextMessage operation.

      Returns:
      The ARN of the IAM role that Amazon Cognito assumes to send SMS messages through Amazon Web Services End User Messaging SMS. The role must grant permission to call the sms-voice:SendTextMessage operation.

    • externalId

      public final String externalId()

      The external ID that Amazon Cognito includes when it assumes the CallerArn role. Use this value as a condition in the role trust policy to prevent the confused deputy problem.

      Returns:
      The external ID that Amazon Cognito includes when it assumes the CallerArn role. Use this value as a condition in the role trust policy to prevent the confused deputy problem.

    • originationIdentity

      public final String originationIdentity()

      The origination identity that Amazon Web Services End User Messaging SMS uses to send messages to your users. This value can be one of the following:

      • A phone number – A long code, toll-free number, or short code that is assigned to your account.

      • A sender ID – An alphabetic name that identifies the message sender in supported countries.

      • A phone pool – A group of phone numbers that Amazon Web Services End User Messaging SMS selects from when it sends messages.

      You can provide an E.164 phone number or the ARN of the phone number, sender ID, or phone pool. Amazon Web Services End User Messaging SMS evaluates IAM authorization with the value that you provide. If the permissions policy of your CallerArn role scopes the sms-voice:SendTextMessage resource to a specific ARN, provide that same ARN. If the formats do not match, requests fail with an InvalidSmsRoleAccessPolicyException.

      Depending on the destination country, you must provide an origination identity. For country-specific requirements, see Supported countries and regions for SMS messaging in the Amazon Web Services End User Messaging SMS User Guide.

      Returns:
      The origination identity that Amazon Web Services End User Messaging SMS uses to send messages to your users. This value can be one of the following:

      • A phone number – A long code, toll-free number, or short code that is assigned to your account.

      • A sender ID – An alphabetic name that identifies the message sender in supported countries.

      • A phone pool – A group of phone numbers that Amazon Web Services End User Messaging SMS selects from when it sends messages.

      You can provide an E.164 phone number or the ARN of the phone number, sender ID, or phone pool. Amazon Web Services End User Messaging SMS evaluates IAM authorization with the value that you provide. If the permissions policy of your CallerArn role scopes the sms-voice:SendTextMessage resource to a specific ARN, provide that same ARN. If the formats do not match, requests fail with an InvalidSmsRoleAccessPolicyException.

      Depending on the destination country, you must provide an origination identity. For country-specific requirements, see Supported countries and regions for SMS messaging in the Amazon Web Services End User Messaging SMS User Guide.

    • configurationSetName

      public final String configurationSetName()

      The name of the Amazon Web Services End User Messaging SMS configuration set that Amazon Cognito applies to messages, for logging and event destinations. If you omit this member, Amazon Cognito sends messages without applying a configuration set.

      Returns:
      The name of the Amazon Web Services End User Messaging SMS configuration set that Amazon Cognito applies to messages, for logging and event destinations. If you omit this member, Amazon Cognito sends messages without applying a configuration set.

    • inEntityId

      public final String inEntityId()

      The principal entity ID required by India's Distributed Ledger Technology (DLT) regulations for SMS messages.

      Returns:
      The principal entity ID required by India's Distributed Ledger Technology (DLT) regulations for SMS messages.

    • inTemplateId

      public final String inTemplateId()

      The registered template ID for the message template required by India's DLT regulations for SMS messages.

      Returns:
      The registered template ID for the message template required by India's DLT regulations for SMS messages.

    • region

      public final String region()

      The Amazon Web Services Region of the Amazon Web Services End User Messaging SMS resources that Amazon Cognito uses to send messages. Amazon Web Services End User Messaging SMS must be available in your user pool's Region.

      If you omit this parameter, Amazon Cognito uses the same Region as your user pool. You can also set this parameter to your user pool's Region explicitly. Amazon Cognito rejects any other value with an InvalidParameterException.

      Returns:
      The Amazon Web Services Region of the Amazon Web Services End User Messaging SMS resources that Amazon Cognito uses to send messages. Amazon Web Services End User Messaging SMS must be available in your user pool's Region.

      If you omit this parameter, Amazon Cognito uses the same Region as your user pool. You can also set this parameter to your user pool's Region explicitly. Amazon Cognito rejects any other value with an InvalidParameterException.

    • toBuilder

      public EumsSmsConfigurationType.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<EumsSmsConfigurationType.Builder,EumsSmsConfigurationType>

    • builder

      public static EumsSmsConfigurationType.Builder builder()

    • serializableBuilderClass

      public static Class<? extends EumsSmsConfigurationType.Builder> serializableBuilderClass()

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo