Viewing docs for Upstash v0.5.0
published on Wednesday, Aug 27, 2025 by Upstash
published on Wednesday, Aug 27, 2025 by Upstash
Upstash: Installation & Configuration
I want to use the Pulumi Upstash package (upstash) in my project.
## Provider details
- Package: upstash
- Version: v0.5.0
- Publisher: Upstash
- Source: pulumi
- Repository: https://github.com/upstash/pulumi-upstash
## 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/upstash/upstash/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/upstash/upstash/versions/latest/readme
- Installation and configuration: https://api.pulumi.com/api/registry/packages/pulumi/upstash/upstash/versions/latest/installation
- Per-resource/function docs: https://api.pulumi.com/api/registry/packages/pulumi/upstash/upstash/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 Upstash v0.5.0
published on Wednesday, Aug 27, 2025 by Upstash
published on Wednesday, Aug 27, 2025 by Upstash
Installation
The Pulumi Upstash provider is available as a package in all Pulumi languages:
- JavaScript/TypeScript:
@upstash/pulumi - Go:
github.com/upstash/pulumi-upstash/sdk/go/upstash - Python:
upstash_pulumi
Provider Binary
The Upstash provider can be installed using the pulumi plugin command.
pulumi plugin install resource upstash --server https://github.com/upstash/pulumi-upstash/releases/download/v0.2.0
Setup
To provision resources with the Pulumi Upstash provider, you need to have Upstash credentials. Upstash maintains documentation on how to create API keys here.
Set environment variables
Once you have provisioned these credentials, you can set environment variables to provision resources in Upstash:
$ export UPSTASH_EMAIL=<UPSTASH_EMAIL>
$ export UPSTASH_API_KEY=<UPSTASH_API_KEY>
$ export UPSTASH_EMAIL=<UPSTASH_EMAIL>
$ export UPSTASH_API_KEY=<UPSTASH_API_KEY>
> $env:UPSTASH_EMAIL = "<UPSTASH_EMAIL>"
> $env:UPSTASH_API_KEY = "<UPSTASH_API_KEY>"
Configuration Options
Use pulumi config set upstash:<option> or pass options to the constructor of new upstash.Provider.
| Option | Required/Optional | Description |
|---|---|---|
email | Required | Upstash user email |
apiKey | Required | Upstash Api key |
Viewing docs for Upstash v0.5.0
published on Wednesday, Aug 27, 2025 by Upstash
published on Wednesday, Aug 27, 2025 by Upstash
