VpnConnection class
Manages a Site-to-Site VPN connection. A Site-to-Site VPN connection is an IP security (IPsec) VPN connection between a VPC and an on-premises network. Any new Site-to-Site VPN connection that you create is an AWS VPN connection.
> Note: The CIDR blocks in the arguments tunnel1InsideCidr and tunnel2InsideCidr must have a prefix of /30 and be a part of a specific range.
Read more about this in the AWS documentation.
Example Usage
EC2 Transit Gateway
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.ec2transitgateway.TransitGateway("example", {});
const exampleCustomerGateway = new aws.ec2.CustomerGateway("example", {
bgpAsn: "65000",
ipAddress: "172.0.0.1",
type: "ipsec.1",
});
const exampleVpnConnection = new aws.ec2.VpnConnection("example", {
customerGatewayId: exampleCustomerGateway.id,
transitGatewayId: example.id,
type: exampleCustomerGateway.type,
});
import pulumi
import pulumi_aws as aws
example = aws.ec2transitgateway.TransitGateway("example")
example_customer_gateway = aws.ec2.CustomerGateway("example",
bgp_asn="65000",
ip_address="172.0.0.1",
type="ipsec.1")
example_vpn_connection = aws.ec2.VpnConnection("example",
customer_gateway_id=example_customer_gateway.id,
transit_gateway_id=example.id,
type=example_customer_gateway.type)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Ec2TransitGateway.TransitGateway("example");
var exampleCustomerGateway = new Aws.Ec2.CustomerGateway("example", new()
{
BgpAsn = "65000",
IpAddress = "172.0.0.1",
Type = "ipsec.1",
});
var exampleVpnConnection = new Aws.Ec2.VpnConnection("example", new()
{
CustomerGatewayId = exampleCustomerGateway.Id,
TransitGatewayId = example.Id,
Type = exampleCustomerGateway.Type,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ec2"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ec2transitgateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := ec2transitgateway.NewTransitGateway(ctx, "example", nil)
if err != nil {
return err
}
exampleCustomerGateway, err := ec2.NewCustomerGateway(ctx, "example", &ec2.CustomerGatewayArgs{
BgpAsn: pulumi.String("65000"),
IpAddress: pulumi.String("172.0.0.1"),
Type: pulumi.String("ipsec.1"),
})
if err != nil {
return err
}
_, err = ec2.NewVpnConnection(ctx, "example", &ec2.VpnConnectionArgs{
CustomerGatewayId: exampleCustomerGateway.ID().ToIDOutput().ToStringOutput(),
TransitGatewayId: example.ID().ToIDOutput().ToStringOutput(),
Type: exampleCustomerGateway.Type,
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_ec2transitgateway_transitgateway" "example" {
}
resource "aws_ec2_customergateway" "example" {
bgp_asn = 65000
ip_address = "172.0.0.1"
type = "ipsec.1"
}
resource "aws_ec2_vpnconnection" "example" {
customer_gateway_id = aws_ec2_customergateway.example.id
transit_gateway_id = aws_ec2transitgateway_transitgateway.example.id
type = aws_ec2_customergateway.example.type
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2transitgateway.TransitGateway;
import com.pulumi.aws.ec2.CustomerGateway;
import com.pulumi.aws.ec2.CustomerGatewayArgs;
import com.pulumi.aws.ec2.VpnConnection;
import com.pulumi.aws.ec2.VpnConnectionArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
var example = new TransitGateway("example");
var exampleCustomerGateway = new CustomerGateway("exampleCustomerGateway", CustomerGatewayArgs.builder()
.bgpAsn("65000")
.ipAddress("172.0.0.1")
.type("ipsec.1")
.build());
var exampleVpnConnection = new VpnConnection("exampleVpnConnection", VpnConnectionArgs.builder()
.customerGatewayId(exampleCustomerGateway.id())
.transitGatewayId(example.id())
.type(exampleCustomerGateway.type())
.build());
}
}
resources:
example:
type: aws:ec2transitgateway:TransitGateway
exampleCustomerGateway:
type: aws:ec2:CustomerGateway
name: example
properties:
bgpAsn: 65000
ipAddress: 172.0.0.1
type: ipsec.1
exampleVpnConnection:
type: aws:ec2:VpnConnection
name: example
properties:
customerGatewayId: ${exampleCustomerGateway.id}
transitGatewayId: ${example.id}
type: ${exampleCustomerGateway.type}
Virtual Private Gateway
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const vpc = new aws.ec2.Vpc("vpc", {cidrBlock: "10.0.0.0/16"});
const vpnGateway = new aws.ec2.VpnGateway("vpn_gateway", {vpcId: vpc.id});
const customerGateway = new aws.ec2.CustomerGateway("customer_gateway", {
bgpAsn: "65000",
ipAddress: "172.0.0.1",
type: "ipsec.1",
});
const main = new aws.ec2.VpnConnection("main", {
vpnGatewayId: vpnGateway.id,
customerGatewayId: customerGateway.id,
type: "ipsec.1",
staticRoutesOnly: true,
});
import pulumi
import pulumi_aws as aws
vpc = aws.ec2.Vpc("vpc", cidr_block="10.0.0.0/16")
vpn_gateway = aws.ec2.VpnGateway("vpn_gateway", vpc_id=vpc.id)
customer_gateway = aws.ec2.CustomerGateway("customer_gateway",
bgp_asn="65000",
ip_address="172.0.0.1",
type="ipsec.1")
main = aws.ec2.VpnConnection("main",
vpn_gateway_id=vpn_gateway.id,
customer_gateway_id=customer_gateway.id,
type="ipsec.1",
static_routes_only=True)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var vpc = new Aws.Ec2.Vpc("vpc", new()
{
CidrBlock = "10.0.0.0/16",
});
var vpnGateway = new Aws.Ec2.VpnGateway("vpn_gateway", new()
{
VpcId = vpc.Id,
});
var customerGateway = new Aws.Ec2.CustomerGateway("customer_gateway", new()
{
BgpAsn = "65000",
IpAddress = "172.0.0.1",
Type = "ipsec.1",
});
var main = new Aws.Ec2.VpnConnection("main", new()
{
VpnGatewayId = vpnGateway.Id,
CustomerGatewayId = customerGateway.Id,
Type = "ipsec.1",
StaticRoutesOnly = true,
});
});
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 {
vpc, err := ec2.NewVpc(ctx, "vpc", &ec2.VpcArgs{
CidrBlock: pulumi.String("10.0.0.0/16"),
})
if err != nil {
return err
}
vpnGateway, err := ec2.NewVpnGateway(ctx, "vpn_gateway", &ec2.VpnGatewayArgs{
VpcId: vpc.ID().ToIDOutput().ToStringOutput(),
})
if err != nil {
return err
}
customerGateway, err := ec2.NewCustomerGateway(ctx, "customer_gateway", &ec2.CustomerGatewayArgs{
BgpAsn: pulumi.String("65000"),
IpAddress: pulumi.String("172.0.0.1"),
Type: pulumi.String("ipsec.1"),
})
if err != nil {
return err
}
_, err = ec2.NewVpnConnection(ctx, "main", &ec2.VpnConnectionArgs{
VpnGatewayId: vpnGateway.ID().ToIDOutput().ToStringOutput(),
CustomerGatewayId: customerGateway.ID().ToIDOutput().ToStringOutput(),
Type: pulumi.String("ipsec.1"),
StaticRoutesOnly: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_ec2_vpc" "vpc" {
cidr_block = "10.0.0.0/16"
}
resource "aws_ec2_vpngateway" "vpn_gateway" {
vpc_id = aws_ec2_vpc.vpc.id
}
resource "aws_ec2_customergateway" "customer_gateway" {
bgp_asn = 65000
ip_address = "172.0.0.1"
type = "ipsec.1"
}
resource "aws_ec2_vpnconnection" "main" {
vpn_gateway_id = aws_ec2_vpngateway.vpn_gateway.id
customer_gateway_id = aws_ec2_customergateway.customer_gateway.id
type = "ipsec.1"
static_routes_only = true
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.Vpc;
import com.pulumi.aws.ec2.VpcArgs;
import com.pulumi.aws.ec2.VpnGateway;
import com.pulumi.aws.ec2.VpnGatewayArgs;
import com.pulumi.aws.ec2.CustomerGateway;
import com.pulumi.aws.ec2.CustomerGatewayArgs;
import com.pulumi.aws.ec2.VpnConnection;
import com.pulumi.aws.ec2.VpnConnectionArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
var vpc = new Vpc("vpc", VpcArgs.builder()
.cidrBlock("10.0.0.0/16")
.build());
var vpnGateway = new VpnGateway("vpnGateway", VpnGatewayArgs.builder()
.vpcId(vpc.id())
.build());
var customerGateway = new CustomerGateway("customerGateway", CustomerGatewayArgs.builder()
.bgpAsn("65000")
.ipAddress("172.0.0.1")
.type("ipsec.1")
.build());
var main = new VpnConnection("main", VpnConnectionArgs.builder()
.vpnGatewayId(vpnGateway.id())
.customerGatewayId(customerGateway.id())
.type("ipsec.1")
.staticRoutesOnly(true)
.build());
}
}
resources:
vpc:
type: aws:ec2:Vpc
properties:
cidrBlock: 10.0.0.0/16
vpnGateway:
type: aws:ec2:VpnGateway
name: vpn_gateway
properties:
vpcId: ${vpc.id}
customerGateway:
type: aws:ec2:CustomerGateway
name: customer_gateway
properties:
bgpAsn: 65000
ipAddress: 172.0.0.1
type: ipsec.1
main:
type: aws:ec2:VpnConnection
properties:
vpnGatewayId: ${vpnGateway.id}
customerGatewayId: ${customerGateway.id}
type: ipsec.1
staticRoutesOnly: true
AWS Site to Site Private VPN
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const exampleGateway = new aws.directconnect.Gateway("example", {
name: "example_ipsec_vpn_example",
amazonSideAsn: "64512",
});
const exampleTransitGateway = new aws.ec2transitgateway.TransitGateway("example", {
amazonSideAsn: 64513,
description: "example_ipsec_vpn_example",
transitGatewayCidrBlocks: ["10.0.0.0/24"],
});
const exampleCustomerGateway = new aws.ec2.CustomerGateway("example", {
bgpAsn: "64514",
ipAddress: "10.0.0.1",
type: "ipsec.1",
tags: {
Name: "example_ipsec_vpn_example",
},
});
const exampleGatewayAssociation = new aws.directconnect.GatewayAssociation("example", {
dxGatewayId: exampleGateway.id,
associatedGatewayId: exampleTransitGateway.id,
allowedPrefixes: ["10.0.0.0/8"],
});
const example = aws.ec2transitgateway.getDirectConnectGatewayAttachmentOutput({
transitGatewayId: exampleTransitGateway.id,
dxGatewayId: exampleGateway.id,
});
const exampleVpnConnection = new aws.ec2.VpnConnection("example", {
customerGatewayId: exampleCustomerGateway.id,
outsideIpAddressType: "PrivateIpv4",
transitGatewayId: exampleTransitGateway.id,
transportTransitGatewayAttachmentId: example.id,
type: "ipsec.1",
tags: {
Name: "example_ipsec_vpn_example",
},
});
import pulumi
import pulumi_aws as aws
example_gateway = aws.directconnect.Gateway("example",
name="example_ipsec_vpn_example",
amazon_side_asn="64512")
example_transit_gateway = aws.ec2transitgateway.TransitGateway("example",
amazon_side_asn=64513,
description="example_ipsec_vpn_example",
transit_gateway_cidr_blocks=["10.0.0.0/24"])
example_customer_gateway = aws.ec2.CustomerGateway("example",
bgp_asn="64514",
ip_address="10.0.0.1",
type="ipsec.1",
tags={
"Name": "example_ipsec_vpn_example",
})
example_gateway_association = aws.directconnect.GatewayAssociation("example",
dx_gateway_id=example_gateway.id,
associated_gateway_id=example_transit_gateway.id,
allowed_prefixes=["10.0.0.0/8"])
example = aws.ec2transitgateway.get_direct_connect_gateway_attachment_output(transit_gateway_id=example_transit_gateway.id,
dx_gateway_id=example_gateway.id)
example_vpn_connection = aws.ec2.VpnConnection("example",
customer_gateway_id=example_customer_gateway.id,
outside_ip_address_type="PrivateIpv4",
transit_gateway_id=example_transit_gateway.id,
transport_transit_gateway_attachment_id=example.id,
type="ipsec.1",
tags={
"Name": "example_ipsec_vpn_example",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var exampleGateway = new Aws.DirectConnect.Gateway("example", new()
{
Name = "example_ipsec_vpn_example",
AmazonSideAsn = "64512",
});
var exampleTransitGateway = new Aws.Ec2TransitGateway.TransitGateway("example", new()
{
AmazonSideAsn = 64513,
Description = "example_ipsec_vpn_example",
TransitGatewayCidrBlocks = new[]
{
"10.0.0.0/24",
},
});
var exampleCustomerGateway = new Aws.Ec2.CustomerGateway("example", new()
{
BgpAsn = "64514",
IpAddress = "10.0.0.1",
Type = "ipsec.1",
Tags =
{
{ "Name", "example_ipsec_vpn_example" },
},
});
var exampleGatewayAssociation = new Aws.DirectConnect.GatewayAssociation("example", new()
{
DxGatewayId = exampleGateway.Id,
AssociatedGatewayId = exampleTransitGateway.Id,
AllowedPrefixes = new[]
{
"10.0.0.0/8",
},
});
var example = Aws.Ec2TransitGateway.GetDirectConnectGatewayAttachment.Invoke(new()
{
TransitGatewayId = exampleTransitGateway.Id,
DxGatewayId = exampleGateway.Id,
});
var exampleVpnConnection = new Aws.Ec2.VpnConnection("example", new()
{
CustomerGatewayId = exampleCustomerGateway.Id,
OutsideIpAddressType = "PrivateIpv4",
TransitGatewayId = exampleTransitGateway.Id,
TransportTransitGatewayAttachmentId = example.Apply(getDirectConnectGatewayAttachmentResult => getDirectConnectGatewayAttachmentResult.Id),
Type = "ipsec.1",
Tags =
{
{ "Name", "example_ipsec_vpn_example" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/directconnect"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ec2"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ec2transitgateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleGateway, err := directconnect.NewGateway(ctx, "example", &directconnect.GatewayArgs{
Name: pulumi.String("example_ipsec_vpn_example"),
AmazonSideAsn: pulumi.String("64512"),
})
if err != nil {
return err
}
exampleTransitGateway, err := ec2transitgateway.NewTransitGateway(ctx, "example", &ec2transitgateway.TransitGatewayArgs{
AmazonSideAsn: pulumi.Int(64513),
Description: pulumi.String("example_ipsec_vpn_example"),
TransitGatewayCidrBlocks: pulumi.StringArray{
pulumi.String("10.0.0.0/24"),
},
})
if err != nil {
return err
}
exampleCustomerGateway, err := ec2.NewCustomerGateway(ctx, "example", &ec2.CustomerGatewayArgs{
BgpAsn: pulumi.String("64514"),
IpAddress: pulumi.String("10.0.0.1"),
Type: pulumi.String("ipsec.1"),
Tags: pulumi.StringMap{
"Name": pulumi.String("example_ipsec_vpn_example"),
},
})
if err != nil {
return err
}
_, err = directconnect.NewGatewayAssociation(ctx, "example", &directconnect.GatewayAssociationArgs{
DxGatewayId: exampleGateway.ID().ToIDOutput().ToStringOutput(),
AssociatedGatewayId: exampleTransitGateway.ID().ToIDOutput().ToStringOutput(),
AllowedPrefixes: pulumi.StringArray{
pulumi.String("10.0.0.0/8"),
},
})
if err != nil {
return err
}
example := ec2transitgateway.GetDirectConnectGatewayAttachmentOutput(ctx, ec2transitgateway.GetDirectConnectGatewayAttachmentOutputArgs{
TransitGatewayId: exampleTransitGateway.ID().ToIDOutput().ToStringOutput(),
DxGatewayId: exampleGateway.ID().ToIDOutput().ToStringOutput(),
}, nil)
_, err = ec2.NewVpnConnection(ctx, "example", &ec2.VpnConnectionArgs{
CustomerGatewayId: exampleCustomerGateway.ID().ToIDOutput().ToStringOutput(),
OutsideIpAddressType: pulumi.String("PrivateIpv4"),
TransitGatewayId: exampleTransitGateway.ID().ToIDOutput().ToStringOutput(),
TransportTransitGatewayAttachmentId: example.Id(),
Type: pulumi.String("ipsec.1"),
Tags: pulumi.StringMap{
"Name": pulumi.String("example_ipsec_vpn_example"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_ec2transitgateway_getdirectconnectgatewayattachment" "example" {
transit_gateway_id = aws_ec2transitgateway_transitgateway.example.id
dx_gateway_id = aws_directconnect_gateway.example.id
}
resource "aws_directconnect_gateway" "example" {
name = "example_ipsec_vpn_example"
amazon_side_asn = "64512"
}
resource "aws_ec2transitgateway_transitgateway" "example" {
amazon_side_asn = "64513"
description = "example_ipsec_vpn_example"
transit_gateway_cidr_blocks = ["10.0.0.0/24"]
}
resource "aws_ec2_customergateway" "example" {
bgp_asn = 64514
ip_address = "10.0.0.1"
type = "ipsec.1"
tags = {
"Name" = "example_ipsec_vpn_example"
}
}
resource "aws_directconnect_gatewayassociation" "example" {
dx_gateway_id = aws_directconnect_gateway.example.id
associated_gateway_id = aws_ec2transitgateway_transitgateway.example.id
allowed_prefixes = ["10.0.0.0/8"]
}
resource "aws_ec2_vpnconnection" "example" {
customer_gateway_id = aws_ec2_customergateway.example.id
outside_ip_address_type = "PrivateIpv4"
transit_gateway_id = aws_ec2transitgateway_transitgateway.example.id
transport_transit_gateway_attachment_id = data.aws_ec2transitgateway_getdirectconnectgatewayattachment.example.id
type = "ipsec.1"
tags = {
"Name" = "example_ipsec_vpn_example"
}
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.directconnect.Gateway;
import com.pulumi.aws.directconnect.GatewayArgs;
import com.pulumi.aws.ec2transitgateway.TransitGateway;
import com.pulumi.aws.ec2transitgateway.TransitGatewayArgs;
import com.pulumi.aws.ec2.CustomerGateway;
import com.pulumi.aws.ec2.CustomerGatewayArgs;
import com.pulumi.aws.directconnect.GatewayAssociation;
import com.pulumi.aws.directconnect.GatewayAssociationArgs;
import com.pulumi.aws.ec2transitgateway.Ec2transitgatewayFunctions;
import com.pulumi.aws.ec2transitgateway.inputs.GetDirectConnectGatewayAttachmentArgs;
import com.pulumi.aws.ec2.VpnConnection;
import com.pulumi.aws.ec2.VpnConnectionArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
var exampleGateway = new Gateway("exampleGateway", GatewayArgs.builder()
.name("example_ipsec_vpn_example")
.amazonSideAsn("64512")
.build());
var exampleTransitGateway = new TransitGateway("exampleTransitGateway", TransitGatewayArgs.builder()
.amazonSideAsn(64513)
.description("example_ipsec_vpn_example")
.transitGatewayCidrBlocks("10.0.0.0/24")
.build());
var exampleCustomerGateway = new CustomerGateway("exampleCustomerGateway", CustomerGatewayArgs.builder()
.bgpAsn("64514")
.ipAddress("10.0.0.1")
.type("ipsec.1")
.tags(Map.of("Name", "example_ipsec_vpn_example"))
.build());
var exampleGatewayAssociation = new GatewayAssociation("exampleGatewayAssociation", GatewayAssociationArgs.builder()
.dxGatewayId(exampleGateway.id())
.associatedGatewayId(exampleTransitGateway.id())
.allowedPrefixes("10.0.0.0/8")
.build());
final var example = Ec2transitgatewayFunctions.getDirectConnectGatewayAttachment(GetDirectConnectGatewayAttachmentArgs.builder()
.transitGatewayId(exampleTransitGateway.id())
.dxGatewayId(exampleGateway.id())
.build());
var exampleVpnConnection = new VpnConnection("exampleVpnConnection", VpnConnectionArgs.builder()
.customerGatewayId(exampleCustomerGateway.id())
.outsideIpAddressType("PrivateIpv4")
.transitGatewayId(exampleTransitGateway.id())
.transportTransitGatewayAttachmentId(example.applyValue(_example -> _example.id()))
.type("ipsec.1")
.tags(Map.of("Name", "example_ipsec_vpn_example"))
.build());
}
}
resources:
exampleGateway:
type: aws:directconnect:Gateway
name: example
properties:
name: example_ipsec_vpn_example
amazonSideAsn: '64512'
exampleTransitGateway:
type: aws:ec2transitgateway:TransitGateway
name: example
properties:
amazonSideAsn: '64513'
description: example_ipsec_vpn_example
transitGatewayCidrBlocks:
- 10.0.0.0/24
exampleCustomerGateway:
type: aws:ec2:CustomerGateway
name: example
properties:
bgpAsn: 64514
ipAddress: 10.0.0.1
type: ipsec.1
tags:
Name: example_ipsec_vpn_example
exampleGatewayAssociation:
type: aws:directconnect:GatewayAssociation
name: example
properties:
dxGatewayId: ${exampleGateway.id}
associatedGatewayId: ${exampleTransitGateway.id}
allowedPrefixes:
- 10.0.0.0/8
exampleVpnConnection:
type: aws:ec2:VpnConnection
name: example
properties:
customerGatewayId: ${exampleCustomerGateway.id}
outsideIpAddressType: PrivateIpv4
transitGatewayId: ${exampleTransitGateway.id}
transportTransitGatewayAttachmentId: ${example.id}
type: ipsec.1
tags:
Name: example_ipsec_vpn_example
variables:
example:
fn::invoke:
function: aws:ec2transitgateway:getDirectConnectGatewayAttachment
arguments:
transitGatewayId: ${exampleTransitGateway.id}
dxGatewayId: ${exampleGateway.id}
Import
Using pulumi import, import VPN Connections using the VPN connection id. For example:
$ pulumi import aws:ec2/vpnConnection:VpnConnection testvpnconnection vpn-40f41529
Constructors
- VpnConnection(String name, {VpnConnectionArgs? args, CustomResourceOptions? options})
-
Creates a new VpnConnection.
nameThe Pulumi resource name.argsArguments used to configure this VpnConnection. The set of arguments for VpnConnection.optionsResource options controlling this resource's behavior. - VpnConnection.reference(String urn)
- Creates a typed reference to an existing VpnConnection resource.
Properties
-
arn
↔ Output<
String> -
ARN of the VPN Connection.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
coreNetworkArn
↔ Output<
String> -
The ARN of the core network.
latefinal
-
coreNetworkAttachmentArn
↔ Output<
String> -
The ARN of the core network attachment.
latefinal
-
customerGatewayConfiguration
↔ Output<
String> -
The configuration information for the VPN connection's customer gateway (in the native XML format).
latefinal
-
customerGatewayId
↔ Output<
String> -
The ID of the customer gateway.
latefinal
-
enableAcceleration
↔ Output<
bool> -
Indicate whether to enable acceleration for the VPN connection. Supports only EC2 Transit Gateway.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
localIpv4NetworkCidr
↔ Output<
String> -
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
latefinal
-
localIpv6NetworkCidr
↔ Output<
String> -
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
latefinal
-
outsideIpAddressType
↔ Output<
String> -
Indicates if a Public S2S VPN or Private S2S VPN over AWS Direct Connect. Valid values are
PublicIpv4 | PrivateIpv4latefinal -
ARN of the Secrets Manager secret storing the pre-shared key(s) for the VPN connection. Note that even if it returns a valid Secrets Manager ARN, the pre-shared key(s) will not be stored in Secrets Manager unless the
presharedKeyStorageargument is set toSecretsManager.latefinal -
Storage mode for the pre-shared key (PSK). Valid values are
Standard(stored in the Site-to-Site VPN service) orSecretsManager(stored in AWS Secrets Manager).latefinal -
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
remoteIpv4NetworkCidr
↔ Output<
String> -
The IPv4 CIDR on the AWS side of the VPN connection.
latefinal
-
remoteIpv6NetworkCidr
↔ Output<
String> -
The IPv6 CIDR on the AWS side of the VPN connection.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
-
routes
↔ Output<
List< VpnConnectionRoute> > -
The static routes associated with the VPN connection. Detailed below.
latefinal
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
staticRoutesOnly
↔ Output<
bool> -
Whether the VPN connection uses static routes exclusively. Static routes must be used for devices that don't support BGP.
latefinal
-
Tags to apply to the connection. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
transitGatewayAttachmentId
↔ Output<
String> -
When associated with an EC2 Transit Gateway (
transitGatewayIdargument), the attachment ID. See also theaws.ec2.Tagresource for tagging the EC2 Transit Gateway VPN Attachment.latefinal -
transitGatewayId
↔ Output<
String?> -
The ID of the EC2 Transit Gateway.
latefinal
-
transportTransitGatewayAttachmentId
↔ Output<
String?> -
. The attachment ID of the Transit Gateway attachment to Direct Connect Gateway. The ID is obtained through a data source only.
latefinal
-
tunnel1Address
↔ Output<
String> -
The public IP address of the first VPN tunnel.
latefinal
-
tunnel1BgpAsn
↔ Output<
String> -
The bgp asn number of the first VPN tunnel.
latefinal
-
tunnel1BgpHoldtime
↔ Output<
int> -
The bgp holdtime of the first VPN tunnel.
latefinal
-
tunnel1CgwInsideAddress
↔ Output<
String> -
The RFC 6890 link-local address of the first VPN tunnel (Customer Gateway Side).
latefinal
-
tunnel1DpdTimeoutAction
↔ Output<
String?> -
The action to take after DPD timeout occurs for the first VPN tunnel. Specify restart to restart the IKE initiation. Specify clear to end the IKE session. Valid values are
clear | none | restart.latefinal -
tunnel1DpdTimeoutSeconds
↔ Output<
int?> -
The number of seconds after which a DPD timeout occurs for the first VPN tunnel. Valid value is equal or higher than
30.latefinal -
tunnel1EnableTunnelLifecycleControl
↔ Output<
bool?> -
Turn on or off tunnel endpoint lifecycle control feature for the first VPN tunnel. Valid values are
true | false.latefinal -
tunnel1IkeVersions
↔ Output<
List< String> ?> -
The IKE versions that are permitted for the first VPN tunnel. Valid values are
ikev1 | ikev2.latefinal -
tunnel1InsideCidr
↔ Output<
String> -
The CIDR block of the inside IP addresses for the first VPN tunnel. Valid value is a size /30 CIDR block from the 169.254.0.0/16 range.
latefinal
-
tunnel1InsideIpv6Cidr
↔ Output<
String> -
The range of inside IPv6 addresses for the first VPN tunnel. Supports only EC2 Transit Gateway. Valid value is a size /126 CIDR block from the local fd00::/8 range.
latefinal
-
tunnel1LogOptions
↔ Output<
VpnConnectionTunnel1LogOptions> -
Options for logging VPN tunnel activity. See Log Options below for more details.
latefinal
-
tunnel1Phase1DhGroupNumbers
↔ Output<
List< int> ?> -
List of one or more Diffie-Hellman group numbers that are permitted for the first VPN tunnel for phase 1 IKE negotiations. Valid values are
2 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24.latefinal -
tunnel1Phase1EncryptionAlgorithms
↔ Output<
List< String> ?> -
List of one or more encryption algorithms that are permitted for the first VPN tunnel for phase 1 IKE negotiations. Valid values are
AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16.latefinal -
tunnel1Phase1IntegrityAlgorithms
↔ Output<
List< String> ?> -
One or more integrity algorithms that are permitted for the first VPN tunnel for phase 1 IKE negotiations. Valid values are
SHA1 | SHA2-256 | SHA2-384 | SHA2-512.latefinal -
tunnel1Phase1LifetimeSeconds
↔ Output<
int?> -
The lifetime for phase 1 of the IKE negotiation for the first VPN tunnel, in seconds. Valid value is between
900and28800.latefinal -
tunnel1Phase2DhGroupNumbers
↔ Output<
List< int> ?> -
List of one or more Diffie-Hellman group numbers that are permitted for the first VPN tunnel for phase 2 IKE negotiations. Valid values are
2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24.latefinal -
tunnel1Phase2EncryptionAlgorithms
↔ Output<
List< String> ?> -
List of one or more encryption algorithms that are permitted for the first VPN tunnel for phase 2 IKE negotiations. Valid values are
AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16.latefinal -
tunnel1Phase2IntegrityAlgorithms
↔ Output<
List< String> ?> -
List of one or more integrity algorithms that are permitted for the first VPN tunnel for phase 2 IKE negotiations. Valid values are
SHA1 | SHA2-256 | SHA2-384 | SHA2-512.latefinal -
tunnel1Phase2LifetimeSeconds
↔ Output<
int?> -
The lifetime for phase 2 of the IKE negotiation for the first VPN tunnel, in seconds. Valid value is between
900and3600.latefinal -
The preshared key of the first VPN tunnel. The preshared key must be between 8 and 64 characters in length and cannot start with zero(0). Allowed characters are alphanumeric characters, periods(.) and underscores(_).
latefinal
-
tunnel1RekeyFuzzPercentage
↔ Output<
int?> -
The percentage of the rekey window for the first VPN tunnel (determined by
tunnel1RekeyMarginTimeSeconds) during which the rekey time is randomly selected. Valid value is between0and100.latefinal -
tunnel1RekeyMarginTimeSeconds
↔ Output<
int?> -
The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the first VPN connection performs an IKE rekey. The exact time of the rekey is randomly selected based on the value for
tunnel1RekeyFuzzPercentage. Valid value is between60and half oftunnel1Phase2LifetimeSeconds.latefinal -
tunnel1ReplayWindowSize
↔ Output<
int?> -
The number of packets in an IKE replay window for the first VPN tunnel. Valid value is between
64and2048.latefinal -
tunnel1StartupAction
↔ Output<
String?> -
The action to take when the establishing the tunnel for the first VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify start for AWS to initiate the IKE negotiation. Valid values are
add | start.latefinal -
tunnel1VgwInsideAddress
↔ Output<
String> -
The RFC 6890 link-local address of the first VPN tunnel (VPN Gateway Side).
latefinal
-
tunnel2Address
↔ Output<
String> -
The public IP address of the second VPN tunnel.
latefinal
-
tunnel2BgpAsn
↔ Output<
String> -
The bgp asn number of the second VPN tunnel.
latefinal
-
tunnel2BgpHoldtime
↔ Output<
int> -
The bgp holdtime of the second VPN tunnel.
latefinal
-
tunnel2CgwInsideAddress
↔ Output<
String> -
The RFC 6890 link-local address of the second VPN tunnel (Customer Gateway Side).
latefinal
-
tunnel2DpdTimeoutAction
↔ Output<
String?> -
The action to take after DPD timeout occurs for the second VPN tunnel. Specify restart to restart the IKE initiation. Specify clear to end the IKE session. Valid values are
clear | none | restart.latefinal -
tunnel2DpdTimeoutSeconds
↔ Output<
int?> -
The number of seconds after which a DPD timeout occurs for the second VPN tunnel. Valid value is equal or higher than
30.latefinal -
tunnel2EnableTunnelLifecycleControl
↔ Output<
bool?> -
Turn on or off tunnel endpoint lifecycle control feature for the second VPN tunnel. Valid values are
true | false.latefinal -
tunnel2IkeVersions
↔ Output<
List< String> ?> -
The IKE versions that are permitted for the second VPN tunnel. Valid values are
ikev1 | ikev2.latefinal -
tunnel2InsideCidr
↔ Output<
String> -
The CIDR block of the inside IP addresses for the second VPN tunnel. Valid value is a size /30 CIDR block from the 169.254.0.0/16 range.
latefinal
-
tunnel2InsideIpv6Cidr
↔ Output<
String> -
The range of inside IPv6 addresses for the second VPN tunnel. Supports only EC2 Transit Gateway. Valid value is a size /126 CIDR block from the local fd00::/8 range.
latefinal
-
tunnel2LogOptions
↔ Output<
VpnConnectionTunnel2LogOptions> -
Options for logging VPN tunnel activity. See Log Options below for more details.
latefinal
-
tunnel2Phase1DhGroupNumbers
↔ Output<
List< int> ?> -
List of one or more Diffie-Hellman group numbers that are permitted for the second VPN tunnel for phase 1 IKE negotiations. Valid values are
2 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24.latefinal -
tunnel2Phase1EncryptionAlgorithms
↔ Output<
List< String> ?> -
List of one or more encryption algorithms that are permitted for the second VPN tunnel for phase 1 IKE negotiations. Valid values are
AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16.latefinal -
tunnel2Phase1IntegrityAlgorithms
↔ Output<
List< String> ?> -
One or more integrity algorithms that are permitted for the second VPN tunnel for phase 1 IKE negotiations. Valid values are
SHA1 | SHA2-256 | SHA2-384 | SHA2-512.latefinal -
tunnel2Phase1LifetimeSeconds
↔ Output<
int?> -
The lifetime for phase 1 of the IKE negotiation for the second VPN tunnel, in seconds. Valid value is between
900and28800.latefinal -
tunnel2Phase2DhGroupNumbers
↔ Output<
List< int> ?> -
List of one or more Diffie-Hellman group numbers that are permitted for the second VPN tunnel for phase 2 IKE negotiations. Valid values are
2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24.latefinal -
tunnel2Phase2EncryptionAlgorithms
↔ Output<
List< String> ?> -
List of one or more encryption algorithms that are permitted for the second VPN tunnel for phase 2 IKE negotiations. Valid values are
AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16.latefinal -
tunnel2Phase2IntegrityAlgorithms
↔ Output<
List< String> ?> -
List of one or more integrity algorithms that are permitted for the second VPN tunnel for phase 2 IKE negotiations. Valid values are
SHA1 | SHA2-256 | SHA2-384 | SHA2-512.latefinal -
tunnel2Phase2LifetimeSeconds
↔ Output<
int?> -
The lifetime for phase 2 of the IKE negotiation for the second VPN tunnel, in seconds. Valid value is between
900and3600.latefinal -
The preshared key of the second VPN tunnel. The preshared key must be between 8 and 64 characters in length and cannot start with zero(0). Allowed characters are alphanumeric characters, periods(.) and underscores(_).
latefinal
-
tunnel2RekeyFuzzPercentage
↔ Output<
int?> -
The percentage of the rekey window for the second VPN tunnel (determined by
tunnel2RekeyMarginTimeSeconds) during which the rekey time is randomly selected. Valid value is between0and100.latefinal -
tunnel2RekeyMarginTimeSeconds
↔ Output<
int?> -
The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the second VPN connection performs an IKE rekey. The exact time of the rekey is randomly selected based on the value for
tunnel2RekeyFuzzPercentage. Valid value is between60and half oftunnel2Phase2LifetimeSeconds.latefinal -
tunnel2ReplayWindowSize
↔ Output<
int?> -
The number of packets in an IKE replay window for the second VPN tunnel. Valid value is between
64and2048.latefinal -
tunnel2StartupAction
↔ Output<
String?> -
The action to take when the establishing the tunnel for the second VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify start for AWS to initiate the IKE negotiation. Valid values are
add | start.latefinal -
tunnel2VgwInsideAddress
↔ Output<
String> -
The RFC 6890 link-local address of the second VPN tunnel (VPN Gateway Side).
latefinal
-
tunnelBandwidth
↔ Output<
String> -
Desired bandwidth specification for the VPN tunnel. Valid values are
standard | large.standardsupports up to 1.25 Gbps per tunnel, whilelargesupports up to 5 Gbps per tunnel. Not supported whenvpnGatewayIdis specified, orenableAccelerationistrue.latefinal -
tunnelInsideIpVersion
↔ Output<
String> -
Indicate whether the VPN tunnels process IPv4 or IPv6 traffic. Valid values are
ipv4 | ipv6.ipv6Supports only EC2 Transit Gateway.latefinal -
type
↔ Output<
String> -
The type of VPN connection. The only type AWS supports at this time is "ipsec.1".
latefinal
-
urn
↔ Output<
String> -
latefinalinherited
-
vgwTelemetries
↔ Output<
List< VpnConnectionVgwTelemetry> > -
Telemetry for the VPN tunnels. Detailed below.
latefinal
-
vpnConcentratorId
↔ Output<
String?> -
ID of the VPN concentrator to associate with the VPN connection.
latefinal
-
vpnGatewayId
↔ Output<
String?> -
The ID of the Virtual Private Gateway.
latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {VpnConnectionState? state, CustomResourceOptions? options}) → VpnConnection -
Gets an existing VpnConnection resource's state with the given
nameandid.