Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Mongodbatlas Provider
  3. API Docs
  4. getSearchIndex
MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-mongodbatlas

mongodbatlas.getSearchIndex

Explore with Pulumi AI

MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-mongodbatlas

# Data Source: mongodbatlas.SearchIndex

mongodbatlas.SearchIndex describes a single search indexes. This represents a single search index that have been created.

NOTE: Groups and projects are synonymous terms. You may find groupId in the official documentation.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const test = mongodbatlas.getSearchIndex({
    indexId: "<INDEX_ID",
    projectId: "<PROJECT_ID>",
    clusterName: "<CLUSTER_NAME>",
});
Copy
import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.get_search_index(index_id="<INDEX_ID",
    project_id="<PROJECT_ID>",
    cluster_name="<CLUSTER_NAME>")
Copy
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.LookupSearchIndex(ctx, &mongodbatlas.LookupSearchIndexArgs{
			IndexId:     "<INDEX_ID",
			ProjectId:   "<PROJECT_ID>",
			ClusterName: "<CLUSTER_NAME>",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

return await Deployment.RunAsync(() => 
{
    var test = Mongodbatlas.GetSearchIndex.Invoke(new()
    {
        IndexId = "<INDEX_ID",
        ProjectId = "<PROJECT_ID>",
        ClusterName = "<CLUSTER_NAME>",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.MongodbatlasFunctions;
import com.pulumi.mongodbatlas.inputs.GetSearchIndexArgs;
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) {
        final var test = MongodbatlasFunctions.getSearchIndex(GetSearchIndexArgs.builder()
            .indexId("<INDEX_ID")
            .projectId("<PROJECT_ID>")
            .clusterName("<CLUSTER_NAME>")
            .build());

    }
}
Copy
variables:
  test:
    fn::invoke:
      function: mongodbatlas:getSearchIndex
      arguments:
        indexId: <INDEX_ID
        projectId: <PROJECT_ID>
        clusterName: <CLUSTER_NAME>
Copy

Using getSearchIndex

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getSearchIndex(args: GetSearchIndexArgs, opts?: InvokeOptions): Promise<GetSearchIndexResult>
function getSearchIndexOutput(args: GetSearchIndexOutputArgs, opts?: InvokeOptions): Output<GetSearchIndexResult>
Copy
def get_search_index(cluster_name: Optional[str] = None,
                     index_id: Optional[str] = None,
                     project_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetSearchIndexResult
def get_search_index_output(cluster_name: Optional[pulumi.Input[str]] = None,
                     index_id: Optional[pulumi.Input[str]] = None,
                     project_id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetSearchIndexResult]
Copy
func LookupSearchIndex(ctx *Context, args *LookupSearchIndexArgs, opts ...InvokeOption) (*LookupSearchIndexResult, error)
func LookupSearchIndexOutput(ctx *Context, args *LookupSearchIndexOutputArgs, opts ...InvokeOption) LookupSearchIndexResultOutput
Copy

> Note: This function is named LookupSearchIndex in the Go SDK.

public static class GetSearchIndex 
{
    public static Task<GetSearchIndexResult> InvokeAsync(GetSearchIndexArgs args, InvokeOptions? opts = null)
    public static Output<GetSearchIndexResult> Invoke(GetSearchIndexInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSearchIndexResult> getSearchIndex(GetSearchIndexArgs args, InvokeOptions options)
public static Output<GetSearchIndexResult> getSearchIndex(GetSearchIndexArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: mongodbatlas:index/getSearchIndex:getSearchIndex
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ClusterName This property is required. string
The name of the cluster containing the collection with one or more Atlas Search indexes.
IndexId This property is required. string
The unique identifier of the Atlas Search index. Use the mongodbatlas.getSearchIndexesdatasource to find the IDs of all Atlas Search indexes.
ProjectId This property is required. string
The unique identifier for the project that contains the specified cluster.
ClusterName This property is required. string
The name of the cluster containing the collection with one or more Atlas Search indexes.
IndexId This property is required. string
The unique identifier of the Atlas Search index. Use the mongodbatlas.getSearchIndexesdatasource to find the IDs of all Atlas Search indexes.
ProjectId This property is required. string
The unique identifier for the project that contains the specified cluster.
clusterName This property is required. String
The name of the cluster containing the collection with one or more Atlas Search indexes.
indexId This property is required. String
The unique identifier of the Atlas Search index. Use the mongodbatlas.getSearchIndexesdatasource to find the IDs of all Atlas Search indexes.
projectId This property is required. String
The unique identifier for the project that contains the specified cluster.
clusterName This property is required. string
The name of the cluster containing the collection with one or more Atlas Search indexes.
indexId This property is required. string
The unique identifier of the Atlas Search index. Use the mongodbatlas.getSearchIndexesdatasource to find the IDs of all Atlas Search indexes.
projectId This property is required. string
The unique identifier for the project that contains the specified cluster.
cluster_name This property is required. str
The name of the cluster containing the collection with one or more Atlas Search indexes.
index_id This property is required. str
The unique identifier of the Atlas Search index. Use the mongodbatlas.getSearchIndexesdatasource to find the IDs of all Atlas Search indexes.
project_id This property is required. str
The unique identifier for the project that contains the specified cluster.
clusterName This property is required. String
The name of the cluster containing the collection with one or more Atlas Search indexes.
indexId This property is required. String
The unique identifier of the Atlas Search index. Use the mongodbatlas.getSearchIndexesdatasource to find the IDs of all Atlas Search indexes.
projectId This property is required. String
The unique identifier for the project that contains the specified cluster.

getSearchIndex Result

The following output properties are available:

Analyzer string
Analyzer to use when creating the index.
Analyzers string
Custom analyzers to use in this index (this is an array of objects).
ClusterName string
CollectionName string
Name of the collection the index is on.
Database string
Name of the database the collection is in.
Fields string
Id string
The provider-assigned unique ID for this managed resource.
IndexId string
MappingsDynamic bool
Flag indicating whether the index uses dynamic or static mappings.
MappingsFields string
Object containing one or more field specifications.
Name string
Name of the index.
ProjectId string
SearchAnalyzer string
Analyzer to use when searching the index.
Status string
Current status of the index.
StoredSource string
String that can be "true" (store all fields), "false" (default, don't store any field), or a JSON string that contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see Stored Source Fields.
Synonyms List<GetSearchIndexSynonym>
Synonyms mapping definition to use in this index.

  • synonyms.#.name - Name of the synonym mapping definition.
  • synonyms.#.source_collection - Name of the source MongoDB collection for the synonyms.
  • synonyms.#.analyzer - Name of the analyzer to use with this synonym mapping.
Type string
Analyzer string
Analyzer to use when creating the index.
Analyzers string
Custom analyzers to use in this index (this is an array of objects).
ClusterName string
CollectionName string
Name of the collection the index is on.
Database string
Name of the database the collection is in.
Fields string
Id string
The provider-assigned unique ID for this managed resource.
IndexId string
MappingsDynamic bool
Flag indicating whether the index uses dynamic or static mappings.
MappingsFields string
Object containing one or more field specifications.
Name string
Name of the index.
ProjectId string
SearchAnalyzer string
Analyzer to use when searching the index.
Status string
Current status of the index.
StoredSource string
String that can be "true" (store all fields), "false" (default, don't store any field), or a JSON string that contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see Stored Source Fields.
Synonyms []GetSearchIndexSynonym
Synonyms mapping definition to use in this index.

  • synonyms.#.name - Name of the synonym mapping definition.
  • synonyms.#.source_collection - Name of the source MongoDB collection for the synonyms.
  • synonyms.#.analyzer - Name of the analyzer to use with this synonym mapping.
Type string
analyzer String
Analyzer to use when creating the index.
analyzers String
Custom analyzers to use in this index (this is an array of objects).
clusterName String
collectionName String
Name of the collection the index is on.
database String
Name of the database the collection is in.
fields String
id String
The provider-assigned unique ID for this managed resource.
indexId String
mappingsDynamic Boolean
Flag indicating whether the index uses dynamic or static mappings.
mappingsFields String
Object containing one or more field specifications.
name String
Name of the index.
projectId String
searchAnalyzer String
Analyzer to use when searching the index.
status String
Current status of the index.
storedSource String
String that can be "true" (store all fields), "false" (default, don't store any field), or a JSON string that contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see Stored Source Fields.
synonyms List<GetSearchIndexSynonym>
Synonyms mapping definition to use in this index.

  • synonyms.#.name - Name of the synonym mapping definition.
  • synonyms.#.source_collection - Name of the source MongoDB collection for the synonyms.
  • synonyms.#.analyzer - Name of the analyzer to use with this synonym mapping.
type String
analyzer string
Analyzer to use when creating the index.
analyzers string
Custom analyzers to use in this index (this is an array of objects).
clusterName string
collectionName string
Name of the collection the index is on.
database string
Name of the database the collection is in.
fields string
id string
The provider-assigned unique ID for this managed resource.
indexId string
mappingsDynamic boolean
Flag indicating whether the index uses dynamic or static mappings.
mappingsFields string
Object containing one or more field specifications.
name string
Name of the index.
projectId string
searchAnalyzer string
Analyzer to use when searching the index.
status string
Current status of the index.
storedSource string
String that can be "true" (store all fields), "false" (default, don't store any field), or a JSON string that contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see Stored Source Fields.
synonyms GetSearchIndexSynonym[]
Synonyms mapping definition to use in this index.

  • synonyms.#.name - Name of the synonym mapping definition.
  • synonyms.#.source_collection - Name of the source MongoDB collection for the synonyms.
  • synonyms.#.analyzer - Name of the analyzer to use with this synonym mapping.
type string
analyzer str
Analyzer to use when creating the index.
analyzers str
Custom analyzers to use in this index (this is an array of objects).
cluster_name str
collection_name str
Name of the collection the index is on.
database str
Name of the database the collection is in.
fields str
id str
The provider-assigned unique ID for this managed resource.
index_id str
mappings_dynamic bool
Flag indicating whether the index uses dynamic or static mappings.
mappings_fields str
Object containing one or more field specifications.
name str
Name of the index.
project_id str
search_analyzer str
Analyzer to use when searching the index.
status str
Current status of the index.
stored_source str
String that can be "true" (store all fields), "false" (default, don't store any field), or a JSON string that contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see Stored Source Fields.
synonyms Sequence[GetSearchIndexSynonym]
Synonyms mapping definition to use in this index.

  • synonyms.#.name - Name of the synonym mapping definition.
  • synonyms.#.source_collection - Name of the source MongoDB collection for the synonyms.
  • synonyms.#.analyzer - Name of the analyzer to use with this synonym mapping.
type str
analyzer String
Analyzer to use when creating the index.
analyzers String
Custom analyzers to use in this index (this is an array of objects).
clusterName String
collectionName String
Name of the collection the index is on.
database String
Name of the database the collection is in.
fields String
id String
The provider-assigned unique ID for this managed resource.
indexId String
mappingsDynamic Boolean
Flag indicating whether the index uses dynamic or static mappings.
mappingsFields String
Object containing one or more field specifications.
name String
Name of the index.
projectId String
searchAnalyzer String
Analyzer to use when searching the index.
status String
Current status of the index.
storedSource String
String that can be "true" (store all fields), "false" (default, don't store any field), or a JSON string that contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see Stored Source Fields.
synonyms List<Property Map>
Synonyms mapping definition to use in this index.

  • synonyms.#.name - Name of the synonym mapping definition.
  • synonyms.#.source_collection - Name of the source MongoDB collection for the synonyms.
  • synonyms.#.analyzer - Name of the analyzer to use with this synonym mapping.
type String

Supporting Types

GetSearchIndexSynonym

Analyzer This property is required. string
Analyzer to use when creating the index.
Name This property is required. string
Name of the index.
SourceCollection This property is required. string
Analyzer This property is required. string
Analyzer to use when creating the index.
Name This property is required. string
Name of the index.
SourceCollection This property is required. string
analyzer This property is required. String
Analyzer to use when creating the index.
name This property is required. String
Name of the index.
sourceCollection This property is required. String
analyzer This property is required. string
Analyzer to use when creating the index.
name This property is required. string
Name of the index.
sourceCollection This property is required. string
analyzer This property is required. str
Analyzer to use when creating the index.
name This property is required. str
Name of the index.
source_collection This property is required. str
analyzer This property is required. String
Analyzer to use when creating the index.
name This property is required. String
Name of the index.
sourceCollection This property is required. String

Package Details

Repository
MongoDB Atlas pulumi/pulumi-mongodbatlas
License
Apache-2.0
Notes
This Pulumi package is based on the mongodbatlas Terraform Provider.
MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-mongodbatlas