class CfnPoolPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.SMSVOICE.Mixins.CfnPoolPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awssmsvoice/mixins#CfnPoolPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.smsvoice.mixins.CfnPoolPropsMixin
Python	aws_cdk.mixins_preview.aws_smsvoice.mixins.CfnPoolPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_smsvoice » mixins » CfnPoolPropsMixin

Implements IMixin

Extends Mixin

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.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as smsvoice_mixins } from '@aws-cdk/mixins-preview/aws-smsvoice';
const cfnPoolPropsMixin = new smsvoice_mixins.CfnPoolPropsMixin({
  deletionProtectionEnabled: false,
  mandatoryKeywords: {
    help: {
      message: 'message',
    },
    stop: {
      message: 'message',
    },
  },
  optionalKeywords: [{
    action: 'action',
    keyword: 'keyword',
    message: 'message',
  }],
  optOutListName: 'optOutListName',
  originationIdentities: ['originationIdentities'],
  selfManagedOptOutsEnabled: false,
  sharedRoutesEnabled: false,
  tags: [{
    key: 'key',
    value: 'value',
  }],
  twoWay: {
    channelArn: 'channelArn',
    channelRole: 'channelRole',
    enabled: false,
  },
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnPoolPropsMixin(props: CfnPoolMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnPoolMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

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

Properties

Name	Type	Description
props	CfnPoolMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnPoolMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.