AWS::SMSVOICE::Pool - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::SMSVOICE::Pool

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 Amazon 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.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::SMSVOICE::Pool",
  "Properties" : {
      "DeletionProtectionEnabled" : Boolean,
      "MandatoryKeywords" : MandatoryKeywords,
      "OptionalKeywords" : [ OptionalKeyword, ... ],
      "OptOutListName" : String,
      "OriginationIdentities" : [ String, ... ],
      "SelfManagedOptOutsEnabled" : Boolean,
      "SharedRoutesEnabled" : Boolean,
      "Tags" : [ Tag, ... ],
      "TwoWay" : TwoWay
    }
}

Properties

DeletionProtectionEnabled

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

Required: No

Type: Boolean

Update requires: No interruption

MandatoryKeywords

Creates or updates the pool's MandatoryKeyword configuration. For more information, see Keywords in the Amazon End User Messaging SMS User Guide.

Required: Yes

Type: MandatoryKeywords

Update requires: No interruption

OptionalKeywords

Specifies any optional keywords to associate with the pool. For more information, see Keywords in the Amazon End User Messaging SMS User Guide.

Required: No

Type: Array of OptionalKeyword

Update requires: No interruption

OptOutListName

The name of the OptOutList associated with the pool.

Required: No

Type: String

Pattern: ^[A-Za-z0-9_:/-]+$

Minimum: 1

Maximum: 256

Update requires: No interruption

OriginationIdentities

The list of origination identities to apply to the pool, either PhoneNumberArn or SenderIdArn. For more information, see Registrations in the Amazon End User Messaging SMS User Guide.

Important

If you are using a shared Amazon End User Messaging SMS resource then you must use the full Amazon Resource Name (ARN).

Required: Yes

Type: Array of String

Maximum: 256

Minimum: 20 | 1

Update requires: No interruption

SelfManagedOptOutsEnabled

When set to false, an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon End User Messaging SMS 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

Required: No

Type: Boolean

Update requires: No interruption

SharedRoutesEnabled

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.

Required: No

Type: Boolean

Update requires: No interruption

Tags

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

Required: No

Type: Array of Tag

Update requires: No interruption

TwoWay

Describes the two-way SMS configuration for a phone number. For more information, see Two-way SMS messaging in the Amazon End User Messaging SMS User Guide.

Required: No

Type: TwoWay

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returnsPoolId.

Fn::GetAtt

Arn

The Amazon Resource Name of the Pool.

PoolId

The unique identifier for the pool.