Pulumi project file reference

Every Pulumi program has a project file, Pulumi.yaml, which specifies metadata about your project, such as the project name and language runtime. The project file must begin with a capital P and have an extension of either .yml or .yaml. For more information about Pulumi projects, see the following Pulumi projects overview.

Attributes

About main

For all languages, main can point to a directory to have Pulumi load the program from that directory instead of the directory containing Pulumi.yaml.

Some languages also support using main to point to a specific file to change what the runtime considers the program entrypoint.

• For Node.js projects, main can point to a .ts or .js file and behaves similarly to setting the main attribute in package.json. When the main property is set in Pulumi.yaml, it may be omitted from package.json (and vice-versa). When it exists in both Pulumi.yaml and package.json, the value in Pulumi.yaml takes precedence.

• For Python projects, main can point to a module file (e.g., example.py) and the file will be passed to python.

• For .NET projects, main can point to a .NET project file (e.g., example.csproj) and the file will be passed to dotnet run.

• For YAML projects, main can point to another YAML file (it must be named Main.yaml but it can be in a sub-folder of the project folder) containing the variables, resources, and output properties. The config property can exist in either the Pulumi.yaml or the referenced file.

For all other languages, the actual filename is ignored, and the system behaves as though main referred to the file’s containing directory.

runtime options

The runtime attribute has an additional property called options where you can further specify runtime configuration.

About nodeargs

Arguments specified here are passed to node when running the Pulumi program. For example, nodeargs: "--trace-warnings" will result in node being invoked as node --trace-warnings.

About buildTarget

• For Go
  • If specified, Go sources in $CWD will be compiled with go build to the specified path before being run.
  • If unspecified, Go sources in $CWD will be compiled with go build to a temporary executable that is deleted after running.
  • Cannot be specified with the binary runtime option.

About binary

• For Go, cannot be specified with the buildTarget runtime option.
• For .NET, if not specified, a .NET project in $CWD will be invoked with dotnet run.

About virtualenv

New Python projects created with pulumi new have this option set by default. If not specified, Pulumi will invoke the python3 command it finds on $PATH (falling back to python) to run the Python program. To use a virtual environment without the virtualenv option, run pulumi commands (such as pulumi up) from an activated virtual environment shell. Or, if using a tool like Pipenv, prefix pulumi commands with pipenv run pulumi ....

About typechecker

This option can be set to mypy or pyright. (For additional type checkers, file an issue at https://github.com/pulumi/pulumi/issues.). If set, the given type checker will be invoked to check the Python code before running the Pulumi program.

packages options

packages is a map of package names to either package add arguments or structured package declarations. It specifies the packages that the program is utilizing. The command pulumi install will install these packages and generate the corresponding SDKs for them.

Values

Package declarations

config options

config is a map of config property keys to either values or structured declarations.

Non-object values are allowed to be set directly. Anything more complex must be defined using the structured schema declaration, or the nested value declaration both shown below.

Values

Schemas

Schemas are only valid for project property keys. For setting the value of a provider configuration either use a direct value, or the nested value declaration shown above.

backend options

options options

template options

config

plugins options

Use this option to link to local plugin binaries. This option is intended for use in developing pulumi plugins.

Options for providers, analyzers, and languages

Deprecated attributes

Example project files

Example project file with only required attributes

name: Example Pulumi project file with only required attributes
runtime: nodejs

Example project file with all possible attributes

name: Example Pulumi project file with all possible attributes
runtime: yaml
description: An example project with all attributes
main: example-project/
stackConfigDir: config/
backend:
  url: https://pulumi.example.com
options:
  refresh: always
template:
  displayName: Example Template
  description: An example template
  config:
    aws:region:
      description: The AWS region to deploy into
      default: us-east-1
      secret: true
  metadata:
    cloud: aws
plugins:
  providers:
    - name: aws
      path: ../../bin
  languages:
    - name: yaml
      path: ../../../pulumi-yaml/bin
      version: 1.2.3