software.amazon.awscdk.services.pinpoint

Interface CfnSMSChannelProps

All Known Implementing Classes:

CfnSMSChannelProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:24.883Z")
public interface CfnSMSChannelProps

Properties for defining a `CfnSMSChannel`.

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.*;
 CfnSMSChannelProps cfnSMSChannelProps = CfnSMSChannelProps.builder()
         .applicationId("applicationId")
         // the properties below are optional
         .enabled(false)
         .senderId("senderId")
         .shortCode("shortCode")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnSMSChannelProps.Builder A builder for CfnSMSChannelProps
static class	CfnSMSChannelProps.Jsii$Proxy An implementation for CfnSMSChannelProps

Method Summary

Modifier and Type	Method and Description
static CfnSMSChannelProps.Builder	builder()
java.lang.String	getApplicationId() The unique identifier for the Amazon Pinpoint application that the SMS channel applies to.
default java.lang.Object	getEnabled() Specifies whether to enable the SMS channel for the application.
default java.lang.String	getSenderId() The identity that you want to display on recipients' devices when they receive messages from the SMS channel.
default java.lang.String	getShortCode() The registered short code that you want to use when you send messages through the SMS channel.

Method Detail

getApplicationId

java.lang.String getApplicationId()

The unique identifier for the Amazon Pinpoint application that the SMS channel applies to.

getEnabled

default java.lang.Object getEnabled()

Specifies whether to enable the SMS channel for the application.

getSenderId

default java.lang.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

default java.lang.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

static CfnSMSChannelProps.Builder builder()

Returns:

a CfnSMSChannelProps.Builder of CfnSMSChannelProps