Update google_billing_budget resource to add notifications (#3817) (#2366)

Signed-off-by: Modular Magician <[email protected]>

Author: modular-magician

.changelog/3817.txt

@@ -0,0 +1,3 @@
+```release-note:enhancement
+billing_budget: Added support for `monitoring_notification_channels` to allow sending budget notifications to Cloud Monitoring email notification channels.
+```

google-beta/resource_billing_budget.go

@@ -128,13 +128,26 @@ using threshold rules.`,
 				MaxItems: 1,
 				Elem: &schema.Resource{
 					Schema: map[string]*schema.Schema{
+						"monitoring_notification_channels": {
+							Type:     schema.TypeList,
+							Optional: true,
+							Description: `The full resource name of a monitoring notification
+channel in the form
+projects/{project_id}/notificationChannels/{channel_id}.
+A maximum of 5 channels are allowed.`,
+							Elem: &schema.Schema{
+								Type: schema.TypeString,
+							},
+							AtLeastOneOf: []string{"all_updates_rule.0.pubsub_topic", "all_updates_rule.0.monitoring_notification_channels"},
+						},
 						"pubsub_topic": {
 							Type:     schema.TypeString,
-							Required: true,
+							Optional: true,
 							Description: `The name of the Cloud Pub/Sub topic where budget related
 messages will be published, in the form
 projects/{project_id}/topics/{topic_id}. Updates are sent
 at regular intervals to the topic.`,
+							AtLeastOneOf: []string{"all_updates_rule.0.pubsub_topic", "all_updates_rule.0.monitoring_notification_channels"},
 						},
 						"schema_version": {
 							Type:     schema.TypeString,
@@ -509,6 +522,8 @@ func flattenBillingBudgetBudgetAllUpdatesRule(v interface{}, d *schema.ResourceD
 		flattenBillingBudgetBudgetAllUpdatesRulePubsubTopic(original["pubsubTopic"], d, config)
 	transformed["schema_version"] =
 		flattenBillingBudgetBudgetAllUpdatesRuleSchemaVersion(original["schemaVersion"], d, config)
+	transformed["monitoring_notification_channels"] =
+		flattenBillingBudgetBudgetAllUpdatesRuleMonitoringNotificationChannels(original["monitoringNotificationChannels"], d, config)
 	return []interface{}{transformed}
 }
 func flattenBillingBudgetBudgetAllUpdatesRulePubsubTopic(v interface{}, d *schema.ResourceData, config *Config) interface{} {
@@ -519,6 +534,10 @@ func flattenBillingBudgetBudgetAllUpdatesRuleSchemaVersion(v interface{}, d *sch
 	return v
 }
 
+func flattenBillingBudgetBudgetAllUpdatesRuleMonitoringNotificationChannels(v interface{}, d *schema.ResourceData, config *Config) interface{} {
+	return v
+}
+
 func expandBillingBudgetBudget(v interface{}, d TerraformResourceData, config *Config) (interface{}, error) {
 	transformed := make(map[string]interface{})
 	transformedDisplayName, err := expandBillingBudgetBudgetDisplayName(d.Get("display_name"), d, config)
@@ -732,6 +751,13 @@ func expandBillingBudgetBudgetAllUpdatesRule(v interface{}, d TerraformResourceD
 		transformed["schemaVersion"] = transformedSchemaVersion
 	}
 
+	transformedMonitoringNotificationChannels, err := expandBillingBudgetBudgetAllUpdatesRuleMonitoringNotificationChannels(original["monitoring_notification_channels"], d, config)
+	if err != nil {
+		return nil, err
+	} else if val := reflect.ValueOf(transformedMonitoringNotificationChannels); val.IsValid() && !isEmptyValue(val) {
+		transformed["monitoringNotificationChannels"] = transformedMonitoringNotificationChannels
+	}
+
 	return transformed, nil
 }
 
@@ -742,3 +768,7 @@ func expandBillingBudgetBudgetAllUpdatesRulePubsubTopic(v interface{}, d Terrafo
 func expandBillingBudgetBudgetAllUpdatesRuleSchemaVersion(v interface{}, d TerraformResourceData, config *Config) (interface{}, error) {
 	return v, nil
 }
+
+func expandBillingBudgetBudgetAllUpdatesRuleMonitoringNotificationChannels(v interface{}, d TerraformResourceData, config *Config) (interface{}, error) {
+	return v, nil
+}

google-beta/resource_billing_budget_generated_test.go

@@ -124,6 +124,77 @@ resource "google_billing_budget" "budget" {
 `, context)
 }
 
+func TestAccBillingBudget_billingBudgetNotifyExample(t *testing.T) {
+	t.Parallel()
+
+	context := map[string]interface{}{
+		"billing_acct":  getTestBillingAccountFromEnv(t),
+		"project":       getTestProjectFromEnv(),
+		"random_suffix": randString(t, 10),
+	}
+
+	vcrTest(t, resource.TestCase{
+		PreCheck:     func() { testAccPreCheck(t) },
+		Providers:    testAccProvidersOiCS,
+		CheckDestroy: testAccCheckBillingBudgetDestroyProducer(t),
+		Steps: []resource.TestStep{
+			{
+				Config: testAccBillingBudget_billingBudgetNotifyExample(context),
+			},
+		},
+	})
+}
+
+func testAccBillingBudget_billingBudgetNotifyExample(context map[string]interface{}) string {
+	return Nprintf(`
+data "google_billing_account" "account" {
+  provider        = google-beta
+  billing_account = "%{billing_acct}"
+}
+
+resource "google_billing_budget" "budget" {
+  provider        = google-beta
+  billing_account = data.google_billing_account.account.id
+  display_name    = "Example Billing Budget%{random_suffix}"
+
+  budget_filter {
+    projects = ["projects/%{project}"]
+  }
+
+  amount {
+    specified_amount {
+      currency_code = "USD"
+      units         = "100000"
+    }
+  }
+
+  threshold_rules {
+    threshold_percent = 1.0
+  }
+  threshold_rules {
+    threshold_percent = 1.0
+    spend_basis       = "FORECASTED_SPEND"
+  }
+  
+  all_updates_rule {
+    monitoring_notification_channels = [
+      google_monitoring_notification_channel.notification_channel.id,
+    ]
+  }
+}
+
+resource "google_monitoring_notification_channel" "notification_channel" {
+  provider     = google-beta
+  display_name = "Example Notification Channel%{random_suffix}"
+  type         = "email"
+  
+  labels = {
+    email_address = "[email protected]"
+  }
+}
+`, context)
+}
+
 func testAccCheckBillingBudgetDestroyProducer(t *testing.T) func(s *terraform.State) error {
 	return func(s *terraform.State) error {
 		for name, rs := range s.RootModule().Resources {

website/docs/r/billing_budget.html.markdown

@@ -103,6 +103,61 @@ resource "google_billing_budget" "budget" {
   }
 }
 ```
+<div class = "oics-button" style="float: right; margin: 0 0 -15px">
+  <a href="https://console.cloud.google.com/cloudshell/open?cloudshell_git_repo=https%3A%2F%2Fgithub.com%2Fterraform-google-modules%2Fdocs-examples.git&cloudshell_working_dir=billing_budget_notify&cloudshell_image=gcr.io%2Fgraphite-cloud-shell-images%2Fterraform%3Alatest&open_in_editor=main.tf&cloudshell_print=.%2Fmotd&cloudshell_tutorial=.%2Ftutorial.md" target="_blank">
+    <img alt="Open in Cloud Shell" src="//gstatic.com/cloudssh/images/open-btn.svg" style="max-height: 44px; margin: 32px auto; max-width: 100%;">
+  </a>
+</div>
+## Example Usage - Billing Budget Notify
+
+
+```hcl
+data "google_billing_account" "account" {
+  provider        = google-beta
+  billing_account = "000000-0000000-0000000-000000"
+}
+
+resource "google_billing_budget" "budget" {
+  provider        = google-beta
+  billing_account = data.google_billing_account.account.id
+  display_name    = "Example Billing Budget"
+
+  budget_filter {
+    projects = ["projects/my-project-name"]
+  }
+
+  amount {
+    specified_amount {
+      currency_code = "USD"
+      units         = "100000"
+    }
+  }
+
+  threshold_rules {
+    threshold_percent = 1.0
+  }
+  threshold_rules {
+    threshold_percent = 1.0
+    spend_basis       = "FORECASTED_SPEND"
+  }
+  
+  all_updates_rule {
+    monitoring_notification_channels = [
+      google_monitoring_notification_channel.notification_channel.id,
+    ]
+  }
+}
+
+resource "google_monitoring_notification_channel" "notification_channel" {
+  provider     = google-beta
+  display_name = "Example Notification Channel"
+  type         = "email"
+  
+  labels = {
+    email_address = "[email protected]"
+  }
+}
+```
 
 ## Argument Reference
 
@@ -202,7 +257,7 @@ The `threshold_rules` block supports:
 The `all_updates_rule` block supports:
 
 * `pubsub_topic` -
-  (Required)
+  (Optional)
   The name of the Cloud Pub/Sub topic where budget related
   messages will be published, in the form
   projects/{project_id}/topics/{topic_id}. Updates are sent
@@ -214,6 +269,13 @@ The `all_updates_rule` block supports:
   accepted. It represents the JSON schema as defined in
   https://cloud.google.com/billing/docs/how-to/budgets#notification_format.
 
+* `monitoring_notification_channels` -
+  (Optional)
+  The full resource name of a monitoring notification
+  channel in the form
+  projects/{project_id}/notificationChannels/{channel_id}.
+  A maximum of 5 channels are allowed.
+
 - - -