interface EncryptionConfigurationProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.S3Vectors.CfnIndex.EncryptionConfigurationProperty |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awss3vectors#CfnIndex_EncryptionConfigurationProperty |
 Java | software.amazon.awscdk.services.s3vectors.CfnIndex.EncryptionConfigurationProperty |
 Python | aws_cdk.aws_s3vectors.CfnIndex.EncryptionConfigurationProperty |
 TypeScript | aws-cdk-lib » aws_s3vectors » CfnIndex » EncryptionConfigurationProperty |
The encryption configuration for a vector bucket or index.
By default, if you don't specify, all new vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed keys (SSE-S3), specifically AES256 . You can optionally override bucket level encryption settings, and set a specific encryption configuration for a vector index at the time of index creation.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_s3vectors as s3vectors } from 'aws-cdk-lib';
const encryptionConfigurationProperty: s3vectors.CfnIndex.EncryptionConfigurationProperty = {
kmsKeyArn: 'kmsKeyArn',
sseType: 'sseType',
};
Properties
| Name | Type | Description |
|---|---|---|
| kms | string | AWS Key Management Service (KMS) customer managed key ID to use for the encryption configuration. |
| sse | string | The server-side encryption type to use for the encryption configuration of the vector bucket. |
kmsKeyArn?
Type:
string
(optional)
AWS Key Management Service (KMS) customer managed key ID to use for the encryption configuration.
This parameter is allowed if and only if sseType is set to aws:kms .
To specify the KMS key, you must use the format of the KMS key Amazon Resource Name (ARN).
For example, specify Key ARN in the following format: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
sseType?
Type:
string
(optional)
The server-side encryption type to use for the encryption configuration of the vector bucket.
By default, if you don't specify, all new vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed keys (SSE-S3), specifically AES256 .