Class CfnIndexPropsMixin.EncryptionConfigurationProperty

The encryption configuration for a vector bucket or index.

Inheritance
object
CfnIndexPropsMixin.EncryptionConfigurationProperty
Inherited Members
Namespace: Amazon.CDK.Mixins.Preview.AWS.S3Vectors.Mixins
Assembly: Amazon.CDK.Mixins.Preview.dll
Syntax (csharp)
public class CfnIndexPropsMixin.EncryptionConfigurationProperty : CfnIndexPropsMixin.IEncryptionConfigurationProperty
Syntax (vb)
Public Class CfnIndexPropsMixin.EncryptionConfigurationProperty Implements CfnIndexPropsMixin.IEncryptionConfigurationProperty
Remarks

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.

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.S3Vectors.Mixins;

             var encryptionConfigurationProperty = new EncryptionConfigurationProperty {
                 KmsKeyArn = "kmsKeyArn",
                 SseType = "sseType"
             };

Synopsis

Constructors

EncryptionConfigurationProperty()

The encryption configuration for a vector bucket or index.

Properties

KmsKeyArn

AWS Key Management Service (KMS) customer managed key ID to use for the encryption configuration.
SseType

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

Constructors

EncryptionConfigurationProperty()

The encryption configuration for a vector bucket or index.

public EncryptionConfigurationProperty()
Remarks

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.

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.S3Vectors.Mixins;

             var encryptionConfigurationProperty = new EncryptionConfigurationProperty {
                 KmsKeyArn = "kmsKeyArn",
                 SseType = "sseType"
             };

Properties

KmsKeyArn

AWS Key Management Service (KMS) customer managed key ID to use for the encryption configuration.

public string? KmsKeyArn { get; set; }
Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3vectors-index-encryptionconfiguration.html#cfn-s3vectors-index-encryptionconfiguration-kmskeyarn

SseType

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

public string? SseType { get; set; }
Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3vectors-index-encryptionconfiguration.html#cfn-s3vectors-index-encryptionconfiguration-ssetype

Implements