Class: AWSCDK::S3Vectors::CfnIndex::MetadataConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
s3_vectors/cfn_index.rb

Overview

The metadata configuration for the vector index.

This configuration allows you to specify which metadata keys should be treated as non-filterable.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(non_filterable_metadata_keys: nil) ⇒ MetadataConfigurationProperty

Returns a new instance of MetadataConfigurationProperty.

Parameters:

  • non_filterable_metadata_keys (Array<String>, nil) (defaults to: nil) —

    Non-filterable metadata keys allow you to enrich vectors with additional context during storage and retrieval.



710
711
712
713
 
# File 's3_vectors/cfn_index.rb', line 710

def initialize(non_filterable_metadata_keys: nil)
  @non_filterable_metadata_keys = non_filterable_metadata_keys
  Jsii::Type.check_type(@non_filterable_metadata_keys, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "nonFilterableMetadataKeys") unless @non_filterable_metadata_keys.nil?
end

Instance Attribute Details

#non_filterable_metadata_keys ⇒ Array<String>? (readonly)

Non-filterable metadata keys allow you to enrich vectors with additional context during storage and retrieval.

Unlike default metadata keys, these keys can't be used as query filters. Non-filterable metadata keys can be retrieved but can't be searched, queried, or filtered. You can access non-filterable metadata keys of your vectors after finding the vectors.

You can specify 1 to 10 non-filterable metadata keys. Each key must be 1 to 63 characters long.

Returns:

  • (Array<String>, nil)

See Also:



723
724
725
 
# File 's3_vectors/cfn_index.rb', line 723

def non_filterable_metadata_keys
  @non_filterable_metadata_keys
end

Class Method Details

.jsii_properties ⇒ Object 



725
726
727
728
729
 
# File 's3_vectors/cfn_index.rb', line 725

def self.jsii_properties
  {
    :non_filterable_metadata_keys => "nonFilterableMetadataKeys",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



731
732
733
734
735
736
737
 
# File 's3_vectors/cfn_index.rb', line 731

def to_jsii
  result = {}
  result.merge!({
    "nonFilterableMetadataKeys" => @non_filterable_metadata_keys,
  })
  result.compact
end