Skip to content

IpsecServerProps

Properties for defining a IpsecServer.

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

Initializer

import ros_cdk_vpc
ros_cdk_vpc.IpsecServerProps(
  client_ip_pool: typing.Union[str, IResolvable],
  local_subnet: typing.Union[str, IResolvable],
  vpn_gateway_id: typing.Union[str, IResolvable],
  effect_immediately: typing.Union[bool, IResolvable] = None,
  ike_config: typing.Union[IResolvable, IkeConfigProperty] = None,
  ipsec_config: typing.Union[IResolvable, IpsecConfigProperty] = None,
  ipsec_server_name: typing.Union[str, IResolvable] = None,
  psk: typing.Union[str, IResolvable] = None,
  psk_enabled: typing.Union[bool, IResolvable] = None
)

Properties

Name Type Description
client_ip_pool typing.Union[str, ros_cdk_core.IResolvable] Property clientIpPool: Client network segment refers to the address segment that assigns access addresses to the virtual network card of the client.
local_subnet typing.Union[str, ros_cdk_core.IResolvable] Property localSubnet: The local network segment refers to the network segment on the VPC side that needs to be interconnected with the client network segment.
vpn_gateway_id typing.Union[str, ros_cdk_core.IResolvable] Property vpnGatewayId: VPN gateway instance ID.
effect_immediately typing.Union[bool, ros_cdk_core.IResolvable] Property effectImmediately: true: Apply the new configuration and trigger a reconnection immediately.
ike_config typing.Union[ros_cdk_core.IResolvable, IkeConfigProperty] Property ikeConfig: Negotiation parameter configuration in the first phase.
ipsec_config typing.Union[ros_cdk_core.IResolvable, IpsecConfigProperty] Property ipsecConfig: Negotiation parameter configuration in the second phase.
ipsec_server_name typing.Union[str, ros_cdk_core.IResolvable] Property ipsecServerName: The value must be 2 to 128 characters in length and start with a letter or Chinese character.
psk typing.Union[str, ros_cdk_core.IResolvable] Property psk: Pre-Shared key.
psk_enabled typing.Union[bool, ros_cdk_core.IResolvable] Property pskEnabled: Whether to enable the pre-shared key authentication method.

client_ip_poolRequired

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

Property clientIpPool: Client network segment refers to the address segment that assigns access addresses to the virtual network card of the client.

Note: The client network segment cannot conflict with the VPC side network segment.


local_subnetRequired

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

Property localSubnet: The local network segment refers to the network segment on the VPC side that needs to be interconnected with the client network segment.

Use half-width commas (,) to separate multiple network segments, for example: 192.168.1.0/24,192.168.2.0/24.


vpn_gateway_idRequired

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

Property vpnGatewayId: VPN gateway instance ID.


effect_immediatelyOptional

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

Property effectImmediately: true: Apply the new configuration and trigger a reconnection immediately.

false: Trigger a reconnection only when network traffic occurs. (The reconnection may cause the network to be unavailable for a brief moment)


ike_configOptional

ike_config: typing.Union[IResolvable, IkeConfigProperty]

Property ikeConfig: Negotiation parameter configuration in the first phase.


ipsec_configOptional

ipsec_config: typing.Union[IResolvable, IpsecConfigProperty]

Property ipsecConfig: Negotiation parameter configuration in the second phase.


ipsec_server_nameOptional

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

Property ipsecServerName: The value must be 2 to 128 characters in length and start with a letter or Chinese character.

It can contain digits, underscores (_), and hyphens (-).


pskOptional

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

Property psk: Pre-Shared key.

Used for identity authentication between the VPN gateway and the client. A 16-bit random string is randomly generated by default, or you can manually specify the key. The length is limited to 100 characters.


psk_enabledOptional

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

Property pskEnabled: Whether to enable the pre-shared key authentication method.

Only the value is true, which means that the pre-shared key authentication mode is enabled.