Skip to content

VpnConnectionProps

Properties for defining a VpnConnection.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-vpc-vpnconnection

Initializer 

import { VpnConnectionProps } from '@alicloud/ros-cdk-vpc'
const vpnConnectionProps: VpnConnectionProps = { ... }

Properties

Name Type Description
localSubnet string | @alicloud/ros-cdk-core.IResolvable Property localSubnet: A network segment on the VPC side that needs to be interconnected with the local IDC for the second phase negotiation.
remoteSubnet string | @alicloud/ros-cdk-core.IResolvable Property remoteSubnet: The network segment of the local IDC is used for the second phase negotiation.
vpnGatewayId string | @alicloud/ros-cdk-core.IResolvable Property vpnGatewayId: ID of the VPN gateway.
autoConfigRoute boolean | @alicloud/ros-cdk-core.IResolvable Property autoConfigRoute: Specifies whether to automatically configure routes.
bgpConfig @alicloud/ros-cdk-core.IResolvable | BgpConfigProperty Property bgpConfig: The Border Gateway Protocol (BGP) configuration.
customerGatewayId string | @alicloud/ros-cdk-core.IResolvable Property customerGatewayId: The ID of the user gateway.
effectImmediately boolean | @alicloud/ros-cdk-core.IResolvable Property effectImmediately: Whether to delete the currently negotiated IPsec tunnel and re-initiate the negotiation.
enableDpd boolean | @alicloud/ros-cdk-core.IResolvable Property enableDpd: Specifies whether to enable the dead peer detection (DPD) feature.
enableNatTraversal boolean | @alicloud/ros-cdk-core.IResolvable Property enableNatTraversal: Specifies whether to enable NAT traversal.
enableTunnelsBgp boolean | @alicloud/ros-cdk-core.IResolvable Property enableTunnelsBgp: Specifies whether to enable the BGP feature for the tunnel.
healthCheckConfig @alicloud/ros-cdk-core.IResolvable | HealthCheckConfigProperty Property healthCheckConfig: Whether to enable the health check configuration.
ikeConfig @alicloud/ros-cdk-core.IResolvable | IkeConfigProperty Property ikeConfig: Configuration information for the first phase of negotiation.
ipsecConfig @alicloud/ros-cdk-core.IResolvable | IpsecConfigProperty Property ipsecConfig: Configuration information for the second phase negotiation.
name string | @alicloud/ros-cdk-core.IResolvable Property name: The name of the IPsec connection.
remoteCaCertificate string | @alicloud/ros-cdk-core.IResolvable Property remoteCaCertificate: The peer CA certificate when a ShangMi (SM) VPN gateway is used to establish the IPsec-VPN connection.
tunnelOptionsSpecification @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | TunnelOptionsSpecificationProperty[] Property tunnelOptionsSpecification: TunnelOptionsSpecification parameters are supported by dual-tunnel IPsec-VPN gateways.

localSubnetRequired 

public readonly localSubnet: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property localSubnet: A network segment on the VPC side that needs to be interconnected with the local IDC for the second phase negotiation.

Multiple network segments are separated by commas, for example: 192.168.1.0\/24, 192.168.2.0\/24.

remoteSubnetRequired 

public readonly remoteSubnet: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property remoteSubnet: The network segment of the local IDC is used for the second phase negotiation.

Multiple network segments are separated by commas, for example: 192.168.3.0\/24, 192.168.4.0\/24.

vpnGatewayIdRequired 

public readonly vpnGatewayId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vpnGatewayId: ID of the VPN gateway.

autoConfigRouteOptional 

public readonly autoConfigRoute: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property autoConfigRoute: Specifies whether to automatically configure routes.

Valid values: true (default) false

bgpConfigOptional 

public readonly bgpConfig: IResolvable | BgpConfigProperty;

Property bgpConfig: The Border Gateway Protocol (BGP) configuration.

This parameter is required when the VPN gateway has dynamic BGP enabled. Before you configure BGP, we recommend that you learn about how BGP works and its limits. For more information, see VPN Gateway supports BGP dynamic routing. We recommend that you use a private ASN to establish a connection with Alibaba Cloud over BGP. Refer to the relevant documentation for the private ASN range.

customerGatewayIdOptional 

public readonly customerGatewayId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property customerGatewayId: The ID of the user gateway.

effectImmediatelyOptional 

public readonly effectImmediately: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property effectImmediately: Whether to delete the currently negotiated IPsec tunnel and re-initiate the negotiation.

Value: True: Negotiate immediately after the configuration is complete. False (default): Negotiate when traffic enters.

enableDpdOptional 

public readonly enableDpd: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property enableDpd: Specifies whether to enable the dead peer detection (DPD) feature.

Valid values: true (default) The initiator of the IPsec-VPN connection sends DPD packets to verify the existence and availability of the peer. If no response is received from the peer within a specified period of time, the connection fails. ISAKMP SAs and IPsec SAs are deleted. The IPsec tunnel is also deleted. false: disables DPD. The IPsec initiator does not send DPD packets.

enableNatTraversalOptional 

public readonly enableNatTraversal: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property enableNatTraversal: Specifies whether to enable NAT traversal.

Valid values: true (default) After NAT traversal is enabled, the initiator does not check the UDP ports during IKE negotiations and can automatically discover NAT gateway devices along the VPN tunnel. false

enableTunnelsBgpOptional 

public readonly enableTunnelsBgp: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property enableTunnelsBgp: Specifies whether to enable the BGP feature for the tunnel.

Valid values: true and false. Default value: false.

healthCheckConfigOptional 

public readonly healthCheckConfig: IResolvable | HealthCheckConfigProperty;

Property healthCheckConfig: Whether to enable the health check configuration.

ikeConfigOptional 

public readonly ikeConfig: IResolvable | IkeConfigProperty;

Property ikeConfig: Configuration information for the first phase of negotiation.

ipsecConfigOptional 

public readonly ipsecConfig: IResolvable | IpsecConfigProperty;

Property ipsecConfig: Configuration information for the second phase negotiation.

nameOptional 

public readonly name: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property name: The name of the IPsec connection.

The length is 2-128 characters and must start with a letter or Chinese. It can contain numbers, periods (.), underscores (_) and dashes (-), but cannot start with http:\/\/ or https:\/\/ .

remoteCaCertificateOptional 

public readonly remoteCaCertificate: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property remoteCaCertificate: The peer CA certificate when a ShangMi (SM) VPN gateway is used to establish the IPsec-VPN connection.

This parameter is required when an SM VPN gateway is used to establish the IPsec-VPN connection. You can ignore this parameter when a standard VPN gateway is used to create the IPsec-VPN connection.

tunnelOptionsSpecificationOptional 

public readonly tunnelOptionsSpecification: IResolvable | IResolvable | TunnelOptionsSpecificationProperty[];

Property tunnelOptionsSpecification: TunnelOptionsSpecification parameters are supported by dual-tunnel IPsec-VPN gateways.

You can modify both the active and standby tunnels of the IPsec-VPN connection.