Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . storagegateway ]

create-cached-iscsi-volume

Description

Creates a cached volume on a specified cached volume gateway. This operation is only supported in the cached volume gateway type.

Note

Cache storage must be allocated to the gateway before you can create a cached volume. Use the add-cache 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.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-cached-iscsi-volume
--gateway-arn <value>
--volume-size-in-bytes <value>
[--snapshot-id <value>]
--target-name <value>
[--source-volume-arn <value>]
--network-interface-id <value>
--client-token <value>
[--kms-encrypted | --no-kms-encrypted]
[--kms-key <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--gateway-arn (string)

The Amazon Resource Name (ARN) of the gateway. Use the list-gateways operation to return a list of gateways for your account and region.

--volume-size-in-bytes (long)

The size of the volume in bytes.

--snapshot-id (string)

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 .

--target-name (string)

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 target-name 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.

--source-volume-arn (string)

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.

--network-interface-id (string)

The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use describe-gateway-information to get a list of the network interfaces available on a gateway.

Valid Values: A valid IP address.

--client-token (string)

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

--kms-encrypted | --no-kms-encrypted (boolean)

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.

--kms-key (string)

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.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

VolumeARN -> (string)

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

TargetARN -> (string)

he Amazon Resource Name (ARN) of the volume target that includes the iSCSI name that initiators can use to connect to the target.