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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone (e.g., us-east-2a).

The create disk operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

Synopsis

data CreateDisk = CreateDisk' {
- addOns :: Maybe [AddOnRequest]
- tags :: Maybe [Tag]
- diskName :: Text
- availabilityZone :: Text
- sizeInGb :: Int
}
newCreateDisk :: Text -> Text -> Int -> CreateDisk
createDisk_addOns :: Lens' CreateDisk (Maybe [AddOnRequest])
createDisk_tags :: Lens' CreateDisk (Maybe [Tag])
createDisk_diskName :: Lens' CreateDisk Text
createDisk_availabilityZone :: Lens' CreateDisk Text
createDisk_sizeInGb :: Lens' CreateDisk Int
data CreateDiskResponse = CreateDiskResponse' {
- operations :: Maybe [Operation]
- httpStatus :: Int
}
newCreateDiskResponse :: Int -> CreateDiskResponse
createDiskResponse_operations :: Lens' CreateDiskResponse (Maybe [Operation])
createDiskResponse_httpStatus :: Lens' CreateDiskResponse Int

Creating a Request

data CreateDisk Source #

See: newCreateDisk smart constructor.

Constructors

CreateDisk'

Fields

addOns :: Maybe [AddOnRequest]
An array of objects that represent the add-ons to enable for the new disk.
tags :: Maybe [Tag]
The tag keys and optional values to add to the resource during create.
Use the TagResource action to tag a resource after it's created.
diskName :: Text
The unique Lightsail disk name (e.g., my-disk).
availabilityZone :: Text
The Availability Zone where you want to create the disk (e.g., us-east-2a). Use the same Availability Zone as the Lightsail instance to which you want to attach the disk.
Use the get regions operation to list the Availability Zones where Lightsail is currently available.
sizeInGb :: Int
The size of the disk in GB (e.g., 32).

Instances

Instances details

ToJSON CreateDisk Source #
Instance details Defined in Amazonka.Lightsail.CreateDisk Methods toJSON :: CreateDisk -> Value # toEncoding :: CreateDisk -> Encoding # toJSONList :: [CreateDisk] -> Value # toEncodingList :: [CreateDisk] -> Encoding #
ToHeaders CreateDisk Source #
Instance details Defined in Amazonka.Lightsail.CreateDisk Methods toHeaders :: CreateDisk -> [Header] #
ToPath CreateDisk Source #
Instance details Defined in Amazonka.Lightsail.CreateDisk Methods toPath :: CreateDisk -> ByteString #
ToQuery CreateDisk Source #
Instance details Defined in Amazonka.Lightsail.CreateDisk Methods toQuery :: CreateDisk -> QueryString #
AWSRequest CreateDisk Source #
Instance details Defined in Amazonka.Lightsail.CreateDisk Associated Types type AWSResponse CreateDisk # Methods request :: (Service -> Service) -> CreateDisk -> Request CreateDisk # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateDisk -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDisk))) #
Generic CreateDisk Source #
Instance details Defined in Amazonka.Lightsail.CreateDisk Associated Types type Rep CreateDisk :: Type -> Type # Methods from :: CreateDisk -> Rep CreateDisk x # to :: Rep CreateDisk x -> CreateDisk #
Read CreateDisk Source #
Instance details Defined in Amazonka.Lightsail.CreateDisk Methods readsPrec :: Int -> ReadS CreateDisk # readList :: ReadS [CreateDisk] # readPrec :: ReadPrec CreateDisk # readListPrec :: ReadPrec [CreateDisk] #
Show CreateDisk Source #
Instance details Defined in Amazonka.Lightsail.CreateDisk Methods showsPrec :: Int -> CreateDisk -> ShowS # show :: CreateDisk -> String # showList :: [CreateDisk] -> ShowS #
NFData CreateDisk Source #
Instance details Defined in Amazonka.Lightsail.CreateDisk Methods rnf :: CreateDisk -> () #
Eq CreateDisk Source #
Instance details Defined in Amazonka.Lightsail.CreateDisk Methods (==) :: CreateDisk -> CreateDisk -> Bool # (/=) :: CreateDisk -> CreateDisk -> Bool #
Hashable CreateDisk Source #
Instance details Defined in Amazonka.Lightsail.CreateDisk Methods hashWithSalt :: Int -> CreateDisk -> Int # hash :: CreateDisk -> Int #
type AWSResponse CreateDisk Source #
Instance details Defined in Amazonka.Lightsail.CreateDisk type AWSResponse CreateDisk = CreateDiskResponse
type Rep CreateDisk Source #
Instance details Defined in Amazonka.Lightsail.CreateDisk type Rep CreateDisk = D1 ('MetaData "CreateDisk" "Amazonka.Lightsail.CreateDisk" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "CreateDisk'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "addOns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AddOnRequest])) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :: (S1 ('MetaSel ('Just "diskName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "availabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "sizeInGb") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newCreateDisk Source #

Arguments

:: Text	`$sel:diskName:CreateDisk'`
-> Text	`CreateDisk`
-> Int	`CreateDisk`
-> CreateDisk

Create a value of CreateDisk 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:

CreateDisk, createDisk_addOns - An array of objects that represent the add-ons to enable for the new disk.

CreateDisk, createDisk_tags - The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

$sel:diskName:CreateDisk', createDisk_diskName - The unique Lightsail disk name (e.g., my-disk).

CreateDisk, createDisk_availabilityZone - The Availability Zone where you want to create the disk (e.g., us-east-2a). Use the same Availability Zone as the Lightsail instance to which you want to attach the disk.

Use the get regions operation to list the Availability Zones where Lightsail is currently available.

CreateDisk, createDisk_sizeInGb - The size of the disk in GB (e.g., 32).

Request Lenses

createDisk_addOns :: Lens' CreateDisk (Maybe [AddOnRequest]) Source #

An array of objects that represent the add-ons to enable for the new disk.

createDisk_tags :: Lens' CreateDisk (Maybe [Tag]) Source #

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

createDisk_diskName :: Lens' CreateDisk Text Source #

The unique Lightsail disk name (e.g., my-disk).

createDisk_availabilityZone :: Lens' CreateDisk Text Source #

The Availability Zone where you want to create the disk (e.g., us-east-2a). Use the same Availability Zone as the Lightsail instance to which you want to attach the disk.

Use the get regions operation to list the Availability Zones where Lightsail is currently available.

createDisk_sizeInGb :: Lens' CreateDisk Int Source #

The size of the disk in GB (e.g., 32).

Destructuring the Response

data CreateDiskResponse Source #

See: newCreateDiskResponse smart constructor.

Constructors

CreateDiskResponse'
Fields operations :: Maybe [Operation] An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateDiskResponse Source #
Instance details Defined in Amazonka.Lightsail.CreateDisk Associated Types type Rep CreateDiskResponse :: Type -> Type # Methods from :: CreateDiskResponse -> Rep CreateDiskResponse x # to :: Rep CreateDiskResponse x -> CreateDiskResponse #
Read CreateDiskResponse Source #
Instance details Defined in Amazonka.Lightsail.CreateDisk Methods readsPrec :: Int -> ReadS CreateDiskResponse # readList :: ReadS [CreateDiskResponse] # readPrec :: ReadPrec CreateDiskResponse # readListPrec :: ReadPrec [CreateDiskResponse] #
Show CreateDiskResponse Source #
Instance details Defined in Amazonka.Lightsail.CreateDisk Methods showsPrec :: Int -> CreateDiskResponse -> ShowS # show :: CreateDiskResponse -> String # showList :: [CreateDiskResponse] -> ShowS #
NFData CreateDiskResponse Source #
Instance details Defined in Amazonka.Lightsail.CreateDisk Methods rnf :: CreateDiskResponse -> () #
Eq CreateDiskResponse Source #
Instance details Defined in Amazonka.Lightsail.CreateDisk Methods (==) :: CreateDiskResponse -> CreateDiskResponse -> Bool # (/=) :: CreateDiskResponse -> CreateDiskResponse -> Bool #
type Rep CreateDiskResponse Source #
Instance details Defined in Amazonka.Lightsail.CreateDisk type Rep CreateDiskResponse = D1 ('MetaData "CreateDiskResponse" "Amazonka.Lightsail.CreateDisk" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "CreateDiskResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "operations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Operation])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateDiskResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateDiskResponse'`
-> CreateDiskResponse

Create a value of CreateDiskResponse 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:operations:CreateDiskResponse', createDiskResponse_operations - An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

$sel:httpStatus:CreateDiskResponse', createDiskResponse_httpStatus - The response's http status code.

Response Lenses

createDiskResponse_operations :: Lens' CreateDiskResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

createDiskResponse_httpStatus :: Lens' CreateDiskResponse Int Source #

The response's http status code.