Package software.amazon.awscdk.services.s3vectors

Interface CfnVectorBucket.EncryptionConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnVectorBucket.EncryptionConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnVectorBucket

@Stability(Stable)
public static interface CfnVectorBucket.EncryptionConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.s3vectors.*;
 EncryptionConfigurationProperty encryptionConfigurationProperty = EncryptionConfigurationProperty.builder()
         .kmsKeyArn("kmsKeyArn")
         .sseType("sseType")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnVectorBucket.EncryptionConfigurationProperty.Builder	A builder for CfnVectorBucket.EncryptionConfigurationProperty
static final class	CfnVectorBucket.EncryptionConfigurationProperty.Jsii$Proxy	An implementation for CfnVectorBucket.EncryptionConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnVectorBucket.EncryptionConfigurationProperty.Builder	builder()
default String	getKmsKeyArn()	AWS Key Management Service (KMS) customer managed key ARN to use for the encryption configuration.
default String	getSseType()	The server-side encryption type to use for the encryption configuration of the vector bucket.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getKmsKeyArn

@Stability(Stable)
@Nullable
default String getKmsKeyArn()

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

getSseType

@Stability(Stable)
@Nullable
default String getSseType()

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.

Default: - "AES256"

See Also:

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

builder

@Stability(Stable)
static CfnVectorBucket.EncryptionConfigurationProperty.Builder builder()

Returns:

a CfnVectorBucket.EncryptionConfigurationProperty.Builder of CfnVectorBucket.EncryptionConfigurationProperty