---
title: Getting Started with Datadog
description: Datadog, the leading service for cloud-scale monitoring.
breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog
---

# gcp_compute_security_policy{% #gcp_compute_security_policy %}

## `adaptive_protection_config`{% #adaptive_protection_config %}

**Type**: `STRUCT`**Provider name**: `adaptiveProtectionConfig`

- `layer7_ddos_defense_config`**Type**: `STRUCT`**Provider name**: `layer7DdosDefenseConfig`**Description**: If set to true, enables Cloud Armor Machine Learning.
  - `enable`**Type**: `BOOLEAN`**Provider name**: `enable`**Description**: If set to true, enables CAAP for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
  - `rule_visibility`**Type**: `STRING`**Provider name**: `ruleVisibility`**Description**: Rule visibility can be one of the following: STANDARD - opaque rules. (default) PREMIUM - transparent rules. This field is only supported in Global Security Policies of type CLOUD_ARMOR.**Possible values**:
    - `PREMIUM`
    - `STANDARD`
  - `threshold_configs`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `thresholdConfigs`**Description**: Configuration options for layer7 adaptive protection for various customizable thresholds.
    - `auto_deploy_confidence_threshold`**Type**: `FLOAT`**Provider name**: `autoDeployConfidenceThreshold`
    - `auto_deploy_expiration_sec`**Type**: `INT32`**Provider name**: `autoDeployExpirationSec`
    - `auto_deploy_impacted_baseline_threshold`**Type**: `FLOAT`**Provider name**: `autoDeployImpactedBaselineThreshold`
    - `auto_deploy_load_threshold`**Type**: `FLOAT`**Provider name**: `autoDeployLoadThreshold`
    - `detection_absolute_qps`**Type**: `FLOAT`**Provider name**: `detectionAbsoluteQps`
    - `detection_load_threshold`**Type**: `FLOAT`**Provider name**: `detectionLoadThreshold`
    - `detection_relative_to_baseline_qps`**Type**: `FLOAT`**Provider name**: `detectionRelativeToBaselineQps`
    - `name`**Type**: `STRING`**Provider name**: `name`**Description**: The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the security policy.
    - `traffic_granularity_configs`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `trafficGranularityConfigs`**Description**: Configuration options for enabling Adaptive Protection to operate on specified granular traffic units.
      - `enable_each_unique_value`**Type**: `BOOLEAN`**Provider name**: `enableEachUniqueValue`**Description**: If enabled, traffic matching each unique value for the specified type constitutes a separate traffic unit. It can only be set to true if `value` is empty.
      - `type`**Type**: `STRING`**Provider name**: `type`**Description**: Type of this configuration.**Possible values**:
        - `HTTP_HEADER_HOST`
        - `HTTP_PATH`
        - `UNSPECIFIED_TYPE`
      - `value`**Type**: `STRING`**Provider name**: `value`**Description**: Requests that match this value constitute a granular traffic unit.

## `advanced_options_config`{% #advanced_options_config %}

**Type**: `STRUCT`**Provider name**: `advancedOptionsConfig`

- `json_custom_config`**Type**: `STRUCT`**Provider name**: `jsonCustomConfig`**Description**: Custom configuration to apply the JSON parsing. Only applicable when json_parsing is set to STANDARD.
  - `content_types`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `contentTypes`**Description**: A list of custom Content-Type header values to apply the JSON parsing. As per RFC 1341, a Content-Type header value has the following format: Content-Type := type "/" subtype *[";" parameter] When configuring a custom Content-Type header value, only the type/subtype needs to be specified, and the parameters should be excluded.
- `json_parsing`**Type**: `STRING`**Provider name**: `jsonParsing`
- `log_level`**Type**: `STRING`**Provider name**: `logLevel`
- `user_ip_request_headers`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `userIpRequestHeaders`**Description**: An optional list of case-insensitive request header names to use for resolving the callers client IP address.

## `ancestors`{% #ancestors %}

**Type**: `UNORDERED_LIST_STRING`

## `creation_timestamp`{% #creation_timestamp %}

**Type**: `TIMESTAMP`**Provider name**: `creationTimestamp`**Description**: [Output Only] Creation timestamp in RFC3339 text format.

## `ddos_protection_config`{% #ddos_protection_config %}

**Type**: `STRUCT`**Provider name**: `ddosProtectionConfig`

- `ddos_protection`**Type**: `STRING`**Provider name**: `ddosProtection`

## `description`{% #description %}

**Type**: `STRING`**Provider name**: `description`**Description**: An optional description of this resource. Provide this property when you create the resource.

## `id`{% #id %}

**Type**: `STRING`**Provider name**: `id`**Description**: [Output Only] The unique identifier for the resource. This identifier is defined by the server.

## `kind`{% #kind %}

**Type**: `STRING`**Provider name**: `kind`**Description**: [Output only] Type of the resource. Always compute#securityPolicyfor security policies

## `labels`{% #labels %}

**Type**: `UNORDERED_LIST_STRING`

## `name`{% #name %}

**Type**: `STRING`**Provider name**: `name`**Description**: 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]([-a-z0-9]*[a-z0-9])?` 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.

## `organization_id`{% #organization_id %}

**Type**: `STRING`

## `parent`{% #parent %}

**Type**: `STRING`

## `project_id`{% #project_id %}

**Type**: `STRING`

## `project_number`{% #project_number %}

**Type**: `STRING`

## `recaptcha_options_config`{% #recaptcha_options_config %}

**Type**: `STRUCT`**Provider name**: `recaptchaOptionsConfig`

- `redirect_site_key`**Type**: `STRING`**Provider name**: `redirectSiteKey`**Description**: An optional field to supply a reCAPTCHA site key to be used for all the rules using the redirect action with the type of GOOGLE_RECAPTCHA under the security policy. The specified site key needs to be created from the reCAPTCHA API. The user is responsible for the validity of the specified site key. If not specified, a Google-managed site key is used. This field is only supported in Global Security Policies of type CLOUD_ARMOR.

## `region`{% #region %}

**Type**: `STRING`**Provider name**: `region`**Description**: [Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies.

## `region_id`{% #region_id %}

**Type**: `STRING`

## `resource_name`{% #resource_name %}

**Type**: `STRING`

## `rules`{% #rules %}

**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `rules`**Description**: A list of rules that belong to this policy. There must always be a default rule which is a rule with priority 2147483647 and match all condition (for the match condition this means match "*" for srcIpRanges and for the networkMatch condition every field must be either match "*" or not set). If no rules are provided when creating a security policy, a default rule with action "allow" will be added.

- `action`**Type**: `STRING`**Provider name**: `action`**Description**: 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 rate_limit_options 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 rate_limit_options to be set for this.
- `description`**Type**: `STRING`**Provider name**: `description`**Description**: An optional description of this resource. Provide this property when you create the resource.
- `header_action`**Type**: `STRUCT`**Provider name**: `headerAction`**Description**: Optional, additional actions that are performed on headers. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
  - `request_headers_to_adds`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `requestHeadersToAdds`**Description**: The list of request headers to add or overwrite if they're already present.
    - `header_name`**Type**: `STRING`**Provider name**: `headerName`**Description**: The name of the header to set.
    - `header_value`**Type**: `STRING`**Provider name**: `headerValue`**Description**: The value to set the named header to.
- `kind`**Type**: `STRING`**Provider name**: `kind`**Description**: [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules
- `match`**Type**: `STRUCT`**Provider name**: `match`**Description**: A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
  - `config`**Type**: `STRUCT`**Provider name**: `config`**Description**: The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified.
    - `src_ip_ranges`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `srcIpRanges`**Description**: CIDR IP address range. Maximum number of src_ip_ranges allowed is 10.
  - `expr`**Type**: `STRUCT`**Provider name**: `expr`**Description**: 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. Expressions containing `evaluateThreatIntelligence` require Cloud Armor Managed Protection Plus tier and are not supported in Edge Policies nor in Regional Policies. Expressions containing `evaluatePreconfiguredExpr('sourceiplist-*')` require Cloud Armor Managed Protection Plus tier and are only supported in Global Security Policies.
    - `description`**Type**: `STRING`**Provider name**: `description`**Description**: Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
    - `expression`**Type**: `STRING`**Provider name**: `expression`**Description**: Textual representation of an expression in Common Expression Language syntax.
    - `location`**Type**: `STRING`**Provider name**: `location`**Description**: Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
    - `title`**Type**: `STRING`**Provider name**: `title`**Description**: Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
  - `expr_options`**Type**: `STRUCT`**Provider name**: `exprOptions`**Description**: The configuration options available when specifying a user defined CEVAL expression (i.e., 'expr').
    - `recaptcha_options`**Type**: `STRUCT`**Provider name**: `recaptchaOptions`**Description**: reCAPTCHA configuration options to be applied for the rule. If the rule does not evaluate reCAPTCHA tokens, this field has no effect.
      - `action_token_site_keys`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `actionTokenSiteKeys`**Description**: A list of site keys to be used during the validation of reCAPTCHA action-tokens. The provided site keys need to be created from reCAPTCHA API under the same project where the security policy is created.
      - `session_token_site_keys`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `sessionTokenSiteKeys`**Description**: A list of site keys to be used during the validation of reCAPTCHA session-tokens. The provided site keys need to be created from reCAPTCHA API under the same project where the security policy is created.
  - `versioned_expr`**Type**: `STRING`**Provider name**: `versionedExpr`**Description**: 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 src_ip_range field in config.**Possible values**:
    - `SRC_IPS_V1` - Matches the source IP address of a request to the IP ranges supplied in config.
- `network_match`**Type**: `STRUCT`**Provider name**: `networkMatch`**Description**: 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.
  - `dest_ip_ranges`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `destIpRanges`**Description**: Destination IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
  - `dest_ports`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `destPorts`**Description**: 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`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `ipProtocols`**Description**: 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`**Type**: `UNORDERED_LIST_INT32`**Provider name**: `srcAsns`**Description**: BGP Autonomous System Number associated with the source IP address.
  - `src_ip_ranges`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `srcIpRanges`**Description**: Source IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
  - `src_ports`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `srcPorts`**Description**: 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`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `srcRegionCodes`**Description**: Two-letter ISO 3166-1 alpha-2 country code associated with the source IP address.
  - `user_defined_fields`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `userDefinedFields`**Description**: User-defined fields. Each element names a defined field and lists the matching values for that field.
    - `name`**Type**: `STRING`**Provider name**: `name`**Description**: Name of the user-defined field, as given in the definition.
    - `values`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `values`**Description**: 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").
- `preconfigured_waf_config`**Type**: `STRUCT`**Provider name**: `preconfiguredWafConfig`**Description**: 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.
  - `exclusions`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `exclusions`**Description**: A list of exclusions to apply during preconfigured WAF evaluation.
    - `request_cookies_to_exclude`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `requestCookiesToExclude`**Description**: A list of request cookie names whose value will be excluded from inspection during preconfigured WAF evaluation.
      - `op`**Type**: `STRING`**Provider name**: `op`**Description**: The match operator for the field.**Possible values**:
        - `CONTAINS` - The operator matches if the field value contains the specified value.
        - `ENDS_WITH` - The operator matches if the field value ends with the specified value.
        - `EQUALS` - The operator matches if the field value equals the specified value.
        - `EQUALS_ANY` - The operator matches if the field value is any value.
        - `STARTS_WITH` - The operator matches if the field value starts with the specified value.
      - `val`**Type**: `STRING`**Provider name**: `val`**Description**: The value of the field.
    - `request_headers_to_exclude`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `requestHeadersToExclude`**Description**: A list of request header names whose value will be excluded from inspection during preconfigured WAF evaluation.
      - `op`**Type**: `STRING`**Provider name**: `op`**Description**: The match operator for the field.**Possible values**:
        - `CONTAINS` - The operator matches if the field value contains the specified value.
        - `ENDS_WITH` - The operator matches if the field value ends with the specified value.
        - `EQUALS` - The operator matches if the field value equals the specified value.
        - `EQUALS_ANY` - The operator matches if the field value is any value.
        - `STARTS_WITH` - The operator matches if the field value starts with the specified value.
      - `val`**Type**: `STRING`**Provider name**: `val`**Description**: The value of the field.
    - `request_query_params_to_exclude`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `requestQueryParamsToExclude`**Description**: A list of request query parameter names 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.
      - `op`**Type**: `STRING`**Provider name**: `op`**Description**: The match operator for the field.**Possible values**:
        - `CONTAINS` - The operator matches if the field value contains the specified value.
        - `ENDS_WITH` - The operator matches if the field value ends with the specified value.
        - `EQUALS` - The operator matches if the field value equals the specified value.
        - `EQUALS_ANY` - The operator matches if the field value is any value.
        - `STARTS_WITH` - The operator matches if the field value starts with the specified value.
      - `val`**Type**: `STRING`**Provider name**: `val`**Description**: The value of the field.
    - `request_uris_to_exclude`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `requestUrisToExclude`**Description**: A list of request URIs 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.
      - `op`**Type**: `STRING`**Provider name**: `op`**Description**: The match operator for the field.**Possible values**:
        - `CONTAINS` - The operator matches if the field value contains the specified value.
        - `ENDS_WITH` - The operator matches if the field value ends with the specified value.
        - `EQUALS` - The operator matches if the field value equals the specified value.
        - `EQUALS_ANY` - The operator matches if the field value is any value.
        - `STARTS_WITH` - The operator matches if the field value starts with the specified value.
      - `val`**Type**: `STRING`**Provider name**: `val`**Description**: The value of the field.
    - `target_rule_ids`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `targetRuleIds`**Description**: 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`**Type**: `STRING`**Provider name**: `targetRuleSet`**Description**: Target WAF rule set to apply the preconfigured WAF exclusion.
- `preview`**Type**: `BOOLEAN`**Provider name**: `preview`**Description**: If set to true, the specified action is not enforced.
- `priority`**Type**: `INT32`**Provider name**: `priority`**Description**: 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.
- `rate_limit_options`**Type**: `STRUCT`**Provider name**: `rateLimitOptions`**Description**: Must be specified if the action is "rate_based_ban" or "throttle". Cannot be specified for any other actions.
  - `ban_duration_sec`**Type**: `INT32`**Provider name**: `banDurationSec`**Description**: 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.
  - `ban_threshold`**Type**: `STRUCT`**Provider name**: `banThreshold`**Description**: Can only be specified if the action for the rule is "rate_based_ban". If specified, the key will be banned for the configured 'ban_duration_sec' when the number of requests that exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'.
    - `count`**Type**: `INT32`**Provider name**: `count`**Description**: Number of HTTP(S) requests for calculating the threshold.
    - `interval_sec`**Type**: `INT32`**Provider name**: `intervalSec`**Description**: Interval over which the threshold is computed.
  - `conform_action`**Type**: `STRING`**Provider name**: `conformAction`**Description**: Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only.
  - `enforce_on_key`**Type**: `STRING`**Provider name**: `enforceOnKey`**Description**: Determines the key to enforce the rate_limit_threshold 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. - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL.**Possible values**:
    - `ALL`
    - `HTTP_COOKIE`
    - `HTTP_HEADER`
    - `HTTP_PATH`
    - `IP`
    - `REGION_CODE`
    - `SNI`
    - `TLS_JA3_FINGERPRINT`
    - `TLS_JA4_FINGERPRINT`
    - `USER_IP`
    - `XFF_IP`
  - `enforce_on_key_configs`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `enforceOnKeyConfigs`**Description**: If specified, any combination of values of enforce_on_key_type/enforce_on_key_name is treated as the key on which ratelimit threshold/action is enforced. You can specify up to 3 enforce_on_key_configs. If enforce_on_key_configs is specified, enforce_on_key must not be specified.
    - `enforce_on_key_name`**Type**: `STRING`**Provider name**: `enforceOnKeyName`**Description**: 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.
    - `enforce_on_key_type`**Type**: `STRING`**Provider name**: `enforceOnKeyType`**Description**: Determines the key to enforce the rate_limit_threshold 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. - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL.**Possible values**:
      - `ALL`
      - `HTTP_COOKIE`
      - `HTTP_HEADER`
      - `HTTP_PATH`
      - `IP`
      - `REGION_CODE`
      - `SNI`
      - `TLS_JA3_FINGERPRINT`
      - `TLS_JA4_FINGERPRINT`
      - `USER_IP`
      - `XFF_IP`
  - `enforce_on_key_name`**Type**: `STRING`**Provider name**: `enforceOnKeyName`**Description**: 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.
  - `exceed_action`**Type**: `STRING`**Provider name**: `exceedAction`**Description**: Action to take for requests that are above the configured rate limit threshold, to either deny with a specified HTTP response code, or redirect to a different endpoint. Valid options are `deny(STATUS)`, where valid values for `STATUS` are 403, 404, 429, and 502, and `redirect`, where the redirect parameters come from `exceedRedirectOptions` below. The `redirect` action is only supported in Global Security Policies of type CLOUD_ARMOR.
  - `exceed_redirect_options`**Type**: `STRUCT`**Provider name**: `exceedRedirectOptions`**Description**: Parameters defining the redirect action that is used as the exceed action. Cannot be specified if the exceed action is not redirect. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
    - `target`**Type**: `STRING`**Provider name**: `target`**Description**: Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.
    - `type`**Type**: `STRING`**Provider name**: `type`**Description**: Type of the redirect action.**Possible values**:
      - `EXTERNAL_302`
      - `GOOGLE_RECAPTCHA`
  - `rate_limit_threshold`**Type**: `STRUCT`**Provider name**: `rateLimitThreshold`**Description**: Threshold at which to begin ratelimiting.
    - `count`**Type**: `INT32`**Provider name**: `count`**Description**: Number of HTTP(S) requests for calculating the threshold.
    - `interval_sec`**Type**: `INT32`**Provider name**: `intervalSec`**Description**: Interval over which the threshold is computed.
- `redirect_options`**Type**: `STRUCT`**Provider name**: `redirectOptions`**Description**: Parameters defining the redirect action. Cannot be specified for any other actions. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
  - `target`**Type**: `STRING`**Provider name**: `target`**Description**: Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.
  - `type`**Type**: `STRING`**Provider name**: `type`**Description**: Type of the redirect action.**Possible values**:
    - `EXTERNAL_302`
    - `GOOGLE_RECAPTCHA`

## `self_link`{% #self_link %}

**Type**: `STRING`**Provider name**: `selfLink`**Description**: [Output Only] Server-defined URL for the resource.

## `tags`{% #tags %}

**Type**: `UNORDERED_LIST_STRING`

## `type`{% #type %}

**Type**: `STRING`**Provider name**: `type`**Description**: 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_INTERNAL_SERVICE: Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - 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**:

- `CLOUD_ARMOR`
- `CLOUD_ARMOR_EDGE`
- `CLOUD_ARMOR_NETWORK`

## `user_defined_fields`{% #user_defined_fields %}

**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `userDefinedFields`**Description**: 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. Example: userDefinedFields: - name: "ipv4_fragment_offset" base: IPV4 offset: 6 size: 2 mask: "0x1fff"

- `base`**Type**: `STRING`**Provider name**: `base`**Description**: 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. required**Possible values**:
  - `IPV4`
  - `IPV6`
  - `TCP`
  - `UDP`
- `mask`**Type**: `STRING`**Provider name**: `mask`**Description**: 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`**Type**: `STRING`**Provider name**: `name`**Description**: The name of this field. Must be unique within the policy.
- `offset`**Type**: `INT32`**Provider name**: `offset`**Description**: Offset of the first byte of the field (in network byte order) relative to 'base'.
- `size`**Type**: `INT32`**Provider name**: `size`**Description**: Size of the field in bytes. Valid values: 1-4.

## `zone_id`{% #zone_id %}

**Type**: `STRING`