AWS::SMSVOICE::PhoneNumber - 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::PhoneNumber

Request an origination phone number for use in your account. For more information on phone number request see Request a phone number in the Amazon End User Messaging SMS User Guide.

Note

Registering phone numbers is not supported by Amazon CloudFormation. You can import phone numbers and sender IDs that are automatically provisioned at registration.

Syntax

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

JSON

{
  "Type" : "AWS::SMSVOICE::PhoneNumber",
  "Properties" : {
      "DeletionProtectionEnabled" : Boolean,
      "IsoCountryCode" : String,
      "MandatoryKeywords" : MandatoryKeywords,
      "NumberCapabilities" : [ String, ... ],
      "NumberType" : String,
      "OptionalKeywords" : [ OptionalKeyword, ... ],
      "OptOutListName" : String,
      "SelfManagedOptOutsEnabled" : Boolean,
      "Tags" : [ Tag, ... ],
      "TwoWay" : TwoWay
    }
}

Properties

DeletionProtectionEnabled

By default this is set to false. When set to true the phone number can't be deleted.

Required: No

Type: Boolean

Update requires: No interruption

IsoCountryCode

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

Required: Yes

Type: String

Pattern: ^[A-Z]{2}$

Update requires: Replacement

MandatoryKeywords

Creates or updates a MandatoryKeyword configuration on an origination phone number For more information, see Keywords in the Amazon End User Messaging SMS User Guide.

Required: Yes

Type: MandatoryKeywords

Update requires: No interruption

NumberCapabilities

Indicates if the phone number will be used for text messages, voice messages, or both.

Required: Yes

Type: Array of String

Allowed values: SMS | VOICE | MMS

Update requires: Replacement

NumberType

The type of phone number to request.

Note

The ShortCode number type is not supported in Amazon CloudFormation.

Required: Yes

Type: String

Allowed values: LONG_CODE | TOLL_FREE | TEN_DLC | SIMULATOR

Update requires: Replacement

OptionalKeywords

A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon End User Messaging SMS responds with a customizable message. Optional keywords are differentiated from mandatory keywords. 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 phone number.

Required: No

Type: String

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

Minimum: 1

Maximum: 256

Update requires: No interruption

SelfManagedOptOutsEnabled

When set to false and 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 request. For more information see Self-managed opt-outs

Required: No

Type: Boolean

Update requires: No interruption

Tags

An array of tags (key and value pairs) to associate with the requested phone number.

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

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The PhoneNumber's Amazon Resource Name (ARN)

PhoneNumber

The phone number in E.164 format.

PhoneNumberId

The unique identifier for the phone number.