Skip to content

Commit b009247

Browse files
chore: update readme
1 parent b08fb64 commit b009247

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ This module provisions:
2828

2929
To apply the terraform module, the compiled lambdas (.zip files) need to be available locally. They can either be downloaded from the GitHub release page or built locally.
3030

31-
The lambdas can be downloaded manually from the [release page](https://github.com/iKnowJavaScript/terraform-aws-vulne-soldier/releases) or by building the Lambda folder using Node.
31+
> **Info**
32+
33+
> The lambdas can be downloaded from the [release page](https://github.com/iKnowJavaScript/terraform-aws-vulne-soldier/releases) or by building the Lambda folder using Node.
3234
3335
For local development you can build the lambdas at once using `/lambda` or individually using `npm zip`.
3436

@@ -49,8 +51,10 @@ module "remediation" {
4951
remediation_options = {
5052
region = "us-east-1"
5153
reboot_option = "NoReboot"
54+
# You need to specify the tag name and value of the EC2 instances you want to remediate
5255
target_ec2_tag_name = "AmazonECSManaged"
5356
target_ec2_tag_value = "true"
57+
# You can specify the vulnerability severities to filter findings: default is CRITICAL and HIGH vulnerabilities
5458
vulnerability_severities = ["CRITICAL, HIGH"]
5559
override_findings_for_target_instances_ids = []
5660
}

main.tf

+1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ provider "aws" {
55
locals {
66
function_name = "${var.name}-${var.environment}"
77
ssm_document_name = "${var.name}-inspector-findings-${var.environment}"
8+
# You can specify the vulnerability severities to filter findings: default is CRITICAL and HIGH vulnerabilities
89
lambda_zip = var.lambda_zip
910
}
1011

0 commit comments

Comments
 (0)