From 800613bfc4336f959fc42685e2dfc9c84ef728e8 Mon Sep 17 00:00:00 2001 From: Anton Eremin Date: Thu, 24 Aug 2023 18:00:21 +0500 Subject: [PATCH] docs improvment --- examples/complete_exapmle/main.tf | 8 +++----- modules/eventbridge/README.MD | 2 +- modules/iam/README.MD | 3 ++- modules/reservations/README.MD | 2 +- modules/savings_plans/README.MD | 2 +- 5 files changed, 8 insertions(+), 9 deletions(-) diff --git a/examples/complete_exapmle/main.tf b/examples/complete_exapmle/main.tf index 33da1f5..f3e932b 100644 --- a/examples/complete_exapmle/main.tf +++ b/examples/complete_exapmle/main.tf @@ -5,14 +5,13 @@ locals { "prod-alerts" = "PPOIUYTREWQ" } } - # Both SNS topic ARN and email addresses can be used as subscribers, but at least one of them is required budget_subscriber_email_addresses = [ "prod_alerts@gmail.com", ] prod_sns_topic_arn = [aws_sns_topic.prod_chatbot.arn] } -# Optional Automatic creation Chatbot IAM role +# Creation of IAM resources for Chatbot module "chatbot_role" { source = "./modules/iam" } @@ -24,7 +23,6 @@ module "chatbot_slack_workspace" { workspace_id = local.slack.workspace_id - # Here can be placed default_iam_role_arn for Chatbot instead of automatic creation default_iam_role_arn = module.chatbot_role.iam_role_arn # Mapping of topics to channels @@ -68,10 +66,10 @@ module "budget_alerts" { module "eventbridge_alerts" { source = "./modules/eventbridge" - # create_guardduty_findings_rule will create eventbridge rule and send all GuardDuty findings to Slack + # It will create eventbridge rule and send all GuardDuty findings to Slack create_guardduty_findings_rule = true - # create_aws_health_rule will create eventbridge rule and send all AWS Health events to Slack + # Same for AWS Health events create_aws_health_rule = true sns_topic_arn = local.prod_sns_topic_arn[0] diff --git a/modules/eventbridge/README.MD b/modules/eventbridge/README.MD index 29c747b..0c647e4 100644 --- a/modules/eventbridge/README.MD +++ b/modules/eventbridge/README.MD @@ -1,5 +1,5 @@ # Event brige alerts: -GuardDuty and AWS health events, both are can be disabled. +GuardDuty and AWS health events. diff --git a/modules/iam/README.MD b/modules/iam/README.MD index eded97f..617b7c1 100644 --- a/modules/iam/README.MD +++ b/modules/iam/README.MD @@ -1,4 +1,5 @@ -# Optional automated Iam for Chatbot +# Iam for Chatbot +Automated creation of IAM resources for AWS Chatbot. diff --git a/modules/reservations/README.MD b/modules/reservations/README.MD index 00e2aa7..c46a7f4 100644 --- a/modules/reservations/README.MD +++ b/modules/reservations/README.MD @@ -1,6 +1,6 @@ # Reservations utilization alert -Like in budget alerts, required only 2 values: +Required only 2 values: - `threshold` - percentage of utilization - `subscriber_sns_topic_arns` - sns topic for chatbot diff --git a/modules/savings_plans/README.MD b/modules/savings_plans/README.MD index 5bcd065..a0a1e68 100644 --- a/modules/savings_plans/README.MD +++ b/modules/savings_plans/README.MD @@ -1,6 +1,6 @@ # Savings plans utilization alert -Like in budget alerts, required only 2 values: +Required only 2 values: - `threshold` - percentage of utilization - `subscriber_sns_topic_arns` - sns topic for chatbot