Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--mongodb-atlas-searchindex.json
Parent schema serverless-framework-configuration
Type: object

Returns, adds, edits, and removes Atlas Search indexes. Also returns and updates user-defined analyzers.. Source:- https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git

Properties

ClusterName string | Aws_CF_FunctionString required

Name of the cluster that contains the database and collection with one or more Application Search indexes.

CollectionName string | Aws_CF_FunctionString required

Human-readable label that identifies the collection that contains one or more Atlas Search indexes.

Database string | Aws_CF_FunctionString required

Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes.

Mappings object required
2 nested properties
Dynamic boolean

Flag that indicates whether the index uses dynamic or static mappings. Required if mappings.fields is omitted.

Fields string[]

One or more field specifications for the Atlas Search index. The element of the array must have the format fieldName:fieldType. Required if mappings.dynamic is omitted or set to false.

Analyzer string | Aws_CF_FunctionString

Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a term or token. This process, known as tokenization, involves a variety of changes made to the text in fields:

  • extracting words
  • removing punctuation
  • removing accents
  • changing to lowercase
  • removing common words
  • reducing words to their root form (stemming)
  • changing words to their base form (lemmatization) MongoDB Cloud uses the selected process to build the Atlas Search index.
Analyzers object[]

List of user-defined methods to convert database field text into searchable words.

Profile string | Aws_CF_FunctionString

The profile is defined in AWS Secret manager. See Secret Manager Profile setup.

ProjectId string | Aws_CF_FunctionString

Unique 24-hexadecimal digit string that identifies your project.

Name string | Aws_CF_FunctionString

Human-readable label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique.

SearchAnalyzer string | Aws_CF_FunctionString

Method applied to identify words when searching this index.

Synonyms object[]

Rule sets that map words to their synonyms in this index.

Definitions

ApiAtlasFTSAnalyzersViewManual object
CharFilters object[]

Filters that examine text one character at a time and perform filtering operations.

Name string | Aws_CF_FunctionString

Human-readable name that identifies the custom analyzer. Names must be unique within an index, and must not start with any of the following strings:

  • lucene.
  • builtin.
  • mongodb.
TokenFilters array

Filter that performs operations such as:

  • Stemming, which reduces related words, such as "talking", "talked", and "talks" to their root word "talk".

  • Redaction, the removal of sensitive information from public documents.

Tokenizer object

Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing.

ApiAtlasFTSMappingsViewManual object
Dynamic boolean

Flag that indicates whether the index uses dynamic or static mappings. Required if mappings.fields is omitted.

Fields string[]

One or more field specifications for the Atlas Search index. The element of the array must have the format fieldName:fieldType. Required if mappings.dynamic is omitted or set to false.

ApiAtlasFTSSynonymMappingDefinitionView object
Analyzer string | Aws_CF_FunctionString

Specific pre-defined method chosen to apply to the synonyms to be searched.

Name string | Aws_CF_FunctionString

Human-readable label that identifies the synonym definition. Each synonym.name must be unique within the same index definition.

Source object
1 nested properties
Collection string | Aws_CF_FunctionString

Human-readable label that identifies the MongoDB collection that stores words and their applicable synonyms.

SynonymSource object
Collection string | Aws_CF_FunctionString

Human-readable label that identifies the MongoDB collection that stores words and their applicable synonyms.