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

Class: Aws::Lightsail::Types::Disk

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

Overview

Describes a system disk or a block storage disk.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#add_ons ⇒ Array<Types::AddOn>

An array of objects representing the add-ons enabled on the disk.

Returns:

  • (Array<Types::AddOn>) —

    An array of objects representing the add-ons enabled on the disk.

#arn ⇒ String

The Amazon Resource Name (ARN) of the disk.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the disk.

#attached_to ⇒ String

The resources to which the disk is attached.

Returns:

  • (String) —

    The resources to which the disk is attached.

#attachment_state ⇒ String

(Deprecated) The attachment state of the disk.

In releases prior to November 14, 2017, this parameter returned attached for system disks in the API response. It is now deprecated, but still included in the response. Use isAttached instead.

Returns:

  • (String) —

    (Deprecated) The attachment state of the disk.

#created_at ⇒ Time

The date when the disk was created.

Returns:

  • (Time) —

    The date when the disk was created.

#gb_in_use ⇒ Integer

(Deprecated) The number of GB in use by the disk.

In releases prior to November 14, 2017, this parameter was not included in the API response. It is now deprecated.

Returns:

  • (Integer) —

    (Deprecated) The number of GB in use by the disk.

#iops ⇒ Integer

The input/output operations per second (IOPS) of the disk.

Returns:

  • (Integer) —

    The input/output operations per second (IOPS) of the disk.

#is_attached ⇒ Boolean

A Boolean value indicating whether the disk is attached.

Returns:

  • (Boolean) —

    A Boolean value indicating whether the disk is attached.

#is_system_disk ⇒ Boolean

A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).

Returns:

  • (Boolean) —

    A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).

#location ⇒ Types::ResourceLocation

The AWS Region and Availability Zone where the disk is located.

Returns:

#name ⇒ String

The unique name of the disk.

Returns:

  • (String) —

    The unique name of the disk.

#path ⇒ String

The disk path.

Returns:

  • (String) —

    The disk path.

#resource_type ⇒ String

The Lightsail resource type (e.g., Disk).

Possible values:

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

Returns:

  • (String) —

    The Lightsail resource type (e.g., Disk).

#size_in_gb ⇒ Integer

The size of the disk in GB.

Returns:

  • (Integer) —

    The size of the disk in GB.

#state ⇒ String

Describes the status of the disk.

Possible values:

  • pending
  • error
  • available
  • in-use
  • unknown

Returns:

  • (String) —

    Describes the status of the disk.

#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.