1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. FirewallRule
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

cloudflare.FirewallRule

Explore with Pulumi AI

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

    cloudflare.FirewallRule is in a deprecation phase until June 15th, 2025. During this time period, this resource is still fully supported but you are strongly advised to move to the cloudflare.Ruleset resource. Full details can be found in the developer documentation.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudflare from "@pulumi/cloudflare";
    
    const exampleFirewallRule = new cloudflare.FirewallRule("example_firewall_rule", {
        zoneId: "023e105f4ecef8ad9ca31a8372d0c353",
        action: {
            mode: "challenge",
            response: {
                body: "<error>This request has been rate-limited.</error>",
                contentType: "text/xml",
            },
            timeout: 86400,
        },
        filter: {
            description: "Restrict access from these browsers on this address range.",
            expression: "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
            paused: false,
            ref: "FIL-100",
        },
    });
    
    import pulumi
    import pulumi_cloudflare as cloudflare
    
    example_firewall_rule = cloudflare.FirewallRule("example_firewall_rule",
        zone_id="023e105f4ecef8ad9ca31a8372d0c353",
        action={
            "mode": "challenge",
            "response": {
                "body": "<error>This request has been rate-limited.</error>",
                "content_type": "text/xml",
            },
            "timeout": 86400,
        },
        filter={
            "description": "Restrict access from these browsers on this address range.",
            "expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
            "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.NewFirewallRule(ctx, "example_firewall_rule", &cloudflare.FirewallRuleArgs{
    			ZoneId: pulumi.String("023e105f4ecef8ad9ca31a8372d0c353"),
    			Action: &cloudflare.FirewallRuleActionArgs{
    				Mode: pulumi.String("challenge"),
    				Response: &cloudflare.FirewallRuleActionResponseArgs{
    					Body:        pulumi.String("<error>This request has been rate-limited.</error>"),
    					ContentType: pulumi.String("text/xml"),
    				},
    				Timeout: pulumi.Float64(86400),
    			},
    			Filter: &cloudflare.FirewallRuleFilterArgs{
    				Description: pulumi.String("Restrict access from these browsers on this address range."),
    				Expression:  pulumi.String("(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155"),
    				Paused:      pulumi.Bool(false),
    				Ref:         pulumi.String("FIL-100"),
    			},
    		})
    		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 exampleFirewallRule = new Cloudflare.FirewallRule("example_firewall_rule", new()
        {
            ZoneId = "023e105f4ecef8ad9ca31a8372d0c353",
            Action = new Cloudflare.Inputs.FirewallRuleActionArgs
            {
                Mode = "challenge",
                Response = new Cloudflare.Inputs.FirewallRuleActionResponseArgs
                {
                    Body = "<error>This request has been rate-limited.</error>",
                    ContentType = "text/xml",
                },
                Timeout = 86400,
            },
            Filter = new Cloudflare.Inputs.FirewallRuleFilterArgs
            {
                Description = "Restrict access from these browsers on this address range.",
                Expression = "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
                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.FirewallRule;
    import com.pulumi.cloudflare.FirewallRuleArgs;
    import com.pulumi.cloudflare.inputs.FirewallRuleActionArgs;
    import com.pulumi.cloudflare.inputs.FirewallRuleActionResponseArgs;
    import com.pulumi.cloudflare.inputs.FirewallRuleFilterArgs;
    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) {
            var exampleFirewallRule = new FirewallRule("exampleFirewallRule", FirewallRuleArgs.builder()
                .zoneId("023e105f4ecef8ad9ca31a8372d0c353")
                .action(FirewallRuleActionArgs.builder()
                    .mode("challenge")
                    .response(FirewallRuleActionResponseArgs.builder()
                        .body("<error>This request has been rate-limited.</error>")
                        .contentType("text/xml")
                        .build())
                    .timeout(86400.0)
                    .build())
                .filter(FirewallRuleFilterArgs.builder()
                    .description("Restrict access from these browsers on this address range.")
                    .expression("(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155")
                    .paused(false)
                    .ref("FIL-100")
                    .build())
                .build());
    
        }
    }
    
    resources:
      exampleFirewallRule:
        type: cloudflare:FirewallRule
        name: example_firewall_rule
        properties:
          zoneId: 023e105f4ecef8ad9ca31a8372d0c353
          action:
            mode: challenge
            response:
              body: <error>This request has been rate-limited.</error>
              contentType: text/xml
            timeout: 86400
          filter:
            description: Restrict access from these browsers on this address range.
            expression: (http.request.uri.path ~ ".*wp-login.php" or http.request.uri.path ~ ".*xmlrpc.php") and ip.addr ne 172.16.22.155
            paused: false
            ref: FIL-100
    

    Create FirewallRule Resource

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

    Constructor syntax

    new FirewallRule(name: string, args: FirewallRuleArgs, opts?: CustomResourceOptions);
    @overload
    def FirewallRule(resource_name: str,
                     args: FirewallRuleArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def FirewallRule(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     action: Optional[FirewallRuleActionArgs] = None,
                     filter: Optional[FirewallRuleFilterArgs] = None,
                     zone_id: Optional[str] = None)
    func NewFirewallRule(ctx *Context, name string, args FirewallRuleArgs, opts ...ResourceOption) (*FirewallRule, error)
    public FirewallRule(string name, FirewallRuleArgs args, CustomResourceOptions? opts = null)
    public FirewallRule(String name, FirewallRuleArgs args)
    public FirewallRule(String name, FirewallRuleArgs args, CustomResourceOptions options)
    
    type: cloudflare:FirewallRule
    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 FirewallRuleArgs
    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 FirewallRuleArgs
    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 FirewallRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FirewallRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FirewallRuleArgs
    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 firewallRuleResource = new Cloudflare.FirewallRule("firewallRuleResource", new()
    {
        Action = new Cloudflare.Inputs.FirewallRuleActionArgs
        {
            Mode = "string",
            Response = new Cloudflare.Inputs.FirewallRuleActionResponseArgs
            {
                Body = "string",
                ContentType = "string",
            },
            Timeout = 0,
        },
        Filter = new Cloudflare.Inputs.FirewallRuleFilterArgs
        {
            Description = "string",
            Expression = "string",
            Id = "string",
            Paused = false,
            Ref = "string",
        },
        ZoneId = "string",
    });
    
    example, err := cloudflare.NewFirewallRule(ctx, "firewallRuleResource", &cloudflare.FirewallRuleArgs{
    	Action: &cloudflare.FirewallRuleActionArgs{
    		Mode: pulumi.String("string"),
    		Response: &cloudflare.FirewallRuleActionResponseArgs{
    			Body:        pulumi.String("string"),
    			ContentType: pulumi.String("string"),
    		},
    		Timeout: pulumi.Float64(0),
    	},
    	Filter: &cloudflare.FirewallRuleFilterArgs{
    		Description: pulumi.String("string"),
    		Expression:  pulumi.String("string"),
    		Id:          pulumi.String("string"),
    		Paused:      pulumi.Bool(false),
    		Ref:         pulumi.String("string"),
    	},
    	ZoneId: pulumi.String("string"),
    })
    
    var firewallRuleResource = new FirewallRule("firewallRuleResource", FirewallRuleArgs.builder()
        .action(FirewallRuleActionArgs.builder()
            .mode("string")
            .response(FirewallRuleActionResponseArgs.builder()
                .body("string")
                .contentType("string")
                .build())
            .timeout(0)
            .build())
        .filter(FirewallRuleFilterArgs.builder()
            .description("string")
            .expression("string")
            .id("string")
            .paused(false)
            .ref("string")
            .build())
        .zoneId("string")
        .build());
    
    firewall_rule_resource = cloudflare.FirewallRule("firewallRuleResource",
        action={
            "mode": "string",
            "response": {
                "body": "string",
                "content_type": "string",
            },
            "timeout": 0,
        },
        filter={
            "description": "string",
            "expression": "string",
            "id": "string",
            "paused": False,
            "ref": "string",
        },
        zone_id="string")
    
    const firewallRuleResource = new cloudflare.FirewallRule("firewallRuleResource", {
        action: {
            mode: "string",
            response: {
                body: "string",
                contentType: "string",
            },
            timeout: 0,
        },
        filter: {
            description: "string",
            expression: "string",
            id: "string",
            paused: false,
            ref: "string",
        },
        zoneId: "string",
    });
    
    type: cloudflare:FirewallRule
    properties:
        action:
            mode: string
            response:
                body: string
                contentType: string
            timeout: 0
        filter:
            description: string
            expression: string
            id: string
            paused: false
            ref: string
        zoneId: string
    

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

    Action FirewallRuleAction
    The action to perform when the threshold of matched traffic within the configured period is exceeded.
    Filter FirewallRuleFilter
    ZoneId string
    Identifier
    Action FirewallRuleActionArgs
    The action to perform when the threshold of matched traffic within the configured period is exceeded.
    Filter FirewallRuleFilterArgs
    ZoneId string
    Identifier
    action FirewallRuleAction
    The action to perform when the threshold of matched traffic within the configured period is exceeded.
    filter FirewallRuleFilter
    zoneId String
    Identifier
    action FirewallRuleAction
    The action to perform when the threshold of matched traffic within the configured period is exceeded.
    filter FirewallRuleFilter
    zoneId string
    Identifier
    action FirewallRuleActionArgs
    The action to perform when the threshold of matched traffic within the configured period is exceeded.
    filter FirewallRuleFilterArgs
    zone_id str
    Identifier
    action Property Map
    The action to perform when the threshold of matched traffic within the configured period is exceeded.
    filter Property Map
    zoneId String
    Identifier

    Outputs

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

    Description string
    An informative summary of the firewall rule.
    Id string
    The provider-assigned unique ID for this managed resource.
    Paused bool
    When true, indicates that the firewall rule is currently paused.
    Priority double
    The priority of the rule. Optional value used to define the processing order. A lower number indicates a higher priority. If not provided, rules with a defined priority will be processed before rules without a priority.
    Products List<string>
    Ref string
    A short reference tag. Allows you to select related firewall rules.
    Description string
    An informative summary of the firewall rule.
    Id string
    The provider-assigned unique ID for this managed resource.
    Paused bool
    When true, indicates that the firewall rule is currently paused.
    Priority float64
    The priority of the rule. Optional value used to define the processing order. A lower number indicates a higher priority. If not provided, rules with a defined priority will be processed before rules without a priority.
    Products []string
    Ref string
    A short reference tag. Allows you to select related firewall rules.
    description String
    An informative summary of the firewall rule.
    id String
    The provider-assigned unique ID for this managed resource.
    paused Boolean
    When true, indicates that the firewall rule is currently paused.
    priority Double
    The priority of the rule. Optional value used to define the processing order. A lower number indicates a higher priority. If not provided, rules with a defined priority will be processed before rules without a priority.
    products List<String>
    ref String
    A short reference tag. Allows you to select related firewall rules.
    description string
    An informative summary of the firewall rule.
    id string
    The provider-assigned unique ID for this managed resource.
    paused boolean
    When true, indicates that the firewall rule is currently paused.
    priority number
    The priority of the rule. Optional value used to define the processing order. A lower number indicates a higher priority. If not provided, rules with a defined priority will be processed before rules without a priority.
    products string[]
    ref string
    A short reference tag. Allows you to select related firewall rules.
    description str
    An informative summary of the firewall rule.
    id str
    The provider-assigned unique ID for this managed resource.
    paused bool
    When true, indicates that the firewall rule is currently paused.
    priority float
    The priority of the rule. Optional value used to define the processing order. A lower number indicates a higher priority. If not provided, rules with a defined priority will be processed before rules without a priority.
    products Sequence[str]
    ref str
    A short reference tag. Allows you to select related firewall rules.
    description String
    An informative summary of the firewall rule.
    id String
    The provider-assigned unique ID for this managed resource.
    paused Boolean
    When true, indicates that the firewall rule is currently paused.
    priority Number
    The priority of the rule. Optional value used to define the processing order. A lower number indicates a higher priority. If not provided, rules with a defined priority will be processed before rules without a priority.
    products List<String>
    ref String
    A short reference tag. Allows you to select related firewall rules.

    Look up Existing FirewallRule Resource

    Get an existing FirewallRule 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?: FirewallRuleState, opts?: CustomResourceOptions): FirewallRule
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            action: Optional[FirewallRuleActionArgs] = None,
            description: Optional[str] = None,
            filter: Optional[FirewallRuleFilterArgs] = None,
            paused: Optional[bool] = None,
            priority: Optional[float] = None,
            products: Optional[Sequence[str]] = None,
            ref: Optional[str] = None,
            zone_id: Optional[str] = None) -> FirewallRule
    func GetFirewallRule(ctx *Context, name string, id IDInput, state *FirewallRuleState, opts ...ResourceOption) (*FirewallRule, error)
    public static FirewallRule Get(string name, Input<string> id, FirewallRuleState? state, CustomResourceOptions? opts = null)
    public static FirewallRule get(String name, Output<String> id, FirewallRuleState state, CustomResourceOptions options)
    resources:  _:    type: cloudflare:FirewallRule    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:
    Action FirewallRuleAction
    The action to perform when the threshold of matched traffic within the configured period is exceeded.
    Description string
    An informative summary of the firewall rule.
    Filter FirewallRuleFilter
    Paused bool
    When true, indicates that the firewall rule is currently paused.
    Priority double
    The priority of the rule. Optional value used to define the processing order. A lower number indicates a higher priority. If not provided, rules with a defined priority will be processed before rules without a priority.
    Products List<string>
    Ref string
    A short reference tag. Allows you to select related firewall rules.
    ZoneId string
    Identifier
    Action FirewallRuleActionArgs
    The action to perform when the threshold of matched traffic within the configured period is exceeded.
    Description string
    An informative summary of the firewall rule.
    Filter FirewallRuleFilterArgs
    Paused bool
    When true, indicates that the firewall rule is currently paused.
    Priority float64
    The priority of the rule. Optional value used to define the processing order. A lower number indicates a higher priority. If not provided, rules with a defined priority will be processed before rules without a priority.
    Products []string
    Ref string
    A short reference tag. Allows you to select related firewall rules.
    ZoneId string
    Identifier
    action FirewallRuleAction
    The action to perform when the threshold of matched traffic within the configured period is exceeded.
    description String
    An informative summary of the firewall rule.
    filter FirewallRuleFilter
    paused Boolean
    When true, indicates that the firewall rule is currently paused.
    priority Double
    The priority of the rule. Optional value used to define the processing order. A lower number indicates a higher priority. If not provided, rules with a defined priority will be processed before rules without a priority.
    products List<String>
    ref String
    A short reference tag. Allows you to select related firewall rules.
    zoneId String
    Identifier
    action FirewallRuleAction
    The action to perform when the threshold of matched traffic within the configured period is exceeded.
    description string
    An informative summary of the firewall rule.
    filter FirewallRuleFilter
    paused boolean
    When true, indicates that the firewall rule is currently paused.
    priority number
    The priority of the rule. Optional value used to define the processing order. A lower number indicates a higher priority. If not provided, rules with a defined priority will be processed before rules without a priority.
    products string[]
    ref string
    A short reference tag. Allows you to select related firewall rules.
    zoneId string
    Identifier
    action FirewallRuleActionArgs
    The action to perform when the threshold of matched traffic within the configured period is exceeded.
    description str
    An informative summary of the firewall rule.
    filter FirewallRuleFilterArgs
    paused bool
    When true, indicates that the firewall rule is currently paused.
    priority float
    The priority of the rule. Optional value used to define the processing order. A lower number indicates a higher priority. If not provided, rules with a defined priority will be processed before rules without a priority.
    products Sequence[str]
    ref str
    A short reference tag. Allows you to select related firewall rules.
    zone_id str
    Identifier
    action Property Map
    The action to perform when the threshold of matched traffic within the configured period is exceeded.
    description String
    An informative summary of the firewall rule.
    filter Property Map
    paused Boolean
    When true, indicates that the firewall rule is currently paused.
    priority Number
    The priority of the rule. Optional value used to define the processing order. A lower number indicates a higher priority. If not provided, rules with a defined priority will be processed before rules without a priority.
    products List<String>
    ref String
    A short reference tag. Allows you to select related firewall rules.
    zoneId String
    Identifier

    Supporting Types

    FirewallRuleAction, FirewallRuleActionArgs

    Mode string
    The action to perform. Available values: "simulate", "ban", "challenge", "jschallenge", "managedchallenge".
    Response FirewallRuleActionResponse
    A custom content type and reponse to return when the threshold is exceeded. The custom response configured in this object will override the custom error for the zone. This object is optional. Notes: If you omit this object, Cloudflare will use the default HTML error page. If "mode" is "challenge", "managedchallenge", or "jschallenge", Cloudflare will use the zone challenge pages and you should not provide the "response" object.
    Timeout double
    The time in seconds during which Cloudflare will perform the mitigation action. Must be an integer value greater than or equal to the period. Notes: If "mode" is "challenge", "managedchallenge", or "jschallenge", Cloudflare will use the zone's Challenge Passage time and you should not provide this value.
    Mode string
    The action to perform. Available values: "simulate", "ban", "challenge", "jschallenge", "managedchallenge".
    Response FirewallRuleActionResponse
    A custom content type and reponse to return when the threshold is exceeded. The custom response configured in this object will override the custom error for the zone. This object is optional. Notes: If you omit this object, Cloudflare will use the default HTML error page. If "mode" is "challenge", "managedchallenge", or "jschallenge", Cloudflare will use the zone challenge pages and you should not provide the "response" object.
    Timeout float64
    The time in seconds during which Cloudflare will perform the mitigation action. Must be an integer value greater than or equal to the period. Notes: If "mode" is "challenge", "managedchallenge", or "jschallenge", Cloudflare will use the zone's Challenge Passage time and you should not provide this value.
    mode String
    The action to perform. Available values: "simulate", "ban", "challenge", "jschallenge", "managedchallenge".
    response FirewallRuleActionResponse
    A custom content type and reponse to return when the threshold is exceeded. The custom response configured in this object will override the custom error for the zone. This object is optional. Notes: If you omit this object, Cloudflare will use the default HTML error page. If "mode" is "challenge", "managedchallenge", or "jschallenge", Cloudflare will use the zone challenge pages and you should not provide the "response" object.
    timeout Double
    The time in seconds during which Cloudflare will perform the mitigation action. Must be an integer value greater than or equal to the period. Notes: If "mode" is "challenge", "managedchallenge", or "jschallenge", Cloudflare will use the zone's Challenge Passage time and you should not provide this value.
    mode string
    The action to perform. Available values: "simulate", "ban", "challenge", "jschallenge", "managedchallenge".
    response FirewallRuleActionResponse
    A custom content type and reponse to return when the threshold is exceeded. The custom response configured in this object will override the custom error for the zone. This object is optional. Notes: If you omit this object, Cloudflare will use the default HTML error page. If "mode" is "challenge", "managedchallenge", or "jschallenge", Cloudflare will use the zone challenge pages and you should not provide the "response" object.
    timeout number
    The time in seconds during which Cloudflare will perform the mitigation action. Must be an integer value greater than or equal to the period. Notes: If "mode" is "challenge", "managedchallenge", or "jschallenge", Cloudflare will use the zone's Challenge Passage time and you should not provide this value.
    mode str
    The action to perform. Available values: "simulate", "ban", "challenge", "jschallenge", "managedchallenge".
    response FirewallRuleActionResponse
    A custom content type and reponse to return when the threshold is exceeded. The custom response configured in this object will override the custom error for the zone. This object is optional. Notes: If you omit this object, Cloudflare will use the default HTML error page. If "mode" is "challenge", "managedchallenge", or "jschallenge", Cloudflare will use the zone challenge pages and you should not provide the "response" object.
    timeout float
    The time in seconds during which Cloudflare will perform the mitigation action. Must be an integer value greater than or equal to the period. Notes: If "mode" is "challenge", "managedchallenge", or "jschallenge", Cloudflare will use the zone's Challenge Passage time and you should not provide this value.
    mode String
    The action to perform. Available values: "simulate", "ban", "challenge", "jschallenge", "managedchallenge".
    response Property Map
    A custom content type and reponse to return when the threshold is exceeded. The custom response configured in this object will override the custom error for the zone. This object is optional. Notes: If you omit this object, Cloudflare will use the default HTML error page. If "mode" is "challenge", "managedchallenge", or "jschallenge", Cloudflare will use the zone challenge pages and you should not provide the "response" object.
    timeout Number
    The time in seconds during which Cloudflare will perform the mitigation action. Must be an integer value greater than or equal to the period. Notes: If "mode" is "challenge", "managedchallenge", or "jschallenge", Cloudflare will use the zone's Challenge Passage time and you should not provide this value.

    FirewallRuleActionResponse, FirewallRuleActionResponseArgs

    Body string
    The response body to return. The value must conform to the configured content type.
    ContentType string
    The content type of the body. Must be one of the following: text/plain, text/xml, or application/json.
    Body string
    The response body to return. The value must conform to the configured content type.
    ContentType string
    The content type of the body. Must be one of the following: text/plain, text/xml, or application/json.
    body String
    The response body to return. The value must conform to the configured content type.
    contentType String
    The content type of the body. Must be one of the following: text/plain, text/xml, or application/json.
    body string
    The response body to return. The value must conform to the configured content type.
    contentType string
    The content type of the body. Must be one of the following: text/plain, text/xml, or application/json.
    body str
    The response body to return. The value must conform to the configured content type.
    content_type str
    The content type of the body. Must be one of the following: text/plain, text/xml, or application/json.
    body String
    The response body to return. The value must conform to the configured content type.
    contentType String
    The content type of the body. Must be one of the following: text/plain, text/xml, or application/json.

    FirewallRuleFilter, FirewallRuleFilterArgs

    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.

    Import

    $ pulumi import cloudflare:index/firewallRule:FirewallRule example '<zone_id>/<rule_id>'
    

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

    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