# Playbook Formation Resource

> Creates a playbook — a versioned template of nodes that cases are filled against.

# 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

```yaml
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:

```yaml
      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

---