Skip to content

Commit f817848

Browse files
committed
Add secret permissions and keys
1 parent d56188a commit f817848

File tree

1 file changed

+36
-12
lines changed
  • content/operate/rc/databases/rdi

1 file changed

+36
-12
lines changed

content/operate/rc/databases/rdi/setup.md

Lines changed: 36 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -33,18 +33,42 @@ See the [RDI architecture overview]({{< relref "/integrate/redis-data-integratio
3333

3434
You need to share your source database credentials and certificates in an Amazon secret with Redis Cloud so that the pipeline can connect to your database.
3535

36-
In the [AWS Management Console](https://console.aws.amazon.com/), use the **Services** menu to locate and select **Security, Identity, and Compliance** > **Secrets Manager**. [Create a secret](https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_secret.html) of type **Other type of secret** with the following key/value fields:
37-
38-
- `username`: Database username
39-
- `password`: Database password
40-
- `server_certificate`: Server certificate in PEM format *(TLS only)*
41-
- `client_certificate`: [X.509 client certificate](https://en.wikipedia.org/wiki/X.509) or chain in PEM format *(mTLS only)*
42-
- `client_certificate_key`: Key for the client certificate or chain in PEM format *(mTLS only)*
43-
- `client_certificate_passphrase`: Passphrase or password for the client certificate or chain in PEM format *(mTLS only)*
44-
45-
{{<note>}}
46-
If your source database has TLS or mTLS enabled, we recommend that you enter the `server_certificate`, `client_certificate`, and `client_certificate_key` into the secret editor using the **Key/Value** input method instead of the **JSON** input method. Pasting directly into the JSON editor may cause an error.
47-
{{</note>}}
36+
In the [AWS Management Console](https://console.aws.amazon.com/), use the **Services** menu to locate and select **Security, Identity, and Compliance** > **Secrets Manager**. [Create a secret](https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_secret.html) of type **Other type of secret** with the following settings:
37+
38+
- **Key/value pairs**: Enter the following key/value pairs.
39+
40+
- `username`: Database username
41+
- `password`: Database password
42+
- `server_certificate`: Server certificate in PEM format *(TLS only)*
43+
- `client_certificate`: [X.509 client certificate](https://en.wikipedia.org/wiki/X.509) or chain in PEM format *(mTLS only)*
44+
- `client_certificate_key`: Key for the client certificate or chain in PEM format *(mTLS only)*
45+
- `client_certificate_passphrase`: Passphrase or password for the client certificate or chain in PEM format *(mTLS only)*
46+
47+
{{<note>}}
48+
If your source database has TLS or mTLS enabled, we recommend that you enter the `server_certificate`, `client_certificate`, and `client_certificate_key` into the secret editor using the **Key/Value** input method instead of the **JSON** input method. Pasting directly into the JSON editor may cause an error.
49+
{{</note>}}
50+
51+
- **Encryption key**: Select a self-managed encryption key from the list of keys, or select **Add a new key** to [create one](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html).
52+
53+
- **Resource permissions**: Add the following permissions to your secret to allow the Redis data pipeline to access your secret:
54+
55+
```json
56+
{
57+
"Version" : "2012-10-17",
58+
"Statement" : [ {
59+
"Sid" : "RedisDataIntegrationRoleAccess",
60+
"Effect" : "Allow",
61+
"Principal" : "*",
62+
"Action" : [ "secretsmanager:GetSecretValue", "secretsmanager:DescribeSecret" ],
63+
"Resource" : "*",
64+
"Condition" : {
65+
"StringLike" : {
66+
"aws:PrincipalArn" : "arn:aws:iam::984612047909:role/redis-data-pipeline-secrets-role"
67+
}
68+
}
69+
} ]
70+
}
71+
```
4872

4973
After you store this secret, you can view and copy the [Amazon Resource Name (ARN)](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#iam-resources) of your secret on the secret details page.
5074

0 commit comments

Comments
 (0)