Formal Provider: Installation & Configuration

Installation

The Formal provider is available as a package in the following Pulumi languages:

• JavaScript/TypeScript: @formalco/pulumi
• Python: pulumi-formal
• Go: github.com/formalco/pulumi-formal/sdk/go/formal
• .NET: Formal.Pulumi

Provider Binary

The Formal provider plugin is a third-party binary. It can be installed using the pulumi plugin command.

pulumi plugin install resource formal <version> --server github://api.github.com/formalco

Replace the version string <version> with your desired version.

Authentication

The Formal provider must be configured with an API Key in order to deploy Formal resources. See the Formal documentation on API keys here.

Example configuration

Configure your Formal API key (with --secret):

pulumi config set formal:apiKey FORMAL_API_KEY --secret

You should now be able to deploy Formal resources.

Configuration options

The following configuration options are available for the Formal provider:

• formal:apiKey (environment: FORMAL_API_KEY) - The API key used to access the formal control plane.