Package software.amazon.awscdk.services.smsvoice

Class CfnPhoneNumber.Builder

java.lang.Object

software.amazon.awscdk.services.smsvoice.CfnPhoneNumber.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnPhoneNumber>

Enclosing class:

CfnPhoneNumber

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

A fluent builder for CfnPhoneNumber.

Method Summary

Modifier and Type	Method	Description
CfnPhoneNumber	build()
static CfnPhoneNumber.Builder	create(software.constructs.Construct scope, String id)
CfnPhoneNumber.Builder	deletionProtectionEnabled(Boolean deletionProtectionEnabled)	By default this is set to false.
CfnPhoneNumber.Builder	deletionProtectionEnabled(IResolvable deletionProtectionEnabled)	By default this is set to false.
CfnPhoneNumber.Builder	isoCountryCode(String isoCountryCode)	The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
CfnPhoneNumber.Builder	mandatoryKeywords(IResolvable mandatoryKeywords)	Creates or updates a MandatoryKeyword configuration on an origination phone number For more information, see Keywords in the End User Messaging User Guide.
CfnPhoneNumber.Builder	mandatoryKeywords(CfnPhoneNumber.MandatoryKeywordsProperty mandatoryKeywords)	Creates or updates a MandatoryKeyword configuration on an origination phone number For more information, see Keywords in the End User Messaging User Guide.
CfnPhoneNumber.Builder	numberCapabilities(List<String> numberCapabilities)	Indicates if the phone number will be used for text messages, voice messages, or both.
CfnPhoneNumber.Builder	numberType(String numberType)	The type of phone number to request.
CfnPhoneNumber.Builder	optionalKeywords(List<? extends Object> optionalKeywords)	A keyword is a word that you can search for on a particular phone number or pool.
CfnPhoneNumber.Builder	optionalKeywords(IResolvable optionalKeywords)	A keyword is a word that you can search for on a particular phone number or pool.
CfnPhoneNumber.Builder	optOutListName(String optOutListName)	The name of the OptOutList associated with the phone number.
CfnPhoneNumber.Builder	selfManagedOptOutsEnabled(Boolean selfManagedOptOutsEnabled)	When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging automatically replies with a customizable message and adds the end recipient to the OptOutList.
CfnPhoneNumber.Builder	selfManagedOptOutsEnabled(IResolvable selfManagedOptOutsEnabled)	When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging automatically replies with a customizable message and adds the end recipient to the OptOutList.
CfnPhoneNumber.Builder	tags(List<? extends CfnTag> tags)	An array of tags (key and value pairs) to associate with the requested phone number.
CfnPhoneNumber.Builder	twoWay(IResolvable twoWay)	Describes the two-way SMS configuration for a phone number.
CfnPhoneNumber.Builder	twoWay(CfnPhoneNumber.TwoWayProperty twoWay)	Describes the two-way SMS configuration for a phone number.

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 CfnPhoneNumber.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 CfnPhoneNumber.Builder.

isoCountryCode

@Stability(Stable)
public CfnPhoneNumber.Builder isoCountryCode(String isoCountryCode)

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

Parameters:

isoCountryCode - The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-isocountrycode

mandatoryKeywords

@Stability(Stable)
public CfnPhoneNumber.Builder mandatoryKeywords(IResolvable mandatoryKeywords)

Creates or updates a MandatoryKeyword configuration on an origination phone number For more information, see Keywords in the End User Messaging User Guide.

Parameters:

mandatoryKeywords - Creates or updates a MandatoryKeyword configuration on an origination phone number For more information, see Keywords in the End User Messaging User Guide. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-mandatorykeywords

mandatoryKeywords

@Stability(Stable)
public CfnPhoneNumber.Builder mandatoryKeywords(CfnPhoneNumber.MandatoryKeywordsProperty mandatoryKeywords)

Creates or updates a MandatoryKeyword configuration on an origination phone number For more information, see Keywords in the End User Messaging User Guide.

Parameters:

mandatoryKeywords - Creates or updates a MandatoryKeyword configuration on an origination phone number For more information, see Keywords in the End User Messaging User Guide. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-mandatorykeywords

numberCapabilities

@Stability(Stable)
public CfnPhoneNumber.Builder numberCapabilities(List<String> numberCapabilities)

Indicates if the phone number will be used for text messages, voice messages, or both.

Parameters:

numberCapabilities - Indicates if the phone number will be used for text messages, voice messages, or both. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-numbercapabilities

numberType

@Stability(Stable)
public CfnPhoneNumber.Builder numberType(String numberType)

The type of phone number to request.

The ShortCode number type is not supported in AWS CloudFormation .

Parameters:

numberType - The type of phone number to request. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-numbertype

deletionProtectionEnabled

@Stability(Stable)
public CfnPhoneNumber.Builder deletionProtectionEnabled(Boolean deletionProtectionEnabled)

By default this is set to false.

When set to true the phone number can't be deleted.

Parameters:

deletionProtectionEnabled - By default this is set to false. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-deletionprotectionenabled

deletionProtectionEnabled

@Stability(Stable)
public CfnPhoneNumber.Builder deletionProtectionEnabled(IResolvable deletionProtectionEnabled)

By default this is set to false.

When set to true the phone number can't be deleted.

Parameters:

deletionProtectionEnabled - By default this is set to false. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-deletionprotectionenabled

optionalKeywords

@Stability(Stable)
public CfnPhoneNumber.Builder optionalKeywords(IResolvable optionalKeywords)

A keyword is a word that you can search for on a particular phone number or pool.

It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, End User Messaging responds with a customizable message. Optional keywords are differentiated from mandatory keywords. For more information, see Keywords in the End User Messaging User Guide.

Parameters:

optionalKeywords - A keyword is a word that you can search for on a particular phone number or pool. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-optionalkeywords

optionalKeywords

@Stability(Stable)
public CfnPhoneNumber.Builder optionalKeywords(List<? extends Object> optionalKeywords)

A keyword is a word that you can search for on a particular phone number or pool.

It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, End User Messaging responds with a customizable message. Optional keywords are differentiated from mandatory keywords. For more information, see Keywords in the End User Messaging User Guide.

Parameters:

optionalKeywords - A keyword is a word that you can search for on a particular phone number or pool. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-optionalkeywords

optOutListName

@Stability(Stable)
public CfnPhoneNumber.Builder optOutListName(String optOutListName)

The name of the OptOutList associated with the phone number.

Parameters:

optOutListName - The name of the OptOutList associated with the phone number. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-optoutlistname

selfManagedOptOutsEnabled

@Stability(Stable)
public CfnPhoneNumber.Builder selfManagedOptOutsEnabled(Boolean selfManagedOptOutsEnabled)

When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging automatically replies with a customizable message and adds the end recipient to the OptOutList.

When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out request. For more information see Self-managed opt-outs

Parameters:

selfManagedOptOutsEnabled - When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging automatically replies with a customizable message and adds the end recipient to the OptOutList. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-selfmanagedoptoutsenabled

selfManagedOptOutsEnabled

@Stability(Stable)
public CfnPhoneNumber.Builder selfManagedOptOutsEnabled(IResolvable selfManagedOptOutsEnabled)

When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging automatically replies with a customizable message and adds the end recipient to the OptOutList.

When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out request. For more information see Self-managed opt-outs

Parameters:

selfManagedOptOutsEnabled - When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging automatically replies with a customizable message and adds the end recipient to the OptOutList. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-selfmanagedoptoutsenabled

tags

@Stability(Stable)
public CfnPhoneNumber.Builder tags(List<? extends CfnTag> tags)

An array of tags (key and value pairs) to associate with the requested phone number.

Parameters:

tags - An array of tags (key and value pairs) to associate with the requested phone number. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-tags

twoWay

@Stability(Stable)
public CfnPhoneNumber.Builder twoWay(IResolvable twoWay)

Describes the two-way SMS configuration for a phone number.

For more information, see Two-way SMS messaging in the End User Messaging User Guide.

Parameters:

twoWay - Describes the two-way SMS configuration for a phone number. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-twoway

twoWay

@Stability(Stable)
public CfnPhoneNumber.Builder twoWay(CfnPhoneNumber.TwoWayProperty twoWay)

Describes the two-way SMS configuration for a phone number.

For more information, see Two-way SMS messaging in the End User Messaging User Guide.

Parameters:

twoWay - Describes the two-way SMS configuration for a phone number. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-twoway

build

@Stability(Stable)
public CfnPhoneNumber build()

Specified by:

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

Returns:

a newly built instance of CfnPhoneNumber.