Skip to main content

Playbook

This page is auto-generated from the formations OpenAPI spec. Do not edit manually — run pnpm generate-formations-resource-docs to regenerate.

Creates a playbook — a versioned template of nodes that cases are filled against. An executor's id and a transformation's tool accept a { "ref": … } to a resource in the same template. The version a deploy writes runs as the credential that deployed it, checked as a direct write is: playbooks:CreatePlaybook plus the start action of every executor it names. Only a change to definition archives a new version; a playbook with cases is not deleted. Mirrors the playbooks REST contract.

Syntax​

type: playbook
properties:
  name: String
  description: String
  definition: Any

Output​

The physical resource ID is the public ID of the created resource. Reference it from other resources with a ref expression:

      some_field:
        ref: MyPlaybook

Properties​

name

Human-readable name, unique per project

Required: Yes Type: String

description

What the playbook is for

Required: No Type: String Nullable: Yes

definition

The nodes and how their inputs are sourced

Required: Yes Type: Any