gcp.compute.getHcVpnGateway

Explore with Pulumi AI

Google Cloud v8.27.0 published on Thursday, Apr 17, 2025 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const gateway = gcp.compute.getHcVpnGateway({
    name: "foobar",
});

import pulumi
import pulumi_gcp as gcp

gateway = gcp.compute.get_hc_vpn_gateway(name="foobar")

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.GetHcVpnGateway(ctx, &compute.GetHcVpnGatewayArgs{
			Name: "foobar",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var gateway = Gcp.Compute.GetHcVpnGateway.Invoke(new()
    {
        Name = "foobar",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.ComputeFunctions;
import com.pulumi.gcp.compute.inputs.GetHcVpnGatewayArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var gateway = ComputeFunctions.getHcVpnGateway(GetHcVpnGatewayArgs.builder()
            .name("foobar")
            .build());

    }
}

variables:
  gateway:
    fn::invoke:
      function: gcp:compute:getHcVpnGateway
      arguments:
        name: foobar

Using getHcVpnGateway

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getHcVpnGateway(args: GetHcVpnGatewayArgs, opts?: InvokeOptions): Promise<GetHcVpnGatewayResult>
function getHcVpnGatewayOutput(args: GetHcVpnGatewayOutputArgs, opts?: InvokeOptions): Output<GetHcVpnGatewayResult>

def get_hc_vpn_gateway(name: Optional[str] = None,
                       project: Optional[str] = None,
                       region: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetHcVpnGatewayResult
def get_hc_vpn_gateway_output(name: Optional[pulumi.Input[str]] = None,
                       project: Optional[pulumi.Input[str]] = None,
                       region: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetHcVpnGatewayResult]

func GetHcVpnGateway(ctx *Context, args *GetHcVpnGatewayArgs, opts ...InvokeOption) (*GetHcVpnGatewayResult, error)
func GetHcVpnGatewayOutput(ctx *Context, args *GetHcVpnGatewayOutputArgs, opts ...InvokeOption) GetHcVpnGatewayResultOutput

> Note: This function is named GetHcVpnGateway in the Go SDK.

public static class GetHcVpnGateway 
{
    public static Task<GetHcVpnGatewayResult> InvokeAsync(GetHcVpnGatewayArgs args, InvokeOptions? opts = null)
    public static Output<GetHcVpnGatewayResult> Invoke(GetHcVpnGatewayInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetHcVpnGatewayResult> getHcVpnGateway(GetHcVpnGatewayArgs args, InvokeOptions options)
public static Output<GetHcVpnGatewayResult> getHcVpnGateway(GetHcVpnGatewayArgs args, InvokeOptions options)

fn::invoke:
  function: gcp:compute/getHcVpnGateway:getHcVpnGateway
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: The name of the forwarding rule.
Project string: The project in which the resource belongs. If it is not provided, the provider project is used.
Region string: The region in which the resource belongs. If it is not provided, the project region is used.

Name string: The name of the forwarding rule.
Project string: The project in which the resource belongs. If it is not provided, the provider project is used.
Region string: The region in which the resource belongs. If it is not provided, the project region is used.

name String: The name of the forwarding rule.
project String: The project in which the resource belongs. If it is not provided, the provider project is used.
region String: The region in which the resource belongs. If it is not provided, the project region is used.

name string: The name of the forwarding rule.
project string: The project in which the resource belongs. If it is not provided, the provider project is used.
region string: The region in which the resource belongs. If it is not provided, the project region is used.

name str: The name of the forwarding rule.
project str: The project in which the resource belongs. If it is not provided, the provider project is used.
region str: The region in which the resource belongs. If it is not provided, the project region is used.

name String: The name of the forwarding rule.
project String: The project in which the resource belongs. If it is not provided, the provider project is used.
region String: The region in which the resource belongs. If it is not provided, the project region is used.

getHcVpnGateway Result

The following output properties are available:

Description string
EffectiveLabels Dictionary<string, string>
GatewayIpVersion string
Id string: The provider-assigned unique ID for this managed resource.
LabelFingerprint string
Labels Dictionary<string, string>
Name string
Network string
PulumiLabels Dictionary<string, string>
SelfLink string
StackType string
VpnInterfaces List<GetHcVpnGatewayVpnInterface>
Project string
Region string

Description string
EffectiveLabels map[string]string
GatewayIpVersion string
Id string: The provider-assigned unique ID for this managed resource.
LabelFingerprint string
Labels map[string]string
Name string
Network string
PulumiLabels map[string]string
SelfLink string
StackType string
VpnInterfaces []GetHcVpnGatewayVpnInterface
Project string
Region string

description String
effectiveLabels Map<String,String>
gatewayIpVersion String
id String: The provider-assigned unique ID for this managed resource.
labelFingerprint String
labels Map<String,String>
name String
network String
pulumiLabels Map<String,String>
selfLink String
stackType String
vpnInterfaces List<GetHcVpnGatewayVpnInterface>
project String
region String

description string
effectiveLabels {[key: string]: string}
gatewayIpVersion string
id string: The provider-assigned unique ID for this managed resource.
labelFingerprint string
labels {[key: string]: string}
name string
network string
pulumiLabels {[key: string]: string}
selfLink string
stackType string
vpnInterfaces GetHcVpnGatewayVpnInterface[]
project string
region string

description str
effective_labels Mapping[str, str]
gateway_ip_version str
id str: The provider-assigned unique ID for this managed resource.
label_fingerprint str
labels Mapping[str, str]
name str
network str
pulumi_labels Mapping[str, str]
self_link str
stack_type str
vpn_interfaces Sequence[GetHcVpnGatewayVpnInterface]
project str
region str

description String
effectiveLabels Map<String>
gatewayIpVersion String
id String: The provider-assigned unique ID for this managed resource.
labelFingerprint String
labels Map<String>
name String
network String
pulumiLabels Map<String>
selfLink String
stackType String
vpnInterfaces List<Property Map>
project String
region String

Supporting Types

GetHcVpnGatewayVpnInterface

Id int

The numeric ID of this VPN gateway interface.

InterconnectAttachment string

URL of the interconnect attachment resource. When the value of this field is present, the VPN Gateway will be used for IPsec-encrypted Cloud Interconnect; all Egress or Ingress traffic for this VPN Gateway interface will go through the specified interconnect attachment resource.

Not currently available publicly.

IpAddress string

The external IP address for this VPN gateway interface.

Id int

The numeric ID of this VPN gateway interface.

InterconnectAttachment string

Not currently available publicly.

IpAddress string

The external IP address for this VPN gateway interface.

id Integer

The numeric ID of this VPN gateway interface.

interconnectAttachment String