SharedVPCHostProject class

Enables the Google Compute Engine Shared VPC feature for a project, assigning it as a Shared VPC host project.

For more information, see, the Project API documentation, where the Shared VPC feature is referred to by its former name "XPN".

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

// A host project provides network resources to associated service projects.
const host = new gcp.compute.SharedVPCHostProject("host", {project: "host-project-id"});
// A service project gains access to network resources provided by its
// associated host project.
const service1 = new gcp.compute.SharedVPCServiceProject("service1", {
    hostProject: host.project,
    serviceProject: "service-project-id-1",
});
const service2 = new gcp.compute.SharedVPCServiceProject("service2", {
    hostProject: host.project,
    serviceProject: "service-project-id-2",
});

import pulumi
import pulumi_gcp as gcp

# A host project provides network resources to associated service projects.
host = gcp.compute.SharedVPCHostProject("host", project="host-project-id")
# A service project gains access to network resources provided by its
# associated host project.
service1 = gcp.compute.SharedVPCServiceProject("service1",
    host_project=host.project,
    service_project="service-project-id-1")
service2 = gcp.compute.SharedVPCServiceProject("service2",
    host_project=host.project,
    service_project="service-project-id-2")

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    // A host project provides network resources to associated service projects.
    var host = new Gcp.Compute.SharedVPCHostProject("host", new()
    {
        Project = "host-project-id",
    });

    // A service project gains access to network resources provided by its
    // associated host project.
    var service1 = new Gcp.Compute.SharedVPCServiceProject("service1", new()
    {
        HostProject = host.Project,
        ServiceProject = "service-project-id-1",
    });

    var service2 = new Gcp.Compute.SharedVPCServiceProject("service2", new()
    {
        HostProject = host.Project,
        ServiceProject = "service-project-id-2",
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// A host project provides network resources to associated service projects.
		host, err := compute.NewSharedVPCHostProject(ctx, "host", &compute.SharedVPCHostProjectArgs{
			Project: pulumi.String("host-project-id"),
		})
		if err != nil {
			return err
		}
		// A service project gains access to network resources provided by its
		// associated host project.
		_, err = compute.NewSharedVPCServiceProject(ctx, "service1", &compute.SharedVPCServiceProjectArgs{
			HostProject:    host.Project,
			ServiceProject: pulumi.String("service-project-id-1"),
		})
		if err != nil {
			return err
		}
		_, err = compute.NewSharedVPCServiceProject(ctx, "service2", &compute.SharedVPCServiceProjectArgs{
			HostProject:    host.Project,
			ServiceProject: pulumi.String("service-project-id-2"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

# A host project provides network resources to associated service projects.
resource "gcp_compute_sharedvpchostproject" "host" {
  project = "host-project-id"
}
# A service project gains access to network resources provided by its
# associated host project.
resource "gcp_compute_sharedvpcserviceproject" "service1" {
  host_project    = gcp_compute_sharedvpchostproject.host.project
  service_project = "service-project-id-1"
}
resource "gcp_compute_sharedvpcserviceproject" "service2" {
  host_project    = gcp_compute_sharedvpchostproject.host.project
  service_project = "service-project-id-2"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.SharedVPCHostProject;
import com.pulumi.gcp.compute.SharedVPCHostProjectArgs;
import com.pulumi.gcp.compute.SharedVPCServiceProject;
import com.pulumi.gcp.compute.SharedVPCServiceProjectArgs;
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) {
        // A host project provides network resources to associated service projects.
        var host = new SharedVPCHostProject("host", SharedVPCHostProjectArgs.builder()
            .project("host-project-id")
            .build());

        // A service project gains access to network resources provided by its
        // associated host project.
        var service1 = new SharedVPCServiceProject("service1", SharedVPCServiceProjectArgs.builder()
            .hostProject(host.project())
            .serviceProject("service-project-id-1")
            .build());

        var service2 = new SharedVPCServiceProject("service2", SharedVPCServiceProjectArgs.builder()
            .hostProject(host.project())
            .serviceProject("service-project-id-2")
            .build());

    }
}

resources:
  # A host project provides network resources to associated service projects.
  host:
    type: gcp:compute:SharedVPCHostProject
    properties:
      project: host-project-id
  # A service project gains access to network resources provided by its
  # associated host project.
  service1:
    type: gcp:compute:SharedVPCServiceProject
    properties:
      hostProject: ${host.project}
      serviceProject: service-project-id-1
  service2:
    type: gcp:compute:SharedVPCServiceProject
    properties:
      hostProject: ${host.project}
      serviceProject: service-project-id-2

Import

Google Compute Engine Shared VPC host project feature can be imported using project, e.g.

• {{project_id}}

When using the pulumi import command, Google Compute Engine Shared VPC host projects can be imported using one of the formats above. For example:

$ pulumi import gcp:compute/sharedVPCHostProject:SharedVPCHostProject default {{project_id}}

Constructors

SharedVPCHostProject(String name, {SharedVPCHostProjectArgs? args, CustomResourceOptions? options})

Creates a new SharedVPCHostProject. name The Pulumi resource name. args Arguments used to configure this SharedVPCHostProject. The set of arguments for SharedVPCHostProject. options Resource options controlling this resource's behavior.

SharedVPCHostProject.reference(String urn)

Creates a typed reference to an existing SharedVPCHostProject resource.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE". When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

project ↔ Output<String>

The ID of the project that will serve as a Shared VPC host project

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {SharedVPCHostProjectState? state, CustomResourceOptions? options}) → SharedVPCHostProject

Gets an existing SharedVPCHostProject resource's state with the given name and id.