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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

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:



4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4420

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

#arn ⇒ String

The Amazon Resource Name (ARN) of the disk.

Returns:

  • (String) 


4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4420

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

#attached_to ⇒ String

The resources to which the disk is attached.

Returns:

  • (String) 


4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4420

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

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


4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4420

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

#created_at ⇒ Time

The date when the disk was created.

Returns:

  • (Time) 


4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4420

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

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


4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4420

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

#iops ⇒ Integer

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

Returns:

  • (Integer) 


4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4420

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

#is_attached ⇒ Boolean

A Boolean value indicating whether the disk is attached.

Returns:

  • (Boolean) 


4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4420

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

#is_system_disk ⇒ Boolean

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

Returns:

  • (Boolean) 


4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4420

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

#location ⇒ Types::ResourceLocation

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

Returns:



4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4420

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

#name ⇒ String

The unique name of the disk.

Returns:

  • (String) 


4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4420

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

#path ⇒ String

The disk path.

Returns:

  • (String) 


4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4420

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

#resource_type ⇒ String

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

Returns:

  • (String) 


4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4420

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

#size_in_gb ⇒ Integer

The size of the disk in GB.

Returns:

  • (Integer) 


4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4420

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

#state ⇒ String

Describes the status of the disk.

Returns:

  • (String) 


4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4420

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

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


4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4420

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

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



4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
 
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 4420

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