1. Packages
  2. Zscaler Internet Access (ZIA)
  3. API Docs
  4. VzenCluster
Viewing docs for pulumi-resource-zia v1.3.8
published on Friday, Mar 13, 2026 by Zscaler
Schema (JSON)
zscaler/pulumi-zia

zia.VzenCluster

zia logo
Viewing docs for pulumi-resource-zia v1.3.8
published on Friday, Mar 13, 2026 by Zscaler
Schema (JSON)
zscaler/pulumi-zia

    The zia.VzenCluster resource manages Virtual ZEN (VZEN) cluster configurations in the Zscaler Internet Access (ZIA) cloud. VZEN clusters group multiple VZEN nodes for high availability and load balancing of traffic processing.

    Example Usage

    Basic VZEN Cluster

    Example coming soon!

    Example coming soon!

    Example coming soon!

    import * as zia from "@bdzscaler/pulumi-zia";

const example = new zia.VzenCluster("example", {
    name: "Example VZEN Cluster",
    status: "ENABLED",
    type: "VZEN",
    ipAddress: "10.0.0.20",
    subnetMask: "255.255.255.0",
    defaultGateway: "10.0.0.1",
    ipSecEnabled: true,
    virtualZenNodes: [12345, 67890],
});

    import zscaler_pulumi_zia as zia

example = zia.VzenCluster("example",
    name="Example VZEN Cluster",
    status="ENABLED",
    type="VZEN",
    ip_address="10.0.0.20",
    subnet_mask="255.255.255.0",
    default_gateway="10.0.0.1",
    ip_sec_enabled=True,
    virtual_zen_nodes=[12345, 67890],
)

    resources:
  example:
    type: zia:VzenCluster
    properties:
      name: Example VZEN Cluster
      status: ENABLED
      type: VZEN
      ipAddress: "10.0.0.20"
      subnetMask: "255.255.255.0"
      defaultGateway: "10.0.0.1"
      ipSecEnabled: true
      virtualZenNodes:
        - 12345
        - 67890

    Create VzenCluster Resource

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

    Constructor syntax

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

@overload
def VzenCluster(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                default_gateway: Optional[str] = None,
                ip_address: Optional[str] = None,
                ip_sec_enabled: Optional[bool] = None,
                name: Optional[str] = None,
                status: Optional[str] = None,
                subnet_mask: Optional[str] = None,
                type: Optional[str] = None,
                virtual_zen_nodes: Optional[Sequence[int]] = None)
    func NewVzenCluster(ctx *Context, name string, args *VzenClusterArgs, opts ...ResourceOption) (*VzenCluster, error)
    public VzenCluster(string name, VzenClusterArgs? args = null, CustomResourceOptions? opts = null)
    public VzenCluster(String name, VzenClusterArgs args)
public VzenCluster(String name, VzenClusterArgs args, CustomResourceOptions options)

    type: zia:VzenCluster
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 VzenClusterArgs
    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 VzenClusterArgs
    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 VzenClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VzenClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VzenClusterArgs
    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 vzenClusterResource = new Zia.VzenCluster("vzenClusterResource", new()
{
    DefaultGateway = "string",
    IpAddress = "string",
    IpSecEnabled = false,
    Name = "string",
    Status = "string",
    SubnetMask = "string",
    Type = "string",
    VirtualZenNodes = new[]
    {
        0,
    },
});

    example, err := zia.NewVzenCluster(ctx, "vzenClusterResource", &zia.VzenClusterArgs{
	DefaultGateway: pulumi.String("string"),
	IpAddress:      pulumi.String("string"),
	IpSecEnabled:   pulumi.Bool(false),
	Name:           pulumi.String("string"),
	Status:         pulumi.String("string"),
	SubnetMask:     pulumi.String("string"),
	Type:           pulumi.String("string"),
	VirtualZenNodes: pulumi.IntArray{
		pulumi.Int(0),
	},
})

    var vzenClusterResource = new VzenCluster("vzenClusterResource", VzenClusterArgs.builder()
    .defaultGateway("string")
    .ipAddress("string")
    .ipSecEnabled(false)
    .name("string")
    .status("string")
    .subnetMask("string")
    .type("string")
    .virtualZenNodes(0)
    .build());

    vzen_cluster_resource = zia.VzenCluster("vzenClusterResource",
    default_gateway="string",
    ip_address="string",
    ip_sec_enabled=False,
    name="string",
    status="string",
    subnet_mask="string",
    type="string",
    virtual_zen_nodes=[0])

    const vzenClusterResource = new zia.VzenCluster("vzenClusterResource", {
    defaultGateway: "string",
    ipAddress: "string",
    ipSecEnabled: false,
    name: "string",
    status: "string",
    subnetMask: "string",
    type: "string",
    virtualZenNodes: [0],
});

    type: zia:VzenCluster
properties:
    defaultGateway: string
    ipAddress: string
    ipSecEnabled: false
    name: string
    status: string
    subnetMask: string
    type: string
    virtualZenNodes:
        - 0

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

    DefaultGateway string
    The default gateway of the VZEN cluster.
    IpAddress string
    The IP address of the VZEN cluster.
    IpSecEnabled bool
    Whether IPSec is enabled on the cluster.
    Name string
    Name of the VZEN cluster.
    Status string
    The status of the cluster (e.g., 'ENABLED', 'DISABLED').
    SubnetMask string
    The subnet mask of the VZEN cluster.
    Type string
    The type of the VZEN cluster.
    VirtualZenNodes List<int>
    List of VZEN node IDs that belong to this cluster.
    DefaultGateway string
    The default gateway of the VZEN cluster.
    IpAddress string
    The IP address of the VZEN cluster.
    IpSecEnabled bool
    Whether IPSec is enabled on the cluster.
    Name string
    Name of the VZEN cluster.
    Status string
    The status of the cluster (e.g., 'ENABLED', 'DISABLED').
    SubnetMask string
    The subnet mask of the VZEN cluster.
    Type string
    The type of the VZEN cluster.
    VirtualZenNodes []int
    List of VZEN node IDs that belong to this cluster.
    defaultGateway String
    The default gateway of the VZEN cluster.
    ipAddress String
    The IP address of the VZEN cluster.
    ipSecEnabled Boolean
    Whether IPSec is enabled on the cluster.
    name String
    Name of the VZEN cluster.
    status String
    The status of the cluster (e.g., 'ENABLED', 'DISABLED').
    subnetMask String
    The subnet mask of the VZEN cluster.
    type String
    The type of the VZEN cluster.
    virtualZenNodes List<Integer>
    List of VZEN node IDs that belong to this cluster.
    defaultGateway string
    The default gateway of the VZEN cluster.
    ipAddress string
    The IP address of the VZEN cluster.
    ipSecEnabled boolean
    Whether IPSec is enabled on the cluster.
    name string
    Name of the VZEN cluster.
    status string
    The status of the cluster (e.g., 'ENABLED', 'DISABLED').
    subnetMask string
    The subnet mask of the VZEN cluster.
    type string
    The type of the VZEN cluster.
    virtualZenNodes number[]
    List of VZEN node IDs that belong to this cluster.
    default_gateway str
    The default gateway of the VZEN cluster.
    ip_address str
    The IP address of the VZEN cluster.
    ip_sec_enabled bool
    Whether IPSec is enabled on the cluster.
    name str
    Name of the VZEN cluster.
    status str
    The status of the cluster (e.g., 'ENABLED', 'DISABLED').
    subnet_mask str
    The subnet mask of the VZEN cluster.
    type str
    The type of the VZEN cluster.
    virtual_zen_nodes Sequence[int]
    List of VZEN node IDs that belong to this cluster.
    defaultGateway String
    The default gateway of the VZEN cluster.
    ipAddress String
    The IP address of the VZEN cluster.
    ipSecEnabled Boolean
    Whether IPSec is enabled on the cluster.
    name String
    Name of the VZEN cluster.
    status String
    The status of the cluster (e.g., 'ENABLED', 'DISABLED').
    subnetMask String
    The subnet mask of the VZEN cluster.
    type String
    The type of the VZEN cluster.
    virtualZenNodes List<Number>
    List of VZEN node IDs that belong to this cluster.

    Outputs

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

    ClusterId int
    The unique identifier for the VZEN cluster assigned by the ZIA cloud.
    Id string
    The provider-assigned unique ID for this managed resource.
    ClusterId int
    The unique identifier for the VZEN cluster assigned by the ZIA cloud.
    Id string
    The provider-assigned unique ID for this managed resource.
    clusterId Integer
    The unique identifier for the VZEN cluster assigned by the ZIA cloud.
    id String
    The provider-assigned unique ID for this managed resource.
    clusterId number
    The unique identifier for the VZEN cluster assigned by the ZIA cloud.
    id string
    The provider-assigned unique ID for this managed resource.
    cluster_id int
    The unique identifier for the VZEN cluster assigned by the ZIA cloud.
    id str
    The provider-assigned unique ID for this managed resource.
    clusterId Number
    The unique identifier for the VZEN cluster assigned by the ZIA cloud.
    id String
    The provider-assigned unique ID for this managed resource.

    Import

    An existing VZEN cluster can be imported using its ID, e.g.

    $ pulumi import zia:index:VzenCluster example 12345

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

    Package Details

    Repository
    zia zscaler/pulumi-zia
    License
    zia logo
    Viewing docs for pulumi-resource-zia v1.3.8
    published on Friday, Mar 13, 2026 by Zscaler
    Schema (JSON)
    zscaler/pulumi-zia
      Try Pulumi Cloud free. Your team will thank you.