* update tfdoc * rewrite check docs, refactor tfdoc replace, regenerate modules READMEs * remove dead code from check docs * do not fail on missing variable files in check docs * fix typos |
||
---|---|---|
.. | ||
README.md | ||
main.tf | ||
outputs.tf | ||
variables.tf | ||
versions.tf |
README.md
Google Cloud Billing Budget Module
This module allows creating a Cloud Billing budget for a set of services and projects.
To create billing budgets you need one of the following IAM roles on the target billing account:
- Billing Account Administrator
- Billing Account Costs Manager
Examples
Simple email notification
Send a notification to an email when a set of projects reach $100 of spend.
module "budget" {
source = "./modules/billing-budget"
billing_account = var.billing_account_id
name = "$100 budget"
amount = 100
thresholds = {
current = [0.5, 0.75, 1.0]
forecasted = [1.0]
}
projects = [
"projects/123456789000",
"projects/123456789111"
]
email_recipients = {
project_id = "my-project"
emails = ["user@example.com"]
}
}
# tftest:modules=1:resources=2
Pubsub notification
Send a notification to a PubSub topic the total spend of a billing account reaches the previous month's spend.
module "budget" {
source = "./modules/billing-budget"
billing_account = var.billing_account_id
name = "previous period budget"
amount = 0
thresholds = {
current = [1.0]
forecasted = []
}
pubsub_topic = module.pubsub.id
}
module "pubsub" {
source = "./modules/pubsub"
project_id = var.project_id
name = "budget-topic"
}
# tftest:modules=2:resources=2
Variables
name | description | type | required | default |
---|---|---|---|---|
billing_account | Billing account id. | string |
✓ | |
name | Budget name. | string |
✓ | |
thresholds | Thresholds percentages at which alerts are sent. Must be a value between 0 and 1. | object({…}) |
✓ | |
amount | Amount in the billing account's currency for the budget. Use 0 to set budget to 100% of last period's spend. | number |
0 |
|
credit_treatment | How credits should be treated when determining spend for threshold calculations. Only INCLUDE_ALL_CREDITS or EXCLUDE_ALL_CREDITS are supported | string |
"INCLUDE_ALL_CREDITS" |
|
email_recipients | Emails where budget notifications will be sent. Setting this will create a notification channel for each email in the specified project. | object({…}) |
null |
|
notification_channels | Monitoring notification channels where to send updates. | list(string) |
null |
|
notify_default_recipients | Notify Billing Account Administrators and Billing Account Users IAM roles for the target account. | bool |
false |
|
projects | List of projects of the form projects/{project_number}, specifying that usage from only this set of projects should be included in the budget. Set to null to include all projects linked to the billing account. | list(string) |
null |
|
pubsub_topic | The ID of the Cloud Pub/Sub topic where budget related messages will be published. | string |
null |
|
services | List of services of the form services/{service_id}, specifying that usage from only this set of services should be included in the budget. Set to null to include usage for all services. | list(string) |
null |
Outputs
name | description | sensitive |
---|---|---|
budget | Budget resource. | |
id | Budget ID. |