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

Property mappings for the OpenSearch Serverless index.

Syntax

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

JSON

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

YAML

  Dimension: Integer
  Index: Boolean
  Method: 
    Method
  Properties: 
    Key: Value
  Type: String
  Value: String

Properties

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

Type

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

Required: Yes

Type: String

Allowed values: text | knn_vector

Update requires: No interruption

Value

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

Required: No

Type: String

Update requires: No interruption