Schema registry

Pulumi

Pulumi project metadata and configuration

Pulumi.yamlpulumi.yaml

Validate

Check your file against this schema

Opens the validator with this schema already loaded. Paste your Pulumi.yaml and it validates in your browser — nothing is uploaded.

Validate a Pulumi.yaml → View raw schema

Reference

Fields

Generated directly from the schema, following local $refs, to two levels of nesting.

Field	Type	Description
`name`required	`string`	Name of the project containing alphanumeric characters, hyphens, underscores, and periods.
`description`	`string \| null`	Description of the project.
`author`	`string \| null`	Author is an optional author that created this project.
`website`	`string \| null`	Website is an optional website for additional info about this project.
`license`	`string \| null`	License is the optional license governing this project's usage.
`runtime`required	`oneOf`	—
`main`	`string \| null`	Path to the Pulumi program. The default is the working directory.
`config`	`object \| null`	A map of configuration keys to their types. Using config directory location relative to the location of Pulumi.yaml is a deprecated use of this key. Use stackConfigDir instead.
`config.secret`	`boolean`	If true this configuration value should be encrypted. default: `false`
`stackConfigDir`	`string \| null`	Config directory location relative to the location of Pulumi.yaml.
`backend`	`object \| null`	Backend of the project.
`backend.url`	`string`	URL is optional field to explicitly set backend url
`options`	`object \| null`	Additional project options.
`options.refresh`	`string`	Set to "always" to refresh the state before performing a Pulumi operation.
`template`	`object \| null`	ProjectTemplate is a Pulumi project template manifest.
`template.description`	`string \| null`	Description of the template.
`template.quickstart`	`string \| null`	Quickstart contains optional text to be displayed after template creation.
`template.important`	`boolean \| null`	Important indicates the template is important and should be listed by default.
`template.config`	`object \| null`	Config to apply to each stack in the project.
`plugins`	`object`	Override for the plugin selection. Intended for use in developing pulumi plugins.
`plugins.providers`	`array`	Plugins for resource providers.
`plugins.analyzers`	`array`	Plugins for policy analyzers.
`plugins.languages`	`array`	Plugins for languages.

Audit

What we found in this schema

Declared draft: draft-07
Validates cleanly against its own meta-schema.
40 properties, 70% carrying a description, max nesting depth 9.

Standards

Specification sections for the keywords in this schema

Keyword	Document	Section
`$defs`	JSON Schema Core, draft 2020-12	§8.2.4 — Schema Re-Use With "$defs"
`$id`	JSON Schema Core, draft 2020-12	§8.2.1 — The "$id" Keyword
`$ref`	JSON Schema Core, draft 2020-12	§8.2.3.1 — Direct References with "$ref"
`$schema`	JSON Schema Core, draft 2020-12	§8.1.1 — "$schema"
`additionalProperties`	JSON Schema Core, draft 2020-12	§10.3.2.3 — "additionalProperties"
`const`	JSON Schema Validation, draft 2020-12	§6.1.3 — "const"
`default`	JSON Schema Validation, draft 2020-12	§9.2 — "default"
`description`	JSON Schema Validation, draft 2020-12	§9.1 — "title" and "description"
`enum`	JSON Schema Validation, draft 2020-12	§6.1.2 — "enum"
`if`	JSON Schema Core, draft 2020-12	§10.2.2.1 — "if"
`items`	JSON Schema Core, draft 2020-12	§10.3.1.2 — "items"
`minLength`	JSON Schema Validation, draft 2020-12	§6.3.2 — "minLength"
`oneOf`	JSON Schema Core, draft 2020-12	§10.2.1.3 — "oneOf"
`properties`	JSON Schema Core, draft 2020-12	§10.3.2.1 — "properties"
`required`	JSON Schema Validation, draft 2020-12	§6.5.3 — "required"
`then`	JSON Schema Core, draft 2020-12	§10.2.2.2 — "then"
`type`	JSON Schema Validation, draft 2020-12	§6.1.1 — "type"

Documents

JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.

Source

Attribution

This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.

← All schemas