Package software.amazon.awscdk.services.smsvoice

Interface CfnPhoneNumberProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPhoneNumberProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:10:14.601Z")
@Stability(Stable)
public interface CfnPhoneNumberProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnPhoneNumber.

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.*;
 CfnPhoneNumberProps cfnPhoneNumberProps = CfnPhoneNumberProps.builder()
         .isoCountryCode("isoCountryCode")
         .mandatoryKeywords(MandatoryKeywordsProperty.builder()
                 .help(MandatoryKeywordProperty.builder()
                         .message("message")
                         .build())
                 .stop(MandatoryKeywordProperty.builder()
                         .message("message")
                         .build())
                 .build())
         .numberCapabilities(List.of("numberCapabilities"))
         .numberType("numberType")
         // the properties below are optional
         .deletionProtectionEnabled(false)
         .optionalKeywords(List.of(OptionalKeywordProperty.builder()
                 .action("action")
                 .keyword("keyword")
                 .message("message")
                 .build()))
         .optOutListName("optOutListName")
         .selfManagedOptOutsEnabled(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-phonenumber.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnPhoneNumberProps.Builder	builder()
default Object	getDeletionProtectionEnabled()	By default this is set to false.
String	getIsoCountryCode()	The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
Object	getMandatoryKeywords()	Creates or updates a MandatoryKeyword configuration on an origination phone number For more information, see Keywords in the End User Messaging User Guide.
List<String>	getNumberCapabilities()	Indicates if the phone number will be used for text messages, voice messages, or both.
String	getNumberType()	The type of phone number to request.
default Object	getOptionalKeywords()	A keyword is a word that you can search for on a particular phone number or pool.
default String	getOptOutListName()	The name of the OptOutList associated with the phone number.
default Object	getSelfManagedOptOutsEnabled()	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.
default List<CfnTag>	getTags()	An array of tags (key and value pairs) to associate with the requested phone number.
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

getIsoCountryCode

@Stability(Stable)
@NotNull
String getIsoCountryCode()

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

See Also:

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

getMandatoryKeywords

@Stability(Stable)
@NotNull
Object getMandatoryKeywords()

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

Returns union: either IResolvable or CfnPhoneNumber.MandatoryKeywordsProperty

See Also:

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

getNumberCapabilities

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

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

See Also:

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

getNumberType

@Stability(Stable)
@NotNull
String getNumberType()

The type of phone number to request.

The ShortCode number type is not supported in AWS CloudFormation .

See Also:

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

getDeletionProtectionEnabled

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

By default this is set to false.

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

Returns union: either Boolean or IResolvable

See Also:

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

getOptionalKeywords

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

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnPhoneNumber.OptionalKeywordProperty>

See Also:

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

getOptOutListName

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

The name of the OptOutList associated with the phone number.

See Also:

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

getSelfManagedOptOutsEnabled

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

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

Returns union: either Boolean or IResolvable

See Also:

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

getTags

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-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.

Returns union: either IResolvable or CfnPhoneNumber.TwoWayProperty

See Also:

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

builder

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

Returns:

a CfnPhoneNumberProps.Builder of CfnPhoneNumberProps