Skip to content

Commit

Permalink
Add example to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
max-rocket-internet committed Aug 11, 2023
1 parent 37d66ec commit db794cc
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,26 @@ The modules in this repo will create CloudWatch alarms for all available, critic
- [modules/usage_alarms](modules/usage_alarms): Creates alarms in the `AWS/Usage` namespace. This module needs to be defined for each region that is to be monitored.
- [modules/dashboard](modules/dashboard): Creates a CloudWatch dashboard for all service quotas. This module should only be defined once in the `us-east-1` region.

## Example

See [example](example) for a full example implimentation of both modules, multiple regions and multiple terraform AWS providers.

```hcl
module "dashboard" {
source = "git::https://github.com/deliveryhero/terraform-aws-service-quota-alarms.git//modules/dashboard?ref=1.4"
regions = ["us-east-1"]
}
module "trusted_advisor_alarms" {
source = "git::https://github.com/deliveryhero/terraform-aws-service-quota-alarms.git//modules/trusted_advisor_alarms?ref=1.4"
regions = ["us-east-1"]
}
module "usage_alarms" {
source = "git::https://github.com/deliveryhero/terraform-aws-service-quota-alarms.git//modules/usage_alarms?ref=1.4"
}
```

## Details

AWS service quotas can be monitored in 2 different CloudWatch namespaces:
Expand Down

0 comments on commit db794cc

Please sign in to comment.