1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. Ruleset
Cloudflare v6.0.1 published on Wednesday, Apr 16, 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: managed
      name: My ruleset
      phase: ddos_l4
      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: 10
            countingExpression: http.request.body.raw eq "abcd"
            mitigationTimeout: 600
            requestsPerPeriod: 1000
            requestsToOrigin: true
            scorePerPeriod: 400
            scoreResponseHeaderName: my-score
          ref: my_ref
Copy

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 This property is required. string
The unique name of the resource.
args This property is required. RulesetArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. RulesetArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. RulesetArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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",
});
Copy
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"),
})
Copy
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());
Copy
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")
Copy
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",
});
Copy
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
Copy

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 This property is required. string
The kind of the ruleset. Available values: "managed", "custom", "root", "zone".
Name This property is required. string
The human-readable name of the ruleset.
Phase This property is required. 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".
AccountId 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<RulesetRule>
The list of rules in the ruleset.
ZoneId string
The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
Kind This property is required. string
The kind of the ruleset. Available values: "managed", "custom", "root", "zone".
Name This property is required. string
The human-readable name of the ruleset.
Phase This property is required. 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".
AccountId string
The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
Description string
An informative description of the ruleset.
Rules []RulesetRuleArgs
The list of rules in the ruleset.
ZoneId string
The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
kind This property is required. String
The kind of the ruleset. Available values: "managed", "custom", "root", "zone".
name This property is required. String
The human-readable name of the ruleset.
phase This property is required. 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".
accountId 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<RulesetRule>
The list of rules in the ruleset.
zoneId String
The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
kind This property is required. string
The kind of the ruleset. Available values: "managed", "custom", "root", "zone".
name This property is required. string
The human-readable name of the ruleset.
phase This property is required. 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".
accountId string
The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
description string
An informative description of the ruleset.
rules RulesetRule[]
The list of rules in the ruleset.
zoneId string
The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
kind This property is required. str
The kind of the ruleset. Available values: "managed", "custom", "root", "zone".
name This property is required. str
The human-readable name of the ruleset.
phase This property is required. 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[RulesetRuleArgs]
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 This property is required. String
The kind of the ruleset. Available values: "managed", "custom", "root", "zone".
name This property is required. String
The human-readable name of the ruleset.
phase This property is required. 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".
accountId 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.
zoneId 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) -> Ruleset
func 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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AccountId 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<RulesetRule>
The list of rules in the ruleset.
ZoneId string
The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
AccountId 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 []RulesetRuleArgs
The list of rules in the ruleset.
ZoneId string
The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
accountId 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<RulesetRule>
The list of rules in the ruleset.
zoneId String
The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
accountId 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 RulesetRule[]
The list of rules in the ruleset.
zoneId 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[RulesetRuleArgs]
The list of rules in the ruleset.
zone_id str
The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
accountId 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.
zoneId 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".
ActionParameters RulesetRuleActionParameters
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.
ExposedCredentialCheck RulesetRuleExposedCredentialCheck
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 RulesetRuleLogging
An object configuring the rule's logging behavior.
Ratelimit RulesetRuleRatelimit
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".
ActionParameters RulesetRuleActionParameters
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.
ExposedCredentialCheck RulesetRuleExposedCredentialCheck
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 RulesetRuleLogging
An object configuring the rule's logging behavior.
Ratelimit RulesetRuleRatelimit
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".
actionParameters RulesetRuleActionParameters
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.
exposedCredentialCheck RulesetRuleExposedCredentialCheck
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 RulesetRuleLogging
An object configuring the rule's logging behavior.
ratelimit RulesetRuleRatelimit
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".
actionParameters RulesetRuleActionParameters
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.
exposedCredentialCheck RulesetRuleExposedCredentialCheck
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 RulesetRuleLogging
An object configuring the rule's logging behavior.
ratelimit RulesetRuleRatelimit
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 RulesetRuleActionParameters
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_check RulesetRuleExposedCredentialCheck
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 RulesetRuleLogging
An object configuring the rule's logging behavior.
ratelimit RulesetRuleRatelimit
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".
actionParameters 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.
exposedCredentialCheck Property Map
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

AdditionalCacheablePorts List<int>
List of additional ports that caching can be enabled on.
Algorithms List<RulesetRuleActionParametersAlgorithm>
Custom order for compression algorithms.
AutomaticHttpsRewrites bool
Turn on or off Automatic HTTPS Rewrites.
Autominify RulesetRuleActionParametersAutominify
Select which file extensions to minify automatically.
Bic bool
Turn on or off Browser Integrity Check.
BrowserTtl RulesetRuleActionParametersBrowserTtl
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.
CacheKey RulesetRuleActionParametersCacheKey
Define which components of the request are included or excluded from the cache key Cloudflare uses to store the response in cache.
CacheReserve RulesetRuleActionParametersCacheReserve
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.
ContentType string
Content-type header to set with the response. Available values: "application/json", "text/xml", "text/plain", "text/html".
CookieFields List<RulesetRuleActionParametersCookieField>
The cookie fields to log.
DisableApps bool
Turn off all active Cloudflare Apps.
DisableRum bool
Turn off Real User Monitoring (RUM).
DisableZaraz bool
Turn off Zaraz.
EdgeTtl RulesetRuleActionParametersEdgeTtl
TTL (Time to Live) specifies the maximum time to cache a resource in the Cloudflare edge network.
EmailObfuscation bool
Turn on or off Email Obfuscation.
Fonts bool
Turn on or off Cloudflare Fonts.
FromList RulesetRuleActionParametersFromList
Serve a redirect based on a bulk list lookup.
FromValue RulesetRuleActionParametersFromValue
Serve a redirect based on the request properties.
Headers Dictionary<string, RulesetRuleActionParametersHeaders>
Map of request headers to modify.
HostHeader string
Rewrite the HTTP Host header.
HotlinkProtection 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.
MatchedData RulesetRuleActionParametersMatchedData
The configuration to use for matched data logging.
Mirage bool
Turn on or off Mirage.
OpportunisticEncryption bool
Turn on or off Opportunistic Encryption.
Origin RulesetRuleActionParametersOrigin
Override the IP/TCP destination.
OriginCacheControl bool
When enabled, Cloudflare will aim to strictly adhere to RFC 7234.
OriginErrorPagePassthru bool
Generate Cloudflare error pages from issues sent from the origin server. When on, error pages will trigger for issues from the origin
Overrides RulesetRuleActionParametersOverrides
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.
RawResponseFields List<RulesetRuleActionParametersRawResponseField>
The raw response fields to log.
ReadTimeout 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.
RequestFields List<RulesetRuleActionParametersRequestField>
The raw request fields to log.
RespectStrongEtags 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 RulesetRuleActionParametersResponse
The response to show when the block is applied.
ResponseFields List<RulesetRuleActionParametersResponseField>
The transformed response fields to log.
RocketLoader bool
Turn on or off Rocket Loader
Rules Dictionary<string, ImmutableArray<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.
SecurityLevel string
Configure the Security Level. Available values: "off", "essentiallyoff", "low", "medium", "high", "underattack".
ServeStale RulesetRuleActionParametersServeStale
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.
ServerSideExcludes bool
Turn on or off Server Side Excludes.
Sni RulesetRuleActionParametersSni
Override the Server Name Indication (SNI).
Ssl string
Configure the SSL level. Available values: "off", "flexible", "full", "strict", "origin_pull".
StatusCode double
The status code to use for the error.
Sxg bool
Turn on or off Signed Exchanges (SXG).
TransformedRequestFields List<RulesetRuleActionParametersTransformedRequestField>
The transformed request fields to log.
Uri RulesetRuleActionParametersUri
URI to rewrite the request to.
AdditionalCacheablePorts []int
List of additional ports that caching can be enabled on.
Algorithms []RulesetRuleActionParametersAlgorithm
Custom order for compression algorithms.
AutomaticHttpsRewrites bool
Turn on or off Automatic HTTPS Rewrites.
Autominify RulesetRuleActionParametersAutominify
Select which file extensions to minify automatically.
Bic bool
Turn on or off Browser Integrity Check.
BrowserTtl RulesetRuleActionParametersBrowserTtl
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.
CacheKey RulesetRuleActionParametersCacheKey
Define which components of the request are included or excluded from the cache key Cloudflare uses to store the response in cache.
CacheReserve RulesetRuleActionParametersCacheReserve
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.
ContentType string
Content-type header to set with the response. Available values: "application/json", "text/xml", "text/plain", "text/html".
CookieFields []RulesetRuleActionParametersCookieField
The cookie fields to log.
DisableApps bool
Turn off all active Cloudflare Apps.
DisableRum bool
Turn off Real User Monitoring (RUM).
DisableZaraz bool
Turn off Zaraz.
EdgeTtl RulesetRuleActionParametersEdgeTtl
TTL (Time to Live) specifies the maximum time to cache a resource in the Cloudflare edge network.
EmailObfuscation bool
Turn on or off Email Obfuscation.
Fonts bool
Turn on or off Cloudflare Fonts.
FromList RulesetRuleActionParametersFromList
Serve a redirect based on a bulk list lookup.
FromValue RulesetRuleActionParametersFromValue
Serve a redirect based on the request properties.
Headers map[string]RulesetRuleActionParametersHeaders
Map of request headers to modify.
HostHeader string
Rewrite the HTTP Host header.
HotlinkProtection 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.
MatchedData RulesetRuleActionParametersMatchedData
The configuration to use for matched data logging.
Mirage bool
Turn on or off Mirage.
OpportunisticEncryption bool
Turn on or off Opportunistic Encryption.
Origin RulesetRuleActionParametersOrigin
Override the IP/TCP destination.
OriginCacheControl bool
When enabled, Cloudflare will aim to strictly adhere to RFC 7234.
OriginErrorPagePassthru bool
Generate Cloudflare error pages from issues sent from the origin server. When on, error pages will trigger for issues from the origin
Overrides RulesetRuleActionParametersOverrides
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.
RawResponseFields []RulesetRuleActionParametersRawResponseField
The raw response fields to log.
ReadTimeout 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.
RequestFields []RulesetRuleActionParametersRequestField
The raw request fields to log.
RespectStrongEtags 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 RulesetRuleActionParametersResponse
The response to show when the block is applied.
ResponseFields []RulesetRuleActionParametersResponseField
The transformed response fields to log.
RocketLoader 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.
SecurityLevel string
Configure the Security Level. Available values: "off", "essentiallyoff", "low", "medium", "high", "underattack".
ServeStale RulesetRuleActionParametersServeStale
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.
ServerSideExcludes bool
Turn on or off Server Side Excludes.
Sni RulesetRuleActionParametersSni
Override the Server Name Indication (SNI).
Ssl string
Configure the SSL level. Available values: "off", "flexible", "full", "strict", "origin_pull".
StatusCode float64
The status code to use for the error.
Sxg bool
Turn on or off Signed Exchanges (SXG).
TransformedRequestFields []RulesetRuleActionParametersTransformedRequestField
The transformed request fields to log.
Uri RulesetRuleActionParametersUri
URI to rewrite the request to.
additionalCacheablePorts List<Integer>
List of additional ports that caching can be enabled on.
algorithms List<RulesetRuleActionParametersAlgorithm>
Custom order for compression algorithms.
automaticHttpsRewrites Boolean
Turn on or off Automatic HTTPS Rewrites.
autominify RulesetRuleActionParametersAutominify
Select which file extensions to minify automatically.
bic Boolean
Turn on or off Browser Integrity Check.
browserTtl RulesetRuleActionParametersBrowserTtl
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.
cacheKey RulesetRuleActionParametersCacheKey
Define which components of the request are included or excluded from the cache key Cloudflare uses to store the response in cache.
cacheReserve RulesetRuleActionParametersCacheReserve
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.
contentType String
Content-type header to set with the response. Available values: "application/json", "text/xml", "text/plain", "text/html".
cookieFields List<RulesetRuleActionParametersCookieField>
The cookie fields to log.
disableApps Boolean
Turn off all active Cloudflare Apps.
disableRum Boolean
Turn off Real User Monitoring (RUM).
disableZaraz Boolean
Turn off Zaraz.
edgeTtl RulesetRuleActionParametersEdgeTtl
TTL (Time to Live) specifies the maximum time to cache a resource in the Cloudflare edge network.
emailObfuscation Boolean
Turn on or off Email Obfuscation.
fonts Boolean
Turn on or off Cloudflare Fonts.
fromList RulesetRuleActionParametersFromList
Serve a redirect based on a bulk list lookup.
fromValue RulesetRuleActionParametersFromValue
Serve a redirect based on the request properties.
headers Map<String,RulesetRuleActionParametersHeaders>
Map of request headers to modify.
hostHeader String
Rewrite the HTTP Host header.
hotlinkProtection 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.
matchedData RulesetRuleActionParametersMatchedData
The configuration to use for matched data logging.
mirage Boolean
Turn on or off Mirage.
opportunisticEncryption Boolean
Turn on or off Opportunistic Encryption.
origin RulesetRuleActionParametersOrigin
Override the IP/TCP destination.
originCacheControl Boolean
When enabled, Cloudflare will aim to strictly adhere to RFC 7234.
originErrorPagePassthru Boolean
Generate Cloudflare error pages from issues sent from the origin server. When on, error pages will trigger for issues from the origin
overrides RulesetRuleActionParametersOverrides
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.
rawResponseFields List<RulesetRuleActionParametersRawResponseField>
The raw response fields to log.
readTimeout 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.
requestFields List<RulesetRuleActionParametersRequestField>
The raw request fields to log.
respectStrongEtags 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 RulesetRuleActionParametersResponse
The response to show when the block is applied.
responseFields List<RulesetRuleActionParametersResponseField>
The transformed response fields to log.
rocketLoader 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.
securityLevel String
Configure the Security Level. Available values: "off", "essentiallyoff", "low", "medium", "high", "underattack".
serveStale RulesetRuleActionParametersServeStale
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.
serverSideExcludes Boolean
Turn on or off Server Side Excludes.
sni RulesetRuleActionParametersSni
Override the Server Name Indication (SNI).
ssl String
Configure the SSL level. Available values: "off", "flexible", "full", "strict", "origin_pull".
statusCode Double
The status code to use for the error.
sxg Boolean
Turn on or off Signed Exchanges (SXG).
transformedRequestFields List<RulesetRuleActionParametersTransformedRequestField>
The transformed request fields to log.
uri RulesetRuleActionParametersUri
URI to rewrite the request to.
additionalCacheablePorts number[]
List of additional ports that caching can be enabled on.
algorithms RulesetRuleActionParametersAlgorithm[]
Custom order for compression algorithms.
automaticHttpsRewrites boolean
Turn on or off Automatic HTTPS Rewrites.
autominify RulesetRuleActionParametersAutominify
Select which file extensions to minify automatically.
bic boolean
Turn on or off Browser Integrity Check.
browserTtl RulesetRuleActionParametersBrowserTtl
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.
cacheKey RulesetRuleActionParametersCacheKey
Define which components of the request are included or excluded from the cache key Cloudflare uses to store the response in cache.
cacheReserve RulesetRuleActionParametersCacheReserve
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.
contentType string
Content-type header to set with the response. Available values: "application/json", "text/xml", "text/plain", "text/html".
cookieFields RulesetRuleActionParametersCookieField[]
The cookie fields to log.
disableApps boolean
Turn off all active Cloudflare Apps.
disableRum boolean
Turn off Real User Monitoring (RUM).
disableZaraz boolean
Turn off Zaraz.
edgeTtl RulesetRuleActionParametersEdgeTtl
TTL (Time to Live) specifies the maximum time to cache a resource in the Cloudflare edge network.
emailObfuscation boolean
Turn on or off Email Obfuscation.
fonts boolean
Turn on or off Cloudflare Fonts.
fromList RulesetRuleActionParametersFromList
Serve a redirect based on a bulk list lookup.
fromValue RulesetRuleActionParametersFromValue
Serve a redirect based on the request properties.
headers {[key: string]: RulesetRuleActionParametersHeaders}
Map of request headers to modify.
hostHeader string
Rewrite the HTTP Host header.
hotlinkProtection 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.
matchedData RulesetRuleActionParametersMatchedData
The configuration to use for matched data logging.
mirage boolean
Turn on or off Mirage.
opportunisticEncryption boolean
Turn on or off Opportunistic Encryption.
origin RulesetRuleActionParametersOrigin
Override the IP/TCP destination.
originCacheControl boolean
When enabled, Cloudflare will aim to strictly adhere to RFC 7234.
originErrorPagePassthru boolean
Generate Cloudflare error pages from issues sent from the origin server. When on, error pages will trigger for issues from the origin
overrides RulesetRuleActionParametersOverrides
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.
rawResponseFields RulesetRuleActionParametersRawResponseField[]
The raw response fields to log.
readTimeout 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.
requestFields RulesetRuleActionParametersRequestField[]
The raw request fields to log.
respectStrongEtags 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 RulesetRuleActionParametersResponse
The response to show when the block is applied.
responseFields RulesetRuleActionParametersResponseField[]
The transformed response fields to log.
rocketLoader 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.
securityLevel string
Configure the Security Level. Available values: "off", "essentiallyoff", "low", "medium", "high", "underattack".
serveStale RulesetRuleActionParametersServeStale
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.
serverSideExcludes boolean
Turn on or off Server Side Excludes.
sni RulesetRuleActionParametersSni
Override the Server Name Indication (SNI).
ssl string
Configure the SSL level. Available values: "off", "flexible", "full", "strict", "origin_pull".
statusCode number
The status code to use for the error.
sxg boolean
Turn on or off Signed Exchanges (SXG).
transformedRequestFields RulesetRuleActionParametersTransformedRequestField[]
The transformed request fields to log.
uri RulesetRuleActionParametersUri
URI to rewrite the request to.
additional_cacheable_ports Sequence[int]
List of additional ports that caching can be enabled on.
algorithms Sequence[RulesetRuleActionParametersAlgorithm]
Custom order for compression algorithms.
automatic_https_rewrites bool
Turn on or off Automatic HTTPS Rewrites.
autominify RulesetRuleActionParametersAutominify
Select which file extensions to minify automatically.
bic bool
Turn on or off Browser Integrity Check.
browser_ttl RulesetRuleActionParametersBrowserTtl
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 RulesetRuleActionParametersCacheKey
Define which components of the request are included or excluded from the cache key Cloudflare uses to store the response in cache.
cache_reserve RulesetRuleActionParametersCacheReserve
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".
cookie_fields Sequence[RulesetRuleActionParametersCookieField]
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 RulesetRuleActionParametersEdgeTtl
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 RulesetRuleActionParametersFromList
Serve a redirect based on a bulk list lookup.
from_value RulesetRuleActionParametersFromValue
Serve a redirect based on the request properties.
headers Mapping[str, RulesetRuleActionParametersHeaders]
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 RulesetRuleActionParametersMatchedData
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 RulesetRuleActionParametersOrigin
Override the IP/TCP destination.
origin_cache_control bool
When enabled, Cloudflare will aim to strictly adhere to RFC 7234.
origin_error_page_passthru bool
Generate Cloudflare error pages from issues sent from the origin server. When on, error pages will trigger for issues from the origin
overrides RulesetRuleActionParametersOverrides
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_fields Sequence[RulesetRuleActionParametersRawResponseField]
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[RulesetRuleActionParametersRequestField]
The raw request fields to log.
respect_strong_etags 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 RulesetRuleActionParametersResponse
The response to show when the block is applied.
response_fields Sequence[RulesetRuleActionParametersResponseField]
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 RulesetRuleActionParametersServeStale
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_excludes bool
Turn on or off Server Side Excludes.
sni RulesetRuleActionParametersSni
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_fields Sequence[RulesetRuleActionParametersTransformedRequestField]
The transformed request fields to log.
uri RulesetRuleActionParametersUri
URI to rewrite the request to.
additionalCacheablePorts List<Number>
List of additional ports that caching can be enabled on.
algorithms List<Property Map>
Custom order for compression algorithms.
automaticHttpsRewrites Boolean
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.
browserTtl 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.
cacheKey Property Map
Define which components of the request are included or excluded from the cache key Cloudflare uses to store the response in cache.
cacheReserve 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.
contentType String
Content-type header to set with the response. Available values: "application/json", "text/xml", "text/plain", "text/html".
cookieFields List<Property Map>
The cookie fields to log.
disableApps Boolean
Turn off all active Cloudflare Apps.
disableRum Boolean
Turn off Real User Monitoring (RUM).
disableZaraz Boolean
Turn off Zaraz.
edgeTtl Property Map
TTL (Time to Live) specifies the maximum time to cache a resource in the Cloudflare edge network.
emailObfuscation Boolean
Turn on or off Email Obfuscation.
fonts Boolean
Turn on or off Cloudflare Fonts.
fromList Property Map
Serve a redirect based on a bulk list lookup.
fromValue Property Map
Serve a redirect based on the request properties.
headers Map<Property Map>
Map of request headers to modify.
hostHeader String
Rewrite the HTTP Host header.
hotlinkProtection 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.
matchedData Property Map
The configuration to use for matched data logging.
mirage Boolean
Turn on or off Mirage.
opportunisticEncryption Boolean
Turn on or off Opportunistic Encryption.
origin Property Map
Override the IP/TCP destination.
originCacheControl Boolean
When enabled, Cloudflare will aim to strictly adhere to RFC 7234.
originErrorPagePassthru Boolean
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.
rawResponseFields List<Property Map>
The raw response fields to log.
readTimeout 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.
requestFields List<Property Map>
The raw request fields to log.
respectStrongEtags 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.
responseFields List<Property Map>
The transformed response fields to log.
rocketLoader 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.
securityLevel String
Configure the Security Level. Available values: "off", "essentiallyoff", "low", "medium", "high", "underattack".
serveStale 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.
serverSideExcludes Boolean
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".
statusCode Number
The status code to use for the error.
sxg Boolean
Turn on or off Signed Exchanges (SXG).
transformedRequestFields List<Property Map>
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

Css bool
Minify CSS files.
Html bool
Minify HTML files.
Js bool
Minify JS files.
Css bool
Minify CSS files.
Html bool
Minify HTML files.
Js bool
Minify JS files.
css Boolean
Minify CSS files.
html Boolean
Minify HTML files.
js Boolean
Minify JS files.
css boolean
Minify CSS files.
html boolean
Minify HTML files.
js boolean
Minify JS files.
css bool
Minify CSS files.
html bool
Minify HTML files.
js bool
Minify JS files.
css Boolean
Minify CSS files.
html Boolean
Minify HTML files.
js Boolean
Minify JS files.

RulesetRuleActionParametersBrowserTtl
, RulesetRuleActionParametersBrowserTtlArgs

Mode This property is required. string
Determines which browser ttl mode to use. Available values: "respectorigin", "bypassbydefault", "overrideorigin".
Default int
The TTL (in seconds) if you choose override_origin mode.
Mode This property is required. string
Determines which browser ttl mode to use. Available values: "respectorigin", "bypassbydefault", "overrideorigin".
Default int
The TTL (in seconds) if you choose override_origin mode.
mode This property is required. String
Determines which browser ttl mode to use. Available values: "respectorigin", "bypassbydefault", "overrideorigin".
default_ Integer
The TTL (in seconds) if you choose override_origin mode.
mode This property is required. string
Determines which browser ttl mode to use. Available values: "respectorigin", "bypassbydefault", "overrideorigin".
default number
The TTL (in seconds) if you choose override_origin mode.
mode This property is required. str
Determines which browser ttl mode to use. Available values: "respectorigin", "bypassbydefault", "overrideorigin".
default int
The TTL (in seconds) if you choose override_origin mode.
mode This property is required. String
Determines which browser ttl mode to use. Available values: "respectorigin", "bypassbydefault", "overrideorigin".
default Number
The TTL (in seconds) if you choose override_origin mode.

RulesetRuleActionParametersCacheKey
, RulesetRuleActionParametersCacheKeyArgs

CacheByDeviceType bool
Separate cached content based on the visitor’s device type
CacheDeceptionArmor bool
Protect from web cache deception attacks while allowing static assets to be cached
CustomKey RulesetRuleActionParametersCacheKeyCustomKey
Customize which components of the request are included or excluded from the cache key.
IgnoreQueryStringsOrder bool
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.
CacheByDeviceType bool
Separate cached content based on the visitor’s device type
CacheDeceptionArmor bool
Protect from web cache deception attacks while allowing static assets to be cached
CustomKey RulesetRuleActionParametersCacheKeyCustomKey
Customize which components of the request are included or excluded from the cache key.
IgnoreQueryStringsOrder bool
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.
cacheByDeviceType Boolean
Separate cached content based on the visitor’s device type
cacheDeceptionArmor Boolean
Protect from web cache deception attacks while allowing static assets to be cached
customKey RulesetRuleActionParametersCacheKeyCustomKey
Customize which components of the request are included or excluded from the cache key.
ignoreQueryStringsOrder Boolean
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.
cacheByDeviceType boolean
Separate cached content based on the visitor’s device type
cacheDeceptionArmor boolean
Protect from web cache deception attacks while allowing static assets to be cached
customKey RulesetRuleActionParametersCacheKeyCustomKey
Customize which components of the request are included or excluded from the cache key.
ignoreQueryStringsOrder boolean
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_device_type bool
Separate cached content based on the visitor’s device type
cache_deception_armor bool
Protect from web cache deception attacks while allowing static assets to be cached
custom_key RulesetRuleActionParametersCacheKeyCustomKey
Customize which components of the request are included or excluded from the cache key.
ignore_query_strings_order bool
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.
cacheByDeviceType Boolean
Separate cached content based on the visitor’s device type
cacheDeceptionArmor Boolean
Protect from web cache deception attacks while allowing static assets to be cached
customKey Property Map
Customize which components of the request are included or excluded from the cache key.
ignoreQueryStringsOrder Boolean
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

Cookie RulesetRuleActionParametersCacheKeyCustomKeyCookie
The cookies to include in building the cache key.
Header RulesetRuleActionParametersCacheKeyCustomKeyHeader
The header names and values to include in building the cache key.
Host RulesetRuleActionParametersCacheKeyCustomKeyHost
Whether to use the original host or the resolved host in the cache key.
QueryString RulesetRuleActionParametersCacheKeyCustomKeyQueryString
Use the presence of parameters in the query string to build the cache key.
User RulesetRuleActionParametersCacheKeyCustomKeyUser
Characteristics of the request user agent used in building the cache key.
Cookie RulesetRuleActionParametersCacheKeyCustomKeyCookie
The cookies to include in building the cache key.
Header RulesetRuleActionParametersCacheKeyCustomKeyHeader
The header names and values to include in building the cache key.
Host RulesetRuleActionParametersCacheKeyCustomKeyHost
Whether to use the original host or the resolved host in the cache key.
QueryString RulesetRuleActionParametersCacheKeyCustomKeyQueryString
Use the presence of parameters in the query string to build the cache key.
User RulesetRuleActionParametersCacheKeyCustomKeyUser
Characteristics of the request user agent used in building the cache key.
cookie RulesetRuleActionParametersCacheKeyCustomKeyCookie
The cookies to include in building the cache key.
header RulesetRuleActionParametersCacheKeyCustomKeyHeader
The header names and values to include in building the cache key.
host RulesetRuleActionParametersCacheKeyCustomKeyHost
Whether to use the original host or the resolved host in the cache key.
queryString RulesetRuleActionParametersCacheKeyCustomKeyQueryString
Use the presence of parameters in the query string to build the cache key.
user RulesetRuleActionParametersCacheKeyCustomKeyUser
Characteristics of the request user agent used in building the cache key.
cookie RulesetRuleActionParametersCacheKeyCustomKeyCookie
The cookies to include in building the cache key.
header RulesetRuleActionParametersCacheKeyCustomKeyHeader
The header names and values to include in building the cache key.
host RulesetRuleActionParametersCacheKeyCustomKeyHost
Whether to use the original host or the resolved host in the cache key.
queryString RulesetRuleActionParametersCacheKeyCustomKeyQueryString
Use the presence of parameters in the query string to build the cache key.
user RulesetRuleActionParametersCacheKeyCustomKeyUser
Characteristics of the request user agent used in building the cache key.
cookie RulesetRuleActionParametersCacheKeyCustomKeyCookie
The cookies to include in building the cache key.
header RulesetRuleActionParametersCacheKeyCustomKeyHeader
The header names and values to include in building the cache key.
host RulesetRuleActionParametersCacheKeyCustomKeyHost
Whether to use the original host or the resolved host in the cache key.
query_string RulesetRuleActionParametersCacheKeyCustomKeyQueryString
Use the presence of parameters in the query string to build the cache key.
user RulesetRuleActionParametersCacheKeyCustomKeyUser
Characteristics of the request user agent used in building the cache key.
cookie 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.
queryString 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

CheckPresences 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.
CheckPresences []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.
checkPresences 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.
checkPresences 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.
checkPresences 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

CheckPresences 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, ImmutableArray<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.
ExcludeOrigin 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.
CheckPresences []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.
ExcludeOrigin 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.
checkPresences 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.
excludeOrigin 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.
checkPresences 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.
excludeOrigin 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.
checkPresences 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.
excludeOrigin 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 RulesetRuleActionParametersCacheKeyCustomKeyQueryStringExclude
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 RulesetRuleActionParametersCacheKeyCustomKeyQueryStringInclude
A list of query string parameters used to build the cache key.
Exclude RulesetRuleActionParametersCacheKeyCustomKeyQueryStringExclude
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 RulesetRuleActionParametersCacheKeyCustomKeyQueryStringInclude
A list of query string parameters used to build the cache key.
exclude RulesetRuleActionParametersCacheKeyCustomKeyQueryStringExclude
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 RulesetRuleActionParametersCacheKeyCustomKeyQueryStringInclude
A list of query string parameters used to build the cache key.
exclude RulesetRuleActionParametersCacheKeyCustomKeyQueryStringExclude
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 RulesetRuleActionParametersCacheKeyCustomKeyQueryStringInclude
A list of query string parameters used to build the cache key.
exclude RulesetRuleActionParametersCacheKeyCustomKeyQueryStringExclude
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 RulesetRuleActionParametersCacheKeyCustomKeyQueryStringInclude
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

All bool
Determines whether to exclude all query string parameters from the cache key.
Lists List<string>
All bool
Determines whether to exclude all query string parameters from the cache key.
Lists []string
all Boolean
Determines whether to exclude all query string parameters from the cache key.
lists List<String>
all boolean
Determines whether to exclude all query string parameters from the cache key.
lists string[]
all bool
Determines whether to exclude all query string parameters from the cache key.
lists Sequence[str]
all Boolean
Determines whether to exclude all query string parameters from the cache key.
lists List<String>

RulesetRuleActionParametersCacheKeyCustomKeyQueryStringInclude
, RulesetRuleActionParametersCacheKeyCustomKeyQueryStringIncludeArgs

All bool
Determines whether to include all query string parameters in the cache key.
Lists List<string>
All bool
Determines whether to include all query string parameters in the cache key.
Lists []string
all Boolean
Determines whether to include all query string parameters in the cache key.
lists List<String>
all boolean
Determines whether to include all query string parameters in the cache key.
lists string[]
all bool
Determines whether to include all query string parameters in the cache key.
lists Sequence[str]
all Boolean
Determines whether to include all query string parameters in the cache key.
lists List<String>

RulesetRuleActionParametersCacheKeyCustomKeyUser
, RulesetRuleActionParametersCacheKeyCustomKeyUserArgs

DeviceType 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.
DeviceType 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.
deviceType 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.
deviceType 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.
deviceType 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 This property is required. 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.
MinimumFileSize This property is required. int
The minimum file size eligible for store in cache reserve.
Eligible This property is required. 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.
MinimumFileSize This property is required. int
The minimum file size eligible for store in cache reserve.
eligible This property is required. 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.
minimumFileSize This property is required. Integer
The minimum file size eligible for store in cache reserve.
eligible This property is required. 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.
minimumFileSize This property is required. number
The minimum file size eligible for store in cache reserve.
eligible This property is required. 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_size This property is required. int
The minimum file size eligible for store in cache reserve.
eligible This property is required. 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.
minimumFileSize This property is required. Number
The minimum file size eligible for store in cache reserve.

RulesetRuleActionParametersCookieField
, RulesetRuleActionParametersCookieFieldArgs

Name This property is required. string
The name of the field.
Name This property is required. string
The name of the field.
name This property is required. String
The name of the field.
name This property is required. string
The name of the field.
name This property is required. str
The name of the field.
name This property is required. String
The name of the field.

RulesetRuleActionParametersEdgeTtl
, RulesetRuleActionParametersEdgeTtlArgs

Mode This property is required. string
edge ttl options Available values: "respectorigin", "bypassbydefault", "overrideorigin".
Default int
The TTL (in seconds) if you choose override_origin mode.
StatusCodeTtls List<RulesetRuleActionParametersEdgeTtlStatusCodeTtl>
List of single status codes, or status code ranges to apply the selected mode
Mode This property is required. string
edge ttl options Available values: "respectorigin", "bypassbydefault", "overrideorigin".
Default int
The TTL (in seconds) if you choose override_origin mode.
StatusCodeTtls []RulesetRuleActionParametersEdgeTtlStatusCodeTtl
List of single status codes, or status code ranges to apply the selected mode
mode This property is required. String
edge ttl options Available values: "respectorigin", "bypassbydefault", "overrideorigin".
default_ Integer
The TTL (in seconds) if you choose override_origin mode.
statusCodeTtls List<RulesetRuleActionParametersEdgeTtlStatusCodeTtl>
List of single status codes, or status code ranges to apply the selected mode
mode This property is required. string
edge ttl options Available values: "respectorigin", "bypassbydefault", "overrideorigin".
default number
The TTL (in seconds) if you choose override_origin mode.
statusCodeTtls RulesetRuleActionParametersEdgeTtlStatusCodeTtl[]
List of single status codes, or status code ranges to apply the selected mode
mode This property is required. str
edge ttl options Available values: "respectorigin", "bypassbydefault", "overrideorigin".
default int
The TTL (in seconds) if you choose override_origin mode.
status_code_ttls Sequence[RulesetRuleActionParametersEdgeTtlStatusCodeTtl]
List of single status codes, or status code ranges to apply the selected mode
mode This property is required. String
edge ttl options Available values: "respectorigin", "bypassbydefault", "overrideorigin".
default Number
The TTL (in seconds) if you choose override_origin mode.
statusCodeTtls List<Property Map>
List of single status codes, or status code ranges to apply the selected mode

RulesetRuleActionParametersEdgeTtlStatusCodeTtl
, RulesetRuleActionParametersEdgeTtlStatusCodeTtlArgs

Value This property is required. 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".
StatusCode int
Set the ttl for responses with this specific status code
StatusCodeRange RulesetRuleActionParametersEdgeTtlStatusCodeTtlStatusCodeRange
The range of status codes used to apply the selected mode.
Value This property is required. 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".
StatusCode int
Set the ttl for responses with this specific status code
StatusCodeRange RulesetRuleActionParametersEdgeTtlStatusCodeTtlStatusCodeRange
The range of status codes used to apply the selected mode.
value This property is required. 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".
statusCode Integer
Set the ttl for responses with this specific status code
statusCodeRange RulesetRuleActionParametersEdgeTtlStatusCodeTtlStatusCodeRange
The range of status codes used to apply the selected mode.
value This property is required. 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".
statusCode number
Set the ttl for responses with this specific status code
statusCodeRange RulesetRuleActionParametersEdgeTtlStatusCodeTtlStatusCodeRange
The range of status codes used to apply the selected mode.
value This property is required. 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_range RulesetRuleActionParametersEdgeTtlStatusCodeTtlStatusCodeRange
The range of status codes used to apply the selected mode.
value This property is required. 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".
statusCode Number
Set the ttl for responses with this specific status code
statusCodeRange Property Map
The range of status codes used to apply the selected mode.

RulesetRuleActionParametersEdgeTtlStatusCodeTtlStatusCodeRange
, RulesetRuleActionParametersEdgeTtlStatusCodeTtlStatusCodeRangeArgs

From int
response status code lower bound
To int
response status code upper bound
From int
response status code lower bound
To int
response status code upper bound
from Integer
response status code lower bound
to Integer
response status code upper bound
from number
response status code lower bound
to number
response status code upper bound
from_ int
response status code lower bound
to int
response status code upper bound
from Number
response status code lower bound
to Number
response status code upper bound

RulesetRuleActionParametersFromList
, RulesetRuleActionParametersFromListArgs

Key string
Expression that evaluates to the list lookup key.
Name string
The name of the list to match against.
Key string
Expression that evaluates to the list lookup key.
Name string
The name of the list to match against.
key String
Expression that evaluates to the list lookup key.
name String
The name of the list to match against.
key string
Expression that evaluates to the list lookup key.
name string
The name of the list to match against.
key str
Expression that evaluates to the list lookup key.
name str
The name of the list to match against.
key String
Expression that evaluates to the list lookup key.
name String
The name of the list to match against.

RulesetRuleActionParametersFromValue
, RulesetRuleActionParametersFromValueArgs

PreserveQueryString bool
Keep the query string of the original request.
StatusCode double
The status code to be used for the redirect. Available values: 301, 302, 303, 307, 308.
TargetUrl RulesetRuleActionParametersFromValueTargetUrl
The URL to redirect the request to.
PreserveQueryString bool
Keep the query string of the original request.
StatusCode float64
The status code to be used for the redirect. Available values: 301, 302, 303, 307, 308.
TargetUrl RulesetRuleActionParametersFromValueTargetUrl
The URL to redirect the request to.
preserveQueryString Boolean
Keep the query string of the original request.
statusCode Double
The status code to be used for the redirect. Available values: 301, 302, 303, 307, 308.
targetUrl RulesetRuleActionParametersFromValueTargetUrl
The URL to redirect the request to.
preserveQueryString boolean
Keep the query string of the original request.
statusCode number
The status code to be used for the redirect. Available values: 301, 302, 303, 307, 308.
targetUrl RulesetRuleActionParametersFromValueTargetUrl
The URL to redirect the request to.
preserve_query_string bool
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 RulesetRuleActionParametersFromValueTargetUrl
The URL to redirect the request to.
preserveQueryString Boolean
Keep the query string of the original request.
statusCode Number
The status code to be used for the redirect. Available values: 301, 302, 303, 307, 308.
targetUrl 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 This property is required. string
Available values: "remove".
Expression string
Expression for the header value.
Value string
Static value for the header.
Operation This property is required. string
Available values: "remove".
Expression string
Expression for the header value.
Value string
Static value for the header.
operation This property is required. String
Available values: "remove".
expression String
Expression for the header value.
value String
Static value for the header.
operation This property is required. string
Available values: "remove".
expression string
Expression for the header value.
value string
Static value for the header.
operation This property is required. str
Available values: "remove".
expression str
Expression for the header value.
value str
Static value for the header.
operation This property is required. String
Available values: "remove".
expression String
Expression for the header value.
value String
Static value for the header.

RulesetRuleActionParametersMatchedData
, RulesetRuleActionParametersMatchedDataArgs

PublicKey This property is required. string
The public key to encrypt matched data logs with.
PublicKey This property is required. string
The public key to encrypt matched data logs with.
publicKey This property is required. String
The public key to encrypt matched data logs with.
publicKey This property is required. string
The public key to encrypt matched data logs with.
public_key This property is required. str
The public key to encrypt matched data logs with.
publicKey This property is required. String
The public key to encrypt matched data logs with.

RulesetRuleActionParametersOrigin
, RulesetRuleActionParametersOriginArgs

Host string
Override the resolved hostname.
Port double
Override the destination port.
Host string
Override the resolved hostname.
Port float64
Override the destination port.
host String
Override the resolved hostname.
port Double
Override the destination port.
host string
Override the resolved hostname.
port number
Override the destination port.
host str
Override the resolved hostname.
port float
Override the destination port.
host String
Override the resolved hostname.
port Number
Override the destination port.

RulesetRuleActionParametersOverrides
, RulesetRuleActionParametersOverridesArgs

Action string
An action to override all rules with. This option has lower precedence than rule and category overrides.
Categories List<RulesetRuleActionParametersOverridesCategory>
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<RulesetRuleActionParametersOverridesRule>
A list of rule-level overrides. This option has the highest precedence.
SensitivityLevel 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 []RulesetRuleActionParametersOverridesCategory
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 []RulesetRuleActionParametersOverridesRule
A list of rule-level overrides. This option has the highest precedence.
SensitivityLevel 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<RulesetRuleActionParametersOverridesCategory>
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<RulesetRuleActionParametersOverridesRule>
A list of rule-level overrides. This option has the highest precedence.
sensitivityLevel 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 RulesetRuleActionParametersOverridesCategory[]
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 RulesetRuleActionParametersOverridesRule[]
A list of rule-level overrides. This option has the highest precedence.
sensitivityLevel 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[RulesetRuleActionParametersOverridesCategory]
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[RulesetRuleActionParametersOverridesRule]
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.
sensitivityLevel 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 This property is required. 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.
SensitivityLevel string
The sensitivity level to use for rules in the category. Available values: "default", "medium", "low", "eoff".
Category This property is required. 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.
SensitivityLevel string
The sensitivity level to use for rules in the category. Available values: "default", "medium", "low", "eoff".
category This property is required. 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.
sensitivityLevel String
The sensitivity level to use for rules in the category. Available values: "default", "medium", "low", "eoff".
category This property is required. 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.
sensitivityLevel string
The sensitivity level to use for rules in the category. Available values: "default", "medium", "low", "eoff".
category This property is required. 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 This property is required. 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.
sensitivityLevel String
The sensitivity level to use for rules in the category. Available values: "default", "medium", "low", "eoff".

RulesetRuleActionParametersOverridesRule
, RulesetRuleActionParametersOverridesRuleArgs

Id This property is required. 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.
ScoreThreshold int
The score threshold to use for the rule.
SensitivityLevel string
The sensitivity level to use for the rule. Available values: "default", "medium", "low", "eoff".
Id This property is required. 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.
ScoreThreshold int
The score threshold to use for the rule.
SensitivityLevel string
The sensitivity level to use for the rule. Available values: "default", "medium", "low", "eoff".
id This property is required. 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.
scoreThreshold Integer
The score threshold to use for the rule.
sensitivityLevel String
The sensitivity level to use for the rule. Available values: "default", "medium", "low", "eoff".
id This property is required. 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.
scoreThreshold number
The score threshold to use for the rule.
sensitivityLevel string
The sensitivity level to use for the rule. Available values: "default", "medium", "low", "eoff".
id This property is required. 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 This property is required. 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.
scoreThreshold Number
The score threshold to use for the rule.
sensitivityLevel String
The sensitivity level to use for the rule. Available values: "default", "medium", "low", "eoff".

RulesetRuleActionParametersRawResponseField
, RulesetRuleActionParametersRawResponseFieldArgs

Name This property is required. string
The name of the field.
PreserveDuplicates bool
Whether to log duplicate values of the same header.
Name This property is required. string
The name of the field.
PreserveDuplicates bool
Whether to log duplicate values of the same header.
name This property is required. String
The name of the field.
preserveDuplicates Boolean
Whether to log duplicate values of the same header.
name This property is required. string
The name of the field.
preserveDuplicates boolean
Whether to log duplicate values of the same header.
name This property is required. str
The name of the field.
preserve_duplicates bool
Whether to log duplicate values of the same header.
name This property is required. String
The name of the field.
preserveDuplicates Boolean
Whether to log duplicate values of the same header.

RulesetRuleActionParametersRequestField
, RulesetRuleActionParametersRequestFieldArgs

Name This property is required. string
The name of the field.
Name This property is required. string
The name of the field.
name This property is required. String
The name of the field.
name This property is required. string
The name of the field.
name This property is required. str
The name of the field.
name This property is required. String
The name of the field.

RulesetRuleActionParametersResponse
, RulesetRuleActionParametersResponseArgs

Content This property is required. string
The content to return.
ContentType This property is required. string
The type of the content to return.
StatusCode This property is required. int
The status code to return.
Content This property is required. string
The content to return.
ContentType This property is required. string
The type of the content to return.
StatusCode This property is required. int
The status code to return.
content This property is required. String
The content to return.
contentType This property is required. String
The type of the content to return.
statusCode This property is required. Integer
The status code to return.
content This property is required. string
The content to return.
contentType This property is required. string
The type of the content to return.
statusCode This property is required. number
The status code to return.
content This property is required. str
The content to return.
content_type This property is required. str
The type of the content to return.
status_code This property is required. int
The status code to return.
content This property is required. String
The content to return.
contentType This property is required. String
The type of the content to return.
statusCode This property is required. Number
The status code to return.

RulesetRuleActionParametersResponseField
, RulesetRuleActionParametersResponseFieldArgs

Name This property is required. string
The name of the field.
PreserveDuplicates bool
Whether to log duplicate values of the same header.
Name This property is required. string
The name of the field.
PreserveDuplicates bool
Whether to log duplicate values of the same header.
name This property is required. String
The name of the field.
preserveDuplicates Boolean
Whether to log duplicate values of the same header.
name This property is required. string
The name of the field.
preserveDuplicates boolean
Whether to log duplicate values of the same header.
name This property is required. str
The name of the field.
preserve_duplicates bool
Whether to log duplicate values of the same header.
name This property is required. String
The name of the field.
preserveDuplicates Boolean
Whether to log duplicate values of the same header.

RulesetRuleActionParametersServeStale
, RulesetRuleActionParametersServeStaleArgs

DisableStaleWhileUpdating This property is required. bool
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.
DisableStaleWhileUpdating This property is required. bool
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.
disableStaleWhileUpdating This property is required. Boolean
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.
disableStaleWhileUpdating This property is required. boolean
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_while_updating This property is required. bool
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.
disableStaleWhileUpdating This property is required. Boolean
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 This property is required. string
The SNI override.
Value This property is required. string
The SNI override.
value This property is required. String
The SNI override.
value This property is required. string
The SNI override.
value This property is required. str
The SNI override.
value This property is required. String
The SNI override.

RulesetRuleActionParametersTransformedRequestField
, RulesetRuleActionParametersTransformedRequestFieldArgs

Name This property is required. string
The name of the field.
Name This property is required. string
The name of the field.
name This property is required. String
The name of the field.
name This property is required. string
The name of the field.
name This property is required. str
The name of the field.
name This property is required. String
The name of the field.

RulesetRuleActionParametersUri
, RulesetRuleActionParametersUriArgs

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

PasswordExpression This property is required. string
Expression that selects the password used in the credentials check.
UsernameExpression This property is required. string
Expression that selects the user ID used in the credentials check.
PasswordExpression This property is required. string
Expression that selects the password used in the credentials check.
UsernameExpression This property is required. string
Expression that selects the user ID used in the credentials check.
passwordExpression This property is required. String
Expression that selects the password used in the credentials check.
usernameExpression This property is required. String
Expression that selects the user ID used in the credentials check.
passwordExpression This property is required. string
Expression that selects the password used in the credentials check.
usernameExpression This property is required. string
Expression that selects the user ID used in the credentials check.
password_expression This property is required. str
Expression that selects the password used in the credentials check.
username_expression This property is required. str
Expression that selects the user ID used in the credentials check.
passwordExpression This property is required. String
Expression that selects the password used in the credentials check.
usernameExpression This property is required. String
Expression that selects the user ID used in the credentials check.

RulesetRuleLogging
, RulesetRuleLoggingArgs

Enabled This property is required. bool
Whether to generate a log when the rule matches.
Enabled This property is required. bool
Whether to generate a log when the rule matches.
enabled This property is required. Boolean
Whether to generate a log when the rule matches.
enabled This property is required. boolean
Whether to generate a log when the rule matches.
enabled This property is required. bool
Whether to generate a log when the rule matches.
enabled This property is required. Boolean
Whether to generate a log when the rule matches.

RulesetRuleRatelimit
, RulesetRuleRatelimitArgs

Characteristics This property is required. List<string>
Characteristics of the request on which the ratelimiter counter will be incremented.
Period This property is required. int
Period in seconds over which the counter is being incremented. Available values: 10, 60, 600, 3600.
CountingExpression string
Defines when the ratelimit counter should be incremented. It is optional and defaults to the same as the rule's expression.
MitigationTimeout int
Period of time in seconds after which the action will be disabled following its first execution.
RequestsPerPeriod int
The threshold of requests per period after which the action will be executed for the first time.
RequestsToOrigin bool
Defines if ratelimit counting is only done when an origin is reached.
ScorePerPeriod int
The score threshold per period for which the action will be executed the first time.
ScoreResponseHeaderName string
The response header name provided by the origin which should contain the score to increment ratelimit counter on.
Characteristics This property is required. []string
Characteristics of the request on which the ratelimiter counter will be incremented.
Period This property is required. int
Period in seconds over which the counter is being incremented. Available values: 10, 60, 600, 3600.
CountingExpression string
Defines when the ratelimit counter should be incremented. It is optional and defaults to the same as the rule's expression.
MitigationTimeout int
Period of time in seconds after which the action will be disabled following its first execution.
RequestsPerPeriod int
The threshold of requests per period after which the action will be executed for the first time.
RequestsToOrigin bool
Defines if ratelimit counting is only done when an origin is reached.
ScorePerPeriod int
The score threshold per period for which the action will be executed the first time.
ScoreResponseHeaderName string
The response header name provided by the origin which should contain the score to increment ratelimit counter on.
characteristics This property is required. List<String>
Characteristics of the request on which the ratelimiter counter will be incremented.
period This property is required. Integer
Period in seconds over which the counter is being incremented. Available values: 10, 60, 600, 3600.
countingExpression String
Defines when the ratelimit counter should be incremented. It is optional and defaults to the same as the rule's expression.
mitigationTimeout Integer
Period of time in seconds after which the action will be disabled following its first execution.
requestsPerPeriod Integer
The threshold of requests per period after which the action will be executed for the first time.
requestsToOrigin Boolean
Defines if ratelimit counting is only done when an origin is reached.
scorePerPeriod Integer
The score threshold per period for which the action will be executed the first time.
scoreResponseHeaderName String
The response header name provided by the origin which should contain the score to increment ratelimit counter on.
characteristics This property is required. string[]
Characteristics of the request on which the ratelimiter counter will be incremented.
period This property is required. number
Period in seconds over which the counter is being incremented. Available values: 10, 60, 600, 3600.
countingExpression string
Defines when the ratelimit counter should be incremented. It is optional and defaults to the same as the rule's expression.
mitigationTimeout number
Period of time in seconds after which the action will be disabled following its first execution.
requestsPerPeriod number
The threshold of requests per period after which the action will be executed for the first time.
requestsToOrigin boolean
Defines if ratelimit counting is only done when an origin is reached.
scorePerPeriod number
The score threshold per period for which the action will be executed the first time.
scoreResponseHeaderName string
The response header name provided by the origin which should contain the score to increment ratelimit counter on.
characteristics This property is required. Sequence[str]
Characteristics of the request on which the ratelimiter counter will be incremented.
period This property is required. 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_period int
The threshold of requests per period after which the action will be executed for the first time.
requests_to_origin bool
Defines if ratelimit counting is only done when an origin is reached.
score_per_period int
The score threshold per period for which the action will be executed the first time.
score_response_header_name str
The response header name provided by the origin which should contain the score to increment ratelimit counter on.
characteristics This property is required. List<String>
Characteristics of the request on which the ratelimiter counter will be incremented.
period This property is required. Number
Period in seconds over which the counter is being incremented. Available values: 10, 60, 600, 3600.
countingExpression String
Defines when the ratelimit counter should be incremented. It is optional and defaults to the same as the rule's expression.
mitigationTimeout Number
Period of time in seconds after which the action will be disabled following its first execution.
requestsPerPeriod Number
The threshold of requests per period after which the action will be executed for the first time.
requestsToOrigin Boolean
Defines if ratelimit counting is only done when an origin is reached.
scorePerPeriod Number
The score threshold per period for which the action will be executed the first time.
scoreResponseHeaderName String
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>'
Copy

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

Package Details

Repository
Cloudflare pulumi/pulumi-cloudflare
License
Apache-2.0
Notes
This Pulumi package is based on the cloudflare Terraform Provider.