Correct SecurityGateway to be global only (#12788) (#21006)

[upstream:03f66203c207e3b0629fdf731d2f8e1e30c011fe] Signed-off-by: Modular Magician <[email protected]>
hashicorp · Jan 22, 2025 · 19daf0c · 19daf0c
1 parent 1d5beef
commit 19daf0c
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 16 deletions.
diff --git a/.changelog/12788.txt b/.changelog/12788.txt
@@ -0,0 +1,6 @@
+```release-note:bug
+beyondcorp: corrected `location` to always be global in `google_beyondcorp_security_gateway` 
+```
+```release-note:deprecation
+beyondcorp: deprecated `location` on `google_beyondcorp_security_gateway`. The only valid value is `global`, which is now also the default value. The field will be removed in a future major release.
+```
diff --git a/google/services/beyondcorp/resource_beyondcorp_security_gateway.go b/google/services/beyondcorp/resource_beyondcorp_security_gateway.go
@@ -30,6 +30,7 @@ import (
 
 	"github.com/hashicorp/terraform-provider-google/google/tpgresource"
 	transport_tpg "github.com/hashicorp/terraform-provider-google/google/transport"
+	"github.com/hashicorp/terraform-provider-google/google/verify"
 )
 
 func ResourceBeyondcorpSecurityGateway() *schema.Resource {
@@ -54,12 +55,6 @@ func ResourceBeyondcorpSecurityGateway() *schema.Resource {
 		),
 
 		Schema: map[string]*schema.Schema{
-			"location": {
-				Type:        schema.TypeString,
-				Required:    true,
-				ForceNew:    true,
-				Description: `Resource ID segment making up resource 'name'. It identifies the resource within its parent collection as described in https://google.aip.dev/122.`,
-			},
 			"security_gateway_id": {
 				Type:     schema.TypeString,
 				Required: true,
@@ -107,6 +102,15 @@ as a key.`,
 					},
 				},
 			},
+			"location": {
+				Type:         schema.TypeString,
+				Optional:     true,
+				Deprecated:   "`location` is deprecated and will be removed in a future major release.",
+				ForceNew:     true,
+				ValidateFunc: verify.ValidateRegexp(`^global$`),
+				Description:  `Resource ID segment making up resource 'name'. It identifies the resource within its parent collection as described in https://google.aip.dev/122. Must be omitted or set to 'global'.`,
+				Default:      "global",
+			},
 			"create_time": {
 				Type:        schema.TypeString,
 				Computed:    true,

diff --git a/google/services/beyondcorp/resource_beyondcorp_security_gateway_generated_test.go b/google/services/beyondcorp/resource_beyondcorp_security_gateway_generated_test.go
@@ -59,7 +59,6 @@ func testAccBeyondcorpSecurityGateway_beyondcorpSecurityGatewayBasicExample(cont
 	return acctest.Nprintf(`
 resource "google_beyondcorp_security_gateway" "example" {
   security_gateway_id = "default%{random_suffix}"
-  location = "global"
   display_name = "My Security Gateway resource"
   hubs { region = "us-central1" }
 }

diff --git a/google/services/beyondcorp/resource_beyondcorp_security_gateway_test.go b/google/services/beyondcorp/resource_beyondcorp_security_gateway_test.go
@@ -29,7 +29,7 @@ func TestAccBeyondcorpSecurityGateway_beyondcorpSecurityGatewayBasicExample_upda
 				ResourceName:            "google_beyondcorp_security_gateway.example",
 				ImportState:             true,
 				ImportStateVerify:       true,
-				ImportStateVerifyIgnore: []string{"location", "security_gateway_id"},
+				ImportStateVerifyIgnore: []string{"security_gateway_id"},
 			},
 			{
 				Config: testAccBeyondcorpSecurityGateway_beyondcorpSecurityGatewayBasicExample_update(context),
@@ -43,7 +43,7 @@ func TestAccBeyondcorpSecurityGateway_beyondcorpSecurityGatewayBasicExample_upda
 				ResourceName:            "google_beyondcorp_security_gateway.example",
 				ImportState:             true,
 				ImportStateVerify:       true,
-				ImportStateVerifyIgnore: []string{"location", "security_gateway_id"},
+				ImportStateVerifyIgnore: []string{"security_gateway_id"},
 			},
 		},
 	})
@@ -53,7 +53,6 @@ func testAccBeyondcorpSecurityGateway_beyondcorpSecurityGatewayBasicExample_basi
 	return acctest.Nprintf(`
 resource "google_beyondcorp_security_gateway" "example" {
   security_gateway_id = "default%{random_suffix}"
-  location = "global"
   display_name = "My Security Gateway resource"
   hubs { region = "us-central1" }
 }
@@ -64,7 +63,6 @@ func testAccBeyondcorpSecurityGateway_beyondcorpSecurityGatewayBasicExample_upda
 	return acctest.Nprintf(`
 resource "google_beyondcorp_security_gateway" "example" {
   security_gateway_id = "default%{random_suffix}"
-  location = "global"
   display_name = "My Security Gateway resource"
   hubs { region = "us-east1" }
 }

diff --git a/website/docs/r/beyondcorp_security_gateway.html.markdown b/website/docs/r/beyondcorp_security_gateway.html.markdown
@@ -34,7 +34,6 @@ Deployment of Security Gateway.
 ```hcl
 resource "google_beyondcorp_security_gateway" "example" {
   security_gateway_id = "default"
-  location = "global"
   display_name = "My Security Gateway resource"
   hubs { region = "us-central1" }
 }
@@ -45,10 +44,6 @@ resource "google_beyondcorp_security_gateway" "example" {
 The following arguments are supported:
 
 
-* `location` -
-  (Required)
-  Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
-
 * `security_gateway_id` -
   (Required)
   Optional. User-settable SecurityGateway resource ID.
@@ -71,6 +66,12 @@ The following arguments are supported:
   Optional. An arbitrary user-provided name for the SecurityGateway.
   Cannot exceed 64 characters.
 
+* `location` -
+  (Optional, Deprecated)
+  Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122. Must be omitted or set to `global`.
+
+  ~> **Warning:** `location` is deprecated and will be removed in a future major release.
+
 * `project` - (Optional) The ID of the project in which the resource belongs.
     If it is not provided, the provider project is used.