Package software.amazon.awscdk.services.pinpoint

Interface CfnSMSChannelProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSMSChannelProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2025-01-15T21:09:22.886Z")
@Stability(Stable)
public interface CfnSMSChannelProps
extends software.amazon.jsii.JsiiSerializable

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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApplicationId

@Stability(Stable)
@NotNull
String getApplicationId()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html#cfn-pinpoint-smschannel-applicationid

getEnabled

@Stability(Stable)
@Nullable
default Object getEnabled()

Specifies whether to enable the SMS channel for the application.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html#cfn-pinpoint-smschannel-enabled

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html#cfn-pinpoint-smschannel-senderid

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html#cfn-pinpoint-smschannel-shortcode

builder

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

Returns:

a CfnSMSChannelProps.Builder of CfnSMSChannelProps