Package software.amazon.awscdk.services.pinpoint

Class CfnSMSChannel

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.pinpoint.CfnSMSChannel
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:00.864Z") @Stability(Stable) public class CfnSMSChannel extends CfnResource implements IInspectable
A CloudFormation AWS::Pinpoint::SMSChannel.

A channel is a type of platform that you can deliver messages to. To send an SMS text message, you send the message through the SMS channel. Before you can use Amazon Pinpoint to send text messages, you have to enable the SMS channel for an Amazon Pinpoint application.

The SMSChannel resource represents the status, sender ID, and other settings for the SMS channel for an application.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.pinpoint.*;
 CfnSMSChannel cfnSMSChannel = CfnSMSChannel.Builder.create(this, "MyCfnSMSChannel")
         .applicationId("applicationId")
         // the properties below are optional
         .enabled(false)
         .senderId("senderId")
         .shortCode("shortCode")
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnSMSChannel

      protected CfnSMSChannel(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnSMSChannel

      protected CfnSMSChannel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnSMSChannel

      @Stability(Stable) public CfnSMSChannel(@NotNull Construct scope, @NotNull String id, @NotNull CfnSMSChannelProps props)
      Create a new AWS::Pinpoint::SMSChannel.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getApplicationId

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

    • setApplicationId

      @Stability(Stable) public void setApplicationId(@NotNull String value)
      The unique identifier for the Amazon Pinpoint application that the SMS channel applies to.

    • getEnabled

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

    • setEnabled

      @Stability(Stable) public void setEnabled(@Nullable Boolean value)
      Specifies whether to enable the SMS channel for the application.

    • setEnabled

      @Stability(Stable) public void setEnabled(@Nullable IResolvable value)
      Specifies whether to enable the SMS channel for the application.

    • getSenderId

      @Stability(Stable) @Nullable public 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 .

    • setSenderId

      @Stability(Stable) public void setSenderId(@Nullable String value)
      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 public 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 .

    • setShortCode

      @Stability(Stable) public void setShortCode(@Nullable String value)
      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 .