@pulumi/digitalocean
Version:
A Pulumi package for creating and managing DigitalOcean cloud resources.
125 lines (124 loc) • 4.15 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a DigitalOcean NFS snapshot which can be used to create new NFS shares.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as digitalocean from "@pulumi/digitalocean";
*
* const foobar = new digitalocean.Vpc("foobar", {
* name: "example-vpc",
* region: "nyc1",
* });
* const foobarNfs = new digitalocean.Nfs("foobar", {
* region: "nyc1",
* name: "example-nfs",
* size: 50,
* vpcId: foobar.id,
* });
* const foobarNfsSnapshot = new digitalocean.NfsSnapshot("foobar", {
* name: "example-snapshot",
* shareId: foobarNfs.id,
* region: "nyc1",
* });
* ```
*
* ## Import
*
* NFS snapshots can be imported using the snapshot ID, e.g.
*
* ```sh
* $ pulumi import digitalocean:index/nfsSnapshot:NfsSnapshot foobar 506f78a4-e098-11e5-ad9f-000f53306ae1
* ```
*/
export declare class NfsSnapshot extends pulumi.CustomResource {
/**
* Get an existing NfsSnapshot 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?: NfsSnapshotState, opts?: pulumi.CustomResourceOptions): NfsSnapshot;
/**
* Returns true if the given object is an instance of NfsSnapshot. 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 NfsSnapshot;
/**
* The date and time when the snapshot was created.
*/
readonly createdAt: pulumi.Output<string>;
/**
* A name for the NFS snapshot. Must be lowercase and composed only of numbers, letters, and "-", up to a limit of 64 characters.
*/
readonly name: pulumi.Output<string>;
/**
* The region where the NFS snapshot will be created.
*/
readonly region: pulumi.Output<string>;
/**
* The ID of the NFS share to snapshot.
*/
readonly shareId: pulumi.Output<string>;
/**
* The size of the snapshot in GiB.
*/
readonly size: pulumi.Output<number>;
readonly status: pulumi.Output<string>;
/**
* Create a NfsSnapshot 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: NfsSnapshotArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering NfsSnapshot resources.
*/
export interface NfsSnapshotState {
/**
* The date and time when the snapshot was created.
*/
createdAt?: pulumi.Input<string>;
/**
* A name for the NFS snapshot. Must be lowercase and composed only of numbers, letters, and "-", up to a limit of 64 characters.
*/
name?: pulumi.Input<string>;
/**
* The region where the NFS snapshot will be created.
*/
region?: pulumi.Input<string>;
/**
* The ID of the NFS share to snapshot.
*/
shareId?: pulumi.Input<string>;
/**
* The size of the snapshot in GiB.
*/
size?: pulumi.Input<number>;
status?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a NfsSnapshot resource.
*/
export interface NfsSnapshotArgs {
/**
* A name for the NFS snapshot. Must be lowercase and composed only of numbers, letters, and "-", up to a limit of 64 characters.
*/
name?: pulumi.Input<string>;
/**
* The region where the NFS snapshot will be created.
*/
region: pulumi.Input<string>;
/**
* The ID of the NFS share to snapshot.
*/
shareId: pulumi.Input<string>;
}