@pulumi/digitalocean/reservedIpAssignment.d.ts

A Pulumi package for creating and managing DigitalOcean cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * 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
 * ```
 */
export declare 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: string, id: pulumi.Input<pulumi.ID>, state?: ReservedIpAssignmentState, opts?: pulumi.CustomResourceOptions): ReservedIpAssignment;
    /**
     * 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: any): obj is ReservedIpAssignment;
    /**
     * The ID of Droplet that the reserved IP will be assigned to.
     */
    readonly dropletId: pulumi.Output<number>;
    /**
     * The reserved IP to assign to the Droplet.
     */
    readonly ipAddress: pulumi.Output<string>;
    /**
     * Create a ReservedIpAssignment 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: ReservedIpAssignmentArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering ReservedIpAssignment resources.
 */
export interface ReservedIpAssignmentState {
    /**
     * The ID of Droplet that the reserved IP will be assigned to.
     */
    dropletId?: pulumi.Input<number>;
    /**
     * The reserved IP to assign to the Droplet.
     */
    ipAddress?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a ReservedIpAssignment resource.
 */
export interface ReservedIpAssignmentArgs {
    /**
     * The ID of Droplet that the reserved IP will be assigned to.
     */
    dropletId: pulumi.Input<number>;
    /**
     * The reserved IP to assign to the Droplet.
     */
    ipAddress: pulumi.Input<string>;
}