libZSservicesZSamazonka-storagegatewayZSamazonka-storagegateway
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.StorageGateway.DetachVolume

Description

Disconnects a volume from an iSCSI connection and then detaches the volume from the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance. This operation is only supported in the volume gateway type.

Synopsis

Creating a Request

data DetachVolume Source #

AttachVolumeInput

See: newDetachVolume smart constructor.

Constructors

DetachVolume' 

Fields

  • forceDetach :: Maybe Bool

    Set to true to forcibly remove the iSCSI connection of the target volume and detach the volume. The default is false. If this value is set to false, you must manually disconnect the iSCSI connection from the target volume.

    Valid Values: true | false

  • volumeARN :: Text

    The Amazon Resource Name (ARN) of the volume to detach from the gateway.

Instances

Instances details
Eq DetachVolume Source # 
Instance details

Defined in Amazonka.StorageGateway.DetachVolume

Read DetachVolume Source # 
Instance details

Defined in Amazonka.StorageGateway.DetachVolume

Show DetachVolume Source # 
Instance details

Defined in Amazonka.StorageGateway.DetachVolume

Generic DetachVolume Source # 
Instance details

Defined in Amazonka.StorageGateway.DetachVolume

Associated Types

type Rep DetachVolume :: Type -> Type #

NFData DetachVolume Source # 
Instance details

Defined in Amazonka.StorageGateway.DetachVolume

Methods

rnf :: DetachVolume -> () #

Hashable DetachVolume Source # 
Instance details

Defined in Amazonka.StorageGateway.DetachVolume

ToJSON DetachVolume Source # 
Instance details

Defined in Amazonka.StorageGateway.DetachVolume

AWSRequest DetachVolume Source # 
Instance details

Defined in Amazonka.StorageGateway.DetachVolume

Associated Types

type AWSResponse DetachVolume #

ToHeaders DetachVolume Source # 
Instance details

Defined in Amazonka.StorageGateway.DetachVolume

ToPath DetachVolume Source # 
Instance details

Defined in Amazonka.StorageGateway.DetachVolume

ToQuery DetachVolume Source # 
Instance details

Defined in Amazonka.StorageGateway.DetachVolume

type Rep DetachVolume Source # 
Instance details

Defined in Amazonka.StorageGateway.DetachVolume

type Rep DetachVolume = D1 ('MetaData "DetachVolume" "Amazonka.StorageGateway.DetachVolume" "libZSservicesZSamazonka-storagegatewayZSamazonka-storagegateway" 'False) (C1 ('MetaCons "DetachVolume'" 'PrefixI 'True) (S1 ('MetaSel ('Just "forceDetach") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "volumeARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DetachVolume Source # 
Instance details

Defined in Amazonka.StorageGateway.DetachVolume

newDetachVolume Source #

Create a value of DetachVolume 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:forceDetach:DetachVolume', detachVolume_forceDetach - Set to true to forcibly remove the iSCSI connection of the target volume and detach the volume. The default is false. If this value is set to false, you must manually disconnect the iSCSI connection from the target volume.

Valid Values: true | false

$sel:volumeARN:DetachVolume', detachVolume_volumeARN - The Amazon Resource Name (ARN) of the volume to detach from the gateway.

Request Lenses

detachVolume_forceDetach :: Lens' DetachVolume (Maybe Bool) Source #

Set to true to forcibly remove the iSCSI connection of the target volume and detach the volume. The default is false. If this value is set to false, you must manually disconnect the iSCSI connection from the target volume.

Valid Values: true | false

detachVolume_volumeARN :: Lens' DetachVolume Text Source #

The Amazon Resource Name (ARN) of the volume to detach from the gateway.

Destructuring the Response

data DetachVolumeResponse Source #

AttachVolumeOutput

See: newDetachVolumeResponse smart constructor.

Constructors

DetachVolumeResponse' 

Fields

Instances

Instances details
Eq DetachVolumeResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.DetachVolume

Read DetachVolumeResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.DetachVolume

Show DetachVolumeResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.DetachVolume

Generic DetachVolumeResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.DetachVolume

Associated Types

type Rep DetachVolumeResponse :: Type -> Type #

NFData DetachVolumeResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.DetachVolume

Methods

rnf :: DetachVolumeResponse -> () #

type Rep DetachVolumeResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.DetachVolume

type Rep DetachVolumeResponse = D1 ('MetaData "DetachVolumeResponse" "Amazonka.StorageGateway.DetachVolume" "libZSservicesZSamazonka-storagegatewayZSamazonka-storagegateway" 'False) (C1 ('MetaCons "DetachVolumeResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "volumeARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDetachVolumeResponse Source #

Create a value of DetachVolumeResponse 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:volumeARN:DetachVolume', detachVolumeResponse_volumeARN - The Amazon Resource Name (ARN) of the volume that was detached.

$sel:httpStatus:DetachVolumeResponse', detachVolumeResponse_httpStatus - The response's http status code.

Response Lenses

detachVolumeResponse_volumeARN :: Lens' DetachVolumeResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the volume that was detached.