Google Cloud v8.25.0, Apr 3 25

Google Cloud v8.25.0 published on Thursday, Apr 3, 2025 by Pulumi

gcp.compute.RegionSecurityPolicy

Explore with Pulumi AI

Google Cloud v8.25.0 published on Thursday, Apr 3, 2025 by Pulumi

pulumi/pulumi-gcp

Example Usage
Region Security Policy Basic
Region Security Policy With Ddos Protection Config
Region Security Policy With User Defined Fields
Region Security Policy With Rules
Create RegionSecurityPolicy Resource
Constructor syntax
Constructor example
RegionSecurityPolicy Resource Properties
Inputs
Outputs
Look up Existing RegionSecurityPolicy Resource
Supporting Types
Import
Package Details

Request a Change

Example Usage

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

const region_sec_policy_basic = new gcp.compute.RegionSecurityPolicy("region-sec-policy-basic", {
    name: "my-sec-policy-basic",
    description: "basic region security policy",
    type: "CLOUD_ARMOR",
});

import pulumi
import pulumi_gcp as gcp

region_sec_policy_basic = gcp.compute.RegionSecurityPolicy("region-sec-policy-basic",
    name="my-sec-policy-basic",
    description="basic region security policy",
    type="CLOUD_ARMOR")

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.NewRegionSecurityPolicy(ctx, "region-sec-policy-basic", &compute.RegionSecurityPolicyArgs{
			Name:        pulumi.String("my-sec-policy-basic"),
			Description: pulumi.String("basic region security policy"),
			Type:        pulumi.String("CLOUD_ARMOR"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var region_sec_policy_basic = new Gcp.Compute.RegionSecurityPolicy("region-sec-policy-basic", new()
    {
        Name = "my-sec-policy-basic",
        Description = "basic region security policy",
        Type = "CLOUD_ARMOR",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.RegionSecurityPolicy;
import com.pulumi.gcp.compute.RegionSecurityPolicyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        var region_sec_policy_basic = new RegionSecurityPolicy("region-sec-policy-basic", RegionSecurityPolicyArgs.builder()
            .name("my-sec-policy-basic")
            .description("basic region security policy")
            .type("CLOUD_ARMOR")
            .build());

    }
}

resources:
  region-sec-policy-basic:
    type: gcp:compute:RegionSecurityPolicy
    properties:
      name: my-sec-policy-basic
      description: basic region security policy
      type: CLOUD_ARMOR

Region Security Policy With Ddos Protection Config

TypeScript
Python
Go
C#
Java
YAML

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

const region_sec_policy_ddos_protection = new gcp.compute.RegionSecurityPolicy("region-sec-policy-ddos-protection", {
    name: "my-sec-policy-ddos-protection",
    description: "with ddos protection config",
    type: "CLOUD_ARMOR_NETWORK",
    ddosProtectionConfig: {
        ddosProtection: "ADVANCED_PREVIEW",
    },
});

import pulumi
import pulumi_gcp as gcp

region_sec_policy_ddos_protection = gcp.compute.RegionSecurityPolicy("region-sec-policy-ddos-protection",
    name="my-sec-policy-ddos-protection",
    description="with ddos protection config",
    type="CLOUD_ARMOR_NETWORK",
    ddos_protection_config={
        "ddos_protection": "ADVANCED_PREVIEW",
    })

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.NewRegionSecurityPolicy(ctx, "region-sec-policy-ddos-protection", &compute.RegionSecurityPolicyArgs{
			Name:        pulumi.String("my-sec-policy-ddos-protection"),
			Description: pulumi.String("with ddos protection config"),
			Type:        pulumi.String("CLOUD_ARMOR_NETWORK"),
			DdosProtectionConfig: &compute.RegionSecurityPolicyDdosProtectionConfigArgs{
				DdosProtection: pulumi.String("ADVANCED_PREVIEW"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var region_sec_policy_ddos_protection = new Gcp.Compute.RegionSecurityPolicy("region-sec-policy-ddos-protection", new()
    {
        Name = "my-sec-policy-ddos-protection",
        Description = "with ddos protection config",
        Type = "CLOUD_ARMOR_NETWORK",
        DdosProtectionConfig = new Gcp.Compute.Inputs.RegionSecurityPolicyDdosProtectionConfigArgs
        {
            DdosProtection = "ADVANCED_PREVIEW",
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.RegionSecurityPolicy;
import com.pulumi.gcp.compute.RegionSecurityPolicyArgs;
import com.pulumi.gcp.compute.inputs.RegionSecurityPolicyDdosProtectionConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        var region_sec_policy_ddos_protection = new RegionSecurityPolicy("region-sec-policy-ddos-protection", RegionSecurityPolicyArgs.builder()
            .name("my-sec-policy-ddos-protection")
            .description("with ddos protection config")
            .type("CLOUD_ARMOR_NETWORK")
            .ddosProtectionConfig(RegionSecurityPolicyDdosProtectionConfigArgs.builder()
                .ddosProtection("ADVANCED_PREVIEW")
                .build())
            .build());

    }
}

resources:
  region-sec-policy-ddos-protection:
    type: gcp:compute:RegionSecurityPolicy
    properties:
      name: my-sec-policy-ddos-protection
      description: with ddos protection config
      type: CLOUD_ARMOR_NETWORK
      ddosProtectionConfig:
        ddosProtection: ADVANCED_PREVIEW

Region Security Policy With User Defined Fields

TypeScript
Python
Go
C#
Java
YAML

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

const region_sec_policy_user_defined_fields = new gcp.compute.RegionSecurityPolicy("region-sec-policy-user-defined-fields", {
    name: "my-sec-policy-user-defined-fields",
    description: "with user defined fields",
    type: "CLOUD_ARMOR_NETWORK",
    userDefinedFields: [
        {
            name: "SIG1_AT_0",
            base: "UDP",
            offset: 8,
            size: 2,
            mask: "0x8F00",
        },
        {
            name: "SIG2_AT_8",
            base: "UDP",
            offset: 16,
            size: 4,
            mask: "0xFFFFFFFF",
        },
    ],
});

import pulumi
import pulumi_gcp as gcp

region_sec_policy_user_defined_fields = gcp.compute.RegionSecurityPolicy("region-sec-policy-user-defined-fields",
    name="my-sec-policy-user-defined-fields",
    description="with user defined fields",
    type="CLOUD_ARMOR_NETWORK",
    user_defined_fields=[
        {
            "name": "SIG1_AT_0",
            "base": "UDP",
            "offset": 8,
            "size": 2,
            "mask": "0x8F00",
        },
        {
            "name": "SIG2_AT_8",
            "base": "UDP",
            "offset": 16,
            "size": 4,
            "mask": "0xFFFFFFFF",
        },
    ])

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.NewRegionSecurityPolicy(ctx, "region-sec-policy-user-defined-fields", &compute.RegionSecurityPolicyArgs{
			Name:        pulumi.String("my-sec-policy-user-defined-fields"),
			Description: pulumi.String("with user defined fields"),
			Type:        pulumi.String("CLOUD_ARMOR_NETWORK"),
			UserDefinedFields: compute.RegionSecurityPolicyUserDefinedFieldArray{
				&compute.RegionSecurityPolicyUserDefinedFieldArgs{
					Name:   pulumi.String("SIG1_AT_0"),
					Base:   pulumi.String("UDP"),
					Offset: pulumi.Int(8),
					Size:   pulumi.Int(2),
					Mask:   pulumi.String("0x8F00"),
				},
				&compute.RegionSecurityPolicyUserDefinedFieldArgs{
					Name:   pulumi.String("SIG2_AT_8"),
					Base:   pulumi.String("UDP"),
					Offset: pulumi.Int(16),
					Size:   pulumi.Int(4),
					Mask:   pulumi.String("0xFFFFFFFF"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var region_sec_policy_user_defined_fields = new Gcp.Compute.RegionSecurityPolicy("region-sec-policy-user-defined-fields", new()
    {
        Name = "my-sec-policy-user-defined-fields",
        Description = "with user defined fields",
        Type = "CLOUD_ARMOR_NETWORK",
        UserDefinedFields = new[]
        {
            new Gcp.Compute.Inputs.RegionSecurityPolicyUserDefinedFieldArgs
            {
                Name = "SIG1_AT_0",
                Base = "UDP",
                Offset = 8,
                Size = 2,
                Mask = "0x8F00",
            },
            new Gcp.Compute.Inputs.RegionSecurityPolicyUserDefinedFieldArgs
            {
                Name = "SIG2_AT_8",
                Base = "UDP",
                Offset = 16,
                Size = 4,
                Mask = "0xFFFFFFFF",
            },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.RegionSecurityPolicy;
import com.pulumi.gcp.compute.RegionSecurityPolicyArgs;
import com.pulumi.gcp.compute.inputs.RegionSecurityPolicyUserDefinedFieldArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        var region_sec_policy_user_defined_fields = new RegionSecurityPolicy("region-sec-policy-user-defined-fields", RegionSecurityPolicyArgs.builder()
            .name("my-sec-policy-user-defined-fields")
            .description("with user defined fields")
            .type("CLOUD_ARMOR_NETWORK")
            .userDefinedFields(            
                RegionSecurityPolicyUserDefinedFieldArgs.builder()
                    .name("SIG1_AT_0")
                    .base("UDP")
                    .offset(8)
                    .size(2)
                    .mask("0x8F00")
                    .build(),
                RegionSecurityPolicyUserDefinedFieldArgs.builder()
                    .name("SIG2_AT_8")
                    .base("UDP")
                    .offset(16)
                    .size(4)
                    .mask("0xFFFFFFFF")
                    .build())
            .build());

    }
}

resources:
  region-sec-policy-user-defined-fields:
    type: gcp:compute:RegionSecurityPolicy
    properties:
      name: my-sec-policy-user-defined-fields
      description: with user defined fields
      type: CLOUD_ARMOR_NETWORK
      userDefinedFields:
        - name: SIG1_AT_0
          base: UDP
          offset: 8
          size: 2
          mask: 0x8F00
        - name: SIG2_AT_8
          base: UDP
          offset: 16
          size: 4
          mask: 0xFFFFFFFF

Region Security Policy With Rules

TypeScript
Python
Go
C#
Java
YAML

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

const region_sec_policy_with_rules = new gcp.compute.RegionSecurityPolicy("region-sec-policy-with-rules", {
    name: "my-sec-policy-with-rules",
    description: "basic region security policy with multiple rules",
    type: "CLOUD_ARMOR",
    rules: [
        {
            action: "deny",
            priority: 1000,
            match: {
                expr: {
                    expression: "request.path.matches(\"/login.html\") && token.recaptcha_session.score < 0.2",
                },
            },
        },
        {
            action: "deny",
            priority: 2147483647,
            match: {
                versionedExpr: "SRC_IPS_V1",
                config: {
                    srcIpRanges: ["*"],
                },
            },
            description: "default rule",
        },
    ],
});

import pulumi
import pulumi_gcp as gcp

region_sec_policy_with_rules = gcp.compute.RegionSecurityPolicy("region-sec-policy-with-rules",
    name="my-sec-policy-with-rules",
    description="basic region security policy with multiple rules",
    type="CLOUD_ARMOR",
    rules=[
        {
            "action": "deny",
            "priority": 1000,
            "match": {
                "expr": {
                    "expression": "request.path.matches(\"/login.html\") && token.recaptcha_session.score < 0.2",
                },
            },
        },
        {
            "action": "deny",
            "priority": 2147483647,
            "match": {
                "versioned_expr": "SRC_IPS_V1",
                "config": {
                    "src_ip_ranges": ["*"],
                },
            },
            "description": "default rule",
        },
    ])

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.NewRegionSecurityPolicy(ctx, "region-sec-policy-with-rules", &compute.RegionSecurityPolicyArgs{
			Name:        pulumi.String("my-sec-policy-with-rules"),
			Description: pulumi.String("basic region security policy with multiple rules"),
			Type:        pulumi.String("CLOUD_ARMOR"),
			Rules: compute.RegionSecurityPolicyRuleTypeArray{
				&compute.RegionSecurityPolicyRuleTypeArgs{
					Action:   pulumi.String("deny"),
					Priority: pulumi.Int(1000),
					Match: &compute.RegionSecurityPolicyRuleMatchArgs{
						Expr: &compute.RegionSecurityPolicyRuleMatchExprArgs{
							Expression: pulumi.String("request.path.matches(\"/login.html\") && token.recaptcha_session.score < 0.2"),
						},
					},
				},
				&compute.RegionSecurityPolicyRuleTypeArgs{
					Action:   pulumi.String("deny"),
					Priority: pulumi.Int(2147483647),
					Match: &compute.RegionSecurityPolicyRuleMatchArgs{
						VersionedExpr: pulumi.String("SRC_IPS_V1"),
						Config: &compute.RegionSecurityPolicyRuleMatchConfigArgs{
							SrcIpRanges: pulumi.StringArray{
								pulumi.String("*"),
							},
						},
					},
					Description: pulumi.String("default rule"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var region_sec_policy_with_rules = new Gcp.Compute.RegionSecurityPolicy("region-sec-policy-with-rules", new()
    {
        Name = "my-sec-policy-with-rules",
        Description = "basic region security policy with multiple rules",
        Type = "CLOUD_ARMOR",
        Rules = new[]
        {
            new Gcp.Compute.Inputs.RegionSecurityPolicyRuleArgs
            {
                Action = "deny",
                Priority = 1000,
                Match = new Gcp.Compute.Inputs.RegionSecurityPolicyRuleMatchArgs
                {
                    Expr = new Gcp.Compute.Inputs.RegionSecurityPolicyRuleMatchExprArgs
                    {
                        Expression = "request.path.matches(\"/login.html\") && token.recaptcha_session.score < 0.2",
                    },
                },
            },
            new Gcp.Compute.Inputs.RegionSecurityPolicyRuleArgs
            {
                Action = "deny",
                Priority = 2147483647,
                Match = new Gcp.Compute.Inputs.RegionSecurityPolicyRuleMatchArgs
                {
                    VersionedExpr = "SRC_IPS_V1",
                    Config = new Gcp.Compute.Inputs.RegionSecurityPolicyRuleMatchConfigArgs
                    {
                        SrcIpRanges = new[]
                        {
                            "*",
                        },
                    },
                },
                Description = "default rule",
            },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.RegionSecurityPolicy;
import com.pulumi.gcp.compute.RegionSecurityPolicyArgs;
import com.pulumi.gcp.compute.inputs.RegionSecurityPolicyRuleArgs;
import com.pulumi.gcp.compute.inputs.RegionSecurityPolicyRuleMatchArgs;
import com.pulumi.gcp.compute.inputs.RegionSecurityPolicyRuleMatchExprArgs;
import com.pulumi.gcp.compute.inputs.RegionSecurityPolicyRuleMatchConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        var region_sec_policy_with_rules = new RegionSecurityPolicy("region-sec-policy-with-rules", RegionSecurityPolicyArgs.builder()
            .name("my-sec-policy-with-rules")
            .description("basic region security policy with multiple rules")
            .type("CLOUD_ARMOR")
            .rules(            
                RegionSecurityPolicyRuleArgs.builder()
                    .action("deny")
                    .priority("1000")
                    .match(RegionSecurityPolicyRuleMatchArgs.builder()
                        .expr(RegionSecurityPolicyRuleMatchExprArgs.builder()
                            .expression("request.path.matches(\"/login.html\") && token.recaptcha_session.score < 0.2")
                            .build())
                        .build())
                    .build(),
                RegionSecurityPolicyRuleArgs.builder()
                    .action("deny")
                    .priority("2147483647")
                    .match(RegionSecurityPolicyRuleMatchArgs.builder()
                        .versionedExpr("SRC_IPS_V1")
                        .config(RegionSecurityPolicyRuleMatchConfigArgs.builder()
                            .srcIpRanges("*")
                            .build())
                        .build())
                    .description("default rule")
                    .build())
            .build());

    }
}

resources:
  region-sec-policy-with-rules:
    type: gcp:compute:RegionSecurityPolicy
    properties:
      name: my-sec-policy-with-rules
      description: basic region security policy with multiple rules
      type: CLOUD_ARMOR
      rules:
        - action: deny
          priority: '1000'
          match:
            expr:
              expression: request.path.matches("/login.html") && token.recaptcha_session.score < 0.2
        - action: deny
          priority: '2147483647'
          match:
            versionedExpr: SRC_IPS_V1
            config:
              srcIpRanges:
                - '*'
          description: default rule

Create RegionSecurityPolicy Resource

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

Constructor syntax

TypeScript
Python
Go
C#
Java
YAML

new RegionSecurityPolicy(name: string, args?: RegionSecurityPolicyArgs, opts?: CustomResourceOptions);

@overload
def RegionSecurityPolicy(resource_name: str,
                         args: Optional[RegionSecurityPolicyArgs] = None,
                         opts: Optional[ResourceOptions] = None)

@overload
def RegionSecurityPolicy(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         ddos_protection_config: Optional[RegionSecurityPolicyDdosProtectionConfigArgs] = None,
                         description: Optional[str] = None,
                         name: Optional[str] = None,
                         project: Optional[str] = None,
                         region: Optional[str] = None,
                         rules: Optional[Sequence[RegionSecurityPolicyRuleArgs]] = None,
                         type: Optional[str] = None,
                         user_defined_fields: Optional[Sequence[RegionSecurityPolicyUserDefinedFieldArgs]] = None)

func NewRegionSecurityPolicy(ctx *Context, name string, args *RegionSecurityPolicyArgs, opts ...ResourceOption) (*RegionSecurityPolicy, error)

public RegionSecurityPolicy(string name, RegionSecurityPolicyArgs? args = null, CustomResourceOptions? opts = null)

public RegionSecurityPolicy(String name, RegionSecurityPolicyArgs args)
public RegionSecurityPolicy(String name, RegionSecurityPolicyArgs args, CustomResourceOptions options)

type: gcp:compute:RegionSecurityPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args RegionSecurityPolicyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args RegionSecurityPolicyArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args RegionSecurityPolicyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args RegionSecurityPolicyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args RegionSecurityPolicyArgs: 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.

TypeScript
Python
Go
C#
Java
YAML

var regionSecurityPolicyResource = new Gcp.Compute.RegionSecurityPolicy("regionSecurityPolicyResource", new()
{
    DdosProtectionConfig = new Gcp.Compute.Inputs.RegionSecurityPolicyDdosProtectionConfigArgs
    {
        DdosProtection = "string",
    },
    Description = "string",
    Name = "string",
    Project = "string",
    Region = "string",
    Rules = new[]
    {
        new Gcp.Compute.Inputs.RegionSecurityPolicyRuleArgs
        {
            Action = "string",
            Priority = 0,
            Description = "string",
            Match = new Gcp.Compute.Inputs.RegionSecurityPolicyRuleMatchArgs
            {
                Config = new Gcp.Compute.Inputs.RegionSecurityPolicyRuleMatchConfigArgs
                {
                    SrcIpRanges = new[]
                    {
                        "string",
                    },
                },
                Expr = new Gcp.Compute.Inputs.RegionSecurityPolicyRuleMatchExprArgs
                {
                    Expression = "string",
                },
                VersionedExpr = "string",
            },
            NetworkMatch = new Gcp.Compute.Inputs.RegionSecurityPolicyRuleNetworkMatchArgs
            {
                DestIpRanges = new[]
                {
                    "string",
                },
                DestPorts = new[]
                {
                    "string",
                },
                IpProtocols = new[]
                {
                    "string",
                },
                SrcAsns = new[]
                {
                    0,
                },
                SrcIpRanges = new[]
                {
                    "string",
                },
                SrcPorts = new[]
                {
                    "string",
                },
                SrcRegionCodes = new[]
                {
                    "string",
                },
                UserDefinedFields = new[]
                {
                    new Gcp.Compute.Inputs.RegionSecurityPolicyRuleNetworkMatchUserDefinedFieldArgs
                    {
                        Name = "string",
                        Values = new[]
                        {
                            "string",
                        },
                    },
                },
            },
            PreconfiguredWafConfig = new Gcp.Compute.Inputs.RegionSecurityPolicyRulePreconfiguredWafConfigArgs
            {
                Exclusions = new[]
                {
                    new Gcp.Compute.Inputs.RegionSecurityPolicyRulePreconfiguredWafConfigExclusionArgs
                    {
                        TargetRuleSet = "string",
                        RequestCookies = new[]
                        {
                            new Gcp.Compute.Inputs.RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestCookyArgs
                            {
                                Operator = "string",
                                Value = "string",
                            },
                        },
                        RequestHeaders = new[]
                        {
                            new Gcp.Compute.Inputs.RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestHeaderArgs
                            {
                                Operator = "string",
                                Value = "string",
                            },
                        },
                        RequestQueryParams = new[]
                        {
                            new Gcp.Compute.Inputs.RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestQueryParamArgs
                            {
                                Operator = "string",
                                Value = "string",
                            },
                        },
                        RequestUris = new[]
                        {
                            new Gcp.Compute.Inputs.RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestUriArgs
                            {
                                Operator = "string",
                                Value = "string",
                            },
                        },
                        TargetRuleIds = new[]
                        {
                            "string",
                        },
                    },
                },
            },
            Preview = false,
            RateLimitOptions = new Gcp.Compute.Inputs.RegionSecurityPolicyRuleRateLimitOptionsArgs
            {
                BanDurationSec = 0,
                BanThreshold = new Gcp.Compute.Inputs.RegionSecurityPolicyRuleRateLimitOptionsBanThresholdArgs
                {
                    Count = 0,
                    IntervalSec = 0,
                },
                ConformAction = "string",
                EnforceOnKey = "string",
                EnforceOnKeyConfigs = new[]
                {
                    new Gcp.Compute.Inputs.RegionSecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigArgs
                    {
                        EnforceOnKeyName = "string",
                        EnforceOnKeyType = "string",
                    },
                },
                EnforceOnKeyName = "string",
                ExceedAction = "string",
                RateLimitThreshold = new Gcp.Compute.Inputs.RegionSecurityPolicyRuleRateLimitOptionsRateLimitThresholdArgs
                {
                    Count = 0,
                    IntervalSec = 0,
                },
            },
        },
    },
    Type = "string",
    UserDefinedFields = new[]
    {
        new Gcp.Compute.Inputs.RegionSecurityPolicyUserDefinedFieldArgs
        {
            Base = "string",
            Mask = "string",
            Name = "string",
            Offset = 0,
            Size = 0,
        },
    },
});

example, err := compute.NewRegionSecurityPolicy(ctx, "regionSecurityPolicyResource", &compute.RegionSecurityPolicyArgs{
	DdosProtectionConfig: &compute.RegionSecurityPolicyDdosProtectionConfigArgs{
		DdosProtection: pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	Project:     pulumi.String("string"),
	Region:      pulumi.String("string"),
	Rules: compute.RegionSecurityPolicyRuleTypeArray{
		&compute.RegionSecurityPolicyRuleTypeArgs{
			Action:      pulumi.String("string"),
			Priority:    pulumi.Int(0),
			Description: pulumi.String("string"),
			Match: &compute.RegionSecurityPolicyRuleMatchArgs{
				Config: &compute.RegionSecurityPolicyRuleMatchConfigArgs{
					SrcIpRanges: pulumi.StringArray{
						pulumi.String("string"),
					},
				},
				Expr: &compute.RegionSecurityPolicyRuleMatchExprArgs{
					Expression: pulumi.String("string"),
				},
				VersionedExpr: pulumi.String("string"),
			},
			NetworkMatch: &compute.RegionSecurityPolicyRuleNetworkMatchArgs{
				DestIpRanges: pulumi.StringArray{
					pulumi.String("string"),
				},
				DestPorts: pulumi.StringArray{
					pulumi.String("string"),
				},
				IpProtocols: pulumi.StringArray{
					pulumi.String("string"),
				},
				SrcAsns: pulumi.IntArray{
					pulumi.Int(0),
				},
				SrcIpRanges: pulumi.StringArray{
					pulumi.String("string"),
				},
				SrcPorts: pulumi.StringArray{
					pulumi.String("string"),
				},
				SrcRegionCodes: pulumi.StringArray{
					pulumi.String("string"),
				},
				UserDefinedFields: compute.RegionSecurityPolicyRuleNetworkMatchUserDefinedFieldArray{
					&compute.RegionSecurityPolicyRuleNetworkMatchUserDefinedFieldArgs{
						Name: pulumi.String("string"),
						Values: pulumi.StringArray{
							pulumi.String("string"),
						},
					},
				},
			},
			PreconfiguredWafConfig: &compute.RegionSecurityPolicyRulePreconfiguredWafConfigArgs{
				Exclusions: compute.RegionSecurityPolicyRulePreconfiguredWafConfigExclusionArray{
					&compute.RegionSecurityPolicyRulePreconfiguredWafConfigExclusionArgs{
						TargetRuleSet: pulumi.String("string"),
						RequestCookies: compute.RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestCookyArray{
							&compute.RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestCookyArgs{
								Operator: pulumi.String("string"),
								Value:    pulumi.String("string"),
							},
						},
						RequestHeaders: compute.RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestHeaderArray{
							&compute.RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestHeaderArgs{
								Operator: pulumi.String("string"),
								Value:    pulumi.String("string"),
							},
						},
						RequestQueryParams: compute.RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestQueryParamArray{
							&compute.RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestQueryParamArgs{
								Operator: pulumi.String("string"),
								Value:    pulumi.String("string"),
							},
						},
						RequestUris: compute.RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestUriArray{
							&compute.RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestUriArgs{
								Operator: pulumi.String("string"),
								Value:    pulumi.String("string"),
							},
						},
						TargetRuleIds: pulumi.StringArray{
							pulumi.String("string"),
						},
					},
				},
			},
			Preview: pulumi.Bool(false),
			RateLimitOptions: &compute.RegionSecurityPolicyRuleRateLimitOptionsArgs{
				BanDurationSec: pulumi.Int(0),
				BanThreshold: &compute.RegionSecurityPolicyRuleRateLimitOptionsBanThresholdArgs{
					Count:       pulumi.Int(0),
					IntervalSec: pulumi.Int(0),
				},
				ConformAction: pulumi.String("string"),
				EnforceOnKey:  pulumi.String("string"),
				EnforceOnKeyConfigs: compute.RegionSecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigArray{
					&compute.RegionSecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigArgs{
						EnforceOnKeyName: pulumi.String("string"),
						EnforceOnKeyType: pulumi.String("string"),
					},
				},
				EnforceOnKeyName: pulumi.String("string"),
				ExceedAction:     pulumi.String("string"),
				RateLimitThreshold: &compute.RegionSecurityPolicyRuleRateLimitOptionsRateLimitThresholdArgs{
					Count:       pulumi.Int(0),
					IntervalSec: pulumi.Int(0),
				},
			},
		},
	},
	Type: pulumi.String("string"),
	UserDefinedFields: compute.RegionSecurityPolicyUserDefinedFieldArray{
		&compute.RegionSecurityPolicyUserDefinedFieldArgs{
			Base:   pulumi.String("string"),
			Mask:   pulumi.String("string"),
			Name:   pulumi.String("string"),
			Offset: pulumi.Int(0),
			Size:   pulumi.Int(0),
		},
	},
})

var regionSecurityPolicyResource = new RegionSecurityPolicy("regionSecurityPolicyResource", RegionSecurityPolicyArgs.builder()
    .ddosProtectionConfig(RegionSecurityPolicyDdosProtectionConfigArgs.builder()
        .ddosProtection("string")
        .build())
    .description("string")
    .name("string")
    .project("string")
    .region("string")
    .rules(RegionSecurityPolicyRuleArgs.builder()
        .action("string")
        .priority(0)
        .description("string")
        .match(RegionSecurityPolicyRuleMatchArgs.builder()
            .config(RegionSecurityPolicyRuleMatchConfigArgs.builder()
                .srcIpRanges("string")
                .build())
            .expr(RegionSecurityPolicyRuleMatchExprArgs.builder()
                .expression("string")
                .build())
            .versionedExpr("string")
            .build())
        .networkMatch(RegionSecurityPolicyRuleNetworkMatchArgs.builder()
            .destIpRanges("string")
            .destPorts("string")
            .ipProtocols("string")
            .srcAsns(0)
            .srcIpRanges("string")
            .srcPorts("string")
            .srcRegionCodes("string")
            .userDefinedFields(RegionSecurityPolicyRuleNetworkMatchUserDefinedFieldArgs.builder()
                .name("string")
                .values("string")
                .build())
            .build())
        .preconfiguredWafConfig(RegionSecurityPolicyRulePreconfiguredWafConfigArgs.builder()
            .exclusions(RegionSecurityPolicyRulePreconfiguredWafConfigExclusionArgs.builder()
                .targetRuleSet("string")
                .requestCookies(RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestCookyArgs.builder()
                    .operator("string")
                    .value("string")
                    .build())
                .requestHeaders(RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestHeaderArgs.builder()
                    .operator("string")
                    .value("string")
                    .build())
                .requestQueryParams(RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestQueryParamArgs.builder()
                    .operator("string")
                    .value("string")
                    .build())
                .requestUris(RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestUriArgs.builder()
                    .operator("string")
                    .value("string")
                    .build())
                .targetRuleIds("string")
                .build())
            .build())
        .preview(false)
        .rateLimitOptions(RegionSecurityPolicyRuleRateLimitOptionsArgs.builder()
            .banDurationSec(0)
            .banThreshold(RegionSecurityPolicyRuleRateLimitOptionsBanThresholdArgs.builder()
                .count(0)
                .intervalSec(0)
                .build())
            .conformAction("string")
            .enforceOnKey("string")
            .enforceOnKeyConfigs(RegionSecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigArgs.builder()
                .enforceOnKeyName("string")
                .enforceOnKeyType("string")
                .build())
            .enforceOnKeyName("string")
            .exceedAction("string")
            .rateLimitThreshold(RegionSecurityPolicyRuleRateLimitOptionsRateLimitThresholdArgs.builder()
                .count(0)
                .intervalSec(0)
                .build())
            .build())
        .build())
    .type("string")
    .userDefinedFields(RegionSecurityPolicyUserDefinedFieldArgs.builder()
        .base("string")
        .mask("string")
        .name("string")
        .offset(0)
        .size(0)
        .build())
    .build());

region_security_policy_resource = gcp.compute.RegionSecurityPolicy("regionSecurityPolicyResource",
    ddos_protection_config={
        "ddos_protection": "string",
    },
    description="string",
    name="string",
    project="string",
    region="string",
    rules=[{
        "action": "string",
        "priority": 0,
        "description": "string",
        "match": {
            "config": {
                "src_ip_ranges": ["string"],
            },
            "expr": {
                "expression": "string",
            },
            "versioned_expr": "string",
        },
        "network_match": {
            "dest_ip_ranges": ["string"],
            "dest_ports": ["string"],
            "ip_protocols": ["string"],
            "src_asns": [0],
            "src_ip_ranges": ["string"],
            "src_ports": ["string"],
            "src_region_codes": ["string"],
            "user_defined_fields": [{
                "name": "string",
                "values": ["string"],
            }],
        },
        "preconfigured_waf_config": {
            "exclusions": [{
                "target_rule_set": "string",
                "request_cookies": [{
                    "operator": "string",
                    "value": "string",
                }],
                "request_headers": [{
                    "operator": "string",
                    "value": "string",
                }],
                "request_query_params": [{
                    "operator": "string",
                    "value": "string",
                }],
                "request_uris": [{
                    "operator": "string",
                    "value": "string",
                }],
                "target_rule_ids": ["string"],
            }],
        },
        "preview": False,
        "rate_limit_options": {
            "ban_duration_sec": 0,
            "ban_threshold": {
                "count": 0,
                "interval_sec": 0,
            },
            "conform_action": "string",
            "enforce_on_key": "string",
            "enforce_on_key_configs": [{
                "enforce_on_key_name": "string",
                "enforce_on_key_type": "string",
            }],
            "enforce_on_key_name": "string",
            "exceed_action": "string",
            "rate_limit_threshold": {
                "count": 0,
                "interval_sec": 0,
            },
        },
    }],
    type="string",
    user_defined_fields=[{
        "base": "string",
        "mask": "string",
        "name": "string",
        "offset": 0,
        "size": 0,
    }])

const regionSecurityPolicyResource = new gcp.compute.RegionSecurityPolicy("regionSecurityPolicyResource", {
    ddosProtectionConfig: {
        ddosProtection: "string",
    },
    description: "string",
    name: "string",
    project: "string",
    region: "string",
    rules: [{
        action: "string",
        priority: 0,
        description: "string",
        match: {
            config: {
                srcIpRanges: ["string"],
            },
            expr: {
                expression: "string",
            },
            versionedExpr: "string",
        },
        networkMatch: {
            destIpRanges: ["string"],
            destPorts: ["string"],
            ipProtocols: ["string"],
            srcAsns: [0],
            srcIpRanges: ["string"],
            srcPorts: ["string"],
            srcRegionCodes: ["string"],
            userDefinedFields: [{
                name: "string",
                values: ["string"],
            }],
        },
        preconfiguredWafConfig: {
            exclusions: [{
                targetRuleSet: "string",
                requestCookies: [{
                    operator: "string",
                    value: "string",
                }],
                requestHeaders: [{
                    operator: "string",
                    value: "string",
                }],
                requestQueryParams: [{
                    operator: "string",
                    value: "string",
                }],
                requestUris: [{
                    operator: "string",
                    value: "string",
                }],
                targetRuleIds: ["string"],
            }],
        },
        preview: false,
        rateLimitOptions: {
            banDurationSec: 0,
            banThreshold: {
                count: 0,
                intervalSec: 0,
            },
            conformAction: "string",
            enforceOnKey: "string",
            enforceOnKeyConfigs: [{
                enforceOnKeyName: "string",
                enforceOnKeyType: "string",
            }],
            enforceOnKeyName: "string",
            exceedAction: "string",
            rateLimitThreshold: {
                count: 0,
                intervalSec: 0,
            },
        },
    }],
    type: "string",
    userDefinedFields: [{
        base: "string",
        mask: "string",
        name: "string",
        offset: 0,
        size: 0,
    }],
});

type: gcp:compute:RegionSecurityPolicy
properties:
    ddosProtectionConfig:
        ddosProtection: string
    description: string
    name: string
    project: string
    region: string
    rules:
        - action: string
          description: string
          match:
            config:
                srcIpRanges:
                    - string
            expr:
                expression: string
            versionedExpr: string
          networkMatch:
            destIpRanges:
                - string
            destPorts:
                - string
            ipProtocols:
                - string
            srcAsns:
                - 0
            srcIpRanges:
                - string
            srcPorts:
                - string
            srcRegionCodes:
                - string
            userDefinedFields:
                - name: string
                  values:
                    - string
          preconfiguredWafConfig:
            exclusions:
                - requestCookies:
                    - operator: string
                      value: string
                  requestHeaders:
                    - operator: string
                      value: string
                  requestQueryParams:
                    - operator: string
                      value: string
                  requestUris:
                    - operator: string
                      value: string
                  targetRuleIds:
                    - string
                  targetRuleSet: string
          preview: false
          priority: 0
          rateLimitOptions:
            banDurationSec: 0
            banThreshold:
                count: 0
                intervalSec: 0
            conformAction: string
            enforceOnKey: string
            enforceOnKeyConfigs:
                - enforceOnKeyName: string
                  enforceOnKeyType: string
            enforceOnKeyName: string
            exceedAction: string
            rateLimitThreshold:
                count: 0
                intervalSec: 0
    type: string
    userDefinedFields:
        - base: string
          mask: string
          name: string
          offset: 0
          size: 0

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

DdosProtectionConfig RegionSecurityPolicyDdosProtectionConfig

Configuration for Google Cloud Armor DDOS Proctection Config. Structure is documented below.

Description string

An optional description of this resource. Provide this property when you create the resource.

Name string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Region string

The Region in which the created Region Security Policy should reside. If it is not provided, the provider region is used.

Rules List<RegionSecurityPolicyRule>

The set of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a security policy, a default rule with action "allow" will be added. Structure is documented below.

Type string

The type indicates the intended use of the security policy.

CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers.
CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache.
CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time. Possible values are: CLOUD_ARMOR, CLOUD_ARMOR_EDGE, CLOUD_ARMOR_NETWORK.

UserDefinedFields List<RegionSecurityPolicyUserDefinedField>

Definitions of user-defined fields for CLOUD_ARMOR_NETWORK policies. A user-defined field consists of up to 4 bytes extracted from a fixed offset in the packet, relative to the IPv4, IPv6, TCP, or UDP header, with an optional mask to select certain bits. Rules may then specify matching values for these fields. Structure is documented below.

DdosProtectionConfig RegionSecurityPolicyDdosProtectionConfigArgs

Configuration for Google Cloud Armor DDOS Proctection Config. Structure is documented below.

Description string

An optional description of this resource. Provide this property when you create the resource.

Name string

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Region string

The Region in which the created Region Security Policy should reside. If it is not provided, the provider region is used.

Rules []RegionSecurityPolicyRuleTypeArgs

Type string

The type indicates the intended use of the security policy.

CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers.
CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache.
CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time. Possible values are: CLOUD_ARMOR, CLOUD_ARMOR_EDGE, CLOUD_ARMOR_NETWORK.

UserDefinedFields []RegionSecurityPolicyUserDefinedFieldArgs

ddosProtectionConfig RegionSecurityPolicyDdosProtectionConfig

Configuration for Google Cloud Armor DDOS Proctection Config. Structure is documented below.

description String

An optional description of this resource. Provide this property when you create the resource.

name String

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

region String

The Region in which the created Region Security Policy should reside. If it is not provided, the provider region is used.

rules List<RegionSecurityPolicyRule>

type String

The type indicates the intended use of the security policy.

CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers.
CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache.
CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time. Possible values are: CLOUD_ARMOR, CLOUD_ARMOR_EDGE, CLOUD_ARMOR_NETWORK.

userDefinedFields List<RegionSecurityPolicyUserDefinedField>

ddosProtectionConfig RegionSecurityPolicyDdosProtectionConfig

Configuration for Google Cloud Armor DDOS Proctection Config. Structure is documented below.

description string

An optional description of this resource. Provide this property when you create the resource.

name string

project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

region string

The Region in which the created Region Security Policy should reside. If it is not provided, the provider region is used.

rules RegionSecurityPolicyRule[]

type string

The type indicates the intended use of the security policy.

CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers.
CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache.
CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time. Possible values are: CLOUD_ARMOR, CLOUD_ARMOR_EDGE, CLOUD_ARMOR_NETWORK.

userDefinedFields RegionSecurityPolicyUserDefinedField[]

ddos_protection_config RegionSecurityPolicyDdosProtectionConfigArgs

Configuration for Google Cloud Armor DDOS Proctection Config. Structure is documented below.

description str

An optional description of this resource. Provide this property when you create the resource.

name str

project str

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

region str

The Region in which the created Region Security Policy should reside. If it is not provided, the provider region is used.

rules Sequence[RegionSecurityPolicyRuleArgs]

type str

The type indicates the intended use of the security policy.

CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers.
CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache.
CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time. Possible values are: CLOUD_ARMOR, CLOUD_ARMOR_EDGE, CLOUD_ARMOR_NETWORK.

user_defined_fields Sequence[RegionSecurityPolicyUserDefinedFieldArgs]

ddosProtectionConfig Property Map

Configuration for Google Cloud Armor DDOS Proctection Config. Structure is documented below.

description String

An optional description of this resource. Provide this property when you create the resource.

name String

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

region String

The Region in which the created Region Security Policy should reside. If it is not provided, the provider region is used.

rules List<Property Map>

type String

The type indicates the intended use of the security policy.

CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers.
CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache.
CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time. Possible values are: CLOUD_ARMOR, CLOUD_ARMOR_EDGE, CLOUD_ARMOR_NETWORK.

userDefinedFields List<Property Map>

Outputs

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

Fingerprint string: Fingerprint of this resource. This field is used internally during updates of this resource.
Id string: The provider-assigned unique ID for this managed resource.
PolicyId string: The unique identifier for the resource. This identifier is defined by the server.
SelfLink string: Server-defined URL for the resource.
SelfLinkWithPolicyId string: Server-defined URL for this resource with the resource id.

Fingerprint string: Fingerprint of this resource. This field is used internally during updates of this resource.
Id string: The provider-assigned unique ID for this managed resource.
PolicyId string: The unique identifier for the resource. This identifier is defined by the server.
SelfLink string: Server-defined URL for the resource.
SelfLinkWithPolicyId string: Server-defined URL for this resource with the resource id.

fingerprint String: Fingerprint of this resource. This field is used internally during updates of this resource.
id String: The provider-assigned unique ID for this managed resource.
policyId String: The unique identifier for the resource. This identifier is defined by the server.
selfLink String: Server-defined URL for the resource.
selfLinkWithPolicyId String: Server-defined URL for this resource with the resource id.

fingerprint string: Fingerprint of this resource. This field is used internally during updates of this resource.
id string: The provider-assigned unique ID for this managed resource.
policyId string: The unique identifier for the resource. This identifier is defined by the server.
selfLink string: Server-defined URL for the resource.
selfLinkWithPolicyId string: Server-defined URL for this resource with the resource id.

fingerprint str: Fingerprint of this resource. This field is used internally during updates of this resource.
id str: The provider-assigned unique ID for this managed resource.
policy_id str: The unique identifier for the resource. This identifier is defined by the server.
self_link str: Server-defined URL for the resource.
self_link_with_policy_id str: Server-defined URL for this resource with the resource id.

fingerprint String: Fingerprint of this resource. This field is used internally during updates of this resource.
id String: The provider-assigned unique ID for this managed resource.
policyId String: The unique identifier for the resource. This identifier is defined by the server.
selfLink String: Server-defined URL for the resource.
selfLinkWithPolicyId String: Server-defined URL for this resource with the resource id.

Look up Existing RegionSecurityPolicy Resource

Get an existing RegionSecurityPolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

TypeScript
Python
Go
C#
Java
YAML

public static get(name: string, id: Input<ID>, state?: RegionSecurityPolicyState, opts?: CustomResourceOptions): RegionSecurityPolicy

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ddos_protection_config: Optional[RegionSecurityPolicyDdosProtectionConfigArgs] = None,
        description: Optional[str] = None,
        fingerprint: Optional[str] = None,
        name: Optional[str] = None,
        policy_id: Optional[str] = None,
        project: Optional[str] = None,
        region: Optional[str] = None,
        rules: Optional[Sequence[RegionSecurityPolicyRuleArgs]] = None,
        self_link: Optional[str] = None,
        self_link_with_policy_id: Optional[str] = None,
        type: Optional[str] = None,
        user_defined_fields: Optional[Sequence[RegionSecurityPolicyUserDefinedFieldArgs]] = None) -> RegionSecurityPolicy

func GetRegionSecurityPolicy(ctx *Context, name string, id IDInput, state *RegionSecurityPolicyState, opts ...ResourceOption) (*RegionSecurityPolicy, error)

public static RegionSecurityPolicy Get(string name, Input<string> id, RegionSecurityPolicyState? state, CustomResourceOptions? opts = null)

public static RegionSecurityPolicy get(String name, Output<String> id, RegionSecurityPolicyState state, CustomResourceOptions options)

resources:  _:    type: gcp:compute:RegionSecurityPolicy    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

DdosProtectionConfig RegionSecurityPolicyDdosProtectionConfig

Configuration for Google Cloud Armor DDOS Proctection Config. Structure is documented below.

Description string

An optional description of this resource. Provide this property when you create the resource.

Fingerprint string

Fingerprint of this resource. This field is used internally during updates of this resource.

Name string

PolicyId string

The unique identifier for the resource. This identifier is defined by the server.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Region string

The Region in which the created Region Security Policy should reside. If it is not provided, the provider region is used.

Rules List<RegionSecurityPolicyRule>

SelfLink string

Server-defined URL for the resource.

SelfLinkWithPolicyId string

Server-defined URL for this resource with the resource id.

Type string

The type indicates the intended use of the security policy.

CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers.
CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache.
CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time. Possible values are: CLOUD_ARMOR, CLOUD_ARMOR_EDGE, CLOUD_ARMOR_NETWORK.

UserDefinedFields List<RegionSecurityPolicyUserDefinedField>

DdosProtectionConfig RegionSecurityPolicyDdosProtectionConfigArgs

Configuration for Google Cloud Armor DDOS Proctection Config. Structure is documented below.

Description string

An optional description of this resource. Provide this property when you create the resource.

Fingerprint string

Fingerprint of this resource. This field is used internally during updates of this resource.

Name string

PolicyId string

The unique identifier for the resource. This identifier is defined by the server.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Region string

The Region in which the created Region Security Policy should reside. If it is not provided, the provider region is used.

Rules []RegionSecurityPolicyRuleTypeArgs

SelfLink string

Server-defined URL for the resource.

SelfLinkWithPolicyId string

Server-defined URL for this resource with the resource id.

Type string

The type indicates the intended use of the security policy.

CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers.
CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache.
CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time. Possible values are: CLOUD_ARMOR, CLOUD_ARMOR_EDGE, CLOUD_ARMOR_NETWORK.

UserDefinedFields []RegionSecurityPolicyUserDefinedFieldArgs

ddosProtectionConfig RegionSecurityPolicyDdosProtectionConfig

Configuration for Google Cloud Armor DDOS Proctection Config. Structure is documented below.

description String

An optional description of this resource. Provide this property when you create the resource.

fingerprint String

Fingerprint of this resource. This field is used internally during updates of this resource.

name String

policyId String

The unique identifier for the resource. This identifier is defined by the server.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

region String

The Region in which the created Region Security Policy should reside. If it is not provided, the provider region is used.

rules List<RegionSecurityPolicyRule>

selfLink String

Server-defined URL for the resource.

selfLinkWithPolicyId String

Server-defined URL for this resource with the resource id.

type String

The type indicates the intended use of the security policy.

CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers.
CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache.
CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time. Possible values are: CLOUD_ARMOR, CLOUD_ARMOR_EDGE, CLOUD_ARMOR_NETWORK.

userDefinedFields List<RegionSecurityPolicyUserDefinedField>

ddosProtectionConfig RegionSecurityPolicyDdosProtectionConfig

Configuration for Google Cloud Armor DDOS Proctection Config. Structure is documented below.

description string

An optional description of this resource. Provide this property when you create the resource.

fingerprint string

Fingerprint of this resource. This field is used internally during updates of this resource.

name string

policyId string

The unique identifier for the resource. This identifier is defined by the server.

project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

region string

The Region in which the created Region Security Policy should reside. If it is not provided, the provider region is used.

rules RegionSecurityPolicyRule[]

selfLink string

Server-defined URL for the resource.

selfLinkWithPolicyId string

Server-defined URL for this resource with the resource id.

type string

The type indicates the intended use of the security policy.

CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers.
CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache.
CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time. Possible values are: CLOUD_ARMOR, CLOUD_ARMOR_EDGE, CLOUD_ARMOR_NETWORK.

userDefinedFields RegionSecurityPolicyUserDefinedField[]

ddos_protection_config RegionSecurityPolicyDdosProtectionConfigArgs

Configuration for Google Cloud Armor DDOS Proctection Config. Structure is documented below.

description str

An optional description of this resource. Provide this property when you create the resource.

fingerprint str

Fingerprint of this resource. This field is used internally during updates of this resource.

name str

policy_id str

The unique identifier for the resource. This identifier is defined by the server.

project str

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

region str

The Region in which the created Region Security Policy should reside. If it is not provided, the provider region is used.

rules Sequence[RegionSecurityPolicyRuleArgs]

self_link str

Server-defined URL for the resource.

self_link_with_policy_id str

Server-defined URL for this resource with the resource id.

type str

The type indicates the intended use of the security policy.

CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers.
CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache.
CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time. Possible values are: CLOUD_ARMOR, CLOUD_ARMOR_EDGE, CLOUD_ARMOR_NETWORK.

user_defined_fields Sequence[RegionSecurityPolicyUserDefinedFieldArgs]

ddosProtectionConfig Property Map

Configuration for Google Cloud Armor DDOS Proctection Config. Structure is documented below.

description String

An optional description of this resource. Provide this property when you create the resource.

fingerprint String

Fingerprint of this resource. This field is used internally during updates of this resource.

name String

policyId String

The unique identifier for the resource. This identifier is defined by the server.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

region String

The Region in which the created Region Security Policy should reside. If it is not provided, the provider region is used.

rules List<Property Map>

selfLink String

Server-defined URL for the resource.

selfLinkWithPolicyId String

Server-defined URL for this resource with the resource id.

type String

The type indicates the intended use of the security policy.

CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers.
CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache.
CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time. Possible values are: CLOUD_ARMOR, CLOUD_ARMOR_EDGE, CLOUD_ARMOR_NETWORK.

userDefinedFields List<Property Map>

Supporting Types

RegionSecurityPolicyDdosProtectionConfig
, RegionSecurityPolicyDdosProtectionConfigArgs

DdosProtection string

Google Cloud Armor offers the following options to help protect systems against DDoS attacks:

STANDARD: basic always-on protection for network load balancers, protocol forwarding, or VMs with public IP addresses.
ADVANCED: additional protections for Managed Protection Plus subscribers who use network load balancers, protocol forwarding, or VMs with public IP addresses.
ADVANCED_PREVIEW: flag to enable the security policy in preview mode. Possible values are: ADVANCED, ADVANCED_PREVIEW, STANDARD.

DdosProtection string

Google Cloud Armor offers the following options to help protect systems against DDoS attacks:

STANDARD: basic always-on protection for network load balancers, protocol forwarding, or VMs with public IP addresses.
ADVANCED: additional protections for Managed Protection Plus subscribers who use network load balancers, protocol forwarding, or VMs with public IP addresses.
ADVANCED_PREVIEW: flag to enable the security policy in preview mode. Possible values are: ADVANCED, ADVANCED_PREVIEW, STANDARD.

ddosProtection String

Google Cloud Armor offers the following options to help protect systems against DDoS attacks:

STANDARD: basic always-on protection for network load balancers, protocol forwarding, or VMs with public IP addresses.
ADVANCED: additional protections for Managed Protection Plus subscribers who use network load balancers, protocol forwarding, or VMs with public IP addresses.
ADVANCED_PREVIEW: flag to enable the security policy in preview mode. Possible values are: ADVANCED, ADVANCED_PREVIEW, STANDARD.

ddosProtection string

Google Cloud Armor offers the following options to help protect systems against DDoS attacks:

STANDARD: basic always-on protection for network load balancers, protocol forwarding, or VMs with public IP addresses.
ADVANCED: additional protections for Managed Protection Plus subscribers who use network load balancers, protocol forwarding, or VMs with public IP addresses.
ADVANCED_PREVIEW: flag to enable the security policy in preview mode. Possible values are: ADVANCED, ADVANCED_PREVIEW, STANDARD.

ddos_protection str

Google Cloud Armor offers the following options to help protect systems against DDoS attacks:

STANDARD: basic always-on protection for network load balancers, protocol forwarding, or VMs with public IP addresses.
ADVANCED: additional protections for Managed Protection Plus subscribers who use network load balancers, protocol forwarding, or VMs with public IP addresses.
ADVANCED_PREVIEW: flag to enable the security policy in preview mode. Possible values are: ADVANCED, ADVANCED_PREVIEW, STANDARD.

ddosProtection String

Google Cloud Armor offers the following options to help protect systems against DDoS attacks:

STANDARD: basic always-on protection for network load balancers, protocol forwarding, or VMs with public IP addresses.
ADVANCED: additional protections for Managed Protection Plus subscribers who use network load balancers, protocol forwarding, or VMs with public IP addresses.
ADVANCED_PREVIEW: flag to enable the security policy in preview mode. Possible values are: ADVANCED, ADVANCED_PREVIEW, STANDARD.

RegionSecurityPolicyRule
, RegionSecurityPolicyRuleArgs

Action string

The Action to perform when the rule is matched. The following are the valid actions:

allow: allow access to target.
deny(STATUS): deny access to target, returns the HTTP response code specified. Valid values for STATUS are 403, 404, and 502.
rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rateLimitOptions to be set.
redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. This action is only supported in Global Security Policies of type CLOUD_ARMOR.
throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rateLimitOptions to be set for this.

Priority int

An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.

Description string

An optional description of this resource. Provide this property when you create the resource.

Match RegionSecurityPolicyRuleMatch

A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. Structure is documented below.

NetworkMatch RegionSecurityPolicyRuleNetworkMatch

A match condition that incoming packets are evaluated against for CLOUD_ARMOR_NETWORK security policies. If it matches, the corresponding 'action' is enforced. The match criteria for a rule consists of built-in match fields (like 'srcIpRanges') and potentially multiple user-defined match fields ('userDefinedFields'). Field values may be extracted directly from the packet or derived from it (e.g. 'srcRegionCodes'). Some fields may not be present in every packet (e.g. 'srcPorts'). A user-defined field is only present if the base header is found in the packet and the entire field is in bounds. Each match field may specify which values can match it, listing one or more ranges, prefixes, or exact values that are considered a match for the field. A field value must be present in order to match a specified match field. If no match values are specified for a match field, then any field value is considered to match it, and it's not required to be present. For strings specifying '*' is also equivalent to match all. For a packet to match a rule, all specified match fields must match the corresponding field values derived from the packet. Example: networkMatch: srcIpRanges: - "192.0.2.0/24" - "198.51.100.0/24" userDefinedFields: - name: "ipv4_fragment_offset" values: - "1-0x1fff" The above match condition matches packets with a source IP in 192.0.2.0/24 or 198.51.100.0/24 and a user-defined field named "ipv4_fragment_offset" with a value between 1 and 0x1fff inclusive Structure is documented below.

PreconfiguredWafConfig RegionSecurityPolicyRulePreconfiguredWafConfig

Preconfigured WAF configuration to be applied for the rule. If the rule does not evaluate preconfigured WAF rules, i.e., if evaluatePreconfiguredWaf() is not used, this field will have no effect. Structure is documented below.

Preview bool

If set to true, the specified action is not enforced.

RateLimitOptions RegionSecurityPolicyRuleRateLimitOptions

Must be specified if the action is "rate_based_ban" or "throttle". Cannot be specified for any other actions. Structure is documented below.

Action string

The Action to perform when the rule is matched. The following are the valid actions:

allow: allow access to target.
deny(STATUS): deny access to target, returns the HTTP response code specified. Valid values for STATUS are 403, 404, and 502.
rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rateLimitOptions to be set.
redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. This action is only supported in Global Security Policies of type CLOUD_ARMOR.
throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rateLimitOptions to be set for this.

Priority int

Description string

An optional description of this resource. Provide this property when you create the resource.

Match RegionSecurityPolicyRuleMatch

A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. Structure is documented below.

NetworkMatch RegionSecurityPolicyRuleNetworkMatch

PreconfiguredWafConfig RegionSecurityPolicyRulePreconfiguredWafConfig

Preview bool

If set to true, the specified action is not enforced.

RateLimitOptions RegionSecurityPolicyRuleRateLimitOptions

Must be specified if the action is "rate_based_ban" or "throttle". Cannot be specified for any other actions. Structure is documented below.

action String

The Action to perform when the rule is matched. The following are the valid actions:

allow: allow access to target.
deny(STATUS): deny access to target, returns the HTTP response code specified. Valid values for STATUS are 403, 404, and 502.
rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rateLimitOptions to be set.
redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. This action is only supported in Global Security Policies of type CLOUD_ARMOR.
throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rateLimitOptions to be set for this.

priority Integer

description String

An optional description of this resource. Provide this property when you create the resource.

match RegionSecurityPolicyRuleMatch

A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. Structure is documented below.

networkMatch RegionSecurityPolicyRuleNetworkMatch

preconfiguredWafConfig RegionSecurityPolicyRulePreconfiguredWafConfig

preview Boolean

If set to true, the specified action is not enforced.

rateLimitOptions RegionSecurityPolicyRuleRateLimitOptions

Must be specified if the action is "rate_based_ban" or "throttle". Cannot be specified for any other actions. Structure is documented below.

action string

The Action to perform when the rule is matched. The following are the valid actions:

allow: allow access to target.
deny(STATUS): deny access to target, returns the HTTP response code specified. Valid values for STATUS are 403, 404, and 502.
rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rateLimitOptions to be set.
redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. This action is only supported in Global Security Policies of type CLOUD_ARMOR.
throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rateLimitOptions to be set for this.

priority number

description string

An optional description of this resource. Provide this property when you create the resource.

match RegionSecurityPolicyRuleMatch

A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. Structure is documented below.

networkMatch RegionSecurityPolicyRuleNetworkMatch

preconfiguredWafConfig RegionSecurityPolicyRulePreconfiguredWafConfig

preview boolean

If set to true, the specified action is not enforced.

rateLimitOptions RegionSecurityPolicyRuleRateLimitOptions

Must be specified if the action is "rate_based_ban" or "throttle". Cannot be specified for any other actions. Structure is documented below.

action str

The Action to perform when the rule is matched. The following are the valid actions:

allow: allow access to target.
deny(STATUS): deny access to target, returns the HTTP response code specified. Valid values for STATUS are 403, 404, and 502.
rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rateLimitOptions to be set.
redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. This action is only supported in Global Security Policies of type CLOUD_ARMOR.
throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rateLimitOptions to be set for this.

priority int

description str

An optional description of this resource. Provide this property when you create the resource.

match RegionSecurityPolicyRuleMatch

A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. Structure is documented below.

network_match RegionSecurityPolicyRuleNetworkMatch

preconfigured_waf_config RegionSecurityPolicyRulePreconfiguredWafConfig

preview bool

If set to true, the specified action is not enforced.

rate_limit_options RegionSecurityPolicyRuleRateLimitOptions

Must be specified if the action is "rate_based_ban" or "throttle". Cannot be specified for any other actions. Structure is documented below.

action String

The Action to perform when the rule is matched. The following are the valid actions:

allow: allow access to target.
deny(STATUS): deny access to target, returns the HTTP response code specified. Valid values for STATUS are 403, 404, and 502.
rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rateLimitOptions to be set.
redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. This action is only supported in Global Security Policies of type CLOUD_ARMOR.
throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rateLimitOptions to be set for this.

priority Number

description String

An optional description of this resource. Provide this property when you create the resource.

match Property Map

A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. Structure is documented below.

networkMatch Property Map

preconfiguredWafConfig Property Map

preview Boolean

If set to true, the specified action is not enforced.

rateLimitOptions Property Map

Must be specified if the action is "rate_based_ban" or "throttle". Cannot be specified for any other actions. Structure is documented below.

RegionSecurityPolicyRuleMatch
, RegionSecurityPolicyRuleMatchArgs

Config RegionSecurityPolicyRuleMatchConfig: The configuration options available when specifying versionedExpr. This field must be specified if versionedExpr is specified and cannot be specified if versionedExpr is not specified. Structure is documented below.
Expr RegionSecurityPolicyRuleMatchExpr: User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Structure is documented below.
VersionedExpr string: Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding srcIpRange field in config. Possible values are: SRC_IPS_V1.

Config RegionSecurityPolicyRuleMatchConfig: The configuration options available when specifying versionedExpr. This field must be specified if versionedExpr is specified and cannot be specified if versionedExpr is not specified. Structure is documented below.
Expr RegionSecurityPolicyRuleMatchExpr: User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Structure is documented below.
VersionedExpr string: Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding srcIpRange field in config. Possible values are: SRC_IPS_V1.

config RegionSecurityPolicyRuleMatchConfig: The configuration options available when specifying versionedExpr. This field must be specified if versionedExpr is specified and cannot be specified if versionedExpr is not specified. Structure is documented below.
expr RegionSecurityPolicyRuleMatchExpr: User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Structure is documented below.
versionedExpr String: Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding srcIpRange field in config. Possible values are: SRC_IPS_V1.

config RegionSecurityPolicyRuleMatchConfig: The configuration options available when specifying versionedExpr. This field must be specified if versionedExpr is specified and cannot be specified if versionedExpr is not specified. Structure is documented below.
expr RegionSecurityPolicyRuleMatchExpr: User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Structure is documented below.
versionedExpr string: Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding srcIpRange field in config. Possible values are: SRC_IPS_V1.

config RegionSecurityPolicyRuleMatchConfig: The configuration options available when specifying versionedExpr. This field must be specified if versionedExpr is specified and cannot be specified if versionedExpr is not specified. Structure is documented below.
expr RegionSecurityPolicyRuleMatchExpr: User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Structure is documented below.
versioned_expr str: Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding srcIpRange field in config. Possible values are: SRC_IPS_V1.

config Property Map: The configuration options available when specifying versionedExpr. This field must be specified if versionedExpr is specified and cannot be specified if versionedExpr is not specified. Structure is documented below.
expr Property Map: User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Structure is documented below.
versionedExpr String: Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding srcIpRange field in config. Possible values are: SRC_IPS_V1.

RegionSecurityPolicyRuleMatchConfig
, RegionSecurityPolicyRuleMatchConfigArgs

SrcIpRanges List<string>: CIDR IP address range. Maximum number of srcIpRanges allowed is 10.

SrcIpRanges []string: CIDR IP address range. Maximum number of srcIpRanges allowed is 10.

srcIpRanges List<String>: CIDR IP address range. Maximum number of srcIpRanges allowed is 10.

srcIpRanges string[]: CIDR IP address range. Maximum number of srcIpRanges allowed is 10.

src_ip_ranges Sequence[str]: CIDR IP address range. Maximum number of srcIpRanges allowed is 10.

srcIpRanges List<String>: CIDR IP address range. Maximum number of srcIpRanges allowed is 10.

RegionSecurityPolicyRuleMatchExpr
, RegionSecurityPolicyRuleMatchExprArgs

Expression string: Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported.

Expression string: Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported.

expression String: Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported.

expression string: Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported.

expression str: Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported.

expression String: Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported.

RegionSecurityPolicyRuleNetworkMatch
, RegionSecurityPolicyRuleNetworkMatchArgs

DestIpRanges List<string>: Destination IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
DestPorts List<string>: Destination port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. "80") or range (e.g. "0-1023").
IpProtocols List<string>: IPv4 protocol / IPv6 next header (after extension headers). Each element can be an 8-bit unsigned decimal number (e.g. "6"), range (e.g. "253-254"), or one of the following protocol names: "tcp", "udp", "icmp", "esp", "ah", "ipip", or "sctp".
SrcAsns List<int>: BGP Autonomous System Number associated with the source IP address.
SrcIpRanges List<string>: Source IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
SrcPorts List<string>: Source port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. "80") or range (e.g. "0-1023").
SrcRegionCodes List<string>: Two-letter ISO 3166-1 alpha-2 country code associated with the source IP address.
UserDefinedFields List<RegionSecurityPolicyRuleNetworkMatchUserDefinedField>: User-defined fields. Each element names a defined field and lists the matching values for that field. Structure is documented below.

DestIpRanges []string: Destination IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
DestPorts []string: Destination port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. "80") or range (e.g. "0-1023").
IpProtocols []string: IPv4 protocol / IPv6 next header (after extension headers). Each element can be an 8-bit unsigned decimal number (e.g. "6"), range (e.g. "253-254"), or one of the following protocol names: "tcp", "udp", "icmp", "esp", "ah", "ipip", or "sctp".
SrcAsns []int: BGP Autonomous System Number associated with the source IP address.
SrcIpRanges []string: Source IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
SrcPorts []string: Source port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. "80") or range (e.g. "0-1023").
SrcRegionCodes []string: Two-letter ISO 3166-1 alpha-2 country code associated with the source IP address.
UserDefinedFields []RegionSecurityPolicyRuleNetworkMatchUserDefinedField: User-defined fields. Each element names a defined field and lists the matching values for that field. Structure is documented below.

destIpRanges List<String>: Destination IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
destPorts List<String>: Destination port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. "80") or range (e.g. "0-1023").
ipProtocols List<String>: IPv4 protocol / IPv6 next header (after extension headers). Each element can be an 8-bit unsigned decimal number (e.g. "6"), range (e.g. "253-254"), or one of the following protocol names: "tcp", "udp", "icmp", "esp", "ah", "ipip", or "sctp".
srcAsns List<Integer>: BGP Autonomous System Number associated with the source IP address.
srcIpRanges List<String>: Source IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
srcPorts List<String>: Source port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. "80") or range (e.g. "0-1023").
srcRegionCodes List<String>: Two-letter ISO 3166-1 alpha-2 country code associated with the source IP address.
userDefinedFields List<RegionSecurityPolicyRuleNetworkMatchUserDefinedField>: User-defined fields. Each element names a defined field and lists the matching values for that field. Structure is documented below.

destIpRanges string[]: Destination IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
destPorts string[]: Destination port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. "80") or range (e.g. "0-1023").
ipProtocols string[]: IPv4 protocol / IPv6 next header (after extension headers). Each element can be an 8-bit unsigned decimal number (e.g. "6"), range (e.g. "253-254"), or one of the following protocol names: "tcp", "udp", "icmp", "esp", "ah", "ipip", or "sctp".
srcAsns number[]: BGP Autonomous System Number associated with the source IP address.
srcIpRanges string[]: Source IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
srcPorts string[]: Source port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. "80") or range (e.g. "0-1023").
srcRegionCodes string[]: Two-letter ISO 3166-1 alpha-2 country code associated with the source IP address.
userDefinedFields RegionSecurityPolicyRuleNetworkMatchUserDefinedField[]: User-defined fields. Each element names a defined field and lists the matching values for that field. Structure is documented below.

dest_ip_ranges Sequence[str]: Destination IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
dest_ports Sequence[str]: Destination port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. "80") or range (e.g. "0-1023").
ip_protocols Sequence[str]: IPv4 protocol / IPv6 next header (after extension headers). Each element can be an 8-bit unsigned decimal number (e.g. "6"), range (e.g. "253-254"), or one of the following protocol names: "tcp", "udp", "icmp", "esp", "ah", "ipip", or "sctp".
src_asns Sequence[int]: BGP Autonomous System Number associated with the source IP address.
src_ip_ranges Sequence[str]: Source IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
src_ports Sequence[str]: Source port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. "80") or range (e.g. "0-1023").
src_region_codes Sequence[str]: Two-letter ISO 3166-1 alpha-2 country code associated with the source IP address.
user_defined_fields Sequence[RegionSecurityPolicyRuleNetworkMatchUserDefinedField]: User-defined fields. Each element names a defined field and lists the matching values for that field. Structure is documented below.

destIpRanges List<String>: Destination IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
destPorts List<String>: Destination port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. "80") or range (e.g. "0-1023").
ipProtocols List<String>: IPv4 protocol / IPv6 next header (after extension headers). Each element can be an 8-bit unsigned decimal number (e.g. "6"), range (e.g. "253-254"), or one of the following protocol names: "tcp", "udp", "icmp", "esp", "ah", "ipip", or "sctp".
srcAsns List<Number>: BGP Autonomous System Number associated with the source IP address.
srcIpRanges List<String>: Source IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
srcPorts List<String>: Source port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. "80") or range (e.g. "0-1023").
srcRegionCodes List<String>: Two-letter ISO 3166-1 alpha-2 country code associated with the source IP address.
userDefinedFields List<Property Map>: User-defined fields. Each element names a defined field and lists the matching values for that field. Structure is documented below.

RegionSecurityPolicyRuleNetworkMatchUserDefinedField
, RegionSecurityPolicyRuleNetworkMatchUserDefinedFieldArgs

Name string: Name of the user-defined field, as given in the definition.
Values List<string>: Matching values of the field. Each element can be a 32-bit unsigned decimal or hexadecimal (starting with "0x") number (e.g. "64") or range (e.g. "0x400-0x7ff").

Name string: Name of the user-defined field, as given in the definition.
Values []string: Matching values of the field. Each element can be a 32-bit unsigned decimal or hexadecimal (starting with "0x") number (e.g. "64") or range (e.g. "0x400-0x7ff").

name String: Name of the user-defined field, as given in the definition.
values List<String>: Matching values of the field. Each element can be a 32-bit unsigned decimal or hexadecimal (starting with "0x") number (e.g. "64") or range (e.g. "0x400-0x7ff").

name string: Name of the user-defined field, as given in the definition.
values string[]: Matching values of the field. Each element can be a 32-bit unsigned decimal or hexadecimal (starting with "0x") number (e.g. "64") or range (e.g. "0x400-0x7ff").

name str: Name of the user-defined field, as given in the definition.
values Sequence[str]: Matching values of the field. Each element can be a 32-bit unsigned decimal or hexadecimal (starting with "0x") number (e.g. "64") or range (e.g. "0x400-0x7ff").

name String: Name of the user-defined field, as given in the definition.
values List<String>: Matching values of the field. Each element can be a 32-bit unsigned decimal or hexadecimal (starting with "0x") number (e.g. "64") or range (e.g. "0x400-0x7ff").

RegionSecurityPolicyRulePreconfiguredWafConfig
, RegionSecurityPolicyRulePreconfiguredWafConfigArgs

Exclusions List<RegionSecurityPolicyRulePreconfiguredWafConfigExclusion>: An exclusion to apply during preconfigured WAF evaluation. Structure is documented below.

Exclusions []RegionSecurityPolicyRulePreconfiguredWafConfigExclusion: An exclusion to apply during preconfigured WAF evaluation. Structure is documented below.

exclusions List<RegionSecurityPolicyRulePreconfiguredWafConfigExclusion>: An exclusion to apply during preconfigured WAF evaluation. Structure is documented below.

exclusions RegionSecurityPolicyRulePreconfiguredWafConfigExclusion[]: An exclusion to apply during preconfigured WAF evaluation. Structure is documented below.

exclusions Sequence[RegionSecurityPolicyRulePreconfiguredWafConfigExclusion]: An exclusion to apply during preconfigured WAF evaluation. Structure is documented below.

exclusions List<Property Map>: An exclusion to apply during preconfigured WAF evaluation. Structure is documented below.

RegionSecurityPolicyRulePreconfiguredWafConfigExclusion
, RegionSecurityPolicyRulePreconfiguredWafConfigExclusionArgs

TargetRuleSet string: Target WAF rule set to apply the preconfigured WAF exclusion.
RequestCookies List<RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestCooky>: Request cookie whose value will be excluded from inspection during preconfigured WAF evaluation. Structure is documented below.
RequestHeaders List<RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestHeader>: Request header whose value will be excluded from inspection during preconfigured WAF evaluation. Structure is documented below.
RequestQueryParams List<RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestQueryParam>: Request query parameter whose value will be excluded from inspection during preconfigured WAF evaluation. Note that the parameter can be in the query string or in the POST body. Structure is documented below.
RequestUris List<RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestUri>: Request URI from the request line to be excluded from inspection during preconfigured WAF evaluation. When specifying this field, the query or fragment part should be excluded. Structure is documented below.
TargetRuleIds List<string>: A list of target rule IDs under the WAF rule set to apply the preconfigured WAF exclusion. If omitted, it refers to all the rule IDs under the WAF rule set.

TargetRuleSet string: Target WAF rule set to apply the preconfigured WAF exclusion.
RequestCookies []RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestCooky: Request cookie whose value will be excluded from inspection during preconfigured WAF evaluation. Structure is documented below.
RequestHeaders []RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestHeader: Request header whose value will be excluded from inspection during preconfigured WAF evaluation. Structure is documented below.
RequestQueryParams []RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestQueryParam: Request query parameter whose value will be excluded from inspection during preconfigured WAF evaluation. Note that the parameter can be in the query string or in the POST body. Structure is documented below.
RequestUris []RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestUri: Request URI from the request line to be excluded from inspection during preconfigured WAF evaluation. When specifying this field, the query or fragment part should be excluded. Structure is documented below.
TargetRuleIds []string: A list of target rule IDs under the WAF rule set to apply the preconfigured WAF exclusion. If omitted, it refers to all the rule IDs under the WAF rule set.

targetRuleSet String: Target WAF rule set to apply the preconfigured WAF exclusion.
requestCookies List<RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestCooky>: Request cookie whose value will be excluded from inspection during preconfigured WAF evaluation. Structure is documented below.
requestHeaders List<RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestHeader>: Request header whose value will be excluded from inspection during preconfigured WAF evaluation. Structure is documented below.
requestQueryParams List<RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestQueryParam>: Request query parameter whose value will be excluded from inspection during preconfigured WAF evaluation. Note that the parameter can be in the query string or in the POST body. Structure is documented below.
requestUris List<RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestUri>: Request URI from the request line to be excluded from inspection during preconfigured WAF evaluation. When specifying this field, the query or fragment part should be excluded. Structure is documented below.
targetRuleIds List<String>: A list of target rule IDs under the WAF rule set to apply the preconfigured WAF exclusion. If omitted, it refers to all the rule IDs under the WAF rule set.

targetRuleSet string: Target WAF rule set to apply the preconfigured WAF exclusion.
requestCookies RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestCooky[]: Request cookie whose value will be excluded from inspection during preconfigured WAF evaluation. Structure is documented below.
requestHeaders RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestHeader[]: Request header whose value will be excluded from inspection during preconfigured WAF evaluation. Structure is documented below.
requestQueryParams RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestQueryParam[]: Request query parameter whose value will be excluded from inspection during preconfigured WAF evaluation. Note that the parameter can be in the query string or in the POST body. Structure is documented below.
requestUris RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestUri[]: Request URI from the request line to be excluded from inspection during preconfigured WAF evaluation. When specifying this field, the query or fragment part should be excluded. Structure is documented below.
targetRuleIds string[]: A list of target rule IDs under the WAF rule set to apply the preconfigured WAF exclusion. If omitted, it refers to all the rule IDs under the WAF rule set.

target_rule_set str: Target WAF rule set to apply the preconfigured WAF exclusion.
request_cookies Sequence[RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestCooky]: Request cookie whose value will be excluded from inspection during preconfigured WAF evaluation. Structure is documented below.
request_headers Sequence[RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestHeader]: Request header whose value will be excluded from inspection during preconfigured WAF evaluation. Structure is documented below.
request_query_params Sequence[RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestQueryParam]: Request query parameter whose value will be excluded from inspection during preconfigured WAF evaluation. Note that the parameter can be in the query string or in the POST body. Structure is documented below.
request_uris Sequence[RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestUri]: Request URI from the request line to be excluded from inspection during preconfigured WAF evaluation. When specifying this field, the query or fragment part should be excluded. Structure is documented below.
target_rule_ids Sequence[str]: A list of target rule IDs under the WAF rule set to apply the preconfigured WAF exclusion. If omitted, it refers to all the rule IDs under the WAF rule set.

targetRuleSet String: Target WAF rule set to apply the preconfigured WAF exclusion.
requestCookies List<Property Map>: Request cookie whose value will be excluded from inspection during preconfigured WAF evaluation. Structure is documented below.
requestHeaders List<Property Map>: Request header whose value will be excluded from inspection during preconfigured WAF evaluation. Structure is documented below.
requestQueryParams List<Property Map>: Request query parameter whose value will be excluded from inspection during preconfigured WAF evaluation. Note that the parameter can be in the query string or in the POST body. Structure is documented below.
requestUris List<Property Map>: Request URI from the request line to be excluded from inspection during preconfigured WAF evaluation. When specifying this field, the query or fragment part should be excluded. Structure is documented below.
targetRuleIds List<String>: A list of target rule IDs under the WAF rule set to apply the preconfigured WAF exclusion. If omitted, it refers to all the rule IDs under the WAF rule set.

RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestCooky
, RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestCookyArgs

Operator string: You can specify an exact match or a partial match by using a field operator and a field value. Available options: EQUALS: The operator matches if the field value equals the specified value. STARTS_WITH: The operator matches if the field value starts with the specified value. ENDS_WITH: The operator matches if the field value ends with the specified value. CONTAINS: The operator matches if the field value contains the specified value. EQUALS_ANY: The operator matches if the field value is any value. Possible values are: CONTAINS, ENDS_WITH, EQUALS, EQUALS_ANY, STARTS_WITH.
Value string: A request field matching the specified value will be excluded from inspection during preconfigured WAF evaluation. The field value must be given if the field operator is not EQUALS_ANY, and cannot be given if the field operator is EQUALS_ANY.

Operator string: You can specify an exact match or a partial match by using a field operator and a field value. Available options: EQUALS: The operator matches if the field value equals the specified value. STARTS_WITH: The operator matches if the field value starts with the specified value. ENDS_WITH: The operator matches if the field value ends with the specified value. CONTAINS: The operator matches if the field value contains the specified value. EQUALS_ANY: The operator matches if the field value is any value. Possible values are: CONTAINS, ENDS_WITH, EQUALS, EQUALS_ANY, STARTS_WITH.
Value string: A request field matching the specified value will be excluded from inspection during preconfigured WAF evaluation. The field value must be given if the field operator is not EQUALS_ANY, and cannot be given if the field operator is EQUALS_ANY.

operator String: You can specify an exact match or a partial match by using a field operator and a field value. Available options: EQUALS: The operator matches if the field value equals the specified value. STARTS_WITH: The operator matches if the field value starts with the specified value. ENDS_WITH: The operator matches if the field value ends with the specified value. CONTAINS: The operator matches if the field value contains the specified value. EQUALS_ANY: The operator matches if the field value is any value. Possible values are: CONTAINS, ENDS_WITH, EQUALS, EQUALS_ANY, STARTS_WITH.
value String: A request field matching the specified value will be excluded from inspection during preconfigured WAF evaluation. The field value must be given if the field operator is not EQUALS_ANY, and cannot be given if the field operator is EQUALS_ANY.

operator string: You can specify an exact match or a partial match by using a field operator and a field value. Available options: EQUALS: The operator matches if the field value equals the specified value. STARTS_WITH: The operator matches if the field value starts with the specified value. ENDS_WITH: The operator matches if the field value ends with the specified value. CONTAINS: The operator matches if the field value contains the specified value. EQUALS_ANY: The operator matches if the field value is any value. Possible values are: CONTAINS, ENDS_WITH, EQUALS, EQUALS_ANY, STARTS_WITH.
value string: A request field matching the specified value will be excluded from inspection during preconfigured WAF evaluation. The field value must be given if the field operator is not EQUALS_ANY, and cannot be given if the field operator is EQUALS_ANY.

operator str: You can specify an exact match or a partial match by using a field operator and a field value. Available options: EQUALS: The operator matches if the field value equals the specified value. STARTS_WITH: The operator matches if the field value starts with the specified value. ENDS_WITH: The operator matches if the field value ends with the specified value. CONTAINS: The operator matches if the field value contains the specified value. EQUALS_ANY: The operator matches if the field value is any value. Possible values are: CONTAINS, ENDS_WITH, EQUALS, EQUALS_ANY, STARTS_WITH.
value str: A request field matching the specified value will be excluded from inspection during preconfigured WAF evaluation. The field value must be given if the field operator is not EQUALS_ANY, and cannot be given if the field operator is EQUALS_ANY.

operator String: You can specify an exact match or a partial match by using a field operator and a field value. Available options: EQUALS: The operator matches if the field value equals the specified value. STARTS_WITH: The operator matches if the field value starts with the specified value. ENDS_WITH: The operator matches if the field value ends with the specified value. CONTAINS: The operator matches if the field value contains the specified value. EQUALS_ANY: The operator matches if the field value is any value. Possible values are: CONTAINS, ENDS_WITH, EQUALS, EQUALS_ANY, STARTS_WITH.
value String: A request field matching the specified value will be excluded from inspection during preconfigured WAF evaluation. The field value must be given if the field operator is not EQUALS_ANY, and cannot be given if the field operator is EQUALS_ANY.

RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestHeader
, RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestHeaderArgs

Operator string: You can specify an exact match or a partial match by using a field operator and a field value. Available options: EQUALS: The operator matches if the field value equals the specified value. STARTS_WITH: The operator matches if the field value starts with the specified value. ENDS_WITH: The operator matches if the field value ends with the specified value. CONTAINS: The operator matches if the field value contains the specified value. EQUALS_ANY: The operator matches if the field value is any value. Possible values are: CONTAINS, ENDS_WITH, EQUALS, EQUALS_ANY, STARTS_WITH.
Value string: A request field matching the specified value will be excluded from inspection during preconfigured WAF evaluation. The field value must be given if the field operator is not EQUALS_ANY, and cannot be given if the field operator is EQUALS_ANY.

Operator string: You can specify an exact match or a partial match by using a field operator and a field value. Available options: EQUALS: The operator matches if the field value equals the specified value. STARTS_WITH: The operator matches if the field value starts with the specified value. ENDS_WITH: The operator matches if the field value ends with the specified value. CONTAINS: The operator matches if the field value contains the specified value. EQUALS_ANY: The operator matches if the field value is any value. Possible values are: CONTAINS, ENDS_WITH, EQUALS, EQUALS_ANY, STARTS_WITH.
Value string: A request field matching the specified value will be excluded from inspection during preconfigured WAF evaluation. The field value must be given if the field operator is not EQUALS_ANY, and cannot be given if the field operator is EQUALS_ANY.

operator String: You can specify an exact match or a partial match by using a field operator and a field value. Available options: EQUALS: The operator matches if the field value equals the specified value. STARTS_WITH: The operator matches if the field value starts with the specified value. ENDS_WITH: The operator matches if the field value ends with the specified value. CONTAINS: The operator matches if the field value contains the specified value. EQUALS_ANY: The operator matches if the field value is any value. Possible values are: CONTAINS, ENDS_WITH, EQUALS, EQUALS_ANY, STARTS_WITH.
value String: A request field matching the specified value will be excluded from inspection during preconfigured WAF evaluation. The field value must be given if the field operator is not EQUALS_ANY, and cannot be given if the field operator is EQUALS_ANY.

operator string: You can specify an exact match or a partial match by using a field operator and a field value. Available options: EQUALS: The operator matches if the field value equals the specified value. STARTS_WITH: The operator matches if the field value starts with the specified value. ENDS_WITH: The operator matches if the field value ends with the specified value. CONTAINS: The operator matches if the field value contains the specified value. EQUALS_ANY: The operator matches if the field value is any value. Possible values are: CONTAINS, ENDS_WITH, EQUALS, EQUALS_ANY, STARTS_WITH.
value string: A request field matching the specified value will be excluded from inspection during preconfigured WAF evaluation. The field value must be given if the field operator is not EQUALS_ANY, and cannot be given if the field operator is EQUALS_ANY.

operator str: You can specify an exact match or a partial match by using a field operator and a field value. Available options: EQUALS: The operator matches if the field value equals the specified value. STARTS_WITH: The operator matches if the field value starts with the specified value. ENDS_WITH: The operator matches if the field value ends with the specified value. CONTAINS: The operator matches if the field value contains the specified value. EQUALS_ANY: The operator matches if the field value is any value. Possible values are: CONTAINS, ENDS_WITH, EQUALS, EQUALS_ANY, STARTS_WITH.
value str: A request field matching the specified value will be excluded from inspection during preconfigured WAF evaluation. The field value must be given if the field operator is not EQUALS_ANY, and cannot be given if the field operator is EQUALS_ANY.

operator String: You can specify an exact match or a partial match by using a field operator and a field value. Available options: EQUALS: The operator matches if the field value equals the specified value. STARTS_WITH: The operator matches if the field value starts with the specified value. ENDS_WITH: The operator matches if the field value ends with the specified value. CONTAINS: The operator matches if the field value contains the specified value. EQUALS_ANY: The operator matches if the field value is any value. Possible values are: CONTAINS, ENDS_WITH, EQUALS, EQUALS_ANY, STARTS_WITH.
value String: A request field matching the specified value will be excluded from inspection during preconfigured WAF evaluation. The field value must be given if the field operator is not EQUALS_ANY, and cannot be given if the field operator is EQUALS_ANY.

RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestQueryParam
, RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestQueryParamArgs

Operator string: You can specify an exact match or a partial match by using a field operator and a field value. Available options: EQUALS: The operator matches if the field value equals the specified value. STARTS_WITH: The operator matches if the field value starts with the specified value. ENDS_WITH: The operator matches if the field value ends with the specified value. CONTAINS: The operator matches if the field value contains the specified value. EQUALS_ANY: The operator matches if the field value is any value. Possible values are: CONTAINS, ENDS_WITH, EQUALS, EQUALS_ANY, STARTS_WITH.
Value string: A request field matching the specified value will be excluded from inspection during preconfigured WAF evaluation. The field value must be given if the field operator is not EQUALS_ANY, and cannot be given if the field operator is EQUALS_ANY.

Operator string: You can specify an exact match or a partial match by using a field operator and a field value. Available options: EQUALS: The operator matches if the field value equals the specified value. STARTS_WITH: The operator matches if the field value starts with the specified value. ENDS_WITH: The operator matches if the field value ends with the specified value. CONTAINS: The operator matches if the field value contains the specified value. EQUALS_ANY: The operator matches if the field value is any value. Possible values are: CONTAINS, ENDS_WITH, EQUALS, EQUALS_ANY, STARTS_WITH.
Value string: A request field matching the specified value will be excluded from inspection during preconfigured WAF evaluation. The field value must be given if the field operator is not EQUALS_ANY, and cannot be given if the field operator is EQUALS_ANY.

operator String: You can specify an exact match or a partial match by using a field operator and a field value. Available options: EQUALS: The operator matches if the field value equals the specified value. STARTS_WITH: The operator matches if the field value starts with the specified value. ENDS_WITH: The operator matches if the field value ends with the specified value. CONTAINS: The operator matches if the field value contains the specified value. EQUALS_ANY: The operator matches if the field value is any value. Possible values are: CONTAINS, ENDS_WITH, EQUALS, EQUALS_ANY, STARTS_WITH.
value String: A request field matching the specified value will be excluded from inspection during preconfigured WAF evaluation. The field value must be given if the field operator is not EQUALS_ANY, and cannot be given if the field operator is EQUALS_ANY.

operator string: You can specify an exact match or a partial match by using a field operator and a field value. Available options: EQUALS: The operator matches if the field value equals the specified value. STARTS_WITH: The operator matches if the field value starts with the specified value. ENDS_WITH: The operator matches if the field value ends with the specified value. CONTAINS: The operator matches if the field value contains the specified value. EQUALS_ANY: The operator matches if the field value is any value. Possible values are: CONTAINS, ENDS_WITH, EQUALS, EQUALS_ANY, STARTS_WITH.
value string: A request field matching the specified value will be excluded from inspection during preconfigured WAF evaluation. The field value must be given if the field operator is not EQUALS_ANY, and cannot be given if the field operator is EQUALS_ANY.

operator str: You can specify an exact match or a partial match by using a field operator and a field value. Available options: EQUALS: The operator matches if the field value equals the specified value. STARTS_WITH: The operator matches if the field value starts with the specified value. ENDS_WITH: The operator matches if the field value ends with the specified value. CONTAINS: The operator matches if the field value contains the specified value. EQUALS_ANY: The operator matches if the field value is any value. Possible values are: CONTAINS, ENDS_WITH, EQUALS, EQUALS_ANY, STARTS_WITH.
value str: A request field matching the specified value will be excluded from inspection during preconfigured WAF evaluation. The field value must be given if the field operator is not EQUALS_ANY, and cannot be given if the field operator is EQUALS_ANY.

operator String: You can specify an exact match or a partial match by using a field operator and a field value. Available options: EQUALS: The operator matches if the field value equals the specified value. STARTS_WITH: The operator matches if the field value starts with the specified value. ENDS_WITH: The operator matches if the field value ends with the specified value. CONTAINS: The operator matches if the field value contains the specified value. EQUALS_ANY: The operator matches if the field value is any value. Possible values are: CONTAINS, ENDS_WITH, EQUALS, EQUALS_ANY, STARTS_WITH.
value String: A request field matching the specified value will be excluded from inspection during preconfigured WAF evaluation. The field value must be given if the field operator is not EQUALS_ANY, and cannot be given if the field operator is EQUALS_ANY.

RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestUri
, RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestUriArgs

Operator string: You can specify an exact match or a partial match by using a field operator and a field value. Available options: EQUALS: The operator matches if the field value equals the specified value. STARTS_WITH: The operator matches if the field value starts with the specified value. ENDS_WITH: The operator matches if the field value ends with the specified value. CONTAINS: The operator matches if the field value contains the specified value. EQUALS_ANY: The operator matches if the field value is any value. Possible values are: CONTAINS, ENDS_WITH, EQUALS, EQUALS_ANY, STARTS_WITH.
Value string: A request field matching the specified value will be excluded from inspection during preconfigured WAF evaluation. The field value must be given if the field operator is not EQUALS_ANY, and cannot be given if the field operator is EQUALS_ANY.

Operator string: You can specify an exact match or a partial match by using a field operator and a field value. Available options: EQUALS: The operator matches if the field value equals the specified value. STARTS_WITH: The operator matches if the field value starts with the specified value. ENDS_WITH: The operator matches if the field value ends with the specified value. CONTAINS: The operator matches if the field value contains the specified value. EQUALS_ANY: The operator matches if the field value is any value. Possible values are: CONTAINS, ENDS_WITH, EQUALS, EQUALS_ANY, STARTS_WITH.
Value string: A request field matching the specified value will be excluded from inspection during preconfigured WAF evaluation. The field value must be given if the field operator is not EQUALS_ANY, and cannot be given if the field operator is EQUALS_ANY.

operator String: You can specify an exact match or a partial match by using a field operator and a field value. Available options: EQUALS: The operator matches if the field value equals the specified value. STARTS_WITH: The operator matches if the field value starts with the specified value. ENDS_WITH: The operator matches if the field value ends with the specified value. CONTAINS: The operator matches if the field value contains the specified value. EQUALS_ANY: The operator matches if the field value is any value. Possible values are: CONTAINS, ENDS_WITH, EQUALS, EQUALS_ANY, STARTS_WITH.
value String: A request field matching the specified value will be excluded from inspection during preconfigured WAF evaluation. The field value must be given if the field operator is not EQUALS_ANY, and cannot be given if the field operator is EQUALS_ANY.

operator string: You can specify an exact match or a partial match by using a field operator and a field value. Available options: EQUALS: The operator matches if the field value equals the specified value. STARTS_WITH: The operator matches if the field value starts with the specified value. ENDS_WITH: The operator matches if the field value ends with the specified value. CONTAINS: The operator matches if the field value contains the specified value. EQUALS_ANY: The operator matches if the field value is any value. Possible values are: CONTAINS, ENDS_WITH, EQUALS, EQUALS_ANY, STARTS_WITH.
value string: A request field matching the specified value will be excluded from inspection during preconfigured WAF evaluation. The field value must be given if the field operator is not EQUALS_ANY, and cannot be given if the field operator is EQUALS_ANY.

operator str: You can specify an exact match or a partial match by using a field operator and a field value. Available options: EQUALS: The operator matches if the field value equals the specified value. STARTS_WITH: The operator matches if the field value starts with the specified value. ENDS_WITH: The operator matches if the field value ends with the specified value. CONTAINS: The operator matches if the field value contains the specified value. EQUALS_ANY: The operator matches if the field value is any value. Possible values are: CONTAINS, ENDS_WITH, EQUALS, EQUALS_ANY, STARTS_WITH.
value str: A request field matching the specified value will be excluded from inspection during preconfigured WAF evaluation. The field value must be given if the field operator is not EQUALS_ANY, and cannot be given if the field operator is EQUALS_ANY.

operator String: You can specify an exact match or a partial match by using a field operator and a field value. Available options: EQUALS: The operator matches if the field value equals the specified value. STARTS_WITH: The operator matches if the field value starts with the specified value. ENDS_WITH: The operator matches if the field value ends with the specified value. CONTAINS: The operator matches if the field value contains the specified value. EQUALS_ANY: The operator matches if the field value is any value. Possible values are: CONTAINS, ENDS_WITH, EQUALS, EQUALS_ANY, STARTS_WITH.
value String: A request field matching the specified value will be excluded from inspection during preconfigured WAF evaluation. The field value must be given if the field operator is not EQUALS_ANY, and cannot be given if the field operator is EQUALS_ANY.

RegionSecurityPolicyRuleRateLimitOptions
, RegionSecurityPolicyRuleRateLimitOptionsArgs

BanDurationSec int

Can only be specified if the action for the rule is "rate_based_ban". If specified, determines the time (in seconds) the traffic will continue to be banned by the rate limit after the rate falls below the threshold.

BanThreshold RegionSecurityPolicyRuleRateLimitOptionsBanThreshold

Can only be specified if the action for the rule is "rate_based_ban". If specified, the key will be banned for the configured 'banDurationSec' when the number of requests that exceed the 'rateLimitThreshold' also exceed this 'banThreshold'. Structure is documented below.

ConformAction string

Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only.

EnforceOnKey string

Determines the key to enforce the rateLimitThreshold on. Possible values are:

ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKey" is not configured.
IP: The source IP address of the request is the key. Each IP has this limit enforced separately.
HTTP_HEADER: The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL.
XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP.
HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL.
HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes.
SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session.
REGION_CODE: The country/region from which the request originates.
TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL.
USER_IP: The IP address of the originating client, which is resolved based on "userIpRequestHeaders" configured with the security policy. If there is no "userIpRequestHeaders" configuration or an IP address cannot be resolved from it, the key type defaults to IP. Possible values are: ALL, IP, HTTP_HEADER, XFF_IP, HTTP_COOKIE, HTTP_PATH, SNI, REGION_CODE, TLS_JA3_FINGERPRINT, USER_IP.

EnforceOnKeyConfigs List<RegionSecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig>

If specified, any combination of values of enforceOnKeyType/enforceOnKeyName is treated as the key on which ratelimit threshold/action is enforced. You can specify up to 3 enforceOnKeyConfigs. If enforceOnKeyConfigs is specified, enforceOnKey must not be specified. Structure is documented below.

EnforceOnKeyName string

Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value.

ExceedAction string

Action to take for requests that are above the configured rate limit threshold, to deny with a specified HTTP response code. Valid options are deny(STATUS), where valid values for STATUS are 403, 404, 429, and 502.

RateLimitThreshold RegionSecurityPolicyRuleRateLimitOptionsRateLimitThreshold

Threshold at which to begin ratelimiting. Structure is documented below.

BanDurationSec int

BanThreshold RegionSecurityPolicyRuleRateLimitOptionsBanThreshold

ConformAction string

Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only.

EnforceOnKey string

Determines the key to enforce the rateLimitThreshold on. Possible values are:

ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKey" is not configured.
IP: The source IP address of the request is the key. Each IP has this limit enforced separately.
HTTP_HEADER: The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL.
XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP.
HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL.
HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes.
SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session.
REGION_CODE: The country/region from which the request originates.
TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL.
USER_IP: The IP address of the originating client, which is resolved based on "userIpRequestHeaders" configured with the security policy. If there is no "userIpRequestHeaders" configuration or an IP address cannot be resolved from it, the key type defaults to IP. Possible values are: ALL, IP, HTTP_HEADER, XFF_IP, HTTP_COOKIE, HTTP_PATH, SNI, REGION_CODE, TLS_JA3_FINGERPRINT, USER_IP.

EnforceOnKeyConfigs []RegionSecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig

EnforceOnKeyName string

ExceedAction string

RateLimitThreshold RegionSecurityPolicyRuleRateLimitOptionsRateLimitThreshold

Threshold at which to begin ratelimiting. Structure is documented below.

banDurationSec Integer

banThreshold RegionSecurityPolicyRuleRateLimitOptionsBanThreshold

conformAction String

Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only.

enforceOnKey String

Determines the key to enforce the rateLimitThreshold on. Possible values are:

ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKey" is not configured.
IP: The source IP address of the request is the key. Each IP has this limit enforced separately.
HTTP_HEADER: The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL.
XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP.
HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL.
HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes.
SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session.
REGION_CODE: The country/region from which the request originates.
TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL.
USER_IP: The IP address of the originating client, which is resolved based on "userIpRequestHeaders" configured with the security policy. If there is no "userIpRequestHeaders" configuration or an IP address cannot be resolved from it, the key type defaults to IP. Possible values are: ALL, IP, HTTP_HEADER, XFF_IP, HTTP_COOKIE, HTTP_PATH, SNI, REGION_CODE, TLS_JA3_FINGERPRINT, USER_IP.

enforceOnKeyConfigs List<RegionSecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig>

enforceOnKeyName String

exceedAction String

rateLimitThreshold RegionSecurityPolicyRuleRateLimitOptionsRateLimitThreshold

Threshold at which to begin ratelimiting. Structure is documented below.

banDurationSec number

banThreshold RegionSecurityPolicyRuleRateLimitOptionsBanThreshold

conformAction string

Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only.

enforceOnKey string

Determines the key to enforce the rateLimitThreshold on. Possible values are:

ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKey" is not configured.
IP: The source IP address of the request is the key. Each IP has this limit enforced separately.
HTTP_HEADER: The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL.
XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP.
HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL.
HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes.
SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session.
REGION_CODE: The country/region from which the request originates.
TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL.
USER_IP: The IP address of the originating client, which is resolved based on "userIpRequestHeaders" configured with the security policy. If there is no "userIpRequestHeaders" configuration or an IP address cannot be resolved from it, the key type defaults to IP. Possible values are: ALL, IP, HTTP_HEADER, XFF_IP, HTTP_COOKIE, HTTP_PATH, SNI, REGION_CODE, TLS_JA3_FINGERPRINT, USER_IP.

enforceOnKeyConfigs RegionSecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig[]

enforceOnKeyName string

exceedAction string

rateLimitThreshold RegionSecurityPolicyRuleRateLimitOptionsRateLimitThreshold

Threshold at which to begin ratelimiting. Structure is documented below.

ban_duration_sec int

ban_threshold RegionSecurityPolicyRuleRateLimitOptionsBanThreshold

conform_action str

Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only.

enforce_on_key str

Determines the key to enforce the rateLimitThreshold on. Possible values are:

ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKey" is not configured.
IP: The source IP address of the request is the key. Each IP has this limit enforced separately.
HTTP_HEADER: The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL.
XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP.
HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL.
HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes.
SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session.
REGION_CODE: The country/region from which the request originates.
TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL.
USER_IP: The IP address of the originating client, which is resolved based on "userIpRequestHeaders" configured with the security policy. If there is no "userIpRequestHeaders" configuration or an IP address cannot be resolved from it, the key type defaults to IP. Possible values are: ALL, IP, HTTP_HEADER, XFF_IP, HTTP_COOKIE, HTTP_PATH, SNI, REGION_CODE, TLS_JA3_FINGERPRINT, USER_IP.

enforce_on_key_configs Sequence[RegionSecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig]

enforce_on_key_name str

exceed_action str

rate_limit_threshold RegionSecurityPolicyRuleRateLimitOptionsRateLimitThreshold

Threshold at which to begin ratelimiting. Structure is documented below.

banDurationSec Number

banThreshold Property Map

conformAction String

Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only.

enforceOnKey String

Determines the key to enforce the rateLimitThreshold on. Possible values are:

ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKey" is not configured.
IP: The source IP address of the request is the key. Each IP has this limit enforced separately.
HTTP_HEADER: The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL.
XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP.
HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL.
HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes.
SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session.
REGION_CODE: The country/region from which the request originates.
TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL.
USER_IP: The IP address of the originating client, which is resolved based on "userIpRequestHeaders" configured with the security policy. If there is no "userIpRequestHeaders" configuration or an IP address cannot be resolved from it, the key type defaults to IP. Possible values are: ALL, IP, HTTP_HEADER, XFF_IP, HTTP_COOKIE, HTTP_PATH, SNI, REGION_CODE, TLS_JA3_FINGERPRINT, USER_IP.

enforceOnKeyConfigs List<Property Map>

enforceOnKeyName String

exceedAction String

rateLimitThreshold Property Map

Threshold at which to begin ratelimiting. Structure is documented below.

RegionSecurityPolicyRuleRateLimitOptionsBanThreshold
, RegionSecurityPolicyRuleRateLimitOptionsBanThresholdArgs

Count int: Number of HTTP(S) requests for calculating the threshold.
IntervalSec int: Interval over which the threshold is computed.

Count int: Number of HTTP(S) requests for calculating the threshold.
IntervalSec int: Interval over which the threshold is computed.

count Integer: Number of HTTP(S) requests for calculating the threshold.
intervalSec Integer: Interval over which the threshold is computed.

count number: Number of HTTP(S) requests for calculating the threshold.
intervalSec number: Interval over which the threshold is computed.

count int: Number of HTTP(S) requests for calculating the threshold.
interval_sec int: Interval over which the threshold is computed.

count Number: Number of HTTP(S) requests for calculating the threshold.
intervalSec Number: Interval over which the threshold is computed.

RegionSecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
, RegionSecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigArgs

EnforceOnKeyName string

EnforceOnKeyType string

Determines the key to enforce the rateLimitThreshold on. Possible values are:

ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKeyConfigs" is not configured.
IP: The source IP address of the request is the key. Each IP has this limit enforced separately.
HTTP_HEADER: The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL.
XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP.
HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL.
HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes.
SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session.
REGION_CODE: The country/region from which the request originates.
TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL.
USER_IP: The IP address of the originating client, which is resolved based on "userIpRequestHeaders" configured with the security policy. If there is no "userIpRequestHeaders" configuration or an IP address cannot be resolved from it, the key type defaults to IP. Possible values are: ALL, IP, HTTP_HEADER, XFF_IP, HTTP_COOKIE, HTTP_PATH, SNI, REGION_CODE, TLS_JA3_FINGERPRINT, USER_IP.

EnforceOnKeyName string

EnforceOnKeyType string

Determines the key to enforce the rateLimitThreshold on. Possible values are:

ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKeyConfigs" is not configured.
IP: The source IP address of the request is the key. Each IP has this limit enforced separately.
HTTP_HEADER: The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL.
XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP.
HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL.
HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes.
SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session.
REGION_CODE: The country/region from which the request originates.
TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL.
USER_IP: The IP address of the originating client, which is resolved based on "userIpRequestHeaders" configured with the security policy. If there is no "userIpRequestHeaders" configuration or an IP address cannot be resolved from it, the key type defaults to IP. Possible values are: ALL, IP, HTTP_HEADER, XFF_IP, HTTP_COOKIE, HTTP_PATH, SNI, REGION_CODE, TLS_JA3_FINGERPRINT, USER_IP.

enforceOnKeyName String

enforceOnKeyType String

Determines the key to enforce the rateLimitThreshold on. Possible values are:

ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKeyConfigs" is not configured.
IP: The source IP address of the request is the key. Each IP has this limit enforced separately.
HTTP_HEADER: The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL.
XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP.
HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL.
HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes.
SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session.
REGION_CODE: The country/region from which the request originates.
TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL.
USER_IP: The IP address of the originating client, which is resolved based on "userIpRequestHeaders" configured with the security policy. If there is no "userIpRequestHeaders" configuration or an IP address cannot be resolved from it, the key type defaults to IP. Possible values are: ALL, IP, HTTP_HEADER, XFF_IP, HTTP_COOKIE, HTTP_PATH, SNI, REGION_CODE, TLS_JA3_FINGERPRINT, USER_IP.

enforceOnKeyName string

enforceOnKeyType string

Determines the key to enforce the rateLimitThreshold on. Possible values are:

ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKeyConfigs" is not configured.
IP: The source IP address of the request is the key. Each IP has this limit enforced separately.
HTTP_HEADER: The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL.
XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP.
HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL.
HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes.
SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session.
REGION_CODE: The country/region from which the request originates.
TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL.
USER_IP: The IP address of the originating client, which is resolved based on "userIpRequestHeaders" configured with the security policy. If there is no "userIpRequestHeaders" configuration or an IP address cannot be resolved from it, the key type defaults to IP. Possible values are: ALL, IP, HTTP_HEADER, XFF_IP, HTTP_COOKIE, HTTP_PATH, SNI, REGION_CODE, TLS_JA3_FINGERPRINT, USER_IP.

enforce_on_key_name str

enforce_on_key_type str

Determines the key to enforce the rateLimitThreshold on. Possible values are:

ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKeyConfigs" is not configured.
IP: The source IP address of the request is the key. Each IP has this limit enforced separately.
HTTP_HEADER: The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL.
XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP.
HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL.
HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes.
SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session.
REGION_CODE: The country/region from which the request originates.
TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL.
USER_IP: The IP address of the originating client, which is resolved based on "userIpRequestHeaders" configured with the security policy. If there is no "userIpRequestHeaders" configuration or an IP address cannot be resolved from it, the key type defaults to IP. Possible values are: ALL, IP, HTTP_HEADER, XFF_IP, HTTP_COOKIE, HTTP_PATH, SNI, REGION_CODE, TLS_JA3_FINGERPRINT, USER_IP.

enforceOnKeyName String

enforceOnKeyType String

Determines the key to enforce the rateLimitThreshold on. Possible values are:

ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKeyConfigs" is not configured.
IP: The source IP address of the request is the key. Each IP has this limit enforced separately.
HTTP_HEADER: The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL.
XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP.
HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL.
HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes.
SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session.
REGION_CODE: The country/region from which the request originates.
TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL.
USER_IP: The IP address of the originating client, which is resolved based on "userIpRequestHeaders" configured with the security policy. If there is no "userIpRequestHeaders" configuration or an IP address cannot be resolved from it, the key type defaults to IP. Possible values are: ALL, IP, HTTP_HEADER, XFF_IP, HTTP_COOKIE, HTTP_PATH, SNI, REGION_CODE, TLS_JA3_FINGERPRINT, USER_IP.

RegionSecurityPolicyRuleRateLimitOptionsRateLimitThreshold
, RegionSecurityPolicyRuleRateLimitOptionsRateLimitThresholdArgs

Count int: Number of HTTP(S) requests for calculating the threshold.
IntervalSec int: Interval over which the threshold is computed.

Count int: Number of HTTP(S) requests for calculating the threshold.
IntervalSec int: Interval over which the threshold is computed.

count Integer: Number of HTTP(S) requests for calculating the threshold.
intervalSec Integer: Interval over which the threshold is computed.

count number: Number of HTTP(S) requests for calculating the threshold.
intervalSec number: Interval over which the threshold is computed.

count int: Number of HTTP(S) requests for calculating the threshold.
interval_sec int: Interval over which the threshold is computed.

count Number: Number of HTTP(S) requests for calculating the threshold.
intervalSec Number: Interval over which the threshold is computed.

RegionSecurityPolicyUserDefinedField
, RegionSecurityPolicyUserDefinedFieldArgs

Base string

The base relative to which 'offset' is measured. Possible values are:

IPV4: Points to the beginning of the IPv4 header.
IPV6: Points to the beginning of the IPv6 header.
TCP: Points to the beginning of the TCP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments.
UDP: Points to the beginning of the UDP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments. Possible values are: IPV4, IPV6, TCP, UDP.

Mask string

If specified, apply this mask (bitwise AND) to the field to ignore bits before matching. Encoded as a hexadecimal number (starting with "0x"). The last byte of the field (in network byte order) corresponds to the least significant byte of the mask.

Name string

Name of the user-defined field, as given in the definition.

Offset int

Offset of the first byte of the field (in network byte order) relative to 'base'.

Size int

Size of the field in bytes. Valid values: 1-4.

Base string

The base relative to which 'offset' is measured. Possible values are:

IPV4: Points to the beginning of the IPv4 header.
IPV6: Points to the beginning of the IPv6 header.
TCP: Points to the beginning of the TCP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments.
UDP: Points to the beginning of the UDP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments. Possible values are: IPV4, IPV6, TCP, UDP.

Mask string

Name string

Name of the user-defined field, as given in the definition.

Offset int

Offset of the first byte of the field (in network byte order) relative to 'base'.

Size int

Size of the field in bytes. Valid values: 1-4.

base String

The base relative to which 'offset' is measured. Possible values are:

IPV4: Points to the beginning of the IPv4 header.
IPV6: Points to the beginning of the IPv6 header.
TCP: Points to the beginning of the TCP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments.
UDP: Points to the beginning of the UDP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments. Possible values are: IPV4, IPV6, TCP, UDP.

mask String

name String

Name of the user-defined field, as given in the definition.

offset Integer

Offset of the first byte of the field (in network byte order) relative to 'base'.

size Integer

Size of the field in bytes. Valid values: 1-4.

base string

The base relative to which 'offset' is measured. Possible values are:

IPV4: Points to the beginning of the IPv4 header.
IPV6: Points to the beginning of the IPv6 header.
TCP: Points to the beginning of the TCP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments.
UDP: Points to the beginning of the UDP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments. Possible values are: IPV4, IPV6, TCP, UDP.

mask string

name string

Name of the user-defined field, as given in the definition.

offset number

Offset of the first byte of the field (in network byte order) relative to 'base'.

size number

Size of the field in bytes. Valid values: 1-4.

base str

The base relative to which 'offset' is measured. Possible values are:

IPV4: Points to the beginning of the IPv4 header.
IPV6: Points to the beginning of the IPv6 header.
TCP: Points to the beginning of the TCP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments.
UDP: Points to the beginning of the UDP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments. Possible values are: IPV4, IPV6, TCP, UDP.

mask str

name str

Name of the user-defined field, as given in the definition.

offset int

Offset of the first byte of the field (in network byte order) relative to 'base'.

size int

Size of the field in bytes. Valid values: 1-4.

base String

The base relative to which 'offset' is measured. Possible values are:

IPV4: Points to the beginning of the IPv4 header.
IPV6: Points to the beginning of the IPv6 header.
TCP: Points to the beginning of the TCP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments.
UDP: Points to the beginning of the UDP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments. Possible values are: IPV4, IPV6, TCP, UDP.

mask String

name String

Name of the user-defined field, as given in the definition.

offset Number

Offset of the first byte of the field (in network byte order) relative to 'base'.

size Number

Size of the field in bytes. Valid values: 1-4.

Import

RegionSecurityPolicy can be imported using any of these accepted formats:

projects/{{project}}/regions/{{region}}/securityPolicies/{{name}}
{{project}}/{{region}}/{{name}}
{{region}}/{{name}}
{{name}}

When using the pulumi import command, RegionSecurityPolicy can be imported using one of the formats above. For example:

$ pulumi import gcp:compute/regionSecurityPolicy:RegionSecurityPolicy default projects/{{project}}/regions/{{region}}/securityPolicies/{{name}}

$ pulumi import gcp:compute/regionSecurityPolicy:RegionSecurityPolicy default {{project}}/{{region}}/{{name}}

$ pulumi import gcp:compute/regionSecurityPolicy:RegionSecurityPolicy default {{region}}/{{name}}

$ pulumi import gcp:compute/regionSecurityPolicy:RegionSecurityPolicy default {{name}}

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

Package Details

Repository: Google Cloud (GCP) Classic pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

Google Cloud v8.25.0 published on Thursday, Apr 3, 2025 by Pulumi

pulumi/pulumi-gcp

Example Usage
Region Security Policy Basic
Region Security Policy With Ddos Protection Config
Region Security Policy With User Defined Fields
Region Security Policy With Rules
Create RegionSecurityPolicy Resource
Constructor syntax
Constructor example
RegionSecurityPolicy Resource Properties
Inputs
Outputs
Look up Existing RegionSecurityPolicy Resource
Supporting Types
Import
Package Details

Request a Change

gcp.compute.RegionSecurityPolicy

On this page

On this page

Example Usage

Region Security Policy Basic

Region Security Policy With Ddos Protection Config

Region Security Policy With User Defined Fields

Region Security Policy With Rules

Create RegionSecurityPolicy Resource

Constructor syntax

Parameters

Constructor example

RegionSecurityPolicy Resource Properties

Inputs

Outputs

Look up Existing RegionSecurityPolicy Resource

Supporting Types

RegionSecurityPolicyDdosProtectionConfig
, RegionSecurityPolicyDdosProtectionConfigArgs

RegionSecurityPolicyRule
, RegionSecurityPolicyRuleArgs

RegionSecurityPolicyRuleMatch
, RegionSecurityPolicyRuleMatchArgs

RegionSecurityPolicyRuleMatchConfig
, RegionSecurityPolicyRuleMatchConfigArgs

RegionSecurityPolicyRuleMatchExpr
, RegionSecurityPolicyRuleMatchExprArgs

RegionSecurityPolicyRuleNetworkMatch
, RegionSecurityPolicyRuleNetworkMatchArgs

RegionSecurityPolicyRuleNetworkMatchUserDefinedField
, RegionSecurityPolicyRuleNetworkMatchUserDefinedFieldArgs

RegionSecurityPolicyRulePreconfiguredWafConfig
, RegionSecurityPolicyRulePreconfiguredWafConfigArgs

RegionSecurityPolicyRulePreconfiguredWafConfigExclusion
, RegionSecurityPolicyRulePreconfiguredWafConfigExclusionArgs

RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestCooky
, RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestCookyArgs

RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestHeader
, RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestHeaderArgs

RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestQueryParam
, RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestQueryParamArgs

RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestUri
, RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestUriArgs

RegionSecurityPolicyRuleRateLimitOptions
, RegionSecurityPolicyRuleRateLimitOptionsArgs

RegionSecurityPolicyRuleRateLimitOptionsBanThreshold
, RegionSecurityPolicyRuleRateLimitOptionsBanThresholdArgs

RegionSecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
, RegionSecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigArgs

RegionSecurityPolicyRuleRateLimitOptionsRateLimitThreshold
, RegionSecurityPolicyRuleRateLimitOptionsRateLimitThresholdArgs

RegionSecurityPolicyUserDefinedField
, RegionSecurityPolicyUserDefinedFieldArgs

Import

Package Details

On this page

On this page

gcp.compute.RegionSecurityPolicy

On this page

On this page

Example Usage

Region Security Policy Basic

Region Security Policy With Ddos Protection Config

Region Security Policy With User Defined Fields

Region Security Policy With Rules

Create RegionSecurityPolicy Resource

Constructor syntax

Parameters

Constructor example

RegionSecurityPolicy Resource Properties

Inputs

Outputs

Look up Existing RegionSecurityPolicy Resource

Supporting Types

RegionSecurityPolicyDdosProtectionConfig, RegionSecurityPolicyDdosProtectionConfigArgs

RegionSecurityPolicyRule, RegionSecurityPolicyRuleArgs

RegionSecurityPolicyRuleMatch, RegionSecurityPolicyRuleMatchArgs

RegionSecurityPolicyRuleMatchConfig, RegionSecurityPolicyRuleMatchConfigArgs

RegionSecurityPolicyRuleMatchExpr, RegionSecurityPolicyRuleMatchExprArgs

RegionSecurityPolicyRuleNetworkMatch, RegionSecurityPolicyRuleNetworkMatchArgs

RegionSecurityPolicyRuleNetworkMatchUserDefinedField, RegionSecurityPolicyRuleNetworkMatchUserDefinedFieldArgs

RegionSecurityPolicyRulePreconfiguredWafConfig, RegionSecurityPolicyRulePreconfiguredWafConfigArgs

RegionSecurityPolicyRulePreconfiguredWafConfigExclusion, RegionSecurityPolicyRulePreconfiguredWafConfigExclusionArgs

RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestCooky, RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestCookyArgs

RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestHeader, RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestHeaderArgs

RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestQueryParam, RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestQueryParamArgs

RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestUri, RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestUriArgs

RegionSecurityPolicyRuleRateLimitOptions, RegionSecurityPolicyRuleRateLimitOptionsArgs

RegionSecurityPolicyRuleRateLimitOptionsBanThreshold, RegionSecurityPolicyRuleRateLimitOptionsBanThresholdArgs

RegionSecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig, RegionSecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigArgs

RegionSecurityPolicyRuleRateLimitOptionsRateLimitThreshold, RegionSecurityPolicyRuleRateLimitOptionsRateLimitThresholdArgs

RegionSecurityPolicyUserDefinedField, RegionSecurityPolicyUserDefinedFieldArgs

Import

Package Details

On this page

On this page

RegionSecurityPolicyDdosProtectionConfig
, RegionSecurityPolicyDdosProtectionConfigArgs

RegionSecurityPolicyRule
, RegionSecurityPolicyRuleArgs

RegionSecurityPolicyRuleMatch
, RegionSecurityPolicyRuleMatchArgs

RegionSecurityPolicyRuleMatchConfig
, RegionSecurityPolicyRuleMatchConfigArgs

RegionSecurityPolicyRuleMatchExpr
, RegionSecurityPolicyRuleMatchExprArgs

RegionSecurityPolicyRuleNetworkMatch
, RegionSecurityPolicyRuleNetworkMatchArgs

RegionSecurityPolicyRuleNetworkMatchUserDefinedField
, RegionSecurityPolicyRuleNetworkMatchUserDefinedFieldArgs

RegionSecurityPolicyRulePreconfiguredWafConfig
, RegionSecurityPolicyRulePreconfiguredWafConfigArgs

RegionSecurityPolicyRulePreconfiguredWafConfigExclusion
, RegionSecurityPolicyRulePreconfiguredWafConfigExclusionArgs

RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestCooky
, RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestCookyArgs

RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestHeader
, RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestHeaderArgs

RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestQueryParam
, RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestQueryParamArgs

RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestUri
, RegionSecurityPolicyRulePreconfiguredWafConfigExclusionRequestUriArgs

RegionSecurityPolicyRuleRateLimitOptions
, RegionSecurityPolicyRuleRateLimitOptionsArgs

RegionSecurityPolicyRuleRateLimitOptionsBanThreshold
, RegionSecurityPolicyRuleRateLimitOptionsBanThresholdArgs

RegionSecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig
, RegionSecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigArgs

RegionSecurityPolicyRuleRateLimitOptionsRateLimitThreshold
, RegionSecurityPolicyRuleRateLimitOptionsRateLimitThresholdArgs

RegionSecurityPolicyUserDefinedField
, RegionSecurityPolicyUserDefinedFieldArgs