AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::SMSVOICE::Pool

CfnPool

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.

Import

import { CfnPool } from 'aws-cdk-lib/aws-smsvoice';

Or use the module namespace:

import * as smsvoice from 'aws-cdk-lib/aws-smsvoice';
// smsvoice.CfnPool

Properties

Configuration passed to the constructor as CfnPoolProps.

mandatoryKeywordsRequired
IResolvable | MandatoryKeywordsProperty

Creates or updates the pool's `MandatoryKeyword` configuration. For more information, see [Keywords](https://docs.aws.amazon.com/sms-voice/latest/userguide/keywords.html) in the End User Messaging User Guide.

originationIdentitiesRequired
string[]

The list of origination identities to apply to the pool, either `PhoneNumberArn` or `SenderIdArn` . For more information, see [Registrations](https://docs.aws.amazon.com/sms-voice/latest/userguide/registrations.html) 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).

deletionProtectionEnabledOptional
boolean | IResolvable

When set to true the pool can't be deleted.

optionalKeywordsOptional
IResolvable | IResolvable | OptionalKeywordProperty[]

Specifies any optional keywords to associate with the pool. For more information, see [Keywords](https://docs.aws.amazon.com/sms-voice/latest/userguide/keywords.html) in the End User Messaging User Guide.

optOutListNameOptional
string

The name of the OptOutList associated with the pool.

selfManagedOptOutsEnabledOptional
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. 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](https://docs.aws.amazon.com//pinpoint/latest/userguide/settings-sms-managing.html#settings-account-sms-self-managed-opt-out)

sharedRoutesEnabledOptional
boolean | IResolvable

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.

tagsOptional
CfnTag[]

An array of tags (key and value pairs) associated with the pool.

twoWayOptional
IResolvable | TwoWayProperty

Describes the two-way SMS configuration for a phone number. For more information, see [Two-way SMS messaging](https://docs.aws.amazon.com/sms-voice/latest/userguide/two-way-sms.html) in the End User Messaging User Guide.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::SMSVOICE::PoolView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-smsvoice
CFN TypeAWS::SMSVOICE::Pool
Properties9

Related Constructs

Explore This Service

External Links