Skip to content

SslVpnServer

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

Initializers 

import ros_cdk_vpc
ros_cdk_vpc.SslVpnServer(
  scope: Construct,
  id: str,
  client_ip_pool: typing.Union[str, IResolvable],
  local_subnet: typing.Union[str, IResolvable],
  vpn_gateway_id: typing.Union[str, IResolvable],
  cipher: typing.Union[str, IResolvable] = None,
  compress: typing.Union[bool, IResolvable] = None,
  enable_multi_factor_auth: typing.Union[bool, IResolvable] = None,
  i_daa_s_application_id: typing.Union[str, IResolvable] = None,
  i_daa_s_instance_id: typing.Union[str, IResolvable] = None,
  i_daa_s_region_id: typing.Union[str, IResolvable] = None,
  name: typing.Union[str, IResolvable] = None,
  port: typing.Union[typing.Union[int, float], IResolvable] = None,
  proto: typing.Union[str, 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: It is the address segment that assigns the access address to the client virtual NIC.
local_subnet typing.Union[str, ros_cdk_core.IResolvable] Property localSubnet: Is the address segment that the client wants to access through an SSL-VPN connection.
vpn_gateway_id typing.Union[str, ros_cdk_core.IResolvable] Property vpnGatewayId: ID of the VPN gateway.
cipher typing.Union[str, ros_cdk_core.IResolvable] Property cipher: The encryption algorithm used by SSL-VPN.
compress typing.Union[bool, ros_cdk_core.IResolvable] Property compress: Whether it is compressed.
enable_multi_factor_auth typing.Union[bool, ros_cdk_core.IResolvable] Property enableMultiFactorAuth: Whether to enable multi-factor authentication.
i_daa_s_application_id typing.Union[str, ros_cdk_core.IResolvable] Property iDaaSApplicationId: The ID of the IDaaS application.
i_daa_s_instance_id typing.Union[str, ros_cdk_core.IResolvable] Property iDaaSInstanceId: The ID of the IDaaS instance.
i_daa_s_region_id typing.Union[str, ros_cdk_core.IResolvable] Property iDaaSRegionId: The region ID of the IDaaS instance.
name typing.Union[str, ros_cdk_core.IResolvable] Property name: The name of the SSL-VPN server.
port typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property port: The port used by the SSL-VPN server.
proto typing.Union[str, ros_cdk_core.IResolvable] Property proto: The protocol used by the SSL-VPN server.
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: It is the address segment that assigns the access address to the client virtual NIC.

It does not refer to the existing intranet segment of the client. When the client accesses the local end through an SSL-VPN connection, the VPN gateway allocates an IP address to the client from the specified client network segment. The network segment cannot conflict with the LocalSubnet address segment.

local_subnetRequired

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

Property localSubnet: Is the address segment that the client wants to access through an SSL-VPN connection.

The local network segment can be the network segment of the VPC, the network segment of the switch, the network segment of the IDC interconnected by the leased line and the VPC, and the network segment of the cloud service such as RDS/OSS.

vpn_gateway_idRequired

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

Property vpnGatewayId: ID of the VPN gateway.

cipherOptional

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

Property cipher: The encryption algorithm used by SSL-VPN.

Value: AES-128-CBC (default) | AES-192-CBC | AES-256-CBC | none

compressOptional

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

Property compress: Whether it is compressed.

enable_multi_factor_authOptional

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

Property enableMultiFactorAuth: Whether to enable multi-factor authentication.

The default value is false.

i_daa_s_application_idOptional

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

Property iDaaSApplicationId: The ID of the IDaaS application.

i_daa_s_instance_idOptional

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

Property iDaaSInstanceId: The ID of the IDaaS instance.

i_daa_s_region_idOptional

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

Property iDaaSRegionId: The region ID of the IDaaS instance.

nameOptional

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

Property name: The name of the SSL-VPN server.

The length is 2-128 characters and must start with a letter or Chinese. It can contain numbers, periods (.), underscores (_), and dashes (-). But it can't start with http:// or https://.

portOptional

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

Property port: The port used by the SSL-VPN server.

The default value is 1194. Cannot use the following ports: 22, 2222, 22222, 9000, 9001, 9002, 7505, 80, 443, 53, 68, 123, 4510, 4560, 500, 4500

protoOptional

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

Property proto: The protocol used by the SSL-VPN server.

Allowed values: UDP (default) | TCP.

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.SslVpnServer.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_ssl_vpn_server_id ros_cdk_core.IResolvable Attribute SslVpnServerId: ID of the SSL-VPN server.

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_ssl_vpn_server_idRequired 

attr_ssl_vpn_server_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SslVpnServerId: ID of the SSL-VPN server.