Cleanup auditlogs on destroy

docs/resources/config.md

@@ -53,8 +53,6 @@ output "config_id" {
 
 Import is supported using the following syntax:
 
-The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example:
-
 ```shell
 # Configs can be imported using the ConfigId. Get the ConfigId using the [List Configs API](https://api.configcat.com/docs/#tag/Configs/operation/get-configs) for example.
 

docs/resources/environment.md

@@ -42,6 +42,7 @@ output "environment_id" {
 
 ### Optional
 
+- `cleanup_auditlogs_on_destroy` (Boolean) An optional flag which indicates whether the audit log records related to the environment should be deleted upon destroying the resource. It can be useful to turn on for temporary, ephemeral environments, when you don't want to keep the audit log entries for the environment after it is destroyed.
 - `color` (String) The color of the Environment.
 - `description` (String) The description of the Environment.
 
@@ -53,8 +54,6 @@ output "environment_id" {
 
 Import is supported using the following syntax:
 
-The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example:
-
 ```shell
 # Environments can be imported using the EnvironmentId. Get the EnvironmentId using the [List Environments API](https://api.configcat.com/docs/#tag/Environments/operation/get-environments) for example.
 

docs/resources/integration.md

@@ -123,8 +123,6 @@ output "slack_integration_id" {
 
 Import is supported using the following syntax:
 
-The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example:
-
 ```shell
 # Integrations can be imported using the IntegrationId. Get the IntegrationId using the [List Integrations API](https://api.configcat.com/docs/index.html#tag/Integrations/operation/get-integrations) for example.
 

docs/resources/permission_group.md

@@ -119,8 +119,6 @@ output "custom_permission_group_id" {
 
 Import is supported using the following syntax:
 
-The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example:
-
 ```shell
 # Permission Groups can be imported using the PermissionGroupId. Get the PermissionGroupId using the [List Permission Groups API](https://api.configcat.com/docs/#tag/Permission-Groups/operation/get-permission-groups) for example.
 

docs/resources/product.md

@@ -51,8 +51,6 @@ output "product_id" {
 
 Import is supported using the following syntax:
 
-The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example:
-
 ```shell
 # Products can be imported using the ProductId. Get the ProductId using the [List Products API](https://api.configcat.com/docs/#tag/Products/operation/get-products) for example.
 

docs/resources/product_preferences.md

@@ -72,8 +72,6 @@ resource "configcat_product_preferences" "preferences" {
 
 Import is supported using the following syntax:
 
-The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example:
-
 ```shell
 # Product preferences can be imported using the ProductId. Get the ProductId using the [List Products API](https://api.configcat.com/docs/#tag/Products/operation/get-products) for example.
 

docs/resources/segment.md

@@ -55,8 +55,6 @@ output "segment_id" {
 
 Import is supported using the following syntax:
 
-The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example:
-
 ```shell
 # Segments can be imported using the SegmentId. Get the SegmentId using the [List Segments API](https://api.configcat.com/docs/#tag/Segments/operation/get-segments) for example.
 

docs/resources/setting.md

@@ -82,8 +82,6 @@ Optional:
 
 Import is supported using the following syntax:
 
-The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example:
-
 ```shell
 # Feature Flags/Settings can be imported using the SettingId. Get the SettingId using e.g. the [List Flags API](https://api.configcat.com/docs/#tag/Feature-Flags-and-Settings/operation/get-settings).
 

docs/resources/setting_tag.md

@@ -43,8 +43,6 @@ resource "configcat_setting_tag" "my_setting_tag" {
 
 Import is supported using the following syntax:
 
-The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example:
-
 ```shell
 # Setting Tags can be imported using a combined SettingId:TagId ID.  
 # Get the SettingId using e.g. the [List Flags API](https://api.configcat.com/docs/#tag/Feature-Flags-and-Settings/operation/get-settings).  

docs/resources/setting_value.md

@@ -106,8 +106,6 @@ Optional:
 
 Import is supported using the following syntax:
 
-The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example:
-
 ```shell
 # Feature Flag/Setting values (V1) can be imported using a combined EnvironmentID:SettingId ID.  
 # Get the EnvironmentId using e.g. the [List Environments API](https://api.configcat.com/docs/#tag/Environments/operation/get-environments).  

docs/resources/setting_value_v2.md

@@ -304,8 +304,6 @@ Optional:
 
 Import is supported using the following syntax:
 
-The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example:
-
 ```shell
 # Feature Flag/Setting values (V2) can be imported using a combined EnvironmentID:SettingId ID.  
 # Get the EnvironmentId using e.g. the [List Environments API](https://api.configcat.com/docs/#tag/Environments/operation/get-environments).  

docs/resources/tag.md

@@ -49,8 +49,6 @@ output "tag_id" {
 
 Import is supported using the following syntax:
 
-The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example:
-
 ```shell
 # Tags can be imported using the TagId. Get the TagId using e.g. the [List Tags API](https://api.configcat.com/docs/#tag/Tags/operation/get-tags).
 

docs/resources/webhook.md

@@ -83,8 +83,6 @@ Required:
 
 Import is supported using the following syntax:
 
-The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example:
-
 ```shell
 # Webhooks can be imported using the WebhookId. Get the WebhookId using the [List Webhooks API](https://api.configcat.com/docs/index.html#tag/Webhooks/operation/get-webhooks) for example.
 # It is important to note that webhooks containing secure webhook headers cannot be imported via `terraform import`.

internal/configcat/client/client_environment.go

@@ -42,10 +42,10 @@ func (client *Client) UpdateEnvironment(environmentID string, body sw.UpdateEnvi
 	return model, error
 }
 
-func (client *Client) DeleteEnvironment(environmentID string) error {
+func (client *Client) DeleteEnvironment(environmentID string, cleanupAuditLogs bool) error {
 	response, err := client.apiClient.EnvironmentsAPI.DeleteEnvironment(
 		client.GetAuthContext(),
-		environmentID).Execute()
+		environmentID).CleanupAuditLogs(cleanupAuditLogs).Execute()
 	error := handleAPIError(err)
 	if response != nil && response.Body != nil {
 		defer response.Body.Close()

internal/configcat/configcat_keys.go

@@ -28,9 +28,10 @@ const (
 	ConfigId           = "config_id"
 	EvaluationVersion  = "evaluation_version"
 
-	EnvironmentResourceName = "Environment"
-	Environments            = "environments"
-	EnvironmentId           = "environment_id"
+	EnvironmentResourceName   = "Environment"
+	Environments              = "environments"
+	EnvironmentId             = "environment_id"
+	CleanupAuditLogsOnDestroy = "cleanup_auditlogs_on_destroy"
 
 	WebhookResourceName  = "Webhook"
 	WebhookId            = "webhook_id"

internal/configcat/environment_resource.go

@@ -8,6 +8,8 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/path"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
+	"github.com/hashicorp/terraform-plugin-framework/resource/schema/booldefault"
+	"github.com/hashicorp/terraform-plugin-framework/resource/schema/boolplanmodifier"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/stringplanmodifier"
 	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
@@ -31,11 +33,12 @@ type environmentResource struct {
 type environmentResourceModel struct {
 	ProductId types.String `tfsdk:"product_id"`
 
-	ID          types.String `tfsdk:"id"`
-	Name        types.String `tfsdk:"name"`
-	Description types.String `tfsdk:"description"`
-	Color       types.String `tfsdk:"color"`
-	Order       types.Int64  `tfsdk:"order"`
+	ID                        types.String `tfsdk:"id"`
+	Name                      types.String `tfsdk:"name"`
+	Description               types.String `tfsdk:"description"`
+	Color                     types.String `tfsdk:"color"`
+	Order                     types.Int64  `tfsdk:"order"`
+	CleanupAuditLogsOnDestroy types.Bool   `tfsdk:"cleanup_auditlogs_on_destroy"`
 }
 
 func (r *environmentResource) Metadata(ctx context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse) {
@@ -86,6 +89,15 @@ func (r *environmentResource) Schema(ctx context.Context, req resource.SchemaReq
 				Description: "The order of the " + EnvironmentResourceName + " within a " + ProductResourceName + " (zero-based). If multiple " + EnvironmentResourceName + "s has the same order, they are displayed in alphabetical order.",
 				Required:    true,
 			},
+			CleanupAuditLogsOnDestroy: schema.BoolAttribute{
+				Description: "An optional flag which indicates whether the audit log records related to the environment should be deleted upon destroying the resource. It can be useful to turn on for temporary, ephemeral environments, when you don't want to keep the audit log entries for the environment after it is destroyed.",
+				Computed:    true,
+				Optional:    true,
+				Default:     booldefault.StaticBool(false),
+				PlanModifiers: []planmodifier.Bool{
+					boolplanmodifier.UseStateForUnknown(),
+				},
+			},
 		},
 	}
 }
@@ -132,7 +144,7 @@ func (r *environmentResource) Create(ctx context.Context, req resource.CreateReq
 		return
 	}
 
-	plan.UpdateFromApiModel(*model)
+	plan.UpdateFromApiModel(*model, plan.CleanupAuditLogsOnDestroy.ValueBool())
 
 	resp.Diagnostics.Append(resp.State.Set(ctx, &plan)...)
 }
@@ -158,7 +170,7 @@ func (r *environmentResource) Read(ctx context.Context, req resource.ReadRequest
 		return
 	}
 
-	state.UpdateFromApiModel(*model)
+	state.UpdateFromApiModel(*model, state.CleanupAuditLogsOnDestroy.ValueBool())
 	resp.Diagnostics.Append(resp.State.Set(ctx, &state)...)
 }
 
@@ -190,7 +202,7 @@ func (r *environmentResource) Update(ctx context.Context, req resource.UpdateReq
 		return
 	}
 
-	plan.UpdateFromApiModel(*model)
+	plan.UpdateFromApiModel(*model, plan.CleanupAuditLogsOnDestroy.ValueBool())
 	resp.Diagnostics.Append(resp.State.Set(ctx, &plan)...)
 }
 
@@ -203,7 +215,7 @@ func (r *environmentResource) Delete(ctx context.Context, req resource.DeleteReq
 		return
 	}
 
-	err := r.client.DeleteEnvironment(state.ID.ValueString())
+	err := r.client.DeleteEnvironment(state.ID.ValueString(), state.CleanupAuditLogsOnDestroy.ValueBool())
 
 	if err != nil {
 		if _, ok := err.(client.NotFoundError); ok {
@@ -220,12 +232,13 @@ func (r *environmentResource) ImportState(ctx context.Context, req resource.Impo
 	resource.ImportStatePassthroughID(ctx, path.Root(ID), req, resp)
 }
 
-func (resourceModel *environmentResourceModel) UpdateFromApiModel(model sw.EnvironmentModel) {
+func (resourceModel *environmentResourceModel) UpdateFromApiModel(model sw.EnvironmentModel, cleanupAuditLogsOnDestroy bool) {
 	modelOrder := int64(model.Order)
 	resourceModel.ID = types.StringValue(model.EnvironmentId)
 	resourceModel.ProductId = types.StringValue(model.Product.ProductId)
 	resourceModel.Name = types.StringValue(model.Name)
 	resourceModel.Description = types.StringPointerValue(model.Description.Get())
 	resourceModel.Color = types.StringPointerValue(model.Color.Get())
 	resourceModel.Order = types.Int64Value(modelOrder)
+	resourceModel.CleanupAuditLogsOnDestroy = types.BoolValue(cleanupAuditLogsOnDestroy)
 }

internal/configcat/environment_resource_test.go

@@ -63,3 +63,52 @@ func TestAccEnvironmentResource(t *testing.T) {
 		},
 	})
 }
+
+func TestAccCleanupAuditLogsOnDestroyEnvironmentResource(t *testing.T) {
+	const productId = "08d86d63-2721-4da6-8c06-584521d516bc"
+	const testResourceName = "configcat_environment.test"
+
+	resource.Test(t, resource.TestCase{
+		PreCheck:                 func() { testAccPreCheck(t) },
+		ProtoV6ProviderFactories: testAccProtoV6ProviderFactories,
+		Steps: []resource.TestStep{
+			{
+				ConfigFile: config.TestNameFile("cleanup_step_1.tf"),
+				ConfigVariables: config.Variables{
+					"product_id": config.StringVariable(productId),
+					"name":       config.StringVariable("Resource name"),
+					"order":      config.IntegerVariable(1),
+				},
+				Check: resource.ComposeAggregateTestCheckFunc(
+					resource.TestCheckResourceAttrSet(testResourceName, ID),
+					resource.TestCheckResourceAttr(testResourceName, Name, "Resource name"),
+					resource.TestCheckResourceAttr(testResourceName, Order, "1"),
+					resource.TestCheckResourceAttr(testResourceName, Description, ""),
+					resource.TestCheckResourceAttr(testResourceName, Color, ""),
+				),
+			},
+			{
+				ConfigFile: config.TestNameFile("cleanup_step_2.tf"),
+			},
+			{
+				ConfigFile: config.TestNameFile("cleanup_step_1.tf"),
+				ConfigVariables: config.Variables{
+					"product_id":                   config.StringVariable(productId),
+					"name":                         config.StringVariable("Resource name"),
+					"order":                        config.IntegerVariable(1),
+					"cleanup_auditlogs_on_destroy": config.BoolVariable(true),
+				},
+				Check: resource.ComposeAggregateTestCheckFunc(
+					resource.TestCheckResourceAttrSet(testResourceName, ID),
+					resource.TestCheckResourceAttr(testResourceName, Name, "Resource name"),
+					resource.TestCheckResourceAttr(testResourceName, Order, "1"),
+					resource.TestCheckResourceAttr(testResourceName, Description, ""),
+					resource.TestCheckResourceAttr(testResourceName, Color, ""),
+				),
+			},
+			{
+				ConfigFile: config.TestNameFile("cleanup_step_2.tf"),
+			},
+		},
+	})
+}

internal/configcat/testdata/TestAccCleanupAuditLogsOnDestroyEnvironmentResource/cleanup_step_1.tf

@@ -0,0 +1,32 @@
+variable "product_id" {
+  type = string
+}
+
+variable "name" {
+  type = string
+}
+variable "description" {
+  type    = string
+  default = null
+}
+variable "color" {
+  type    = string
+  default = null
+}
+variable "order" {
+  type    = number
+  default = 0
+}
+variable "cleanup_auditlogs_on_destroy" {
+  type    = bool
+  default = false
+}
+
+resource "configcat_environment" "test" {
+  product_id  = var.product_id
+  name        = var.name
+  description = var.description
+  color       = var.color
+  order       = var.order
+  cleanup_auditlogs_on_destroy = var.cleanup_auditlogs_on_destroy
+}