mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-22 15:11:07 +02:00
0660ea6fac
* Update README Let contributors know that docs will now be located in UDR * Add comments to each mdx doc Comment has been added to all mdx docs that are not partials * chore: added changelog changelog check failure * wip: removed changelog * Fix content errors * Doc spacing * Update website/content/docs/deploy/kubernetes/vso/helm.mdx Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com> --------- Co-authored-by: jonathanfrappier <92055993+jonathanfrappier@users.noreply.github.com> Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
68 lines
2.6 KiB
Plaintext
68 lines
2.6 KiB
Plaintext
---
|
||
layout: api
|
||
page_title: Redis ElastiCache - Database - Secrets Engines - HTTP API
|
||
description: >-
|
||
The Redis ElastiCache plugin for Vault's database secrets engine generates new passwords for ElastiCache users.
|
||
---
|
||
|
||
> [!IMPORTANT]
|
||
> **Documentation Update:** Product documentation, which were located in this repository under `/website`, are now located in [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs), colocated with all other product documentation. Contributions to this content should be done in the `web-unified-docs` repo, and not this one. Changes made to `/website` content in this repo will not be reflected on the developer.hashicorp.com website.
|
||
|
||
# Redis ElastiCache database plugin HTTP API
|
||
|
||
The Redis ElastiCache database plugin is one of the supported plugins for the database
|
||
secrets engine. This plugin generates static database credentials based on
|
||
configured roles for the Redis ElastiCache database.
|
||
|
||
## Configure connection
|
||
|
||
In addition to the parameters defined by the [Database
|
||
Secrets Engine](/vault/api-docs/secret/databases#configure-connection), this plugin
|
||
has a number of parameters to further configure a connection.
|
||
|
||
| Method | Path |
|
||
| :----- | :----------------------- |
|
||
| `POST` | `/database/config/:name` |
|
||
|
||
### Parameters
|
||
|
||
- `url` `(string: <required>)` – Specifies the primary endpoint to connect to.
|
||
|
||
- `access_key_id` `(string)` – Specifies the IAM `access_key_id` for Vault to use. If omitted, authentication falls back on
|
||
the AWS credentials provider chain and tries to infer authentication from the environment.
|
||
|
||
- `secret_access_key` `(string)` – Specifies the IAM `secret_access_key` corresponding to the given `access_key_id`.
|
||
If omitted, authentication falls back on the AWS credentials provider chain and tries to infer authentication from the environment.
|
||
|
||
- `region` `(string)` – Specifies the AWS region where to ElastiCache cluster is provisioned. If omitted, falls back on
|
||
the context from the environment.
|
||
|
||
### Deprecated parameters
|
||
|
||
- `username` `(string)` – Use `access_key_id` instead, it is strictly equivalent.
|
||
|
||
- `password` `(string)` – Use `secret_access_key` instead, it is strictly equivalent.
|
||
|
||
### Sample payload
|
||
|
||
```json
|
||
{
|
||
"plugin_name": "redis-elasticache-database-plugin",
|
||
"url": "primary-endpoint.my-cluster.xxx.yyy.cache.amazonaws.com:6379",
|
||
"access_key_id": "AKI***",
|
||
"secret_access_key": "ktriNYvULAWLzUmTGb***",
|
||
"region": "us-east-1",
|
||
"allowed-roles": "*"
|
||
}
|
||
```
|
||
|
||
### Sample request
|
||
|
||
```shell-session
|
||
$ curl \
|
||
--header "X-Vault-Token: ..." \
|
||
--request POST \
|
||
--data @payload.json \
|
||
http://127.0.0.1:8200/v1/database/config/my-redis-cluster
|
||
```
|