| Name | pulumi-random JSON |
| Version |
4.16.1
JSON |
| download |
| home_page | None |
| Summary | A Pulumi package to safely use randomness in Pulumi programs. |
| upload_time | 2024-04-17 12:36:56 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | Apache-2.0 |
| keywords |
pulumi
random
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://github.com/pulumi/pulumi-random/actions)
[](https://slack.pulumi.com)
[](https://npmjs.com/package/@pulumi/random)
[](https://badge.fury.io/nu/pulumi.random)
[](https://pypi.org/project/pulumi-random)
[](https://pkg.go.dev/github.com/pulumi/pulumi-random/sdk/v4/go)
[](https://github.com/pulumi/pulumi-random/blob/master/LICENSE)
# Random Provider
The random provider allows the safe use of randomness in a Pulumi program. This allows you to generate resource
properties, such as names, that contain randomness in a way that works with Pulumi's goal state oriented approach.
Using randomness as usual would not work well with Pulumi, because by definition, each time the program is evaluated,
a new random state would be produced, necessitating re-convergence on the goal state. This provider understands
how to work with the Pulumi resource lifecycle to accomplish randomness safely and in a way that works as desired.
## Installing
This package is available in many languages in the standard packaging formats.
### Node.js (Java/TypeScript)
To use from JavaScript or TypeScript in Node.js, install using either `npm`:
$ npm install @pulumi/random
or `yarn`:
$ yarn add @pulumi/random
### Python
To use from Python, install using `pip`:
$ pip install pulumi_random
### Go
To use from Go, use `go get` to grab the latest version of the library
$ go get github.com/pulumi/pulumi-random/sdk/v4/go/...
### .NET
To use from .NET, install using `dotnet add package`:
$ dotnet add package Pulumi.Random
## Example
For example, to generate a random password, allocate a `RandomPassword` resource
and then use its `result` output property (of type `Output<string>`) to pass
to another resource.
```typescript
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
import * as random from "@pulumi/random";
const password = new random.RandomPassword("password", {
length: 16,
overrideSpecial: "_%@",
special: true,
});
const example = new aws.rds.Instance("example", {
password: password.result,
});
```
## Reference
For further information, please visit [the random provider docs](https://www.pulumi.com/docs/intro/cloud-providers/random) or for detailed reference documentation, please visit [the API docs](https://www.pulumi.com/docs/reference/pkg/random).
Raw data
{
"_id": null,
"home_page": null,
"name": "pulumi-random",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "pulumi, random",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/7a/08/cc9e613c03a007714ac2ce72b82f3da4722226eaf3573ad164f4a79f605f/pulumi_random-4.16.1.tar.gz",
"platform": null,
"description": "[](https://github.com/pulumi/pulumi-random/actions)\n[](https://slack.pulumi.com)\n[](https://npmjs.com/package/@pulumi/random)\n[](https://badge.fury.io/nu/pulumi.random)\n[](https://pypi.org/project/pulumi-random)\n[](https://pkg.go.dev/github.com/pulumi/pulumi-random/sdk/v4/go)\n[](https://github.com/pulumi/pulumi-random/blob/master/LICENSE)\n\n# Random Provider\n\nThe random provider allows the safe use of randomness in a Pulumi program. This allows you to generate resource\nproperties, such as names, that contain randomness in a way that works with Pulumi's goal state oriented approach.\nUsing randomness as usual would not work well with Pulumi, because by definition, each time the program is evaluated,\na new random state would be produced, necessitating re-convergence on the goal state. This provider understands\nhow to work with the Pulumi resource lifecycle to accomplish randomness safely and in a way that works as desired.\n\n## Installing\n\nThis package is available in many languages in the standard packaging formats.\n\n### Node.js (Java/TypeScript)\n\nTo use from JavaScript or TypeScript in Node.js, install using either `npm`:\n\n $ npm install @pulumi/random\n\nor `yarn`:\n\n $ yarn add @pulumi/random\n\n### Python\n\nTo use from Python, install using `pip`:\n\n $ pip install pulumi_random\n\n### Go\n\nTo use from Go, use `go get` to grab the latest version of the library\n\n $ go get github.com/pulumi/pulumi-random/sdk/v4/go/...\n\n### .NET\n\nTo use from .NET, install using `dotnet add package`:\n\n $ dotnet add package Pulumi.Random\n\n## Example\n\nFor example, to generate a random password, allocate a `RandomPassword` resource\nand then use its `result` output property (of type `Output<string>`) to pass\nto another resource.\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as aws from \"@pulumi/aws\";\nimport * as random from \"@pulumi/random\";\n\nconst password = new random.RandomPassword(\"password\", {\n length: 16,\n overrideSpecial: \"_%@\",\n special: true,\n});\nconst example = new aws.rds.Instance(\"example\", {\n password: password.result,\n});\n```\n\n## Reference\n\nFor further information, please visit [the random provider docs](https://www.pulumi.com/docs/intro/cloud-providers/random) or for detailed reference documentation, please visit [the API docs](https://www.pulumi.com/docs/reference/pkg/random).\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A Pulumi package to safely use randomness in Pulumi programs.",
"version": "4.16.1",
"project_urls": {
"Homepage": "https://pulumi.io",
"Repository": "https://github.com/pulumi/pulumi-random"
},
"split_keywords": [
"pulumi",
" random"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c480052e889c4f94186991f35e98c3bd495026080c1bebd8a54f68928a11a2d2",
"md5": "7b472c5085744d9ddf3c98dfb284191c",
"sha256": "6d5a3a267de0ccb76e34ed362c261492c4c30c7e5ca676f8eb5cfcfc3b3a9d46"
},
"downloads": -1,
"filename": "pulumi_random-4.16.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7b472c5085744d9ddf3c98dfb284191c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 30060,
"upload_time": "2024-04-17T12:36:52",
"upload_time_iso_8601": "2024-04-17T12:36:52.449122Z",
"url": "https://files.pythonhosted.org/packages/c4/80/052e889c4f94186991f35e98c3bd495026080c1bebd8a54f68928a11a2d2/pulumi_random-4.16.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7a08cc9e613c03a007714ac2ce72b82f3da4722226eaf3573ad164f4a79f605f",
"md5": "82ed9481d0979deef582e56a867711f3",
"sha256": "f90fe3f58160802fa87137e7f0415b3204a294b75d8dfa779d64005e65c2fb83"
},
"downloads": -1,
"filename": "pulumi_random-4.16.1.tar.gz",
"has_sig": false,
"md5_digest": "82ed9481d0979deef582e56a867711f3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 20653,
"upload_time": "2024-04-17T12:36:56",
"upload_time_iso_8601": "2024-04-17T12:36:56.121344Z",
"url": "https://files.pythonhosted.org/packages/7a/08/cc9e613c03a007714ac2ce72b82f3da4722226eaf3573ad164f4a79f605f/pulumi_random-4.16.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-17 12:36:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pulumi",
"github_project": "pulumi-random",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pulumi-random"
}
