Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. compute
  5. compute/beta
  6. VpnTunnel

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.compute/beta.VpnTunnel

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Creates a VpnTunnel resource in the specified project and region using the data included in the request.

    Create VpnTunnel Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new VpnTunnel(name: string, args: VpnTunnelArgs, opts?: CustomResourceOptions);
    @overload
def VpnTunnel(resource_name: str,
              args: VpnTunnelArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def VpnTunnel(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              region: Optional[str] = None,
              peer_ip: Optional[str] = None,
              local_traffic_selector: Optional[Sequence[str]] = None,
              ike_version: Optional[int] = None,
              remote_traffic_selector: Optional[Sequence[str]] = None,
              peer_external_gateway: Optional[str] = None,
              peer_external_gateway_interface: Optional[int] = None,
              peer_gcp_gateway: Optional[str] = None,
              description: Optional[str] = None,
              vpn_gateway_interface: Optional[int] = None,
              labels: Optional[Mapping[str, str]] = None,
              name: Optional[str] = None,
              request_id: Optional[str] = None,
              router: Optional[str] = None,
              shared_secret: Optional[str] = None,
              shared_secret_hash: Optional[str] = None,
              target_vpn_gateway: Optional[str] = None,
              vpn_gateway: Optional[str] = None,
              project: Optional[str] = None)
    func NewVpnTunnel(ctx *Context, name string, args VpnTunnelArgs, opts ...ResourceOption) (*VpnTunnel, error)
    public VpnTunnel(string name, VpnTunnelArgs args, CustomResourceOptions? opts = null)
    public VpnTunnel(String name, VpnTunnelArgs args)
public VpnTunnel(String name, VpnTunnelArgs args, CustomResourceOptions options)

    type: google-native:compute/beta:VpnTunnel
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args VpnTunnelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VpnTunnelArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VpnTunnelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VpnTunnelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VpnTunnelArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var google_nativeVpnTunnelResource = new GoogleNative.Compute.Beta.VpnTunnel("google-nativeVpnTunnelResource", new()
{
    Region = "string",
    PeerIp = "string",
    LocalTrafficSelector = new[]
    {
        "string",
    },
    IkeVersion = 0,
    RemoteTrafficSelector = new[]
    {
        "string",
    },
    PeerExternalGateway = "string",
    PeerExternalGatewayInterface = 0,
    PeerGcpGateway = "string",
    Description = "string",
    VpnGatewayInterface = 0,
    Labels = 
    {
        { "string", "string" },
    },
    Name = "string",
    RequestId = "string",
    Router = "string",
    SharedSecret = "string",
    SharedSecretHash = "string",
    TargetVpnGateway = "string",
    VpnGateway = "string",
    Project = "string",
});

    example, err := computebeta.NewVpnTunnel(ctx, "google-nativeVpnTunnelResource", &computebeta.VpnTunnelArgs{
Region: pulumi.String("string"),
PeerIp: pulumi.String("string"),
LocalTrafficSelector: pulumi.StringArray{
pulumi.String("string"),
},
IkeVersion: pulumi.Int(0),
RemoteTrafficSelector: pulumi.StringArray{
pulumi.String("string"),
},
PeerExternalGateway: pulumi.String("string"),
PeerExternalGatewayInterface: pulumi.Int(0),
PeerGcpGateway: pulumi.String("string"),
Description: pulumi.String("string"),
VpnGatewayInterface: pulumi.Int(0),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
Name: pulumi.String("string"),
RequestId: pulumi.String("string"),
Router: pulumi.String("string"),
SharedSecret: pulumi.String("string"),
SharedSecretHash: pulumi.String("string"),
TargetVpnGateway: pulumi.String("string"),
VpnGateway: pulumi.String("string"),
Project: pulumi.String("string"),
})

    var google_nativeVpnTunnelResource = new VpnTunnel("google-nativeVpnTunnelResource", VpnTunnelArgs.builder()
    .region("string")
    .peerIp("string")
    .localTrafficSelector("string")
    .ikeVersion(0)
    .remoteTrafficSelector("string")
    .peerExternalGateway("string")
    .peerExternalGatewayInterface(0)
    .peerGcpGateway("string")
    .description("string")
    .vpnGatewayInterface(0)
    .labels(Map.of("string", "string"))
    .name("string")
    .requestId("string")
    .router("string")
    .sharedSecret("string")
    .sharedSecretHash("string")
    .targetVpnGateway("string")
    .vpnGateway("string")
    .project("string")
    .build());

    google_native_vpn_tunnel_resource = google_native.compute.beta.VpnTunnel("google-nativeVpnTunnelResource",
    region="string",
    peer_ip="string",
    local_traffic_selector=["string"],
    ike_version=0,
    remote_traffic_selector=["string"],
    peer_external_gateway="string",
    peer_external_gateway_interface=0,
    peer_gcp_gateway="string",
    description="string",
    vpn_gateway_interface=0,
    labels={
        "string": "string",
    },
    name="string",
    request_id="string",
    router="string",
    shared_secret="string",
    shared_secret_hash="string",
    target_vpn_gateway="string",
    vpn_gateway="string",
    project="string")

    const google_nativeVpnTunnelResource = new google_native.compute.beta.VpnTunnel("google-nativeVpnTunnelResource", {
    region: "string",
    peerIp: "string",
    localTrafficSelector: ["string"],
    ikeVersion: 0,
    remoteTrafficSelector: ["string"],
    peerExternalGateway: "string",
    peerExternalGatewayInterface: 0,
    peerGcpGateway: "string",
    description: "string",
    vpnGatewayInterface: 0,
    labels: {
        string: "string",
    },
    name: "string",
    requestId: "string",
    router: "string",
    sharedSecret: "string",
    sharedSecretHash: "string",
    targetVpnGateway: "string",
    vpnGateway: "string",
    project: "string",
});

    type: google-native:compute/beta:VpnTunnel
properties:
    description: string
    ikeVersion: 0
    labels:
        string: string
    localTrafficSelector:
        - string
    name: string
    peerExternalGateway: string
    peerExternalGatewayInterface: 0
    peerGcpGateway: string
    peerIp: string
    project: string
    region: string
    remoteTrafficSelector:
        - string
    requestId: string
    router: string
    sharedSecret: string
    sharedSecretHash: string
    targetVpnGateway: string
    vpnGateway: string
    vpnGatewayInterface: 0

    VpnTunnel Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The VpnTunnel resource accepts the following input properties:

    Region string
    Description string
    An optional description of this resource. Provide this property when you create the resource.
    IkeVersion int
    IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2.
    Labels Dictionary<string, string>
    Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
    LocalTrafficSelector List<string>
    Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported.
    Name string
    Name of the resource. Provided by the client when the resource is created. 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]([-a-z0-9]*[a-z0-9])? 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.
    PeerExternalGateway string
    URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway.
    PeerExternalGatewayInterface int
    The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. Possible values are: 0, 1, 2, 3. The number of IDs in use depends on the external VPN gateway redundancy type.
    PeerGcpGateway string
    URL of the peer side HA VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer Google Cloud VPN gateway.
    PeerIp string
    IP address of the peer VPN gateway. Only IPv4 is supported.
    Project string
    RemoteTrafficSelector List<string>
    Remote traffic selectors to use when establishing the VPN tunnel with the 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.
    RequestId string
    An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
    Router string
    URL of the router resource to be used for dynamic routing.
    SharedSecret string
    Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
    SharedSecretHash string
    Hash of the shared secret.
    TargetVpnGateway string
    URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
    VpnGateway string
    URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created.
    VpnGatewayInterface int
    The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: 0, 1.
    Region string
    Description string
    An optional description of this resource. Provide this property when you create the resource.
    IkeVersion int
    IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2.
    Labels map[string]string
    Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
    LocalTrafficSelector []string
    Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported.
    Name string
    Name of the resource. Provided by the client when the resource is created. 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]([-a-z0-9]*[a-z0-9])? 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.
    PeerExternalGateway string
    URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway.
    PeerExternalGatewayInterface int
    The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. Possible values are: 0, 1, 2, 3. The number of IDs in use depends on the external VPN gateway redundancy type.
    PeerGcpGateway string
    URL of the peer side HA VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer Google Cloud VPN gateway.
    PeerIp string
    IP address of the peer VPN gateway. Only IPv4 is supported.
    Project string
    RemoteTrafficSelector []string
    Remote traffic selectors to use when establishing the VPN tunnel with the 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.
    RequestId string
    An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
    Router string
    URL of the router resource to be used for dynamic routing.
    SharedSecret string
    Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
    SharedSecretHash string
    Hash of the shared secret.
    TargetVpnGateway string
    URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
    VpnGateway string
    URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created.
    VpnGatewayInterface int
    The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: 0, 1.
    region String
    description String
    An optional description of this resource. Provide this property when you create the resource.
    ikeVersion Integer
    IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2.
    labels Map<String,String>
    Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
    localTrafficSelector List<String>
    Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported.
    name String
    Name of the resource. Provided by the client when the resource is created. 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]([-a-z0-9]*[a-z0-9])? 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.
    peerExternalGateway String
    URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway.
    peerExternalGatewayInterface Integer
    The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. Possible values are: 0, 1, 2, 3. The number of IDs in use depends on the external VPN gateway redundancy type.
    peerGcpGateway String
    URL of the peer side HA VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer Google Cloud VPN gateway.
    peerIp String
    IP address of the peer VPN gateway. Only IPv4 is supported.
    project String
    remoteTrafficSelector List<String>
    Remote traffic selectors to use when establishing the VPN tunnel with the 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.
    requestId String
    An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
    router String
    URL of the router resource to be used for dynamic routing.
    sharedSecret String
    Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
    sharedSecretHash String
    Hash of the shared secret.
    targetVpnGateway String
    URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
    vpnGateway String
    URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created.
    vpnGatewayInterface Integer
    The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: 0, 1.
    region string
    description string
    An optional description of this resource. Provide this property when you create the resource.
    ikeVersion number
    IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2.
    labels {[key: string]: string}
    Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
    localTrafficSelector string[]
    Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported.
    name string
    Name of the resource. Provided by the client when the resource is created. 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]([-a-z0-9]*[a-z0-9])? 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.
    peerExternalGateway string
    URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway.
    peerExternalGatewayInterface number
    The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. Possible values are: 0, 1, 2, 3. The number of IDs in use depends on the external VPN gateway redundancy type.
    peerGcpGateway string
    URL of the peer side HA VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer Google Cloud VPN gateway.
    peerIp string
    IP address of the peer VPN gateway. Only IPv4 is supported.
    project string
    remoteTrafficSelector string[]
    Remote traffic selectors to use when establishing the VPN tunnel with the 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.
    requestId string
    An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
    router string
    URL of the router resource to be used for dynamic routing.
    sharedSecret string
    Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
    sharedSecretHash string
    Hash of the shared secret.
    targetVpnGateway string
    URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
    vpnGateway string
    URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created.
    vpnGatewayInterface number
    The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: 0, 1.
    region str
    description str
    An optional description of this resource. Provide this property when you create the resource.
    ike_version int
    IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2.
    labels Mapping[str, str]
    Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
    local_traffic_selector Sequence[str]
    Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported.
    name str
    Name of the resource. Provided by the client when the resource is created. 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]([-a-z0-9]*[a-z0-9])? 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.
    peer_external_gateway str
    URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway.
    peer_external_gateway_interface int
    The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. Possible values are: 0, 1, 2, 3. The number of IDs in use depends on the external VPN gateway redundancy type.
    peer_gcp_gateway str
    URL of the peer side HA VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer Google Cloud VPN gateway.
    peer_ip str
    IP address of the peer VPN gateway. Only IPv4 is supported.
    project str
    remote_traffic_selector Sequence[str]
    Remote traffic selectors to use when establishing the VPN tunnel with the 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.
    request_id str
    An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
    router str
    URL of the router resource to be used for dynamic routing.
    shared_secret str
    Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
    shared_secret_hash str
    Hash of the shared secret.
    target_vpn_gateway str
    URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
    vpn_gateway str
    URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created.
    vpn_gateway_interface int
    The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: 0, 1.
    region String
    description String
    An optional description of this resource. Provide this property when you create the resource.
    ikeVersion Number
    IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2.
    labels Map<String>
    Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
    localTrafficSelector List<String>
    Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported.
    name String
    Name of the resource. Provided by the client when the resource is created. 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]([-a-z0-9]*[a-z0-9])? 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.
    peerExternalGateway String
    URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway.
    peerExternalGatewayInterface Number
    The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. Possible values are: 0, 1, 2, 3. The number of IDs in use depends on the external VPN gateway redundancy type.
    peerGcpGateway String
    URL of the peer side HA VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer Google Cloud VPN gateway.
    peerIp String
    IP address of the peer VPN gateway. Only IPv4 is supported.
    project String
    remoteTrafficSelector List<String>
    Remote traffic selectors to use when establishing the VPN tunnel with the 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.
    requestId String
    An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
    router String
    URL of the router resource to be used for dynamic routing.
    sharedSecret String
    Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
    sharedSecretHash String
    Hash of the shared secret.
    targetVpnGateway String
    URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
    vpnGateway String
    URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created.
    vpnGatewayInterface Number
    The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: 0, 1.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the VpnTunnel resource produces the following output properties:

    CreationTimestamp string
    Creation timestamp in RFC3339 text format.
    DetailedStatus string
    Detailed status message for the VPN tunnel.
    Id string
    The provider-assigned unique ID for this managed resource.
    Kind string
    Type of resource. Always compute#vpnTunnel for VPN tunnels.
    LabelFingerprint string
    A fingerprint for the labels being applied to this VpnTunnel, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a VpnTunnel.
    SelfLink string
    Server-defined URL for the resource.
    Status string
    The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: Tunnel configuration was rejected, can be result of being denied access. - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel.
    CreationTimestamp string
    Creation timestamp in RFC3339 text format.
    DetailedStatus string
    Detailed status message for the VPN tunnel.
    Id string
    The provider-assigned unique ID for this managed resource.
    Kind string
    Type of resource. Always compute#vpnTunnel for VPN tunnels.
    LabelFingerprint string
    A fingerprint for the labels being applied to this VpnTunnel, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a VpnTunnel.
    SelfLink string
    Server-defined URL for the resource.
    Status string
    The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: Tunnel configuration was rejected, can be result of being denied access. - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel.
    creationTimestamp String
    Creation timestamp in RFC3339 text format.
    detailedStatus String
    Detailed status message for the VPN tunnel.
    id String
    The provider-assigned unique ID for this managed resource.
    kind String
    Type of resource. Always compute#vpnTunnel for VPN tunnels.
    labelFingerprint String
    A fingerprint for the labels being applied to this VpnTunnel, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a VpnTunnel.
    selfLink String
    Server-defined URL for the resource.
    status String
    The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: Tunnel configuration was rejected, can be result of being denied access. - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel.
    creationTimestamp string
    Creation timestamp in RFC3339 text format.
    detailedStatus string
    Detailed status message for the VPN tunnel.
    id string
    The provider-assigned unique ID for this managed resource.
    kind string
    Type of resource. Always compute#vpnTunnel for VPN tunnels.
    labelFingerprint string
    A fingerprint for the labels being applied to this VpnTunnel, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a VpnTunnel.
    selfLink string
    Server-defined URL for the resource.
    status string
    The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: Tunnel configuration was rejected, can be result of being denied access. - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel.
    creation_timestamp str
    Creation timestamp in RFC3339 text format.
    detailed_status str
    Detailed status message for the VPN tunnel.
    id str
    The provider-assigned unique ID for this managed resource.
    kind str
    Type of resource. Always compute#vpnTunnel for VPN tunnels.
    label_fingerprint str
    A fingerprint for the labels being applied to this VpnTunnel, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a VpnTunnel.
    self_link str
    Server-defined URL for the resource.
    status str
    The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: Tunnel configuration was rejected, can be result of being denied access. - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel.
    creationTimestamp String
    Creation timestamp in RFC3339 text format.
    detailedStatus String
    Detailed status message for the VPN tunnel.
    id String
    The provider-assigned unique ID for this managed resource.
    kind String
    Type of resource. Always compute#vpnTunnel for VPN tunnels.
    labelFingerprint String
    A fingerprint for the labels being applied to this VpnTunnel, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a VpnTunnel.
    selfLink String
    Server-defined URL for the resource.
    status String
    The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: Tunnel configuration was rejected, can be result of being denied access. - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native