MongoDB Atlas v3.18.0 published on Thursday, Sep 12, 2024 by Pulumi
mongodbatlas.getSearchDeployment
Explore with Pulumi AI
# Data Source: mongodbatlas.SearchDeployment
mongodbatlas.SearchDeployment
describes a search node deployment.
Example Usage
S
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.Project;
import com.pulumi.mongodbatlas.ProjectArgs;
import com.pulumi.mongodbatlas.AdvancedCluster;
import com.pulumi.mongodbatlas.AdvancedClusterArgs;
import com.pulumi.mongodbatlas.inputs.AdvancedClusterReplicationSpecArgs;
import com.pulumi.mongodbatlas.SearchDeployment;
import com.pulumi.mongodbatlas.SearchDeploymentArgs;
import com.pulumi.mongodbatlas.inputs.SearchDeploymentSpecArgs;
import com.pulumi.mongodbatlas.MongodbatlasFunctions;
import com.pulumi.mongodbatlas.inputs.GetSearchDeploymentArgs;
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) {
var exampleProject = new Project("exampleProject", ProjectArgs.builder()
.name("project-name")
.orgId(orgId)
.build());
var exampleAdvancedCluster = new AdvancedCluster("exampleAdvancedCluster", AdvancedClusterArgs.builder()
.projectId(exampleProject.id())
.name("ClusterExample")
.clusterType("REPLICASET")
.replicationSpecs(AdvancedClusterReplicationSpecArgs.builder()
.regionConfigs(AdvancedClusterReplicationSpecRegionConfigArgs.builder()
.electableSpecs(AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs.builder()
.instanceSize("M10")
.nodeCount(3)
.build())
.providerName("AWS")
.priority(7)
.regionName("US_EAST_1")
.build())
.build())
.build());
var exampleSearchDeployment = new SearchDeployment("exampleSearchDeployment", SearchDeploymentArgs.builder()
.projectId(exampleProject.id())
.clusterName(exampleAdvancedCluster.name())
.specs(SearchDeploymentSpecArgs.builder()
.instance_size("S20_HIGHCPU_NVME")
.node_count(2)
.build())
.build());
final var example = MongodbatlasFunctions.getSearchDeployment(GetSearchDeploymentArgs.builder()
.projectId(exampleSearchDeployment.projectId())
.clusterName(exampleSearchDeployment.clusterName())
.build());
ctx.export("mongodbatlasSearchDeploymentId", example.applyValue(getSearchDeploymentResult -> getSearchDeploymentResult).applyValue(example -> example.applyValue(getSearchDeploymentResult -> getSearchDeploymentResult.id())));
}
}
resources:
exampleProject:
type: mongodbatlas:Project
name: example
properties:
name: project-name
orgId: ${orgId}
exampleAdvancedCluster:
type: mongodbatlas:AdvancedCluster
name: example
properties:
projectId: ${exampleProject.id}
name: ClusterExample
clusterType: REPLICASET
replicationSpecs:
- regionConfigs:
- electableSpecs:
instanceSize: M10
nodeCount: 3
providerName: AWS
priority: 7
regionName: US_EAST_1
exampleSearchDeployment:
type: mongodbatlas:SearchDeployment
name: example
properties:
projectId: ${exampleProject.id}
clusterName: ${exampleAdvancedCluster.name}
specs:
- instance_size: S20_HIGHCPU_NVME
node_count: 2
variables:
example:
fn::invoke:
Function: mongodbatlas:getSearchDeployment
Arguments:
projectId: ${exampleSearchDeployment.projectId}
clusterName: ${exampleSearchDeployment.clusterName}
outputs:
mongodbatlasSearchDeploymentId: ${example.id}
Using getSearchDeployment
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 getSearchDeployment(args: GetSearchDeploymentArgs, opts?: InvokeOptions): Promise<GetSearchDeploymentResult>
function getSearchDeploymentOutput(args: GetSearchDeploymentOutputArgs, opts?: InvokeOptions): Output<GetSearchDeploymentResult>
def get_search_deployment(cluster_name: Optional[str] = None,
project_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetSearchDeploymentResult
def get_search_deployment_output(cluster_name: Optional[pulumi.Input[str]] = None,
project_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetSearchDeploymentResult]
func LookupSearchDeployment(ctx *Context, args *LookupSearchDeploymentArgs, opts ...InvokeOption) (*LookupSearchDeploymentResult, error)
func LookupSearchDeploymentOutput(ctx *Context, args *LookupSearchDeploymentOutputArgs, opts ...InvokeOption) LookupSearchDeploymentResultOutput
> Note: This function is named LookupSearchDeployment
in the Go SDK.
public static class GetSearchDeployment
{
public static Task<GetSearchDeploymentResult> InvokeAsync(GetSearchDeploymentArgs args, InvokeOptions? opts = null)
public static Output<GetSearchDeploymentResult> Invoke(GetSearchDeploymentInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetSearchDeploymentResult> getSearchDeployment(GetSearchDeploymentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: mongodbatlas:index/getSearchDeployment:getSearchDeployment
arguments:
# arguments dictionary
The following arguments are supported:
- Cluster
Name string - Label that identifies the cluster to return the search nodes for.
- Project
Id string - Unique 24-hexadecimal digit string that identifies your project.
- Cluster
Name string - Label that identifies the cluster to return the search nodes for.
- Project
Id string - Unique 24-hexadecimal digit string that identifies your project.
- cluster
Name String - Label that identifies the cluster to return the search nodes for.
- project
Id String - Unique 24-hexadecimal digit string that identifies your project.
- cluster
Name string - Label that identifies the cluster to return the search nodes for.
- project
Id string - Unique 24-hexadecimal digit string that identifies your project.
- cluster_
name str - Label that identifies the cluster to return the search nodes for.
- project_
id str - Unique 24-hexadecimal digit string that identifies your project.
- cluster
Name String - Label that identifies the cluster to return the search nodes for.
- project
Id String - Unique 24-hexadecimal digit string that identifies your project.
getSearchDeployment Result
The following output properties are available:
- Cluster
Name string - Label that identifies the cluster to return the search nodes for.
- Id string
- Unique 24-hexadecimal digit string that identifies the search deployment.
- Project
Id string - Unique 24-hexadecimal digit string that identifies your project.
- Specs
List<Get
Search Deployment Spec> - List of settings that configure the search nodes for your cluster. This list is currently limited to defining a single element.
- State
Name string - Human-readable label that indicates the current operating condition of this search deployment.
- Cluster
Name string - Label that identifies the cluster to return the search nodes for.
- Id string
- Unique 24-hexadecimal digit string that identifies the search deployment.
- Project
Id string - Unique 24-hexadecimal digit string that identifies your project.
- Specs
[]Get
Search Deployment Spec - List of settings that configure the search nodes for your cluster. This list is currently limited to defining a single element.
- State
Name string - Human-readable label that indicates the current operating condition of this search deployment.
- cluster
Name String - Label that identifies the cluster to return the search nodes for.
- id String
- Unique 24-hexadecimal digit string that identifies the search deployment.
- project
Id String - Unique 24-hexadecimal digit string that identifies your project.
- specs
List<Get
Search Deployment Spec> - List of settings that configure the search nodes for your cluster. This list is currently limited to defining a single element.
- state
Name String - Human-readable label that indicates the current operating condition of this search deployment.
- cluster
Name string - Label that identifies the cluster to return the search nodes for.
- id string
- Unique 24-hexadecimal digit string that identifies the search deployment.
- project
Id string - Unique 24-hexadecimal digit string that identifies your project.
- specs
Get
Search Deployment Spec[] - List of settings that configure the search nodes for your cluster. This list is currently limited to defining a single element.
- state
Name string - Human-readable label that indicates the current operating condition of this search deployment.
- cluster_
name str - Label that identifies the cluster to return the search nodes for.
- id str
- Unique 24-hexadecimal digit string that identifies the search deployment.
- project_
id str - Unique 24-hexadecimal digit string that identifies your project.
- specs
Sequence[Get
Search Deployment Spec] - List of settings that configure the search nodes for your cluster. This list is currently limited to defining a single element.
- state_
name str - Human-readable label that indicates the current operating condition of this search deployment.
- cluster
Name String - Label that identifies the cluster to return the search nodes for.
- id String
- Unique 24-hexadecimal digit string that identifies the search deployment.
- project
Id String - Unique 24-hexadecimal digit string that identifies your project.
- specs List<Property Map>
- List of settings that configure the search nodes for your cluster. This list is currently limited to defining a single element.
- state
Name String - Human-readable label that indicates the current operating condition of this search deployment.
Supporting Types
GetSearchDeploymentSpec
- Instance
Size string - Hardware specification for the search node instance sizes. The MongoDB Atlas API describes the valid values. More details can also be found in the Search Node Documentation.
- Node
Count int - Number of search nodes in the cluster.
- Instance
Size string - Hardware specification for the search node instance sizes. The MongoDB Atlas API describes the valid values. More details can also be found in the Search Node Documentation.
- Node
Count int - Number of search nodes in the cluster.
- instance
Size String - Hardware specification for the search node instance sizes. The MongoDB Atlas API describes the valid values. More details can also be found in the Search Node Documentation.
- node
Count Integer - Number of search nodes in the cluster.
- instance
Size string - Hardware specification for the search node instance sizes. The MongoDB Atlas API describes the valid values. More details can also be found in the Search Node Documentation.
- node
Count number - Number of search nodes in the cluster.
- instance_
size str - Hardware specification for the search node instance sizes. The MongoDB Atlas API describes the valid values. More details can also be found in the Search Node Documentation.
- node_
count int - Number of search nodes in the cluster.
- instance
Size String - Hardware specification for the search node instance sizes. The MongoDB Atlas API describes the valid values. More details can also be found in the Search Node Documentation.
- node
Count Number - Number of search nodes in the cluster.
Package Details
- Repository
- MongoDB Atlas pulumi/pulumi-mongodbatlas
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
mongodbatlas
Terraform Provider.