YAML

YAML is a data type used to save object definitions in YAML.

Common usage

Use YAML properties to store the contents of configuration files, such as:

• Kubernetes manifests.
• Helm values files.
• CI/CD pipeline definitions.

API definition

Basic

{
  "myYAMLProp": {
    "title": "My yaml",
    "icon": "My icon",
    "description": "My yaml property",
    "type": "string",
    "format": "yaml"
  }
}

Array

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

Check out Port's API reference to learn more.

Terraform definition

The examples below use version 2.29.0 of the Terraform and Pulumi providers. Configure your provider first, then run one example at a time in its own project. Each example creates a blueprint; use distinct identifiers when you combine examples.

Basic

resource "port_blueprint" "myBlueprint" {
  identifier = "myBlueprint"
  title      = "My blueprint"
  properties = {
    string_props = {
      "myYAMLProp" = {
        title    = "My yaml"
        required = false
        format   = "yaml"
      }
    }
  }
}

Array

resource "port_blueprint" "myBlueprint" {
  identifier = "myBlueprint"
  title      = "My blueprint"
  properties = {
    array_props = {
      "myYAMLArray" = {
        title    = "My yaml array"
        required = false
        string_items = {
          format = "yaml"
        }
      }
    }
  }
}

Pulumi definition

Basic

Python

"""A Python Pulumi program"""

import pulumi
from port_pulumi import Blueprint,BlueprintPropertiesArgs,BlueprintPropertiesStringPropsArgs

blueprint = Blueprint(
    "myBlueprint",
    identifier="myBlueprint",
    title="My Blueprint",
    properties=BlueprintPropertiesArgs(
        string_props={
            "myYAMLProp": BlueprintPropertiesStringPropsArgs(
                title="My yaml",
                required=False,
                format="yaml",
            )
        }
    ),
    relations={}
)

TypeScript

import * as pulumi from "@pulumi/pulumi";
import * as port from "@port-labs/port";

export const blueprint = new port.Blueprint("myBlueprint", {
  identifier: "myBlueprint",
  title: "My Blueprint",
  properties: {
    stringProps: {
      myYAMLProp: {
        title: "My yaml",
        required: false,
        format: "yaml",
      },
    },
  },
});

JavaScript

"use strict";
const pulumi = require("@pulumi/pulumi");
const port = require("@port-labs/port");

const entity = new port.Blueprint("myBlueprint", {
  title: "My Blueprint",
  identifier: "myBlueprint",
  properties: {
    stringProps: {
      myYAMLProp: {
        title: "My yaml",
        required: false,
        format: "yaml",
      },
    },
  },
  relations: {},
});

exports.title = entity.title;

Go

package main

import (
	"github.com/port-labs/pulumi-port/sdk/v2/go/port"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		blueprint, err := port.NewBlueprint(ctx, "myBlueprint", &port.BlueprintArgs{
			Identifier: pulumi.String("myBlueprint"),
			Title:      pulumi.String("My Blueprint"),
			Properties: port.BlueprintPropertiesArgs{
				StringProps: port.BlueprintPropertiesStringPropsMap{
					"myYAMLProp": port.BlueprintPropertiesStringPropsArgs{
						Title:    pulumi.String("My yaml"),
						Required: pulumi.Bool(false),
						Format:   pulumi.String("yaml"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		ctx.Export("blueprint", blueprint.Title)
		return nil
	})
}