Docs Home
Cloudflare v6.1.1 published on Monday, Apr 21, 2025 by Pulumi
cloudflare.Ruleset
Explore with Pulumi AI
Example Usage
Coming soon!
Coming soon!
Coming soon!
Coming soon!
Coming soon!
resources:
exampleRuleset:
type: cloudflare:Ruleset
name: example_ruleset
properties:
kind: root
name: My ruleset
phase: http_request_firewall_custom
zoneId: zone_id
description: My ruleset to execute managed rulesets
rules:
- id: 3a03d665bac047339bb530ecb439a90d
action: block
action_parameters:
response:
content: |2
{
"success": false,
"error": "you have been blocked"
}
contentType: application/json
statusCode: 400
description: Block when the IP address is not 1.1.1.1
enabled: true
exposed_credential_check:
passwordExpression: url_decode(http.request.body.form[\"password\"][0])
usernameExpression: url_decode(http.request.body.form[\"username\"][0])
expression: ip.src ne 1.1.1.1
logging:
enabled: true
ratelimit:
characteristics:
- ip.src
period: 60
countingExpression: http.request.body.raw eq "abcd"
mitigationTimeout: 600
requestsPerPeriod: 1000
requestsToOrigin: true
scorePerPeriod: 400
scoreResponseHeaderName: my-score
ref: my_ref
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",
ActionParameters = new Cloudflare.Inputs.RulesetRuleActionParametersArgs
{
AdditionalCacheablePorts = new[]
{
0,
},
Algorithms = new[]
{
new Cloudflare.Inputs.RulesetRuleActionParametersAlgorithmArgs
{
Name = "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
{
PreserveQueryString = false,
StatusCode = 0,
TargetUrl = new Cloudflare.Inputs.RulesetRuleActionParametersFromValueTargetUrlArgs
{
Expression = "string",
Value = "string",
},
},
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",
},
},
},
Categories = new[]
{
"string",
},
Description = "string",
Enabled = false,
ExposedCredentialCheck = new Cloudflare.Inputs.RulesetRuleExposedCredentialCheckArgs
{
PasswordExpression = "string",
UsernameExpression = "string",
},
Expression = "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"),
ActionParameters: &cloudflare.RulesetRuleActionParametersArgs{
AdditionalCacheablePorts: pulumi.IntArray{
pulumi.Int(0),
},
Algorithms: cloudflare.RulesetRuleActionParametersAlgorithmArray{
&cloudflare.RulesetRuleActionParametersAlgorithmArgs{
Name: 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{
PreserveQueryString: pulumi.Bool(false),
StatusCode: pulumi.Float64(0),
TargetUrl: &cloudflare.RulesetRuleActionParametersFromValueTargetUrlArgs{
Expression: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
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.Float64(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.Float64(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"),
},
},
},
Categories: pulumi.StringArray{
pulumi.String("string"),
},
Description: pulumi.String("string"),
Enabled: pulumi.Bool(false),
ExposedCredentialCheck: &cloudflare.RulesetRuleExposedCredentialCheckArgs{
PasswordExpression: pulumi.String("string"),
UsernameExpression: pulumi.String("string"),
},
Expression: 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")
.actionParameters(RulesetRuleActionParametersArgs.builder()
.additionalCacheablePorts(0)
.algorithms(RulesetRuleActionParametersAlgorithmArgs.builder()
.name("string")
.build())
.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()
.preserveQueryString(false)
.statusCode(0)
.targetUrl(RulesetRuleActionParametersFromValueTargetUrlArgs.builder()
.expression("string")
.value("string")
.build())
.build())
.headers(Map.of("string", Map.ofEntries(
Map.entry("operation", "string"),
Map.entry("expression", "string"),
Map.entry("value", "string")
)))
.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())
.categories("string")
.description("string")
.enabled(false)
.exposedCredentialCheck(RulesetRuleExposedCredentialCheckArgs.builder()
.passwordExpression("string")
.usernameExpression("string")
.build())
.expression("string")
.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",
"action_parameters": {
"additional_cacheable_ports": [0],
"algorithms": [{
"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": {
"preserve_query_string": False,
"status_code": 0,
"target_url": {
"expression": "string",
"value": "string",
},
},
"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",
},
},
},
"categories": ["string"],
"description": "string",
"enabled": False,
"exposed_credential_check": {
"password_expression": "string",
"username_expression": "string",
},
"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",
actionParameters: {
additionalCacheablePorts: [0],
algorithms: [{
name: "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: {
preserveQueryString: false,
statusCode: 0,
targetUrl: {
expression: "string",
value: "string",
},
},
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",
},
},
},
categories: ["string"],
description: "string",
enabled: false,
exposedCredentialCheck: {
passwordExpression: "string",
usernameExpression: "string",
},
expression: "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
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
categories:
- 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 Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
- Description string
- An informative description of the ruleset.
- Rules
List<Ruleset
Rule> - The list of rules in the ruleset.
- Zone
Id string - The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
- 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 Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
- Description string
- An informative description of the ruleset.
- Rules
[]Ruleset
Rule Args - The list of rules in the ruleset.
- Zone
Id string - The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
- 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 Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
- description String
- An informative description of the ruleset.
- rules
List<Ruleset
Rule> - The list of rules in the ruleset.
- zone
Id String - The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
- 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 Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
- description string
- An informative description of the ruleset.
- rules
Ruleset
Rule[] - The list of rules in the ruleset.
- zone
Id string - The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
- 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 Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
- description str
- An informative description of the ruleset.
- rules
Sequence[Ruleset
Rule Args] - The list of rules in the ruleset.
- zone_
id str - The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
- 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 Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
- description String
- An informative description of the ruleset.
- rules List<Property Map>
- The list of rules in the ruleset.
- zone
Id String - The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
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.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing 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,
name: Optional[str] = None,
phase: Optional[str] = None,
rules: Optional[Sequence[RulesetRuleArgs]] = 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 Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
- Description string
- An informative description of the ruleset.
- 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".
- Rules
List<Ruleset
Rule> - The list of rules in the ruleset.
- Zone
Id string - The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
- Account
Id string - The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
- Description string
- An informative description of the ruleset.
- 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".
- Rules
[]Ruleset
Rule Args - The list of rules in the ruleset.
- Zone
Id string - The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
- account
Id String - The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
- description String
- An informative description of the ruleset.
- 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".
- rules
List<Ruleset
Rule> - The list of rules in the ruleset.
- zone
Id String - The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
- account
Id string - The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
- description string
- An informative description of the ruleset.
- 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".
- rules
Ruleset
Rule[] - The list of rules in the ruleset.
- zone
Id string - The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
- account_
id str - The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
- description str
- An informative description of the ruleset.
- 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".
- rules
Sequence[Ruleset
Rule Args] - The list of rules in the ruleset.
- zone_
id str - The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
- account
Id String - The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
- description String
- An informative description of the ruleset.
- 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".
- rules List<Property Map>
- The list of rules in the ruleset.
- zone
Id String - The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
Supporting Types
RulesetRule, RulesetRuleArgs
- Action string
- The action to perform when the rule matches. Available values: "block".
- Action
Parameters RulesetRule Action Parameters - The parameters configuring the rule's action.
- Categories List<string>
- The categories of the rule.
- Description string
- An informative description of the rule.
- Enabled bool
- Whether the rule should be executed.
- Exposed
Credential RulesetCheck Rule Exposed Credential Check - Configure checks for exposed credentials.
- Expression string
- The expression defining which traffic will match the rule.
- 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 ratelimit behavior.
- Ref string
- The reference of the rule (the rule ID by default).
- Action string
- The action to perform when the rule matches. Available values: "block".
- Action
Parameters RulesetRule Action Parameters - The parameters configuring the rule's action.
- Categories []string
- The categories of the rule.
- Description string
- An informative description of the rule.
- Enabled bool
- Whether the rule should be executed.
- Exposed
Credential RulesetCheck Rule Exposed Credential Check - Configure checks for exposed credentials.
- Expression string
- The expression defining which traffic will match the rule.
- 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 ratelimit behavior.
- Ref string
- The reference of the rule (the rule ID by default).
- action String
- The action to perform when the rule matches. Available values: "block".
- action
Parameters RulesetRule Action Parameters - The parameters configuring the rule's action.
- categories List<String>
- The categories of the rule.
- description String
- An informative description of the rule.
- enabled Boolean
- Whether the rule should be executed.
- exposed
Credential RulesetCheck Rule Exposed Credential Check - Configure checks for exposed credentials.
- expression String
- The expression defining which traffic will match the rule.
- 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 ratelimit behavior.
- ref String
- The reference of the rule (the rule ID by default).
- action string
- The action to perform when the rule matches. Available values: "block".
- action
Parameters RulesetRule Action Parameters - The parameters configuring the rule's action.
- categories string[]
- The categories of the rule.
- description string
- An informative description of the rule.
- enabled boolean
- Whether the rule should be executed.
- exposed
Credential RulesetCheck Rule Exposed Credential Check - Configure checks for exposed credentials.
- expression string
- The expression defining which traffic will match the rule.
- 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 ratelimit behavior.
- ref string
- The reference of the rule (the rule ID by default).
- action str
- The action to perform when the rule matches. Available values: "block".
- action_
parameters RulesetRule Action Parameters - The parameters configuring the rule's action.
- categories Sequence[str]
- The categories of the rule.
- description str
- An informative description of the rule.
- enabled bool
- Whether the rule should be executed.
- exposed_
credential_ Rulesetcheck Rule Exposed Credential Check - Configure checks for exposed credentials.
- expression str
- The expression defining which traffic will match the rule.
- 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 ratelimit behavior.
- ref str
- The reference of the rule (the rule ID by default).
- action String
- The action to perform when the rule matches. Available values: "block".
- action
Parameters Property Map - The parameters configuring the rule's action.
- categories List<String>
- The categories of the rule.
- description String
- An informative description of the rule.
- enabled Boolean
- Whether the rule should be executed.
- exposed
Credential Property MapCheck - Configure checks for exposed credentials.
- expression String
- The expression defining which traffic will match the rule.
- 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 ratelimit behavior.
- ref String
- The reference of the rule (the rule ID by default).
RulesetRuleActionParameters, RulesetRuleActionParametersArgs
- Additional
Cacheable List<int>Ports - List of additional ports that caching can be enabled on.
- Algorithms
List<Ruleset
Rule Action Parameters Algorithm> - Custom order for compression algorithms.
- Automatic
Https boolRewrites - Turn on or off Automatic HTTPS Rewrites.
- Autominify
Ruleset
Rule Action Parameters Autominify - Select which file extensions to minify automatically.
- Bic bool
- Turn on or off Browser Integrity Check.
- Browser
Ttl RulesetRule Action Parameters Browser Ttl - Specify 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
- Mark whether the request’s response from 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 - Define which components of the request are included or excluded from the cache key Cloudflare uses to store the response in cache.
- Cache
Reserve RulesetRule Action Parameters Cache Reserve - Mark whether the request's response from origin is eligible for Cache Reserve (requires a Cache Reserve add-on plan).
- Content string
- Error response content.
- Content
Type string - Content-type header to set with the response. Available values: "application/json", "text/xml", "text/plain", "text/html".
-
List<Ruleset
Rule Action Parameters Cookie Field> - The cookie fields to log.
- Disable
Apps bool - Turn off all active Cloudflare Apps.
- Disable
Rum bool - Turn off Real User Monitoring (RUM).
- Disable
Zaraz bool - Turn off Zaraz.
- Edge
Ttl RulesetRule Action Parameters Edge Ttl - TTL (Time to Live) specifies the maximum time to cache a resource in the Cloudflare edge network.
- Email
Obfuscation bool - Turn on or off Email Obfuscation.
- Fonts bool
- Turn on or off Cloudflare Fonts.
- From
List RulesetRule Action Parameters From List - Serve a redirect based on a bulk list lookup.
- From
Value RulesetRule Action Parameters From Value - Serve a redirect based on the request properties.
- Headers
Dictionary<string, Ruleset
Rule Action Parameters Headers> - Map of request headers to modify.
- Host
Header string - Rewrite the HTTP Host header.
- Hotlink
Protection bool - Turn on or off the Hotlink Protection.
- Id string
- The ID of the ruleset to execute.
- Increment int
- Increment contains the delta to change the score and can be either positive or negative.
- Matched
Data RulesetRule Action Parameters Matched Data - The configuration to use for matched data logging.
- Mirage bool
- Turn on or off Mirage.
- Opportunistic
Encryption bool - Turn on or off Opportunistic Encryption.
- Origin
Ruleset
Rule Action Parameters Origin - Override the IP/TCP destination.
- Origin
Cache boolControl - When enabled, Cloudflare will aim to strictly adhere to RFC 7234.
- Origin
Error boolPage Passthru - Generate Cloudflare error pages from issues sent from the origin server. When on, error pages will trigger for issues from the origin
- 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 ruleset and rulesets options.
- Polish string
- Configure the Polish level. Available values: "off", "lossless", "lossy".
- Products List<string>
- A list of legacy security products to skip the execution of.
- Raw
Response List<RulesetFields Rule Action Parameters Raw Response Field> - The raw response fields to log.
- Read
Timeout int - Define a timeout value between two successive read operations to 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
- Specify whether or not Cloudflare should respect strong ETag (entity tag) headers. When off, 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 - Turn on or off 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, rules and phases options. 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 - Configure the Security Level. Available values: "off", "essentiallyoff", "low", "medium", "high", "underattack".
- Serve
Stale RulesetRule Action Parameters Serve Stale - Define if Cloudflare should serve stale content while getting the latest content from the origin. If on, Cloudflare will not serve stale content while getting the latest content from the origin.
- Server
Side boolExcludes - Turn on or off Server Side Excludes.
- Sni
Ruleset
Rule Action Parameters Sni - Override the Server Name Indication (SNI).
- Ssl string
- Configure the SSL level. Available values: "off", "flexible", "full", "strict", "origin_pull".
- Status
Code double - The status code to use for the error.
- Sxg bool
- Turn on or off 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 - URI to rewrite the request to.
- Additional
Cacheable []intPorts - List of additional ports that caching can be enabled on.
- Algorithms
[]Ruleset
Rule Action Parameters Algorithm - Custom order for compression algorithms.
- Automatic
Https boolRewrites - Turn on or off Automatic HTTPS Rewrites.
- Autominify
Ruleset
Rule Action Parameters Autominify - Select which file extensions to minify automatically.
- Bic bool
- Turn on or off Browser Integrity Check.
- Browser
Ttl RulesetRule Action Parameters Browser Ttl - Specify 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
- Mark whether the request’s response from 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 - Define which components of the request are included or excluded from the cache key Cloudflare uses to store the response in cache.
- Cache
Reserve RulesetRule Action Parameters Cache Reserve - Mark whether the request's response from origin is eligible for Cache Reserve (requires a Cache Reserve add-on plan).
- Content string
- Error response content.
- Content
Type string - Content-type header to set with the response. Available values: "application/json", "text/xml", "text/plain", "text/html".
-
[]Ruleset
Rule Action Parameters Cookie Field - The cookie fields to log.
- Disable
Apps bool - Turn off all active Cloudflare Apps.
- Disable
Rum bool - Turn off Real User Monitoring (RUM).
- Disable
Zaraz bool - Turn off Zaraz.
- Edge
Ttl RulesetRule Action Parameters Edge Ttl - TTL (Time to Live) specifies the maximum time to cache a resource in the Cloudflare edge network.
- Email
Obfuscation bool - Turn on or off Email Obfuscation.
- Fonts bool
- Turn on or off Cloudflare Fonts.
- From
List RulesetRule Action Parameters From List - Serve a redirect based on a bulk list lookup.
- From
Value RulesetRule Action Parameters From Value - Serve a redirect based on the request properties.
- Headers
map[string]Ruleset
Rule Action Parameters Headers - Map of request headers to modify.
- Host
Header string - Rewrite the HTTP Host header.
- Hotlink
Protection bool - Turn on or off the Hotlink Protection.
- Id string
- The ID of the ruleset to execute.
- Increment int
- Increment contains the delta to change the score and can be either positive or negative.
- Matched
Data RulesetRule Action Parameters Matched Data - The configuration to use for matched data logging.
- Mirage bool
- Turn on or off Mirage.
- Opportunistic
Encryption bool - Turn on or off Opportunistic Encryption.
- Origin
Ruleset
Rule Action Parameters Origin - Override the IP/TCP destination.
- Origin
Cache boolControl - When enabled, Cloudflare will aim to strictly adhere to RFC 7234.
- Origin
Error boolPage Passthru - Generate Cloudflare error pages from issues sent from the origin server. When on, error pages will trigger for issues from the origin
- 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 ruleset and rulesets options.
- Polish string
- Configure the Polish level. Available values: "off", "lossless", "lossy".
- Products []string
- A list of legacy security products to skip the execution of.
- Raw
Response []RulesetFields Rule Action Parameters Raw Response Field - The raw response fields to log.
- Read
Timeout int - Define a timeout value between two successive read operations to 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
- Specify whether or not Cloudflare should respect strong ETag (entity tag) headers. When off, 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 - Turn on or off 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, rules and phases options. 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 - Configure the Security Level. Available values: "off", "essentiallyoff", "low", "medium", "high", "underattack".
- Serve
Stale RulesetRule Action Parameters Serve Stale - Define if Cloudflare should serve stale content while getting the latest content from the origin. If on, Cloudflare will not serve stale content while getting the latest content from the origin.
- Server
Side boolExcludes - Turn on or off Server Side Excludes.
- Sni
Ruleset
Rule Action Parameters Sni - Override the Server Name Indication (SNI).
- Ssl string
- Configure the SSL level. Available values: "off", "flexible", "full", "strict", "origin_pull".
- Status
Code float64 - The status code to use for the error.
- Sxg bool
- Turn on or off Signed Exchanges (SXG).
- Transformed
Request []RulesetFields Rule Action Parameters Transformed Request Field - The transformed request fields to log.
- Uri
Ruleset
Rule Action Parameters Uri - URI to rewrite the request to.
- additional
Cacheable List<Integer>Ports - List of additional ports that caching can be enabled on.
- algorithms
List<Ruleset
Rule Action Parameters Algorithm> - Custom order for compression algorithms.
- automatic
Https BooleanRewrites - Turn on or off Automatic HTTPS Rewrites.
- autominify
Ruleset
Rule Action Parameters Autominify - Select which file extensions to minify automatically.
- bic Boolean
- Turn on or off Browser Integrity Check.
- browser
Ttl RulesetRule Action Parameters Browser Ttl - Specify 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
- Mark whether the request’s response from 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 - Define which components of the request are included or excluded from the cache key Cloudflare uses to store the response in cache.
- cache
Reserve RulesetRule Action Parameters Cache Reserve - Mark whether the request's response from origin is eligible for Cache Reserve (requires a Cache Reserve add-on plan).
- content String
- Error response content.
- content
Type String - Content-type header to set with the response. Available values: "application/json", "text/xml", "text/plain", "text/html".
-
List<Ruleset
Rule Action Parameters Cookie Field> - The cookie fields to log.
- disable
Apps Boolean - Turn off all active Cloudflare Apps.
- disable
Rum Boolean - Turn off Real User Monitoring (RUM).
- disable
Zaraz Boolean - Turn off Zaraz.
- edge
Ttl RulesetRule Action Parameters Edge Ttl - TTL (Time to Live) specifies the maximum time to cache a resource in the Cloudflare edge network.
- email
Obfuscation Boolean - Turn on or off Email Obfuscation.
- fonts Boolean
- Turn on or off Cloudflare Fonts.
- from
List RulesetRule Action Parameters From List - Serve a redirect based on a bulk list lookup.
- from
Value RulesetRule Action Parameters From Value - Serve a redirect based on the request properties.
- headers
Map<String,Ruleset
Rule Action Parameters Headers> - Map of request headers to modify.
- host
Header String - Rewrite the HTTP Host header.
- hotlink
Protection Boolean - Turn on or off the Hotlink Protection.
- id String
- The ID of the ruleset to execute.
- increment Integer
- Increment contains the delta to change the score and can be either positive or negative.
- matched
Data RulesetRule Action Parameters Matched Data - The configuration to use for matched data logging.
- mirage Boolean
- Turn on or off Mirage.
- opportunistic
Encryption Boolean - Turn on or off Opportunistic Encryption.
- origin
Ruleset
Rule Action Parameters Origin - Override the IP/TCP destination.
- origin
Cache BooleanControl - When enabled, Cloudflare will aim to strictly adhere to RFC 7234.
- origin
Error BooleanPage Passthru - Generate Cloudflare error pages from issues sent from the origin server. When on, error pages will trigger for issues from the origin
- 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 ruleset and rulesets options.
- polish String
- Configure the Polish level. Available values: "off", "lossless", "lossy".
- products List<String>
- A list of legacy security products to skip the execution of.
- raw
Response List<RulesetFields Rule Action Parameters Raw Response Field> - The raw response fields to log.
- read
Timeout Integer - Define a timeout value between two successive read operations to 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
- Specify whether or not Cloudflare should respect strong ETag (entity tag) headers. When off, 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 - Turn on or off 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, rules and phases options. 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 - Configure the Security Level. Available values: "off", "essentiallyoff", "low", "medium", "high", "underattack".
- serve
Stale RulesetRule Action Parameters Serve Stale - Define if Cloudflare should serve stale content while getting the latest content from the origin. If on, Cloudflare will not serve stale content while getting the latest content from the origin.
- server
Side BooleanExcludes - Turn on or off Server Side Excludes.
- sni
Ruleset
Rule Action Parameters Sni - Override the Server Name Indication (SNI).
- ssl String
- Configure the SSL level. Available values: "off", "flexible", "full", "strict", "origin_pull".
- status
Code Double - The status code to use for the error.
- sxg Boolean
- Turn on or off 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 - URI to rewrite the request to.
- additional
Cacheable number[]Ports - List of additional ports that caching can be enabled on.
- algorithms
Ruleset
Rule Action Parameters Algorithm[] - Custom order for compression algorithms.
- automatic
Https booleanRewrites - Turn on or off Automatic HTTPS Rewrites.
- autominify
Ruleset
Rule Action Parameters Autominify - Select which file extensions to minify automatically.
- bic boolean
- Turn on or off Browser Integrity Check.
- browser
Ttl RulesetRule Action Parameters Browser Ttl - Specify 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
- Mark whether the request’s response from 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 - Define which components of the request are included or excluded from the cache key Cloudflare uses to store the response in cache.
- cache
Reserve RulesetRule Action Parameters Cache Reserve - Mark whether the request's response from origin is eligible for Cache Reserve (requires a Cache Reserve add-on plan).
- content string
- Error response content.
- content
Type string - Content-type header to set with the response. Available values: "application/json", "text/xml", "text/plain", "text/html".
-
Ruleset
Rule Action Parameters Cookie Field[] - The cookie fields to log.
- disable
Apps boolean - Turn off all active Cloudflare Apps.
- disable
Rum boolean - Turn off Real User Monitoring (RUM).
- disable
Zaraz boolean - Turn off Zaraz.
- edge
Ttl RulesetRule Action Parameters Edge Ttl - TTL (Time to Live) specifies the maximum time to cache a resource in the Cloudflare edge network.
- email
Obfuscation boolean - Turn on or off Email Obfuscation.
- fonts boolean
- Turn on or off Cloudflare Fonts.
- from
List RulesetRule Action Parameters From List - Serve a redirect based on a bulk list lookup.
- from
Value RulesetRule Action Parameters From Value - Serve a redirect based on the request properties.
- headers
{[key: string]: Ruleset
Rule Action Parameters Headers} - Map of request headers to modify.
- host
Header string - Rewrite the HTTP Host header.
- hotlink
Protection boolean - Turn on or off the Hotlink Protection.
- id string
- The ID of the ruleset to execute.
- increment number
- Increment contains the delta to change the score and can be either positive or negative.
- matched
Data RulesetRule Action Parameters Matched Data - The configuration to use for matched data logging.
- mirage boolean
- Turn on or off Mirage.
- opportunistic
Encryption boolean - Turn on or off Opportunistic Encryption.
- origin
Ruleset
Rule Action Parameters Origin - Override the IP/TCP destination.
- origin
Cache booleanControl - When enabled, Cloudflare will aim to strictly adhere to RFC 7234.
- origin
Error booleanPage Passthru - Generate Cloudflare error pages from issues sent from the origin server. When on, error pages will trigger for issues from the origin
- 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 ruleset and rulesets options.
- polish string
- Configure the Polish level. Available values: "off", "lossless", "lossy".
- products string[]
- A list of legacy security products to skip the execution of.
- raw
Response RulesetFields Rule Action Parameters Raw Response Field[] - The raw response fields to log.
- read
Timeout number - Define a timeout value between two successive read operations to 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
- Specify whether or not Cloudflare should respect strong ETag (entity tag) headers. When off, 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 - Turn on or off 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, rules and phases options. 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 - Configure the Security Level. Available values: "off", "essentiallyoff", "low", "medium", "high", "underattack".
- serve
Stale RulesetRule Action Parameters Serve Stale - Define if Cloudflare should serve stale content while getting the latest content from the origin. If on, Cloudflare will not serve stale content while getting the latest content from the origin.
- server
Side booleanExcludes - Turn on or off Server Side Excludes.
- sni
Ruleset
Rule Action Parameters Sni - Override the Server Name Indication (SNI).
- ssl string
- Configure the SSL level. Available values: "off", "flexible", "full", "strict", "origin_pull".
- status
Code number - The status code to use for the error.
- sxg boolean
- Turn on or off Signed Exchanges (SXG).
- transformed
Request RulesetFields Rule Action Parameters Transformed Request Field[] - The transformed request fields to log.
- uri
Ruleset
Rule Action Parameters Uri - URI to rewrite the request to.
- additional_
cacheable_ Sequence[int]ports - List of additional ports that caching can be enabled on.
- algorithms
Sequence[Ruleset
Rule Action Parameters Algorithm] - Custom order for compression algorithms.
- automatic_
https_ boolrewrites - Turn on or off Automatic HTTPS Rewrites.
- autominify
Ruleset
Rule Action Parameters Autominify - Select which file extensions to minify automatically.
- bic bool
- Turn on or off Browser Integrity Check.
- browser_
ttl RulesetRule Action Parameters Browser Ttl - Specify 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
- Mark whether the request’s response from 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 - Define which components of the request are included or excluded from the cache key Cloudflare uses to store the response in cache.
- cache_
reserve RulesetRule Action Parameters Cache Reserve - Mark whether the request's response from origin is eligible for Cache Reserve (requires a Cache Reserve add-on plan).
- content str
- Error response content.
- content_
type str - Content-type header to set with the response. Available values: "application/json", "text/xml", "text/plain", "text/html".
-
Sequence[Ruleset
Rule Action Parameters Cookie Field] - The cookie fields to log.
- disable_
apps bool - Turn off all active Cloudflare Apps.
- disable_
rum bool - Turn off Real User Monitoring (RUM).
- disable_
zaraz bool - Turn off Zaraz.
- edge_
ttl RulesetRule Action Parameters Edge Ttl - TTL (Time to Live) specifies the maximum time to cache a resource in the Cloudflare edge network.
- email_
obfuscation bool - Turn on or off Email Obfuscation.
- fonts bool
- Turn on or off Cloudflare Fonts.
- from_
list RulesetRule Action Parameters From List - Serve a redirect based on a bulk list lookup.
- from_
value RulesetRule Action Parameters From Value - Serve a redirect based on the request properties.
- headers
Mapping[str, Ruleset
Rule Action Parameters Headers] - Map of request headers to modify.
- host_
header str - Rewrite the HTTP Host header.
- hotlink_
protection bool - Turn on or off the Hotlink Protection.
- id str
- The ID of the ruleset to execute.
- increment int
- Increment contains the delta to change the score and can be either positive or negative.
- matched_
data RulesetRule Action Parameters Matched Data - The configuration to use for matched data logging.
- mirage bool
- Turn on or off Mirage.
- opportunistic_
encryption bool - Turn on or off Opportunistic Encryption.
- origin
Ruleset
Rule Action Parameters Origin - Override the IP/TCP destination.
- origin_
cache_ boolcontrol - When enabled, Cloudflare will aim to strictly adhere to RFC 7234.
- origin_
error_ boolpage_ passthru - Generate Cloudflare error pages from issues sent from the origin server. When on, error pages will trigger for issues from the origin
- 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 ruleset and rulesets options.
- polish str
- Configure the Polish level. Available values: "off", "lossless", "lossy".
- products Sequence[str]
- A list of legacy security products to skip the execution of.
- raw_
response_ Sequence[Rulesetfields Rule Action Parameters Raw Response Field] - The raw response fields to log.
- read_
timeout int - Define a timeout value between two successive read operations to 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
- Specify whether or not Cloudflare should respect strong ETag (entity tag) headers. When off, 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 - Turn on or off 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, rules and phases options. 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 - Configure the Security Level. Available values: "off", "essentiallyoff", "low", "medium", "high", "underattack".
- serve_
stale RulesetRule Action Parameters Serve Stale - Define if Cloudflare should serve stale content while getting the latest content from the origin. If on, Cloudflare will not serve stale content while getting the latest content from the origin.
- server_
side_ boolexcludes - Turn on or off Server Side Excludes.
- sni
Ruleset
Rule Action Parameters Sni - Override the Server Name Indication (SNI).
- ssl str
- Configure the SSL level. Available values: "off", "flexible", "full", "strict", "origin_pull".
- status_
code float - The status code to use for the error.
- sxg bool
- Turn on or off 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 - URI to rewrite the request to.
- additional
Cacheable List<Number>Ports - List of additional ports that caching can be enabled on.
- algorithms List<Property Map>
- Custom order for compression algorithms.
- automatic
Https BooleanRewrites - Turn on or off Automatic HTTPS Rewrites.
- autominify Property Map
- Select which file extensions to minify automatically.
- bic Boolean
- Turn on or off Browser Integrity Check.
- browser
Ttl Property Map - Specify 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
- Mark whether the request’s response from origin is eligible for caching. Caching itself will still depend on the cache-control header and your other caching configurations.
- cache
Key Property Map - Define which components of the request are included or excluded from the cache key Cloudflare uses to store the response in cache.
- cache
Reserve Property Map - Mark whether the request's response from origin is eligible for Cache Reserve (requires a Cache Reserve add-on plan).
- content String
- Error response content.
- content
Type String - Content-type header to set with the response. Available values: "application/json", "text/xml", "text/plain", "text/html".
- List<Property Map>
- The cookie fields to log.
- disable
Apps Boolean - Turn off all active Cloudflare Apps.
- disable
Rum Boolean - Turn off Real User Monitoring (RUM).
- disable
Zaraz Boolean - Turn off Zaraz.
- edge
Ttl Property Map - TTL (Time to Live) specifies the maximum time to cache a resource in the Cloudflare edge network.
- email
Obfuscation Boolean - Turn on or off Email Obfuscation.
- fonts Boolean
- Turn on or off Cloudflare Fonts.
- from
List Property Map - Serve a redirect based on a bulk list lookup.
- from
Value Property Map - Serve a redirect based on the request properties.
- headers Map<Property Map>
- Map of request headers to modify.
- host
Header String - Rewrite the HTTP Host header.
- hotlink
Protection Boolean - Turn on or off the Hotlink Protection.
- id String
- The ID of the ruleset to execute.
- increment Number
- Increment contains the delta to change the score and can be either positive or negative.
- matched
Data Property Map - The configuration to use for matched data logging.
- mirage Boolean
- Turn on or off Mirage.
- opportunistic
Encryption Boolean - Turn on or off Opportunistic Encryption.
- origin Property Map
- Override the IP/TCP destination.
- origin
Cache BooleanControl - When enabled, Cloudflare will aim to strictly adhere to RFC 7234.
- origin
Error BooleanPage Passthru - Generate Cloudflare error pages from issues sent from the origin server. When on, error pages will trigger for issues from the origin
- 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 ruleset and rulesets options.
- polish String
- Configure the Polish level. Available values: "off", "lossless", "lossy".
- products List<String>
- A list of legacy security products to skip the execution of.
- raw
Response List<Property Map>Fields - The raw response fields to log.
- read
Timeout Number - Define a timeout value between two successive read operations to 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
- Specify whether or not Cloudflare should respect strong ETag (entity tag) headers. When off, 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 - Turn on or off 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, rules and phases options. 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 - Configure the Security Level. Available values: "off", "essentiallyoff", "low", "medium", "high", "underattack".
- serve
Stale Property Map - Define if Cloudflare should serve stale content while getting the latest content from the origin. If on, Cloudflare will not serve stale content while getting the latest content from the origin.
- server
Side BooleanExcludes - Turn on or off Server Side Excludes.
- sni Property Map
- Override the Server Name Indication (SNI).
- ssl String
- Configure the SSL level. Available values: "off", "flexible", "full", "strict", "origin_pull".
- status
Code Number - The status code to use for the error.
- sxg Boolean
- Turn on or off Signed Exchanges (SXG).
- transformed
Request List<Property Map>Fields - The transformed request fields to log.
- uri Property Map
- URI to rewrite the request to.
RulesetRuleActionParametersAlgorithm, RulesetRuleActionParametersAlgorithmArgs
- Name string
- Name of compression algorithm to enable. Available values: "none", "auto", "default", "gzip", "brotli".
- Name string
- Name of compression algorithm to enable. Available values: "none", "auto", "default", "gzip", "brotli".
- name String
- Name of compression algorithm to enable. Available values: "none", "auto", "default", "gzip", "brotli".
- name string
- Name of compression algorithm to enable. Available values: "none", "auto", "default", "gzip", "brotli".
- name str
- Name of compression algorithm to enable. Available values: "none", "auto", "default", "gzip", "brotli".
- name String
- Name of compression algorithm to enable. Available values: "none", "auto", "default", "gzip", "brotli".
RulesetRuleActionParametersAutominify, RulesetRuleActionParametersAutominifyArgs
RulesetRuleActionParametersBrowserTtl, RulesetRuleActionParametersBrowserTtlArgs
RulesetRuleActionParametersCacheKey, RulesetRuleActionParametersCacheKeyArgs
- Cache
By boolDevice Type - Separate cached content based on the visitor’s device type
- Cache
Deception boolArmor - Protect from web cache deception attacks while allowing static assets to be cached
- Custom
Key RulesetRule Action Parameters Cache Key Custom Key - Customize which components of the request are included or excluded from the cache key.
- Ignore
Query boolStrings Order - Treat requests with the same query parameters the same, regardless of the order those query parameters are in. A value of true ignores the query strings' order.
- Cache
By boolDevice Type - Separate cached content based on the visitor’s device type
- Cache
Deception boolArmor - Protect from web cache deception attacks while allowing static assets to be cached
- Custom
Key RulesetRule Action Parameters Cache Key Custom Key - Customize which components of the request are included or excluded from the cache key.
- Ignore
Query boolStrings Order - Treat requests with the same query parameters the same, regardless of the order those query parameters are in. A value of true ignores the query strings' order.
- cache
By BooleanDevice Type - Separate cached content based on the visitor’s device type
- cache
Deception BooleanArmor - Protect from web cache deception attacks while allowing static assets to be cached
- custom
Key RulesetRule Action Parameters Cache Key Custom Key - Customize which components of the request are included or excluded from the cache key.
- ignore
Query BooleanStrings Order - Treat requests with the same query parameters the same, regardless of the order those query parameters are in. A value of true ignores the query strings' order.
- cache
By booleanDevice Type - Separate cached content based on the visitor’s device type
- cache
Deception booleanArmor - Protect from web cache deception attacks while allowing static assets to be cached
- custom
Key RulesetRule Action Parameters Cache Key Custom Key - Customize which components of the request are included or excluded from the cache key.
- ignore
Query booleanStrings Order - Treat requests with the same query parameters the same, regardless of the order those query parameters are in. A value of true ignores the query strings' order.
- cache_
by_ booldevice_ type - Separate cached content based on the visitor’s device type
- cache_
deception_ boolarmor - Protect from web cache deception attacks while allowing static assets to be cached
- custom_
key RulesetRule Action Parameters Cache Key Custom Key - Customize which components of the request are included or excluded from the cache key.
- ignore_
query_ boolstrings_ order - Treat requests with the same query parameters the same, regardless of the order those query parameters are in. A value of true ignores the query strings' order.
- cache
By BooleanDevice Type - Separate cached content based on the visitor’s device type
- cache
Deception BooleanArmor - Protect from web cache deception attacks while allowing static assets to be cached
- custom
Key Property Map - Customize which components of the request are included or excluded from the cache key.
- ignore
Query BooleanStrings Order - Treat requests with the same query parameters the same, regardless of the order those query parameters are in. A value of true ignores the query strings' order.
RulesetRuleActionParametersCacheKeyCustomKey, RulesetRuleActionParametersCacheKeyCustomKeyArgs
-
Ruleset
Rule Action Parameters Cache Key Custom Key Cookie - The cookies to include in building the cache key.
- Header
Ruleset
Rule Action Parameters Cache Key Custom Key Header - The header names and values to include in building the cache key.
- Host
Ruleset
Rule Action Parameters Cache Key Custom Key Host - Whether to use the original host or the resolved host in the cache key.
- Query
String RulesetRule Action Parameters Cache Key Custom Key Query String - Use the presence of parameters in the query string to build the cache key.
- User
Ruleset
Rule Action Parameters Cache Key Custom Key User - Characteristics of the request user agent used in building the cache key.
-
Ruleset
Rule Action Parameters Cache Key Custom Key Cookie - The cookies to include in building the cache key.
- Header
Ruleset
Rule Action Parameters Cache Key Custom Key Header - The header names and values to include in building the cache key.
- Host
Ruleset
Rule Action Parameters Cache Key Custom Key Host - Whether to use the original host or the resolved host in the cache key.
- Query
String RulesetRule Action Parameters Cache Key Custom Key Query String - Use the presence of parameters in the query string to build the cache key.
- User
Ruleset
Rule Action Parameters Cache Key Custom Key User - Characteristics of the request user agent used in building the cache key.
-
Ruleset
Rule Action Parameters Cache Key Custom Key Cookie - The cookies to include in building the cache key.
- header
Ruleset
Rule Action Parameters Cache Key Custom Key Header - The header names and values to include in building the cache key.
- host
Ruleset
Rule Action Parameters Cache Key Custom Key Host - Whether to use the original host or the resolved host in the cache key.
- query
String RulesetRule Action Parameters Cache Key Custom Key Query String - Use the presence of parameters in the query string to build the cache key.
- user
Ruleset
Rule Action Parameters Cache Key Custom Key User - Characteristics of the request user agent used in building the cache key.
-
Ruleset
Rule Action Parameters Cache Key Custom Key Cookie - The cookies to include in building the cache key.
- header
Ruleset
Rule Action Parameters Cache Key Custom Key Header - The header names and values to include in building the cache key.
- host
Ruleset
Rule Action Parameters Cache Key Custom Key Host - Whether to use the original host or the resolved host in the cache key.
- query
String RulesetRule Action Parameters Cache Key Custom Key Query String - Use the presence of parameters in the query string to build the cache key.
- user
Ruleset
Rule Action Parameters Cache Key Custom Key User - Characteristics of the request user agent used in building the cache key.
-
Ruleset
Rule Action Parameters Cache Key Custom Key Cookie - The cookies to include in building the cache key.
- header
Ruleset
Rule Action Parameters Cache Key Custom Key Header - The header names and values to include in building the cache key.
- host
Ruleset
Rule Action Parameters Cache Key Custom Key Host - Whether to use the original host or the resolved host in the cache key.
- query_
string RulesetRule Action Parameters Cache Key Custom Key Query String - Use the presence of parameters in the query string to build the cache key.
- user
Ruleset
Rule Action Parameters Cache Key Custom Key User - Characteristics of the request user agent used in building the cache key.
- Property Map
- The cookies to include in building the cache key.
- header Property Map
- The header names and values to include in building the cache key.
- host Property Map
- Whether to use the original host or the resolved host in the cache key.
- query
String Property Map - Use the presence of parameters in the query string to build the cache key.
- user Property Map
- Characteristics of the request user agent used in building the cache key.
RulesetRuleActionParametersCacheKeyCustomKeyCookie, RulesetRuleActionParametersCacheKeyCustomKeyCookieArgs
- Check
Presences List<string> - Checks for the presence of these cookie names. The presence of these cookies is used in building the cache key.
- Includes List<string>
- Include these cookies' names and their values.
- Check
Presences []string - Checks for the presence of these cookie names. The presence of these cookies is used in building the cache key.
- Includes []string
- Include these cookies' names and their values.
- check
Presences List<String> - Checks for the presence of these cookie names. The presence of these cookies is used in building the cache key.
- includes List<String>
- Include these cookies' names and their values.
- check
Presences string[] - Checks for the presence of these cookie names. The presence of these cookies is used in building the cache key.
- includes string[]
- Include these cookies' names and their values.
- check_
presences Sequence[str] - Checks for the presence of these cookie names. The presence of these cookies is used in building the cache key.
- includes Sequence[str]
- Include these cookies' names and their values.
- check
Presences List<String> - Checks for the presence of these cookie names. The presence of these cookies is used in building the cache key.
- includes List<String>
- Include these cookies' names and their values.
RulesetRuleActionParametersCacheKeyCustomKeyHeader, RulesetRuleActionParametersCacheKeyCustomKeyHeaderArgs
- Check
Presences List<string> - Checks for the presence of these header names. The presence of these headers is used in building the cache key.
- Contains
Dictionary<string, Immutable
Array<string>> - For each header name and list of values combination, check if the request header contains any of the values provided. The presence of the request header and whether any of the values provided are contained in the request header value is used in building the cache key.
- Exclude
Origin bool - Whether or not to include the origin header. A value of true will exclude the origin header in the cache key.
- Includes List<string>
- Include these headers' names and their values.
- Check
Presences []string - Checks for the presence of these header names. The presence of these headers is used in building the cache key.
- Contains map[string][]string
- For each header name and list of values combination, check if the request header contains any of the values provided. The presence of the request header and whether any of the values provided are contained in the request header value is used in building the cache key.
- Exclude
Origin bool - Whether or not to include the origin header. A value of true will exclude the origin header in the cache key.
- Includes []string
- Include these headers' names and their values.
- check
Presences List<String> - Checks for the presence of these header names. The presence of these headers is used in building the cache key.
- contains Map<String,List<String>>
- For each header name and list of values combination, check if the request header contains any of the values provided. The presence of the request header and whether any of the values provided are contained in the request header value is used in building the cache key.
- exclude
Origin Boolean - Whether or not to include the origin header. A value of true will exclude the origin header in the cache key.
- includes List<String>
- Include these headers' names and their values.
- check
Presences string[] - Checks for the presence of these header names. The presence of these headers is used in building the cache key.
- contains {[key: string]: string[]}
- For each header name and list of values combination, check if the request header contains any of the values provided. The presence of the request header and whether any of the values provided are contained in the request header value is used in building the cache key.
- exclude
Origin boolean - Whether or not to include the origin header. A value of true will exclude the origin header in the cache key.
- includes string[]
- Include these headers' names and their values.
- check_
presences Sequence[str] - Checks for the presence of these header names. The presence of these headers is used in building the cache key.
- contains Mapping[str, Sequence[str]]
- For each header name and list of values combination, check if the request header contains any of the values provided. The presence of the request header and whether any of the values provided are contained in the request header value is used in building the cache key.
- exclude_
origin bool - Whether or not to include the origin header. A value of true will exclude the origin header in the cache key.
- includes Sequence[str]
- Include these headers' names and their values.
- check
Presences List<String> - Checks for the presence of these header names. The presence of these headers is used in building the cache key.
- contains Map<List<String>>
- For each header name and list of values combination, check if the request header contains any of the values provided. The presence of the request header and whether any of the values provided are contained in the request header value is used in building the cache key.
- exclude
Origin Boolean - Whether or not to include the origin header. A value of true will exclude the origin header in the cache key.
- includes List<String>
- Include these headers' names and their values.
RulesetRuleActionParametersCacheKeyCustomKeyHost, RulesetRuleActionParametersCacheKeyCustomKeyHostArgs
- Resolved bool
- Use the resolved host in the cache key. A value of true will use the resolved host, while a value or false will use the original host.
- Resolved bool
- Use the resolved host in the cache key. A value of true will use the resolved host, while a value or false will use the original host.
- resolved Boolean
- Use the resolved host in the cache key. A value of true will use the resolved host, while a value or false will use the original host.
- resolved boolean
- Use the resolved host in the cache key. A value of true will use the resolved host, while a value or false will use the original host.
- resolved bool
- Use the resolved host in the cache key. A value of true will use the resolved host, while a value or false will use the original host.
- resolved Boolean
- Use the resolved host in the cache key. A value of true will use the resolved host, while a value or false will use the original host.
RulesetRuleActionParametersCacheKeyCustomKeyQueryString, RulesetRuleActionParametersCacheKeyCustomKeyQueryStringArgs
- Exclude
Ruleset
Rule Action Parameters Cache Key Custom Key Query String Exclude - A list of query string parameters NOT used to build the cache key. All parameters present in the request but missing in this list will be used to build the cache key.
- Include
Ruleset
Rule Action Parameters Cache Key Custom Key Query String Include - A list of query string parameters used to build the cache key.
- Exclude
Ruleset
Rule Action Parameters Cache Key Custom Key Query String Exclude - A list of query string parameters NOT used to build the cache key. All parameters present in the request but missing in this list will be used to build the cache key.
- Include
Ruleset
Rule Action Parameters Cache Key Custom Key Query String Include - A list of query string parameters used to build the cache key.
- exclude
Ruleset
Rule Action Parameters Cache Key Custom Key Query String Exclude - A list of query string parameters NOT used to build the cache key. All parameters present in the request but missing in this list will be used to build the cache key.
- include
Ruleset
Rule Action Parameters Cache Key Custom Key Query String Include - A list of query string parameters used to build the cache key.
- exclude
Ruleset
Rule Action Parameters Cache Key Custom Key Query String Exclude - A list of query string parameters NOT used to build the cache key. All parameters present in the request but missing in this list will be used to build the cache key.
- include
Ruleset
Rule Action Parameters Cache Key Custom Key Query String Include - A list of query string parameters used to build the cache key.
- exclude
Ruleset
Rule Action Parameters Cache Key Custom Key Query String Exclude - A list of query string parameters NOT used to build the cache key. All parameters present in the request but missing in this list will be used to build the cache key.
- include
Ruleset
Rule Action Parameters Cache Key Custom Key Query String Include - A list of query string parameters used to build the cache key.
- exclude Property Map
- A list of query string parameters NOT used to build the cache key. All parameters present in the request but missing in this list will be used to build the cache key.
- include Property Map
- A list of query string parameters used to build the cache key.
RulesetRuleActionParametersCacheKeyCustomKeyQueryStringExclude, RulesetRuleActionParametersCacheKeyCustomKeyQueryStringExcludeArgs
RulesetRuleActionParametersCacheKeyCustomKeyQueryStringInclude, RulesetRuleActionParametersCacheKeyCustomKeyQueryStringIncludeArgs
RulesetRuleActionParametersCacheKeyCustomKeyUser, RulesetRuleActionParametersCacheKeyCustomKeyUserArgs
- Device
Type bool - Use the user agent's device type in the cache key.
- Geo bool
- Use the user agents's country in the cache key.
- Lang bool
- Use the user agent's language in the cache key.
- Device
Type bool - Use the user agent's device type in the cache key.
- Geo bool
- Use the user agents's country in the cache key.
- Lang bool
- Use the user agent's language in the cache key.
- device
Type Boolean - Use the user agent's device type in the cache key.
- geo Boolean
- Use the user agents's country in the cache key.
- lang Boolean
- Use the user agent's language in the cache key.
- device
Type boolean - Use the user agent's device type in the cache key.
- geo boolean
- Use the user agents's country in the cache key.
- lang boolean
- Use the user agent's language in the cache key.
- device_
type bool - Use the user agent's device type in the cache key.
- geo bool
- Use the user agents's country in the cache key.
- lang bool
- Use the user agent's language in the cache key.
- device
Type Boolean - Use the user agent's device type in the cache key.
- geo Boolean
- Use the user agents's country in the cache key.
- lang Boolean
- Use the user agent's language in the cache key.
RulesetRuleActionParametersCacheReserve, RulesetRuleActionParametersCacheReserveArgs
- Eligible bool
- Determines 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 store in cache reserve.
- Eligible bool
- Determines 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 store in cache reserve.
- eligible Boolean
- Determines 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 store in cache reserve.
- eligible boolean
- Determines 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 store in cache reserve.
- eligible bool
- Determines 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 store in cache reserve.
- eligible Boolean
- Determines 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 store in cache reserve.
RulesetRuleActionParametersCookieField, RulesetRuleActionParametersCookieFieldArgs
- Name string
- The name of the field.
- Name string
- The name of the field.
- name String
- The name of the field.
- name string
- The name of the field.
- name str
- The name of the field.
- name String
- The name of the field.
RulesetRuleActionParametersEdgeTtl, RulesetRuleActionParametersEdgeTtlArgs
- Mode string
- edge ttl options Available values: "respectorigin", "bypassbydefault", "overrideorigin".
- Default int
- The TTL (in seconds) if you choose override_origin mode.
- Status
Code List<RulesetTtls Rule Action Parameters Edge Ttl Status Code Ttl> - List of single status codes, or status code ranges to apply the selected mode
- Mode string
- edge ttl options Available values: "respectorigin", "bypassbydefault", "overrideorigin".
- Default int
- The TTL (in seconds) if you choose override_origin mode.
- Status
Code []RulesetTtls Rule Action Parameters Edge Ttl Status Code Ttl - List of single status codes, or status code ranges to apply the selected mode
- mode String
- edge ttl options Available values: "respectorigin", "bypassbydefault", "overrideorigin".
- default_ Integer
- The TTL (in seconds) if you choose override_origin mode.
- status
Code List<RulesetTtls Rule Action Parameters Edge Ttl Status Code Ttl> - List of single status codes, or status code ranges to apply the selected mode
- mode string
- edge ttl options Available values: "respectorigin", "bypassbydefault", "overrideorigin".
- default number
- The TTL (in seconds) if you choose override_origin mode.
- status
Code RulesetTtls Rule Action Parameters Edge Ttl Status Code Ttl[] - List of single status codes, or status code ranges to apply the selected mode
- mode str
- edge ttl options Available values: "respectorigin", "bypassbydefault", "overrideorigin".
- default int
- The TTL (in seconds) if you choose override_origin mode.
- status_
code_ Sequence[Rulesetttls Rule Action Parameters Edge Ttl Status Code Ttl] - List of single status codes, or status code ranges to apply the selected mode
- mode String
- edge ttl options Available values: "respectorigin", "bypassbydefault", "overrideorigin".
- default Number
- The TTL (in seconds) if you choose override_origin mode.
- status
Code List<Property Map>Ttls - List of single status codes, or status code ranges to apply the selected mode
RulesetRuleActionParametersEdgeTtlStatusCodeTtl, RulesetRuleActionParametersEdgeTtlStatusCodeTtlArgs
- Value int
- Time to cache a response (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 Cache-Control header with the value of "no-store".
- Status
Code int - Set the ttl for responses with this specific status code
- Status
Code RulesetRange Rule Action Parameters Edge Ttl Status Code Ttl Status Code Range - The range of status codes used to apply the selected mode.
- Value int
- Time to cache a response (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 Cache-Control header with the value of "no-store".
- Status
Code int - Set the ttl for responses with this specific status code
- Status
Code RulesetRange Rule Action Parameters Edge Ttl Status Code Ttl Status Code Range - The range of status codes used to apply the selected mode.
- value Integer
- Time to cache a response (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 Cache-Control header with the value of "no-store".
- status
Code Integer - Set the ttl for responses with this specific status code
- status
Code RulesetRange Rule Action Parameters Edge Ttl Status Code Ttl Status Code Range - The range of status codes used to apply the selected mode.
- value number
- Time to cache a response (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 Cache-Control header with the value of "no-store".
- status
Code number - Set the ttl for responses with this specific status code
- status
Code RulesetRange Rule Action Parameters Edge Ttl Status Code Ttl Status Code Range - The range of status codes used to apply the selected mode.
- value int
- Time to cache a response (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 Cache-Control header with the value of "no-store".
- status_
code int - Set the ttl for responses with this specific status code
- status_
code_ Rulesetrange Rule Action Parameters Edge Ttl Status Code Ttl Status Code Range - The range of status codes used to apply the selected mode.
- value Number
- Time to cache a response (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 Cache-Control header with the value of "no-store".
- status
Code Number - Set the ttl for responses with this specific status code
- status
Code Property MapRange - The range of status codes used to apply the selected mode.
RulesetRuleActionParametersEdgeTtlStatusCodeTtlStatusCodeRange, RulesetRuleActionParametersEdgeTtlStatusCodeTtlStatusCodeRangeArgs
RulesetRuleActionParametersFromList, RulesetRuleActionParametersFromListArgs
RulesetRuleActionParametersFromValue, RulesetRuleActionParametersFromValueArgs
- Preserve
Query boolString - Keep the query string of the original request.
- Status
Code double - The status code to be used for the redirect. Available values: 301, 302, 303, 307, 308.
- Target
Url RulesetRule Action Parameters From Value Target Url - The URL to redirect the request to.
- Preserve
Query boolString - Keep the query string of the original request.
- Status
Code float64 - The status code to be used for the redirect. Available values: 301, 302, 303, 307, 308.
- Target
Url RulesetRule Action Parameters From Value Target Url - The URL to redirect the request to.
- preserve
Query BooleanString - Keep the query string of the original request.
- status
Code Double - The status code to be used for the redirect. Available values: 301, 302, 303, 307, 308.
- target
Url RulesetRule Action Parameters From Value Target Url - The URL to redirect the request to.
- preserve
Query booleanString - Keep the query string of the original request.
- status
Code number - The status code to be used for the redirect. Available values: 301, 302, 303, 307, 308.
- target
Url RulesetRule Action Parameters From Value Target Url - The URL to redirect the request to.
- preserve_
query_ boolstring - Keep the query string of the original request.
- status_
code float - The status code to be used for the redirect. Available values: 301, 302, 303, 307, 308.
- target_
url RulesetRule Action Parameters From Value Target Url - The URL to redirect the request to.
- preserve
Query BooleanString - Keep the query string of the original request.
- status
Code Number - The status code to be used for the redirect. Available values: 301, 302, 303, 307, 308.
- target
Url Property Map - The URL to redirect the request to.
RulesetRuleActionParametersFromValueTargetUrl, RulesetRuleActionParametersFromValueTargetUrlArgs
- Expression string
- An expression to evaluate to get the URL to redirect the request to.
- Value string
- The URL to redirect the request to.
- Expression string
- An expression to evaluate to get the URL to redirect the request to.
- Value string
- The URL to redirect the request to.
- expression String
- An expression to evaluate to get the URL to redirect the request to.
- value String
- The URL to redirect the request to.
- expression string
- An expression to evaluate to get the URL to redirect the request to.
- value string
- The URL to redirect the request to.
- expression str
- An expression to evaluate to get the URL to redirect the request to.
- value str
- The URL to redirect the request to.
- expression String
- An expression to evaluate to get the URL to redirect the request to.
- value String
- The URL to redirect the request to.
RulesetRuleActionParametersHeaders, RulesetRuleActionParametersHeadersArgs
- Operation string
- Available values: "remove".
- Expression string
- Expression for the header value.
- Value string
- Static value for the header.
- Operation string
- Available values: "remove".
- Expression string
- Expression for the header value.
- Value string
- Static value for the header.
- operation String
- Available values: "remove".
- expression String
- Expression for the header value.
- value String
- Static value for the header.
- operation string
- Available values: "remove".
- expression string
- Expression for the header value.
- value string
- Static value for the header.
- operation str
- Available values: "remove".
- expression str
- Expression for the header value.
- value str
- Static value for the header.
- operation String
- Available values: "remove".
- expression String
- Expression for the header value.
- value String
- 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. Available values: "default", "medium", "low", "eoff".
RulesetRuleActionParametersRawResponseField, RulesetRuleActionParametersRawResponseFieldArgs
- Name string
- The name of the field.
- Preserve
Duplicates bool - Whether to log duplicate values of the same header.
- Name string
- The name of the field.
- Preserve
Duplicates bool - Whether to log duplicate values of the same header.
- name String
- The name of the field.
- preserve
Duplicates Boolean - Whether to log duplicate values of the same header.
- name string
- The name of the field.
- preserve
Duplicates boolean - Whether to log duplicate values of the same header.
- name str
- The name of the field.
- preserve_
duplicates bool - Whether to log duplicate values of the same header.
- name String
- The name of the field.
- preserve
Duplicates Boolean - Whether to log duplicate values of the same header.
RulesetRuleActionParametersRequestField, RulesetRuleActionParametersRequestFieldArgs
- Name string
- The name of the field.
- Name string
- The name of the field.
- name String
- The name of the field.
- name string
- The name of the field.
- name str
- The name of the field.
- name String
- The name of the field.
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 field.
- Preserve
Duplicates bool - Whether to log duplicate values of the same header.
- Name string
- The name of the field.
- Preserve
Duplicates bool - Whether to log duplicate values of the same header.
- name String
- The name of the field.
- preserve
Duplicates Boolean - Whether to log duplicate values of the same header.
- name string
- The name of the field.
- preserve
Duplicates boolean - Whether to log duplicate values of the same header.
- name str
- The name of the field.
- preserve_
duplicates bool - Whether to log duplicate values of the same header.
- name String
- The name of the field.
- preserve
Duplicates Boolean - Whether to log duplicate values of the same header.
RulesetRuleActionParametersServeStale, RulesetRuleActionParametersServeStaleArgs
- Disable
Stale boolWhile Updating - Defines whether Cloudflare should serve stale content while updating. If true, Cloudflare will not serve stale content while getting the latest content from the origin.
- Disable
Stale boolWhile Updating - Defines whether Cloudflare should serve stale content while updating. If true, Cloudflare will not serve stale content while getting the latest content from the origin.
- disable
Stale BooleanWhile Updating - Defines whether Cloudflare should serve stale content while updating. If true, Cloudflare will not serve stale content while getting the latest content from the origin.
- disable
Stale booleanWhile Updating - Defines whether Cloudflare should serve stale content while updating. If true, Cloudflare will not serve stale content while getting the latest content from the origin.
- disable_
stale_ boolwhile_ updating - Defines whether Cloudflare should serve stale content while updating. If true, Cloudflare will not serve stale content while getting the latest content from the origin.
- disable
Stale BooleanWhile Updating - Defines whether Cloudflare should serve stale content while updating. If true, Cloudflare will not serve stale content while getting the latest content from the origin.
RulesetRuleActionParametersSni, RulesetRuleActionParametersSniArgs
- Value string
- The SNI override.
- Value string
- The SNI override.
- value String
- The SNI override.
- value string
- The SNI override.
- value str
- The SNI override.
- value String
- The SNI override.
RulesetRuleActionParametersTransformedRequestField, RulesetRuleActionParametersTransformedRequestFieldArgs
- Name string
- The name of the field.
- Name string
- The name of the field.
- name String
- The name of the field.
- name string
- The name of the field.
- name str
- The name of the field.
- name String
- The name of the field.
RulesetRuleActionParametersUri, RulesetRuleActionParametersUriArgs
- Path
Ruleset
Rule Action Parameters Uri Path - Path portion rewrite.
- Query
Ruleset
Rule Action Parameters Uri Query - Query portion rewrite.
- Path
Ruleset
Rule Action Parameters Uri Path - Path portion rewrite.
- Query
Ruleset
Rule Action Parameters Uri Query - Query portion rewrite.
- path
Ruleset
Rule Action Parameters Uri Path - Path portion rewrite.
- query
Ruleset
Rule Action Parameters Uri Query - Query portion rewrite.
- path
Ruleset
Rule Action Parameters Uri Path - Path portion rewrite.
- query
Ruleset
Rule Action Parameters Uri Query - Query portion rewrite.
- path
Ruleset
Rule Action Parameters Uri Path - Path portion rewrite.
- query
Ruleset
Rule Action Parameters Uri Query - Query portion rewrite.
- path Property Map
- Path portion rewrite.
- query Property Map
- Query portion rewrite.
RulesetRuleActionParametersUriPath, RulesetRuleActionParametersUriPathArgs
- Expression string
- Expression to evaluate for the replacement value.
- Value string
- Predefined replacement value.
- Expression string
- Expression to evaluate for the replacement value.
- Value string
- Predefined replacement value.
- expression String
- Expression to evaluate for the replacement value.
- value String
- Predefined replacement value.
- expression string
- Expression to evaluate for the replacement value.
- value string
- Predefined replacement value.
- expression str
- Expression to evaluate for the replacement value.
- value str
- Predefined replacement value.
- expression String
- Expression to evaluate for the replacement value.
- value String
- Predefined replacement value.
RulesetRuleActionParametersUriQuery, RulesetRuleActionParametersUriQueryArgs
- Expression string
- Expression to evaluate for the replacement value.
- Value string
- Predefined replacement value.
- Expression string
- Expression to evaluate for the replacement value.
- Value string
- Predefined replacement value.
- expression String
- Expression to evaluate for the replacement value.
- value String
- Predefined replacement value.
- expression string
- Expression to evaluate for the replacement value.
- value string
- Predefined replacement value.
- expression str
- Expression to evaluate for the replacement value.
- value str
- Predefined replacement value.
- expression String
- Expression to evaluate for the replacement value.
- value String
- Predefined replacement value.
RulesetRuleExposedCredentialCheck, RulesetRuleExposedCredentialCheckArgs
- Password
Expression string - Expression that selects the password used in the credentials check.
- Username
Expression string - Expression that selects the user ID used in the credentials check.
- Password
Expression string - Expression that selects the password used in the credentials check.
- Username
Expression string - Expression that selects the user ID used in the credentials check.
- password
Expression String - Expression that selects the password used in the credentials check.
- username
Expression String - Expression that selects the user ID used in the credentials check.
- password
Expression string - Expression that selects the password used in the credentials check.
- username
Expression string - Expression that selects the user ID used in the credentials check.
- password_
expression str - Expression that selects the password used in the credentials check.
- username_
expression str - Expression that selects the user ID used in the credentials check.
- password
Expression String - Expression that selects the password used in the credentials check.
- username
Expression String - 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 ratelimiter counter will be incremented.
- Period int
- Period in seconds over which the counter is being incremented. Available values: 10, 60, 600, 3600.
- Counting
Expression string - Defines when the ratelimit counter should be incremented. It is optional and 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 - Defines if ratelimit counting is only done 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 - The response header name provided by the origin which should contain the score to increment ratelimit counter on.
- Characteristics []string
- Characteristics of the request on which the ratelimiter counter will be incremented.
- Period int
- Period in seconds over which the counter is being incremented. Available values: 10, 60, 600, 3600.
- Counting
Expression string - Defines when the ratelimit counter should be incremented. It is optional and 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 - Defines if ratelimit counting is only done 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 - The response header name provided by the origin which should contain the score to increment ratelimit counter on.
- characteristics List<String>
- Characteristics of the request on which the ratelimiter counter will be incremented.
- period Integer
- Period in seconds over which the counter is being incremented. Available values: 10, 60, 600, 3600.
- counting
Expression String - Defines when the ratelimit counter should be incremented. It is optional and 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 - Defines if ratelimit counting is only done 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 - The response header name provided by the origin which should contain the score to increment ratelimit counter on.
- characteristics string[]
- Characteristics of the request on which the ratelimiter counter will be incremented.
- period number
- Period in seconds over which the counter is being incremented. Available values: 10, 60, 600, 3600.
- counting
Expression string - Defines when the ratelimit counter should be incremented. It is optional and 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 - Defines if ratelimit counting is only done 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 - The response header name provided by the origin which should contain the score to increment ratelimit counter on.
- characteristics Sequence[str]
- Characteristics of the request on which the ratelimiter counter will be incremented.
- period int
- Period in seconds over which the counter is being incremented. Available values: 10, 60, 600, 3600.
- counting_
expression str - Defines when the ratelimit counter should be incremented. It is optional and 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 - Defines if ratelimit counting is only done 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 - The response header name provided by the origin which should contain the score to increment ratelimit counter on.
- characteristics List<String>
- Characteristics of the request on which the ratelimiter counter will be incremented.
- period Number
- Period in seconds over which the counter is being incremented. Available values: 10, 60, 600, 3600.
- counting
Expression String - Defines when the ratelimit counter should be incremented. It is optional and 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 - Defines if ratelimit counting is only done 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 - The response header name provided by the origin which should contain the score to increment ratelimit counter on.
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.