Skip to content

Commit a85c425

Browse files
committed
doc(suppression_rules): Add documentation and examples
Add suppression rule docs and examples Changelog: Added
1 parent 7337890 commit a85c425

File tree

5 files changed

+161
-0
lines changed

5 files changed

+161
-0
lines changed
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "aquasec_suppression_rules Data Source - terraform-provider-aquasec"
4+
subcategory: ""
5+
description: |-
6+
Fetches the list of suppression rules.
7+
---
8+
9+
# aquasec_suppression_rules (Data Source)
10+
11+
Fetches the list of suppression rules.
12+
13+
## Example Usage
14+
15+
```terraform
16+
# List all suppression rules.
17+
data "aquasec_suppression_rules" "suppression_rules" {}
18+
19+
output "suppression_rules" {
20+
value = { for rule in data.aquasec_suppression_rules.suppression_rules.suppression_rules : rule.id => rule.name }
21+
}
22+
```
23+
24+
<!-- schema generated by tfplugindocs -->
25+
## Schema
26+
27+
### Read-Only
28+
29+
- `suppression_rules` (Attributes List) (see [below for nested schema](#nestedatt--suppression_rules))
30+
31+
<a id="nestedatt--suppression_rules"></a>
32+
### Nested Schema for `suppression_rules`
33+
34+
Read-Only:
35+
36+
- `application_scopes` (List of String) List of application scopes for the suppression rule.
37+
- `author` (String) Author of the suppression rule.
38+
- `comment` (String) Comment for the suppression rule.
39+
- `created` (String) Creation date of the suppression rule.
40+
- `expiry` (Number) Expiry in days of the suppression rule.
41+
- `fix_available` (String) Fix available for the suppression rule.
42+
- `id` (Number) Identifier used by AquaSec to identify the suppression rule.
43+
- `name` (String) Name of the suppression rule.
44+
- `scope` (Attributes) Scope of the suppression rule. (see [below for nested schema](#nestedatt--suppression_rules--scope))
45+
- `score` (List of Number) List of scores for the suppression rule.
46+
- `severity` (String) Severity of the suppression rule.
47+
- `status` (Boolean) Status of the suppression rule.
48+
- `vulnerabilities` (String) Vulnerabilities as comma separated list for the suppression rule.
49+
50+
<a id="nestedatt--suppression_rules--scope"></a>
51+
### Nested Schema for `suppression_rules.scope`
52+
53+
Read-Only:
54+
55+
- `expression` (String) Expression of the suppression rule.
56+
- `variables` (Attributes List) Variables of the suppression rule. (see [below for nested schema](#nestedatt--suppression_rules--scope--variables))
57+
58+
<a id="nestedatt--suppression_rules--scope--variables"></a>
59+
### Nested Schema for `suppression_rules.scope.variables`
60+
61+
Read-Only:
62+
63+
- `attribute` (String) Attribute of the variable.
64+
- `name` (String) Name of the variable.
65+
- `value` (String) Value of the variable.
66+
67+

docs/resources/suppression_rule.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "aquasec_suppression_rule Resource - terraform-provider-aquasec"
4+
subcategory: ""
5+
description: |-
6+
Manages a suppression rule.
7+
---
8+
9+
# aquasec_suppression_rule (Resource)
10+
11+
Manages a suppression rule.
12+
13+
## Example Usage
14+
15+
```terraform
16+
# Manage example suppression rule
17+
resource "aquasec_suppression_rule" "example" {
18+
name = "Example Suppression Rule"
19+
application_scopes = ["Global"]
20+
score = []
21+
fix_available = false
22+
comment = "This is an example suppression rule"
23+
}
24+
```
25+
26+
<!-- schema generated by tfplugindocs -->
27+
## Schema
28+
29+
### Required
30+
31+
- `application_scopes` (List of String) List of application scopes for the suppression rule.
32+
- `comment` (String) Comment for the suppression rule.
33+
- `name` (String) Name of the suppression rule.
34+
35+
### Optional
36+
37+
- `expiry` (Number) Expiry in days of the suppression rule.
38+
- `fix_available` (String) Fix available for the suppression rule.
39+
- `scope` (Attributes) Scope of the suppression rule. (see [below for nested schema](#nestedatt--scope))
40+
- `score` (List of Number) List of scores for the suppression rule.
41+
- `severity` (String) Severity of the suppression rule.
42+
- `status` (Boolean) Activation status of the suppression rule.
43+
- `vulnerabilities` (String) Vulnerabilities for the suppression rule.
44+
45+
### Read-Only
46+
47+
- `author` (String) Author of the suppression rule.
48+
- `created` (String) Creation date of the suppression rule.
49+
- `id` (String) Numeric identifier of the suppression rule.
50+
51+
<a id="nestedatt--scope"></a>
52+
### Nested Schema for `scope`
53+
54+
Optional:
55+
56+
- `expression` (String) Expression of the suppression rule.
57+
- `variables` (Attributes List) (see [below for nested schema](#nestedatt--scope--variables))
58+
59+
<a id="nestedatt--scope--variables"></a>
60+
### Nested Schema for `scope.variables`
61+
62+
Required:
63+
64+
- `attribute` (String) Attribute of the variable.
65+
- `value` (String) Value of the variable.
66+
67+
Optional:
68+
69+
- `name` (String) Name of the variable.
70+
71+
## Import
72+
73+
Import is supported using the following syntax:
74+
75+
```shell
76+
# Suppression rule can be imported by specifying the numeric identifier.
77+
terraform import aquasec_suppression_rule.example 123
78+
```
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# List all suppression rules.
2+
data "aquasec_suppression_rules" "suppression_rules" {}
3+
4+
output "suppression_rules" {
5+
value = { for rule in data.aquasec_suppression_rules.suppression_rules.suppression_rules : rule.id => rule.name }
6+
}
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Suppression rule can be imported by specifying the numeric identifier.
2+
terraform import aquasec_suppression_rule.example 123
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Manage example suppression rule
2+
resource "aquasec_suppression_rule" "example" {
3+
name = "Example Suppression Rule"
4+
application_scopes = ["Global"]
5+
score = []
6+
fix_available = false
7+
comment = "This is an example suppression rule"
8+
}

0 commit comments

Comments
 (0)