UploadBuffer class

Manages an AWS Storage Gateway upload buffer.

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

Example Usage

Cached and VTL Gateway Type

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = aws.storagegateway.getLocalDisk({
    diskNode: testAwsVolumeAttachment.deviceName,
    gatewayArn: testAwsStoragegatewayGateway.arn,
});
const testUploadBuffer = new aws.storagegateway.UploadBuffer("test", {
    diskPath: test.then(test => test.diskPath),
    gatewayArn: testAwsStoragegatewayGateway.arn,
});
import pulumi
import pulumi_aws as aws

test = aws.storagegateway.get_local_disk(disk_node=test_aws_volume_attachment["deviceName"],
    gateway_arn=test_aws_storagegateway_gateway["arn"])
test_upload_buffer = aws.storagegateway.UploadBuffer("test",
    disk_path=test.disk_path,
    gateway_arn=test_aws_storagegateway_gateway["arn"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var test = Aws.StorageGateway.GetLocalDisk.Invoke(new()
    {
        DiskNode = testAwsVolumeAttachment.DeviceName,
        GatewayArn = testAwsStoragegatewayGateway.Arn,
    });

    var testUploadBuffer = new Aws.StorageGateway.UploadBuffer("test", new()
    {
        DiskPath = test.Apply(getLocalDiskResult => getLocalDiskResult.DiskPath),
        GatewayArn = testAwsStoragegatewayGateway.Arn,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/storagegateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		test, err := storagegateway.GetLocalDisk(ctx, &storagegateway.GetLocalDiskArgs{
			DiskNode:   pulumi.StringRef(testAwsVolumeAttachment.DeviceName),
			GatewayArn: testAwsStoragegatewayGateway.Arn,
		}, nil)
		if err != nil {
			return err
		}
		_, err = storagegateway.NewUploadBuffer(ctx, "test", &storagegateway.UploadBufferArgs{
			DiskPath:   pulumi.String(test.DiskPath),
			GatewayArn: pulumi.Any(testAwsStoragegatewayGateway.Arn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_storagegateway_getlocaldisk" "test" {
  disk_node   = testAwsVolumeAttachment.deviceName
  gateway_arn = testAwsStoragegatewayGateway.arn
}

resource "aws_storagegateway_uploadbuffer" "test" {
  disk_path   = data.aws_storagegateway_getlocaldisk.test.disk_path
  gateway_arn = testAwsStoragegatewayGateway.arn
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.storagegateway.StoragegatewayFunctions;
import com.pulumi.aws.storagegateway.inputs.GetLocalDiskArgs;
import com.pulumi.aws.storagegateway.UploadBuffer;
import com.pulumi.aws.storagegateway.UploadBufferArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var test = StoragegatewayFunctions.getLocalDisk(GetLocalDiskArgs.builder()
            .diskNode(testAwsVolumeAttachment.deviceName())
            .gatewayArn(testAwsStoragegatewayGateway.arn())
            .build());

        var testUploadBuffer = new UploadBuffer("testUploadBuffer", UploadBufferArgs.builder()
            .diskPath(test.diskPath())
            .gatewayArn(testAwsStoragegatewayGateway.arn())
            .build());

    }
}
resources:
  testUploadBuffer:
    type: aws:storagegateway:UploadBuffer
    name: test
    properties:
      diskPath: ${test.diskPath}
      gatewayArn: ${testAwsStoragegatewayGateway.arn}
variables:
  test:
    fn::invoke:
      function: aws:storagegateway:getLocalDisk
      arguments:
        diskNode: ${testAwsVolumeAttachment.deviceName}
        gatewayArn: ${testAwsStoragegatewayGateway.arn}

Stored Gateway Type

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = aws.storagegateway.getLocalDisk({
    diskNode: testAwsVolumeAttachment.deviceName,
    gatewayArn: testAwsStoragegatewayGateway.arn,
});
const example = new aws.storagegateway.UploadBuffer("example", {
    diskId: exampleAwsStoragegatewayLocalDisk.id,
    gatewayArn: exampleAwsStoragegatewayGateway.arn,
});
import pulumi
import pulumi_aws as aws

test = aws.storagegateway.get_local_disk(disk_node=test_aws_volume_attachment["deviceName"],
    gateway_arn=test_aws_storagegateway_gateway["arn"])
example = aws.storagegateway.UploadBuffer("example",
    disk_id=example_aws_storagegateway_local_disk["id"],
    gateway_arn=example_aws_storagegateway_gateway["arn"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var test = Aws.StorageGateway.GetLocalDisk.Invoke(new()
    {
        DiskNode = testAwsVolumeAttachment.DeviceName,
        GatewayArn = testAwsStoragegatewayGateway.Arn,
    });

    var example = new Aws.StorageGateway.UploadBuffer("example", new()
    {
        DiskId = exampleAwsStoragegatewayLocalDisk.Id,
        GatewayArn = exampleAwsStoragegatewayGateway.Arn,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/storagegateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := storagegateway.GetLocalDisk(ctx, &storagegateway.GetLocalDiskArgs{
			DiskNode:   pulumi.StringRef(testAwsVolumeAttachment.DeviceName),
			GatewayArn: testAwsStoragegatewayGateway.Arn,
		}, nil)
		if err != nil {
			return err
		}
		_, err = storagegateway.NewUploadBuffer(ctx, "example", &storagegateway.UploadBufferArgs{
			DiskId:     pulumi.Any(exampleAwsStoragegatewayLocalDisk.Id),
			GatewayArn: pulumi.Any(exampleAwsStoragegatewayGateway.Arn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_storagegateway_getlocaldisk" "test" {
  disk_node   = testAwsVolumeAttachment.deviceName
  gateway_arn = testAwsStoragegatewayGateway.arn
}

resource "aws_storagegateway_uploadbuffer" "example" {
  disk_id     = exampleAwsStoragegatewayLocalDisk.id
  gateway_arn = exampleAwsStoragegatewayGateway.arn
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.storagegateway.StoragegatewayFunctions;
import com.pulumi.aws.storagegateway.inputs.GetLocalDiskArgs;
import com.pulumi.aws.storagegateway.UploadBuffer;
import com.pulumi.aws.storagegateway.UploadBufferArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var test = StoragegatewayFunctions.getLocalDisk(GetLocalDiskArgs.builder()
            .diskNode(testAwsVolumeAttachment.deviceName())
            .gatewayArn(testAwsStoragegatewayGateway.arn())
            .build());

        var example = new UploadBuffer("example", UploadBufferArgs.builder()
            .diskId(exampleAwsStoragegatewayLocalDisk.id())
            .gatewayArn(exampleAwsStoragegatewayGateway.arn())
            .build());

    }
}
resources:
  example:
    type: aws:storagegateway:UploadBuffer
    properties:
      diskId: ${exampleAwsStoragegatewayLocalDisk.id}
      gatewayArn: ${exampleAwsStoragegatewayGateway.arn}
variables:
  test:
    fn::invoke:
      function: aws:storagegateway:getLocalDisk
      arguments:
        diskNode: ${testAwsVolumeAttachment.deviceName}
        gatewayArn: ${testAwsStoragegatewayGateway.arn}

Import

Using pulumi import, import aws.storagegateway.UploadBuffer using the gateway ARN and local disk identifier separated with a colon (:). For example:

$ pulumi import aws:storagegateway/uploadBuffer:UploadBuffer example arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678:pci-0000:03:00.0-scsi-0:0:0:0

Constructors

UploadBuffer(String name, {UploadBufferArgs? args, CustomResourceOptions? options})
Creates a new UploadBuffer. name The Pulumi resource name. args Arguments used to configure this UploadBuffer. The set of arguments for UploadBuffer. options Resource options controlling this resource's behavior.
UploadBuffer.reference(String urn)
Creates a typed reference to an existing UploadBuffer resource.

Properties

childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
diskId ↔ Output<String>
Local disk identifier. For example, pci-0000:03:00.0-scsi-0:0:0:0.
latefinal
diskPath ↔ Output<String>
Local disk path. For example, /dev/nvme1n1.
latefinal
gatewayArn ↔ Output<String>
ARN of the gateway.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {UploadBufferState? state, CustomResourceOptions? options}) → UploadBuffer
Gets an existing UploadBuffer resource's state with the given name and id.