@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
90 lines (89 loc) • 3.62 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Enables the Google Compute Engine
* [Shared VPC](https://cloud.google.com/compute/docs/shared-vpc)
* feature for a project, assigning it as a Shared VPC host project.
*
* For more information, see,
* [the Project API documentation](https://cloud.google.com/compute/docs/reference/latest/projects),
* where the Shared VPC feature is referred to by its former name "XPN".
*
* ## Example Usage
*
* ```typescript
* 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
*
* 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:
*
* ```sh
* $ pulumi import gcp:compute/sharedVPCHostProject:SharedVPCHostProject default {{project_id}}
* ```
*/
export declare class SharedVPCHostProject extends pulumi.CustomResource {
/**
* Get an existing SharedVPCHostProject resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SharedVPCHostProjectState, opts?: pulumi.CustomResourceOptions): SharedVPCHostProject;
/**
* Returns true if the given object is an instance of SharedVPCHostProject. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is SharedVPCHostProject;
/**
* The ID of the project that will serve as a Shared VPC host project
*/
readonly project: pulumi.Output<string>;
/**
* Create a SharedVPCHostProject resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: SharedVPCHostProjectArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering SharedVPCHostProject resources.
*/
export interface SharedVPCHostProjectState {
/**
* The ID of the project that will serve as a Shared VPC host project
*/
project?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a SharedVPCHostProject resource.
*/
export interface SharedVPCHostProjectArgs {
/**
* The ID of the project that will serve as a Shared VPC host project
*/
project: pulumi.Input<string>;
}