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

Interface EumsSmsConfigurationType.Builder

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

  • Method Details

    • callerArn

      EumsSmsConfigurationType.Builder callerArn(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.

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

    • externalId

      EumsSmsConfigurationType.Builder externalId(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.

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

    • originationIdentity

      EumsSmsConfigurationType.Builder originationIdentity(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.

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

    • configurationSetName

      EumsSmsConfigurationType.Builder configurationSetName(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.

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

    • inEntityId

      EumsSmsConfigurationType.Builder inEntityId(String inEntityId)

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

      Parameters:
      inEntityId - The principal entity ID required by India's Distributed Ledger Technology (DLT) regulations for SMS messages.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inTemplateId

      EumsSmsConfigurationType.Builder inTemplateId(String inTemplateId)

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

      Parameters:
      inTemplateId - The registered template ID for the message template required by India's DLT regulations for SMS messages.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • region

      EumsSmsConfigurationType.Builder region(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.

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