From 52140edf6ca81c39a5ec39c3b4b22f38eba4d49d Mon Sep 17 00:00:00 2001 From: Wes Murray <114347469+wescmx@users.noreply.github.com> Date: Wed, 30 Oct 2024 09:15:05 +0200 Subject: [PATCH] Update README.md --- README.md | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5f6d081..26a0938 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,15 @@ -# aws-monitoring-sg +

+ Terraform Trailwatch Modules +

+ +

Security Group

+ +

+ Releases + License +

+ +## About This Terraform module creates CloudWatch Log Metric Filters and associated Alarms for monitoring Security Groups (SGs) based on specified event names. It helps ensure that critical changes to SGs are monitored effectively and alerts are sent to a pre-existing SNS topic. ## Features @@ -27,8 +38,8 @@ This Terraform module creates CloudWatch Log Metric Filters and associated Alarm ## Simple Example ```hcl -module "aws_monitoring_sg" { - source = "path/to/module" +module "terraform_trailwatch_sg" { + source = "terraform-trailwatch-modules/security-groups/trailwatch" sg_ids = ["sg-12345678", "sg-87654321"] cw_log_group_name = "the-cloudtrail-log-group" cw_metric_filter_alarm_actions = ["arn:aws:sns:region:account-id:sns-topic"] @@ -37,8 +48,8 @@ module "aws_monitoring_sg" { ## Advanced Example ```hcl -module "aws_monitoring_sg" { - source = "path/to/module" +module "terraform_trailwatch_sg" { + source = "terraform-trailwatch-modules/security-groups/trailwatch" sg_ids = ["sg-12345678", "sg-87654321"] sg_event_names = ["DeleteSecurityGroup", "AuthorizeSecurityGroupIngress"] cw_log_group_name = "the-cloudtrail-log-group"