Viewing docs for Redis Cloud v1.3.5
published on Wednesday, Dec 20, 2023 by RedisLabs
published on Wednesday, Dec 20, 2023 by RedisLabs
RedisCloud: Installation & Configuration
I want to use the Pulumi Redis Cloud package (rediscloud) in my project.
## Provider details
- Package: rediscloud
- Version: v1.3.5
- Publisher: RedisLabs
- Source: pulumi
- Repository: https://github.com/RedisLabs/pulumi-rediscloud
## 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/redislabs/rediscloud/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/redislabs/rediscloud/versions/latest/readme
- Installation and configuration: https://api.pulumi.com/api/registry/packages/pulumi/redislabs/rediscloud/versions/latest/installation
- Per-resource/function docs: https://api.pulumi.com/api/registry/packages/pulumi/redislabs/rediscloud/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 Redis Cloud v1.3.5
published on Wednesday, Dec 20, 2023 by RedisLabs
published on Wednesday, Dec 20, 2023 by RedisLabs
Installation
The Pulumi Redis Cloud provider is available as a package in the following Pulumi languages:
- JavaScript/TypeScript:
@rediscloud/pulumi-rediscloud - Python:
pulumi_rediscloud - Go:
github.com/RedisLabs/pulumi-rediscloud/sdk/go/rediscloud
Provider Binary
The Redis Cloud provider binary is a third party binary. It can be installed using the pulumi plugin command.
pulumi plugin install resource rediscloud <version> --server github://api.github.com/RedisLabs
Replace the version string with your desired version.
Setup
To provision resources with the Pulumi Redis Cloud provider, you need to have Redis Cloud credentials. Redis 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 Redis Cloud:
$ export REDISCLOUD_ACCESS_KEY=<REDISCLOUD_ACCESS_KEY>
$ export REDISCLOUD_SECRET_KEY=<REDISCLOUD_SECRET_KEY>
$ export REDISCLOUD_ACCESS_KEY=<REDISCLOUD_ACCESS_KEY>
$ export REDISCLOUD_SECRET_KEY=<REDISCLOUD_SECRET_KEY>
> $env:REDISCLOUD_ACCESS_KEY = "<REDISCLOUD_ACCESS_KEY>"
> $env:REDISCLOUD_SECRET_KEY = "<REDISCLOUD_SECRET_KEY>"
Configuration Options
Use pulumi config set rediscloud:<option> or pass options to the constructor of new rediscloud.Provider.
| Option | Environment Variables | Required/Optional | Description |
|---|---|---|---|
apiKey | REDISCLOUD_ACCESS_KEY | Required | Redis Cloud access |
secretKey | REDISCLOUD_SECRET_KEY | Required | Redis Cloud secret key |
Viewing docs for Redis Cloud v1.3.5
published on Wednesday, Dec 20, 2023 by RedisLabs
published on Wednesday, Dec 20, 2023 by RedisLabs
