UNPKG

@pulumi/digitalocean

Version:

A Pulumi package for creating and managing DigitalOcean cloud resources.

91 lines (90 loc) 3.41 kB
import * as pulumi from "@pulumi/pulumi"; /** * Manages attaching a Volume to a Droplet. * * > **NOTE:** Volumes can be attached either directly on the `digitalocean.Droplet` resource, or using the `digitalocean.VolumeAttachment` resource - but the two cannot be used together. If both are used against the same Droplet, the volume attachments will constantly drift. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as digitalocean from "@pulumi/digitalocean"; * * const foobar = new digitalocean.Volume("foobar", { * region: digitalocean.Region.NYC1, * name: "baz", * size: 100, * initialFilesystemType: digitalocean.FileSystemType.EXT4, * description: "an example volume", * }); * const foobarDroplet = new digitalocean.Droplet("foobar", { * name: "baz", * size: digitalocean.DropletSlug.DropletS1VCPU1GB, * image: "ubuntu-18-04-x64", * region: digitalocean.Region.NYC1, * }); * const foobarVolumeAttachment = new digitalocean.VolumeAttachment("foobar", { * dropletId: foobarDroplet.id, * volumeId: foobar.id, * }); * ``` */ export declare class VolumeAttachment extends pulumi.CustomResource { /** * Get an existing VolumeAttachment 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?: VolumeAttachmentState, opts?: pulumi.CustomResourceOptions): VolumeAttachment; /** * Returns true if the given object is an instance of VolumeAttachment. 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 VolumeAttachment; /** * ID of the Droplet to attach the volume to. */ readonly dropletId: pulumi.Output<number>; /** * ID of the Volume to be attached to the Droplet. */ readonly volumeId: pulumi.Output<string>; /** * Create a VolumeAttachment 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: VolumeAttachmentArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering VolumeAttachment resources. */ export interface VolumeAttachmentState { /** * ID of the Droplet to attach the volume to. */ dropletId?: pulumi.Input<number>; /** * ID of the Volume to be attached to the Droplet. */ volumeId?: pulumi.Input<string>; } /** * The set of arguments for constructing a VolumeAttachment resource. */ export interface VolumeAttachmentArgs { /** * ID of the Droplet to attach the volume to. */ dropletId: pulumi.Input<number>; /** * ID of the Volume to be attached to the Droplet. */ volumeId: pulumi.Input<string>; }