Skip to content

VpnConnectionProps

Properties for defining a VpnConnection.

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

Initializer 

import com.aliyun.ros.cdk.vpc.VpnConnectionProps;
VpnConnectionProps.builder()
    .localSubnet(java.lang.String)
    .localSubnet(IResolvable)
    .remoteSubnet(java.lang.String)
    .remoteSubnet(IResolvable)
    .vpnGatewayId(java.lang.String)
    .vpnGatewayId(IResolvable)
//  .autoConfigRoute(java.lang.Boolean)
//  .autoConfigRoute(IResolvable)
//  .bgpConfig(IResolvable)
//  .bgpConfig(BgpConfigProperty)
//  .customerGatewayId(java.lang.String)
//  .customerGatewayId(IResolvable)
//  .effectImmediately(java.lang.Boolean)
//  .effectImmediately(IResolvable)
//  .enableDpd(java.lang.Boolean)
//  .enableDpd(IResolvable)
//  .enableNatTraversal(java.lang.Boolean)
//  .enableNatTraversal(IResolvable)
//  .enableTunnelsBgp(java.lang.Boolean)
//  .enableTunnelsBgp(IResolvable)
//  .healthCheckConfig(IResolvable)
//  .healthCheckConfig(HealthCheckConfigProperty)
//  .ikeConfig(IResolvable)
//  .ikeConfig(IkeConfigProperty)
//  .ipsecConfig(IResolvable)
//  .ipsecConfig(IpsecConfigProperty)
//  .name(java.lang.String)
//  .name(IResolvable)
//  .remoteCaCertificate(java.lang.String)
//  .remoteCaCertificate(IResolvable)
//  .tunnelOptionsSpecification(IResolvable)
//  .tunnelOptionsSpecification(java.util.List<IResolvable)
//  .tunnelOptionsSpecification(TunnelOptionsSpecificationProperty>)
    .build();

Properties

Name Type Description
localSubnet java.lang.String OR com.aliyun.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 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property remoteSubnet: The network segment of the local IDC is used for the second phase negotiation.
vpnGatewayId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpnGatewayId: ID of the VPN gateway.
autoConfigRoute java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property autoConfigRoute: Specifies whether to automatically configure routes.
bgpConfig com.aliyun.ros.cdk.core.IResolvable OR BgpConfigProperty Property bgpConfig: The Border Gateway Protocol (BGP) configuration.
customerGatewayId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property customerGatewayId: The ID of the user gateway.
effectImmediately java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property effectImmediately: Whether to delete the currently negotiated IPsec tunnel and re-initiate the negotiation.
enableDpd java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property enableDpd: Specifies whether to enable the dead peer detection (DPD) feature.
enableNatTraversal java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property enableNatTraversal: Specifies whether to enable NAT traversal.
enableTunnelsBgp java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property enableTunnelsBgp: Specifies whether to enable the BGP feature for the tunnel.
healthCheckConfig com.aliyun.ros.cdk.core.IResolvable OR HealthCheckConfigProperty Property healthCheckConfig: Whether to enable the health check configuration.
ikeConfig com.aliyun.ros.cdk.core.IResolvable OR IkeConfigProperty Property ikeConfig: Configuration information for the first phase of negotiation.
ipsecConfig com.aliyun.ros.cdk.core.IResolvable OR IpsecConfigProperty Property ipsecConfig: Configuration information for the second phase negotiation.
name java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property name: The name of the IPsec connection.
remoteCaCertificate java.lang.String OR com.aliyun.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 com.aliyun.ros.cdk.core.IResolvable OR java.util.ListTunnelOptionsSpecificationProperty> Property tunnelOptionsSpecification: TunnelOptionsSpecification parameters are supported by dual-tunnel IPsec-VPN gateways.

localSubnetRequired 

public java.lang.Object getLocalSubnet();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getRemoteSubnet();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getVpnGatewayId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vpnGatewayId: ID of the VPN gateway.

autoConfigRouteOptional 

public java.lang.Object getAutoConfigRoute();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property autoConfigRoute: Specifies whether to automatically configure routes.

Valid values: true (default) false

bgpConfigOptional 

public java.lang.Object getBgpConfig();

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 java.lang.Object getCustomerGatewayId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property customerGatewayId: The ID of the user gateway.

effectImmediatelyOptional 

public java.lang.Object getEffectImmediately();
  • Type: java.lang.Boolean OR com.aliyun.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 java.lang.Object getEnableDpd();
  • Type: java.lang.Boolean OR com.aliyun.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 java.lang.Object getEnableNatTraversal();
  • Type: java.lang.Boolean OR com.aliyun.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 java.lang.Object getEnableTunnelsBgp();
  • Type: java.lang.Boolean OR com.aliyun.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 java.lang.Object getHealthCheckConfig();

Property healthCheckConfig: Whether to enable the health check configuration.

ikeConfigOptional 

public java.lang.Object getIkeConfig();

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

ipsecConfigOptional 

public java.lang.Object getIpsecConfig();

Property ipsecConfig: Configuration information for the second phase negotiation.

nameOptional 

public java.lang.Object getName();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getRemoteCaCertificate();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getTunnelOptionsSpecification();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListTunnelOptionsSpecificationProperty>

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.