r/grafana_workspace - fix vpc config update + workspace config arg

.changelog/28569.txt

@@ -0,0 +1,7 @@
+```release-note:bug
+resource/aws_grafana_workspace: Fix updating `vpc_configuration`
+```
+
+```release-note:enhancement
+resource/aws_grafana_workspace: Add `configuration` argument
+```

internal/service/ec2/sweep.go

@@ -250,6 +250,7 @@ func init() {
 			"aws_spot_fleet_request",
 			"aws_spot_instance_request",
 			"aws_vpc_endpoint",
+			"aws_grafana_workspace",
 		},
 	})
 

internal/service/grafana/sweep.go

@@ -0,0 +1,76 @@
+//go:build sweep
+// +build sweep
+
+package grafana
+
+import (
+	"fmt"
+	"log"
+
+	"github.com/aws/aws-sdk-go/aws"
+	"github.com/aws/aws-sdk-go/service/managedgrafana"
+	"github.com/hashicorp/go-multierror"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
+	"github.com/hashicorp/terraform-provider-aws/internal/conns"
+	"github.com/hashicorp/terraform-provider-aws/internal/sweep"
+)
+
+func init() {
+	resource.AddTestSweepers("aws_grafana_workspace", &resource.Sweeper{
+		Name: "aws_grafana_workspace",
+		F:    sweepWorkSpaces,
+	})
+}
+
+func sweepWorkSpaces(region string) error {
+	client, err := sweep.SharedRegionalSweepClient(region)
+	if err != nil {
+		return fmt.Errorf("error getting client: %s", err)
+	}
+	conn := client.(*conns.AWSClient).GrafanaConn()
+
+	sweepResources := make([]sweep.Sweepable, 0)
+	var errs *multierror.Error
+
+	input := &managedgrafana.ListWorkspacesInput{}
+
+	err = conn.ListWorkspacesPages(input, func(page *managedgrafana.ListWorkspacesOutput, lastPage bool) bool {
+		if len(page.Workspaces) == 0 {
+			log.Printf("[INFO] No Grafana Workspaces to sweep")
+			return false
+		}
+		for _, workspace := range page.Workspaces {
+
+			id := aws.StringValue(workspace.Id)
+			log.Printf("[INFO] Deleting Grafana Workspace: %s", id)
+			r := ResourceWorkspace()
+			d := r.Data(nil)
+			d.SetId(id)
+
+			if err != nil {
+				err := fmt.Errorf("reading Grafana Workspace (%s): %w", id, err)
+				log.Printf("[ERROR] %s", err)
+				errs = multierror.Append(errs, err)
+				continue
+			}
+
+			sweepResources = append(sweepResources, sweep.NewSweepResource(r, d, client))
+		}
+		return !lastPage
+	})
+
+	if err != nil {
+		errs = multierror.Append(errs, fmt.Errorf("listing Grafana Workspace for %s: %w", region, err))
+	}
+
+	if err := sweep.SweepOrchestrator(sweepResources); err != nil {
+		errs = multierror.Append(errs, fmt.Errorf("sweeping Grafana Workspace for %s: %w", region, err))
+	}
+
+	if sweep.SkipSweepError(err) {
+		log.Printf("[WARN] Skipping Grafana Workspace sweep for %s: %s", region, errs)
+		return nil
+	}
+
+	return errs.ErrorOrNil()
+}

internal/service/grafana/workspace.go

@@ -11,6 +11,7 @@ import (
 	"github.com/hashicorp/aws-sdk-go-base/v2/awsv1shim/v2/tfawserr"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/structure"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
 	"github.com/hashicorp/terraform-provider-aws/internal/conns"
 	"github.com/hashicorp/terraform-provider-aws/internal/flex"
@@ -54,6 +55,17 @@ func ResourceWorkspace() *schema.Resource {
 					ValidateFunc: validation.StringInSlice(managedgrafana.AuthenticationProviderTypes_Values(), false),
 				},
 			},
+			"configuration": {
+				Type:             schema.TypeString,
+				Optional:         true,
+				Computed:         true,
+				ValidateFunc:     validation.StringIsJSON,
+				DiffSuppressFunc: verify.SuppressEquivalentJSONDiffs,
+				StateFunc: func(v interface{}) string {
+					json, _ := structure.NormalizeJsonString(v)
+					return json
+				},
+			},
 			"data_sources": {
 				Type:     schema.TypeList,
 				Optional: true,
@@ -157,12 +169,8 @@ func resourceWorkspaceCreate(d *schema.ResourceData, meta interface{}) error {
 		Tags:                    Tags(tags.IgnoreAWS()),
 	}
 
-	if v, ok := d.GetOk("organization_role_name"); ok {
-		input.OrganizationRoleName = aws.String(v.(string))
-	}
-
-	if v, ok := d.GetOk("stack_set_name"); ok {
-		input.StackSetName = aws.String(v.(string))
+	if v, ok := d.GetOk("configuration"); ok {
+		input.Configuration = aws.String(v.(string))
 	}
 
 	if v, ok := d.GetOk("data_sources"); ok {
@@ -181,6 +189,10 @@ func resourceWorkspaceCreate(d *schema.ResourceData, meta interface{}) error {
 		input.WorkspaceNotificationDestinations = flex.ExpandStringList(v.([]interface{}))
 	}
 
+	if v, ok := d.GetOk("organization_role_name"); ok {
+		input.OrganizationRoleName = aws.String(v.(string))
+	}
+
 	if v, ok := d.GetOk("organizational_units"); ok {
 		input.WorkspaceOrganizationalUnits = flex.ExpandStringList(v.([]interface{}))
 	}
@@ -189,6 +201,10 @@ func resourceWorkspaceCreate(d *schema.ResourceData, meta interface{}) error {
 		input.WorkspaceRoleArn = aws.String(v.(string))
 	}
 
+	if v, ok := d.GetOk("stack_set_name"); ok {
+		input.StackSetName = aws.String(v.(string))
+	}
+
 	if v, ok := d.GetOk("vpc_configuration"); ok {
 		input.VpcConfiguration = expandVPCConfiguration(v.([]interface{}))
 	}
@@ -265,13 +281,25 @@ func resourceWorkspaceRead(d *schema.ResourceData, meta interface{}) error {
 		return fmt.Errorf("error setting tags_all: %w", err)
 	}
 
+	input := &managedgrafana.DescribeWorkspaceConfigurationInput{
+		WorkspaceId: aws.String(d.Id()),
+	}
+
+	output, err := conn.DescribeWorkspaceConfiguration(input)
+
+	if err != nil {
+		return fmt.Errorf("error reading Grafana Workspace (%s) configuration: %w", d.Id(), err)
+	}
+
+	d.Set("configuration", output.Configuration)
+
 	return nil
 }
 
 func resourceWorkspaceUpdate(d *schema.ResourceData, meta interface{}) error {
 	conn := meta.(*conns.AWSClient).GrafanaConn()
 
-	if d.HasChangesExcept("tags", "tags_all") {
+	if d.HasChangesExcept("configuration", "tags", "tags_all") {
 		input := &managedgrafana.UpdateWorkspaceInput{
 			WorkspaceId: aws.String(d.Id()),
 		}
@@ -316,6 +344,10 @@ func resourceWorkspaceUpdate(d *schema.ResourceData, meta interface{}) error {
 			input.StackSetName = aws.String(d.Get("stack_set_name").(string))
 		}
 
+		if d.HasChange("vpc_configuration") {
+			input.VpcConfiguration = expandVPCConfiguration(d.Get("vpc_configuration").([]interface{}))
+		}
+
 		_, err := conn.UpdateWorkspace(input)
 
 		if err != nil {
@@ -327,6 +359,23 @@ func resourceWorkspaceUpdate(d *schema.ResourceData, meta interface{}) error {
 		}
 	}
 
+	if d.HasChange("configuration") {
+		input := &managedgrafana.UpdateWorkspaceConfigurationInput{
+			WorkspaceId:   aws.String(d.Id()),
+			Configuration: aws.String(d.Get("configuration").(string)),
+		}
+
+		_, err := conn.UpdateWorkspaceConfiguration(input)
+
+		if err != nil {
+			return fmt.Errorf("error updating Grafana Workspace (%s) configuration: %w", d.Id(), err)
+		}
+
+		if _, err := waitWorkspaceUpdated(conn, d.Id(), d.Timeout(schema.TimeoutUpdate)); err != nil {
+			return fmt.Errorf("error waiting for Grafana Workspace (%s) configuration update: %w", d.Id(), err)
+		}
+	}
+
 	if d.HasChange("tags_all") {
 		o, n := d.GetChange("tags_all")
 

internal/service/grafana/workspace_test.go

@@ -27,6 +27,7 @@ func TestAccGrafana_serial(t *testing.T) {
 			"notificationDestinations": testAccWorkspace_notificationDestinations,
 			"tags":                     testAccWorkspace_tags,
 			"vpc":                      testAccWorkspace_vpc,
+			"configuration":            testAccWorkspace_configuration,
 		},
 		"ApiKey": {
 			"basic": testAccWorkspaceAPIKey_basic,
@@ -120,7 +121,7 @@ func testAccWorkspace_vpc(t *testing.T) {
 		ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories,
 		Steps: []resource.TestStep{
 			{
-				Config: testAccWorkspaceConfig_vpc(rName),
+				Config: testAccWorkspaceConfig_vpc(rName, 2),
 				Check: resource.ComposeAggregateTestCheckFunc(
 					testAccCheckWorkspaceExists(resourceName),
 					resource.TestCheckResourceAttr(resourceName, "vpc_configuration.#", "1"),
@@ -133,6 +134,15 @@ func testAccWorkspace_vpc(t *testing.T) {
 				ImportState:       true,
 				ImportStateVerify: true,
 			},
+			{
+				Config: testAccWorkspaceConfig_vpc(rName, 3),
+				Check: resource.ComposeAggregateTestCheckFunc(
+					testAccCheckWorkspaceExists(resourceName),
+					resource.TestCheckResourceAttr(resourceName, "vpc_configuration.#", "1"),
+					resource.TestCheckResourceAttr(resourceName, "vpc_configuration.0.security_group_ids.#", "1"),
+					resource.TestCheckResourceAttr(resourceName, "vpc_configuration.0.subnet_ids.#", "3"),
+				),
+			},
 		},
 	})
 }
@@ -401,6 +411,39 @@ func testAccWorkspace_notificationDestinations(t *testing.T) {
 	})
 }
 
+func testAccWorkspace_configuration(t *testing.T) {
+	rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix)
+	resourceName := "aws_grafana_workspace.test"
+
+	resource.Test(t, resource.TestCase{
+		PreCheck:                 func() { acctest.PreCheck(t); acctest.PreCheckPartitionHasService(managedgrafana.EndpointsID, t) },
+		ErrorCheck:               acctest.ErrorCheck(t, managedgrafana.EndpointsID),
+		CheckDestroy:             testAccCheckWorkspaceDestroy,
+		ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories,
+		Steps: []resource.TestStep{
+			{
+				Config: testAccWorkspaceConfig_configuration(rName, `{"unifiedAlerting": { "enabled": true }}`),
+				Check: resource.ComposeAggregateTestCheckFunc(
+					testAccCheckWorkspaceExists(resourceName),
+					resource.TestCheckResourceAttr(resourceName, "configuration", `{"unifiedAlerting":{"enabled":true}}`),
+				),
+			},
+			{
+				ResourceName:      resourceName,
+				ImportState:       true,
+				ImportStateVerify: true,
+			},
+			{
+				Config: testAccWorkspaceConfig_configuration(rName, `{"unifiedAlerting": { "enabled": false }}`),
+				Check: resource.ComposeAggregateTestCheckFunc(
+					testAccCheckWorkspaceExists(resourceName),
+					resource.TestCheckResourceAttr(resourceName, "configuration", `{"unifiedAlerting":{"enabled":false}}`),
+				),
+			},
+		},
+	})
+}
+
 func testAccCheckWorkspaceExists(name string) resource.TestCheckFunc {
 	return func(s *terraform.State) error {
 		rs, ok := s.RootModule().Resources[name]
@@ -569,8 +612,8 @@ resource "aws_grafana_workspace" "test" {
 `, rName))
 }
 
-func testAccWorkspaceConfig_vpc(rName string) string {
-	return acctest.ConfigCompose(testAccWorkspaceConfig_base(rName), acctest.ConfigVPCWithSubnets(rName, 2), fmt.Sprintf(`
+func testAccWorkspaceConfig_vpc(rName string, subnets int) string {
+	return acctest.ConfigCompose(testAccWorkspaceConfig_base(rName), acctest.ConfigVPCWithSubnets(rName, subnets), fmt.Sprintf(`
 resource "aws_security_group" "test" {
   description = %[1]q
   vpc_id      = aws_vpc.test.id
@@ -589,3 +632,15 @@ resource "aws_grafana_workspace" "test" {
 }
 `, rName))
 }
+
+func testAccWorkspaceConfig_configuration(rName, configuration string) string {
+	return acctest.ConfigCompose(testAccWorkspaceConfig_base(rName), fmt.Sprintf(`
+resource "aws_grafana_workspace" "test" {
+  account_access_type      = "CURRENT_ACCOUNT"
+  authentication_providers = ["SAML"]
+  permission_type          = "SERVICE_MANAGED"
+  role_arn                 = aws_iam_role.test.arn
+  configuration            = %[1]q
+}
+`, configuration))
+}

website/docs/r/grafana_workspace.html.markdown

@@ -50,6 +50,7 @@ The following arguments are required:
 
 The following arguments are optional:
 
+* `configuration` - (Optional) The configuration string for the workspace that you create. For more information about the format and configuration options available, see [Working in your Grafana workspace](https://docs.aws.amazon.com/grafana/latest/userguide/AMG-configure-workspace.html).
 * `data_sources` - (Optional) The data sources for the workspace. Valid values are `AMAZON_OPENSEARCH_SERVICE`, `ATHENA`, `CLOUDWATCH`, `PROMETHEUS`, `REDSHIFT`, `SITEWISE`, `TIMESTREAM`, `XRAY`
 * `description` - (Optional) The workspace description.
 * `name` - (Optional) The Grafana workspace name.