-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
108 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,100 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "port_folder Resource - terraform-provider-port-labs" | ||
subcategory: "" | ||
description: |- | ||
Folder resource | ||
A full list of the available folder types and their identifiers can be found here https://docs.getport.io/customize-pages-dashboards-and-plugins/folder/catalog-folder. | ||
~> WARNING | ||
The folder resource is currently in beta and is subject to change in future versions. | ||
Use it by setting the Environment Variable PORT_BETA_FEATURES_ENABLED=true. | ||
If this Environment Variable isn't specified, you won't be able to use the resource. | ||
Example Usage | ||
Basic Folder | ||
```hcl | ||
resource "portfolder" "examplefolder" { | ||
sidebaridentifier = "examplesidebar" | ||
folderidentifier = "examplefolder" | ||
title = "Example Folder" | ||
description = "This is an example folder" | ||
} | ||
``` | ||
Folder with Parent | ||
Create a folder inside another folder. | ||
```hcl | ||
resource "portfolder" "childfolder" { | ||
sidebaridentifier = "examplesidebar" | ||
folderidentifier = "childfolder" | ||
parent = portfolder.examplefolder.folder_identifier | ||
title = "Child Folder" | ||
description = "This is a child folder" | ||
} | ||
``` | ||
--- | ||
|
||
# port_folder (Resource) | ||
|
||
# Folder resource | ||
|
||
A full list of the available folder types and their identifiers can be found [here](https://docs.getport.io/customize-pages-dashboards-and-plugins/folder/catalog-folder). | ||
|
||
~> **WARNING** | ||
The folder resource is currently in beta and is subject to change in future versions. | ||
Use it by setting the Environment Variable `PORT_BETA_FEATURES_ENABLED=true`. | ||
If this Environment Variable isn't specified, you won't be able to use the resource. | ||
|
||
## Example Usage | ||
|
||
### Basic Folder | ||
|
||
```hcl | ||
resource "port_folder" "example_folder" { | ||
sidebar_identifier = "example_sidebar" | ||
folder_identifier = "example_folder" | ||
title = "Example Folder" | ||
description = "This is an example folder" | ||
} | ||
``` | ||
|
||
### Folder with Parent | ||
|
||
Create a folder inside another folder. | ||
|
||
```hcl | ||
resource "port_folder" "child_folder" { | ||
sidebar_identifier = "example_sidebar" | ||
folder_identifier = "child_folder" | ||
parent = port_folder.example_folder.folder_identifier | ||
title = "Child Folder" | ||
description = "This is a child folder" | ||
} | ||
``` | ||
|
||
|
||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `folder_identifier` (String) The Identifier of the folder | ||
- `sidebar_identifier` (String) The Identifier of the sidebar | ||
|
||
### Optional | ||
|
||
- `after` (String) The identifier of the folder after which the folder should be placed | ||
- `description` (String) The folder description | ||
- `parent` (String) The identifier of the parent folder | ||
- `title` (String) The title of the folder | ||
|
||
### Read-Only | ||
|
||
- `created_at` (String) The creation date of the folder | ||
- `created_by` (String) The creator of the folder | ||
- `id` (String) The ID of this resource. | ||
- `updated_at` (String) The last update date of the folder | ||
- `updated_by` (String) The last updater of the folder |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters