Package software.amazon.awscdk.cfnpropertymixins.services.pinpoint

Class CfnSMSChannelPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.pinpoint.CfnSMSChannelPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnSMSChannelPropsMixin>

Enclosing class:

CfnSMSChannelPropsMixin

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

A fluent builder for CfnSMSChannelPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnSMSChannelPropsMixin.Builder	applicationId(String applicationId)	The unique identifier for the Amazon Pinpoint application that the SMS channel applies to.
CfnSMSChannelPropsMixin	build()
static CfnSMSChannelPropsMixin.Builder	create()
static CfnSMSChannelPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnSMSChannelPropsMixin.Builder	enabled(Boolean enabled)	Specifies whether to enable the SMS channel for the application.
CfnSMSChannelPropsMixin.Builder	enabled(IResolvable enabled)	Specifies whether to enable the SMS channel for the application.
CfnSMSChannelPropsMixin.Builder	senderId(String senderId)	The identity that you want to display on recipients' devices when they receive messages from the SMS channel.
CfnSMSChannelPropsMixin.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 CfnSMSChannelPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnSMSChannelPropsMixin.Builder.

create

@Stability(Stable)
public static CfnSMSChannelPropsMixin.Builder create()

Returns:

a new instance of CfnSMSChannelPropsMixin.Builder.

applicationId

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

Specified by:

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

Returns:

a newly built instance of CfnSMSChannelPropsMixin.