@pulumi/digitalocean
Version:
A Pulumi package for creating and managing DigitalOcean cloud resources.
91 lines • 3.62 kB
JavaScript
;
// *** 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.ReservedIp = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
* Provides a DigitalOcean reserved IP to represent a publicly-accessible static IP addresses that can be mapped to one of your Droplets.
*
* > **NOTE:** Reserved IPs can be assigned to a Droplet either directly on the `digitalocean.ReservedIp` resource by setting a `dropletId` or using the `digitalocean.ReservedIpAssignment` resource, but the two cannot be used together.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as digitalocean from "@pulumi/digitalocean";
*
* const example = new digitalocean.Droplet("example", {
* name: "example",
* size: digitalocean.DropletSlug.DropletS1VCPU1GB,
* image: "ubuntu-22-04-x64",
* region: digitalocean.Region.NYC3,
* ipv6: true,
* privateNetworking: true,
* });
* const exampleReservedIp = new digitalocean.ReservedIp("example", {
* dropletId: example.id,
* region: example.region,
* });
* ```
*
* ## Import
*
* Reserved IPs can be imported using the `ip`, e.g.
*
* ```sh
* $ pulumi import digitalocean:index/reservedIp:ReservedIp myip 192.168.0.1
* ```
*/
class ReservedIp extends pulumi.CustomResource {
/**
* Get an existing ReservedIp 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 ReservedIp(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of ReservedIp. 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'] === ReservedIp.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["dropletId"] = state?.dropletId;
resourceInputs["ipAddress"] = state?.ipAddress;
resourceInputs["region"] = state?.region;
resourceInputs["reservedIpUrn"] = state?.reservedIpUrn;
}
else {
const args = argsOrState;
if (args?.region === undefined && !opts.urn) {
throw new Error("Missing required property 'region'");
}
resourceInputs["dropletId"] = args?.dropletId;
resourceInputs["ipAddress"] = args?.ipAddress;
resourceInputs["region"] = args?.region;
resourceInputs["reservedIpUrn"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(ReservedIp.__pulumiType, name, resourceInputs, opts);
}
}
exports.ReservedIp = ReservedIp;
/** @internal */
ReservedIp.__pulumiType = 'digitalocean:index/reservedIp:ReservedIp';
//# sourceMappingURL=reservedIp.js.map