Class: Aws::S3Vectors::Types::EncryptionConfiguration

Inherits:

Struct

Object
Struct
Aws::S3Vectors::Types::EncryptionConfiguration

show all

Defined in:: gems/aws-sdk-s3vectors/lib/aws-sdk-s3vectors/types.rb

Overview

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.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#kms_key_arn ⇒ String
Amazon Web Services Key Management Service (KMS) customer managed key ID to use for the encryption configuration.
#sse_type ⇒ String
The server-side encryption type to use for the encryption configuration of the vector bucket.

Instance Attribute Details

#kms_key_arn ⇒ `String`

Amazon Web Services 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

Returns:

(String)

# File 'gems/aws-sdk-s3vectors/lib/aws-sdk-s3vectors/types.rb', line 306

class EncryptionConfiguration < Struct.new(
  :sse_type,
  :kms_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#sse_type ⇒ `String`

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.