Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Mongodbatlas Provider
  4. API Docs
  5. ClusterOverloadSimulation
Viewing docs for MongoDB Atlas v4.17.0
published on Thursday, Oct 1, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-mongodbatlas

mongodbatlas.ClusterOverloadSimulation

mongodbatlas logo mongodbatlas logo
Viewing docs for MongoDB Atlas v4.17.0
published on Thursday, Oct 1, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-mongodbatlas

    mongodbatlas.ClusterOverloadSimulation starts and deletes an overload protection simulation for one MongoDB Atlas cluster.

    IMPORTANT: An overload protection simulation intentionally applies load to the target cluster. Use it only in an environment where the resulting performance impact is acceptable. See Intelligent Workload Management for more information.

    NOTE: Only one overload protection simulation can exist per cluster at a time. To change its configuration, remove the existing resource and apply, then add it with the new values and apply again.

    Example Usage

    S

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

const thisAdvancedCluster = new mongodbatlas.AdvancedCluster("this", {
    projectId: projectId,
    name: clusterName,
    clusterType: "REPLICASET",
    replicationSpecs: [{
        regionConfigs: [{
            electableSpecs: {
                instanceSize: instanceSize,
                nodeCount: 3,
            },
            providerName: cloudProvider,
            priority: 7,
            regionName: regionName,
        }],
    }],
});
const thisClusterOverloadSimulation = new mongodbatlas.ClusterOverloadSimulation("this", {
    projectId: thisAdvancedCluster.projectId,
    clusterName: thisAdvancedCluster.name,
    durationSeconds: Number(durationSeconds),
});
const _this = mongodbatlas.getClusterOverloadSimulationOutput({
    projectId: thisClusterOverloadSimulation.projectId,
    clusterName: thisClusterOverloadSimulation.clusterName,
    simulationId: thisClusterOverloadSimulation.simulationId,
});

    import pulumi
import pulumi_mongodbatlas as mongodbatlas

this_advanced_cluster = mongodbatlas.AdvancedCluster("this",
    project_id=project_id,
    name=cluster_name,
    cluster_type="REPLICASET",
    replication_specs=[{
        "region_configs": [{
            "electable_specs": {
                "instance_size": instance_size,
                "node_count": 3,
            },
            "provider_name": cloud_provider,
            "priority": 7,
            "region_name": region_name,
        }],
    }])
this_cluster_overload_simulation = mongodbatlas.ClusterOverloadSimulation("this",
    project_id=this_advanced_cluster.project_id,
    cluster_name=this_advanced_cluster.name,
    duration_seconds=int(duration_seconds))
this = mongodbatlas.get_cluster_overload_simulation_output(project_id=this_cluster_overload_simulation.project_id,
    cluster_name=this_cluster_overload_simulation.cluster_name,
    simulation_id=this_cluster_overload_simulation.simulation_id)

    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 {
		thisAdvancedCluster, err := mongodbatlas.NewAdvancedCluster(ctx, "this", &mongodbatlas.AdvancedClusterArgs{
			ProjectId:   pulumi.Any(projectId),
			Name:        pulumi.Any(clusterName),
			ClusterType: pulumi.String("REPLICASET"),
			ReplicationSpecs: mongodbatlas.AdvancedClusterReplicationSpecArray{
				&mongodbatlas.AdvancedClusterReplicationSpecArgs{
					RegionConfigs: mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArray{
						&mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArgs{
							ElectableSpecs: &mongodbatlas.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs{
								InstanceSize: pulumi.Any(instanceSize),
								NodeCount:    pulumi.Int(3),
							},
							ProviderName: pulumi.Any(cloudProvider),
							Priority:     pulumi.Int(7),
							RegionName:   pulumi.Any(regionName),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		thisClusterOverloadSimulation, err := mongodbatlas.NewClusterOverloadSimulation(ctx, "this", &mongodbatlas.ClusterOverloadSimulationArgs{
			ProjectId:       thisAdvancedCluster.ProjectId,
			ClusterName:     thisAdvancedCluster.Name,
			DurationSeconds: pulumi.Any(durationSeconds),
		})
		if err != nil {
			return err
		}
		_ = mongodbatlas.GetClusterOverloadSimulationOutput(ctx, mongodbatlas.GetClusterOverloadSimulationOutputArgs{
			ProjectId:    thisClusterOverloadSimulation.ProjectId,
			ClusterName:  thisClusterOverloadSimulation.ClusterName,
			SimulationId: thisClusterOverloadSimulation.SimulationId,
		}, nil)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

return await Deployment.RunAsync(() => 
{
    var thisAdvancedCluster = new Mongodbatlas.AdvancedCluster("this", new()
    {
        ProjectId = projectId,
        Name = clusterName,
        ClusterType = "REPLICASET",
        ReplicationSpecs = new[]
        {
            new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecArgs
            {
                RegionConfigs = new[]
                {
                    new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigArgs
                    {
                        ElectableSpecs = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs
                        {
                            InstanceSize = instanceSize,
                            NodeCount = 3,
                        },
                        ProviderName = cloudProvider,
                        Priority = 7,
                        RegionName = regionName,
                    },
                },
            },
        },
    });

    var thisClusterOverloadSimulation = new Mongodbatlas.ClusterOverloadSimulation("this", new()
    {
        ProjectId = thisAdvancedCluster.ProjectId,
        ClusterName = thisAdvancedCluster.Name,
        DurationSeconds = durationSeconds,
    });

    var @this = Mongodbatlas.GetClusterOverloadSimulation.Invoke(new()
    {
        ProjectId = thisClusterOverloadSimulation.ProjectId,
        ClusterName = thisClusterOverloadSimulation.ClusterName,
        SimulationId = thisClusterOverloadSimulation.SimulationId,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.AdvancedCluster;
import com.pulumi.mongodbatlas.AdvancedClusterArgs;
import com.pulumi.mongodbatlas.inputs.AdvancedClusterReplicationSpecArgs;
import com.pulumi.mongodbatlas.inputs.AdvancedClusterReplicationSpecRegionConfigArgs;
import com.pulumi.mongodbatlas.inputs.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs;
import com.pulumi.mongodbatlas.ClusterOverloadSimulation;
import com.pulumi.mongodbatlas.ClusterOverloadSimulationArgs;
import com.pulumi.mongodbatlas.MongodbatlasFunctions;
import com.pulumi.mongodbatlas.inputs.GetClusterOverloadSimulationArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 thisAdvancedCluster = new AdvancedCluster("thisAdvancedCluster", AdvancedClusterArgs.builder()
            .projectId(projectId)
            .name(clusterName)
            .clusterType("REPLICASET")
            .replicationSpecs(AdvancedClusterReplicationSpecArgs.builder()
                .regionConfigs(AdvancedClusterReplicationSpecRegionConfigArgs.builder()
                    .electableSpecs(AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs.builder()
                        .instanceSize(instanceSize)
                        .nodeCount(3)
                        .build())
                    .providerName(cloudProvider)
                    .priority(7)
                    .regionName(regionName)
                    .build())
                .build())
            .build());

        var thisClusterOverloadSimulation = new ClusterOverloadSimulation("thisClusterOverloadSimulation", ClusterOverloadSimulationArgs.builder()
            .projectId(thisAdvancedCluster.projectId())
            .clusterName(thisAdvancedCluster.name())
            .durationSeconds(durationSeconds)
            .build());

        final var this = MongodbatlasFunctions.getClusterOverloadSimulation(GetClusterOverloadSimulationArgs.builder()
            .projectId(thisClusterOverloadSimulation.projectId())
            .clusterName(thisClusterOverloadSimulation.clusterName())
            .simulationId(thisClusterOverloadSimulation.simulationId())
            .build());

    }
}

    resources:
  thisAdvancedCluster:
    type: mongodbatlas:AdvancedCluster
    name: this
    properties:
      projectId: ${projectId}
      name: ${clusterName}
      clusterType: REPLICASET
      replicationSpecs:
        - regionConfigs:
            - electableSpecs:
                instanceSize: ${instanceSize}
                nodeCount: 3
              providerName: ${cloudProvider}
              priority: 7
              regionName: ${regionName}
  thisClusterOverloadSimulation:
    type: mongodbatlas:ClusterOverloadSimulation
    name: this
    properties:
      projectId: ${thisAdvancedCluster.projectId}
      clusterName: ${thisAdvancedCluster.name}
      durationSeconds: ${durationSeconds}
variables:
  this:
    fn::invoke:
      function: mongodbatlas:getClusterOverloadSimulation
      arguments:
        projectId: ${thisClusterOverloadSimulation.projectId}
        clusterName: ${thisClusterOverloadSimulation.clusterName}
        simulationId: ${thisClusterOverloadSimulation.simulationId}

    pulumi {
  required_providers {
    mongodbatlas = {
      source = "pulumi/mongodbatlas"
    }
  }
}

data "mongodbatlas_getclusteroverloadsimulation" "this" {
  project_id    = mongodbatlas_clusteroverloadsimulation.this.project_id
  cluster_name  = mongodbatlas_clusteroverloadsimulation.this.cluster_name
  simulation_id = mongodbatlas_clusteroverloadsimulation.this.simulation_id
}

resource "mongodbatlas_advancedcluster" "this" {
  project_id   = projectId
  name         = clusterName
  cluster_type = "REPLICASET"
  replication_specs {
    region_configs {
      electable_specs = {
        instance_size = instanceSize
        node_count    = 3
      }
      provider_name = cloudProvider
      priority      = 7
      region_name   = regionName
    }
  }
}
resource "mongodbatlas_clusteroverloadsimulation" "this" {
  project_id       = mongodbatlas_advancedcluster.this.project_id
  cluster_name     = mongodbatlas_advancedcluster.this.name
  duration_seconds = durationSeconds
}

    Create ClusterOverloadSimulation Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ClusterOverloadSimulation(name: string, args: ClusterOverloadSimulationArgs, opts?: CustomResourceOptions);
    @overload
def ClusterOverloadSimulation(resource_name: str,
                              args: ClusterOverloadSimulationArgs,
                              opts: Optional[ResourceOptions] = None)

@overload
def ClusterOverloadSimulation(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              cluster_name: Optional[str] = None,
                              duration_seconds: Optional[int] = None,
                              project_id: Optional[str] = None,
                              delete_on_create_timeout: Optional[bool] = None,
                              timeouts: Optional[ClusterOverloadSimulationTimeoutsArgs] = None)
    func NewClusterOverloadSimulation(ctx *Context, name string, args ClusterOverloadSimulationArgs, opts ...ResourceOption) (*ClusterOverloadSimulation, error)
    public ClusterOverloadSimulation(string name, ClusterOverloadSimulationArgs args, CustomResourceOptions? opts = null)
    public ClusterOverloadSimulation(String name, ClusterOverloadSimulationArgs args)
public ClusterOverloadSimulation(String name, ClusterOverloadSimulationArgs args, CustomResourceOptions options)

    type: mongodbatlas:ClusterOverloadSimulation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "mongodbatlas_cluster_overload_simulation" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args ClusterOverloadSimulationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ClusterOverloadSimulationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ClusterOverloadSimulationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterOverloadSimulationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterOverloadSimulationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var clusterOverloadSimulationResource = new Mongodbatlas.ClusterOverloadSimulation("clusterOverloadSimulationResource", new()
{
    ClusterName = "string",
    DurationSeconds = 0,
    ProjectId = "string",
    DeleteOnCreateTimeout = false,
    Timeouts = new Mongodbatlas.Inputs.ClusterOverloadSimulationTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
    },
});

    example, err := mongodbatlas.NewClusterOverloadSimulation(ctx, "clusterOverloadSimulationResource", &mongodbatlas.ClusterOverloadSimulationArgs{
	ClusterName:           pulumi.String("string"),
	DurationSeconds:       pulumi.Int(0),
	ProjectId:             pulumi.String("string"),
	DeleteOnCreateTimeout: pulumi.Bool(false),
	Timeouts: &mongodbatlas.ClusterOverloadSimulationTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
	},
})

    resource "mongodbatlas_cluster_overload_simulation" "clusterOverloadSimulationResource" {
  lifecycle {
    create_before_destroy = true
  }
  cluster_name             = "string"
  duration_seconds         = 0
  project_id               = "string"
  delete_on_create_timeout = false
  timeouts = {
    create = "string"
    delete = "string"
  }
}

    var clusterOverloadSimulationResource = new ClusterOverloadSimulation("clusterOverloadSimulationResource", ClusterOverloadSimulationArgs.builder()
    .clusterName("string")
    .durationSeconds(0)
    .projectId("string")
    .deleteOnCreateTimeout(false)
    .timeouts(ClusterOverloadSimulationTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .build())
    .build());

    cluster_overload_simulation_resource = mongodbatlas.ClusterOverloadSimulation("clusterOverloadSimulationResource",
    cluster_name="string",
    duration_seconds=0,
    project_id="string",
    delete_on_create_timeout=False,
    timeouts={
        "create": "string",
        "delete": "string",
    })

    const clusterOverloadSimulationResource = new mongodbatlas.ClusterOverloadSimulation("clusterOverloadSimulationResource", {
    clusterName: "string",
    durationSeconds: 0,
    projectId: "string",
    deleteOnCreateTimeout: false,
    timeouts: {
        create: "string",
        "delete": "string",
    },
});

    type: mongodbatlas:ClusterOverloadSimulation
properties:
    clusterName: string
    deleteOnCreateTimeout: false
    durationSeconds: 0
    projectId: string
    timeouts:
        create: string
        delete: string

    ClusterOverloadSimulation Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ClusterOverloadSimulation resource accepts the following input properties:

    ClusterName string
    Human-readable label that identifies the cluster on which to start the overload protection simulation.
    DurationSeconds int
    Duration of the overload protection simulation in seconds.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    DeleteOnCreateTimeout bool
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    Timeouts ClusterOverloadSimulationTimeouts
    ClusterName string
    Human-readable label that identifies the cluster on which to start the overload protection simulation.
    DurationSeconds int
    Duration of the overload protection simulation in seconds.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    DeleteOnCreateTimeout bool
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    Timeouts ClusterOverloadSimulationTimeoutsArgs
    cluster_name string
    Human-readable label that identifies the cluster on which to start the overload protection simulation.
    duration_seconds number
    Duration of the overload protection simulation in seconds.
    project_id string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    delete_on_create_timeout bool
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    timeouts object
    clusterName String
    Human-readable label that identifies the cluster on which to start the overload protection simulation.
    durationSeconds Integer
    Duration of the overload protection simulation in seconds.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    deleteOnCreateTimeout Boolean
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    timeouts ClusterOverloadSimulationTimeouts
    clusterName string
    Human-readable label that identifies the cluster on which to start the overload protection simulation.
    durationSeconds number
    Duration of the overload protection simulation in seconds.
    projectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    deleteOnCreateTimeout boolean
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    timeouts ClusterOverloadSimulationTimeouts
    cluster_name str
    Human-readable label that identifies the cluster on which to start the overload protection simulation.
    duration_seconds int
    Duration of the overload protection simulation in seconds.
    project_id str
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    delete_on_create_timeout bool
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    timeouts ClusterOverloadSimulationTimeoutsArgs
    clusterName String
    Human-readable label that identifies the cluster on which to start the overload protection simulation.
    durationSeconds Number
    Duration of the overload protection simulation in seconds.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    deleteOnCreateTimeout Boolean
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    timeouts Property Map

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ClusterOverloadSimulation resource produces the following output properties:

    CancelRequestedAt string
    Date and time when cancellation of the overload protection simulation was requested. This parameter is only present when a cancellation has been requested and expresses its value in the ISO 8601 timestamp format in UTC.
    ExpiresAt string
    Date and time when the overload protection simulation expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    Id string
    The provider-assigned unique ID for this managed resource.
    RequestDate string
    Date and time when the overload protection simulation was requested. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    SimulationId string
    Unique identifier of the overload protection simulation.
    State string
    Current state of the overload protection simulation.
    CancelRequestedAt string
    Date and time when cancellation of the overload protection simulation was requested. This parameter is only present when a cancellation has been requested and expresses its value in the ISO 8601 timestamp format in UTC.
    ExpiresAt string
    Date and time when the overload protection simulation expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    Id string
    The provider-assigned unique ID for this managed resource.
    RequestDate string
    Date and time when the overload protection simulation was requested. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    SimulationId string
    Unique identifier of the overload protection simulation.
    State string
    Current state of the overload protection simulation.
    cancel_requested_at string
    Date and time when cancellation of the overload protection simulation was requested. This parameter is only present when a cancellation has been requested and expresses its value in the ISO 8601 timestamp format in UTC.
    expires_at string
    Date and time when the overload protection simulation expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    id string
    The provider-assigned unique ID for this managed resource.
    request_date string
    Date and time when the overload protection simulation was requested. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    simulation_id string
    Unique identifier of the overload protection simulation.
    state string
    Current state of the overload protection simulation.
    cancelRequestedAt String
    Date and time when cancellation of the overload protection simulation was requested. This parameter is only present when a cancellation has been requested and expresses its value in the ISO 8601 timestamp format in UTC.
    expiresAt String
    Date and time when the overload protection simulation expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    id String
    The provider-assigned unique ID for this managed resource.
    requestDate String
    Date and time when the overload protection simulation was requested. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    simulationId String
    Unique identifier of the overload protection simulation.
    state String
    Current state of the overload protection simulation.
    cancelRequestedAt string
    Date and time when cancellation of the overload protection simulation was requested. This parameter is only present when a cancellation has been requested and expresses its value in the ISO 8601 timestamp format in UTC.
    expiresAt string
    Date and time when the overload protection simulation expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    id string
    The provider-assigned unique ID for this managed resource.
    requestDate string
    Date and time when the overload protection simulation was requested. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    simulationId string
    Unique identifier of the overload protection simulation.
    state string
    Current state of the overload protection simulation.
    cancel_requested_at str
    Date and time when cancellation of the overload protection simulation was requested. This parameter is only present when a cancellation has been requested and expresses its value in the ISO 8601 timestamp format in UTC.
    expires_at str
    Date and time when the overload protection simulation expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    id str
    The provider-assigned unique ID for this managed resource.
    request_date str
    Date and time when the overload protection simulation was requested. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    simulation_id str
    Unique identifier of the overload protection simulation.
    state str
    Current state of the overload protection simulation.
    cancelRequestedAt String
    Date and time when cancellation of the overload protection simulation was requested. This parameter is only present when a cancellation has been requested and expresses its value in the ISO 8601 timestamp format in UTC.
    expiresAt String
    Date and time when the overload protection simulation expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    id String
    The provider-assigned unique ID for this managed resource.
    requestDate String
    Date and time when the overload protection simulation was requested. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    simulationId String
    Unique identifier of the overload protection simulation.
    state String
    Current state of the overload protection simulation.

    Look up Existing ClusterOverloadSimulation Resource

    Get an existing ClusterOverloadSimulation resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ClusterOverloadSimulationState, opts?: CustomResourceOptions): ClusterOverloadSimulation
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cancel_requested_at: Optional[str] = None,
        cluster_name: Optional[str] = None,
        delete_on_create_timeout: Optional[bool] = None,
        duration_seconds: Optional[int] = None,
        expires_at: Optional[str] = None,
        project_id: Optional[str] = None,
        request_date: Optional[str] = None,
        simulation_id: Optional[str] = None,
        state: Optional[str] = None,
        timeouts: Optional[ClusterOverloadSimulationTimeoutsArgs] = None) -> ClusterOverloadSimulation
    func GetClusterOverloadSimulation(ctx *Context, name string, id IDInput, state *ClusterOverloadSimulationState, opts ...ResourceOption) (*ClusterOverloadSimulation, error)
    public static ClusterOverloadSimulation Get(string name, Input<string> id, ClusterOverloadSimulationState? state, CustomResourceOptions? opts = null)
    public static ClusterOverloadSimulation get(String name, Output<String> id, ClusterOverloadSimulationState state, CustomResourceOptions options)
    resources:  _:    type: mongodbatlas:ClusterOverloadSimulation    get:      id: ${id}
    import {
  to = mongodbatlas_cluster_overload_simulation.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CancelRequestedAt string
    Date and time when cancellation of the overload protection simulation was requested. This parameter is only present when a cancellation has been requested and expresses its value in the ISO 8601 timestamp format in UTC.
    ClusterName string
    Human-readable label that identifies the cluster on which to start the overload protection simulation.
    DeleteOnCreateTimeout bool
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    DurationSeconds int
    Duration of the overload protection simulation in seconds.
    ExpiresAt string
    Date and time when the overload protection simulation expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    RequestDate string
    Date and time when the overload protection simulation was requested. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    SimulationId string
    Unique identifier of the overload protection simulation.
    State string
    Current state of the overload protection simulation.
    Timeouts ClusterOverloadSimulationTimeouts
    CancelRequestedAt string
    Date and time when cancellation of the overload protection simulation was requested. This parameter is only present when a cancellation has been requested and expresses its value in the ISO 8601 timestamp format in UTC.
    ClusterName string
    Human-readable label that identifies the cluster on which to start the overload protection simulation.
    DeleteOnCreateTimeout bool
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    DurationSeconds int
    Duration of the overload protection simulation in seconds.
    ExpiresAt string
    Date and time when the overload protection simulation expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    RequestDate string
    Date and time when the overload protection simulation was requested. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    SimulationId string
    Unique identifier of the overload protection simulation.
    State string
    Current state of the overload protection simulation.
    Timeouts ClusterOverloadSimulationTimeoutsArgs
    cancel_requested_at string
    Date and time when cancellation of the overload protection simulation was requested. This parameter is only present when a cancellation has been requested and expresses its value in the ISO 8601 timestamp format in UTC.
    cluster_name string
    Human-readable label that identifies the cluster on which to start the overload protection simulation.
    delete_on_create_timeout bool
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    duration_seconds number
    Duration of the overload protection simulation in seconds.
    expires_at string
    Date and time when the overload protection simulation expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    project_id string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    request_date string
    Date and time when the overload protection simulation was requested. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    simulation_id string
    Unique identifier of the overload protection simulation.
    state string
    Current state of the overload protection simulation.
    timeouts object
    cancelRequestedAt String
    Date and time when cancellation of the overload protection simulation was requested. This parameter is only present when a cancellation has been requested and expresses its value in the ISO 8601 timestamp format in UTC.
    clusterName String
    Human-readable label that identifies the cluster on which to start the overload protection simulation.
    deleteOnCreateTimeout Boolean
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    durationSeconds Integer
    Duration of the overload protection simulation in seconds.
    expiresAt String
    Date and time when the overload protection simulation expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    requestDate String
    Date and time when the overload protection simulation was requested. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    simulationId String
    Unique identifier of the overload protection simulation.
    state String
    Current state of the overload protection simulation.
    timeouts ClusterOverloadSimulationTimeouts
    cancelRequestedAt string
    Date and time when cancellation of the overload protection simulation was requested. This parameter is only present when a cancellation has been requested and expresses its value in the ISO 8601 timestamp format in UTC.
    clusterName string
    Human-readable label that identifies the cluster on which to start the overload protection simulation.
    deleteOnCreateTimeout boolean
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    durationSeconds number
    Duration of the overload protection simulation in seconds.
    expiresAt string
    Date and time when the overload protection simulation expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    projectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    requestDate string
    Date and time when the overload protection simulation was requested. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    simulationId string
    Unique identifier of the overload protection simulation.
    state string
    Current state of the overload protection simulation.
    timeouts ClusterOverloadSimulationTimeouts
    cancel_requested_at str
    Date and time when cancellation of the overload protection simulation was requested. This parameter is only present when a cancellation has been requested and expresses its value in the ISO 8601 timestamp format in UTC.
    cluster_name str
    Human-readable label that identifies the cluster on which to start the overload protection simulation.
    delete_on_create_timeout bool
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    duration_seconds int
    Duration of the overload protection simulation in seconds.
    expires_at str
    Date and time when the overload protection simulation expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    project_id str
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    request_date str
    Date and time when the overload protection simulation was requested. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    simulation_id str
    Unique identifier of the overload protection simulation.
    state str
    Current state of the overload protection simulation.
    timeouts ClusterOverloadSimulationTimeoutsArgs
    cancelRequestedAt String
    Date and time when cancellation of the overload protection simulation was requested. This parameter is only present when a cancellation has been requested and expresses its value in the ISO 8601 timestamp format in UTC.
    clusterName String
    Human-readable label that identifies the cluster on which to start the overload protection simulation.
    deleteOnCreateTimeout Boolean
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    durationSeconds Number
    Duration of the overload protection simulation in seconds.
    expiresAt String
    Date and time when the overload protection simulation expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    requestDate String
    Date and time when the overload protection simulation was requested. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
    simulationId String
    Unique identifier of the overload protection simulation.
    state String
    Current state of the overload protection simulation.
    timeouts Property Map

    Supporting Types

    ClusterOverloadSimulationTimeouts, ClusterOverloadSimulationTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.

    Import

    Import a cluster overload simulation by using the project ID, cluster name, and simulation ID in the format PROJECT_ID/CLUSTER_NAME/SIMULATION_ID, for example:

    $ pulumi import mongodbatlas:index/clusterOverloadSimulation:ClusterOverloadSimulation this 0123456789abcdef01234567/Cluster0/89abcdef0123456701234567

    To learn more about importing existing cloud resources, see Importing resources.

    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 mongodbatlas logo
    Viewing docs for MongoDB Atlas v4.17.0
    published on Thursday, Oct 1, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-mongodbatlas

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial