1. Registry
  2. Packages
  3. Mongodbatlas Provider
  4. API Docs
  5. getClusterAdaptiveSettings
Viewing docs for MongoDB Atlas v4.17.0
published on Thursday, Oct 1, 2026 by Pulumi
mongodbatlas logo mongodbatlas logo
Viewing docs for MongoDB Atlas v4.17.0
published on Thursday, Oct 1, 2026 by Pulumi

    mongodbatlas.ClusterAdaptiveSettings describes the Adaptive Settings overrides and effective settings for one MongoDB Atlas cluster.

    Example Usage

    S

    import * as pulumi from "@pulumi/pulumi";
    import * as mongodbatlas from "@pulumi/mongodbatlas";
    
    // Manage Adaptive Settings overrides for an existing MongoDB Atlas cluster and read the resulting effective settings with the corresponding data source.
    const thisClusterAdaptiveSettings = new mongodbatlas.ClusterAdaptiveSettings("this", {
        projectId: projectId,
        clusterName: clusterName,
        adaptiveSettingsOverrides: JSON.stringify({
            LOAD_SHEDDING: loadSheddingEnabled,
            SEARCH_LOAD_SHEDDING: searchLoadSheddingEnabled,
        }),
    });
    const _this = mongodbatlas.getClusterAdaptiveSettingsOutput({
        projectId: thisClusterAdaptiveSettings.projectId,
        clusterName: thisClusterAdaptiveSettings.clusterName,
    });
    
    import pulumi
    import json
    import pulumi_mongodbatlas as mongodbatlas
    
    # Manage Adaptive Settings overrides for an existing MongoDB Atlas cluster and read the resulting effective settings with the corresponding data source.
    this_cluster_adaptive_settings = mongodbatlas.ClusterAdaptiveSettings("this",
        project_id=project_id,
        cluster_name=cluster_name,
        adaptive_settings_overrides=json.dumps({
            "LOAD_SHEDDING": load_shedding_enabled,
            "SEARCH_LOAD_SHEDDING": search_load_shedding_enabled,
        }))
    this = mongodbatlas.get_cluster_adaptive_settings_output(project_id=this_cluster_adaptive_settings.project_id,
        cluster_name=this_cluster_adaptive_settings.cluster_name)
    
    package main
    
    import (
    	"encoding/json"
    
    	"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 {
    		tmpJSON0, err := json.Marshal(map[string]interface{}{
    			"LOAD_SHEDDING":        loadSheddingEnabled,
    			"SEARCH_LOAD_SHEDDING": searchLoadSheddingEnabled,
    		})
    		if err != nil {
    			return err
    		}
    		json0 := string(tmpJSON0)
    		// Manage Adaptive Settings overrides for an existing MongoDB Atlas cluster and read the resulting effective settings with the corresponding data source.
    		thisClusterAdaptiveSettings, err := mongodbatlas.NewClusterAdaptiveSettings(ctx, "this", &mongodbatlas.ClusterAdaptiveSettingsArgs{
    			ProjectId:                 pulumi.Any(projectId),
    			ClusterName:               pulumi.Any(clusterName),
    			AdaptiveSettingsOverrides: pulumi.String(json0),
    		})
    		if err != nil {
    			return err
    		}
    		_ = mongodbatlas.GetClusterAdaptiveSettingsOutput(ctx, mongodbatlas.GetClusterAdaptiveSettingsOutputArgs{
    			ProjectId:   thisClusterAdaptiveSettings.ProjectId,
    			ClusterName: thisClusterAdaptiveSettings.ClusterName,
    		}, nil)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using System.Text.Json;
    using Pulumi;
    using Mongodbatlas = Pulumi.Mongodbatlas;
    
    return await Deployment.RunAsync(() => 
    {
        // Manage Adaptive Settings overrides for an existing MongoDB Atlas cluster and read the resulting effective settings with the corresponding data source.
        var thisClusterAdaptiveSettings = new Mongodbatlas.ClusterAdaptiveSettings("this", new()
        {
            ProjectId = projectId,
            ClusterName = clusterName,
            AdaptiveSettingsOverrides = JsonSerializer.Serialize(new Dictionary<string, object?>
            {
                ["LOAD_SHEDDING"] = loadSheddingEnabled,
                ["SEARCH_LOAD_SHEDDING"] = searchLoadSheddingEnabled,
            }),
        });
    
        var @this = Mongodbatlas.GetClusterAdaptiveSettings.Invoke(new()
        {
            ProjectId = thisClusterAdaptiveSettings.ProjectId,
            ClusterName = thisClusterAdaptiveSettings.ClusterName,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.mongodbatlas.ClusterAdaptiveSettings;
    import com.pulumi.mongodbatlas.ClusterAdaptiveSettingsArgs;
    import com.pulumi.mongodbatlas.MongodbatlasFunctions;
    import com.pulumi.mongodbatlas.inputs.GetClusterAdaptiveSettingsArgs;
    import static com.pulumi.codegen.internal.Serialization.*;
    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) {
            // Manage Adaptive Settings overrides for an existing MongoDB Atlas cluster and read the resulting effective settings with the corresponding data source.
            var thisClusterAdaptiveSettings = new ClusterAdaptiveSettings("thisClusterAdaptiveSettings", ClusterAdaptiveSettingsArgs.builder()
                .projectId(projectId)
                .clusterName(clusterName)
                .adaptiveSettingsOverrides(serializeJson(
                    jsonObject(
                        jsonProperty("LOAD_SHEDDING", loadSheddingEnabled),
                        jsonProperty("SEARCH_LOAD_SHEDDING", searchLoadSheddingEnabled)
                    )))
                .build());
    
            final var this = MongodbatlasFunctions.getClusterAdaptiveSettings(GetClusterAdaptiveSettingsArgs.builder()
                .projectId(thisClusterAdaptiveSettings.projectId())
                .clusterName(thisClusterAdaptiveSettings.clusterName())
                .build());
    
        }
    }
    
    resources:
      # Manage Adaptive Settings overrides for an existing MongoDB Atlas cluster and read the resulting effective settings with the corresponding data source.
      thisClusterAdaptiveSettings:
        type: mongodbatlas:ClusterAdaptiveSettings
        name: this
        properties:
          projectId: ${projectId}
          clusterName: ${clusterName}
          adaptiveSettingsOverrides:
            fn::toJSON:
              LOAD_SHEDDING: ${loadSheddingEnabled}
              SEARCH_LOAD_SHEDDING: ${searchLoadSheddingEnabled}
    variables:
      this:
        fn::invoke:
          function: mongodbatlas:getClusterAdaptiveSettings
          arguments:
            projectId: ${thisClusterAdaptiveSettings.projectId}
            clusterName: ${thisClusterAdaptiveSettings.clusterName}
    
    pulumi {
      required_providers {
        mongodbatlas = {
          source = "pulumi/mongodbatlas"
        }
      }
    }
    
    data "mongodbatlas_getclusteradaptivesettings" "this" {
      project_id   = mongodbatlas_clusteradaptivesettings.this.project_id
      cluster_name = mongodbatlas_clusteradaptivesettings.this.cluster_name
    }
    
    # Manage Adaptive Settings overrides for an existing MongoDB Atlas cluster and read the resulting effective settings with the corresponding data source.
    resource "mongodbatlas_clusteradaptivesettings" "this" {
      project_id   = projectId
      cluster_name = clusterName
      adaptive_settings_overrides = jsonencode({
        "LOAD_SHEDDING"        = loadSheddingEnabled
        "SEARCH_LOAD_SHEDDING" = searchLoadSheddingEnabled
      })
    }
    

    Using getClusterAdaptiveSettings

    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 getClusterAdaptiveSettings(args: GetClusterAdaptiveSettingsArgs, opts?: InvokeOptions): Promise<GetClusterAdaptiveSettingsResult>
    function getClusterAdaptiveSettingsOutput(args: GetClusterAdaptiveSettingsOutputArgs, opts?: InvokeOutputOptions): Output<GetClusterAdaptiveSettingsResult>
    def get_cluster_adaptive_settings(cluster_name: Optional[str] = None,
                                      project_id: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetClusterAdaptiveSettingsResult
    def get_cluster_adaptive_settings_output(cluster_name: pulumi.Input[Optional[str]] = None,
                                      project_id: pulumi.Input[Optional[str]] = None,
                                      opts: Optional[InvokeOutputOptions] = None) -> Output[GetClusterAdaptiveSettingsResult]
    func LookupClusterAdaptiveSettings(ctx *Context, args *LookupClusterAdaptiveSettingsArgs, opts ...InvokeOption) (*LookupClusterAdaptiveSettingsResult, error)
    func LookupClusterAdaptiveSettingsOutput(ctx *Context, args *LookupClusterAdaptiveSettingsOutputArgs, opts ...InvokeOption) LookupClusterAdaptiveSettingsResultOutput

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

    public static class GetClusterAdaptiveSettings 
    {
        public static Task<GetClusterAdaptiveSettingsResult> InvokeAsync(GetClusterAdaptiveSettingsArgs args, InvokeOptions? opts = null)
        public static Output<GetClusterAdaptiveSettingsResult> Invoke(GetClusterAdaptiveSettingsInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetClusterAdaptiveSettingsResult> Invoke(GetClusterAdaptiveSettingsInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetClusterAdaptiveSettingsResult> getClusterAdaptiveSettings(GetClusterAdaptiveSettingsArgs args, InvokeOptions options)
    public static Output<GetClusterAdaptiveSettingsResult> getClusterAdaptiveSettings(GetClusterAdaptiveSettingsArgs args, InvokeOptions options)
    public static Output<GetClusterAdaptiveSettingsResult> getClusterAdaptiveSettings(GetClusterAdaptiveSettingsArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: mongodbatlas:index/getClusterAdaptiveSettings:getClusterAdaptiveSettings
      arguments:
        # arguments dictionary
    data "mongodbatlas_get_cluster_adaptive_settings" "name" {
        # arguments
    }

    The following arguments are supported:

    ClusterName string
    Human-readable label that identifies the cluster.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    ClusterName string
    Human-readable label that identifies the cluster.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    cluster_name string
    Human-readable label that identifies the cluster.
    project_id string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    clusterName String
    Human-readable label that identifies the cluster.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    clusterName string
    Human-readable label that identifies the cluster.
    projectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    cluster_name str
    Human-readable label that identifies the cluster.
    project_id str
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    clusterName String
    Human-readable label that identifies the cluster.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.

    getClusterAdaptiveSettings Result

    The following output properties are available:

    AdaptiveSettingsOverrides string
    JSON-encoded map of customer-specified Adaptive Settings overrides, applied on a best-effort basis. Use jsonencode to configure this attribute. Each supported entry that you specify takes precedence over the corresponding Atlas-managed default.
    ClusterName string
    Human-readable label that identifies the cluster.
    EffectiveAdaptiveSettings string
    JSON-encoded map of the effective Adaptive Settings currently applied to your cluster, based on your overrides and Atlas-managed defaults. Atlas-managed defaults can vary by MongoDB version. An override for a setting unsupported by the cluster's MongoDB version doesn't take effect, and the effective value reflects the Atlas-managed default.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    AdaptiveSettingsOverrides string
    JSON-encoded map of customer-specified Adaptive Settings overrides, applied on a best-effort basis. Use jsonencode to configure this attribute. Each supported entry that you specify takes precedence over the corresponding Atlas-managed default.
    ClusterName string
    Human-readable label that identifies the cluster.
    EffectiveAdaptiveSettings string
    JSON-encoded map of the effective Adaptive Settings currently applied to your cluster, based on your overrides and Atlas-managed defaults. Atlas-managed defaults can vary by MongoDB version. An override for a setting unsupported by the cluster's MongoDB version doesn't take effect, and the effective value reflects the Atlas-managed default.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    adaptive_settings_overrides string
    JSON-encoded map of customer-specified Adaptive Settings overrides, applied on a best-effort basis. Use jsonencode to configure this attribute. Each supported entry that you specify takes precedence over the corresponding Atlas-managed default.
    cluster_name string
    Human-readable label that identifies the cluster.
    effective_adaptive_settings string
    JSON-encoded map of the effective Adaptive Settings currently applied to your cluster, based on your overrides and Atlas-managed defaults. Atlas-managed defaults can vary by MongoDB version. An override for a setting unsupported by the cluster's MongoDB version doesn't take effect, and the effective value reflects the Atlas-managed default.
    project_id string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    adaptiveSettingsOverrides String
    JSON-encoded map of customer-specified Adaptive Settings overrides, applied on a best-effort basis. Use jsonencode to configure this attribute. Each supported entry that you specify takes precedence over the corresponding Atlas-managed default.
    clusterName String
    Human-readable label that identifies the cluster.
    effectiveAdaptiveSettings String
    JSON-encoded map of the effective Adaptive Settings currently applied to your cluster, based on your overrides and Atlas-managed defaults. Atlas-managed defaults can vary by MongoDB version. An override for a setting unsupported by the cluster's MongoDB version doesn't take effect, and the effective value reflects the Atlas-managed default.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    adaptiveSettingsOverrides string
    JSON-encoded map of customer-specified Adaptive Settings overrides, applied on a best-effort basis. Use jsonencode to configure this attribute. Each supported entry that you specify takes precedence over the corresponding Atlas-managed default.
    clusterName string
    Human-readable label that identifies the cluster.
    effectiveAdaptiveSettings string
    JSON-encoded map of the effective Adaptive Settings currently applied to your cluster, based on your overrides and Atlas-managed defaults. Atlas-managed defaults can vary by MongoDB version. An override for a setting unsupported by the cluster's MongoDB version doesn't take effect, and the effective value reflects the Atlas-managed default.
    projectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    adaptive_settings_overrides str
    JSON-encoded map of customer-specified Adaptive Settings overrides, applied on a best-effort basis. Use jsonencode to configure this attribute. Each supported entry that you specify takes precedence over the corresponding Atlas-managed default.
    cluster_name str
    Human-readable label that identifies the cluster.
    effective_adaptive_settings str
    JSON-encoded map of the effective Adaptive Settings currently applied to your cluster, based on your overrides and Atlas-managed defaults. Atlas-managed defaults can vary by MongoDB version. An override for a setting unsupported by the cluster's MongoDB version doesn't take effect, and the effective value reflects the Atlas-managed default.
    project_id str
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    adaptiveSettingsOverrides String
    JSON-encoded map of customer-specified Adaptive Settings overrides, applied on a best-effort basis. Use jsonencode to configure this attribute. Each supported entry that you specify takes precedence over the corresponding Atlas-managed default.
    clusterName String
    Human-readable label that identifies the cluster.
    effectiveAdaptiveSettings String
    JSON-encoded map of the effective Adaptive Settings currently applied to your cluster, based on your overrides and Atlas-managed defaults. Atlas-managed defaults can vary by MongoDB version. An override for a setting unsupported by the cluster's MongoDB version doesn't take effect, and the effective value reflects the Atlas-managed default.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.

    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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial