AWS::Lightsail::DiskSnapshot - 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::Lightsail::DiskSnapshot

Describes a block storage disk snapshot.

Syntax

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

JSON

{
  "Type" : "AWS::Lightsail::DiskSnapshot",
  "Properties" : {
      "DiskName" : String,
      "DiskSnapshotName" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Lightsail::DiskSnapshot
Properties:
  DiskName: String
  DiskSnapshotName: String
  Tags: 
    - Tag

Properties

DiskName

The unique name of the disk.

Required: Yes

Type: String

Pattern: ^\w[\w\-]*\w$

Minimum: 2

Maximum: 255

Update requires: Replacement

DiskSnapshotName

The name of the disk snapshot (my-disk-snapshot).

Required: Yes

Type: String

Pattern: ^\w[\w\-]*\w$

Minimum: 2

Maximum: 255

Update requires: Replacement

Tags

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Return values

Ref

Fn::GetAtt

CreatedAt

The date when the disk snapshot was created.

DiskSnapshotArn

The Amazon Resource Name (ARN) of the disk snapshot.

FromDiskName

The unique name of the source disk from which the disk snapshot was created.

IsFromAutoSnapshot

A Boolean value indicating whether the snapshot was created from an automatic snapshot.

Progress

The progress of the snapshot.

ResourceType

The Lightsail resource type (DiskSnapshot).

SizeInGb

The size of the disk in GB.

State

The status of the disk snapshot operation.

SupportCode

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.