DigitalOcean

Pulumi Official

Package maintained by Pulumi

v4.12.0 published on Wednesday, Apr 6, 2022 by Pulumi

getFloatingIp

Get information on a floating ip. This data source provides the region and Droplet id as configured on your DigitalOcean account. This is useful if the floating IP in question is not managed by the provider or you need to find the Droplet the IP is attached to.

An error is triggered if the provided floating IP does not exist.

Example Usage

using Pulumi;
using DigitalOcean = Pulumi.DigitalOcean;

class MyStack : Stack
{
    public MyStack()
    {
        var config = new Config();
        var publicIp = config.RequireObject<dynamic>("publicIp");
        var example = Output.Create(DigitalOcean.GetFloatingIp.InvokeAsync(new DigitalOcean.GetFloatingIpArgs
        {
            IpAddress = publicIp,
        }));
        this.FipOutput = example.Apply(example => example.DropletId);
    }

    [Output("fipOutput")]
    public Output<string> FipOutput { get; set; }
}

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		publicIp := cfg.RequireObject("publicIp")
		example, err := digitalocean.LookupFloatingIp(ctx, &GetFloatingIpArgs{
			IpAddress: publicIp,
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("fipOutput", example.DropletId)
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_digitalocean as digitalocean

config = pulumi.Config()
public_ip = config.require_object("publicIp")
example = digitalocean.get_floating_ip(ip_address=public_ip)
pulumi.export("fipOutput", example.droplet_id)

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

const config = new pulumi.Config();
const publicIp = config.requireObject("publicIp");
const example = digitalocean.getFloatingIp({
    ipAddress: publicIp,
});
export const fipOutput = example.then(example => example.dropletId);

Coming soon!

Using getFloatingIp

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getFloatingIp(args: GetFloatingIpArgs, opts?: InvokeOptions): Promise<GetFloatingIpResult>
function getFloatingIpOutput(args: GetFloatingIpOutputArgs, opts?: InvokeOptions): Output<GetFloatingIpResult>

def get_floating_ip(ip_address: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetFloatingIpResult
def get_floating_ip_output(ip_address: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetFloatingIpResult]

func LookupFloatingIp(ctx *Context, args *LookupFloatingIpArgs, opts ...InvokeOption) (*LookupFloatingIpResult, error)
func LookupFloatingIpOutput(ctx *Context, args *LookupFloatingIpOutputArgs, opts ...InvokeOption) LookupFloatingIpResultOutput

> Note: This function is named LookupFloatingIp in the Go SDK.

public static class GetFloatingIp 
{
    public static Task<GetFloatingIpResult> InvokeAsync(GetFloatingIpArgs args, InvokeOptions? opts = null)
    public static Output<GetFloatingIpResult> Invoke(GetFloatingIpInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetFloatingIpResult> getFloatingIp(GetFloatingIpArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

Fn::Invoke:
  Function: digitalocean:index/getFloatingIp:getFloatingIp
  Arguments:
    # Arguments dictionary

The following arguments are supported:

IpAddress string: The allocated IP address of the specific floating IP to retrieve.

IpAddress string: The allocated IP address of the specific floating IP to retrieve.

ipAddress String: The allocated IP address of the specific floating IP to retrieve.

ipAddress string: The allocated IP address of the specific floating IP to retrieve.

ip_address str: The allocated IP address of the specific floating IP to retrieve.

ipAddress String: The allocated IP address of the specific floating IP to retrieve.

getFloatingIp Result

The following output properties are available:

DropletId int
FloatingIpUrn string
Id string: The provider-assigned unique ID for this managed resource.
IpAddress string
Region string

DropletId int
FloatingIpUrn string
Id string: The provider-assigned unique ID for this managed resource.
IpAddress string
Region string

dropletId Integer
floatingIpUrn String
id String: The provider-assigned unique ID for this managed resource.
ipAddress String
region String

dropletId number
floatingIpUrn string
id string: The provider-assigned unique ID for this managed resource.
ipAddress string
region string

droplet_id int
floating_ip_urn str
id str: The provider-assigned unique ID for this managed resource.
ip_address str
region str

dropletId Number
floatingIpUrn String
id String: The provider-assigned unique ID for this managed resource.
ipAddress String
region String

Package Details

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