Package software.amazon.awscdk.services.s3vectors

Interface CfnIndex.EncryptionConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIndex.EncryptionConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnIndex

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

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 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-index-encryptionconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnIndex.EncryptionConfigurationProperty.Builder	builder()
default String	getKmsKeyArn()	AWS Key Management Service (KMS) customer managed key ID 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 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

See Also:

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

getSseType

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

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 .

See Also:

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

builder

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

Returns:

a CfnIndex.EncryptionConfigurationProperty.Builder of CfnIndex.EncryptionConfigurationProperty