interface CfnVPNConnectionProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.EC2.CfnVPNConnectionProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsec2#CfnVPNConnectionProps |
![]() | software.amazon.awscdk.services.ec2.CfnVPNConnectionProps |
![]() | aws_cdk.aws_ec2.CfnVPNConnectionProps |
![]() | aws-cdk-lib » aws_ec2 » CfnVPNConnectionProps |
Properties for defining a CfnVPNConnection
.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html
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
enableAcceleration: false,
localIpv4NetworkCidr: 'localIpv4NetworkCidr',
localIpv6NetworkCidr: 'localIpv6NetworkCidr',
outsideIpAddressType: 'outsideIpAddressType',
remoteIpv4NetworkCidr: 'remoteIpv4NetworkCidr',
remoteIpv6NetworkCidr: 'remoteIpv6NetworkCidr',
staticRoutesOnly: false,
tags: [{
key: 'key',
value: 'value',
}],
transitGatewayId: 'transitGatewayId',
transportTransitGatewayAttachmentId: 'transportTransitGatewayAttachmentId',
tunnelInsideIpVersion: 'tunnelInsideIpVersion',
vpnGatewayId: 'vpnGatewayId',
vpnTunnelOptionsSpecifications: [{
dpdTimeoutAction: 'dpdTimeoutAction',
dpdTimeoutSeconds: 123,
enableTunnelLifecycleControl: false,
ikeVersions: [{
value: 'value',
}],
logOptions: {
cloudwatchLogOptions: {
logEnabled: false,
logGroupArn: 'logGroupArn',
logOutputFormat: 'logOutputFormat',
},
},
phase1DhGroupNumbers: [{
value: 123,
}],
phase1EncryptionAlgorithms: [{
value: 'value',
}],
phase1IntegrityAlgorithms: [{
value: 'value',
}],
phase1LifetimeSeconds: 123,
phase2DhGroupNumbers: [{
value: 123,
}],
phase2EncryptionAlgorithms: [{
value: 'value',
}],
phase2IntegrityAlgorithms: [{
value: 'value',
}],
phase2LifetimeSeconds: 123,
preSharedKey: 'preSharedKey',
rekeyFuzzPercentage: 123,
rekeyMarginTimeSeconds: 123,
replayWindowSize: 123,
startupAction: 'startupAction',
tunnelInsideCidr: 'tunnelInsideCidr',
tunnelInsideIpv6Cidr: 'tunnelInsideIpv6Cidr',
}],
};
Properties
Name | Type | Description |
---|---|---|
customer | string | The ID of the customer gateway at your end of the VPN connection. |
type | string | The type of VPN connection. |
enable | boolean | IResolvable | Indicate whether to enable acceleration for the VPN connection. |
local | string | The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection. |
local | string | The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection. |
outside | string | The type of IPv4 address assigned to the outside interface of the customer gateway device. |
remote | string | The IPv4 CIDR on the AWS side of the VPN connection. |
remote | string | The IPv6 CIDR on the AWS side of the VPN connection. |
static | boolean | IResolvable | Indicates whether the VPN connection uses static routes only. |
tags? | Cfn [] | Any tags assigned to the VPN connection. |
transit | string | The ID of the transit gateway associated with the VPN connection. |
transport | string | The transit gateway attachment ID to use for the VPN tunnel. |
tunnel | string | Indicate whether the VPN tunnels process IPv4 or IPv6 traffic. |
vpn | string | The ID of the virtual private gateway at the AWS side of the VPN connection. |
vpn | IResolvable | IResolvable | Vpn [] | 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.
enableAcceleration?
Type:
boolean |
IResolvable
(optional)
Indicate whether to enable acceleration for the VPN connection.
Default: false
localIpv4NetworkCidr?
Type:
string
(optional)
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: 0.0.0.0/0
localIpv6NetworkCidr?
Type:
string
(optional)
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: ::/0
outsideIpAddressType?
Type:
string
(optional)
The type of IPv4 address assigned to the outside interface of the customer gateway device.
Valid values: PrivateIpv4
| PublicIpv4
Default: PublicIpv4
remoteIpv4NetworkCidr?
Type:
string
(optional)
The IPv4 CIDR on the AWS side of the VPN connection.
Default: 0.0.0.0/0
remoteIpv6NetworkCidr?
Type:
string
(optional)
The IPv6 CIDR on the AWS side of the VPN connection.
Default: ::/0
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:
Cfn
[]
(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.
transportTransitGatewayAttachmentId?
Type:
string
(optional)
The transit gateway attachment ID to use for the VPN tunnel.
Required if OutsideIpAddressType
is set to PrivateIpv4
.
tunnelInsideIpVersion?
Type:
string
(optional)
Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.
Default: ipv4
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
|
Vpn
[]
(optional)
The tunnel options for the VPN connection.