@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
505 lines (504 loc) • 18.7 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* VPN tunnel resource.
*
* To get more information about VpnTunnel, see:
*
* * [API documentation](https://cloud.google.com/compute/docs/reference/rest/v1/vpnTunnels)
* * How-to Guides
* * [Cloud VPN Overview](https://cloud.google.com/vpn/docs/concepts/overview)
* * [Networks and Tunnel Routing](https://cloud.google.com/vpn/docs/concepts/choosing-networks-routing)
*
* ## Example Usage
*
* ### Vpn Tunnel Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const network1 = new gcp.compute.Network("network1", {name: "network-1"});
* const targetGateway = new gcp.compute.VPNGateway("target_gateway", {
* name: "vpn-1",
* network: network1.id,
* });
* const vpnStaticIp = new gcp.compute.Address("vpn_static_ip", {name: "vpn-static-ip"});
* const frEsp = new gcp.compute.ForwardingRule("fr_esp", {
* name: "fr-esp",
* ipProtocol: "ESP",
* ipAddress: vpnStaticIp.address,
* target: targetGateway.id,
* });
* const frUdp500 = new gcp.compute.ForwardingRule("fr_udp500", {
* name: "fr-udp500",
* ipProtocol: "UDP",
* portRange: "500",
* ipAddress: vpnStaticIp.address,
* target: targetGateway.id,
* });
* const frUdp4500 = new gcp.compute.ForwardingRule("fr_udp4500", {
* name: "fr-udp4500",
* ipProtocol: "UDP",
* portRange: "4500",
* ipAddress: vpnStaticIp.address,
* target: targetGateway.id,
* });
* const tunnel1 = new gcp.compute.VPNTunnel("tunnel1", {
* name: "tunnel-1",
* peerIp: "15.0.0.120",
* sharedSecret: "a secret message",
* targetVpnGateway: targetGateway.id,
* labels: {
* foo: "bar",
* },
* }, {
* dependsOn: [
* frEsp,
* frUdp500,
* frUdp4500,
* ],
* });
* const route1 = new gcp.compute.Route("route1", {
* name: "route1",
* network: network1.name,
* destRange: "15.0.0.0/24",
* priority: 1000,
* nextHopVpnTunnel: tunnel1.id,
* });
* ```
*
* ## Import
*
* VpnTunnel can be imported using any of these accepted formats:
*
* * `projects/{{project}}/regions/{{region}}/vpnTunnels/{{name}}`
*
* * `{{project}}/{{region}}/{{name}}`
*
* * `{{region}}/{{name}}`
*
* * `{{name}}`
*
* When using the `pulumi import` command, VpnTunnel can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:compute/vPNTunnel:VPNTunnel default projects/{{project}}/regions/{{region}}/vpnTunnels/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:compute/vPNTunnel:VPNTunnel default {{project}}/{{region}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:compute/vPNTunnel:VPNTunnel default {{region}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:compute/vPNTunnel:VPNTunnel default {{name}}
* ```
*/
export declare class VPNTunnel extends pulumi.CustomResource {
/**
* Get an existing VPNTunnel 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?: VPNTunnelState, opts?: pulumi.CustomResourceOptions): VPNTunnel;
/**
* Returns true if the given object is an instance of VPNTunnel. 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 VPNTunnel;
/**
* Creation timestamp in RFC3339 text format.
*/
readonly creationTimestamp: pulumi.Output<string>;
/**
* An optional description of this resource.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Detailed status message for the VPN tunnel.
*/
readonly detailedStatus: pulumi.Output<string>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
readonly effectiveLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* IKE protocol version to use when establishing the VPN tunnel with
* peer VPN gateway.
* Acceptable IKE versions are 1 or 2. Default version is 2.
*/
readonly ikeVersion: pulumi.Output<number | undefined>;
/**
* The fingerprint used for optimistic locking of this resource. Used
* internally during updates.
*/
readonly labelFingerprint: pulumi.Output<string>;
/**
* Labels to apply to this VpnTunnel.
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
readonly labels: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Local traffic selector to use when establishing the VPN tunnel with
* peer VPN gateway. The value should be a CIDR formatted string,
* for example `192.168.0.0/16`. The ranges should be disjoint.
* Only IPv4 is supported.
*/
readonly localTrafficSelectors: pulumi.Output<string[]>;
/**
* Name of the resource. The name must be 1-63 characters long, and
* comply with RFC1035. Specifically, the name must be 1-63
* characters long and match the regular expression
* `a-z?` which means the first character
* must be a lowercase letter, and all following characters must
* be a dash, lowercase letter, or digit,
* except the last character, which cannot be a dash.
*/
readonly name: pulumi.Output<string>;
/**
* URL of the peer side external VPN gateway to which this VPN tunnel is connected.
*/
readonly peerExternalGateway: pulumi.Output<string | undefined>;
/**
* The interface ID of the external VPN gateway to which this VPN tunnel is connected.
*/
readonly peerExternalGatewayInterface: pulumi.Output<number | undefined>;
/**
* URL of the peer side HA GCP VPN gateway to which this VPN tunnel is connected.
* If provided, the VPN tunnel will automatically use the same vpnGatewayInterface
* ID in the peer GCP VPN gateway.
* This field must reference a `gcp.compute.HaVpnGateway` resource.
*/
readonly peerGcpGateway: pulumi.Output<string | undefined>;
/**
* IP address of the peer VPN gateway. Only IPv4 is supported.
*/
readonly peerIp: 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>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
readonly pulumiLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* The region where the tunnel is located. If unset, is set to the region of `targetVpnGateway`.
*/
readonly region: pulumi.Output<string>;
/**
* Remote traffic selector to use when establishing the VPN tunnel with
* peer VPN gateway. The value should be a CIDR formatted string,
* for example `192.168.0.0/16`. The ranges should be disjoint.
* Only IPv4 is supported.
*/
readonly remoteTrafficSelectors: pulumi.Output<string[]>;
/**
* URL of router resource to be used for dynamic routing.
*/
readonly router: pulumi.Output<string | undefined>;
/**
* The URI of the created resource.
*/
readonly selfLink: pulumi.Output<string>;
/**
* Shared secret used to set the secure session between the Cloud VPN
* gateway and the peer VPN gateway.
* **Note**: This property is sensitive and will not be displayed in the plan.
*
*
* - - -
*/
readonly sharedSecret: pulumi.Output<string>;
/**
* Hash of the shared secret.
*/
readonly sharedSecretHash: pulumi.Output<string>;
/**
* URL of the Target VPN gateway with which this VPN tunnel is
* associated.
*/
readonly targetVpnGateway: pulumi.Output<string | undefined>;
/**
* The unique identifier for the resource. This identifier is defined by the server.
*/
readonly tunnelId: pulumi.Output<string>;
/**
* URL of the VPN gateway with which this VPN tunnel is associated.
* This must be used if a High Availability VPN gateway resource is created.
* This field must reference a `gcp.compute.HaVpnGateway` resource.
*/
readonly vpnGateway: pulumi.Output<string | undefined>;
/**
* The interface ID of the VPN gateway with which this VPN tunnel is associated.
*/
readonly vpnGatewayInterface: pulumi.Output<number | undefined>;
/**
* Create a VPNTunnel 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: VPNTunnelArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering VPNTunnel resources.
*/
export interface VPNTunnelState {
/**
* Creation timestamp in RFC3339 text format.
*/
creationTimestamp?: pulumi.Input<string>;
/**
* An optional description of this resource.
*/
description?: pulumi.Input<string>;
/**
* Detailed status message for the VPN tunnel.
*/
detailedStatus?: pulumi.Input<string>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
effectiveLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* IKE protocol version to use when establishing the VPN tunnel with
* peer VPN gateway.
* Acceptable IKE versions are 1 or 2. Default version is 2.
*/
ikeVersion?: pulumi.Input<number>;
/**
* The fingerprint used for optimistic locking of this resource. Used
* internally during updates.
*/
labelFingerprint?: pulumi.Input<string>;
/**
* Labels to apply to this VpnTunnel.
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Local traffic selector to use when establishing the VPN tunnel with
* peer VPN gateway. The value should be a CIDR formatted string,
* for example `192.168.0.0/16`. The ranges should be disjoint.
* Only IPv4 is supported.
*/
localTrafficSelectors?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Name of the resource. The name must be 1-63 characters long, and
* comply with RFC1035. Specifically, the name must be 1-63
* characters long and match the regular expression
* `a-z?` which means the first character
* must be a lowercase letter, and all following characters must
* be a dash, lowercase letter, or digit,
* except the last character, which cannot be a dash.
*/
name?: pulumi.Input<string>;
/**
* URL of the peer side external VPN gateway to which this VPN tunnel is connected.
*/
peerExternalGateway?: pulumi.Input<string>;
/**
* The interface ID of the external VPN gateway to which this VPN tunnel is connected.
*/
peerExternalGatewayInterface?: pulumi.Input<number>;
/**
* URL of the peer side HA GCP VPN gateway to which this VPN tunnel is connected.
* If provided, the VPN tunnel will automatically use the same vpnGatewayInterface
* ID in the peer GCP VPN gateway.
* This field must reference a `gcp.compute.HaVpnGateway` resource.
*/
peerGcpGateway?: pulumi.Input<string>;
/**
* IP address of the peer VPN gateway. Only IPv4 is supported.
*/
peerIp?: 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>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
pulumiLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The region where the tunnel is located. If unset, is set to the region of `targetVpnGateway`.
*/
region?: pulumi.Input<string>;
/**
* Remote traffic selector to use when establishing the VPN tunnel with
* peer VPN gateway. The value should be a CIDR formatted string,
* for example `192.168.0.0/16`. The ranges should be disjoint.
* Only IPv4 is supported.
*/
remoteTrafficSelectors?: pulumi.Input<pulumi.Input<string>[]>;
/**
* URL of router resource to be used for dynamic routing.
*/
router?: pulumi.Input<string>;
/**
* The URI of the created resource.
*/
selfLink?: pulumi.Input<string>;
/**
* Shared secret used to set the secure session between the Cloud VPN
* gateway and the peer VPN gateway.
* **Note**: This property is sensitive and will not be displayed in the plan.
*
*
* - - -
*/
sharedSecret?: pulumi.Input<string>;
/**
* Hash of the shared secret.
*/
sharedSecretHash?: pulumi.Input<string>;
/**
* URL of the Target VPN gateway with which this VPN tunnel is
* associated.
*/
targetVpnGateway?: pulumi.Input<string>;
/**
* The unique identifier for the resource. This identifier is defined by the server.
*/
tunnelId?: pulumi.Input<string>;
/**
* URL of the VPN gateway with which this VPN tunnel is associated.
* This must be used if a High Availability VPN gateway resource is created.
* This field must reference a `gcp.compute.HaVpnGateway` resource.
*/
vpnGateway?: pulumi.Input<string>;
/**
* The interface ID of the VPN gateway with which this VPN tunnel is associated.
*/
vpnGatewayInterface?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a VPNTunnel resource.
*/
export interface VPNTunnelArgs {
/**
* An optional description of this resource.
*/
description?: pulumi.Input<string>;
/**
* IKE protocol version to use when establishing the VPN tunnel with
* peer VPN gateway.
* Acceptable IKE versions are 1 or 2. Default version is 2.
*/
ikeVersion?: pulumi.Input<number>;
/**
* Labels to apply to this VpnTunnel.
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Local traffic selector to use when establishing the VPN tunnel with
* peer VPN gateway. The value should be a CIDR formatted string,
* for example `192.168.0.0/16`. The ranges should be disjoint.
* Only IPv4 is supported.
*/
localTrafficSelectors?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Name of the resource. The name must be 1-63 characters long, and
* comply with RFC1035. Specifically, the name must be 1-63
* characters long and match the regular expression
* `a-z?` which means the first character
* must be a lowercase letter, and all following characters must
* be a dash, lowercase letter, or digit,
* except the last character, which cannot be a dash.
*/
name?: pulumi.Input<string>;
/**
* URL of the peer side external VPN gateway to which this VPN tunnel is connected.
*/
peerExternalGateway?: pulumi.Input<string>;
/**
* The interface ID of the external VPN gateway to which this VPN tunnel is connected.
*/
peerExternalGatewayInterface?: pulumi.Input<number>;
/**
* URL of the peer side HA GCP VPN gateway to which this VPN tunnel is connected.
* If provided, the VPN tunnel will automatically use the same vpnGatewayInterface
* ID in the peer GCP VPN gateway.
* This field must reference a `gcp.compute.HaVpnGateway` resource.
*/
peerGcpGateway?: pulumi.Input<string>;
/**
* IP address of the peer VPN gateway. Only IPv4 is supported.
*/
peerIp?: 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>;
/**
* The region where the tunnel is located. If unset, is set to the region of `targetVpnGateway`.
*/
region?: pulumi.Input<string>;
/**
* Remote traffic selector to use when establishing the VPN tunnel with
* peer VPN gateway. The value should be a CIDR formatted string,
* for example `192.168.0.0/16`. The ranges should be disjoint.
* Only IPv4 is supported.
*/
remoteTrafficSelectors?: pulumi.Input<pulumi.Input<string>[]>;
/**
* URL of router resource to be used for dynamic routing.
*/
router?: pulumi.Input<string>;
/**
* Shared secret used to set the secure session between the Cloud VPN
* gateway and the peer VPN gateway.
* **Note**: This property is sensitive and will not be displayed in the plan.
*
*
* - - -
*/
sharedSecret: pulumi.Input<string>;
/**
* URL of the Target VPN gateway with which this VPN tunnel is
* associated.
*/
targetVpnGateway?: pulumi.Input<string>;
/**
* URL of the VPN gateway with which this VPN tunnel is associated.
* This must be used if a High Availability VPN gateway resource is created.
* This field must reference a `gcp.compute.HaVpnGateway` resource.
*/
vpnGateway?: pulumi.Input<string>;
/**
* The interface ID of the VPN gateway with which this VPN tunnel is associated.
*/
vpnGatewayInterface?: pulumi.Input<number>;
}