Skip to content

Resource: awsStoragegatewayUploadBuffer

Manages an AWS Storage Gateway upload buffer.

\~> NOTE: The Storage Gateway API provides no method to remove an upload buffer disk. Destroying this Terraform resource does not perform any Storage Gateway actions.

Example Usage

Cached and VTL Gateway Type

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
const dataAwsStoragegatewayLocalDiskTest =
  new aws.dataAwsStoragegatewayLocalDisk.DataAwsStoragegatewayLocalDisk(
    this,
    "test",
    {
      diskNode: "${aws_volume_attachment.test.device_name}",
      gatewayArn: "${aws_storagegateway_gateway.test.arn}",
    }
  );
const awsStoragegatewayUploadBufferTest =
  new aws.storagegatewayUploadBuffer.StoragegatewayUploadBuffer(
    this,
    "test_1",
    {
      diskPath: dataAwsStoragegatewayLocalDiskTest.diskPath,
      gatewayArn: "${aws_storagegateway_gateway.test.arn}",
    }
  );
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
awsStoragegatewayUploadBufferTest.overrideLogicalId("test");

Stored Gateway Type

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.storagegatewayUploadBuffer.StoragegatewayUploadBuffer(this, "example", {
  diskId: "${data.aws_storagegateway_local_disk.example.id}",
  gatewayArn: "${aws_storagegateway_gateway.example.arn}",
});
new aws.dataAwsStoragegatewayLocalDisk.DataAwsStoragegatewayLocalDisk(
  this,
  "test",
  {
    diskNode: "${aws_volume_attachment.test.device_name}",
    gatewayArn: "${aws_storagegateway_gateway.test.arn}",
  }
);

Argument Reference

The following arguments are supported:

  • diskId - (Optional) Local disk identifier. For example, pci0000:03:000Scsi0:0:0:0.
  • diskPath - (Optional) Local disk path. For example, /dev/nvme1N1.
  • gatewayArn - (Required) The Amazon Resource Name (ARN) of the gateway.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • id - Combined gateway Amazon Resource Name (ARN) and local disk identifier.

Import

awsStoragegatewayUploadBuffer can be imported by using the gateway Amazon Resource Name (ARN) and local disk identifier separated with a colon (:), e.g.,

$ terraform import aws_storagegateway_upload_buffer.example arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678:pci-0000:03:00.0-scsi-0:0:0:0