Viewing docs for Formal v1.1.0
published on Sunday, Mar 1, 2026 by Formal
published on Sunday, Mar 1, 2026 by Formal
Formal Provider: Installation & Configuration
I want to use the Pulumi Formal package (formal) in my project.
## Provider details
- Package: formal
- Version: v1.1.0
- Publisher: Formal
- Source: pulumi
- Repository: https://github.com/formalco/pulumi-formal
## Documentation
The Pulumi Cloud Registry API serves canonical, up-to-date docs for this package — including private packages and every published version. Send the "Accept: text/markdown" header for clean readable content, or "application/json" for structured data.
Start at the navigation tree, which cross-links to the readme, installation guide, and per-resource docs URL template:
- https://api.pulumi.com/api/registry/packages/pulumi/Formal/formal/versions/latest/nav
Returns a summary by default. The full tree can be hundreds of kB for large providers, so prefer targeted search: append "?q=<query>&depth=full" to filter by resource/function title or token (for example "?q=bucket&depth=full"). Only request the full nav without a query if you actually need to enumerate every resource.
Other endpoints:
- Overview and getting started: https://api.pulumi.com/api/registry/packages/pulumi/Formal/formal/versions/latest/readme
- Installation and configuration: https://api.pulumi.com/api/registry/packages/pulumi/Formal/formal/versions/latest/installation
- Per-resource/function docs: https://api.pulumi.com/api/registry/packages/pulumi/Formal/formal/versions/latest/docs/{token}?lang={lang}
Replace {token} with the percent-encoded token from the nav response (for example aws:s3/bucket:Bucket).
Replace {lang} with typescript, python, go, csharp, java, or yaml.
Fetch the installation endpoint above for the correct setup steps — install instructions vary between native providers, bridged Terraform providers, and component packages.
Help me get started using this provider. Show me a complete Pulumi program that provisions a common resource, including all necessary configuration and imports.
Viewing docs for Formal v1.1.0
published on Sunday, Mar 1, 2026 by Formal
published on Sunday, Mar 1, 2026 by Formal
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.
Viewing docs for Formal v1.1.0
published on Sunday, Mar 1, 2026 by Formal
published on Sunday, Mar 1, 2026 by Formal