BandwidthControlRule

pulumi-resource-zia v1.3.8, Mar 13 26

Viewing docs for pulumi-resource-zia v1.3.8
published on Friday, Mar 13, 2026 by Zscaler

Schema (JSON)

zscaler/pulumi-zia

Viewing docs for pulumi-resource-zia v1.3.8
published on Friday, Mar 13, 2026 by Zscaler

Schema (JSON)

zscaler/pulumi-zia

The zia_bandwidth_control_rule resource manages bandwidth control rules in the Zscaler Internet Access (ZIA) cloud service. Bandwidth control rules allow administrators to define minimum and maximum bandwidth limits for specific traffic, locations, and time windows to ensure quality of service across the network.

For more information, see the ZIA Bandwidth Control documentation.

Example Usage

Basic Bandwidth Control Rule

Example coming soon!

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

const example = new zia.BandwidthControlRule("example", {
    name: "Example Bandwidth Control Rule",
    description: "Limit streaming bandwidth",
    order: 1,
    state: "ENABLED",
    maxBandwidth: 50,
    protocols: ["ANY_RULE"],
});

import zscaler_pulumi_zia as zia

example = zia.BandwidthControlRule("example",
    name="Example Bandwidth Control Rule",
    description="Limit streaming bandwidth",
    order=1,
    state="ENABLED",
    max_bandwidth=50,
    protocols=["ANY_RULE"],
)

resources:
  example:
    type: zia:BandwidthControlRule
    properties:
      name: Example Bandwidth Control Rule
      description: Limit streaming bandwidth
      order: 1
      state: ENABLED
      maxBandwidth: 50
      protocols:
        - ANY_RULE

Create BandwidthControlRule Resource

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

Constructor syntax

new BandwidthControlRule(name: string, args: BandwidthControlRuleArgs, opts?: CustomResourceOptions);

@overload
def BandwidthControlRule(resource_name: str,
                         args: BandwidthControlRuleArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def BandwidthControlRule(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         name: Optional[str] = None,
                         order: Optional[int] = None,
                         min_bandwidth: Optional[int] = None,
                         location_groups: Optional[Sequence[int]] = None,
                         locations: Optional[Sequence[int]] = None,
                         max_bandwidth: Optional[int] = None,
                         bandwidth_classes: Optional[Sequence[int]] = None,
                         labels: Optional[Sequence[int]] = None,
                         description: Optional[str] = None,
                         protocols: Optional[Sequence[str]] = None,
                         rank: Optional[int] = None,
                         state: Optional[str] = None,
                         time_windows: Optional[Sequence[int]] = None)

func NewBandwidthControlRule(ctx *Context, name string, args BandwidthControlRuleArgs, opts ...ResourceOption) (*BandwidthControlRule, error)

public BandwidthControlRule(string name, BandwidthControlRuleArgs args, CustomResourceOptions? opts = null)

public BandwidthControlRule(String name, BandwidthControlRuleArgs args)
public BandwidthControlRule(String name, BandwidthControlRuleArgs args, CustomResourceOptions options)

type: zia:BandwidthControlRule
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 BandwidthControlRuleArgs: 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 BandwidthControlRuleArgs: 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 BandwidthControlRuleArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args BandwidthControlRuleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args BandwidthControlRuleArgs: 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 bandwidthControlRuleResource = new Zia.BandwidthControlRule("bandwidthControlRuleResource", new()
{
    Name = "string",
    Order = 0,
    MinBandwidth = 0,
    LocationGroups = new[]
    {
        0,
    },
    Locations = new[]
    {
        0,
    },
    MaxBandwidth = 0,
    BandwidthClasses = new[]
    {
        0,
    },
    Labels = new[]
    {
        0,
    },
    Description = "string",
    Protocols = new[]
    {
        "string",
    },
    Rank = 0,
    State = "string",
    TimeWindows = new[]
    {
        0,
    },
});

example, err := zia.NewBandwidthControlRule(ctx, "bandwidthControlRuleResource", &zia.BandwidthControlRuleArgs{
	Name:         pulumi.String("string"),
	Order:        pulumi.Int(0),
	MinBandwidth: pulumi.Int(0),
	LocationGroups: pulumi.IntArray{
		pulumi.Int(0),
	},
	Locations: pulumi.IntArray{
		pulumi.Int(0),
	},
	MaxBandwidth: pulumi.Int(0),
	BandwidthClasses: pulumi.IntArray{
		pulumi.Int(0),
	},
	Labels: pulumi.IntArray{
		pulumi.Int(0),
	},
	Description: pulumi.String("string"),
	Protocols: pulumi.StringArray{
		pulumi.String("string"),
	},
	Rank:  pulumi.Int(0),
	State: pulumi.String("string"),
	TimeWindows: pulumi.IntArray{
		pulumi.Int(0),
	},
})

var bandwidthControlRuleResource = new BandwidthControlRule("bandwidthControlRuleResource", BandwidthControlRuleArgs.builder()
    .name("string")
    .order(0)
    .minBandwidth(0)
    .locationGroups(0)
    .locations(0)
    .maxBandwidth(0)
    .bandwidthClasses(0)
    .labels(0)
    .description("string")
    .protocols("string")
    .rank(0)
    .state("string")
    .timeWindows(0)
    .build());

bandwidth_control_rule_resource = zia.BandwidthControlRule("bandwidthControlRuleResource",
    name="string",
    order=0,
    min_bandwidth=0,
    location_groups=[0],
    locations=[0],
    max_bandwidth=0,
    bandwidth_classes=[0],
    labels=[0],
    description="string",
    protocols=["string"],
    rank=0,
    state="string",
    time_windows=[0])

const bandwidthControlRuleResource = new zia.BandwidthControlRule("bandwidthControlRuleResource", {
    name: "string",
    order: 0,
    minBandwidth: 0,
    locationGroups: [0],
    locations: [0],
    maxBandwidth: 0,
    bandwidthClasses: [0],
    labels: [0],
    description: "string",
    protocols: ["string"],
    rank: 0,
    state: "string",
    timeWindows: [0],
});

type: zia:BandwidthControlRule
properties:
    bandwidthClasses:
        - 0
    description: string
    labels:
        - 0
    locationGroups:
        - 0
    locations:
        - 0
    maxBandwidth: 0
    minBandwidth: 0
    name: string
    order: 0
    protocols:
        - string
    rank: 0
    state: string
    timeWindows:
        - 0