AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateStorediSCSIVolume operation. 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.

Inheritance Hierarchy


Namespace: Amazon.StorageGateway.Model
Assembly: AWSSDK.StorageGateway.dll
Version: 3.x.y.z


public class CreateStorediSCSIVolumeRequest : AmazonStorageGatewayRequest

The CreateStorediSCSIVolumeRequest type exposes the following members



Public Property DiskId System.String

Gets and sets the property DiskId.

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

Public Property GatewayARN System.String

Gets and sets the property GatewayARN.

Public Property KMSEncrypted System.Boolean

Gets and sets the property KMSEncrypted.

True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

Public Property KMSKey System.String

Gets and sets the property KMSKey.

The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

Public Property NetworkInterfaceId System.String

Gets and sets the property NetworkInterfaceId.

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.

Public Property PreserveExistingData System.Boolean

Gets and sets the property PreserveExistingData.

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

Public Property SnapshotId System.String

Gets and sets the property SnapshotId.

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.

Public Property TargetName System.String

Gets and sets the property TargetName.

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:gateway/sgw-12A3456B/target/ The target name must be unique across all volumes of a gateway.


Creates a stored volume on a specified stored gateway.

To create a stored iSCSI volume

var response = client.CreateStorediSCSIVolume(new CreateStorediSCSIVolumeRequest 
    DiskId = "pci-0000:03:00.0-scsi-0:0:0:0",
    GatewayARN = "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
    NetworkInterfaceId = "",
    PreserveExistingData = true,
    SnapshotId = "snap-f47b7b94",
    TargetName = "my-volume"

string targetARN = response.TargetARN;
string volumeARN = response.VolumeARN;
long volumeSizeInBytes = response.VolumeSizeInBytes;


Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms