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 CreateCachediSCSIVolume operation. Creates a cached volume on a specified cached volume gateway. This operation is only supported in the cached volume gateway type.

Cache storage must be allocated to the gateway before you can create a cached volume. Use the AddCache operation to add cache storage to a gateway.

In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, the gateway creates the volume and returns information about it. This information includes the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.

Optionally, you can provide the ARN for an existing volume as the SourceVolumeARN for this cached volume, which creates an exact copy of the existing volume’s latest recovery point. The VolumeSizeInBytes value must be equal to or larger than the size of the copied volume, in bytes.

Inheritance Hierarchy

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

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

Syntax

C#
public class CreateCachediSCSIVolumeRequest : AmazonStorageGatewayRequest
         IAmazonWebServiceRequest

The CreateCachediSCSIVolumeRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property ClientToken System.String

Gets and sets the property ClientToken.

A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.

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 AWS 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 SnapshotId System.String

Gets and sets the property SnapshotId.

The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new cached 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 SourceVolumeARN System.String

Gets and sets the property SourceVolumeARN.

The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The VolumeSizeInBytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.

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

Public Property VolumeSizeInBytes System.Int64

Gets and sets the property VolumeSizeInBytes.

The size of the volume in bytes.

Examples

Creates a cached volume on a specified cached gateway.

To create a cached iSCSI volume


var response = client.CreateCachediSCSIVolume(new CreateCachediSCSIVolumeRequest 
{
    ClientToken = "cachedvol112233",
    GatewayARN = "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
    NetworkInterfaceId = "10.1.1.1",
    SnapshotId = "snap-f47b7b94",
    TargetName = "my-volume",
    VolumeSizeInBytes = 536870912000
});

string targetARN = response.TargetARN;
string volumeARN = response.VolumeARN;

            

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