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

getVpc

suspend fun getVpc(argument: GetVpcPlainArgs): GetVpcResult

Retrieve information about a VPC for use in other resources. This data source provides all of the VPC's properties as configured on your DigitalOcean account. This is useful if the VPC in question is not managed by the provider or you need to utilize any of the VPC's data. VPCs may be looked up by id or name. Specifying a region will return that that region's default VPC.

Example Usage

VPC By Name

import * as pulumi from "@pulumi/pulumi";
import * as digitalocean from "@pulumi/digitalocean";
const example = digitalocean.getVpc({
    name: "example-network",
});
Content copied to clipboard
import pulumi
import pulumi_digitalocean as digitalocean
example = digitalocean.get_vpc(name="example-network")
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using DigitalOcean = Pulumi.DigitalOcean;
return await Deployment.RunAsync(() =>
{
    var example = DigitalOcean.GetVpc.Invoke(new()
    {
        Name = "example-network",
    });
});
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.LookupVpc(ctx, &digitalocean.LookupVpcArgs{
			Name: pulumi.StringRef("example-network"),
		}, 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.GetVpcArgs;
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.getVpc(GetVpcArgs.builder()
            .name("example-network")
            .build());
    }
}
Content copied to clipboard
variables:
  example:
    fn::invoke:
      function: digitalocean:getVpc
      arguments:
        name: example-network
Content copied to clipboard

Reuse the data about a VPC to assign a Droplet to it:

import * as pulumi from "@pulumi/pulumi";
import * as digitalocean from "@pulumi/digitalocean";
const example = digitalocean.getVpc({
    name: "example-network",
});
const exampleDroplet = new digitalocean.Droplet("example", {
    name: "example-01",
    size: digitalocean.DropletSlug.DropletS1VCPU1GB,
    image: "ubuntu-18-04-x64",
    region: digitalocean.Region.NYC3,
    vpcUuid: example.then(example => example.id),
});
Content copied to clipboard
import pulumi
import pulumi_digitalocean as digitalocean
example = digitalocean.get_vpc(name="example-network")
example_droplet = digitalocean.Droplet("example",
    name="example-01",
    size=digitalocean.DropletSlug.DROPLET_S1_VCPU1_GB,
    image="ubuntu-18-04-x64",
    region=digitalocean.Region.NYC3,
    vpc_uuid=example.id)
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using DigitalOcean = Pulumi.DigitalOcean;
return await Deployment.RunAsync(() =>
{
    var example = DigitalOcean.GetVpc.Invoke(new()
    {
        Name = "example-network",
    });
    var exampleDroplet = new DigitalOcean.Droplet("example", new()
    {
        Name = "example-01",
        Size = DigitalOcean.DropletSlug.DropletS1VCPU1GB,
        Image = "ubuntu-18-04-x64",
        Region = DigitalOcean.Region.NYC3,
        VpcUuid = example.Apply(getVpcResult => getVpcResult.Id),
    });
});
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.LookupVpc(ctx, &digitalocean.LookupVpcArgs{
			Name: pulumi.StringRef("example-network"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = digitalocean.NewDroplet(ctx, "example", &digitalocean.DropletArgs{
			Name:    pulumi.String("example-01"),
			Size:    pulumi.String(digitalocean.DropletSlugDropletS1VCPU1GB),
			Image:   pulumi.String("ubuntu-18-04-x64"),
			Region:  pulumi.String(digitalocean.RegionNYC3),
			VpcUuid: pulumi.String(example.Id),
		})
		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.GetVpcArgs;
import com.pulumi.digitalocean.Droplet;
import com.pulumi.digitalocean.DropletArgs;
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.getVpc(GetVpcArgs.builder()
            .name("example-network")
            .build());
        var exampleDroplet = new Droplet("exampleDroplet", DropletArgs.builder()
            .name("example-01")
            .size("s-1vcpu-1gb")
            .image("ubuntu-18-04-x64")
            .region("nyc3")
            .vpcUuid(example.id())
            .build());
    }
}
Content copied to clipboard
resources:
  exampleDroplet:
    type: digitalocean:Droplet
    name: example
    properties:
      name: example-01
      size: s-1vcpu-1gb
      image: ubuntu-18-04-x64
      region: nyc3
      vpcUuid: ${example.id}
variables:
  example:
    fn::invoke:
      function: digitalocean:getVpc
      arguments:
        name: example-network
Content copied to clipboard

Return

A collection of values returned by getVpc.

Parameters

argument

A collection of arguments for invoking getVpc.

suspend fun getVpc(id: String? = null, name: String? = null, region: String? = null): GetVpcResult

Return

A collection of values returned by getVpc.

Parameters

id

The unique identifier of an existing VPC.

name

The name of an existing VPC.

region

The DigitalOcean region slug for the VPC's location.

See also

.

suspend fun getVpc(argument: suspend GetVpcPlainArgsBuilder.() -> Unit): GetVpcResult

Return

A collection of values returned by getVpc.

Parameters

argument

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

See also

.