Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. stackit
  4. API Docs
  5. getVpnGateway
Viewing docs for stackit v0.0.7
published on Monday, Aug 17, 2026 by stackitcloud
Schema (JSON)
stackitcloud/pulumi-stackit

stackit.getVpnGateway

stackit logo
Viewing docs for stackit v0.0.7
published on Monday, Aug 17, 2026 by stackitcloud
Schema (JSON)
stackitcloud/pulumi-stackit

    VPN Gateway data source schema. Uses the defaultRegion specified in the provider configuration as a fallback in case no region is defined on datasource level.

    Example Usage

    data "stackit_vpn_gateway" "example" {
  project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  gateway_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

    Using getVpnGateway

    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 getVpnGateway(args: GetVpnGatewayArgs, opts?: InvokeOptions): Promise<GetVpnGatewayResult>
function getVpnGatewayOutput(args: GetVpnGatewayOutputArgs, opts?: InvokeOutputOptions): Output<GetVpnGatewayResult>
    def get_vpn_gateway(gateway_id: Optional[str] = None,
                    project_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetVpnGatewayResult
def get_vpn_gateway_output(gateway_id: pulumi.Input[Optional[str]] = None,
                    project_id: pulumi.Input[Optional[str]] = None,
                    opts: Optional[InvokeOutputOptions] = None) -> Output[GetVpnGatewayResult]
    func LookupVpnGateway(ctx *Context, args *LookupVpnGatewayArgs, opts ...InvokeOption) (*LookupVpnGatewayResult, error)
func LookupVpnGatewayOutput(ctx *Context, args *LookupVpnGatewayOutputArgs, opts ...InvokeOption) LookupVpnGatewayResultOutput

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

    public static class GetVpnGateway 
{
    public static Task<GetVpnGatewayResult> InvokeAsync(GetVpnGatewayArgs args, InvokeOptions? opts = null)
    public static Output<GetVpnGatewayResult> Invoke(GetVpnGatewayInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetVpnGatewayResult> Invoke(GetVpnGatewayInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetVpnGatewayResult> getVpnGateway(GetVpnGatewayArgs args, InvokeOptions options)
public static Output<GetVpnGatewayResult> getVpnGateway(GetVpnGatewayArgs args, InvokeOptions options)
public static Output<GetVpnGatewayResult> getVpnGateway(GetVpnGatewayArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: stackit:index/getVpnGateway:getVpnGateway
  arguments:
    # arguments dictionary
    data "stackit_get_vpn_gateway" "name" {
    # arguments
}

    The following arguments are supported:

    GatewayId string
    The server-generated UUID of the VPN gateway.
    ProjectId string
    STACKIT project ID associated with the VPN gateway.
    GatewayId string
    The server-generated UUID of the VPN gateway.
    ProjectId string
    STACKIT project ID associated with the VPN gateway.
    gateway_id string
    The server-generated UUID of the VPN gateway.
    project_id string
    STACKIT project ID associated with the VPN gateway.
    gatewayId String
    The server-generated UUID of the VPN gateway.
    projectId String
    STACKIT project ID associated with the VPN gateway.
    gatewayId string
    The server-generated UUID of the VPN gateway.
    projectId string
    STACKIT project ID associated with the VPN gateway.
    gateway_id str
    The server-generated UUID of the VPN gateway.
    project_id str
    STACKIT project ID associated with the VPN gateway.
    gatewayId String
    The server-generated UUID of the VPN gateway.
    projectId String
    STACKIT project ID associated with the VPN gateway.

    getVpnGateway Result

    The following output properties are available:

    AvailabilityZones GetVpnGatewayAvailabilityZones
    Availability zones for the two tunnel endpoints.
    Bgp GetVpnGatewayBgp
    BGP configuration. Only applicable when routingtype is BGPROUTE_BASED.
    DisplayName string
    A user-friendly name for the VPN gateway.
    GatewayId string
    The server-generated UUID of the VPN gateway.
    Id string
    Terraform's internal resource identifier. Structured as "projectId,region,gatewayId".
    Labels Dictionary<string, string>
    Map of custom labels (key-value string pairs).
    PlanId string
    The service plan identifier (e.g. p500). For guidance on finding available plans, see List available service plans.
    ProjectId string
    STACKIT project ID associated with the VPN gateway.
    Region string
    STACKIT region name the resource is located in. If not defined, the provider region is used.
    RoutingType string
    Routing architecture. Possible values are: POLICY_BASED, ROUTE_BASED, BGP_ROUTE_BASED.
    AvailabilityZones GetVpnGatewayAvailabilityZones
    Availability zones for the two tunnel endpoints.
    Bgp GetVpnGatewayBgp
    BGP configuration. Only applicable when routingtype is BGPROUTE_BASED.
    DisplayName string
    A user-friendly name for the VPN gateway.
    GatewayId string
    The server-generated UUID of the VPN gateway.
    Id string
    Terraform's internal resource identifier. Structured as "projectId,region,gatewayId".
    Labels map[string]string
    Map of custom labels (key-value string pairs).
    PlanId string
    The service plan identifier (e.g. p500). For guidance on finding available plans, see List available service plans.
    ProjectId string
    STACKIT project ID associated with the VPN gateway.
    Region string
    STACKIT region name the resource is located in. If not defined, the provider region is used.
    RoutingType string
    Routing architecture. Possible values are: POLICY_BASED, ROUTE_BASED, BGP_ROUTE_BASED.
    availability_zones object
    Availability zones for the two tunnel endpoints.
    bgp object
    BGP configuration. Only applicable when routingtype is BGPROUTE_BASED.
    display_name string
    A user-friendly name for the VPN gateway.
    gateway_id string
    The server-generated UUID of the VPN gateway.
    id string
    Terraform's internal resource identifier. Structured as "projectId,region,gatewayId".
    labels map(string)
    Map of custom labels (key-value string pairs).
    plan_id string
    The service plan identifier (e.g. p500). For guidance on finding available plans, see List available service plans.
    project_id string
    STACKIT project ID associated with the VPN gateway.
    region string
    STACKIT region name the resource is located in. If not defined, the provider region is used.
    routing_type string
    Routing architecture. Possible values are: POLICY_BASED, ROUTE_BASED, BGP_ROUTE_BASED.
    availabilityZones GetVpnGatewayAvailabilityZones
    Availability zones for the two tunnel endpoints.
    bgp GetVpnGatewayBgp
    BGP configuration. Only applicable when routingtype is BGPROUTE_BASED.
    displayName String
    A user-friendly name for the VPN gateway.
    gatewayId String
    The server-generated UUID of the VPN gateway.
    id String
    Terraform's internal resource identifier. Structured as "projectId,region,gatewayId".
    labels Map<String,String>
    Map of custom labels (key-value string pairs).
    planId String
    The service plan identifier (e.g. p500). For guidance on finding available plans, see List available service plans.
    projectId String
    STACKIT project ID associated with the VPN gateway.
    region String
    STACKIT region name the resource is located in. If not defined, the provider region is used.
    routingType String
    Routing architecture. Possible values are: POLICY_BASED, ROUTE_BASED, BGP_ROUTE_BASED.
    availabilityZones GetVpnGatewayAvailabilityZones
    Availability zones for the two tunnel endpoints.
    bgp GetVpnGatewayBgp
    BGP configuration. Only applicable when routingtype is BGPROUTE_BASED.
    displayName string
    A user-friendly name for the VPN gateway.
    gatewayId string
    The server-generated UUID of the VPN gateway.
    id string
    Terraform's internal resource identifier. Structured as "projectId,region,gatewayId".
    labels {[key: string]: string}
    Map of custom labels (key-value string pairs).
    planId string
    The service plan identifier (e.g. p500). For guidance on finding available plans, see List available service plans.
    projectId string
    STACKIT project ID associated with the VPN gateway.
    region string
    STACKIT region name the resource is located in. If not defined, the provider region is used.
    routingType string
    Routing architecture. Possible values are: POLICY_BASED, ROUTE_BASED, BGP_ROUTE_BASED.
    availability_zones GetVpnGatewayAvailabilityZones
    Availability zones for the two tunnel endpoints.
    bgp GetVpnGatewayBgp
    BGP configuration. Only applicable when routingtype is BGPROUTE_BASED.
    display_name str
    A user-friendly name for the VPN gateway.
    gateway_id str
    The server-generated UUID of the VPN gateway.
    id str
    Terraform's internal resource identifier. Structured as "projectId,region,gatewayId".
    labels Mapping[str, str]
    Map of custom labels (key-value string pairs).
    plan_id str
    The service plan identifier (e.g. p500). For guidance on finding available plans, see List available service plans.
    project_id str
    STACKIT project ID associated with the VPN gateway.
    region str
    STACKIT region name the resource is located in. If not defined, the provider region is used.
    routing_type str
    Routing architecture. Possible values are: POLICY_BASED, ROUTE_BASED, BGP_ROUTE_BASED.
    availabilityZones Property Map
    Availability zones for the two tunnel endpoints.
    bgp Property Map
    BGP configuration. Only applicable when routingtype is BGPROUTE_BASED.
    displayName String
    A user-friendly name for the VPN gateway.
    gatewayId String
    The server-generated UUID of the VPN gateway.
    id String
    Terraform's internal resource identifier. Structured as "projectId,region,gatewayId".
    labels Map<String>
    Map of custom labels (key-value string pairs).
    planId String
    The service plan identifier (e.g. p500). For guidance on finding available plans, see List available service plans.
    projectId String
    STACKIT project ID associated with the VPN gateway.
    region String
    STACKIT region name the resource is located in. If not defined, the provider region is used.
    routingType String
    Routing architecture. Possible values are: POLICY_BASED, ROUTE_BASED, BGP_ROUTE_BASED.

    Supporting Types

    GetVpnGatewayAvailabilityZones

    Tunnel1 string
    Availability zone for tunnel 1.
    Tunnel2 string
    Availability zone for tunnel 2.
    Tunnel1 string
    Availability zone for tunnel 1.
    Tunnel2 string
    Availability zone for tunnel 2.
    tunnel1 string
    Availability zone for tunnel 1.
    tunnel2 string
    Availability zone for tunnel 2.
    tunnel1 String
    Availability zone for tunnel 1.
    tunnel2 String
    Availability zone for tunnel 2.
    tunnel1 string
    Availability zone for tunnel 1.
    tunnel2 string
    Availability zone for tunnel 2.
    tunnel1 str
    Availability zone for tunnel 1.
    tunnel2 str
    Availability zone for tunnel 2.
    tunnel1 String
    Availability zone for tunnel 1.
    tunnel2 String
    Availability zone for tunnel 2.

    GetVpnGatewayBgp

    LocalAsn int
    Local ASN for BGP (private ASN range, 64512-4294967294).
    OverrideAdvertisedRoutes List<string>
    List of IPv4 CIDRs to advertise via BGP. If omitted, SNA network ranges are advertised.
    LocalAsn int
    Local ASN for BGP (private ASN range, 64512-4294967294).
    OverrideAdvertisedRoutes []string
    List of IPv4 CIDRs to advertise via BGP. If omitted, SNA network ranges are advertised.
    local_asn number
    Local ASN for BGP (private ASN range, 64512-4294967294).
    override_advertised_routes list(string)
    List of IPv4 CIDRs to advertise via BGP. If omitted, SNA network ranges are advertised.
    localAsn Integer
    Local ASN for BGP (private ASN range, 64512-4294967294).
    overrideAdvertisedRoutes List<String>
    List of IPv4 CIDRs to advertise via BGP. If omitted, SNA network ranges are advertised.
    localAsn number
    Local ASN for BGP (private ASN range, 64512-4294967294).
    overrideAdvertisedRoutes string[]
    List of IPv4 CIDRs to advertise via BGP. If omitted, SNA network ranges are advertised.
    local_asn int
    Local ASN for BGP (private ASN range, 64512-4294967294).
    override_advertised_routes Sequence[str]
    List of IPv4 CIDRs to advertise via BGP. If omitted, SNA network ranges are advertised.
    localAsn Number
    Local ASN for BGP (private ASN range, 64512-4294967294).
    overrideAdvertisedRoutes List<String>
    List of IPv4 CIDRs to advertise via BGP. If omitted, SNA network ranges are advertised.

    Package Details

    Repository
    stackit stackitcloud/pulumi-stackit
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the stackit Terraform Provider.
    stackit logo
    Viewing docs for stackit v0.0.7
    published on Monday, Aug 17, 2026 by stackitcloud
    Schema (JSON)
    stackitcloud/pulumi-stackit

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial