# Upstash Resource Provider
The Upstash Pulumi Provider lets you manage [Upstash](http://upstash.com) Redis and Kafka resources programatically.
## Installing
This package is available for several languages/platforms:
### Node.js (JavaScript/TypeScript)
To use from JavaScript or TypeScript in Node.js, install using either `npm`:
```bash
npm install @upstash/pulumi
```
or `yarn`:
```bash
yarn add @upstash/pulumi
```
### Python
To use from Python, install using `pip`:
```bash
pip install upstash_pulumi
```
### Go
To use from Go, use `go get` to grab the latest version of the library:
```bash
go get github.com/upstash/pulumi-upstash/sdk/go/...
```
## Configuration
The following configuration points are available for the `upstash` provider:
- `upstash:apiKey` (environment: `UPSTASH_API_KEY`) - the API key for `upstash`. Can be obtained from the [console](https://console.upstash.com).
- `upstash:email` (environment: `UPSTASH_EMAIL`) - owner email of the resources
## Some Examples
### TypeScript:
```
import * as pulumi from "@pulumi/pulumi";
import * as upstash from "@upstash/pulumi";
// multiple redis databases in a single for loop
for (let i = 0; i < 5; i++) {
new upstash.RedisDatabase("mydb" + i, {
databaseName: "pulumi-ts-db" + i,
region: "eu-west-1",
tls: true
})
}
```
### Go:
```
package main
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 {
createdTeam, err := upstash.NewTeam(ctx, "exampleTeam", &upstash.TeamArgs{
TeamName: pulumi.String("pulumi go team"),
CopyCc: pulumi.Bool(false),
TeamMembers: pulumi.StringMap{
"<owner-email>": pulumi.String("owner"),
"<some-other-user-email>": pulumi.String("dev"),
},
})
if err != nil {
return err
}
return nil
})
}
```
### Python:
```
import pulumi
import upstash_pulumi as upstash
created_cluster = upstash.KafkaCluster(
resource_name="myCluster",
cluster_name="pulumi-python-cluster",
multizone=False,
region="eu-west-1"
)
```
## Reference
For reference, please look into `/examples` directory for resource management using different languages. You can also visit [developer api docs](https://developer.upstash.com/) to see parameters and their behaviors.
Raw data
{
"_id": null,
"home_page": "https://www.upstash.com",
"name": "upstash-pulumi",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "pulumi upstash category/cloud",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/9d/31/5a77464ccbd6d1700fc5bdaf90e68304f2a6602ff3e3a5ea77a01181eb43/upstash_pulumi-0.3.14.tar.gz",
"platform": null,
"description": "# Upstash Resource Provider\n\nThe Upstash Pulumi Provider lets you manage [Upstash](http://upstash.com) Redis and Kafka resources programatically.\n\n## Installing\n\nThis package is available for several languages/platforms:\n\n### Node.js (JavaScript/TypeScript)\n\nTo use from JavaScript or TypeScript in Node.js, install using either `npm`:\n\n```bash\nnpm install @upstash/pulumi\n```\n\nor `yarn`:\n\n```bash\nyarn add @upstash/pulumi\n```\n\n### Python\n\nTo use from Python, install using `pip`:\n\n```bash\npip install upstash_pulumi\n```\n\n### Go\n\nTo use from Go, use `go get` to grab the latest version of the library:\n\n```bash\ngo get github.com/upstash/pulumi-upstash/sdk/go/...\n```\n\n## Configuration\n\nThe following configuration points are available for the `upstash` provider:\n\n- `upstash:apiKey` (environment: `UPSTASH_API_KEY`) - the API key for `upstash`. Can be obtained from the [console](https://console.upstash.com).\n- `upstash:email` (environment: `UPSTASH_EMAIL`) - owner email of the resources\n\n## Some Examples\n\n### TypeScript:\n```\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as upstash from \"@upstash/pulumi\";\n\n// multiple redis databases in a single for loop\n\nfor (let i = 0; i < 5; i++) {\n new upstash.RedisDatabase(\"mydb\" + i, {\n databaseName: \"pulumi-ts-db\" + i,\n region: \"eu-west-1\",\n tls: true\n })\n}\n\n```\n\n### Go:\n```\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/upstash/pulumi-upstash/sdk/go/upstash\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\n\t\tcreatedTeam, err := upstash.NewTeam(ctx, \"exampleTeam\", &upstash.TeamArgs{\n\t\t\tTeamName: pulumi.String(\"pulumi go team\"),\n\t\t\tCopyCc: pulumi.Bool(false),\n\t\t\tTeamMembers: pulumi.StringMap{\n\t\t\t\t\"<owner-email>\": pulumi.String(\"owner\"),\n\t\t\t\t\"<some-other-user-email>\": pulumi.String(\"dev\"),\n\t\t\t},\n\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n\n```\n\n\n### Python: \n```\nimport pulumi\nimport upstash_pulumi as upstash\n\ncreated_cluster = upstash.KafkaCluster(\n resource_name=\"myCluster\",\n cluster_name=\"pulumi-python-cluster\",\n multizone=False,\n region=\"eu-west-1\"\n)\n```\n\n## Reference\n\nFor reference, please look into `/examples` directory for resource management using different languages. You can also visit [developer api docs](https://developer.upstash.com/) to see parameters and their behaviors.\n\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A Pulumi package for creating and managing upstash cloud resources.",
"version": "0.3.14",
"project_urls": {
"Homepage": "https://www.upstash.com",
"Repository": "https://github.com/upstash/pulumi-upstash"
},
"split_keywords": [
"pulumi",
"upstash",
"category/cloud"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9d315a77464ccbd6d1700fc5bdaf90e68304f2a6602ff3e3a5ea77a01181eb43",
"md5": "49bd7e6c73f8f099baae74e5cebc1d74",
"sha256": "03573df8da2ef604726ba64e376e06984be2b1e865685e82b417357a559583ac"
},
"downloads": -1,
"filename": "upstash_pulumi-0.3.14.tar.gz",
"has_sig": false,
"md5_digest": "49bd7e6c73f8f099baae74e5cebc1d74",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 36664,
"upload_time": "2024-08-09T15:00:42",
"upload_time_iso_8601": "2024-08-09T15:00:42.831430Z",
"url": "https://files.pythonhosted.org/packages/9d/31/5a77464ccbd6d1700fc5bdaf90e68304f2a6602ff3e3a5ea77a01181eb43/upstash_pulumi-0.3.14.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-09 15:00:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "upstash",
"github_project": "pulumi-upstash",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "upstash-pulumi"
}
JSON
