terraform-provider-stackitp.../docs/resources/resourcemanager_folder.md

61 lines
2.4 KiB
Markdown

---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "stackit_resourcemanager_folder Resource - stackit"
subcategory: ""
description: |-
Resource Manager folder resource schema.
---
# stackit_resourcemanager_folder (Resource)
Resource Manager folder resource schema.
## Example Usage
```terraform
resource "stackit_resourcemanager_folder" "example" {
name = "example-folder"
owner_email = "foo.bar@stackit.cloud"
parent_container_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
# Note:
# You can add projects under folders.
# However, when deleting a project, be aware:
# - Projects may remain "invisible" for up to 7 days after deletion
# - During this time, deleting the parent folder may fail because the project is still technically linked
resource "stackit_resourcemanager_project" "example_project" {
name = "example-project"
owner_email = "foo.bar@stackit.cloud"
parent_container_id = stackit_resourcemanager_folder.example.container_id
}
# Only use the import statement, if you want to import an existing resourcemanager folder
# Note: There will be a conflict which needs to be resolved manually.
# Must set a configuration value for the owner_email attribute as the provider has marked it as required.
import {
to = stackit_resourcemanager_folder.import-example
id = var.container_id
}
```
<!-- schema generated by tfplugindocs -->
## Schema
### Required
- `name` (String) The name of the folder.
- `owner_email` (String) Email address of the owner of the folder. This value is only considered during creation. Changing it afterwards will have no effect.
- `parent_container_id` (String) Parent resource identifier. Both container ID (user-friendly) and UUID are supported.
### Optional
- `labels` (Map of String) Labels are key-value string pairs which can be attached to a resource container. A label key must match the regex [A-ZÄÜÖa-zäüöß0-9_-]{1,64}. A label value must match the regex ^$|[A-ZÄÜÖa-zäüöß0-9_-]{1,64}.
### Read-Only
- `container_id` (String) Folder container ID. Globally unique, user-friendly identifier.
- `creation_time` (String) Date-time at which the folder was created.
- `folder_id` (String) Folder UUID identifier. Globally unique folder identifier
- `id` (String) Terraform's internal resource ID. It is structured as "`container_id`".
- `update_time` (String) Date-time at which the folder was last modified.