Skip to content

VpnConnectionProps

Properties for defining a VpnConnection.

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

Initializer 

import ros_cdk_vpc
ros_cdk_vpc.VpnConnectionProps(
  local_subnet: typing.Union[str, IResolvable],
  remote_subnet: typing.Union[str, IResolvable],
  vpn_gateway_id: typing.Union[str, IResolvable],
  auto_config_route: typing.Union[bool, IResolvable] = None,
  bgp_config: typing.Union[IResolvable, BgpConfigProperty] = None,
  customer_gateway_id: typing.Union[str, IResolvable] = None,
  effect_immediately: typing.Union[bool, IResolvable] = None,
  enable_dpd: typing.Union[bool, IResolvable] = None,
  enable_nat_traversal: typing.Union[bool, IResolvable] = None,
  enable_tunnels_bgp: typing.Union[bool, IResolvable] = None,
  health_check_config: typing.Union[IResolvable, HealthCheckConfigProperty] = None,
  ike_config: typing.Union[IResolvable, IkeConfigProperty] = None,
  ipsec_config: typing.Union[IResolvable, IpsecConfigProperty] = None,
  name: typing.Union[str, IResolvable] = None,
  remote_ca_certificate: typing.Union[str, IResolvable] = None,
  tunnel_options_specification: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, TunnelOptionsSpecificationProperty]]] = None
)

Properties

Name Type Description
local_subnet typing.Union[str, 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.
remote_subnet typing.Union[str, ros_cdk_core.IResolvable] Property remoteSubnet: The network segment of the local IDC is used for the second phase negotiation.
vpn_gateway_id typing.Union[str, ros_cdk_core.IResolvable] Property vpnGatewayId: ID of the VPN gateway.
auto_config_route typing.Union[bool, ros_cdk_core.IResolvable] Property autoConfigRoute: Specifies whether to automatically configure routes.
bgp_config typing.Union[ros_cdk_core.IResolvable, BgpConfigProperty] Property bgpConfig: The Border Gateway Protocol (BGP) configuration.
customer_gateway_id typing.Union[str, ros_cdk_core.IResolvable] Property customerGatewayId: The ID of the user gateway.
effect_immediately typing.Union[bool, ros_cdk_core.IResolvable] Property effectImmediately: Whether to delete the currently negotiated IPsec tunnel and re-initiate the negotiation.
enable_dpd typing.Union[bool, ros_cdk_core.IResolvable] Property enableDpd: Specifies whether to enable the dead peer detection (DPD) feature.
enable_nat_traversal typing.Union[bool, ros_cdk_core.IResolvable] Property enableNatTraversal: Specifies whether to enable NAT traversal.
enable_tunnels_bgp typing.Union[bool, ros_cdk_core.IResolvable] Property enableTunnelsBgp: Specifies whether to enable the BGP feature for the tunnel.
health_check_config typing.Union[ros_cdk_core.IResolvable, HealthCheckConfigProperty] Property healthCheckConfig: Whether to enable the health check configuration.
ike_config typing.Union[ros_cdk_core.IResolvable, IkeConfigProperty] Property ikeConfig: Configuration information for the first phase of negotiation.
ipsec_config typing.Union[ros_cdk_core.IResolvable, IpsecConfigProperty] Property ipsecConfig: Configuration information for the second phase negotiation.
name typing.Union[str, ros_cdk_core.IResolvable] Property name: The name of the IPsec connection.
remote_ca_certificate typing.Union[str, ros_cdk_core.IResolvable] Property remoteCaCertificate: The peer CA certificate when a ShangMi (SM) VPN gateway is used to establish the IPsec-VPN connection.
tunnel_options_specification typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, TunnelOptionsSpecificationProperty]]] Property tunnelOptionsSpecification: TunnelOptionsSpecification parameters are supported by dual-tunnel IPsec-VPN gateways.

local_subnetRequired 

local_subnet: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

remote_subnetRequired 

remote_subnet: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

vpn_gateway_idRequired 

vpn_gateway_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property vpnGatewayId: ID of the VPN gateway.

auto_config_routeOptional 

auto_config_route: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property autoConfigRoute: Specifies whether to automatically configure routes.

Valid values: true (default) false

bgp_configOptional 

bgp_config: typing.Union[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.

customer_gateway_idOptional 

customer_gateway_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property customerGatewayId: The ID of the user gateway.

effect_immediatelyOptional 

effect_immediately: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, 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.

enable_dpdOptional 

enable_dpd: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, 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.

enable_nat_traversalOptional 

enable_nat_traversal: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, 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

enable_tunnels_bgpOptional 

enable_tunnels_bgp: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

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

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

health_check_configOptional 

health_check_config: typing.Union[IResolvable, HealthCheckConfigProperty]

Property healthCheckConfig: Whether to enable the health check configuration.

ike_configOptional 

ike_config: typing.Union[IResolvable, IkeConfigProperty]

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

ipsec_configOptional 

ipsec_config: typing.Union[IResolvable, IpsecConfigProperty]

Property ipsecConfig: Configuration information for the second phase negotiation.

nameOptional 

name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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:// .

remote_ca_certificateOptional 

remote_ca_certificate: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

tunnel_options_specificationOptional 

tunnel_options_specification: typing.Union[IResolvable, typing.List[typing.Union[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.