Skip to contents

Creates a volume on a specified gateway

Source: R/storagegateway_operations.R
storagegateway_create_storedi_scsi_volume.Rd

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

See https://www.paws-r-sdk.com/docs/storagegateway_create_storedi_scsi_volume/ for full documentation.

Usage

storagegateway_create_storedi_scsi_volume(
  GatewayARN,
  DiskId,
  SnapshotId = NULL,
  PreserveExistingData,
  TargetName,
  NetworkInterfaceId,
  KMSEncrypted = NULL,
  KMSKey = NULL,
  Tags = NULL
)

Arguments

GatewayARN

[required] The Amazon Resource Name (ARN) of the gateway. Use the list_gateways operation to return a list of gateways for your account and Amazon Web Services Region.

DiskId

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

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.

PreserveExistingData

[required] 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

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

NetworkInterfaceId

[required] The network interface of the gateway on which to expose the iSCSI target. Accepts IPv4 and IPv6 addresses. Use describe_gateway_information to get a list of the network interfaces available on a gateway.

Valid Values: A valid IP address.

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

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.

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.