google-native.compute/beta.getOrganizationSecurityPolicy

func LookupOrganizationSecurityPolicy(ctx *Context, args *LookupOrganizationSecurityPolicyArgs, opts ...InvokeOption) (*LookupOrganizationSecurityPolicyResult, error)
func LookupOrganizationSecurityPolicyOutput(ctx *Context, args *LookupOrganizationSecurityPolicyOutputArgs, opts ...InvokeOption) LookupOrganizationSecurityPolicyResultOutput

> Note: This function is named LookupOrganizationSecurityPolicy in the Go SDK.

SecurityPolicy string

SecurityPolicy string

securityPolicy String

securityPolicy string

security_policy str

securityPolicy String

AdaptiveProtectionConfig Pulumi.GoogleNative.Compute.Beta.Outputs.SecurityPolicyAdaptiveProtectionConfigResponse

AdvancedOptionsConfig Pulumi.GoogleNative.Compute.Beta.Outputs.SecurityPolicyAdvancedOptionsConfigResponse

Associations List<Pulumi.GoogleNative.Compute.Beta.Outputs.SecurityPolicyAssociationResponse>

A list of associations that belong to this policy.

CreationTimestamp string

Creation timestamp in RFC3339 text format.

DdosProtectionConfig Pulumi.GoogleNative.Compute.Beta.Outputs.SecurityPolicyDdosProtectionConfigResponse

Description string

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

DisplayName string

User-provided name of the Organization security plicy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is FIREWALL. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. 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.

Fingerprint string

Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy.

Kind string

[Output only] Type of the resource. Always compute#securityPolicyfor security policies

LabelFingerprint string

A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the security policy.

Labels Dictionary<string, string>

Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

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]([-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.

Parent string

The parent of the security policy.

RecaptchaOptionsConfig Pulumi.GoogleNative.Compute.Beta.Outputs.SecurityPolicyRecaptchaOptionsConfigResponse

Region string

URL of the region where the regional security policy resides. This field is not applicable to global security policies.

RuleTupleCount int

Total count of all security policy rule tuples. A security policy can not exceed a set number of tuples.

Rules List<Pulumi.GoogleNative.Compute.Beta.Outputs.SecurityPolicyRuleResponse>

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.

SelfLink string

Server-defined URL for the resource.

SelfLinkWithId 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_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.

UserDefinedFields List<Pulumi.GoogleNative.Compute.Beta.Outputs.SecurityPolicyUserDefinedFieldResponse>

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"

AdaptiveProtectionConfig SecurityPolicyAdaptiveProtectionConfigResponse

AdvancedOptionsConfig SecurityPolicyAdvancedOptionsConfigResponse

Associations []SecurityPolicyAssociationResponse

A list of associations that belong to this policy.

CreationTimestamp string

Creation timestamp in RFC3339 text format.

DdosProtectionConfig SecurityPolicyDdosProtectionConfigResponse

Description string

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

DisplayName string

User-provided name of the Organization security plicy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is FIREWALL. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. 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.

Fingerprint string

Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy.

Kind string

[Output only] Type of the resource. Always compute#securityPolicyfor security policies

LabelFingerprint string

A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the security policy.

Labels map[string]string

Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

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]([-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.

Parent string

The parent of the security policy.

RecaptchaOptionsConfig SecurityPolicyRecaptchaOptionsConfigResponse

Region string

URL of the region where the regional security policy resides. This field is not applicable to global security policies.

RuleTupleCount int

Total count of all security policy rule tuples. A security policy can not exceed a set number of tuples.

Rules []SecurityPolicyRuleResponse

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.

SelfLink string

Server-defined URL for the resource.

SelfLinkWithId 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_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.

UserDefinedFields []SecurityPolicyUserDefinedFieldResponse

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"

adaptiveProtectionConfig SecurityPolicyAdaptiveProtectionConfigResponse

advancedOptionsConfig SecurityPolicyAdvancedOptionsConfigResponse

associations List<SecurityPolicyAssociationResponse>

A list of associations that belong to this policy.

creationTimestamp String

Creation timestamp in RFC3339 text format.

ddosProtectionConfig SecurityPolicyDdosProtectionConfigResponse

description String

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

displayName String

User-provided name of the Organization security plicy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is FIREWALL. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. 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.

fingerprint String

Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy.

kind String

[Output only] Type of the resource. Always compute#securityPolicyfor security policies

labelFingerprint String

A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the security policy.

labels Map<String,String>

Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

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]([-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.

parent String

The parent of the security policy.

recaptchaOptionsConfig SecurityPolicyRecaptchaOptionsConfigResponse

region String

URL of the region where the regional security policy resides. This field is not applicable to global security policies.

ruleTupleCount Integer

Total count of all security policy rule tuples. A security policy can not exceed a set number of tuples.

rules List<SecurityPolicyRuleResponse>

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.

selfLink String

Server-defined URL for the resource.

selfLinkWithId 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_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.

userDefinedFields List<SecurityPolicyUserDefinedFieldResponse>

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"

adaptiveProtectionConfig SecurityPolicyAdaptiveProtectionConfigResponse

advancedOptionsConfig SecurityPolicyAdvancedOptionsConfigResponse

associations SecurityPolicyAssociationResponse[]

A list of associations that belong to this policy.

creationTimestamp string

Creation timestamp in RFC3339 text format.

ddosProtectionConfig SecurityPolicyDdosProtectionConfigResponse

description string

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

displayName string

User-provided name of the Organization security plicy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is FIREWALL. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. 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.

fingerprint string

Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy.

kind string

[Output only] Type of the resource. Always compute#securityPolicyfor security policies

labelFingerprint string

A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the security policy.

labels {[key: string]: string}

Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

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]([-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.

parent string

The parent of the security policy.

recaptchaOptionsConfig SecurityPolicyRecaptchaOptionsConfigResponse

region string

URL of the region where the regional security policy resides. This field is not applicable to global security policies.

ruleTupleCount number

Total count of all security policy rule tuples. A security policy can not exceed a set number of tuples.

rules SecurityPolicyRuleResponse[]

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.

selfLink string

Server-defined URL for the resource.

selfLinkWithId 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_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.

userDefinedFields SecurityPolicyUserDefinedFieldResponse[]

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"

adaptive_protection_config SecurityPolicyAdaptiveProtectionConfigResponse

advanced_options_config SecurityPolicyAdvancedOptionsConfigResponse

associations Sequence[SecurityPolicyAssociationResponse]

A list of associations that belong to this policy.

creation_timestamp str

Creation timestamp in RFC3339 text format.

ddos_protection_config SecurityPolicyDdosProtectionConfigResponse

description str

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

display_name str

User-provided name of the Organization security plicy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is FIREWALL. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. 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.

fingerprint str

Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy.

kind str

[Output only] Type of the resource. Always compute#securityPolicyfor security policies

label_fingerprint str

A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the security policy.

labels Mapping[str, str]

Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

name str

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.

parent str

The parent of the security policy.

recaptcha_options_config SecurityPolicyRecaptchaOptionsConfigResponse

region str

URL of the region where the regional security policy resides. This field is not applicable to global security policies.

rule_tuple_count int

Total count of all security policy rule tuples. A security policy can not exceed a set number of tuples.

rules Sequence[SecurityPolicyRuleResponse]

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.

self_link str

Server-defined URL for the resource.

self_link_with_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_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.

user_defined_fields Sequence[SecurityPolicyUserDefinedFieldResponse]

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"

adaptiveProtectionConfig Property Map

advancedOptionsConfig Property Map

associations List<Property Map>

A list of associations that belong to this policy.

creationTimestamp String

Creation timestamp in RFC3339 text format.

ddosProtectionConfig Property Map

description String

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

displayName String

User-provided name of the Organization security plicy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is FIREWALL. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. 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.

fingerprint String

Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy.

kind String

[Output only] Type of the resource. Always compute#securityPolicyfor security policies

labelFingerprint String

A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the security policy.

labels Map<String>

Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

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]([-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.

parent String

The parent of the security policy.

recaptchaOptionsConfig Property Map

region String

URL of the region where the regional security policy resides. This field is not applicable to global security policies.

ruleTupleCount Number

Total count of all security policy rule tuples. A security policy can not exceed a set number of tuples.

rules List<Property Map>

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.

selfLink String

Server-defined URL for the resource.

selfLinkWithId 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_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.

userDefinedFields List<Property Map>

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"

Description string

Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

Expression string

Textual representation of an expression in Common Expression Language syntax.

Location string

Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

Title string

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.

Description string

Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

Expression string

Textual representation of an expression in Common Expression Language syntax.

Location string

Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

Title string

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.

description String

Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

expression String

Textual representation of an expression in Common Expression Language syntax.

location String

Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

title String

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.

description string

Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

expression string

Textual representation of an expression in Common Expression Language syntax.

location string

Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

title string

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.

description str

Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

expression str

Textual representation of an expression in Common Expression Language syntax.

location str

Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

title str

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.

description String

Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

expression String

Textual representation of an expression in Common Expression Language syntax.

location String

Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

title String

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.

ConfidenceThreshold double

ExpirationSec int

ImpactedBaselineThreshold double

LoadThreshold double

ConfidenceThreshold float64

ExpirationSec int

ImpactedBaselineThreshold float64

LoadThreshold float64

confidenceThreshold Double

expirationSec Integer

impactedBaselineThreshold Double

loadThreshold Double

confidenceThreshold number

expirationSec number

impactedBaselineThreshold number

loadThreshold number

confidence_threshold float

expiration_sec int

impacted_baseline_threshold float

load_threshold float

confidenceThreshold Number

expirationSec Number

impactedBaselineThreshold Number

loadThreshold Number

Enable bool

If set to true, enables CAAP for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR.

RuleVisibility string

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.

Enable bool

If set to true, enables CAAP for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR.

RuleVisibility string

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.

enable Boolean

If set to true, enables CAAP for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR.

ruleVisibility String

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.

enable boolean

If set to true, enables CAAP for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR.

ruleVisibility string

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.

enable bool

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 str

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.

enable Boolean

If set to true, enables CAAP for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR.

ruleVisibility String

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.

AutoDeployConfig Pulumi.GoogleNative.Compute.Beta.Inputs.SecurityPolicyAdaptiveProtectionConfigAutoDeployConfigResponse

Layer7DdosDefenseConfig Pulumi.GoogleNative.Compute.Beta.Inputs.SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigResponse

If set to true, enables Cloud Armor Machine Learning.

AutoDeployConfig SecurityPolicyAdaptiveProtectionConfigAutoDeployConfigResponse

Layer7DdosDefenseConfig SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigResponse

If set to true, enables Cloud Armor Machine Learning.

autoDeployConfig SecurityPolicyAdaptiveProtectionConfigAutoDeployConfigResponse

layer7DdosDefenseConfig SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigResponse

If set to true, enables Cloud Armor Machine Learning.

autoDeployConfig SecurityPolicyAdaptiveProtectionConfigAutoDeployConfigResponse

layer7DdosDefenseConfig SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigResponse

If set to true, enables Cloud Armor Machine Learning.

auto_deploy_config SecurityPolicyAdaptiveProtectionConfigAutoDeployConfigResponse

layer7_ddos_defense_config SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigResponse

If set to true, enables Cloud Armor Machine Learning.

autoDeployConfig Property Map

layer7DdosDefenseConfig Property Map

If set to true, enables Cloud Armor Machine Learning.

ContentTypes List<string>

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.

ContentTypes []string

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.

contentTypes List<String>

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.

contentTypes string[]

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.

content_types Sequence[str]

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.

contentTypes List<String>

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.

JsonCustomConfig Pulumi.GoogleNative.Compute.Beta.Inputs.SecurityPolicyAdvancedOptionsConfigJsonCustomConfigResponse

Custom configuration to apply the JSON parsing. Only applicable when json_parsing is set to STANDARD.

JsonParsing string

LogLevel string

UserIpRequestHeaders List<string>

An optional list of case-insensitive request header names to use for resolving the callers client IP address.

JsonCustomConfig SecurityPolicyAdvancedOptionsConfigJsonCustomConfigResponse

Custom configuration to apply the JSON parsing. Only applicable when json_parsing is set to STANDARD.

JsonParsing string

LogLevel string

UserIpRequestHeaders []string

An optional list of case-insensitive request header names to use for resolving the callers client IP address.

jsonCustomConfig SecurityPolicyAdvancedOptionsConfigJsonCustomConfigResponse

Custom configuration to apply the JSON parsing. Only applicable when json_parsing is set to STANDARD.

jsonParsing String

logLevel String

userIpRequestHeaders List<String>

An optional list of case-insensitive request header names to use for resolving the callers client IP address.

jsonCustomConfig SecurityPolicyAdvancedOptionsConfigJsonCustomConfigResponse

Custom configuration to apply the JSON parsing. Only applicable when json_parsing is set to STANDARD.

jsonParsing string

logLevel string

userIpRequestHeaders string[]

An optional list of case-insensitive request header names to use for resolving the callers client IP address.

json_custom_config SecurityPolicyAdvancedOptionsConfigJsonCustomConfigResponse

Custom configuration to apply the JSON parsing. Only applicable when json_parsing is set to STANDARD.

json_parsing str

log_level str

user_ip_request_headers Sequence[str]

An optional list of case-insensitive request header names to use for resolving the callers client IP address.

jsonCustomConfig Property Map

Custom configuration to apply the JSON parsing. Only applicable when json_parsing is set to STANDARD.

jsonParsing String

logLevel String

userIpRequestHeaders List<String>

An optional list of case-insensitive request header names to use for resolving the callers client IP address.

AttachmentId string

The resource that the security policy is attached to.

DisplayName string

The display name of the security policy of the association.

Name string

The name for an association.

SecurityPolicyId string

The security policy ID of the association.

AttachmentId string

The resource that the security policy is attached to.

DisplayName string

The display name of the security policy of the association.

Name string

The name for an association.

SecurityPolicyId string

The security policy ID of the association.

attachmentId String

The resource that the security policy is attached to.

displayName String

The display name of the security policy of the association.

name String

The name for an association.

securityPolicyId String

The security policy ID of the association.

attachmentId string

The resource that the security policy is attached to.

displayName string

The display name of the security policy of the association.

name string

The name for an association.

securityPolicyId string

The security policy ID of the association.

attachment_id str

The resource that the security policy is attached to.

display_name str

The display name of the security policy of the association.

name str

The name for an association.

security_policy_id str

The security policy ID of the association.

attachmentId String

The resource that the security policy is attached to.

displayName String

The display name of the security policy of the association.

name String

The name for an association.

securityPolicyId String

The security policy ID of the association.

DdosProtection string

DdosProtection string

ddosProtection String

ddosProtection string

ddos_protection str

ddosProtection String

RedirectSiteKey string

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.

RedirectSiteKey string

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.

redirectSiteKey String

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.

redirectSiteKey string

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.

redirect_site_key str

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.

redirectSiteKey String

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.

HeaderName string

The name of the header to set.

HeaderValue string

The value to set the named header to.

HeaderName string

The name of the header to set.

HeaderValue string

The value to set the named header to.

headerName String

The name of the header to set.

headerValue String

The value to set the named header to.

headerName string

The name of the header to set.

headerValue string

The value to set the named header to.

header_name str

The name of the header to set.

header_value str

The value to set the named header to.

headerName String

The name of the header to set.

headerValue String

The value to set the named header to.

RequestHeadersToAdds List<Pulumi.GoogleNative.Compute.Beta.Inputs.SecurityPolicyRuleHttpHeaderActionHttpHeaderOptionResponse>

The list of request headers to add or overwrite if they're already present.

RequestHeadersToAdds []SecurityPolicyRuleHttpHeaderActionHttpHeaderOptionResponse

The list of request headers to add or overwrite if they're already present.

requestHeadersToAdds List<SecurityPolicyRuleHttpHeaderActionHttpHeaderOptionResponse>

The list of request headers to add or overwrite if they're already present.

requestHeadersToAdds SecurityPolicyRuleHttpHeaderActionHttpHeaderOptionResponse[]

The list of request headers to add or overwrite if they're already present.

request_headers_to_adds Sequence[SecurityPolicyRuleHttpHeaderActionHttpHeaderOptionResponse]

The list of request headers to add or overwrite if they're already present.

requestHeadersToAdds List<Property Map>

The list of request headers to add or overwrite if they're already present.

IpProtocol string

The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.

Ports List<string>

An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. This field may only be specified when versioned_expr is set to FIREWALL.

IpProtocol string

The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.

Ports []string

An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. This field may only be specified when versioned_expr is set to FIREWALL.

ipProtocol String

The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.

ports List<String>

An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. This field may only be specified when versioned_expr is set to FIREWALL.

ipProtocol string

The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.

ports string[]

An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. This field may only be specified when versioned_expr is set to FIREWALL.

ip_protocol str

The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.

ports Sequence[str]

An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. This field may only be specified when versioned_expr is set to FIREWALL.

ipProtocol String

The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.

ports List<String>

An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. This field may only be specified when versioned_expr is set to FIREWALL.

DestIpRanges List<string>

CIDR IP address range. This field may only be specified when versioned_expr is set to FIREWALL.

Layer4Configs List<Pulumi.GoogleNative.Compute.Beta.Inputs.SecurityPolicyRuleMatcherConfigLayer4ConfigResponse>

Pairs of IP protocols and ports that the rule should match. This field may only be specified when versioned_expr is set to FIREWALL.

SrcIpRanges List<string>

CIDR IP address range. Maximum number of src_ip_ranges allowed is 10.

DestIpRanges []string

CIDR IP address range. This field may only be specified when versioned_expr is set to FIREWALL.

Layer4Configs []SecurityPolicyRuleMatcherConfigLayer4ConfigResponse

Pairs of IP protocols and ports that the rule should match. This field may only be specified when versioned_expr is set to FIREWALL.

SrcIpRanges []string

CIDR IP address range. Maximum number of src_ip_ranges allowed is 10.

destIpRanges List<String>

CIDR IP address range. This field may only be specified when versioned_expr is set to FIREWALL.

layer4Configs List<SecurityPolicyRuleMatcherConfigLayer4ConfigResponse>

Pairs of IP protocols and ports that the rule should match. This field may only be specified when versioned_expr is set to FIREWALL.

srcIpRanges List<String>

CIDR IP address range. Maximum number of src_ip_ranges allowed is 10.

destIpRanges string[]

CIDR IP address range. This field may only be specified when versioned_expr is set to FIREWALL.

layer4Configs SecurityPolicyRuleMatcherConfigLayer4ConfigResponse[]

Pairs of IP protocols and ports that the rule should match. This field may only be specified when versioned_expr is set to FIREWALL.

srcIpRanges string[]

CIDR IP address range. Maximum number of src_ip_ranges allowed is 10.

dest_ip_ranges Sequence[str]

CIDR IP address range. This field may only be specified when versioned_expr is set to FIREWALL.

layer4_configs Sequence[SecurityPolicyRuleMatcherConfigLayer4ConfigResponse]

Pairs of IP protocols and ports that the rule should match. This field may only be specified when versioned_expr is set to FIREWALL.

src_ip_ranges Sequence[str]

CIDR IP address range. Maximum number of src_ip_ranges allowed is 10.

destIpRanges List<String>

CIDR IP address range. This field may only be specified when versioned_expr is set to FIREWALL.

layer4Configs List<Property Map>

Pairs of IP protocols and ports that the rule should match. This field may only be specified when versioned_expr is set to FIREWALL.

srcIpRanges List<String>

CIDR IP address range. Maximum number of src_ip_ranges allowed is 10.

ActionTokenSiteKeys List<string>

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.

SessionTokenSiteKeys List<string>

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.

ActionTokenSiteKeys []string

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.

SessionTokenSiteKeys []string

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.

actionTokenSiteKeys List<String>

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.

sessionTokenSiteKeys List<String>

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.

actionTokenSiteKeys string[]

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.

sessionTokenSiteKeys string[]

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.

action_token_site_keys Sequence[str]

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 Sequence[str]

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.

actionTokenSiteKeys List<String>

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.

sessionTokenSiteKeys List<String>

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.

RecaptchaOptions Pulumi.GoogleNative.Compute.Beta.Inputs.SecurityPolicyRuleMatcherExprOptionsRecaptchaOptionsResponse

reCAPTCHA configuration options to be applied for the rule. If the rule does not evaluate reCAPTCHA tokens, this field will have no effect.

RecaptchaOptions SecurityPolicyRuleMatcherExprOptionsRecaptchaOptionsResponse

reCAPTCHA configuration options to be applied for the rule. If the rule does not evaluate reCAPTCHA tokens, this field will have no effect.

recaptchaOptions SecurityPolicyRuleMatcherExprOptionsRecaptchaOptionsResponse

reCAPTCHA configuration options to be applied for the rule. If the rule does not evaluate reCAPTCHA tokens, this field will have no effect.

recaptchaOptions SecurityPolicyRuleMatcherExprOptionsRecaptchaOptionsResponse

reCAPTCHA configuration options to be applied for the rule. If the rule does not evaluate reCAPTCHA tokens, this field will have no effect.

recaptcha_options SecurityPolicyRuleMatcherExprOptionsRecaptchaOptionsResponse

reCAPTCHA configuration options to be applied for the rule. If the rule does not evaluate reCAPTCHA tokens, this field will have no effect.

recaptchaOptions Property Map

reCAPTCHA configuration options to be applied for the rule. If the rule does not evaluate reCAPTCHA tokens, this field will have no effect.

Config Pulumi.GoogleNative.Compute.Beta.Inputs.SecurityPolicyRuleMatcherConfigResponse

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.

Expr Pulumi.GoogleNative.Compute.Beta.Inputs.ExprResponse

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.

ExprOptions Pulumi.GoogleNative.Compute.Beta.Inputs.SecurityPolicyRuleMatcherExprOptionsResponse

The configuration options available when specifying a user defined CEVAL expression (i.e., 'expr').

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 src_ip_range field in config.

Config SecurityPolicyRuleMatcherConfigResponse

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.

Expr ExprResponse

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.

ExprOptions SecurityPolicyRuleMatcherExprOptionsResponse

The configuration options available when specifying a user defined CEVAL expression (i.e., 'expr').

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 src_ip_range field in config.

config SecurityPolicyRuleMatcherConfigResponse

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.

expr ExprResponse

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.

exprOptions SecurityPolicyRuleMatcherExprOptionsResponse

The configuration options available when specifying a user defined CEVAL expression (i.e., 'expr').

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 src_ip_range field in config.

config SecurityPolicyRuleMatcherConfigResponse

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.

expr ExprResponse

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.

exprOptions SecurityPolicyRuleMatcherExprOptionsResponse

The configuration options available when specifying a user defined CEVAL expression (i.e., 'expr').

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 src_ip_range field in config.

config SecurityPolicyRuleMatcherConfigResponse

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.

expr ExprResponse

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.

expr_options SecurityPolicyRuleMatcherExprOptionsResponse

The configuration options available when specifying a user defined CEVAL expression (i.e., 'expr').

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 src_ip_range field in config.

config Property Map

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.

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. 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.

exprOptions Property Map

The configuration options available when specifying a user defined CEVAL expression (i.e., 'expr').

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 src_ip_range field in config.

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<Pulumi.GoogleNative.Compute.Beta.Inputs.SecurityPolicyRuleNetworkMatcherUserDefinedFieldMatchResponse>

User-defined fields. Each element names a defined field and lists the matching values for that field.

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 []SecurityPolicyRuleNetworkMatcherUserDefinedFieldMatchResponse

User-defined fields. Each element names a defined field and lists the matching values for that field.

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<SecurityPolicyRuleNetworkMatcherUserDefinedFieldMatchResponse>

User-defined fields. Each element names a defined field and lists the matching values for that field.

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 SecurityPolicyRuleNetworkMatcherUserDefinedFieldMatchResponse[]

User-defined fields. Each element names a defined field and lists the matching values for that field.

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[SecurityPolicyRuleNetworkMatcherUserDefinedFieldMatchResponse]

User-defined fields. Each element names a defined field and lists the matching values for that field.

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.

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").

Op string

The match operator for the field.

Val string

The value of the field.

Op string

The match operator for the field.

Val string

The value of the field.

op String

The match operator for the field.

val String

The value of the field.

op string

The match operator for the field.

val string

The value of the field.

op str

The match operator for the field.

val str

The value of the field.

op String

The match operator for the field.

val String

The value of the field.

RequestCookiesToExclude List<Pulumi.GoogleNative.Compute.Beta.Inputs.SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParamsResponse>

A list of request cookie names whose value will be excluded from inspection during preconfigured WAF evaluation.

RequestHeadersToExclude List<Pulumi.GoogleNative.Compute.Beta.Inputs.SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParamsResponse>

A list of request header names whose value will be excluded from inspection during preconfigured WAF evaluation.

RequestQueryParamsToExclude List<Pulumi.GoogleNative.Compute.Beta.Inputs.SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParamsResponse>

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.

RequestUrisToExclude List<Pulumi.GoogleNative.Compute.Beta.Inputs.SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParamsResponse>

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.

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.

RequestCookiesToExclude []SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParamsResponse

A list of request cookie names whose value will be excluded from inspection during preconfigured WAF evaluation.

RequestHeadersToExclude []SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParamsResponse

A list of request header names whose value will be excluded from inspection during preconfigured WAF evaluation.

RequestQueryParamsToExclude []SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParamsResponse

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.

RequestUrisToExclude []SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParamsResponse

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.

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.

requestCookiesToExclude List<SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParamsResponse>

A list of request cookie names whose value will be excluded from inspection during preconfigured WAF evaluation.

requestHeadersToExclude List<SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParamsResponse>

A list of request header names whose value will be excluded from inspection during preconfigured WAF evaluation.

requestQueryParamsToExclude List<SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParamsResponse>

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.

requestUrisToExclude List<SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParamsResponse>

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.

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.

requestCookiesToExclude SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParamsResponse[]

A list of request cookie names whose value will be excluded from inspection during preconfigured WAF evaluation.

requestHeadersToExclude SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParamsResponse[]

A list of request header names whose value will be excluded from inspection during preconfigured WAF evaluation.

requestQueryParamsToExclude SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParamsResponse[]

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.

requestUrisToExclude SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParamsResponse[]

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.

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.

request_cookies_to_exclude Sequence[SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParamsResponse]

A list of request cookie names whose value will be excluded from inspection during preconfigured WAF evaluation.

request_headers_to_exclude Sequence[SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParamsResponse]

A list of request header names whose value will be excluded from inspection during preconfigured WAF evaluation.

request_query_params_to_exclude Sequence[SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParamsResponse]

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.

request_uris_to_exclude Sequence[SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParamsResponse]

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.

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.

target_rule_set str

Target WAF rule set to apply the preconfigured WAF exclusion.

requestCookiesToExclude List<Property Map>

A list of request cookie names whose value will be excluded from inspection during preconfigured WAF evaluation.

requestHeadersToExclude List<Property Map>

A list of request header names whose value will be excluded from inspection during preconfigured WAF evaluation.

requestQueryParamsToExclude List<Property Map>

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.

requestUrisToExclude List<Property Map>

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.

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.

Exclusions List<Pulumi.GoogleNative.Compute.Beta.Inputs.SecurityPolicyRulePreconfiguredWafConfigExclusionResponse>

A list of exclusions to apply during preconfigured WAF evaluation.

Exclusions []SecurityPolicyRulePreconfiguredWafConfigExclusionResponse

A list of exclusions to apply during preconfigured WAF evaluation.

exclusions List<SecurityPolicyRulePreconfiguredWafConfigExclusionResponse>

A list of exclusions to apply during preconfigured WAF evaluation.

exclusions SecurityPolicyRulePreconfiguredWafConfigExclusionResponse[]

A list of exclusions to apply during preconfigured WAF evaluation.

exclusions Sequence[SecurityPolicyRulePreconfiguredWafConfigExclusionResponse]

A list of exclusions to apply during preconfigured WAF evaluation.

exclusions List<Property Map>

A list of exclusions to apply during preconfigured WAF evaluation.

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.

EnforceOnKeyType string

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.

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.

EnforceOnKeyType string

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.

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.

enforceOnKeyType String

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.

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.

enforceOnKeyType string

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.

enforce_on_key_name str

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 str

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.

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.

enforceOnKeyType String

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.

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 Pulumi.GoogleNative.Compute.Beta.Inputs.SecurityPolicyRuleRateLimitOptionsThresholdResponse

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'.

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 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.

EnforceOnKeyConfigs List<Pulumi.GoogleNative.Compute.Beta.Inputs.SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigResponse>

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.

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 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.

ExceedRedirectOptions Pulumi.GoogleNative.Compute.Beta.Inputs.SecurityPolicyRuleRedirectOptionsResponse

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.

RateLimitThreshold Pulumi.GoogleNative.Compute.Beta.Inputs.SecurityPolicyRuleRateLimitOptionsThresholdResponse

Threshold at which to begin ratelimiting.

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 SecurityPolicyRuleRateLimitOptionsThresholdResponse

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'.

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 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.

EnforceOnKeyConfigs []SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigResponse

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.

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 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.

ExceedRedirectOptions SecurityPolicyRuleRedirectOptionsResponse

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.

RateLimitThreshold SecurityPolicyRuleRateLimitOptionsThresholdResponse

Threshold at which to begin ratelimiting.

banDurationSec Integer

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 SecurityPolicyRuleRateLimitOptionsThresholdResponse

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'.

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 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.

enforceOnKeyConfigs List<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigResponse>

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.

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 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.

exceedRedirectOptions SecurityPolicyRuleRedirectOptionsResponse

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.

rateLimitThreshold SecurityPolicyRuleRateLimitOptionsThresholdResponse

Threshold at which to begin ratelimiting.

banDurationSec number

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 SecurityPolicyRuleRateLimitOptionsThresholdResponse

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'.

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 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.

enforceOnKeyConfigs SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigResponse[]

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.

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 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.

exceedRedirectOptions SecurityPolicyRuleRedirectOptionsResponse

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.

rateLimitThreshold SecurityPolicyRuleRateLimitOptionsThresholdResponse

Threshold at which to begin ratelimiting.

ban_duration_sec 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.

ban_threshold SecurityPolicyRuleRateLimitOptionsThresholdResponse

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'.

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 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.

enforce_on_key_configs Sequence[SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigResponse]

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 str

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 str

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 SecurityPolicyRuleRedirectOptionsResponse

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.

rate_limit_threshold SecurityPolicyRuleRateLimitOptionsThresholdResponse

Threshold at which to begin ratelimiting.

banDurationSec Number

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 Property Map

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'.

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 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.

enforceOnKeyConfigs List<Property Map>

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.

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 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.

exceedRedirectOptions Property Map

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.

rateLimitThreshold Property Map

Threshold at which to begin ratelimiting.

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.

Target string

Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.

Type string

Type of the redirect action.

Target string

Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.

Type string

Type of the redirect action.

target String

Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.

type String

Type of the redirect action.

target string

Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.

type string

Type of the redirect action.

target str

Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.

type str

Type of the redirect action.

target String

Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.

type String

Type of the redirect action.

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 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 string

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

Direction string

The direction in which this rule applies. This field may only be specified when versioned_expr is set to FIREWALL.

EnableLogging bool

Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. This field may only be specified when the versioned_expr is set to FIREWALL.

HeaderAction Pulumi.GoogleNative.Compute.Beta.Inputs.SecurityPolicyRuleHttpHeaderActionResponse

Optional, additional actions that are performed on headers. This field is only supported in Global Security Policies of type CLOUD_ARMOR.

Kind string

[Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules

Match Pulumi.GoogleNative.Compute.Beta.Inputs.SecurityPolicyRuleMatcherResponse

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

NetworkMatch Pulumi.GoogleNative.Compute.Beta.Inputs.SecurityPolicyRuleNetworkMatcherResponse

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.

PreconfiguredWafConfig Pulumi.GoogleNative.Compute.Beta.Inputs.SecurityPolicyRulePreconfiguredWafConfigResponse

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.

Preview bool

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

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.

RateLimitOptions Pulumi.GoogleNative.Compute.Beta.Inputs.SecurityPolicyRuleRateLimitOptionsResponse

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

RedirectOptions Pulumi.GoogleNative.Compute.Beta.Inputs.SecurityPolicyRuleRedirectOptionsResponse

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.

RuleNumber string

Identifier for the rule. This is only unique within the given security policy. This can only be set during rule creation, if rule number is not specified it will be generated by the server.

RuleTupleCount int

Calculation of the complexity of a single firewall security policy rule.

TargetResources List<string>

A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. This field may only be specified when versioned_expr is set to FIREWALL.

TargetServiceAccounts List<string>

A list of service accounts indicating the sets of instances that are applied with this rule.

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 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 string

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

Direction string

The direction in which this rule applies. This field may only be specified when versioned_expr is set to FIREWALL.

EnableLogging bool

Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. This field may only be specified when the versioned_expr is set to FIREWALL.

HeaderAction SecurityPolicyRuleHttpHeaderActionResponse

Optional, additional actions that are performed on headers. This field is only supported in Global Security Policies of type CLOUD_ARMOR.

Kind string

[Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules

Match SecurityPolicyRuleMatcherResponse

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

NetworkMatch SecurityPolicyRuleNetworkMatcherResponse

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.

PreconfiguredWafConfig SecurityPolicyRulePreconfiguredWafConfigResponse

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.

Preview bool

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

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.

RateLimitOptions SecurityPolicyRuleRateLimitOptionsResponse

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

RedirectOptions SecurityPolicyRuleRedirectOptionsResponse

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.

RuleNumber string

Identifier for the rule. This is only unique within the given security policy. This can only be set during rule creation, if rule number is not specified it will be generated by the server.

RuleTupleCount int

Calculation of the complexity of a single firewall security policy rule.

TargetResources []string

A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. This field may only be specified when versioned_expr is set to FIREWALL.

TargetServiceAccounts []string

A list of service accounts indicating the sets of instances that are applied with this rule.

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 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 String

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

direction String

The direction in which this rule applies. This field may only be specified when versioned_expr is set to FIREWALL.

enableLogging Boolean

Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. This field may only be specified when the versioned_expr is set to FIREWALL.

headerAction SecurityPolicyRuleHttpHeaderActionResponse

Optional, additional actions that are performed on headers. This field is only supported in Global Security Policies of type CLOUD_ARMOR.

kind String

[Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules

match SecurityPolicyRuleMatcherResponse

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

networkMatch SecurityPolicyRuleNetworkMatcherResponse

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.

preconfiguredWafConfig SecurityPolicyRulePreconfiguredWafConfigResponse

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.

preview Boolean

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

priority Integer

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.

rateLimitOptions SecurityPolicyRuleRateLimitOptionsResponse

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

redirectOptions SecurityPolicyRuleRedirectOptionsResponse

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.

ruleNumber String

Identifier for the rule. This is only unique within the given security policy. This can only be set during rule creation, if rule number is not specified it will be generated by the server.

ruleTupleCount Integer

Calculation of the complexity of a single firewall security policy rule.

targetResources List<String>

A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. This field may only be specified when versioned_expr is set to FIREWALL.

targetServiceAccounts List<String>

A list of service accounts indicating the sets of instances that are applied with this rule.

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 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 string

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

direction string

The direction in which this rule applies. This field may only be specified when versioned_expr is set to FIREWALL.

enableLogging boolean

Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. This field may only be specified when the versioned_expr is set to FIREWALL.

headerAction SecurityPolicyRuleHttpHeaderActionResponse

Optional, additional actions that are performed on headers. This field is only supported in Global Security Policies of type CLOUD_ARMOR.

kind string

[Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules

match SecurityPolicyRuleMatcherResponse

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

networkMatch SecurityPolicyRuleNetworkMatcherResponse

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.

preconfiguredWafConfig SecurityPolicyRulePreconfiguredWafConfigResponse

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.

preview boolean

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

priority number

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.

rateLimitOptions SecurityPolicyRuleRateLimitOptionsResponse

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

redirectOptions SecurityPolicyRuleRedirectOptionsResponse

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.

ruleNumber string

Identifier for the rule. This is only unique within the given security policy. This can only be set during rule creation, if rule number is not specified it will be generated by the server.

ruleTupleCount number

Calculation of the complexity of a single firewall security policy rule.

targetResources string[]

A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. This field may only be specified when versioned_expr is set to FIREWALL.

targetServiceAccounts string[]

A list of service accounts indicating the sets of instances that are applied with this rule.

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 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 str

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

direction str

The direction in which this rule applies. This field may only be specified when versioned_expr is set to FIREWALL.

enable_logging bool

Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. This field may only be specified when the versioned_expr is set to FIREWALL.

header_action SecurityPolicyRuleHttpHeaderActionResponse

Optional, additional actions that are performed on headers. This field is only supported in Global Security Policies of type CLOUD_ARMOR.

kind str

[Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules

match SecurityPolicyRuleMatcherResponse

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

network_match SecurityPolicyRuleNetworkMatcherResponse

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.

preconfigured_waf_config SecurityPolicyRulePreconfiguredWafConfigResponse

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.

preview bool

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

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.

rate_limit_options SecurityPolicyRuleRateLimitOptionsResponse

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

redirect_options SecurityPolicyRuleRedirectOptionsResponse

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.

rule_number str

Identifier for the rule. This is only unique within the given security policy. This can only be set during rule creation, if rule number is not specified it will be generated by the server.

rule_tuple_count int

Calculation of the complexity of a single firewall security policy rule.

target_resources Sequence[str]

A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. This field may only be specified when versioned_expr is set to FIREWALL.

target_service_accounts Sequence[str]

A list of service accounts indicating the sets of instances that are applied with this rule.

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 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 String

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

direction String

The direction in which this rule applies. This field may only be specified when versioned_expr is set to FIREWALL.

enableLogging Boolean

Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. This field may only be specified when the versioned_expr is set to FIREWALL.

headerAction Property Map

Optional, additional actions that are performed on headers. This field is only supported in Global Security Policies of type CLOUD_ARMOR.

kind String

[Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules

match Property Map

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

networkMatch Property Map

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.

preconfiguredWafConfig Property Map

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.

preview Boolean

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

priority Number

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.

rateLimitOptions Property Map

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

redirectOptions Property Map

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.

ruleNumber String

Identifier for the rule. This is only unique within the given security policy. This can only be set during rule creation, if rule number is not specified it will be generated by the server.

ruleTupleCount Number

Calculation of the complexity of a single firewall security policy rule.

targetResources List<String>

A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. This field may only be specified when versioned_expr is set to FIREWALL.

targetServiceAccounts List<String>

A list of service accounts indicating the sets of instances that are applied with this rule.

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. required

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

The name of this field. Must be unique within the policy.

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. required

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

The name of this field. Must be unique within the policy.

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. required

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

The name of this field. Must be unique within the policy.

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. required

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

The name of this field. Must be unique within the policy.

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. required

mask str

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 str

The name of this field. Must be unique within the policy.

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.