aws-cdk-lib.aws_ec2.CfnVPNConnectionProps

interface CfnVPNConnectionProps

LanguageType name
.NETAmazon.CDK.AWS.EC2.CfnVPNConnectionProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsec2#CfnVPNConnectionProps
Javasoftware.amazon.awscdk.services.ec2.CfnVPNConnectionProps
Pythonaws_cdk.aws_ec2.CfnVPNConnectionProps
TypeScript aws-cdk-lib » aws_ec2 » CfnVPNConnectionProps

Properties for defining a CfnVPNConnection.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
const cfnVPNConnectionProps: ec2.CfnVPNConnectionProps = {
  customerGatewayId: 'customerGatewayId',
  type: 'type',

  // the properties below are optional
  staticRoutesOnly: false,
  tags: [{
    key: 'key',
    value: 'value',
  }],
  transitGatewayId: 'transitGatewayId',
  vpnGatewayId: 'vpnGatewayId',
  vpnTunnelOptionsSpecifications: [{
    preSharedKey: 'preSharedKey',
    tunnelInsideCidr: 'tunnelInsideCidr',
  }],
};

Properties

NameTypeDescription
customerGatewayIdstringThe ID of the customer gateway at your end of the VPN connection.
typestringThe type of VPN connection.
staticRoutesOnly?boolean | IResolvableIndicates whether the VPN connection uses static routes only.
tags?CfnTag[]Any tags assigned to the VPN connection.
transitGatewayId?stringThe ID of the transit gateway associated with the VPN connection.
vpnGatewayId?stringThe ID of the virtual private gateway at the AWS side of the VPN connection.
vpnTunnelOptionsSpecifications?IResolvable | IResolvable | VpnTunnelOptionsSpecificationProperty[]The tunnel options for the VPN connection.

customerGatewayId

Type: string

The ID of the customer gateway at your end of the VPN connection.


type

Type: string

The type of VPN connection.


staticRoutesOnly?

Type: boolean | IResolvable (optional)

Indicates whether the VPN connection uses static routes only.

Static routes must be used for devices that don't support BGP.

If you are creating a VPN connection for a device that does not support Border Gateway Protocol (BGP), you must specify true .


tags?

Type: CfnTag[] (optional)

Any tags assigned to the VPN connection.


transitGatewayId?

Type: string (optional)

The ID of the transit gateway associated with the VPN connection.

You must specify either TransitGatewayId or VpnGatewayId , but not both.


vpnGatewayId?

Type: string (optional)

The ID of the virtual private gateway at the AWS side of the VPN connection.

You must specify either TransitGatewayId or VpnGatewayId , but not both.


vpnTunnelOptionsSpecifications?

Type: IResolvable | IResolvable | VpnTunnelOptionsSpecificationProperty[] (optional)

The tunnel options for the VPN connection.