Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Lightsail.Types.Disk

Description

Synopsis

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

Documentation

data Disk Source #

Describes a block storage disk.

See: newDisk smart constructor.

Constructors

Disk'

Fields

addOns :: Maybe [AddOn]
An array of objects representing the add-ons enabled on the disk.
arn :: Maybe Text
The Amazon Resource Name (ARN) of the disk.
attachedTo :: Maybe Text
The resources to which the disk is attached.
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.
createdAt :: Maybe POSIX
The date when the disk was created.
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.
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.
isSystemDisk :: Maybe Bool
A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
location :: Maybe ResourceLocation
The AWS Region and Availability Zone where the disk is located.
name :: Maybe Text
The unique name of the disk.
path :: Maybe Text
The disk path.
resourceType :: Maybe ResourceType
The Lightsail resource type (e.g., Disk).
sizeInGb :: Maybe Int
The size of the disk in GB.
state :: Maybe DiskState
Describes the status of the disk.
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.
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

FromJSON Disk Source #
Instance details Defined in Amazonka.Lightsail.Types.Disk Methods parseJSON :: Value -> Parser Disk # parseJSONList :: Value -> Parser [Disk] #
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 #
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 #
NFData Disk Source #
Instance details Defined in Amazonka.Lightsail.Types.Disk Methods rnf :: Disk -> () #
Eq Disk Source #
Instance details Defined in Amazonka.Lightsail.Types.Disk Methods (==) :: Disk -> Disk -> Bool # (/=) :: Disk -> Disk -> Bool #
Hashable Disk Source #
Instance details Defined in Amazonka.Lightsail.Types.Disk Methods hashWithSalt :: Int -> Disk -> Int # hash :: Disk -> Int #
type Rep Disk Source #
Instance details Defined in Amazonka.Lightsail.Types.Disk type Rep Disk = D1 ('MetaData "Disk" "Amazonka.Lightsail.Types.Disk" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "Disk'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "addOns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AddOn])) :: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "attachedTo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "attachmentState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "gbInUse") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "iops") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "isAttached") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :: (((S1 ('MetaSel ('Just "isSystemDisk") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceLocation))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceType)) :: S1 ('MetaSel ('Just "sizeInGb") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DiskState)) :: (S1 ('MetaSel ('Just "supportCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: 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:addOns:Disk', disk_addOns - An array of objects representing the add-ons enabled on the disk.

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

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

$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:createdAt:Disk', disk_createdAt - The date when the disk was created.

$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: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:isSystemDisk:Disk', disk_isSystemDisk - A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).

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

Disk, disk_name - The unique name of the disk.

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

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

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

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

$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: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_addOns :: Lens' Disk (Maybe [AddOn]) Source #

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

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

The Amazon Resource Name (ARN) of the disk.

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

The resources to which the disk is attached.

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_createdAt :: Lens' Disk (Maybe UTCTime) Source #

The date when the disk was created.

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_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_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_location :: Lens' Disk (Maybe ResourceLocation) Source #

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

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

The unique name of the disk.

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

The disk path.

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

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

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

The size of the disk in GB.

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

Describes the status of the disk.

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