mongodbatlas.getAdvancedCluster
Explore with Pulumi AI
# Data Source: mongodbatlas.AdvancedCluster
mongodbatlas.AdvancedCluster describes an Advanced Cluster. The data source requires your Project ID.
This page describes the current version of mongodbatlas.AdvancedCluster, the page for the Preview for MongoDB Atlas Provider 2.0.0 can be found here.
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.
NOTE: This data source also includes Flex clusters.
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: "M0",
            },
            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": "M0",
            },
            "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("M0"),
							},
							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 = "M0",
                        },
                        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("M0")
                        .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: M0
              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
Example using Flex cluster
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";
const example_flex = new mongodbatlas.AdvancedCluster("example-flex", {
    projectId: "<YOUR-PROJECT-ID>",
    name: "flex-cluster",
    clusterType: "REPLICASET",
    replicationSpecs: [{
        regionConfigs: [{
            providerName: "FLEX",
            backingProviderName: "AWS",
            regionName: "US_EAST_1",
            priority: 7,
        }],
    }],
});
const example = mongodbatlas.getAdvancedClusterOutput({
    projectId: example_flex.projectId,
    name: example_flex.name,
});
import pulumi
import pulumi_mongodbatlas as mongodbatlas
example_flex = mongodbatlas.AdvancedCluster("example-flex",
    project_id="<YOUR-PROJECT-ID>",
    name="flex-cluster",
    cluster_type="REPLICASET",
    replication_specs=[{
        "region_configs": [{
            "provider_name": "FLEX",
            "backing_provider_name": "AWS",
            "region_name": "US_EAST_1",
            "priority": 7,
        }],
    }])
example = mongodbatlas.get_advanced_cluster_output(project_id=example_flex.project_id,
    name=example_flex.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 {
		example_flex, err := mongodbatlas.NewAdvancedCluster(ctx, "example-flex", &mongodbatlas.AdvancedClusterArgs{
			ProjectId:   pulumi.String("<YOUR-PROJECT-ID>"),
			Name:        pulumi.String("flex-cluster"),
			ClusterType: pulumi.String("REPLICASET"),
			ReplicationSpecs: mongodbatlas.AdvancedClusterReplicationSpecArray{
				&mongodbatlas.AdvancedClusterReplicationSpecArgs{
					RegionConfigs: mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArray{
						&mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArgs{
							ProviderName:        pulumi.String("FLEX"),
							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: example_flex.ProjectId,
			Name:      example_flex.Name,
		}, nil)
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;
return await Deployment.RunAsync(() => 
{
    var example_flex = new Mongodbatlas.AdvancedCluster("example-flex", new()
    {
        ProjectId = "<YOUR-PROJECT-ID>",
        Name = "flex-cluster",
        ClusterType = "REPLICASET",
        ReplicationSpecs = new[]
        {
            new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecArgs
            {
                RegionConfigs = new[]
                {
                    new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigArgs
                    {
                        ProviderName = "FLEX",
                        BackingProviderName = "AWS",
                        RegionName = "US_EAST_1",
                        Priority = 7,
                    },
                },
            },
        },
    });
    var example = Mongodbatlas.GetAdvancedCluster.Invoke(new()
    {
        ProjectId = example_flex.ProjectId,
        Name = example_flex.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 example_flex = new AdvancedCluster("example-flex", AdvancedClusterArgs.builder()
            .projectId("<YOUR-PROJECT-ID>")
            .name("flex-cluster")
            .clusterType("REPLICASET")
            .replicationSpecs(AdvancedClusterReplicationSpecArgs.builder()
                .regionConfigs(AdvancedClusterReplicationSpecRegionConfigArgs.builder()
                    .providerName("FLEX")
                    .backingProviderName("AWS")
                    .regionName("US_EAST_1")
                    .priority(7)
                    .build())
                .build())
            .build());
        final var example = MongodbatlasFunctions.getAdvancedCluster(GetAdvancedClusterArgs.builder()
            .projectId(example_flex.projectId())
            .name(example_flex.name())
            .build());
    }
}
resources:
  example-flex:
    type: mongodbatlas:AdvancedCluster
    properties:
      projectId: <YOUR-PROJECT-ID>
      name: flex-cluster
      clusterType: REPLICASET
      replicationSpecs:
        - regionConfigs:
            - providerName: FLEX
              backingProviderName: AWS
              regionName: US_EAST_1
              priority: 7
variables:
  example:
    fn::invoke:
      function: mongodbatlas:getAdvancedCluster
      arguments:
        projectId: ${["example-flex"].projectId}
        name: ${["example-flex"].name}
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)
public static Output<GetAdvancedClusterResult> getAdvancedCluster(GetAdvancedClusterArgs args, InvokeOptions options)
fn::invoke:
  function: mongodbatlas:index/getAdvancedCluster:getAdvancedCluster
  arguments:
    # arguments dictionaryThe 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 cluster.
- PitEnabled bool
- Flag that indicates if the cluster uses Continuous Cloud Backup.
- UseReplication boolSpec Per Shard 
- Set this field to true to allow the data source to use the latest schema representing each shard with an individual replication_specsobject. 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 cluster.
- PitEnabled bool
- Flag that indicates if the cluster uses Continuous Cloud Backup.
- UseReplication boolSpec Per Shard 
- Set this field to true to allow the data source to use the latest schema representing each shard with an individual replication_specsobject. 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 cluster.
- pitEnabled Boolean
- Flag that indicates if the cluster uses Continuous Cloud Backup.
- useReplication BooleanSpec Per Shard 
- Set this field to true to allow the data source to use the latest schema representing each shard with an individual replication_specsobject. 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 cluster.
- pitEnabled boolean
- Flag that indicates if the cluster uses Continuous Cloud Backup.
- useReplication booleanSpec Per Shard 
- Set this field to true to allow the data source to use the latest schema representing each shard with an individual replication_specsobject. 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 cluster.
- pit_enabled bool
- Flag that indicates if the cluster uses Continuous Cloud Backup.
- use_replication_ boolspec_ per_ shard 
- Set this field to true to allow the data source to use the latest schema representing each shard with an individual replication_specsobject. 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 cluster.
- pitEnabled Boolean
- Flag that indicates if the cluster uses Continuous Cloud Backup.
- useReplication BooleanSpec Per Shard 
- Set this field to true to allow the data source to use the latest schema representing each shard with an individual replication_specsobject. This enables representing clusters with independent shard scaling.
getAdvancedCluster Result
The following output properties are available:
- AdvancedConfigurations List<GetAdvanced Cluster Advanced Configuration> 
- Get the advanced configuration options. See Advanced Configuration below for more details.
- BackupEnabled bool
- BiConnector List<GetConfigs Advanced Cluster Bi Connector Config> 
- ClusterType string
- Type of the cluster that you want to create.
- ConfigServer stringManagement Mode 
- Config Server Management Mode for creating or updating a sharded cluster. Valid values are ATLAS_MANAGED(default) andFIXED_TO_DEDICATED. When configured asATLAS_MANAGED, Atlas may automatically switch the cluster's config server type for optimal performance and savings. When configured asFIXED_TO_DEDICATED, the cluster will always use a dedicated config server. To learn more, see the Sharded Cluster Config Servers documentation.
- ConfigServer stringType 
- Describes a sharded cluster's config server type. Valid values are DEDICATEDandEMBEDDED. To learn more, see the Sharded Cluster Config Servers documentation.
- ConnectionStrings List<GetAdvanced Cluster Connection String> 
- Set of connection strings that your applications use to connect to this cluster. More information 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
- DiskSize doubleGb 
- 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.
- EncryptionAt stringRest Provider 
- Possible values are AWS, GCP, AZURE or NONE.
- GlobalCluster boolSelf Managed Sharding 
- 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<GetAdvanced Cluster Label> 
- Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. (DEPRECATED) Use tagsinstead.
- MongoDb stringMajor Version 
- Version of the cluster to deploy.
- MongoDb stringVersion 
- Version of MongoDB the cluster runs, in major-version.minor-versionformat.
- Name string
- Paused bool
- Flag that indicates whether the cluster is paused or not.
- PinnedFcvs List<GetAdvanced Cluster Pinned Fcv> 
- The pinned Feature Compatibility Version (FCV) with its associated expiration date. See below.
- PitEnabled bool
- Flag that indicates if the cluster uses Continuous Cloud Backup.
- ProjectId string
- RedactClient boolLog Data 
- (Optional) Flag that enables or disables log redaction, see the manual for more information.
- ReplicaSet stringScaling Strategy 
- (Optional) Replica set scaling mode for your cluster.
- ReplicationSpecs List<GetAdvanced Cluster Replication Spec> 
- 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.
- RootCert stringType 
- Certificate Authority that MongoDB Atlas clusters use.
- StateName string
- Current state of the cluster. The possible states are:
- 
List<GetAdvanced Cluster Tag> 
- Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
- TerminationProtection boolEnabled 
- 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.
- VersionRelease stringSystem 
- Release cadence that Atlas uses for this cluster.
- UseReplication boolSpec Per Shard 
- AdvancedConfigurations []GetAdvanced Cluster Advanced Configuration 
- Get the advanced configuration options. See Advanced Configuration below for more details.
- BackupEnabled bool
- BiConnector []GetConfigs Advanced Cluster Bi Connector Config 
- ClusterType string
- Type of the cluster that you want to create.
- ConfigServer stringManagement Mode 
- Config Server Management Mode for creating or updating a sharded cluster. Valid values are ATLAS_MANAGED(default) andFIXED_TO_DEDICATED. When configured asATLAS_MANAGED, Atlas may automatically switch the cluster's config server type for optimal performance and savings. When configured asFIXED_TO_DEDICATED, the cluster will always use a dedicated config server. To learn more, see the Sharded Cluster Config Servers documentation.
- ConfigServer stringType 
- Describes a sharded cluster's config server type. Valid values are DEDICATEDandEMBEDDED. To learn more, see the Sharded Cluster Config Servers documentation.
- ConnectionStrings []GetAdvanced Cluster Connection String 
- Set of connection strings that your applications use to connect to this cluster. More information 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
- DiskSize float64Gb 
- 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.
- EncryptionAt stringRest Provider 
- Possible values are AWS, GCP, AZURE or NONE.
- GlobalCluster boolSelf Managed Sharding 
- 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
[]GetAdvanced Cluster Label 
- Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. (DEPRECATED) Use tagsinstead.
- MongoDb stringMajor Version 
- Version of the cluster to deploy.
- MongoDb stringVersion 
- Version of MongoDB the cluster runs, in major-version.minor-versionformat.
- Name string
- Paused bool
- Flag that indicates whether the cluster is paused or not.
- PinnedFcvs []GetAdvanced Cluster Pinned Fcv 
- The pinned Feature Compatibility Version (FCV) with its associated expiration date. See below.
- PitEnabled bool
- Flag that indicates if the cluster uses Continuous Cloud Backup.
- ProjectId string
- RedactClient boolLog Data 
- (Optional) Flag that enables or disables log redaction, see the manual for more information.
- ReplicaSet stringScaling Strategy 
- (Optional) Replica set scaling mode for your cluster.
- ReplicationSpecs []GetAdvanced Cluster Replication Spec 
- 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.
- RootCert stringType 
- Certificate Authority that MongoDB Atlas clusters use.
- StateName string
- Current state of the cluster. The possible states are:
- 
[]GetAdvanced Cluster Tag 
- Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
- TerminationProtection boolEnabled 
- 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.
- VersionRelease stringSystem 
- Release cadence that Atlas uses for this cluster.
- UseReplication boolSpec Per Shard 
- advancedConfigurations List<GetAdvanced Cluster Advanced Configuration> 
- Get the advanced configuration options. See Advanced Configuration below for more details.
- backupEnabled Boolean
- biConnector List<GetConfigs Advanced Cluster Bi Connector Config> 
- clusterType String
- Type of the cluster that you want to create.
- configServer StringManagement Mode 
- Config Server Management Mode for creating or updating a sharded cluster. Valid values are ATLAS_MANAGED(default) andFIXED_TO_DEDICATED. When configured asATLAS_MANAGED, Atlas may automatically switch the cluster's config server type for optimal performance and savings. When configured asFIXED_TO_DEDICATED, the cluster will always use a dedicated config server. To learn more, see the Sharded Cluster Config Servers documentation.
- configServer StringType 
- Describes a sharded cluster's config server type. Valid values are DEDICATEDandEMBEDDED. To learn more, see the Sharded Cluster Config Servers documentation.
- connectionStrings List<GetAdvanced Cluster Connection String> 
- Set of connection strings that your applications use to connect to this cluster. More information 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
- diskSize DoubleGb 
- 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.
- encryptionAt StringRest Provider 
- Possible values are AWS, GCP, AZURE or NONE.
- globalCluster BooleanSelf Managed Sharding 
- 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<GetAdvanced Cluster Label> 
- Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. (DEPRECATED) Use tagsinstead.
- mongoDb StringMajor Version 
- Version of the cluster to deploy.
- mongoDb StringVersion 
- Version of MongoDB the cluster runs, in major-version.minor-versionformat.
- name String
- paused Boolean
- Flag that indicates whether the cluster is paused or not.
- pinnedFcvs List<GetAdvanced Cluster Pinned Fcv> 
- The pinned Feature Compatibility Version (FCV) with its associated expiration date. See below.
- pitEnabled Boolean
- Flag that indicates if the cluster uses Continuous Cloud Backup.
- projectId String
- redactClient BooleanLog Data 
- (Optional) Flag that enables or disables log redaction, see the manual for more information.
- replicaSet StringScaling Strategy 
- (Optional) Replica set scaling mode for your cluster.
- replicationSpecs List<GetAdvanced Cluster Replication Spec> 
- 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.
- rootCert StringType 
- Certificate Authority that MongoDB Atlas clusters use.
- stateName String
- Current state of the cluster. The possible states are:
- 
List<GetAdvanced Cluster Tag> 
- Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
- terminationProtection BooleanEnabled 
- 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.
- versionRelease StringSystem 
- Release cadence that Atlas uses for this cluster.
- useReplication BooleanSpec Per Shard 
- advancedConfigurations GetAdvanced Cluster Advanced Configuration[] 
- Get the advanced configuration options. See Advanced Configuration below for more details.
- backupEnabled boolean
- biConnector GetConfigs Advanced Cluster Bi Connector Config[] 
- clusterType string
- Type of the cluster that you want to create.
- configServer stringManagement Mode 
- Config Server Management Mode for creating or updating a sharded cluster. Valid values are ATLAS_MANAGED(default) andFIXED_TO_DEDICATED. When configured asATLAS_MANAGED, Atlas may automatically switch the cluster's config server type for optimal performance and savings. When configured asFIXED_TO_DEDICATED, the cluster will always use a dedicated config server. To learn more, see the Sharded Cluster Config Servers documentation.
- configServer stringType 
- Describes a sharded cluster's config server type. Valid values are DEDICATEDandEMBEDDED. To learn more, see the Sharded Cluster Config Servers documentation.
- connectionStrings GetAdvanced Cluster Connection String[] 
- Set of connection strings that your applications use to connect to this cluster. More information 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
- diskSize numberGb 
- 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.
- encryptionAt stringRest Provider 
- Possible values are AWS, GCP, AZURE or NONE.
- globalCluster booleanSelf Managed Sharding 
- 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
GetAdvanced Cluster Label[] 
- Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. (DEPRECATED) Use tagsinstead.
- mongoDb stringMajor Version 
- Version of the cluster to deploy.
- mongoDb stringVersion 
- Version of MongoDB the cluster runs, in major-version.minor-versionformat.
- name string
- paused boolean
- Flag that indicates whether the cluster is paused or not.
- pinnedFcvs GetAdvanced Cluster Pinned Fcv[] 
- The pinned Feature Compatibility Version (FCV) with its associated expiration date. See below.
- pitEnabled boolean
- Flag that indicates if the cluster uses Continuous Cloud Backup.
- projectId string
- redactClient booleanLog Data 
- (Optional) Flag that enables or disables log redaction, see the manual for more information.
- replicaSet stringScaling Strategy 
- (Optional) Replica set scaling mode for your cluster.
- replicationSpecs GetAdvanced Cluster Replication Spec[] 
- 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.
- rootCert stringType 
- Certificate Authority that MongoDB Atlas clusters use.
- stateName string
- Current state of the cluster. The possible states are:
- 
GetAdvanced Cluster Tag[] 
- Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
- terminationProtection booleanEnabled 
- 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.
- versionRelease stringSystem 
- Release cadence that Atlas uses for this cluster.
- useReplication booleanSpec Per Shard 
- advanced_configurations Sequence[GetAdvanced Cluster Advanced Configuration] 
- Get the advanced configuration options. See Advanced Configuration below for more details.
- backup_enabled bool
- bi_connector_ Sequence[Getconfigs Advanced Cluster Bi Connector Config] 
- cluster_type str
- Type of the cluster that you want to create.
- config_server_ strmanagement_ mode 
- Config Server Management Mode for creating or updating a sharded cluster. Valid values are ATLAS_MANAGED(default) andFIXED_TO_DEDICATED. When configured asATLAS_MANAGED, Atlas may automatically switch the cluster's config server type for optimal performance and savings. When configured asFIXED_TO_DEDICATED, the cluster will always use a dedicated config server. To learn more, see the Sharded Cluster Config Servers documentation.
- config_server_ strtype 
- Describes a sharded cluster's config server type. Valid values are DEDICATEDandEMBEDDED. To learn more, see the Sharded Cluster Config Servers documentation.
- connection_strings Sequence[GetAdvanced Cluster Connection String] 
- Set of connection strings that your applications use to connect to this cluster. More information 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_ floatgb 
- 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.
- encryption_at_ strrest_ provider 
- Possible values are AWS, GCP, AZURE or NONE.
- global_cluster_ boolself_ managed_ sharding 
- 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[GetAdvanced Cluster Label] 
- Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. (DEPRECATED) Use tagsinstead.
- mongo_db_ strmajor_ version 
- Version of the cluster to deploy.
- mongo_db_ strversion 
- Version of MongoDB the cluster runs, in major-version.minor-versionformat.
- name str
- paused bool
- Flag that indicates whether the cluster is paused or not.
- pinned_fcvs Sequence[GetAdvanced Cluster Pinned Fcv] 
- The pinned Feature Compatibility Version (FCV) with its associated expiration date. See below.
- pit_enabled bool
- Flag that indicates if the cluster uses Continuous Cloud Backup.
- project_id str
- redact_client_ boollog_ data 
- (Optional) Flag that enables or disables log redaction, see the manual for more information.
- replica_set_ strscaling_ strategy 
- (Optional) Replica set scaling mode for your cluster.
- replication_specs Sequence[GetAdvanced Cluster Replication Spec] 
- 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_ strtype 
- Certificate Authority that MongoDB Atlas clusters use.
- state_name str
- Current state of the cluster. The possible states are:
- 
Sequence[GetAdvanced Cluster Tag] 
- Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
- termination_protection_ boolenabled 
- 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_ strsystem 
- Release cadence that Atlas uses for this cluster.
- use_replication_ boolspec_ per_ shard 
- advancedConfigurations List<Property Map>
- Get the advanced configuration options. See Advanced Configuration below for more details.
- backupEnabled Boolean
- biConnector List<Property Map>Configs 
- clusterType String
- Type of the cluster that you want to create.
- configServer StringManagement Mode 
- Config Server Management Mode for creating or updating a sharded cluster. Valid values are ATLAS_MANAGED(default) andFIXED_TO_DEDICATED. When configured asATLAS_MANAGED, Atlas may automatically switch the cluster's config server type for optimal performance and savings. When configured asFIXED_TO_DEDICATED, the cluster will always use a dedicated config server. To learn more, see the Sharded Cluster Config Servers documentation.
- configServer StringType 
- Describes a sharded cluster's config server type. Valid values are DEDICATEDandEMBEDDED. 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 information 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
- diskSize NumberGb 
- 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.
- encryptionAt StringRest Provider 
- Possible values are AWS, GCP, AZURE or NONE.
- globalCluster BooleanSelf Managed Sharding 
- 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 tagsinstead.
- mongoDb StringMajor Version 
- Version of the cluster to deploy.
- mongoDb StringVersion 
- Version of MongoDB the cluster runs, in major-version.minor-versionformat.
- name String
- paused Boolean
- Flag that indicates whether the cluster is paused or not.
- pinnedFcvs List<Property Map>
- The pinned Feature Compatibility Version (FCV) with its associated expiration date. See below.
- pitEnabled Boolean
- Flag that indicates if the cluster uses Continuous Cloud Backup.
- projectId String
- redactClient BooleanLog Data 
- (Optional) Flag that enables or disables log redaction, see the manual for more information.
- replicaSet StringScaling Strategy 
- (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.
- rootCert StringType 
- Certificate Authority that MongoDB Atlas clusters use.
- stateName String
- Current state of the cluster. The possible states are:
- List<Property Map>
- Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
- terminationProtection BooleanEnabled 
- 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.
- versionRelease StringSystem 
- Release cadence that Atlas uses for this cluster.
- useReplication BooleanSpec Per Shard 
Supporting Types
GetAdvancedClusterAdvancedConfiguration    
- ChangeStream intOptions Pre And Post Images Expire After Seconds 
- (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).
- CustomOpenssl List<string>Cipher Config Tls12s 
- The custom OpenSSL cipher suite list for TLS 1.2. This field is only valid when tls_cipher_config_modeis set toCUSTOM.
- DefaultMax intTime Ms 
- Default time limit in milliseconds for individual read operations to complete. This option corresponds to the defaultMaxTimeMS cluster parameter. This parameter is supported only for MongoDB version 8.0 and above.
- DefaultRead stringConcern 
- 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.
- DefaultWrite stringConcern 
- Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.
- FailIndex boolKey Too Long 
- 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.
- 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.
- MinimumEnabled stringTls Protocol 
- Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections. Valid values are:
- NoTable boolScan 
- 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.
- OplogMin doubleRetention Hours 
- 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.
- OplogSize intMb 
- The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.
- SampleRefresh intInterval Bi Connector 
- 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.
- SampleSize intBi Connector 
- 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.
- TlsCipher stringConfig Mode 
- The TLS cipher suite configuration mode. Valid values include CUSTOMorDEFAULT. TheDEFAULTmode uses the default cipher suites. TheCUSTOMmode allows you to specify custom cipher suites for both TLS 1.2 and TLS 1.3.
- TransactionLifetime intLimit Seconds 
- Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.
- ChangeStream intOptions Pre And Post Images Expire After Seconds 
- (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).
- CustomOpenssl []stringCipher Config Tls12s 
- The custom OpenSSL cipher suite list for TLS 1.2. This field is only valid when tls_cipher_config_modeis set toCUSTOM.
- DefaultMax intTime Ms 
- Default time limit in milliseconds for individual read operations to complete. This option corresponds to the defaultMaxTimeMS cluster parameter. This parameter is supported only for MongoDB version 8.0 and above.
- DefaultRead stringConcern 
- 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.
- DefaultWrite stringConcern 
- Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.
- FailIndex boolKey Too Long 
- 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.
- 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.
- MinimumEnabled stringTls Protocol 
- Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections. Valid values are:
- NoTable boolScan 
- 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.
- OplogMin float64Retention Hours 
- 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.
- OplogSize intMb 
- The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.
- SampleRefresh intInterval Bi Connector 
- 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.
- SampleSize intBi Connector 
- 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.
- TlsCipher stringConfig Mode 
- The TLS cipher suite configuration mode. Valid values include CUSTOMorDEFAULT. TheDEFAULTmode uses the default cipher suites. TheCUSTOMmode allows you to specify custom cipher suites for both TLS 1.2 and TLS 1.3.
- TransactionLifetime intLimit Seconds 
- Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.
- changeStream IntegerOptions Pre And Post Images Expire After Seconds 
- (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).
- customOpenssl List<String>Cipher Config Tls12s 
- The custom OpenSSL cipher suite list for TLS 1.2. This field is only valid when tls_cipher_config_modeis set toCUSTOM.
- defaultMax IntegerTime Ms 
- Default time limit in milliseconds for individual read operations to complete. This option corresponds to the defaultMaxTimeMS cluster parameter. This parameter is supported only for MongoDB version 8.0 and above.
- defaultRead StringConcern 
- 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.
- defaultWrite StringConcern 
- Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.
- failIndex BooleanKey Too Long 
- 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.
- 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.
- minimumEnabled StringTls Protocol 
- Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections. Valid values are:
- noTable BooleanScan 
- 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.
- oplogMin DoubleRetention Hours 
- 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.
- oplogSize IntegerMb 
- The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.
- sampleRefresh IntegerInterval Bi Connector 
- 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.
- sampleSize IntegerBi Connector 
- 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.
- tlsCipher StringConfig Mode 
- The TLS cipher suite configuration mode. Valid values include CUSTOMorDEFAULT. TheDEFAULTmode uses the default cipher suites. TheCUSTOMmode allows you to specify custom cipher suites for both TLS 1.2 and TLS 1.3.
- transactionLifetime IntegerLimit Seconds 
- Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.
- changeStream numberOptions Pre And Post Images Expire After Seconds 
- (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).
- customOpenssl string[]Cipher Config Tls12s 
- The custom OpenSSL cipher suite list for TLS 1.2. This field is only valid when tls_cipher_config_modeis set toCUSTOM.
- defaultMax numberTime Ms 
- Default time limit in milliseconds for individual read operations to complete. This option corresponds to the defaultMaxTimeMS cluster parameter. This parameter is supported only for MongoDB version 8.0 and above.
- defaultRead stringConcern 
- 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.
- defaultWrite stringConcern 
- Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.
- failIndex booleanKey Too Long 
- 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.
- 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.
- minimumEnabled stringTls Protocol 
- Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections. Valid values are:
- noTable booleanScan 
- 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.
- oplogMin numberRetention Hours 
- 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.
- oplogSize numberMb 
- The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.
- sampleRefresh numberInterval Bi Connector 
- 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.
- sampleSize numberBi Connector 
- 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.
- tlsCipher stringConfig Mode 
- The TLS cipher suite configuration mode. Valid values include CUSTOMorDEFAULT. TheDEFAULTmode uses the default cipher suites. TheCUSTOMmode allows you to specify custom cipher suites for both TLS 1.2 and TLS 1.3.
- transactionLifetime numberLimit Seconds 
- Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.
- change_stream_ intoptions_ pre_ and_ post_ images_ expire_ after_ seconds 
- (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).
- custom_openssl_ Sequence[str]cipher_ config_ tls12s 
- The custom OpenSSL cipher suite list for TLS 1.2. This field is only valid when tls_cipher_config_modeis set toCUSTOM.
- default_max_ inttime_ ms 
- Default time limit in milliseconds for individual read operations to complete. This option corresponds to the defaultMaxTimeMS cluster parameter. This parameter is supported only for MongoDB version 8.0 and above.
- default_read_ strconcern 
- 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.
- default_write_ strconcern 
- Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.
- fail_index_ boolkey_ too_ long 
- 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.
- 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_ strtls_ protocol 
- Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections. Valid values are:
- no_table_ boolscan 
- 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_ floatretention_ hours 
- 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_ intmb 
- 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_ intinterval_ bi_ connector 
- 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_ intbi_ connector 
- 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.
- tls_cipher_ strconfig_ mode 
- The TLS cipher suite configuration mode. Valid values include CUSTOMorDEFAULT. TheDEFAULTmode uses the default cipher suites. TheCUSTOMmode allows you to specify custom cipher suites for both TLS 1.2 and TLS 1.3.
- transaction_lifetime_ intlimit_ seconds 
- Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.
- changeStream NumberOptions Pre And Post Images Expire After Seconds 
- (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).
- customOpenssl List<String>Cipher Config Tls12s 
- The custom OpenSSL cipher suite list for TLS 1.2. This field is only valid when tls_cipher_config_modeis set toCUSTOM.
- defaultMax NumberTime Ms 
- Default time limit in milliseconds for individual read operations to complete. This option corresponds to the defaultMaxTimeMS cluster parameter. This parameter is supported only for MongoDB version 8.0 and above.
- defaultRead StringConcern 
- 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.
- defaultWrite StringConcern 
- Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.
- failIndex BooleanKey Too Long 
- 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.
- 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.
- minimumEnabled StringTls Protocol 
- Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections. Valid values are:
- noTable BooleanScan 
- 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.
- oplogMin NumberRetention Hours 
- 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.
- oplogSize NumberMb 
- The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.
- sampleRefresh NumberInterval Bi Connector 
- 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.
- sampleSize NumberBi Connector 
- 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.
- tlsCipher StringConfig Mode 
- The TLS cipher suite configuration mode. Valid values include CUSTOMorDEFAULT. TheDEFAULTmode uses the default cipher suites. TheCUSTOMmode allows you to specify custom cipher suites for both TLS 1.2 and TLS 1.3.
- transactionLifetime NumberLimit Seconds 
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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<GetAdvanced Cluster Connection String Private Endpoint> 
- 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+srvprotocol 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[#].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 support it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[#].srvConnectionString.
- connection_strings.private_endpoint.#.type- Type of MongoDB process that you connect to with the connection strings. Atlas returns- MONGODfor replica sets, or- MONGOSfor sharded clusters.
- connection_strings.private_endpoint.#.endpoints- Private endpoint through which you connect to Atlas when you use- connection_strings.private_endpoint[#].connection_stringor- connection_strings.private_endpoint[#].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- AWSor- 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
- 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 []GetAdvanced Cluster Connection String Private Endpoint 
- 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+srvprotocol 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[#].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 support it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[#].srvConnectionString.
- connection_strings.private_endpoint.#.type- Type of MongoDB process that you connect to with the connection strings. Atlas returns- MONGODfor replica sets, or- MONGOSfor sharded clusters.
- connection_strings.private_endpoint.#.endpoints- Private endpoint through which you connect to Atlas when you use- connection_strings.private_endpoint[#].connection_stringor- connection_strings.private_endpoint[#].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- AWSor- 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.
- privateEndpoints List<GetAdvanced Cluster Connection String Private Endpoint> 
- 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+srvprotocol 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[#].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 support it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[#].srvConnectionString.
- connection_strings.private_endpoint.#.type- Type of MongoDB process that you connect to with the connection strings. Atlas returns- MONGODfor replica sets, or- MONGOSfor sharded clusters.
- connection_strings.private_endpoint.#.endpoints- Private endpoint through which you connect to Atlas when you use- connection_strings.private_endpoint[#].connection_stringor- connection_strings.private_endpoint[#].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- AWSor- 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.
- 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.
- 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
- 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 GetAdvanced Cluster Connection String Private Endpoint[] 
- 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+srvprotocol 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[#].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 support it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[#].srvConnectionString.
- connection_strings.private_endpoint.#.type- Type of MongoDB process that you connect to with the connection strings. Atlas returns- MONGODfor replica sets, or- MONGOSfor sharded clusters.
- connection_strings.private_endpoint.#.endpoints- Private endpoint through which you connect to Atlas when you use- connection_strings.private_endpoint[#].connection_stringor- connection_strings.private_endpoint[#].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- AWSor- 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 str
- 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.
- private_endpoints Sequence[GetAdvanced Cluster Connection String Private Endpoint] 
- 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+srvprotocol 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[#].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 support it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[#].srvConnectionString.
- connection_strings.private_endpoint.#.type- Type of MongoDB process that you connect to with the connection strings. Atlas returns- MONGODfor replica sets, or- MONGOSfor sharded clusters.
- connection_strings.private_endpoint.#.endpoints- Private endpoint through which you connect to Atlas when you use- connection_strings.private_endpoint[#].connection_stringor- connection_strings.private_endpoint[#].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- AWSor- AZURE.
- connection_strings.private_endpoint.#.endpoints.#.region- Region to which you deployed the private endpoint.
 
- private_srv str
- 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 str
- Public mongodb:// connection string for this cluster.
- standard_srv str
- 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
- 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<Property Map>
- 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+srvprotocol 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[#].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 support it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[#].srvConnectionString.
- connection_strings.private_endpoint.#.type- Type of MongoDB process that you connect to with the connection strings. Atlas returns- MONGODfor replica sets, or- MONGOSfor sharded clusters.
- connection_strings.private_endpoint.#.endpoints- Private endpoint through which you connect to Atlas when you use- connection_strings.private_endpoint[#].connection_stringor- connection_strings.private_endpoint[#].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- AWSor- 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.
GetAdvancedClusterConnectionStringPrivateEndpoint      
- connectionString String
- endpoints List<Property Map>
- srvConnection StringString 
- srvShard StringOptimized Connection 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   
GetAdvancedClusterPinnedFcv    
- ExpirationDate string
- Expiration date of the fixed FCV. This value is in the ISO 8601 timestamp format (e.g. "2024-12-04T16:25:00Z").
- Version string
- Feature compatibility version of the cluster.
- ExpirationDate string
- Expiration date of the fixed FCV. This value is in the ISO 8601 timestamp format (e.g. "2024-12-04T16:25:00Z").
- Version string
- Feature compatibility version of the cluster.
- expirationDate String
- Expiration date of the fixed FCV. This value is in the ISO 8601 timestamp format (e.g. "2024-12-04T16:25:00Z").
- version String
- Feature compatibility version of the cluster.
- expirationDate string
- Expiration date of the fixed FCV. This value is in the ISO 8601 timestamp format (e.g. "2024-12-04T16:25:00Z").
- version string
- Feature compatibility version of the cluster.
- expiration_date str
- Expiration date of the fixed FCV. This value is in the ISO 8601 timestamp format (e.g. "2024-12-04T16:25:00Z").
- version str
- Feature compatibility version of the cluster.
- expirationDate String
- Expiration date of the fixed FCV. This value is in the ISO 8601 timestamp format (e.g. "2024-12-04T16:25:00Z").
- version String
- Feature compatibility version of the cluster.
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". ExampleAWS: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_shardsgreater than 1) this value is not populated.
- Id string
- NumShards int
- Provide this value if you set a cluster_typeofSHARDEDorGEOSHARDED. (DEPRECATED) To learn more, see the Migration Guide.
- RegionConfigs List<GetAdvanced Cluster Replication Spec Region Config> 
- Configuration for the hardware specifications for nodes set for a given region. Each region_configsobject describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Eachregion_configsobject must have either ananalytics_specsobject,electable_specsobject, orread_only_specsobject. 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". ExampleAWS: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_shardsgreater than 1) this value is not populated.
- Id string
- NumShards int
- Provide this value if you set a cluster_typeofSHARDEDorGEOSHARDED. (DEPRECATED) To learn more, see the Migration Guide.
- RegionConfigs []GetAdvanced Cluster Replication Spec Region Config 
- Configuration for the hardware specifications for nodes set for a given region. Each region_configsobject describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Eachregion_configsobject must have either ananalytics_specsobject,electable_specsobject, orread_only_specsobject. 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". ExampleAWS: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_shardsgreater than 1) this value is not populated.
- id String
- numShards Integer
- Provide this value if you set a cluster_typeofSHARDEDorGEOSHARDED. (DEPRECATED) To learn more, see the Migration Guide.
- regionConfigs List<GetAdvanced Cluster Replication Spec Region Config> 
- Configuration for the hardware specifications for nodes set for a given region. Each region_configsobject describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Eachregion_configsobject must have either ananalytics_specsobject,electable_specsobject, orread_only_specsobject. 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". ExampleAWS: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_shardsgreater than 1) this value is not populated.
- id string
- numShards number
- Provide this value if you set a cluster_typeofSHARDEDorGEOSHARDED. (DEPRECATED) To learn more, see the Migration Guide.
- regionConfigs GetAdvanced Cluster Replication Spec Region Config[] 
- Configuration for the hardware specifications for nodes set for a given region. Each region_configsobject describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Eachregion_configsobject must have either ananalytics_specsobject,electable_specsobject, orread_only_specsobject. 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". ExampleAWS: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_shardsgreater than 1) this value is not populated.
- id str
- num_shards int
- Provide this value if you set a cluster_typeofSHARDEDorGEOSHARDED. (DEPRECATED) To learn more, see the Migration Guide.
- region_configs Sequence[GetAdvanced Cluster Replication Spec Region Config] 
- Configuration for the hardware specifications for nodes set for a given region. Each region_configsobject describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Eachregion_configsobject must have either ananalytics_specsobject,electable_specsobject, orread_only_specsobject. 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". ExampleAWS: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_shardsgreater than 1) this value is not populated.
- id String
- numShards Number
- Provide this value if you set a cluster_typeofSHARDEDorGEOSHARDED. (DEPRECATED) To learn more, see the Migration Guide.
- regionConfigs List<Property Map>
- Configuration for the hardware specifications for nodes set for a given region. Each region_configsobject describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Eachregion_configsobject must have either ananalytics_specsobject,electable_specsobject, orread_only_specsobject. 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      
- AnalyticsAuto List<GetScalings Advanced Cluster Replication Spec Region Config Analytics Auto Scaling> 
- Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. See below.
- AnalyticsSpecs GetAdvanced Cluster Replication Spec Region Config Analytics Specs 
- Hardware specifications for analytics nodes needed in the region. See below.
- AutoScalings List<GetAdvanced Cluster Replication Spec Region Config Auto Scaling> 
- Configuration for the Collection of settings that configures auto-scaling information for the cluster. See below.
- BackingProvider stringName 
- Cloud service provider on which you provision the host for a multi-tenant cluster.
- ElectableSpecs GetAdvanced Cluster Replication Spec Region Config Electable Specs 
- 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.
- ReadOnly GetSpecs Advanced Cluster Replication Spec Region Config Read Only Specs 
- Hardware specifications for read-only nodes in the region. See below.
- RegionName string
- Physical location of your MongoDB cluster.
- AnalyticsAuto []GetScalings Advanced Cluster Replication Spec Region Config Analytics Auto Scaling 
- Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. See below.
- AnalyticsSpecs GetAdvanced Cluster Replication Spec Region Config Analytics Specs 
- Hardware specifications for analytics nodes needed in the region. See below.
- AutoScalings []GetAdvanced Cluster Replication Spec Region Config Auto Scaling 
- Configuration for the Collection of settings that configures auto-scaling information for the cluster. See below.
- BackingProvider stringName 
- Cloud service provider on which you provision the host for a multi-tenant cluster.
- ElectableSpecs GetAdvanced Cluster Replication Spec Region Config Electable Specs 
- 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.
- ReadOnly GetSpecs Advanced Cluster Replication Spec Region Config Read Only Specs 
- Hardware specifications for read-only nodes in the region. See below.
- RegionName string
- Physical location of your MongoDB cluster.
- analyticsAuto List<GetScalings Advanced Cluster Replication Spec Region Config Analytics Auto Scaling> 
- Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. See below.
- analyticsSpecs GetAdvanced Cluster Replication Spec Region Config Analytics Specs 
- Hardware specifications for analytics nodes needed in the region. See below.
- autoScalings List<GetAdvanced Cluster Replication Spec Region Config Auto Scaling> 
- Configuration for the Collection of settings that configures auto-scaling information for the cluster. See below.
- backingProvider StringName 
- Cloud service provider on which you provision the host for a multi-tenant cluster.
- electableSpecs GetAdvanced Cluster Replication Spec Region Config Electable Specs 
- 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.
- readOnly GetSpecs Advanced Cluster Replication Spec Region Config Read Only Specs 
- Hardware specifications for read-only nodes in the region. See below.
- regionName String
- Physical location of your MongoDB cluster.
- analyticsAuto GetScalings Advanced Cluster Replication Spec Region Config Analytics Auto Scaling[] 
- Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. See below.
- analyticsSpecs GetAdvanced Cluster Replication Spec Region Config Analytics Specs 
- Hardware specifications for analytics nodes needed in the region. See below.
- autoScalings GetAdvanced Cluster Replication Spec Region Config Auto Scaling[] 
- Configuration for the Collection of settings that configures auto-scaling information for the cluster. See below.
- backingProvider stringName 
- Cloud service provider on which you provision the host for a multi-tenant cluster.
- electableSpecs GetAdvanced Cluster Replication Spec Region Config Electable Specs 
- 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.
- readOnly GetSpecs Advanced Cluster Replication Spec Region Config Read Only Specs 
- Hardware specifications for read-only nodes in the region. See below.
- regionName string
- Physical location of your MongoDB cluster.
- analytics_auto_ Sequence[Getscalings Advanced Cluster Replication Spec Region Config Analytics Auto Scaling] 
- Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. See below.
- analytics_specs GetAdvanced Cluster Replication Spec Region Config Analytics Specs 
- Hardware specifications for analytics nodes needed in the region. See below.
- auto_scalings Sequence[GetAdvanced Cluster Replication Spec Region Config Auto Scaling] 
- Configuration for the Collection of settings that configures auto-scaling information for the cluster. See below.
- backing_provider_ strname 
- Cloud service provider on which you provision the host for a multi-tenant cluster.
- electable_specs GetAdvanced Cluster Replication Spec Region Config Electable Specs 
- 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_ Getspecs Advanced Cluster Replication Spec Region Config Read Only Specs 
- Hardware specifications for read-only nodes in the region. See below.
- region_name str
- Physical location of your MongoDB cluster.
- analyticsAuto List<Property Map>Scalings 
- 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.
- backingProvider StringName 
- 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.
- readOnly Property MapSpecs 
- 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.
- ComputeMax stringInstance Size 
- Maximum instance size to which your cluster can automatically scale (such as M40).Advanced Configuration
- ComputeMin stringInstance Size 
- Minimum instance size to which your cluster can automatically scale (such as M10).
- ComputeScale boolDown Enabled 
- Flag that indicates whether the instance size may scale down.
- DiskGb boolEnabled 
- Flag that indicates whether this cluster enables disk auto-scaling.
- ComputeEnabled bool
- Flag that indicates whether instance size auto-scaling is enabled.
- ComputeMax stringInstance Size 
- Maximum instance size to which your cluster can automatically scale (such as M40).Advanced Configuration
- ComputeMin stringInstance Size 
- Minimum instance size to which your cluster can automatically scale (such as M10).
- ComputeScale boolDown Enabled 
- Flag that indicates whether the instance size may scale down.
- DiskGb boolEnabled 
- Flag that indicates whether this cluster enables disk auto-scaling.
- computeEnabled Boolean
- Flag that indicates whether instance size auto-scaling is enabled.
- computeMax StringInstance Size 
- Maximum instance size to which your cluster can automatically scale (such as M40).Advanced Configuration
- computeMin StringInstance Size 
- Minimum instance size to which your cluster can automatically scale (such as M10).
- computeScale BooleanDown Enabled 
- Flag that indicates whether the instance size may scale down.
- diskGb BooleanEnabled 
- Flag that indicates whether this cluster enables disk auto-scaling.
- computeEnabled boolean
- Flag that indicates whether instance size auto-scaling is enabled.
- computeMax stringInstance Size 
- Maximum instance size to which your cluster can automatically scale (such as M40).Advanced Configuration
- computeMin stringInstance Size 
- Minimum instance size to which your cluster can automatically scale (such as M10).
- computeScale booleanDown Enabled 
- Flag that indicates whether the instance size may scale down.
- diskGb booleanEnabled 
- 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_ strinstance_ size 
- Maximum instance size to which your cluster can automatically scale (such as M40).Advanced Configuration
- compute_min_ strinstance_ size 
- Minimum instance size to which your cluster can automatically scale (such as M10).
- compute_scale_ booldown_ enabled 
- Flag that indicates whether the instance size may scale down.
- disk_gb_ boolenabled 
- Flag that indicates whether this cluster enables disk auto-scaling.
- computeEnabled Boolean
- Flag that indicates whether instance size auto-scaling is enabled.
- computeMax StringInstance Size 
- Maximum instance size to which your cluster can automatically scale (such as M40).Advanced Configuration
- computeMin StringInstance Size 
- Minimum instance size to which your cluster can automatically scale (such as M10).
- computeScale BooleanDown Enabled 
- Flag that indicates whether the instance size may scale down.
- diskGb BooleanEnabled 
- 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.
- DiskSize doubleGb 
- 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.
- EbsVolume stringType 
- Type of storage you want to attach to your AWS-provisioned cluster.- STANDARDvolume types can't exceed the default IOPS rate for the selected volume size.
- PROVISIONEDvolume 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.
- DiskSize float64Gb 
- 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.
- EbsVolume stringType 
- Type of storage you want to attach to your AWS-provisioned cluster.- STANDARDvolume types can't exceed the default IOPS rate for the selected volume size.
- PROVISIONEDvolume 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.
- diskSize DoubleGb 
- 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.
- ebsVolume StringType 
- Type of storage you want to attach to your AWS-provisioned cluster.- STANDARDvolume types can't exceed the default IOPS rate for the selected volume size.
- PROVISIONEDvolume 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.
- diskSize numberGb 
- 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.
- ebsVolume stringType 
- Type of storage you want to attach to your AWS-provisioned cluster.- STANDARDvolume types can't exceed the default IOPS rate for the selected volume size.
- PROVISIONEDvolume 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_ floatgb 
- 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.
- ebs_volume_ strtype 
- Type of storage you want to attach to your AWS-provisioned cluster.- STANDARDvolume types can't exceed the default IOPS rate for the selected volume size.
- PROVISIONEDvolume 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.
- diskSize NumberGb 
- 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.
- ebsVolume StringType 
- Type of storage you want to attach to your AWS-provisioned cluster.- STANDARDvolume types can't exceed the default IOPS rate for the selected volume size.
- PROVISIONEDvolume 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.
- ComputeMax stringInstance Size 
- Maximum instance size to which your cluster can automatically scale (such as M40).Advanced Configuration
- ComputeMin stringInstance Size 
- Minimum instance size to which your cluster can automatically scale (such as M10).
- ComputeScale boolDown Enabled 
- Flag that indicates whether the instance size may scale down.
- DiskGb boolEnabled 
- Flag that indicates whether this cluster enables disk auto-scaling.
- ComputeEnabled bool
- Flag that indicates whether instance size auto-scaling is enabled.
- ComputeMax stringInstance Size 
- Maximum instance size to which your cluster can automatically scale (such as M40).Advanced Configuration
- ComputeMin stringInstance Size 
- Minimum instance size to which your cluster can automatically scale (such as M10).
- ComputeScale boolDown Enabled 
- Flag that indicates whether the instance size may scale down.
- DiskGb boolEnabled 
- Flag that indicates whether this cluster enables disk auto-scaling.
- computeEnabled Boolean
- Flag that indicates whether instance size auto-scaling is enabled.
- computeMax StringInstance Size 
- Maximum instance size to which your cluster can automatically scale (such as M40).Advanced Configuration
- computeMin StringInstance Size 
- Minimum instance size to which your cluster can automatically scale (such as M10).
- computeScale BooleanDown Enabled 
- Flag that indicates whether the instance size may scale down.
- diskGb BooleanEnabled 
- Flag that indicates whether this cluster enables disk auto-scaling.
- computeEnabled boolean
- Flag that indicates whether instance size auto-scaling is enabled.
- computeMax stringInstance Size 
- Maximum instance size to which your cluster can automatically scale (such as M40).Advanced Configuration
- computeMin stringInstance Size 
- Minimum instance size to which your cluster can automatically scale (such as M10).
- computeScale booleanDown Enabled 
- Flag that indicates whether the instance size may scale down.
- diskGb booleanEnabled 
- 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_ strinstance_ size 
- Maximum instance size to which your cluster can automatically scale (such as M40).Advanced Configuration
- compute_min_ strinstance_ size 
- Minimum instance size to which your cluster can automatically scale (such as M10).
- compute_scale_ booldown_ enabled 
- Flag that indicates whether the instance size may scale down.
- disk_gb_ boolenabled 
- Flag that indicates whether this cluster enables disk auto-scaling.
- computeEnabled Boolean
- Flag that indicates whether instance size auto-scaling is enabled.
- computeMax StringInstance Size 
- Maximum instance size to which your cluster can automatically scale (such as M40).Advanced Configuration
- computeMin StringInstance Size 
- Minimum instance size to which your cluster can automatically scale (such as M10).
- computeScale BooleanDown Enabled 
- Flag that indicates whether the instance size may scale down.
- diskGb BooleanEnabled 
- 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.
- DiskSize doubleGb 
- 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.
- EbsVolume stringType 
- Type of storage you want to attach to your AWS-provisioned cluster.- STANDARDvolume types can't exceed the default IOPS rate for the selected volume size.
- PROVISIONEDvolume 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.
- DiskSize float64Gb 
- 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.
- EbsVolume stringType 
- Type of storage you want to attach to your AWS-provisioned cluster.- STANDARDvolume types can't exceed the default IOPS rate for the selected volume size.
- PROVISIONEDvolume 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.
- diskSize DoubleGb 
- 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.
- ebsVolume StringType 
- Type of storage you want to attach to your AWS-provisioned cluster.- STANDARDvolume types can't exceed the default IOPS rate for the selected volume size.
- PROVISIONEDvolume 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.
- diskSize numberGb 
- 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.
- ebsVolume stringType 
- Type of storage you want to attach to your AWS-provisioned cluster.- STANDARDvolume types can't exceed the default IOPS rate for the selected volume size.
- PROVISIONEDvolume 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_ floatgb 
- 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.
- ebs_volume_ strtype 
- Type of storage you want to attach to your AWS-provisioned cluster.- STANDARDvolume types can't exceed the default IOPS rate for the selected volume size.
- PROVISIONEDvolume 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.
- diskSize NumberGb 
- 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.
- ebsVolume StringType 
- Type of storage you want to attach to your AWS-provisioned cluster.- STANDARDvolume types can't exceed the default IOPS rate for the selected volume size.
- PROVISIONEDvolume 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.
- DiskSize doubleGb 
- 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.
- EbsVolume stringType 
- Type of storage you want to attach to your AWS-provisioned cluster.- STANDARDvolume types can't exceed the default IOPS rate for the selected volume size.
- PROVISIONEDvolume 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.
- DiskSize float64Gb 
- 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.
- EbsVolume stringType 
- Type of storage you want to attach to your AWS-provisioned cluster.- STANDARDvolume types can't exceed the default IOPS rate for the selected volume size.
- PROVISIONEDvolume 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.
- diskSize DoubleGb 
- 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.
- ebsVolume StringType 
- Type of storage you want to attach to your AWS-provisioned cluster.- STANDARDvolume types can't exceed the default IOPS rate for the selected volume size.
- PROVISIONEDvolume 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.
- diskSize numberGb 
- 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.
- ebsVolume stringType 
- Type of storage you want to attach to your AWS-provisioned cluster.- STANDARDvolume types can't exceed the default IOPS rate for the selected volume size.
- PROVISIONEDvolume 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_ floatgb 
- 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.
- ebs_volume_ strtype 
- Type of storage you want to attach to your AWS-provisioned cluster.- STANDARDvolume types can't exceed the default IOPS rate for the selected volume size.
- PROVISIONEDvolume 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.
- diskSize NumberGb 
- 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.
- ebsVolume StringType 
- Type of storage you want to attach to your AWS-provisioned cluster.- STANDARDvolume types can't exceed the default IOPS rate for the selected volume size.
- PROVISIONEDvolume 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   
Package Details
- Repository
- MongoDB Atlas pulumi/pulumi-mongodbatlas
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the mongodbatlasTerraform Provider.