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

Request a new sender ID that doesn't require registration.

Syntax

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

JSON

{
  "Type" : "AWS::SMSVOICE::SenderId",
  "Properties" : {
      "DeletionProtectionEnabled" : Boolean,
      "IsoCountryCode" : String,
      "SenderId" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::SMSVOICE::SenderId
Properties:
  DeletionProtectionEnabled: Boolean
  IsoCountryCode: String
  SenderId: String
  Tags: 
    - Tag

Properties

DeletionProtectionEnabled

By default this is set to false. When set to true the sender ID 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

SenderId

The sender ID string to request.

Required: Yes

Type: String

Pattern: ^[A-Z0-9_-]+$

Update requires: Replacement

Tags

An array of tags (key and value pairs) to associate with the sender ID.

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 returnsIsoCountryCode|SenderId.

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 of the SenderId.