AWS::Lightsail::DiskSnapshot

Lightsail DiskSnapshot

Resource Type definition for AWS::Lightsail::DiskSnapshot

Properties

3 configurable properties. 2 required. Click a row to see details.

Filter:

Property	Type	Flags
`DiskName`	`string`	RequiredCreate-only
`DiskSnapshotName`	`string`	RequiredCreate-only
`Tags`	`Array<Tag>`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`CreatedAt`	`string`	The timestamp when the disk snapshot was created.
`DiskSnapshotArn`	`string`	The Amazon Resource Name (ARN) of the disk snapshot.
`FromDiskName`	`string`	The name of the source disk from which the disk snapshot was created.
`IsFromAutoSnapshot`	`boolean`	A Boolean value indicating whether the snapshot was created from an automatic snapshot.
`Location`	`object`	The AWS Region and Availability Zone where the disk snapshot was created.
`Progress`	`string`	The progress of the disk snapshot creation operation.
`ResourceType`	`string`	The Lightsail resource type (DiskSnapshot).
`SizeInGb`	`integer`	The size of the disk snapshot in GB.
`State`	`string`	The status of the disk snapshot operation.
`SupportCode`	`string`	The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Lightsail::DiskSnapshot

Resources:
  MyResource:
    Type: AWS::Lightsail::DiskSnapshot
    Properties:
      DiskSnapshotName: "my-disksnapshotname"
      DiskName: "my-diskname"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

lightsail:CreateDiskSnapshotlightsail:GetDiskSnapshotlightsail:TagResource

read

lightsail:GetDiskSnapshot

update

lightsail:GetDiskSnapshotlightsail:TagResourcelightsail:UntagResource

delete

lightsail:DeleteDiskSnapshotlightsail:GetDiskSnapshot

list

lightsail:GetDiskSnapshots

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceLightsail

Properties13

Required2

TaggingSupported

Primary IDDiskSnapshotName

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

DiskSnapshotNameDiskName

Related Resources

External Links

AWS Documentation