Package software.amazon.awscdk.services.pinpoint

Class CfnSMSChannel.Builder

java.lang.Object

software.amazon.awscdk.services.pinpoint.CfnSMSChannel.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnSMSChannel>

Enclosing class:

CfnSMSChannel

@Stability(Stable)
public static final class CfnSMSChannel.Builder
extends Object
implements software.amazon.jsii.Builder<CfnSMSChannel>

A fluent builder for CfnSMSChannel.

Method Summary

Modifier and Type	Method	Description
CfnSMSChannel.Builder	applicationId(String applicationId)	The unique identifier for the Amazon Pinpoint application that the SMS channel applies to.
CfnSMSChannel	build()
static CfnSMSChannel.Builder	create(software.constructs.Construct scope, String id)
CfnSMSChannel.Builder	enabled(Boolean enabled)	Specifies whether to enable the SMS channel for the application.
CfnSMSChannel.Builder	enabled(IResolvable enabled)	Specifies whether to enable the SMS channel for the application.
CfnSMSChannel.Builder	senderId(String senderId)	The identity that you want to display on recipients' devices when they receive messages from the SMS channel.
CfnSMSChannel.Builder	shortCode(String shortCode)	The registered short code that you want to use when you send messages through the SMS channel.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnSMSChannel.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnSMSChannel.Builder.

applicationId

@Stability(Stable)
public CfnSMSChannel.Builder applicationId(String applicationId)

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

Parameters:

applicationId - The unique identifier for the Amazon Pinpoint application that the SMS channel applies to. This parameter is required.

Returns:

this

See Also:

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

enabled

@Stability(Stable)
public CfnSMSChannel.Builder enabled(Boolean enabled)

Specifies whether to enable the SMS channel for the application.

Parameters:

enabled - Specifies whether to enable the SMS channel for the application. This parameter is required.

Returns:

this

See Also:

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

enabled

@Stability(Stable)
public CfnSMSChannel.Builder enabled(IResolvable enabled)

Specifies whether to enable the SMS channel for the application.

Parameters:

enabled - Specifies whether to enable the SMS channel for the application. This parameter is required.

Returns:

this

See Also:

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

senderId

@Stability(Stable)
public CfnSMSChannel.Builder senderId(String senderId)

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 .

Parameters:

senderId - The identity that you want to display on recipients' devices when they receive messages from the SMS channel. This parameter is required.

Returns:

this

See Also:

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

shortCode

@Stability(Stable)
public CfnSMSChannel.Builder shortCode(String shortCode)

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 .

Parameters:

shortCode - The registered short code that you want to use when you send messages through the SMS channel. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnSMSChannel build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnSMSChannel>

Returns:

a newly built instance of CfnSMSChannel.