Skip to content
v2.275.0

Experimental

@aws-cdk/aws-ec2-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

VPNGatewayV2Props Struct ​

Properties to define a VPN gateway.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as ec2_alpha from '@aws-cdk/aws-ec2-alpha';
import { aws_ec2 as ec2 } from 'aws-cdk-lib';

declare const subnet: ec2.Subnet;
declare const subnetFilter: ec2.SubnetFilter;
declare const vpcV2: ec2_alpha.VpcV2;
const vPNGatewayV2Props: ec2_alpha.VPNGatewayV2Props = {
  type: ec2.VpnConnectionType.IPSEC_1,
  vpc: vpcV2,

  // the properties below are optional
  amazonSideAsn: 123,
  vpnGatewayName: 'vpnGatewayName',
  vpnRoutePropagation: [{
    availabilityZones: ['availabilityZones'],
    onePerAz: false,
    subnetFilters: [subnetFilter],
    subnetGroupName: 'subnetGroupName',
    subnets: [subnet],
    subnetType: ec2.SubnetType.PRIVATE_ISOLATED,
  }],
};

Properties ​

amazonSideAsnoptionalnumberamazon_side_asnoptionalint | floatamazonSideAsnoptionalNumberAmazonSideAsnoptionaldoubleAmazonSideAsnoptional*float64#
The private Autonomous System Number (ASN) for the Amazon side of a BGP session.

Default: no ASN set for BGP session

The type of VPN connection the virtual private gateway supports.
vpcIVpcV2vpcIVpcV2vpcIVpcV2VpcIVpcV2VpcIVpcV2required#
The ID of the VPC for which to create the VPN gateway.
vpnGatewayNameoptionalstringvpn_gateway_nameoptionalstrvpnGatewayNameoptionalStringVpnGatewayNameoptionalstringVpnGatewayNameoptional*string#
The resource name of the VPN gateway.

Default: resource provisioned without any name

vpnRoutePropagationoptionalSubnetSelection[]vpn_route_propagationoptionaltyping.List[SubnetSelection]vpnRoutePropagationoptionalList<SubnetSelection>VpnRoutePropagationoptionalSubnetSelection[]VpnRoutePropagationoptional*[]SubnetSelection#
Subnets where the route propagation should be added.

Default: no propagation for routes