getVirtualGateway

outscale 1.4.0, Feb 24 26

Viewing docs for outscale 1.4.0
published on Tuesday, Feb 24, 2026 by outscale

Schema (JSON)

outscale/terraform-provider-outscale

Viewing docs for outscale 1.4.0
published on Tuesday, Feb 24, 2026 by outscale

Schema (JSON)

outscale/terraform-provider-outscale

Example Usage

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

const virtualGateway01 = outscale.getVirtualGateway({
    filters: [{
        name: "virtual_gateway_ids",
        values: ["vgw-12345678"],
    }],
});

import pulumi
import pulumi_outscale as outscale

virtual_gateway01 = outscale.get_virtual_gateway(filters=[{
    "name": "virtual_gateway_ids",
    "values": ["vgw-12345678"],
}])

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/outscale/outscale"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := outscale.LookupVirtualGateway(ctx, &outscale.LookupVirtualGatewayArgs{
			Filters: []outscale.GetVirtualGatewayFilter{
				{
					Name: "virtual_gateway_ids",
					Values: []string{
						"vgw-12345678",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var virtualGateway01 = Outscale.GetVirtualGateway.Invoke(new()
    {
        Filters = new[]
        {
            new Outscale.Inputs.GetVirtualGatewayFilterInputArgs
            {
                Name = "virtual_gateway_ids",
                Values = new[]
                {
                    "vgw-12345678",
                },
            },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.outscale.OutscaleFunctions;
import com.pulumi.outscale.inputs.GetVirtualGatewayArgs;
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 virtualGateway01 = OutscaleFunctions.getVirtualGateway(GetVirtualGatewayArgs.builder()
            .filters(GetVirtualGatewayFilterArgs.builder()
                .name("virtual_gateway_ids")
                .values("vgw-12345678")
                .build())
            .build());

    }
}

variables:
  virtualGateway01:
    fn::invoke:
      function: outscale:getVirtualGateway
      arguments:
        filters:
          - name: virtual_gateway_ids
            values:
              - vgw-12345678

Using getVirtualGateway

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 getVirtualGateway(args: GetVirtualGatewayArgs, opts?: InvokeOptions): Promise<GetVirtualGatewayResult>
function getVirtualGatewayOutput(args: GetVirtualGatewayOutputArgs, opts?: InvokeOptions): Output<GetVirtualGatewayResult>

def get_virtual_gateway(connection_type: Optional[str] = None,
                        filters: Optional[Sequence[GetVirtualGatewayFilter]] = None,
                        id: Optional[str] = None,
                        state: Optional[str] = None,
                        virtual_gateway_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetVirtualGatewayResult
def get_virtual_gateway_output(connection_type: Optional[pulumi.Input[str]] = None,
                        filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetVirtualGatewayFilterArgs]]]] = None,
                        id: Optional[pulumi.Input[str]] = None,
                        state: Optional[pulumi.Input[str]] = None,
                        virtual_gateway_id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetVirtualGatewayResult]

func LookupVirtualGateway(ctx *Context, args *LookupVirtualGatewayArgs, opts ...InvokeOption) (*LookupVirtualGatewayResult, error)
func LookupVirtualGatewayOutput(ctx *Context, args *LookupVirtualGatewayOutputArgs, opts ...InvokeOption) LookupVirtualGatewayResultOutput

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

public static class GetVirtualGateway 
{
    public static Task<GetVirtualGatewayResult> InvokeAsync(GetVirtualGatewayArgs args, InvokeOptions? opts = null)
    public static Output<GetVirtualGatewayResult> Invoke(GetVirtualGatewayInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetVirtualGatewayResult> getVirtualGateway(GetVirtualGatewayArgs args, InvokeOptions options)
public static Output<GetVirtualGatewayResult> getVirtualGateway(GetVirtualGatewayArgs args, InvokeOptions options)

fn::invoke:
  function: outscale:index/getVirtualGateway:getVirtualGateway
  arguments:
    # arguments dictionary

The following arguments are supported:

ConnectionType string: The type of VPN connection supported by the virtual gateway (always ipsec.1).
Filters List<GetVirtualGatewayFilter>: A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
Id string
State string: The state of the virtual gateway (pending | available | deleting | deleted).
VirtualGatewayId string: The ID of the virtual gateway.

ConnectionType string: The type of VPN connection supported by the virtual gateway (always ipsec.1).
Filters []GetVirtualGatewayFilter: A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
Id string
State string: The state of the virtual gateway (pending | available | deleting | deleted).
VirtualGatewayId string: The ID of the virtual gateway.

connectionType String: The type of VPN connection supported by the virtual gateway (always ipsec.1).
filters List<GetVirtualGatewayFilter>: A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
id String
state String: The state of the virtual gateway (pending | available | deleting | deleted).
virtualGatewayId String: The ID of the virtual gateway.

connectionType string: The type of VPN connection supported by the virtual gateway (always ipsec.1).
filters GetVirtualGatewayFilter[]: A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
id string
state string: The state of the virtual gateway (pending | available | deleting | deleted).
virtualGatewayId string: The ID of the virtual gateway.

connection_type str: The type of VPN connection supported by the virtual gateway (always ipsec.1).
filters Sequence[GetVirtualGatewayFilter]: A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
id str
state str: The state of the virtual gateway (pending | available | deleting | deleted).
virtual_gateway_id str: The ID of the virtual gateway.

connectionType String: The type of VPN connection supported by the virtual gateway (always ipsec.1).
filters List<Property Map>: A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
id String
state String: The state of the virtual gateway (pending | available | deleting | deleted).
virtualGatewayId String: The ID of the virtual gateway.