AWS::OpenSearchServerless::Index Method - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

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

AWS::OpenSearchServerless::Index Method

Configuration for k-NN search method.

Syntax

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

JSON

{
  "Engine" : String,
  "Name" : String,
  "Parameters" : Parameters,
  "SpaceType" : String
}

YAML

  Engine: String
  Name: String
  Parameters: 
    Parameters
  SpaceType: String

Properties

Engine

The k-NN search engine to use

Required: Yes

Type: String

Allowed values: nmslib | faiss | lucene

Update requires: No interruption

Name

The algorithm name for k-NN search.

Required: Yes

Type: String

Allowed values: hnsw | ivf

Update requires: No interruption

Parameters

Additional parameters for the k-NN algorithm.

Required: No

Type: Parameters

Update requires: No interruption

SpaceType

The distance function used for k-NN search.

Required: No

Type: String

Allowed values: l2 | l1 | linf | cosinesimil | innerproduct | hamming

Update requires: No interruption