amazonka-lightsail-2.0: Amazon Lightsail SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Lightsail.AttachDisk

Description

Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.

The attach disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Amazon Lightsail Developer Guide.

Synopsis

Creating a Request

data AttachDisk Source #

See: newAttachDisk smart constructor.

Constructors

AttachDisk' 

Fields

  • diskName :: Text

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

  • instanceName :: Text

    The name of the Lightsail instance where you want to utilize the storage disk.

  • diskPath :: Text

    The disk path to expose to the instance (e.g., /dev/xvdf).

Instances

Instances details
ToJSON AttachDisk Source # 
Instance details

Defined in Amazonka.Lightsail.AttachDisk

ToHeaders AttachDisk Source # 
Instance details

Defined in Amazonka.Lightsail.AttachDisk

Methods

toHeaders :: AttachDisk -> [Header] #

ToPath AttachDisk Source # 
Instance details

Defined in Amazonka.Lightsail.AttachDisk

ToQuery AttachDisk Source # 
Instance details

Defined in Amazonka.Lightsail.AttachDisk

AWSRequest AttachDisk Source # 
Instance details

Defined in Amazonka.Lightsail.AttachDisk

Associated Types

type AWSResponse AttachDisk #

Generic AttachDisk Source # 
Instance details

Defined in Amazonka.Lightsail.AttachDisk

Associated Types

type Rep AttachDisk :: Type -> Type #

Read AttachDisk Source # 
Instance details

Defined in Amazonka.Lightsail.AttachDisk

Show AttachDisk Source # 
Instance details

Defined in Amazonka.Lightsail.AttachDisk

NFData AttachDisk Source # 
Instance details

Defined in Amazonka.Lightsail.AttachDisk

Methods

rnf :: AttachDisk -> () #

Eq AttachDisk Source # 
Instance details

Defined in Amazonka.Lightsail.AttachDisk

Hashable AttachDisk Source # 
Instance details

Defined in Amazonka.Lightsail.AttachDisk

type AWSResponse AttachDisk Source # 
Instance details

Defined in Amazonka.Lightsail.AttachDisk

type Rep AttachDisk Source # 
Instance details

Defined in Amazonka.Lightsail.AttachDisk

type Rep AttachDisk = D1 ('MetaData "AttachDisk" "Amazonka.Lightsail.AttachDisk" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "AttachDisk'" 'PrefixI 'True) (S1 ('MetaSel ('Just "diskName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "instanceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "diskPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newAttachDisk Source #

Create a value of AttachDisk 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:diskName:AttachDisk', attachDisk_diskName - The unique Lightsail disk name (e.g., my-disk).

AttachDisk, attachDisk_instanceName - The name of the Lightsail instance where you want to utilize the storage disk.

$sel:diskPath:AttachDisk', attachDisk_diskPath - The disk path to expose to the instance (e.g., /dev/xvdf).

Request Lenses

attachDisk_diskName :: Lens' AttachDisk Text Source #

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

attachDisk_instanceName :: Lens' AttachDisk Text Source #

The name of the Lightsail instance where you want to utilize the storage disk.

attachDisk_diskPath :: Lens' AttachDisk Text Source #

The disk path to expose to the instance (e.g., /dev/xvdf).

Destructuring the Response

data AttachDiskResponse Source #

See: newAttachDiskResponse smart constructor.

Constructors

AttachDiskResponse' 

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 AttachDiskResponse Source # 
Instance details

Defined in Amazonka.Lightsail.AttachDisk

Associated Types

type Rep AttachDiskResponse :: Type -> Type #

Read AttachDiskResponse Source # 
Instance details

Defined in Amazonka.Lightsail.AttachDisk

Show AttachDiskResponse Source # 
Instance details

Defined in Amazonka.Lightsail.AttachDisk

NFData AttachDiskResponse Source # 
Instance details

Defined in Amazonka.Lightsail.AttachDisk

Methods

rnf :: AttachDiskResponse -> () #

Eq AttachDiskResponse Source # 
Instance details

Defined in Amazonka.Lightsail.AttachDisk

type Rep AttachDiskResponse Source # 
Instance details

Defined in Amazonka.Lightsail.AttachDisk

type Rep AttachDiskResponse = D1 ('MetaData "AttachDiskResponse" "Amazonka.Lightsail.AttachDisk" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "AttachDiskResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "operations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Operation])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newAttachDiskResponse Source #

Create a value of AttachDiskResponse 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:AttachDiskResponse', attachDiskResponse_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:AttachDiskResponse', attachDiskResponse_httpStatus - The response's http status code.

Response Lenses

attachDiskResponse_operations :: Lens' AttachDiskResponse (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.