MongoDB Atlas v3.20.4, Oct 30 24

MongoDB Atlas v3.20.4 published on Wednesday, Oct 30, 2024 by Pulumi

mongodbatlas.getAdvancedCluster

Explore with Pulumi AI

MongoDB Atlas v3.20.4 published on Wednesday, Oct 30, 2024 by Pulumi

pulumi/pulumi-mongodbatlas

# Data Source: mongodbatlas.AdvancedCluster

mongodbatlas.AdvancedCluster describes an Advanced Cluster. The data source requires your Project ID.

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

IMPORTANT:
• Changes to cluster configurations can affect costs. Before making changes, please see Billing.
• If your Atlas project contains a custom role that uses actions introduced in a specific MongoDB version, you cannot create a cluster with a MongoDB version less than that version unless you delete the custom role.

Example Usage

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

const exampleAdvancedCluster = new mongodbatlas.AdvancedCluster("example", {
    projectId: "<YOUR-PROJECT-ID>",
    name: "cluster-test",
    clusterType: "REPLICASET",
    replicationSpecs: [{
        regionConfigs: [{
            electableSpecs: {
                instanceSize: "M5",
            },
            providerName: "TENANT",
            backingProviderName: "AWS",
            regionName: "US_EAST_1",
            priority: 7,
        }],
    }],
});
const example = mongodbatlas.getAdvancedClusterOutput({
    projectId: exampleAdvancedCluster.projectId,
    name: exampleAdvancedCluster.name,
});

import pulumi
import pulumi_mongodbatlas as mongodbatlas

example_advanced_cluster = mongodbatlas.AdvancedCluster("example",
    project_id="<YOUR-PROJECT-ID>",
    name="cluster-test",
    cluster_type="REPLICASET",
    replication_specs=[{
        "region_configs": [{
            "electable_specs": {
                "instance_size": "M5",
            },
            "provider_name": "TENANT",
            "backing_provider_name": "AWS",
            "region_name": "US_EAST_1",
            "priority": 7,
        }],
    }])
example = mongodbatlas.get_advanced_cluster_output(project_id=example_advanced_cluster.project_id,
    name=example_advanced_cluster.name)

package main

import (
	"github.com/pulumi/pulumi-mongodbatlas/sdk/v3/go/mongodbatlas"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleAdvancedCluster, err := mongodbatlas.NewAdvancedCluster(ctx, "example", &mongodbatlas.AdvancedClusterArgs{
			ProjectId:   pulumi.String("<YOUR-PROJECT-ID>"),
			Name:        pulumi.String("cluster-test"),
			ClusterType: pulumi.String("REPLICASET"),
			ReplicationSpecs: mongodbatlas.AdvancedClusterReplicationSpecArray{
				&mongodbatlas.AdvancedClusterReplicationSpecArgs{
					RegionConfigs: mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArray{
						&mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArgs{
							ElectableSpecs: &mongodbatlas.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs{
								InstanceSize: pulumi.String("M5"),
							},
							ProviderName:        pulumi.String("TENANT"),
							BackingProviderName: pulumi.String("AWS"),
							RegionName:          pulumi.String("US_EAST_1"),
							Priority:            pulumi.Int(7),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		_ = mongodbatlas.LookupAdvancedClusterOutput(ctx, mongodbatlas.GetAdvancedClusterOutputArgs{
			ProjectId: exampleAdvancedCluster.ProjectId,
			Name:      exampleAdvancedCluster.Name,
		}, nil)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var exampleAdvancedCluster = new Mongodbatlas.AdvancedCluster("example", new()
    {
        ProjectId = "<YOUR-PROJECT-ID>",
        Name = "cluster-test",
        ClusterType = "REPLICASET",
        ReplicationSpecs = new[]
        {
            new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecArgs
            {
                RegionConfigs = new[]
                {
                    new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigArgs
                    {
                        ElectableSpecs = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs
                        {
                            InstanceSize = "M5",
                        },
                        ProviderName = "TENANT",
                        BackingProviderName = "AWS",
                        RegionName = "US_EAST_1",
                        Priority = 7,
                    },
                },
            },
        },
    });

    var example = Mongodbatlas.GetAdvancedCluster.Invoke(new()
    {
        ProjectId = exampleAdvancedCluster.ProjectId,
        Name = exampleAdvancedCluster.Name,
    });

});

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.MongodbatlasFunctions;
import com.pulumi.mongodbatlas.inputs.GetAdvancedClusterArgs;
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 exampleAdvancedCluster = new AdvancedCluster("exampleAdvancedCluster", AdvancedClusterArgs.builder()
            .projectId("<YOUR-PROJECT-ID>")
            .name("cluster-test")
            .clusterType("REPLICASET")
            .replicationSpecs(AdvancedClusterReplicationSpecArgs.builder()
                .regionConfigs(AdvancedClusterReplicationSpecRegionConfigArgs.builder()
                    .electableSpecs(AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs.builder()
                        .instanceSize("M5")
                        .build())
                    .providerName("TENANT")
                    .backingProviderName("AWS")
                    .regionName("US_EAST_1")
                    .priority(7)
                    .build())
                .build())
            .build());

        final var example = MongodbatlasFunctions.getAdvancedCluster(GetAdvancedClusterArgs.builder()
            .projectId(exampleAdvancedCluster.projectId())
            .name(exampleAdvancedCluster.name())
            .build());

    }
}

resources:
  exampleAdvancedCluster:
    type: mongodbatlas:AdvancedCluster
    name: example
    properties:
      projectId: <YOUR-PROJECT-ID>
      name: cluster-test
      clusterType: REPLICASET
      replicationSpecs:
        - regionConfigs:
            - electableSpecs:
                instanceSize: M5
              providerName: TENANT
              backingProviderName: AWS
              regionName: US_EAST_1
              priority: 7
variables:
  example:
    fn::invoke:
      Function: mongodbatlas:getAdvancedCluster
      Arguments:
        projectId: ${exampleAdvancedCluster.projectId}
        name: ${exampleAdvancedCluster.name}

Example using latest sharding configurations with independent shard scaling in the cluster

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

const exampleAdvancedCluster = new mongodbatlas.AdvancedCluster("example", {
    projectId: "<YOUR-PROJECT-ID>",
    name: "cluster-test",
    backupEnabled: false,
    clusterType: "SHARDED",
    replicationSpecs: [
        {
            regionConfigs: [{
                electableSpecs: {
                    instanceSize: "M30",
                    diskIops: 3000,
                    nodeCount: 3,
                },
                providerName: "AWS",
                priority: 7,
                regionName: "EU_WEST_1",
            }],
        },
        {
            regionConfigs: [{
                electableSpecs: {
                    instanceSize: "M40",
                    diskIops: 3000,
                    nodeCount: 3,
                },
                providerName: "AWS",
                priority: 7,
                regionName: "EU_WEST_1",
            }],
        },
    ],
});
const example = mongodbatlas.getAdvancedClusterOutput({
    projectId: exampleAdvancedCluster.projectId,
    name: exampleAdvancedCluster.name,
    useReplicationSpecPerShard: true,
});

import pulumi
import pulumi_mongodbatlas as mongodbatlas

example_advanced_cluster = mongodbatlas.AdvancedCluster("example",
    project_id="<YOUR-PROJECT-ID>",
    name="cluster-test",
    backup_enabled=False,
    cluster_type="SHARDED",
    replication_specs=[
        {
            "region_configs": [{
                "electable_specs": {
                    "instance_size": "M30",
                    "disk_iops": 3000,
                    "node_count": 3,
                },
                "provider_name": "AWS",
                "priority": 7,
                "region_name": "EU_WEST_1",
            }],
        },
        {
            "region_configs": [{
                "electable_specs": {
                    "instance_size": "M40",
                    "disk_iops": 3000,
                    "node_count": 3,
                },
                "provider_name": "AWS",
                "priority": 7,
                "region_name": "EU_WEST_1",
            }],
        },
    ])
example = mongodbatlas.get_advanced_cluster_output(project_id=example_advanced_cluster.project_id,
    name=example_advanced_cluster.name,
    use_replication_spec_per_shard=True)

package main

import (
	"github.com/pulumi/pulumi-mongodbatlas/sdk/v3/go/mongodbatlas"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleAdvancedCluster, err := mongodbatlas.NewAdvancedCluster(ctx, "example", &mongodbatlas.AdvancedClusterArgs{
			ProjectId:     pulumi.String("<YOUR-PROJECT-ID>"),
			Name:          pulumi.String("cluster-test"),
			BackupEnabled: pulumi.Bool(false),
			ClusterType:   pulumi.String("SHARDED"),
			ReplicationSpecs: mongodbatlas.AdvancedClusterReplicationSpecArray{
				&mongodbatlas.AdvancedClusterReplicationSpecArgs{
					RegionConfigs: mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArray{
						&mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArgs{
							ElectableSpecs: &mongodbatlas.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs{
								InstanceSize: pulumi.String("M30"),
								DiskIops:     pulumi.Int(3000),
								NodeCount:    pulumi.Int(3),
							},
							ProviderName: pulumi.String("AWS"),
							Priority:     pulumi.Int(7),
							RegionName:   pulumi.String("EU_WEST_1"),
						},
					},
				},
				&mongodbatlas.AdvancedClusterReplicationSpecArgs{
					RegionConfigs: mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArray{
						&mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArgs{
							ElectableSpecs: &mongodbatlas.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs{
								InstanceSize: pulumi.String("M40"),
								DiskIops:     pulumi.Int(3000),
								NodeCount:    pulumi.Int(3),
							},
							ProviderName: pulumi.String("AWS"),
							Priority:     pulumi.Int(7),
							RegionName:   pulumi.String("EU_WEST_1"),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		_ = mongodbatlas.LookupAdvancedClusterOutput(ctx, mongodbatlas.GetAdvancedClusterOutputArgs{
			ProjectId:                  exampleAdvancedCluster.ProjectId,
			Name:                       exampleAdvancedCluster.Name,
			UseReplicationSpecPerShard: pulumi.Bool(true),
		}, nil)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var exampleAdvancedCluster = new Mongodbatlas.AdvancedCluster("example", new()
    {
        ProjectId = "<YOUR-PROJECT-ID>",
        Name = "cluster-test",
        BackupEnabled = false,
        ClusterType = "SHARDED",
        ReplicationSpecs = new[]
        {
            new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecArgs
            {
                RegionConfigs = new[]
                {
                    new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigArgs
                    {
                        ElectableSpecs = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs
                        {
                            InstanceSize = "M30",
                            DiskIops = 3000,
                            NodeCount = 3,
                        },
                        ProviderName = "AWS",
                        Priority = 7,
                        RegionName = "EU_WEST_1",
                    },
                },
            },
            new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecArgs
            {
                RegionConfigs = new[]
                {
                    new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigArgs
                    {
                        ElectableSpecs = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs
                        {
                            InstanceSize = "M40",
                            DiskIops = 3000,
                            NodeCount = 3,
                        },
                        ProviderName = "AWS",
                        Priority = 7,
                        RegionName = "EU_WEST_1",
                    },
                },
            },
        },
    });

    var example = Mongodbatlas.GetAdvancedCluster.Invoke(new()
    {
        ProjectId = exampleAdvancedCluster.ProjectId,
        Name = exampleAdvancedCluster.Name,
        UseReplicationSpecPerShard = true,
    });

});

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.MongodbatlasFunctions;
import com.pulumi.mongodbatlas.inputs.GetAdvancedClusterArgs;
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 exampleAdvancedCluster = new AdvancedCluster("exampleAdvancedCluster", AdvancedClusterArgs.builder()
            .projectId("<YOUR-PROJECT-ID>")
            .name("cluster-test")
            .backupEnabled(false)
            .clusterType("SHARDED")
            .replicationSpecs(            
                AdvancedClusterReplicationSpecArgs.builder()
                    .regionConfigs(AdvancedClusterReplicationSpecRegionConfigArgs.builder()
                        .electableSpecs(AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs.builder()
                            .instanceSize("M30")
                            .diskIops(3000)
                            .nodeCount(3)
                            .build())
                        .providerName("AWS")
                        .priority(7)
                        .regionName("EU_WEST_1")
                        .build())
                    .build(),
                AdvancedClusterReplicationSpecArgs.builder()
                    .regionConfigs(AdvancedClusterReplicationSpecRegionConfigArgs.builder()
                        .electableSpecs(AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs.builder()
                            .instanceSize("M40")
                            .diskIops(3000)
                            .nodeCount(3)
                            .build())
                        .providerName("AWS")
                        .priority(7)
                        .regionName("EU_WEST_1")
                        .build())
                    .build())
            .build());

        final var example = MongodbatlasFunctions.getAdvancedCluster(GetAdvancedClusterArgs.builder()
            .projectId(exampleAdvancedCluster.projectId())
            .name(exampleAdvancedCluster.name())
            .useReplicationSpecPerShard(true)
            .build());

    }
}

resources:
  exampleAdvancedCluster:
    type: mongodbatlas:AdvancedCluster
    name: example
    properties:
      projectId: <YOUR-PROJECT-ID>
      name: cluster-test
      backupEnabled: false
      clusterType: SHARDED
      replicationSpecs:
        - regionConfigs:
            - electableSpecs:
                instanceSize: M30
                diskIops: 3000
                nodeCount: 3
              providerName: AWS
              priority: 7
              regionName: EU_WEST_1
        - regionConfigs:
            - electableSpecs:
                instanceSize: M40
                diskIops: 3000
                nodeCount: 3
              providerName: AWS
              priority: 7
              regionName: EU_WEST_1
variables:
  example:
    fn::invoke:
      Function: mongodbatlas:getAdvancedCluster
      Arguments:
        projectId: ${exampleAdvancedCluster.projectId}
        name: ${exampleAdvancedCluster.name}
        useReplicationSpecPerShard: true

Using getAdvancedCluster

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 getAdvancedCluster(args: GetAdvancedClusterArgs, opts?: InvokeOptions): Promise<GetAdvancedClusterResult>
function getAdvancedClusterOutput(args: GetAdvancedClusterOutputArgs, opts?: InvokeOptions): Output<GetAdvancedClusterResult>

def get_advanced_cluster(name: Optional[str] = None,
                         pit_enabled: Optional[bool] = None,
                         project_id: Optional[str] = None,
                         use_replication_spec_per_shard: Optional[bool] = None,
                         opts: Optional[InvokeOptions] = None) -> GetAdvancedClusterResult
def get_advanced_cluster_output(name: Optional[pulumi.Input[str]] = None,
                         pit_enabled: Optional[pulumi.Input[bool]] = None,
                         project_id: Optional[pulumi.Input[str]] = None,
                         use_replication_spec_per_shard: Optional[pulumi.Input[bool]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetAdvancedClusterResult]

func LookupAdvancedCluster(ctx *Context, args *LookupAdvancedClusterArgs, opts ...InvokeOption) (*LookupAdvancedClusterResult, error)
func LookupAdvancedClusterOutput(ctx *Context, args *LookupAdvancedClusterOutputArgs, opts ...InvokeOption) LookupAdvancedClusterResultOutput

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

public static class GetAdvancedCluster 
{
    public static Task<GetAdvancedClusterResult> InvokeAsync(GetAdvancedClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetAdvancedClusterResult> Invoke(GetAdvancedClusterInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAdvancedClusterResult> getAdvancedCluster(GetAdvancedClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

Name string: Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed.
ProjectId string: The unique ID for the project to create the database user.
PitEnabled bool: Flag that indicates if the cluster uses Continuous Cloud Backup.
UseReplicationSpecPerShard bool: Set this field to true to allow the data source to use the latest schema representing each shard with an individual replication_specs object. This enables representing clusters with independent shard scaling.

Name string: Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed.
ProjectId string: The unique ID for the project to create the database user.
PitEnabled bool: Flag that indicates if the cluster uses Continuous Cloud Backup.
UseReplicationSpecPerShard bool: Set this field to true to allow the data source to use the latest schema representing each shard with an individual replication_specs object. This enables representing clusters with independent shard scaling.

name String: Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed.
projectId String: The unique ID for the project to create the database user.
pitEnabled Boolean: Flag that indicates if the cluster uses Continuous Cloud Backup.
useReplicationSpecPerShard Boolean: Set this field to true to allow the data source to use the latest schema representing each shard with an individual replication_specs object. This enables representing clusters with independent shard scaling.

name string: Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed.
projectId string: The unique ID for the project to create the database user.
pitEnabled boolean: Flag that indicates if the cluster uses Continuous Cloud Backup.
useReplicationSpecPerShard boolean: Set this field to true to allow the data source to use the latest schema representing each shard with an individual replication_specs object. This enables representing clusters with independent shard scaling.

name str: Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed.
project_id str: The unique ID for the project to create the database user.
pit_enabled bool: Flag that indicates if the cluster uses Continuous Cloud Backup.
use_replication_spec_per_shard bool: Set this field to true to allow the data source to use the latest schema representing each shard with an individual replication_specs object. This enables representing clusters with independent shard scaling.

name String: Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed.
projectId String: The unique ID for the project to create the database user.
pitEnabled Boolean: Flag that indicates if the cluster uses Continuous Cloud Backup.
useReplicationSpecPerShard Boolean: Set this field to true to allow the data source to use the latest schema representing each shard with an individual replication_specs object. This enables representing clusters with independent shard scaling.

getAdvancedCluster Result

The following output properties are available:

AdvancedConfigurations List<GetAdvancedClusterAdvancedConfiguration>: Get the advanced configuration options. See Advanced Configuration below for more details.
BackupEnabled bool
BiConnectorConfigs List<GetAdvancedClusterBiConnectorConfig>: Configuration settings applied to BI Connector for Atlas on this cluster. See below. NOTE Prior version of provider had parameter as bi_connector
ClusterType string: Type of the cluster that you want to create.
ConfigServerManagementMode string: Config Server Management Mode for creating or updating a sharded cluster. Valid values are ATLAS_MANAGED (default) and FIXED_TO_DEDICATED. When configured as ATLAS_MANAGED, Atlas may automatically switch the cluster's config server type for optimal performance and savings. When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. To learn more, see the Sharded Cluster Config Servers documentation.
ConfigServerType string: Describes a sharded cluster's config server type. Valid values are DEDICATED and EMBEDDED. To learn more, see the Sharded Cluster Config Servers documentation.
ConnectionStrings List<GetAdvancedClusterConnectionString>: Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.
CreateDate string
DiskSizeGb double: Storage capacity that the host's root volume possesses expressed in gigabytes. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.
Deprecated: This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
EncryptionAtRestProvider string: Possible values are AWS, GCP, AZURE or NONE.
GlobalClusterSelfManagedSharding bool: Flag that indicates if cluster uses Atlas-Managed Sharding (false) or Self-Managed Sharding (true).
Id string: The provider-assigned unique ID for this managed resource.
Labels List<GetAdvancedClusterLabel>: Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. (DEPRECATED.) Use tags instead.
MongoDbMajorVersion string: Version of the cluster to deploy.
MongoDbVersion string: Version of MongoDB the cluster runs, in major-version.minor-version format.
Name string
Paused bool: Flag that indicates whether the cluster is paused or not.
PitEnabled bool: Flag that indicates if the cluster uses Continuous Cloud Backup.
ProjectId string
RedactClientLogData bool: (Optional) Flag that enables or disables log redaction, see the manual for more info.
ReplicaSetScalingStrategy string: (Optional) Replica set scaling mode for your cluster.
ReplicationSpecs List<GetAdvancedClusterReplicationSpec>: List of settings that configure your cluster regions. If use_replication_spec_per_shard = true, this array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. See below.
RootCertType string: Certificate Authority that MongoDB Atlas clusters use.
StateName string: Current state of the cluster. The possible states are:
Tags List<GetAdvancedClusterTag>: Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
TerminationProtectionEnabled bool: Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
VersionReleaseSystem string: Release cadence that Atlas uses for this cluster.
UseReplicationSpecPerShard bool

AdvancedConfigurations []GetAdvancedClusterAdvancedConfiguration: Get the advanced configuration options. See Advanced Configuration below for more details.
BackupEnabled bool
BiConnectorConfigs []GetAdvancedClusterBiConnectorConfig: Configuration settings applied to BI Connector for Atlas on this cluster. See below. NOTE Prior version of provider had parameter as bi_connector
ClusterType string: Type of the cluster that you want to create.
ConfigServerManagementMode string: Config Server Management Mode for creating or updating a sharded cluster. Valid values are ATLAS_MANAGED (default) and FIXED_TO_DEDICATED. When configured as ATLAS_MANAGED, Atlas may automatically switch the cluster's config server type for optimal performance and savings. When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. To learn more, see the Sharded Cluster Config Servers documentation.
ConfigServerType string: Describes a sharded cluster's config server type. Valid values are DEDICATED and EMBEDDED. To learn more, see the Sharded Cluster Config Servers documentation.
ConnectionStrings []GetAdvancedClusterConnectionString: Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.
CreateDate string
DiskSizeGb float64: Storage capacity that the host's root volume possesses expressed in gigabytes. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.
Deprecated: This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
EncryptionAtRestProvider string: Possible values are AWS, GCP, AZURE or NONE.
GlobalClusterSelfManagedSharding bool: Flag that indicates if cluster uses Atlas-Managed Sharding (false) or Self-Managed Sharding (true).
Id string: The provider-assigned unique ID for this managed resource.
Labels []GetAdvancedClusterLabel: Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. (DEPRECATED.) Use tags instead.
MongoDbMajorVersion string: Version of the cluster to deploy.
MongoDbVersion string: Version of MongoDB the cluster runs, in major-version.minor-version format.
Name string
Paused bool: Flag that indicates whether the cluster is paused or not.
PitEnabled bool: Flag that indicates if the cluster uses Continuous Cloud Backup.
ProjectId string
RedactClientLogData bool: (Optional) Flag that enables or disables log redaction, see the manual for more info.
ReplicaSetScalingStrategy string: (Optional) Replica set scaling mode for your cluster.
ReplicationSpecs []GetAdvancedClusterReplicationSpec: List of settings that configure your cluster regions. If use_replication_spec_per_shard = true, this array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. See below.
RootCertType string: Certificate Authority that MongoDB Atlas clusters use.
StateName string: Current state of the cluster. The possible states are:
Tags []GetAdvancedClusterTag: Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
TerminationProtectionEnabled bool: Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
VersionReleaseSystem string: Release cadence that Atlas uses for this cluster.
UseReplicationSpecPerShard bool

advancedConfigurations List<GetAdvancedClusterAdvancedConfiguration>: Get the advanced configuration options. See Advanced Configuration below for more details.
backupEnabled Boolean
biConnectorConfigs List<GetAdvancedClusterBiConnectorConfig>: Configuration settings applied to BI Connector for Atlas on this cluster. See below. NOTE Prior version of provider had parameter as bi_connector
clusterType String: Type of the cluster that you want to create.
configServerManagementMode String: Config Server Management Mode for creating or updating a sharded cluster. Valid values are ATLAS_MANAGED (default) and FIXED_TO_DEDICATED. When configured as ATLAS_MANAGED, Atlas may automatically switch the cluster's config server type for optimal performance and savings. When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. To learn more, see the Sharded Cluster Config Servers documentation.
configServerType String: Describes a sharded cluster's config server type. Valid values are DEDICATED and EMBEDDED. To learn more, see the Sharded Cluster Config Servers documentation.
connectionStrings List<GetAdvancedClusterConnectionString>: Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.
createDate String
diskSizeGb Double: Storage capacity that the host's root volume possesses expressed in gigabytes. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.
Deprecated: This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
encryptionAtRestProvider String: Possible values are AWS, GCP, AZURE or NONE.
globalClusterSelfManagedSharding Boolean: Flag that indicates if cluster uses Atlas-Managed Sharding (false) or Self-Managed Sharding (true).
id String: The provider-assigned unique ID for this managed resource.
labels List<GetAdvancedClusterLabel>: Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. (DEPRECATED.) Use tags instead.
mongoDbMajorVersion String: Version of the cluster to deploy.
mongoDbVersion String: Version of MongoDB the cluster runs, in major-version.minor-version format.
name String
paused Boolean: Flag that indicates whether the cluster is paused or not.
pitEnabled Boolean: Flag that indicates if the cluster uses Continuous Cloud Backup.
projectId String
redactClientLogData Boolean: (Optional) Flag that enables or disables log redaction, see the manual for more info.
replicaSetScalingStrategy String: (Optional) Replica set scaling mode for your cluster.
replicationSpecs List<GetAdvancedClusterReplicationSpec>: List of settings that configure your cluster regions. If use_replication_spec_per_shard = true, this array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. See below.
rootCertType String: Certificate Authority that MongoDB Atlas clusters use.
stateName String: Current state of the cluster. The possible states are:
tags List<GetAdvancedClusterTag>: Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
terminationProtectionEnabled Boolean: Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
versionReleaseSystem String: Release cadence that Atlas uses for this cluster.
useReplicationSpecPerShard Boolean

advancedConfigurations GetAdvancedClusterAdvancedConfiguration[]: Get the advanced configuration options. See Advanced Configuration below for more details.
backupEnabled boolean
biConnectorConfigs GetAdvancedClusterBiConnectorConfig[]: Configuration settings applied to BI Connector for Atlas on this cluster. See below. NOTE Prior version of provider had parameter as bi_connector
clusterType string: Type of the cluster that you want to create.
configServerManagementMode string: Config Server Management Mode for creating or updating a sharded cluster. Valid values are ATLAS_MANAGED (default) and FIXED_TO_DEDICATED. When configured as ATLAS_MANAGED, Atlas may automatically switch the cluster's config server type for optimal performance and savings. When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. To learn more, see the Sharded Cluster Config Servers documentation.
configServerType string: Describes a sharded cluster's config server type. Valid values are DEDICATED and EMBEDDED. To learn more, see the Sharded Cluster Config Servers documentation.
connectionStrings GetAdvancedClusterConnectionString[]: Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.
createDate string
diskSizeGb number: Storage capacity that the host's root volume possesses expressed in gigabytes. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.
Deprecated: This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
encryptionAtRestProvider string: Possible values are AWS, GCP, AZURE or NONE.
globalClusterSelfManagedSharding boolean: Flag that indicates if cluster uses Atlas-Managed Sharding (false) or Self-Managed Sharding (true).
id string: The provider-assigned unique ID for this managed resource.
labels GetAdvancedClusterLabel[]: Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. (DEPRECATED.) Use tags instead.
mongoDbMajorVersion string: Version of the cluster to deploy.
mongoDbVersion string: Version of MongoDB the cluster runs, in major-version.minor-version format.
name string
paused boolean: Flag that indicates whether the cluster is paused or not.
pitEnabled boolean: Flag that indicates if the cluster uses Continuous Cloud Backup.
projectId string
redactClientLogData boolean: (Optional) Flag that enables or disables log redaction, see the manual for more info.
replicaSetScalingStrategy string: (Optional) Replica set scaling mode for your cluster.
replicationSpecs GetAdvancedClusterReplicationSpec[]: List of settings that configure your cluster regions. If use_replication_spec_per_shard = true, this array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. See below.
rootCertType string: Certificate Authority that MongoDB Atlas clusters use.
stateName string: Current state of the cluster. The possible states are:
tags GetAdvancedClusterTag[]: Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
terminationProtectionEnabled boolean: Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
versionReleaseSystem string: Release cadence that Atlas uses for this cluster.
useReplicationSpecPerShard boolean

advanced_configurations Sequence[GetAdvancedClusterAdvancedConfiguration]: Get the advanced configuration options. See Advanced Configuration below for more details.
backup_enabled bool
bi_connector_configs Sequence[GetAdvancedClusterBiConnectorConfig]: Configuration settings applied to BI Connector for Atlas on this cluster. See below. NOTE Prior version of provider had parameter as bi_connector
cluster_type str: Type of the cluster that you want to create.
config_server_management_mode str: Config Server Management Mode for creating or updating a sharded cluster. Valid values are ATLAS_MANAGED (default) and FIXED_TO_DEDICATED. When configured as ATLAS_MANAGED, Atlas may automatically switch the cluster's config server type for optimal performance and savings. When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. To learn more, see the Sharded Cluster Config Servers documentation.
config_server_type str: Describes a sharded cluster's config server type. Valid values are DEDICATED and EMBEDDED. To learn more, see the Sharded Cluster Config Servers documentation.
connection_strings Sequence[GetAdvancedClusterConnectionString]: Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.
create_date str
disk_size_gb float: Storage capacity that the host's root volume possesses expressed in gigabytes. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.
Deprecated: This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
encryption_at_rest_provider str: Possible values are AWS, GCP, AZURE or NONE.
global_cluster_self_managed_sharding bool: Flag that indicates if cluster uses Atlas-Managed Sharding (false) or Self-Managed Sharding (true).
id str: The provider-assigned unique ID for this managed resource.
labels Sequence[GetAdvancedClusterLabel]: Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. (DEPRECATED.) Use tags instead.
mongo_db_major_version str: Version of the cluster to deploy.
mongo_db_version str: Version of MongoDB the cluster runs, in major-version.minor-version format.
name str
paused bool: Flag that indicates whether the cluster is paused or not.
pit_enabled bool: Flag that indicates if the cluster uses Continuous Cloud Backup.
project_id str
redact_client_log_data bool: (Optional) Flag that enables or disables log redaction, see the manual for more info.
replica_set_scaling_strategy str: (Optional) Replica set scaling mode for your cluster.
replication_specs Sequence[GetAdvancedClusterReplicationSpec]: List of settings that configure your cluster regions. If use_replication_spec_per_shard = true, this array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. See below.
root_cert_type str: Certificate Authority that MongoDB Atlas clusters use.
state_name str: Current state of the cluster. The possible states are:
tags Sequence[GetAdvancedClusterTag]: Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
termination_protection_enabled bool: Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
version_release_system str: Release cadence that Atlas uses for this cluster.
use_replication_spec_per_shard bool

advancedConfigurations List<Property Map>: Get the advanced configuration options. See Advanced Configuration below for more details.
backupEnabled Boolean
biConnectorConfigs List<Property Map>: Configuration settings applied to BI Connector for Atlas on this cluster. See below. NOTE Prior version of provider had parameter as bi_connector
clusterType String: Type of the cluster that you want to create.
configServerManagementMode String: Config Server Management Mode for creating or updating a sharded cluster. Valid values are ATLAS_MANAGED (default) and FIXED_TO_DEDICATED. When configured as ATLAS_MANAGED, Atlas may automatically switch the cluster's config server type for optimal performance and savings. When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. To learn more, see the Sharded Cluster Config Servers documentation.
configServerType String: Describes a sharded cluster's config server type. Valid values are DEDICATED and EMBEDDED. To learn more, see the Sharded Cluster Config Servers documentation.
connectionStrings List<Property Map>: Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.
createDate String
diskSizeGb Number: Storage capacity that the host's root volume possesses expressed in gigabytes. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.
Deprecated: This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
encryptionAtRestProvider String: Possible values are AWS, GCP, AZURE or NONE.
globalClusterSelfManagedSharding Boolean: Flag that indicates if cluster uses Atlas-Managed Sharding (false) or Self-Managed Sharding (true).
id String: The provider-assigned unique ID for this managed resource.
labels List<Property Map>: Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. (DEPRECATED.) Use tags instead.
mongoDbMajorVersion String: Version of the cluster to deploy.
mongoDbVersion String: Version of MongoDB the cluster runs, in major-version.minor-version format.
name String
paused Boolean: Flag that indicates whether the cluster is paused or not.
pitEnabled Boolean: Flag that indicates if the cluster uses Continuous Cloud Backup.
projectId String
redactClientLogData Boolean: (Optional) Flag that enables or disables log redaction, see the manual for more info.
replicaSetScalingStrategy String: (Optional) Replica set scaling mode for your cluster.
replicationSpecs List<Property Map>: List of settings that configure your cluster regions. If use_replication_spec_per_shard = true, this array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. See below.
rootCertType String: Certificate Authority that MongoDB Atlas clusters use.
stateName String: Current state of the cluster. The possible states are:
tags List<Property Map>: Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
terminationProtectionEnabled Boolean: Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
versionReleaseSystem String: Release cadence that Atlas uses for this cluster.
useReplicationSpecPerShard Boolean

Supporting Types

GetAdvancedClusterAdvancedConfiguration

ChangeStreamOptionsPreAndPostImagesExpireAfterSeconds int: (Optional) The minimum pre- and post-image retention time in seconds This parameter is only supported for MongoDB version 6.0 and above. Defaults to -1(off).
DefaultReadConcern string: Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available. (DEPRECATED.) MongoDB 5.0 and later clusters default to local. To use a custom read concern level, please refer to your driver documentation.
Deprecated: This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
DefaultWriteConcern string: Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.
FailIndexKeyTooLong bool: When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them. (DEPRECATED.) This parameter has been removed as of MongoDB 4.4.
Deprecated: This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
JavascriptEnabled bool: When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.
MinimumEnabledTlsProtocol string: Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:
NoTableScan bool: When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.
OplogMinRetentionHours double: Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
OplogSizeMb int: The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.
SampleRefreshIntervalBiConnector int: Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
SampleSizeBiConnector int: Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
TransactionLifetimeLimitSeconds int: Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.

ChangeStreamOptionsPreAndPostImagesExpireAfterSeconds int: (Optional) The minimum pre- and post-image retention time in seconds This parameter is only supported for MongoDB version 6.0 and above. Defaults to -1(off).
DefaultReadConcern string: Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available. (DEPRECATED.) MongoDB 5.0 and later clusters default to local. To use a custom read concern level, please refer to your driver documentation.
Deprecated: This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
DefaultWriteConcern string: Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.
FailIndexKeyTooLong bool: When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them. (DEPRECATED.) This parameter has been removed as of MongoDB 4.4.
Deprecated: This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
JavascriptEnabled bool: When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.
MinimumEnabledTlsProtocol string: Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:
NoTableScan bool: When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.
OplogMinRetentionHours float64: Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
OplogSizeMb int: The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.
SampleRefreshIntervalBiConnector int: Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
SampleSizeBiConnector int: Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
TransactionLifetimeLimitSeconds int: Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.

changeStreamOptionsPreAndPostImagesExpireAfterSeconds Integer: (Optional) The minimum pre- and post-image retention time in seconds This parameter is only supported for MongoDB version 6.0 and above. Defaults to -1(off).
defaultReadConcern String: Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available. (DEPRECATED.) MongoDB 5.0 and later clusters default to local. To use a custom read concern level, please refer to your driver documentation.
Deprecated: This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
defaultWriteConcern String: Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.
failIndexKeyTooLong Boolean: When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them. (DEPRECATED.) This parameter has been removed as of MongoDB 4.4.
Deprecated: This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
javascriptEnabled Boolean: When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.
minimumEnabledTlsProtocol String: Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:
noTableScan Boolean: When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.
oplogMinRetentionHours Double: Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
oplogSizeMb Integer: The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.
sampleRefreshIntervalBiConnector Integer: Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
sampleSizeBiConnector Integer: Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
transactionLifetimeLimitSeconds Integer: Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.

changeStreamOptionsPreAndPostImagesExpireAfterSeconds number: (Optional) The minimum pre- and post-image retention time in seconds This parameter is only supported for MongoDB version 6.0 and above. Defaults to -1(off).
defaultReadConcern string: Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available. (DEPRECATED.) MongoDB 5.0 and later clusters default to local. To use a custom read concern level, please refer to your driver documentation.
Deprecated: This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
defaultWriteConcern string: Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.
failIndexKeyTooLong boolean: When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them. (DEPRECATED.) This parameter has been removed as of MongoDB 4.4.
Deprecated: This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
javascriptEnabled boolean: When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.
minimumEnabledTlsProtocol string: Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:
noTableScan boolean: When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.
oplogMinRetentionHours number: Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
oplogSizeMb number: The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.
sampleRefreshIntervalBiConnector number: Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
sampleSizeBiConnector number: Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
transactionLifetimeLimitSeconds number: Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.

change_stream_options_pre_and_post_images_expire_after_seconds int: (Optional) The minimum pre- and post-image retention time in seconds This parameter is only supported for MongoDB version 6.0 and above. Defaults to -1(off).
default_read_concern str: Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available. (DEPRECATED.) MongoDB 5.0 and later clusters default to local. To use a custom read concern level, please refer to your driver documentation.
Deprecated: This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
default_write_concern str: Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.
fail_index_key_too_long bool: When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them. (DEPRECATED.) This parameter has been removed as of MongoDB 4.4.
Deprecated: This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
javascript_enabled bool: When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.
minimum_enabled_tls_protocol str: Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:
no_table_scan bool: When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.
oplog_min_retention_hours float: Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
oplog_size_mb int: The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.
sample_refresh_interval_bi_connector int: Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
sample_size_bi_connector int: Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
transaction_lifetime_limit_seconds int: Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.

changeStreamOptionsPreAndPostImagesExpireAfterSeconds Number: (Optional) The minimum pre- and post-image retention time in seconds This parameter is only supported for MongoDB version 6.0 and above. Defaults to -1(off).
defaultReadConcern String: Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available. (DEPRECATED.) MongoDB 5.0 and later clusters default to local. To use a custom read concern level, please refer to your driver documentation.
Deprecated: This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
defaultWriteConcern String: Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.
failIndexKeyTooLong Boolean: When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them. (DEPRECATED.) This parameter has been removed as of MongoDB 4.4.
Deprecated: This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
javascriptEnabled Boolean: When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.
minimumEnabledTlsProtocol String: Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:
noTableScan Boolean: When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.
oplogMinRetentionHours Number: Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
oplogSizeMb Number: The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.
sampleRefreshIntervalBiConnector Number: Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
sampleSizeBiConnector Number: Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
transactionLifetimeLimitSeconds Number: Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.

GetAdvancedClusterBiConnectorConfig

Enabled bool: Specifies whether or not BI Connector for Atlas is enabled on the cluster.l
ReadPreference string: Specifies the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. For details on BI Connector for Atlas read preferences, refer to the BI Connector Read Preferences Table.

Enabled bool: Specifies whether or not BI Connector for Atlas is enabled on the cluster.l
ReadPreference string: Specifies the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. For details on BI Connector for Atlas read preferences, refer to the BI Connector Read Preferences Table.

enabled Boolean: Specifies whether or not BI Connector for Atlas is enabled on the cluster.l
readPreference String: Specifies the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. For details on BI Connector for Atlas read preferences, refer to the BI Connector Read Preferences Table.

enabled boolean: Specifies whether or not BI Connector for Atlas is enabled on the cluster.l
readPreference string: Specifies the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. For details on BI Connector for Atlas read preferences, refer to the BI Connector Read Preferences Table.

enabled bool: Specifies whether or not BI Connector for Atlas is enabled on the cluster.l
read_preference str: Specifies the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. For details on BI Connector for Atlas read preferences, refer to the BI Connector Read Preferences Table.

enabled Boolean: Specifies whether or not BI Connector for Atlas is enabled on the cluster.l
readPreference String: Specifies the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. For details on BI Connector for Atlas read preferences, refer to the BI Connector Read Preferences Table.

GetAdvancedClusterConnectionString

Private string

Network-peering-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.

PrivateEndpoints List<GetAdvancedClusterConnectionStringPrivateEndpoint>

Private endpoint connection strings. Each object describes the connection strings you can use to connect to this cluster through a private endpoint. Atlas returns this parameter only if you deployed a private endpoint to all regions to which you deployed this cluster's nodes.

connection_strings.private_endpoint.#.connection_string - Private-endpoint-aware mongodb://connection string for this private endpoint.
connection_strings.private_endpoint.#.srv_connection_string - Private-endpoint-aware mongodb+srv:// connection string for this private endpoint. The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS . Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don't need to: Append the seed list or Change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn't, use connection_strings.private_endpoint[n].connection_string
connection_strings.private_endpoint.#.srv_shard_optimized_connection_string - Private endpoint-aware connection string optimized for sharded clusters that uses the mongodb+srv:// protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString.
connection_strings.private_endpoint.#.type - Type of MongoDB process that you connect to with the connection strings. Atlas returns MONGOD for replica sets, or MONGOS for sharded clusters.
connection_strings.private_endpoint.#.endpoints - Private endpoint through which you connect to Atlas when you use connection_strings.private_endpoint[n].connection_string or connection_strings.private_endpoint[n].srv_connection_string
connection_strings.private_endpoint.#.endpoints.#.endpoint_id - Unique identifier of the private endpoint.
connection_strings.private_endpoint.#.endpoints.#.provider_name - Cloud provider to which you deployed the private endpoint. Atlas returns AWS or AZURE.
connection_strings.private_endpoint.#.endpoints.#.region - Region to which you deployed the private endpoint.

PrivateSrv string

Network-peering-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.

Standard string

Public mongodb:// connection string for this cluster.

StandardSrv string

Public mongodb+srv:// connection string for this cluster. The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS. Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don’t need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn’t , use connectionStrings.standard.

Private string

PrivateEndpoints []GetAdvancedClusterConnectionStringPrivateEndpoint

connection_strings.private_endpoint.#.connection_string - Private-endpoint-aware mongodb://connection string for this private endpoint.
connection_strings.private_endpoint.#.srv_connection_string - Private-endpoint-aware mongodb+srv:// connection string for this private endpoint. The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS . Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don't need to: Append the seed list or Change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn't, use connection_strings.private_endpoint[n].connection_string
connection_strings.private_endpoint.#.srv_shard_optimized_connection_string - Private endpoint-aware connection string optimized for sharded clusters that uses the mongodb+srv:// protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString.
connection_strings.private_endpoint.#.type - Type of MongoDB process that you connect to with the connection strings. Atlas returns MONGOD for replica sets, or MONGOS for sharded clusters.
connection_strings.private_endpoint.#.endpoints - Private endpoint through which you connect to Atlas when you use connection_strings.private_endpoint[n].connection_string or connection_strings.private_endpoint[n].srv_connection_string
connection_strings.private_endpoint.#.endpoints.#.endpoint_id - Unique identifier of the private endpoint.
connection_strings.private_endpoint.#.endpoints.#.provider_name - Cloud provider to which you deployed the private endpoint. Atlas returns AWS or AZURE.
connection_strings.private_endpoint.#.endpoints.#.region - Region to which you deployed the private endpoint.

PrivateSrv string

Standard string

Public mongodb:// connection string for this cluster.

StandardSrv string

privateEndpoints List<GetAdvancedClusterConnectionStringPrivateEndpoint>

connection_strings.private_endpoint.#.connection_string - Private-endpoint-aware mongodb://connection string for this private endpoint.
connection_strings.private_endpoint.#.srv_connection_string - Private-endpoint-aware mongodb+srv:// connection string for this private endpoint. The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS . Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don't need to: Append the seed list or Change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn't, use connection_strings.private_endpoint[n].connection_string
connection_strings.private_endpoint.#.srv_shard_optimized_connection_string - Private endpoint-aware connection string optimized for sharded clusters that uses the mongodb+srv:// protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString.
connection_strings.private_endpoint.#.type - Type of MongoDB process that you connect to with the connection strings. Atlas returns MONGOD for replica sets, or MONGOS for sharded clusters.
connection_strings.private_endpoint.#.endpoints - Private endpoint through which you connect to Atlas when you use connection_strings.private_endpoint[n].connection_string or connection_strings.private_endpoint[n].srv_connection_string
connection_strings.private_endpoint.#.endpoints.#.endpoint_id - Unique identifier of the private endpoint.
connection_strings.private_endpoint.#.endpoints.#.provider_name - Cloud provider to which you deployed the private endpoint. Atlas returns AWS or AZURE.
connection_strings.private_endpoint.#.endpoints.#.region - Region to which you deployed the private endpoint.

privateSrv String

private_ String

standard String

Public mongodb:// connection string for this cluster.

standardSrv String

private string

privateEndpoints GetAdvancedClusterConnectionStringPrivateEndpoint[]

connection_strings.private_endpoint.#.connection_string - Private-endpoint-aware mongodb://connection string for this private endpoint.
connection_strings.private_endpoint.#.srv_connection_string - Private-endpoint-aware mongodb+srv:// connection string for this private endpoint. The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS . Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don't need to: Append the seed list or Change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn't, use connection_strings.private_endpoint[n].connection_string
connection_strings.private_endpoint.#.srv_shard_optimized_connection_string - Private endpoint-aware connection string optimized for sharded clusters that uses the mongodb+srv:// protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString.
connection_strings.private_endpoint.#.type - Type of MongoDB process that you connect to with the connection strings. Atlas returns MONGOD for replica sets, or MONGOS for sharded clusters.
connection_strings.private_endpoint.#.endpoints - Private endpoint through which you connect to Atlas when you use connection_strings.private_endpoint[n].connection_string or connection_strings.private_endpoint[n].srv_connection_string
connection_strings.private_endpoint.#.endpoints.#.endpoint_id - Unique identifier of the private endpoint.
connection_strings.private_endpoint.#.endpoints.#.provider_name - Cloud provider to which you deployed the private endpoint. Atlas returns AWS or AZURE.
connection_strings.private_endpoint.#.endpoints.#.region - Region to which you deployed the private endpoint.

privateSrv string

standard string

Public mongodb:// connection string for this cluster.

standardSrv string

private str

private_endpoints Sequence[GetAdvancedClusterConnectionStringPrivateEndpoint]

connection_strings.private_endpoint.#.connection_string - Private-endpoint-aware mongodb://connection string for this private endpoint.
connection_strings.private_endpoint.#.srv_connection_string - Private-endpoint-aware mongodb+srv:// connection string for this private endpoint. The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS . Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don't need to: Append the seed list or Change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn't, use connection_strings.private_endpoint[n].connection_string
connection_strings.private_endpoint.#.srv_shard_optimized_connection_string - Private endpoint-aware connection string optimized for sharded clusters that uses the mongodb+srv:// protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString.
connection_strings.private_endpoint.#.type - Type of MongoDB process that you connect to with the connection strings. Atlas returns MONGOD for replica sets, or MONGOS for sharded clusters.
connection_strings.private_endpoint.#.endpoints - Private endpoint through which you connect to Atlas when you use connection_strings.private_endpoint[n].connection_string or connection_strings.private_endpoint[n].srv_connection_string
connection_strings.private_endpoint.#.endpoints.#.endpoint_id - Unique identifier of the private endpoint.
connection_strings.private_endpoint.#.endpoints.#.provider_name - Cloud provider to which you deployed the private endpoint. Atlas returns AWS or AZURE.
connection_strings.private_endpoint.#.endpoints.#.region - Region to which you deployed the private endpoint.

private_srv str

standard str

Public mongodb:// connection string for this cluster.

standard_srv str

private String

privateEndpoints List<Property Map>

connection_strings.private_endpoint.#.connection_string - Private-endpoint-aware mongodb://connection string for this private endpoint.
connection_strings.private_endpoint.#.srv_connection_string - Private-endpoint-aware mongodb+srv:// connection string for this private endpoint. The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS . Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don't need to: Append the seed list or Change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn't, use connection_strings.private_endpoint[n].connection_string
connection_strings.private_endpoint.#.srv_shard_optimized_connection_string - Private endpoint-aware connection string optimized for sharded clusters that uses the mongodb+srv:// protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString.
connection_strings.private_endpoint.#.type - Type of MongoDB process that you connect to with the connection strings. Atlas returns MONGOD for replica sets, or MONGOS for sharded clusters.
connection_strings.private_endpoint.#.endpoints - Private endpoint through which you connect to Atlas when you use connection_strings.private_endpoint[n].connection_string or connection_strings.private_endpoint[n].srv_connection_string
connection_strings.private_endpoint.#.endpoints.#.endpoint_id - Unique identifier of the private endpoint.
connection_strings.private_endpoint.#.endpoints.#.provider_name - Cloud provider to which you deployed the private endpoint. Atlas returns AWS or AZURE.
connection_strings.private_endpoint.#.endpoints.#.region - Region to which you deployed the private endpoint.

privateSrv String

standard String

Public mongodb:// connection string for this cluster.

standardSrv String

GetAdvancedClusterConnectionStringPrivateEndpoint

ConnectionString string
Endpoints List<GetAdvancedClusterConnectionStringPrivateEndpointEndpoint>
SrvConnectionString string
SrvShardOptimizedConnectionString string
Type string

ConnectionString string
Endpoints []GetAdvancedClusterConnectionStringPrivateEndpointEndpoint
SrvConnectionString string
SrvShardOptimizedConnectionString string
Type string

connectionString String
endpoints List<GetAdvancedClusterConnectionStringPrivateEndpointEndpoint>
srvConnectionString String
srvShardOptimizedConnectionString String
type String

connectionString string
endpoints GetAdvancedClusterConnectionStringPrivateEndpointEndpoint[]
srvConnectionString string
srvShardOptimizedConnectionString string
type string

connection_string str
endpoints Sequence[GetAdvancedClusterConnectionStringPrivateEndpointEndpoint]
srv_connection_string str
srv_shard_optimized_connection_string str
type str

connectionString String
endpoints List<Property Map>
srvConnectionString String
srvShardOptimizedConnectionString String
type String

GetAdvancedClusterConnectionStringPrivateEndpointEndpoint

EndpointId string
ProviderName string: Cloud service provider on which the servers are provisioned.
Region string

EndpointId string
ProviderName string: Cloud service provider on which the servers are provisioned.
Region string

endpointId String
providerName String: Cloud service provider on which the servers are provisioned.
region String

endpointId string
providerName string: Cloud service provider on which the servers are provisioned.
region string

endpoint_id str
provider_name str: Cloud service provider on which the servers are provisioned.
region str

endpointId String
providerName String: Cloud service provider on which the servers are provisioned.
region String

GetAdvancedClusterLabel

Key string: The key that you want to write.
Value string: The value that you want to write.

Key string: The key that you want to write.
Value string: The value that you want to write.

key String: The key that you want to write.
value String: The value that you want to write.

key string: The key that you want to write.
value string: The value that you want to write.

key str: The key that you want to write.
value str: The value that you want to write.

key String: The key that you want to write.
value String: The value that you want to write.

GetAdvancedClusterReplicationSpec

ContainerId Dictionary<string, string>: A key-value map of the Network Peering Container ID(s) for the configuration specified in region_configs. The Container ID is the id of the container either created programmatically by the user before any clusters existed in a project or when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is "providerName:regionName" = "containerId". Example AWS:US_EAST_1" = "61e0797dde08fb498ca11a71.
ExternalId string: Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. This value corresponds to Shard ID displayed in the UI. When using old sharding configuration (replication spec with num_shards greater than 1) this value is not populated.
Id string: Deprecated: This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
NumShards int: Provide this value if you set a cluster_type of SHARDED or GEOSHARDED. (DEPRECATED.) To learn more, see the Migration Guide.
Deprecated: This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
RegionConfigs List<GetAdvancedClusterReplicationSpecRegionConfig>: Configuration for the hardware specifications for nodes set for a given regionEach region_configs object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Each region_configs object must have either an analytics_specs object, electable_specs object, or read_only_specs object. See below
ZoneId string: Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. If clusterType is GEOSHARDED, this value indicates the zone that the given shard belongs to and can be used to configure Global Cluster backup policies.
ZoneName string: Name for the zone in a Global Cluster.

ContainerId map[string]string: A key-value map of the Network Peering Container ID(s) for the configuration specified in region_configs. The Container ID is the id of the container either created programmatically by the user before any clusters existed in a project or when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is "providerName:regionName" = "containerId". Example AWS:US_EAST_1" = "61e0797dde08fb498ca11a71.
ExternalId string: Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. This value corresponds to Shard ID displayed in the UI. When using old sharding configuration (replication spec with num_shards greater than 1) this value is not populated.
Id string: Deprecated: This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
NumShards int: Provide this value if you set a cluster_type of SHARDED or GEOSHARDED. (DEPRECATED.) To learn more, see the Migration Guide.
Deprecated: This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
RegionConfigs []GetAdvancedClusterReplicationSpecRegionConfig: Configuration for the hardware specifications for nodes set for a given regionEach region_configs object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Each region_configs object must have either an analytics_specs object, electable_specs object, or read_only_specs object. See below
ZoneId string: Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. If clusterType is GEOSHARDED, this value indicates the zone that the given shard belongs to and can be used to configure Global Cluster backup policies.
ZoneName string: Name for the zone in a Global Cluster.

containerId Map<String,String>: A key-value map of the Network Peering Container ID(s) for the configuration specified in region_configs. The Container ID is the id of the container either created programmatically by the user before any clusters existed in a project or when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is "providerName:regionName" = "containerId". Example AWS:US_EAST_1" = "61e0797dde08fb498ca11a71.
externalId String: Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. This value corresponds to Shard ID displayed in the UI. When using old sharding configuration (replication spec with num_shards greater than 1) this value is not populated.
id String: Deprecated: This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
numShards Integer: Provide this value if you set a cluster_type of SHARDED or GEOSHARDED. (DEPRECATED.) To learn more, see the Migration Guide.
Deprecated: This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
regionConfigs List<GetAdvancedClusterReplicationSpecRegionConfig>: Configuration for the hardware specifications for nodes set for a given regionEach region_configs object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Each region_configs object must have either an analytics_specs object, electable_specs object, or read_only_specs object. See below
zoneId String: Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. If clusterType is GEOSHARDED, this value indicates the zone that the given shard belongs to and can be used to configure Global Cluster backup policies.
zoneName String: Name for the zone in a Global Cluster.

containerId {[key: string]: string}: A key-value map of the Network Peering Container ID(s) for the configuration specified in region_configs. The Container ID is the id of the container either created programmatically by the user before any clusters existed in a project or when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is "providerName:regionName" = "containerId". Example AWS:US_EAST_1" = "61e0797dde08fb498ca11a71.
externalId string: Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. This value corresponds to Shard ID displayed in the UI. When using old sharding configuration (replication spec with num_shards greater than 1) this value is not populated.
id string: Deprecated: This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
numShards number: Provide this value if you set a cluster_type of SHARDED or GEOSHARDED. (DEPRECATED.) To learn more, see the Migration Guide.
Deprecated: This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
regionConfigs GetAdvancedClusterReplicationSpecRegionConfig[]: Configuration for the hardware specifications for nodes set for a given regionEach region_configs object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Each region_configs object must have either an analytics_specs object, electable_specs object, or read_only_specs object. See below
zoneId string: Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. If clusterType is GEOSHARDED, this value indicates the zone that the given shard belongs to and can be used to configure Global Cluster backup policies.
zoneName string: Name for the zone in a Global Cluster.

container_id Mapping[str, str]: A key-value map of the Network Peering Container ID(s) for the configuration specified in region_configs. The Container ID is the id of the container either created programmatically by the user before any clusters existed in a project or when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is "providerName:regionName" = "containerId". Example AWS:US_EAST_1" = "61e0797dde08fb498ca11a71.
external_id str: Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. This value corresponds to Shard ID displayed in the UI. When using old sharding configuration (replication spec with num_shards greater than 1) this value is not populated.
id str: Deprecated: This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
num_shards int: Provide this value if you set a cluster_type of SHARDED or GEOSHARDED. (DEPRECATED.) To learn more, see the Migration Guide.
Deprecated: This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
region_configs Sequence[GetAdvancedClusterReplicationSpecRegionConfig]: Configuration for the hardware specifications for nodes set for a given regionEach region_configs object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Each region_configs object must have either an analytics_specs object, electable_specs object, or read_only_specs object. See below
zone_id str: Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. If clusterType is GEOSHARDED, this value indicates the zone that the given shard belongs to and can be used to configure Global Cluster backup policies.
zone_name str: Name for the zone in a Global Cluster.

containerId Map<String>: A key-value map of the Network Peering Container ID(s) for the configuration specified in region_configs. The Container ID is the id of the container either created programmatically by the user before any clusters existed in a project or when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is "providerName:regionName" = "containerId". Example AWS:US_EAST_1" = "61e0797dde08fb498ca11a71.
externalId String: Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. This value corresponds to Shard ID displayed in the UI. When using old sharding configuration (replication spec with num_shards greater than 1) this value is not populated.
id String: Deprecated: This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
numShards Number: Provide this value if you set a cluster_type of SHARDED or GEOSHARDED. (DEPRECATED.) To learn more, see the Migration Guide.
Deprecated: This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
regionConfigs List<Property Map>: Configuration for the hardware specifications for nodes set for a given regionEach region_configs object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Each region_configs object must have either an analytics_specs object, electable_specs object, or read_only_specs object. See below
zoneId String: Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. If clusterType is GEOSHARDED, this value indicates the zone that the given shard belongs to and can be used to configure Global Cluster backup policies.
zoneName String: Name for the zone in a Global Cluster.

GetAdvancedClusterReplicationSpecRegionConfig

AnalyticsAutoScalings List<GetAdvancedClusterReplicationSpecRegionConfigAnalyticsAutoScaling>: Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. See below
AnalyticsSpecs GetAdvancedClusterReplicationSpecRegionConfigAnalyticsSpecs: Hardware specifications for analytics nodes needed in the region. See below
AutoScalings List<GetAdvancedClusterReplicationSpecRegionConfigAutoScaling>: Configuration for the Collection of settings that configures auto-scaling information for the cluster. See below
BackingProviderName string: Cloud service provider on which you provision the host for a multi-tenant cluster.
ElectableSpecs GetAdvancedClusterReplicationSpecRegionConfigElectableSpecs: Hardware specifications for electable nodes in the region.
Priority int: Election priority of the region.
ProviderName string: Cloud service provider on which the servers are provisioned.
ReadOnlySpecs GetAdvancedClusterReplicationSpecRegionConfigReadOnlySpecs: Hardware specifications for read-only nodes in the region. See below
RegionName string: Physical location of your MongoDB cluster.

AnalyticsAutoScalings []GetAdvancedClusterReplicationSpecRegionConfigAnalyticsAutoScaling: Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. See below
AnalyticsSpecs GetAdvancedClusterReplicationSpecRegionConfigAnalyticsSpecs: Hardware specifications for analytics nodes needed in the region. See below
AutoScalings []GetAdvancedClusterReplicationSpecRegionConfigAutoScaling: Configuration for the Collection of settings that configures auto-scaling information for the cluster. See below
BackingProviderName string: Cloud service provider on which you provision the host for a multi-tenant cluster.
ElectableSpecs GetAdvancedClusterReplicationSpecRegionConfigElectableSpecs: Hardware specifications for electable nodes in the region.
Priority int: Election priority of the region.
ProviderName string: Cloud service provider on which the servers are provisioned.
ReadOnlySpecs GetAdvancedClusterReplicationSpecRegionConfigReadOnlySpecs: Hardware specifications for read-only nodes in the region. See below
RegionName string: Physical location of your MongoDB cluster.

analyticsAutoScalings List<GetAdvancedClusterReplicationSpecRegionConfigAnalyticsAutoScaling>: Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. See below
analyticsSpecs GetAdvancedClusterReplicationSpecRegionConfigAnalyticsSpecs: Hardware specifications for analytics nodes needed in the region. See below
autoScalings List<GetAdvancedClusterReplicationSpecRegionConfigAutoScaling>: Configuration for the Collection of settings that configures auto-scaling information for the cluster. See below
backingProviderName String: Cloud service provider on which you provision the host for a multi-tenant cluster.
electableSpecs GetAdvancedClusterReplicationSpecRegionConfigElectableSpecs: Hardware specifications for electable nodes in the region.
priority Integer: Election priority of the region.
providerName String: Cloud service provider on which the servers are provisioned.
readOnlySpecs GetAdvancedClusterReplicationSpecRegionConfigReadOnlySpecs: Hardware specifications for read-only nodes in the region. See below
regionName String: Physical location of your MongoDB cluster.

analyticsAutoScalings GetAdvancedClusterReplicationSpecRegionConfigAnalyticsAutoScaling[]: Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. See below
analyticsSpecs GetAdvancedClusterReplicationSpecRegionConfigAnalyticsSpecs: Hardware specifications for analytics nodes needed in the region. See below
autoScalings GetAdvancedClusterReplicationSpecRegionConfigAutoScaling[]: Configuration for the Collection of settings that configures auto-scaling information for the cluster. See below
backingProviderName string: Cloud service provider on which you provision the host for a multi-tenant cluster.
electableSpecs GetAdvancedClusterReplicationSpecRegionConfigElectableSpecs: Hardware specifications for electable nodes in the region.
priority number: Election priority of the region.
providerName string: Cloud service provider on which the servers are provisioned.
readOnlySpecs GetAdvancedClusterReplicationSpecRegionConfigReadOnlySpecs: Hardware specifications for read-only nodes in the region. See below
regionName string: Physical location of your MongoDB cluster.

analytics_auto_scalings Sequence[GetAdvancedClusterReplicationSpecRegionConfigAnalyticsAutoScaling]: Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. See below
analytics_specs GetAdvancedClusterReplicationSpecRegionConfigAnalyticsSpecs: Hardware specifications for analytics nodes needed in the region. See below
auto_scalings Sequence[GetAdvancedClusterReplicationSpecRegionConfigAutoScaling]: Configuration for the Collection of settings that configures auto-scaling information for the cluster. See below
backing_provider_name str: Cloud service provider on which you provision the host for a multi-tenant cluster.
electable_specs GetAdvancedClusterReplicationSpecRegionConfigElectableSpecs: Hardware specifications for electable nodes in the region.
priority int: Election priority of the region.
provider_name str: Cloud service provider on which the servers are provisioned.
read_only_specs GetAdvancedClusterReplicationSpecRegionConfigReadOnlySpecs: Hardware specifications for read-only nodes in the region. See below
region_name str: Physical location of your MongoDB cluster.

analyticsAutoScalings List<Property Map>: Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. See below
analyticsSpecs Property Map: Hardware specifications for analytics nodes needed in the region. See below
autoScalings List<Property Map>: Configuration for the Collection of settings that configures auto-scaling information for the cluster. See below
backingProviderName String: Cloud service provider on which you provision the host for a multi-tenant cluster.
electableSpecs Property Map: Hardware specifications for electable nodes in the region.
priority Number: Election priority of the region.
providerName String: Cloud service provider on which the servers are provisioned.
readOnlySpecs Property Map: Hardware specifications for read-only nodes in the region. See below
regionName String: Physical location of your MongoDB cluster.

GetAdvancedClusterReplicationSpecRegionConfigAnalyticsAutoScaling

ComputeEnabled bool: Flag that indicates whether instance size auto-scaling is enabled.
ComputeMaxInstanceSize string: Maximum instance size to which your cluster can automatically scale (such as M40).
Advanced Configuration
ComputeMinInstanceSize string: Minimum instance size to which your cluster can automatically scale (such as M10).
ComputeScaleDownEnabled bool: Flag that indicates whether the instance size may scale down.
DiskGbEnabled bool: Flag that indicates whether this cluster enables disk auto-scaling.

ComputeEnabled bool: Flag that indicates whether instance size auto-scaling is enabled.
ComputeMaxInstanceSize string: Maximum instance size to which your cluster can automatically scale (such as M40).
Advanced Configuration
ComputeMinInstanceSize string: Minimum instance size to which your cluster can automatically scale (such as M10).
ComputeScaleDownEnabled bool: Flag that indicates whether the instance size may scale down.
DiskGbEnabled bool: Flag that indicates whether this cluster enables disk auto-scaling.

computeEnabled Boolean: Flag that indicates whether instance size auto-scaling is enabled.
computeMaxInstanceSize String: Maximum instance size to which your cluster can automatically scale (such as M40).
Advanced Configuration
computeMinInstanceSize String: Minimum instance size to which your cluster can automatically scale (such as M10).
computeScaleDownEnabled Boolean: Flag that indicates whether the instance size may scale down.
diskGbEnabled Boolean: Flag that indicates whether this cluster enables disk auto-scaling.

computeEnabled boolean: Flag that indicates whether instance size auto-scaling is enabled.
computeMaxInstanceSize string: Maximum instance size to which your cluster can automatically scale (such as M40).
Advanced Configuration
computeMinInstanceSize string: Minimum instance size to which your cluster can automatically scale (such as M10).
computeScaleDownEnabled boolean: Flag that indicates whether the instance size may scale down.
diskGbEnabled boolean: Flag that indicates whether this cluster enables disk auto-scaling.

compute_enabled bool: Flag that indicates whether instance size auto-scaling is enabled.
compute_max_instance_size str: Maximum instance size to which your cluster can automatically scale (such as M40).
Advanced Configuration
compute_min_instance_size str: Minimum instance size to which your cluster can automatically scale (such as M10).
compute_scale_down_enabled bool: Flag that indicates whether the instance size may scale down.
disk_gb_enabled bool: Flag that indicates whether this cluster enables disk auto-scaling.

computeEnabled Boolean: Flag that indicates whether instance size auto-scaling is enabled.
computeMaxInstanceSize String: Maximum instance size to which your cluster can automatically scale (such as M40).
Advanced Configuration
computeMinInstanceSize String: Minimum instance size to which your cluster can automatically scale (such as M10).
computeScaleDownEnabled Boolean: Flag that indicates whether the instance size may scale down.
diskGbEnabled Boolean: Flag that indicates whether this cluster enables disk auto-scaling.

GetAdvancedClusterReplicationSpecRegionConfigAnalyticsSpecs

DiskIops int

Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. This parameter defaults to the cluster tier's standard IOPS value.

DiskSizeGb double

Storage capacity that the host's root volume possesses expressed in gigabytes. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.

EbsVolumeType string

Type of storage you want to attach to your AWS-provisioned cluster.

STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.

InstanceSize string

Hardware specification for the instance sizes in this region.

NodeCount int

Number of nodes of the given type for MongoDB Atlas to deploy to the region.

DiskIops int

Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. This parameter defaults to the cluster tier's standard IOPS value.

DiskSizeGb float64

EbsVolumeType string

Type of storage you want to attach to your AWS-provisioned cluster.

STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.

InstanceSize string

Hardware specification for the instance sizes in this region.

NodeCount int

Number of nodes of the given type for MongoDB Atlas to deploy to the region.

diskIops Integer

Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. This parameter defaults to the cluster tier's standard IOPS value.

diskSizeGb Double

ebsVolumeType String

Type of storage you want to attach to your AWS-provisioned cluster.

STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.

instanceSize String

Hardware specification for the instance sizes in this region.

nodeCount Integer

Number of nodes of the given type for MongoDB Atlas to deploy to the region.

diskIops number

Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. This parameter defaults to the cluster tier's standard IOPS value.

diskSizeGb number

ebsVolumeType string

Type of storage you want to attach to your AWS-provisioned cluster.

STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.

instanceSize string

Hardware specification for the instance sizes in this region.

nodeCount number

Number of nodes of the given type for MongoDB Atlas to deploy to the region.

disk_iops int

Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. This parameter defaults to the cluster tier's standard IOPS value.

disk_size_gb float

ebs_volume_type str

Type of storage you want to attach to your AWS-provisioned cluster.

STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.

instance_size str

Hardware specification for the instance sizes in this region.

node_count int

Number of nodes of the given type for MongoDB Atlas to deploy to the region.

diskIops Number

Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. This parameter defaults to the cluster tier's standard IOPS value.

diskSizeGb Number

ebsVolumeType String

Type of storage you want to attach to your AWS-provisioned cluster.

STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.

instanceSize String

Hardware specification for the instance sizes in this region.

nodeCount Number

Number of nodes of the given type for MongoDB Atlas to deploy to the region.

GetAdvancedClusterReplicationSpecRegionConfigAutoScaling

ComputeEnabled bool: Flag that indicates whether instance size auto-scaling is enabled.
ComputeMaxInstanceSize string: Maximum instance size to which your cluster can automatically scale (such as M40).
Advanced Configuration
ComputeMinInstanceSize string: Minimum instance size to which your cluster can automatically scale (such as M10).
ComputeScaleDownEnabled bool: Flag that indicates whether the instance size may scale down.
DiskGbEnabled bool: Flag that indicates whether this cluster enables disk auto-scaling.

ComputeEnabled bool: Flag that indicates whether instance size auto-scaling is enabled.
ComputeMaxInstanceSize string: Maximum instance size to which your cluster can automatically scale (such as M40).
Advanced Configuration
ComputeMinInstanceSize string: Minimum instance size to which your cluster can automatically scale (such as M10).
ComputeScaleDownEnabled bool: Flag that indicates whether the instance size may scale down.
DiskGbEnabled bool: Flag that indicates whether this cluster enables disk auto-scaling.

computeEnabled Boolean: Flag that indicates whether instance size auto-scaling is enabled.
computeMaxInstanceSize String: Maximum instance size to which your cluster can automatically scale (such as M40).
Advanced Configuration
computeMinInstanceSize String: Minimum instance size to which your cluster can automatically scale (such as M10).
computeScaleDownEnabled Boolean: Flag that indicates whether the instance size may scale down.
diskGbEnabled Boolean: Flag that indicates whether this cluster enables disk auto-scaling.

computeEnabled boolean: Flag that indicates whether instance size auto-scaling is enabled.
computeMaxInstanceSize string: Maximum instance size to which your cluster can automatically scale (such as M40).
Advanced Configuration
computeMinInstanceSize string: Minimum instance size to which your cluster can automatically scale (such as M10).
computeScaleDownEnabled boolean: Flag that indicates whether the instance size may scale down.
diskGbEnabled boolean: Flag that indicates whether this cluster enables disk auto-scaling.

compute_enabled bool: Flag that indicates whether instance size auto-scaling is enabled.
compute_max_instance_size str: Maximum instance size to which your cluster can automatically scale (such as M40).
Advanced Configuration
compute_min_instance_size str: Minimum instance size to which your cluster can automatically scale (such as M10).
compute_scale_down_enabled bool: Flag that indicates whether the instance size may scale down.
disk_gb_enabled bool: Flag that indicates whether this cluster enables disk auto-scaling.

computeEnabled Boolean: Flag that indicates whether instance size auto-scaling is enabled.
computeMaxInstanceSize String: Maximum instance size to which your cluster can automatically scale (such as M40).
Advanced Configuration
computeMinInstanceSize String: Minimum instance size to which your cluster can automatically scale (such as M10).
computeScaleDownEnabled Boolean: Flag that indicates whether the instance size may scale down.
diskGbEnabled Boolean: Flag that indicates whether this cluster enables disk auto-scaling.

GetAdvancedClusterReplicationSpecRegionConfigElectableSpecs

DiskIops int

Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. This parameter defaults to the cluster tier's standard IOPS value.

DiskSizeGb double

EbsVolumeType string

Type of storage you want to attach to your AWS-provisioned cluster.

STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.

InstanceSize string

Hardware specification for the instance sizes in this region.

NodeCount int

Number of nodes of the given type for MongoDB Atlas to deploy to the region.

DiskIops int

Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. This parameter defaults to the cluster tier's standard IOPS value.

DiskSizeGb float64

EbsVolumeType string

Type of storage you want to attach to your AWS-provisioned cluster.

STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.

InstanceSize string

Hardware specification for the instance sizes in this region.

NodeCount int

Number of nodes of the given type for MongoDB Atlas to deploy to the region.

diskIops Integer

Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. This parameter defaults to the cluster tier's standard IOPS value.

diskSizeGb Double

ebsVolumeType String

Type of storage you want to attach to your AWS-provisioned cluster.

STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.

instanceSize String

Hardware specification for the instance sizes in this region.

nodeCount Integer

Number of nodes of the given type for MongoDB Atlas to deploy to the region.

diskIops number

Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. This parameter defaults to the cluster tier's standard IOPS value.

diskSizeGb number

ebsVolumeType string

Type of storage you want to attach to your AWS-provisioned cluster.

STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.

instanceSize string

Hardware specification for the instance sizes in this region.

nodeCount number

Number of nodes of the given type for MongoDB Atlas to deploy to the region.

disk_iops int

Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. This parameter defaults to the cluster tier's standard IOPS value.

disk_size_gb float

ebs_volume_type str

Type of storage you want to attach to your AWS-provisioned cluster.

STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.

instance_size str

Hardware specification for the instance sizes in this region.

node_count int

Number of nodes of the given type for MongoDB Atlas to deploy to the region.

diskIops Number

Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. This parameter defaults to the cluster tier's standard IOPS value.

diskSizeGb Number

ebsVolumeType String

Type of storage you want to attach to your AWS-provisioned cluster.

STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.

instanceSize String

Hardware specification for the instance sizes in this region.

nodeCount Number

Number of nodes of the given type for MongoDB Atlas to deploy to the region.

GetAdvancedClusterReplicationSpecRegionConfigReadOnlySpecs

DiskIops int

Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. This parameter defaults to the cluster tier's standard IOPS value.

DiskSizeGb double

EbsVolumeType string

Type of storage you want to attach to your AWS-provisioned cluster.

STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.

InstanceSize string

Hardware specification for the instance sizes in this region.

NodeCount int

Number of nodes of the given type for MongoDB Atlas to deploy to the region.

DiskIops int

Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. This parameter defaults to the cluster tier's standard IOPS value.

DiskSizeGb float64

EbsVolumeType string

Type of storage you want to attach to your AWS-provisioned cluster.

STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.

InstanceSize string

Hardware specification for the instance sizes in this region.

NodeCount int

Number of nodes of the given type for MongoDB Atlas to deploy to the region.

diskIops Integer

Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. This parameter defaults to the cluster tier's standard IOPS value.

diskSizeGb Double

ebsVolumeType String

Type of storage you want to attach to your AWS-provisioned cluster.

STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.

instanceSize String

Hardware specification for the instance sizes in this region.

nodeCount Integer

Number of nodes of the given type for MongoDB Atlas to deploy to the region.

diskIops number

Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. This parameter defaults to the cluster tier's standard IOPS value.

diskSizeGb number

ebsVolumeType string

Type of storage you want to attach to your AWS-provisioned cluster.

STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.

instanceSize string

Hardware specification for the instance sizes in this region.

nodeCount number

Number of nodes of the given type for MongoDB Atlas to deploy to the region.

disk_iops int

Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. This parameter defaults to the cluster tier's standard IOPS value.

disk_size_gb float

ebs_volume_type str

Type of storage you want to attach to your AWS-provisioned cluster.

STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.

instance_size str

Hardware specification for the instance sizes in this region.

node_count int

Number of nodes of the given type for MongoDB Atlas to deploy to the region.

diskIops Number

Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. This parameter defaults to the cluster tier's standard IOPS value.

diskSizeGb Number

ebsVolumeType String

Type of storage you want to attach to your AWS-provisioned cluster.

STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.

instanceSize String

Hardware specification for the instance sizes in this region.

nodeCount Number

Number of nodes of the given type for MongoDB Atlas to deploy to the region.

GetAdvancedClusterTag

Key string: The key that you want to write.
Value string: The value that you want to write.

Key string: The key that you want to write.
Value string: The value that you want to write.

key String: The key that you want to write.
value String: The value that you want to write.

key string: The key that you want to write.
value string: The value that you want to write.

key str: The key that you want to write.
value str: The value that you want to write.

key String: The key that you want to write.
value String: The value that you want to write.

Package Details

Repository: MongoDB Atlas pulumi/pulumi-mongodbatlas
License: Apache-2.0
Notes: This Pulumi package is based on the mongodbatlas Terraform Provider.

MongoDB Atlas v3.20.4 published on Wednesday, Oct 30, 2024 by Pulumi

pulumi/pulumi-mongodbatlas

mongodbatlas.getAdvancedCluster

On this page

On this page

# Data Source: mongodbatlas.AdvancedCluster

Example Usage

Example using latest sharding configurations with independent shard scaling in the cluster

Using getAdvancedCluster

getAdvancedCluster Result

Supporting Types

GetAdvancedClusterAdvancedConfiguration

GetAdvancedClusterBiConnectorConfig

GetAdvancedClusterConnectionString

GetAdvancedClusterConnectionStringPrivateEndpoint

GetAdvancedClusterConnectionStringPrivateEndpointEndpoint

GetAdvancedClusterLabel

GetAdvancedClusterReplicationSpec

GetAdvancedClusterReplicationSpecRegionConfig

GetAdvancedClusterReplicationSpecRegionConfigAnalyticsAutoScaling

Advanced Configuration

Advanced Configuration

Advanced Configuration

Advanced Configuration

Advanced Configuration

Advanced Configuration

GetAdvancedClusterReplicationSpecRegionConfigAnalyticsSpecs

GetAdvancedClusterReplicationSpecRegionConfigAutoScaling

Advanced Configuration

Advanced Configuration

Advanced Configuration

Advanced Configuration

Advanced Configuration

Advanced Configuration

GetAdvancedClusterReplicationSpecRegionConfigElectableSpecs

GetAdvancedClusterReplicationSpecRegionConfigReadOnlySpecs

GetAdvancedClusterTag

Package Details

On this page

On this page