JSON

JSON is a data type used to save structured data as key-value pairs.

Common usage

Use JSON properties to store structured data, such as:

• Cloud resource tags and Kubernetes labels.
• Service configuration values.
• Structured metadata from an integration.

API definition

JSON properties use "type": "object" without a format field. The following example defines the property in your blueprint; icon, description, and default are optional.

Basic

{
  "myObjectProp": {
    "type": "object",
    "title": "My object"
  }
}

Array

{
  "myObjectArray": {
    "title": "My object array",
    "icon": "My icon",
    "description": "My object array",
    "type": "array",
    "items": {
      "type": "object"
    }
  }
}

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 = {
    object_props = {
      "myObjectProp" = {
        title       = "My object"
        icon        = "My icon"
        description = "My object property"
        default     = jsonencode({ "myKey" = "myValue" })
      }
    }
  }
}

Array

resource "port_blueprint" "myBlueprint" {
  identifier = "myBlueprint"
  title      = "My blueprint"
  properties = {
    array_props = {
      myObjectArray = {
        title        = "My object array"
        object_items = {}
      }
    }
  }
}

Pulumi definition

Basic

Python

"""A Python Pulumi program"""

import pulumi
from port_pulumi import Blueprint,BlueprintPropertiesArgs,BlueprintPropertiesObjectPropsArgs

blueprint = Blueprint(
    "myBlueprint",
    identifier="myBlueprint",
    title="My Blueprint",
    properties=BlueprintPropertiesArgs(
        object_props={
            "myObjectProp": BlueprintPropertiesObjectPropsArgs(
                title="My object", required=False
            )
        }
    ),
    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: {
    objectProps: {
      myObjectProp: {
        title: "My object",
        required: true,
      },
    },
  },
});

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: {
    objectProps: {
      myObjectProp: {
        title: "My object",
        required: true,
      },
    },
  },
  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{
				ObjectProps: port.BlueprintPropertiesObjectPropsMap{
					"myObjectProp": port.BlueprintPropertiesObjectPropsArgs{
						Title:    pulumi.String("My object"),
						Required: pulumi.Bool(false),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		ctx.Export("blueprint", blueprint.Title)
		return nil
	})
}

Validate object

Object validations support the following operators:

• properties - which keys must appear and what their type should be.
• additionalProperties - are keys not defined in properties allowed and what their type should be.
• patternProperties - which regex pattern should properties follow

JSON schema validations

Object validations follow the JSON schema model, refer to the JSON schema docs to learn about all of the available validations

Basic

{
  "myObjectProp": {
    "title": "My object",
    "icon": "My icon",
    "description": "My object property",
    "type": "object",
    "properties": {
      "myRequiredProp": { "type": "number" }
    },
    "patternProperties": {
      "^S_": { "type": "string" },
      "^I_": { "type": "number" }
    },
    "additionalProperties": true
  }
}

Array

{
  "myObjectArray": {
    "title": "My object array",
    "icon": "My icon",
    "description": "My object array",
    "type": "array",
    "items": {
      "type": "object",
      "properties": {
        "myRequiredProp": { "type": "number" }
      },
      "patternProperties": {
        "^S_": { "type": "string" },
        "^I_": { "type": "number" }
      },
      "additionalProperties": true
    }
  }
}