Viewing docs for DigitalOcean v4.77.0
published on Friday, Jul 31, 2026 by Pulumi
published on Friday, Jul 31, 2026 by Pulumi
Viewing docs for DigitalOcean v4.77.0
published on Friday, Jul 31, 2026 by Pulumi
published on Friday, Jul 31, 2026 by Pulumi
Fetches a single DigitalOcean MicroDroplet by id or by name.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as digitalocean from "@pulumi/digitalocean";
const byid = digitalocean.getMicrodroplet({
id: "506f78a4-e098-11e5-ad9f-000f53306ae1",
});
const byname = digitalocean.getMicrodroplet({
name: "my-microdroplet",
});
import pulumi
import pulumi_digitalocean as digitalocean
byid = digitalocean.get_microdroplet(id="506f78a4-e098-11e5-ad9f-000f53306ae1")
byname = digitalocean.get_microdroplet(name="my-microdroplet")
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.GetMicrodroplet(ctx, &digitalocean.LookupMicrodropletArgs{
Id: pulumi.StringRef("506f78a4-e098-11e5-ad9f-000f53306ae1"),
}, nil)
if err != nil {
return err
}
_, err = digitalocean.GetMicrodroplet(ctx, &digitalocean.LookupMicrodropletArgs{
Name: pulumi.StringRef("my-microdroplet"),
}, nil)
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 byid = DigitalOcean.GetMicrodroplet.Invoke(new()
{
Id = "506f78a4-e098-11e5-ad9f-000f53306ae1",
});
var byname = DigitalOcean.GetMicrodroplet.Invoke(new()
{
Name = "my-microdroplet",
});
});
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.GetMicrodropletArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 byid = DigitaloceanFunctions.getMicrodroplet(GetMicrodropletArgs.builder()
.id("506f78a4-e098-11e5-ad9f-000f53306ae1")
.build());
final var byname = DigitaloceanFunctions.getMicrodroplet(GetMicrodropletArgs.builder()
.name("my-microdroplet")
.build());
}
}
variables:
byid:
fn::invoke:
function: digitalocean:getMicrodroplet
arguments:
id: 506f78a4-e098-11e5-ad9f-000f53306ae1
byname:
fn::invoke:
function: digitalocean:getMicrodroplet
arguments:
name: my-microdroplet
pulumi {
required_providers {
digitalocean = {
source = "pulumi/digitalocean"
}
}
}
data "digitalocean_getmicrodroplet" "byid" {
id = "506f78a4-e098-11e5-ad9f-000f53306ae1"
}
data "digitalocean_getmicrodroplet" "byname" {
name = "my-microdroplet"
}
Using getMicrodroplet
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 getMicrodroplet(args: GetMicrodropletArgs, opts?: InvokeOptions): Promise<GetMicrodropletResult>
function getMicrodropletOutput(args: GetMicrodropletOutputArgs, opts?: InvokeOptions): Output<GetMicrodropletResult>def get_microdroplet(id: Optional[str] = None,
name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetMicrodropletResult
def get_microdroplet_output(id: pulumi.Input[Optional[str]] = None,
name: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetMicrodropletResult]func LookupMicrodroplet(ctx *Context, args *LookupMicrodropletArgs, opts ...InvokeOption) (*LookupMicrodropletResult, error)
func LookupMicrodropletOutput(ctx *Context, args *LookupMicrodropletOutputArgs, opts ...InvokeOption) LookupMicrodropletResultOutput> Note: This function is named LookupMicrodroplet in the Go SDK.
public static class GetMicrodroplet
{
public static Task<GetMicrodropletResult> InvokeAsync(GetMicrodropletArgs args, InvokeOptions? opts = null)
public static Output<GetMicrodropletResult> Invoke(GetMicrodropletInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetMicrodropletResult> getMicrodroplet(GetMicrodropletArgs args, InvokeOptions options)
public static Output<GetMicrodropletResult> getMicrodroplet(GetMicrodropletArgs args, InvokeOptions options)
fn::invoke:
function: digitalocean:index/getMicrodroplet:getMicrodroplet
arguments:
# arguments dictionarydata "digitalocean_get_microdroplet" "name" {
# arguments
}The following arguments are supported:
getMicrodroplet Result
The following output properties are available:
- Auto
Pauses List<Pulumi.Digital Ocean. Outputs. Get Microdroplet Auto Pause> - Auto
Resume bool - Created
At string - Current
State string - Endpoint string
- Environment Dictionary<string, string>
- Http
Port int - Http
Protocol string - Id string
- Image string
- Name string
- Networking string
- Region string
- ,
size,image,networking,vpcUuid,httpPort,httpProtocol,environment,autoPause,autoResume,endpoint,currentState,createdAt,urn. - Size string
- State string
- Urn string
- Vpc
Uuid string
- Auto
Pauses []GetMicrodroplet Auto Pause - Auto
Resume bool - Created
At string - Current
State string - Endpoint string
- Environment map[string]string
- Http
Port int - Http
Protocol string - Id string
- Image string
- Name string
- Networking string
- Region string
- ,
size,image,networking,vpcUuid,httpPort,httpProtocol,environment,autoPause,autoResume,endpoint,currentState,createdAt,urn. - Size string
- State string
- Urn string
- Vpc
Uuid string
- auto_
pauses list(object) - auto_
resume bool - created_
at string - current_
state string - endpoint string
- environment map(string)
- http_
port number - http_
protocol string - id string
- image string
- name string
- networking string
- region string
- ,
size,image,networking,vpcUuid,httpPort,httpProtocol,environment,autoPause,autoResume,endpoint,currentState,createdAt,urn. - size string
- state string
- urn string
- vpc_
uuid string
- auto
Pauses List<GetMicrodroplet Auto Pause> - auto
Resume Boolean - created
At String - current
State String - endpoint String
- environment Map<String,String>
- http
Port Integer - http
Protocol String - id String
- image String
- name String
- networking String
- region String
- ,
size,image,networking,vpcUuid,httpPort,httpProtocol,environment,autoPause,autoResume,endpoint,currentState,createdAt,urn. - size String
- state String
- urn String
- vpc
Uuid String
- auto
Pauses GetMicrodroplet Auto Pause[] - auto
Resume boolean - created
At string - current
State string - endpoint string
- environment {[key: string]: string}
- http
Port number - http
Protocol string - id string
- image string
- name string
- networking string
- region string
- ,
size,image,networking,vpcUuid,httpPort,httpProtocol,environment,autoPause,autoResume,endpoint,currentState,createdAt,urn. - size string
- state string
- urn string
- vpc
Uuid string
- auto_
pauses Sequence[GetMicrodroplet Auto Pause] - auto_
resume bool - created_
at str - current_
state str - endpoint str
- environment Mapping[str, str]
- http_
port int - http_
protocol str - id str
- image str
- name str
- networking str
- region str
- ,
size,image,networking,vpcUuid,httpPort,httpProtocol,environment,autoPause,autoResume,endpoint,currentState,createdAt,urn. - size str
- state str
- urn str
- vpc_
uuid str
- auto
Pauses List<Property Map> - auto
Resume Boolean - created
At String - current
State String - endpoint String
- environment Map<String>
- http
Port Number - http
Protocol String - id String
- image String
- name String
- networking String
- region String
- ,
size,image,networking,vpcUuid,httpPort,httpProtocol,environment,autoPause,autoResume,endpoint,currentState,createdAt,urn. - size String
- state String
- urn String
- vpc
Uuid String
Supporting Types
GetMicrodropletAutoPause
- Enabled bool
- Whether auto-pause is enabled. Forces recreation on change (no in-place API path).
- Idle
Timeout string - Idle timeout as a Go duration string (e.g. '5m', '30s'). Forces recreation on change (no in-place API path).
- Enabled bool
- Whether auto-pause is enabled. Forces recreation on change (no in-place API path).
- Idle
Timeout string - Idle timeout as a Go duration string (e.g. '5m', '30s'). Forces recreation on change (no in-place API path).
- enabled bool
- Whether auto-pause is enabled. Forces recreation on change (no in-place API path).
- idle_
timeout string - Idle timeout as a Go duration string (e.g. '5m', '30s'). Forces recreation on change (no in-place API path).
- enabled Boolean
- Whether auto-pause is enabled. Forces recreation on change (no in-place API path).
- idle
Timeout String - Idle timeout as a Go duration string (e.g. '5m', '30s'). Forces recreation on change (no in-place API path).
- enabled boolean
- Whether auto-pause is enabled. Forces recreation on change (no in-place API path).
- idle
Timeout string - Idle timeout as a Go duration string (e.g. '5m', '30s'). Forces recreation on change (no in-place API path).
- enabled bool
- Whether auto-pause is enabled. Forces recreation on change (no in-place API path).
- idle_
timeout str - Idle timeout as a Go duration string (e.g. '5m', '30s'). Forces recreation on change (no in-place API path).
- enabled Boolean
- Whether auto-pause is enabled. Forces recreation on change (no in-place API path).
- idle
Timeout String - Idle timeout as a Go duration string (e.g. '5m', '30s'). Forces recreation on change (no in-place API path).
Package Details
- Repository
- DigitalOcean pulumi/pulumi-digitalocean
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
digitaloceanTerraform Provider.
Viewing docs for DigitalOcean v4.77.0
published on Friday, Jul 31, 2026 by Pulumi
published on Friday, Jul 31, 2026 by Pulumi