From 42d3178c40cea47a9fc359e0edc4620153fbb446 Mon Sep 17 00:00:00 2001
From: Taylor <28880387+tsmithv11@users.noreply.github.com>
Date: Fri, 27 Sep 2024 10:27:27 -0700
Subject: [PATCH] fix(general): Fix operator docs (#6735)
Fix operator docs
---
docs/3.Custom Policies/YAML Custom Policies.md | 17 ++++++++---------
1 file changed, 8 insertions(+), 9 deletions(-)
diff --git a/docs/3.Custom Policies/YAML Custom Policies.md b/docs/3.Custom Policies/YAML Custom Policies.md
index a9f09d5817f..1a67c670f56 100644
--- a/docs/3.Custom Policies/YAML Custom Policies.md
+++ b/docs/3.Custom Policies/YAML Custom Policies.md
@@ -108,15 +108,14 @@ definition:
| `exists` | The attribute or connection appears in the
resource definition | None | attribute: "name"
operator: exists |
| `not_exists` | The attribute or connection does not
appear in the resource | None | attribute: "name"
operator: not_exists |
| `one_exists` | At least one connection of a specific type
exists | None | resource_types:
- aws_vpc
connected_resource_types:
- aws_flow_log
operator: one_exists
attribute: networking
cond_type: connection |
-| `any` | Any of a list of attribute values match what
the resource contains | (List) Strings | operator: "any"
value:
-"value1" |
-| `contains` | The values of a resource attribute includes
all of these values | (List) Strings | operator: "contains"
value:
-"value1" |
-| `not_contains` | The values of a resource attribute includes
all of these values | (List) Strings | operator: "not_contains"
value:
-"value1" |
-| `within` | Used with filter to focus the findings on a
specific resource type or with attribute to
provide a list of possible options | String | cond_type: filter
attribute: resource_type
value:
- google_logging_organization_sink
operator: within |
-| `not_within` | Specify a list of unacceptable resource
and value options | (List) Strings | cond_type: attribute
attribute: 'subjects.*.kind'
operator: not_within
value:
- 'Node'
resource_types:
- ClusterRoleBinding |
-| `starting_with` | The value must begin with a string | String | operator: starting_with
value: terraform-aws-modules |
-| `not_starting_with` | The value must not begin with a string | String | operator: not_starting_with
value: terraform-aws-modules |
-| `ending_with` | The value used by the attribute must end
with this string | String | operator: not_ending_with
value: "-good" |
-| `not_ending_with` | The value used by the attribute must not
end with this string | String | operator: ending_with
value: "-bad" |
+| `contains` | Checks if an attribute's value contains
the specified values, supporting nested structures | String | operator: "contains"
value:
-"value1" |
+| `not_contains` | Checks if an attribute's value does not contain
the specified values, supporting nested structures | String | operator: "not_contains"
value:
-"value1" |
+| `within` | Checks if the attribute is within a given list of values | (List) String | operator: within
- value1
- value2 |
+| `not_within` | Checks if the attribute is not within a given list of values | (List) Strings | operator: not_within
value:
- 'value1'
- 'value2' |
+| `starting_with` | The attribute must begin with the value | String | operator: starting_with
value: terraform-aws-modules |
+| `not_starting_with` | The attribute must not begin with the value | String | operator: not_starting_with
value: terraform-aws-modules |
+| `ending_with` | The value used by the attribute must end
with this string | String | operator: ending_with
value: "-good" |
+| `not_ending_with` | The value used by the attribute must not
end with this string | String | operator: not_ending_with
value: "-bad" |
| `greater_than` | The value used by the attribute must be
greater than this value | String, Int | operator: greater_than
value: "100" |
| `greater_than_or_equal` | The value used by the attribute must be
greater than or equal to this value | String, Int | operator: less_than_or_equal
value: "100" |
| `less_than` | The value used by the attribute must be
less than this value | String, Int | operator: less_than
value: "100" |