Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. getFilters
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-cloudflare

cloudflare.getFilters

Explore with Pulumi AI

cloudflare logo
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-cloudflare

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";

const exampleFilters = cloudflare.getFilters({
    zoneId: "023e105f4ecef8ad9ca31a8372d0c353",
    id: "372e67954025e0ba6aaa6d586b9e0b61",
    description: "browsers",
    expression: "php",
    paused: false,
    ref: "FIL-100",
});

    import pulumi
import pulumi_cloudflare as cloudflare

example_filters = cloudflare.get_filters(zone_id="023e105f4ecef8ad9ca31a8372d0c353",
    id="372e67954025e0ba6aaa6d586b9e0b61",
    description="browsers",
    expression="php",
    paused=False,
    ref="FIL-100")

    package main

import (
	"github.com/pulumi/pulumi-cloudflare/sdk/v6/go/cloudflare"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudflare.LookupFilters(ctx, &cloudflare.LookupFiltersArgs{
			ZoneId:      "023e105f4ecef8ad9ca31a8372d0c353",
			Id:          pulumi.StringRef("372e67954025e0ba6aaa6d586b9e0b61"),
			Description: pulumi.StringRef("browsers"),
			Expression:  pulumi.StringRef("php"),
			Paused:      pulumi.BoolRef(false),
			Ref:         pulumi.StringRef("FIL-100"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;

return await Deployment.RunAsync(() => 
{
    var exampleFilters = Cloudflare.GetFilters.Invoke(new()
    {
        ZoneId = "023e105f4ecef8ad9ca31a8372d0c353",
        Id = "372e67954025e0ba6aaa6d586b9e0b61",
        Description = "browsers",
        Expression = "php",
        Paused = false,
        Ref = "FIL-100",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.CloudflareFunctions;
import com.pulumi.cloudflare.inputs.GetFiltersArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var exampleFilters = CloudflareFunctions.getFilters(GetFiltersArgs.builder()
            .zoneId("023e105f4ecef8ad9ca31a8372d0c353")
            .id("372e67954025e0ba6aaa6d586b9e0b61")
            .description("browsers")
            .expression("php")
            .paused(false)
            .ref("FIL-100")
            .build());

    }
}

    variables:
  exampleFilters:
    fn::invoke:
      function: cloudflare:getFilters
      arguments:
        zoneId: 023e105f4ecef8ad9ca31a8372d0c353
        id: 372e67954025e0ba6aaa6d586b9e0b61
        description: browsers
        expression: php
        paused: false
        ref: FIL-100

    Using getFilters

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getFilters(args: GetFiltersArgs, opts?: InvokeOptions): Promise<GetFiltersResult>
function getFiltersOutput(args: GetFiltersOutputArgs, opts?: InvokeOptions): Output<GetFiltersResult>
    def get_filters(description: Optional[str] = None,
                expression: Optional[str] = None,
                id: Optional[str] = None,
                max_items: Optional[int] = None,
                paused: Optional[bool] = None,
                ref: Optional[str] = None,
                zone_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetFiltersResult
def get_filters_output(description: Optional[pulumi.Input[str]] = None,
                expression: Optional[pulumi.Input[str]] = None,
                id: Optional[pulumi.Input[str]] = None,
                max_items: Optional[pulumi.Input[int]] = None,
                paused: Optional[pulumi.Input[bool]] = None,
                ref: Optional[pulumi.Input[str]] = None,
                zone_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetFiltersResult]
    func LookupFilters(ctx *Context, args *LookupFiltersArgs, opts ...InvokeOption) (*LookupFiltersResult, error)
func LookupFiltersOutput(ctx *Context, args *LookupFiltersOutputArgs, opts ...InvokeOption) LookupFiltersResultOutput

    > Note: This function is named LookupFilters in the Go SDK.

    public static class GetFilters 
{
    public static Task<GetFiltersResult> InvokeAsync(GetFiltersArgs args, InvokeOptions? opts = null)
    public static Output<GetFiltersResult> Invoke(GetFiltersInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetFiltersResult> getFilters(GetFiltersArgs args, InvokeOptions options)
public static Output<GetFiltersResult> getFilters(GetFiltersArgs args, InvokeOptions options)

    fn::invoke:
  function: cloudflare:index/getFilters:getFilters
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ZoneId string
    Identifier
    Description string
    A case-insensitive string to find in the description.
    Expression string
    A case-insensitive string to find in the expression.
    Id string
    The unique identifier of the filter.
    MaxItems int
    Max items to fetch, default: 1000
    Paused bool
    When true, indicates that the filter is currently paused.
    Ref string
    The filter ref (a short reference tag) to search for. Must be an exact match.
    ZoneId string
    Identifier
    Description string
    A case-insensitive string to find in the description.
    Expression string
    A case-insensitive string to find in the expression.
    Id string
    The unique identifier of the filter.
    MaxItems int
    Max items to fetch, default: 1000
    Paused bool
    When true, indicates that the filter is currently paused.
    Ref string
    The filter ref (a short reference tag) to search for. Must be an exact match.
    zoneId String
    Identifier
    description String
    A case-insensitive string to find in the description.
    expression String
    A case-insensitive string to find in the expression.
    id String
    The unique identifier of the filter.
    maxItems Integer
    Max items to fetch, default: 1000
    paused Boolean
    When true, indicates that the filter is currently paused.
    ref String
    The filter ref (a short reference tag) to search for. Must be an exact match.
    zoneId string
    Identifier
    description string
    A case-insensitive string to find in the description.
    expression string
    A case-insensitive string to find in the expression.
    id string
    The unique identifier of the filter.
    maxItems number
    Max items to fetch, default: 1000
    paused boolean
    When true, indicates that the filter is currently paused.
    ref string
    The filter ref (a short reference tag) to search for. Must be an exact match.
    zone_id str
    Identifier
    description str
    A case-insensitive string to find in the description.
    expression str
    A case-insensitive string to find in the expression.
    id str
    The unique identifier of the filter.
    max_items int
    Max items to fetch, default: 1000
    paused bool
    When true, indicates that the filter is currently paused.
    ref str
    The filter ref (a short reference tag) to search for. Must be an exact match.
    zoneId String
    Identifier
    description String
    A case-insensitive string to find in the description.
    expression String
    A case-insensitive string to find in the expression.
    id String
    The unique identifier of the filter.
    maxItems Number
    Max items to fetch, default: 1000
    paused Boolean
    When true, indicates that the filter is currently paused.
    ref String
    The filter ref (a short reference tag) to search for. Must be an exact match.

    getFilters Result

    The following output properties are available:

    Results List<GetFiltersResult>
    The items returned by the data source
    ZoneId string
    Identifier
    Description string
    A case-insensitive string to find in the description.
    Expression string
    A case-insensitive string to find in the expression.
    Id string
    The unique identifier of the filter.
    MaxItems int
    Max items to fetch, default: 1000
    Paused bool
    When true, indicates that the filter is currently paused.
    Ref string
    The filter ref (a short reference tag) to search for. Must be an exact match.
    Results []GetFiltersResult
    The items returned by the data source
    ZoneId string
    Identifier
    Description string
    A case-insensitive string to find in the description.
    Expression string
    A case-insensitive string to find in the expression.
    Id string
    The unique identifier of the filter.
    MaxItems int
    Max items to fetch, default: 1000
    Paused bool
    When true, indicates that the filter is currently paused.
    Ref string
    The filter ref (a short reference tag) to search for. Must be an exact match.
    results List<GetFiltersResult>
    The items returned by the data source
    zoneId String
    Identifier
    description String
    A case-insensitive string to find in the description.
    expression String
    A case-insensitive string to find in the expression.
    id String
    The unique identifier of the filter.
    maxItems Integer
    Max items to fetch, default: 1000
    paused Boolean
    When true, indicates that the filter is currently paused.
    ref String
    The filter ref (a short reference tag) to search for. Must be an exact match.
    results GetFiltersResult[]
    The items returned by the data source
    zoneId string
    Identifier
    description string
    A case-insensitive string to find in the description.
    expression string
    A case-insensitive string to find in the expression.
    id string
    The unique identifier of the filter.
    maxItems number
    Max items to fetch, default: 1000
    paused boolean
    When true, indicates that the filter is currently paused.
    ref string
    The filter ref (a short reference tag) to search for. Must be an exact match.
    results Sequence[GetFiltersResult]
    The items returned by the data source
    zone_id str
    Identifier
    description str
    A case-insensitive string to find in the description.
    expression str
    A case-insensitive string to find in the expression.
    id str
    The unique identifier of the filter.
    max_items int
    Max items to fetch, default: 1000
    paused bool
    When true, indicates that the filter is currently paused.
    ref str
    The filter ref (a short reference tag) to search for. Must be an exact match.
    results List<Property Map>
    The items returned by the data source
    zoneId String
    Identifier
    description String
    A case-insensitive string to find in the description.
    expression String
    A case-insensitive string to find in the expression.
    id String
    The unique identifier of the filter.
    maxItems Number
    Max items to fetch, default: 1000
    paused Boolean
    When true, indicates that the filter is currently paused.
    ref String
    The filter ref (a short reference tag) to search for. Must be an exact match.

    Supporting Types

    GetFiltersResult

    Description string
    An informative summary of the filter.
    Expression string
    The filter expression. For more information, refer to Expressions.
    Id string
    The unique identifier of the filter.
    Paused bool
    When true, indicates that the filter is currently paused.
    Ref string
    A short reference tag. Allows you to select related filters.
    Description string
    An informative summary of the filter.
    Expression string
    The filter expression. For more information, refer to Expressions.
    Id string
    The unique identifier of the filter.
    Paused bool
    When true, indicates that the filter is currently paused.
    Ref string
    A short reference tag. Allows you to select related filters.
    description String
    An informative summary of the filter.
    expression String
    The filter expression. For more information, refer to Expressions.
    id String
    The unique identifier of the filter.
    paused Boolean
    When true, indicates that the filter is currently paused.
    ref String
    A short reference tag. Allows you to select related filters.
    description string
    An informative summary of the filter.
    expression string
    The filter expression. For more information, refer to Expressions.
    id string
    The unique identifier of the filter.
    paused boolean
    When true, indicates that the filter is currently paused.
    ref string
    A short reference tag. Allows you to select related filters.
    description str
    An informative summary of the filter.
    expression str
    The filter expression. For more information, refer to Expressions.
    id str
    The unique identifier of the filter.
    paused bool
    When true, indicates that the filter is currently paused.
    ref str
    A short reference tag. Allows you to select related filters.
    description String
    An informative summary of the filter.
    expression String
    The filter expression. For more information, refer to Expressions.
    id String
    The unique identifier of the filter.
    paused Boolean
    When true, indicates that the filter is currently paused.
    ref String
    A short reference tag. Allows you to select related filters.

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo
    Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-cloudflare