Package software.amazon.awscdk.services.smsvoice

Class CfnPool.Builder

java.lang.Object

software.amazon.awscdk.services.smsvoice.CfnPool.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnPool>

Enclosing class:

CfnPool

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

A fluent builder for CfnPool.

Method Summary

Modifier and Type	Method	Description
CfnPool	build()
static CfnPool.Builder	create(software.constructs.Construct scope, String id)
CfnPool.Builder	deletionProtectionEnabled(Boolean deletionProtectionEnabled)	When set to true the pool can't be deleted.
CfnPool.Builder	deletionProtectionEnabled(IResolvable deletionProtectionEnabled)	When set to true the pool can't be deleted.
CfnPool.Builder	mandatoryKeywords(IResolvable mandatoryKeywords)	Creates or updates the pool's MandatoryKeyword configuration.
CfnPool.Builder	mandatoryKeywords(CfnPool.MandatoryKeywordsProperty mandatoryKeywords)	Creates or updates the pool's MandatoryKeyword configuration.
CfnPool.Builder	optionalKeywords(List<? extends Object> optionalKeywords)	Specifies any optional keywords to associate with the pool.
CfnPool.Builder	optionalKeywords(IResolvable optionalKeywords)	Specifies any optional keywords to associate with the pool.
CfnPool.Builder	optOutListName(String optOutListName)	The name of the OptOutList associated with the pool.
CfnPool.Builder	originationIdentities(List<String> originationIdentities)	The list of origination identities to apply to the pool, either PhoneNumberArn or SenderIdArn .
CfnPool.Builder	selfManagedOptOutsEnabled(Boolean selfManagedOptOutsEnabled)	When set to false, 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.
CfnPool.Builder	selfManagedOptOutsEnabled(IResolvable selfManagedOptOutsEnabled)	When set to false, 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.
CfnPool.Builder	sharedRoutesEnabled(Boolean sharedRoutesEnabled)	Allows you to enable shared routes on your pool.
CfnPool.Builder	sharedRoutesEnabled(IResolvable sharedRoutesEnabled)	Allows you to enable shared routes on your pool.
CfnPool.Builder	tags(List<? extends CfnTag> tags)	An array of tags (key and value pairs) associated with the pool.
CfnPool.Builder	twoWay(IResolvable twoWay)	Describes the two-way SMS configuration for a phone number.
CfnPool.Builder	twoWay(CfnPool.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 CfnPool.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 CfnPool.Builder.

mandatoryKeywords

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

Creates or updates the pool's MandatoryKeyword configuration.

For more information, see Keywords in the End User Messaging User Guide.

Parameters:

mandatoryKeywords - Creates or updates the pool's MandatoryKeyword configuration. This parameter is required.

Returns:

this

See Also:

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

mandatoryKeywords

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

Creates or updates the pool's MandatoryKeyword configuration.

For more information, see Keywords in the End User Messaging User Guide.

Parameters:

mandatoryKeywords - Creates or updates the pool's MandatoryKeyword configuration. This parameter is required.

Returns:

this

See Also:

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

originationIdentities

@Stability(Stable)
public CfnPool.Builder originationIdentities(List<String> originationIdentities)

The list of origination identities to apply to the pool, either PhoneNumberArn or SenderIdArn .

For more information, see Registrations in the End User Messaging User Guide.

If you are using a shared End User Messaging resource then you must use the full Amazon Resource Name (ARN).

Parameters:

originationIdentities - The list of origination identities to apply to the pool, either PhoneNumberArn or SenderIdArn . This parameter is required.

Returns:

this

See Also:

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

deletionProtectionEnabled

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

When set to true the pool can't be deleted.

Parameters:

deletionProtectionEnabled - When set to true the pool can't be deleted. This parameter is required.

Returns:

this

See Also:

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

deletionProtectionEnabled

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

When set to true the pool can't be deleted.

Parameters:

deletionProtectionEnabled - When set to true the pool can't be deleted. This parameter is required.

Returns:

this

See Also:

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

optionalKeywords

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

Specifies any optional keywords to associate with the pool.

For more information, see Keywords in the End User Messaging User Guide.

Parameters:

optionalKeywords - Specifies any optional keywords to associate with the pool. This parameter is required.

Returns:

this

See Also:

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

optionalKeywords

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

Specifies any optional keywords to associate with the pool.

For more information, see Keywords in the End User Messaging User Guide.

Parameters:

optionalKeywords - Specifies any optional keywords to associate with the pool. This parameter is required.

Returns:

this

See Also:

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

optOutListName

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

The name of the OptOutList associated with the pool.

Parameters:

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

Returns:

this

See Also:

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

selfManagedOptOutsEnabled

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

When set to false, 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 requests. For more information see Self-managed opt-outs

Parameters:

selfManagedOptOutsEnabled - When set to false, 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-pool.html#cfn-smsvoice-pool-selfmanagedoptoutsenabled

selfManagedOptOutsEnabled

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

When set to false, 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 requests. For more information see Self-managed opt-outs

Parameters:

selfManagedOptOutsEnabled - When set to false, 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-pool.html#cfn-smsvoice-pool-selfmanagedoptoutsenabled

sharedRoutesEnabled

@Stability(Stable)
public CfnPool.Builder sharedRoutesEnabled(Boolean sharedRoutesEnabled)

Allows you to enable shared routes on your pool.

By default, this is set to False . If you set this value to True , your messages are sent using phone numbers or sender IDs (depending on the country) that are shared with other users. In some countries, such as the United States, senders aren't allowed to use shared routes and must use a dedicated phone number or short code.

Parameters:

sharedRoutesEnabled - Allows you to enable shared routes on your pool. This parameter is required.

Returns:

this

See Also:

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

sharedRoutesEnabled

@Stability(Stable)
public CfnPool.Builder sharedRoutesEnabled(IResolvable sharedRoutesEnabled)

Allows you to enable shared routes on your pool.

By default, this is set to False . If you set this value to True , your messages are sent using phone numbers or sender IDs (depending on the country) that are shared with other users. In some countries, such as the United States, senders aren't allowed to use shared routes and must use a dedicated phone number or short code.

Parameters:

sharedRoutesEnabled - Allows you to enable shared routes on your pool. This parameter is required.

Returns:

this

See Also:

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

tags

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

An array of tags (key and value pairs) associated with the pool.

Parameters:

tags - An array of tags (key and value pairs) associated with the pool. This parameter is required.

Returns:

this

See Also:

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

twoWay

@Stability(Stable)
public CfnPool.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-pool.html#cfn-smsvoice-pool-twoway

twoWay

@Stability(Stable)
public CfnPool.Builder twoWay(CfnPool.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-pool.html#cfn-smsvoice-pool-twoway

build

@Stability(Stable)
public CfnPool build()

Specified by:

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

Returns:

a newly built instance of CfnPool.