You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Lightsail::Types::InstanceSnapshot

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Describes an instance snapshot.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the snapshot (e.g., arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE).

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the snapshot (e.g., arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE).

#created_at ⇒ Time

The timestamp when the snapshot was created (e.g., 1479907467.024).

Returns:

  • (Time) —

    The timestamp when the snapshot was created (e.g., 1479907467.024).

#from_attached_disks ⇒ Array<Types::Disk>

An array of disk objects containing information about all block storage disks.

Returns:

  • (Array<Types::Disk>) —

    An array of disk objects containing information about all block storage disks.

#from_blueprint_id ⇒ String

The blueprint ID from which you created the snapshot (e.g., os_debian_8_3). A blueprint is a virtual private server (or instance) image used to create instances quickly.

Returns:

  • (String) —

    The blueprint ID from which you created the snapshot (e.g., os_debian_8_3).

#from_bundle_id ⇒ String

The bundle ID from which you created the snapshot (e.g., micro_1_0).

Returns:

  • (String) —

    The bundle ID from which you created the snapshot (e.g., micro_1_0).

#from_instance_arn ⇒ String

The Amazon Resource Name (ARN) of the instance from which the snapshot was created (e.g., arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the instance from which the snapshot was created (e.g., arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).

#from_instance_name ⇒ String

The instance from which the snapshot was created.

Returns:

  • (String) —

    The instance from which the snapshot was created.

#is_from_auto_snapshot ⇒ Boolean

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

Returns:

  • (Boolean) —

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

#location ⇒ Types::ResourceLocation

The region name and Availability Zone where you created the snapshot.

Returns:

#name ⇒ String

The name of the snapshot.

Returns:

  • (String) —

    The name of the snapshot.

#progress ⇒ String

The progress of the snapshot.

Returns:

  • (String) —

    The progress of the snapshot.

#resource_type ⇒ String

The type of resource (usually InstanceSnapshot).

Possible values:

  • ContainerService
  • Instance
  • StaticIp
  • KeyPair
  • InstanceSnapshot
  • Domain
  • PeeredVpc
  • LoadBalancer
  • LoadBalancerTlsCertificate
  • Disk
  • DiskSnapshot
  • RelationalDatabase
  • RelationalDatabaseSnapshot
  • ExportSnapshotRecord
  • CloudFormationStackRecord
  • Alarm
  • ContactMethod
  • Distribution
  • Certificate

Returns:

  • (String) —

    The type of resource (usually InstanceSnapshot).

#size_in_gb ⇒ Integer

The size in GB of the SSD.

Returns:

  • (Integer) —

    The size in GB of the SSD.

#state ⇒ String

The state the snapshot is in.

Possible values:

  • pending
  • error
  • available

Returns:

  • (String) —

    The state the snapshot is in.

#support_code ⇒ String

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.

Returns:

  • (String) —

    The support code.

#tags ⇒ Array<Types::Tag>

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

Returns:

  • (Array<Types::Tag>) —

    The tag keys and optional values for the resource.