When you send documents to the index API or file upload API , Vectara will receive both document text and metadata information to be indexed. If you choose the “textless” option for corpus creation, then document text will be indexed (converted into vectors) but not stored anywhere in the platform. Metadata, however, is always stored. For the safety of your data, Vectara always stores your text and metadata in an encrypted format. By default this encryption will use Vectara's own encryption key to encrypt your data (text and/or metadata).
However, for Scale accounts Vectara also allows you to use your own AWS KMS encryption key so that you have full control over how your data is encrypted. If you would like to do so, follow the instructions below.
If you use your own key and at some point disable your AWS KMS key, there is no way to encrypt or decrypt your data so your corpus will not be queryable by anyone until you enable the key back. You can disable and enable your KMS key to resume service but you should be very careful when removing your AWS KMS key as this is a permanently destructive action. If you remove the AWS KMS key entirely, neither you nor Vectara will be able to recover that encryption key, which also means any Vectara corpora depending on that key will be inaccessible forever.
Create your AWS KMS key
KMS keys are only available to Scale plan accounts. If you need help with setting up your customer-managed key, reach out to support
To create an AWS KMS key:
- Go to KMS on the AWS Console
- Select “Customer Managed Keys”
- Select the “Create key” button
- Ensure “Key Type” is “Symmetric” and “Key Usage” is “Encrypt and decrypt”.
- In the “Advanced options”:
- Make sure “KMS” is selected for the “Key material origin”.
- For the regionality:
- Both “Single-Region key” and “Multi-Region key” are ok if the key
is created in the
- If the key is not created in
us-west-2, it needs to be created as a "Multi-Region key." Then, after creating the key, go to the “Regionality” tab and create a replica key in
us-west-2by clicking “Create new replica keys”.
- Both “Single-Region key” and “Multi-Region key” are ok if the key is created in the
- Eventually created key’s ARN should start with
- On the “Define key usage permissions” step of the key creation wizard, you
should see the “Other AWS Accounts” section at the bottom. Enter
941566284283as the AWS ID (this is Vectara's production AWS account ID. You are giving permission to Vectara to use your key to encrypt and decrypt your indexed documents.
- On the last “Review” step, update the following section and
update the ARN from
The key should look like the following:
"Sid": "Allow use of the key",
The final step to creating the AWS KMS key to finish the key creation.
Attach your AWS KMS key to your account
In order to get Vectara to use your key, you must
contact Vectara Support. Send us the ARN for the KMS key
you created (starting with
The Vectara team will set the configuration up for you. In the future, you will be able to set the ARN on the Vectara Console and these instructions will be updated.
How the encryption key works
Once your AWS KMS key is configured in the platform, when encrypting your document text or metadata, Vectara will connect to your KMS service to generate an encryption key. The encryption key provided by the KMS is stored in-memory and used to encrypt and decrypt your data. In-memory key will expire every hour. In turn, every hour Vectara will ask your AWS KMS to generate that encryption key again.