Yaml

Yaml is an input used to save object definitions in YAML.

💡 Common yaml usage

The yaml input type can be used to store any key/value based data, for example:

• Configurations
• Helm charts
• Dictionaries/Hash maps
• Manifests
• values.yml

API definition

Basic

{
  "myYamlInput": {
    "title": "My yaml input",
    "icon": "My icon",
    "description": "My yaml input",
    "type": "string",
    "format": "yaml"
  }
}

Array

{
  "myYamlArrayInput": {
    "title": "My yaml array input",
    "icon": "My icon",
    "description": "My yaml array input",
    "type": "array",
    "items": {
      "type": "string",
      "format": "yaml"
    }
  }
}

Check out Port's API reference to learn more.

Terraform definition

Basic

resource "port_action" "myAction" {
  # ...action properties
  user_properties = {
    string_props = {
      "myYamlInput" = {
        title       = "My yaml input"
        description = "My yaml input"
      }
    }
  }
}

Array

resource "port_action" "myAction" {
  # ...action properties
  user_properties = {
    array_props = {
      "myYamlArrayInput" = {
        title       = "My yaml array input"
        description = "My yaml array input"
        string_items = {
          format = "yaml"
        }
      }
    }
  }
}