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

Class CfnPoolPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.smsvoice.CfnPoolPropsMixin

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.635Z")
@Stability(Stable)
public class CfnPoolPropsMixin
extends Mixin
implements software.constructs.IMixin

Creates a new pool and associates the specified origination identity to the pool.

A pool can include one or more phone numbers and SenderIds that are associated with your AWS account.

The new pool inherits its configuration from the specified origination identity. This includes keywords, message type, opt-out list, two-way configuration, and self-managed opt-out configuration. Deletion protection isn't inherited from the origination identity and defaults to false.

If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.

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;
 CfnPoolPropsMixin cfnPoolPropsMixin = CfnPoolPropsMixin.Builder.create(CfnPoolMixinProps.builder()
         .deletionProtectionEnabled(false)
         .mandatoryKeywords(MandatoryKeywordsProperty.builder()
                 .help(MandatoryKeywordProperty.builder()
                         .message("message")
                         .build())
                 .stop(MandatoryKeywordProperty.builder()
                         .message("message")
                         .build())
                 .build())
         .optionalKeywords(List.of(OptionalKeywordProperty.builder()
                 .action("action")
                 .keyword("keyword")
                 .message("message")
                 .build()))
         .optOutListName("optOutListName")
         .originationIdentities(List.of("originationIdentities"))
         .selfManagedOptOutsEnabled(false)
         .sharedRoutesEnabled(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-pool.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnPoolPropsMixin.Builder	A fluent builder for CfnPoolPropsMixin.
static interface	CfnPoolPropsMixin.MandatoryKeywordProperty	The keywords HELP and STOP are mandatory keywords that each phone number must have.
static interface	CfnPoolPropsMixin.MandatoryKeywordsProperty	The manadatory keywords, HELP and STOP to add to the pool.
static interface	CfnPoolPropsMixin.OptionalKeywordProperty	The pool's OptionalKeyword configuration.
static interface	CfnPoolPropsMixin.TwoWayProperty	The pool'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
	CfnPoolPropsMixin(CfnPoolMixinProps props)	Create a mixin to apply properties to AWS::SMSVOICE::Pool.
	CfnPoolPropsMixin(CfnPoolMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::SMSVOICE::Pool.
protected	CfnPoolPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPoolPropsMixin(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 CfnPoolMixinProps	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

CfnPoolPropsMixin

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

CfnPoolPropsMixin

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

CfnPoolPropsMixin

@Stability(Stable)
public CfnPoolPropsMixin(@NotNull
 CfnPoolMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

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

Parameters:

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

options - Mixin options.

CfnPoolPropsMixin

@Stability(Stable)
public CfnPoolPropsMixin(@NotNull
 CfnPoolMixinProps props)

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

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 CfnPoolMixinProps getProps()

getStrategy

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