MongoDB Atlas v3.7.2, Mar 31 23

mongodbatlas.getSearchIndexes

Explore with Pulumi AI

mongodbatlas.getSearchIndexes describe 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.

Example Usage

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.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()
            .clusterName("<CLUSTER_NAME>")
            .collectionName("<COLLECTION_NAME>")
            .databaseName("<DATABASE_NAME>")
            .itemsPerPage(100)
            .pageNum(1)
            .projectId("<PROJECT_ID>")
            .build());

    }
}

Coming soon!

variables:
  test:
    fn::invoke:
      Function: mongodbatlas:getSearchIndex
      Arguments:
        clusterName: <CLUSTER_NAME>
        collectionName: <COLLECTION_NAME>
        databaseName: <DATABASE_NAME>
        itemsPerPage: 100
        pageNum: 1
        projectId: <PROJECT_ID>

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.

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,
                       items_per_page: Optional[int] = None,
                       page_num: Optional[int] = 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,
                       items_per_page: Optional[pulumi.Input[int]] = None,
                       page_num: Optional[pulumi.Input[int]] = 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)
// Output-based functions aren't available in Java yet

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.
ItemsPerPage int: Number of items that Atlas returns per page, up to a maximum of 500.
PageNum int: Page number, starting with one, that Atlas returns of the total number 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.
ProjectId string: Unique identifier for the project that contains the specified cluster.
ItemsPerPage int: Number of items that Atlas returns per page, up to a maximum of 500.
PageNum int: Page number, starting with one, that Atlas returns of the total number 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.
projectId String: Unique identifier for the project that contains the specified cluster.
itemsPerPage Integer: Number of items that Atlas returns per page, up to a maximum of 500.
pageNum Integer: Page number, starting with one, that Atlas returns of the total number 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.
projectId string: Unique identifier for the project that contains the specified cluster.
itemsPerPage number: Number of items that Atlas returns per page, up to a maximum of 500.
pageNum number: Page number, starting with one, that Atlas returns of the total number 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.
project_id str: Unique identifier for the project that contains the specified cluster.
items_per_page int: Number of items that Atlas returns per page, up to a maximum of 500.
page_num int: Page number, starting with one, that Atlas returns of the total number 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.
projectId String: Unique identifier for the project that contains the specified cluster.
itemsPerPage Number: Number of items that Atlas returns per page, up to a maximum of 500.
pageNum Number: Page number, starting with one, that Atlas returns of the total number of objects.

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
ItemsPerPage int
PageNum int

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
ItemsPerPage int
PageNum int

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
itemsPerPage Integer
pageNum Integer

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
itemsPerPage number
pageNum number

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
items_per_page int
page_num int

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
itemsPerPage Number
pageNum Number

Supporting Types

GetSearchIndexesResult

Analyzer string

Analyzer to use when creating the index.

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.

IndexId string

Name string

Name of the index.

ProjectId string

Unique identifier for the project that contains the specified cluster.

Status string

Analyzers string

Custom analyzers to use in this index (this is an array of objects).

MappingsDynamic bool

Flag indicating whether the index uses dynamic or static mappings.

MappingsFields string

Object containing one or more field specifications.

SearchAnalyzer string

Analyzer to use when searching the index.

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.

WaitForIndexBuildCompletion bool

Analyzer string

Analyzer to use when creating the index.

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.

IndexId string

Name string

Name of the index.

ProjectId string

Unique identifier for the project that contains the specified cluster.

Status string

Analyzers string

Custom analyzers to use in this index (this is an array of objects).

MappingsDynamic bool

Flag indicating whether the index uses dynamic or static mappings.

MappingsFields string

Object containing one or more field specifications.

SearchAnalyzer string

Analyzer to use when searching the index.

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.

WaitForIndexBuildCompletion bool

analyzer String

Analyzer to use when creating the index.

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.

indexId String

name String

Name of the index.

projectId String

Unique identifier for the project that contains the specified cluster.

status String

analyzers String

Custom analyzers to use in this index (this is an array of objects).

mappingsDynamic Boolean

Flag indicating whether the index uses dynamic or static mappings.

mappingsFields String

Object containing one or more field specifications.

searchAnalyzer String

Analyzer to use when searching the index.

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.

waitForIndexBuildCompletion Boolean

analyzer string

Analyzer to use when creating the index.

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.

indexId string

name string

Name of the index.

projectId string

Unique identifier for the project that contains the specified cluster.

status string

analyzers string

Custom analyzers to use in this index (this is an array of objects).

mappingsDynamic boolean

Flag indicating whether the index uses dynamic or static mappings.

mappingsFields string

Object containing one or more field specifications.

searchAnalyzer string

Analyzer to use when searching the index.

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.

waitForIndexBuildCompletion boolean

analyzer str

Analyzer to use when creating the index.

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.

index_id str

name str

Name of the index.

project_id str

Unique identifier for the project that contains the specified cluster.

status str

analyzers str

Custom analyzers to use in this index (this is an array of objects).

mappings_dynamic bool

Flag indicating whether the index uses dynamic or static mappings.

mappings_fields str

Object containing one or more field specifications.

search_analyzer str

Analyzer to use when searching the index.

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.

wait_for_index_build_completion bool

analyzer String

Analyzer to use when creating the index.

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.

indexId String

name String

Name of the index.

projectId String

Unique identifier for the project that contains the specified cluster.

status String

analyzers String

Custom analyzers to use in this index (this is an array of objects).

mappingsDynamic Boolean

Flag indicating whether the index uses dynamic or static mappings.

mappingsFields String

Object containing one or more field specifications.

searchAnalyzer String

Analyzer to use when searching the index.

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.

waitForIndexBuildCompletion Boolean

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.

mongodbatlas.getSearchIndexes

Example Usage

Using getSearchIndexes

getSearchIndexes Result

Supporting Types

GetSearchIndexesResult

GetSearchIndexesResultSynonym

Package Details

On this page

On this page