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

    The zia.FtpControlPolicy resource manages the FTP control policy settings in the Zscaler Internet Access (ZIA) cloud. This is a singleton resource (one per tenant). The policy controls whether FTP and FTP-over-HTTP traffic is allowed or blocked, and which URLs and URL categories are subject to FTP controls. Deleting the Pulumi resource does not remove the underlying settings.

    Example Usage

    Basic FTP Control Policy

    Example coming soon!

    Example coming soon!

    Example coming soon!

    import * as zia from "@bdzscaler/pulumi-zia";
    
    const example = new zia.FtpControlPolicy("example", {
        ftpEnabled: true,
        ftpOverHttpEnabled: false,
        urls: ["example.com"],
        urlCategories: ["OTHER_ADULT_MATERIAL"],
    });
    
    import zscaler_pulumi_zia as zia
    
    example = zia.FtpControlPolicy("example",
        ftp_enabled=True,
        ftp_over_http_enabled=False,
        urls=["example.com"],
        url_categories=["OTHER_ADULT_MATERIAL"],
    )
    
    resources:
      example:
        type: zia:FtpControlPolicy
        properties:
          ftpEnabled: true
          ftpOverHttpEnabled: false
          urls:
            - example.com
          urlCategories:
            - OTHER_ADULT_MATERIAL
    

    Create FtpControlPolicy Resource

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

    Constructor syntax

    new FtpControlPolicy(name: string, args?: FtpControlPolicyArgs, opts?: CustomResourceOptions);
    @overload
    def FtpControlPolicy(resource_name: str,
                         args: Optional[FtpControlPolicyArgs] = None,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def FtpControlPolicy(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         ftp_enabled: Optional[bool] = None,
                         ftp_over_http_enabled: Optional[bool] = None,
                         url_categories: Optional[Sequence[str]] = None,
                         urls: Optional[Sequence[str]] = None)
    func NewFtpControlPolicy(ctx *Context, name string, args *FtpControlPolicyArgs, opts ...ResourceOption) (*FtpControlPolicy, error)
    public FtpControlPolicy(string name, FtpControlPolicyArgs? args = null, CustomResourceOptions? opts = null)
    public FtpControlPolicy(String name, FtpControlPolicyArgs args)
    public FtpControlPolicy(String name, FtpControlPolicyArgs args, CustomResourceOptions options)
    
    type: zia:FtpControlPolicy
    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 FtpControlPolicyArgs
    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 FtpControlPolicyArgs
    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 FtpControlPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FtpControlPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FtpControlPolicyArgs
    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 ftpControlPolicyResource = new Zia.FtpControlPolicy("ftpControlPolicyResource", new()
    {
        FtpEnabled = false,
        FtpOverHttpEnabled = false,
        UrlCategories = new[]
        {
            "string",
        },
        Urls = new[]
        {
            "string",
        },
    });
    
    example, err := zia.NewFtpControlPolicy(ctx, "ftpControlPolicyResource", &zia.FtpControlPolicyArgs{
    	FtpEnabled:         pulumi.Bool(false),
    	FtpOverHttpEnabled: pulumi.Bool(false),
    	UrlCategories: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Urls: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var ftpControlPolicyResource = new FtpControlPolicy("ftpControlPolicyResource", FtpControlPolicyArgs.builder()
        .ftpEnabled(false)
        .ftpOverHttpEnabled(false)
        .urlCategories("string")
        .urls("string")
        .build());
    
    ftp_control_policy_resource = zia.FtpControlPolicy("ftpControlPolicyResource",
        ftp_enabled=False,
        ftp_over_http_enabled=False,
        url_categories=["string"],
        urls=["string"])
    
    const ftpControlPolicyResource = new zia.FtpControlPolicy("ftpControlPolicyResource", {
        ftpEnabled: false,
        ftpOverHttpEnabled: false,
        urlCategories: ["string"],
        urls: ["string"],
    });
    
    type: zia:FtpControlPolicy
    properties:
        ftpEnabled: false
        ftpOverHttpEnabled: false
        urlCategories:
            - string
        urls:
            - string
    

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

    FtpEnabled bool
    Whether native FTP traffic is enabled.
    FtpOverHttpEnabled bool
    Whether FTP-over-HTTP traffic is enabled.
    UrlCategories List<string>
    List of URL categories subject to the FTP control policy.
    Urls List<string>
    List of URLs subject to the FTP control policy.
    FtpEnabled bool
    Whether native FTP traffic is enabled.
    FtpOverHttpEnabled bool
    Whether FTP-over-HTTP traffic is enabled.
    UrlCategories []string
    List of URL categories subject to the FTP control policy.
    Urls []string
    List of URLs subject to the FTP control policy.
    ftpEnabled Boolean
    Whether native FTP traffic is enabled.
    ftpOverHttpEnabled Boolean
    Whether FTP-over-HTTP traffic is enabled.
    urlCategories List<String>
    List of URL categories subject to the FTP control policy.
    urls List<String>
    List of URLs subject to the FTP control policy.
    ftpEnabled boolean
    Whether native FTP traffic is enabled.
    ftpOverHttpEnabled boolean
    Whether FTP-over-HTTP traffic is enabled.
    urlCategories string[]
    List of URL categories subject to the FTP control policy.
    urls string[]
    List of URLs subject to the FTP control policy.
    ftp_enabled bool
    Whether native FTP traffic is enabled.
    ftp_over_http_enabled bool
    Whether FTP-over-HTTP traffic is enabled.
    url_categories Sequence[str]
    List of URL categories subject to the FTP control policy.
    urls Sequence[str]
    List of URLs subject to the FTP control policy.
    ftpEnabled Boolean
    Whether native FTP traffic is enabled.
    ftpOverHttpEnabled Boolean
    Whether FTP-over-HTTP traffic is enabled.
    urlCategories List<String>
    List of URL categories subject to the FTP control policy.
    urls List<String>
    List of URLs subject to the FTP control policy.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Import

    This is a singleton resource and import is not supported. The resource is managed by creating it in your Pulumi program.

    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
      Try Pulumi Cloud free. Your team will thank you.