@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
222 lines (221 loc) • 7.26 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Provides connectivity for VMware Engine private clouds.
*
* To get more information about Network, see:
*
* * [API documentation](https://cloud.google.com/vmware-engine/docs/reference/rest/v1/projects.locations.vmwareEngineNetworks)
*
* ## Example Usage
*
* ### Vmware Engine Network Standard
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const vmw_engine_network = new gcp.vmwareengine.Network("vmw-engine-network", {
* name: "standard-nw",
* location: "global",
* type: "STANDARD",
* description: "VMwareEngine standard network sample",
* });
* ```
* ### Vmware Engine Network Legacy
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* import * as time from "@pulumi/time";
*
* // there can be only 1 Legacy network per region for a given project,
* // so creating new project for isolation in CI.
* const acceptanceProject = new gcp.organizations.Project("acceptance", {
* name: "vmw-proj",
* projectId: "vmw-proj",
* orgId: "123456789",
* billingAccount: "000000-0000000-0000000-000000",
* deletionPolicy: "DELETE",
* });
* const wait60Seconds = new time.index.Sleep("wait_60_seconds", {createDuration: "60s"}, {
* dependsOn: [acceptanceProject],
* });
* const acceptance = new gcp.projects.Service("acceptance", {
* project: acceptanceProject.projectId,
* service: "vmwareengine.googleapis.com",
* }, {
* dependsOn: [wait60Seconds],
* });
* const vmw_engine_network = new gcp.vmwareengine.Network("vmw-engine-network", {
* project: acceptance.project,
* name: "us-west1-default",
* location: "us-west1",
* type: "LEGACY",
* description: "VMwareEngine legacy network sample",
* });
* ```
*
* ## Import
*
* Network can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/vmwareEngineNetworks/{{name}}`
*
* * `{{project}}/{{location}}/{{name}}`
*
* * `{{location}}/{{name}}`
*
* When using the `pulumi import` command, Network can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:vmwareengine/network:Network default projects/{{project}}/locations/{{location}}/vmwareEngineNetworks/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:vmwareengine/network:Network default {{project}}/{{location}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:vmwareengine/network:Network default {{location}}/{{name}}
* ```
*/
export declare class Network extends pulumi.CustomResource {
/**
* Get an existing Network 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?: NetworkState, opts?: pulumi.CustomResourceOptions): Network;
/**
* Returns true if the given object is an instance of Network. 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 Network;
/**
* User-provided description for this VMware Engine network.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The location where the VMwareEngineNetwork should reside.
*/
readonly location: pulumi.Output<string>;
/**
* The ID of the VMwareEngineNetwork.
*
*
* - - -
*/
readonly name: pulumi.Output<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
readonly project: pulumi.Output<string>;
/**
* State of the VMware Engine network.
*/
readonly state: pulumi.Output<string>;
/**
* VMware Engine network type.
* Possible values are: `LEGACY`, `STANDARD`.
*/
readonly type: pulumi.Output<string>;
/**
* System-generated unique identifier for the resource.
*/
readonly uid: pulumi.Output<string>;
/**
* VMware Engine service VPC networks that provide connectivity from a private cloud to customer projects,
* the internet, and other Google Cloud services.
* Structure is documented below.
*/
readonly vpcNetworks: pulumi.Output<outputs.vmwareengine.NetworkVpcNetwork[]>;
/**
* Create a Network 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: NetworkArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Network resources.
*/
export interface NetworkState {
/**
* User-provided description for this VMware Engine network.
*/
description?: pulumi.Input<string>;
/**
* The location where the VMwareEngineNetwork should reside.
*/
location?: pulumi.Input<string>;
/**
* The ID of the VMwareEngineNetwork.
*
*
* - - -
*/
name?: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* State of the VMware Engine network.
*/
state?: pulumi.Input<string>;
/**
* VMware Engine network type.
* Possible values are: `LEGACY`, `STANDARD`.
*/
type?: pulumi.Input<string>;
/**
* System-generated unique identifier for the resource.
*/
uid?: pulumi.Input<string>;
/**
* VMware Engine service VPC networks that provide connectivity from a private cloud to customer projects,
* the internet, and other Google Cloud services.
* Structure is documented below.
*/
vpcNetworks?: pulumi.Input<pulumi.Input<inputs.vmwareengine.NetworkVpcNetwork>[]>;
}
/**
* The set of arguments for constructing a Network resource.
*/
export interface NetworkArgs {
/**
* User-provided description for this VMware Engine network.
*/
description?: pulumi.Input<string>;
/**
* The location where the VMwareEngineNetwork should reside.
*/
location: pulumi.Input<string>;
/**
* The ID of the VMwareEngineNetwork.
*
*
* - - -
*/
name?: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* VMware Engine network type.
* Possible values are: `LEGACY`, `STANDARD`.
*/
type: pulumi.Input<string>;
}