AWS::S3Vectors::Index MetadataConfiguration - AWS CloudFormation

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::S3Vectors::Index MetadataConfiguration

The metadata configuration for the vector index. This configuration allows you to specify which metadata keys should be treated as non-filterable.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "NonFilterableMetadataKeys" : [ String, ... ] }

Properties

NonFilterableMetadataKeys

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.

Required: No

Type: Array of String

Minimum: 1 | 1

Maximum: 63 | 10

Update requires: Replacement