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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb

Overview

Describes a system disk or an block storage disk.

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) of the disk.

Returns:

  • (String)


1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1519

class Disk < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :size_in_gb,
  :is_system_disk,
  :iops,
  :path,
  :state,
  :attached_to,
  :is_attached,
  :attachment_state,
  :gb_in_use)
  include Aws::Structure
end

#attached_toString

The resources to which the disk is attached.

Returns:

  • (String)


1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1519

class Disk < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :size_in_gb,
  :is_system_disk,
  :iops,
  :path,
  :state,
  :attached_to,
  :is_attached,
  :attachment_state,
  :gb_in_use)
  include Aws::Structure
end

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


1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1519

class Disk < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :size_in_gb,
  :is_system_disk,
  :iops,
  :path,
  :state,
  :attached_to,
  :is_attached,
  :attachment_state,
  :gb_in_use)
  include Aws::Structure
end

#created_atTime

The date when the disk was created.

Returns:

  • (Time)


1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1519

class Disk < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :size_in_gb,
  :is_system_disk,
  :iops,
  :path,
  :state,
  :attached_to,
  :is_attached,
  :attachment_state,
  :gb_in_use)
  include Aws::Structure
end

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


1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1519

class Disk < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :size_in_gb,
  :is_system_disk,
  :iops,
  :path,
  :state,
  :attached_to,
  :is_attached,
  :attachment_state,
  :gb_in_use)
  include Aws::Structure
end

#iopsInteger

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

Returns:

  • (Integer)


1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1519

class Disk < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :size_in_gb,
  :is_system_disk,
  :iops,
  :path,
  :state,
  :attached_to,
  :is_attached,
  :attachment_state,
  :gb_in_use)
  include Aws::Structure
end

#is_attachedBoolean

A Boolean value indicating whether the disk is attached.

Returns:

  • (Boolean)


1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1519

class Disk < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :size_in_gb,
  :is_system_disk,
  :iops,
  :path,
  :state,
  :attached_to,
  :is_attached,
  :attachment_state,
  :gb_in_use)
  include Aws::Structure
end

#is_system_diskBoolean

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

Returns:

  • (Boolean)


1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1519

class Disk < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :size_in_gb,
  :is_system_disk,
  :iops,
  :path,
  :state,
  :attached_to,
  :is_attached,
  :attachment_state,
  :gb_in_use)
  include Aws::Structure
end

#locationTypes::ResourceLocation

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



1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1519

class Disk < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :size_in_gb,
  :is_system_disk,
  :iops,
  :path,
  :state,
  :attached_to,
  :is_attached,
  :attachment_state,
  :gb_in_use)
  include Aws::Structure
end

#nameString

The unique name of the disk.

Returns:

  • (String)


1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1519

class Disk < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :size_in_gb,
  :is_system_disk,
  :iops,
  :path,
  :state,
  :attached_to,
  :is_attached,
  :attachment_state,
  :gb_in_use)
  include Aws::Structure
end

#pathString

The disk path.

Returns:

  • (String)


1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1519

class Disk < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :size_in_gb,
  :is_system_disk,
  :iops,
  :path,
  :state,
  :attached_to,
  :is_attached,
  :attachment_state,
  :gb_in_use)
  include Aws::Structure
end

#resource_typeString

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

Returns:

  • (String)


1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1519

class Disk < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :size_in_gb,
  :is_system_disk,
  :iops,
  :path,
  :state,
  :attached_to,
  :is_attached,
  :attachment_state,
  :gb_in_use)
  include Aws::Structure
end

#size_in_gbInteger

The size of the disk in GB.

Returns:

  • (Integer)


1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1519

class Disk < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :size_in_gb,
  :is_system_disk,
  :iops,
  :path,
  :state,
  :attached_to,
  :is_attached,
  :attachment_state,
  :gb_in_use)
  include Aws::Structure
end

#stateString

Describes the status of the disk.

Returns:

  • (String)


1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1519

class Disk < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :size_in_gb,
  :is_system_disk,
  :iops,
  :path,
  :state,
  :attached_to,
  :is_attached,
  :attachment_state,
  :gb_in_use)
  include Aws::Structure
end

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


1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1519

class Disk < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :size_in_gb,
  :is_system_disk,
  :iops,
  :path,
  :state,
  :attached_to,
  :is_attached,
  :attachment_state,
  :gb_in_use)
  include Aws::Structure
end