Description Usage Arguments Value Request syntax Examples
View source: R/storagegateway_operations.R
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 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.
1 2 3 | storagegateway_create_cachedi_scsi_volume(GatewayARN, VolumeSizeInBytes,
SnapshotId, TargetName, SourceVolumeARN, NetworkInterfaceId,
ClientToken, KMSEncrypted, KMSKey, Tags)
|
GatewayARN |
[required] |
VolumeSizeInBytes |
[required] The size of the volume in bytes. |
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. |
TargetName |
[required] 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
If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name. |
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 |
NetworkInterfaceId |
[required] The network interface of the gateway on which to expose the iSCSI
target. Only IPv4 addresses are accepted. Use
Valid Values: A valid IP address. |
ClientToken |
[required] A unique identifier that you use to retry a request. If you retry a
request, use the same |
KMSEncrypted |
Set to Valid Values: |
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 |
Tags |
A list of up to 50 tags that you can assign to a cached volume. Each tag is a key-value pair. Valid characters for key and value are letters, spaces, and numbers that you can represent in UTF-8 format, and the following special characters:
|
A list with the following syntax:
1 2 3 4 | list(
VolumeARN = "string",
TargetARN = "string"
)
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | svc$create_cachedi_scsi_volume(
GatewayARN = "string",
VolumeSizeInBytes = 123,
SnapshotId = "string",
TargetName = "string",
SourceVolumeARN = "string",
NetworkInterfaceId = "string",
ClientToken = "string",
KMSEncrypted = TRUE|FALSE,
KMSKey = "string",
Tags = list(
list(
Key = "string",
Value = "string"
)
)
)
|
1 2 3 4 5 6 7 8 9 10 11 12 | ## Not run:
# Creates a cached volume on a specified cached gateway.
svc$create_cachedi_scsi_volume(
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
)
## End(Not run)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.