1. Packages
  2. AWS
  3. API Docs
  4. ec2
  5. getVpnConnection
Viewing docs for AWS v7.21.0
published on Wednesday, Mar 4, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.ec2.getVpnConnection

aws logo
Viewing docs for AWS v7.21.0
published on Wednesday, Mar 4, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    Fetches details of a Site-to-Site VPN connection. A Site-to-Site VPN connection is an Internet Protocol security (IPsec) VPN connection between a VPC and an on-premises network.

    Example Usage

    Basic Usage

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

const example = aws.ec2.getVpnConnection({
    filters: [{
        name: "customer-gateway-id",
        values: ["cgw-1234567890"],
    }],
});
export const vpnConnectionId = example.then(example => example.vpnConnectionId);

    import pulumi
import pulumi_aws as aws

example = aws.ec2.get_vpn_connection(filters=[{
    "name": "customer-gateway-id",
    "values": ["cgw-1234567890"],
}])
pulumi.export("vpnConnectionId", example.vpn_connection_id)

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := ec2.LookupVpnConnection(ctx, &ec2.LookupVpnConnectionArgs{
			Filters: []ec2.GetVpnConnectionFilter{
				{
					Name: "customer-gateway-id",
					Values: []string{
						"cgw-1234567890",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("vpnConnectionId", example.VpnConnectionId)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Aws.Ec2.GetVpnConnection.Invoke(new()
    {
        Filters = new[]
        {
            new Aws.Ec2.Inputs.GetVpnConnectionFilterInputArgs
            {
                Name = "customer-gateway-id",
                Values = new[]
                {
                    "cgw-1234567890",
                },
            },
        },
    });

    return new Dictionary<string, object?>
    {
        ["vpnConnectionId"] = example.Apply(getVpnConnectionResult => getVpnConnectionResult.VpnConnectionId),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.Ec2Functions;
import com.pulumi.aws.ec2.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 example = Ec2Functions.getVpnConnection(GetVpnConnectionArgs.builder()
            .filters(GetVpnConnectionFilterArgs.builder()
                .name("customer-gateway-id")
                .values("cgw-1234567890")
                .build())
            .build());

        ctx.export("vpnConnectionId", example.vpnConnectionId());
    }
}

    variables:
  example:
    fn::invoke:
      function: aws:ec2:getVpnConnection
      arguments:
        filters:
          - name: customer-gateway-id
            values:
              - cgw-1234567890
outputs:
  vpnConnectionId: ${example.vpnConnectionId}

    Find by VPN Connection ID

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

const example = aws.ec2.getVpnConnection({
    vpnConnectionId: "vpn-abcd1234567890",
});
export const gatewayAssociationState = example.then(example => example.gatewayAssociationState);

    import pulumi
import pulumi_aws as aws

example = aws.ec2.get_vpn_connection(vpn_connection_id="vpn-abcd1234567890")
pulumi.export("gatewayAssociationState", example.gateway_association_state)

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := ec2.LookupVpnConnection(ctx, &ec2.LookupVpnConnectionArgs{
			VpnConnectionId: pulumi.StringRef("vpn-abcd1234567890"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("gatewayAssociationState", example.GatewayAssociationState)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Aws.Ec2.GetVpnConnection.Invoke(new()
    {
        VpnConnectionId = "vpn-abcd1234567890",
    });

    return new Dictionary<string, object?>
    {
        ["gatewayAssociationState"] = example.Apply(getVpnConnectionResult => getVpnConnectionResult.GatewayAssociationState),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.Ec2Functions;
import com.pulumi.aws.ec2.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 example = Ec2Functions.getVpnConnection(GetVpnConnectionArgs.builder()
            .vpnConnectionId("vpn-abcd1234567890")
            .build());

        ctx.export("gatewayAssociationState", example.gatewayAssociationState());
    }
}

    variables:
  example:
    fn::invoke:
      function: aws:ec2:getVpnConnection
      arguments:
        vpnConnectionId: vpn-abcd1234567890
outputs:
  gatewayAssociationState: ${example.gatewayAssociationState}

    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,
                       region: Optional[str] = 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,
                       region: Optional[pulumi.Input[str]] = 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: aws:ec2/getVpnConnection:getVpnConnection
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Filters List<GetVpnConnectionFilter>
    Configuration block(s) for filtering. Detailed below.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    VpnConnectionId string
    Identifier of the EC2 VPN Connection.
    Filters []GetVpnConnectionFilter
    Configuration block(s) for filtering. Detailed below.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    VpnConnectionId string
    Identifier of the EC2 VPN Connection.
    filters List<GetVpnConnectionFilter>
    Configuration block(s) for filtering. Detailed below.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    vpnConnectionId String
    Identifier of the EC2 VPN Connection.
    filters GetVpnConnectionFilter[]
    Configuration block(s) for filtering. Detailed below.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    vpnConnectionId string
    Identifier of the EC2 VPN Connection.
    filters Sequence[GetVpnConnectionFilter]
    Configuration block(s) for filtering. Detailed below.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    vpn_connection_id str
    Identifier of the EC2 VPN Connection.
    filters List<Property Map>
    Configuration block(s) for filtering. Detailed below.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    vpnConnectionId String
    Identifier of the EC2 VPN Connection.

    getVpnConnection Result

    The following output properties are available:

    Category string
    Category of the VPN connection. A value of VPN indicates an AWS VPN connection. A value of VPN-Classic indicates an AWS Classic VPN connection.
    CoreNetworkArn string
    ARN of the core network.
    CoreNetworkAttachmentArn string
    ARN of the core network attachment.
    CustomerGatewayConfiguration string
    Configuration information for the VPN connection's customer gateway (in the native XML format).
    CustomerGatewayId string
    ID of the customer gateway at your end of the VPN connection.
    GatewayAssociationState string
    Current state of the gateway association.
    Id string
    The provider-assigned unique ID for this managed resource.
    PreSharedKeyArn string
    (ARN) of the Secrets Manager secret storing the pre-shared key(s) for the VPN connection.
    Region string
    Routes List<GetVpnConnectionRoute>
    List of static routes associated with the VPN connection.
    State string
    Current state of the VPN connection.
    Tags Dictionary<string, string>
    Tags associated to the VPN Connection.
    TransitGatewayId string
    ID of a transit gateway associated with the VPN connection.
    Type string
    Type of VPN connection. Currently the only supported type is ipsec.1.
    VgwTelemetries List<GetVpnConnectionVgwTelemetry>
    List of objects containing information about the VPN tunnel.
    VpnConcentratorId string
    ID of a VPN concentrator associated with the VPN connection.
    VpnConnectionId string
    VpnGatewayId string
    ID of a virtual private gateway associated with the VPN connection.
    Filters List<GetVpnConnectionFilter>
    Category string
    Category of the VPN connection. A value of VPN indicates an AWS VPN connection. A value of VPN-Classic indicates an AWS Classic VPN connection.
    CoreNetworkArn string
    ARN of the core network.
    CoreNetworkAttachmentArn string
    ARN of the core network attachment.
    CustomerGatewayConfiguration string
    Configuration information for the VPN connection's customer gateway (in the native XML format).
    CustomerGatewayId string
    ID of the customer gateway at your end of the VPN connection.
    GatewayAssociationState string
    Current state of the gateway association.
    Id string
    The provider-assigned unique ID for this managed resource.
    PreSharedKeyArn string
    (ARN) of the Secrets Manager secret storing the pre-shared key(s) for the VPN connection.
    Region string
    Routes []GetVpnConnectionRouteType
    List of static routes associated with the VPN connection.
    State string
    Current state of the VPN connection.
    Tags map[string]string
    Tags associated to the VPN Connection.
    TransitGatewayId string
    ID of a transit gateway associated with the VPN connection.
    Type string
    Type of VPN connection. Currently the only supported type is ipsec.1.
    VgwTelemetries []GetVpnConnectionVgwTelemetry
    List of objects containing information about the VPN tunnel.
    VpnConcentratorId string
    ID of a VPN concentrator associated with the VPN connection.
    VpnConnectionId string
    VpnGatewayId string
    ID of a virtual private gateway associated with the VPN connection.
    Filters []GetVpnConnectionFilter
    category String
    Category of the VPN connection. A value of VPN indicates an AWS VPN connection. A value of VPN-Classic indicates an AWS Classic VPN connection.
    coreNetworkArn String
    ARN of the core network.
    coreNetworkAttachmentArn String
    ARN of the core network attachment.
    customerGatewayConfiguration String
    Configuration information for the VPN connection's customer gateway (in the native XML format).
    customerGatewayId String
    ID of the customer gateway at your end of the VPN connection.
    gatewayAssociationState String
    Current state of the gateway association.
    id String
    The provider-assigned unique ID for this managed resource.
    preSharedKeyArn String
    (ARN) of the Secrets Manager secret storing the pre-shared key(s) for the VPN connection.
    region String
    routes List<GetVpnConnectionRoute>
    List of static routes associated with the VPN connection.
    state String
    Current state of the VPN connection.
    tags Map<String,String>
    Tags associated to the VPN Connection.
    transitGatewayId String
    ID of a transit gateway associated with the VPN connection.
    type String
    Type of VPN connection. Currently the only supported type is ipsec.1.
    vgwTelemetries List<GetVpnConnectionVgwTelemetry>
    List of objects containing information about the VPN tunnel.
    vpnConcentratorId String
    ID of a VPN concentrator associated with the VPN connection.
    vpnConnectionId String
    vpnGatewayId String
    ID of a virtual private gateway associated with the VPN connection.
    filters List<GetVpnConnectionFilter>
    category string
    Category of the VPN connection. A value of VPN indicates an AWS VPN connection. A value of VPN-Classic indicates an AWS Classic VPN connection.
    coreNetworkArn string
    ARN of the core network.
    coreNetworkAttachmentArn string
    ARN of the core network attachment.
    customerGatewayConfiguration string
    Configuration information for the VPN connection's customer gateway (in the native XML format).
    customerGatewayId string
    ID of the customer gateway at your end of the VPN connection.
    gatewayAssociationState string
    Current state of the gateway association.
    id string
    The provider-assigned unique ID for this managed resource.
    preSharedKeyArn string
    (ARN) of the Secrets Manager secret storing the pre-shared key(s) for the VPN connection.
    region string
    routes GetVpnConnectionRoute[]
    List of static routes associated with the VPN connection.
    state string
    Current state of the VPN connection.
    tags {[key: string]: string}
    Tags associated to the VPN Connection.
    transitGatewayId string
    ID of a transit gateway associated with the VPN connection.
    type string
    Type of VPN connection. Currently the only supported type is ipsec.1.
    vgwTelemetries GetVpnConnectionVgwTelemetry[]
    List of objects containing information about the VPN tunnel.
    vpnConcentratorId string
    ID of a VPN concentrator associated with the VPN connection.
    vpnConnectionId string
    vpnGatewayId string
    ID of a virtual private gateway associated with the VPN connection.
    filters GetVpnConnectionFilter[]
    category str
    Category of the VPN connection. A value of VPN indicates an AWS VPN connection. A value of VPN-Classic indicates an AWS Classic VPN connection.
    core_network_arn str
    ARN of the core network.
    core_network_attachment_arn str
    ARN of the core network attachment.
    customer_gateway_configuration str
    Configuration information for the VPN connection's customer gateway (in the native XML format).
    customer_gateway_id str
    ID of the customer gateway at your end of the VPN connection.
    gateway_association_state str
    Current state of the gateway association.
    id str
    The provider-assigned unique ID for this managed resource.
    pre_shared_key_arn str
    (ARN) of the Secrets Manager secret storing the pre-shared key(s) for the VPN connection.
    region str
    routes Sequence[GetVpnConnectionRoute]
    List of static routes associated with the VPN connection.
    state str
    Current state of the VPN connection.
    tags Mapping[str, str]
    Tags associated to the VPN Connection.
    transit_gateway_id str
    ID of a transit gateway associated with the VPN connection.
    type str
    Type of VPN connection. Currently the only supported type is ipsec.1.
    vgw_telemetries Sequence[GetVpnConnectionVgwTelemetry]
    List of objects containing information about the VPN tunnel.
    vpn_concentrator_id str
    ID of a VPN concentrator associated with the VPN connection.
    vpn_connection_id str
    vpn_gateway_id str
    ID of a virtual private gateway associated with the VPN connection.
    filters Sequence[GetVpnConnectionFilter]
    category String
    Category of the VPN connection. A value of VPN indicates an AWS VPN connection. A value of VPN-Classic indicates an AWS Classic VPN connection.
    coreNetworkArn String
    ARN of the core network.
    coreNetworkAttachmentArn String
    ARN of the core network attachment.
    customerGatewayConfiguration String
    Configuration information for the VPN connection's customer gateway (in the native XML format).
    customerGatewayId String
    ID of the customer gateway at your end of the VPN connection.
    gatewayAssociationState String
    Current state of the gateway association.
    id String
    The provider-assigned unique ID for this managed resource.
    preSharedKeyArn String
    (ARN) of the Secrets Manager secret storing the pre-shared key(s) for the VPN connection.
    region String
    routes List<Property Map>
    List of static routes associated with the VPN connection.
    state String
    Current state of the VPN connection.
    tags Map<String>
    Tags associated to the VPN Connection.
    transitGatewayId String
    ID of a transit gateway associated with the VPN connection.
    type String
    Type of VPN connection. Currently the only supported type is ipsec.1.
    vgwTelemetries List<Property Map>
    List of objects containing information about the VPN tunnel.
    vpnConcentratorId String
    ID of a VPN concentrator associated with the VPN connection.
    vpnConnectionId String
    vpnGatewayId String
    ID of a virtual private gateway associated with the VPN connection.
    filters List<Property Map>

    Supporting Types

    GetVpnConnectionFilter

    Name string
    Name of the filter field. Valid values can be found in the EC2 DescribeVPNConnections API Reference.
    Values List<string>
    Set of values that are accepted for the given filter field. Results will be selected if any given value matches.
    Name string
    Name of the filter field. Valid values can be found in the EC2 DescribeVPNConnections API Reference.
    Values []string
    Set of values that are accepted for the given filter field. Results will be selected if any given value matches.
    name String
    Name of the filter field. Valid values can be found in the EC2 DescribeVPNConnections API Reference.
    values List<String>
    Set of values that are accepted for the given filter field. Results will be selected if any given value matches.
    name string
    Name of the filter field. Valid values can be found in the EC2 DescribeVPNConnections API Reference.
    values string[]
    Set of values that are accepted for the given filter field. Results will be selected if any given value matches.
    name str
    Name of the filter field. Valid values can be found in the EC2 DescribeVPNConnections API Reference.
    values Sequence[str]
    Set of values that are accepted for the given filter field. Results will be selected if any given value matches.
    name String
    Name of the filter field. Valid values can be found in the EC2 DescribeVPNConnections API Reference.
    values List<String>
    Set of values that are accepted for the given filter field. Results will be selected if any given value matches.

    GetVpnConnectionRoute

    DestinationCidrBlock string
    Source string
    State string
    Current state of the VPN connection.
    DestinationCidrBlock string
    Source string
    State string
    Current state of the VPN connection.
    destinationCidrBlock String
    source String
    state String
    Current state of the VPN connection.
    destinationCidrBlock string
    source string
    state string
    Current state of the VPN connection.
    destination_cidr_block str
    source str
    state str
    Current state of the VPN connection.
    destinationCidrBlock String
    source String
    state String
    Current state of the VPN connection.

    GetVpnConnectionVgwTelemetry

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    Viewing docs for AWS v7.21.0
    published on Wednesday, Mar 4, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws
      Try Pulumi Cloud free. Your team will thank you.