1. Registry
  2. Packages
  3. stackit
  4. API Docs
  5. getVpnGatewayStatus
Viewing docs for stackit v0.0.7
published on Monday, Aug 17, 2026 by stackitcloud
stackit logo
Viewing docs for stackit v0.0.7
published on Monday, Aug 17, 2026 by stackitcloud

    VPN Gateway Status 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_status" "example" {
      project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
      gateway_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    }
    

    Using getVpnGatewayStatus

    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 getVpnGatewayStatus(args: GetVpnGatewayStatusArgs, opts?: InvokeOptions): Promise<GetVpnGatewayStatusResult>
    function getVpnGatewayStatusOutput(args: GetVpnGatewayStatusOutputArgs, opts?: InvokeOutputOptions): Output<GetVpnGatewayStatusResult>
    def get_vpn_gateway_status(gateway_id: Optional[str] = None,
                               project_id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetVpnGatewayStatusResult
    def get_vpn_gateway_status_output(gateway_id: pulumi.Input[Optional[str]] = None,
                               project_id: pulumi.Input[Optional[str]] = None,
                               opts: Optional[InvokeOutputOptions] = None) -> Output[GetVpnGatewayStatusResult]
    func GetVpnGatewayStatus(ctx *Context, args *GetVpnGatewayStatusArgs, opts ...InvokeOption) (*GetVpnGatewayStatusResult, error)
    func GetVpnGatewayStatusOutput(ctx *Context, args *GetVpnGatewayStatusOutputArgs, opts ...InvokeOption) GetVpnGatewayStatusResultOutput

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

    public static class GetVpnGatewayStatus 
    {
        public static Task<GetVpnGatewayStatusResult> InvokeAsync(GetVpnGatewayStatusArgs args, InvokeOptions? opts = null)
        public static Output<GetVpnGatewayStatusResult> Invoke(GetVpnGatewayStatusInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetVpnGatewayStatusResult> Invoke(GetVpnGatewayStatusInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetVpnGatewayStatusResult> getVpnGatewayStatus(GetVpnGatewayStatusArgs args, InvokeOptions options)
    public static Output<GetVpnGatewayStatusResult> getVpnGatewayStatus(GetVpnGatewayStatusArgs args, InvokeOptions options)
    public static Output<GetVpnGatewayStatusResult> getVpnGatewayStatus(GetVpnGatewayStatusArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: stackit:index/getVpnGatewayStatus:getVpnGatewayStatus
      arguments:
        # arguments dictionary
    data "stackit_get_vpn_gateway_status" "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.

    getVpnGatewayStatus Result

    The following output properties are available:

    Connections List<GetVpnGatewayStatusConnection>
    List of connections in the VPN gateway.
    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".
    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.
    Tunnels List<GetVpnGatewayStatusTunnel>
    List of the VPN tunnels in the gateway.
    Connections []GetVpnGatewayStatusConnection
    List of connections in the VPN gateway.
    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".
    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.
    Tunnels []GetVpnGatewayStatusTunnel
    List of the VPN tunnels in the gateway.
    connections list(object)
    List of connections in the VPN gateway.
    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".
    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.
    tunnels list(object)
    List of the VPN tunnels in the gateway.
    connections List<GetVpnGatewayStatusConnection>
    List of connections in the VPN gateway.
    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".
    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.
    tunnels List<GetVpnGatewayStatusTunnel>
    List of the VPN tunnels in the gateway.
    connections GetVpnGatewayStatusConnection[]
    List of connections in the VPN gateway.
    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".
    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.
    tunnels GetVpnGatewayStatusTunnel[]
    List of the VPN tunnels in the gateway.
    connections Sequence[GetVpnGatewayStatusConnection]
    List of connections in the VPN gateway.
    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".
    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.
    tunnels Sequence[GetVpnGatewayStatusTunnel]
    List of the VPN tunnels in the gateway.
    connections List<Property Map>
    List of connections in the VPN gateway.
    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".
    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.
    tunnels List<Property Map>
    List of the VPN tunnels in the gateway.

    Supporting Types

    GetVpnGatewayStatusConnection

    ConnectionId string
    ID of the VPN connection.
    DisplayName string
    Display name of the VPN connection.
    Enabled bool
    Wether the VPN connection is enabled or not.
    ConnectionId string
    ID of the VPN connection.
    DisplayName string
    Display name of the VPN connection.
    Enabled bool
    Wether the VPN connection is enabled or not.
    connection_id string
    ID of the VPN connection.
    display_name string
    Display name of the VPN connection.
    enabled bool
    Wether the VPN connection is enabled or not.
    connectionId String
    ID of the VPN connection.
    displayName String
    Display name of the VPN connection.
    enabled Boolean
    Wether the VPN connection is enabled or not.
    connectionId string
    ID of the VPN connection.
    displayName string
    Display name of the VPN connection.
    enabled boolean
    Wether the VPN connection is enabled or not.
    connection_id str
    ID of the VPN connection.
    display_name str
    Display name of the VPN connection.
    enabled bool
    Wether the VPN connection is enabled or not.
    connectionId String
    ID of the VPN connection.
    displayName String
    Display name of the VPN connection.
    enabled Boolean
    Wether the VPN connection is enabled or not.

    GetVpnGatewayStatusTunnel

    InternalNextHopIp string
    The IPv4 address of the endpoint in the SNA.
    Name string
    The name of the VPN tunnel. Possible values are: tunnel1, tunnel2.
    PublicIp string
    The public IPv4 address of this endpoint.
    InternalNextHopIp string
    The IPv4 address of the endpoint in the SNA.
    Name string
    The name of the VPN tunnel. Possible values are: tunnel1, tunnel2.
    PublicIp string
    The public IPv4 address of this endpoint.
    internal_next_hop_ip string
    The IPv4 address of the endpoint in the SNA.
    name string
    The name of the VPN tunnel. Possible values are: tunnel1, tunnel2.
    public_ip string
    The public IPv4 address of this endpoint.
    internalNextHopIp String
    The IPv4 address of the endpoint in the SNA.
    name String
    The name of the VPN tunnel. Possible values are: tunnel1, tunnel2.
    publicIp String
    The public IPv4 address of this endpoint.
    internalNextHopIp string
    The IPv4 address of the endpoint in the SNA.
    name string
    The name of the VPN tunnel. Possible values are: tunnel1, tunnel2.
    publicIp string
    The public IPv4 address of this endpoint.
    internal_next_hop_ip str
    The IPv4 address of the endpoint in the SNA.
    name str
    The name of the VPN tunnel. Possible values are: tunnel1, tunnel2.
    public_ip str
    The public IPv4 address of this endpoint.
    internalNextHopIp String
    The IPv4 address of the endpoint in the SNA.
    name String
    The name of the VPN tunnel. Possible values are: tunnel1, tunnel2.
    publicIp String
    The public IPv4 address of this endpoint.

    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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial