View a markdown version of this page

AWS::SMSVOICE::NotifyConfiguration - AWS CloudFormation
SyntaxPropertiesReturn values

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

AWS::SMSVOICE::NotifyConfiguration

Creates a new notify configuration for managed messaging. A notify configuration defines the settings for sending templated messages, including the display name, use case, enabled channels, and enabled countries.

Syntax

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

JSON

{
  "Type" : "AWS::SMSVOICE::NotifyConfiguration",
  "Properties" : {
      "DefaultTemplateId" : String,
      "DeletionProtectionEnabled" : Boolean,
      "DisplayName" : String,
      "EnabledChannels" : [ String, ... ],
      "EnabledCountries" : [ String, ... ],
      "PoolId" : String,
      "Tags" : [ Tag, ... ],
      "UseCase" : String
    }
}

YAML

Type: AWS::SMSVOICE::NotifyConfiguration
Properties:
  DefaultTemplateId: String
  DeletionProtectionEnabled: Boolean
  DisplayName: String
  EnabledChannels: 
    - String
  EnabledCountries: 
    - String
  PoolId: String
  Tags: 
    - Tag
  UseCase: String

Properties

DefaultTemplateId

The default template identifier associated with the notify configuration.

Required: No

Type: String

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

Maximum: 256

Update requires: No interruption

DeletionProtectionEnabled

When set to true deletion protection is enabled. By default this is set to false.

Required: No

Type: Boolean

Update requires: No interruption

DisplayName

The display name associated with the notify configuration.

Required: Yes

Type: String

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

Minimum: 1

Maximum: 15

Update requires: Replacement

EnabledChannels

An array of channels enabled for the notify configuration. Supported values include SMS and VOICE.

Required: Yes

Type: Array of String

Allowed values: SMS | VOICE | MMS | RCS

Minimum: 1

Maximum: 4

Update requires: No interruption

EnabledCountries

An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.

Required: No

Type: Array of String

Minimum: 2

Maximum: 2 | 300

Update requires: No interruption

PoolId

The identifier of the pool associated with the notify configuration.

Required: No

Type: String

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

Minimum: 1

Maximum: 256

Update requires: No interruption

Tags

Property description not available.

Required: No

Type: Array of Tag

Maximum: 200

Update requires: No interruption

UseCase

The use case for the notify configuration.

Required: Yes

Type: String

Allowed values: CODE_VERIFICATION

Update requires: Replacement

Return values

Ref

Fn::GetAtt

CreatedTimestamp

The time when the notify configuration was created, in UNIX epoch time format.

NotifyConfigurationArn

The Amazon Resource Name (ARN) for the notify configuration.

NotifyConfigurationId

The unique identifier for the notify configuration.

Status

The current status of the notify configuration.

Tier

The tier of the notify configuration.

TierUpgradeStatus

The tier upgrade status of the notify configuration.