interface IndexProperty

Language	Type name
.NET	`Amazon.CDK.AWS.OpenSearchServerless.CfnIndex.IndexProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsopensearchserverless#CfnIndex_IndexProperty`
Java	`software.amazon.awscdk.services.opensearchserverless.CfnIndex.IndexProperty`
Python	`aws_cdk.aws_opensearchserverless.CfnIndex.IndexProperty`
TypeScript	`aws-cdk-lib` » `aws_opensearchserverless` » `CfnIndex` » `IndexProperty`

An OpenSearch Serverless index resource.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-index.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_opensearchserverless as opensearchserverless } from 'aws-cdk-lib';
const indexProperty: opensearchserverless.CfnIndex.IndexProperty = {
  knn: false,
  knnAlgoParamEfSearch: 123,
  refreshInterval: 'refreshInterval',
};

Properties

Name	Type	Description
knn?	`boolean \|` `IResolvable`	Enable or disable k-nearest neighbor search capability.
knnAlgoParamEfSearch?	`number`	The size of the dynamic list for the nearest neighbors.
refreshInterval?	`string`	How often to perform a refresh operation.

knn?

Type: boolean | IResolvable (optional)

Enable or disable k-nearest neighbor search capability.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-index.html#cfn-opensearchserverless-index-index-knn

knnAlgoParamEfSearch?

Type: number (optional)

The size of the dynamic list for the nearest neighbors.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-index.html#cfn-opensearchserverless-index-index-knnalgoparamefsearch

refreshInterval?

Type: string (optional)

How often to perform a refresh operation.

For example, 1s or 5s.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-index.html#cfn-opensearchserverless-index-index-refreshinterval

AWS CDK