interface CfnPoolProps

Language	Type name
.NET	Amazon.CDK.aws_smsvoice.CfnPoolProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awssmsvoice#CfnPoolProps
Java	software.amazon.awscdk.services.smsvoice.CfnPoolProps
Python	aws_cdk.aws_smsvoice.CfnPoolProps
TypeScript	aws-cdk-lib » aws_smsvoice » CfnPoolProps

Properties for defining a CfnPool.

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 { aws_smsvoice as smsvoice } from 'aws-cdk-lib';
const cfnPoolProps: smsvoice.CfnPoolProps = {
  mandatoryKeywords: {
    help: {
      message: 'message',
    },
    stop: {
      message: 'message',
    },
  },
  originationIdentities: ['originationIdentities'],

  // the properties below are optional
  deletionProtectionEnabled: false,
  optionalKeywords: [{
    action: 'action',
    keyword: 'keyword',
    message: 'message',
  }],
  optOutListName: 'optOutListName',
  selfManagedOptOutsEnabled: false,
  sharedRoutesEnabled: false,
  tags: [{
    key: 'key',
    value: 'value',
  }],
  twoWay: {
    enabled: false,

    // the properties below are optional
    channelArn: 'channelArn',
    channelRole: 'channelRole',
  },
};

Properties

Name	Type	Description
mandatoryKeywords	IResolvable | MandatoryKeywordsProperty	Creates or updates the pool's MandatoryKeyword configuration.
originationIdentities	string[]	The list of origination identities to apply to the pool, either PhoneNumberArn or SenderIdArn .
deletionProtectionEnabled?	boolean | IResolvable	When set to true the pool can't be deleted.
optOutListName?	string	The name of the OptOutList associated with the pool.
optionalKeywords?	IResolvable | IResolvable | OptionalKeywordProperty[]	Specifies any optional keywords to associate with the pool.
selfManagedOptOutsEnabled?	boolean | IResolvable	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.
sharedRoutesEnabled?	boolean | IResolvable	Allows you to enable shared routes on your pool.
tags?	CfnTag[]	An array of tags (key and value pairs) associated with the pool.
twoWay?	IResolvable | TwoWayProperty	Describes the two-way SMS configuration for a phone number.

---

mandatoryKeywords

Type: IResolvable | MandatoryKeywordsProperty

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

---

originationIdentities

Type: string[]

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

---

deletionProtectionEnabled?

Type: boolean | IResolvable (optional)

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

---

optOutListName?

Type: string (optional)

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

---

optionalKeywords?

Type: IResolvable | IResolvable | OptionalKeywordProperty[] (optional)

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

---

selfManagedOptOutsEnabled?

Type: boolean | IResolvable (optional)

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

---

sharedRoutesEnabled?

Type: boolean | IResolvable (optional)

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

---

tags?

Type: CfnTag[] (optional)

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

---

twoWay?

Type: IResolvable | TwoWayProperty (optional)

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