Pulumi project file

The Pulumi.yaml project file specifies metadata about your project, such as the project name and language runtime for your project.

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:
  description: An example template
  config:
    aws:region:
      description: The AWS region to deploy into
      default: us-east-1
      secret: true
plugins:
  providers:
    - name: aws
      path: ../../bin
  languages:
    - name: yaml
      path: ../../../pulumi-yaml/bin
      version: 1.2.3

Attributes

All attributes

About main

For all languages main can point to a directory to tell Pulumi to use that directory to load the program from instead of the directory with the Pulumi.yaml file. Some languages also support main pointing to a file to change what the runtime considers the entrypoint.

• For NodeJS main can point to a ts or js file and behaves similarly to setting the main attribute in package.json.
• For .NET main can point at a project file (e.g. example.csproj) and will pass that project to dotnet run.
• For Python main can point to a module file (e.g. example.py) and will pass that to python.
• For other languages if a file is specified it is ignored and the system behaves as if the files directory was given to main instead.

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 via go build to the specified path before being run.
  • If unspecified, go sources in $CWD will be compiled via 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 via 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 ....

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