generated from clouddrove/terraform-module-template
-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.yaml
149 lines (133 loc) · 5.05 KB
/
README.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#
# Name of this project
name: Terraform AWS cost billing alarm
# License of this project
license: "APACHE"
# Canonical GitHub repo
github_repo: clouddrove/terraform-aws-cost-billing-alarm
# Badges to display
badges:
- name: "Latest Release"
image: "https://img.shields.io/github/release/clouddrove/terraform-aws-cost-billing-alarm.svg"
url: "https://github.com/clouddrove/terraform-aws-cost-billing-alarm/releases/latest"
- name: "tfsec"
image: "https://github.com/clouddrove/terraform-aws-cost-billing-alarm/actions/workflows/tfsec.yml/badge.svg"
url: "https://github.com/clouddrove/terraform-aws-cost-billing-alarm/actions/workflows/tfsec.yml"
- name: "Licence"
image: "https://img.shields.io/badge/License-APACHE-blue.svg"
url: "LICENSE.md"
- name: "Changelog"
image: "https://img.shields.io/badge/Changelog-blue"
url: "CHANGELOG.md"
prerequesties:
- name: Terraform
url: https://learn.hashicorp.com/terraform/getting-started/install.html
version: ">= 1.6.2"
providers:
- name: aws
url: https://aws.amazon.com/
version: ">= 5.22.0"
module_dependencies:
- name: Labels Module
url: https://github.com/clouddrove/terraform-aws-labels
description: Provides resource tagging.
# description of this project
# yamllint disable rule:line-length
description: |-
Terraform module to create aws cost billing alarm resource on AWS with sns topic.
# How to use this project
# yamllint disable rule:line-length
usage: |-
Here is examples of how you can use this module in your inventory structure:
### cloudwatch-billing-alert-to-new-sns-consolidated-acct
```hcl
module "billing_cloudwatch_alert" {
source = "clouddrove/terraform-aws-cost-billing-alarm/aws"
name = "billing/aws"
environment = "test"
monthly_billing_threshold = 10
currency = "USD"
subscribers = {
sms = {
protocol = "email"
endpoint = "xxxxxxx@clouddrove.com"
endpoint_auto_confirms = false
raw_message_delivery = false
filter_policy = ""
delivery_policy = ""
confirmation_timeout_in_minutes = "60"
}
}
}
```
### cloudwatch-billing-alert-to-new-sns-with-acct-id
```hcl
module "billing_cloudwatch_alert" {
source = "clouddrove/terraform-aws-cost-billing-alarm/aws"
name = "billing/aws"
environment = "test"
aws_account_id = 11111111111
monthly_billing_threshold = 100
currency = "USD"
subscribers = {
sms = {
protocol = "email"
endpoint = "xxxxxxxxclouddrove.com"
endpoint_auto_confirms = false
raw_message_delivery = false
filter_policy = ""
delivery_policy = ""
confirmation_timeout_in_minutes = "60"
}
}
}
```
### cloudwatch-billing-alert-to-pre-existing-sns-consolidated-acct
```hcl
module "billing_cloudwatch_alert" {
source = "clouddrove/terraform-aws-cost-billing-alarm/aws"
name = "billing/aws"
environment = "test"
monthly_billing_threshold = 500
currency = "USD"
#sns_topic_arns = ["arn:aws:lambda:us-east-1:111111111111:function:bb-root-org-notify_slack"]
subscribers = {
sms = {
protocol = "email"
endpoint = "xxxxxclouddrove.com"
endpoint_auto_confirms = false
raw_message_delivery = false
filter_policy = ""
delivery_policy = ""
confirmation_timeout_in_minutes = "60"
}
}
}
```
### cloudwatch-billing-alert-to-pre-existing-sns-with-acct-id
```hcl
module "billing_cloudwatch_alert" {
source = "clouddrove/terraform-aws-cost-billing-alarm/aws"
name = "billing/aws"
environment = "test"
aws_account_id = 111111111111
monthly_billing_threshold = 500
currency = "USD"
#sns_topic_arns = ["arn:aws:lambda:us-east-1:111111111111:function:bb-root-org-notify_slack"]
subscribers = {
sms = {
protocol = "email"
endpoint = "clouddrove.com"
endpoint_auto_confirms = false
raw_message_delivery = false
filter_policy = ""
delivery_policy = ""
confirmation_timeout_in_minutes = "60"
}
}
}
```