Docs Home
Cloudflare v6.9.0 published on Saturday, Sep 13, 2025 by Pulumi
cloudflare.Ruleset
Explore with Pulumi AI
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";
const exampleRuleset = new cloudflare.Ruleset("example_ruleset", {
zoneId: "9f1839b6152d298aca64c4e906b6d074",
name: "My ruleset",
phase: "http_request_firewall_custom",
kind: "root",
description: "A description for my ruleset.",
rules: [{
description: "Block the request.",
expression: "ip.src ne 1.1.1.1",
action: "block",
ref: "my_rule",
}],
});
import pulumi
import pulumi_cloudflare as cloudflare
example_ruleset = cloudflare.Ruleset("example_ruleset",
zone_id="9f1839b6152d298aca64c4e906b6d074",
name="My ruleset",
phase="http_request_firewall_custom",
kind="root",
description="A description for my ruleset.",
rules=[{
"description": "Block the request.",
"expression": "ip.src ne 1.1.1.1",
"action": "block",
"ref": "my_rule",
}])
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.NewRuleset(ctx, "example_ruleset", &cloudflare.RulesetArgs{
ZoneId: pulumi.String("9f1839b6152d298aca64c4e906b6d074"),
Name: pulumi.String("My ruleset"),
Phase: pulumi.String("http_request_firewall_custom"),
Kind: pulumi.String("root"),
Description: pulumi.String("A description for my ruleset."),
Rules: cloudflare.RulesetRuleArray{
&cloudflare.RulesetRuleArgs{
Description: pulumi.String("Block the request."),
Expression: pulumi.String("ip.src ne 1.1.1.1"),
Action: pulumi.String("block"),
Ref: pulumi.String("my_rule"),
},
},
})
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 exampleRuleset = new Cloudflare.Ruleset("example_ruleset", new()
{
ZoneId = "9f1839b6152d298aca64c4e906b6d074",
Name = "My ruleset",
Phase = "http_request_firewall_custom",
Kind = "root",
Description = "A description for my ruleset.",
Rules = new[]
{
new Cloudflare.Inputs.RulesetRuleArgs
{
Description = "Block the request.",
Expression = "ip.src ne 1.1.1.1",
Action = "block",
Ref = "my_rule",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.Ruleset;
import com.pulumi.cloudflare.RulesetArgs;
import com.pulumi.cloudflare.inputs.RulesetRuleArgs;
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 exampleRuleset = new Ruleset("exampleRuleset", RulesetArgs.builder()
.zoneId("9f1839b6152d298aca64c4e906b6d074")
.name("My ruleset")
.phase("http_request_firewall_custom")
.kind("root")
.description("A description for my ruleset.")
.rules(RulesetRuleArgs.builder()
.description("Block the request.")
.expression("ip.src ne 1.1.1.1")
.action("block")
.ref("my_rule")
.build())
.build());
}
}
resources:
exampleRuleset:
type: cloudflare:Ruleset
name: example_ruleset
properties:
zoneId: 9f1839b6152d298aca64c4e906b6d074
name: My ruleset
phase: http_request_firewall_custom
kind: root
description: A description for my ruleset.
rules:
- description: Block the request.
expression: ip.src ne 1.1.1.1
action: block
ref: my_rule
Create Ruleset Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Ruleset(name: string, args: RulesetArgs, opts?: CustomResourceOptions);@overload
def Ruleset(resource_name: str,
args: RulesetArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Ruleset(resource_name: str,
opts: Optional[ResourceOptions] = None,
kind: Optional[str] = None,
name: Optional[str] = None,
phase: Optional[str] = None,
account_id: Optional[str] = None,
description: Optional[str] = None,
rules: Optional[Sequence[RulesetRuleArgs]] = None,
zone_id: Optional[str] = None)func NewRuleset(ctx *Context, name string, args RulesetArgs, opts ...ResourceOption) (*Ruleset, error)public Ruleset(string name, RulesetArgs args, CustomResourceOptions? opts = null)
public Ruleset(String name, RulesetArgs args)
public Ruleset(String name, RulesetArgs args, CustomResourceOptions options)
type: cloudflare:Ruleset
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 RulesetArgs
- 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 RulesetArgs
- 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 RulesetArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RulesetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args RulesetArgs
- 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 rulesetResource = new Cloudflare.Ruleset("rulesetResource", new()
{
Kind = "string",
Name = "string",
Phase = "string",
AccountId = "string",
Description = "string",
Rules = new[]
{
new Cloudflare.Inputs.RulesetRuleArgs
{
Action = "string",
Expression = "string",
ActionParameters = new Cloudflare.Inputs.RulesetRuleActionParametersArgs
{
AdditionalCacheablePorts = new[]
{
0,
},
Algorithms = new[]
{
new Cloudflare.Inputs.RulesetRuleActionParametersAlgorithmArgs
{
Name = "string",
},
},
AssetName = "string",
AutomaticHttpsRewrites = false,
Autominify = new Cloudflare.Inputs.RulesetRuleActionParametersAutominifyArgs
{
Css = false,
Html = false,
Js = false,
},
Bic = false,
BrowserTtl = new Cloudflare.Inputs.RulesetRuleActionParametersBrowserTtlArgs
{
Mode = "string",
Default = 0,
},
Cache = false,
CacheKey = new Cloudflare.Inputs.RulesetRuleActionParametersCacheKeyArgs
{
CacheByDeviceType = false,
CacheDeceptionArmor = false,
CustomKey = new Cloudflare.Inputs.RulesetRuleActionParametersCacheKeyCustomKeyArgs
{
Cookie = new Cloudflare.Inputs.RulesetRuleActionParametersCacheKeyCustomKeyCookieArgs
{
CheckPresences = new[]
{
"string",
},
Includes = new[]
{
"string",
},
},
Header = new Cloudflare.Inputs.RulesetRuleActionParametersCacheKeyCustomKeyHeaderArgs
{
CheckPresences = new[]
{
"string",
},
Contains =
{
{ "string", new[]
{
"string",
} },
},
ExcludeOrigin = false,
Includes = new[]
{
"string",
},
},
Host = new Cloudflare.Inputs.RulesetRuleActionParametersCacheKeyCustomKeyHostArgs
{
Resolved = false,
},
QueryString = new Cloudflare.Inputs.RulesetRuleActionParametersCacheKeyCustomKeyQueryStringArgs
{
Exclude = new Cloudflare.Inputs.RulesetRuleActionParametersCacheKeyCustomKeyQueryStringExcludeArgs
{
All = false,
Lists = new[]
{
"string",
},
},
Include = new Cloudflare.Inputs.RulesetRuleActionParametersCacheKeyCustomKeyQueryStringIncludeArgs
{
All = false,
Lists = new[]
{
"string",
},
},
},
User = new Cloudflare.Inputs.RulesetRuleActionParametersCacheKeyCustomKeyUserArgs
{
DeviceType = false,
Geo = false,
Lang = false,
},
},
IgnoreQueryStringsOrder = false,
},
CacheReserve = new Cloudflare.Inputs.RulesetRuleActionParametersCacheReserveArgs
{
Eligible = false,
MinimumFileSize = 0,
},
Content = "string",
ContentType = "string",
CookieFields = new[]
{
new Cloudflare.Inputs.RulesetRuleActionParametersCookieFieldArgs
{
Name = "string",
},
},
DisableApps = false,
DisableRum = false,
DisableZaraz = false,
EdgeTtl = new Cloudflare.Inputs.RulesetRuleActionParametersEdgeTtlArgs
{
Mode = "string",
Default = 0,
StatusCodeTtls = new[]
{
new Cloudflare.Inputs.RulesetRuleActionParametersEdgeTtlStatusCodeTtlArgs
{
Value = 0,
StatusCode = 0,
StatusCodeRange = new Cloudflare.Inputs.RulesetRuleActionParametersEdgeTtlStatusCodeTtlStatusCodeRangeArgs
{
From = 0,
To = 0,
},
},
},
},
EmailObfuscation = false,
Fonts = false,
FromList = new Cloudflare.Inputs.RulesetRuleActionParametersFromListArgs
{
Key = "string",
Name = "string",
},
FromValue = new Cloudflare.Inputs.RulesetRuleActionParametersFromValueArgs
{
TargetUrl = new Cloudflare.Inputs.RulesetRuleActionParametersFromValueTargetUrlArgs
{
Expression = "string",
Value = "string",
},
PreserveQueryString = false,
StatusCode = 0,
},
Headers =
{
{ "string", new Cloudflare.Inputs.RulesetRuleActionParametersHeadersArgs
{
Operation = "string",
Expression = "string",
Value = "string",
} },
},
HostHeader = "string",
HotlinkProtection = false,
Id = "string",
Increment = 0,
MatchedData = new Cloudflare.Inputs.RulesetRuleActionParametersMatchedDataArgs
{
PublicKey = "string",
},
Mirage = false,
OpportunisticEncryption = false,
Origin = new Cloudflare.Inputs.RulesetRuleActionParametersOriginArgs
{
Host = "string",
Port = 0,
},
OriginCacheControl = false,
OriginErrorPagePassthru = false,
Overrides = new Cloudflare.Inputs.RulesetRuleActionParametersOverridesArgs
{
Action = "string",
Categories = new[]
{
new Cloudflare.Inputs.RulesetRuleActionParametersOverridesCategoryArgs
{
Category = "string",
Action = "string",
Enabled = false,
SensitivityLevel = "string",
},
},
Enabled = false,
Rules = new[]
{
new Cloudflare.Inputs.RulesetRuleActionParametersOverridesRuleArgs
{
Id = "string",
Action = "string",
Enabled = false,
ScoreThreshold = 0,
SensitivityLevel = "string",
},
},
SensitivityLevel = "string",
},
Phases = new[]
{
"string",
},
Polish = "string",
Products = new[]
{
"string",
},
RawResponseFields = new[]
{
new Cloudflare.Inputs.RulesetRuleActionParametersRawResponseFieldArgs
{
Name = "string",
PreserveDuplicates = false,
},
},
ReadTimeout = 0,
RequestFields = new[]
{
new Cloudflare.Inputs.RulesetRuleActionParametersRequestFieldArgs
{
Name = "string",
},
},
RespectStrongEtags = false,
Response = new Cloudflare.Inputs.RulesetRuleActionParametersResponseArgs
{
Content = "string",
ContentType = "string",
StatusCode = 0,
},
ResponseFields = new[]
{
new Cloudflare.Inputs.RulesetRuleActionParametersResponseFieldArgs
{
Name = "string",
PreserveDuplicates = false,
},
},
RocketLoader = false,
Rules =
{
{ "string", new[]
{
"string",
} },
},
Ruleset = "string",
Rulesets = new[]
{
"string",
},
SecurityLevel = "string",
ServeStale = new Cloudflare.Inputs.RulesetRuleActionParametersServeStaleArgs
{
DisableStaleWhileUpdating = false,
},
ServerSideExcludes = false,
Sni = new Cloudflare.Inputs.RulesetRuleActionParametersSniArgs
{
Value = "string",
},
Ssl = "string",
StatusCode = 0,
Sxg = false,
TransformedRequestFields = new[]
{
new Cloudflare.Inputs.RulesetRuleActionParametersTransformedRequestFieldArgs
{
Name = "string",
},
},
Uri = new Cloudflare.Inputs.RulesetRuleActionParametersUriArgs
{
Path = new Cloudflare.Inputs.RulesetRuleActionParametersUriPathArgs
{
Expression = "string",
Value = "string",
},
Query = new Cloudflare.Inputs.RulesetRuleActionParametersUriQueryArgs
{
Expression = "string",
Value = "string",
},
},
},
Description = "string",
Enabled = false,
ExposedCredentialCheck = new Cloudflare.Inputs.RulesetRuleExposedCredentialCheckArgs
{
PasswordExpression = "string",
UsernameExpression = "string",
},
Id = "string",
Logging = new Cloudflare.Inputs.RulesetRuleLoggingArgs
{
Enabled = false,
},
Ratelimit = new Cloudflare.Inputs.RulesetRuleRatelimitArgs
{
Characteristics = new[]
{
"string",
},
Period = 0,
CountingExpression = "string",
MitigationTimeout = 0,
RequestsPerPeriod = 0,
RequestsToOrigin = false,
ScorePerPeriod = 0,
ScoreResponseHeaderName = "string",
},
Ref = "string",
},
},
ZoneId = "string",
});
example, err := cloudflare.NewRuleset(ctx, "rulesetResource", &cloudflare.RulesetArgs{
Kind: pulumi.String("string"),
Name: pulumi.String("string"),
Phase: pulumi.String("string"),
AccountId: pulumi.String("string"),
Description: pulumi.String("string"),
Rules: cloudflare.RulesetRuleArray{
&cloudflare.RulesetRuleArgs{
Action: pulumi.String("string"),
Expression: pulumi.String("string"),
ActionParameters: &cloudflare.RulesetRuleActionParametersArgs{
AdditionalCacheablePorts: pulumi.IntArray{
pulumi.Int(0),
},
Algorithms: cloudflare.RulesetRuleActionParametersAlgorithmArray{
&cloudflare.RulesetRuleActionParametersAlgorithmArgs{
Name: pulumi.String("string"),
},
},
AssetName: pulumi.String("string"),
AutomaticHttpsRewrites: pulumi.Bool(false),
Autominify: &cloudflare.RulesetRuleActionParametersAutominifyArgs{
Css: pulumi.Bool(false),
Html: pulumi.Bool(false),
Js: pulumi.Bool(false),
},
Bic: pulumi.Bool(false),
BrowserTtl: &cloudflare.RulesetRuleActionParametersBrowserTtlArgs{
Mode: pulumi.String("string"),
Default: pulumi.Int(0),
},
Cache: pulumi.Bool(false),
CacheKey: &cloudflare.RulesetRuleActionParametersCacheKeyArgs{
CacheByDeviceType: pulumi.Bool(false),
CacheDeceptionArmor: pulumi.Bool(false),
CustomKey: &cloudflare.RulesetRuleActionParametersCacheKeyCustomKeyArgs{
Cookie: &cloudflare.RulesetRuleActionParametersCacheKeyCustomKeyCookieArgs{
CheckPresences: pulumi.StringArray{
pulumi.String("string"),
},
Includes: pulumi.StringArray{
pulumi.String("string"),
},
},
Header: &cloudflare.RulesetRuleActionParametersCacheKeyCustomKeyHeaderArgs{
CheckPresences: pulumi.StringArray{
pulumi.String("string"),
},
Contains: pulumi.StringArrayMap{
"string": pulumi.StringArray{
pulumi.String("string"),
},
},
ExcludeOrigin: pulumi.Bool(false),
Includes: pulumi.StringArray{
pulumi.String("string"),
},
},
Host: &cloudflare.RulesetRuleActionParametersCacheKeyCustomKeyHostArgs{
Resolved: pulumi.Bool(false),
},
QueryString: &cloudflare.RulesetRuleActionParametersCacheKeyCustomKeyQueryStringArgs{
Exclude: &cloudflare.RulesetRuleActionParametersCacheKeyCustomKeyQueryStringExcludeArgs{
All: pulumi.Bool(false),
Lists: pulumi.StringArray{
pulumi.String("string"),
},
},
Include: &cloudflare.RulesetRuleActionParametersCacheKeyCustomKeyQueryStringIncludeArgs{
All: pulumi.Bool(false),
Lists: pulumi.StringArray{
pulumi.String("string"),
},
},
},
User: &cloudflare.RulesetRuleActionParametersCacheKeyCustomKeyUserArgs{
DeviceType: pulumi.Bool(false),
Geo: pulumi.Bool(false),
Lang: pulumi.Bool(false),
},
},
IgnoreQueryStringsOrder: pulumi.Bool(false),
},
CacheReserve: &cloudflare.RulesetRuleActionParametersCacheReserveArgs{
Eligible: pulumi.Bool(false),
MinimumFileSize: pulumi.Int(0),
},
Content: pulumi.String("string"),
ContentType: pulumi.String("string"),
CookieFields: cloudflare.RulesetRuleActionParametersCookieFieldArray{
&cloudflare.RulesetRuleActionParametersCookieFieldArgs{
Name: pulumi.String("string"),
},
},
DisableApps: pulumi.Bool(false),
DisableRum: pulumi.Bool(false),
DisableZaraz: pulumi.Bool(false),
EdgeTtl: &cloudflare.RulesetRuleActionParametersEdgeTtlArgs{
Mode: pulumi.String("string"),
Default: pulumi.Int(0),
StatusCodeTtls: cloudflare.RulesetRuleActionParametersEdgeTtlStatusCodeTtlArray{
&cloudflare.RulesetRuleActionParametersEdgeTtlStatusCodeTtlArgs{
Value: pulumi.Int(0),
StatusCode: pulumi.Int(0),
StatusCodeRange: &cloudflare.RulesetRuleActionParametersEdgeTtlStatusCodeTtlStatusCodeRangeArgs{
From: pulumi.Int(0),
To: pulumi.Int(0),
},
},
},
},
EmailObfuscation: pulumi.Bool(false),
Fonts: pulumi.Bool(false),
FromList: &cloudflare.RulesetRuleActionParametersFromListArgs{
Key: pulumi.String("string"),
Name: pulumi.String("string"),
},
FromValue: &cloudflare.RulesetRuleActionParametersFromValueArgs{
TargetUrl: &cloudflare.RulesetRuleActionParametersFromValueTargetUrlArgs{
Expression: pulumi.String("string"),
Value: pulumi.String("string"),
},
PreserveQueryString: pulumi.Bool(false),
StatusCode: pulumi.Int(0),
},
Headers: cloudflare.RulesetRuleActionParametersHeadersMap{
"string": &cloudflare.RulesetRuleActionParametersHeadersArgs{
Operation: pulumi.String("string"),
Expression: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
HostHeader: pulumi.String("string"),
HotlinkProtection: pulumi.Bool(false),
Id: pulumi.String("string"),
Increment: pulumi.Int(0),
MatchedData: &cloudflare.RulesetRuleActionParametersMatchedDataArgs{
PublicKey: pulumi.String("string"),
},
Mirage: pulumi.Bool(false),
OpportunisticEncryption: pulumi.Bool(false),
Origin: &cloudflare.RulesetRuleActionParametersOriginArgs{
Host: pulumi.String("string"),
Port: pulumi.Int(0),
},
OriginCacheControl: pulumi.Bool(false),
OriginErrorPagePassthru: pulumi.Bool(false),
Overrides: &cloudflare.RulesetRuleActionParametersOverridesArgs{
Action: pulumi.String("string"),
Categories: cloudflare.RulesetRuleActionParametersOverridesCategoryArray{
&cloudflare.RulesetRuleActionParametersOverridesCategoryArgs{
Category: pulumi.String("string"),
Action: pulumi.String("string"),
Enabled: pulumi.Bool(false),
SensitivityLevel: pulumi.String("string"),
},
},
Enabled: pulumi.Bool(false),
Rules: cloudflare.RulesetRuleActionParametersOverridesRuleArray{
&cloudflare.RulesetRuleActionParametersOverridesRuleArgs{
Id: pulumi.String("string"),
Action: pulumi.String("string"),
Enabled: pulumi.Bool(false),
ScoreThreshold: pulumi.Int(0),
SensitivityLevel: pulumi.String("string"),
},
},
SensitivityLevel: pulumi.String("string"),
},
Phases: pulumi.StringArray{
pulumi.String("string"),
},
Polish: pulumi.String("string"),
Products: pulumi.StringArray{
pulumi.String("string"),
},
RawResponseFields: cloudflare.RulesetRuleActionParametersRawResponseFieldArray{
&cloudflare.RulesetRuleActionParametersRawResponseFieldArgs{
Name: pulumi.String("string"),
PreserveDuplicates: pulumi.Bool(false),
},
},
ReadTimeout: pulumi.Int(0),
RequestFields: cloudflare.RulesetRuleActionParametersRequestFieldArray{
&cloudflare.RulesetRuleActionParametersRequestFieldArgs{
Name: pulumi.String("string"),
},
},
RespectStrongEtags: pulumi.Bool(false),
Response: &cloudflare.RulesetRuleActionParametersResponseArgs{
Content: pulumi.String("string"),
ContentType: pulumi.String("string"),
StatusCode: pulumi.Int(0),
},
ResponseFields: cloudflare.RulesetRuleActionParametersResponseFieldArray{
&cloudflare.RulesetRuleActionParametersResponseFieldArgs{
Name: pulumi.String("string"),
PreserveDuplicates: pulumi.Bool(false),
},
},
RocketLoader: pulumi.Bool(false),
Rules: pulumi.StringArrayMap{
"string": pulumi.StringArray{
pulumi.String("string"),
},
},
Ruleset: pulumi.String("string"),
Rulesets: pulumi.StringArray{
pulumi.String("string"),
},
SecurityLevel: pulumi.String("string"),
ServeStale: &cloudflare.RulesetRuleActionParametersServeStaleArgs{
DisableStaleWhileUpdating: pulumi.Bool(false),
},
ServerSideExcludes: pulumi.Bool(false),
Sni: &cloudflare.RulesetRuleActionParametersSniArgs{
Value: pulumi.String("string"),
},
Ssl: pulumi.String("string"),
StatusCode: pulumi.Int(0),
Sxg: pulumi.Bool(false),
TransformedRequestFields: cloudflare.RulesetRuleActionParametersTransformedRequestFieldArray{
&cloudflare.RulesetRuleActionParametersTransformedRequestFieldArgs{
Name: pulumi.String("string"),
},
},
Uri: &cloudflare.RulesetRuleActionParametersUriArgs{
Path: &cloudflare.RulesetRuleActionParametersUriPathArgs{
Expression: pulumi.String("string"),
Value: pulumi.String("string"),
},
Query: &cloudflare.RulesetRuleActionParametersUriQueryArgs{
Expression: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
},
Description: pulumi.String("string"),
Enabled: pulumi.Bool(false),
ExposedCredentialCheck: &cloudflare.RulesetRuleExposedCredentialCheckArgs{
PasswordExpression: pulumi.String("string"),
UsernameExpression: pulumi.String("string"),
},
Id: pulumi.String("string"),
Logging: &cloudflare.RulesetRuleLoggingArgs{
Enabled: pulumi.Bool(false),
},
Ratelimit: &cloudflare.RulesetRuleRatelimitArgs{
Characteristics: pulumi.StringArray{
pulumi.String("string"),
},
Period: pulumi.Int(0),
CountingExpression: pulumi.String("string"),
MitigationTimeout: pulumi.Int(0),
RequestsPerPeriod: pulumi.Int(0),
RequestsToOrigin: pulumi.Bool(false),
ScorePerPeriod: pulumi.Int(0),
ScoreResponseHeaderName: pulumi.String("string"),
},
Ref: pulumi.String("string"),
},
},
ZoneId: pulumi.String("string"),
})
var rulesetResource = new Ruleset("rulesetResource", RulesetArgs.builder()
.kind("string")
.name("string")
.phase("string")
.accountId("string")
.description("string")
.rules(RulesetRuleArgs.builder()
.action("string")
.expression("string")
.actionParameters(RulesetRuleActionParametersArgs.builder()
.additionalCacheablePorts(0)
.algorithms(RulesetRuleActionParametersAlgorithmArgs.builder()
.name("string")
.build())
.assetName("string")
.automaticHttpsRewrites(false)
.autominify(RulesetRuleActionParametersAutominifyArgs.builder()
.css(false)
.html(false)
.js(false)
.build())
.bic(false)
.browserTtl(RulesetRuleActionParametersBrowserTtlArgs.builder()
.mode("string")
.default_(0)
.build())
.cache(false)
.cacheKey(RulesetRuleActionParametersCacheKeyArgs.builder()
.cacheByDeviceType(false)
.cacheDeceptionArmor(false)
.customKey(RulesetRuleActionParametersCacheKeyCustomKeyArgs.builder()
.cookie(RulesetRuleActionParametersCacheKeyCustomKeyCookieArgs.builder()
.checkPresences("string")
.includes("string")
.build())
.header(RulesetRuleActionParametersCacheKeyCustomKeyHeaderArgs.builder()
.checkPresences("string")
.contains(Map.of("string", "string"))
.excludeOrigin(false)
.includes("string")
.build())
.host(RulesetRuleActionParametersCacheKeyCustomKeyHostArgs.builder()
.resolved(false)
.build())
.queryString(RulesetRuleActionParametersCacheKeyCustomKeyQueryStringArgs.builder()
.exclude(RulesetRuleActionParametersCacheKeyCustomKeyQueryStringExcludeArgs.builder()
.all(false)
.lists("string")
.build())
.include(RulesetRuleActionParametersCacheKeyCustomKeyQueryStringIncludeArgs.builder()
.all(false)
.lists("string")
.build())
.build())
.user(RulesetRuleActionParametersCacheKeyCustomKeyUserArgs.builder()
.deviceType(false)
.geo(false)
.lang(false)
.build())
.build())
.ignoreQueryStringsOrder(false)
.build())
.cacheReserve(RulesetRuleActionParametersCacheReserveArgs.builder()
.eligible(false)
.minimumFileSize(0)
.build())
.content("string")
.contentType("string")
.cookieFields(RulesetRuleActionParametersCookieFieldArgs.builder()
.name("string")
.build())
.disableApps(false)
.disableRum(false)
.disableZaraz(false)
.edgeTtl(RulesetRuleActionParametersEdgeTtlArgs.builder()
.mode("string")
.default_(0)
.statusCodeTtls(RulesetRuleActionParametersEdgeTtlStatusCodeTtlArgs.builder()
.value(0)
.statusCode(0)
.statusCodeRange(RulesetRuleActionParametersEdgeTtlStatusCodeTtlStatusCodeRangeArgs.builder()
.from(0)
.to(0)
.build())
.build())
.build())
.emailObfuscation(false)
.fonts(false)
.fromList(RulesetRuleActionParametersFromListArgs.builder()
.key("string")
.name("string")
.build())
.fromValue(RulesetRuleActionParametersFromValueArgs.builder()
.targetUrl(RulesetRuleActionParametersFromValueTargetUrlArgs.builder()
.expression("string")
.value("string")
.build())
.preserveQueryString(false)
.statusCode(0)
.build())
.headers(Map.of("string", RulesetRuleActionParametersHeadersArgs.builder()
.operation("string")
.expression("string")
.value("string")
.build()))
.hostHeader("string")
.hotlinkProtection(false)
.id("string")
.increment(0)
.matchedData(RulesetRuleActionParametersMatchedDataArgs.builder()
.publicKey("string")
.build())
.mirage(false)
.opportunisticEncryption(false)
.origin(RulesetRuleActionParametersOriginArgs.builder()
.host("string")
.port(0)
.build())
.originCacheControl(false)
.originErrorPagePassthru(false)
.overrides(RulesetRuleActionParametersOverridesArgs.builder()
.action("string")
.categories(RulesetRuleActionParametersOverridesCategoryArgs.builder()
.category("string")
.action("string")
.enabled(false)
.sensitivityLevel("string")
.build())
.enabled(false)
.rules(RulesetRuleActionParametersOverridesRuleArgs.builder()
.id("string")
.action("string")
.enabled(false)
.scoreThreshold(0)
.sensitivityLevel("string")
.build())
.sensitivityLevel("string")
.build())
.phases("string")
.polish("string")
.products("string")
.rawResponseFields(RulesetRuleActionParametersRawResponseFieldArgs.builder()
.name("string")
.preserveDuplicates(false)
.build())
.readTimeout(0)
.requestFields(RulesetRuleActionParametersRequestFieldArgs.builder()
.name("string")
.build())
.respectStrongEtags(false)
.response(RulesetRuleActionParametersResponseArgs.builder()
.content("string")
.contentType("string")
.statusCode(0)
.build())
.responseFields(RulesetRuleActionParametersResponseFieldArgs.builder()
.name("string")
.preserveDuplicates(false)
.build())
.rocketLoader(false)
.rules(Map.of("string", "string"))
.ruleset("string")
.rulesets("string")
.securityLevel("string")
.serveStale(RulesetRuleActionParametersServeStaleArgs.builder()
.disableStaleWhileUpdating(false)
.build())
.serverSideExcludes(false)
.sni(RulesetRuleActionParametersSniArgs.builder()
.value("string")
.build())
.ssl("string")
.statusCode(0)
.sxg(false)
.transformedRequestFields(RulesetRuleActionParametersTransformedRequestFieldArgs.builder()
.name("string")
.build())
.uri(RulesetRuleActionParametersUriArgs.builder()
.path(RulesetRuleActionParametersUriPathArgs.builder()
.expression("string")
.value("string")
.build())
.query(RulesetRuleActionParametersUriQueryArgs.builder()
.expression("string")
.value("string")
.build())
.build())
.build())
.description("string")
.enabled(false)
.exposedCredentialCheck(RulesetRuleExposedCredentialCheckArgs.builder()
.passwordExpression("string")
.usernameExpression("string")
.build())
.id("string")
.logging(RulesetRuleLoggingArgs.builder()
.enabled(false)
.build())
.ratelimit(RulesetRuleRatelimitArgs.builder()
.characteristics("string")
.period(0)
.countingExpression("string")
.mitigationTimeout(0)
.requestsPerPeriod(0)
.requestsToOrigin(false)
.scorePerPeriod(0)
.scoreResponseHeaderName("string")
.build())
.ref("string")
.build())
.zoneId("string")
.build());
ruleset_resource = cloudflare.Ruleset("rulesetResource",
kind="string",
name="string",
phase="string",
account_id="string",
description="string",
rules=[{
"action": "string",
"expression": "string",
"action_parameters": {
"additional_cacheable_ports": [0],
"algorithms": [{
"name": "string",
}],
"asset_name": "string",
"automatic_https_rewrites": False,
"autominify": {
"css": False,
"html": False,
"js": False,
},
"bic": False,
"browser_ttl": {
"mode": "string",
"default": 0,
},
"cache": False,
"cache_key": {
"cache_by_device_type": False,
"cache_deception_armor": False,
"custom_key": {
"cookie": {
"check_presences": ["string"],
"includes": ["string"],
},
"header": {
"check_presences": ["string"],
"contains": {
"string": ["string"],
},
"exclude_origin": False,
"includes": ["string"],
},
"host": {
"resolved": False,
},
"query_string": {
"exclude": {
"all": False,
"lists": ["string"],
},
"include": {
"all": False,
"lists": ["string"],
},
},
"user": {
"device_type": False,
"geo": False,
"lang": False,
},
},
"ignore_query_strings_order": False,
},
"cache_reserve": {
"eligible": False,
"minimum_file_size": 0,
},
"content": "string",
"content_type": "string",
"cookie_fields": [{
"name": "string",
}],
"disable_apps": False,
"disable_rum": False,
"disable_zaraz": False,
"edge_ttl": {
"mode": "string",
"default": 0,
"status_code_ttls": [{
"value": 0,
"status_code": 0,
"status_code_range": {
"from_": 0,
"to": 0,
},
}],
},
"email_obfuscation": False,
"fonts": False,
"from_list": {
"key": "string",
"name": "string",
},
"from_value": {
"target_url": {
"expression": "string",
"value": "string",
},
"preserve_query_string": False,
"status_code": 0,
},
"headers": {
"string": {
"operation": "string",
"expression": "string",
"value": "string",
},
},
"host_header": "string",
"hotlink_protection": False,
"id": "string",
"increment": 0,
"matched_data": {
"public_key": "string",
},
"mirage": False,
"opportunistic_encryption": False,
"origin": {
"host": "string",
"port": 0,
},
"origin_cache_control": False,
"origin_error_page_passthru": False,
"overrides": {
"action": "string",
"categories": [{
"category": "string",
"action": "string",
"enabled": False,
"sensitivity_level": "string",
}],
"enabled": False,
"rules": [{
"id": "string",
"action": "string",
"enabled": False,
"score_threshold": 0,
"sensitivity_level": "string",
}],
"sensitivity_level": "string",
},
"phases": ["string"],
"polish": "string",
"products": ["string"],
"raw_response_fields": [{
"name": "string",
"preserve_duplicates": False,
}],
"read_timeout": 0,
"request_fields": [{
"name": "string",
}],
"respect_strong_etags": False,
"response": {
"content": "string",
"content_type": "string",
"status_code": 0,
},
"response_fields": [{
"name": "string",
"preserve_duplicates": False,
}],
"rocket_loader": False,
"rules": {
"string": ["string"],
},
"ruleset": "string",
"rulesets": ["string"],
"security_level": "string",
"serve_stale": {
"disable_stale_while_updating": False,
},
"server_side_excludes": False,
"sni": {
"value": "string",
},
"ssl": "string",
"status_code": 0,
"sxg": False,
"transformed_request_fields": [{
"name": "string",
}],
"uri": {
"path": {
"expression": "string",
"value": "string",
},
"query": {
"expression": "string",
"value": "string",
},
},
},
"description": "string",
"enabled": False,
"exposed_credential_check": {
"password_expression": "string",
"username_expression": "string",
},
"id": "string",
"logging": {
"enabled": False,
},
"ratelimit": {
"characteristics": ["string"],
"period": 0,
"counting_expression": "string",
"mitigation_timeout": 0,
"requests_per_period": 0,
"requests_to_origin": False,
"score_per_period": 0,
"score_response_header_name": "string",
},
"ref": "string",
}],
zone_id="string")
const rulesetResource = new cloudflare.Ruleset("rulesetResource", {
kind: "string",
name: "string",
phase: "string",
accountId: "string",
description: "string",
rules: [{
action: "string",
expression: "string",
actionParameters: {
additionalCacheablePorts: [0],
algorithms: [{
name: "string",
}],
assetName: "string",
automaticHttpsRewrites: false,
autominify: {
css: false,
html: false,
js: false,
},
bic: false,
browserTtl: {
mode: "string",
"default": 0,
},
cache: false,
cacheKey: {
cacheByDeviceType: false,
cacheDeceptionArmor: false,
customKey: {
cookie: {
checkPresences: ["string"],
includes: ["string"],
},
header: {
checkPresences: ["string"],
contains: {
string: ["string"],
},
excludeOrigin: false,
includes: ["string"],
},
host: {
resolved: false,
},
queryString: {
exclude: {
all: false,
lists: ["string"],
},
include: {
all: false,
lists: ["string"],
},
},
user: {
deviceType: false,
geo: false,
lang: false,
},
},
ignoreQueryStringsOrder: false,
},
cacheReserve: {
eligible: false,
minimumFileSize: 0,
},
content: "string",
contentType: "string",
cookieFields: [{
name: "string",
}],
disableApps: false,
disableRum: false,
disableZaraz: false,
edgeTtl: {
mode: "string",
"default": 0,
statusCodeTtls: [{
value: 0,
statusCode: 0,
statusCodeRange: {
from: 0,
to: 0,
},
}],
},
emailObfuscation: false,
fonts: false,
fromList: {
key: "string",
name: "string",
},
fromValue: {
targetUrl: {
expression: "string",
value: "string",
},
preserveQueryString: false,
statusCode: 0,
},
headers: {
string: {
operation: "string",
expression: "string",
value: "string",
},
},
hostHeader: "string",
hotlinkProtection: false,
id: "string",
increment: 0,
matchedData: {
publicKey: "string",
},
mirage: false,
opportunisticEncryption: false,
origin: {
host: "string",
port: 0,
},
originCacheControl: false,
originErrorPagePassthru: false,
overrides: {
action: "string",
categories: [{
category: "string",
action: "string",
enabled: false,
sensitivityLevel: "string",
}],
enabled: false,
rules: [{
id: "string",
action: "string",
enabled: false,
scoreThreshold: 0,
sensitivityLevel: "string",
}],
sensitivityLevel: "string",
},
phases: ["string"],
polish: "string",
products: ["string"],
rawResponseFields: [{
name: "string",
preserveDuplicates: false,
}],
readTimeout: 0,
requestFields: [{
name: "string",
}],
respectStrongEtags: false,
response: {
content: "string",
contentType: "string",
statusCode: 0,
},
responseFields: [{
name: "string",
preserveDuplicates: false,
}],
rocketLoader: false,
rules: {
string: ["string"],
},
ruleset: "string",
rulesets: ["string"],
securityLevel: "string",
serveStale: {
disableStaleWhileUpdating: false,
},
serverSideExcludes: false,
sni: {
value: "string",
},
ssl: "string",
statusCode: 0,
sxg: false,
transformedRequestFields: [{
name: "string",
}],
uri: {
path: {
expression: "string",
value: "string",
},
query: {
expression: "string",
value: "string",
},
},
},
description: "string",
enabled: false,
exposedCredentialCheck: {
passwordExpression: "string",
usernameExpression: "string",
},
id: "string",
logging: {
enabled: false,
},
ratelimit: {
characteristics: ["string"],
period: 0,
countingExpression: "string",
mitigationTimeout: 0,
requestsPerPeriod: 0,
requestsToOrigin: false,
scorePerPeriod: 0,
scoreResponseHeaderName: "string",
},
ref: "string",
}],
zoneId: "string",
});
type: cloudflare:Ruleset
properties:
accountId: string
description: string
kind: string
name: string
phase: string
rules:
- action: string
actionParameters:
additionalCacheablePorts:
- 0
algorithms:
- name: string
assetName: string
automaticHttpsRewrites: false
autominify:
css: false
html: false
js: false
bic: false
browserTtl:
default: 0
mode: string
cache: false
cacheKey:
cacheByDeviceType: false
cacheDeceptionArmor: false
customKey:
cookie:
checkPresences:
- string
includes:
- string
header:
checkPresences:
- string
contains:
string:
- string
excludeOrigin: false
includes:
- string
host:
resolved: false
queryString:
exclude:
all: false
lists:
- string
include:
all: false
lists:
- string
user:
deviceType: false
geo: false
lang: false
ignoreQueryStringsOrder: false
cacheReserve:
eligible: false
minimumFileSize: 0
content: string
contentType: string
cookieFields:
- name: string
disableApps: false
disableRum: false
disableZaraz: false
edgeTtl:
default: 0
mode: string
statusCodeTtls:
- statusCode: 0
statusCodeRange:
from: 0
to: 0
value: 0
emailObfuscation: false
fonts: false
fromList:
key: string
name: string
fromValue:
preserveQueryString: false
statusCode: 0
targetUrl:
expression: string
value: string
headers:
string:
expression: string
operation: string
value: string
hostHeader: string
hotlinkProtection: false
id: string
increment: 0
matchedData:
publicKey: string
mirage: false
opportunisticEncryption: false
origin:
host: string
port: 0
originCacheControl: false
originErrorPagePassthru: false
overrides:
action: string
categories:
- action: string
category: string
enabled: false
sensitivityLevel: string
enabled: false
rules:
- action: string
enabled: false
id: string
scoreThreshold: 0
sensitivityLevel: string
sensitivityLevel: string
phases:
- string
polish: string
products:
- string
rawResponseFields:
- name: string
preserveDuplicates: false
readTimeout: 0
requestFields:
- name: string
respectStrongEtags: false
response:
content: string
contentType: string
statusCode: 0
responseFields:
- name: string
preserveDuplicates: false
rocketLoader: false
rules:
string:
- string
ruleset: string
rulesets:
- string
securityLevel: string
serveStale:
disableStaleWhileUpdating: false
serverSideExcludes: false
sni:
value: string
ssl: string
statusCode: 0
sxg: false
transformedRequestFields:
- name: string
uri:
path:
expression: string
value: string
query:
expression: string
value: string
description: string
enabled: false
exposedCredentialCheck:
passwordExpression: string
usernameExpression: string
expression: string
id: string
logging:
enabled: false
ratelimit:
characteristics:
- string
countingExpression: string
mitigationTimeout: 0
period: 0
requestsPerPeriod: 0
requestsToOrigin: false
scorePerPeriod: 0
scoreResponseHeaderName: string
ref: string
zoneId: string
Ruleset 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 Ruleset resource accepts the following input properties:
- Kind string
- The kind of the ruleset. Available values: "managed", "custom", "root", "zone".
- Name string
- The human-readable name of the ruleset.
- Phase string
- The phase of the ruleset. Available values: "ddosl4", "ddosl7", "httpconfigsettings", "httpcustomerrors", "httplogcustomfields", "httpratelimit", "httprequestcachesettings", "httprequestdynamicredirect", "httprequestfirewallcustom", "httprequestfirewallmanaged", "httprequestlatetransform", "httprequestorigin", "httprequestredirect", "httprequestsanitize", "httprequestsbfm", "httprequesttransform", "httpresponsecompression", "httpresponsefirewallmanaged", "httpresponseheaderstransform", "magictransit", "magictransitidsmanaged", "magictransitmanaged", "magictransit_ratelimit".
- Account
Id string - The unique ID of the account.
- Description string
- An informative description of the ruleset.
- Rules
List<Ruleset
Rule> - The list of rules in the ruleset.
- Zone
Id string - The unique ID of the zone.
- Kind string
- The kind of the ruleset. Available values: "managed", "custom", "root", "zone".
- Name string
- The human-readable name of the ruleset.
- Phase string
- The phase of the ruleset. Available values: "ddosl4", "ddosl7", "httpconfigsettings", "httpcustomerrors", "httplogcustomfields", "httpratelimit", "httprequestcachesettings", "httprequestdynamicredirect", "httprequestfirewallcustom", "httprequestfirewallmanaged", "httprequestlatetransform", "httprequestorigin", "httprequestredirect", "httprequestsanitize", "httprequestsbfm", "httprequesttransform", "httpresponsecompression", "httpresponsefirewallmanaged", "httpresponseheaderstransform", "magictransit", "magictransitidsmanaged", "magictransitmanaged", "magictransit_ratelimit".
- Account
Id string - The unique ID of the account.
- Description string
- An informative description of the ruleset.
- Rules
[]Ruleset
Rule Args - The list of rules in the ruleset.
- Zone
Id string - The unique ID of the zone.
- kind String
- The kind of the ruleset. Available values: "managed", "custom", "root", "zone".
- name String
- The human-readable name of the ruleset.
- phase String
- The phase of the ruleset. Available values: "ddosl4", "ddosl7", "httpconfigsettings", "httpcustomerrors", "httplogcustomfields", "httpratelimit", "httprequestcachesettings", "httprequestdynamicredirect", "httprequestfirewallcustom", "httprequestfirewallmanaged", "httprequestlatetransform", "httprequestorigin", "httprequestredirect", "httprequestsanitize", "httprequestsbfm", "httprequesttransform", "httpresponsecompression", "httpresponsefirewallmanaged", "httpresponseheaderstransform", "magictransit", "magictransitidsmanaged", "magictransitmanaged", "magictransit_ratelimit".
- account
Id String - The unique ID of the account.
- description String
- An informative description of the ruleset.
- rules
List<Ruleset
Rule> - The list of rules in the ruleset.
- zone
Id String - The unique ID of the zone.
- kind string
- The kind of the ruleset. Available values: "managed", "custom", "root", "zone".
- name string
- The human-readable name of the ruleset.
- phase string
- The phase of the ruleset. Available values: "ddosl4", "ddosl7", "httpconfigsettings", "httpcustomerrors", "httplogcustomfields", "httpratelimit", "httprequestcachesettings", "httprequestdynamicredirect", "httprequestfirewallcustom", "httprequestfirewallmanaged", "httprequestlatetransform", "httprequestorigin", "httprequestredirect", "httprequestsanitize", "httprequestsbfm", "httprequesttransform", "httpresponsecompression", "httpresponsefirewallmanaged", "httpresponseheaderstransform", "magictransit", "magictransitidsmanaged", "magictransitmanaged", "magictransit_ratelimit".
- account
Id string - The unique ID of the account.
- description string
- An informative description of the ruleset.
- rules
Ruleset
Rule[] - The list of rules in the ruleset.
- zone
Id string - The unique ID of the zone.
- kind str
- The kind of the ruleset. Available values: "managed", "custom", "root", "zone".
- name str
- The human-readable name of the ruleset.
- phase str
- The phase of the ruleset. Available values: "ddosl4", "ddosl7", "httpconfigsettings", "httpcustomerrors", "httplogcustomfields", "httpratelimit", "httprequestcachesettings", "httprequestdynamicredirect", "httprequestfirewallcustom", "httprequestfirewallmanaged", "httprequestlatetransform", "httprequestorigin", "httprequestredirect", "httprequestsanitize", "httprequestsbfm", "httprequesttransform", "httpresponsecompression", "httpresponsefirewallmanaged", "httpresponseheaderstransform", "magictransit", "magictransitidsmanaged", "magictransitmanaged", "magictransit_ratelimit".
- account_
id str - The unique ID of the account.
- description str
- An informative description of the ruleset.
- rules
Sequence[Ruleset
Rule Args] - The list of rules in the ruleset.
- zone_
id str - The unique ID of the zone.
- kind String
- The kind of the ruleset. Available values: "managed", "custom", "root", "zone".
- name String
- The human-readable name of the ruleset.
- phase String
- The phase of the ruleset. Available values: "ddosl4", "ddosl7", "httpconfigsettings", "httpcustomerrors", "httplogcustomfields", "httpratelimit", "httprequestcachesettings", "httprequestdynamicredirect", "httprequestfirewallcustom", "httprequestfirewallmanaged", "httprequestlatetransform", "httprequestorigin", "httprequestredirect", "httprequestsanitize", "httprequestsbfm", "httprequesttransform", "httpresponsecompression", "httpresponsefirewallmanaged", "httpresponseheaderstransform", "magictransit", "magictransitidsmanaged", "magictransitmanaged", "magictransit_ratelimit".
- account
Id String - The unique ID of the account.
- description String
- An informative description of the ruleset.
- rules List<Property Map>
- The list of rules in the ruleset.
- zone
Id String - The unique ID of the zone.
Outputs
All input properties are implicitly available as output properties. Additionally, the Ruleset resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Updated string - The timestamp of when the ruleset was last modified.
- Version string
- The version of the ruleset.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Updated string - The timestamp of when the ruleset was last modified.
- Version string
- The version of the ruleset.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Updated String - The timestamp of when the ruleset was last modified.
- version String
- The version of the ruleset.
- id string
- The provider-assigned unique ID for this managed resource.
- last
Updated string - The timestamp of when the ruleset was last modified.
- version string
- The version of the ruleset.
- id str
- The provider-assigned unique ID for this managed resource.
- last_
updated str - The timestamp of when the ruleset was last modified.
- version str
- The version of the ruleset.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Updated String - The timestamp of when the ruleset was last modified.
- version String
- The version of the ruleset.
Look up Existing Ruleset Resource
Get an existing Ruleset 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?: RulesetState, opts?: CustomResourceOptions): Ruleset@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
account_id: Optional[str] = None,
description: Optional[str] = None,
kind: Optional[str] = None,
last_updated: Optional[str] = None,
name: Optional[str] = None,
phase: Optional[str] = None,
rules: Optional[Sequence[RulesetRuleArgs]] = None,
version: Optional[str] = None,
zone_id: Optional[str] = None) -> Rulesetfunc GetRuleset(ctx *Context, name string, id IDInput, state *RulesetState, opts ...ResourceOption) (*Ruleset, error)public static Ruleset Get(string name, Input<string> id, RulesetState? state, CustomResourceOptions? opts = null)public static Ruleset get(String name, Output<String> id, RulesetState state, CustomResourceOptions options)resources: _: type: cloudflare:Ruleset 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.
- Account
Id string - The unique ID of the account.
- Description string
- An informative description of the ruleset.
- Kind string
- The kind of the ruleset. Available values: "managed", "custom", "root", "zone".
- Last
Updated string - The timestamp of when the ruleset was last modified.
- Name string
- The human-readable name of the ruleset.
- Phase string
- The phase of the ruleset. Available values: "ddosl4", "ddosl7", "httpconfigsettings", "httpcustomerrors", "httplogcustomfields", "httpratelimit", "httprequestcachesettings", "httprequestdynamicredirect", "httprequestfirewallcustom", "httprequestfirewallmanaged", "httprequestlatetransform", "httprequestorigin", "httprequestredirect", "httprequestsanitize", "httprequestsbfm", "httprequesttransform", "httpresponsecompression", "httpresponsefirewallmanaged", "httpresponseheaderstransform", "magictransit", "magictransitidsmanaged", "magictransitmanaged", "magictransit_ratelimit".
- Rules
List<Ruleset
Rule> - The list of rules in the ruleset.
- Version string
- The version of the ruleset.
- Zone
Id string - The unique ID of the zone.
- Account
Id string - The unique ID of the account.
- Description string
- An informative description of the ruleset.
- Kind string
- The kind of the ruleset. Available values: "managed", "custom", "root", "zone".
- Last
Updated string - The timestamp of when the ruleset was last modified.
- Name string
- The human-readable name of the ruleset.
- Phase string
- The phase of the ruleset. Available values: "ddosl4", "ddosl7", "httpconfigsettings", "httpcustomerrors", "httplogcustomfields", "httpratelimit", "httprequestcachesettings", "httprequestdynamicredirect", "httprequestfirewallcustom", "httprequestfirewallmanaged", "httprequestlatetransform", "httprequestorigin", "httprequestredirect", "httprequestsanitize", "httprequestsbfm", "httprequesttransform", "httpresponsecompression", "httpresponsefirewallmanaged", "httpresponseheaderstransform", "magictransit", "magictransitidsmanaged", "magictransitmanaged", "magictransit_ratelimit".
- Rules
[]Ruleset
Rule Args - The list of rules in the ruleset.
- Version string
- The version of the ruleset.
- Zone
Id string - The unique ID of the zone.
- account
Id String - The unique ID of the account.
- description String
- An informative description of the ruleset.
- kind String
- The kind of the ruleset. Available values: "managed", "custom", "root", "zone".
- last
Updated String - The timestamp of when the ruleset was last modified.
- name String
- The human-readable name of the ruleset.
- phase String
- The phase of the ruleset. Available values: "ddosl4", "ddosl7", "httpconfigsettings", "httpcustomerrors", "httplogcustomfields", "httpratelimit", "httprequestcachesettings", "httprequestdynamicredirect", "httprequestfirewallcustom", "httprequestfirewallmanaged", "httprequestlatetransform", "httprequestorigin", "httprequestredirect", "httprequestsanitize", "httprequestsbfm", "httprequesttransform", "httpresponsecompression", "httpresponsefirewallmanaged", "httpresponseheaderstransform", "magictransit", "magictransitidsmanaged", "magictransitmanaged", "magictransit_ratelimit".
- rules
List<Ruleset
Rule> - The list of rules in the ruleset.
- version String
- The version of the ruleset.
- zone
Id String - The unique ID of the zone.
- account
Id string - The unique ID of the account.
- description string
- An informative description of the ruleset.
- kind string
- The kind of the ruleset. Available values: "managed", "custom", "root", "zone".
- last
Updated string - The timestamp of when the ruleset was last modified.
- name string
- The human-readable name of the ruleset.
- phase string
- The phase of the ruleset. Available values: "ddosl4", "ddosl7", "httpconfigsettings", "httpcustomerrors", "httplogcustomfields", "httpratelimit", "httprequestcachesettings", "httprequestdynamicredirect", "httprequestfirewallcustom", "httprequestfirewallmanaged", "httprequestlatetransform", "httprequestorigin", "httprequestredirect", "httprequestsanitize", "httprequestsbfm", "httprequesttransform", "httpresponsecompression", "httpresponsefirewallmanaged", "httpresponseheaderstransform", "magictransit", "magictransitidsmanaged", "magictransitmanaged", "magictransit_ratelimit".
- rules
Ruleset
Rule[] - The list of rules in the ruleset.
- version string
- The version of the ruleset.
- zone
Id string - The unique ID of the zone.
- account_
id str - The unique ID of the account.
- description str
- An informative description of the ruleset.
- kind str
- The kind of the ruleset. Available values: "managed", "custom", "root", "zone".
- last_
updated str - The timestamp of when the ruleset was last modified.
- name str
- The human-readable name of the ruleset.
- phase str
- The phase of the ruleset. Available values: "ddosl4", "ddosl7", "httpconfigsettings", "httpcustomerrors", "httplogcustomfields", "httpratelimit", "httprequestcachesettings", "httprequestdynamicredirect", "httprequestfirewallcustom", "httprequestfirewallmanaged", "httprequestlatetransform", "httprequestorigin", "httprequestredirect", "httprequestsanitize", "httprequestsbfm", "httprequesttransform", "httpresponsecompression", "httpresponsefirewallmanaged", "httpresponseheaderstransform", "magictransit", "magictransitidsmanaged", "magictransitmanaged", "magictransit_ratelimit".
- rules
Sequence[Ruleset
Rule Args] - The list of rules in the ruleset.
- version str
- The version of the ruleset.
- zone_
id str - The unique ID of the zone.
- account
Id String - The unique ID of the account.
- description String
- An informative description of the ruleset.
- kind String
- The kind of the ruleset. Available values: "managed", "custom", "root", "zone".
- last
Updated String - The timestamp of when the ruleset was last modified.
- name String
- The human-readable name of the ruleset.
- phase String
- The phase of the ruleset. Available values: "ddosl4", "ddosl7", "httpconfigsettings", "httpcustomerrors", "httplogcustomfields", "httpratelimit", "httprequestcachesettings", "httprequestdynamicredirect", "httprequestfirewallcustom", "httprequestfirewallmanaged", "httprequestlatetransform", "httprequestorigin", "httprequestredirect", "httprequestsanitize", "httprequestsbfm", "httprequesttransform", "httpresponsecompression", "httpresponsefirewallmanaged", "httpresponseheaderstransform", "magictransit", "magictransitidsmanaged", "magictransitmanaged", "magictransit_ratelimit".
- rules List<Property Map>
- The list of rules in the ruleset.
- version String
- The version of the ruleset.
- zone
Id String - The unique ID of the zone.
Supporting Types
RulesetRule, RulesetRuleArgs
- Action string
- The action to perform when the rule matches. Available values: "block", "challenge", "compressresponse", "ddosdynamic", "execute", "forceconnectionclose", "jschallenge", "log", "logcustomfield", "managedchallenge", "redirect", "rewrite", "route", "score", "serveerror", "setcachesettings", "setconfig", "skip".
- Expression string
- The expression defining which traffic will match the rule.
- Action
Parameters RulesetRule Action Parameters - The parameters configuring the rule's action.
- Description string
- An informative description of the rule.
- Enabled bool
- Whether the rule should be executed.
- Exposed
Credential RulesetCheck Rule Exposed Credential Check - Configuration for exposed credential checking.
- Id string
- The unique ID of the rule.
- Logging
Ruleset
Rule Logging - An object configuring the rule's logging behavior.
- Ratelimit
Ruleset
Rule Ratelimit - An object configuring the rule's rate limit behavior.
- Ref string
- The reference of the rule (the rule's ID by default).
- Action string
- The action to perform when the rule matches. Available values: "block", "challenge", "compressresponse", "ddosdynamic", "execute", "forceconnectionclose", "jschallenge", "log", "logcustomfield", "managedchallenge", "redirect", "rewrite", "route", "score", "serveerror", "setcachesettings", "setconfig", "skip".
- Expression string
- The expression defining which traffic will match the rule.
- Action
Parameters RulesetRule Action Parameters - The parameters configuring the rule's action.
- Description string
- An informative description of the rule.
- Enabled bool
- Whether the rule should be executed.
- Exposed
Credential RulesetCheck Rule Exposed Credential Check - Configuration for exposed credential checking.
- Id string
- The unique ID of the rule.
- Logging
Ruleset
Rule Logging - An object configuring the rule's logging behavior.
- Ratelimit
Ruleset
Rule Ratelimit - An object configuring the rule's rate limit behavior.
- Ref string
- The reference of the rule (the rule's ID by default).
- action String
- The action to perform when the rule matches. Available values: "block", "challenge", "compressresponse", "ddosdynamic", "execute", "forceconnectionclose", "jschallenge", "log", "logcustomfield", "managedchallenge", "redirect", "rewrite", "route", "score", "serveerror", "setcachesettings", "setconfig", "skip".
- expression String
- The expression defining which traffic will match the rule.
- action
Parameters RulesetRule Action Parameters - The parameters configuring the rule's action.
- description String
- An informative description of the rule.
- enabled Boolean
- Whether the rule should be executed.
- exposed
Credential RulesetCheck Rule Exposed Credential Check - Configuration for exposed credential checking.
- id String
- The unique ID of the rule.
- logging
Ruleset
Rule Logging - An object configuring the rule's logging behavior.
- ratelimit
Ruleset
Rule Ratelimit - An object configuring the rule's rate limit behavior.
- ref String
- The reference of the rule (the rule's ID by default).
- action string
- The action to perform when the rule matches. Available values: "block", "challenge", "compressresponse", "ddosdynamic", "execute", "forceconnectionclose", "jschallenge", "log", "logcustomfield", "managedchallenge", "redirect", "rewrite", "route", "score", "serveerror", "setcachesettings", "setconfig", "skip".
- expression string
- The expression defining which traffic will match the rule.
- action
Parameters RulesetRule Action Parameters - The parameters configuring the rule's action.
- description string
- An informative description of the rule.
- enabled boolean
- Whether the rule should be executed.
- exposed
Credential RulesetCheck Rule Exposed Credential Check - Configuration for exposed credential checking.
- id string
- The unique ID of the rule.
- logging
Ruleset
Rule Logging - An object configuring the rule's logging behavior.
- ratelimit
Ruleset
Rule Ratelimit - An object configuring the rule's rate limit behavior.
- ref string
- The reference of the rule (the rule's ID by default).
- action str
- The action to perform when the rule matches. Available values: "block", "challenge", "compressresponse", "ddosdynamic", "execute", "forceconnectionclose", "jschallenge", "log", "logcustomfield", "managedchallenge", "redirect", "rewrite", "route", "score", "serveerror", "setcachesettings", "setconfig", "skip".
- expression str
- The expression defining which traffic will match the rule.
- action_
parameters RulesetRule Action Parameters - The parameters configuring the rule's action.
- description str
- An informative description of the rule.
- enabled bool
- Whether the rule should be executed.
- exposed_
credential_ Rulesetcheck Rule Exposed Credential Check - Configuration for exposed credential checking.
- id str
- The unique ID of the rule.
- logging
Ruleset
Rule Logging - An object configuring the rule's logging behavior.
- ratelimit
Ruleset
Rule Ratelimit - An object configuring the rule's rate limit behavior.
- ref str
- The reference of the rule (the rule's ID by default).
- action String
- The action to perform when the rule matches. Available values: "block", "challenge", "compressresponse", "ddosdynamic", "execute", "forceconnectionclose", "jschallenge", "log", "logcustomfield", "managedchallenge", "redirect", "rewrite", "route", "score", "serveerror", "setcachesettings", "setconfig", "skip".
- expression String
- The expression defining which traffic will match the rule.
- action
Parameters Property Map - The parameters configuring the rule's action.
- description String
- An informative description of the rule.
- enabled Boolean
- Whether the rule should be executed.
- exposed
Credential Property MapCheck - Configuration for exposed credential checking.
- id String
- The unique ID of the rule.
- logging Property Map
- An object configuring the rule's logging behavior.
- ratelimit Property Map
- An object configuring the rule's rate limit behavior.
- ref String
- The reference of the rule (the rule's ID by default).
RulesetRuleActionParameters, RulesetRuleActionParametersArgs
- Additional
Cacheable List<int>Ports - A list of additional ports that caching should be enabled on.
- Algorithms
List<Ruleset
Rule Action Parameters Algorithm> - Custom order for compression algorithms.
- Asset
Name string - The name of a custom asset to serve as the response.
- Automatic
Https boolRewrites - Whether to enable Automatic HTTPS Rewrites.
- Autominify
Ruleset
Rule Action Parameters Autominify - Which file extensions to minify automatically.
- Bic bool
- Whether to enable Browser Integrity Check (BIC).
- Browser
Ttl RulesetRule Action Parameters Browser Ttl - How long client browsers should cache the response. Cloudflare cache purge will not purge content cached on client browsers, so high browser TTLs may lead to stale content.
- Cache bool
- Whether the request's response from the origin is eligible for caching. Caching itself will still depend on the cache control header and your other caching configurations.
- Cache
Key RulesetRule Action Parameters Cache Key - Which components of the request are included in or excluded from the cache key Cloudflare uses to store the response in cache.
- Cache
Reserve RulesetRule Action Parameters Cache Reserve - Settings to determine whether the request's response from origin is eligible for Cache Reserve (requires a Cache Reserve add-on plan).
- Content string
- The response content.
- Content
Type string - The content type header to set with the error response. Available values: "application/json", "text/html", "text/plain", "text/xml".
-
List<Ruleset
Rule Action Parameters Cookie Field> - The cookie fields to log.
- Disable
Apps bool - Whether to disable Cloudflare Apps.
- Disable
Rum bool - Whether to disable Real User Monitoring (RUM).
- Disable
Zaraz bool - Whether to disable Zaraz.
- Edge
Ttl RulesetRule Action Parameters Edge Ttl - How long the Cloudflare edge network should cache the response.
- Email
Obfuscation bool - Whether to enable Email Obfuscation.
- Fonts bool
- Whether to enable Cloudflare Fonts.
- From
List RulesetRule Action Parameters From List - A redirect based on a bulk list lookup.
- From
Value RulesetRule Action Parameters From Value - A redirect based on the request properties.
- Headers
Dictionary<string, Ruleset
Rule Action Parameters Headers> - A map of headers to rewrite.
- Host
Header string - A value to rewrite the HTTP host header to.
- Hotlink
Protection bool - Whether to enable Hotlink Protection.
- Id string
- The ID of the ruleset to execute.
- Increment int
- A delta to change the score by, which can be either positive or negative.
- Matched
Data RulesetRule Action Parameters Matched Data - The configuration to use for matched data logging.
- Mirage bool
- Whether to enable Mirage.
- Opportunistic
Encryption bool - Whether to enable Opportunistic Encryption.
- Origin
Ruleset
Rule Action Parameters Origin - An origin to route to.
- Origin
Cache boolControl - Whether Cloudflare will aim to strictly adhere to RFC 7234.
- Origin
Error boolPage Passthru - Whether to generate Cloudflare error pages for issues from the origin server.
- Overrides
Ruleset
Rule Action Parameters Overrides - A set of overrides to apply to the target ruleset.
- Phases List<string>
- A list of phases to skip the execution of. This option is incompatible with the rulesets option. Available values: "ddosl4", "ddosl7", "httpconfigsettings", "httpcustomerrors", "httplogcustomfields", "httpratelimit", "httprequestcachesettings", "httprequestdynamicredirect", "httprequestfirewallcustom", "httprequestfirewallmanaged", "httprequestlatetransform", "httprequestorigin", "httprequestredirect", "httprequestsanitize", "httprequestsbfm", "httprequesttransform", "httpresponsecompression", "httpresponsefirewallmanaged", "httpresponseheaderstransform", "magictransit", "magictransitidsmanaged", "magictransitmanaged", "magictransit_ratelimit".
- Polish string
- The Polish level to configure. Available values: "off", "lossless", "lossy", "webp".
- Products List<string>
- A list of legacy security products to skip the execution of. Available values: "bic", "hot", "rateLimit", "securityLevel", "uaBlock", "waf", "zoneLockdown".
- Raw
Response List<RulesetFields Rule Action Parameters Raw Response Field> - The raw response fields to log.
- Read
Timeout int - A timeout value between two successive read operations to use for your origin server. Historically, the timeout value between two read options from Cloudflare to an origin server is 100 seconds. If you are attempting to reduce HTTP 524 errors because of timeouts from an origin server, try increasing this timeout value.
- Request
Fields List<RulesetRule Action Parameters Request Field> - The raw request fields to log.
- bool
- Whether Cloudflare should respect strong ETag (entity tag) headers. If false, Cloudflare converts strong ETag headers to weak ETag headers.
- Response
Ruleset
Rule Action Parameters Response - The response to show when the block is applied.
- Response
Fields List<RulesetRule Action Parameters Response Field> - The transformed response fields to log.
- Rocket
Loader bool - Whether to enable Rocket Loader.
- Rules
Dictionary<string, Immutable
Array<string>> - A mapping of ruleset IDs to a list of rule IDs in that ruleset to skip the execution of. This option is incompatible with the ruleset option.
- Ruleset string
- A ruleset to skip the execution of. This option is incompatible with the rulesets option. Available values: "current".
- Rulesets List<string>
- A list of ruleset IDs to skip the execution of. This option is incompatible with the ruleset and phases options.
- Security
Level string - The Security Level to configure. Available values: "off", "essentiallyoff", "low", "medium", "high", "underattack".
- Serve
Stale RulesetRule Action Parameters Serve Stale - When to serve stale content from cache.
- Server
Side boolExcludes - Whether to enable Server-Side Excludes.
- Sni
Ruleset
Rule Action Parameters Sni - A Server Name Indication (SNI) override.
- Ssl string
- The SSL level to configure. Available values: "off", "flexible", "full", "strict", "origin_pull".
- Status
Code int - The status code to use for the error.
- Sxg bool
- Whether to enable Signed Exchanges (SXG).
- Transformed
Request List<RulesetFields Rule Action Parameters Transformed Request Field> - The transformed request fields to log.
- Uri
Ruleset
Rule Action Parameters Uri - A URI rewrite.
- Additional
Cacheable []intPorts - A list of additional ports that caching should be enabled on.
- Algorithms
[]Ruleset
Rule Action Parameters Algorithm - Custom order for compression algorithms.
- Asset
Name string - The name of a custom asset to serve as the response.
- Automatic
Https boolRewrites - Whether to enable Automatic HTTPS Rewrites.
- Autominify
Ruleset
Rule Action Parameters Autominify - Which file extensions to minify automatically.
- Bic bool
- Whether to enable Browser Integrity Check (BIC).
- Browser
Ttl RulesetRule Action Parameters Browser Ttl - How long client browsers should cache the response. Cloudflare cache purge will not purge content cached on client browsers, so high browser TTLs may lead to stale content.
- Cache bool
- Whether the request's response from the origin is eligible for caching. Caching itself will still depend on the cache control header and your other caching configurations.
- Cache
Key RulesetRule Action Parameters Cache Key - Which components of the request are included in or excluded from the cache key Cloudflare uses to store the response in cache.
- Cache
Reserve RulesetRule Action Parameters Cache Reserve - Settings to determine whether the request's response from origin is eligible for Cache Reserve (requires a Cache Reserve add-on plan).
- Content string
- The response content.
- Content
Type string - The content type header to set with the error response. Available values: "application/json", "text/html", "text/plain", "text/xml".
-
[]Ruleset
Rule Action Parameters Cookie Field - The cookie fields to log.
- Disable
Apps bool - Whether to disable Cloudflare Apps.
- Disable
Rum bool - Whether to disable Real User Monitoring (RUM).
- Disable
Zaraz bool - Whether to disable Zaraz.
- Edge
Ttl RulesetRule Action Parameters Edge Ttl - How long the Cloudflare edge network should cache the response.
- Email
Obfuscation bool - Whether to enable Email Obfuscation.
- Fonts bool
- Whether to enable Cloudflare Fonts.
- From
List RulesetRule Action Parameters From List - A redirect based on a bulk list lookup.
- From
Value RulesetRule Action Parameters From Value - A redirect based on the request properties.
- Headers
map[string]Ruleset
Rule Action Parameters Headers - A map of headers to rewrite.
- Host
Header string - A value to rewrite the HTTP host header to.
- Hotlink
Protection bool - Whether to enable Hotlink Protection.
- Id string
- The ID of the ruleset to execute.
- Increment int
- A delta to change the score by, which can be either positive or negative.
- Matched
Data RulesetRule Action Parameters Matched Data - The configuration to use for matched data logging.
- Mirage bool
- Whether to enable Mirage.
- Opportunistic
Encryption bool - Whether to enable Opportunistic Encryption.
- Origin
Ruleset
Rule Action Parameters Origin - An origin to route to.
- Origin
Cache boolControl - Whether Cloudflare will aim to strictly adhere to RFC 7234.
- Origin
Error boolPage Passthru - Whether to generate Cloudflare error pages for issues from the origin server.
- Overrides
Ruleset
Rule Action Parameters Overrides - A set of overrides to apply to the target ruleset.
- Phases []string
- A list of phases to skip the execution of. This option is incompatible with the rulesets option. Available values: "ddosl4", "ddosl7", "httpconfigsettings", "httpcustomerrors", "httplogcustomfields", "httpratelimit", "httprequestcachesettings", "httprequestdynamicredirect", "httprequestfirewallcustom", "httprequestfirewallmanaged", "httprequestlatetransform", "httprequestorigin", "httprequestredirect", "httprequestsanitize", "httprequestsbfm", "httprequesttransform", "httpresponsecompression", "httpresponsefirewallmanaged", "httpresponseheaderstransform", "magictransit", "magictransitidsmanaged", "magictransitmanaged", "magictransit_ratelimit".
- Polish string
- The Polish level to configure. Available values: "off", "lossless", "lossy", "webp".
- Products []string
- A list of legacy security products to skip the execution of. Available values: "bic", "hot", "rateLimit", "securityLevel", "uaBlock", "waf", "zoneLockdown".
- Raw
Response []RulesetFields Rule Action Parameters Raw Response Field - The raw response fields to log.
- Read
Timeout int - A timeout value between two successive read operations to use for your origin server. Historically, the timeout value between two read options from Cloudflare to an origin server is 100 seconds. If you are attempting to reduce HTTP 524 errors because of timeouts from an origin server, try increasing this timeout value.
- Request
Fields []RulesetRule Action Parameters Request Field - The raw request fields to log.
- bool
- Whether Cloudflare should respect strong ETag (entity tag) headers. If false, Cloudflare converts strong ETag headers to weak ETag headers.
- Response
Ruleset
Rule Action Parameters Response - The response to show when the block is applied.
- Response
Fields []RulesetRule Action Parameters Response Field - The transformed response fields to log.
- Rocket
Loader bool - Whether to enable Rocket Loader.
- Rules map[string][]string
- A mapping of ruleset IDs to a list of rule IDs in that ruleset to skip the execution of. This option is incompatible with the ruleset option.
- Ruleset string
- A ruleset to skip the execution of. This option is incompatible with the rulesets option. Available values: "current".
- Rulesets []string
- A list of ruleset IDs to skip the execution of. This option is incompatible with the ruleset and phases options.
- Security
Level string - The Security Level to configure. Available values: "off", "essentiallyoff", "low", "medium", "high", "underattack".
- Serve
Stale RulesetRule Action Parameters Serve Stale - When to serve stale content from cache.
- Server
Side boolExcludes - Whether to enable Server-Side Excludes.
- Sni
Ruleset
Rule Action Parameters Sni - A Server Name Indication (SNI) override.
- Ssl string
- The SSL level to configure. Available values: "off", "flexible", "full", "strict", "origin_pull".
- Status
Code int - The status code to use for the error.
- Sxg bool
- Whether to enable Signed Exchanges (SXG).
- Transformed
Request []RulesetFields Rule Action Parameters Transformed Request Field - The transformed request fields to log.
- Uri
Ruleset
Rule Action Parameters Uri - A URI rewrite.
- additional
Cacheable List<Integer>Ports - A list of additional ports that caching should be enabled on.
- algorithms
List<Ruleset
Rule Action Parameters Algorithm> - Custom order for compression algorithms.
- asset
Name String - The name of a custom asset to serve as the response.
- automatic
Https BooleanRewrites - Whether to enable Automatic HTTPS Rewrites.
- autominify
Ruleset
Rule Action Parameters Autominify - Which file extensions to minify automatically.
- bic Boolean
- Whether to enable Browser Integrity Check (BIC).
- browser
Ttl RulesetRule Action Parameters Browser Ttl - How long client browsers should cache the response. Cloudflare cache purge will not purge content cached on client browsers, so high browser TTLs may lead to stale content.
- cache Boolean
- Whether the request's response from the origin is eligible for caching. Caching itself will still depend on the cache control header and your other caching configurations.
- cache
Key RulesetRule Action Parameters Cache Key - Which components of the request are included in or excluded from the cache key Cloudflare uses to store the response in cache.
- cache
Reserve RulesetRule Action Parameters Cache Reserve - Settings to determine whether the request's response from origin is eligible for Cache Reserve (requires a Cache Reserve add-on plan).
- content String
- The response content.
- content
Type String - The content type header to set with the error response. Available values: "application/json", "text/html", "text/plain", "text/xml".
-
List<Ruleset
Rule Action Parameters Cookie Field> - The cookie fields to log.
- disable
Apps Boolean - Whether to disable Cloudflare Apps.
- disable
Rum Boolean - Whether to disable Real User Monitoring (RUM).
- disable
Zaraz Boolean - Whether to disable Zaraz.
- edge
Ttl RulesetRule Action Parameters Edge Ttl - How long the Cloudflare edge network should cache the response.
- email
Obfuscation Boolean - Whether to enable Email Obfuscation.
- fonts Boolean
- Whether to enable Cloudflare Fonts.
- from
List RulesetRule Action Parameters From List - A redirect based on a bulk list lookup.
- from
Value RulesetRule Action Parameters From Value - A redirect based on the request properties.
- headers
Map<String,Ruleset
Rule Action Parameters Headers> - A map of headers to rewrite.
- host
Header String - A value to rewrite the HTTP host header to.
- hotlink
Protection Boolean - Whether to enable Hotlink Protection.
- id String
- The ID of the ruleset to execute.
- increment Integer
- A delta to change the score by, which can be either positive or negative.
- matched
Data RulesetRule Action Parameters Matched Data - The configuration to use for matched data logging.
- mirage Boolean
- Whether to enable Mirage.
- opportunistic
Encryption Boolean - Whether to enable Opportunistic Encryption.
- origin
Ruleset
Rule Action Parameters Origin - An origin to route to.
- origin
Cache BooleanControl - Whether Cloudflare will aim to strictly adhere to RFC 7234.
- origin
Error BooleanPage Passthru - Whether to generate Cloudflare error pages for issues from the origin server.
- overrides
Ruleset
Rule Action Parameters Overrides - A set of overrides to apply to the target ruleset.
- phases List<String>
- A list of phases to skip the execution of. This option is incompatible with the rulesets option. Available values: "ddosl4", "ddosl7", "httpconfigsettings", "httpcustomerrors", "httplogcustomfields", "httpratelimit", "httprequestcachesettings", "httprequestdynamicredirect", "httprequestfirewallcustom", "httprequestfirewallmanaged", "httprequestlatetransform", "httprequestorigin", "httprequestredirect", "httprequestsanitize", "httprequestsbfm", "httprequesttransform", "httpresponsecompression", "httpresponsefirewallmanaged", "httpresponseheaderstransform", "magictransit", "magictransitidsmanaged", "magictransitmanaged", "magictransit_ratelimit".
- polish String
- The Polish level to configure. Available values: "off", "lossless", "lossy", "webp".
- products List<String>
- A list of legacy security products to skip the execution of. Available values: "bic", "hot", "rateLimit", "securityLevel", "uaBlock", "waf", "zoneLockdown".
- raw
Response List<RulesetFields Rule Action Parameters Raw Response Field> - The raw response fields to log.
- read
Timeout Integer - A timeout value between two successive read operations to use for your origin server. Historically, the timeout value between two read options from Cloudflare to an origin server is 100 seconds. If you are attempting to reduce HTTP 524 errors because of timeouts from an origin server, try increasing this timeout value.
- request
Fields List<RulesetRule Action Parameters Request Field> - The raw request fields to log.
- Boolean
- Whether Cloudflare should respect strong ETag (entity tag) headers. If false, Cloudflare converts strong ETag headers to weak ETag headers.
- response
Ruleset
Rule Action Parameters Response - The response to show when the block is applied.
- response
Fields List<RulesetRule Action Parameters Response Field> - The transformed response fields to log.
- rocket
Loader Boolean - Whether to enable Rocket Loader.
- rules Map<String,List<String>>
- A mapping of ruleset IDs to a list of rule IDs in that ruleset to skip the execution of. This option is incompatible with the ruleset option.
- ruleset String
- A ruleset to skip the execution of. This option is incompatible with the rulesets option. Available values: "current".
- rulesets List<String>
- A list of ruleset IDs to skip the execution of. This option is incompatible with the ruleset and phases options.
- security
Level String - The Security Level to configure. Available values: "off", "essentiallyoff", "low", "medium", "high", "underattack".
- serve
Stale RulesetRule Action Parameters Serve Stale - When to serve stale content from cache.
- server
Side BooleanExcludes - Whether to enable Server-Side Excludes.
- sni
Ruleset
Rule Action Parameters Sni - A Server Name Indication (SNI) override.
- ssl String
- The SSL level to configure. Available values: "off", "flexible", "full", "strict", "origin_pull".
- status
Code Integer - The status code to use for the error.
- sxg Boolean
- Whether to enable Signed Exchanges (SXG).
- transformed
Request List<RulesetFields Rule Action Parameters Transformed Request Field> - The transformed request fields to log.
- uri
Ruleset
Rule Action Parameters Uri - A URI rewrite.
- additional
Cacheable number[]Ports - A list of additional ports that caching should be enabled on.
- algorithms
Ruleset
Rule Action Parameters Algorithm[] - Custom order for compression algorithms.
- asset
Name string - The name of a custom asset to serve as the response.
- automatic
Https booleanRewrites - Whether to enable Automatic HTTPS Rewrites.
- autominify
Ruleset
Rule Action Parameters Autominify - Which file extensions to minify automatically.
- bic boolean
- Whether to enable Browser Integrity Check (BIC).
- browser
Ttl RulesetRule Action Parameters Browser Ttl - How long client browsers should cache the response. Cloudflare cache purge will not purge content cached on client browsers, so high browser TTLs may lead to stale content.
- cache boolean
- Whether the request's response from the origin is eligible for caching. Caching itself will still depend on the cache control header and your other caching configurations.
- cache
Key RulesetRule Action Parameters Cache Key - Which components of the request are included in or excluded from the cache key Cloudflare uses to store the response in cache.
- cache
Reserve RulesetRule Action Parameters Cache Reserve - Settings to determine whether the request's response from origin is eligible for Cache Reserve (requires a Cache Reserve add-on plan).
- content string
- The response content.
- content
Type string - The content type header to set with the error response. Available values: "application/json", "text/html", "text/plain", "text/xml".
-
Ruleset
Rule Action Parameters Cookie Field[] - The cookie fields to log.
- disable
Apps boolean - Whether to disable Cloudflare Apps.
- disable
Rum boolean - Whether to disable Real User Monitoring (RUM).
- disable
Zaraz boolean - Whether to disable Zaraz.
- edge
Ttl RulesetRule Action Parameters Edge Ttl - How long the Cloudflare edge network should cache the response.
- email
Obfuscation boolean - Whether to enable Email Obfuscation.
- fonts boolean
- Whether to enable Cloudflare Fonts.
- from
List RulesetRule Action Parameters From List - A redirect based on a bulk list lookup.
- from
Value RulesetRule Action Parameters From Value - A redirect based on the request properties.
- headers
{[key: string]: Ruleset
Rule Action Parameters Headers} - A map of headers to rewrite.
- host
Header string - A value to rewrite the HTTP host header to.
- hotlink
Protection boolean - Whether to enable Hotlink Protection.
- id string
- The ID of the ruleset to execute.
- increment number
- A delta to change the score by, which can be either positive or negative.
- matched
Data RulesetRule Action Parameters Matched Data - The configuration to use for matched data logging.
- mirage boolean
- Whether to enable Mirage.
- opportunistic
Encryption boolean - Whether to enable Opportunistic Encryption.
- origin
Ruleset
Rule Action Parameters Origin - An origin to route to.
- origin
Cache booleanControl - Whether Cloudflare will aim to strictly adhere to RFC 7234.
- origin
Error booleanPage Passthru - Whether to generate Cloudflare error pages for issues from the origin server.
- overrides
Ruleset
Rule Action Parameters Overrides - A set of overrides to apply to the target ruleset.
- phases string[]
- A list of phases to skip the execution of. This option is incompatible with the rulesets option. Available values: "ddosl4", "ddosl7", "httpconfigsettings", "httpcustomerrors", "httplogcustomfields", "httpratelimit", "httprequestcachesettings", "httprequestdynamicredirect", "httprequestfirewallcustom", "httprequestfirewallmanaged", "httprequestlatetransform", "httprequestorigin", "httprequestredirect", "httprequestsanitize", "httprequestsbfm", "httprequesttransform", "httpresponsecompression", "httpresponsefirewallmanaged", "httpresponseheaderstransform", "magictransit", "magictransitidsmanaged", "magictransitmanaged", "magictransit_ratelimit".
- polish string
- The Polish level to configure. Available values: "off", "lossless", "lossy", "webp".
- products string[]
- A list of legacy security products to skip the execution of. Available values: "bic", "hot", "rateLimit", "securityLevel", "uaBlock", "waf", "zoneLockdown".
- raw
Response RulesetFields Rule Action Parameters Raw Response Field[] - The raw response fields to log.
- read
Timeout number - A timeout value between two successive read operations to use for your origin server. Historically, the timeout value between two read options from Cloudflare to an origin server is 100 seconds. If you are attempting to reduce HTTP 524 errors because of timeouts from an origin server, try increasing this timeout value.
- request
Fields RulesetRule Action Parameters Request Field[] - The raw request fields to log.
- boolean
- Whether Cloudflare should respect strong ETag (entity tag) headers. If false, Cloudflare converts strong ETag headers to weak ETag headers.
- response
Ruleset
Rule Action Parameters Response - The response to show when the block is applied.
- response
Fields RulesetRule Action Parameters Response Field[] - The transformed response fields to log.
- rocket
Loader boolean - Whether to enable Rocket Loader.
- rules {[key: string]: string[]}
- A mapping of ruleset IDs to a list of rule IDs in that ruleset to skip the execution of. This option is incompatible with the ruleset option.
- ruleset string
- A ruleset to skip the execution of. This option is incompatible with the rulesets option. Available values: "current".
- rulesets string[]
- A list of ruleset IDs to skip the execution of. This option is incompatible with the ruleset and phases options.
- security
Level string - The Security Level to configure. Available values: "off", "essentiallyoff", "low", "medium", "high", "underattack".
- serve
Stale RulesetRule Action Parameters Serve Stale - When to serve stale content from cache.
- server
Side booleanExcludes - Whether to enable Server-Side Excludes.
- sni
Ruleset
Rule Action Parameters Sni - A Server Name Indication (SNI) override.
- ssl string
- The SSL level to configure. Available values: "off", "flexible", "full", "strict", "origin_pull".
- status
Code number - The status code to use for the error.
- sxg boolean
- Whether to enable Signed Exchanges (SXG).
- transformed
Request RulesetFields Rule Action Parameters Transformed Request Field[] - The transformed request fields to log.
- uri
Ruleset
Rule Action Parameters Uri - A URI rewrite.
- additional_
cacheable_ Sequence[int]ports - A list of additional ports that caching should be enabled on.
- algorithms
Sequence[Ruleset
Rule Action Parameters Algorithm] - Custom order for compression algorithms.
- asset_
name str - The name of a custom asset to serve as the response.
- automatic_
https_ boolrewrites - Whether to enable Automatic HTTPS Rewrites.
- autominify
Ruleset
Rule Action Parameters Autominify - Which file extensions to minify automatically.
- bic bool
- Whether to enable Browser Integrity Check (BIC).
- browser_
ttl RulesetRule Action Parameters Browser Ttl - How long client browsers should cache the response. Cloudflare cache purge will not purge content cached on client browsers, so high browser TTLs may lead to stale content.
- cache bool
- Whether the request's response from the origin is eligible for caching. Caching itself will still depend on the cache control header and your other caching configurations.
- cache_
key RulesetRule Action Parameters Cache Key - Which components of the request are included in or excluded from the cache key Cloudflare uses to store the response in cache.
- cache_
reserve RulesetRule Action Parameters Cache Reserve - Settings to determine whether the request's response from origin is eligible for Cache Reserve (requires a Cache Reserve add-on plan).
- content str
- The response content.
- content_
type str - The content type header to set with the error response. Available values: "application/json", "text/html", "text/plain", "text/xml".
-
Sequence[Ruleset
Rule Action Parameters Cookie Field] - The cookie fields to log.
- disable_
apps bool - Whether to disable Cloudflare Apps.
- disable_
rum bool - Whether to disable Real User Monitoring (RUM).
- disable_
zaraz bool - Whether to disable Zaraz.
- edge_
ttl RulesetRule Action Parameters Edge Ttl - How long the Cloudflare edge network should cache the response.
- email_
obfuscation bool - Whether to enable Email Obfuscation.
- fonts bool
- Whether to enable Cloudflare Fonts.
- from_
list RulesetRule Action Parameters From List - A redirect based on a bulk list lookup.
- from_
value RulesetRule Action Parameters From Value - A redirect based on the request properties.
- headers
Mapping[str, Ruleset
Rule Action Parameters Headers] - A map of headers to rewrite.
- host_
header str - A value to rewrite the HTTP host header to.
- hotlink_
protection bool - Whether to enable Hotlink Protection.
- id str
- The ID of the ruleset to execute.
- increment int
- A delta to change the score by, which can be either positive or negative.
- matched_
data RulesetRule Action Parameters Matched Data - The configuration to use for matched data logging.
- mirage bool
- Whether to enable Mirage.
- opportunistic_
encryption bool - Whether to enable Opportunistic Encryption.
- origin
Ruleset
Rule Action Parameters Origin - An origin to route to.
- origin_
cache_ boolcontrol - Whether Cloudflare will aim to strictly adhere to RFC 7234.
- origin_
error_ boolpage_ passthru - Whether to generate Cloudflare error pages for issues from the origin server.
- overrides
Ruleset
Rule Action Parameters Overrides - A set of overrides to apply to the target ruleset.
- phases Sequence[str]
- A list of phases to skip the execution of. This option is incompatible with the rulesets option. Available values: "ddosl4", "ddosl7", "httpconfigsettings", "httpcustomerrors", "httplogcustomfields", "httpratelimit", "httprequestcachesettings", "httprequestdynamicredirect", "httprequestfirewallcustom", "httprequestfirewallmanaged", "httprequestlatetransform", "httprequestorigin", "httprequestredirect", "httprequestsanitize", "httprequestsbfm", "httprequesttransform", "httpresponsecompression", "httpresponsefirewallmanaged", "httpresponseheaderstransform", "magictransit", "magictransitidsmanaged", "magictransitmanaged", "magictransit_ratelimit".
- polish str
- The Polish level to configure. Available values: "off", "lossless", "lossy", "webp".
- products Sequence[str]
- A list of legacy security products to skip the execution of. Available values: "bic", "hot", "rateLimit", "securityLevel", "uaBlock", "waf", "zoneLockdown".
- raw_
response_ Sequence[Rulesetfields Rule Action Parameters Raw Response Field] - The raw response fields to log.
- read_
timeout int - A timeout value between two successive read operations to use for your origin server. Historically, the timeout value between two read options from Cloudflare to an origin server is 100 seconds. If you are attempting to reduce HTTP 524 errors because of timeouts from an origin server, try increasing this timeout value.
- request_
fields Sequence[RulesetRule Action Parameters Request Field] - The raw request fields to log.
- bool
- Whether Cloudflare should respect strong ETag (entity tag) headers. If false, Cloudflare converts strong ETag headers to weak ETag headers.
- response
Ruleset
Rule Action Parameters Response - The response to show when the block is applied.
- response_
fields Sequence[RulesetRule Action Parameters Response Field] - The transformed response fields to log.
- rocket_
loader bool - Whether to enable Rocket Loader.
- rules Mapping[str, Sequence[str]]
- A mapping of ruleset IDs to a list of rule IDs in that ruleset to skip the execution of. This option is incompatible with the ruleset option.
- ruleset str
- A ruleset to skip the execution of. This option is incompatible with the rulesets option. Available values: "current".
- rulesets Sequence[str]
- A list of ruleset IDs to skip the execution of. This option is incompatible with the ruleset and phases options.
- security_
level str - The Security Level to configure. Available values: "off", "essentiallyoff", "low", "medium", "high", "underattack".
- serve_
stale RulesetRule Action Parameters Serve Stale - When to serve stale content from cache.
- server_
side_ boolexcludes - Whether to enable Server-Side Excludes.
- sni
Ruleset
Rule Action Parameters Sni - A Server Name Indication (SNI) override.
- ssl str
- The SSL level to configure. Available values: "off", "flexible", "full", "strict", "origin_pull".
- status_
code int - The status code to use for the error.
- sxg bool
- Whether to enable Signed Exchanges (SXG).
- transformed_
request_ Sequence[Rulesetfields Rule Action Parameters Transformed Request Field] - The transformed request fields to log.
- uri
Ruleset
Rule Action Parameters Uri - A URI rewrite.
- additional
Cacheable List<Number>Ports - A list of additional ports that caching should be enabled on.
- algorithms List<Property Map>
- Custom order for compression algorithms.
- asset
Name String - The name of a custom asset to serve as the response.
- automatic
Https BooleanRewrites - Whether to enable Automatic HTTPS Rewrites.
- autominify Property Map
- Which file extensions to minify automatically.
- bic Boolean
- Whether to enable Browser Integrity Check (BIC).
- browser
Ttl Property Map - How long client browsers should cache the response. Cloudflare cache purge will not purge content cached on client browsers, so high browser TTLs may lead to stale content.
- cache Boolean
- Whether the request's response from the origin is eligible for caching. Caching itself will still depend on the cache control header and your other caching configurations.
- cache
Key Property Map - Which components of the request are included in or excluded from the cache key Cloudflare uses to store the response in cache.
- cache
Reserve Property Map - Settings to determine whether the request's response from origin is eligible for Cache Reserve (requires a Cache Reserve add-on plan).
- content String
- The response content.
- content
Type String - The content type header to set with the error response. Available values: "application/json", "text/html", "text/plain", "text/xml".
- List<Property Map>
- The cookie fields to log.
- disable
Apps Boolean - Whether to disable Cloudflare Apps.
- disable
Rum Boolean - Whether to disable Real User Monitoring (RUM).
- disable
Zaraz Boolean - Whether to disable Zaraz.
- edge
Ttl Property Map - How long the Cloudflare edge network should cache the response.
- email
Obfuscation Boolean - Whether to enable Email Obfuscation.
- fonts Boolean
- Whether to enable Cloudflare Fonts.
- from
List Property Map - A redirect based on a bulk list lookup.
- from
Value Property Map - A redirect based on the request properties.
- headers Map<Property Map>
- A map of headers to rewrite.
- host
Header String - A value to rewrite the HTTP host header to.
- hotlink
Protection Boolean - Whether to enable Hotlink Protection.
- id String
- The ID of the ruleset to execute.
- increment Number
- A delta to change the score by, which can be either positive or negative.
- matched
Data Property Map - The configuration to use for matched data logging.
- mirage Boolean
- Whether to enable Mirage.
- opportunistic
Encryption Boolean - Whether to enable Opportunistic Encryption.
- origin Property Map
- An origin to route to.
- origin
Cache BooleanControl - Whether Cloudflare will aim to strictly adhere to RFC 7234.
- origin
Error BooleanPage Passthru - Whether to generate Cloudflare error pages for issues from the origin server.
- overrides Property Map
- A set of overrides to apply to the target ruleset.
- phases List<String>
- A list of phases to skip the execution of. This option is incompatible with the rulesets option. Available values: "ddosl4", "ddosl7", "httpconfigsettings", "httpcustomerrors", "httplogcustomfields", "httpratelimit", "httprequestcachesettings", "httprequestdynamicredirect", "httprequestfirewallcustom", "httprequestfirewallmanaged", "httprequestlatetransform", "httprequestorigin", "httprequestredirect", "httprequestsanitize", "httprequestsbfm", "httprequesttransform", "httpresponsecompression", "httpresponsefirewallmanaged", "httpresponseheaderstransform", "magictransit", "magictransitidsmanaged", "magictransitmanaged", "magictransit_ratelimit".
- polish String
- The Polish level to configure. Available values: "off", "lossless", "lossy", "webp".
- products List<String>
- A list of legacy security products to skip the execution of. Available values: "bic", "hot", "rateLimit", "securityLevel", "uaBlock", "waf", "zoneLockdown".
- raw
Response List<Property Map>Fields - The raw response fields to log.
- read
Timeout Number - A timeout value between two successive read operations to use for your origin server. Historically, the timeout value between two read options from Cloudflare to an origin server is 100 seconds. If you are attempting to reduce HTTP 524 errors because of timeouts from an origin server, try increasing this timeout value.
- request
Fields List<Property Map> - The raw request fields to log.
- Boolean
- Whether Cloudflare should respect strong ETag (entity tag) headers. If false, Cloudflare converts strong ETag headers to weak ETag headers.
- response Property Map
- The response to show when the block is applied.
- response
Fields List<Property Map> - The transformed response fields to log.
- rocket
Loader Boolean - Whether to enable Rocket Loader.
- rules Map<List<String>>
- A mapping of ruleset IDs to a list of rule IDs in that ruleset to skip the execution of. This option is incompatible with the ruleset option.
- ruleset String
- A ruleset to skip the execution of. This option is incompatible with the rulesets option. Available values: "current".
- rulesets List<String>
- A list of ruleset IDs to skip the execution of. This option is incompatible with the ruleset and phases options.
- security
Level String - The Security Level to configure. Available values: "off", "essentiallyoff", "low", "medium", "high", "underattack".
- serve
Stale Property Map - When to serve stale content from cache.
- server
Side BooleanExcludes - Whether to enable Server-Side Excludes.
- sni Property Map
- A Server Name Indication (SNI) override.
- ssl String
- The SSL level to configure. Available values: "off", "flexible", "full", "strict", "origin_pull".
- status
Code Number - The status code to use for the error.
- sxg Boolean
- Whether to enable Signed Exchanges (SXG).
- transformed
Request List<Property Map>Fields - The transformed request fields to log.
- uri Property Map
- A URI rewrite.
RulesetRuleActionParametersAlgorithm, RulesetRuleActionParametersAlgorithmArgs
- Name string
- Name of the compression algorithm to enable. Available values: "none", "auto", "default", "gzip", "brotli", "zstd".
- Name string
- Name of the compression algorithm to enable. Available values: "none", "auto", "default", "gzip", "brotli", "zstd".
- name String
- Name of the compression algorithm to enable. Available values: "none", "auto", "default", "gzip", "brotli", "zstd".
- name string
- Name of the compression algorithm to enable. Available values: "none", "auto", "default", "gzip", "brotli", "zstd".
- name str
- Name of the compression algorithm to enable. Available values: "none", "auto", "default", "gzip", "brotli", "zstd".
- name String
- Name of the compression algorithm to enable. Available values: "none", "auto", "default", "gzip", "brotli", "zstd".
RulesetRuleActionParametersAutominify, RulesetRuleActionParametersAutominifyArgs
RulesetRuleActionParametersBrowserTtl, RulesetRuleActionParametersBrowserTtlArgs
RulesetRuleActionParametersCacheKey, RulesetRuleActionParametersCacheKeyArgs
- Cache
By boolDevice Type - Whether to separate cached content based on the visitor's device type.
- Cache
Deception boolArmor - Whether to protect from web cache deception attacks, while allowing static assets to be cached.
- Custom
Key RulesetRule Action Parameters Cache Key Custom Key - Which components of the request are included or excluded from the cache key.
- Ignore
Query boolStrings Order - Whether to treat requests with the same query parameters the same, regardless of the order those query parameters are in.
- Cache
By boolDevice Type - Whether to separate cached content based on the visitor's device type.
- Cache
Deception boolArmor - Whether to protect from web cache deception attacks, while allowing static assets to be cached.
- Custom
Key RulesetRule Action Parameters Cache Key Custom Key - Which components of the request are included or excluded from the cache key.
- Ignore
Query boolStrings Order - Whether to treat requests with the same query parameters the same, regardless of the order those query parameters are in.
- cache
By BooleanDevice Type - Whether to separate cached content based on the visitor's device type.
- cache
Deception BooleanArmor - Whether to protect from web cache deception attacks, while allowing static assets to be cached.
- custom
Key RulesetRule Action Parameters Cache Key Custom Key - Which components of the request are included or excluded from the cache key.
- ignore
Query BooleanStrings Order - Whether to treat requests with the same query parameters the same, regardless of the order those query parameters are in.
- cache
By booleanDevice Type - Whether to separate cached content based on the visitor's device type.
- cache
Deception booleanArmor - Whether to protect from web cache deception attacks, while allowing static assets to be cached.
- custom
Key RulesetRule Action Parameters Cache Key Custom Key - Which components of the request are included or excluded from the cache key.
- ignore
Query booleanStrings Order - Whether to treat requests with the same query parameters the same, regardless of the order those query parameters are in.
- cache_
by_ booldevice_ type - Whether to separate cached content based on the visitor's device type.
- cache_
deception_ boolarmor - Whether to protect from web cache deception attacks, while allowing static assets to be cached.
- custom_
key RulesetRule Action Parameters Cache Key Custom Key - Which components of the request are included or excluded from the cache key.
- ignore_
query_ boolstrings_ order - Whether to treat requests with the same query parameters the same, regardless of the order those query parameters are in.
- cache
By BooleanDevice Type - Whether to separate cached content based on the visitor's device type.
- cache
Deception BooleanArmor - Whether to protect from web cache deception attacks, while allowing static assets to be cached.
- custom
Key Property Map - Which components of the request are included or excluded from the cache key.
- ignore
Query BooleanStrings Order - Whether to treat requests with the same query parameters the same, regardless of the order those query parameters are in.
RulesetRuleActionParametersCacheKeyCustomKey, RulesetRuleActionParametersCacheKeyCustomKeyArgs
-
Ruleset
Rule Action Parameters Cache Key Custom Key Cookie - Which cookies to include in the cache key.
- Header
Ruleset
Rule Action Parameters Cache Key Custom Key Header - Which headers to include in the cache key.
- Host
Ruleset
Rule Action Parameters Cache Key Custom Key Host - How to use the host in the cache key.
- Query
String RulesetRule Action Parameters Cache Key Custom Key Query String - Which query string parameters to include in or exclude from the cache key.
- User
Ruleset
Rule Action Parameters Cache Key Custom Key User - How to use characteristics of the request user agent in the cache key.
-
Ruleset
Rule Action Parameters Cache Key Custom Key Cookie - Which cookies to include in the cache key.
- Header
Ruleset
Rule Action Parameters Cache Key Custom Key Header - Which headers to include in the cache key.
- Host
Ruleset
Rule Action Parameters Cache Key Custom Key Host - How to use the host in the cache key.
- Query
String RulesetRule Action Parameters Cache Key Custom Key Query String - Which query string parameters to include in or exclude from the cache key.
- User
Ruleset
Rule Action Parameters Cache Key Custom Key User - How to use characteristics of the request user agent in the cache key.
-
Ruleset
Rule Action Parameters Cache Key Custom Key Cookie - Which cookies to include in the cache key.
- header
Ruleset
Rule Action Parameters Cache Key Custom Key Header - Which headers to include in the cache key.
- host
Ruleset
Rule Action Parameters Cache Key Custom Key Host - How to use the host in the cache key.
- query
String RulesetRule Action Parameters Cache Key Custom Key Query String - Which query string parameters to include in or exclude from the cache key.
- user
Ruleset
Rule Action Parameters Cache Key Custom Key User - How to use characteristics of the request user agent in the cache key.
-
Ruleset
Rule Action Parameters Cache Key Custom Key Cookie - Which cookies to include in the cache key.
- header
Ruleset
Rule Action Parameters Cache Key Custom Key Header - Which headers to include in the cache key.
- host
Ruleset
Rule Action Parameters Cache Key Custom Key Host - How to use the host in the cache key.
- query
String RulesetRule Action Parameters Cache Key Custom Key Query String - Which query string parameters to include in or exclude from the cache key.
- user
Ruleset
Rule Action Parameters Cache Key Custom Key User - How to use characteristics of the request user agent in the cache key.
-
Ruleset
Rule Action Parameters Cache Key Custom Key Cookie - Which cookies to include in the cache key.
- header
Ruleset
Rule Action Parameters Cache Key Custom Key Header - Which headers to include in the cache key.
- host
Ruleset
Rule Action Parameters Cache Key Custom Key Host - How to use the host in the cache key.
- query_
string RulesetRule Action Parameters Cache Key Custom Key Query String - Which query string parameters to include in or exclude from the cache key.
- user
Ruleset
Rule Action Parameters Cache Key Custom Key User - How to use characteristics of the request user agent in the cache key.
- Property Map
- Which cookies to include in the cache key.
- header Property Map
- Which headers to include in the cache key.
- host Property Map
- How to use the host in the cache key.
- query
String Property Map - Which query string parameters to include in or exclude from the cache key.
- user Property Map
- How to use characteristics of the request user agent in the cache key.
RulesetRuleActionParametersCacheKeyCustomKeyCookie, RulesetRuleActionParametersCacheKeyCustomKeyCookieArgs
- Check
Presences List<string> - A list of cookies to check for the presence of. The presence of these cookies is included in the cache key.
- Includes List<string>
- A list of cookies to include in the cache key.
- Check
Presences []string - A list of cookies to check for the presence of. The presence of these cookies is included in the cache key.
- Includes []string
- A list of cookies to include in the cache key.
- check
Presences List<String> - A list of cookies to check for the presence of. The presence of these cookies is included in the cache key.
- includes List<String>
- A list of cookies to include in the cache key.
- check
Presences string[] - A list of cookies to check for the presence of. The presence of these cookies is included in the cache key.
- includes string[]
- A list of cookies to include in the cache key.
- check_
presences Sequence[str] - A list of cookies to check for the presence of. The presence of these cookies is included in the cache key.
- includes Sequence[str]
- A list of cookies to include in the cache key.
- check
Presences List<String> - A list of cookies to check for the presence of. The presence of these cookies is included in the cache key.
- includes List<String>
- A list of cookies to include in the cache key.
RulesetRuleActionParametersCacheKeyCustomKeyHeader, RulesetRuleActionParametersCacheKeyCustomKeyHeaderArgs
- Check
Presences List<string> - A list of headers to check for the presence of. The presence of these headers is included in the cache key.
- Contains
Dictionary<string, Immutable
Array<string>> - A mapping of header names to a list of values. If a header is present in the request and contains any of the values provided, its value is included in the cache key.
- Exclude
Origin bool - Whether to exclude the origin header in the cache key.
- Includes List<string>
- A list of headers to include in the cache key.
- Check
Presences []string - A list of headers to check for the presence of. The presence of these headers is included in the cache key.
- Contains map[string][]string
- A mapping of header names to a list of values. If a header is present in the request and contains any of the values provided, its value is included in the cache key.
- Exclude
Origin bool - Whether to exclude the origin header in the cache key.
- Includes []string
- A list of headers to include in the cache key.
- check
Presences List<String> - A list of headers to check for the presence of. The presence of these headers is included in the cache key.
- contains Map<String,List<String>>
- A mapping of header names to a list of values. If a header is present in the request and contains any of the values provided, its value is included in the cache key.
- exclude
Origin Boolean - Whether to exclude the origin header in the cache key.
- includes List<String>
- A list of headers to include in the cache key.
- check
Presences string[] - A list of headers to check for the presence of. The presence of these headers is included in the cache key.
- contains {[key: string]: string[]}
- A mapping of header names to a list of values. If a header is present in the request and contains any of the values provided, its value is included in the cache key.
- exclude
Origin boolean - Whether to exclude the origin header in the cache key.
- includes string[]
- A list of headers to include in the cache key.
- check_
presences Sequence[str] - A list of headers to check for the presence of. The presence of these headers is included in the cache key.
- contains Mapping[str, Sequence[str]]
- A mapping of header names to a list of values. If a header is present in the request and contains any of the values provided, its value is included in the cache key.
- exclude_
origin bool - Whether to exclude the origin header in the cache key.
- includes Sequence[str]
- A list of headers to include in the cache key.
- check
Presences List<String> - A list of headers to check for the presence of. The presence of these headers is included in the cache key.
- contains Map<List<String>>
- A mapping of header names to a list of values. If a header is present in the request and contains any of the values provided, its value is included in the cache key.
- exclude
Origin Boolean - Whether to exclude the origin header in the cache key.
- includes List<String>
- A list of headers to include in the cache key.
RulesetRuleActionParametersCacheKeyCustomKeyHost, RulesetRuleActionParametersCacheKeyCustomKeyHostArgs
- Resolved bool
- Whether to use the resolved host in the cache key.
- Resolved bool
- Whether to use the resolved host in the cache key.
- resolved Boolean
- Whether to use the resolved host in the cache key.
- resolved boolean
- Whether to use the resolved host in the cache key.
- resolved bool
- Whether to use the resolved host in the cache key.
- resolved Boolean
- Whether to use the resolved host in the cache key.
RulesetRuleActionParametersCacheKeyCustomKeyQueryString, RulesetRuleActionParametersCacheKeyCustomKeyQueryStringArgs
- Exclude
Ruleset
Rule Action Parameters Cache Key Custom Key Query String Exclude - Which query string parameters to exclude from the cache key.
- Include
Ruleset
Rule Action Parameters Cache Key Custom Key Query String Include - Which query string parameters to include in the cache key.
- Exclude
Ruleset
Rule Action Parameters Cache Key Custom Key Query String Exclude - Which query string parameters to exclude from the cache key.
- Include
Ruleset
Rule Action Parameters Cache Key Custom Key Query String Include - Which query string parameters to include in the cache key.
- exclude
Ruleset
Rule Action Parameters Cache Key Custom Key Query String Exclude - Which query string parameters to exclude from the cache key.
- include
Ruleset
Rule Action Parameters Cache Key Custom Key Query String Include - Which query string parameters to include in the cache key.
- exclude
Ruleset
Rule Action Parameters Cache Key Custom Key Query String Exclude - Which query string parameters to exclude from the cache key.
- include
Ruleset
Rule Action Parameters Cache Key Custom Key Query String Include - Which query string parameters to include in the cache key.
- exclude
Ruleset
Rule Action Parameters Cache Key Custom Key Query String Exclude - Which query string parameters to exclude from the cache key.
- include
Ruleset
Rule Action Parameters Cache Key Custom Key Query String Include - Which query string parameters to include in the cache key.
- exclude Property Map
- Which query string parameters to exclude from the cache key.
- include Property Map
- Which query string parameters to include in the cache key.
RulesetRuleActionParametersCacheKeyCustomKeyQueryStringExclude, RulesetRuleActionParametersCacheKeyCustomKeyQueryStringExcludeArgs
RulesetRuleActionParametersCacheKeyCustomKeyQueryStringInclude, RulesetRuleActionParametersCacheKeyCustomKeyQueryStringIncludeArgs
RulesetRuleActionParametersCacheKeyCustomKeyUser, RulesetRuleActionParametersCacheKeyCustomKeyUserArgs
- Device
Type bool - Whether to use the user agent's device type in the cache key.
- Geo bool
- Whether to use the user agents's country in the cache key.
- Lang bool
- Whether to use the user agent's language in the cache key.
- Device
Type bool - Whether to use the user agent's device type in the cache key.
- Geo bool
- Whether to use the user agents's country in the cache key.
- Lang bool
- Whether to use the user agent's language in the cache key.
- device
Type Boolean - Whether to use the user agent's device type in the cache key.
- geo Boolean
- Whether to use the user agents's country in the cache key.
- lang Boolean
- Whether to use the user agent's language in the cache key.
- device
Type boolean - Whether to use the user agent's device type in the cache key.
- geo boolean
- Whether to use the user agents's country in the cache key.
- lang boolean
- Whether to use the user agent's language in the cache key.
- device_
type bool - Whether to use the user agent's device type in the cache key.
- geo bool
- Whether to use the user agents's country in the cache key.
- lang bool
- Whether to use the user agent's language in the cache key.
- device
Type Boolean - Whether to use the user agent's device type in the cache key.
- geo Boolean
- Whether to use the user agents's country in the cache key.
- lang Boolean
- Whether to use the user agent's language in the cache key.
RulesetRuleActionParametersCacheReserve, RulesetRuleActionParametersCacheReserveArgs
- Eligible bool
- Whether Cache Reserve is enabled. If this is true and a request meets eligibility criteria, Cloudflare will write the resource to Cache Reserve.
- Minimum
File intSize - The minimum file size eligible for storage in Cache Reserve.
- Eligible bool
- Whether Cache Reserve is enabled. If this is true and a request meets eligibility criteria, Cloudflare will write the resource to Cache Reserve.
- Minimum
File intSize - The minimum file size eligible for storage in Cache Reserve.
- eligible Boolean
- Whether Cache Reserve is enabled. If this is true and a request meets eligibility criteria, Cloudflare will write the resource to Cache Reserve.
- minimum
File IntegerSize - The minimum file size eligible for storage in Cache Reserve.
- eligible boolean
- Whether Cache Reserve is enabled. If this is true and a request meets eligibility criteria, Cloudflare will write the resource to Cache Reserve.
- minimum
File numberSize - The minimum file size eligible for storage in Cache Reserve.
- eligible bool
- Whether Cache Reserve is enabled. If this is true and a request meets eligibility criteria, Cloudflare will write the resource to Cache Reserve.
- minimum_
file_ intsize - The minimum file size eligible for storage in Cache Reserve.
- eligible Boolean
- Whether Cache Reserve is enabled. If this is true and a request meets eligibility criteria, Cloudflare will write the resource to Cache Reserve.
- minimum
File NumberSize - The minimum file size eligible for storage in Cache Reserve.
RulesetRuleActionParametersCookieField, RulesetRuleActionParametersCookieFieldArgs
- Name string
- The name of the cookie.
- Name string
- The name of the cookie.
- name String
- The name of the cookie.
- name string
- The name of the cookie.
- name str
- The name of the cookie.
- name String
- The name of the cookie.
RulesetRuleActionParametersEdgeTtl, RulesetRuleActionParametersEdgeTtlArgs
- Mode string
- The edge TTL mode. Available values: "respectorigin", "bypassbydefault", "overrideorigin".
- Default int
- The edge TTL (in seconds) if you choose the "override_origin" mode.
- Status
Code List<RulesetTtls Rule Action Parameters Edge Ttl Status Code Ttl> - A list of TTLs to apply to specific status codes or status code ranges.
- Mode string
- The edge TTL mode. Available values: "respectorigin", "bypassbydefault", "overrideorigin".
- Default int
- The edge TTL (in seconds) if you choose the "override_origin" mode.
- Status
Code []RulesetTtls Rule Action Parameters Edge Ttl Status Code Ttl - A list of TTLs to apply to specific status codes or status code ranges.
- mode String
- The edge TTL mode. Available values: "respectorigin", "bypassbydefault", "overrideorigin".
- default_ Integer
- The edge TTL (in seconds) if you choose the "override_origin" mode.
- status
Code List<RulesetTtls Rule Action Parameters Edge Ttl Status Code Ttl> - A list of TTLs to apply to specific status codes or status code ranges.
- mode string
- The edge TTL mode. Available values: "respectorigin", "bypassbydefault", "overrideorigin".
- default number
- The edge TTL (in seconds) if you choose the "override_origin" mode.
- status
Code RulesetTtls Rule Action Parameters Edge Ttl Status Code Ttl[] - A list of TTLs to apply to specific status codes or status code ranges.
- mode str
- The edge TTL mode. Available values: "respectorigin", "bypassbydefault", "overrideorigin".
- default int
- The edge TTL (in seconds) if you choose the "override_origin" mode.
- status_
code_ Sequence[Rulesetttls Rule Action Parameters Edge Ttl Status Code Ttl] - A list of TTLs to apply to specific status codes or status code ranges.
- mode String
- The edge TTL mode. Available values: "respectorigin", "bypassbydefault", "overrideorigin".
- default Number
- The edge TTL (in seconds) if you choose the "override_origin" mode.
- status
Code List<Property Map>Ttls - A list of TTLs to apply to specific status codes or status code ranges.
RulesetRuleActionParametersEdgeTtlStatusCodeTtl, RulesetRuleActionParametersEdgeTtlStatusCodeTtlArgs
- Value int
- The time to cache the response for (in seconds). A value of 0 is equivalent to setting the cache control header with the value "no-cache". A value of -1 is equivalent to setting the cache control header with the value of "no-store".
- Status
Code int - A single status code to apply the TTL to.
- Status
Code RulesetRange Rule Action Parameters Edge Ttl Status Code Ttl Status Code Range - A range of status codes to apply the TTL to.
- Value int
- The time to cache the response for (in seconds). A value of 0 is equivalent to setting the cache control header with the value "no-cache". A value of -1 is equivalent to setting the cache control header with the value of "no-store".
- Status
Code int - A single status code to apply the TTL to.
- Status
Code RulesetRange Rule Action Parameters Edge Ttl Status Code Ttl Status Code Range - A range of status codes to apply the TTL to.
- value Integer
- The time to cache the response for (in seconds). A value of 0 is equivalent to setting the cache control header with the value "no-cache". A value of -1 is equivalent to setting the cache control header with the value of "no-store".
- status
Code Integer - A single status code to apply the TTL to.
- status
Code RulesetRange Rule Action Parameters Edge Ttl Status Code Ttl Status Code Range - A range of status codes to apply the TTL to.
- value number
- The time to cache the response for (in seconds). A value of 0 is equivalent to setting the cache control header with the value "no-cache". A value of -1 is equivalent to setting the cache control header with the value of "no-store".
- status
Code number - A single status code to apply the TTL to.
- status
Code RulesetRange Rule Action Parameters Edge Ttl Status Code Ttl Status Code Range - A range of status codes to apply the TTL to.
- value int
- The time to cache the response for (in seconds). A value of 0 is equivalent to setting the cache control header with the value "no-cache". A value of -1 is equivalent to setting the cache control header with the value of "no-store".
- status_
code int - A single status code to apply the TTL to.
- status_
code_ Rulesetrange Rule Action Parameters Edge Ttl Status Code Ttl Status Code Range - A range of status codes to apply the TTL to.
- value Number
- The time to cache the response for (in seconds). A value of 0 is equivalent to setting the cache control header with the value "no-cache". A value of -1 is equivalent to setting the cache control header with the value of "no-store".
- status
Code Number - A single status code to apply the TTL to.
- status
Code Property MapRange - A range of status codes to apply the TTL to.
RulesetRuleActionParametersEdgeTtlStatusCodeTtlStatusCodeRange, RulesetRuleActionParametersEdgeTtlStatusCodeTtlStatusCodeRangeArgs
RulesetRuleActionParametersFromList, RulesetRuleActionParametersFromListArgs
RulesetRuleActionParametersFromValue, RulesetRuleActionParametersFromValueArgs
- Target
Url RulesetRule Action Parameters From Value Target Url - A URL to redirect the request to.
- Preserve
Query boolString - Whether to keep the query string of the original request.
- Status
Code int - The status code to use for the redirect.
- Target
Url RulesetRule Action Parameters From Value Target Url - A URL to redirect the request to.
- Preserve
Query boolString - Whether to keep the query string of the original request.
- Status
Code int - The status code to use for the redirect.
- target
Url RulesetRule Action Parameters From Value Target Url - A URL to redirect the request to.
- preserve
Query BooleanString - Whether to keep the query string of the original request.
- status
Code Integer - The status code to use for the redirect.
- target
Url RulesetRule Action Parameters From Value Target Url - A URL to redirect the request to.
- preserve
Query booleanString - Whether to keep the query string of the original request.
- status
Code number - The status code to use for the redirect.
- target_
url RulesetRule Action Parameters From Value Target Url - A URL to redirect the request to.
- preserve_
query_ boolstring - Whether to keep the query string of the original request.
- status_
code int - The status code to use for the redirect.
- target
Url Property Map - A URL to redirect the request to.
- preserve
Query BooleanString - Whether to keep the query string of the original request.
- status
Code Number - The status code to use for the redirect.
RulesetRuleActionParametersFromValueTargetUrl, RulesetRuleActionParametersFromValueTargetUrlArgs
- Expression string
- An expression that evaluates to a URL to redirect the request to.
- Value string
- A URL to redirect the request to.
- Expression string
- An expression that evaluates to a URL to redirect the request to.
- Value string
- A URL to redirect the request to.
- expression String
- An expression that evaluates to a URL to redirect the request to.
- value String
- A URL to redirect the request to.
- expression string
- An expression that evaluates to a URL to redirect the request to.
- value string
- A URL to redirect the request to.
- expression str
- An expression that evaluates to a URL to redirect the request to.
- value str
- A URL to redirect the request to.
- expression String
- An expression that evaluates to a URL to redirect the request to.
- value String
- A URL to redirect the request to.
RulesetRuleActionParametersHeaders, RulesetRuleActionParametersHeadersArgs
- Operation string
- The operation to perform on the header. Available values: "add", "set", "remove".
- Expression string
- An expression that evaluates to a value for the header.
- Value string
- A static value for the header.
- Operation string
- The operation to perform on the header. Available values: "add", "set", "remove".
- Expression string
- An expression that evaluates to a value for the header.
- Value string
- A static value for the header.
- operation String
- The operation to perform on the header. Available values: "add", "set", "remove".
- expression String
- An expression that evaluates to a value for the header.
- value String
- A static value for the header.
- operation string
- The operation to perform on the header. Available values: "add", "set", "remove".
- expression string
- An expression that evaluates to a value for the header.
- value string
- A static value for the header.
- operation str
- The operation to perform on the header. Available values: "add", "set", "remove".
- expression str
- An expression that evaluates to a value for the header.
- value str
- A static value for the header.
- operation String
- The operation to perform on the header. Available values: "add", "set", "remove".
- expression String
- An expression that evaluates to a value for the header.
- value String
- A static value for the header.
RulesetRuleActionParametersMatchedData, RulesetRuleActionParametersMatchedDataArgs
- Public
Key string - The public key to encrypt matched data logs with.
- Public
Key string - The public key to encrypt matched data logs with.
- public
Key String - The public key to encrypt matched data logs with.
- public
Key string - The public key to encrypt matched data logs with.
- public_
key str - The public key to encrypt matched data logs with.
- public
Key String - The public key to encrypt matched data logs with.
RulesetRuleActionParametersOrigin, RulesetRuleActionParametersOriginArgs
RulesetRuleActionParametersOverrides, RulesetRuleActionParametersOverridesArgs
- Action string
- An action to override all rules with. This option has lower precedence than rule and category overrides.
- Categories
List<Ruleset
Rule Action Parameters Overrides Category> - A list of category-level overrides. This option has the second-highest precedence after rule-level overrides.
- Enabled bool
- Whether to enable execution of all rules. This option has lower precedence than rule and category overrides.
- Rules
List<Ruleset
Rule Action Parameters Overrides Rule> - A list of rule-level overrides. This option has the highest precedence.
- Sensitivity
Level string - A sensitivity level to set for all rules. This option has lower precedence than rule and category overrides and is only applicable for DDoS phases. Available values: "default", "medium", "low", "eoff".
- Action string
- An action to override all rules with. This option has lower precedence than rule and category overrides.
- Categories
[]Ruleset
Rule Action Parameters Overrides Category - A list of category-level overrides. This option has the second-highest precedence after rule-level overrides.
- Enabled bool
- Whether to enable execution of all rules. This option has lower precedence than rule and category overrides.
- Rules
[]Ruleset
Rule Action Parameters Overrides Rule - A list of rule-level overrides. This option has the highest precedence.
- Sensitivity
Level string - A sensitivity level to set for all rules. This option has lower precedence than rule and category overrides and is only applicable for DDoS phases. Available values: "default", "medium", "low", "eoff".
- action String
- An action to override all rules with. This option has lower precedence than rule and category overrides.
- categories
List<Ruleset
Rule Action Parameters Overrides Category> - A list of category-level overrides. This option has the second-highest precedence after rule-level overrides.
- enabled Boolean
- Whether to enable execution of all rules. This option has lower precedence than rule and category overrides.
- rules
List<Ruleset
Rule Action Parameters Overrides Rule> - A list of rule-level overrides. This option has the highest precedence.
- sensitivity
Level String - A sensitivity level to set for all rules. This option has lower precedence than rule and category overrides and is only applicable for DDoS phases. Available values: "default", "medium", "low", "eoff".
- action string
- An action to override all rules with. This option has lower precedence than rule and category overrides.
- categories
Ruleset
Rule Action Parameters Overrides Category[] - A list of category-level overrides. This option has the second-highest precedence after rule-level overrides.
- enabled boolean
- Whether to enable execution of all rules. This option has lower precedence than rule and category overrides.
- rules
Ruleset
Rule Action Parameters Overrides Rule[] - A list of rule-level overrides. This option has the highest precedence.
- sensitivity
Level string - A sensitivity level to set for all rules. This option has lower precedence than rule and category overrides and is only applicable for DDoS phases. Available values: "default", "medium", "low", "eoff".
- action str
- An action to override all rules with. This option has lower precedence than rule and category overrides.
- categories
Sequence[Ruleset
Rule Action Parameters Overrides Category] - A list of category-level overrides. This option has the second-highest precedence after rule-level overrides.
- enabled bool
- Whether to enable execution of all rules. This option has lower precedence than rule and category overrides.
- rules
Sequence[Ruleset
Rule Action Parameters Overrides Rule] - A list of rule-level overrides. This option has the highest precedence.
- sensitivity_
level str - A sensitivity level to set for all rules. This option has lower precedence than rule and category overrides and is only applicable for DDoS phases. Available values: "default", "medium", "low", "eoff".
- action String
- An action to override all rules with. This option has lower precedence than rule and category overrides.
- categories List<Property Map>
- A list of category-level overrides. This option has the second-highest precedence after rule-level overrides.
- enabled Boolean
- Whether to enable execution of all rules. This option has lower precedence than rule and category overrides.
- rules List<Property Map>
- A list of rule-level overrides. This option has the highest precedence.
- sensitivity
Level String - A sensitivity level to set for all rules. This option has lower precedence than rule and category overrides and is only applicable for DDoS phases. Available values: "default", "medium", "low", "eoff".
RulesetRuleActionParametersOverridesCategory, RulesetRuleActionParametersOverridesCategoryArgs
- Category string
- The name of the category to override.
- Action string
- The action to override rules in the category with.
- Enabled bool
- Whether to enable execution of rules in the category.
- Sensitivity
Level string - The sensitivity level to use for rules in the category. This option is only applicable for DDoS phases. Available values: "default", "medium", "low", "eoff".
- Category string
- The name of the category to override.
- Action string
- The action to override rules in the category with.
- Enabled bool
- Whether to enable execution of rules in the category.
- Sensitivity
Level string - The sensitivity level to use for rules in the category. This option is only applicable for DDoS phases. Available values: "default", "medium", "low", "eoff".
- category String
- The name of the category to override.
- action String
- The action to override rules in the category with.
- enabled Boolean
- Whether to enable execution of rules in the category.
- sensitivity
Level String - The sensitivity level to use for rules in the category. This option is only applicable for DDoS phases. Available values: "default", "medium", "low", "eoff".
- category string
- The name of the category to override.
- action string
- The action to override rules in the category with.
- enabled boolean
- Whether to enable execution of rules in the category.
- sensitivity
Level string - The sensitivity level to use for rules in the category. This option is only applicable for DDoS phases. Available values: "default", "medium", "low", "eoff".
- category str
- The name of the category to override.
- action str
- The action to override rules in the category with.
- enabled bool
- Whether to enable execution of rules in the category.
- sensitivity_
level str - The sensitivity level to use for rules in the category. This option is only applicable for DDoS phases. Available values: "default", "medium", "low", "eoff".
- category String
- The name of the category to override.
- action String
- The action to override rules in the category with.
- enabled Boolean
- Whether to enable execution of rules in the category.
- sensitivity
Level String - The sensitivity level to use for rules in the category. This option is only applicable for DDoS phases. Available values: "default", "medium", "low", "eoff".
RulesetRuleActionParametersOverridesRule, RulesetRuleActionParametersOverridesRuleArgs
- Id string
- The ID of the rule to override.
- Action string
- The action to override the rule with.
- Enabled bool
- Whether to enable execution of the rule.
- Score
Threshold int - The score threshold to use for the rule.
- Sensitivity
Level string - The sensitivity level to use for the rule. This option is only applicable for DDoS phases. Available values: "default", "medium", "low", "eoff".
- Id string
- The ID of the rule to override.
- Action string
- The action to override the rule with.
- Enabled bool
- Whether to enable execution of the rule.
- Score
Threshold int - The score threshold to use for the rule.
- Sensitivity
Level string - The sensitivity level to use for the rule. This option is only applicable for DDoS phases. Available values: "default", "medium", "low", "eoff".
- id String
- The ID of the rule to override.
- action String
- The action to override the rule with.
- enabled Boolean
- Whether to enable execution of the rule.
- score
Threshold Integer - The score threshold to use for the rule.
- sensitivity
Level String - The sensitivity level to use for the rule. This option is only applicable for DDoS phases. Available values: "default", "medium", "low", "eoff".
- id string
- The ID of the rule to override.
- action string
- The action to override the rule with.
- enabled boolean
- Whether to enable execution of the rule.
- score
Threshold number - The score threshold to use for the rule.
- sensitivity
Level string - The sensitivity level to use for the rule. This option is only applicable for DDoS phases. Available values: "default", "medium", "low", "eoff".
- id str
- The ID of the rule to override.
- action str
- The action to override the rule with.
- enabled bool
- Whether to enable execution of the rule.
- score_
threshold int - The score threshold to use for the rule.
- sensitivity_
level str - The sensitivity level to use for the rule. This option is only applicable for DDoS phases. Available values: "default", "medium", "low", "eoff".
- id String
- The ID of the rule to override.
- action String
- The action to override the rule with.
- enabled Boolean
- Whether to enable execution of the rule.
- score
Threshold Number - The score threshold to use for the rule.
- sensitivity
Level String - The sensitivity level to use for the rule. This option is only applicable for DDoS phases. Available values: "default", "medium", "low", "eoff".
RulesetRuleActionParametersRawResponseField, RulesetRuleActionParametersRawResponseFieldArgs
- Name string
- The name of the response header.
- Preserve
Duplicates bool - Whether to log duplicate values of the same header.
- Name string
- The name of the response header.
- Preserve
Duplicates bool - Whether to log duplicate values of the same header.
- name String
- The name of the response header.
- preserve
Duplicates Boolean - Whether to log duplicate values of the same header.
- name string
- The name of the response header.
- preserve
Duplicates boolean - Whether to log duplicate values of the same header.
- name str
- The name of the response header.
- preserve_
duplicates bool - Whether to log duplicate values of the same header.
- name String
- The name of the response header.
- preserve
Duplicates Boolean - Whether to log duplicate values of the same header.
RulesetRuleActionParametersRequestField, RulesetRuleActionParametersRequestFieldArgs
- Name string
- The name of the header.
- Name string
- The name of the header.
- name String
- The name of the header.
- name string
- The name of the header.
- name str
- The name of the header.
- name String
- The name of the header.
RulesetRuleActionParametersResponse, RulesetRuleActionParametersResponseArgs
- Content string
- The content to return.
- Content
Type string - The type of the content to return.
- Status
Code int - The status code to return.
- Content string
- The content to return.
- Content
Type string - The type of the content to return.
- Status
Code int - The status code to return.
- content String
- The content to return.
- content
Type String - The type of the content to return.
- status
Code Integer - The status code to return.
- content string
- The content to return.
- content
Type string - The type of the content to return.
- status
Code number - The status code to return.
- content str
- The content to return.
- content_
type str - The type of the content to return.
- status_
code int - The status code to return.
- content String
- The content to return.
- content
Type String - The type of the content to return.
- status
Code Number - The status code to return.
RulesetRuleActionParametersResponseField, RulesetRuleActionParametersResponseFieldArgs
- Name string
- The name of the response header.
- Preserve
Duplicates bool - Whether to log duplicate values of the same header.
- Name string
- The name of the response header.
- Preserve
Duplicates bool - Whether to log duplicate values of the same header.
- name String
- The name of the response header.
- preserve
Duplicates Boolean - Whether to log duplicate values of the same header.
- name string
- The name of the response header.
- preserve
Duplicates boolean - Whether to log duplicate values of the same header.
- name str
- The name of the response header.
- preserve_
duplicates bool - Whether to log duplicate values of the same header.
- name String
- The name of the response header.
- preserve
Duplicates Boolean - Whether to log duplicate values of the same header.
RulesetRuleActionParametersServeStale, RulesetRuleActionParametersServeStaleArgs
- Disable
Stale boolWhile Updating - Whether Cloudflare should disable serving stale content while getting the latest content from the origin.
- Disable
Stale boolWhile Updating - Whether Cloudflare should disable serving stale content while getting the latest content from the origin.
- disable
Stale BooleanWhile Updating - Whether Cloudflare should disable serving stale content while getting the latest content from the origin.
- disable
Stale booleanWhile Updating - Whether Cloudflare should disable serving stale content while getting the latest content from the origin.
- disable_
stale_ boolwhile_ updating - Whether Cloudflare should disable serving stale content while getting the latest content from the origin.
- disable
Stale BooleanWhile Updating - Whether Cloudflare should disable serving stale content while getting the latest content from the origin.
RulesetRuleActionParametersSni, RulesetRuleActionParametersSniArgs
- Value string
- A value to override the SNI to.
- Value string
- A value to override the SNI to.
- value String
- A value to override the SNI to.
- value string
- A value to override the SNI to.
- value str
- A value to override the SNI to.
- value String
- A value to override the SNI to.
RulesetRuleActionParametersTransformedRequestField, RulesetRuleActionParametersTransformedRequestFieldArgs
- Name string
- The name of the header.
- Name string
- The name of the header.
- name String
- The name of the header.
- name string
- The name of the header.
- name str
- The name of the header.
- name String
- The name of the header.
RulesetRuleActionParametersUri, RulesetRuleActionParametersUriArgs
- Path
Ruleset
Rule Action Parameters Uri Path - A URI path rewrite.
- Query
Ruleset
Rule Action Parameters Uri Query - A URI query rewrite.
- Path
Ruleset
Rule Action Parameters Uri Path - A URI path rewrite.
- Query
Ruleset
Rule Action Parameters Uri Query - A URI query rewrite.
- path
Ruleset
Rule Action Parameters Uri Path - A URI path rewrite.
- query
Ruleset
Rule Action Parameters Uri Query - A URI query rewrite.
- path
Ruleset
Rule Action Parameters Uri Path - A URI path rewrite.
- query
Ruleset
Rule Action Parameters Uri Query - A URI query rewrite.
- path
Ruleset
Rule Action Parameters Uri Path - A URI path rewrite.
- query
Ruleset
Rule Action Parameters Uri Query - A URI query rewrite.
- path Property Map
- A URI path rewrite.
- query Property Map
- A URI query rewrite.
RulesetRuleActionParametersUriPath, RulesetRuleActionParametersUriPathArgs
- Expression string
- An expression that evaluates to a value to rewrite the URI path to.
- Value string
- A value to rewrite the URI path to.
- Expression string
- An expression that evaluates to a value to rewrite the URI path to.
- Value string
- A value to rewrite the URI path to.
- expression String
- An expression that evaluates to a value to rewrite the URI path to.
- value String
- A value to rewrite the URI path to.
- expression string
- An expression that evaluates to a value to rewrite the URI path to.
- value string
- A value to rewrite the URI path to.
- expression str
- An expression that evaluates to a value to rewrite the URI path to.
- value str
- A value to rewrite the URI path to.
- expression String
- An expression that evaluates to a value to rewrite the URI path to.
- value String
- A value to rewrite the URI path to.
RulesetRuleActionParametersUriQuery, RulesetRuleActionParametersUriQueryArgs
- Expression string
- An expression that evaluates to a value to rewrite the URI query to.
- Value string
- A value to rewrite the URI query to.
- Expression string
- An expression that evaluates to a value to rewrite the URI query to.
- Value string
- A value to rewrite the URI query to.
- expression String
- An expression that evaluates to a value to rewrite the URI query to.
- value String
- A value to rewrite the URI query to.
- expression string
- An expression that evaluates to a value to rewrite the URI query to.
- value string
- A value to rewrite the URI query to.
- expression str
- An expression that evaluates to a value to rewrite the URI query to.
- value str
- A value to rewrite the URI query to.
- expression String
- An expression that evaluates to a value to rewrite the URI query to.
- value String
- A value to rewrite the URI query to.
RulesetRuleExposedCredentialCheck, RulesetRuleExposedCredentialCheckArgs
- Password
Expression string - An expression that selects the password used in the credentials check.
- Username
Expression string - An expression that selects the user ID used in the credentials check.
- Password
Expression string - An expression that selects the password used in the credentials check.
- Username
Expression string - An expression that selects the user ID used in the credentials check.
- password
Expression String - An expression that selects the password used in the credentials check.
- username
Expression String - An expression that selects the user ID used in the credentials check.
- password
Expression string - An expression that selects the password used in the credentials check.
- username
Expression string - An expression that selects the user ID used in the credentials check.
- password_
expression str - An expression that selects the password used in the credentials check.
- username_
expression str - An expression that selects the user ID used in the credentials check.
- password
Expression String - An expression that selects the password used in the credentials check.
- username
Expression String - An expression that selects the user ID used in the credentials check.
RulesetRuleLogging, RulesetRuleLoggingArgs
- Enabled bool
- Whether to generate a log when the rule matches.
- Enabled bool
- Whether to generate a log when the rule matches.
- enabled Boolean
- Whether to generate a log when the rule matches.
- enabled boolean
- Whether to generate a log when the rule matches.
- enabled bool
- Whether to generate a log when the rule matches.
- enabled Boolean
- Whether to generate a log when the rule matches.
RulesetRuleRatelimit, RulesetRuleRatelimitArgs
- Characteristics List<string>
- Characteristics of the request on which the rate limit counter will be incremented.
- Period int
- Period in seconds over which the counter is being incremented.
- Counting
Expression string - An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule's expression.
- Mitigation
Timeout int - Period of time in seconds after which the action will be disabled following its first execution.
- Requests
Per intPeriod - The threshold of requests per period after which the action will be executed for the first time.
- Requests
To boolOrigin - Whether counting is only performed when an origin is reached.
- Score
Per intPeriod - The score threshold per period for which the action will be executed the first time.
- Score
Response stringHeader Name - A response header name provided by the origin, which contains the score to increment rate limit counter with.
- Characteristics []string
- Characteristics of the request on which the rate limit counter will be incremented.
- Period int
- Period in seconds over which the counter is being incremented.
- Counting
Expression string - An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule's expression.
- Mitigation
Timeout int - Period of time in seconds after which the action will be disabled following its first execution.
- Requests
Per intPeriod - The threshold of requests per period after which the action will be executed for the first time.
- Requests
To boolOrigin - Whether counting is only performed when an origin is reached.
- Score
Per intPeriod - The score threshold per period for which the action will be executed the first time.
- Score
Response stringHeader Name - A response header name provided by the origin, which contains the score to increment rate limit counter with.
- characteristics List<String>
- Characteristics of the request on which the rate limit counter will be incremented.
- period Integer
- Period in seconds over which the counter is being incremented.
- counting
Expression String - An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule's expression.
- mitigation
Timeout Integer - Period of time in seconds after which the action will be disabled following its first execution.
- requests
Per IntegerPeriod - The threshold of requests per period after which the action will be executed for the first time.
- requests
To BooleanOrigin - Whether counting is only performed when an origin is reached.
- score
Per IntegerPeriod - The score threshold per period for which the action will be executed the first time.
- score
Response StringHeader Name - A response header name provided by the origin, which contains the score to increment rate limit counter with.
- characteristics string[]
- Characteristics of the request on which the rate limit counter will be incremented.
- period number
- Period in seconds over which the counter is being incremented.
- counting
Expression string - An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule's expression.
- mitigation
Timeout number - Period of time in seconds after which the action will be disabled following its first execution.
- requests
Per numberPeriod - The threshold of requests per period after which the action will be executed for the first time.
- requests
To booleanOrigin - Whether counting is only performed when an origin is reached.
- score
Per numberPeriod - The score threshold per period for which the action will be executed the first time.
- score
Response stringHeader Name - A response header name provided by the origin, which contains the score to increment rate limit counter with.
- characteristics Sequence[str]
- Characteristics of the request on which the rate limit counter will be incremented.
- period int
- Period in seconds over which the counter is being incremented.
- counting_
expression str - An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule's expression.
- mitigation_
timeout int - Period of time in seconds after which the action will be disabled following its first execution.
- requests_
per_ intperiod - The threshold of requests per period after which the action will be executed for the first time.
- requests_
to_ boolorigin - Whether counting is only performed when an origin is reached.
- score_
per_ intperiod - The score threshold per period for which the action will be executed the first time.
- score_
response_ strheader_ name - A response header name provided by the origin, which contains the score to increment rate limit counter with.
- characteristics List<String>
- Characteristics of the request on which the rate limit counter will be incremented.
- period Number
- Period in seconds over which the counter is being incremented.
- counting
Expression String - An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule's expression.
- mitigation
Timeout Number - Period of time in seconds after which the action will be disabled following its first execution.
- requests
Per NumberPeriod - The threshold of requests per period after which the action will be executed for the first time.
- requests
To BooleanOrigin - Whether counting is only performed when an origin is reached.
- score
Per NumberPeriod - The score threshold per period for which the action will be executed the first time.
- score
Response StringHeader Name - A response header name provided by the origin, which contains the score to increment rate limit counter with.
Import
$ pulumi import cloudflare:index/ruleset:Ruleset example '<{accounts|zones}/{account_id|zone_id}>/<ruleset_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
cloudflareTerraform Provider.