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

outscale.getVpnConnection

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 a VPN connection.

    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 vpnConnection01 = outscale.getVpnConnection({
    filters: [{
        name: "vpn_connection_ids",
        values: ["vpn-12345678"],
    }],
});

    import pulumi
import pulumi_outscale as outscale

vpn_connection01 = outscale.get_vpn_connection(filters=[{
    "name": "vpn_connection_ids",
    "values": ["vpn-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.LookupVpnConnection(ctx, &outscale.LookupVpnConnectionArgs{
			Filters: []outscale.GetVpnConnectionFilter{
				{
					Name: "vpn_connection_ids",
					Values: []string{
						"vpn-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 vpnConnection01 = Outscale.GetVpnConnection.Invoke(new()
    {
        Filters = new[]
        {
            new Outscale.Inputs.GetVpnConnectionFilterInputArgs
            {
                Name = "vpn_connection_ids",
                Values = new[]
                {
                    "vpn-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.GetVpnConnectionArgs;
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 vpnConnection01 = OutscaleFunctions.getVpnConnection(GetVpnConnectionArgs.builder()
            .filters(GetVpnConnectionFilterArgs.builder()
                .name("vpn_connection_ids")
                .values("vpn-12345678")
                .build())
            .build());

    }
}

    variables:
  vpnConnection01:
    fn::invoke:
      function: outscale:getVpnConnection
      arguments:
        filters:
          - name: vpn_connection_ids
            values:
              - vpn-12345678

    Using getVpnConnection

    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 getVpnConnection(args: GetVpnConnectionArgs, opts?: InvokeOptions): Promise<GetVpnConnectionResult>
function getVpnConnectionOutput(args: GetVpnConnectionOutputArgs, opts?: InvokeOptions): Output<GetVpnConnectionResult>
    def get_vpn_connection(filters: Optional[Sequence[GetVpnConnectionFilter]] = None,
                       id: Optional[str] = None,
                       static_routes_only: Optional[bool] = None,
                       vpn_connection_id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetVpnConnectionResult
def get_vpn_connection_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetVpnConnectionFilterArgs]]]] = None,
                       id: Optional[pulumi.Input[str]] = None,
                       static_routes_only: Optional[pulumi.Input[bool]] = None,
                       vpn_connection_id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetVpnConnectionResult]
    func LookupVpnConnection(ctx *Context, args *LookupVpnConnectionArgs, opts ...InvokeOption) (*LookupVpnConnectionResult, error)
func LookupVpnConnectionOutput(ctx *Context, args *LookupVpnConnectionOutputArgs, opts ...InvokeOption) LookupVpnConnectionResultOutput

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

    public static class GetVpnConnection 
{
    public static Task<GetVpnConnectionResult> InvokeAsync(GetVpnConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetVpnConnectionResult> Invoke(GetVpnConnectionInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVpnConnectionResult> getVpnConnection(GetVpnConnectionArgs args, InvokeOptions options)
public static Output<GetVpnConnectionResult> getVpnConnection(GetVpnConnectionArgs args, InvokeOptions options)

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

    The following arguments are supported:

    Filters List<GetVpnConnectionFilter>
    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
    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.
    VpnConnectionId string
    The ID of the VPN connection.
    Filters []GetVpnConnectionFilter
    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
    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.
    VpnConnectionId string
    The ID of the VPN connection.
    filters List<GetVpnConnectionFilter>
    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
    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.
    vpnConnectionId String
    The ID of the VPN connection.
    filters GetVpnConnectionFilter[]
    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
    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.
    vpnConnectionId string
    The ID of the VPN connection.
    filters Sequence[GetVpnConnectionFilter]
    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
    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.
    vpn_connection_id str
    The ID of the VPN connection.
    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
    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.
    vpnConnectionId String
    The ID of the VPN connection.

    getVpnConnection Result

    The following output properties are available:

    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).
    Id string
    RequestId string
    Routes List<GetVpnConnectionRoute>
    Information about one or more static routes associated with the VPN connection, if any.
    State string
    The state of the IPSEC tunnel (UP | DOWN).
    Tags List<GetVpnConnectionTag>
    One or more tags associated with the VPN connection.
    VgwTelemetries List<GetVpnConnectionVgwTelemetry>
    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.
    Filters List<GetVpnConnectionFilter>
    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.
    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).
    Id string
    RequestId string
    Routes []GetVpnConnectionRouteType
    Information about one or more static routes associated with the VPN connection, if any.
    State string
    The state of the IPSEC tunnel (UP | DOWN).
    Tags []GetVpnConnectionTag
    One or more tags associated with the VPN connection.
    VgwTelemetries []GetVpnConnectionVgwTelemetry
    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.
    Filters []GetVpnConnectionFilter
    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.
    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).
    id String
    requestId String
    routes List<GetVpnConnectionRoute>
    Information about one or more static routes associated with the VPN connection, if any.
    state String
    The state of the IPSEC tunnel (UP | DOWN).
    tags List<GetVpnConnectionTag>
    One or more tags associated with the VPN connection.
    vgwTelemetries List<GetVpnConnectionVgwTelemetry>
    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.
    filters List<GetVpnConnectionFilter>
    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.
    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).
    id string
    requestId string
    routes GetVpnConnectionRoute[]
    Information about one or more static routes associated with the VPN connection, if any.
    state string
    The state of the IPSEC tunnel (UP | DOWN).
    tags GetVpnConnectionTag[]
    One or more tags associated with the VPN connection.
    vgwTelemetries GetVpnConnectionVgwTelemetry[]
    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.
    filters GetVpnConnectionFilter[]
    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.
    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).
    id str
    request_id str
    routes Sequence[GetVpnConnectionRoute]
    Information about one or more static routes associated with the VPN connection, if any.
    state str
    The state of the IPSEC tunnel (UP | DOWN).
    tags Sequence[GetVpnConnectionTag]
    One or more tags associated with the VPN connection.
    vgw_telemetries Sequence[GetVpnConnectionVgwTelemetry]
    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.
    filters Sequence[GetVpnConnectionFilter]
    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.
    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).
    id String
    requestId String
    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).
    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.
    filters List<Property Map>
    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.
    vpnConnectionId String
    The ID of the VPN connection.

    Supporting Types

    GetVpnConnectionFilter

    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>

    GetVpnConnectionRoute

    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).

    GetVpnConnectionTag

    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.

    GetVpnConnectionVgwTelemetry

    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