GetRegionSecurityPolicyRule class
Constructors
-
GetRegionSecurityPolicyRule({required Input<String> action, required Input<String> description, required Input<List<GetRegionSecurityPolicyRuleMatch>> matches, required Input<List<GetRegionSecurityPolicyRuleNetworkMatch>> networkMatches, required Input<List<GetRegionSecurityPolicyRulePreconfiguredWafConfig>> preconfiguredWafConfigs, required Input<bool> preview, required Input<int> priority, required Input<List<GetRegionSecurityPolicyRuleRateLimitOption>> rateLimitOptions})
-
Creates a new GetRegionSecurityPolicyRule.
action The Action to perform when the rule is matched. The following are the valid actions:
description An optional description of this resource. Provide this property when you create the resource.
matches A match condition that incoming traffic is evaluated against.
networkMatches A match condition that incoming packets are evaluated against for CLOUD_ARMOR_NETWORK security policies. If it matches, the corresponding 'action' is enforced.
preconfiguredWafConfigs Preconfigured WAF configuration to be applied for the rule.
preview If set to true, the specified action is not enforced.
priority An integer indicating the priority of a rule in the list.
rateLimitOptions Must be specified if the action is "rateBasedBan" or "throttle". Cannot be specified for any other actions.
const
-
GetRegionSecurityPolicyRule.fromMap(Map<String, dynamic> map)
-
factory
Properties
-
action
→ Input<String>
-
The Action to perform when the rule is matched. The following are the valid actions:
final
-
description
→ Input<String>
-
An optional description of this resource. Provide this property when you create the resource.
final
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
matches
→ Input<List<GetRegionSecurityPolicyRuleMatch>>
-
A match condition that incoming traffic is evaluated against.
If it evaluates to true, the corresponding 'action' is enforced.
final
-
networkMatches
→ Input<List<GetRegionSecurityPolicyRuleNetworkMatch>>
-
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: "ipv4FragmentOffset" 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 "ipv4FragmentOffset" with a value between 1 and 0x1fff inclusive
final
-
preconfiguredWafConfigs
→ Input<List<GetRegionSecurityPolicyRulePreconfiguredWafConfig>>
-
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.
final
-
preview
→ Input<bool>
-
If set to true, the specified action is not enforced.
final
-
priority
→ Input<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.
final
-
rateLimitOptions
→ Input<List<GetRegionSecurityPolicyRuleRateLimitOption>>
-
Must be specified if the action is "rateBasedBan" or "throttle". Cannot be specified for any other actions.
final
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
