Package software.amazon.awscdk.cfnpropertymixins.services.smsvoice

Class CfnPhoneNumberPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.smsvoice.CfnPhoneNumberPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:05.618Z")
@Stability(Stable)
public class CfnPhoneNumberPropsMixin
extends Mixin
implements software.constructs.IMixin

Request an origination phone number for use in your account.

For more information on phone number request see Request a phone number in the End User Messaging User Guide .

Registering phone numbers is not supported by AWS CloudFormation . You can import phone numbers and sender IDs that are automatically provisioned at registration.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.smsvoice.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnPhoneNumberPropsMixin cfnPhoneNumberPropsMixin = CfnPhoneNumberPropsMixin.Builder.create(CfnPhoneNumberMixinProps.builder()
         .deletionProtectionEnabled(false)
         .isoCountryCode("isoCountryCode")
         .mandatoryKeywords(MandatoryKeywordsProperty.builder()
                 .help(MandatoryKeywordProperty.builder()
                         .message("message")
                         .build())
                 .stop(MandatoryKeywordProperty.builder()
                         .message("message")
                         .build())
                 .build())
         .numberCapabilities(List.of("numberCapabilities"))
         .numberType("numberType")
         .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()
                 .channelArn("channelArn")
                 .channelRole("channelRole")
                 .enabled(false)
                 .build())
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnPhoneNumberPropsMixin.Builder	A fluent builder for CfnPhoneNumberPropsMixin.
static interface	CfnPhoneNumberPropsMixin.MandatoryKeywordProperty	The keywords HELP and STOP are mandatory keywords that each phone number must have.
static interface	CfnPhoneNumberPropsMixin.MandatoryKeywordsProperty	The keywords HELP and STOP are mandatory keywords that each phone number must have.
static interface	CfnPhoneNumberPropsMixin.OptionalKeywordProperty	The OptionalKeyword configuration.
static interface	CfnPhoneNumberPropsMixin.TwoWayProperty	The phone number's two-way SMS configuration object.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnPhoneNumberPropsMixin(CfnPhoneNumberMixinProps props)	Create a mixin to apply properties to AWS::SMSVOICE::PhoneNumber.
	CfnPhoneNumberPropsMixin(CfnPhoneNumberMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::SMSVOICE::PhoneNumber.
protected	CfnPhoneNumberPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPhoneNumberPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnPhoneNumberMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnPhoneNumberPropsMixin

protected CfnPhoneNumberPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnPhoneNumberPropsMixin

protected CfnPhoneNumberPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnPhoneNumberPropsMixin

@Stability(Stable)
public CfnPhoneNumberPropsMixin(@NotNull
 CfnPhoneNumberMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::SMSVOICE::PhoneNumber.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnPhoneNumberPropsMixin

@Stability(Stable)
public CfnPhoneNumberPropsMixin(@NotNull
 CfnPhoneNumberMixinProps props)

Create a mixin to apply properties to AWS::SMSVOICE::PhoneNumber.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnPhoneNumberMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()