aws-cdk-lib.aws_dynamodb.CfnTable.VectorIndexProperty

VectorIndexProperty Struct

Source

Generated code

Type last changed

v2.272.0 · 30 Sep 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_dynamodb as dynamodb } from 'aws-cdk-lib';
const vectorIndexProperty: dynamodb.CfnTable.VectorIndexProperty = {
  dimensions: 123,
  distanceFunction: 'distanceFunction',
  indexName: 'indexName',
  projection: {
    nonKeyAttributes: ['nonKeyAttributes'],
    projectionType: 'projectionType',
  },
  vectorAttribute: {
    attributeName: 'attributeName',
  },

  // the properties below are optional
  searchSchema: [{
    attributeName: 'attributeName',
    searchSchemaElementType: 'searchSchemaElementType',
  }],
};

Properties

dimensionsnumberdimensionsint | floatdimensionsNumberDimensionsdoubleDimensions*float64required#

distanceFunctionstringdistance_functionstrdistanceFunctionStringDistanceFunctionstringDistanceFunction*stringrequired#

indexNamestringindex_namestrindexNameStringIndexNamestringIndexName*stringrequired#

projectionIResolvable | CfnTable.ProjectionPropertyprojectiontyping.Union[IResolvable, ProjectionProperty]projectionIResolvableProjectionIResolvableProjectioninterface{}required#

Represents attributes that are copied (projected) from the table into an index.

These are in addition to the primary key attributes and index key attributes, which are automatically projected.

searchSchema?optionalIResolvable | IResolvable | CfnTable.SearchSchemaElementProperty[]search_schema?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, SearchSchemaElementProperty]]]searchSchema?optionalIResolvableSearchSchema?optionalIResolvableSearchSchema?optionalinterface{}#

vectorAttributeIResolvable | CfnTable.VectorAttributePropertyvector_attributetyping.Union[IResolvable, VectorAttributeProperty]vectorAttributeIResolvableVectorAttributeIResolvableVectorAttributeinterface{}required#