interface EncryptionConfigurationProperty

Language	Type name
.NET	Amazon.CDK.AWS.S3Vectors.CfnVectorBucket.EncryptionConfigurationProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awss3vectors#CfnVectorBucket_EncryptionConfigurationProperty
Java	software.amazon.awscdk.services.s3vectors.CfnVectorBucket.EncryptionConfigurationProperty
Python	aws_cdk.aws_s3vectors.CfnVectorBucket.EncryptionConfigurationProperty
TypeScript	aws-cdk-lib » aws_s3vectors » CfnVectorBucket » EncryptionConfigurationProperty

Specifies the encryption configuration for the vector bucket.

By default, all new vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed keys (SSE-S3), specifically AES256.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3vectors-vectorbucket-encryptionconfiguration.html

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.CfnVectorBucket.EncryptionConfigurationProperty = {
  kmsKeyArn: 'kmsKeyArn',
  sseType: 'sseType',
};

Properties

Name	Type	Description
kmsKeyArn?	string	AWS Key Management Service (KMS) customer managed key ARN to use for the encryption configuration.
sseType?	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 ARN to use for the encryption configuration.

This parameter is required if and only if SseType is set to aws:kms .

You must specify the full ARN of the KMS key. Key IDs or key aliases aren't supported.

Amazon S3 Vectors only supports symmetric encryption KMS keys. For more information, see Asymmetric keys in AWS KMS in the AWS Key Management Service Developer Guide .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3vectors-vectorbucket-encryptionconfiguration.html#cfn-s3vectors-vectorbucket-encryptionconfiguration-kmskeyarn

---

sseType?

Type: string (optional, default: "AES256")

The server-side encryption type to use for the encryption configuration of the vector bucket.

Valid values are AES256 for Amazon S3 managed keys and aws:kms for AWS KMS keys.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3vectors-vectorbucket-encryptionconfiguration.html#cfn-s3vectors-vectorbucket-encryptionconfiguration-ssetype