# Elastic Cloud Resource Provider
The Elastic Cloud Resource Provider lets you manage [Elastic Cloud](https://www.elastic.co/cloud/) resources.
## 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 @pulumi/ec
```
or `yarn`:
```bash
yarn add @pulumi/ec
```
### Python
To use from Python, install using `pip`:
```bash
pip install pulumi_ec
```
### Go
To use from Go, use `go get` to grab the latest version of the library:
```bash
go get github.com/pulumi/pulumi-ec/sdk
```
### .NET
To use from .NET, install using `dotnet add package`:
```bash
dotnet add package Pulumi.ElasticCloud
```
## Configuration
The following configuration points are available for the `ec` provider:
- `ec:endpoint`: The Elastic Cloud endpoint to which requests should be sent. This value should be specified only when using the Elastic Cloud provider with an ECE installation or ESS Private.
- `ec:apikey`: The Elastic Cloud API key, recommended over `username` and `password` to authenticate against the Elastic Cloud API. May also be sourced from environment variable `EC_API_KEY`.
- `ec:username`: The Elastic Cloud username. May also be sourced from environment variable `EC_USER` or `EC_USERNAME`. Conflicts with `ec:apiKey`. Not recommened - prefer using `ec:apikey` over `ec:username` and `ec:password`.
- `ec:password`: The Elastic Cloud user's password. May also be sourced from environment variable `EC_PASS` or `EC_PASSWORD`. Conflicts with `ec:apiKey`. Not recommened - prefer using `ec:apikey` over `ec:username` and `ec:password`.
- `ec:insecure`: If `true`, allows the provider to skip TLS verification (not recommended). Defaults to `false`.
- `ec:timeout`: Allows the user to set a custom timeout in the individual HTTP request level. Defaults to 1 minute (`"1m"`), but can be extended if timeouts are experienced.
- `ec:verbose`: When set to true, it writes a requests.json file in the folder where Terraform runs with all the outgoing HTTP requests and responses. Defaults to false.
- `ec:verboseCredentials`: If set to `true` and `ec:verbose` is set to `true`, the contents of the Authorization header will not be redacted. Defaults to `false`.
- `ec:verboseFile`: Sets the name of the file to which verbose request and response HTTP flow will be written. Defaults to `request.log`.
Either `ec:endpoint` or (`ec:username` and `ec:password`) must be specified. All other parameters are optional:
## Reference
For detailed reference documentation, please visit [the Pulumi registry](https://www.pulumi.com/registry/packages/ec/api-docs/).
Raw data
{
"_id": null,
"home_page": null,
"name": "pulumi-ec",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "pulumi, ec, elasticsearch, es, elastic, elasticcloud",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/5b/5e/c0b02cc1f85aee9a1e93fbc7cb9424135a638e453ea2ca201ab8aef3a4fb/pulumi_ec-0.8.0.tar.gz",
"platform": null,
"description": "# Elastic Cloud Resource Provider\n\nThe Elastic Cloud Resource Provider lets you manage [Elastic Cloud](https://www.elastic.co/cloud/) resources.\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 @pulumi/ec\n```\n\nor `yarn`:\n\n```bash\nyarn add @pulumi/ec\n```\n\n### Python\n\nTo use from Python, install using `pip`:\n\n```bash\npip install pulumi_ec\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/pulumi/pulumi-ec/sdk\n```\n\n### .NET\n\nTo use from .NET, install using `dotnet add package`:\n\n```bash\ndotnet add package Pulumi.ElasticCloud\n```\n\n## Configuration\n\nThe following configuration points are available for the `ec` provider:\n\n- `ec:endpoint`: The Elastic Cloud endpoint to which requests should be sent. This value should be specified only when using the Elastic Cloud provider with an ECE installation or ESS Private.\n- `ec:apikey`: The Elastic Cloud API key, recommended over `username` and `password` to authenticate against the Elastic Cloud API. May also be sourced from environment variable `EC_API_KEY`.\n- `ec:username`: The Elastic Cloud username. May also be sourced from environment variable `EC_USER` or `EC_USERNAME`. Conflicts with `ec:apiKey`. Not recommened - prefer using `ec:apikey` over `ec:username` and `ec:password`.\n- `ec:password`: The Elastic Cloud user's password. May also be sourced from environment variable `EC_PASS` or `EC_PASSWORD`. Conflicts with `ec:apiKey`. Not recommened - prefer using `ec:apikey` over `ec:username` and `ec:password`.\n- `ec:insecure`: If `true`, allows the provider to skip TLS verification (not recommended). Defaults to `false`.\n- `ec:timeout`: Allows the user to set a custom timeout in the individual HTTP request level. Defaults to 1 minute (`\"1m\"`), but can be extended if timeouts are experienced.\n- `ec:verbose`: When set to true, it writes a requests.json file in the folder where Terraform runs with all the outgoing HTTP requests and responses. Defaults to false.\n- `ec:verboseCredentials`: If set to `true` and `ec:verbose` is set to `true`, the contents of the Authorization header will not be redacted. Defaults to `false`.\n- `ec:verboseFile`: Sets the name of the file to which verbose request and response HTTP flow will be written. Defaults to `request.log`.\n\nEither `ec:endpoint` or (`ec:username` and `ec:password`) must be specified. All other parameters are optional:\n\n## Reference\n\nFor detailed reference documentation, please visit [the Pulumi registry](https://www.pulumi.com/registry/packages/ec/api-docs/).\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A Pulumi package for creating and managing ElasticCloud resources.",
"version": "0.8.0",
"project_urls": {
"Homepage": "https://pulumi.io",
"Repository": "https://github.com/pulumi/pulumi-ec"
},
"split_keywords": [
"pulumi",
" ec",
" elasticsearch",
" es",
" elastic",
" elasticcloud"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "37bbd98f061bf96ed50a193dba1f584a9b5af159e0b79e4827257d04a65f21cb",
"md5": "479866a01659216095aa96f4cb25c73c",
"sha256": "618b5d076de149564310e2f8069e450630a9a623bb5be98dfa0e5cb2cb87d4f4"
},
"downloads": -1,
"filename": "pulumi_ec-0.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "479866a01659216095aa96f4cb25c73c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 77065,
"upload_time": "2024-04-04T09:46:07",
"upload_time_iso_8601": "2024-04-04T09:46:07.038617Z",
"url": "https://files.pythonhosted.org/packages/37/bb/d98f061bf96ed50a193dba1f584a9b5af159e0b79e4827257d04a65f21cb/pulumi_ec-0.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5b5ec0b02cc1f85aee9a1e93fbc7cb9424135a638e453ea2ca201ab8aef3a4fb",
"md5": "df362d0256cbaaba5668e72eaaf0347c",
"sha256": "14bcaa4ddecfd4a92f666ab7ffe35e85fb9c4182e829f3be383f81cbf8ffbd5e"
},
"downloads": -1,
"filename": "pulumi_ec-0.8.0.tar.gz",
"has_sig": false,
"md5_digest": "df362d0256cbaaba5668e72eaaf0347c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 59731,
"upload_time": "2024-04-04T09:46:09",
"upload_time_iso_8601": "2024-04-04T09:46:09.043526Z",
"url": "https://files.pythonhosted.org/packages/5b/5e/c0b02cc1f85aee9a1e93fbc7cb9424135a638e453ea2ca201ab8aef3a4fb/pulumi_ec-0.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-04 09:46:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pulumi",
"github_project": "pulumi-ec",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pulumi-ec"
}
JSON
