pulumi-digitalocean-kotlin/com.pulumi.digitalocean.kotlin/DigitaloceanFunctions/getDroplet

getDroplet

suspend fun getDroplet(argument: GetDropletPlainArgs): GetDropletResult

Get information on a Droplet for use in other resources. This data source provides all of the Droplet's properties as configured on your DigitalOcean account. This is useful if the Droplet in question is not managed by this provider or you need to utilize any of the Droplet's data. Note: This data source returns a single Droplet. When specifying a tag, an error is triggered if more than one Droplet is found.

Example Usage

Get the Droplet by name:

import * as pulumi from "@pulumi/pulumi";
import * as digitalocean from "@pulumi/digitalocean";
const example = digitalocean.getDroplet({
    name: "web",
});
export const dropletOutput = example.then(example => example.ipv4Address);
Content copied to clipboard
import pulumi
import pulumi_digitalocean as digitalocean
example = digitalocean.get_droplet(name="web")
pulumi.export("dropletOutput", example.ipv4_address)
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using DigitalOcean = Pulumi.DigitalOcean;
return await Deployment.RunAsync(() =>
{
    var example = DigitalOcean.GetDroplet.Invoke(new()
    {
        Name = "web",
    });
    return new Dictionary<string, object?>
    {
        ["dropletOutput"] = example.Apply(getDropletResult => getDropletResult.Ipv4Address),
    };
});
Content copied to clipboard
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 {
		example, err := digitalocean.LookupDroplet(ctx, &digitalocean.LookupDropletArgs{
			Name: pulumi.StringRef("web"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("dropletOutput", example.Ipv4Address)
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.digitalocean.DigitaloceanFunctions;
import com.pulumi.digitalocean.inputs.GetDropletArgs;
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) {
        final var example = DigitaloceanFunctions.getDroplet(GetDropletArgs.builder()
            .name("web")
            .build());
        ctx.export("dropletOutput", example.ipv4Address());
    }
}
Content copied to clipboard
variables:
  example:
    fn::invoke:
      function: digitalocean:getDroplet
      arguments:
        name: web
outputs:
  dropletOutput: ${example.ipv4Address}
Content copied to clipboard

Get the Droplet by tag:

import * as pulumi from "@pulumi/pulumi";
import * as digitalocean from "@pulumi/digitalocean";
const example = digitalocean.getDroplet({
    tag: "web",
});
Content copied to clipboard
import pulumi
import pulumi_digitalocean as digitalocean
example = digitalocean.get_droplet(tag="web")
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using DigitalOcean = Pulumi.DigitalOcean;
return await Deployment.RunAsync(() =>
{
    var example = DigitalOcean.GetDroplet.Invoke(new()
    {
        Tag = "web",
    });
});
Content copied to clipboard
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 {
		_, err := digitalocean.LookupDroplet(ctx, &digitalocean.LookupDropletArgs{
			Tag: pulumi.StringRef("web"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.digitalocean.DigitaloceanFunctions;
import com.pulumi.digitalocean.inputs.GetDropletArgs;
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) {
        final var example = DigitaloceanFunctions.getDroplet(GetDropletArgs.builder()
            .tag("web")
            .build());
    }
}
Content copied to clipboard
variables:
  example:
    fn::invoke:
      function: digitalocean:getDroplet
      arguments:
        tag: web
Content copied to clipboard

Get the Droplet by ID:

import * as pulumi from "@pulumi/pulumi";
import * as digitalocean from "@pulumi/digitalocean";
const example = digitalocean.getDroplet({
    id: exampleDigitaloceanKubernetesCluster.nodePool[0]&#46;nodes[0].dropletId,
});
Content copied to clipboard
import pulumi
import pulumi_digitalocean as digitalocean
example = digitalocean.get_droplet(id=example_digitalocean_kubernetes_cluster["nodePool"][0]["nodes"][0]["dropletId"])
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using DigitalOcean = Pulumi.DigitalOcean;
return await Deployment.RunAsync(() =>
{
    var example = DigitalOcean.GetDroplet.Invoke(new()
    {
        Id = exampleDigitaloceanKubernetesCluster.NodePool[0]&#46;Nodes[0].DropletId,
    });
});
Content copied to clipboard
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 {
		_, err := digitalocean.LookupDroplet(ctx, &digitalocean.LookupDropletArgs{
			Id: pulumi.IntRef(exampleDigitaloceanKubernetesCluster.NodePool[0]&#46;Nodes[0].DropletId),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.digitalocean.DigitaloceanFunctions;
import com.pulumi.digitalocean.inputs.GetDropletArgs;
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) {
        final var example = DigitaloceanFunctions.getDroplet(GetDropletArgs.builder()
            .id(exampleDigitaloceanKubernetesCluster.nodePool()[0]&#46;nodes()[0].dropletId())
            .build());
    }
}
Content copied to clipboard
variables:
  example:
    fn::invoke:
      function: digitalocean:getDroplet
      arguments:
        id: ${exampleDigitaloceanKubernetesCluster.nodePool[0]&#46;nodes[0].dropletId}
Content copied to clipboard

Return

A collection of values returned by getDroplet.

Parameters

argument

A collection of arguments for invoking getDroplet.

suspend fun getDroplet(gpu: Boolean? = null, id: Int? = null, name: String? = null, tag: String? = null): GetDropletResult

Return

A collection of values returned by getDroplet.

Parameters

gpu

A boolean value specifying whether or not to search GPU Droplets

id

The ID of the Droplet

name

The name of the Droplet.

tag

A tag applied to the Droplet. To include GPU Droplets when searching by name, use:

See also

.

suspend fun getDroplet(argument: suspend GetDropletPlainArgsBuilder.() -> Unit): GetDropletResult

Return

A collection of values returned by getDroplet.

Parameters

argument

Builder for com.pulumi.digitalocean.kotlin.inputs.GetDropletPlainArgs.

See also

.