Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
This operation 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.
See: AWS API Reference for CreateStorediSCSIVolume.
- createStorediSCSIVolume :: Text -> Text -> Bool -> Text -> Text -> CreateStorediSCSIVolume
- data CreateStorediSCSIVolume
- csscsivSnapshotId :: Lens' CreateStorediSCSIVolume (Maybe Text)
- csscsivGatewayARN :: Lens' CreateStorediSCSIVolume Text
- csscsivDiskId :: Lens' CreateStorediSCSIVolume Text
- csscsivPreserveExistingData :: Lens' CreateStorediSCSIVolume Bool
- csscsivTargetName :: Lens' CreateStorediSCSIVolume Text
- csscsivNetworkInterfaceId :: Lens' CreateStorediSCSIVolume Text
- createStorediSCSIVolumeResponse :: Int -> CreateStorediSCSIVolumeResponse
- data CreateStorediSCSIVolumeResponse
- csscsivrsTargetARN :: Lens' CreateStorediSCSIVolumeResponse (Maybe Text)
- csscsivrsVolumeARN :: Lens' CreateStorediSCSIVolumeResponse (Maybe Text)
- csscsivrsVolumeSizeInBytes :: Lens' CreateStorediSCSIVolumeResponse (Maybe Integer)
- csscsivrsResponseStatus :: Lens' CreateStorediSCSIVolumeResponse Int
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:
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.
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.
csscsivGatewayARN :: Lens' CreateStorediSCSIVolume Text Source
Undocumented member.
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-1:111122223333:gateway/mygateway/target/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.
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.
csscsivrsVolumeSizeInBytes :: Lens' CreateStorediSCSIVolumeResponse (Maybe Integer) Source
The size of the volume in bytes.
csscsivrsResponseStatus :: Lens' CreateStorediSCSIVolumeResponse Int Source
The response status code.