1. Packages
  2. Mongodbatlas Provider
  3. API Docs
  4. getSearchIndex
Viewing docs for MongoDB Atlas v4.5.0
published on Thursday, Mar 12, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-mongodbatlas

mongodbatlas.getSearchIndex

mongodbatlas logo
Viewing docs for MongoDB Atlas v4.5.0
published on Thursday, Mar 12, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-mongodbatlas

    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>",
});

    import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.get_search_index(index_id="<INDEX_ID",
    project_id="<PROJECT_ID>",
    cluster_name="<CLUSTER_NAME>")

    package main

import (
	"github.com/pulumi/pulumi-mongodbatlas/sdk/v4/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
	})
}

    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>",
    });

});

    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());

    }
}

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

    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>
    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]
    func LookupSearchIndex(ctx *Context, args *LookupSearchIndexArgs, opts ...InvokeOption) (*LookupSearchIndexResult, error)
func LookupSearchIndexOutput(ctx *Context, args *LookupSearchIndexOutputArgs, opts ...InvokeOption) LookupSearchIndexResultOutput

    > 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)
}
    public static CompletableFuture<GetSearchIndexResult> getSearchIndex(GetSearchIndexArgs args, InvokeOptions options)
public static Output<GetSearchIndexResult> getSearchIndex(GetSearchIndexArgs args, InvokeOptions options)

    fn::invoke:
  function: mongodbatlas:index/getSearchIndex:getSearchIndex
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ClusterName string
    The name of the cluster containing the collection with one or more Atlas Search indexes.
    IndexId string
    The unique identifier of the Atlas Search index. Use the mongodbatlas.getSearchIndexesdatasource to find the IDs of all Atlas Search indexes.
    ProjectId string
    The unique identifier for the project that contains the specified cluster.
    ClusterName string
    The name of the cluster containing the collection with one or more Atlas Search indexes.
    IndexId string
    The unique identifier of the Atlas Search index. Use the mongodbatlas.getSearchIndexesdatasource to find the IDs of all Atlas Search indexes.
    ProjectId string
    The unique identifier for the project that contains the specified cluster.
    clusterName String
    The name of the cluster containing the collection with one or more Atlas Search indexes.
    indexId String
    The unique identifier of the Atlas Search index. Use the mongodbatlas.getSearchIndexesdatasource to find the IDs of all Atlas Search indexes.
    projectId String
    The unique identifier for the project that contains the specified cluster.
    clusterName string
    The name of the cluster containing the collection with one or more Atlas Search indexes.
    indexId string
    The unique identifier of the Atlas Search index. Use the mongodbatlas.getSearchIndexesdatasource to find the IDs of all Atlas Search indexes.
    projectId string
    The unique identifier for the project that contains the specified cluster.
    cluster_name str
    The name of the cluster containing the collection with one or more Atlas Search indexes.
    index_id str
    The unique identifier of the Atlas Search index. Use the mongodbatlas.getSearchIndexesdatasource to find the IDs of all Atlas Search indexes.
    project_id str
    The unique identifier for the project that contains the specified cluster.
    clusterName String
    The name of the cluster containing the collection with one or more Atlas Search indexes.
    indexId String
    The unique identifier of the Atlas Search index. Use the mongodbatlas.getSearchIndexesdatasource to find the IDs of all Atlas Search indexes.
    projectId 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.
    MappingsDynamicConfig string
    JSON object for mappings.dynamic when Atlas returns an object (Please see the documentation for dynamic and static mappings). Mutually exclusive with mappings_dynamic.
    MappingsFields string
    Object containing one or more field specifications.
    Name string
    Type set name.
    NumPartitions int
    Number of index partitions.
    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
    TypeSets List<GetSearchIndexTypeSet>
    Set of type set definitions (when present). Each item includes:
    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.
    MappingsDynamicConfig string
    JSON object for mappings.dynamic when Atlas returns an object (Please see the documentation for dynamic and static mappings). Mutually exclusive with mappings_dynamic.
    MappingsFields string
    Object containing one or more field specifications.
    Name string
    Type set name.
    NumPartitions int
    Number of index partitions.
    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
    TypeSets []GetSearchIndexTypeSet
    Set of type set definitions (when present). Each item includes:
    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.
    mappingsDynamicConfig String
    JSON object for mappings.dynamic when Atlas returns an object (Please see the documentation for dynamic and static mappings). Mutually exclusive with mappings_dynamic.
    mappingsFields String
    Object containing one or more field specifications.
    name String
    Type set name.
    numPartitions Integer
    Number of index partitions.
    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
    typeSets List<GetSearchIndexTypeSet>
    Set of type set definitions (when present). Each item includes:
    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.
    mappingsDynamicConfig string
    JSON object for mappings.dynamic when Atlas returns an object (Please see the documentation for dynamic and static mappings). Mutually exclusive with mappings_dynamic.
    mappingsFields string
    Object containing one or more field specifications.
    name string
    Type set name.
    numPartitions number
    Number of index partitions.
    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
    typeSets GetSearchIndexTypeSet[]
    Set of type set definitions (when present). Each item includes:
    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_dynamic_config str
    JSON object for mappings.dynamic when Atlas returns an object (Please see the documentation for dynamic and static mappings). Mutually exclusive with mappings_dynamic.
    mappings_fields str
    Object containing one or more field specifications.
    name str
    Type set name.
    num_partitions int
    Number of index partitions.
    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
    type_sets Sequence[GetSearchIndexTypeSet]
    Set of type set definitions (when present). Each item includes:
    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.
    mappingsDynamicConfig String
    JSON object for mappings.dynamic when Atlas returns an object (Please see the documentation for dynamic and static mappings). Mutually exclusive with mappings_dynamic.
    mappingsFields String
    Object containing one or more field specifications.
    name String
    Type set name.
    numPartitions Number
    Number of index partitions.
    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
    typeSets List<Property Map>
    Set of type set definitions (when present). Each item includes:

    Supporting Types

    GetSearchIndexSynonym

    Analyzer string
    Analyzer to use when creating the index.
    Name string
    Type set name.
    SourceCollection string
    Analyzer string
    Analyzer to use when creating the index.
    Name string
    Type set name.
    SourceCollection string
    analyzer String
    Analyzer to use when creating the index.
    name String
    Type set name.
    sourceCollection String
    analyzer string
    Analyzer to use when creating the index.
    name string
    Type set name.
    sourceCollection string
    analyzer str
    Analyzer to use when creating the index.
    name str
    Type set name.
    source_collection str
    analyzer String
    Analyzer to use when creating the index.
    name String
    Type set name.
    sourceCollection String

    GetSearchIndexTypeSet

    Name string
    Type set name.
    Types string
    JSON array string describing the types for the set.
    Name string
    Type set name.
    Types string
    JSON array string describing the types for the set.
    name String
    Type set name.
    types String
    JSON array string describing the types for the set.
    name string
    Type set name.
    types string
    JSON array string describing the types for the set.
    name str
    Type set name.
    types str
    JSON array string describing the types for the set.
    name String
    Type set name.
    types String
    JSON array string describing the types for the set.

    Package Details

    Repository
    MongoDB Atlas pulumi/pulumi-mongodbatlas
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the mongodbatlas Terraform Provider.
    mongodbatlas logo
    Viewing docs for MongoDB Atlas v4.5.0
    published on Thursday, Mar 12, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-mongodbatlas
      Try Pulumi Cloud free. Your team will thank you.