Interface CfnSMSChannelProps

All Superinterfaces:
All Known Implementing Classes:

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:00.865Z") @Stability(Stable) public interface CfnSMSChannelProps extends
Properties for defining a CfnSMSChannel.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 CfnSMSChannelProps cfnSMSChannelProps = CfnSMSChannelProps.builder()
         // the properties below are optional
  • Method Details

    • getApplicationId

      @Stability(Stable) @NotNull String getApplicationId()
      The unique identifier for the Amazon Pinpoint application that the SMS channel applies to.
    • getEnabled

      @Stability(Stable) @Nullable default Object getEnabled()
      Specifies whether to enable the SMS channel for the application.
    • getSenderId

      @Stability(Stable) @Nullable default String getSenderId()
      The identity that you want to display on recipients' devices when they receive messages from the SMS channel.

      SenderIDs are only supported in certain countries and regions. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide .

    • getShortCode

      @Stability(Stable) @Nullable default String getShortCode()
      The registered short code that you want to use when you send messages through the SMS channel.

      For information about obtaining a dedicated short code for sending SMS messages, see Requesting Dedicated Short Codes for SMS Messaging with Amazon Pinpoint in the Amazon Pinpoint User Guide .

    • builder

      @Stability(Stable) static CfnSMSChannelProps.Builder builder()
      a CfnSMSChannelProps.Builder of CfnSMSChannelProps