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

Creates a new opt-out list.

If the opt-out list name already exists, an error is returned.

An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the Amazon End User Messaging SMS User Guide.

Syntax

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

JSON

{
  "Type" : "AWS::SMSVOICE::OptOutList",
  "Properties" : {
      "OptOutListName" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::SMSVOICE::OptOutList
Properties:
  OptOutListName: String
  Tags: 
    - Tag

Properties

OptOutListName

The name of the OptOutList.

Required: No

Type: String

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

Minimum: 1

Maximum: 64

Update requires: Replacement

Tags

An array of tags (key and value pairs) to associate with the new OptOutList.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

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

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 Amazon Resource Name (ARN) for the OptOutList.