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 an block storage disk.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) of the disk.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of the disk.

#attached_toString

The resources to which the disk is attached.

Returns:

  • (String)

    The resources to which the disk is attached.

#attachment_stateString

(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_atTime

The date when the disk was created.

Returns:

  • (Time)

    The date when the disk was created.

#gb_in_useInteger

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

#iopsInteger

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

Returns:

  • (Integer)

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

#is_attachedBoolean

A Boolean value indicating whether the disk is attached.

Returns:

  • (Boolean)

    A Boolean value indicating whether the disk is attached.

#is_system_diskBoolean

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

#locationTypes::ResourceLocation

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

Returns:

#nameString

The unique name of the disk.

Returns:

  • (String)

    The unique name of the disk.

#pathString

The disk path.

Returns:

  • (String)

    The disk path.

#resource_typeString

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

Possible values:

  • Instance
  • StaticIp
  • KeyPair
  • InstanceSnapshot
  • Domain
  • PeeredVpc
  • LoadBalancer
  • LoadBalancerTlsCertificate
  • Disk
  • DiskSnapshot

Returns:

  • (String)

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

#size_in_gbInteger

The size of the disk in GB.

Returns:

  • (Integer)

    The size of the disk in GB.

#stateString

Describes the status of the disk.

Possible values:

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

Returns:

  • (String)

    Describes the status of the disk.

#support_codeString

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.