interface VectorIndexProperty

Language	Type name
.NET	Amazon.CDK.AWS.DynamoDB.CfnGlobalTable.VectorIndexProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsdynamodb#CfnGlobalTable_VectorIndexProperty
Java	software.amazon.awscdk.services.dynamodb.CfnGlobalTable.VectorIndexProperty
Python	aws_cdk.aws_dynamodb.CfnGlobalTable.VectorIndexProperty
TypeScript	aws-cdk-lib » aws_dynamodb » CfnGlobalTable » VectorIndexProperty

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-vectorindex.html

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.CfnGlobalTable.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

Name	Type	Description
dimensions	number
distanceFunction	string
indexName	string
projection	IResolvable | ProjectionProperty
vectorAttribute	IResolvable | VectorAttributeProperty
searchSchema?	IResolvable | (IResolvable | SearchSchemaElementProperty)[]

---

dimensions

Type: number

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-vectorindex.html#cfn-dynamodb-globaltable-vectorindex-dimensions

---

distanceFunction

Type: string

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-vectorindex.html#cfn-dynamodb-globaltable-vectorindex-distancefunction

---

indexName

Type: string

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-vectorindex.html#cfn-dynamodb-globaltable-vectorindex-indexname

---

projection

Type: IResolvable | ProjectionProperty

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-vectorindex.html#cfn-dynamodb-globaltable-vectorindex-projection

---

vectorAttribute

Type: IResolvable | VectorAttributeProperty

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-vectorindex.html#cfn-dynamodb-globaltable-vectorindex-vectorattribute

---

searchSchema?

Type: IResolvable | (IResolvable | SearchSchemaElementProperty)[] (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-vectorindex.html#cfn-dynamodb-globaltable-vectorindex-searchschema