View a markdown version of this page

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

Create a new registration attachment to use for uploading a file or a URL to a file. The maximum file size is 5MB and valid file extensions are PDF, JPEG and PNG. For example, many sender ID registrations require a signed “letter of authorization” (LOA) to be submitted.

Use either AttachmentUrl or AttachmentBody to upload your attachment. If both are specified then an exception is returned.

Syntax

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

JSON

{
  "Type" : "AWS::SMSVOICE::RegistrationAttachment",
  "Properties" : {
      "AttachmentBody" : String,
      "AttachmentUrl" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::SMSVOICE::RegistrationAttachment
Properties:
  AttachmentBody: String
  AttachmentUrl: String
  Tags: 
    - Tag

Properties

AttachmentBody

Property description not available.

Required: No

Type: String

Minimum: 1

Update requires: Replacement

AttachmentUrl

The URL to the document that's associated with the registration attachment.

Required: No

Type: String

Pattern: ^\S+$

Minimum: 1

Maximum: 2048

Update requires: Replacement

Tags

Property description not available.

Required: No

Type: Array of Tag

Maximum: 200

Update requires: No interruption

Return values

Ref

Fn::GetAtt

AttachmentStatus

The status of the registration attachment.

  • UPLOAD_IN_PROGRESS The attachment is being uploaded.

  • UPLOAD_COMPLETE The attachment has been uploaded.

  • UPLOAD_FAILED The attachment failed to uploaded.

  • DELETED The attachment has been deleted..

CreatedTimestamp

The time when the registration attachment was created, in UNIX epoch time format.

RegistrationAttachmentArn

The Amazon Resource Name (ARN) for the registration attachment.

RegistrationAttachmentId

The unique identifier for the registration attachment.

UploadedAttachmentUrl

Property description not available.