createStorediSCSIVolume method

Future<CreateStorediSCSIVolumeOutput> createStorediSCSIVolume({ required String diskId, required String gatewayARN, required String networkInterfaceId, required bool preserveExistingData, required String targetName, bool? kMSEncrypted, String? kMSKey, String? snapshotId, List<Tag>? tags, })

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.

May throw InvalidGatewayRequestException. May throw InternalServerError.

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

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

Parameter preserveExistingData : Set to true 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

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

Parameter kMSEncrypted : Set to 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.

Valid Values: true | false

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

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

Parameter tags : A list of up to 50 tags that can be assigned to a stored volume. Each tag is a key-value pair.

Implementation

Future<CreateStorediSCSIVolumeOutput> createStorediSCSIVolume({
  required String diskId,
  required String gatewayARN,
  required String networkInterfaceId,
  required bool preserveExistingData,
  required String targetName,
  bool? kMSEncrypted,
  String? kMSKey,
  String? snapshotId,
  List<Tag>? tags,
}) async {
  ArgumentError.checkNotNull(diskId, 'diskId');
  _s.validateStringLength(
    'diskId',
    diskId,
    1,
    300,
    isRequired: true,
  );
  ArgumentError.checkNotNull(gatewayARN, 'gatewayARN');
  _s.validateStringLength(
    'gatewayARN',
    gatewayARN,
    50,
    500,
    isRequired: true,
  );
  ArgumentError.checkNotNull(networkInterfaceId, 'networkInterfaceId');
  ArgumentError.checkNotNull(preserveExistingData, 'preserveExistingData');
  ArgumentError.checkNotNull(targetName, 'targetName');
  _s.validateStringLength(
    'targetName',
    targetName,
    1,
    200,
    isRequired: true,
  );
  _s.validateStringLength(
    'kMSKey',
    kMSKey,
    7,
    2048,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'StorageGateway_20130630.CreateStorediSCSIVolume'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'DiskId': diskId,
      'GatewayARN': gatewayARN,
      'NetworkInterfaceId': networkInterfaceId,
      'PreserveExistingData': preserveExistingData,
      'TargetName': targetName,
      if (kMSEncrypted != null) 'KMSEncrypted': kMSEncrypted,
      if (kMSKey != null) 'KMSKey': kMSKey,
      if (snapshotId != null) 'SnapshotId': snapshotId,
      if (tags != null) 'Tags': tags,
    },
  );

  return CreateStorediSCSIVolumeOutput.fromJson(jsonResponse.body);
}