Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

FloatingIp

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

using Pulumi;
using HCloud = Pulumi.HCloud;

class MyStack : Stack
{
    public MyStack()
    {
        var node1 = new HCloud.Server("node1", new HCloud.ServerArgs
        {
            Image = "debian-9",
            ServerType = "cx11",
        });
        var master = new HCloud.FloatingIp("master", new HCloud.FloatingIpArgs
        {
            Type = "ipv4",
            ServerId = node1.Id,
        });
    }

}
package main

import (
    "github.com/pulumi/pulumi-hcloud/sdk/go/hcloud"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        node1, err := hcloud.NewServer(ctx, "node1", &hcloud.ServerArgs{
            Image:      pulumi.String("debian-9"),
            ServerType: pulumi.String("cx11"),
        })
        if err != nil {
            return err
        }
        _, err = hcloud.NewFloatingIp(ctx, "master", &hcloud.FloatingIpArgs{
            Type:     pulumi.String("ipv4"),
            ServerId: node1.ID(),
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_hcloud as hcloud

node1 = hcloud.Server("node1",
    image="debian-9",
    server_type="cx11")
master = hcloud.FloatingIp("master",
    type="ipv4",
    server_id=node1.id)
import * as pulumi from "@pulumi/pulumi";
import * as hcloud from "@pulumi/hcloud";

const node1 = new hcloud.Server("node1", {
    image: "debian-9",
    serverType: "cx11",
});
const master = new hcloud.FloatingIp("master", {
    type: "ipv4",
    serverId: node1.id,
});

Create a FloatingIp Resource

new FloatingIp(name: string, args: FloatingIpArgs, opts?: CustomResourceOptions);
def FloatingIp(resource_name: str, opts: Optional[ResourceOptions] = None, description: Optional[str] = None, home_location: Optional[str] = None, labels: Optional[Mapping[str, Any]] = None, name: Optional[str] = None, server_id: Optional[int] = None, type: Optional[str] = None)
func NewFloatingIp(ctx *Context, name string, args FloatingIpArgs, opts ...ResourceOption) (*FloatingIp, error)
public FloatingIp(string name, FloatingIpArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args FloatingIpArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args FloatingIpArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args FloatingIpArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

FloatingIp Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The FloatingIp resource accepts the following input properties:

Type string

Type of the Floating IP. ipv4 ipv6

Description string

Description of the Floating IP.

HomeLocation string

Home location (routing is optimized for that location). Optional if server_id argument is passed.

Labels Dictionary<string, object>

User-defined labels (key-value pairs) should be created with.

Name string

Name of the Floating IP.

ServerId int

Server to assign the Floating IP to.

Type string

Type of the Floating IP. ipv4 ipv6

Description string

Description of the Floating IP.

HomeLocation string

Home location (routing is optimized for that location). Optional if server_id argument is passed.

Labels map[string]interface{}

User-defined labels (key-value pairs) should be created with.

Name string

Name of the Floating IP.

ServerId int

Server to assign the Floating IP to.

type string

Type of the Floating IP. ipv4 ipv6

description string

Description of the Floating IP.

homeLocation string

Home location (routing is optimized for that location). Optional if server_id argument is passed.

labels {[key: string]: any}

User-defined labels (key-value pairs) should be created with.

name string

Name of the Floating IP.

serverId number

Server to assign the Floating IP to.

type str

Type of the Floating IP. ipv4 ipv6

description str

Description of the Floating IP.

home_location str

Home location (routing is optimized for that location). Optional if server_id argument is passed.

labels Mapping[str, Any]

User-defined labels (key-value pairs) should be created with.

name str

Name of the Floating IP.

server_id int

Server to assign the Floating IP to.

Outputs

All input properties are implicitly available as output properties. Additionally, the FloatingIp resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
IpAddress string

(string) IP Address of the Floating IP.

IpNetwork string

(string) IPv6 subnet. (Only set if type is ipv6)

Id string
The provider-assigned unique ID for this managed resource.
IpAddress string

(string) IP Address of the Floating IP.

IpNetwork string

(string) IPv6 subnet. (Only set if type is ipv6)

id string
The provider-assigned unique ID for this managed resource.
ipAddress string

(string) IP Address of the Floating IP.

ipNetwork string

(string) IPv6 subnet. (Only set if type is ipv6)

id str
The provider-assigned unique ID for this managed resource.
ip_address str

(string) IP Address of the Floating IP.

ip_network str

(string) IPv6 subnet. (Only set if type is ipv6)

Look up an Existing FloatingIp Resource

Get an existing FloatingIp resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: FloatingIpState, opts?: CustomResourceOptions): FloatingIp
@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, description: Optional[str] = None, home_location: Optional[str] = None, ip_address: Optional[str] = None, ip_network: Optional[str] = None, labels: Optional[Mapping[str, Any]] = None, name: Optional[str] = None, server_id: Optional[int] = None, type: Optional[str] = None) -> FloatingIp
func GetFloatingIp(ctx *Context, name string, id IDInput, state *FloatingIpState, opts ...ResourceOption) (*FloatingIp, error)
public static FloatingIp Get(string name, Input<string> id, FloatingIpState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

Description string

Description of the Floating IP.

HomeLocation string

Home location (routing is optimized for that location). Optional if server_id argument is passed.

IpAddress string

(string) IP Address of the Floating IP.

IpNetwork string

(string) IPv6 subnet. (Only set if type is ipv6)

Labels Dictionary<string, object>

User-defined labels (key-value pairs) should be created with.

Name string

Name of the Floating IP.

ServerId int

Server to assign the Floating IP to.

Type string

Type of the Floating IP. ipv4 ipv6

Description string

Description of the Floating IP.

HomeLocation string

Home location (routing is optimized for that location). Optional if server_id argument is passed.

IpAddress string

(string) IP Address of the Floating IP.

IpNetwork string

(string) IPv6 subnet. (Only set if type is ipv6)

Labels map[string]interface{}

User-defined labels (key-value pairs) should be created with.

Name string

Name of the Floating IP.

ServerId int

Server to assign the Floating IP to.

Type string

Type of the Floating IP. ipv4 ipv6

description string

Description of the Floating IP.

homeLocation string

Home location (routing is optimized for that location). Optional if server_id argument is passed.

ipAddress string

(string) IP Address of the Floating IP.

ipNetwork string

(string) IPv6 subnet. (Only set if type is ipv6)

labels {[key: string]: any}

User-defined labels (key-value pairs) should be created with.

name string

Name of the Floating IP.

serverId number

Server to assign the Floating IP to.

type string

Type of the Floating IP. ipv4 ipv6

description str

Description of the Floating IP.

home_location str

Home location (routing is optimized for that location). Optional if server_id argument is passed.

ip_address str

(string) IP Address of the Floating IP.

ip_network str

(string) IPv6 subnet. (Only set if type is ipv6)

labels Mapping[str, Any]

User-defined labels (key-value pairs) should be created with.

name str

Name of the Floating IP.

server_id int

Server to assign the Floating IP to.

type str

Type of the Floating IP. ipv4 ipv6

Import

Floating IPs can be imported using its id

 $ pulumi import hcloud:index/floatingIp:FloatingIp myip <id>

Package Details

Repository
https://github.com/pulumi/pulumi-hcloud
License
Apache-2.0
Notes
This Pulumi package is based on the hcloud Terraform Provider.