CreateStorediSCSIVolumeRequest Class

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

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.StorageGateway.AmazonStorageGatewayRequest
      Amazon.StorageGateway.Model.CreateStorediSCSIVolumeRequest

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

Syntax

public class CreateStorediSCSIVolumeRequest : AmazonStorageGatewayRequest
         IAmazonWebServiceRequest

The CreateStorediSCSIVolumeRequest type exposes the following members

Constructors

	Name	Description
	CreateStorediSCSIVolumeRequest()

Properties

Name	Type	Description
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.
GatewayARN	System.String	Gets and sets the property GatewayARN.
KMSEncrypted	System.Boolean	Gets and sets the property KMSEncrypted. Set to `true` to use Amazon S3 server-side encryption with your own KMS key, or `false` to use a key managed by Amazon S3. Optional. Valid Values: `true` \| `false`
KMSKey	System.String	Gets and sets the property KMSKey. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when `KMSEncrypted` is `true`. Optional.
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.
PreserveExistingData	System.Boolean	Gets and sets the property PreserveExistingData. Set to `true` if you want to preserve the data on the local disk. Otherwise, set to `false` to create an empty volume. Valid Values: `true` \| `false`
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.
Tags	System.Collections.Generic.List<Amazon.StorageGateway.Model.Tag>	Gets and sets the property Tags. A list of up to 50 tags that can be assigned to a stored volume. Each tag is a key-value pair. Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
TargetName	System.String	Gets and sets the property TargetName. The name of the iSCSI target used by an initiator to connect to a volume and used 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/iqn.1997-05.com.amazon:myvolume`. The target name must be unique across all volumes on a gateway. If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

Examples

Creates a stored volume on a specified stored gateway.

To create a stored iSCSI volume


var client = new AmazonStorageGatewayClient();
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 = "10.1.1.1",
    PreserveExistingData = true,
    SnapshotId = "snap-f47b7b94",
    TargetName = "my-volume"
});

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

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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