@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
110 lines (109 loc) • 4.58 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 service project associated
* with a given 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";
*
* const service1 = new gcp.compute.SharedVPCServiceProject("service1", {
* hostProject: "host-project-id",
* serviceProject: "service-project-id-1",
* });
* ```
*
* For a complete Shared VPC example with both host and service projects, see
* [`gcp.compute.SharedVPCHostProject`](https://www.terraform.io/docs/providers/google/r/compute_shared_vpc_host_project.html).
*
* ## Import
*
* Google Compute Engine Shared VPC service project feature can be imported using the `host_project` and `service_project`, e.g.
*
* * `{{host_project}/{{service_project}}`
*
* When using the `pulumi import` command, Google Compute Engine Shared VPC service project can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:compute/sharedVPCServiceProject:SharedVPCServiceProject default {{host_project}/{{service_project}}
* ```
*/
export declare class SharedVPCServiceProject extends pulumi.CustomResource {
/**
* Get an existing SharedVPCServiceProject 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?: SharedVPCServiceProjectState, opts?: pulumi.CustomResourceOptions): SharedVPCServiceProject;
/**
* Returns true if the given object is an instance of SharedVPCServiceProject. 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 SharedVPCServiceProject;
/**
* The deletion policy for the shared VPC service. Setting ABANDON allows the resource to be abandoned rather than deleted. Possible values are: "ABANDON".
*/
readonly deletionPolicy: pulumi.Output<string | undefined>;
/**
* The ID of a host project to associate.
*/
readonly hostProject: pulumi.Output<string>;
/**
* The ID of the project that will serve as a Shared VPC service project.
*/
readonly serviceProject: pulumi.Output<string>;
/**
* Create a SharedVPCServiceProject 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: SharedVPCServiceProjectArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering SharedVPCServiceProject resources.
*/
export interface SharedVPCServiceProjectState {
/**
* The deletion policy for the shared VPC service. Setting ABANDON allows the resource to be abandoned rather than deleted. Possible values are: "ABANDON".
*/
deletionPolicy?: pulumi.Input<string>;
/**
* The ID of a host project to associate.
*/
hostProject?: pulumi.Input<string>;
/**
* The ID of the project that will serve as a Shared VPC service project.
*/
serviceProject?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a SharedVPCServiceProject resource.
*/
export interface SharedVPCServiceProjectArgs {
/**
* The deletion policy for the shared VPC service. Setting ABANDON allows the resource to be abandoned rather than deleted. Possible values are: "ABANDON".
*/
deletionPolicy?: pulumi.Input<string>;
/**
* The ID of a host project to associate.
*/
hostProject: pulumi.Input<string>;
/**
* The ID of the project that will serve as a Shared VPC service project.
*/
serviceProject: pulumi.Input<string>;
}