MongoDB Atlas v3.20.4 published on Wednesday, Oct 30, 2024 by Pulumi
mongodbatlas.getSearchIndex
Explore with Pulumi AI
# 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>",
});
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/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
})
}
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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: mongodbatlas:index/getSearchIndex:getSearchIndex
arguments:
# arguments dictionary
The following arguments are supported:
- Cluster
Name string - The name of the cluster containing the collection with one or more Atlas Search indexes.
- Index
Id string - The unique identifier of the Atlas Search index. Use the
mongodbatlas.getSearchIndexes
datasource to find the IDs of all Atlas Search indexes. - Project
Id string - The unique identifier for the project that contains the specified cluster.
- Cluster
Name string - The name of the cluster containing the collection with one or more Atlas Search indexes.
- Index
Id string - The unique identifier of the Atlas Search index. Use the
mongodbatlas.getSearchIndexes
datasource to find the IDs of all Atlas Search indexes. - Project
Id string - The unique identifier for the project that contains the specified cluster.
- cluster
Name String - The name of the cluster containing the collection with one or more Atlas Search indexes.
- index
Id String - The unique identifier of the Atlas Search index. Use the
mongodbatlas.getSearchIndexes
datasource to find the IDs of all Atlas Search indexes. - project
Id String - The unique identifier for the project that contains the specified cluster.
- cluster
Name string - The name of the cluster containing the collection with one or more Atlas Search indexes.
- index
Id string - The unique identifier of the Atlas Search index. Use the
mongodbatlas.getSearchIndexes
datasource to find the IDs of all Atlas Search indexes. - project
Id 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.getSearchIndexes
datasource to find the IDs of all Atlas Search indexes. - project_
id str - The unique identifier for the project that contains the specified cluster.
- cluster
Name String - The name of the cluster containing the collection with one or more Atlas Search indexes.
- index
Id String - The unique identifier of the Atlas Search index. Use the
mongodbatlas.getSearchIndexes
datasource to find the IDs of all Atlas Search indexes. - project
Id 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).
- Cluster
Name string - Collection
Name 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.
- Index
Id string - Mappings
Dynamic bool - Flag indicating whether the index uses dynamic or static mappings.
- Mappings
Fields string - Object containing one or more field specifications.
- Name string
- Name of the index.
- Project
Id string - Search
Analyzer string - Analyzer to use when searching the index.
- Status string
- Current status of the index.
- Stored
Source 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<Get
Search Index Synonym> - 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).
- Cluster
Name string - Collection
Name 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.
- Index
Id string - Mappings
Dynamic bool - Flag indicating whether the index uses dynamic or static mappings.
- Mappings
Fields string - Object containing one or more field specifications.
- Name string
- Name of the index.
- Project
Id string - Search
Analyzer string - Analyzer to use when searching the index.
- Status string
- Current status of the index.
- Stored
Source 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
[]Get
Search Index Synonym - 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).
- cluster
Name String - collection
Name 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.
- index
Id String - mappings
Dynamic Boolean - Flag indicating whether the index uses dynamic or static mappings.
- mappings
Fields String - Object containing one or more field specifications.
- name String
- Name of the index.
- project
Id String - search
Analyzer String - Analyzer to use when searching the index.
- status String
- Current status of the index.
- stored
Source 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<Get
Search Index Synonym> - 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).
- cluster
Name string - collection
Name 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.
- index
Id string - mappings
Dynamic boolean - Flag indicating whether the index uses dynamic or static mappings.
- mappings
Fields string - Object containing one or more field specifications.
- name string
- Name of the index.
- project
Id string - search
Analyzer string - Analyzer to use when searching the index.
- status string
- Current status of the index.
- stored
Source 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
Get
Search Index Synonym[] - 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[Get
Search Index Synonym] - 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).
- cluster
Name String - collection
Name 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.
- index
Id String - mappings
Dynamic Boolean - Flag indicating whether the index uses dynamic or static mappings.
- mappings
Fields String - Object containing one or more field specifications.
- name String
- Name of the index.
- project
Id String - search
Analyzer String - Analyzer to use when searching the index.
- status String
- Current status of the index.
- stored
Source 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 string
- Analyzer to use when creating the index.
- Name string
- Name of the index.
- Source
Collection string
- Analyzer string
- Analyzer to use when creating the index.
- Name string
- Name of the index.
- Source
Collection string
- analyzer String
- Analyzer to use when creating the index.
- name String
- Name of the index.
- source
Collection String
- analyzer string
- Analyzer to use when creating the index.
- name string
- Name of the index.
- source
Collection 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.
- source
Collection String
Package Details
- Repository
- MongoDB Atlas pulumi/pulumi-mongodbatlas
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
mongodbatlas
Terraform Provider.