published on Monday, May 25, 2026 by Byteplus
published on Monday, May 25, 2026 by Byteplus
The SSL server is a service module in SSL VPN that provides SSL services and handles packet encapsulation and decapsulation.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as bytepluscc from "@byteplus/pulumi-bytepluscc";
const vPNSslVpnServerDemo = new bytepluscc.vpn.SslVpnServer("VPNSslVpnServerDemo", {
compress: false,
clientIpPool: "192.168.xxx.0/26",
description: "修改的SSL服务端描述",
projectName: "default",
port: 1195,
sslVpnServerName: "更新的SSL服务端名称",
localSubnets: [
"192.168.1.0/24",
"192.168.2.0/24",
],
vpnGatewayId: "vgw-****",
auth: "SHA1",
cipher: "AES-128-CBC",
clientCertSessionPolicy: "PreemptExisting",
protocol: "TCP",
tags: [{
value: "env",
key: "test",
}],
});
import pulumi
import pulumi_bytepluscc as bytepluscc
v_pnssl_vpn_server_demo = bytepluscc.vpn.SslVpnServer("VPNSslVpnServerDemo",
compress=False,
client_ip_pool="192.168.xxx.0/26",
description="修改的SSL服务端描述",
project_name="default",
port=1195,
ssl_vpn_server_name="更新的SSL服务端名称",
local_subnets=[
"192.168.1.0/24",
"192.168.2.0/24",
],
vpn_gateway_id="vgw-****",
auth="SHA1",
cipher="AES-128-CBC",
client_cert_session_policy="PreemptExisting",
protocol="TCP",
tags=[{
"value": "env",
"key": "test",
}])
package main
import (
"github.com/byteplus-sdk/pulumi-bytepluscc/sdk/go/bytepluscc/vpn"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := vpn.NewSslVpnServer(ctx, "VPNSslVpnServerDemo", &vpn.SslVpnServerArgs{
Compress: pulumi.Bool(false),
ClientIpPool: pulumi.String("192.168.xxx.0/26"),
Description: pulumi.String("修改的SSL服务端描述"),
ProjectName: pulumi.String("default"),
Port: pulumi.Int(1195),
SslVpnServerName: pulumi.String("更新的SSL服务端名称"),
LocalSubnets: pulumi.StringArray{
pulumi.String("192.168.1.0/24"),
pulumi.String("192.168.2.0/24"),
},
VpnGatewayId: pulumi.String("vgw-****"),
Auth: pulumi.String("SHA1"),
Cipher: pulumi.String("AES-128-CBC"),
ClientCertSessionPolicy: pulumi.String("PreemptExisting"),
Protocol: pulumi.String("TCP"),
Tags: vpn.SslVpnServerTagArray{
&vpn.SslVpnServerTagArgs{
Value: pulumi.String("env"),
Key: pulumi.String("test"),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Bytepluscc = Byteplus.Pulumi.Bytepluscc;
return await Deployment.RunAsync(() =>
{
var vPNSslVpnServerDemo = new Bytepluscc.Vpn.SslVpnServer("VPNSslVpnServerDemo", new()
{
Compress = false,
ClientIpPool = "192.168.xxx.0/26",
Description = "修改的SSL服务端描述",
ProjectName = "default",
Port = 1195,
SslVpnServerName = "更新的SSL服务端名称",
LocalSubnets = new[]
{
"192.168.1.0/24",
"192.168.2.0/24",
},
VpnGatewayId = "vgw-****",
Auth = "SHA1",
Cipher = "AES-128-CBC",
ClientCertSessionPolicy = "PreemptExisting",
Protocol = "TCP",
Tags = new[]
{
new Bytepluscc.Vpn.Inputs.SslVpnServerTagArgs
{
Value = "env",
Key = "test",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.byteplus.bytepluscc.vpn.SslVpnServer;
import com.byteplus.bytepluscc.vpn.SslVpnServerArgs;
import com.pulumi.bytepluscc.vpn.inputs.SslVpnServerTagArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var vPNSslVpnServerDemo = new SslVpnServer("vPNSslVpnServerDemo", SslVpnServerArgs.builder()
.compress(false)
.clientIpPool("192.168.xxx.0/26")
.description("修改的SSL服务端描述")
.projectName("default")
.port(1195)
.sslVpnServerName("更新的SSL服务端名称")
.localSubnets(
"192.168.1.0/24",
"192.168.2.0/24")
.vpnGatewayId("vgw-****")
.auth("SHA1")
.cipher("AES-128-CBC")
.clientCertSessionPolicy("PreemptExisting")
.protocol("TCP")
.tags(SslVpnServerTagArgs.builder()
.value("env")
.key("test")
.build())
.build());
}
}
resources:
vPNSslVpnServerDemo:
type: bytepluscc:vpn:SslVpnServer
name: VPNSslVpnServerDemo
properties:
compress: false
clientIpPool: 192.168.xxx.0/26
description: 修改的SSL服务端描述
projectName: default
port: 1195
sslVpnServerName: 更新的SSL服务端名称
localSubnets:
- 192.168.1.0/24
- 192.168.2.0/24
vpnGatewayId: vgw-****
auth: SHA1
cipher: AES-128-CBC
clientCertSessionPolicy: PreemptExisting
protocol: TCP
tags:
- value: env
key: test
Example coming soon!
Create SslVpnServer Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SslVpnServer(name: string, args: SslVpnServerArgs, opts?: CustomResourceOptions);@overload
def SslVpnServer(resource_name: str,
args: SslVpnServerArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SslVpnServer(resource_name: str,
opts: Optional[ResourceOptions] = None,
local_subnets: Optional[Sequence[str]] = None,
client_ip_pool: Optional[str] = None,
vpn_gateway_id: Optional[str] = None,
cipher: Optional[str] = None,
client_cert_session_policy: Optional[str] = None,
compress: Optional[bool] = None,
description: Optional[str] = None,
auth: Optional[str] = None,
port: Optional[int] = None,
project_name: Optional[str] = None,
protocol: Optional[str] = None,
ssl_vpn_server_name: Optional[str] = None,
tags: Optional[Sequence[SslVpnServerTagArgs]] = None)func NewSslVpnServer(ctx *Context, name string, args SslVpnServerArgs, opts ...ResourceOption) (*SslVpnServer, error)public SslVpnServer(string name, SslVpnServerArgs args, CustomResourceOptions? opts = null)
public SslVpnServer(String name, SslVpnServerArgs args)
public SslVpnServer(String name, SslVpnServerArgs args, CustomResourceOptions options)
type: bytepluscc:vpn:SslVpnServer
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "bytepluscc_vpn_sslvpnserver" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args SslVpnServerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args SslVpnServerArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args SslVpnServerArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SslVpnServerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SslVpnServerArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var sslVpnServerResource = new Bytepluscc.Vpn.SslVpnServer("sslVpnServerResource", new()
{
LocalSubnets = new[]
{
"string",
},
ClientIpPool = "string",
VpnGatewayId = "string",
Cipher = "string",
ClientCertSessionPolicy = "string",
Compress = false,
Description = "string",
Auth = "string",
Port = 0,
ProjectName = "string",
Protocol = "string",
SslVpnServerName = "string",
Tags = new[]
{
new Bytepluscc.Vpn.Inputs.SslVpnServerTagArgs
{
Key = "string",
Value = "string",
},
},
});
example, err := vpn.NewSslVpnServer(ctx, "sslVpnServerResource", &vpn.SslVpnServerArgs{
LocalSubnets: pulumi.StringArray{
pulumi.String("string"),
},
ClientIpPool: pulumi.String("string"),
VpnGatewayId: pulumi.String("string"),
Cipher: pulumi.String("string"),
ClientCertSessionPolicy: pulumi.String("string"),
Compress: pulumi.Bool(false),
Description: pulumi.String("string"),
Auth: pulumi.String("string"),
Port: pulumi.Int(0),
ProjectName: pulumi.String("string"),
Protocol: pulumi.String("string"),
SslVpnServerName: pulumi.String("string"),
Tags: vpn.SslVpnServerTagArray{
&vpn.SslVpnServerTagArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
})
resource "bytepluscc_vpn_sslvpnserver" "sslVpnServerResource" {
local_subnets = ["string"]
client_ip_pool = "string"
vpn_gateway_id = "string"
cipher = "string"
client_cert_session_policy = "string"
compress = false
description = "string"
auth = "string"
port = 0
project_name = "string"
protocol = "string"
ssl_vpn_server_name = "string"
tags {
key = "string"
value = "string"
}
}
var sslVpnServerResource = new SslVpnServer("sslVpnServerResource", SslVpnServerArgs.builder()
.localSubnets("string")
.clientIpPool("string")
.vpnGatewayId("string")
.cipher("string")
.clientCertSessionPolicy("string")
.compress(false)
.description("string")
.auth("string")
.port(0)
.projectName("string")
.protocol("string")
.sslVpnServerName("string")
.tags(SslVpnServerTagArgs.builder()
.key("string")
.value("string")
.build())
.build());
ssl_vpn_server_resource = bytepluscc.vpn.SslVpnServer("sslVpnServerResource",
local_subnets=["string"],
client_ip_pool="string",
vpn_gateway_id="string",
cipher="string",
client_cert_session_policy="string",
compress=False,
description="string",
auth="string",
port=0,
project_name="string",
protocol="string",
ssl_vpn_server_name="string",
tags=[{
"key": "string",
"value": "string",
}])
const sslVpnServerResource = new bytepluscc.vpn.SslVpnServer("sslVpnServerResource", {
localSubnets: ["string"],
clientIpPool: "string",
vpnGatewayId: "string",
cipher: "string",
clientCertSessionPolicy: "string",
compress: false,
description: "string",
auth: "string",
port: 0,
projectName: "string",
protocol: "string",
sslVpnServerName: "string",
tags: [{
key: "string",
value: "string",
}],
});
type: bytepluscc:vpn:SslVpnServer
properties:
auth: string
cipher: string
clientCertSessionPolicy: string
clientIpPool: string
compress: false
description: string
localSubnets:
- string
port: 0
projectName: string
protocol: string
sslVpnServerName: string
tags:
- key: string
value: string
vpnGatewayId: string
SslVpnServer Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The SslVpnServer resource accepts the following input properties:
- Client
Ip stringPool - SSL client address pool. In SSL VPN, the client address pool is the address range assigned to the client's virtual network interface, not the client's existing internal network segment. Client address pool mask range: /16 to /28. The client address pool must not conflict with the LocalSubnet or IPSec connection routes. The client address pool must not overlap with 100.64.0.0/10, 169.254.0.0/16, 127.0.0.0/8, 224.0.0.0/4, or 240.0.0.0/4. The number of available IPs in the client address pool must be greater than four times the number of SSL connections selected when creating the VPN gateway. For example, if the number of SSL connections is 10, the client address pool must have more than 40 available IPs.
- Local
Subnets List<string> - Local subnet of the SSL server. The local subnet is the address range accessed by clients through the SSL VPN connection. Note: Up to 5 local subnets can be specified, and they must not conflict with the ClientIpPool.
- Vpn
Gateway stringId - ID of the VPN gateway used by the SSL server.
- Auth string
- Authentication algorithm for the SSL server. SHA1 (default), MD5, None (no encryption).
- Cipher string
- Encryption algorithm for the SSL server. AES-128-CBC (default) AES-192-CBC AES-256-CBC None (no encryption).
- Client
Cert stringSession Policy - Session policy for client certificates. AllowConcurrent: Reuse supported. PreemptExisting: Reuse not supported.
- Compress bool
- Whether to compress transmitted data. true: Enable compression for communication. false (default): Do not compress communication.
- Description string
- Description of the SSL server to be created. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), spaces ( ), underscores (_), hyphens (-), equals signs (=), English commas (,), Chinese commas (,), and Chinese periods (。). Length: 0 to 255 characters. If not specified, defaults to an empty string.
- Port int
- Port used by the SSL server. Default: 1194. Valid port range: 1 ~ 65535. The following ports are not supported: 22, 68, 179, 323, 500, 4500.
- Project
Name string - Project to which the SSL server belongs. If left blank, the default is default, meaning the created resource belongs to the default project.
- Protocol string
- Protocol used by the SSL server. Options: TCP (default): TCP protocol. UDP: UDP protocol.
- Ssl
Vpn stringServer Name - Name of the SSL server to be created. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-). Length: 1 to 128 characters. If not specified, defaults to the SSL server ID.
-
List<Byteplus.
Ssl Vpn Server Tag>
- Client
Ip stringPool - SSL client address pool. In SSL VPN, the client address pool is the address range assigned to the client's virtual network interface, not the client's existing internal network segment. Client address pool mask range: /16 to /28. The client address pool must not conflict with the LocalSubnet or IPSec connection routes. The client address pool must not overlap with 100.64.0.0/10, 169.254.0.0/16, 127.0.0.0/8, 224.0.0.0/4, or 240.0.0.0/4. The number of available IPs in the client address pool must be greater than four times the number of SSL connections selected when creating the VPN gateway. For example, if the number of SSL connections is 10, the client address pool must have more than 40 available IPs.
- Local
Subnets []string - Local subnet of the SSL server. The local subnet is the address range accessed by clients through the SSL VPN connection. Note: Up to 5 local subnets can be specified, and they must not conflict with the ClientIpPool.
- Vpn
Gateway stringId - ID of the VPN gateway used by the SSL server.
- Auth string
- Authentication algorithm for the SSL server. SHA1 (default), MD5, None (no encryption).
- Cipher string
- Encryption algorithm for the SSL server. AES-128-CBC (default) AES-192-CBC AES-256-CBC None (no encryption).
- Client
Cert stringSession Policy - Session policy for client certificates. AllowConcurrent: Reuse supported. PreemptExisting: Reuse not supported.
- Compress bool
- Whether to compress transmitted data. true: Enable compression for communication. false (default): Do not compress communication.
- Description string
- Description of the SSL server to be created. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), spaces ( ), underscores (_), hyphens (-), equals signs (=), English commas (,), Chinese commas (,), and Chinese periods (。). Length: 0 to 255 characters. If not specified, defaults to an empty string.
- Port int
- Port used by the SSL server. Default: 1194. Valid port range: 1 ~ 65535. The following ports are not supported: 22, 68, 179, 323, 500, 4500.
- Project
Name string - Project to which the SSL server belongs. If left blank, the default is default, meaning the created resource belongs to the default project.
- Protocol string
- Protocol used by the SSL server. Options: TCP (default): TCP protocol. UDP: UDP protocol.
- Ssl
Vpn stringServer Name - Name of the SSL server to be created. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-). Length: 1 to 128 characters. If not specified, defaults to the SSL server ID.
-
[]Ssl
Vpn Server Tag Args
- client_
ip_ stringpool - SSL client address pool. In SSL VPN, the client address pool is the address range assigned to the client's virtual network interface, not the client's existing internal network segment. Client address pool mask range: /16 to /28. The client address pool must not conflict with the LocalSubnet or IPSec connection routes. The client address pool must not overlap with 100.64.0.0/10, 169.254.0.0/16, 127.0.0.0/8, 224.0.0.0/4, or 240.0.0.0/4. The number of available IPs in the client address pool must be greater than four times the number of SSL connections selected when creating the VPN gateway. For example, if the number of SSL connections is 10, the client address pool must have more than 40 available IPs.
- local_
subnets list(string) - Local subnet of the SSL server. The local subnet is the address range accessed by clients through the SSL VPN connection. Note: Up to 5 local subnets can be specified, and they must not conflict with the ClientIpPool.
- vpn_
gateway_ stringid - ID of the VPN gateway used by the SSL server.
- auth string
- Authentication algorithm for the SSL server. SHA1 (default), MD5, None (no encryption).
- cipher string
- Encryption algorithm for the SSL server. AES-128-CBC (default) AES-192-CBC AES-256-CBC None (no encryption).
- client_
cert_ stringsession_ policy - Session policy for client certificates. AllowConcurrent: Reuse supported. PreemptExisting: Reuse not supported.
- compress bool
- Whether to compress transmitted data. true: Enable compression for communication. false (default): Do not compress communication.
- description string
- Description of the SSL server to be created. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), spaces ( ), underscores (_), hyphens (-), equals signs (=), English commas (,), Chinese commas (,), and Chinese periods (。). Length: 0 to 255 characters. If not specified, defaults to an empty string.
- port number
- Port used by the SSL server. Default: 1194. Valid port range: 1 ~ 65535. The following ports are not supported: 22, 68, 179, 323, 500, 4500.
- project_
name string - Project to which the SSL server belongs. If left blank, the default is default, meaning the created resource belongs to the default project.
- protocol string
- Protocol used by the SSL server. Options: TCP (default): TCP protocol. UDP: UDP protocol.
- ssl_
vpn_ stringserver_ name - Name of the SSL server to be created. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-). Length: 1 to 128 characters. If not specified, defaults to the SSL server ID.
- list(object)
- client
Ip StringPool - SSL client address pool. In SSL VPN, the client address pool is the address range assigned to the client's virtual network interface, not the client's existing internal network segment. Client address pool mask range: /16 to /28. The client address pool must not conflict with the LocalSubnet or IPSec connection routes. The client address pool must not overlap with 100.64.0.0/10, 169.254.0.0/16, 127.0.0.0/8, 224.0.0.0/4, or 240.0.0.0/4. The number of available IPs in the client address pool must be greater than four times the number of SSL connections selected when creating the VPN gateway. For example, if the number of SSL connections is 10, the client address pool must have more than 40 available IPs.
- local
Subnets List<String> - Local subnet of the SSL server. The local subnet is the address range accessed by clients through the SSL VPN connection. Note: Up to 5 local subnets can be specified, and they must not conflict with the ClientIpPool.
- vpn
Gateway StringId - ID of the VPN gateway used by the SSL server.
- auth String
- Authentication algorithm for the SSL server. SHA1 (default), MD5, None (no encryption).
- cipher String
- Encryption algorithm for the SSL server. AES-128-CBC (default) AES-192-CBC AES-256-CBC None (no encryption).
- client
Cert StringSession Policy - Session policy for client certificates. AllowConcurrent: Reuse supported. PreemptExisting: Reuse not supported.
- compress Boolean
- Whether to compress transmitted data. true: Enable compression for communication. false (default): Do not compress communication.
- description String
- Description of the SSL server to be created. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), spaces ( ), underscores (_), hyphens (-), equals signs (=), English commas (,), Chinese commas (,), and Chinese periods (。). Length: 0 to 255 characters. If not specified, defaults to an empty string.
- port Integer
- Port used by the SSL server. Default: 1194. Valid port range: 1 ~ 65535. The following ports are not supported: 22, 68, 179, 323, 500, 4500.
- project
Name String - Project to which the SSL server belongs. If left blank, the default is default, meaning the created resource belongs to the default project.
- protocol String
- Protocol used by the SSL server. Options: TCP (default): TCP protocol. UDP: UDP protocol.
- ssl
Vpn StringServer Name - Name of the SSL server to be created. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-). Length: 1 to 128 characters. If not specified, defaults to the SSL server ID.
-
List<Ssl
Vpn Server Tag>
- client
Ip stringPool - SSL client address pool. In SSL VPN, the client address pool is the address range assigned to the client's virtual network interface, not the client's existing internal network segment. Client address pool mask range: /16 to /28. The client address pool must not conflict with the LocalSubnet or IPSec connection routes. The client address pool must not overlap with 100.64.0.0/10, 169.254.0.0/16, 127.0.0.0/8, 224.0.0.0/4, or 240.0.0.0/4. The number of available IPs in the client address pool must be greater than four times the number of SSL connections selected when creating the VPN gateway. For example, if the number of SSL connections is 10, the client address pool must have more than 40 available IPs.
- local
Subnets string[] - Local subnet of the SSL server. The local subnet is the address range accessed by clients through the SSL VPN connection. Note: Up to 5 local subnets can be specified, and they must not conflict with the ClientIpPool.
- vpn
Gateway stringId - ID of the VPN gateway used by the SSL server.
- auth string
- Authentication algorithm for the SSL server. SHA1 (default), MD5, None (no encryption).
- cipher string
- Encryption algorithm for the SSL server. AES-128-CBC (default) AES-192-CBC AES-256-CBC None (no encryption).
- client
Cert stringSession Policy - Session policy for client certificates. AllowConcurrent: Reuse supported. PreemptExisting: Reuse not supported.
- compress boolean
- Whether to compress transmitted data. true: Enable compression for communication. false (default): Do not compress communication.
- description string
- Description of the SSL server to be created. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), spaces ( ), underscores (_), hyphens (-), equals signs (=), English commas (,), Chinese commas (,), and Chinese periods (。). Length: 0 to 255 characters. If not specified, defaults to an empty string.
- port number
- Port used by the SSL server. Default: 1194. Valid port range: 1 ~ 65535. The following ports are not supported: 22, 68, 179, 323, 500, 4500.
- project
Name string - Project to which the SSL server belongs. If left blank, the default is default, meaning the created resource belongs to the default project.
- protocol string
- Protocol used by the SSL server. Options: TCP (default): TCP protocol. UDP: UDP protocol.
- ssl
Vpn stringServer Name - Name of the SSL server to be created. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-). Length: 1 to 128 characters. If not specified, defaults to the SSL server ID.
-
Ssl
Vpn Server Tag[]
- client_
ip_ strpool - SSL client address pool. In SSL VPN, the client address pool is the address range assigned to the client's virtual network interface, not the client's existing internal network segment. Client address pool mask range: /16 to /28. The client address pool must not conflict with the LocalSubnet or IPSec connection routes. The client address pool must not overlap with 100.64.0.0/10, 169.254.0.0/16, 127.0.0.0/8, 224.0.0.0/4, or 240.0.0.0/4. The number of available IPs in the client address pool must be greater than four times the number of SSL connections selected when creating the VPN gateway. For example, if the number of SSL connections is 10, the client address pool must have more than 40 available IPs.
- local_
subnets Sequence[str] - Local subnet of the SSL server. The local subnet is the address range accessed by clients through the SSL VPN connection. Note: Up to 5 local subnets can be specified, and they must not conflict with the ClientIpPool.
- vpn_
gateway_ strid - ID of the VPN gateway used by the SSL server.
- auth str
- Authentication algorithm for the SSL server. SHA1 (default), MD5, None (no encryption).
- cipher str
- Encryption algorithm for the SSL server. AES-128-CBC (default) AES-192-CBC AES-256-CBC None (no encryption).
- client_
cert_ strsession_ policy - Session policy for client certificates. AllowConcurrent: Reuse supported. PreemptExisting: Reuse not supported.
- compress bool
- Whether to compress transmitted data. true: Enable compression for communication. false (default): Do not compress communication.
- description str
- Description of the SSL server to be created. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), spaces ( ), underscores (_), hyphens (-), equals signs (=), English commas (,), Chinese commas (,), and Chinese periods (。). Length: 0 to 255 characters. If not specified, defaults to an empty string.
- port int
- Port used by the SSL server. Default: 1194. Valid port range: 1 ~ 65535. The following ports are not supported: 22, 68, 179, 323, 500, 4500.
- project_
name str - Project to which the SSL server belongs. If left blank, the default is default, meaning the created resource belongs to the default project.
- protocol str
- Protocol used by the SSL server. Options: TCP (default): TCP protocol. UDP: UDP protocol.
- ssl_
vpn_ strserver_ name - Name of the SSL server to be created. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-). Length: 1 to 128 characters. If not specified, defaults to the SSL server ID.
-
Sequence[Ssl
Vpn Server Tag Args]
- client
Ip StringPool - SSL client address pool. In SSL VPN, the client address pool is the address range assigned to the client's virtual network interface, not the client's existing internal network segment. Client address pool mask range: /16 to /28. The client address pool must not conflict with the LocalSubnet or IPSec connection routes. The client address pool must not overlap with 100.64.0.0/10, 169.254.0.0/16, 127.0.0.0/8, 224.0.0.0/4, or 240.0.0.0/4. The number of available IPs in the client address pool must be greater than four times the number of SSL connections selected when creating the VPN gateway. For example, if the number of SSL connections is 10, the client address pool must have more than 40 available IPs.
- local
Subnets List<String> - Local subnet of the SSL server. The local subnet is the address range accessed by clients through the SSL VPN connection. Note: Up to 5 local subnets can be specified, and they must not conflict with the ClientIpPool.
- vpn
Gateway StringId - ID of the VPN gateway used by the SSL server.
- auth String
- Authentication algorithm for the SSL server. SHA1 (default), MD5, None (no encryption).
- cipher String
- Encryption algorithm for the SSL server. AES-128-CBC (default) AES-192-CBC AES-256-CBC None (no encryption).
- client
Cert StringSession Policy - Session policy for client certificates. AllowConcurrent: Reuse supported. PreemptExisting: Reuse not supported.
- compress Boolean
- Whether to compress transmitted data. true: Enable compression for communication. false (default): Do not compress communication.
- description String
- Description of the SSL server to be created. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), spaces ( ), underscores (_), hyphens (-), equals signs (=), English commas (,), Chinese commas (,), and Chinese periods (。). Length: 0 to 255 characters. If not specified, defaults to an empty string.
- port Number
- Port used by the SSL server. Default: 1194. Valid port range: 1 ~ 65535. The following ports are not supported: 22, 68, 179, 323, 500, 4500.
- project
Name String - Project to which the SSL server belongs. If left blank, the default is default, meaning the created resource belongs to the default project.
- protocol String
- Protocol used by the SSL server. Options: TCP (default): TCP protocol. UDP: UDP protocol.
- ssl
Vpn StringServer Name - Name of the SSL server to be created. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-). Length: 1 to 128 characters. If not specified, defaults to the SSL server ID.
- List<Property Map>
Outputs
All input properties are implicitly available as output properties. Additionally, the SslVpnServer resource produces the following output properties:
- Creation
Time string - Time when the SSL server was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Is
Blocked bool - Indicates whether the current resource is blocked. true: Blocked false: Not blocked.
- Ssl
Vpn stringServer Id - ID of the SSL server.
- Status string
- Status of the SSL server. Available: Available Creating: Creating Pending: In progress Deleting: Deleting.
- Update
Time string - Modify the time of the SSL server.
- Creation
Time string - Time when the SSL server was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Is
Blocked bool - Indicates whether the current resource is blocked. true: Blocked false: Not blocked.
- Ssl
Vpn stringServer Id - ID of the SSL server.
- Status string
- Status of the SSL server. Available: Available Creating: Creating Pending: In progress Deleting: Deleting.
- Update
Time string - Modify the time of the SSL server.
- creation_
time string - Time when the SSL server was created.
- id string
- The provider-assigned unique ID for this managed resource.
- is_
blocked bool - Indicates whether the current resource is blocked. true: Blocked false: Not blocked.
- ssl_
vpn_ stringserver_ id - ID of the SSL server.
- status string
- Status of the SSL server. Available: Available Creating: Creating Pending: In progress Deleting: Deleting.
- update_
time string - Modify the time of the SSL server.
- creation
Time String - Time when the SSL server was created.
- id String
- The provider-assigned unique ID for this managed resource.
- is
Blocked Boolean - Indicates whether the current resource is blocked. true: Blocked false: Not blocked.
- ssl
Vpn StringServer Id - ID of the SSL server.
- status String
- Status of the SSL server. Available: Available Creating: Creating Pending: In progress Deleting: Deleting.
- update
Time String - Modify the time of the SSL server.
- creation
Time string - Time when the SSL server was created.
- id string
- The provider-assigned unique ID for this managed resource.
- is
Blocked boolean - Indicates whether the current resource is blocked. true: Blocked false: Not blocked.
- ssl
Vpn stringServer Id - ID of the SSL server.
- status string
- Status of the SSL server. Available: Available Creating: Creating Pending: In progress Deleting: Deleting.
- update
Time string - Modify the time of the SSL server.
- creation_
time str - Time when the SSL server was created.
- id str
- The provider-assigned unique ID for this managed resource.
- is_
blocked bool - Indicates whether the current resource is blocked. true: Blocked false: Not blocked.
- ssl_
vpn_ strserver_ id - ID of the SSL server.
- status str
- Status of the SSL server. Available: Available Creating: Creating Pending: In progress Deleting: Deleting.
- update_
time str - Modify the time of the SSL server.
- creation
Time String - Time when the SSL server was created.
- id String
- The provider-assigned unique ID for this managed resource.
- is
Blocked Boolean - Indicates whether the current resource is blocked. true: Blocked false: Not blocked.
- ssl
Vpn StringServer Id - ID of the SSL server.
- status String
- Status of the SSL server. Available: Available Creating: Creating Pending: In progress Deleting: Deleting.
- update
Time String - Modify the time of the SSL server.
Look up Existing SslVpnServer Resource
Get an existing SslVpnServer resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: SslVpnServerState, opts?: CustomResourceOptions): SslVpnServer@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
auth: Optional[str] = None,
cipher: Optional[str] = None,
client_cert_session_policy: Optional[str] = None,
client_ip_pool: Optional[str] = None,
compress: Optional[bool] = None,
creation_time: Optional[str] = None,
description: Optional[str] = None,
is_blocked: Optional[bool] = None,
local_subnets: Optional[Sequence[str]] = None,
port: Optional[int] = None,
project_name: Optional[str] = None,
protocol: Optional[str] = None,
ssl_vpn_server_id: Optional[str] = None,
ssl_vpn_server_name: Optional[str] = None,
status: Optional[str] = None,
tags: Optional[Sequence[SslVpnServerTagArgs]] = None,
update_time: Optional[str] = None,
vpn_gateway_id: Optional[str] = None) -> SslVpnServerfunc GetSslVpnServer(ctx *Context, name string, id IDInput, state *SslVpnServerState, opts ...ResourceOption) (*SslVpnServer, error)public static SslVpnServer Get(string name, Input<string> id, SslVpnServerState? state, CustomResourceOptions? opts = null)public static SslVpnServer get(String name, Output<String> id, SslVpnServerState state, CustomResourceOptions options)resources: _: type: bytepluscc:vpn:SslVpnServer get: id: ${id}import {
to = bytepluscc_vpn_sslvpnserver.example
id = "${id}"
}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Auth string
- Authentication algorithm for the SSL server. SHA1 (default), MD5, None (no encryption).
- Cipher string
- Encryption algorithm for the SSL server. AES-128-CBC (default) AES-192-CBC AES-256-CBC None (no encryption).
- Client
Cert stringSession Policy - Session policy for client certificates. AllowConcurrent: Reuse supported. PreemptExisting: Reuse not supported.
- Client
Ip stringPool - SSL client address pool. In SSL VPN, the client address pool is the address range assigned to the client's virtual network interface, not the client's existing internal network segment. Client address pool mask range: /16 to /28. The client address pool must not conflict with the LocalSubnet or IPSec connection routes. The client address pool must not overlap with 100.64.0.0/10, 169.254.0.0/16, 127.0.0.0/8, 224.0.0.0/4, or 240.0.0.0/4. The number of available IPs in the client address pool must be greater than four times the number of SSL connections selected when creating the VPN gateway. For example, if the number of SSL connections is 10, the client address pool must have more than 40 available IPs.
- Compress bool
- Whether to compress transmitted data. true: Enable compression for communication. false (default): Do not compress communication.
- Creation
Time string - Time when the SSL server was created.
- Description string
- Description of the SSL server to be created. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), spaces ( ), underscores (_), hyphens (-), equals signs (=), English commas (,), Chinese commas (,), and Chinese periods (。). Length: 0 to 255 characters. If not specified, defaults to an empty string.
- Is
Blocked bool - Indicates whether the current resource is blocked. true: Blocked false: Not blocked.
- Local
Subnets List<string> - Local subnet of the SSL server. The local subnet is the address range accessed by clients through the SSL VPN connection. Note: Up to 5 local subnets can be specified, and they must not conflict with the ClientIpPool.
- Port int
- Port used by the SSL server. Default: 1194. Valid port range: 1 ~ 65535. The following ports are not supported: 22, 68, 179, 323, 500, 4500.
- Project
Name string - Project to which the SSL server belongs. If left blank, the default is default, meaning the created resource belongs to the default project.
- Protocol string
- Protocol used by the SSL server. Options: TCP (default): TCP protocol. UDP: UDP protocol.
- Ssl
Vpn stringServer Id - ID of the SSL server.
- Ssl
Vpn stringServer Name - Name of the SSL server to be created. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-). Length: 1 to 128 characters. If not specified, defaults to the SSL server ID.
- Status string
- Status of the SSL server. Available: Available Creating: Creating Pending: In progress Deleting: Deleting.
-
List<Byteplus.
Ssl Vpn Server Tag> - Update
Time string - Modify the time of the SSL server.
- Vpn
Gateway stringId - ID of the VPN gateway used by the SSL server.
- Auth string
- Authentication algorithm for the SSL server. SHA1 (default), MD5, None (no encryption).
- Cipher string
- Encryption algorithm for the SSL server. AES-128-CBC (default) AES-192-CBC AES-256-CBC None (no encryption).
- Client
Cert stringSession Policy - Session policy for client certificates. AllowConcurrent: Reuse supported. PreemptExisting: Reuse not supported.
- Client
Ip stringPool - SSL client address pool. In SSL VPN, the client address pool is the address range assigned to the client's virtual network interface, not the client's existing internal network segment. Client address pool mask range: /16 to /28. The client address pool must not conflict with the LocalSubnet or IPSec connection routes. The client address pool must not overlap with 100.64.0.0/10, 169.254.0.0/16, 127.0.0.0/8, 224.0.0.0/4, or 240.0.0.0/4. The number of available IPs in the client address pool must be greater than four times the number of SSL connections selected when creating the VPN gateway. For example, if the number of SSL connections is 10, the client address pool must have more than 40 available IPs.
- Compress bool
- Whether to compress transmitted data. true: Enable compression for communication. false (default): Do not compress communication.
- Creation
Time string - Time when the SSL server was created.
- Description string
- Description of the SSL server to be created. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), spaces ( ), underscores (_), hyphens (-), equals signs (=), English commas (,), Chinese commas (,), and Chinese periods (。). Length: 0 to 255 characters. If not specified, defaults to an empty string.
- Is
Blocked bool - Indicates whether the current resource is blocked. true: Blocked false: Not blocked.
- Local
Subnets []string - Local subnet of the SSL server. The local subnet is the address range accessed by clients through the SSL VPN connection. Note: Up to 5 local subnets can be specified, and they must not conflict with the ClientIpPool.
- Port int
- Port used by the SSL server. Default: 1194. Valid port range: 1 ~ 65535. The following ports are not supported: 22, 68, 179, 323, 500, 4500.
- Project
Name string - Project to which the SSL server belongs. If left blank, the default is default, meaning the created resource belongs to the default project.
- Protocol string
- Protocol used by the SSL server. Options: TCP (default): TCP protocol. UDP: UDP protocol.
- Ssl
Vpn stringServer Id - ID of the SSL server.
- Ssl
Vpn stringServer Name - Name of the SSL server to be created. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-). Length: 1 to 128 characters. If not specified, defaults to the SSL server ID.
- Status string
- Status of the SSL server. Available: Available Creating: Creating Pending: In progress Deleting: Deleting.
-
[]Ssl
Vpn Server Tag Args - Update
Time string - Modify the time of the SSL server.
- Vpn
Gateway stringId - ID of the VPN gateway used by the SSL server.
- auth string
- Authentication algorithm for the SSL server. SHA1 (default), MD5, None (no encryption).
- cipher string
- Encryption algorithm for the SSL server. AES-128-CBC (default) AES-192-CBC AES-256-CBC None (no encryption).
- client_
cert_ stringsession_ policy - Session policy for client certificates. AllowConcurrent: Reuse supported. PreemptExisting: Reuse not supported.
- client_
ip_ stringpool - SSL client address pool. In SSL VPN, the client address pool is the address range assigned to the client's virtual network interface, not the client's existing internal network segment. Client address pool mask range: /16 to /28. The client address pool must not conflict with the LocalSubnet or IPSec connection routes. The client address pool must not overlap with 100.64.0.0/10, 169.254.0.0/16, 127.0.0.0/8, 224.0.0.0/4, or 240.0.0.0/4. The number of available IPs in the client address pool must be greater than four times the number of SSL connections selected when creating the VPN gateway. For example, if the number of SSL connections is 10, the client address pool must have more than 40 available IPs.
- compress bool
- Whether to compress transmitted data. true: Enable compression for communication. false (default): Do not compress communication.
- creation_
time string - Time when the SSL server was created.
- description string
- Description of the SSL server to be created. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), spaces ( ), underscores (_), hyphens (-), equals signs (=), English commas (,), Chinese commas (,), and Chinese periods (。). Length: 0 to 255 characters. If not specified, defaults to an empty string.
- is_
blocked bool - Indicates whether the current resource is blocked. true: Blocked false: Not blocked.
- local_
subnets list(string) - Local subnet of the SSL server. The local subnet is the address range accessed by clients through the SSL VPN connection. Note: Up to 5 local subnets can be specified, and they must not conflict with the ClientIpPool.
- port number
- Port used by the SSL server. Default: 1194. Valid port range: 1 ~ 65535. The following ports are not supported: 22, 68, 179, 323, 500, 4500.
- project_
name string - Project to which the SSL server belongs. If left blank, the default is default, meaning the created resource belongs to the default project.
- protocol string
- Protocol used by the SSL server. Options: TCP (default): TCP protocol. UDP: UDP protocol.
- ssl_
vpn_ stringserver_ id - ID of the SSL server.
- ssl_
vpn_ stringserver_ name - Name of the SSL server to be created. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-). Length: 1 to 128 characters. If not specified, defaults to the SSL server ID.
- status string
- Status of the SSL server. Available: Available Creating: Creating Pending: In progress Deleting: Deleting.
- list(object)
- update_
time string - Modify the time of the SSL server.
- vpn_
gateway_ stringid - ID of the VPN gateway used by the SSL server.
- auth String
- Authentication algorithm for the SSL server. SHA1 (default), MD5, None (no encryption).
- cipher String
- Encryption algorithm for the SSL server. AES-128-CBC (default) AES-192-CBC AES-256-CBC None (no encryption).
- client
Cert StringSession Policy - Session policy for client certificates. AllowConcurrent: Reuse supported. PreemptExisting: Reuse not supported.
- client
Ip StringPool - SSL client address pool. In SSL VPN, the client address pool is the address range assigned to the client's virtual network interface, not the client's existing internal network segment. Client address pool mask range: /16 to /28. The client address pool must not conflict with the LocalSubnet or IPSec connection routes. The client address pool must not overlap with 100.64.0.0/10, 169.254.0.0/16, 127.0.0.0/8, 224.0.0.0/4, or 240.0.0.0/4. The number of available IPs in the client address pool must be greater than four times the number of SSL connections selected when creating the VPN gateway. For example, if the number of SSL connections is 10, the client address pool must have more than 40 available IPs.
- compress Boolean
- Whether to compress transmitted data. true: Enable compression for communication. false (default): Do not compress communication.
- creation
Time String - Time when the SSL server was created.
- description String
- Description of the SSL server to be created. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), spaces ( ), underscores (_), hyphens (-), equals signs (=), English commas (,), Chinese commas (,), and Chinese periods (。). Length: 0 to 255 characters. If not specified, defaults to an empty string.
- is
Blocked Boolean - Indicates whether the current resource is blocked. true: Blocked false: Not blocked.
- local
Subnets List<String> - Local subnet of the SSL server. The local subnet is the address range accessed by clients through the SSL VPN connection. Note: Up to 5 local subnets can be specified, and they must not conflict with the ClientIpPool.
- port Integer
- Port used by the SSL server. Default: 1194. Valid port range: 1 ~ 65535. The following ports are not supported: 22, 68, 179, 323, 500, 4500.
- project
Name String - Project to which the SSL server belongs. If left blank, the default is default, meaning the created resource belongs to the default project.
- protocol String
- Protocol used by the SSL server. Options: TCP (default): TCP protocol. UDP: UDP protocol.
- ssl
Vpn StringServer Id - ID of the SSL server.
- ssl
Vpn StringServer Name - Name of the SSL server to be created. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-). Length: 1 to 128 characters. If not specified, defaults to the SSL server ID.
- status String
- Status of the SSL server. Available: Available Creating: Creating Pending: In progress Deleting: Deleting.
-
List<Ssl
Vpn Server Tag> - update
Time String - Modify the time of the SSL server.
- vpn
Gateway StringId - ID of the VPN gateway used by the SSL server.
- auth string
- Authentication algorithm for the SSL server. SHA1 (default), MD5, None (no encryption).
- cipher string
- Encryption algorithm for the SSL server. AES-128-CBC (default) AES-192-CBC AES-256-CBC None (no encryption).
- client
Cert stringSession Policy - Session policy for client certificates. AllowConcurrent: Reuse supported. PreemptExisting: Reuse not supported.
- client
Ip stringPool - SSL client address pool. In SSL VPN, the client address pool is the address range assigned to the client's virtual network interface, not the client's existing internal network segment. Client address pool mask range: /16 to /28. The client address pool must not conflict with the LocalSubnet or IPSec connection routes. The client address pool must not overlap with 100.64.0.0/10, 169.254.0.0/16, 127.0.0.0/8, 224.0.0.0/4, or 240.0.0.0/4. The number of available IPs in the client address pool must be greater than four times the number of SSL connections selected when creating the VPN gateway. For example, if the number of SSL connections is 10, the client address pool must have more than 40 available IPs.
- compress boolean
- Whether to compress transmitted data. true: Enable compression for communication. false (default): Do not compress communication.
- creation
Time string - Time when the SSL server was created.
- description string
- Description of the SSL server to be created. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), spaces ( ), underscores (_), hyphens (-), equals signs (=), English commas (,), Chinese commas (,), and Chinese periods (。). Length: 0 to 255 characters. If not specified, defaults to an empty string.
- is
Blocked boolean - Indicates whether the current resource is blocked. true: Blocked false: Not blocked.
- local
Subnets string[] - Local subnet of the SSL server. The local subnet is the address range accessed by clients through the SSL VPN connection. Note: Up to 5 local subnets can be specified, and they must not conflict with the ClientIpPool.
- port number
- Port used by the SSL server. Default: 1194. Valid port range: 1 ~ 65535. The following ports are not supported: 22, 68, 179, 323, 500, 4500.
- project
Name string - Project to which the SSL server belongs. If left blank, the default is default, meaning the created resource belongs to the default project.
- protocol string
- Protocol used by the SSL server. Options: TCP (default): TCP protocol. UDP: UDP protocol.
- ssl
Vpn stringServer Id - ID of the SSL server.
- ssl
Vpn stringServer Name - Name of the SSL server to be created. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-). Length: 1 to 128 characters. If not specified, defaults to the SSL server ID.
- status string
- Status of the SSL server. Available: Available Creating: Creating Pending: In progress Deleting: Deleting.
-
Ssl
Vpn Server Tag[] - update
Time string - Modify the time of the SSL server.
- vpn
Gateway stringId - ID of the VPN gateway used by the SSL server.
- auth str
- Authentication algorithm for the SSL server. SHA1 (default), MD5, None (no encryption).
- cipher str
- Encryption algorithm for the SSL server. AES-128-CBC (default) AES-192-CBC AES-256-CBC None (no encryption).
- client_
cert_ strsession_ policy - Session policy for client certificates. AllowConcurrent: Reuse supported. PreemptExisting: Reuse not supported.
- client_
ip_ strpool - SSL client address pool. In SSL VPN, the client address pool is the address range assigned to the client's virtual network interface, not the client's existing internal network segment. Client address pool mask range: /16 to /28. The client address pool must not conflict with the LocalSubnet or IPSec connection routes. The client address pool must not overlap with 100.64.0.0/10, 169.254.0.0/16, 127.0.0.0/8, 224.0.0.0/4, or 240.0.0.0/4. The number of available IPs in the client address pool must be greater than four times the number of SSL connections selected when creating the VPN gateway. For example, if the number of SSL connections is 10, the client address pool must have more than 40 available IPs.
- compress bool
- Whether to compress transmitted data. true: Enable compression for communication. false (default): Do not compress communication.
- creation_
time str - Time when the SSL server was created.
- description str
- Description of the SSL server to be created. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), spaces ( ), underscores (_), hyphens (-), equals signs (=), English commas (,), Chinese commas (,), and Chinese periods (。). Length: 0 to 255 characters. If not specified, defaults to an empty string.
- is_
blocked bool - Indicates whether the current resource is blocked. true: Blocked false: Not blocked.
- local_
subnets Sequence[str] - Local subnet of the SSL server. The local subnet is the address range accessed by clients through the SSL VPN connection. Note: Up to 5 local subnets can be specified, and they must not conflict with the ClientIpPool.
- port int
- Port used by the SSL server. Default: 1194. Valid port range: 1 ~ 65535. The following ports are not supported: 22, 68, 179, 323, 500, 4500.
- project_
name str - Project to which the SSL server belongs. If left blank, the default is default, meaning the created resource belongs to the default project.
- protocol str
- Protocol used by the SSL server. Options: TCP (default): TCP protocol. UDP: UDP protocol.
- ssl_
vpn_ strserver_ id - ID of the SSL server.
- ssl_
vpn_ strserver_ name - Name of the SSL server to be created. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-). Length: 1 to 128 characters. If not specified, defaults to the SSL server ID.
- status str
- Status of the SSL server. Available: Available Creating: Creating Pending: In progress Deleting: Deleting.
-
Sequence[Ssl
Vpn Server Tag Args] - update_
time str - Modify the time of the SSL server.
- vpn_
gateway_ strid - ID of the VPN gateway used by the SSL server.
- auth String
- Authentication algorithm for the SSL server. SHA1 (default), MD5, None (no encryption).
- cipher String
- Encryption algorithm for the SSL server. AES-128-CBC (default) AES-192-CBC AES-256-CBC None (no encryption).
- client
Cert StringSession Policy - Session policy for client certificates. AllowConcurrent: Reuse supported. PreemptExisting: Reuse not supported.
- client
Ip StringPool - SSL client address pool. In SSL VPN, the client address pool is the address range assigned to the client's virtual network interface, not the client's existing internal network segment. Client address pool mask range: /16 to /28. The client address pool must not conflict with the LocalSubnet or IPSec connection routes. The client address pool must not overlap with 100.64.0.0/10, 169.254.0.0/16, 127.0.0.0/8, 224.0.0.0/4, or 240.0.0.0/4. The number of available IPs in the client address pool must be greater than four times the number of SSL connections selected when creating the VPN gateway. For example, if the number of SSL connections is 10, the client address pool must have more than 40 available IPs.
- compress Boolean
- Whether to compress transmitted data. true: Enable compression for communication. false (default): Do not compress communication.
- creation
Time String - Time when the SSL server was created.
- description String
- Description of the SSL server to be created. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), spaces ( ), underscores (_), hyphens (-), equals signs (=), English commas (,), Chinese commas (,), and Chinese periods (。). Length: 0 to 255 characters. If not specified, defaults to an empty string.
- is
Blocked Boolean - Indicates whether the current resource is blocked. true: Blocked false: Not blocked.
- local
Subnets List<String> - Local subnet of the SSL server. The local subnet is the address range accessed by clients through the SSL VPN connection. Note: Up to 5 local subnets can be specified, and they must not conflict with the ClientIpPool.
- port Number
- Port used by the SSL server. Default: 1194. Valid port range: 1 ~ 65535. The following ports are not supported: 22, 68, 179, 323, 500, 4500.
- project
Name String - Project to which the SSL server belongs. If left blank, the default is default, meaning the created resource belongs to the default project.
- protocol String
- Protocol used by the SSL server. Options: TCP (default): TCP protocol. UDP: UDP protocol.
- ssl
Vpn StringServer Id - ID of the SSL server.
- ssl
Vpn StringServer Name - Name of the SSL server to be created. Must start with a Chinese character, letter, or number, and can only contain Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-). Length: 1 to 128 characters. If not specified, defaults to the SSL server ID.
- status String
- Status of the SSL server. Available: Available Creating: Creating Pending: In progress Deleting: Deleting.
- List<Property Map>
- update
Time String - Modify the time of the SSL server.
- vpn
Gateway StringId - ID of the VPN gateway used by the SSL server.
Supporting Types
SslVpnServerTag, SslVpnServerTagArgs
- Key string
- Tag key for the SSL server label (Key). Naming rules: Must not start with any case combination of sys:. Only letters, numbers, spaces, and the following English symbols are allowed: "_", ".", ":", "/", "=", "+", "-", "@". Length must be between 1 and 128 characters. Note: Tag keys for the same resource must be unique.
- Value string
- Tag value for the SSL server label (Value). Naming rules: Only letters, numbers, spaces, and the following English symbols are allowed: "_", ".", ":", "/", "=", "+", "-", "@". Can be empty. Length must be between 0 and 256 characters. Case sensitive. Cannot start or end with a space. Note: If Tags.N.Value is provided, Tags.N.Key must also be provided.
- Key string
- Tag key for the SSL server label (Key). Naming rules: Must not start with any case combination of sys:. Only letters, numbers, spaces, and the following English symbols are allowed: "_", ".", ":", "/", "=", "+", "-", "@". Length must be between 1 and 128 characters. Note: Tag keys for the same resource must be unique.
- Value string
- Tag value for the SSL server label (Value). Naming rules: Only letters, numbers, spaces, and the following English symbols are allowed: "_", ".", ":", "/", "=", "+", "-", "@". Can be empty. Length must be between 0 and 256 characters. Case sensitive. Cannot start or end with a space. Note: If Tags.N.Value is provided, Tags.N.Key must also be provided.
- key string
- Tag key for the SSL server label (Key). Naming rules: Must not start with any case combination of sys:. Only letters, numbers, spaces, and the following English symbols are allowed: "_", ".", ":", "/", "=", "+", "-", "@". Length must be between 1 and 128 characters. Note: Tag keys for the same resource must be unique.
- value string
- Tag value for the SSL server label (Value). Naming rules: Only letters, numbers, spaces, and the following English symbols are allowed: "_", ".", ":", "/", "=", "+", "-", "@". Can be empty. Length must be between 0 and 256 characters. Case sensitive. Cannot start or end with a space. Note: If Tags.N.Value is provided, Tags.N.Key must also be provided.
- key String
- Tag key for the SSL server label (Key). Naming rules: Must not start with any case combination of sys:. Only letters, numbers, spaces, and the following English symbols are allowed: "_", ".", ":", "/", "=", "+", "-", "@". Length must be between 1 and 128 characters. Note: Tag keys for the same resource must be unique.
- value String
- Tag value for the SSL server label (Value). Naming rules: Only letters, numbers, spaces, and the following English symbols are allowed: "_", ".", ":", "/", "=", "+", "-", "@". Can be empty. Length must be between 0 and 256 characters. Case sensitive. Cannot start or end with a space. Note: If Tags.N.Value is provided, Tags.N.Key must also be provided.
- key string
- Tag key for the SSL server label (Key). Naming rules: Must not start with any case combination of sys:. Only letters, numbers, spaces, and the following English symbols are allowed: "_", ".", ":", "/", "=", "+", "-", "@". Length must be between 1 and 128 characters. Note: Tag keys for the same resource must be unique.
- value string
- Tag value for the SSL server label (Value). Naming rules: Only letters, numbers, spaces, and the following English symbols are allowed: "_", ".", ":", "/", "=", "+", "-", "@". Can be empty. Length must be between 0 and 256 characters. Case sensitive. Cannot start or end with a space. Note: If Tags.N.Value is provided, Tags.N.Key must also be provided.
- key str
- Tag key for the SSL server label (Key). Naming rules: Must not start with any case combination of sys:. Only letters, numbers, spaces, and the following English symbols are allowed: "_", ".", ":", "/", "=", "+", "-", "@". Length must be between 1 and 128 characters. Note: Tag keys for the same resource must be unique.
- value str
- Tag value for the SSL server label (Value). Naming rules: Only letters, numbers, spaces, and the following English symbols are allowed: "_", ".", ":", "/", "=", "+", "-", "@". Can be empty. Length must be between 0 and 256 characters. Case sensitive. Cannot start or end with a space. Note: If Tags.N.Value is provided, Tags.N.Key must also be provided.
- key String
- Tag key for the SSL server label (Key). Naming rules: Must not start with any case combination of sys:. Only letters, numbers, spaces, and the following English symbols are allowed: "_", ".", ":", "/", "=", "+", "-", "@". Length must be between 1 and 128 characters. Note: Tag keys for the same resource must be unique.
- value String
- Tag value for the SSL server label (Value). Naming rules: Only letters, numbers, spaces, and the following English symbols are allowed: "_", ".", ":", "/", "=", "+", "-", "@". Can be empty. Length must be between 0 and 256 characters. Case sensitive. Cannot start or end with a space. Note: If Tags.N.Value is provided, Tags.N.Key must also be provided.
Import
$ pulumi import bytepluscc:vpn/sslVpnServer:SslVpnServer example "ssl_vpn_server_id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- bytepluscc byteplus-sdk/pulumi-bytepluscc
- License
- MPL-2.0
- Notes
- This Pulumi package is based on the
byteplusccTerraform Provider.
published on Monday, May 25, 2026 by Byteplus