Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. IsVpnServer
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.IsVpnServer

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Provides a resource for VPNServer. This allows VPNServer to be created, updated and deleted. For more information, about VPN Server, see Creating a VPN server.

    Example Usage

    The following example creates a VPN Server:

    import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const example = new ibm.IsVpnServer("example", {
    certificateCrn: "crn:v1:bluemix:public:cloudcerts:us-south:a/efe5afc483594adaa8325e2b4d1290df:86f62739-f3a8-42ac-abea-f23255965983:certificate:00406b5615f95dba9bf7c2ab52bb3083",
    clientAuthentications: [{
        method: "certificate",
        clientCaCrn: "crn:v1:bluemix:public:cloudcerts:us-south:a/efe5afc483594adaa8325e2b4d1290df:86f62739-f3a8-42ac-abea-f23255965983:certificate:00406b5615f95dba9bf7c2ab52bb3083",
    }],
    clientIpPool: "10.5.0.0/21",
    clientDnsServerIps: ["192.168.3.4"],
    clientIdleTimeout: 2800,
    enableSplitTunneling: false,
    port: 443,
    protocol: "udp",
    subnets: [ibm_is_subnet.subnet1.id],
});

    import pulumi
import pulumi_ibm as ibm

example = ibm.IsVpnServer("example",
    certificate_crn="crn:v1:bluemix:public:cloudcerts:us-south:a/efe5afc483594adaa8325e2b4d1290df:86f62739-f3a8-42ac-abea-f23255965983:certificate:00406b5615f95dba9bf7c2ab52bb3083",
    client_authentications=[{
        "method": "certificate",
        "client_ca_crn": "crn:v1:bluemix:public:cloudcerts:us-south:a/efe5afc483594adaa8325e2b4d1290df:86f62739-f3a8-42ac-abea-f23255965983:certificate:00406b5615f95dba9bf7c2ab52bb3083",
    }],
    client_ip_pool="10.5.0.0/21",
    client_dns_server_ips=["192.168.3.4"],
    client_idle_timeout=2800,
    enable_split_tunneling=False,
    port=443,
    protocol="udp",
    subnets=[ibm_is_subnet["subnet1"]["id"]])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewIsVpnServer(ctx, "example", &ibm.IsVpnServerArgs{
			CertificateCrn: pulumi.String("crn:v1:bluemix:public:cloudcerts:us-south:a/efe5afc483594adaa8325e2b4d1290df:86f62739-f3a8-42ac-abea-f23255965983:certificate:00406b5615f95dba9bf7c2ab52bb3083"),
			ClientAuthentications: ibm.IsVpnServerClientAuthenticationArray{
				&ibm.IsVpnServerClientAuthenticationArgs{
					Method:      pulumi.String("certificate"),
					ClientCaCrn: pulumi.String("crn:v1:bluemix:public:cloudcerts:us-south:a/efe5afc483594adaa8325e2b4d1290df:86f62739-f3a8-42ac-abea-f23255965983:certificate:00406b5615f95dba9bf7c2ab52bb3083"),
				},
			},
			ClientIpPool: pulumi.String("10.5.0.0/21"),
			ClientDnsServerIps: pulumi.StringArray{
				pulumi.String("192.168.3.4"),
			},
			ClientIdleTimeout:    pulumi.Float64(2800),
			EnableSplitTunneling: pulumi.Bool(false),
			Port:                 pulumi.Float64(443),
			Protocol:             pulumi.String("udp"),
			Subnets: pulumi.StringArray{
				ibm_is_subnet.Subnet1.Id,
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var example = new Ibm.IsVpnServer("example", new()
    {
        CertificateCrn = "crn:v1:bluemix:public:cloudcerts:us-south:a/efe5afc483594adaa8325e2b4d1290df:86f62739-f3a8-42ac-abea-f23255965983:certificate:00406b5615f95dba9bf7c2ab52bb3083",
        ClientAuthentications = new[]
        {
            new Ibm.Inputs.IsVpnServerClientAuthenticationArgs
            {
                Method = "certificate",
                ClientCaCrn = "crn:v1:bluemix:public:cloudcerts:us-south:a/efe5afc483594adaa8325e2b4d1290df:86f62739-f3a8-42ac-abea-f23255965983:certificate:00406b5615f95dba9bf7c2ab52bb3083",
            },
        },
        ClientIpPool = "10.5.0.0/21",
        ClientDnsServerIps = new[]
        {
            "192.168.3.4",
        },
        ClientIdleTimeout = 2800,
        EnableSplitTunneling = false,
        Port = 443,
        Protocol = "udp",
        Subnets = new[]
        {
            ibm_is_subnet.Subnet1.Id,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IsVpnServer;
import com.pulumi.ibm.IsVpnServerArgs;
import com.pulumi.ibm.inputs.IsVpnServerClientAuthenticationArgs;
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 example = new IsVpnServer("example", IsVpnServerArgs.builder()
            .certificateCrn("crn:v1:bluemix:public:cloudcerts:us-south:a/efe5afc483594adaa8325e2b4d1290df:86f62739-f3a8-42ac-abea-f23255965983:certificate:00406b5615f95dba9bf7c2ab52bb3083")
            .clientAuthentications(IsVpnServerClientAuthenticationArgs.builder()
                .method("certificate")
                .clientCaCrn("crn:v1:bluemix:public:cloudcerts:us-south:a/efe5afc483594adaa8325e2b4d1290df:86f62739-f3a8-42ac-abea-f23255965983:certificate:00406b5615f95dba9bf7c2ab52bb3083")
                .build())
            .clientIpPool("10.5.0.0/21")
            .clientDnsServerIps("192.168.3.4")
            .clientIdleTimeout(2800)
            .enableSplitTunneling(false)
            .port(443)
            .protocol("udp")
            .subnets(ibm_is_subnet.subnet1().id())
            .build());

    }
}

    resources:
  example:
    type: ibm:IsVpnServer
    properties:
      certificateCrn: crn:v1:bluemix:public:cloudcerts:us-south:a/efe5afc483594adaa8325e2b4d1290df:86f62739-f3a8-42ac-abea-f23255965983:certificate:00406b5615f95dba9bf7c2ab52bb3083
      clientAuthentications:
        - method: certificate
          clientCaCrn: crn:v1:bluemix:public:cloudcerts:us-south:a/efe5afc483594adaa8325e2b4d1290df:86f62739-f3a8-42ac-abea-f23255965983:certificate:00406b5615f95dba9bf7c2ab52bb3083
      clientIpPool: 10.5.0.0/21
      clientDnsServerIps:
        - 192.168.3.4
      clientIdleTimeout: 2800
      enableSplitTunneling: false
      port: 443
      protocol: udp
      subnets:
        - ${ibm_is_subnet.subnet1.id}

    Create IsVpnServer Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new IsVpnServer(name: string, args: IsVpnServerArgs, opts?: CustomResourceOptions);
    @overload
def IsVpnServer(resource_name: str,
                args: IsVpnServerArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def IsVpnServer(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                client_ip_pool: Optional[str] = None,
                certificate_crn: Optional[str] = None,
                client_authentications: Optional[Sequence[IsVpnServerClientAuthenticationArgs]] = None,
                subnets: Optional[Sequence[str]] = None,
                name: Optional[str] = None,
                client_idle_timeout: Optional[float] = None,
                enable_split_tunneling: Optional[bool] = None,
                is_vpn_server_id: Optional[str] = None,
                access_tags: Optional[Sequence[str]] = None,
                port: Optional[float] = None,
                protocol: Optional[str] = None,
                resource_group: Optional[str] = None,
                resource_type: Optional[str] = None,
                security_groups: Optional[Sequence[str]] = None,
                client_dns_server_ips: Optional[Sequence[str]] = None,
                timeouts: Optional[IsVpnServerTimeoutsArgs] = None)
    func NewIsVpnServer(ctx *Context, name string, args IsVpnServerArgs, opts ...ResourceOption) (*IsVpnServer, error)
    public IsVpnServer(string name, IsVpnServerArgs args, CustomResourceOptions? opts = null)
    public IsVpnServer(String name, IsVpnServerArgs args)
public IsVpnServer(String name, IsVpnServerArgs args, CustomResourceOptions options)

    type: ibm:IsVpnServer
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 IsVpnServerArgs
    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 IsVpnServerArgs
    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 IsVpnServerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IsVpnServerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IsVpnServerArgs
    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 isVpnServerResource = new Ibm.IsVpnServer("isVpnServerResource", new()
{
    ClientIpPool = "string",
    CertificateCrn = "string",
    ClientAuthentications = new[]
    {
        new Ibm.Inputs.IsVpnServerClientAuthenticationArgs
        {
            Method = "string",
            ClientCaCrn = "string",
            IdentityProvider = "string",
        },
    },
    Subnets = new[]
    {
        "string",
    },
    Name = "string",
    ClientIdleTimeout = 0,
    EnableSplitTunneling = false,
    IsVpnServerId = "string",
    AccessTags = new[]
    {
        "string",
    },
    Port = 0,
    Protocol = "string",
    ResourceGroup = "string",
    ResourceType = "string",
    SecurityGroups = new[]
    {
        "string",
    },
    ClientDnsServerIps = new[]
    {
        "string",
    },
    Timeouts = new Ibm.Inputs.IsVpnServerTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});

    example, err := ibm.NewIsVpnServer(ctx, "isVpnServerResource", &ibm.IsVpnServerArgs{
	ClientIpPool:   pulumi.String("string"),
	CertificateCrn: pulumi.String("string"),
	ClientAuthentications: ibm.IsVpnServerClientAuthenticationArray{
		&ibm.IsVpnServerClientAuthenticationArgs{
			Method:           pulumi.String("string"),
			ClientCaCrn:      pulumi.String("string"),
			IdentityProvider: pulumi.String("string"),
		},
	},
	Subnets: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:                 pulumi.String("string"),
	ClientIdleTimeout:    pulumi.Float64(0),
	EnableSplitTunneling: pulumi.Bool(false),
	IsVpnServerId:        pulumi.String("string"),
	AccessTags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Port:          pulumi.Float64(0),
	Protocol:      pulumi.String("string"),
	ResourceGroup: pulumi.String("string"),
	ResourceType:  pulumi.String("string"),
	SecurityGroups: pulumi.StringArray{
		pulumi.String("string"),
	},
	ClientDnsServerIps: pulumi.StringArray{
		pulumi.String("string"),
	},
	Timeouts: &ibm.IsVpnServerTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    var isVpnServerResource = new IsVpnServer("isVpnServerResource", IsVpnServerArgs.builder()
    .clientIpPool("string")
    .certificateCrn("string")
    .clientAuthentications(IsVpnServerClientAuthenticationArgs.builder()
        .method("string")
        .clientCaCrn("string")
        .identityProvider("string")
        .build())
    .subnets("string")
    .name("string")
    .clientIdleTimeout(0)
    .enableSplitTunneling(false)
    .isVpnServerId("string")
    .accessTags("string")
    .port(0)
    .protocol("string")
    .resourceGroup("string")
    .resourceType("string")
    .securityGroups("string")
    .clientDnsServerIps("string")
    .timeouts(IsVpnServerTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());

    is_vpn_server_resource = ibm.IsVpnServer("isVpnServerResource",
    client_ip_pool="string",
    certificate_crn="string",
    client_authentications=[{
        "method": "string",
        "client_ca_crn": "string",
        "identity_provider": "string",
    }],
    subnets=["string"],
    name="string",
    client_idle_timeout=0,
    enable_split_tunneling=False,
    is_vpn_server_id="string",
    access_tags=["string"],
    port=0,
    protocol="string",
    resource_group="string",
    resource_type="string",
    security_groups=["string"],
    client_dns_server_ips=["string"],
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })

    const isVpnServerResource = new ibm.IsVpnServer("isVpnServerResource", {
    clientIpPool: "string",
    certificateCrn: "string",
    clientAuthentications: [{
        method: "string",
        clientCaCrn: "string",
        identityProvider: "string",
    }],
    subnets: ["string"],
    name: "string",
    clientIdleTimeout: 0,
    enableSplitTunneling: false,
    isVpnServerId: "string",
    accessTags: ["string"],
    port: 0,
    protocol: "string",
    resourceGroup: "string",
    resourceType: "string",
    securityGroups: ["string"],
    clientDnsServerIps: ["string"],
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});

    type: ibm:IsVpnServer
properties:
    accessTags:
        - string
    certificateCrn: string
    clientAuthentications:
        - clientCaCrn: string
          identityProvider: string
          method: string
    clientDnsServerIps:
        - string
    clientIdleTimeout: 0
    clientIpPool: string
    enableSplitTunneling: false
    isVpnServerId: string
    name: string
    port: 0
    protocol: string
    resourceGroup: string
    resourceType: string
    securityGroups:
        - string
    subnets:
        - string
    timeouts:
        create: string
        delete: string
        update: string

    IsVpnServer 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 IsVpnServer resource accepts the following input properties:

    CertificateCrn string

    The certificate CRN of secret from Secrets Manager for this VPN server.

    !> Removal Notification Certificate Manager support is removed, please use Secrets Manager.

    ClientAuthentications List<IsVpnServerClientAuthentication>

    The methods used to authenticate VPN clients to this VPN server.

    Nested scheme for client_authentication:

    ClientIpPool string
    The VPN client IPv4 address pool, expressed in CIDR format. The request must not overlap with any existing address prefixes in the VPC or any of the following reserved address ranges: - 127.0.0.0/8 (IPv4 loopback addresses) - 161.26.0.0/16 (IBM services) - 166.8.0.0/14 (Cloud Service Endpoints) - 169.254.0.0/16 (IPv4 link-local addresses) - 224.0.0.0/4 (IPv4 multicast addresses)The prefix length of the client IP address pool's CIDR must be between/9 (8,388,608 addresses) and /22 (1024 addresses). A CIDR block that contains twice the number of IP addresses that are required to enable the maximum number of concurrent connections is recommended.
    Subnets List<string>
    Comma-separated IDs of the subnets to provision this VPN server in. Use subnets in different zones for high availability. User can also upgrade or downgrade the VPN server to high availability or standalone by adding/remove the subnets.
    AccessTags List<string>

    A list of access management tags to attach to the vpn server.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    ClientDnsServerIps List<string>
    The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered, the DNS server addresses that will be provided to VPN clients connected to this VPN server.
    ClientIdleTimeout double
    The seconds a VPN client can be idle before this VPN server will disconnect it. Specify 0 to prevent the server from disconnecting idle clients.

    • Constraints: The maximum value is 28800. The minimum value is 0, default is 600.
    EnableSplitTunneling bool
    Indicates whether the split tunneling is enabled on this VPN server.

    • Constraints: The default value is false.
    IsVpnServerId string
    (String) The unique identifier for this reserved IP.
    Name string
    The user-defined name for this VPN server. If unspecified, the name will be a hyphenated list of randomly-selected words. Names must be unique within the VPC this VPN server is serving.
    Port double
    The port number to use for this VPN server.

    • Constraints: The maximum value is 65535. The minimum value is 1.
    Protocol string
    The transport protocol to use for this VPN server.

    • Constraints: The default value is udp. Allowable values are: udp, tcp
    ResourceGroup string
    The resource group (id), where the VPN gateway to be created.
    ResourceType string
    (String) The type of resource referenced.
    SecurityGroups List<string>
    The security groups ID to use for this VPN server. If unspecified, the VPC's default security group is used.
    Timeouts IsVpnServerTimeouts
    CertificateCrn string

    The certificate CRN of secret from Secrets Manager for this VPN server.

    !> Removal Notification Certificate Manager support is removed, please use Secrets Manager.

    ClientAuthentications []IsVpnServerClientAuthenticationArgs

    The methods used to authenticate VPN clients to this VPN server.

    Nested scheme for client_authentication:

    ClientIpPool string
    The VPN client IPv4 address pool, expressed in CIDR format. The request must not overlap with any existing address prefixes in the VPC or any of the following reserved address ranges: - 127.0.0.0/8 (IPv4 loopback addresses) - 161.26.0.0/16 (IBM services) - 166.8.0.0/14 (Cloud Service Endpoints) - 169.254.0.0/16 (IPv4 link-local addresses) - 224.0.0.0/4 (IPv4 multicast addresses)The prefix length of the client IP address pool's CIDR must be between/9 (8,388,608 addresses) and /22 (1024 addresses). A CIDR block that contains twice the number of IP addresses that are required to enable the maximum number of concurrent connections is recommended.
    Subnets []string
    Comma-separated IDs of the subnets to provision this VPN server in. Use subnets in different zones for high availability. User can also upgrade or downgrade the VPN server to high availability or standalone by adding/remove the subnets.
    AccessTags []string

    A list of access management tags to attach to the vpn server.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    ClientDnsServerIps []string
    The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered, the DNS server addresses that will be provided to VPN clients connected to this VPN server.
    ClientIdleTimeout float64
    The seconds a VPN client can be idle before this VPN server will disconnect it. Specify 0 to prevent the server from disconnecting idle clients.

    • Constraints: The maximum value is 28800. The minimum value is 0, default is 600.
    EnableSplitTunneling bool
    Indicates whether the split tunneling is enabled on this VPN server.

    • Constraints: The default value is false.
    IsVpnServerId string
    (String) The unique identifier for this reserved IP.
    Name string
    The user-defined name for this VPN server. If unspecified, the name will be a hyphenated list of randomly-selected words. Names must be unique within the VPC this VPN server is serving.
    Port float64
    The port number to use for this VPN server.

    • Constraints: The maximum value is 65535. The minimum value is 1.
    Protocol string
    The transport protocol to use for this VPN server.

    • Constraints: The default value is udp. Allowable values are: udp, tcp
    ResourceGroup string
    The resource group (id), where the VPN gateway to be created.
    ResourceType string
    (String) The type of resource referenced.
    SecurityGroups []string
    The security groups ID to use for this VPN server. If unspecified, the VPC's default security group is used.
    Timeouts IsVpnServerTimeoutsArgs
    certificateCrn String

    The certificate CRN of secret from Secrets Manager for this VPN server.

    !> Removal Notification Certificate Manager support is removed, please use Secrets Manager.

    clientAuthentications List<IsVpnServerClientAuthentication>

    The methods used to authenticate VPN clients to this VPN server.

    Nested scheme for client_authentication:

    clientIpPool String
    The VPN client IPv4 address pool, expressed in CIDR format. The request must not overlap with any existing address prefixes in the VPC or any of the following reserved address ranges: - 127.0.0.0/8 (IPv4 loopback addresses) - 161.26.0.0/16 (IBM services) - 166.8.0.0/14 (Cloud Service Endpoints) - 169.254.0.0/16 (IPv4 link-local addresses) - 224.0.0.0/4 (IPv4 multicast addresses)The prefix length of the client IP address pool's CIDR must be between/9 (8,388,608 addresses) and /22 (1024 addresses). A CIDR block that contains twice the number of IP addresses that are required to enable the maximum number of concurrent connections is recommended.
    subnets List<String>
    Comma-separated IDs of the subnets to provision this VPN server in. Use subnets in different zones for high availability. User can also upgrade or downgrade the VPN server to high availability or standalone by adding/remove the subnets.
    accessTags List<String>

    A list of access management tags to attach to the vpn server.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    clientDnsServerIps List<String>
    The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered, the DNS server addresses that will be provided to VPN clients connected to this VPN server.
    clientIdleTimeout Double
    The seconds a VPN client can be idle before this VPN server will disconnect it. Specify 0 to prevent the server from disconnecting idle clients.

    • Constraints: The maximum value is 28800. The minimum value is 0, default is 600.
    enableSplitTunneling Boolean
    Indicates whether the split tunneling is enabled on this VPN server.

    • Constraints: The default value is false.
    isVpnServerId String
    (String) The unique identifier for this reserved IP.
    name String
    The user-defined name for this VPN server. If unspecified, the name will be a hyphenated list of randomly-selected words. Names must be unique within the VPC this VPN server is serving.
    port Double
    The port number to use for this VPN server.

    • Constraints: The maximum value is 65535. The minimum value is 1.
    protocol String
    The transport protocol to use for this VPN server.

    • Constraints: The default value is udp. Allowable values are: udp, tcp
    resourceGroup String
    The resource group (id), where the VPN gateway to be created.
    resourceType String
    (String) The type of resource referenced.
    securityGroups List<String>
    The security groups ID to use for this VPN server. If unspecified, the VPC's default security group is used.
    timeouts IsVpnServerTimeouts
    certificateCrn string

    The certificate CRN of secret from Secrets Manager for this VPN server.

    !> Removal Notification Certificate Manager support is removed, please use Secrets Manager.

    clientAuthentications IsVpnServerClientAuthentication[]

    The methods used to authenticate VPN clients to this VPN server.

    Nested scheme for client_authentication:

    clientIpPool string
    The VPN client IPv4 address pool, expressed in CIDR format. The request must not overlap with any existing address prefixes in the VPC or any of the following reserved address ranges: - 127.0.0.0/8 (IPv4 loopback addresses) - 161.26.0.0/16 (IBM services) - 166.8.0.0/14 (Cloud Service Endpoints) - 169.254.0.0/16 (IPv4 link-local addresses) - 224.0.0.0/4 (IPv4 multicast addresses)The prefix length of the client IP address pool's CIDR must be between/9 (8,388,608 addresses) and /22 (1024 addresses). A CIDR block that contains twice the number of IP addresses that are required to enable the maximum number of concurrent connections is recommended.
    subnets string[]
    Comma-separated IDs of the subnets to provision this VPN server in. Use subnets in different zones for high availability. User can also upgrade or downgrade the VPN server to high availability or standalone by adding/remove the subnets.
    accessTags string[]

    A list of access management tags to attach to the vpn server.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    clientDnsServerIps string[]
    The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered, the DNS server addresses that will be provided to VPN clients connected to this VPN server.
    clientIdleTimeout number
    The seconds a VPN client can be idle before this VPN server will disconnect it. Specify 0 to prevent the server from disconnecting idle clients.

    • Constraints: The maximum value is 28800. The minimum value is 0, default is 600.
    enableSplitTunneling boolean
    Indicates whether the split tunneling is enabled on this VPN server.

    • Constraints: The default value is false.
    isVpnServerId string
    (String) The unique identifier for this reserved IP.
    name string
    The user-defined name for this VPN server. If unspecified, the name will be a hyphenated list of randomly-selected words. Names must be unique within the VPC this VPN server is serving.
    port number
    The port number to use for this VPN server.

    • Constraints: The maximum value is 65535. The minimum value is 1.
    protocol string
    The transport protocol to use for this VPN server.

    • Constraints: The default value is udp. Allowable values are: udp, tcp
    resourceGroup string
    The resource group (id), where the VPN gateway to be created.
    resourceType string
    (String) The type of resource referenced.
    securityGroups string[]
    The security groups ID to use for this VPN server. If unspecified, the VPC's default security group is used.
    timeouts IsVpnServerTimeouts
    certificate_crn str

    The certificate CRN of secret from Secrets Manager for this VPN server.

    !> Removal Notification Certificate Manager support is removed, please use Secrets Manager.

    client_authentications Sequence[IsVpnServerClientAuthenticationArgs]

    The methods used to authenticate VPN clients to this VPN server.

    Nested scheme for client_authentication:

    client_ip_pool str
    The VPN client IPv4 address pool, expressed in CIDR format. The request must not overlap with any existing address prefixes in the VPC or any of the following reserved address ranges: - 127.0.0.0/8 (IPv4 loopback addresses) - 161.26.0.0/16 (IBM services) - 166.8.0.0/14 (Cloud Service Endpoints) - 169.254.0.0/16 (IPv4 link-local addresses) - 224.0.0.0/4 (IPv4 multicast addresses)The prefix length of the client IP address pool's CIDR must be between/9 (8,388,608 addresses) and /22 (1024 addresses). A CIDR block that contains twice the number of IP addresses that are required to enable the maximum number of concurrent connections is recommended.
    subnets Sequence[str]
    Comma-separated IDs of the subnets to provision this VPN server in. Use subnets in different zones for high availability. User can also upgrade or downgrade the VPN server to high availability or standalone by adding/remove the subnets.
    access_tags Sequence[str]

    A list of access management tags to attach to the vpn server.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    client_dns_server_ips Sequence[str]
    The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered, the DNS server addresses that will be provided to VPN clients connected to this VPN server.
    client_idle_timeout float
    The seconds a VPN client can be idle before this VPN server will disconnect it. Specify 0 to prevent the server from disconnecting idle clients.

    • Constraints: The maximum value is 28800. The minimum value is 0, default is 600.
    enable_split_tunneling bool
    Indicates whether the split tunneling is enabled on this VPN server.

    • Constraints: The default value is false.
    is_vpn_server_id str
    (String) The unique identifier for this reserved IP.
    name str
    The user-defined name for this VPN server. If unspecified, the name will be a hyphenated list of randomly-selected words. Names must be unique within the VPC this VPN server is serving.
    port float
    The port number to use for this VPN server.

    • Constraints: The maximum value is 65535. The minimum value is 1.
    protocol str
    The transport protocol to use for this VPN server.

    • Constraints: The default value is udp. Allowable values are: udp, tcp
    resource_group str
    The resource group (id), where the VPN gateway to be created.
    resource_type str
    (String) The type of resource referenced.
    security_groups Sequence[str]
    The security groups ID to use for this VPN server. If unspecified, the VPC's default security group is used.
    timeouts IsVpnServerTimeoutsArgs
    certificateCrn String

    The certificate CRN of secret from Secrets Manager for this VPN server.

    !> Removal Notification Certificate Manager support is removed, please use Secrets Manager.

    clientAuthentications List<Property Map>

    The methods used to authenticate VPN clients to this VPN server.

    Nested scheme for client_authentication:

    clientIpPool String
    The VPN client IPv4 address pool, expressed in CIDR format. The request must not overlap with any existing address prefixes in the VPC or any of the following reserved address ranges: - 127.0.0.0/8 (IPv4 loopback addresses) - 161.26.0.0/16 (IBM services) - 166.8.0.0/14 (Cloud Service Endpoints) - 169.254.0.0/16 (IPv4 link-local addresses) - 224.0.0.0/4 (IPv4 multicast addresses)The prefix length of the client IP address pool's CIDR must be between/9 (8,388,608 addresses) and /22 (1024 addresses). A CIDR block that contains twice the number of IP addresses that are required to enable the maximum number of concurrent connections is recommended.
    subnets List<String>
    Comma-separated IDs of the subnets to provision this VPN server in. Use subnets in different zones for high availability. User can also upgrade or downgrade the VPN server to high availability or standalone by adding/remove the subnets.
    accessTags List<String>

    A list of access management tags to attach to the vpn server.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    clientDnsServerIps List<String>
    The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered, the DNS server addresses that will be provided to VPN clients connected to this VPN server.
    clientIdleTimeout Number
    The seconds a VPN client can be idle before this VPN server will disconnect it. Specify 0 to prevent the server from disconnecting idle clients.

    • Constraints: The maximum value is 28800. The minimum value is 0, default is 600.
    enableSplitTunneling Boolean
    Indicates whether the split tunneling is enabled on this VPN server.

    • Constraints: The default value is false.
    isVpnServerId String
    (String) The unique identifier for this reserved IP.
    name String
    The user-defined name for this VPN server. If unspecified, the name will be a hyphenated list of randomly-selected words. Names must be unique within the VPC this VPN server is serving.
    port Number
    The port number to use for this VPN server.

    • Constraints: The maximum value is 65535. The minimum value is 1.
    protocol String
    The transport protocol to use for this VPN server.

    • Constraints: The default value is udp. Allowable values are: udp, tcp
    resourceGroup String
    The resource group (id), where the VPN gateway to be created.
    resourceType String
    (String) The type of resource referenced.
    securityGroups List<String>
    The security groups ID to use for this VPN server. If unspecified, the VPC's default security group is used.
    timeouts Property Map

    Outputs

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

    ClientAutoDelete bool
    (Boolean) If set to true, disconnected VPN clients will be automatically deleted after the client_auto_delete_timeout time has passed.
    ClientAutoDeleteTimeout double
    (Integer) Hours after which disconnected VPN clients will be automatically deleted. If 0, disconnected VPN clients will be deleted immediately.
    CreatedAt string
    (String) The date and time that the VPN server was created.
    Crn string
    (String) The CRN for this VPN server.
    HealthReasons List<IsVpnServerHealthReason>
    (List) The reasons for the current health_state (if any).
    HealthState string
    (String) The health of this resource.
    Hostname string
    (String) Fully qualified domain name assigned to this VPN server.
    Href string
    (String) The URL for this reserved IP.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleReasons List<IsVpnServerLifecycleReason>
    (List) The reasons for the current lifecycle_reasons (if any).
    LifecycleState string
    (String) The lifecycle state of the VPN server.
    PrivateIps List<IsVpnServerPrivateIp>
    (List) The reserved IPs bound to this VPN server.
    Vpcs List<IsVpnServerVpc>
    The VPC this VPN server resides in.
    VpnServer string
    The unique identifier of the VPNServer.
    ClientAutoDelete bool
    (Boolean) If set to true, disconnected VPN clients will be automatically deleted after the client_auto_delete_timeout time has passed.
    ClientAutoDeleteTimeout float64
    (Integer) Hours after which disconnected VPN clients will be automatically deleted. If 0, disconnected VPN clients will be deleted immediately.
    CreatedAt string
    (String) The date and time that the VPN server was created.
    Crn string
    (String) The CRN for this VPN server.
    HealthReasons []IsVpnServerHealthReason
    (List) The reasons for the current health_state (if any).
    HealthState string
    (String) The health of this resource.
    Hostname string
    (String) Fully qualified domain name assigned to this VPN server.
    Href string
    (String) The URL for this reserved IP.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleReasons []IsVpnServerLifecycleReason
    (List) The reasons for the current lifecycle_reasons (if any).
    LifecycleState string
    (String) The lifecycle state of the VPN server.
    PrivateIps []IsVpnServerPrivateIp
    (List) The reserved IPs bound to this VPN server.
    Vpcs []IsVpnServerVpc
    The VPC this VPN server resides in.
    VpnServer string
    The unique identifier of the VPNServer.
    clientAutoDelete Boolean
    (Boolean) If set to true, disconnected VPN clients will be automatically deleted after the client_auto_delete_timeout time has passed.
    clientAutoDeleteTimeout Double
    (Integer) Hours after which disconnected VPN clients will be automatically deleted. If 0, disconnected VPN clients will be deleted immediately.
    createdAt String
    (String) The date and time that the VPN server was created.
    crn String
    (String) The CRN for this VPN server.
    healthReasons List<IsVpnServerHealthReason>
    (List) The reasons for the current health_state (if any).
    healthState String
    (String) The health of this resource.
    hostname String
    (String) Fully qualified domain name assigned to this VPN server.
    href String
    (String) The URL for this reserved IP.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleReasons List<IsVpnServerLifecycleReason>
    (List) The reasons for the current lifecycle_reasons (if any).
    lifecycleState String
    (String) The lifecycle state of the VPN server.
    privateIps List<IsVpnServerPrivateIp>
    (List) The reserved IPs bound to this VPN server.
    vpcs List<IsVpnServerVpc>
    The VPC this VPN server resides in.
    vpnServer String
    The unique identifier of the VPNServer.
    clientAutoDelete boolean
    (Boolean) If set to true, disconnected VPN clients will be automatically deleted after the client_auto_delete_timeout time has passed.
    clientAutoDeleteTimeout number
    (Integer) Hours after which disconnected VPN clients will be automatically deleted. If 0, disconnected VPN clients will be deleted immediately.
    createdAt string
    (String) The date and time that the VPN server was created.
    crn string
    (String) The CRN for this VPN server.
    healthReasons IsVpnServerHealthReason[]
    (List) The reasons for the current health_state (if any).
    healthState string
    (String) The health of this resource.
    hostname string
    (String) Fully qualified domain name assigned to this VPN server.
    href string
    (String) The URL for this reserved IP.
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleReasons IsVpnServerLifecycleReason[]
    (List) The reasons for the current lifecycle_reasons (if any).
    lifecycleState string
    (String) The lifecycle state of the VPN server.
    privateIps IsVpnServerPrivateIp[]
    (List) The reserved IPs bound to this VPN server.
    vpcs IsVpnServerVpc[]
    The VPC this VPN server resides in.
    vpnServer string
    The unique identifier of the VPNServer.
    client_auto_delete bool
    (Boolean) If set to true, disconnected VPN clients will be automatically deleted after the client_auto_delete_timeout time has passed.
    client_auto_delete_timeout float
    (Integer) Hours after which disconnected VPN clients will be automatically deleted. If 0, disconnected VPN clients will be deleted immediately.
    created_at str
    (String) The date and time that the VPN server was created.
    crn str
    (String) The CRN for this VPN server.
    health_reasons Sequence[IsVpnServerHealthReason]
    (List) The reasons for the current health_state (if any).
    health_state str
    (String) The health of this resource.
    hostname str
    (String) Fully qualified domain name assigned to this VPN server.
    href str
    (String) The URL for this reserved IP.
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_reasons Sequence[IsVpnServerLifecycleReason]
    (List) The reasons for the current lifecycle_reasons (if any).
    lifecycle_state str
    (String) The lifecycle state of the VPN server.
    private_ips Sequence[IsVpnServerPrivateIp]
    (List) The reserved IPs bound to this VPN server.
    vpcs Sequence[IsVpnServerVpc]
    The VPC this VPN server resides in.
    vpn_server str
    The unique identifier of the VPNServer.
    clientAutoDelete Boolean
    (Boolean) If set to true, disconnected VPN clients will be automatically deleted after the client_auto_delete_timeout time has passed.
    clientAutoDeleteTimeout Number
    (Integer) Hours after which disconnected VPN clients will be automatically deleted. If 0, disconnected VPN clients will be deleted immediately.
    createdAt String
    (String) The date and time that the VPN server was created.
    crn String
    (String) The CRN for this VPN server.
    healthReasons List<Property Map>
    (List) The reasons for the current health_state (if any).
    healthState String
    (String) The health of this resource.
    hostname String
    (String) Fully qualified domain name assigned to this VPN server.
    href String
    (String) The URL for this reserved IP.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleReasons List<Property Map>
    (List) The reasons for the current lifecycle_reasons (if any).
    lifecycleState String
    (String) The lifecycle state of the VPN server.
    privateIps List<Property Map>
    (List) The reserved IPs bound to this VPN server.
    vpcs List<Property Map>
    The VPC this VPN server resides in.
    vpnServer String
    The unique identifier of the VPNServer.

    Look up Existing IsVpnServer Resource

    Get an existing IsVpnServer 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?: IsVpnServerState, opts?: CustomResourceOptions): IsVpnServer
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_tags: Optional[Sequence[str]] = None,
        certificate_crn: Optional[str] = None,
        client_authentications: Optional[Sequence[IsVpnServerClientAuthenticationArgs]] = None,
        client_auto_delete: Optional[bool] = None,
        client_auto_delete_timeout: Optional[float] = None,
        client_dns_server_ips: Optional[Sequence[str]] = None,
        client_idle_timeout: Optional[float] = None,
        client_ip_pool: Optional[str] = None,
        created_at: Optional[str] = None,
        crn: Optional[str] = None,
        enable_split_tunneling: Optional[bool] = None,
        health_reasons: Optional[Sequence[IsVpnServerHealthReasonArgs]] = None,
        health_state: Optional[str] = None,
        hostname: Optional[str] = None,
        href: Optional[str] = None,
        is_vpn_server_id: Optional[str] = None,
        lifecycle_reasons: Optional[Sequence[IsVpnServerLifecycleReasonArgs]] = None,
        lifecycle_state: Optional[str] = None,
        name: Optional[str] = None,
        port: Optional[float] = None,
        private_ips: Optional[Sequence[IsVpnServerPrivateIpArgs]] = None,
        protocol: Optional[str] = None,
        resource_group: Optional[str] = None,
        resource_type: Optional[str] = None,
        security_groups: Optional[Sequence[str]] = None,
        subnets: Optional[Sequence[str]] = None,
        timeouts: Optional[IsVpnServerTimeoutsArgs] = None,
        vpcs: Optional[Sequence[IsVpnServerVpcArgs]] = None,
        vpn_server: Optional[str] = None) -> IsVpnServer
    func GetIsVpnServer(ctx *Context, name string, id IDInput, state *IsVpnServerState, opts ...ResourceOption) (*IsVpnServer, error)
    public static IsVpnServer Get(string name, Input<string> id, IsVpnServerState? state, CustomResourceOptions? opts = null)
    public static IsVpnServer get(String name, Output<String> id, IsVpnServerState state, CustomResourceOptions options)
    resources:  _:    type: ibm:IsVpnServer    get:      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.
    The following state arguments are supported:
    AccessTags List<string>

    A list of access management tags to attach to the vpn server.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    CertificateCrn string

    The certificate CRN of secret from Secrets Manager for this VPN server.

    !> Removal Notification Certificate Manager support is removed, please use Secrets Manager.

    ClientAuthentications List<IsVpnServerClientAuthentication>

    The methods used to authenticate VPN clients to this VPN server.

    Nested scheme for client_authentication:

    ClientAutoDelete bool
    (Boolean) If set to true, disconnected VPN clients will be automatically deleted after the client_auto_delete_timeout time has passed.
    ClientAutoDeleteTimeout double
    (Integer) Hours after which disconnected VPN clients will be automatically deleted. If 0, disconnected VPN clients will be deleted immediately.
    ClientDnsServerIps List<string>
    The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered, the DNS server addresses that will be provided to VPN clients connected to this VPN server.
    ClientIdleTimeout double
    The seconds a VPN client can be idle before this VPN server will disconnect it. Specify 0 to prevent the server from disconnecting idle clients.

    • Constraints: The maximum value is 28800. The minimum value is 0, default is 600.
    ClientIpPool string
    The VPN client IPv4 address pool, expressed in CIDR format. The request must not overlap with any existing address prefixes in the VPC or any of the following reserved address ranges: - 127.0.0.0/8 (IPv4 loopback addresses) - 161.26.0.0/16 (IBM services) - 166.8.0.0/14 (Cloud Service Endpoints) - 169.254.0.0/16 (IPv4 link-local addresses) - 224.0.0.0/4 (IPv4 multicast addresses)The prefix length of the client IP address pool's CIDR must be between/9 (8,388,608 addresses) and /22 (1024 addresses). A CIDR block that contains twice the number of IP addresses that are required to enable the maximum number of concurrent connections is recommended.
    CreatedAt string
    (String) The date and time that the VPN server was created.
    Crn string
    (String) The CRN for this VPN server.
    EnableSplitTunneling bool
    Indicates whether the split tunneling is enabled on this VPN server.

    • Constraints: The default value is false.
    HealthReasons List<IsVpnServerHealthReason>
    (List) The reasons for the current health_state (if any).
    HealthState string
    (String) The health of this resource.
    Hostname string
    (String) Fully qualified domain name assigned to this VPN server.
    Href string
    (String) The URL for this reserved IP.
    IsVpnServerId string
    (String) The unique identifier for this reserved IP.
    LifecycleReasons List<IsVpnServerLifecycleReason>
    (List) The reasons for the current lifecycle_reasons (if any).
    LifecycleState string
    (String) The lifecycle state of the VPN server.
    Name string
    The user-defined name for this VPN server. If unspecified, the name will be a hyphenated list of randomly-selected words. Names must be unique within the VPC this VPN server is serving.
    Port double
    The port number to use for this VPN server.

    • Constraints: The maximum value is 65535. The minimum value is 1.
    PrivateIps List<IsVpnServerPrivateIp>
    (List) The reserved IPs bound to this VPN server.
    Protocol string
    The transport protocol to use for this VPN server.

    • Constraints: The default value is udp. Allowable values are: udp, tcp
    ResourceGroup string
    The resource group (id), where the VPN gateway to be created.
    ResourceType string
    (String) The type of resource referenced.
    SecurityGroups List<string>
    The security groups ID to use for this VPN server. If unspecified, the VPC's default security group is used.
    Subnets List<string>
    Comma-separated IDs of the subnets to provision this VPN server in. Use subnets in different zones for high availability. User can also upgrade or downgrade the VPN server to high availability or standalone by adding/remove the subnets.
    Timeouts IsVpnServerTimeouts
    Vpcs List<IsVpnServerVpc>
    The VPC this VPN server resides in.
    VpnServer string
    The unique identifier of the VPNServer.
    AccessTags []string

    A list of access management tags to attach to the vpn server.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    CertificateCrn string

    The certificate CRN of secret from Secrets Manager for this VPN server.

    !> Removal Notification Certificate Manager support is removed, please use Secrets Manager.

    ClientAuthentications []IsVpnServerClientAuthenticationArgs

    The methods used to authenticate VPN clients to this VPN server.

    Nested scheme for client_authentication:

    ClientAutoDelete bool
    (Boolean) If set to true, disconnected VPN clients will be automatically deleted after the client_auto_delete_timeout time has passed.
    ClientAutoDeleteTimeout float64
    (Integer) Hours after which disconnected VPN clients will be automatically deleted. If 0, disconnected VPN clients will be deleted immediately.
    ClientDnsServerIps []string
    The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered, the DNS server addresses that will be provided to VPN clients connected to this VPN server.
    ClientIdleTimeout float64
    The seconds a VPN client can be idle before this VPN server will disconnect it. Specify 0 to prevent the server from disconnecting idle clients.

    • Constraints: The maximum value is 28800. The minimum value is 0, default is 600.
    ClientIpPool string
    The VPN client IPv4 address pool, expressed in CIDR format. The request must not overlap with any existing address prefixes in the VPC or any of the following reserved address ranges: - 127.0.0.0/8 (IPv4 loopback addresses) - 161.26.0.0/16 (IBM services) - 166.8.0.0/14 (Cloud Service Endpoints) - 169.254.0.0/16 (IPv4 link-local addresses) - 224.0.0.0/4 (IPv4 multicast addresses)The prefix length of the client IP address pool's CIDR must be between/9 (8,388,608 addresses) and /22 (1024 addresses). A CIDR block that contains twice the number of IP addresses that are required to enable the maximum number of concurrent connections is recommended.
    CreatedAt string
    (String) The date and time that the VPN server was created.
    Crn string
    (String) The CRN for this VPN server.
    EnableSplitTunneling bool
    Indicates whether the split tunneling is enabled on this VPN server.

    • Constraints: The default value is false.
    HealthReasons []IsVpnServerHealthReasonArgs
    (List) The reasons for the current health_state (if any).
    HealthState string
    (String) The health of this resource.
    Hostname string
    (String) Fully qualified domain name assigned to this VPN server.
    Href string
    (String) The URL for this reserved IP.
    IsVpnServerId string
    (String) The unique identifier for this reserved IP.
    LifecycleReasons []IsVpnServerLifecycleReasonArgs
    (List) The reasons for the current lifecycle_reasons (if any).
    LifecycleState string
    (String) The lifecycle state of the VPN server.
    Name string
    The user-defined name for this VPN server. If unspecified, the name will be a hyphenated list of randomly-selected words. Names must be unique within the VPC this VPN server is serving.
    Port float64
    The port number to use for this VPN server.

    • Constraints: The maximum value is 65535. The minimum value is 1.
    PrivateIps []IsVpnServerPrivateIpArgs
    (List) The reserved IPs bound to this VPN server.
    Protocol string
    The transport protocol to use for this VPN server.

    • Constraints: The default value is udp. Allowable values are: udp, tcp
    ResourceGroup string
    The resource group (id), where the VPN gateway to be created.
    ResourceType string
    (String) The type of resource referenced.
    SecurityGroups []string
    The security groups ID to use for this VPN server. If unspecified, the VPC's default security group is used.
    Subnets []string
    Comma-separated IDs of the subnets to provision this VPN server in. Use subnets in different zones for high availability. User can also upgrade or downgrade the VPN server to high availability or standalone by adding/remove the subnets.
    Timeouts IsVpnServerTimeoutsArgs
    Vpcs []IsVpnServerVpcArgs
    The VPC this VPN server resides in.
    VpnServer string
    The unique identifier of the VPNServer.
    accessTags List<String>

    A list of access management tags to attach to the vpn server.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    certificateCrn String

    The certificate CRN of secret from Secrets Manager for this VPN server.

    !> Removal Notification Certificate Manager support is removed, please use Secrets Manager.

    clientAuthentications List<IsVpnServerClientAuthentication>

    The methods used to authenticate VPN clients to this VPN server.

    Nested scheme for client_authentication:

    clientAutoDelete Boolean
    (Boolean) If set to true, disconnected VPN clients will be automatically deleted after the client_auto_delete_timeout time has passed.
    clientAutoDeleteTimeout Double
    (Integer) Hours after which disconnected VPN clients will be automatically deleted. If 0, disconnected VPN clients will be deleted immediately.
    clientDnsServerIps List<String>
    The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered, the DNS server addresses that will be provided to VPN clients connected to this VPN server.
    clientIdleTimeout Double
    The seconds a VPN client can be idle before this VPN server will disconnect it. Specify 0 to prevent the server from disconnecting idle clients.

    • Constraints: The maximum value is 28800. The minimum value is 0, default is 600.
    clientIpPool String
    The VPN client IPv4 address pool, expressed in CIDR format. The request must not overlap with any existing address prefixes in the VPC or any of the following reserved address ranges: - 127.0.0.0/8 (IPv4 loopback addresses) - 161.26.0.0/16 (IBM services) - 166.8.0.0/14 (Cloud Service Endpoints) - 169.254.0.0/16 (IPv4 link-local addresses) - 224.0.0.0/4 (IPv4 multicast addresses)The prefix length of the client IP address pool's CIDR must be between/9 (8,388,608 addresses) and /22 (1024 addresses). A CIDR block that contains twice the number of IP addresses that are required to enable the maximum number of concurrent connections is recommended.
    createdAt String
    (String) The date and time that the VPN server was created.
    crn String
    (String) The CRN for this VPN server.
    enableSplitTunneling Boolean
    Indicates whether the split tunneling is enabled on this VPN server.

    • Constraints: The default value is false.
    healthReasons List<IsVpnServerHealthReason>
    (List) The reasons for the current health_state (if any).
    healthState String
    (String) The health of this resource.
    hostname String
    (String) Fully qualified domain name assigned to this VPN server.
    href String
    (String) The URL for this reserved IP.
    isVpnServerId String
    (String) The unique identifier for this reserved IP.
    lifecycleReasons List<IsVpnServerLifecycleReason>
    (List) The reasons for the current lifecycle_reasons (if any).
    lifecycleState String
    (String) The lifecycle state of the VPN server.
    name String
    The user-defined name for this VPN server. If unspecified, the name will be a hyphenated list of randomly-selected words. Names must be unique within the VPC this VPN server is serving.
    port Double
    The port number to use for this VPN server.

    • Constraints: The maximum value is 65535. The minimum value is 1.
    privateIps List<IsVpnServerPrivateIp>
    (List) The reserved IPs bound to this VPN server.
    protocol String
    The transport protocol to use for this VPN server.

    • Constraints: The default value is udp. Allowable values are: udp, tcp
    resourceGroup String
    The resource group (id), where the VPN gateway to be created.
    resourceType String
    (String) The type of resource referenced.
    securityGroups List<String>
    The security groups ID to use for this VPN server. If unspecified, the VPC's default security group is used.
    subnets List<String>
    Comma-separated IDs of the subnets to provision this VPN server in. Use subnets in different zones for high availability. User can also upgrade or downgrade the VPN server to high availability or standalone by adding/remove the subnets.
    timeouts IsVpnServerTimeouts
    vpcs List<IsVpnServerVpc>
    The VPC this VPN server resides in.
    vpnServer String
    The unique identifier of the VPNServer.
    accessTags string[]

    A list of access management tags to attach to the vpn server.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    certificateCrn string

    The certificate CRN of secret from Secrets Manager for this VPN server.

    !> Removal Notification Certificate Manager support is removed, please use Secrets Manager.

    clientAuthentications IsVpnServerClientAuthentication[]

    The methods used to authenticate VPN clients to this VPN server.

    Nested scheme for client_authentication:

    clientAutoDelete boolean
    (Boolean) If set to true, disconnected VPN clients will be automatically deleted after the client_auto_delete_timeout time has passed.
    clientAutoDeleteTimeout number
    (Integer) Hours after which disconnected VPN clients will be automatically deleted. If 0, disconnected VPN clients will be deleted immediately.
    clientDnsServerIps string[]
    The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered, the DNS server addresses that will be provided to VPN clients connected to this VPN server.
    clientIdleTimeout number
    The seconds a VPN client can be idle before this VPN server will disconnect it. Specify 0 to prevent the server from disconnecting idle clients.

    • Constraints: The maximum value is 28800. The minimum value is 0, default is 600.
    clientIpPool string
    The VPN client IPv4 address pool, expressed in CIDR format. The request must not overlap with any existing address prefixes in the VPC or any of the following reserved address ranges: - 127.0.0.0/8 (IPv4 loopback addresses) - 161.26.0.0/16 (IBM services) - 166.8.0.0/14 (Cloud Service Endpoints) - 169.254.0.0/16 (IPv4 link-local addresses) - 224.0.0.0/4 (IPv4 multicast addresses)The prefix length of the client IP address pool's CIDR must be between/9 (8,388,608 addresses) and /22 (1024 addresses). A CIDR block that contains twice the number of IP addresses that are required to enable the maximum number of concurrent connections is recommended.
    createdAt string
    (String) The date and time that the VPN server was created.
    crn string
    (String) The CRN for this VPN server.
    enableSplitTunneling boolean
    Indicates whether the split tunneling is enabled on this VPN server.

    • Constraints: The default value is false.
    healthReasons IsVpnServerHealthReason[]
    (List) The reasons for the current health_state (if any).
    healthState string
    (String) The health of this resource.
    hostname string
    (String) Fully qualified domain name assigned to this VPN server.
    href string
    (String) The URL for this reserved IP.
    isVpnServerId string
    (String) The unique identifier for this reserved IP.
    lifecycleReasons IsVpnServerLifecycleReason[]
    (List) The reasons for the current lifecycle_reasons (if any).
    lifecycleState string
    (String) The lifecycle state of the VPN server.
    name string
    The user-defined name for this VPN server. If unspecified, the name will be a hyphenated list of randomly-selected words. Names must be unique within the VPC this VPN server is serving.
    port number
    The port number to use for this VPN server.

    • Constraints: The maximum value is 65535. The minimum value is 1.
    privateIps IsVpnServerPrivateIp[]
    (List) The reserved IPs bound to this VPN server.
    protocol string
    The transport protocol to use for this VPN server.

    • Constraints: The default value is udp. Allowable values are: udp, tcp
    resourceGroup string
    The resource group (id), where the VPN gateway to be created.
    resourceType string
    (String) The type of resource referenced.
    securityGroups string[]
    The security groups ID to use for this VPN server. If unspecified, the VPC's default security group is used.
    subnets string[]
    Comma-separated IDs of the subnets to provision this VPN server in. Use subnets in different zones for high availability. User can also upgrade or downgrade the VPN server to high availability or standalone by adding/remove the subnets.
    timeouts IsVpnServerTimeouts
    vpcs IsVpnServerVpc[]
    The VPC this VPN server resides in.
    vpnServer string
    The unique identifier of the VPNServer.
    access_tags Sequence[str]

    A list of access management tags to attach to the vpn server.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    certificate_crn str

    The certificate CRN of secret from Secrets Manager for this VPN server.

    !> Removal Notification Certificate Manager support is removed, please use Secrets Manager.

    client_authentications Sequence[IsVpnServerClientAuthenticationArgs]

    The methods used to authenticate VPN clients to this VPN server.

    Nested scheme for client_authentication:

    client_auto_delete bool
    (Boolean) If set to true, disconnected VPN clients will be automatically deleted after the client_auto_delete_timeout time has passed.
    client_auto_delete_timeout float
    (Integer) Hours after which disconnected VPN clients will be automatically deleted. If 0, disconnected VPN clients will be deleted immediately.
    client_dns_server_ips Sequence[str]
    The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered, the DNS server addresses that will be provided to VPN clients connected to this VPN server.
    client_idle_timeout float
    The seconds a VPN client can be idle before this VPN server will disconnect it. Specify 0 to prevent the server from disconnecting idle clients.

    • Constraints: The maximum value is 28800. The minimum value is 0, default is 600.
    client_ip_pool str
    The VPN client IPv4 address pool, expressed in CIDR format. The request must not overlap with any existing address prefixes in the VPC or any of the following reserved address ranges: - 127.0.0.0/8 (IPv4 loopback addresses) - 161.26.0.0/16 (IBM services) - 166.8.0.0/14 (Cloud Service Endpoints) - 169.254.0.0/16 (IPv4 link-local addresses) - 224.0.0.0/4 (IPv4 multicast addresses)The prefix length of the client IP address pool's CIDR must be between/9 (8,388,608 addresses) and /22 (1024 addresses). A CIDR block that contains twice the number of IP addresses that are required to enable the maximum number of concurrent connections is recommended.
    created_at str
    (String) The date and time that the VPN server was created.
    crn str
    (String) The CRN for this VPN server.
    enable_split_tunneling bool
    Indicates whether the split tunneling is enabled on this VPN server.

    • Constraints: The default value is false.
    health_reasons Sequence[IsVpnServerHealthReasonArgs]
    (List) The reasons for the current health_state (if any).
    health_state str
    (String) The health of this resource.
    hostname str
    (String) Fully qualified domain name assigned to this VPN server.
    href str
    (String) The URL for this reserved IP.
    is_vpn_server_id str
    (String) The unique identifier for this reserved IP.
    lifecycle_reasons Sequence[IsVpnServerLifecycleReasonArgs]
    (List) The reasons for the current lifecycle_reasons (if any).
    lifecycle_state str
    (String) The lifecycle state of the VPN server.
    name str
    The user-defined name for this VPN server. If unspecified, the name will be a hyphenated list of randomly-selected words. Names must be unique within the VPC this VPN server is serving.
    port float
    The port number to use for this VPN server.

    • Constraints: The maximum value is 65535. The minimum value is 1.
    private_ips Sequence[IsVpnServerPrivateIpArgs]
    (List) The reserved IPs bound to this VPN server.
    protocol str
    The transport protocol to use for this VPN server.

    • Constraints: The default value is udp. Allowable values are: udp, tcp
    resource_group str
    The resource group (id), where the VPN gateway to be created.
    resource_type str
    (String) The type of resource referenced.
    security_groups Sequence[str]
    The security groups ID to use for this VPN server. If unspecified, the VPC's default security group is used.
    subnets Sequence[str]
    Comma-separated IDs of the subnets to provision this VPN server in. Use subnets in different zones for high availability. User can also upgrade or downgrade the VPN server to high availability or standalone by adding/remove the subnets.
    timeouts IsVpnServerTimeoutsArgs
    vpcs Sequence[IsVpnServerVpcArgs]
    The VPC this VPN server resides in.
    vpn_server str
    The unique identifier of the VPNServer.
    accessTags List<String>

    A list of access management tags to attach to the vpn server.

    Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

    certificateCrn String

    The certificate CRN of secret from Secrets Manager for this VPN server.

    !> Removal Notification Certificate Manager support is removed, please use Secrets Manager.

    clientAuthentications List<Property Map>

    The methods used to authenticate VPN clients to this VPN server.

    Nested scheme for client_authentication:

    clientAutoDelete Boolean
    (Boolean) If set to true, disconnected VPN clients will be automatically deleted after the client_auto_delete_timeout time has passed.
    clientAutoDeleteTimeout Number
    (Integer) Hours after which disconnected VPN clients will be automatically deleted. If 0, disconnected VPN clients will be deleted immediately.
    clientDnsServerIps List<String>
    The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered, the DNS server addresses that will be provided to VPN clients connected to this VPN server.
    clientIdleTimeout Number
    The seconds a VPN client can be idle before this VPN server will disconnect it. Specify 0 to prevent the server from disconnecting idle clients.

    • Constraints: The maximum value is 28800. The minimum value is 0, default is 600.
    clientIpPool String
    The VPN client IPv4 address pool, expressed in CIDR format. The request must not overlap with any existing address prefixes in the VPC or any of the following reserved address ranges: - 127.0.0.0/8 (IPv4 loopback addresses) - 161.26.0.0/16 (IBM services) - 166.8.0.0/14 (Cloud Service Endpoints) - 169.254.0.0/16 (IPv4 link-local addresses) - 224.0.0.0/4 (IPv4 multicast addresses)The prefix length of the client IP address pool's CIDR must be between/9 (8,388,608 addresses) and /22 (1024 addresses). A CIDR block that contains twice the number of IP addresses that are required to enable the maximum number of concurrent connections is recommended.
    createdAt String
    (String) The date and time that the VPN server was created.
    crn String
    (String) The CRN for this VPN server.
    enableSplitTunneling Boolean
    Indicates whether the split tunneling is enabled on this VPN server.

    • Constraints: The default value is false.
    healthReasons List<Property Map>
    (List) The reasons for the current health_state (if any).
    healthState String
    (String) The health of this resource.
    hostname String
    (String) Fully qualified domain name assigned to this VPN server.
    href String
    (String) The URL for this reserved IP.
    isVpnServerId String
    (String) The unique identifier for this reserved IP.
    lifecycleReasons List<Property Map>
    (List) The reasons for the current lifecycle_reasons (if any).
    lifecycleState String
    (String) The lifecycle state of the VPN server.
    name String
    The user-defined name for this VPN server. If unspecified, the name will be a hyphenated list of randomly-selected words. Names must be unique within the VPC this VPN server is serving.
    port Number
    The port number to use for this VPN server.

    • Constraints: The maximum value is 65535. The minimum value is 1.
    privateIps List<Property Map>
    (List) The reserved IPs bound to this VPN server.
    protocol String
    The transport protocol to use for this VPN server.

    • Constraints: The default value is udp. Allowable values are: udp, tcp
    resourceGroup String
    The resource group (id), where the VPN gateway to be created.
    resourceType String
    (String) The type of resource referenced.
    securityGroups List<String>
    The security groups ID to use for this VPN server. If unspecified, the VPC's default security group is used.
    subnets List<String>
    Comma-separated IDs of the subnets to provision this VPN server in. Use subnets in different zones for high availability. User can also upgrade or downgrade the VPN server to high availability or standalone by adding/remove the subnets.
    timeouts Property Map
    vpcs List<Property Map>
    The VPC this VPN server resides in.
    vpnServer String
    The unique identifier of the VPNServer.

    Supporting Types

    IsVpnServerClientAuthentication, IsVpnServerClientAuthenticationArgs

    Method string

    The type of authentication.

    • Constraints: Allowable values are: certificate, username

    NOTE: identity_provider and client_ca_crn are mutually exclusive, which means either one must be provided. When method has certificate as value client_ca_crn must be provided and when method has username as value identity_provider must be provided.

    ClientCaCrn string
    The CRN of the certificate instance or CRN of the secret from secrets manager to use for the VPN client certificate authority (CA). As the usage of certificate CRN from Certificate Manager is getting deprecated, It is recommended to use Secret manger for same.
    IdentityProvider string
    The type of identity provider to be used by VPN client.The type of identity provider to be used by the VPN client.- iam: IBM identity and access management The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the route on which the unexpected property value was encountered.

    • Constraints: Allowable values are: iam
    Method string

    The type of authentication.

    • Constraints: Allowable values are: certificate, username

    NOTE: identity_provider and client_ca_crn are mutually exclusive, which means either one must be provided. When method has certificate as value client_ca_crn must be provided and when method has username as value identity_provider must be provided.

    ClientCaCrn string
    The CRN of the certificate instance or CRN of the secret from secrets manager to use for the VPN client certificate authority (CA). As the usage of certificate CRN from Certificate Manager is getting deprecated, It is recommended to use Secret manger for same.
    IdentityProvider string
    The type of identity provider to be used by VPN client.The type of identity provider to be used by the VPN client.- iam: IBM identity and access management The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the route on which the unexpected property value was encountered.

    • Constraints: Allowable values are: iam
    method String

    The type of authentication.

    • Constraints: Allowable values are: certificate, username

    NOTE: identity_provider and client_ca_crn are mutually exclusive, which means either one must be provided. When method has certificate as value client_ca_crn must be provided and when method has username as value identity_provider must be provided.

    clientCaCrn String
    The CRN of the certificate instance or CRN of the secret from secrets manager to use for the VPN client certificate authority (CA). As the usage of certificate CRN from Certificate Manager is getting deprecated, It is recommended to use Secret manger for same.
    identityProvider String
    The type of identity provider to be used by VPN client.The type of identity provider to be used by the VPN client.- iam: IBM identity and access management The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the route on which the unexpected property value was encountered.

    • Constraints: Allowable values are: iam
    method string

    The type of authentication.

    • Constraints: Allowable values are: certificate, username

    NOTE: identity_provider and client_ca_crn are mutually exclusive, which means either one must be provided. When method has certificate as value client_ca_crn must be provided and when method has username as value identity_provider must be provided.

    clientCaCrn string
    The CRN of the certificate instance or CRN of the secret from secrets manager to use for the VPN client certificate authority (CA). As the usage of certificate CRN from Certificate Manager is getting deprecated, It is recommended to use Secret manger for same.
    identityProvider string
    The type of identity provider to be used by VPN client.The type of identity provider to be used by the VPN client.- iam: IBM identity and access management The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the route on which the unexpected property value was encountered.

    • Constraints: Allowable values are: iam
    method str

    The type of authentication.

    • Constraints: Allowable values are: certificate, username

    NOTE: identity_provider and client_ca_crn are mutually exclusive, which means either one must be provided. When method has certificate as value client_ca_crn must be provided and when method has username as value identity_provider must be provided.

    client_ca_crn str
    The CRN of the certificate instance or CRN of the secret from secrets manager to use for the VPN client certificate authority (CA). As the usage of certificate CRN from Certificate Manager is getting deprecated, It is recommended to use Secret manger for same.
    identity_provider str
    The type of identity provider to be used by VPN client.The type of identity provider to be used by the VPN client.- iam: IBM identity and access management The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the route on which the unexpected property value was encountered.

    • Constraints: Allowable values are: iam
    method String

    The type of authentication.

    • Constraints: Allowable values are: certificate, username

    NOTE: identity_provider and client_ca_crn are mutually exclusive, which means either one must be provided. When method has certificate as value client_ca_crn must be provided and when method has username as value identity_provider must be provided.

    clientCaCrn String
    The CRN of the certificate instance or CRN of the secret from secrets manager to use for the VPN client certificate authority (CA). As the usage of certificate CRN from Certificate Manager is getting deprecated, It is recommended to use Secret manger for same.
    identityProvider String
    The type of identity provider to be used by VPN client.The type of identity provider to be used by the VPN client.- iam: IBM identity and access management The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the route on which the unexpected property value was encountered.

    • Constraints: Allowable values are: iam

    IsVpnServerHealthReason, IsVpnServerHealthReasonArgs

    Code string
    (String) A snake case string succinctly identifying the reason for this lifecycle reason.
    Message string
    (String) An explanation of the reason for this lifecycle reason.
    MoreInfo string
    (String) Link to documentation about deleted resources.
    Code string
    (String) A snake case string succinctly identifying the reason for this lifecycle reason.
    Message string
    (String) An explanation of the reason for this lifecycle reason.
    MoreInfo string
    (String) Link to documentation about deleted resources.
    code String
    (String) A snake case string succinctly identifying the reason for this lifecycle reason.
    message String
    (String) An explanation of the reason for this lifecycle reason.
    moreInfo String
    (String) Link to documentation about deleted resources.
    code string
    (String) A snake case string succinctly identifying the reason for this lifecycle reason.
    message string
    (String) An explanation of the reason for this lifecycle reason.
    moreInfo string
    (String) Link to documentation about deleted resources.
    code str
    (String) A snake case string succinctly identifying the reason for this lifecycle reason.
    message str
    (String) An explanation of the reason for this lifecycle reason.
    more_info str
    (String) Link to documentation about deleted resources.
    code String
    (String) A snake case string succinctly identifying the reason for this lifecycle reason.
    message String
    (String) An explanation of the reason for this lifecycle reason.
    moreInfo String
    (String) Link to documentation about deleted resources.

    IsVpnServerLifecycleReason, IsVpnServerLifecycleReasonArgs

    Code string
    (String) A snake case string succinctly identifying the reason for this lifecycle reason.
    Message string
    (String) An explanation of the reason for this lifecycle reason.
    MoreInfo string
    (String) Link to documentation about deleted resources.
    Code string
    (String) A snake case string succinctly identifying the reason for this lifecycle reason.
    Message string
    (String) An explanation of the reason for this lifecycle reason.
    MoreInfo string
    (String) Link to documentation about deleted resources.
    code String
    (String) A snake case string succinctly identifying the reason for this lifecycle reason.
    message String
    (String) An explanation of the reason for this lifecycle reason.
    moreInfo String
    (String) Link to documentation about deleted resources.
    code string
    (String) A snake case string succinctly identifying the reason for this lifecycle reason.
    message string
    (String) An explanation of the reason for this lifecycle reason.
    moreInfo string
    (String) Link to documentation about deleted resources.
    code str
    (String) A snake case string succinctly identifying the reason for this lifecycle reason.
    message str
    (String) An explanation of the reason for this lifecycle reason.
    more_info str
    (String) Link to documentation about deleted resources.
    code String
    (String) A snake case string succinctly identifying the reason for this lifecycle reason.
    message String
    (String) An explanation of the reason for this lifecycle reason.
    moreInfo String
    (String) Link to documentation about deleted resources.

    IsVpnServerPrivateIp, IsVpnServerPrivateIpArgs

    Address string
    (String) The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    Deleteds List<IsVpnServerPrivateIpDeleted>
    (Optional, List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information. Nested scheme for deleted:
    Href string
    (String) The URL for this reserved IP.
    Id string
    (String) The unique identifier for this reserved IP.
    Name string
    The user-defined name for this VPN server. If unspecified, the name will be a hyphenated list of randomly-selected words. Names must be unique within the VPC this VPN server is serving.
    ResourceType string
    (String) The type of resource referenced.
    Address string
    (String) The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    Deleteds []IsVpnServerPrivateIpDeleted
    (Optional, List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information. Nested scheme for deleted:
    Href string
    (String) The URL for this reserved IP.
    Id string
    (String) The unique identifier for this reserved IP.
    Name string
    The user-defined name for this VPN server. If unspecified, the name will be a hyphenated list of randomly-selected words. Names must be unique within the VPC this VPN server is serving.
    ResourceType string
    (String) The type of resource referenced.
    address String
    (String) The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    deleteds List<IsVpnServerPrivateIpDeleted>
    (Optional, List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information. Nested scheme for deleted:
    href String
    (String) The URL for this reserved IP.
    id String
    (String) The unique identifier for this reserved IP.
    name String
    The user-defined name for this VPN server. If unspecified, the name will be a hyphenated list of randomly-selected words. Names must be unique within the VPC this VPN server is serving.
    resourceType String
    (String) The type of resource referenced.
    address string
    (String) The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    deleteds IsVpnServerPrivateIpDeleted[]
    (Optional, List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information. Nested scheme for deleted:
    href string
    (String) The URL for this reserved IP.
    id string
    (String) The unique identifier for this reserved IP.
    name string
    The user-defined name for this VPN server. If unspecified, the name will be a hyphenated list of randomly-selected words. Names must be unique within the VPC this VPN server is serving.
    resourceType string
    (String) The type of resource referenced.
    address str
    (String) The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    deleteds Sequence[IsVpnServerPrivateIpDeleted]
    (Optional, List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information. Nested scheme for deleted:
    href str
    (String) The URL for this reserved IP.
    id str
    (String) The unique identifier for this reserved IP.
    name str
    The user-defined name for this VPN server. If unspecified, the name will be a hyphenated list of randomly-selected words. Names must be unique within the VPC this VPN server is serving.
    resource_type str
    (String) The type of resource referenced.
    address String
    (String) The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    deleteds List<Property Map>
    (Optional, List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information. Nested scheme for deleted:
    href String
    (String) The URL for this reserved IP.
    id String
    (String) The unique identifier for this reserved IP.
    name String
    The user-defined name for this VPN server. If unspecified, the name will be a hyphenated list of randomly-selected words. Names must be unique within the VPC this VPN server is serving.
    resourceType String
    (String) The type of resource referenced.

    IsVpnServerPrivateIpDeleted, IsVpnServerPrivateIpDeletedArgs

    MoreInfo string
    (String) Link to documentation about deleted resources.
    MoreInfo string
    (String) Link to documentation about deleted resources.
    moreInfo String
    (String) Link to documentation about deleted resources.
    moreInfo string
    (String) Link to documentation about deleted resources.
    more_info str
    (String) Link to documentation about deleted resources.
    moreInfo String
    (String) Link to documentation about deleted resources.

    IsVpnServerTimeouts, IsVpnServerTimeoutsArgs

    Create string
    Delete string
    Update string
    Create string
    Delete string
    Update string
    create String
    delete String
    update String
    create string
    delete string
    update string
    create str
    delete str
    update str
    create String
    delete String
    update String

    IsVpnServerVpc, IsVpnServerVpcArgs

    Crn string
    (String) The CRN for this VPN server.
    Deleteds List<IsVpnServerVpcDeleted>
    (Optional, List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information. Nested scheme for deleted:
    Href string
    (String) The URL for this reserved IP.
    Id string
    (String) The unique identifier for this reserved IP.
    Name string
    The user-defined name for this VPN server. If unspecified, the name will be a hyphenated list of randomly-selected words. Names must be unique within the VPC this VPN server is serving.
    Crn string
    (String) The CRN for this VPN server.
    Deleteds []IsVpnServerVpcDeleted
    (Optional, List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information. Nested scheme for deleted:
    Href string
    (String) The URL for this reserved IP.
    Id string
    (String) The unique identifier for this reserved IP.
    Name string
    The user-defined name for this VPN server. If unspecified, the name will be a hyphenated list of randomly-selected words. Names must be unique within the VPC this VPN server is serving.
    crn String
    (String) The CRN for this VPN server.
    deleteds List<IsVpnServerVpcDeleted>
    (Optional, List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information. Nested scheme for deleted:
    href String
    (String) The URL for this reserved IP.
    id String
    (String) The unique identifier for this reserved IP.
    name String
    The user-defined name for this VPN server. If unspecified, the name will be a hyphenated list of randomly-selected words. Names must be unique within the VPC this VPN server is serving.
    crn string
    (String) The CRN for this VPN server.
    deleteds IsVpnServerVpcDeleted[]
    (Optional, List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information. Nested scheme for deleted:
    href string
    (String) The URL for this reserved IP.
    id string
    (String) The unique identifier for this reserved IP.
    name string
    The user-defined name for this VPN server. If unspecified, the name will be a hyphenated list of randomly-selected words. Names must be unique within the VPC this VPN server is serving.
    crn str
    (String) The CRN for this VPN server.
    deleteds Sequence[IsVpnServerVpcDeleted]
    (Optional, List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information. Nested scheme for deleted:
    href str
    (String) The URL for this reserved IP.
    id str
    (String) The unique identifier for this reserved IP.
    name str
    The user-defined name for this VPN server. If unspecified, the name will be a hyphenated list of randomly-selected words. Names must be unique within the VPC this VPN server is serving.
    crn String
    (String) The CRN for this VPN server.
    deleteds List<Property Map>
    (Optional, List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information. Nested scheme for deleted:
    href String
    (String) The URL for this reserved IP.
    id String
    (String) The unique identifier for this reserved IP.
    name String
    The user-defined name for this VPN server. If unspecified, the name will be a hyphenated list of randomly-selected words. Names must be unique within the VPC this VPN server is serving.

    IsVpnServerVpcDeleted, IsVpnServerVpcDeletedArgs

    MoreInfo string
    (String) Link to documentation about deleted resources.
    MoreInfo string
    (String) Link to documentation about deleted resources.
    moreInfo String
    (String) Link to documentation about deleted resources.
    moreInfo string
    (String) Link to documentation about deleted resources.
    more_info str
    (String) Link to documentation about deleted resources.
    moreInfo String
    (String) Link to documentation about deleted resources.

    Import

    You can import the ibm_is_vpn_server resource by using id. The unique identifier for this VPN server.

    Syntax

    $ pulumi import ibm:index/isVpnServer:IsVpnServer is_vpn_server <id>

    Example

    $ pulumi import ibm:index/isVpnServer:IsVpnServer is_vpn_server r006-d7cc5196-9864-48c4-82d8-3f30da41fcc5

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

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm