Skip to content

Commit

Permalink
docs: add small readme's to every submodule
Browse files Browse the repository at this point in the history
  • Loading branch information
EreminAnton committed Jan 22, 2024
1 parent 744be50 commit 43763a5
Show file tree
Hide file tree
Showing 7 changed files with 13 additions and 3 deletions.
2 changes: 2 additions & 0 deletions modules/budget_alerts/README.MD
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Standartized and simplified budget alert

This module allows you to create a budget alert with a single line of code. It also allows you to specify the percentage of the budget threshold to notify. With default values, notifications will be sent at 100%, 150%, and 200% of the budget `limit_amount`.

<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Requirements

Expand Down
1 change: 1 addition & 0 deletions modules/cost_anomaly_detection/README.MD
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Cost anomaly detection alert

This module creates a cost anomaly detection alert with default values. You need to specify the `threshold` value, which is the dollar value that triggers a notification if the threshold is exceeded.

<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Requirements
Expand Down
2 changes: 2 additions & 0 deletions modules/eventbridge/README.MD
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Event brige alerts:
GuardDuty and AWS health events.

This alert creates two CloudWatch event rules that send notifications to an SNS topic when GuardDuty or AWS Health events are triggered.


<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Requirements
Expand Down
2 changes: 1 addition & 1 deletion modules/iam/README.MD
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Iam for Chatbot
Automated creation of IAM resources for AWS Chatbot.

Automated creation of IAM resources for AWS Chatbot.

<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Requirements
Expand Down
4 changes: 3 additions & 1 deletion modules/reservations/README.MD
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Reservations utilization alert

This module creates a budget alert for Reserved Instance utilization. It will send notifications when utilization falls below a specified threshold.

Required only 2 values:
- `threshold` - percentage of utilization
- `subscriber_sns_topic_arns` - sns topic for chatbot
- `subscriber_sns_topic_arns` or `subscriber_email_addresses`


<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
Expand Down
4 changes: 3 additions & 1 deletion modules/savings_plans/README.MD
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Savings plans utilization alert

This module creates a budget alert for Savings Plans utilization. It will send notifications when utilization falls below a specified threshold.

Required only 2 values:
- `threshold` - percentage of utilization
- `subscriber_sns_topic_arns` - sns topic for chatbot
- `subscriber_sns_topic_arns` or `subscriber_email_addresses`


<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
Expand Down
1 change: 1 addition & 0 deletions modules/slack_workspace/README.MD
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Slack workspace configuration

This module gives you a better way to configure your Slack workspace with AWS Chatbot. It allows you to configure multiple channels and SNS topics, as well as IAM roles and logging levels.

<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Requirements
Expand Down

0 comments on commit 43763a5

Please sign in to comment.