Skip to content

Commit 2084129

Browse files
chore: update readme vars and types
1 parent 8f722d3 commit 2084129

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ module "remediation" {
3232
aws_region = "us-east-1"
3333
account_id = "2123232323"
3434
lambda_log_group = "/aws/lambda/vulne-soldier-compliance-remediate"
35+
lambda_zip = "lambda.zip"
3536
remediation_options = {
3637
region = "us-east-1"
3738
reboot_option = "NoReboot"
@@ -56,13 +57,14 @@ provider "aws" {
5657
| `aws_region` | AWS region where the resources will be created | `string` | n/a | yes |
5758
| `account_id` | AWS account ID | `string` | n/a | yes |
5859
| `lambda_log_group` | Name of the CloudWatch Log Group for the Lambda function | `string` | n/a | yes |
60+
| `lambda_zip` | File location of the lambda zip file for remediation | `string` | `lambda.zip` | yes |
5961
| `remediation_options` | Options for the remediation document | `object` | n/a | yes |
6062
| `remediation_options.region` | The region to use | `string` | `us-east-1` | no |
6163
| `remediation_options.reboot_option` | Reboot option for patching | `string` | `NoReboot` | no |
6264
| `remediation_options.target_ec2_tag_name`| The tag name to filter EC2 instances | `string` | `AmazonECSManaged` | no |
6365
| `remediation_options.target_ec2_tag_value`| The tag value to filter EC2 instances | `string` | `true` | no |
64-
| `remediation_options.vulnerability_severities`| List of vulnerability severities to filter findings | `list(string)`| `["CRITICAL, HIGH"]` | no |
65-
| `remediation_options.override_findings_for_target_instances_ids`| List of instance IDs to override findings for target instances | `list(string)`| `[]` | no |
66+
| `remediation_options.vulnerability_severities`| Comma separated list of vulnerability severities to filter findings | `string`| `"CRITICAL, HIGH"` | no |
67+
| `remediation_options.override_findings_for_target_instances_ids`| Comma separated list of instance IDs to override findings for target instances | `string`| `""` | no |
6668

6769
## Outputs
6870

examples/basic/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ module "remediation" {
1919
aws_region = "us-east-1"
2020
account_id = "2324334432"
2121
lambda_log_group = "/aws/lambda/vulne-soldier-compliance-remediate"
22+
lambda_zip = "lambda.zip"
2223
remediation_options = {
2324
region = "us-east-1"
2425
reboot_option = "NoReboot"
@@ -43,13 +44,14 @@ provider "aws" {
4344
| `aws_region` | AWS region where the resources will be created | `string` | n/a | yes |
4445
| `account_id` | AWS account ID | `string` | n/a | yes |
4546
| `lambda_log_group` | Name of the CloudWatch Log Group for the Lambda function | `string` | n/a | yes |
47+
| `lambda_zip` | File location of the lambda zip file for remediation | `string` | `lambda.zip` | yes |
4648
| `remediation_options` | Options for the remediation document | `object` | n/a | yes |
4749
| `remediation_options.region` | The region to use | `string` | `us-east-1` | no |
4850
| `remediation_options.reboot_option` | Reboot option for patching | `string` | `NoReboot` | no |
4951
| `remediation_options.target_ec2_tag_name`| The tag name to filter EC2 instances | `string` | `AmazonECSManaged` | no |
5052
| `remediation_options.target_ec2_tag_value`| The tag value to filter EC2 instances | `string` | `true` | no |
51-
| `remediation_options.vulnerability_severities`| List of vulnerability severities to filter findings | `list(string)`| `["CRITICAL, HIGH"]` | no |
52-
| `remediation_options.override_findings_for_target_instances_ids`| List of instance IDs to override findings for target instances | `list(string)`| `[]` | no |
53+
| `remediation_options.vulnerability_severities`| Comma separated list of vulnerability severities to filter findings | `string`| `"CRITICAL, HIGH"` | no |
54+
| `remediation_options.override_findings_for_target_instances_ids`| Comma separated list of instance IDs to override findings for target instances | `string`| `""` | no |
5355

5456
### Outputs
5557

0 commit comments

Comments
 (0)