Package software.amazon.awscdk.services.s3vectors

Interface CfnIndex.MetadataConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIndex.MetadataConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnIndex

@Stability(Stable)
public static interface CfnIndex.MetadataConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

The metadata configuration for the vector index.

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.s3vectors.*;
 MetadataConfigurationProperty metadataConfigurationProperty = MetadataConfigurationProperty.builder()
         .nonFilterableMetadataKeys(List.of("nonFilterableMetadataKeys"))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnIndex.MetadataConfigurationProperty.Builder	A builder for CfnIndex.MetadataConfigurationProperty
static final class	CfnIndex.MetadataConfigurationProperty.Jsii$Proxy	An implementation for CfnIndex.MetadataConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnIndex.MetadataConfigurationProperty.Builder	builder()
default List<String>	getNonFilterableMetadataKeys()	Non-filterable metadata keys allow you to enrich vectors with additional context during storage and retrieval.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getNonFilterableMetadataKeys

@Stability(Stable)
@Nullable
default List<String> getNonFilterableMetadataKeys()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3vectors-index-metadataconfiguration.html#cfn-s3vectors-index-metadataconfiguration-nonfilterablemetadatakeys

builder

@Stability(Stable)
static CfnIndex.MetadataConfigurationProperty.Builder builder()

Returns:

a CfnIndex.MetadataConfigurationProperty.Builder of CfnIndex.MetadataConfigurationProperty