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

outscale.getVpnConnections

Explore with Pulumi AI

outscale 1.1.0 published on Thursday, Apr 3, 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",
            ],
        },
    ],
});
Copy
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",
        ],
    },
])
Copy
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
	})
}
Copy
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",
                },
            },
        },
    });

});
Copy
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());

    }
}
Copy
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
Copy

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>
Copy
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]
Copy
func GetVpnConnections(ctx *Context, args *GetVpnConnectionsArgs, opts ...InvokeOption) (*GetVpnConnectionsResult, error)
func GetVpnConnectionsOutput(ctx *Context, args *GetVpnConnectionsOutputArgs, opts ...InvokeOption) GetVpnConnectionsResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetVpnConnectionsResult> getVpnConnections(GetVpnConnectionsArgs args, InvokeOptions options)
public static Output<GetVpnConnectionsResult> getVpnConnections(GetVpnConnectionsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: outscale:index/getVpnConnections:getVpnConnections
  arguments:
    # arguments dictionary
Copy

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 This property is required. string
Values This property is required. List<string>
Name This property is required. string
Values This property is required. []string
name This property is required. String
values This property is required. List<String>
name This property is required. string
values This property is required. string[]
name This property is required. str
values This property is required. Sequence[str]
name This property is required. String
values This property is required. List<String>

GetVpnConnectionsVpnConnection

ClientGatewayConfiguration This property is required. string
Example configuration for the client gateway.
ClientGatewayId This property is required. string
The ID of the client gateway used on the client end of the connection.
ConnectionType This property is required. string
The type of VPN connection (always ipsec.1).
Routes This property is required. List<GetVpnConnectionsVpnConnectionRoute>
Information about one or more static routes associated with the VPN connection, if any.
State This property is required. string
The state of the IPSEC tunnel (UP | DOWN).
StaticRoutesOnly This property is required. 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 This property is required. List<GetVpnConnectionsVpnConnectionTag>
One or more tags associated with the VPN connection.
VgwTelemetries This property is required. List<GetVpnConnectionsVpnConnectionVgwTelemetry>
Information about the current state of one or more of the VPN tunnels.
VirtualGatewayId This property is required. string
The ID of the virtual gateway used on the OUTSCALE end of the connection.
VpnConnectionId This property is required. string
The ID of the VPN connection.
ClientGatewayConfiguration This property is required. string
Example configuration for the client gateway.
ClientGatewayId This property is required. string
The ID of the client gateway used on the client end of the connection.
ConnectionType This property is required. string
The type of VPN connection (always ipsec.1).
Routes This property is required. []GetVpnConnectionsVpnConnectionRoute
Information about one or more static routes associated with the VPN connection, if any.
State This property is required. string
The state of the IPSEC tunnel (UP | DOWN).
StaticRoutesOnly This property is required. 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 This property is required. []GetVpnConnectionsVpnConnectionTag
One or more tags associated with the VPN connection.
VgwTelemetries This property is required. []GetVpnConnectionsVpnConnectionVgwTelemetry
Information about the current state of one or more of the VPN tunnels.
VirtualGatewayId This property is required. string
The ID of the virtual gateway used on the OUTSCALE end of the connection.
VpnConnectionId This property is required. string
The ID of the VPN connection.
clientGatewayConfiguration This property is required. String
Example configuration for the client gateway.
clientGatewayId This property is required. String
The ID of the client gateway used on the client end of the connection.
connectionType This property is required. String
The type of VPN connection (always ipsec.1).
routes This property is required. List<GetVpnConnectionsVpnConnectionRoute>
Information about one or more static routes associated with the VPN connection, if any.
state This property is required. String
The state of the IPSEC tunnel (UP | DOWN).
staticRoutesOnly This property is required. 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 This property is required. List<GetVpnConnectionsVpnConnectionTag>
One or more tags associated with the VPN connection.
vgwTelemetries This property is required. List<GetVpnConnectionsVpnConnectionVgwTelemetry>
Information about the current state of one or more of the VPN tunnels.
virtualGatewayId This property is required. String
The ID of the virtual gateway used on the OUTSCALE end of the connection.
vpnConnectionId This property is required. String
The ID of the VPN connection.
clientGatewayConfiguration This property is required. string
Example configuration for the client gateway.
clientGatewayId This property is required. string
The ID of the client gateway used on the client end of the connection.
connectionType This property is required. string
The type of VPN connection (always ipsec.1).
routes This property is required. GetVpnConnectionsVpnConnectionRoute[]
Information about one or more static routes associated with the VPN connection, if any.
state This property is required. string
The state of the IPSEC tunnel (UP | DOWN).
staticRoutesOnly This property is required. 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 This property is required. GetVpnConnectionsVpnConnectionTag[]
One or more tags associated with the VPN connection.
vgwTelemetries This property is required. GetVpnConnectionsVpnConnectionVgwTelemetry[]
Information about the current state of one or more of the VPN tunnels.
virtualGatewayId This property is required. string
The ID of the virtual gateway used on the OUTSCALE end of the connection.
vpnConnectionId This property is required. string
The ID of the VPN connection.
client_gateway_configuration This property is required. str
Example configuration for the client gateway.
client_gateway_id This property is required. str
The ID of the client gateway used on the client end of the connection.
connection_type This property is required. str
The type of VPN connection (always ipsec.1).
routes This property is required. Sequence[GetVpnConnectionsVpnConnectionRoute]
Information about one or more static routes associated with the VPN connection, if any.
state This property is required. str
The state of the IPSEC tunnel (UP | DOWN).
static_routes_only This property is required. 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 This property is required. Sequence[GetVpnConnectionsVpnConnectionTag]
One or more tags associated with the VPN connection.
vgw_telemetries This property is required. Sequence[GetVpnConnectionsVpnConnectionVgwTelemetry]
Information about the current state of one or more of the VPN tunnels.
virtual_gateway_id This property is required. str
The ID of the virtual gateway used on the OUTSCALE end of the connection.
vpn_connection_id This property is required. str
The ID of the VPN connection.
clientGatewayConfiguration This property is required. String
Example configuration for the client gateway.
clientGatewayId This property is required. String
The ID of the client gateway used on the client end of the connection.
connectionType This property is required. String
The type of VPN connection (always ipsec.1).
routes This property is required. List<Property Map>
Information about one or more static routes associated with the VPN connection, if any.
state This property is required. String
The state of the IPSEC tunnel (UP | DOWN).
staticRoutesOnly This property is required. 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 This property is required. List<Property Map>
One or more tags associated with the VPN connection.
vgwTelemetries This property is required. List<Property Map>
Information about the current state of one or more of the VPN tunnels.
virtualGatewayId This property is required. String
The ID of the virtual gateway used on the OUTSCALE end of the connection.
vpnConnectionId This property is required. String
The ID of the VPN connection.

GetVpnConnectionsVpnConnectionRoute

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

GetVpnConnectionsVpnConnectionTag

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

GetVpnConnectionsVpnConnectionVgwTelemetry

AcceptedRouteCount This property is required. double
The number of routes accepted through BGP (Border Gateway Protocol) route exchanges.
LastStateChangeDate This property is required. string
The date and time (UTC) of the latest state update.
OutsideIpAddress This property is required. string
The IP on the OUTSCALE side of the tunnel.
State This property is required. string
The state of the IPSEC tunnel (UP | DOWN).
StateDescription This property is required. string
A description of the current state of the tunnel.
AcceptedRouteCount This property is required. float64
The number of routes accepted through BGP (Border Gateway Protocol) route exchanges.
LastStateChangeDate This property is required. string
The date and time (UTC) of the latest state update.
OutsideIpAddress This property is required. string
The IP on the OUTSCALE side of the tunnel.
State This property is required. string
The state of the IPSEC tunnel (UP | DOWN).
StateDescription This property is required. string
A description of the current state of the tunnel.
acceptedRouteCount This property is required. Double
The number of routes accepted through BGP (Border Gateway Protocol) route exchanges.
lastStateChangeDate This property is required. String
The date and time (UTC) of the latest state update.
outsideIpAddress This property is required. String
The IP on the OUTSCALE side of the tunnel.
state This property is required. String
The state of the IPSEC tunnel (UP | DOWN).
stateDescription This property is required. String
A description of the current state of the tunnel.
acceptedRouteCount This property is required. number
The number of routes accepted through BGP (Border Gateway Protocol) route exchanges.
lastStateChangeDate This property is required. string
The date and time (UTC) of the latest state update.
outsideIpAddress This property is required. string
The IP on the OUTSCALE side of the tunnel.
state This property is required. string
The state of the IPSEC tunnel (UP | DOWN).
stateDescription This property is required. string
A description of the current state of the tunnel.
accepted_route_count This property is required. float
The number of routes accepted through BGP (Border Gateway Protocol) route exchanges.
last_state_change_date This property is required. str
The date and time (UTC) of the latest state update.
outside_ip_address This property is required. str
The IP on the OUTSCALE side of the tunnel.
state This property is required. str
The state of the IPSEC tunnel (UP | DOWN).
state_description This property is required. str
A description of the current state of the tunnel.
acceptedRouteCount This property is required. Number
The number of routes accepted through BGP (Border Gateway Protocol) route exchanges.
lastStateChangeDate This property is required. String
The date and time (UTC) of the latest state update.
outsideIpAddress This property is required. String
The IP on the OUTSCALE side of the tunnel.
state This property is required. String
The state of the IPSEC tunnel (UP | DOWN).
stateDescription This property is required. 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 1.1.0 published on Thursday, Apr 3, 2025 by outscale
outscale/terraform-provider-outscale