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

local_subnet^Required

local_subnet: typing.Union[str, IResolvable]

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

Property localSubnet: The CIDR block of the virtual private cloud (VPC) that needs to communicate with the on-premises database.

The CIDR block is used in Phase 2 negotiations. Separate multiple CIDR blocks with commas (,). Example: 192.168.1.0/24,192.168.2.0/24. The following routing modes are supported:

• If you set LocalSubnet and RemoteSubnet to 0.0.0.0/0, the routing mode of the IPsec-VPN connection is set to Destination Routing Mode.
• If you set LocalSubnet and RemoteSubnet to specific CIDR blocks, the routing mode of the IPsec-VPN connection is set to Protected Data Flows.

remote_subnet^Required

remote_subnet: typing.Union[str, IResolvable]

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

Property remoteSubnet: The CIDR block of the on-premises database that needs to communicate with the VPC.

The CIDR block is used in Phase 2 negotiations. Separate multiple CIDR blocks with commas (,). Example: 192.168.3.0/24,192.168.4.0/24. The following routing modes are supported:

• If you set LocalSubnet and RemoteSubnet to 0.0.0.0/0...

vpn_gateway_id^Required

vpn_gateway_id: typing.Union[str, IResolvable]

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

Property vpnGatewayId: ID of the VPN gateway.

auto_config_route^Optional

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_config^Optional

bgp_config: typing.Union[IResolvable, BgpConfigProperty]

• Type: typing.Union[ros_cdk_core.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_id^Optional

customer_gateway_id: typing.Union[str, IResolvable]

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

Property customerGatewayId: The ID of the user gateway.

effect_immediately^Optional

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_dpd^Optional

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_traversal^Optional

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_bgp^Optional

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_config^Optional

health_check_config: typing.Union[IResolvable, HealthCheckConfigProperty]

• Type: typing.Union[ros_cdk_core.IResolvable, HealthCheckConfigProperty]

Property healthCheckConfig: This parameter is available if you create an IPsec-VPN connection in single-tunnel mode.

The health check configuration:

• HealthCheckConfig.enable: ... Default value: false.
• HealthCheckConfig.dip / sip / interval (Default: 3) / retry (Default: 3) / Policy (revoke_route default / reserve_route).

ike_config^Optional

ike_config: typing.Union[IResolvable, IkeConfigProperty]

• Type: typing.Union[ros_cdk_core.IResolvable, IkeConfigProperty]

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

ipsec_config^Optional

ipsec_config: typing.Union[IResolvable, IpsecConfigProperty]

• Type: typing.Union[ros_cdk_core.IResolvable, IpsecConfigProperty]

Property ipsecConfig: Configuration information for the second phase negotiation.

name^Optional

name: typing.Union[str, IResolvable]

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

Property name: The name of the IPsec-VPN connection.

The name must be 1 to 100 characters in length and cannot start with http:\/\/ or https:\/\/.

remote_ca_certificate^Optional

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_specification^Optional

tunnel_options_specification: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, TunnelOptionsSpecificationProperty]]]

• Type: 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.

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