Skip to content

IpsecServer

This class encapsulates and extends the ROS resource type ALIYUN::VPC::IpsecServer, which is used to create an IPsec-VPN server.

Initializers 

import ros_cdk_vpc
ros_cdk_vpc.IpsecServer(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No 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.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

client_ip_poolRequired

  • 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

  • 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

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

Property vpnGatewayId: VPN gateway instance ID.

effect_immediatelyOptional

  • 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

Property ikeConfig: Negotiation parameter configuration in the first phase.

ipsec_configOptional

Property ipsecConfig: Negotiation parameter configuration in the second phase.

ipsec_server_nameOptional

  • 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

  • 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

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

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

to_string 

def to_string() -> str

Returns a string representation of this construct.

synthesize 

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct 

import ros_cdk_vpc
ros_cdk_vpc.IpsecServer.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_ipsec_server_id ros_cdk_core.IResolvable Attribute IpsecServerId: IPsec server ID.
attr_ipsec_server_name ros_cdk_core.IResolvable Attribute IpsecServerName: IPsec server name.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_ipsec_server_idRequired 

attr_ipsec_server_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute IpsecServerId: IPsec server ID.

attr_ipsec_server_nameRequired 

attr_ipsec_server_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute IpsecServerName: IPsec server name.