@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
98 lines (97 loc) • 4.02 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages an AWS Storage Gateway working storage.
*
* > **NOTE:** The Storage Gateway API provides no method to remove a working storage disk. Destroying this resource does not perform any Storage Gateway actions.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.storagegateway.WorkingStorage("example", {
* diskId: exampleAwsStoragegatewayLocalDisk.id,
* gatewayArn: exampleAwsStoragegatewayGateway.arn,
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import `aws_storagegateway_working_storage` using the gateway Amazon Resource Name (ARN) and local disk identifier separated with a colon (`:`). For example:
*
* ```sh
* $ pulumi import aws:storagegateway/workingStorage:WorkingStorage example arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678:pci-0000:03:00.0-scsi-0:0:0:0
* ```
*/
export declare class WorkingStorage extends pulumi.CustomResource {
/**
* Get an existing WorkingStorage resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: WorkingStorageState, opts?: pulumi.CustomResourceOptions): WorkingStorage;
/**
* Returns true if the given object is an instance of WorkingStorage. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is WorkingStorage;
/**
* Local disk identifier. For example, `pci-0000:03:00.0-scsi-0:0:0:0`.
*/
readonly diskId: pulumi.Output<string>;
/**
* The Amazon Resource Name (ARN) of the gateway.
*/
readonly gatewayArn: pulumi.Output<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
/**
* Create a WorkingStorage resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: WorkingStorageArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering WorkingStorage resources.
*/
export interface WorkingStorageState {
/**
* Local disk identifier. For example, `pci-0000:03:00.0-scsi-0:0:0:0`.
*/
diskId?: pulumi.Input<string>;
/**
* The Amazon Resource Name (ARN) of the gateway.
*/
gatewayArn?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a WorkingStorage resource.
*/
export interface WorkingStorageArgs {
/**
* Local disk identifier. For example, `pci-0000:03:00.0-scsi-0:0:0:0`.
*/
diskId: pulumi.Input<string>;
/**
* The Amazon Resource Name (ARN) of the gateway.
*/
gatewayArn: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
}