Show / Hide Table of Contents

Interface CfnVectorBucket.IEncryptionConfigurationProperty

Specifies the encryption configuration for the vector bucket.

Namespace: Amazon.CDK.AWS.S3Vectors
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface CfnVectorBucket.IEncryptionConfigurationProperty
Syntax (vb)
Public Interface CfnVectorBucket.IEncryptionConfigurationProperty
Remarks

By default, 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-vectorbucket-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.AWS.S3Vectors;

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

Synopsis

Properties

KmsKeyArn

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

SseType

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

Properties

KmsKeyArn

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

string? KmsKeyArn { get; }
Property Value

string

Remarks

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 <a href="https://docs.aws.amazon.com//kms/latest/developerguide/symmetric-asymmetric.html">Asymmetric keys in AWS KMS</a> in the <em>AWS Key Management Service Developer Guide</em> .

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

SseType

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

string? SseType { get; }
Property Value

string

Remarks

Valid values are AES256 for Amazon S3 managed keys and aws:kms for AWS KMS keys.

Default: - "AES256"

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

Back to top Generated by DocFX