Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Digitalocean Provider
  3. API Docs
  4. FloatingIp
DigitalOcean v4.35.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-digitalocean

digitalocean.FloatingIp

Explore with Pulumi AI

digitalocean logo
DigitalOcean v4.35.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-digitalocean

    Deprecated: DigitalOcean Floating IPs have been renamed reserved IPs. This resource will be removed in a future release. Please use digitalocean.ReservedIp instead.

    Provides a DigitalOcean Floating IP to represent a publicly-accessible static IP addresses that can be mapped to one of your Droplets.

    NOTE: Floating IPs can be assigned to a Droplet either directly on the digitalocean.FloatingIp resource by setting a droplet_id or using the digitalocean.FloatingIpAssignment resource, but the two cannot be used together.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as digitalocean from "@pulumi/digitalocean";

const foobar = new digitalocean.Droplet("foobar", {
    name: "baz",
    size: digitalocean.DropletSlug.DropletS1VCPU1GB,
    image: "ubuntu-18-04-x64",
    region: digitalocean.Region.SGP1,
    ipv6: true,
    privateNetworking: true,
});
const foobarFloatingIp = new digitalocean.FloatingIp("foobar", {
    dropletId: foobar.id,
    region: foobar.region,
});

    import pulumi
import pulumi_digitalocean as digitalocean

foobar = digitalocean.Droplet("foobar",
    name="baz",
    size=digitalocean.DropletSlug.DROPLET_S1_VCPU1_GB,
    image="ubuntu-18-04-x64",
    region=digitalocean.Region.SGP1,
    ipv6=True,
    private_networking=True)
foobar_floating_ip = digitalocean.FloatingIp("foobar",
    droplet_id=foobar.id,
    region=foobar.region)

    package main

import (
	"github.com/pulumi/pulumi-digitalocean/sdk/v4/go/digitalocean"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		foobar, err := digitalocean.NewDroplet(ctx, "foobar", &digitalocean.DropletArgs{
			Name:              pulumi.String("baz"),
			Size:              pulumi.String(digitalocean.DropletSlugDropletS1VCPU1GB),
			Image:             pulumi.String("ubuntu-18-04-x64"),
			Region:            pulumi.String(digitalocean.RegionSGP1),
			Ipv6:              pulumi.Bool(true),
			PrivateNetworking: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = digitalocean.NewFloatingIp(ctx, "foobar", &digitalocean.FloatingIpArgs{
			DropletId: foobar.ID(),
			Region:    foobar.Region,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using DigitalOcean = Pulumi.DigitalOcean;

return await Deployment.RunAsync(() => 
{
    var foobar = new DigitalOcean.Droplet("foobar", new()
    {
        Name = "baz",
        Size = DigitalOcean.DropletSlug.DropletS1VCPU1GB,
        Image = "ubuntu-18-04-x64",
        Region = DigitalOcean.Region.SGP1,
        Ipv6 = true,
        PrivateNetworking = true,
    });

    var foobarFloatingIp = new DigitalOcean.FloatingIp("foobar", new()
    {
        DropletId = foobar.Id,
        Region = foobar.Region,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.digitalocean.Droplet;
import com.pulumi.digitalocean.DropletArgs;
import com.pulumi.digitalocean.FloatingIp;
import com.pulumi.digitalocean.FloatingIpArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var foobar = new Droplet("foobar", DropletArgs.builder()
            .name("baz")
            .size("s-1vcpu-1gb")
            .image("ubuntu-18-04-x64")
            .region("sgp1")
            .ipv6(true)
            .privateNetworking(true)
            .build());

        var foobarFloatingIp = new FloatingIp("foobarFloatingIp", FloatingIpArgs.builder()
            .dropletId(foobar.id())
            .region(foobar.region())
            .build());

    }
}

    resources:
  foobar:
    type: digitalocean:Droplet
    properties:
      name: baz
      size: s-1vcpu-1gb
      image: ubuntu-18-04-x64
      region: sgp1
      ipv6: true
      privateNetworking: true
  foobarFloatingIp:
    type: digitalocean:FloatingIp
    name: foobar
    properties:
      dropletId: ${foobar.id}
      region: ${foobar.region}

    Create FloatingIp Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new FloatingIp(name: string, args: FloatingIpArgs, opts?: CustomResourceOptions);
    @overload
def FloatingIp(resource_name: str,
               args: FloatingIpArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def FloatingIp(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               region: Optional[str] = None,
               droplet_id: Optional[int] = None,
               ip_address: Optional[str] = None)
    func NewFloatingIp(ctx *Context, name string, args FloatingIpArgs, opts ...ResourceOption) (*FloatingIp, error)
    public FloatingIp(string name, FloatingIpArgs args, CustomResourceOptions? opts = null)
    public FloatingIp(String name, FloatingIpArgs args)
public FloatingIp(String name, FloatingIpArgs args, CustomResourceOptions options)

    type: digitalocean:FloatingIp
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    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.
    args FloatingIpArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control 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.
    name String
    The unique name of the resource.
    args FloatingIpArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var floatingIpResource = new DigitalOcean.FloatingIp("floatingIpResource", new()
{
    Region = "string",
    DropletId = 0,
    IpAddress = "string",
});

    example, err := digitalocean.NewFloatingIp(ctx, "floatingIpResource", &digitalocean.FloatingIpArgs{
	Region:    pulumi.String("string"),
	DropletId: pulumi.Int(0),
	IpAddress: pulumi.String("string"),
})

    var floatingIpResource = new FloatingIp("floatingIpResource", FloatingIpArgs.builder()
    .region("string")
    .dropletId(0)
    .ipAddress("string")
    .build());

    floating_ip_resource = digitalocean.FloatingIp("floatingIpResource",
    region="string",
    droplet_id=0,
    ip_address="string")

    const floatingIpResource = new digitalocean.FloatingIp("floatingIpResource", {
    region: "string",
    dropletId: 0,
    ipAddress: "string",
});

    type: digitalocean:FloatingIp
properties:
    dropletId: 0
    ipAddress: string
    region: string

    FloatingIp Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The FloatingIp resource accepts the following input properties:

    Region string
    The region that the Floating IP is reserved to.
    DropletId int
    The ID of Droplet that the Floating IP will be assigned to.
    IpAddress string
    The IP Address of the resource
    Region string
    The region that the Floating IP is reserved to.
    DropletId int
    The ID of Droplet that the Floating IP will be assigned to.
    IpAddress string
    The IP Address of the resource
    region String
    The region that the Floating IP is reserved to.
    dropletId Integer
    The ID of Droplet that the Floating IP will be assigned to.
    ipAddress String
    The IP Address of the resource
    region string
    The region that the Floating IP is reserved to.
    dropletId number
    The ID of Droplet that the Floating IP will be assigned to.
    ipAddress string
    The IP Address of the resource
    region str
    The region that the Floating IP is reserved to.
    droplet_id int
    The ID of Droplet that the Floating IP will be assigned to.
    ip_address str
    The IP Address of the resource
    region String
    The region that the Floating IP is reserved to.
    dropletId Number
    The ID of Droplet that the Floating IP will be assigned to.
    ipAddress String
    The IP Address of the resource

    Outputs

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

    FloatingIpUrn string
    The uniform resource name of the floating ip
    Id string
    The provider-assigned unique ID for this managed resource.
    FloatingIpUrn string
    The uniform resource name of the floating ip
    Id string
    The provider-assigned unique ID for this managed resource.
    floatingIpUrn String
    The uniform resource name of the floating ip
    id String
    The provider-assigned unique ID for this managed resource.
    floatingIpUrn string
    The uniform resource name of the floating ip
    id string
    The provider-assigned unique ID for this managed resource.
    floating_ip_urn str
    The uniform resource name of the floating ip
    id str
    The provider-assigned unique ID for this managed resource.
    floatingIpUrn String
    The uniform resource name of the floating ip
    id String
    The provider-assigned unique ID for this managed resource.

    Look up 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,
        droplet_id: Optional[int] = None,
        floating_ip_urn: Optional[str] = None,
        ip_address: Optional[str] = None,
        region: 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)
    public static FloatingIp get(String name, Output<String> id, FloatingIpState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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:
    DropletId int
    The ID of Droplet that the Floating IP will be assigned to.
    FloatingIpUrn string
    The uniform resource name of the floating ip
    IpAddress string
    The IP Address of the resource
    Region string
    The region that the Floating IP is reserved to.
    DropletId int
    The ID of Droplet that the Floating IP will be assigned to.
    FloatingIpUrn string
    The uniform resource name of the floating ip
    IpAddress string
    The IP Address of the resource
    Region string
    The region that the Floating IP is reserved to.
    dropletId Integer
    The ID of Droplet that the Floating IP will be assigned to.
    floatingIpUrn String
    The uniform resource name of the floating ip
    ipAddress String
    The IP Address of the resource
    region String
    The region that the Floating IP is reserved to.
    dropletId number
    The ID of Droplet that the Floating IP will be assigned to.
    floatingIpUrn string
    The uniform resource name of the floating ip
    ipAddress string
    The IP Address of the resource
    region string
    The region that the Floating IP is reserved to.
    droplet_id int
    The ID of Droplet that the Floating IP will be assigned to.
    floating_ip_urn str
    The uniform resource name of the floating ip
    ip_address str
    The IP Address of the resource
    region str
    The region that the Floating IP is reserved to.
    dropletId Number
    The ID of Droplet that the Floating IP will be assigned to.
    floatingIpUrn String
    The uniform resource name of the floating ip
    ipAddress String
    The IP Address of the resource
    region String
    The region that the Floating IP is reserved to.

    Import

    Floating IPs can be imported using the ip, e.g.

    $ pulumi import digitalocean:index/floatingIp:FloatingIp myip 192.168.0.1

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    DigitalOcean pulumi/pulumi-digitalocean
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the digitalocean Terraform Provider.
    digitalocean logo
    DigitalOcean v4.35.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-digitalocean