Skip to content

environment.md

Latest commit

 

History

History
61 lines (43 loc) · 1.98 KB

environment.md

File metadata and controls

61 lines (43 loc) · 1.98 KB
Raw
page_title configcat_environment Resource - terraform-provider-configcat
subcategory
description Creates and manages an Environment. What is an Environment in ConfigCat? https://configcat.com/docs/main-concepts

configcat_environment (Resource)

Creates and manages an Environment. What is an Environment in ConfigCat?

Example Usage

variable "product_id" {
  type = string
}

resource "configcat_environment" "my_environment" {
  product_id  = var.product_id
  name        = "Staging"
  description = "Staging description"
  color       = "blue"
  order       = 0
}


output "environment_id" {
  value = configcat_environment.my_environment.id
}

Schema

Required

  • name (String) The name of the Environment.
  • order (Number) The order of the Environment within a Product (zero-based). If multiple Environments has the same order, they are displayed in alphabetical order.
  • product_id (String) The ID of the Product.

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.

Read-Only

  • id (String) The unique ID of the Environment.

Import

Import is supported using the following syntax:

# 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.

terraform import configcat_environment.example 08d86d63-2726-47cd-8bfc-59608ecb91e2