pulumi-digitalocean-kotlin/com.pulumi.digitalocean.kotlin/Project

Project

class Project : KotlinCustomResource

Provides a DigitalOcean Project resource. Projects allow you to organize your resources into groups that fit the way you work. You can group resources (like Droplets, Spaces, Load Balancers, domains, and Floating IPs) in ways that align with the applications you host on DigitalOcean. The following resource types can be associated with a project:

  • App Platform Apps

  • Database Clusters

  • Domains

  • Droplets

  • Floating IPs

  • Kubernetes Clusters

  • Load Balancers

  • Spaces Buckets

  • Volumes Note: A provider managed project cannot be set as a default project.

Example Usage

The following example demonstrates the creation of an empty project:

import * as pulumi from "@pulumi/pulumi";
import * as digitalocean from "@pulumi/digitalocean";
const playground = new digitalocean.Project("playground", {
    name: "playground",
    description: "A project to represent development resources.",
    purpose: "Web Application",
    environment: "Development",
});
Content copied to clipboard
import pulumi
import pulumi_digitalocean as digitalocean
playground = digitalocean.Project("playground",
    name="playground",
    description="A project to represent development resources.",
    purpose="Web Application",
    environment="Development")
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using DigitalOcean = Pulumi.DigitalOcean;
return await Deployment.RunAsync(() =>
{
    var playground = new DigitalOcean.Project("playground", new()
    {
        Name = "playground",
        Description = "A project to represent development resources.",
        Purpose = "Web Application",
        Environment = "Development",
    });
});
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.NewProject(ctx, "playground", &digitalocean.ProjectArgs{
			Name:        pulumi.String("playground"),
			Description: pulumi.String("A project to represent development resources."),
			Purpose:     pulumi.String("Web Application"),
			Environment: pulumi.String("Development"),
		})
		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.Project;
import com.pulumi.digitalocean.ProjectArgs;
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 playground = new Project("playground", ProjectArgs.builder()
            .name("playground")
            .description("A project to represent development resources.")
            .purpose("Web Application")
            .environment("Development")
            .build());
    }
}
Content copied to clipboard
resources:
  playground:
    type: digitalocean:Project
    properties:
      name: playground
      description: A project to represent development resources.
      purpose: Web Application
      environment: Development
Content copied to clipboard

The following example demonstrates the creation of a project with a Droplet resource:

import * as pulumi from "@pulumi/pulumi";
import * as digitalocean from "@pulumi/digitalocean";
const foobar = new digitalocean.Droplet("foobar", {
    name: "example",
    size: digitalocean.DropletSlug.DropletS1VCPU1GB,
    image: "ubuntu-22-04-x64",
    region: digitalocean.Region.NYC3,
});
const playground = new digitalocean.Project("playground", {
    name: "playground",
    description: "A project to represent development resources.",
    purpose: "Web Application",
    environment: "Development",
    resources: [foobar.dropletUrn],
});
Content copied to clipboard
import pulumi
import pulumi_digitalocean as digitalocean
foobar = digitalocean.Droplet("foobar",
    name="example",
    size=digitalocean.DropletSlug.DROPLET_S1_VCPU1_GB,
    image="ubuntu-22-04-x64",
    region=digitalocean.Region.NYC3)
playground = digitalocean.Project("playground",
    name="playground",
    description="A project to represent development resources.",
    purpose="Web Application",
    environment="Development",
    resources=[foobar.droplet_urn])
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using DigitalOcean = Pulumi.DigitalOcean;
return await Deployment.RunAsync(() =>
{
    var foobar = new DigitalOcean.Droplet("foobar", new()
    {
        Name = "example",
        Size = DigitalOcean.DropletSlug.DropletS1VCPU1GB,
        Image = "ubuntu-22-04-x64",
        Region = DigitalOcean.Region.NYC3,
    });
    var playground = new DigitalOcean.Project("playground", new()
    {
        Name = "playground",
        Description = "A project to represent development resources.",
        Purpose = "Web Application",
        Environment = "Development",
        Resources = new[]
        {
            foobar.DropletUrn,
        },
    });
});
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 {
		foobar, err := digitalocean.NewDroplet(ctx, "foobar", &digitalocean.DropletArgs{
			Name:   pulumi.String("example"),
			Size:   pulumi.String(digitalocean.DropletSlugDropletS1VCPU1GB),
			Image:  pulumi.String("ubuntu-22-04-x64"),
			Region: pulumi.String(digitalocean.RegionNYC3),
		})
		if err != nil {
			return err
		}
		_, err = digitalocean.NewProject(ctx, "playground", &digitalocean.ProjectArgs{
			Name:        pulumi.String("playground"),
			Description: pulumi.String("A project to represent development resources."),
			Purpose:     pulumi.String("Web Application"),
			Environment: pulumi.String("Development"),
			Resources: pulumi.StringArray{
				foobar.DropletUrn,
			},
		})
		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.Droplet;
import com.pulumi.digitalocean.DropletArgs;
import com.pulumi.digitalocean.Project;
import com.pulumi.digitalocean.ProjectArgs;
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 Droplet("foobar", DropletArgs.builder()
            .name("example")
            .size("s-1vcpu-1gb")
            .image("ubuntu-22-04-x64")
            .region("nyc3")
            .build());
        var playground = new Project("playground", ProjectArgs.builder()
            .name("playground")
            .description("A project to represent development resources.")
            .purpose("Web Application")
            .environment("Development")
            .resources(foobar.dropletUrn())
            .build());
    }
}
Content copied to clipboard
resources:
  foobar:
    type: digitalocean:Droplet
    properties:
      name: example
      size: s-1vcpu-1gb
      image: ubuntu-22-04-x64
      region: nyc3
  playground:
    type: digitalocean:Project
    properties:
      name: playground
      description: A project to represent development resources.
      purpose: Web Application
      environment: Development
      resources:
        - ${foobar.dropletUrn}
Content copied to clipboard

Import

Projects can be imported using the id returned from DigitalOcean, e.g.

$ pulumi import digitalocean:index/project:Project myproject 245bcfd0-7f31-4ce6-a2bc-475a116cca97
Content copied to clipboard

Properties

Link copied to clipboard
val createdAt: Output<String>

the date and time when the project was created, (ISO8601)

Link copied to clipboard
val description: Output<String>?

the description of the project

Link copied to clipboard
val environment: Output<String>?

the environment of the project's resources. The possible values are: Development, Staging, Production)

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val isDefault: Output<Boolean>?

a boolean indicating whether or not the project is the default project. (Default: "false")

Link copied to clipboard
val name: Output<String>

The name of the Project

Link copied to clipboard
val ownerId: Output<Int>

the id of the project owner.

Link copied to clipboard
val ownerUuid: Output<String>

the unique universal identifier of the project owner.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val purpose: Output<String>?

the purpose of the project, (Default: "Web Application")

Link copied to clipboard
val resources: Output<List<String>>

a list of uniform resource names (URNs) for the resources associated with the project

Link copied to clipboard
val updatedAt: Output<String>

the date and time when the project was last updated, (ISO8601)

Link copied to clipboard
val urn: Output<String>