1. Packages
  2. DigitalOcean
  3. API Docs
  4. FloatingIpAssignment
DigitalOcean v4.30.2 published on Wednesday, Jun 5, 2024 by Pulumi

digitalocean.FloatingIpAssignment

Explore with Pulumi AI

digitalocean logo
DigitalOcean v4.30.2 published on Wednesday, Jun 5, 2024 by Pulumi

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

    Provides a resource for assigning an existing DigitalOcean Floating IP to a Droplet. This makes it easy to provision floating IP addresses that are not tied to the lifecycle of your Droplet.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as digitalocean from "@pulumi/digitalocean";
    
    const foobar = new digitalocean.FloatingIp("foobar", {region: "sgp1"});
    const foobarDroplet = new digitalocean.Droplet("foobar", {
        name: "baz",
        size: digitalocean.DropletSlug.DropletS1VCPU1GB,
        image: "ubuntu-18-04-x64",
        region: digitalocean.Region.SGP1,
        ipv6: true,
        privateNetworking: true,
    });
    const foobarFloatingIpAssignment = new digitalocean.FloatingIpAssignment("foobar", {
        ipAddress: foobar.ipAddress,
        dropletId: foobarDroplet.id,
    });
    
    import pulumi
    import pulumi_digitalocean as digitalocean
    
    foobar = digitalocean.FloatingIp("foobar", region="sgp1")
    foobar_droplet = 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_assignment = digitalocean.FloatingIpAssignment("foobar",
        ip_address=foobar.ip_address,
        droplet_id=foobar_droplet.id)
    
    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.NewFloatingIp(ctx, "foobar", &digitalocean.FloatingIpArgs{
    			Region: pulumi.String("sgp1"),
    		})
    		if err != nil {
    			return err
    		}
    		foobarDroplet, 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.NewFloatingIpAssignment(ctx, "foobar", &digitalocean.FloatingIpAssignmentArgs{
    			IpAddress: foobar.IpAddress,
    			DropletId: foobarDroplet.ID(),
    		})
    		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.FloatingIp("foobar", new()
        {
            Region = "sgp1",
        });
    
        var foobarDroplet = 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 foobarFloatingIpAssignment = new DigitalOcean.FloatingIpAssignment("foobar", new()
        {
            IpAddress = foobar.IpAddress,
            DropletId = foobarDroplet.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.digitalocean.FloatingIp;
    import com.pulumi.digitalocean.FloatingIpArgs;
    import com.pulumi.digitalocean.Droplet;
    import com.pulumi.digitalocean.DropletArgs;
    import com.pulumi.digitalocean.FloatingIpAssignment;
    import com.pulumi.digitalocean.FloatingIpAssignmentArgs;
    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 FloatingIp("foobar", FloatingIpArgs.builder()
                .region("sgp1")
                .build());
    
            var foobarDroplet = new Droplet("foobarDroplet", DropletArgs.builder()
                .name("baz")
                .size("s-1vcpu-1gb")
                .image("ubuntu-18-04-x64")
                .region("sgp1")
                .ipv6(true)
                .privateNetworking(true)
                .build());
    
            var foobarFloatingIpAssignment = new FloatingIpAssignment("foobarFloatingIpAssignment", FloatingIpAssignmentArgs.builder()
                .ipAddress(foobar.ipAddress())
                .dropletId(foobarDroplet.id())
                .build());
    
        }
    }
    
    resources:
      foobar:
        type: digitalocean:FloatingIp
        properties:
          region: sgp1
      foobarDroplet:
        type: digitalocean:Droplet
        name: foobar
        properties:
          name: baz
          size: s-1vcpu-1gb
          image: ubuntu-18-04-x64
          region: sgp1
          ipv6: true
          privateNetworking: true
      foobarFloatingIpAssignment:
        type: digitalocean:FloatingIpAssignment
        name: foobar
        properties:
          ipAddress: ${foobar.ipAddress}
          dropletId: ${foobarDroplet.id}
    

    Create FloatingIpAssignment Resource

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

    Constructor syntax

    new FloatingIpAssignment(name: string, args: FloatingIpAssignmentArgs, opts?: CustomResourceOptions);
    @overload
    def FloatingIpAssignment(resource_name: str,
                             args: FloatingIpAssignmentArgs,
                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def FloatingIpAssignment(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             droplet_id: Optional[int] = None,
                             ip_address: Optional[str] = None)
    func NewFloatingIpAssignment(ctx *Context, name string, args FloatingIpAssignmentArgs, opts ...ResourceOption) (*FloatingIpAssignment, error)
    public FloatingIpAssignment(string name, FloatingIpAssignmentArgs args, CustomResourceOptions? opts = null)
    public FloatingIpAssignment(String name, FloatingIpAssignmentArgs args)
    public FloatingIpAssignment(String name, FloatingIpAssignmentArgs args, CustomResourceOptions options)
    
    type: digitalocean:FloatingIpAssignment
    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 FloatingIpAssignmentArgs
    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 FloatingIpAssignmentArgs
    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 FloatingIpAssignmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FloatingIpAssignmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FloatingIpAssignmentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var floatingIpAssignmentResource = new DigitalOcean.FloatingIpAssignment("floatingIpAssignmentResource", new()
    {
        DropletId = 0,
        IpAddress = "string",
    });
    
    example, err := digitalocean.NewFloatingIpAssignment(ctx, "floatingIpAssignmentResource", &digitalocean.FloatingIpAssignmentArgs{
    	DropletId: pulumi.Int(0),
    	IpAddress: pulumi.String("string"),
    })
    
    var floatingIpAssignmentResource = new FloatingIpAssignment("floatingIpAssignmentResource", FloatingIpAssignmentArgs.builder()
        .dropletId(0)
        .ipAddress("string")
        .build());
    
    floating_ip_assignment_resource = digitalocean.FloatingIpAssignment("floatingIpAssignmentResource",
        droplet_id=0,
        ip_address="string")
    
    const floatingIpAssignmentResource = new digitalocean.FloatingIpAssignment("floatingIpAssignmentResource", {
        dropletId: 0,
        ipAddress: "string",
    });
    
    type: digitalocean:FloatingIpAssignment
    properties:
        dropletId: 0
        ipAddress: string
    

    FloatingIpAssignment Resource Properties

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

    Inputs

    The FloatingIpAssignment resource accepts the following input properties:

    DropletId int
    The ID of Droplet that the Floating IP will be assigned to.
    IpAddress string
    The Floating IP to assign to the Droplet.
    DropletId int
    The ID of Droplet that the Floating IP will be assigned to.
    IpAddress string
    The Floating IP to assign to the Droplet.
    dropletId Integer
    The ID of Droplet that the Floating IP will be assigned to.
    ipAddress String
    The Floating IP to assign to the Droplet.
    dropletId number
    The ID of Droplet that the Floating IP will be assigned to.
    ipAddress string
    The Floating IP to assign to the Droplet.
    droplet_id int
    The ID of Droplet that the Floating IP will be assigned to.
    ip_address str
    The Floating IP to assign to the Droplet.
    dropletId Number
    The ID of Droplet that the Floating IP will be assigned to.
    ipAddress String
    The Floating IP to assign to the Droplet.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing FloatingIpAssignment Resource

    Get an existing FloatingIpAssignment 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?: FloatingIpAssignmentState, opts?: CustomResourceOptions): FloatingIpAssignment
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            droplet_id: Optional[int] = None,
            ip_address: Optional[str] = None) -> FloatingIpAssignment
    func GetFloatingIpAssignment(ctx *Context, name string, id IDInput, state *FloatingIpAssignmentState, opts ...ResourceOption) (*FloatingIpAssignment, error)
    public static FloatingIpAssignment Get(string name, Input<string> id, FloatingIpAssignmentState? state, CustomResourceOptions? opts = null)
    public static FloatingIpAssignment get(String name, Output<String> id, FloatingIpAssignmentState 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.
    IpAddress string
    The Floating IP to assign to the Droplet.
    DropletId int
    The ID of Droplet that the Floating IP will be assigned to.
    IpAddress string
    The Floating IP to assign to the Droplet.
    dropletId Integer
    The ID of Droplet that the Floating IP will be assigned to.
    ipAddress String
    The Floating IP to assign to the Droplet.
    dropletId number
    The ID of Droplet that the Floating IP will be assigned to.
    ipAddress string
    The Floating IP to assign to the Droplet.
    droplet_id int
    The ID of Droplet that the Floating IP will be assigned to.
    ip_address str
    The Floating IP to assign to the Droplet.
    dropletId Number
    The ID of Droplet that the Floating IP will be assigned to.
    ipAddress String
    The Floating IP to assign to the Droplet.

    Import

    Floating IP assignments can be imported using the Floating IP itself and the id of

    the Droplet joined with a comma. For example:

    $ pulumi import digitalocean:index/floatingIpAssignment:FloatingIpAssignment foobar 192.0.2.1,123456
    

    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.30.2 published on Wednesday, Jun 5, 2024 by Pulumi