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

zia.ForwardingControlProxies

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.ForwardingControlProxies resource manages forwarding control proxy configurations in the Zscaler Internet Access (ZIA) cloud. Proxies are used in forwarding control rules to direct traffic through proxy chains, ZIA, or EC-self proxy types.

    Example Usage

    Basic Forwarding Control Proxy

    Example coming soon!

    Example coming soon!

    Example coming soon!

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

const example = new zia.ForwardingControlProxies("example", {
    name: "Example Proxy",
    description: "Managed by Pulumi",
    type: "PROXYCHAIN",
    address: "proxy.example.com",
    port: 8080,
});

    import zscaler_pulumi_zia as zia

example = zia.ForwardingControlProxies("example",
    name="Example Proxy",
    description="Managed by Pulumi",
    type="PROXYCHAIN",
    address="proxy.example.com",
    port=8080,
)

    resources:
  example:
    type: zia:ForwardingControlProxies
    properties:
      name: Example Proxy
      description: Managed by Pulumi
      type: PROXYCHAIN
      address: proxy.example.com
      port: 8080

    Create ForwardingControlProxies Resource

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

    Constructor syntax

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

@overload
def ForwardingControlProxies(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             address: Optional[str] = None,
                             base64_encode_xau_header: Optional[bool] = None,
                             cert_id: Optional[int] = None,
                             description: Optional[str] = None,
                             insert_xau_header: Optional[bool] = None,
                             name: Optional[str] = None,
                             port: Optional[int] = None,
                             type: Optional[str] = None)
    func NewForwardingControlProxies(ctx *Context, name string, args *ForwardingControlProxiesArgs, opts ...ResourceOption) (*ForwardingControlProxies, error)
    public ForwardingControlProxies(string name, ForwardingControlProxiesArgs? args = null, CustomResourceOptions? opts = null)
    public ForwardingControlProxies(String name, ForwardingControlProxiesArgs args)
public ForwardingControlProxies(String name, ForwardingControlProxiesArgs args, CustomResourceOptions options)

    type: zia:ForwardingControlProxies
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 ForwardingControlProxiesArgs
    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 ForwardingControlProxiesArgs
    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 ForwardingControlProxiesArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ForwardingControlProxiesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ForwardingControlProxiesArgs
    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 forwardingControlProxiesResource = new Zia.ForwardingControlProxies("forwardingControlProxiesResource", new()
{
    Address = "string",
    Base64EncodeXauHeader = false,
    CertId = 0,
    Description = "string",
    InsertXauHeader = false,
    Name = "string",
    Port = 0,
    Type = "string",
});

    example, err := zia.NewForwardingControlProxies(ctx, "forwardingControlProxiesResource", &zia.ForwardingControlProxiesArgs{
	Address:               pulumi.String("string"),
	Base64EncodeXauHeader: pulumi.Bool(false),
	CertId:                pulumi.Int(0),
	Description:           pulumi.String("string"),
	InsertXauHeader:       pulumi.Bool(false),
	Name:                  pulumi.String("string"),
	Port:                  pulumi.Int(0),
	Type:                  pulumi.String("string"),
})

    var forwardingControlProxiesResource = new ForwardingControlProxies("forwardingControlProxiesResource", ForwardingControlProxiesArgs.builder()
    .address("string")
    .base64EncodeXauHeader(false)
    .certId(0)
    .description("string")
    .insertXauHeader(false)
    .name("string")
    .port(0)
    .type("string")
    .build());

    forwarding_control_proxies_resource = zia.ForwardingControlProxies("forwardingControlProxiesResource",
    address="string",
    base64_encode_xau_header=False,
    cert_id=0,
    description="string",
    insert_xau_header=False,
    name="string",
    port=0,
    type="string")

    const forwardingControlProxiesResource = new zia.ForwardingControlProxies("forwardingControlProxiesResource", {
    address: "string",
    base64EncodeXauHeader: false,
    certId: 0,
    description: "string",
    insertXauHeader: false,
    name: "string",
    port: 0,
    type: "string",
});

    type: zia:ForwardingControlProxies
properties:
    address: string
    base64EncodeXauHeader: false
    certId: 0
    description: string
    insertXauHeader: false
    name: string
    port: 0
    type: string

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

    Address string
    The address of the proxy server.
    Base64EncodeXauHeader bool
    Whether to base64-encode the X-Authenticated-User header.
    CertId int
    The certificate ID used for the proxy.
    Description string
    Description of the forwarding control proxy.
    InsertXauHeader bool
    Whether to insert the X-Authenticated-User header.
    Name string
    Name of the forwarding control proxy.
    Port int
    The port number of the proxy server.
    Type string
    The proxy type. Accepted values: 'PROXYCHAIN', 'ZIA', 'ECSELF'.
    Address string
    The address of the proxy server.
    Base64EncodeXauHeader bool
    Whether to base64-encode the X-Authenticated-User header.
    CertId int
    The certificate ID used for the proxy.
    Description string
    Description of the forwarding control proxy.
    InsertXauHeader bool
    Whether to insert the X-Authenticated-User header.
    Name string
    Name of the forwarding control proxy.
    Port int
    The port number of the proxy server.
    Type string
    The proxy type. Accepted values: 'PROXYCHAIN', 'ZIA', 'ECSELF'.
    address String
    The address of the proxy server.
    base64EncodeXauHeader Boolean
    Whether to base64-encode the X-Authenticated-User header.
    certId Integer
    The certificate ID used for the proxy.
    description String
    Description of the forwarding control proxy.
    insertXauHeader Boolean
    Whether to insert the X-Authenticated-User header.
    name String
    Name of the forwarding control proxy.
    port Integer
    The port number of the proxy server.
    type String
    The proxy type. Accepted values: 'PROXYCHAIN', 'ZIA', 'ECSELF'.
    address string
    The address of the proxy server.
    base64EncodeXauHeader boolean
    Whether to base64-encode the X-Authenticated-User header.
    certId number
    The certificate ID used for the proxy.
    description string
    Description of the forwarding control proxy.
    insertXauHeader boolean
    Whether to insert the X-Authenticated-User header.
    name string
    Name of the forwarding control proxy.
    port number
    The port number of the proxy server.
    type string
    The proxy type. Accepted values: 'PROXYCHAIN', 'ZIA', 'ECSELF'.
    address str
    The address of the proxy server.
    base64_encode_xau_header bool
    Whether to base64-encode the X-Authenticated-User header.
    cert_id int
    The certificate ID used for the proxy.
    description str
    Description of the forwarding control proxy.
    insert_xau_header bool
    Whether to insert the X-Authenticated-User header.
    name str
    Name of the forwarding control proxy.
    port int
    The port number of the proxy server.
    type str
    The proxy type. Accepted values: 'PROXYCHAIN', 'ZIA', 'ECSELF'.
    address String
    The address of the proxy server.
    base64EncodeXauHeader Boolean
    Whether to base64-encode the X-Authenticated-User header.
    certId Number
    The certificate ID used for the proxy.
    description String
    Description of the forwarding control proxy.
    insertXauHeader Boolean
    Whether to insert the X-Authenticated-User header.
    name String
    Name of the forwarding control proxy.
    port Number
    The port number of the proxy server.
    type String
    The proxy type. Accepted values: 'PROXYCHAIN', 'ZIA', 'ECSELF'.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    ProxyId int
    The unique identifier for the proxy assigned by the ZIA cloud.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProxyId int
    The unique identifier for the proxy assigned by the ZIA cloud.
    id String
    The provider-assigned unique ID for this managed resource.
    proxyId Integer
    The unique identifier for the proxy assigned by the ZIA cloud.
    id string
    The provider-assigned unique ID for this managed resource.
    proxyId number
    The unique identifier for the proxy assigned by the ZIA cloud.
    id str
    The provider-assigned unique ID for this managed resource.
    proxy_id int
    The unique identifier for the proxy assigned by the ZIA cloud.
    id String
    The provider-assigned unique ID for this managed resource.
    proxyId Number
    The unique identifier for the proxy assigned by the ZIA cloud.

    Import

    An existing forwarding control proxy can be imported using its ID, e.g.

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