ENG-10659: Adding Force New Directives to Access Gateway resource (#340)

* add force new directives to access gateway resource * update doc * Update docs Co-authored-by: Wilson de Carvalho <[email protected]>
cyralinc · Jan 14, 2023 · 9f91dd8 · 9f91dd8
1 parent 8b7066d
commit 9f91dd8
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 6 deletions.
diff --git a/cyral/resource_cyral_repository_access_gateway.go b/cyral/resource_cyral_repository_access_gateway.go
@@ -105,17 +105,21 @@ func resourceRepositoryAccessGateway() *schema.Resource {
 				Description: "ID of the repository the access gateway is associated with. This is also the " +
 					"import ID for this resource.",
 				Type:     schema.TypeString,
+				ForceNew: true,
 				Required: true,
 			},
 			SidecarIDKey: {
-				Description: "ID of the sidecar that will be set as the access gatway for the given repository.",
+				Description: "ID of the sidecar that will be set as the access gateway for the given repository.",
 				Type:        schema.TypeString,
 				Required:    true,
 			},
 			BindingIDKey: {
-				Description: "ID of the binding that will be set as the access gatway for the given repository.",
-				Type:        schema.TypeString,
-				Required:    true,
+				Description: "ID of the binding that will be set as the access gateway for the given repository.  " +
+					"Note that modifications to this field will result in terraform replacing the given " +
+					"access gateway resource, since the access gateway must be deleted before binding. ",
+				Type:     schema.TypeString,
+				ForceNew: true,
+				Required: true,
 			},
 		},
 		Importer: &schema.ResourceImporter{

diff --git a/docs/resources/repository_access_gateway.md b/docs/resources/repository_access_gateway.md
@@ -59,9 +59,9 @@ resource "cyral_repository_access_gateway" "access_gateway" {
 
 ### Required
 
-- `binding_id` (String) ID of the binding that will be set as the access gatway for the given repository.
+- `binding_id` (String) ID of the binding that will be set as the access gateway for the given repository. Note that modifications to this field will result in terraform replacing the given access gateway resource, since the access gateway must be deleted before binding.
 - `repository_id` (String) ID of the repository the access gateway is associated with. This is also the import ID for this resource.
-- `sidecar_id` (String) ID of the sidecar that will be set as the access gatway for the given repository.
+- `sidecar_id` (String) ID of the sidecar that will be set as the access gateway for the given repository.
 
 ### Read-Only