RegionSecurityPolicyRuleArgs class
The set of arguments for RegionSecurityPolicyRule. The set of arguments for RegionSecurityPolicyRule.
Constructors
-
RegionSecurityPolicyRuleArgs({required Input<
String> action, Input<String?> ? deletionPolicy, Input<String?> ? description, Input<RegionSecurityPolicyRuleMatch?> ? match, Input<RegionSecurityPolicyRuleNetworkMatch?> ? networkMatch, Input<RegionSecurityPolicyRulePreconfiguredWafConfig?> ? preconfiguredWafConfig, Input<bool?> ? preview, required Input<int> priority, Input<String?> ? project, Input<RegionSecurityPolicyRuleRateLimitOptions?> ? rateLimitOptions, required Input<String> region, required Input<String> securityPolicy}) -
Creates a new RegionSecurityPolicyRuleArgs.
actionThe Action to perform when the rule is matched. The following are the valid actions:deletionPolicyWhether Terraform will be prevented from destroying the resource. Defaults to DELETE.descriptionAn optional description of this resource. Provide this property when you create the resource.matchA match condition that incoming traffic is evaluated against.networkMatchA match condition that incoming packets are evaluated against for CLOUD_ARMOR_NETWORK security policies. If it matches, the corresponding 'action' is enforced.preconfiguredWafConfigPreconfigured WAF configuration to be applied for the rule.previewIf set to true, the specified action is not enforced.priorityAn integer indicating the priority of a rule in the list.projectThe ID of the project in which the resource belongs.rateLimitOptionsMust be specified if the action is "rateBasedBan" or "throttle". Cannot be specified for any other actions.regionThe Region in which the created Region Security Policy rule should reside.securityPolicyThe name of the security policy this rule belongs to.const -
RegionSecurityPolicyRuleArgs.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
-
deletionPolicy
→ Input<
String?> ? -
Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
When a 'terraform destroy' or 'pulumi up' would delete the resource,
the command will fail if this field is set to "PREVENT" in Terraform state.
When set to "ABANDON", the command will remove the resource from Terraform
management without updating or deleting the resource in the API.
When set to "DELETE", deleting the resource is allowed.
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
-
match
→ Input<
RegionSecurityPolicyRuleMatch?> ? -
A match condition that incoming traffic is evaluated against.
If it evaluates to true, the corresponding 'action' is enforced.
Structure is documented below.
final
-
networkMatch
→ Input<
RegionSecurityPolicyRuleNetworkMatch?> ? -
A match condition that incoming packets are evaluated against for CLOUD_ARMOR_NETWORK security policies. If it matches, the corresponding 'action' is enforced.
The match criteria for a rule consists of built-in match fields (like 'srcIpRanges') and potentially multiple user-defined match fields ('userDefinedFields').
Field values may be extracted directly from the packet or derived from it (e.g. 'srcRegionCodes'). Some fields may not be present in every packet (e.g. 'srcPorts'). A user-defined field is only present if the base header is found in the packet and the entire field is in bounds.
Each match field may specify which values can match it, listing one or more ranges, prefixes, or exact values that are considered a match for the field. A field value must be present in order to match a specified match field. If no match values are specified for a match field, then any field value is considered to match it, and it's not required to be present. For strings specifying '*' is also equivalent to match all.
For a packet to match a rule, all specified match fields must match the corresponding field values derived from the packet.
Example:
networkMatch: srcIpRanges: - "192.0.2.0/24" - "198.51.100.0/24" userDefinedFields: - name: "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
Structure is documented below.
final
-
preconfiguredWafConfig
→ Input<
RegionSecurityPolicyRulePreconfiguredWafConfig?> ? -
Preconfigured WAF configuration to be applied for the rule.
If the rule does not evaluate preconfigured WAF rules, i.e., if evaluatePreconfiguredWaf() is not used, this field will have no effect.
Structure is documented below.
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
-
project
→ Input<
String?> ? -
The ID of the project in which the resource belongs.
If it is not provided, the provider project is used.
final
-
rateLimitOptions
→ Input<
RegionSecurityPolicyRuleRateLimitOptions?> ? -
Must be specified if the action is "rateBasedBan" or "throttle". Cannot be specified for any other actions.
Structure is documented below.
final
-
region
→ Input<
String> -
The Region in which the created Region Security Policy rule should reside.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
securityPolicy
→ Input<
String> -
The name of the security policy this rule belongs to.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited