View a markdown version of this page

AWS::OpenSearchServerless::Index PropertyMapping - AWS CloudFormation
SyntaxProperties

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::OpenSearchServerless::Index PropertyMapping

Property mappings for the OpenSearch Serverless index.

Syntax

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

JSON

{
  "Analyzer" : String,
  "CompressionLevel" : String,
  "Dimension" : Integer,
  "Index" : Boolean,
  "Method" : Method,
  "Properties" : {Key: Value, ...},
  "SpaceType" : String,
  "Type" : String,
  "Value" : String
}

YAML

  Analyzer: String
  CompressionLevel: String
  Dimension: Integer
  Index: Boolean
  Method: 
    Method
  Properties: 
    Key: Value
  SpaceType: String
  Type: String
  Value: String

Properties

Analyzer

Property description not available.

Required: No

Type: String

Update requires: No interruption

CompressionLevel

Property description not available.

Required: No

Type: String

Allowed values: 16x | 32x | 8x | 4x | 2x | 1x

Update requires: No interruption

Dimension

Dimension size for vector fields, defines the number of dimensions in the vector.

Required: No

Type: Integer

Update requires: No interruption

Index

Whether a field should be indexed.

Required: No

Type: Boolean

Update requires: No interruption

Method

Configuration for k-NN search method.

Required: No

Type: Method

Update requires: No interruption

Properties

Defines the fields within the mapping, including their types and configurations.

Required: No

Type: Object of PropertyMapping

Update requires: No interruption

SpaceType

Property description not available.

Required: No

Type: String

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

Update requires: No interruption

Type

The field data type. Must be a valid OpenSearch field type.

Required: Yes

Type: String

Allowed values: text | knn_vector | keyword | integer

Update requires: No interruption

Value

Default value for the field when not specified in a document.

Required: No

Type: String

Update requires: No interruption