Skip to content

Commit 61ef790

Browse files
docs: improve alert_thresholds_yaml description with typing hints
1 parent 6d62a24 commit 61ef790

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

modules/gcp/budget-alert/buildingblock/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ No modules.
3535

3636
| Name | Description | Type | Default | Required |
3737
|------|-------------|------|---------|:--------:|
38-
| <a name="input_alert_thresholds_yaml"></a> [alert\_thresholds\_yaml](#input\_alert\_thresholds\_yaml) | YAML string defining alert thresholds with fields threshold\_percent and spend\_basis | `string` | `"- percent: 80\n basis: ACTUAL\n- percent: 100\n basis: FORECASTED\n"` | no |
38+
| <a name="input_alert_thresholds_yaml"></a> [alert\_thresholds\_yaml](#input\_alert\_thresholds\_yaml) | YAML string defining alert thresholds as a list of objects having fields 'percent' and 'basis' | `string` | `"- percent: 80\n basis: ACTUAL\n- percent: 100\n basis: FORECASTED\n"` | no |
3939
| <a name="input_backplane_project_id"></a> [backplane\_project\_id](#input\_backplane\_project\_id) | The project ID where the backplane resources will be created | `string` | n/a | yes |
4040
| <a name="input_billing_account_id"></a> [billing\_account\_id](#input\_billing\_account\_id) | The ID of the billing account to which the budget will be applied | `string` | n/a | yes |
4141
| <a name="input_budget_currency"></a> [budget\_currency](#input\_budget\_currency) | The currency for the budget amount, e.g., EUR | `string` | `"EUR"` | no |

modules/gcp/budget-alert/buildingblock/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ variable "contact_email" {
3535
}
3636

3737
variable "alert_thresholds_yaml" {
38-
description = "YAML string defining alert thresholds with fields threshold_percent and spend_basis"
38+
description = "YAML string defining alert thresholds as a list of objects having fields 'percent' and 'basis'"
3939
type = string
4040
default = <<EOT
4141
- percent: 80

0 commit comments

Comments
 (0)