Package software.amazon.awscdk.services.smsvoice

Interface CfnPoolProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPoolProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-09-25T11:29:17.639Z")
@Stability(Stable)
public interface CfnPoolProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnPool.

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.smsvoice.*;
 CfnPoolProps cfnPoolProps = CfnPoolProps.builder()
         .mandatoryKeywords(MandatoryKeywordsProperty.builder()
                 .help(MandatoryKeywordProperty.builder()
                         .message("message")
                         .build())
                 .stop(MandatoryKeywordProperty.builder()
                         .message("message")
                         .build())
                 .build())
         .originationIdentities(List.of("originationIdentities"))
         // the properties below are optional
         .deletionProtectionEnabled(false)
         .optionalKeywords(List.of(OptionalKeywordProperty.builder()
                 .action("action")
                 .keyword("keyword")
                 .message("message")
                 .build()))
         .optOutListName("optOutListName")
         .selfManagedOptOutsEnabled(false)
         .sharedRoutesEnabled(false)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .twoWay(TwoWayProperty.builder()
                 .enabled(false)
                 // the properties below are optional
                 .channelArn("channelArn")
                 .channelRole("channelRole")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPoolProps.Builder	A builder for CfnPoolProps
static final class	CfnPoolProps.Jsii$Proxy	An implementation for CfnPoolProps

Method Summary

Modifier and Type	Method	Description
static CfnPoolProps.Builder	builder()
default Object	getDeletionProtectionEnabled()	When set to true the pool can't be deleted.
Object	getMandatoryKeywords()	Creates or updates the pool's MandatoryKeyword configuration.
default Object	getOptionalKeywords()	Specifies any optional keywords to associate with the pool.
default String	getOptOutListName()	The name of the OptOutList associated with the pool.
List<String>	getOriginationIdentities()	The list of origination identities to apply to the pool, either PhoneNumberArn or SenderIdArn .
default Object	getSelfManagedOptOutsEnabled()	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.
default Object	getSharedRoutesEnabled()	Allows you to enable shared routes on your pool.
default List<CfnTag>	getTags()	An array of tags (key and value pairs) associated with the pool.
default Object	getTwoWay()	Describes the two-way SMS configuration for a phone number.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMandatoryKeywords

@Stability(Stable)
@NotNull
Object getMandatoryKeywords()

Creates or updates the pool's MandatoryKeyword configuration.

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

See Also:

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

getOriginationIdentities

@Stability(Stable)
@NotNull
List<String> getOriginationIdentities()

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).

See Also:

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

getDeletionProtectionEnabled

@Stability(Stable)
@Nullable
default Object getDeletionProtectionEnabled()

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

See Also:

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

getOptionalKeywords

@Stability(Stable)
@Nullable
default Object getOptionalKeywords()

Specifies any optional keywords to associate with the pool.

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

See Also:

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

getOptOutListName

@Stability(Stable)
@Nullable
default String getOptOutListName()

The name of the OptOutList associated with the pool.

See Also:

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

getSelfManagedOptOutsEnabled

@Stability(Stable)
@Nullable
default Object getSelfManagedOptOutsEnabled()

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

See Also:

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

getSharedRoutesEnabled

@Stability(Stable)
@Nullable
default Object getSharedRoutesEnabled()

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.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

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

getTwoWay

@Stability(Stable)
@Nullable
default Object getTwoWay()

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.

See Also:

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

builder

@Stability(Stable)
static CfnPoolProps.Builder builder()

Returns:

a CfnPoolProps.Builder of CfnPoolProps