Set up an AWS Secrets Manager key vault connection
AWS Secrets Manager stores credentials such as passwords and API keys that connectors can retrieve at runtime. Use an AWS Secrets Manager key vault connection when connector credentials are stored in AWS and you want Data Integrity Suite to retrieve them without entering the secret values directly in the connector configuration.
Before you begin:
- You have access to the AWS account where the secrets are stored.
- You know the AWS region where the secrets are stored.
- You have the AWS credentials, IAM role ARN, external ID, or Precisely Agent secret key required by the authentication method that you plan to use.
- Go to .
-
Select Add Key Vault and complete the AWS Secrets Manager fields.
Table 1. AWS Secrets Manager configuration fields Field Description Key Vault Name A display name that identifies the AWS Secrets Manager key vault connection. Description A summary of the key vault purpose or scope. Key Vault Type Select AWS Secrets Manager. Host url The AWS Secrets Manager endpoint. The field is pre-populated with https://secretsmanager.amazonaws.com.Authentication method The method used to authenticate with AWS Secrets Manager. Choose one of the following methods:
- Access Key: Use an AWS access key ID and secret access key.
- Precisely-Managed IAM Role: Allow Precisely to assume an IAM role in your AWS account by using a role ARN and required external ID.
- Customer-Managed IAM Role: Use an AWS access key to assume a customer-managed IAM role in the account that stores the secrets.
- Precisely Agent: Use an agent secret key that is deployed to a registered Precisely Agent.
Region The AWS region where the Secrets Manager secrets are stored. This field is required for all authentication methods except Precisely Agent. Access Key ID The access key ID for the IAM user. This field is required for Access Key and Customer-Managed IAM Role authentication. Secret Access Key The secret access key for the IAM user. This field is required for Access Key and Customer-Managed IAM Role authentication. Customer Role ARN The ARN of the IAM role that Data Integrity Suite assumes to retrieve secrets. This field is required for Precisely-Managed IAM Role and Customer-Managed IAM Role authentication. External ID A unique value that must match the sts:ExternalIdcondition in the IAM role trust policy. This field is required for Precisely-Managed IAM Role authentication and optional for Customer-Managed IAM Role authentication.Agent Secret Key The secret key name deployed to the Precisely Agent. This field is required for Precisely Agent authentication. Test Agent The registered Precisely Agent used to test the key vault connection. - Select Test to validate the key vault connection.
- After the test succeeds, select Add to save the key vault connection.
The AWS Secrets Manager key vault connection is ready to use in connector configurations that support key vault credentials.
Configure AWS IAM permissions
Before configuring the key vault connection, configure the AWS IAM permissions required for your authentication method. For complete setup instructions, including trust policies, permissions policies, and required configuration values, see Configure AWS Secrets Manager authentication methods.
AWS Secrets Manager secret path
When a connector password or credential field references an AWS Secrets Manager secret, enter the complete secret ARN followed by @ and the key name inside the secret.
<complete-secret-arn>@<secret-key>For example:
arn:aws:secretsmanager:us-east-2:12345678:secret:dis/aws-test-DDymHt@snowflake_passwordThe complete secret ARN can be copied directly from your AWS Secrets Manager secret page: AWS Console → Secrets Manager → [your secret] → Secret ARN.