Class: AWSCDK::S3Vectors::CfnVectorBucket::EncryptionConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::S3Vectors::CfnVectorBucket::EncryptionConfigurationProperty

Defined in:

s3_vectors/cfn_vector_bucket.rb

Overview

Specifies the encryption configuration for the vector bucket.

By default, 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-vectorbucket-encryptionconfiguration.html

Instance Attribute Summary

• #kms_key_arn ⇒ String^? readonly

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

• #sse_type ⇒ String^? readonly

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

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(kms_key_arn: nil, sse_type: nil) ⇒ EncryptionConfigurationProperty constructor

  A new instance of EncryptionConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(kms_key_arn: nil, sse_type: nil) ⇒ EncryptionConfigurationProperty

Returns a new instance of EncryptionConfigurationProperty.

Parameters:

• kms_key_arn (String, nil) (defaults to: nil) —

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

• sse_type (String, nil) (defaults to: nil) —

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

# File 's3_vectors/cfn_vector_bucket.rb', line 581

def initialize(kms_key_arn: nil, sse_type: nil)
  @kms_key_arn = kms_key_arn
  Jsii::Type.check_type(@kms_key_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyArn") unless @kms_key_arn.nil?
  @sse_type = sse_type
  Jsii::Type.check_type(@sse_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sseType") unless @sse_type.nil?
end

Instance Attribute Details

#kms_key_arn ⇒ String^? (readonly)

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

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 Asymmetric keys in AWS KMS in the AWS Key Management Service Developer Guide .

Returns:

• (String, nil)

See Also:

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

# File 's3_vectors/cfn_vector_bucket.rb', line 598

def kms_key_arn
  @kms_key_arn
end

#sse_type ⇒ String^? (readonly)

Note:

Default: - "AES256"

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

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

Returns:

• (String, nil)

See Also:

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

# File 's3_vectors/cfn_vector_bucket.rb', line 606

def sse_type
  @sse_type
end

Class Method Details

.jsii_properties ⇒ Object

# File 's3_vectors/cfn_vector_bucket.rb', line 608

def self.jsii_properties
  {
    :kms_key_arn => "kmsKeyArn",
    :sse_type => "sseType",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 's3_vectors/cfn_vector_bucket.rb', line 615

def to_jsii
  result = {}
  result.merge!({
    "kmsKeyArn" => @kms_key_arn,
    "sseType" => @sse_type,
  })
  result.compact
end