1. Packages
  2. Alicloud Provider
  3. API Docs
  4. vpn
  5. SslVpnServer
Alibaba Cloud v3.62.1 published on Monday, Sep 16, 2024 by Pulumi

alicloud.vpn.SslVpnServer

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.62.1 published on Monday, Sep 16, 2024 by Pulumi

    Example Usage

    Basic Usage

    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,
                     client_ip_pool: Optional[str] = None,
                     local_subnet: Optional[str] = None,
                     vpn_gateway_id: Optional[str] = None,
                     cipher: Optional[str] = None,
                     compress: Optional[bool] = None,
                     name: Optional[str] = None,
                     port: Optional[int] = None,
                     protocol: Optional[str] = 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: alicloud:vpn:SslVpnServer
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    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 AliCloud.Vpn.SslVpnServer("sslVpnServerResource", new()
    {
        ClientIpPool = "string",
        LocalSubnet = "string",
        VpnGatewayId = "string",
        Cipher = "string",
        Compress = false,
        Name = "string",
        Port = 0,
        Protocol = "string",
    });
    
    example, err := vpn.NewSslVpnServer(ctx, "sslVpnServerResource", &vpn.SslVpnServerArgs{
    	ClientIpPool: pulumi.String("string"),
    	LocalSubnet:  pulumi.String("string"),
    	VpnGatewayId: pulumi.String("string"),
    	Cipher:       pulumi.String("string"),
    	Compress:     pulumi.Bool(false),
    	Name:         pulumi.String("string"),
    	Port:         pulumi.Int(0),
    	Protocol:     pulumi.String("string"),
    })
    
    var sslVpnServerResource = new SslVpnServer("sslVpnServerResource", SslVpnServerArgs.builder()
        .clientIpPool("string")
        .localSubnet("string")
        .vpnGatewayId("string")
        .cipher("string")
        .compress(false)
        .name("string")
        .port(0)
        .protocol("string")
        .build());
    
    ssl_vpn_server_resource = alicloud.vpn.SslVpnServer("sslVpnServerResource",
        client_ip_pool="string",
        local_subnet="string",
        vpn_gateway_id="string",
        cipher="string",
        compress=False,
        name="string",
        port=0,
        protocol="string")
    
    const sslVpnServerResource = new alicloud.vpn.SslVpnServer("sslVpnServerResource", {
        clientIpPool: "string",
        localSubnet: "string",
        vpnGatewayId: "string",
        cipher: "string",
        compress: false,
        name: "string",
        port: 0,
        protocol: "string",
    });
    
    type: alicloud:vpn:SslVpnServer
    properties:
        cipher: string
        clientIpPool: string
        compress: false
        localSubnet: string
        name: string
        port: 0
        protocol: 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

    The SslVpnServer resource accepts the following input properties:

    ClientIpPool string
    The CIDR block from which access addresses are allocated to the virtual network interface card of the client.
    LocalSubnet string
    The CIDR block to be accessed by the client through the SSL-VPN connection. It supports to set multi CIDRs by comma join ways, like 10.0.1.0/24,10.0.2.0/24,10.0.3.0/24.
    VpnGatewayId string
    The ID of the VPN gateway.
    Cipher string
    The encryption algorithm that is used in the SSL-VPN connection. Valid values: AES-128-CBC,AES-192-CBC,AES-256-CBC,none. Default value: AES-128-CBC.

    • AES-128-CBC - the AES-128-CBC algorithm.
    • AES-192-CBC - the AES-192-CBC algorithm.
    • AES-256-CBC - the AES-256-CBC algorithm.
    Compress bool
    Specifies whether to enable data compression. Valid values: true,false. Default value: false
    Name string
    The name of the SSL-VPN server.
    Port int
    The port used by the SSL-VPN server. The default value is 1194.The following ports cannot be used: [22, 2222, 22222, 9000, 9001, 9002, 7505, 80, 443, 53, 68, 123, 4510, 4560, 500, 4500].
    Protocol string
    The protocol used by the SSL-VPN server. Valid value: UDP(default) |TCP
    ClientIpPool string
    The CIDR block from which access addresses are allocated to the virtual network interface card of the client.
    LocalSubnet string
    The CIDR block to be accessed by the client through the SSL-VPN connection. It supports to set multi CIDRs by comma join ways, like 10.0.1.0/24,10.0.2.0/24,10.0.3.0/24.
    VpnGatewayId string
    The ID of the VPN gateway.
    Cipher string
    The encryption algorithm that is used in the SSL-VPN connection. Valid values: AES-128-CBC,AES-192-CBC,AES-256-CBC,none. Default value: AES-128-CBC.

    • AES-128-CBC - the AES-128-CBC algorithm.
    • AES-192-CBC - the AES-192-CBC algorithm.
    • AES-256-CBC - the AES-256-CBC algorithm.
    Compress bool
    Specifies whether to enable data compression. Valid values: true,false. Default value: false
    Name string
    The name of the SSL-VPN server.
    Port int
    The port used by the SSL-VPN server. The default value is 1194.The following ports cannot be used: [22, 2222, 22222, 9000, 9001, 9002, 7505, 80, 443, 53, 68, 123, 4510, 4560, 500, 4500].
    Protocol string
    The protocol used by the SSL-VPN server. Valid value: UDP(default) |TCP
    clientIpPool String
    The CIDR block from which access addresses are allocated to the virtual network interface card of the client.
    localSubnet String
    The CIDR block to be accessed by the client through the SSL-VPN connection. It supports to set multi CIDRs by comma join ways, like 10.0.1.0/24,10.0.2.0/24,10.0.3.0/24.
    vpnGatewayId String
    The ID of the VPN gateway.
    cipher String
    The encryption algorithm that is used in the SSL-VPN connection. Valid values: AES-128-CBC,AES-192-CBC,AES-256-CBC,none. Default value: AES-128-CBC.

    • AES-128-CBC - the AES-128-CBC algorithm.
    • AES-192-CBC - the AES-192-CBC algorithm.
    • AES-256-CBC - the AES-256-CBC algorithm.
    compress Boolean
    Specifies whether to enable data compression. Valid values: true,false. Default value: false
    name String
    The name of the SSL-VPN server.
    port Integer
    The port used by the SSL-VPN server. The default value is 1194.The following ports cannot be used: [22, 2222, 22222, 9000, 9001, 9002, 7505, 80, 443, 53, 68, 123, 4510, 4560, 500, 4500].
    protocol String
    The protocol used by the SSL-VPN server. Valid value: UDP(default) |TCP
    clientIpPool string
    The CIDR block from which access addresses are allocated to the virtual network interface card of the client.
    localSubnet string
    The CIDR block to be accessed by the client through the SSL-VPN connection. It supports to set multi CIDRs by comma join ways, like 10.0.1.0/24,10.0.2.0/24,10.0.3.0/24.
    vpnGatewayId string
    The ID of the VPN gateway.
    cipher string
    The encryption algorithm that is used in the SSL-VPN connection. Valid values: AES-128-CBC,AES-192-CBC,AES-256-CBC,none. Default value: AES-128-CBC.

    • AES-128-CBC - the AES-128-CBC algorithm.
    • AES-192-CBC - the AES-192-CBC algorithm.
    • AES-256-CBC - the AES-256-CBC algorithm.
    compress boolean
    Specifies whether to enable data compression. Valid values: true,false. Default value: false
    name string
    The name of the SSL-VPN server.
    port number
    The port used by the SSL-VPN server. The default value is 1194.The following ports cannot be used: [22, 2222, 22222, 9000, 9001, 9002, 7505, 80, 443, 53, 68, 123, 4510, 4560, 500, 4500].
    protocol string
    The protocol used by the SSL-VPN server. Valid value: UDP(default) |TCP
    client_ip_pool str
    The CIDR block from which access addresses are allocated to the virtual network interface card of the client.
    local_subnet str
    The CIDR block to be accessed by the client through the SSL-VPN connection. It supports to set multi CIDRs by comma join ways, like 10.0.1.0/24,10.0.2.0/24,10.0.3.0/24.
    vpn_gateway_id str
    The ID of the VPN gateway.
    cipher str
    The encryption algorithm that is used in the SSL-VPN connection. Valid values: AES-128-CBC,AES-192-CBC,AES-256-CBC,none. Default value: AES-128-CBC.

    • AES-128-CBC - the AES-128-CBC algorithm.
    • AES-192-CBC - the AES-192-CBC algorithm.
    • AES-256-CBC - the AES-256-CBC algorithm.
    compress bool
    Specifies whether to enable data compression. Valid values: true,false. Default value: false
    name str
    The name of the SSL-VPN server.
    port int
    The port used by the SSL-VPN server. The default value is 1194.The following ports cannot be used: [22, 2222, 22222, 9000, 9001, 9002, 7505, 80, 443, 53, 68, 123, 4510, 4560, 500, 4500].
    protocol str
    The protocol used by the SSL-VPN server. Valid value: UDP(default) |TCP
    clientIpPool String
    The CIDR block from which access addresses are allocated to the virtual network interface card of the client.
    localSubnet String
    The CIDR block to be accessed by the client through the SSL-VPN connection. It supports to set multi CIDRs by comma join ways, like 10.0.1.0/24,10.0.2.0/24,10.0.3.0/24.
    vpnGatewayId String
    The ID of the VPN gateway.
    cipher String
    The encryption algorithm that is used in the SSL-VPN connection. Valid values: AES-128-CBC,AES-192-CBC,AES-256-CBC,none. Default value: AES-128-CBC.

    • AES-128-CBC - the AES-128-CBC algorithm.
    • AES-192-CBC - the AES-192-CBC algorithm.
    • AES-256-CBC - the AES-256-CBC algorithm.
    compress Boolean
    Specifies whether to enable data compression. Valid values: true,false. Default value: false
    name String
    The name of the SSL-VPN server.
    port Number
    The port used by the SSL-VPN server. The default value is 1194.The following ports cannot be used: [22, 2222, 22222, 9000, 9001, 9002, 7505, 80, 443, 53, 68, 123, 4510, 4560, 500, 4500].
    protocol String
    The protocol used by the SSL-VPN server. Valid value: UDP(default) |TCP

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SslVpnServer resource produces the following output properties:

    Connections int
    The number of current connections.
    Id string
    The provider-assigned unique ID for this managed resource.
    InternetIp string
    The internet IP of the SSL-VPN server.
    MaxConnections int
    The maximum number of connections.
    Connections int
    The number of current connections.
    Id string
    The provider-assigned unique ID for this managed resource.
    InternetIp string
    The internet IP of the SSL-VPN server.
    MaxConnections int
    The maximum number of connections.
    connections Integer
    The number of current connections.
    id String
    The provider-assigned unique ID for this managed resource.
    internetIp String
    The internet IP of the SSL-VPN server.
    maxConnections Integer
    The maximum number of connections.
    connections number
    The number of current connections.
    id string
    The provider-assigned unique ID for this managed resource.
    internetIp string
    The internet IP of the SSL-VPN server.
    maxConnections number
    The maximum number of connections.
    connections int
    The number of current connections.
    id str
    The provider-assigned unique ID for this managed resource.
    internet_ip str
    The internet IP of the SSL-VPN server.
    max_connections int
    The maximum number of connections.
    connections Number
    The number of current connections.
    id String
    The provider-assigned unique ID for this managed resource.
    internetIp String
    The internet IP of the SSL-VPN server.
    maxConnections Number
    The maximum number of connections.

    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,
            cipher: Optional[str] = None,
            client_ip_pool: Optional[str] = None,
            compress: Optional[bool] = None,
            connections: Optional[int] = None,
            internet_ip: Optional[str] = None,
            local_subnet: Optional[str] = None,
            max_connections: Optional[int] = None,
            name: Optional[str] = None,
            port: Optional[int] = None,
            protocol: Optional[str] = None,
            vpn_gateway_id: Optional[str] = None) -> SslVpnServer
    func 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)
    Resource lookup is not supported in YAML
    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.
    The following state arguments are supported:
    Cipher string
    The encryption algorithm that is used in the SSL-VPN connection. Valid values: AES-128-CBC,AES-192-CBC,AES-256-CBC,none. Default value: AES-128-CBC.

    • AES-128-CBC - the AES-128-CBC algorithm.
    • AES-192-CBC - the AES-192-CBC algorithm.
    • AES-256-CBC - the AES-256-CBC algorithm.
    ClientIpPool string
    The CIDR block from which access addresses are allocated to the virtual network interface card of the client.
    Compress bool
    Specifies whether to enable data compression. Valid values: true,false. Default value: false
    Connections int
    The number of current connections.
    InternetIp string
    The internet IP of the SSL-VPN server.
    LocalSubnet string
    The CIDR block to be accessed by the client through the SSL-VPN connection. It supports to set multi CIDRs by comma join ways, like 10.0.1.0/24,10.0.2.0/24,10.0.3.0/24.
    MaxConnections int
    The maximum number of connections.
    Name string
    The name of the SSL-VPN server.
    Port int
    The port used by the SSL-VPN server. The default value is 1194.The following ports cannot be used: [22, 2222, 22222, 9000, 9001, 9002, 7505, 80, 443, 53, 68, 123, 4510, 4560, 500, 4500].
    Protocol string
    The protocol used by the SSL-VPN server. Valid value: UDP(default) |TCP
    VpnGatewayId string
    The ID of the VPN gateway.
    Cipher string
    The encryption algorithm that is used in the SSL-VPN connection. Valid values: AES-128-CBC,AES-192-CBC,AES-256-CBC,none. Default value: AES-128-CBC.

    • AES-128-CBC - the AES-128-CBC algorithm.
    • AES-192-CBC - the AES-192-CBC algorithm.
    • AES-256-CBC - the AES-256-CBC algorithm.
    ClientIpPool string
    The CIDR block from which access addresses are allocated to the virtual network interface card of the client.
    Compress bool
    Specifies whether to enable data compression. Valid values: true,false. Default value: false
    Connections int
    The number of current connections.
    InternetIp string
    The internet IP of the SSL-VPN server.
    LocalSubnet string
    The CIDR block to be accessed by the client through the SSL-VPN connection. It supports to set multi CIDRs by comma join ways, like 10.0.1.0/24,10.0.2.0/24,10.0.3.0/24.
    MaxConnections int
    The maximum number of connections.
    Name string
    The name of the SSL-VPN server.
    Port int
    The port used by the SSL-VPN server. The default value is 1194.The following ports cannot be used: [22, 2222, 22222, 9000, 9001, 9002, 7505, 80, 443, 53, 68, 123, 4510, 4560, 500, 4500].
    Protocol string
    The protocol used by the SSL-VPN server. Valid value: UDP(default) |TCP
    VpnGatewayId string
    The ID of the VPN gateway.
    cipher String
    The encryption algorithm that is used in the SSL-VPN connection. Valid values: AES-128-CBC,AES-192-CBC,AES-256-CBC,none. Default value: AES-128-CBC.

    • AES-128-CBC - the AES-128-CBC algorithm.
    • AES-192-CBC - the AES-192-CBC algorithm.
    • AES-256-CBC - the AES-256-CBC algorithm.
    clientIpPool String
    The CIDR block from which access addresses are allocated to the virtual network interface card of the client.
    compress Boolean
    Specifies whether to enable data compression. Valid values: true,false. Default value: false
    connections Integer
    The number of current connections.
    internetIp String
    The internet IP of the SSL-VPN server.
    localSubnet String
    The CIDR block to be accessed by the client through the SSL-VPN connection. It supports to set multi CIDRs by comma join ways, like 10.0.1.0/24,10.0.2.0/24,10.0.3.0/24.
    maxConnections Integer
    The maximum number of connections.
    name String
    The name of the SSL-VPN server.
    port Integer
    The port used by the SSL-VPN server. The default value is 1194.The following ports cannot be used: [22, 2222, 22222, 9000, 9001, 9002, 7505, 80, 443, 53, 68, 123, 4510, 4560, 500, 4500].
    protocol String
    The protocol used by the SSL-VPN server. Valid value: UDP(default) |TCP
    vpnGatewayId String
    The ID of the VPN gateway.
    cipher string
    The encryption algorithm that is used in the SSL-VPN connection. Valid values: AES-128-CBC,AES-192-CBC,AES-256-CBC,none. Default value: AES-128-CBC.

    • AES-128-CBC - the AES-128-CBC algorithm.
    • AES-192-CBC - the AES-192-CBC algorithm.
    • AES-256-CBC - the AES-256-CBC algorithm.
    clientIpPool string
    The CIDR block from which access addresses are allocated to the virtual network interface card of the client.
    compress boolean
    Specifies whether to enable data compression. Valid values: true,false. Default value: false
    connections number
    The number of current connections.
    internetIp string
    The internet IP of the SSL-VPN server.
    localSubnet string
    The CIDR block to be accessed by the client through the SSL-VPN connection. It supports to set multi CIDRs by comma join ways, like 10.0.1.0/24,10.0.2.0/24,10.0.3.0/24.
    maxConnections number
    The maximum number of connections.
    name string
    The name of the SSL-VPN server.
    port number
    The port used by the SSL-VPN server. The default value is 1194.The following ports cannot be used: [22, 2222, 22222, 9000, 9001, 9002, 7505, 80, 443, 53, 68, 123, 4510, 4560, 500, 4500].
    protocol string
    The protocol used by the SSL-VPN server. Valid value: UDP(default) |TCP
    vpnGatewayId string
    The ID of the VPN gateway.
    cipher str
    The encryption algorithm that is used in the SSL-VPN connection. Valid values: AES-128-CBC,AES-192-CBC,AES-256-CBC,none. Default value: AES-128-CBC.

    • AES-128-CBC - the AES-128-CBC algorithm.
    • AES-192-CBC - the AES-192-CBC algorithm.
    • AES-256-CBC - the AES-256-CBC algorithm.
    client_ip_pool str
    The CIDR block from which access addresses are allocated to the virtual network interface card of the client.
    compress bool
    Specifies whether to enable data compression. Valid values: true,false. Default value: false
    connections int
    The number of current connections.
    internet_ip str
    The internet IP of the SSL-VPN server.
    local_subnet str
    The CIDR block to be accessed by the client through the SSL-VPN connection. It supports to set multi CIDRs by comma join ways, like 10.0.1.0/24,10.0.2.0/24,10.0.3.0/24.
    max_connections int
    The maximum number of connections.
    name str
    The name of the SSL-VPN server.
    port int
    The port used by the SSL-VPN server. The default value is 1194.The following ports cannot be used: [22, 2222, 22222, 9000, 9001, 9002, 7505, 80, 443, 53, 68, 123, 4510, 4560, 500, 4500].
    protocol str
    The protocol used by the SSL-VPN server. Valid value: UDP(default) |TCP
    vpn_gateway_id str
    The ID of the VPN gateway.
    cipher String
    The encryption algorithm that is used in the SSL-VPN connection. Valid values: AES-128-CBC,AES-192-CBC,AES-256-CBC,none. Default value: AES-128-CBC.

    • AES-128-CBC - the AES-128-CBC algorithm.
    • AES-192-CBC - the AES-192-CBC algorithm.
    • AES-256-CBC - the AES-256-CBC algorithm.
    clientIpPool String
    The CIDR block from which access addresses are allocated to the virtual network interface card of the client.
    compress Boolean
    Specifies whether to enable data compression. Valid values: true,false. Default value: false
    connections Number
    The number of current connections.
    internetIp String
    The internet IP of the SSL-VPN server.
    localSubnet String
    The CIDR block to be accessed by the client through the SSL-VPN connection. It supports to set multi CIDRs by comma join ways, like 10.0.1.0/24,10.0.2.0/24,10.0.3.0/24.
    maxConnections Number
    The maximum number of connections.
    name String
    The name of the SSL-VPN server.
    port Number
    The port used by the SSL-VPN server. The default value is 1194.The following ports cannot be used: [22, 2222, 22222, 9000, 9001, 9002, 7505, 80, 443, 53, 68, 123, 4510, 4560, 500, 4500].
    protocol String
    The protocol used by the SSL-VPN server. Valid value: UDP(default) |TCP
    vpnGatewayId String
    The ID of the VPN gateway.

    Import

    SSL-VPN server can be imported using the id, e.g.

    $ pulumi import alicloud:vpn/sslVpnServer:SslVpnServer example vss-abc123456
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.62.1 published on Monday, Sep 16, 2024 by Pulumi