Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Zscaler Internet Access (ZIA)
  3. API Docs
  4. FtpControlPolicy
Zscaler Internet Access v1.1.1 published on Tuesday, Jun 24, 2025 by Zscaler
zscaler/pulumi-zia

zia.FtpControlPolicy

Explore with Pulumi AI

zia logo
Zscaler Internet Access v1.1.1 published on Tuesday, Jun 24, 2025 by Zscaler
zscaler/pulumi-zia

    The zia_ftp_control_policy resource allows you to update FTP control Policy. To learn more see Configuring the FTP Control Policy

    Example Usage

    resource "zia_ftp_control_policy" "this" {
    ftp_enabled = true
    ftp_over_http_enabled = true
    url_categories = ["HOBBIES_AND_LEISURE", "HEALTH","HISTORY","INSURANCE","IMAGE_HOST","INTERNET_SERVICES","GOVERNMENT"]
    urls = ["test1.acme.com", "test10.acme.com"]
}

    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
    Indicates whether to enable native FTP. When enabled, users can connect to native FTP sites and download files.
    FtpOverHttpEnabled bool
    Indicates whether to enable FTP over HTTP.
    UrlCategories List<string>
    List of URL categories for which rule must be applied
    Urls List<string>
    Domains or URLs included for the FTP Control settings
    FtpEnabled bool
    Indicates whether to enable native FTP. When enabled, users can connect to native FTP sites and download files.
    FtpOverHttpEnabled bool
    Indicates whether to enable FTP over HTTP.
    UrlCategories []string
    List of URL categories for which rule must be applied
    Urls []string
    Domains or URLs included for the FTP Control settings
    ftpEnabled Boolean
    Indicates whether to enable native FTP. When enabled, users can connect to native FTP sites and download files.
    ftpOverHttpEnabled Boolean
    Indicates whether to enable FTP over HTTP.
    urlCategories List<String>
    List of URL categories for which rule must be applied
    urls List<String>
    Domains or URLs included for the FTP Control settings
    ftpEnabled boolean
    Indicates whether to enable native FTP. When enabled, users can connect to native FTP sites and download files.
    ftpOverHttpEnabled boolean
    Indicates whether to enable FTP over HTTP.
    urlCategories string[]
    List of URL categories for which rule must be applied
    urls string[]
    Domains or URLs included for the FTP Control settings
    ftp_enabled bool
    Indicates whether to enable native FTP. When enabled, users can connect to native FTP sites and download files.
    ftp_over_http_enabled bool
    Indicates whether to enable FTP over HTTP.
    url_categories Sequence[str]
    List of URL categories for which rule must be applied
    urls Sequence[str]
    Domains or URLs included for the FTP Control settings
    ftpEnabled Boolean
    Indicates whether to enable native FTP. When enabled, users can connect to native FTP sites and download files.
    ftpOverHttpEnabled Boolean
    Indicates whether to enable FTP over HTTP.
    urlCategories List<String>
    List of URL categories for which rule must be applied
    urls List<String>
    Domains or URLs included for the FTP Control settings

    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.

    Look up Existing FtpControlPolicy Resource

    Get an existing FtpControlPolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: FtpControlPolicyState, opts?: CustomResourceOptions): FtpControlPolicy
    @staticmethod
def get(resource_name: str,
        id: 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) -> FtpControlPolicy
    func GetFtpControlPolicy(ctx *Context, name string, id IDInput, state *FtpControlPolicyState, opts ...ResourceOption) (*FtpControlPolicy, error)
    public static FtpControlPolicy Get(string name, Input<string> id, FtpControlPolicyState? state, CustomResourceOptions? opts = null)
    public static FtpControlPolicy get(String name, Output<String> id, FtpControlPolicyState state, CustomResourceOptions options)
    resources:  _:    type: zia:FtpControlPolicy    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    FtpEnabled bool
    Indicates whether to enable native FTP. When enabled, users can connect to native FTP sites and download files.
    FtpOverHttpEnabled bool
    Indicates whether to enable FTP over HTTP.
    UrlCategories List<string>
    List of URL categories for which rule must be applied
    Urls List<string>
    Domains or URLs included for the FTP Control settings
    FtpEnabled bool
    Indicates whether to enable native FTP. When enabled, users can connect to native FTP sites and download files.
    FtpOverHttpEnabled bool
    Indicates whether to enable FTP over HTTP.
    UrlCategories []string
    List of URL categories for which rule must be applied
    Urls []string
    Domains or URLs included for the FTP Control settings
    ftpEnabled Boolean
    Indicates whether to enable native FTP. When enabled, users can connect to native FTP sites and download files.
    ftpOverHttpEnabled Boolean
    Indicates whether to enable FTP over HTTP.
    urlCategories List<String>
    List of URL categories for which rule must be applied
    urls List<String>
    Domains or URLs included for the FTP Control settings
    ftpEnabled boolean
    Indicates whether to enable native FTP. When enabled, users can connect to native FTP sites and download files.
    ftpOverHttpEnabled boolean
    Indicates whether to enable FTP over HTTP.
    urlCategories string[]
    List of URL categories for which rule must be applied
    urls string[]
    Domains or URLs included for the FTP Control settings
    ftp_enabled bool
    Indicates whether to enable native FTP. When enabled, users can connect to native FTP sites and download files.
    ftp_over_http_enabled bool
    Indicates whether to enable FTP over HTTP.
    url_categories Sequence[str]
    List of URL categories for which rule must be applied
    urls Sequence[str]
    Domains or URLs included for the FTP Control settings
    ftpEnabled Boolean
    Indicates whether to enable native FTP. When enabled, users can connect to native FTP sites and download files.
    ftpOverHttpEnabled Boolean
    Indicates whether to enable FTP over HTTP.
    urlCategories List<String>
    List of URL categories for which rule must be applied
    urls List<String>
    Domains or URLs included for the FTP Control settings

    Import

    Zscaler offers a dedicated tool called Zscaler-Terraformer to allow the automated import of ZIA configurations into Terraform-compliant HashiCorp Configuration Language.

    Visit

    zia_ftp_control_policy can be imported by using ftp_control as the import ID.

    For example:

    $ pulumi import zia:index/ftpControlPolicy:FtpControlPolicy this "ftp_control"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    zia zscaler/pulumi-zia
    License
    MIT
    Notes
    This Pulumi package is based on the zia Terraform Provider.
    zia logo
    Zscaler Internet Access v1.1.1 published on Tuesday, Jun 24, 2025 by Zscaler
    zscaler/pulumi-zia