Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Lightsail.Types.Disk

Description

Synopsis

data Disk = Disk' {
- state :: Maybe DiskState
- resourceType :: Maybe ResourceType
- arn :: Maybe Text
- path :: Maybe Text
- createdAt :: Maybe POSIX
- location :: Maybe ResourceLocation
- iops :: Maybe Int
- isAttached :: Maybe Bool
- addOns :: Maybe [AddOn]
- attachmentState :: Maybe Text
- name :: Maybe Text
- sizeInGb :: Maybe Int
- supportCode :: Maybe Text
- isSystemDisk :: Maybe Bool
- attachedTo :: Maybe Text
- gbInUse :: Maybe Int
- tags :: Maybe [Tag]
}
newDisk :: Disk
disk_state :: Lens' Disk (Maybe DiskState)
disk_resourceType :: Lens' Disk (Maybe ResourceType)
disk_arn :: Lens' Disk (Maybe Text)
disk_path :: Lens' Disk (Maybe Text)
disk_createdAt :: Lens' Disk (Maybe UTCTime)
disk_location :: Lens' Disk (Maybe ResourceLocation)
disk_iops :: Lens' Disk (Maybe Int)
disk_isAttached :: Lens' Disk (Maybe Bool)
disk_addOns :: Lens' Disk (Maybe [AddOn])
disk_attachmentState :: Lens' Disk (Maybe Text)
disk_name :: Lens' Disk (Maybe Text)
disk_sizeInGb :: Lens' Disk (Maybe Int)
disk_supportCode :: Lens' Disk (Maybe Text)
disk_isSystemDisk :: Lens' Disk (Maybe Bool)
disk_attachedTo :: Lens' Disk (Maybe Text)
disk_gbInUse :: Lens' Disk (Maybe Int)
disk_tags :: Lens' Disk (Maybe [Tag])

Documentation

data Disk Source #

Describes a block storage disk.

See: newDisk smart constructor.

Constructors

Disk'

Fields

state :: Maybe DiskState
Describes the status of the disk.
resourceType :: Maybe ResourceType
The Lightsail resource type (e.g., Disk).
arn :: Maybe Text
The Amazon Resource Name (ARN) of the disk.
path :: Maybe Text
The disk path.
createdAt :: Maybe POSIX
The date when the disk was created.
location :: Maybe ResourceLocation
The AWS Region and Availability Zone where the disk is located.
iops :: Maybe Int
The input/output operations per second (IOPS) of the disk.
isAttached :: Maybe Bool
A Boolean value indicating whether the disk is attached.
addOns :: Maybe [AddOn]
An array of objects representing the add-ons enabled on the disk.
attachmentState :: Maybe Text
(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.
name :: Maybe Text
The unique name of the disk.
sizeInGb :: Maybe Int
The size of the disk in GB.
supportCode :: Maybe Text
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.
isSystemDisk :: Maybe Bool
A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
attachedTo :: Maybe Text
The resources to which the disk is attached.
gbInUse :: Maybe Int
(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.
tags :: Maybe [Tag]
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

Instances

Instances details

Eq Disk Source #
Instance details Defined in Amazonka.Lightsail.Types.Disk Methods (==) :: Disk -> Disk -> Bool # (/=) :: Disk -> Disk -> Bool #
Read Disk Source #
Instance details Defined in Amazonka.Lightsail.Types.Disk Methods readsPrec :: Int -> ReadS Disk # readList :: ReadS [Disk] # readPrec :: ReadPrec Disk # readListPrec :: ReadPrec [Disk] #
Show Disk Source #
Instance details Defined in Amazonka.Lightsail.Types.Disk Methods showsPrec :: Int -> Disk -> ShowS # show :: Disk -> String # showList :: [Disk] -> ShowS #
Generic Disk Source #
Instance details Defined in Amazonka.Lightsail.Types.Disk Associated Types type Rep Disk :: Type -> Type # Methods from :: Disk -> Rep Disk x # to :: Rep Disk x -> Disk #
NFData Disk Source #
Instance details Defined in Amazonka.Lightsail.Types.Disk Methods rnf :: Disk -> () #
Hashable Disk Source #
Instance details Defined in Amazonka.Lightsail.Types.Disk Methods hashWithSalt :: Int -> Disk -> Int # hash :: Disk -> Int #
FromJSON Disk Source #
Instance details Defined in Amazonka.Lightsail.Types.Disk Methods parseJSON :: Value -> Parser Disk # parseJSONList :: Value -> Parser [Disk] #
type Rep Disk Source #
Instance details Defined in Amazonka.Lightsail.Types.Disk type Rep Disk = D1 ('MetaData "Disk" "Amazonka.Lightsail.Types.Disk" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" 'False) (C1 ('MetaCons "Disk'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DiskState)) :: S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceType))) :: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceLocation))) :: (S1 ('MetaSel ('Just "iops") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "isAttached") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :: (((S1 ('MetaSel ('Just "addOns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AddOn])) :: S1 ('MetaSel ('Just "attachmentState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "sizeInGb") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :: ((S1 ('MetaSel ('Just "supportCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "isSystemDisk") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "attachedTo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "gbInUse") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))))))))

newDisk :: Disk Source #

Create a value of Disk with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:state:Disk', disk_state - Describes the status of the disk.

$sel:resourceType:Disk', disk_resourceType - The Lightsail resource type (e.g., Disk).

$sel:arn:Disk', disk_arn - The Amazon Resource Name (ARN) of the disk.

$sel:path:Disk', disk_path - The disk path.

$sel:createdAt:Disk', disk_createdAt - The date when the disk was created.

$sel:location:Disk', disk_location - The AWS Region and Availability Zone where the disk is located.

$sel:iops:Disk', disk_iops - The input/output operations per second (IOPS) of the disk.

$sel:isAttached:Disk', disk_isAttached - A Boolean value indicating whether the disk is attached.

$sel:addOns:Disk', disk_addOns - An array of objects representing the add-ons enabled on the disk.

$sel:attachmentState:Disk', disk_attachmentState - (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.

$sel:name:Disk', disk_name - The unique name of the disk.

$sel:sizeInGb:Disk', disk_sizeInGb - The size of the disk in GB.

$sel:supportCode:Disk', disk_supportCode - 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.

$sel:isSystemDisk:Disk', disk_isSystemDisk - A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).

$sel:attachedTo:Disk', disk_attachedTo - The resources to which the disk is attached.

$sel:gbInUse:Disk', disk_gbInUse - (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.

$sel:tags:Disk', disk_tags - The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

disk_state :: Lens' Disk (Maybe DiskState) Source #

Describes the status of the disk.

disk_resourceType :: Lens' Disk (Maybe ResourceType) Source #

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

disk_arn :: Lens' Disk (Maybe Text) Source #

The Amazon Resource Name (ARN) of the disk.

disk_path :: Lens' Disk (Maybe Text) Source #

The disk path.

disk_createdAt :: Lens' Disk (Maybe UTCTime) Source #

The date when the disk was created.

disk_location :: Lens' Disk (Maybe ResourceLocation) Source #

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

disk_iops :: Lens' Disk (Maybe Int) Source #

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

disk_isAttached :: Lens' Disk (Maybe Bool) Source #

A Boolean value indicating whether the disk is attached.

disk_addOns :: Lens' Disk (Maybe [AddOn]) Source #

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

disk_attachmentState :: Lens' Disk (Maybe Text) Source #

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

disk_name :: Lens' Disk (Maybe Text) Source #

The unique name of the disk.

disk_sizeInGb :: Lens' Disk (Maybe Int) Source #

The size of the disk in GB.

disk_supportCode :: Lens' Disk (Maybe Text) Source #

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.

disk_isSystemDisk :: Lens' Disk (Maybe Bool) Source #

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

disk_attachedTo :: Lens' Disk (Maybe Text) Source #

The resources to which the disk is attached.

disk_gbInUse :: Lens' Disk (Maybe Int) Source #

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

disk_tags :: Lens' Disk (Maybe [Tag]) Source #

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.