Skip to content

/AWS1/CL_S3VENCRYPTIONCONF

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

The encryption configuration for a 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.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_ssetype TYPE /AWS1/S3VSSETYPE /AWS1/S3VSSETYPE

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.

iv_kmskeyarn TYPE /AWS1/S3VKMSKEYARN /AWS1/S3VKMSKEYARN

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


Queryable Attributes

sseType

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.

Accessible with the following methods

Method Description
GET_SSETYPE() Getter for SSETYPE, with configurable default
ASK_SSETYPE() Getter for SSETYPE w/ exceptions if field has no value
HAS_SSETYPE() Determine if SSETYPE has a value

kmsKeyArn

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

Accessible with the following methods

Method Description
GET_KMSKEYARN() Getter for KMSKEYARN, with configurable default
ASK_KMSKEYARN() Getter for KMSKEYARN w/ exceptions if field has no value
HAS_KMSKEYARN() Determine if KMSKEYARN has a value