MongoDB Atlas v3.30.0, Mar 21 25

MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi

mongodbatlas.getSearchIndexes

Explore with Pulumi AI

MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi

pulumi/pulumi-mongodbatlas

# Data Source: mongodbatlas.getSearchIndexes

mongodbatlas.getSearchIndexes describes all search indexes. This represents search indexes that have been created.

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

Coming soon!

Coming soon!

Coming soon!

Coming soon!

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.GetSearchIndexesArgs;
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.getSearchIndexes(GetSearchIndexesArgs.builder()
            .projectId("<PROJECT_ID>")
            .clusterName("<CLUSTER_NAME>")
            .databaseName("<DATABASE_NAME>")
            .collectionName("<COLLECTION_NAME>")
            .build());

    }
}

variables:
  test:
    fn::invoke:
      function: mongodbatlas:getSearchIndexes
      arguments:
        projectId: <PROJECT_ID>
        clusterName: <CLUSTER_NAME>
        databaseName: <DATABASE_NAME>
        collectionName: <COLLECTION_NAME>

Using getSearchIndexes

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.

TypeScript
Python
Go
C#
Java
YAML

function getSearchIndexes(args: GetSearchIndexesArgs, opts?: InvokeOptions): Promise<GetSearchIndexesResult>
function getSearchIndexesOutput(args: GetSearchIndexesOutputArgs, opts?: InvokeOptions): Output<GetSearchIndexesResult>

def get_search_indexes(cluster_name: Optional[str] = None,
                       collection_name: Optional[str] = None,
                       database: Optional[str] = None,
                       project_id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetSearchIndexesResult
def get_search_indexes_output(cluster_name: Optional[pulumi.Input[str]] = None,
                       collection_name: Optional[pulumi.Input[str]] = None,
                       database: Optional[pulumi.Input[str]] = None,
                       project_id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetSearchIndexesResult]

func LookupSearchIndexes(ctx *Context, args *LookupSearchIndexesArgs, opts ...InvokeOption) (*LookupSearchIndexesResult, error)
func LookupSearchIndexesOutput(ctx *Context, args *LookupSearchIndexesOutputArgs, opts ...InvokeOption) LookupSearchIndexesResultOutput

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

public static class GetSearchIndexes 
{
    public static Task<GetSearchIndexesResult> InvokeAsync(GetSearchIndexesArgs args, InvokeOptions? opts = null)
    public static Output<GetSearchIndexesResult> Invoke(GetSearchIndexesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSearchIndexesResult> getSearchIndexes(GetSearchIndexesArgs args, InvokeOptions options)
public static Output<GetSearchIndexesResult> getSearchIndexes(GetSearchIndexesArgs args, InvokeOptions options)

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

The following arguments are supported:

ClusterName string: Name of the cluster containing the collection with one or more Atlas Search indexes.
CollectionName string: Name of the collection with one or more Atlas Search indexes.
Database string: (Required) Name of the database the collection is in.
ProjectId string: Unique identifier for the project that contains the specified cluster.

ClusterName string: Name of the cluster containing the collection with one or more Atlas Search indexes.
CollectionName string: Name of the collection with one or more Atlas Search indexes.
Database string: (Required) Name of the database the collection is in.
ProjectId string: Unique identifier for the project that contains the specified cluster.

clusterName String: Name of the cluster containing the collection with one or more Atlas Search indexes.
collectionName String: Name of the collection with one or more Atlas Search indexes.
database String: (Required) Name of the database the collection is in.
projectId String: Unique identifier for the project that contains the specified cluster.

clusterName string: Name of the cluster containing the collection with one or more Atlas Search indexes.
collectionName string: Name of the collection with one or more Atlas Search indexes.
database string: (Required) Name of the database the collection is in.
projectId string: Unique identifier for the project that contains the specified cluster.

cluster_name str: Name of the cluster containing the collection with one or more Atlas Search indexes.
collection_name str: Name of the collection with one or more Atlas Search indexes.
database str: (Required) Name of the database the collection is in.
project_id str: Unique identifier for the project that contains the specified cluster.

clusterName String: Name of the cluster containing the collection with one or more Atlas Search indexes.
collectionName String: Name of the collection with one or more Atlas Search indexes.
database String: (Required) Name of the database the collection is in.
projectId String: Unique identifier for the project that contains the specified cluster.

getSearchIndexes Result

The following output properties are available:

ClusterName string
CollectionName string: (Required) Name of the collection the index is on.
Database string: (Required) Name of the database the collection is in.
Id string: The provider-assigned unique ID for this managed resource.
ProjectId string
Results List<GetSearchIndexesResult>: A list where each represents a search index.
TotalCount int: Represents the total of the search indexes

ClusterName string
CollectionName string: (Required) Name of the collection the index is on.
Database string: (Required) Name of the database the collection is in.
Id string: The provider-assigned unique ID for this managed resource.
ProjectId string
Results []GetSearchIndexesResult: A list where each represents a search index.
TotalCount int: Represents the total of the search indexes

clusterName String
collectionName String: (Required) Name of the collection the index is on.
database String: (Required) Name of the database the collection is in.
id String: The provider-assigned unique ID for this managed resource.
projectId String
results List<GetSearchIndexesResult>: A list where each represents a search index.
totalCount Integer: Represents the total of the search indexes

clusterName string
collectionName string: (Required) Name of the collection the index is on.
database string: (Required) Name of the database the collection is in.
id string: The provider-assigned unique ID for this managed resource.
projectId string
results GetSearchIndexesResult[]: A list where each represents a search index.
totalCount number: Represents the total of the search indexes

cluster_name str
collection_name str: (Required) Name of the collection the index is on.
database str: (Required) Name of the database the collection is in.
id str: The provider-assigned unique ID for this managed resource.
project_id str
results Sequence[GetSearchIndexesResult]: A list where each represents a search index.
total_count int: Represents the total of the search indexes

clusterName String
collectionName String: (Required) Name of the collection the index is on.
database String: (Required) Name of the database the collection is in.
id String: The provider-assigned unique ID for this managed resource.
projectId String
results List<Property Map>: A list where each represents a search index.
totalCount Number: Represents the total of the search indexes

Supporting Types

GetSearchIndexesResult

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

Name of the cluster containing the collection with one or more Atlas Search indexes.

CollectionName string

Name of the collection with one or more Atlas Search indexes.

Database string

(Required) Name of the database the collection is in.

Fields string

IndexId string

The unique identifier of the Atlas Search index.

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

Unique identifier for the project that contains the specified cluster.

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<GetSearchIndexesResultSynonym>

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

Name of the cluster containing the collection with one or more Atlas Search indexes.

CollectionName string

Name of the collection with one or more Atlas Search indexes.

Database string

(Required) Name of the database the collection is in.

Fields string

IndexId string

The unique identifier of the Atlas Search index.

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

Unique identifier for the project that contains the specified cluster.

SearchAnalyzer string

Analyzer to use when searching the index.

Status string

Current status of the index.

StoredSource string

Synonyms []GetSearchIndexesResultSynonym

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

Name of the cluster containing the collection with one or more Atlas Search indexes.

collectionName String

Name of the collection with one or more Atlas Search indexes.

database String

(Required) Name of the database the collection is in.

fields String

indexId String

The unique identifier of the Atlas Search index.

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

Unique identifier for the project that contains the specified cluster.

searchAnalyzer String

Analyzer to use when searching the index.

status String

Current status of the index.

storedSource String

synonyms List<GetSearchIndexesResultSynonym>

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

Name of the cluster containing the collection with one or more Atlas Search indexes.

collectionName string

Name of the collection with one or more Atlas Search indexes.

database string

(Required) Name of the database the collection is in.

fields string

indexId string

The unique identifier of the Atlas Search index.

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

Unique identifier for the project that contains the specified cluster.

searchAnalyzer string

Analyzer to use when searching the index.

status string

Current status of the index.

storedSource string

synonyms GetSearchIndexesResultSynonym[]

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

Name of the cluster containing the collection with one or more Atlas Search indexes.

collection_name str

Name of the collection with one or more Atlas Search indexes.

database str

(Required) Name of the database the collection is in.

fields str

index_id str

The unique identifier of the Atlas Search index.

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

Unique identifier for the project that contains the specified cluster.

search_analyzer str

Analyzer to use when searching the index.

status str

Current status of the index.

stored_source str

synonyms Sequence[GetSearchIndexesResultSynonym]

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

Name of the cluster containing the collection with one or more Atlas Search indexes.

collectionName String

Name of the collection with one or more Atlas Search indexes.

database String

(Required) Name of the database the collection is in.

fields String

indexId String

The unique identifier of the Atlas Search index.

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

Unique identifier for the project that contains the specified cluster.

searchAnalyzer String

Analyzer to use when searching the index.

status String

Current status of the index.

storedSource String

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

GetSearchIndexesResultSynonym

Analyzer string: Analyzer to use when creating the index.
Name string: Name of the index.
SourceCollection string

Analyzer string: Analyzer to use when creating the index.
Name string: Name of the index.
SourceCollection string

analyzer String: Analyzer to use when creating the index.
name String: Name of the index.
sourceCollection String

analyzer string: Analyzer to use when creating the index.
name string: Name of the index.
sourceCollection string

analyzer str: Analyzer to use when creating the index.
name str: Name of the index.
source_collection str

analyzer String: Analyzer to use when creating the index.
name String: Name of the index.
sourceCollection 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

mongodbatlas.getSearchIndexes

On this page

On this page

# Data Source: mongodbatlas.getSearchIndexes

Example Usage

Using getSearchIndexes

getSearchIndexes Result

Supporting Types

GetSearchIndexesResult

GetSearchIndexesResultSynonym

Package Details

On this page

On this page