Network.AWS.StorageGateway.CreateStorediSCSIVolume

Creates a volume on a specified gateway. This operation is supported only for the gateway-stored volume architecture.

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, AWS Storage 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.

Creating a Request

createStorediSCSIVolume

Arguments

:: Text

csscsivGatewayARN

-> Text

csscsivDiskId

-> Bool

csscsivPreserveExistingData

-> Text

csscsivTargetName

-> Text

csscsivNetworkInterfaceId

-> CreateStorediSCSIVolume

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
• csscsivGatewayARN
• csscsivDiskId
• csscsivPreserveExistingData
• csscsivTargetName
• csscsivNetworkInterfaceId

data CreateStorediSCSIVolume

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

• CreateStorediSCSIVolumeInputDiskId>
• CreateStorediSCSIVolumeInputNetworkInterfaceId>
• CreateStorediSCSIVolumeInputPreserveExistingData>
• CreateStorediSCSIVolumeInputSnapshotId>
• CreateStorediSCSIVolumeInputTargetName>

See: createStorediSCSIVolume smart constructor.

Instances

Eq CreateStorediSCSIVolume

Methods

(==) :: CreateStorediSCSIVolume -> CreateStorediSCSIVolume -> Bool

(/=) :: CreateStorediSCSIVolume -> CreateStorediSCSIVolume -> Bool

Data 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

Methods

readsPrec :: Int -> ReadS CreateStorediSCSIVolume

readList :: ReadS [CreateStorediSCSIVolume]

readPrec :: ReadPrec CreateStorediSCSIVolume

readListPrec :: ReadPrec [CreateStorediSCSIVolume]

Show CreateStorediSCSIVolume

Methods

showsPrec :: Int -> CreateStorediSCSIVolume -> ShowS

show :: CreateStorediSCSIVolume -> String

showList :: [CreateStorediSCSIVolume] -> ShowS

Generic CreateStorediSCSIVolume

Associated Types

type Rep CreateStorediSCSIVolume :: * -> *

Methods

from :: CreateStorediSCSIVolume -> Rep CreateStorediSCSIVolume x

to :: Rep CreateStorediSCSIVolume x -> CreateStorediSCSIVolume

ToJSON CreateStorediSCSIVolume

Methods

toJSON :: CreateStorediSCSIVolume -> Value

toEncoding :: CreateStorediSCSIVolume -> Encoding

Hashable CreateStorediSCSIVolume

Methods

hashWithSalt :: Int -> CreateStorediSCSIVolume -> Int

hash :: CreateStorediSCSIVolume -> Int

NFData CreateStorediSCSIVolume

Methods

rnf :: CreateStorediSCSIVolume -> ()

AWSRequest CreateStorediSCSIVolume

Associated Types

type Rs CreateStorediSCSIVolume :: *

Methods

request :: CreateStorediSCSIVolume -> Request CreateStorediSCSIVolume

response :: MonadResource m => Logger -> Service -> Proxy * CreateStorediSCSIVolume -> ClientResponse -> m (Response CreateStorediSCSIVolume)

ToPath CreateStorediSCSIVolume

Methods

toPath :: CreateStorediSCSIVolume -> ByteString

ToHeaders CreateStorediSCSIVolume

Methods

toHeaders :: CreateStorediSCSIVolume -> [Header]

ToQuery CreateStorediSCSIVolume

Methods

toQuery :: CreateStorediSCSIVolume -> QueryString

type Rep CreateStorediSCSIVolume

type Rep CreateStorediSCSIVolume = D1 (MetaData "CreateStorediSCSIVolume" "Network.AWS.StorageGateway.CreateStorediSCSIVolume" "amazonka-storagegateway-1.4.3-1vbLkcG6haz5xfGUV2OLbS" False) (C1 (MetaCons "CreateStorediSCSIVolume'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_csscsivSnapshotId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_csscsivGatewayARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_csscsivDiskId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_csscsivPreserveExistingData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)) ((:*:) (S1 (MetaSel (Just Symbol "_csscsivTargetName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_csscsivNetworkInterfaceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs CreateStorediSCSIVolume

type Rs CreateStorediSCSIVolume = CreateStorediSCSIVolumeResponse

Request Lenses

csscsivSnapshotId :: Lens' CreateStorediSCSIVolume (Maybe Text)

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 :: Lens' CreateStorediSCSIVolume Text

Undocumented member.

csscsivDiskId :: Lens' CreateStorediSCSIVolume Text

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

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

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-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes of a gateway.

csscsivNetworkInterfaceId :: Lens' CreateStorediSCSIVolume Text

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

Arguments

:: Int

csscsivrsResponseStatus

-> CreateStorediSCSIVolumeResponse

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:

• csscsivrsTargetARN
• csscsivrsVolumeARN
• csscsivrsVolumeSizeInBytes
• csscsivrsResponseStatus

data CreateStorediSCSIVolumeResponse

A JSON object containing the following fields:

See: createStorediSCSIVolumeResponse smart constructor.

Instances

Eq CreateStorediSCSIVolumeResponse

Methods

(==) :: CreateStorediSCSIVolumeResponse -> CreateStorediSCSIVolumeResponse -> Bool

(/=) :: CreateStorediSCSIVolumeResponse -> CreateStorediSCSIVolumeResponse -> Bool

Data CreateStorediSCSIVolumeResponse

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

Methods

readsPrec :: Int -> ReadS CreateStorediSCSIVolumeResponse

readList :: ReadS [CreateStorediSCSIVolumeResponse]

readPrec :: ReadPrec CreateStorediSCSIVolumeResponse

readListPrec :: ReadPrec [CreateStorediSCSIVolumeResponse]

Show CreateStorediSCSIVolumeResponse

Methods

showsPrec :: Int -> CreateStorediSCSIVolumeResponse -> ShowS

show :: CreateStorediSCSIVolumeResponse -> String

showList :: [CreateStorediSCSIVolumeResponse] -> ShowS

Generic CreateStorediSCSIVolumeResponse

Associated Types

type Rep CreateStorediSCSIVolumeResponse :: * -> *

Methods

from :: CreateStorediSCSIVolumeResponse -> Rep CreateStorediSCSIVolumeResponse x

to :: Rep CreateStorediSCSIVolumeResponse x -> CreateStorediSCSIVolumeResponse

NFData CreateStorediSCSIVolumeResponse

Methods

rnf :: CreateStorediSCSIVolumeResponse -> ()

type Rep CreateStorediSCSIVolumeResponse

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

Response Lenses

csscsivrsTargetARN :: Lens' CreateStorediSCSIVolumeResponse (Maybe Text)

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)

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

csscsivrsVolumeSizeInBytes :: Lens' CreateStorediSCSIVolumeResponse (Maybe Integer)

The size of the volume in bytes.

csscsivrsResponseStatus :: Lens' CreateStorediSCSIVolumeResponse Int

The response status code.