software.amazon.awscdk.services.pinpoint

Class CfnSMSChannel

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.pinpoint.CfnSMSChannel

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.240Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnSMSChannel.Builder A fluent builder for CfnSMSChannel.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnSMSChannel(software.constructs.Construct scope, String id, CfnSMSChannelProps props) Create a new `AWS::Pinpoint::SMSChannel`.
protected	CfnSMSChannel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSMSChannel(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getApplicationId() The unique identifier for the Amazon Pinpoint application that the SMS channel applies to.
protected Map<String,Object>	getCfnProperties()
Object	getEnabled() Specifies whether to enable the SMS channel for the application.
String	getSenderId() The identity that you want to display on recipients' devices when they receive messages from the SMS channel.
String	getShortCode() The registered short code that you want to use when you send messages through the SMS channel.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApplicationId(String value) The unique identifier for the Amazon Pinpoint application that the SMS channel applies to.
void	setEnabled(Boolean value) Specifies whether to enable the SMS channel for the application.
void	setEnabled(IResolvable value) Specifies whether to enable the SMS channel for the application.
void	setSenderId(String value) The identity that you want to display on recipients' devices when they receive messages from the SMS channel.
void	setShortCode(String value) The registered short code that you want to use when you send messages through the SMS channel.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnSMSChannel

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

CfnSMSChannel

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

CfnSMSChannel

@Stability(value=Stable)
public CfnSMSChannel(@NotNull
                                              software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getApplicationId

@Stability(value=Stable)
 @NotNull
public String getApplicationId()

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

setApplicationId

@Stability(value=Stable)
public void setApplicationId(@NotNull
                                                      String value)

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

getEnabled

@Stability(value=Stable)
 @Nullable
public Object getEnabled()

Specifies whether to enable the SMS channel for the application.

setEnabled

@Stability(value=Stable)
public void setEnabled(@Nullable
                                                Boolean value)

Specifies whether to enable the SMS channel for the application.

setEnabled

@Stability(value=Stable)
public void setEnabled(@Nullable
                                                IResolvable value)

Specifies whether to enable the SMS channel for the application.

getSenderId

@Stability(value=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(value=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(value=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(value=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 .