Class: AWSCDK::S3Vectors::CfnIndex::EncryptionConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
s3_vectors/cfn_index.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.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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 ID 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.



658
659
660
661
662
663
 
# File 's3_vectors/cfn_index.rb', line 658

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 ID to use for the encryption configuration.

This parameter is allowed if and only if sse_type 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, nil)

See Also:



675
676
677
 
# File 's3_vectors/cfn_index.rb', line 675

def kms_key_arn
  @kms_key_arn
end

#sse_type ⇒ String? (readonly)

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 .

Returns:

  • (String, nil)

See Also:



682
683
684
 
# File 's3_vectors/cfn_index.rb', line 682

def sse_type
  @sse_type
end

Class Method Details

.jsii_properties ⇒ Object 



684
685
686
687
688
689
 
# File 's3_vectors/cfn_index.rb', line 684

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

Instance Method Details

#to_jsii ⇒ Object 



691
692
693
694
695
696
697
698
 
# File 's3_vectors/cfn_index.rb', line 691

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