amazonka-storagegateway-1.6.1: Amazon Storage Gateway SDK.

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

Network.AWS.StorageGateway.CreateStorediSCSIVolume

Contents

Description

Creates a volume on a specified gateway. This operation is only supported in the stored volume gateway type.

The size of the volume to create is inferred from the disk size. You can choose to preserve existing data on the disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty gateway volume, then any existing data on the disk is erased.

In the request you must specify the gateway and the disk information on which you are creating the volume. In response, the gateway creates the volume and returns volume information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.

Synopsis

Creating a Request

createStorediSCSIVolume Source #

Creates a value of CreateStorediSCSIVolume with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • csscsivSnapshotId - The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new stored volume. Specify this field if you want to create the iSCSI storage volume from a snapshot otherwise do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference .
  • csscsivGatewayARN - Undocumented member.
  • csscsivDiskId - The unique identifier for the gateway local disk that is configured as a stored volume. Use ListLocalDisks to list disk IDs for a gateway.
  • csscsivPreserveExistingData - Specify this field as true if you want to preserve the data on the local disk. Otherwise, specifying this field as false creates an empty volume. Valid Values: true, false
  • csscsivTargetName - The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gatewaysgw-12A3456Btarget/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes of a gateway.
  • csscsivNetworkInterfaceId - The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway. Valid Values: A valid IP address.

data CreateStorediSCSIVolume Source #

A JSON object containing one or more of the following fields:

  • 'CreateStorediSCSIVolumeInput$DiskId'
  • 'CreateStorediSCSIVolumeInput$NetworkInterfaceId'
  • 'CreateStorediSCSIVolumeInput$PreserveExistingData'
  • 'CreateStorediSCSIVolumeInput$SnapshotId'
  • 'CreateStorediSCSIVolumeInput$TargetName'

See: createStorediSCSIVolume smart constructor.

Instances
Eq CreateStorediSCSIVolume Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateStorediSCSIVolume

Data CreateStorediSCSIVolume Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateStorediSCSIVolume

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateStorediSCSIVolume -> c CreateStorediSCSIVolume #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateStorediSCSIVolume #

toConstr :: CreateStorediSCSIVolume -> Constr #

dataTypeOf :: CreateStorediSCSIVolume -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateStorediSCSIVolume) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateStorediSCSIVolume) #

gmapT :: (forall b. Data b => b -> b) -> CreateStorediSCSIVolume -> CreateStorediSCSIVolume #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateStorediSCSIVolume -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateStorediSCSIVolume -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreateStorediSCSIVolume -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateStorediSCSIVolume -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateStorediSCSIVolume -> m CreateStorediSCSIVolume #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateStorediSCSIVolume -> m CreateStorediSCSIVolume #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateStorediSCSIVolume -> m CreateStorediSCSIVolume #

Read CreateStorediSCSIVolume Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateStorediSCSIVolume

Show CreateStorediSCSIVolume Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateStorediSCSIVolume

Generic CreateStorediSCSIVolume Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateStorediSCSIVolume

Associated Types

type Rep CreateStorediSCSIVolume :: Type -> Type #

Hashable CreateStorediSCSIVolume Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateStorediSCSIVolume

ToJSON CreateStorediSCSIVolume Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateStorediSCSIVolume

AWSRequest CreateStorediSCSIVolume Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateStorediSCSIVolume

Associated Types

type Rs CreateStorediSCSIVolume :: Type #

ToHeaders CreateStorediSCSIVolume Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateStorediSCSIVolume

ToPath CreateStorediSCSIVolume Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateStorediSCSIVolume

ToQuery CreateStorediSCSIVolume Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateStorediSCSIVolume

NFData CreateStorediSCSIVolume Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateStorediSCSIVolume

Methods

rnf :: CreateStorediSCSIVolume -> () #

type Rep CreateStorediSCSIVolume Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateStorediSCSIVolume

type Rep CreateStorediSCSIVolume = D1 (MetaData "CreateStorediSCSIVolume" "Network.AWS.StorageGateway.CreateStorediSCSIVolume" "amazonka-storagegateway-1.6.1-8r5RVaLfJcl46lpEVK6Ktc" False) (C1 (MetaCons "CreateStorediSCSIVolume'" PrefixI True) ((S1 (MetaSel (Just "_csscsivSnapshotId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_csscsivGatewayARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_csscsivDiskId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :*: (S1 (MetaSel (Just "_csscsivPreserveExistingData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool) :*: (S1 (MetaSel (Just "_csscsivTargetName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_csscsivNetworkInterfaceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs CreateStorediSCSIVolume Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateStorediSCSIVolume

Request Lenses

csscsivSnapshotId :: Lens' CreateStorediSCSIVolume (Maybe Text) Source #

The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new stored volume. Specify this field if you want to create the iSCSI storage volume from a snapshot otherwise do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference .

csscsivDiskId :: Lens' CreateStorediSCSIVolume Text Source #

The unique identifier for the gateway local disk that is configured as a stored volume. Use ListLocalDisks to list disk IDs for a gateway.

csscsivPreserveExistingData :: Lens' CreateStorediSCSIVolume Bool Source #

Specify this field as true if you want to preserve the data on the local disk. Otherwise, specifying this field as false creates an empty volume. Valid Values: true, false

csscsivTargetName :: Lens' CreateStorediSCSIVolume Text Source #

The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gatewaysgw-12A3456Btarget/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes of a gateway.

csscsivNetworkInterfaceId :: Lens' CreateStorediSCSIVolume Text Source #

The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway. Valid Values: A valid IP address.

Destructuring the Response

createStorediSCSIVolumeResponse Source #

Creates a value of CreateStorediSCSIVolumeResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data CreateStorediSCSIVolumeResponse Source #

A JSON object containing the following fields:

See: createStorediSCSIVolumeResponse smart constructor.

Instances
Eq CreateStorediSCSIVolumeResponse Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateStorediSCSIVolume

Data CreateStorediSCSIVolumeResponse Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateStorediSCSIVolume

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateStorediSCSIVolumeResponse -> c CreateStorediSCSIVolumeResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateStorediSCSIVolumeResponse #

toConstr :: CreateStorediSCSIVolumeResponse -> Constr #

dataTypeOf :: CreateStorediSCSIVolumeResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateStorediSCSIVolumeResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateStorediSCSIVolumeResponse) #

gmapT :: (forall b. Data b => b -> b) -> CreateStorediSCSIVolumeResponse -> CreateStorediSCSIVolumeResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateStorediSCSIVolumeResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateStorediSCSIVolumeResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreateStorediSCSIVolumeResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateStorediSCSIVolumeResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateStorediSCSIVolumeResponse -> m CreateStorediSCSIVolumeResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateStorediSCSIVolumeResponse -> m CreateStorediSCSIVolumeResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateStorediSCSIVolumeResponse -> m CreateStorediSCSIVolumeResponse #

Read CreateStorediSCSIVolumeResponse Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateStorediSCSIVolume

Show CreateStorediSCSIVolumeResponse Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateStorediSCSIVolume

Generic CreateStorediSCSIVolumeResponse Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateStorediSCSIVolume

Associated Types

type Rep CreateStorediSCSIVolumeResponse :: Type -> Type #

NFData CreateStorediSCSIVolumeResponse Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateStorediSCSIVolume

type Rep CreateStorediSCSIVolumeResponse Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateStorediSCSIVolume

type Rep CreateStorediSCSIVolumeResponse = D1 (MetaData "CreateStorediSCSIVolumeResponse" "Network.AWS.StorageGateway.CreateStorediSCSIVolume" "amazonka-storagegateway-1.6.1-8r5RVaLfJcl46lpEVK6Ktc" False) (C1 (MetaCons "CreateStorediSCSIVolumeResponse'" PrefixI True) ((S1 (MetaSel (Just "_csscsivrsTargetARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_csscsivrsVolumeARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_csscsivrsVolumeSizeInBytes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 (MetaSel (Just "_csscsivrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

csscsivrsTargetARN :: Lens' CreateStorediSCSIVolumeResponse (Maybe Text) Source #

he Amazon Resource Name (ARN) of the volume target that includes the iSCSI name that initiators can use to connect to the target.

csscsivrsVolumeARN :: Lens' CreateStorediSCSIVolumeResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the configured volume.