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

zia.ForwardingControlZpaGateway

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.ForwardingControlZpaGateway resource manages forwarding control ZPA gateway configurations in the Zscaler Internet Access (ZIA) cloud. ZPA gateways are used in forwarding control rules to direct traffic to Zscaler Private Access (ZPA) application segments through ZPA server groups.

    Example Usage

    Basic Forwarding Control ZPA Gateway

    Example coming soon!

    Example coming soon!

    Example coming soon!

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

const example = new zia.ForwardingControlZpaGateway("example", {
    name: "Example ZPA Gateway",
    description: "Managed by Pulumi",
    type: "ZPA",
    zpaServerGroup: {
        externalId: "server-group-external-id",
        name: "Example Server Group",
    },
    zpaAppSegments: [{
        externalId: "app-segment-external-id",
        name: "Example App Segment",
    }],
});

    import zscaler_pulumi_zia as zia

example = zia.ForwardingControlZpaGateway("example",
    name="Example ZPA Gateway",
    description="Managed by Pulumi",
    type="ZPA",
    zpa_server_group={
        "external_id": "server-group-external-id",
        "name": "Example Server Group",
    },
    zpa_app_segments=[{
        "external_id": "app-segment-external-id",
        "name": "Example App Segment",
    }],
)

    resources:
  example:
    type: zia:ForwardingControlZpaGateway
    properties:
      name: Example ZPA Gateway
      description: Managed by Pulumi
      type: ZPA
      zpaServerGroup:
        externalId: server-group-external-id
        name: Example Server Group
      zpaAppSegments:
        - externalId: app-segment-external-id
          name: Example App Segment

    Create ForwardingControlZpaGateway Resource

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

    Constructor syntax

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

@overload
def ForwardingControlZpaGateway(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                description: Optional[str] = None,
                                name: Optional[str] = None,
                                type: Optional[str] = None,
                                zpa_app_segments: Optional[Sequence[ZpaGatewayAppSegmentInputArgs]] = None,
                                zpa_server_group: Optional[ZpaServerGroupInputArgs] = None)
    func NewForwardingControlZpaGateway(ctx *Context, name string, args *ForwardingControlZpaGatewayArgs, opts ...ResourceOption) (*ForwardingControlZpaGateway, error)
    public ForwardingControlZpaGateway(string name, ForwardingControlZpaGatewayArgs? args = null, CustomResourceOptions? opts = null)
    public ForwardingControlZpaGateway(String name, ForwardingControlZpaGatewayArgs args)
public ForwardingControlZpaGateway(String name, ForwardingControlZpaGatewayArgs args, CustomResourceOptions options)

    type: zia:ForwardingControlZpaGateway
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 ForwardingControlZpaGatewayArgs
    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 ForwardingControlZpaGatewayArgs
    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 ForwardingControlZpaGatewayArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ForwardingControlZpaGatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ForwardingControlZpaGatewayArgs
    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 forwardingControlZpaGatewayResource = new Zia.Index.ForwardingControlZpaGateway("forwardingControlZpaGatewayResource", new()
{
    Description = "string",
    Name = "string",
    Type = "string",
    ZpaAppSegments = new[]
    {
        new Zia.Inputs.ZpaGatewayAppSegmentInputArgs
        {
            ExternalId = "string",
            Name = "string",
        },
    },
    ZpaServerGroup = new Zia.Inputs.ZpaServerGroupInputArgs
    {
        ExternalId = "string",
        Name = "string",
    },
});

    example, err := zia.NewForwardingControlZpaGateway(ctx, "forwardingControlZpaGatewayResource", &zia.ForwardingControlZpaGatewayArgs{
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	Type:        pulumi.String("string"),
	ZpaAppSegments: pulumizia.ZpaGatewayAppSegmentInputArray{
		&pulumizia.ZpaGatewayAppSegmentInputArgs{
			ExternalId: pulumi.String("string"),
			Name:       pulumi.String("string"),
		},
	},
	ZpaServerGroup: &pulumizia.ZpaServerGroupInputArgs{
		ExternalId: pulumi.String("string"),
		Name:       pulumi.String("string"),
	},
})

    var forwardingControlZpaGatewayResource = new ForwardingControlZpaGateway("forwardingControlZpaGatewayResource", ForwardingControlZpaGatewayArgs.builder()
    .description("string")
    .name("string")
    .type("string")
    .zpaAppSegments(ZpaGatewayAppSegmentInputArgs.builder()
        .externalId("string")
        .name("string")
        .build())
    .zpaServerGroup(ZpaServerGroupInputArgs.builder()
        .externalId("string")
        .name("string")
        .build())
    .build());

    forwarding_control_zpa_gateway_resource = zia.ForwardingControlZpaGateway("forwardingControlZpaGatewayResource",
    description="string",
    name="string",
    type="string",
    zpa_app_segments=[{
        "external_id": "string",
        "name": "string",
    }],
    zpa_server_group={
        "external_id": "string",
        "name": "string",
    })

    const forwardingControlZpaGatewayResource = new zia.ForwardingControlZpaGateway("forwardingControlZpaGatewayResource", {
    description: "string",
    name: "string",
    type: "string",
    zpaAppSegments: [{
        externalId: "string",
        name: "string",
    }],
    zpaServerGroup: {
        externalId: "string",
        name: "string",
    },
});

    type: zia:ForwardingControlZpaGateway
properties:
    description: string
    name: string
    type: string
    zpaAppSegments:
        - externalId: string
          name: string
    zpaServerGroup:
        externalId: string
        name: string

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

    Description string
    Description of the ZPA gateway.
    Name string
    Name of the ZPA gateway.
    Type string
    The gateway type. Accepted values: 'ZPA' or 'ECZPA'.
    ZpaAppSegments List<zscaler.PulumiPackage.Zia.Inputs.ZpaGatewayAppSegmentInput>
    List of ZPA application segments associated with the gateway.
    ZpaServerGroup zscaler.PulumiPackage.Zia.Inputs.ZpaServerGroupInput
    The ZPA server group associated with the gateway.
    Description string
    Description of the ZPA gateway.
    Name string
    Name of the ZPA gateway.
    Type string
    The gateway type. Accepted values: 'ZPA' or 'ECZPA'.
    ZpaAppSegments []ZpaGatewayAppSegmentInputArgs
    List of ZPA application segments associated with the gateway.
    ZpaServerGroup ZpaServerGroupInputArgs
    The ZPA server group associated with the gateway.
    description String
    Description of the ZPA gateway.
    name String
    Name of the ZPA gateway.
    type String
    The gateway type. Accepted values: 'ZPA' or 'ECZPA'.
    zpaAppSegments List<ZpaGatewayAppSegmentInput>
    List of ZPA application segments associated with the gateway.
    zpaServerGroup ZpaServerGroupInput
    The ZPA server group associated with the gateway.
    description string
    Description of the ZPA gateway.
    name string
    Name of the ZPA gateway.
    type string
    The gateway type. Accepted values: 'ZPA' or 'ECZPA'.
    zpaAppSegments ZpaGatewayAppSegmentInput[]
    List of ZPA application segments associated with the gateway.
    zpaServerGroup ZpaServerGroupInput
    The ZPA server group associated with the gateway.
    description str
    Description of the ZPA gateway.
    name str
    Name of the ZPA gateway.
    type str
    The gateway type. Accepted values: 'ZPA' or 'ECZPA'.
    zpa_app_segments Sequence[ZpaGatewayAppSegmentInputArgs]
    List of ZPA application segments associated with the gateway.
    zpa_server_group ZpaServerGroupInputArgs
    The ZPA server group associated with the gateway.
    description String
    Description of the ZPA gateway.
    name String
    Name of the ZPA gateway.
    type String
    The gateway type. Accepted values: 'ZPA' or 'ECZPA'.
    zpaAppSegments List<Property Map>
    List of ZPA application segments associated with the gateway.
    zpaServerGroup Property Map
    The ZPA server group associated with the gateway.

    Outputs

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

    GatewayId int
    The unique identifier for the ZPA gateway assigned by the ZIA cloud.
    Id string
    The provider-assigned unique ID for this managed resource.
    GatewayId int
    The unique identifier for the ZPA gateway assigned by the ZIA cloud.
    Id string
    The provider-assigned unique ID for this managed resource.
    gatewayId Integer
    The unique identifier for the ZPA gateway assigned by the ZIA cloud.
    id String
    The provider-assigned unique ID for this managed resource.
    gatewayId number
    The unique identifier for the ZPA gateway assigned by the ZIA cloud.
    id string
    The provider-assigned unique ID for this managed resource.
    gateway_id int
    The unique identifier for the ZPA gateway assigned by the ZIA cloud.
    id str
    The provider-assigned unique ID for this managed resource.
    gatewayId Number
    The unique identifier for the ZPA gateway assigned by the ZIA cloud.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    ZpaGatewayAppSegmentInput, ZpaGatewayAppSegmentInputArgs

    ExternalId string
    Name string
    ExternalId string
    Name string
    externalId String
    name String
    externalId string
    name string
    externalId String
    name String

    ZpaServerGroupInput, ZpaServerGroupInputArgs

    ExternalId string
    Name string
    ExternalId string
    Name string
    externalId String
    name String
    externalId string
    name string
    externalId String
    name String

    Import

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

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