DiskSnapshot - Amazon Lightsail

DiskSnapshot

Describes a block storage disk snapshot.

Contents

arn

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

Type: String

Pattern: .*\S.*

Required: No

createdAt

The date when the disk snapshot was created.

Type: Timestamp

Required: No

fromDiskArn

The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was created.

Type: String

Pattern: .*\S.*

Required: No

fromDiskName

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

Type: String

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

Required: No

fromInstanceArn

The Amazon Resource Name (ARN) of the source instance from which the disk (system volume) snapshot was created.

Type: String

Pattern: .*\S.*

Required: No

fromInstanceName

The unique name of the source instance from which the disk (system volume) snapshot was created.

Type: String

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

Required: No

isFromAutoSnapshot

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

Type: Boolean

Required: No

location

The AWS Region and Availability Zone where the disk snapshot was created.

Type: ResourceLocation object

Required: No

name

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

Type: String

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

Required: No

progress

The progress of the snapshot.

Type: String

Required: No

resourceType

The Lightsail resource type (DiskSnapshot).

Type: String

Valid Values: ContainerService | Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord | Alarm | ContactMethod | Distribution | Certificate | Bucket

Required: No

sizeInGb

The size of the disk in GB.

Type: Integer

Required: No

state

The status of the disk snapshot operation.

Type: String

Valid Values: pending | completed | error | unknown

Required: No

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.

Type: String

Required: No

tags

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

Type: Array of Tag objects

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: