IpsecServer

• Implements: IIpsecServer

This class encapsulates and extends the ROS resource type ALIYUN::VPC::IpsecServer.

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
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

client_ip_pool^Required

• 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_subnet^Required

• 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_id^Required

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

Property vpnGatewayId: VPN gateway instance ID.

effect_immediately^Optional

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

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

Property ikeConfig: Negotiation parameter configuration in the first phase.

ipsec_config^Optional

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

Property ipsecConfig: Negotiation parameter configuration in the second phase.

ipsec_server_name^Optional

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

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

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

psk^Optional

• 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_enabled^Optional

• 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_constraint^Optional

• Type: bool

Methods

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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

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

count^Required

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

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

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

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

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_ipsec_server_id^Required

attr_ipsec_server_id: typing.Union[str, IResolvable]

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

Attribute IpsecServerId: IPsec server ID.

attr_ipsec_server_name^Required

attr_ipsec_server_name: typing.Union[str, IResolvable]

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

Attribute IpsecServerName: IPsec server name.

props^Required

props: IpsecServerProps

• Type: IpsecServerProps