@pulumi/hcloud
Version:
A Pulumi package for creating and managing hcloud cloud resources.
171 lines (170 loc) • 5.55 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a Hetzner Cloud Floating IP to represent a publicly-accessible static IP address that can be mapped to one of your servers.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as hcloud from "@pulumi/hcloud";
*
* const node1 = new hcloud.Server("node1", {
* name: "node1",
* image: "debian-11",
* serverType: "cx22",
* });
* const master = new hcloud.FloatingIp("master", {
* type: "ipv4",
* serverId: node1.id,
* });
* ```
*
* ## Import
*
* Floating IPs can be imported using its `id`:
*
* ```sh
* $ pulumi import hcloud:index/floatingIp:FloatingIp example "$FLOATING_IP_ID"
* ```
*/
export declare class FloatingIp extends pulumi.CustomResource {
/**
* Get an existing FloatingIp 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?: FloatingIpState, opts?: pulumi.CustomResourceOptions): FloatingIp;
/**
* Returns true if the given object is an instance of FloatingIp. 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 FloatingIp;
/**
* Enable or disable delete protection. See "Delete Protection" in the Provider Docs for details.
*/
readonly deleteProtection: pulumi.Output<boolean | undefined>;
/**
* Description of the Floating IP.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Name of home location (routing is optimized for that location). Optional if `serverId` argument is passed.
*/
readonly homeLocation: pulumi.Output<string>;
/**
* (string) IP Address of the Floating IP.
*/
readonly ipAddress: pulumi.Output<string>;
/**
* (string) IPv6 subnet. (Only set if `type` is `ipv6`)
*/
readonly ipNetwork: pulumi.Output<string>;
/**
* User-defined labels (key-value pairs) should be created with.
*/
readonly labels: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Name of the Floating IP.
*/
readonly name: pulumi.Output<string>;
/**
* Server to assign the Floating IP to. Optional if `homeLocation` argument is passed.
*/
readonly serverId: pulumi.Output<number>;
/**
* Type of the Floating IP. `ipv4` `ipv6`
*/
readonly type: pulumi.Output<string>;
/**
* Create a FloatingIp 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: FloatingIpArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering FloatingIp resources.
*/
export interface FloatingIpState {
/**
* Enable or disable delete protection. See "Delete Protection" in the Provider Docs for details.
*/
deleteProtection?: pulumi.Input<boolean>;
/**
* Description of the Floating IP.
*/
description?: pulumi.Input<string>;
/**
* Name of home location (routing is optimized for that location). Optional if `serverId` argument is passed.
*/
homeLocation?: pulumi.Input<string>;
/**
* (string) IP Address of the Floating IP.
*/
ipAddress?: pulumi.Input<string>;
/**
* (string) IPv6 subnet. (Only set if `type` is `ipv6`)
*/
ipNetwork?: pulumi.Input<string>;
/**
* User-defined labels (key-value pairs) should be created with.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Name of the Floating IP.
*/
name?: pulumi.Input<string>;
/**
* Server to assign the Floating IP to. Optional if `homeLocation` argument is passed.
*/
serverId?: pulumi.Input<number>;
/**
* Type of the Floating IP. `ipv4` `ipv6`
*/
type?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a FloatingIp resource.
*/
export interface FloatingIpArgs {
/**
* Enable or disable delete protection. See "Delete Protection" in the Provider Docs for details.
*/
deleteProtection?: pulumi.Input<boolean>;
/**
* Description of the Floating IP.
*/
description?: pulumi.Input<string>;
/**
* Name of home location (routing is optimized for that location). Optional if `serverId` argument is passed.
*/
homeLocation?: pulumi.Input<string>;
/**
* User-defined labels (key-value pairs) should be created with.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Name of the Floating IP.
*/
name?: pulumi.Input<string>;
/**
* Server to assign the Floating IP to. Optional if `homeLocation` argument is passed.
*/
serverId?: pulumi.Input<number>;
/**
* Type of the Floating IP. `ipv4` `ipv6`
*/
type: pulumi.Input<string>;
}