InstanceSnapshot
Describes an instance snapshot.
Contents
- arn
-
The Amazon Resource Name (ARN) of the snapshot (
arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE).Type: String
Pattern:
.*\S.*Required: No
- createdAt
-
The timestamp when the snapshot was created (
1479907467.024).Type: Timestamp
Required: No
- fromAttachedDisks
-
An array of disk objects containing information about all block storage disks.
Type: Array of Disk objects
Required: No
- fromBlueprintId
-
The blueprint ID from which you created the snapshot (
amazon_linux_2023). A blueprint is a virtual private server (or instance) image used to create instances quickly.Type: String
Required: No
- fromBundleId
-
The bundle ID from which you created the snapshot (
micro_x_x).Type: String
Required: No
- fromInstanceArn
-
The Amazon Resource Name (ARN) of the instance from which the snapshot was created (
arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).Type: String
Pattern:
.*\S.*Required: No
- fromInstanceName
-
The instance from which the snapshot was created.
Type: String
Pattern:
\w[\w\-]*\wRequired: No
- isFromAutoSnapshot
-
A Boolean value indicating whether the snapshot was created from an automatic snapshot.
Type: Boolean
Required: No
- location
-
The region name and Availability Zone where you created the snapshot.
Type: ResourceLocation object
Required: No
- name
-
The name of the snapshot.
Type: String
Pattern:
\w[\w\-]*\wRequired: No
- progress
-
The progress of the snapshot.
Note
This is populated only for disk snapshots, and is
nullfor instance snapshots.Type: String
Required: No
- resourceType
-
The type of resource (usually
InstanceSnapshot).Type: String
Valid Values:
ContainerService | Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord | Alarm | ContactMethod | Distribution | Certificate | BucketRequired: No
- sizeInGb
-
The size in GB of the SSD.
Type: Integer
Required: No
- state
-
The state the snapshot is in.
Type: String
Valid Values:
pending | error | availableRequired: 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
-
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:
