Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Outscale Provider
  3. API Docs
  4. getVpnConnections
outscale 1.0.1 published on Thursday, Mar 13, 2025 by outscale
outscale/terraform-provider-outscale

outscale.getVpnConnections

Explore with Pulumi AI

outscale logo
outscale 1.0.1 published on Thursday, Mar 13, 2025 by outscale
outscale/terraform-provider-outscale

    Provides information about VPN connections.

    For more information on this resource, see the User Guide.
    For more information on this resource actions, see the API documentation.

    Example Usage

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

const vpnConnections01 = outscale.getVpnConnections({
    filters: [
        {
            name: "client_gateway_ids",
            values: ["cgw-12345678"],
        },
        {
            name: "virtual_gateway_ids",
            values: [
                "vgw-12345678",
                "vgw-12345678",
            ],
        },
    ],
});

    import pulumi
import pulumi_outscale as outscale

vpn_connections01 = outscale.get_vpn_connections(filters=[
    {
        "name": "client_gateway_ids",
        "values": ["cgw-12345678"],
    },
    {
        "name": "virtual_gateway_ids",
        "values": [
            "vgw-12345678",
            "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.GetVpnConnections(ctx, &outscale.GetVpnConnectionsArgs{
			Filters: []outscale.GetVpnConnectionsFilter{
				{
					Name: "client_gateway_ids",
					Values: []string{
						"cgw-12345678",
					},
				},
				{
					Name: "virtual_gateway_ids",
					Values: []string{
						"vgw-12345678",
						"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 vpnConnections01 = Outscale.GetVpnConnections.Invoke(new()
    {
        Filters = new[]
        {
            new Outscale.Inputs.GetVpnConnectionsFilterInputArgs
            {
                Name = "client_gateway_ids",
                Values = new[]
                {
                    "cgw-12345678",
                },
            },
            new Outscale.Inputs.GetVpnConnectionsFilterInputArgs
            {
                Name = "virtual_gateway_ids",
                Values = new[]
                {
                    "vgw-12345678",
                    "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.GetVpnConnectionsArgs;
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 vpnConnections01 = OutscaleFunctions.getVpnConnections(GetVpnConnectionsArgs.builder()
            .filters(            
                GetVpnConnectionsFilterArgs.builder()
                    .name("client_gateway_ids")
                    .values("cgw-12345678")
                    .build(),
                GetVpnConnectionsFilterArgs.builder()
                    .name("virtual_gateway_ids")
                    .values(                    
                        "vgw-12345678",
                        "vgw-12345678")
                    .build())
            .build());

    }
}

    variables:
  vpnConnections01:
    fn::invoke:
      function: outscale:getVpnConnections
      arguments:
        filters:
          - name: client_gateway_ids
            values:
              - cgw-12345678
          - name: virtual_gateway_ids
            values:
              - vgw-12345678
              - vgw-12345678

    Using getVpnConnections

    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 getVpnConnections(args: GetVpnConnectionsArgs, opts?: InvokeOptions): Promise<GetVpnConnectionsResult>
function getVpnConnectionsOutput(args: GetVpnConnectionsOutputArgs, opts?: InvokeOptions): Output<GetVpnConnectionsResult>
    def get_vpn_connections(filters: Optional[Sequence[GetVpnConnectionsFilter]] = None,
                        id: Optional[str] = None,
                        vpn_connection_ids: Optional[Sequence[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> GetVpnConnectionsResult
def get_vpn_connections_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetVpnConnectionsFilterArgs]]]] = None,
                        id: Optional[pulumi.Input[str]] = None,
                        vpn_connection_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetVpnConnectionsResult]
    func GetVpnConnections(ctx *Context, args *GetVpnConnectionsArgs, opts ...InvokeOption) (*GetVpnConnectionsResult, error)
func GetVpnConnectionsOutput(ctx *Context, args *GetVpnConnectionsOutputArgs, opts ...InvokeOption) GetVpnConnectionsResultOutput

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

    public static class GetVpnConnections 
{
    public static Task<GetVpnConnectionsResult> InvokeAsync(GetVpnConnectionsArgs args, InvokeOptions? opts = null)
    public static Output<GetVpnConnectionsResult> Invoke(GetVpnConnectionsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVpnConnectionsResult> getVpnConnections(GetVpnConnectionsArgs args, InvokeOptions options)
public static Output<GetVpnConnectionsResult> getVpnConnections(GetVpnConnectionsArgs args, InvokeOptions options)

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

    The following arguments are supported:

    Filters List<GetVpnConnectionsFilter>
    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
    VpnConnectionIds List<string>
    Filters []GetVpnConnectionsFilter
    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
    VpnConnectionIds []string
    filters List<GetVpnConnectionsFilter>
    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
    vpnConnectionIds List<String>
    filters GetVpnConnectionsFilter[]
    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
    vpnConnectionIds string[]
    filters Sequence[GetVpnConnectionsFilter]
    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
    vpn_connection_ids Sequence[str]
    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
    vpnConnectionIds List<String>

    getVpnConnections Result

    The following output properties are available:

    Id string
    RequestId string
    VpnConnections []GetVpnConnectionsVpnConnection
    Information about one or more VPN connections.
    Filters []GetVpnConnectionsFilter
    VpnConnectionIds []string
    id string
    requestId string
    vpnConnections GetVpnConnectionsVpnConnection[]
    Information about one or more VPN connections.
    filters GetVpnConnectionsFilter[]
    vpnConnectionIds string[]
    id String
    requestId String
    vpnConnections List<Property Map>
    Information about one or more VPN connections.
    filters List<Property Map>
    vpnConnectionIds List<String>

    Supporting Types

    GetVpnConnectionsFilter

    Name string
    Values List<string>
    Name string
    Values []string
    name String
    values List<String>
    name string
    values string[]
    name str
    values Sequence[str]
    name String
    values List<String>

    GetVpnConnectionsVpnConnection

    ClientGatewayConfiguration string
    Example configuration for the client gateway.
    ClientGatewayId string
    The ID of the client gateway used on the client end of the connection.
    ConnectionType string
    The type of VPN connection (always ipsec.1).
    Routes List<GetVpnConnectionsVpnConnectionRoute>
    Information about one or more static routes associated with the VPN connection, if any.
    State string
    The state of the IPSEC tunnel (UP | DOWN).
    StaticRoutesOnly bool
    If false, the VPN connection uses dynamic routing with Border Gateway Protocol (BGP). If true, routing is controlled using static routes. For more information about how to create and delete static routes, see CreateVpnConnectionRoute and DeleteVpnConnectionRoute.
    Tags List<GetVpnConnectionsVpnConnectionTag>
    One or more tags associated with the VPN connection.
    VgwTelemetries List<GetVpnConnectionsVpnConnectionVgwTelemetry>
    Information about the current state of one or more of the VPN tunnels.
    VirtualGatewayId string
    The ID of the virtual gateway used on the OUTSCALE end of the connection.
    VpnConnectionId string
    The ID of the VPN connection.
    ClientGatewayConfiguration string
    Example configuration for the client gateway.
    ClientGatewayId string
    The ID of the client gateway used on the client end of the connection.
    ConnectionType string
    The type of VPN connection (always ipsec.1).
    Routes []GetVpnConnectionsVpnConnectionRoute
    Information about one or more static routes associated with the VPN connection, if any.
    State string
    The state of the IPSEC tunnel (UP | DOWN).
    StaticRoutesOnly bool
    If false, the VPN connection uses dynamic routing with Border Gateway Protocol (BGP). If true, routing is controlled using static routes. For more information about how to create and delete static routes, see CreateVpnConnectionRoute and DeleteVpnConnectionRoute.
    Tags []GetVpnConnectionsVpnConnectionTag
    One or more tags associated with the VPN connection.
    VgwTelemetries []GetVpnConnectionsVpnConnectionVgwTelemetry
    Information about the current state of one or more of the VPN tunnels.
    VirtualGatewayId string
    The ID of the virtual gateway used on the OUTSCALE end of the connection.
    VpnConnectionId string
    The ID of the VPN connection.
    clientGatewayConfiguration String
    Example configuration for the client gateway.
    clientGatewayId String
    The ID of the client gateway used on the client end of the connection.
    connectionType String
    The type of VPN connection (always ipsec.1).
    routes List<GetVpnConnectionsVpnConnectionRoute>
    Information about one or more static routes associated with the VPN connection, if any.
    state String
    The state of the IPSEC tunnel (UP | DOWN).
    staticRoutesOnly Boolean
    If false, the VPN connection uses dynamic routing with Border Gateway Protocol (BGP). If true, routing is controlled using static routes. For more information about how to create and delete static routes, see CreateVpnConnectionRoute and DeleteVpnConnectionRoute.
    tags List<GetVpnConnectionsVpnConnectionTag>
    One or more tags associated with the VPN connection.
    vgwTelemetries List<GetVpnConnectionsVpnConnectionVgwTelemetry>
    Information about the current state of one or more of the VPN tunnels.
    virtualGatewayId String
    The ID of the virtual gateway used on the OUTSCALE end of the connection.
    vpnConnectionId String
    The ID of the VPN connection.
    clientGatewayConfiguration string
    Example configuration for the client gateway.
    clientGatewayId string
    The ID of the client gateway used on the client end of the connection.
    connectionType string
    The type of VPN connection (always ipsec.1).
    routes GetVpnConnectionsVpnConnectionRoute[]
    Information about one or more static routes associated with the VPN connection, if any.
    state string
    The state of the IPSEC tunnel (UP | DOWN).
    staticRoutesOnly boolean
    If false, the VPN connection uses dynamic routing with Border Gateway Protocol (BGP). If true, routing is controlled using static routes. For more information about how to create and delete static routes, see CreateVpnConnectionRoute and DeleteVpnConnectionRoute.
    tags GetVpnConnectionsVpnConnectionTag[]
    One or more tags associated with the VPN connection.
    vgwTelemetries GetVpnConnectionsVpnConnectionVgwTelemetry[]
    Information about the current state of one or more of the VPN tunnels.
    virtualGatewayId string
    The ID of the virtual gateway used on the OUTSCALE end of the connection.
    vpnConnectionId string
    The ID of the VPN connection.
    client_gateway_configuration str
    Example configuration for the client gateway.
    client_gateway_id str
    The ID of the client gateway used on the client end of the connection.
    connection_type str
    The type of VPN connection (always ipsec.1).
    routes Sequence[GetVpnConnectionsVpnConnectionRoute]
    Information about one or more static routes associated with the VPN connection, if any.
    state str
    The state of the IPSEC tunnel (UP | DOWN).
    static_routes_only bool
    If false, the VPN connection uses dynamic routing with Border Gateway Protocol (BGP). If true, routing is controlled using static routes. For more information about how to create and delete static routes, see CreateVpnConnectionRoute and DeleteVpnConnectionRoute.
    tags Sequence[GetVpnConnectionsVpnConnectionTag]
    One or more tags associated with the VPN connection.
    vgw_telemetries Sequence[GetVpnConnectionsVpnConnectionVgwTelemetry]
    Information about the current state of one or more of the VPN tunnels.
    virtual_gateway_id str
    The ID of the virtual gateway used on the OUTSCALE end of the connection.
    vpn_connection_id str
    The ID of the VPN connection.
    clientGatewayConfiguration String
    Example configuration for the client gateway.
    clientGatewayId String
    The ID of the client gateway used on the client end of the connection.
    connectionType String
    The type of VPN connection (always ipsec.1).
    routes List<Property Map>
    Information about one or more static routes associated with the VPN connection, if any.
    state String
    The state of the IPSEC tunnel (UP | DOWN).
    staticRoutesOnly Boolean
    If false, the VPN connection uses dynamic routing with Border Gateway Protocol (BGP). If true, routing is controlled using static routes. For more information about how to create and delete static routes, see CreateVpnConnectionRoute and DeleteVpnConnectionRoute.
    tags List<Property Map>
    One or more tags associated with the VPN connection.
    vgwTelemetries List<Property Map>
    Information about the current state of one or more of the VPN tunnels.
    virtualGatewayId String
    The ID of the virtual gateway used on the OUTSCALE end of the connection.
    vpnConnectionId String
    The ID of the VPN connection.

    GetVpnConnectionsVpnConnectionRoute

    DestinationIpRange string
    The IP range used for the destination match, in CIDR notation (for example, 10.0.0.0/24).
    RouteType string
    The type of route (always static).
    State string
    The state of the IPSEC tunnel (UP | DOWN).
    DestinationIpRange string
    The IP range used for the destination match, in CIDR notation (for example, 10.0.0.0/24).
    RouteType string
    The type of route (always static).
    State string
    The state of the IPSEC tunnel (UP | DOWN).
    destinationIpRange String
    The IP range used for the destination match, in CIDR notation (for example, 10.0.0.0/24).
    routeType String
    The type of route (always static).
    state String
    The state of the IPSEC tunnel (UP | DOWN).
    destinationIpRange string
    The IP range used for the destination match, in CIDR notation (for example, 10.0.0.0/24).
    routeType string
    The type of route (always static).
    state string
    The state of the IPSEC tunnel (UP | DOWN).
    destination_ip_range str
    The IP range used for the destination match, in CIDR notation (for example, 10.0.0.0/24).
    route_type str
    The type of route (always static).
    state str
    The state of the IPSEC tunnel (UP | DOWN).
    destinationIpRange String
    The IP range used for the destination match, in CIDR notation (for example, 10.0.0.0/24).
    routeType String
    The type of route (always static).
    state String
    The state of the IPSEC tunnel (UP | DOWN).

    GetVpnConnectionsVpnConnectionTag

    Key string
    The key of the tag, with a minimum of 1 character.
    Value string
    The value of the tag, between 0 and 255 characters.
    Key string
    The key of the tag, with a minimum of 1 character.
    Value string
    The value of the tag, between 0 and 255 characters.
    key String
    The key of the tag, with a minimum of 1 character.
    value String
    The value of the tag, between 0 and 255 characters.
    key string
    The key of the tag, with a minimum of 1 character.
    value string
    The value of the tag, between 0 and 255 characters.
    key str
    The key of the tag, with a minimum of 1 character.
    value str
    The value of the tag, between 0 and 255 characters.
    key String
    The key of the tag, with a minimum of 1 character.
    value String
    The value of the tag, between 0 and 255 characters.

    GetVpnConnectionsVpnConnectionVgwTelemetry

    AcceptedRouteCount double
    The number of routes accepted through BGP (Border Gateway Protocol) route exchanges.
    LastStateChangeDate string
    The date and time (UTC) of the latest state update.
    OutsideIpAddress string
    The IP on the OUTSCALE side of the tunnel.
    State string
    The state of the IPSEC tunnel (UP | DOWN).
    StateDescription string
    A description of the current state of the tunnel.
    AcceptedRouteCount float64
    The number of routes accepted through BGP (Border Gateway Protocol) route exchanges.
    LastStateChangeDate string
    The date and time (UTC) of the latest state update.
    OutsideIpAddress string
    The IP on the OUTSCALE side of the tunnel.
    State string
    The state of the IPSEC tunnel (UP | DOWN).
    StateDescription string
    A description of the current state of the tunnel.
    acceptedRouteCount Double
    The number of routes accepted through BGP (Border Gateway Protocol) route exchanges.
    lastStateChangeDate String
    The date and time (UTC) of the latest state update.
    outsideIpAddress String
    The IP on the OUTSCALE side of the tunnel.
    state String
    The state of the IPSEC tunnel (UP | DOWN).
    stateDescription String
    A description of the current state of the tunnel.
    acceptedRouteCount number
    The number of routes accepted through BGP (Border Gateway Protocol) route exchanges.
    lastStateChangeDate string
    The date and time (UTC) of the latest state update.
    outsideIpAddress string
    The IP on the OUTSCALE side of the tunnel.
    state string
    The state of the IPSEC tunnel (UP | DOWN).
    stateDescription string
    A description of the current state of the tunnel.
    accepted_route_count float
    The number of routes accepted through BGP (Border Gateway Protocol) route exchanges.
    last_state_change_date str
    The date and time (UTC) of the latest state update.
    outside_ip_address str
    The IP on the OUTSCALE side of the tunnel.
    state str
    The state of the IPSEC tunnel (UP | DOWN).
    state_description str
    A description of the current state of the tunnel.
    acceptedRouteCount Number
    The number of routes accepted through BGP (Border Gateway Protocol) route exchanges.
    lastStateChangeDate String
    The date and time (UTC) of the latest state update.
    outsideIpAddress String
    The IP on the OUTSCALE side of the tunnel.
    state String
    The state of the IPSEC tunnel (UP | DOWN).
    stateDescription String
    A description of the current state of the tunnel.

    Package Details

    Repository
    outscale outscale/terraform-provider-outscale
    License
    Notes
    This Pulumi package is based on the outscale Terraform Provider.
    outscale logo
    outscale 1.0.1 published on Thursday, Mar 13, 2025 by outscale
    outscale/terraform-provider-outscale