UNPKG

@pulumi/digitalocean

Version:

A Pulumi package for creating and managing DigitalOcean cloud resources.

93 lines 3.72 kB
"use strict"; // *** WARNING: this file was generated by pulumi-language-nodejs. *** // *** Do not edit by hand unless you're certain you know what you are doing! *** Object.defineProperty(exports, "__esModule", { value: true }); exports.ReservedIpAssignment = void 0; const pulumi = require("@pulumi/pulumi"); const utilities = require("./utilities"); /** * Provides a resource for assigning an existing DigitalOcean reserved IP to a Droplet. This * makes it easy to provision reserved IP addresses that are not tied to the lifecycle of your * Droplet. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as digitalocean from "@pulumi/digitalocean"; * * const example = new digitalocean.ReservedIp("example", {region: "nyc3"}); * const exampleDroplet = new digitalocean.Droplet("example", { * name: "baz", * size: digitalocean.DropletSlug.DropletS1VCPU1GB, * image: "ubuntu-22-04-x64", * region: digitalocean.Region.NYC3, * ipv6: true, * privateNetworking: true, * }); * const exampleReservedIpAssignment = new digitalocean.ReservedIpAssignment("example", { * ipAddress: example.ipAddress, * dropletId: exampleDroplet.id, * }); * ``` * * ## Import * * Reserved IP assignments can be imported using the reserved IP itself and the `id` of * * the Droplet joined with a comma. For example: * * ```sh * $ pulumi import digitalocean:index/reservedIpAssignment:ReservedIpAssignment foobar 192.0.2.1,123456 * ``` */ class ReservedIpAssignment extends pulumi.CustomResource { /** * Get an existing ReservedIpAssignment 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, id, state, opts) { return new ReservedIpAssignment(name, state, { ...opts, id: id }); } /** * Returns true if the given object is an instance of ReservedIpAssignment. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj) { if (obj === undefined || obj === null) { return false; } return obj['__pulumiType'] === ReservedIpAssignment.__pulumiType; } constructor(name, argsOrState, opts) { let resourceInputs = {}; opts = opts || {}; if (opts.id) { const state = argsOrState; resourceInputs["dropletId"] = state?.dropletId; resourceInputs["ipAddress"] = state?.ipAddress; } else { const args = argsOrState; if (args?.dropletId === undefined && !opts.urn) { throw new Error("Missing required property 'dropletId'"); } if (args?.ipAddress === undefined && !opts.urn) { throw new Error("Missing required property 'ipAddress'"); } resourceInputs["dropletId"] = args?.dropletId; resourceInputs["ipAddress"] = args?.ipAddress; } opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts); super(ReservedIpAssignment.__pulumiType, name, resourceInputs, opts); } } exports.ReservedIpAssignment = ReservedIpAssignment; /** @internal */ ReservedIpAssignment.__pulumiType = 'digitalocean:index/reservedIpAssignment:ReservedIpAssignment'; //# sourceMappingURL=reservedIpAssignment.js.map