This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.
AWS::DynamoDB::GlobalTable VectorIndex
Contains the configuration settings for a vector index, including the index name, vector attribute, dimensions, distance function, search schema, and projection.
Syntax
To declare this entity in your CloudFormation template, use the following syntax:
JSON
{ "Dimensions" :Integer, "DistanceFunction" :String, "IndexName" :String, "Projection" :Projection, "SearchSchema" :[ SearchSchemaElement, ... ], "VectorAttribute" :VectorAttribute}
YAML
Dimensions:IntegerDistanceFunction:StringIndexName:StringProjection:ProjectionSearchSchema:- SearchSchemaElementVectorAttribute:VectorAttribute
Properties
Dimensions-
The number of dimensions in each vector.
Required: Yes
Type: Integer
Minimum:
1Maximum:
4096Update requires: Updates are not supported.
DistanceFunction-
The distance function used to calculate similarity between vectors. Valid values:
COSINE,EUCLIDEAN,DOT_PRODUCT.Required: Yes
Type: String
Allowed values:
COSINE | DOT_PRODUCT | EUCLIDEANUpdate requires: Updates are not supported.
IndexName-
The name of the vector index.
Required: Yes
Type: String
Pattern:
[a-zA-Z0-9_.-]+Minimum:
3Maximum:
255Update requires: Updates are not supported.
Projection-
Specifies attributes that are copied (projected) from the table into the vector index.
Required: Yes
Type: Projection
Update requires: Updates are not supported.
SearchSchema-
The search schema that defines partition key and inline filter attributes for the vector index.
Every attribute that you reference in
SearchSchemamust also be declared in the table'sAttributeDefinitions, the same way key attributes are declared for a global secondary index. Otherwise, the request fails with aValidationException.Required: No
Type: Array of SearchSchemaElement
Minimum:
1Update requires: Updates are not supported.
VectorAttribute-
The vector attribute configuration for the index.
Required: Yes
Type: VectorAttribute
Update requires: Updates are not supported.
