getProject

Get information on a single DigitalOcean project. If neither the id nor name attributes are provided, then this data source returns the default project.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as digitalocean from "@pulumi/digitalocean";
const _default = digitalocean.getProject({});
const staging = digitalocean.getProject({
name: "My Staging Project",
});
import pulumi
import pulumi_digitalocean as digitalocean
default = digitalocean.get_project()
staging = digitalocean.get_project(name="My Staging Project")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using DigitalOcean = Pulumi.DigitalOcean;
return await Deployment.RunAsync(() =>
{
var @default = DigitalOcean.GetProject.Invoke();
var staging = DigitalOcean.GetProject.Invoke(new()
{
Name = "My Staging Project",
});
});
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.LookupProject(ctx, &digitalocean.LookupProjectArgs{}, nil)
if err != nil {
return err
}
_, err = digitalocean.LookupProject(ctx, &digitalocean.LookupProjectArgs{
Name: pulumi.StringRef("My Staging Project"),
}, nil)
if err != nil {
return err
}
return nil
})
}
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.GetProjectArgs;
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 default = DigitaloceanFunctions.getProject(GetProjectArgs.builder()
.build());
final var staging = DigitaloceanFunctions.getProject(GetProjectArgs.builder()
.name("My Staging Project")
.build());
}
}
variables:
default:
fn::invoke:
function: digitalocean:getProject
arguments: {}
staging:
fn::invoke:
function: digitalocean:getProject
arguments:
name: My Staging Project

Return

A collection of values returned by getProject.

Parameters

argument

A collection of arguments for invoking getProject.


suspend fun getProject(id: String? = null, name: String? = null): GetProjectResult

Return

A collection of values returned by getProject.

Parameters

id

the ID of the project to retrieve

name

the name of the project to retrieve. The data source will raise an error if more than one project has the provided name or if no project has that name.

See also


suspend fun getProject(argument: suspend GetProjectPlainArgsBuilder.() -> Unit): GetProjectResult

Return

A collection of values returned by getProject.

Parameters

argument

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

See also