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

zia.BandwidthClass

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_bandwidth_class resource manages bandwidth classes in the Zscaler Internet Access (ZIA) cloud service. Bandwidth classes define traffic categories based on URLs, URL categories, and web applications that can be referenced in bandwidth control rules to apply specific bandwidth limits.

    For more information, see the ZIA Bandwidth Control documentation.

    Example Usage

    Basic Bandwidth Class

    Example coming soon!

    Example coming soon!

    Example coming soon!

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

const example = new zia.BandwidthClass("example", {
    name: "Example Bandwidth Class",
    webApplications: ["STREAMING_MEDIA"],
});

    import zscaler_pulumi_zia as zia

example = zia.BandwidthClass("example",
    name="Example Bandwidth Class",
    web_applications=["STREAMING_MEDIA"],
)

    resources:
  example:
    type: zia:BandwidthClass
    properties:
      name: Example Bandwidth Class
      webApplications:
        - STREAMING_MEDIA

    Create BandwidthClass Resource

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

    Constructor syntax

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

@overload
def BandwidthClass(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   name: Optional[str] = None,
                   url_categories: Optional[Sequence[str]] = None,
                   urls: Optional[Sequence[str]] = None,
                   web_applications: Optional[Sequence[str]] = None)
    func NewBandwidthClass(ctx *Context, name string, args *BandwidthClassArgs, opts ...ResourceOption) (*BandwidthClass, error)
    public BandwidthClass(string name, BandwidthClassArgs? args = null, CustomResourceOptions? opts = null)
    public BandwidthClass(String name, BandwidthClassArgs args)
public BandwidthClass(String name, BandwidthClassArgs args, CustomResourceOptions options)

    type: zia:BandwidthClass
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 BandwidthClassArgs
    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 BandwidthClassArgs
    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 BandwidthClassArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BandwidthClassArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BandwidthClassArgs
    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 bandwidthClassResource = new Zia.BandwidthClass("bandwidthClassResource", new()
{
    Name = "string",
    UrlCategories = new[]
    {
        "string",
    },
    Urls = new[]
    {
        "string",
    },
    WebApplications = new[]
    {
        "string",
    },
});

    example, err := zia.NewBandwidthClass(ctx, "bandwidthClassResource", &zia.BandwidthClassArgs{
	Name: pulumi.String("string"),
	UrlCategories: pulumi.StringArray{
		pulumi.String("string"),
	},
	Urls: pulumi.StringArray{
		pulumi.String("string"),
	},
	WebApplications: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var bandwidthClassResource = new BandwidthClass("bandwidthClassResource", BandwidthClassArgs.builder()
    .name("string")
    .urlCategories("string")
    .urls("string")
    .webApplications("string")
    .build());

    bandwidth_class_resource = zia.BandwidthClass("bandwidthClassResource",
    name="string",
    url_categories=["string"],
    urls=["string"],
    web_applications=["string"])

    const bandwidthClassResource = new zia.BandwidthClass("bandwidthClassResource", {
    name: "string",
    urlCategories: ["string"],
    urls: ["string"],
    webApplications: ["string"],
});

    type: zia:BandwidthClass
properties:
    name: string
    urlCategories:
        - string
    urls:
        - string
    webApplications:
        - string

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

    Name string
    The name of the bandwidth class. Must be unique.
    UrlCategories List<string>
    List of URL categories associated with the bandwidth class.
    Urls List<string>
    List of URLs associated with the bandwidth class.
    WebApplications List<string>
    List of web applications associated with the bandwidth class.
    Name string
    The name of the bandwidth class. Must be unique.
    UrlCategories []string
    List of URL categories associated with the bandwidth class.
    Urls []string
    List of URLs associated with the bandwidth class.
    WebApplications []string
    List of web applications associated with the bandwidth class.
    name String
    The name of the bandwidth class. Must be unique.
    urlCategories List<String>
    List of URL categories associated with the bandwidth class.
    urls List<String>
    List of URLs associated with the bandwidth class.
    webApplications List<String>
    List of web applications associated with the bandwidth class.
    name string
    The name of the bandwidth class. Must be unique.
    urlCategories string[]
    List of URL categories associated with the bandwidth class.
    urls string[]
    List of URLs associated with the bandwidth class.
    webApplications string[]
    List of web applications associated with the bandwidth class.
    name str
    The name of the bandwidth class. Must be unique.
    url_categories Sequence[str]
    List of URL categories associated with the bandwidth class.
    urls Sequence[str]
    List of URLs associated with the bandwidth class.
    web_applications Sequence[str]
    List of web applications associated with the bandwidth class.
    name String
    The name of the bandwidth class. Must be unique.
    urlCategories List<String>
    List of URL categories associated with the bandwidth class.
    urls List<String>
    List of URLs associated with the bandwidth class.
    webApplications List<String>
    List of web applications associated with the bandwidth class.

    Outputs

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

    ClassId int
    The system-generated ID of the bandwidth class.
    Id string
    The provider-assigned unique ID for this managed resource.
    ClassId int
    The system-generated ID of the bandwidth class.
    Id string
    The provider-assigned unique ID for this managed resource.
    classId Integer
    The system-generated ID of the bandwidth class.
    id String
    The provider-assigned unique ID for this managed resource.
    classId number
    The system-generated ID of the bandwidth class.
    id string
    The provider-assigned unique ID for this managed resource.
    class_id int
    The system-generated ID of the bandwidth class.
    id str
    The provider-assigned unique ID for this managed resource.
    classId Number
    The system-generated ID of the bandwidth class.
    id String
    The provider-assigned unique ID for this managed resource.

    Import

    An existing Bandwidth Class can be imported using its resource ID, e.g.

    $ pulumi import zia:index:BandwidthClass 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.