Docs
Packages
MongoDB Atlas v3.7.2, Mar 31 23
MongoDB Atlas v3.7.2, Mar 31 23
mongodbatlas.SearchIndex
Explore with Pulumi AI
mongodbatlas.SearchIndex provides a Search Index resource. This allows indexes to be created.
Example Usage
Basic
using System.Collections.Generic;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;
return await Deployment.RunAsync(() =>
{
var test = new Mongodbatlas.SearchIndex("test", new()
{
Analyzer = "lucene.standard",
ClusterName = "<CLUSTER_NAME>",
CollectionName = "collection_test",
Database = "database_test",
MappingsDynamic = true,
ProjectId = "<PROJECT_ID>",
SearchAnalyzer = "lucene.standard",
});
});
package main
import (
"github.com/pulumi/pulumi-mongodbatlas/sdk/v3/go/mongodbatlas"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := mongodbatlas.NewSearchIndex(ctx, "test", &mongodbatlas.SearchIndexArgs{
Analyzer: pulumi.String("lucene.standard"),
ClusterName: pulumi.String("<CLUSTER_NAME>"),
CollectionName: pulumi.String("collection_test"),
Database: pulumi.String("database_test"),
MappingsDynamic: pulumi.Bool(true),
ProjectId: pulumi.String("<PROJECT_ID>"),
SearchAnalyzer: pulumi.String("lucene.standard"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.SearchIndex;
import com.pulumi.mongodbatlas.SearchIndexArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var test = new SearchIndex("test", SearchIndexArgs.builder()
.analyzer("lucene.standard")
.clusterName("<CLUSTER_NAME>")
.collectionName("collection_test")
.database("database_test")
.mappingsDynamic(true)
.projectId("<PROJECT_ID>")
.searchAnalyzer("lucene.standard")
.build());
}
}
import pulumi
import pulumi_mongodbatlas as mongodbatlas
test = mongodbatlas.SearchIndex("test",
analyzer="lucene.standard",
cluster_name="<CLUSTER_NAME>",
collection_name="collection_test",
database="database_test",
mappings_dynamic=True,
project_id="<PROJECT_ID>",
search_analyzer="lucene.standard")
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";
const test = new mongodbatlas.SearchIndex("test", {
analyzer: "lucene.standard",
clusterName: "<CLUSTER_NAME>",
collectionName: "collection_test",
database: "database_test",
mappingsDynamic: true,
projectId: "<PROJECT_ID>",
searchAnalyzer: "lucene.standard",
});
resources:
test:
type: mongodbatlas:SearchIndex
properties:
analyzer: lucene.standard
clusterName: <CLUSTER_NAME>
collectionName: collection_test
database: database_test
mappingsDynamic: true
projectId: <PROJECT_ID>
searchAnalyzer: lucene.standard
Advanced (with custom analyzers)
using System.Collections.Generic;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;
return await Deployment.RunAsync(() =>
{
var test = new Mongodbatlas.SearchIndex("test", new()
{
ProjectId = "%[1]s",
ClusterName = "%[2]s",
Analyzer = "lucene.standard",
CollectionName = "collection_test",
Database = "database_test",
MappingsDynamic = false,
MappingsFields = @"{
""address"": {
""type"": ""document"",
""fields"": {
""city"": {
""type"": ""string"",
""analyzer"": ""lucene.simple"",
""ignoreAbove"": 255
},
""state"": {
""type"": ""string"",
""analyzer"": ""lucene.english""
}
}
},
""company"": {
""type"": ""string"",
""analyzer"": ""lucene.whitespace"",
""multi"": {
""mySecondaryAnalyzer"": {
""type"": ""string"",
""analyzer"": ""lucene.french""
}
}
},
""employees"": {
""type"": ""string"",
""analyzer"": ""lucene.standard""
}
}
",
SearchAnalyzer = "lucene.standard",
Analyzers = @" [{
""name"": ""index_analyzer_test_name"",
""charFilters"": {
""type"": ""mapping"",
""mappings"": {""\\"" : ""/""}
},
""tokenizer"": {
""type"": ""nGram"",
""minGram"": 2,
""maxGram"": 5
},
""tokenFilters"": {
""type"": ""length"",
""min"": 20,
""max"": 33
}
}]
",
Synonyms = new[]
{
new Mongodbatlas.Inputs.SearchIndexSynonymArgs
{
Analyzer = "lucene.simple",
Name = "synonym_test",
SourceCollection = "collection_test",
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-mongodbatlas/sdk/v3/go/mongodbatlas"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := mongodbatlas.NewSearchIndex(ctx, "test", &mongodbatlas.SearchIndexArgs{
ProjectId: pulumi.String("%[1]s"),
ClusterName: pulumi.String("%[2]s"),
Analyzer: pulumi.String("lucene.standard"),
CollectionName: pulumi.String("collection_test"),
Database: pulumi.String("database_test"),
MappingsDynamic: pulumi.Bool(false),
MappingsFields: pulumi.String("{\n \"address\": {\n \"type\": \"document\",\n \"fields\": {\n \"city\": {\n \"type\": \"string\",\n \"analyzer\": \"lucene.simple\",\n \"ignoreAbove\": 255\n },\n \"state\": {\n \"type\": \"string\",\n \"analyzer\": \"lucene.english\"\n }\n }\n },\n \"company\": {\n \"type\": \"string\",\n \"analyzer\": \"lucene.whitespace\",\n \"multi\": {\n \"mySecondaryAnalyzer\": {\n \"type\": \"string\",\n \"analyzer\": \"lucene.french\"\n }\n }\n },\n \"employees\": {\n \"type\": \"string\",\n \"analyzer\": \"lucene.standard\"\n }\n}\n"),
SearchAnalyzer: pulumi.String("lucene.standard"),
Analyzers: pulumi.String(" [{\n \"name\": \"index_analyzer_test_name\",\n \"charFilters\": {\n\"type\": \"mapping\",\n\"mappings\": {\"\\\\\" : \"/\"}\n },\n \"tokenizer\": {\n \"type\": \"nGram\",\n \"minGram\": 2,\n \"maxGram\": 5\n },\n \"tokenFilters\": {\n\"type\": \"length\",\n\"min\": 20,\n\"max\": 33\n }\n }]\n"),
Synonyms: mongodbatlas.SearchIndexSynonymArray{
&mongodbatlas.SearchIndexSynonymArgs{
Analyzer: pulumi.String("lucene.simple"),
Name: pulumi.String("synonym_test"),
SourceCollection: pulumi.String("collection_test"),
},
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.SearchIndex;
import com.pulumi.mongodbatlas.SearchIndexArgs;
import com.pulumi.mongodbatlas.inputs.SearchIndexSynonymArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var test = new SearchIndex("test", SearchIndexArgs.builder()
.projectId("%[1]s")
.clusterName("%[2]s")
.analyzer("lucene.standard")
.collectionName("collection_test")
.database("database_test")
.mappingsDynamic(false)
.mappingsFields("""
{
"address": {
"type": "document",
"fields": {
"city": {
"type": "string",
"analyzer": "lucene.simple",
"ignoreAbove": 255
},
"state": {
"type": "string",
"analyzer": "lucene.english"
}
}
},
"company": {
"type": "string",
"analyzer": "lucene.whitespace",
"multi": {
"mySecondaryAnalyzer": {
"type": "string",
"analyzer": "lucene.french"
}
}
},
"employees": {
"type": "string",
"analyzer": "lucene.standard"
}
}
""")
.searchAnalyzer("lucene.standard")
.analyzers("""
[{
"name": "index_analyzer_test_name",
"charFilters": {
"type": "mapping",
"mappings": {"\\" : "/"}
},
"tokenizer": {
"type": "nGram",
"minGram": 2,
"maxGram": 5
},
"tokenFilters": {
"type": "length",
"min": 20,
"max": 33
}
}]
""")
.synonyms(SearchIndexSynonymArgs.builder()
.analyzer("lucene.simple")
.name("synonym_test")
.sourceCollection("collection_test")
.build())
.build());
}
}
import pulumi
import pulumi_mongodbatlas as mongodbatlas
test = mongodbatlas.SearchIndex("test",
project_id="%[1]s",
cluster_name="%[2]s",
analyzer="lucene.standard",
collection_name="collection_test",
database="database_test",
mappings_dynamic=False,
mappings_fields="""{
"address": {
"type": "document",
"fields": {
"city": {
"type": "string",
"analyzer": "lucene.simple",
"ignoreAbove": 255
},
"state": {
"type": "string",
"analyzer": "lucene.english"
}
}
},
"company": {
"type": "string",
"analyzer": "lucene.whitespace",
"multi": {
"mySecondaryAnalyzer": {
"type": "string",
"analyzer": "lucene.french"
}
}
},
"employees": {
"type": "string",
"analyzer": "lucene.standard"
}
}
""",
search_analyzer="lucene.standard",
analyzers=""" [{
"name": "index_analyzer_test_name",
"charFilters": {
"type": "mapping",
"mappings": {"\\" : "/"}
},
"tokenizer": {
"type": "nGram",
"minGram": 2,
"maxGram": 5
},
"tokenFilters": {
"type": "length",
"min": 20,
"max": 33
}
}]
""",
synonyms=[mongodbatlas.SearchIndexSynonymArgs(
analyzer="lucene.simple",
name="synonym_test",
source_collection="collection_test",
)])
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";
const test = new mongodbatlas.SearchIndex("test", {
projectId: "%[1]s",
clusterName: "%[2]s",
analyzer: "lucene.standard",
collectionName: "collection_test",
database: "database_test",
mappingsDynamic: false,
mappingsFields: `{
"address": {
"type": "document",
"fields": {
"city": {
"type": "string",
"analyzer": "lucene.simple",
"ignoreAbove": 255
},
"state": {
"type": "string",
"analyzer": "lucene.english"
}
}
},
"company": {
"type": "string",
"analyzer": "lucene.whitespace",
"multi": {
"mySecondaryAnalyzer": {
"type": "string",
"analyzer": "lucene.french"
}
}
},
"employees": {
"type": "string",
"analyzer": "lucene.standard"
}
}
`,
searchAnalyzer: "lucene.standard",
analyzers: ` [{
"name": "index_analyzer_test_name",
"charFilters": {
"type": "mapping",
"mappings": {"\\\\" : "/"}
},
"tokenizer": {
"type": "nGram",
"minGram": 2,
"maxGram": 5
},
"tokenFilters": {
"type": "length",
"min": 20,
"max": 33
}
}]
`,
synonyms: [{
analyzer: "lucene.simple",
name: "synonym_test",
sourceCollection: "collection_test",
}],
});
resources:
test:
type: mongodbatlas:SearchIndex
properties:
projectId: '%[1]s'
clusterName: '%[2]s'
analyzer: lucene.standard
collectionName: collection_test
database: database_test
mappingsDynamic: false
mappingsFields: |
{
"address": {
"type": "document",
"fields": {
"city": {
"type": "string",
"analyzer": "lucene.simple",
"ignoreAbove": 255
},
"state": {
"type": "string",
"analyzer": "lucene.english"
}
}
},
"company": {
"type": "string",
"analyzer": "lucene.whitespace",
"multi": {
"mySecondaryAnalyzer": {
"type": "string",
"analyzer": "lucene.french"
}
}
},
"employees": {
"type": "string",
"analyzer": "lucene.standard"
}
}
searchAnalyzer: lucene.standard
analyzers: |2
[{
"name": "index_analyzer_test_name",
"charFilters": {
"type": "mapping",
"mappings": {"\\" : "/"}
},
"tokenizer": {
"type": "nGram",
"minGram": 2,
"maxGram": 5
},
"tokenFilters": {
"type": "length",
"min": 20,
"max": 33
}
}]
synonyms:
- analyzer: lucene.simple
name: synonym_test
sourceCollection: collection_test
Create SearchIndex Resource
new SearchIndex(name: string, args: SearchIndexArgs, opts?: CustomResourceOptions);@overload
def SearchIndex(resource_name: str,
opts: Optional[ResourceOptions] = None,
analyzer: Optional[str] = None,
analyzers: Optional[str] = None,
cluster_name: Optional[str] = None,
collection_name: Optional[str] = None,
database: Optional[str] = None,
mappings_dynamic: Optional[bool] = None,
mappings_fields: Optional[str] = None,
name: Optional[str] = None,
project_id: Optional[str] = None,
search_analyzer: Optional[str] = None,
status: Optional[str] = None,
synonyms: Optional[Sequence[SearchIndexSynonymArgs]] = None,
wait_for_index_build_completion: Optional[bool] = None)
@overload
def SearchIndex(resource_name: str,
args: SearchIndexArgs,
opts: Optional[ResourceOptions] = None)func NewSearchIndex(ctx *Context, name string, args SearchIndexArgs, opts ...ResourceOption) (*SearchIndex, error)public SearchIndex(string name, SearchIndexArgs args, CustomResourceOptions? opts = null)
public SearchIndex(String name, SearchIndexArgs args)
public SearchIndex(String name, SearchIndexArgs args, CustomResourceOptions options)
type: mongodbatlas:SearchIndex
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SearchIndexArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args SearchIndexArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args SearchIndexArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SearchIndexArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SearchIndexArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
SearchIndex Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The SearchIndex resource accepts the following input properties:
- Analyzer string
Analyzer to use when creating the index. Defaults to lucene.standard
- Cluster
Name string The name of the cluster where you want to create the search index within.
- Collection
Name string Name of the collection the index is on.
- Database string
Name of the database the collection is in.
- Project
Id string The ID of the organization or project you want to create the search index within.
- Analyzers string
Custom analyzers to use in this index. This is an array of JSON objects.
- Mappings
Dynamic bool Indicates whether the index uses dynamic or static mapping. For dynamic mapping, set the value to
true. For static mapping, specify the fields to index usingmappings_fields- Mappings
Fields string attribute is required when
mappings_dynamicis true. This field needs to be a JSON string in order to be decoded correctly.- Name string
The name of the search index you want to create.
- Search
Analyzer string Analyzer to use when searching the index. Defaults to lucene.standard
- Status string
- Synonyms
List<Search
Index Synonym Args> Synonyms mapping definition to use in this index.
- Wait
For boolIndex Build Completion
- Analyzer string
Analyzer to use when creating the index. Defaults to lucene.standard
- Cluster
Name string The name of the cluster where you want to create the search index within.
- Collection
Name string Name of the collection the index is on.
- Database string
Name of the database the collection is in.
- Project
Id string The ID of the organization or project you want to create the search index within.
- Analyzers string
Custom analyzers to use in this index. This is an array of JSON objects.
- Mappings
Dynamic bool Indicates whether the index uses dynamic or static mapping. For dynamic mapping, set the value to
true. For static mapping, specify the fields to index usingmappings_fields- Mappings
Fields string attribute is required when
mappings_dynamicis true. This field needs to be a JSON string in order to be decoded correctly.- Name string
The name of the search index you want to create.
- Search
Analyzer string Analyzer to use when searching the index. Defaults to lucene.standard
- Status string
- Synonyms
[]Search
Index Synonym Args Synonyms mapping definition to use in this index.
- Wait
For boolIndex Build Completion
- analyzer String
Analyzer to use when creating the index. Defaults to lucene.standard
- cluster
Name String The name of the cluster where you want to create the search index within.
- collection
Name String Name of the collection the index is on.
- database String
Name of the database the collection is in.
- project
Id String The ID of the organization or project you want to create the search index within.
- analyzers String
Custom analyzers to use in this index. This is an array of JSON objects.
- mappings
Dynamic Boolean Indicates whether the index uses dynamic or static mapping. For dynamic mapping, set the value to
true. For static mapping, specify the fields to index usingmappings_fields- mappings
Fields String attribute is required when
mappings_dynamicis true. This field needs to be a JSON string in order to be decoded correctly.- name String
The name of the search index you want to create.
- search
Analyzer String Analyzer to use when searching the index. Defaults to lucene.standard
- status String
- synonyms
List<Search
Index Synonym Args> Synonyms mapping definition to use in this index.
- wait
For BooleanIndex Build Completion
- analyzer string
Analyzer to use when creating the index. Defaults to lucene.standard
- cluster
Name string The name of the cluster where you want to create the search index within.
- collection
Name string Name of the collection the index is on.
- database string
Name of the database the collection is in.
- project
Id string The ID of the organization or project you want to create the search index within.
- analyzers string
Custom analyzers to use in this index. This is an array of JSON objects.
- mappings
Dynamic boolean Indicates whether the index uses dynamic or static mapping. For dynamic mapping, set the value to
true. For static mapping, specify the fields to index usingmappings_fields- mappings
Fields string attribute is required when
mappings_dynamicis true. This field needs to be a JSON string in order to be decoded correctly.- name string
The name of the search index you want to create.
- search
Analyzer string Analyzer to use when searching the index. Defaults to lucene.standard
- status string
- synonyms
Search
Index Synonym Args[] Synonyms mapping definition to use in this index.
- wait
For booleanIndex Build Completion
- analyzer str
Analyzer to use when creating the index. Defaults to lucene.standard
- cluster_
name str The name of the cluster where you want to create the search index within.
- collection_
name str Name of the collection the index is on.
- database str
Name of the database the collection is in.
- project_
id str The ID of the organization or project you want to create the search index within.
- analyzers str
Custom analyzers to use in this index. This is an array of JSON objects.
- mappings_
dynamic bool Indicates whether the index uses dynamic or static mapping. For dynamic mapping, set the value to
true. For static mapping, specify the fields to index usingmappings_fields- mappings_
fields str attribute is required when
mappings_dynamicis true. This field needs to be a JSON string in order to be decoded correctly.- name str
The name of the search index you want to create.
- search_
analyzer str Analyzer to use when searching the index. Defaults to lucene.standard
- status str
- synonyms
Sequence[Search
Index Synonym Args] Synonyms mapping definition to use in this index.
- wait_
for_ boolindex_ build_ completion
- analyzer String
Analyzer to use when creating the index. Defaults to lucene.standard
- cluster
Name String The name of the cluster where you want to create the search index within.
- collection
Name String Name of the collection the index is on.
- database String
Name of the database the collection is in.
- project
Id String The ID of the organization or project you want to create the search index within.
- analyzers String
Custom analyzers to use in this index. This is an array of JSON objects.
- mappings
Dynamic Boolean Indicates whether the index uses dynamic or static mapping. For dynamic mapping, set the value to
true. For static mapping, specify the fields to index usingmappings_fields- mappings
Fields String attribute is required when
mappings_dynamicis true. This field needs to be a JSON string in order to be decoded correctly.- name String
The name of the search index you want to create.
- search
Analyzer String Analyzer to use when searching the index. Defaults to lucene.standard
- status String
- synonyms List<Property Map>
Synonyms mapping definition to use in this index.
- wait
For BooleanIndex Build Completion
Outputs
All input properties are implicitly available as output properties. Additionally, the SearchIndex resource produces the following output properties:
Look up Existing SearchIndex Resource
Get an existing SearchIndex resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: SearchIndexState, opts?: CustomResourceOptions): SearchIndex@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
analyzer: Optional[str] = None,
analyzers: Optional[str] = None,
cluster_name: Optional[str] = None,
collection_name: Optional[str] = None,
database: Optional[str] = None,
index_id: Optional[str] = None,
mappings_dynamic: Optional[bool] = None,
mappings_fields: Optional[str] = None,
name: Optional[str] = None,
project_id: Optional[str] = None,
search_analyzer: Optional[str] = None,
status: Optional[str] = None,
synonyms: Optional[Sequence[SearchIndexSynonymArgs]] = None,
wait_for_index_build_completion: Optional[bool] = None) -> SearchIndexfunc GetSearchIndex(ctx *Context, name string, id IDInput, state *SearchIndexState, opts ...ResourceOption) (*SearchIndex, error)public static SearchIndex Get(string name, Input<string> id, SearchIndexState? state, CustomResourceOptions? opts = null)public static SearchIndex get(String name, Output<String> id, SearchIndexState state, CustomResourceOptions options)Resource lookup is not supported in YAML- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Analyzer string
Analyzer to use when creating the index. Defaults to lucene.standard
- Analyzers string
Custom analyzers to use in this index. This is an array of JSON objects.
- Cluster
Name string The name of the cluster where you want to create the search index within.
- Collection
Name string Name of the collection the index is on.
- Database string
Name of the database the collection is in.
- Index
Id string - Mappings
Dynamic bool Indicates whether the index uses dynamic or static mapping. For dynamic mapping, set the value to
true. For static mapping, specify the fields to index usingmappings_fields- Mappings
Fields string attribute is required when
mappings_dynamicis true. This field needs to be a JSON string in order to be decoded correctly.- Name string
The name of the search index you want to create.
- Project
Id string The ID of the organization or project you want to create the search index within.
- Search
Analyzer string Analyzer to use when searching the index. Defaults to lucene.standard
- Status string
- Synonyms
List<Search
Index Synonym Args> Synonyms mapping definition to use in this index.
- Wait
For boolIndex Build Completion
- Analyzer string
Analyzer to use when creating the index. Defaults to lucene.standard
- Analyzers string
Custom analyzers to use in this index. This is an array of JSON objects.
- Cluster
Name string The name of the cluster where you want to create the search index within.
- Collection
Name string Name of the collection the index is on.
- Database string
Name of the database the collection is in.
- Index
Id string - Mappings
Dynamic bool Indicates whether the index uses dynamic or static mapping. For dynamic mapping, set the value to
true. For static mapping, specify the fields to index usingmappings_fields- Mappings
Fields string attribute is required when
mappings_dynamicis true. This field needs to be a JSON string in order to be decoded correctly.- Name string
The name of the search index you want to create.
- Project
Id string The ID of the organization or project you want to create the search index within.
- Search
Analyzer string Analyzer to use when searching the index. Defaults to lucene.standard
- Status string
- Synonyms
[]Search
Index Synonym Args Synonyms mapping definition to use in this index.
- Wait
For boolIndex Build Completion
- analyzer String
Analyzer to use when creating the index. Defaults to lucene.standard
- analyzers String
Custom analyzers to use in this index. This is an array of JSON objects.
- cluster
Name String The name of the cluster where you want to create the search index within.
- collection
Name String Name of the collection the index is on.
- database String
Name of the database the collection is in.
- index
Id String - mappings
Dynamic Boolean Indicates whether the index uses dynamic or static mapping. For dynamic mapping, set the value to
true. For static mapping, specify the fields to index usingmappings_fields- mappings
Fields String attribute is required when
mappings_dynamicis true. This field needs to be a JSON string in order to be decoded correctly.- name String
The name of the search index you want to create.
- project
Id String The ID of the organization or project you want to create the search index within.
- search
Analyzer String Analyzer to use when searching the index. Defaults to lucene.standard
- status String
- synonyms
List<Search
Index Synonym Args> Synonyms mapping definition to use in this index.
- wait
For BooleanIndex Build Completion
- analyzer string
Analyzer to use when creating the index. Defaults to lucene.standard
- analyzers string
Custom analyzers to use in this index. This is an array of JSON objects.
- cluster
Name string The name of the cluster where you want to create the search index within.
- collection
Name string Name of the collection the index is on.
- database string
Name of the database the collection is in.
- index
Id string - mappings
Dynamic boolean Indicates whether the index uses dynamic or static mapping. For dynamic mapping, set the value to
true. For static mapping, specify the fields to index usingmappings_fields- mappings
Fields string attribute is required when
mappings_dynamicis true. This field needs to be a JSON string in order to be decoded correctly.- name string
The name of the search index you want to create.
- project
Id string The ID of the organization or project you want to create the search index within.
- search
Analyzer string Analyzer to use when searching the index. Defaults to lucene.standard
- status string
- synonyms
Search
Index Synonym Args[] Synonyms mapping definition to use in this index.
- wait
For booleanIndex Build Completion
- analyzer str
Analyzer to use when creating the index. Defaults to lucene.standard
- analyzers str
Custom analyzers to use in this index. This is an array of JSON objects.
- cluster_
name str The name of the cluster where you want to create the search index within.
- collection_
name str Name of the collection the index is on.
- database str
Name of the database the collection is in.
- index_
id str - mappings_
dynamic bool Indicates whether the index uses dynamic or static mapping. For dynamic mapping, set the value to
true. For static mapping, specify the fields to index usingmappings_fields- mappings_
fields str attribute is required when
mappings_dynamicis true. This field needs to be a JSON string in order to be decoded correctly.- name str
The name of the search index you want to create.
- project_
id str The ID of the organization or project you want to create the search index within.
- search_
analyzer str Analyzer to use when searching the index. Defaults to lucene.standard
- status str
- synonyms
Sequence[Search
Index Synonym Args] Synonyms mapping definition to use in this index.
- wait_
for_ boolindex_ build_ completion
- analyzer String
Analyzer to use when creating the index. Defaults to lucene.standard
- analyzers String
Custom analyzers to use in this index. This is an array of JSON objects.
- cluster
Name String The name of the cluster where you want to create the search index within.
- collection
Name String Name of the collection the index is on.
- database String
Name of the database the collection is in.
- index
Id String - mappings
Dynamic Boolean Indicates whether the index uses dynamic or static mapping. For dynamic mapping, set the value to
true. For static mapping, specify the fields to index usingmappings_fields- mappings
Fields String attribute is required when
mappings_dynamicis true. This field needs to be a JSON string in order to be decoded correctly.- name String
The name of the search index you want to create.
- project
Id String The ID of the organization or project you want to create the search index within.
- search
Analyzer String Analyzer to use when searching the index. Defaults to lucene.standard
- status String
- synonyms List<Property Map>
Synonyms mapping definition to use in this index.
- wait
For BooleanIndex Build Completion
Supporting Types
SearchIndexSynonym
- Analyzer string
Name of the analyzer to use with this synonym mapping. Atlas Search doesn't support these custom analyzer tokenizers and token filters in analyzers used in synonym mappings:
- Name string
Name of the synonym mapping definition. Name must be unique in this index definition and it can't be an empty string.
- Source
Collection string Name of the source MongoDB collection for the synonyms. Documents in this collection must be in the format described in the Synonyms Source Collection Documents.
- Analyzer string
Name of the analyzer to use with this synonym mapping. Atlas Search doesn't support these custom analyzer tokenizers and token filters in analyzers used in synonym mappings:
- Name string
Name of the synonym mapping definition. Name must be unique in this index definition and it can't be an empty string.
- Source
Collection string Name of the source MongoDB collection for the synonyms. Documents in this collection must be in the format described in the Synonyms Source Collection Documents.
- analyzer String
Name of the analyzer to use with this synonym mapping. Atlas Search doesn't support these custom analyzer tokenizers and token filters in analyzers used in synonym mappings:
- name String
Name of the synonym mapping definition. Name must be unique in this index definition and it can't be an empty string.
- source
Collection String Name of the source MongoDB collection for the synonyms. Documents in this collection must be in the format described in the Synonyms Source Collection Documents.
- analyzer string
Name of the analyzer to use with this synonym mapping. Atlas Search doesn't support these custom analyzer tokenizers and token filters in analyzers used in synonym mappings:
- name string
Name of the synonym mapping definition. Name must be unique in this index definition and it can't be an empty string.
- source
Collection string Name of the source MongoDB collection for the synonyms. Documents in this collection must be in the format described in the Synonyms Source Collection Documents.
- analyzer str
Name of the analyzer to use with this synonym mapping. Atlas Search doesn't support these custom analyzer tokenizers and token filters in analyzers used in synonym mappings:
- name str
Name of the synonym mapping definition. Name must be unique in this index definition and it can't be an empty string.
- source_
collection str Name of the source MongoDB collection for the synonyms. Documents in this collection must be in the format described in the Synonyms Source Collection Documents.
- analyzer String
Name of the analyzer to use with this synonym mapping. Atlas Search doesn't support these custom analyzer tokenizers and token filters in analyzers used in synonym mappings:
- name String
Name of the synonym mapping definition. Name must be unique in this index definition and it can't be an empty string.
- source
Collection String Name of the source MongoDB collection for the synonyms. Documents in this collection must be in the format described in the Synonyms Source Collection Documents.
Package Details
- Repository
- MongoDB Atlas pulumi/pulumi-mongodbatlas
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
mongodbatlasTerraform Provider.