folder

package
v2.14.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 22, 2025 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var FolderResourceMarkdownDescription = `

# 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" {
  identifier = "example_folder"
  title      = "Example Folder"
}

` + "```" + `

### Folder with Parent

Create a folder inside another folder.

` + "```hcl" + `

resource "port_folder" "child_folder" {
  identifier = "child_folder"
  parent     = port_folder.example_folder.identifier
  title      = "Child Folder"
}

` + "```" + `

### Folder with After

Create a folder after another folder.

` + "```hcl" + `

resource "port_folder" "another_folder" {
  identifier = "another_folder"
  after      = port_folder.example_folder.identifier
  title      = "Another Folder"
}

` + "```" + `

`

Functions

func FolderModelToCLI

func FolderModelToCLI(state *FolderModel) *cli.Folder

func FolderSchema

func FolderSchema() map[string]schema.Attribute

func FolderToPortRequest

func FolderToPortRequest(fm *FolderModel) (*cli.Folder, error)

func NewFolderResource

func NewFolderResource() resource.Resource

Types

type FolderModel

type FolderModel struct {
	ID         types.String `tfsdk:"id"`
	Identifier types.String `tfsdk:"identifier"`
	Title      types.String `tfsdk:"title"`
	After      types.String `tfsdk:"after"`
	Parent     types.String `tfsdk:"parent"`
}

type FolderResource

type FolderResource struct {
	// contains filtered or unexported fields
}

func (*FolderResource) Configure

func (*FolderResource) Create

func (*FolderResource) Delete

func (*FolderResource) ImportState

func (*FolderResource) Metadata

func (*FolderResource) Read

func (*FolderResource) Schema

func (*FolderResource) Update

func (*FolderResource) ValidateConfig

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL