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 the hard disk (an SSD).

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) of the disk.

Returns:

  • (String)


892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 892

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

#attached_toString

The resources to which the disk is attached.

Returns:

  • (String)


892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 892

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

#attachment_stateString

The attachment state of the disk.

Returns:

  • (String)


892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 892

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

#created_atTime

The date when the disk was created.

Returns:

  • (Time)


892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 892

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

#gb_in_useInteger

The number of GB in use by the disk.

Returns:

  • (Integer)


892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 892

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

#iopsInteger

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

Returns:

  • (Integer)


892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 892

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

#is_attachedBoolean

A Boolean value indicating whether the disk is attached.

Returns:

  • (Boolean)


892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 892

class Disk < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :size_in_gb,
  :gb_in_use,
  :is_system_disk,
  :iops,
  :path,
  :attached_to,
  :is_attached,
  :attachment_state)
  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)


892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 892

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

#locationTypes::ResourceLocation

The region and Availability Zone where the disk is located.



892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 892

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

#nameString

The name of the disk.

Returns:

  • (String)


892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 892

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

#pathString

The disk path.

Returns:

  • (String)


892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 892

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

#resource_typeString

The resource type of the disk.

Returns:

  • (String)


892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 892

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

#size_in_gbInteger

The size of the disk in GB.

Returns:

  • (Integer)


892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 892

class Disk < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :size_in_gb,
  :gb_in_use,
  :is_system_disk,
  :iops,
  :path,
  :attached_to,
  :is_attached,
  :attachment_state)
  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)


892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 892

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