Viewing docs for Upstash v0.5.0
published on Wednesday, Aug 27, 2025 by Upstash
published on Wednesday, Aug 27, 2025 by Upstash
Upstash
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
The Upstash provider for Pulumi can be used to provision Upstash cloud resources such as Upstash Redis, QStash and Vector.
The Upstash provider must be configured with credentials to manage resources in Upstash. Necessary credentials - namely management api keys - can be obtained from Upstash Console.
Example
import * as upstash from "@upstash/pulumi";
const createdDb = new upstash.RedisDatabase("mydb", {
databaseName: "pulumi-ts-db",
region: "global",
primaryRegion: "us-east-1"
tls: true,
multizone: true
})
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/upstash/pulumi-upstash/sdk/go/upstash"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
createdDb, err := upstash.NewRedisDatabase(ctx, "exampleDB", &upstash.RedisDatabaseArgs{
DatabaseName: pulumi.String("pulumi-go-db"),
Region: pulumi.String("global"),
PrimaryRegion: pulumi.String("us-east-1"),
Tls: pulumi.Bool(true),
Multizone: pulumi.Bool(true),
})
if err != nil {
return err
}
ctx.Export("redisDB", createdDb)
return nil
})
}
import upstash_pulumi as upstash
example_db = upstash.RedisDatabase("exampleDB",
database_name="Pulumi DB",
region="global",
primary_region="us-east-1"
tls=True
)
Viewing docs for Upstash v0.5.0
published on Wednesday, Aug 27, 2025 by Upstash
published on Wednesday, Aug 27, 2025 by Upstash
