@pulumi/digitalocean
Version:
A Pulumi package for creating and managing DigitalOcean cloud resources.
143 lines (142 loc) • 4.83 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a DigitalOcean NFS share which can be mounted to Droplets to provide shared storage.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as digitalocean from "@pulumi/digitalocean";
*
* const example = new digitalocean.Vpc("example", {
* name: "example-vpc",
* region: "nyc1",
* });
* const exampleNfs = new digitalocean.Nfs("example", {
* region: "nyc1",
* name: "example-nfs",
* size: 50,
* vpcId: example.id,
* });
* ```
*
* ## Import
*
* NFS shares can be imported using the `share id` and the `region` , e.g.
*
* ```sh
* $ pulumi import digitalocean:index/nfs:Nfs foobar 506f78a4-e098-11e5-ad9f-000f53306ae1,atl1
* ```
*/
export declare class Nfs extends pulumi.CustomResource {
/**
* Get an existing Nfs 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?: NfsState, opts?: pulumi.CustomResourceOptions): Nfs;
/**
* Returns true if the given object is an instance of Nfs. 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 Nfs;
/**
* The host IP of the NFS server accessible from the associated VPC.
*/
readonly host: pulumi.Output<string>;
/**
* The mount path for accessing the NFS share.
*/
readonly mountPath: pulumi.Output<string>;
/**
* A name for the NFS share. Must be lowercase and composed only of numbers, letters, and "-", up to a limit of 64 characters. The name must begin with a letter.
*/
readonly name: pulumi.Output<string>;
/**
* The region where the NFS share will be created.
*/
readonly region: pulumi.Output<string>;
/**
* The size of the NFS share in GiB. Minimum size is 50 GiB.
*/
readonly size: pulumi.Output<number>;
/**
* The current status of the NFS share.
*/
readonly status: pulumi.Output<string>;
readonly tags: pulumi.Output<string[] | undefined>;
/**
* The ID of the VPC where the NFS share will be created.
*/
readonly vpcId: pulumi.Output<string>;
readonly vpcIds: pulumi.Output<string[]>;
/**
* Create a Nfs 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: NfsArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Nfs resources.
*/
export interface NfsState {
/**
* The host IP of the NFS server accessible from the associated VPC.
*/
host?: pulumi.Input<string>;
/**
* The mount path for accessing the NFS share.
*/
mountPath?: pulumi.Input<string>;
/**
* A name for the NFS share. Must be lowercase and composed only of numbers, letters, and "-", up to a limit of 64 characters. The name must begin with a letter.
*/
name?: pulumi.Input<string>;
/**
* The region where the NFS share will be created.
*/
region?: pulumi.Input<string>;
/**
* The size of the NFS share in GiB. Minimum size is 50 GiB.
*/
size?: pulumi.Input<number>;
/**
* The current status of the NFS share.
*/
status?: pulumi.Input<string>;
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The ID of the VPC where the NFS share will be created.
*/
vpcId?: pulumi.Input<string>;
vpcIds?: pulumi.Input<pulumi.Input<string>[]>;
}
/**
* The set of arguments for constructing a Nfs resource.
*/
export interface NfsArgs {
/**
* A name for the NFS share. Must be lowercase and composed only of numbers, letters, and "-", up to a limit of 64 characters. The name must begin with a letter.
*/
name?: pulumi.Input<string>;
/**
* The region where the NFS share will be created.
*/
region: pulumi.Input<string>;
/**
* The size of the NFS share in GiB. Minimum size is 50 GiB.
*/
size: pulumi.Input<number>;
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The ID of the VPC where the NFS share will be created.
*/
vpcId: pulumi.Input<string>;
}