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

mongodbatlas.getClusterOutageSimulation

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

    mongodbatlas.ClusterOutageSimulation provides a Cluster Outage Simulation resource. For more details see https://www.mongodb.com/docs/atlas/tutorial/test-resilience/simulate-regional-outage/

    Test Outage on Minority of Electable Nodes - Select fewer than half of your electable nodes. This operation is supported via Terraform Provider.

    Test Outage on Majority of Electable Nodes - Select at least one more than half of your electable nodes and keep at least one electable node remaining. This operation not supported via Terraform Provider. Use the Atlas UI instead.

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

    Example Usage

    S

    import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const outageSimulation = mongodbatlas.getClusterOutageSimulation({
    projectId: "64707f06c519c20c3a2b1b03",
    clusterName: "Cluster0",
});

    import pulumi
import pulumi_mongodbatlas as mongodbatlas

outage_simulation = mongodbatlas.get_cluster_outage_simulation(project_id="64707f06c519c20c3a2b1b03",
    cluster_name="Cluster0")

    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.LookupClusterOutageSimulation(ctx, &mongodbatlas.LookupClusterOutageSimulationArgs{
			ProjectId:   "64707f06c519c20c3a2b1b03",
			ClusterName: "Cluster0",
		}, 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 outageSimulation = Mongodbatlas.GetClusterOutageSimulation.Invoke(new()
    {
        ProjectId = "64707f06c519c20c3a2b1b03",
        ClusterName = "Cluster0",
    });

});

    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.GetClusterOutageSimulationArgs;
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 outageSimulation = MongodbatlasFunctions.getClusterOutageSimulation(GetClusterOutageSimulationArgs.builder()
            .projectId("64707f06c519c20c3a2b1b03")
            .clusterName("Cluster0")
            .build());

    }
}

    variables:
  outageSimulation:
    fn::invoke:
      function: mongodbatlas:getClusterOutageSimulation
      arguments:
        projectId: 64707f06c519c20c3a2b1b03
        clusterName: Cluster0

    Using getClusterOutageSimulation

    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 getClusterOutageSimulation(args: GetClusterOutageSimulationArgs, opts?: InvokeOptions): Promise<GetClusterOutageSimulationResult>
function getClusterOutageSimulationOutput(args: GetClusterOutageSimulationOutputArgs, opts?: InvokeOptions): Output<GetClusterOutageSimulationResult>
    def get_cluster_outage_simulation(cluster_name: Optional[str] = None,
                                  project_id: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetClusterOutageSimulationResult
def get_cluster_outage_simulation_output(cluster_name: Optional[pulumi.Input[str]] = None,
                                  project_id: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetClusterOutageSimulationResult]
    func LookupClusterOutageSimulation(ctx *Context, args *LookupClusterOutageSimulationArgs, opts ...InvokeOption) (*LookupClusterOutageSimulationResult, error)
func LookupClusterOutageSimulationOutput(ctx *Context, args *LookupClusterOutageSimulationOutputArgs, opts ...InvokeOption) LookupClusterOutageSimulationResultOutput

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

    public static class GetClusterOutageSimulation 
{
    public static Task<GetClusterOutageSimulationResult> InvokeAsync(GetClusterOutageSimulationArgs args, InvokeOptions? opts = null)
    public static Output<GetClusterOutageSimulationResult> Invoke(GetClusterOutageSimulationInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetClusterOutageSimulationResult> getClusterOutageSimulation(GetClusterOutageSimulationArgs args, InvokeOptions options)
public static Output<GetClusterOutageSimulationResult> getClusterOutageSimulation(GetClusterOutageSimulationArgs args, InvokeOptions options)

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

    The following arguments are supported:

    ClusterName string
    Name of the Atlas Cluster that is undergoing outage simulation.
    ProjectId string
    The unique ID for the project that contains the cluster that is undergoing outage simulation.
    ClusterName string
    Name of the Atlas Cluster that is undergoing outage simulation.
    ProjectId string
    The unique ID for the project that contains the cluster that is undergoing outage simulation.
    clusterName String
    Name of the Atlas Cluster that is undergoing outage simulation.
    projectId String
    The unique ID for the project that contains the cluster that is undergoing outage simulation.
    clusterName string
    Name of the Atlas Cluster that is undergoing outage simulation.
    projectId string
    The unique ID for the project that contains the cluster that is undergoing outage simulation.
    cluster_name str
    Name of the Atlas Cluster that is undergoing outage simulation.
    project_id str
    The unique ID for the project that contains the cluster that is undergoing outage simulation.
    clusterName String
    Name of the Atlas Cluster that is undergoing outage simulation.
    projectId String
    The unique ID for the project that contains the cluster that is undergoing outage simulation.

    getClusterOutageSimulation Result

    The following output properties are available:

    ClusterName string
    Id string
    The provider-assigned unique ID for this managed resource.
    OutageFilters List<GetClusterOutageSimulationOutageFilter>
    List of settings that specify the type of cluster outage simulation.
    ProjectId string
    SimulationId string
    Unique 24-hexadecimal character string that identifies the outage simulation.
    StartRequestDate string
    Date and time when MongoDB Cloud started the regional outage simulation.
    State string
    Current phase of the outage simulation:

    • START_REQUESTED - User has requested cluster outage simulation.
    • STARTING - MongoDB Cloud is starting cluster outage simulation.
    • SIMULATING - MongoDB Cloud is simulating cluster outage.
    • RECOVERY_REQUESTED - User has requested recovery from the simulated outage.
    • RECOVERING - MongoDB Cloud is recovering the cluster from the simulated outage.
    • COMPLETE - MongoDB Cloud has completed the cluster outage simulation.
    ClusterName string
    Id string
    The provider-assigned unique ID for this managed resource.
    OutageFilters []GetClusterOutageSimulationOutageFilter
    List of settings that specify the type of cluster outage simulation.
    ProjectId string
    SimulationId string
    Unique 24-hexadecimal character string that identifies the outage simulation.
    StartRequestDate string
    Date and time when MongoDB Cloud started the regional outage simulation.
    State string
    Current phase of the outage simulation:

    • START_REQUESTED - User has requested cluster outage simulation.
    • STARTING - MongoDB Cloud is starting cluster outage simulation.
    • SIMULATING - MongoDB Cloud is simulating cluster outage.
    • RECOVERY_REQUESTED - User has requested recovery from the simulated outage.
    • RECOVERING - MongoDB Cloud is recovering the cluster from the simulated outage.
    • COMPLETE - MongoDB Cloud has completed the cluster outage simulation.
    clusterName String
    id String
    The provider-assigned unique ID for this managed resource.
    outageFilters List<GetClusterOutageSimulationOutageFilter>
    List of settings that specify the type of cluster outage simulation.
    projectId String
    simulationId String
    Unique 24-hexadecimal character string that identifies the outage simulation.
    startRequestDate String
    Date and time when MongoDB Cloud started the regional outage simulation.
    state String
    Current phase of the outage simulation:

    • START_REQUESTED - User has requested cluster outage simulation.
    • STARTING - MongoDB Cloud is starting cluster outage simulation.
    • SIMULATING - MongoDB Cloud is simulating cluster outage.
    • RECOVERY_REQUESTED - User has requested recovery from the simulated outage.
    • RECOVERING - MongoDB Cloud is recovering the cluster from the simulated outage.
    • COMPLETE - MongoDB Cloud has completed the cluster outage simulation.
    clusterName string
    id string
    The provider-assigned unique ID for this managed resource.
    outageFilters GetClusterOutageSimulationOutageFilter[]
    List of settings that specify the type of cluster outage simulation.
    projectId string
    simulationId string
    Unique 24-hexadecimal character string that identifies the outage simulation.
    startRequestDate string
    Date and time when MongoDB Cloud started the regional outage simulation.
    state string
    Current phase of the outage simulation:

    • START_REQUESTED - User has requested cluster outage simulation.
    • STARTING - MongoDB Cloud is starting cluster outage simulation.
    • SIMULATING - MongoDB Cloud is simulating cluster outage.
    • RECOVERY_REQUESTED - User has requested recovery from the simulated outage.
    • RECOVERING - MongoDB Cloud is recovering the cluster from the simulated outage.
    • COMPLETE - MongoDB Cloud has completed the cluster outage simulation.
    cluster_name str
    id str
    The provider-assigned unique ID for this managed resource.
    outage_filters Sequence[GetClusterOutageSimulationOutageFilter]
    List of settings that specify the type of cluster outage simulation.
    project_id str
    simulation_id str
    Unique 24-hexadecimal character string that identifies the outage simulation.
    start_request_date str
    Date and time when MongoDB Cloud started the regional outage simulation.
    state str
    Current phase of the outage simulation:

    • START_REQUESTED - User has requested cluster outage simulation.
    • STARTING - MongoDB Cloud is starting cluster outage simulation.
    • SIMULATING - MongoDB Cloud is simulating cluster outage.
    • RECOVERY_REQUESTED - User has requested recovery from the simulated outage.
    • RECOVERING - MongoDB Cloud is recovering the cluster from the simulated outage.
    • COMPLETE - MongoDB Cloud has completed the cluster outage simulation.
    clusterName String
    id String
    The provider-assigned unique ID for this managed resource.
    outageFilters List<Property Map>
    List of settings that specify the type of cluster outage simulation.
    projectId String
    simulationId String
    Unique 24-hexadecimal character string that identifies the outage simulation.
    startRequestDate String
    Date and time when MongoDB Cloud started the regional outage simulation.
    state String
    Current phase of the outage simulation:

    • START_REQUESTED - User has requested cluster outage simulation.
    • STARTING - MongoDB Cloud is starting cluster outage simulation.
    • SIMULATING - MongoDB Cloud is simulating cluster outage.
    • RECOVERY_REQUESTED - User has requested recovery from the simulated outage.
    • RECOVERING - MongoDB Cloud is recovering the cluster from the simulated outage.
    • COMPLETE - MongoDB Cloud has completed the cluster outage simulation.

    Supporting Types

    GetClusterOutageSimulationOutageFilter

    CloudProvider string
    The cloud provider of the region that undergoes the outage simulation. Following values are supported:

    • AWS
    • GCP
    • AZURE
    RegionName string
    The Atlas name of the region undergoing an outage simulation.
    Type string
    The type of cluster outage simulation. Following values are supported:

    • REGION (Simulates a cluster outage for a region)
    CloudProvider string
    The cloud provider of the region that undergoes the outage simulation. Following values are supported:

    • AWS
    • GCP
    • AZURE
    RegionName string
    The Atlas name of the region undergoing an outage simulation.
    Type string
    The type of cluster outage simulation. Following values are supported:

    • REGION (Simulates a cluster outage for a region)
    cloudProvider String
    The cloud provider of the region that undergoes the outage simulation. Following values are supported:

    • AWS
    • GCP
    • AZURE
    regionName String
    The Atlas name of the region undergoing an outage simulation.
    type String
    The type of cluster outage simulation. Following values are supported:

    • REGION (Simulates a cluster outage for a region)
    cloudProvider string
    The cloud provider of the region that undergoes the outage simulation. Following values are supported:

    • AWS
    • GCP
    • AZURE
    regionName string
    The Atlas name of the region undergoing an outage simulation.
    type string
    The type of cluster outage simulation. Following values are supported:

    • REGION (Simulates a cluster outage for a region)
    cloud_provider str
    The cloud provider of the region that undergoes the outage simulation. Following values are supported:

    • AWS
    • GCP
    • AZURE
    region_name str
    The Atlas name of the region undergoing an outage simulation.
    type str
    The type of cluster outage simulation. Following values are supported:

    • REGION (Simulates a cluster outage for a region)
    cloudProvider String
    The cloud provider of the region that undergoes the outage simulation. Following values are supported:

    • AWS
    • GCP
    • AZURE
    regionName String
    The Atlas name of the region undergoing an outage simulation.
    type String
    The type of cluster outage simulation. Following values are supported:

    • REGION (Simulates a cluster outage for a region)

    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.