diff --git a/docs/resources/environment_output_configuration_variable.md b/docs/resources/environment_output_configuration_variable.md new file mode 100644 index 00000000..33e57e82 --- /dev/null +++ b/docs/resources/environment_output_configuration_variable.md @@ -0,0 +1,58 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "env0_environment_output_configuration_variable Resource - terraform-provider-env0" +subcategory: "" +description: |- + for additional details check: https://docs.env0.com/docs/environment-outputs +--- + +# env0_environment_output_configuration_variable (Resource) + +for additional details check: https://docs.env0.com/docs/environment-outputs + +## Example Usage + +```terraform +resource "env0_environment_output_configuration_variable" "example" { + name = "name" + scope = "PROJECT" + scope_id = "project_to_assign_to_id" + is_read_only = true + is_required = true + type = "terraform" + description = "description" + output_environment_id = "output_environment_id" + output_name = "my_output_name" +} +``` + + +## Schema + +### Required + +- `name` (String) the name of the variable +- `output_environment_id` (String) the environment id of the output +- `output_name` (String) the name of the output value +- `scope_id` (String) the id of the of the resource to assign to (E.g. the environment id) + +### Optional + +- `description` (String) a description of the variable +- `is_read_only` (Boolean) set to 'true' if the value of this variable cannot be edited in lower scopes (applicable only to 'PROJECT' scope) +- `is_required` (Boolean) set to 'true' if the value of this variable is required in lower scopes +- `scope` (String) the type of resource to assign to. Valid values: 'PROJECT', 'ENVIRONMENT', 'WORKFLOW', and 'DEPLOYMENT'. Default value: 'ENVIRONMENT' +- `type` (String) defaults to 'environment'. Set to 'terraform' to create a terraform output variable + +### Read-Only + +- `id` (String) The ID of this resource. + +## Import + +Import is supported using the following syntax: + +```shell +terraform import env0_environment_output_configuration_variable.by_name '{"Scope": "PROJECT", "ScopeId": "project_id", "name": "variable name"}' +terraform import env0_environment_output_configuration_variable.by_id '{"Scope": "PROJECT", "ScopeId": "project_id", "id": "variable id"}' +```