MongoDB Atlas

v3.5.1 published on Thursday, Sep 15, 2022 by Pulumi

AdvancedCluster

Import

Clusters can be imported using project ID and cluster name, in the format PROJECTID-CLUSTERNAME, e.g.

 $ pulumi import mongodbatlas:index/advancedCluster:AdvancedCluster my_cluster 1112222b3bf99403840e8934-Cluster0

See detailed information for arguments and attributesMongoDB API Advanced Clusters

Example Usage

Example single provider and single region

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

return await Deployment.RunAsync(() => 
{
    var test = new Mongodbatlas.AdvancedCluster("test", new()
    {
        ClusterType = "REPLICASET",
        ProjectId = "PROJECT ID",
        ReplicationSpecs = new[]
        {
            new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecArgs
            {
                RegionConfigs = new[]
                {
                    new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigArgs
                    {
                        AnalyticsSpecs = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigAnalyticsSpecsArgs
                        {
                            InstanceSize = "M10",
                            NodeCount = 1,
                        },
                        ElectableSpecs = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs
                        {
                            InstanceSize = "M10",
                            NodeCount = 3,
                        },
                        Priority = 1,
                        ProviderName = "AWS",
                        RegionName = "US_EAST_1",
                    },
                },
            },
        },
    });

});
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 {
		_, err := mongodbatlas.NewAdvancedCluster(ctx, "test", &mongodbatlas.AdvancedClusterArgs{
			ClusterType: pulumi.String("REPLICASET"),
			ProjectId:   pulumi.String("PROJECT ID"),
			ReplicationSpecs: AdvancedClusterReplicationSpecArray{
				&AdvancedClusterReplicationSpecArgs{
					RegionConfigs: AdvancedClusterReplicationSpecRegionConfigArray{
						&AdvancedClusterReplicationSpecRegionConfigArgs{
							AnalyticsSpecs: &AdvancedClusterReplicationSpecRegionConfigAnalyticsSpecsArgs{
								InstanceSize: pulumi.String("M10"),
								NodeCount:    pulumi.Int(1),
							},
							ElectableSpecs: &AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs{
								InstanceSize: pulumi.String("M10"),
								NodeCount:    pulumi.Int(3),
							},
							Priority:     pulumi.Int(1),
							ProviderName: pulumi.String("AWS"),
							RegionName:   pulumi.String("US_EAST_1"),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
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 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 test = new AdvancedCluster("test", AdvancedClusterArgs.builder()        
            .clusterType("REPLICASET")
            .projectId("PROJECT ID")
            .replicationSpecs(AdvancedClusterReplicationSpecArgs.builder()
                .regionConfigs(AdvancedClusterReplicationSpecRegionConfigArgs.builder()
                    .analyticsSpecs(AdvancedClusterReplicationSpecRegionConfigAnalyticsSpecsArgs.builder()
                        .instanceSize("M10")
                        .nodeCount(1)
                        .build())
                    .electableSpecs(AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs.builder()
                        .instanceSize("M10")
                        .nodeCount(3)
                        .build())
                    .priority(1)
                    .providerName("AWS")
                    .regionName("US_EAST_1")
                    .build())
                .build())
            .build());

    }
}
import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.AdvancedCluster("test",
    cluster_type="REPLICASET",
    project_id="PROJECT ID",
    replication_specs=[mongodbatlas.AdvancedClusterReplicationSpecArgs(
        region_configs=[mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArgs(
            analytics_specs=mongodbatlas.AdvancedClusterReplicationSpecRegionConfigAnalyticsSpecsArgs(
                instance_size="M10",
                node_count=1,
            ),
            electable_specs=mongodbatlas.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs(
                instance_size="M10",
                node_count=3,
            ),
            priority=1,
            provider_name="AWS",
            region_name="US_EAST_1",
        )],
    )])
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const test = new mongodbatlas.AdvancedCluster("test", {
    clusterType: "REPLICASET",
    projectId: "PROJECT ID",
    replicationSpecs: [{
        regionConfigs: [{
            analyticsSpecs: {
                instanceSize: "M10",
                nodeCount: 1,
            },
            electableSpecs: {
                instanceSize: "M10",
                nodeCount: 3,
            },
            priority: 1,
            providerName: "AWS",
            regionName: "US_EAST_1",
        }],
    }],
});
resources:
  test:
    type: mongodbatlas:AdvancedCluster
    properties:
      clusterType: REPLICASET
      projectId: PROJECT ID
      replicationSpecs:
        - regionConfigs:
            - analyticsSpecs:
                instanceSize: M10
                nodeCount: 1
              electableSpecs:
                instanceSize: M10
                nodeCount: 3
              priority: 1
              providerName: AWS
              regionName: US_EAST_1

Example Tenant Cluster

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

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

});
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 {
		_, err := mongodbatlas.NewAdvancedCluster(ctx, "test", &mongodbatlas.AdvancedClusterArgs{
			ClusterType: pulumi.String("REPLICASET"),
			ProjectId:   pulumi.String("PROJECT ID"),
			ReplicationSpecs: AdvancedClusterReplicationSpecArray{
				&AdvancedClusterReplicationSpecArgs{
					RegionConfigs: AdvancedClusterReplicationSpecRegionConfigArray{
						&AdvancedClusterReplicationSpecRegionConfigArgs{
							BackingProviderName: pulumi.String("AWS"),
							ElectableSpecs: &AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs{
								InstanceSize: pulumi.String("M5"),
							},
							Priority:     pulumi.Int(1),
							ProviderName: pulumi.String("TENANT"),
							RegionName:   pulumi.String("US_EAST_1"),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
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 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 test = new AdvancedCluster("test", AdvancedClusterArgs.builder()        
            .clusterType("REPLICASET")
            .projectId("PROJECT ID")
            .replicationSpecs(AdvancedClusterReplicationSpecArgs.builder()
                .regionConfigs(AdvancedClusterReplicationSpecRegionConfigArgs.builder()
                    .backingProviderName("AWS")
                    .electableSpecs(AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs.builder()
                        .instanceSize("M5")
                        .build())
                    .priority(1)
                    .providerName("TENANT")
                    .regionName("US_EAST_1")
                    .build())
                .build())
            .build());

    }
}
import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.AdvancedCluster("test",
    cluster_type="REPLICASET",
    project_id="PROJECT ID",
    replication_specs=[mongodbatlas.AdvancedClusterReplicationSpecArgs(
        region_configs=[mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArgs(
            backing_provider_name="AWS",
            electable_specs=mongodbatlas.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs(
                instance_size="M5",
            ),
            priority=1,
            provider_name="TENANT",
            region_name="US_EAST_1",
        )],
    )])
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const test = new mongodbatlas.AdvancedCluster("test", {
    clusterType: "REPLICASET",
    projectId: "PROJECT ID",
    replicationSpecs: [{
        regionConfigs: [{
            backingProviderName: "AWS",
            electableSpecs: {
                instanceSize: "M5",
            },
            priority: 1,
            providerName: "TENANT",
            regionName: "US_EAST_1",
        }],
    }],
});
resources:
  test:
    type: mongodbatlas:AdvancedCluster
    properties:
      clusterType: REPLICASET
      projectId: PROJECT ID
      replicationSpecs:
        - regionConfigs:
            - backingProviderName: AWS
              electableSpecs:
                instanceSize: M5
              priority: 1
              providerName: TENANT
              regionName: US_EAST_1

Example Multicloud.

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

return await Deployment.RunAsync(() => 
{
    var test = new Mongodbatlas.AdvancedCluster("test", new()
    {
        ClusterType = "REPLICASET",
        ProjectId = "PROJECT ID",
        ReplicationSpecs = new[]
        {
            new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecArgs
            {
                RegionConfigs = new[]
                {
                    new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigArgs
                    {
                        AnalyticsSpecs = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigAnalyticsSpecsArgs
                        {
                            InstanceSize = "M10",
                            NodeCount = 1,
                        },
                        ElectableSpecs = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs
                        {
                            InstanceSize = "M10",
                            NodeCount = 3,
                        },
                        Priority = 1,
                        ProviderName = "AWS",
                        RegionName = "US_EAST_1",
                    },
                    new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigArgs
                    {
                        ElectableSpecs = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs
                        {
                            InstanceSize = "M10",
                            NodeCount = 2,
                        },
                        Priority = 6,
                        ProviderName = "GCP",
                        RegionName = "NORTH_AMERICA_NORTHEAST_1",
                    },
                },
            },
        },
    });

});
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 {
		_, err := mongodbatlas.NewAdvancedCluster(ctx, "test", &mongodbatlas.AdvancedClusterArgs{
			ClusterType: pulumi.String("REPLICASET"),
			ProjectId:   pulumi.String("PROJECT ID"),
			ReplicationSpecs: AdvancedClusterReplicationSpecArray{
				&AdvancedClusterReplicationSpecArgs{
					RegionConfigs: AdvancedClusterReplicationSpecRegionConfigArray{
						&AdvancedClusterReplicationSpecRegionConfigArgs{
							AnalyticsSpecs: &AdvancedClusterReplicationSpecRegionConfigAnalyticsSpecsArgs{
								InstanceSize: pulumi.String("M10"),
								NodeCount:    pulumi.Int(1),
							},
							ElectableSpecs: &AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs{
								InstanceSize: pulumi.String("M10"),
								NodeCount:    pulumi.Int(3),
							},
							Priority:     pulumi.Int(1),
							ProviderName: pulumi.String("AWS"),
							RegionName:   pulumi.String("US_EAST_1"),
						},
						&AdvancedClusterReplicationSpecRegionConfigArgs{
							ElectableSpecs: &AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs{
								InstanceSize: pulumi.String("M10"),
								NodeCount:    pulumi.Int(2),
							},
							Priority:     pulumi.Int(6),
							ProviderName: pulumi.String("GCP"),
							RegionName:   pulumi.String("NORTH_AMERICA_NORTHEAST_1"),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
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 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 test = new AdvancedCluster("test", AdvancedClusterArgs.builder()        
            .clusterType("REPLICASET")
            .projectId("PROJECT ID")
            .replicationSpecs(AdvancedClusterReplicationSpecArgs.builder()
                .regionConfigs(                
                    AdvancedClusterReplicationSpecRegionConfigArgs.builder()
                        .analyticsSpecs(AdvancedClusterReplicationSpecRegionConfigAnalyticsSpecsArgs.builder()
                            .instanceSize("M10")
                            .nodeCount(1)
                            .build())
                        .electableSpecs(AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs.builder()
                            .instanceSize("M10")
                            .nodeCount(3)
                            .build())
                        .priority(1)
                        .providerName("AWS")
                        .regionName("US_EAST_1")
                        .build(),
                    AdvancedClusterReplicationSpecRegionConfigArgs.builder()
                        .electableSpecs(AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs.builder()
                            .instanceSize("M10")
                            .nodeCount(2)
                            .build())
                        .priority(6)
                        .providerName("GCP")
                        .regionName("NORTH_AMERICA_NORTHEAST_1")
                        .build())
                .build())
            .build());

    }
}
import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.AdvancedCluster("test",
    cluster_type="REPLICASET",
    project_id="PROJECT ID",
    replication_specs=[mongodbatlas.AdvancedClusterReplicationSpecArgs(
        region_configs=[
            mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArgs(
                analytics_specs=mongodbatlas.AdvancedClusterReplicationSpecRegionConfigAnalyticsSpecsArgs(
                    instance_size="M10",
                    node_count=1,
                ),
                electable_specs=mongodbatlas.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs(
                    instance_size="M10",
                    node_count=3,
                ),
                priority=1,
                provider_name="AWS",
                region_name="US_EAST_1",
            ),
            mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArgs(
                electable_specs=mongodbatlas.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs(
                    instance_size="M10",
                    node_count=2,
                ),
                priority=6,
                provider_name="GCP",
                region_name="NORTH_AMERICA_NORTHEAST_1",
            ),
        ],
    )])
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const test = new mongodbatlas.AdvancedCluster("test", {
    clusterType: "REPLICASET",
    projectId: "PROJECT ID",
    replicationSpecs: [{
        regionConfigs: [
            {
                analyticsSpecs: {
                    instanceSize: "M10",
                    nodeCount: 1,
                },
                electableSpecs: {
                    instanceSize: "M10",
                    nodeCount: 3,
                },
                priority: 1,
                providerName: "AWS",
                regionName: "US_EAST_1",
            },
            {
                electableSpecs: {
                    instanceSize: "M10",
                    nodeCount: 2,
                },
                priority: 6,
                providerName: "GCP",
                regionName: "NORTH_AMERICA_NORTHEAST_1",
            },
        ],
    }],
});
resources:
  test:
    type: mongodbatlas:AdvancedCluster
    properties:
      clusterType: REPLICASET
      projectId: PROJECT ID
      replicationSpecs:
        - regionConfigs:
            - analyticsSpecs:
                instanceSize: M10
                nodeCount: 1
              electableSpecs:
                instanceSize: M10
                nodeCount: 3
              priority: 1
              providerName: AWS
              regionName: US_EAST_1
            - electableSpecs:
                instanceSize: M10
                nodeCount: 2
              priority: 6
              providerName: GCP
              regionName: NORTH_AMERICA_NORTHEAST_1

Create a AdvancedCluster Resource

new AdvancedCluster(name: string, args: AdvancedClusterArgs, opts?: CustomResourceOptions);
@overload
def AdvancedCluster(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    advanced_configuration: Optional[AdvancedClusterAdvancedConfigurationArgs] = None,
                    backup_enabled: Optional[bool] = None,
                    bi_connector: Optional[AdvancedClusterBiConnectorArgs] = None,
                    cluster_type: Optional[str] = None,
                    disk_size_gb: Optional[float] = None,
                    encryption_at_rest_provider: Optional[str] = None,
                    labels: Optional[Sequence[AdvancedClusterLabelArgs]] = None,
                    mongo_db_major_version: Optional[str] = None,
                    name: Optional[str] = None,
                    paused: Optional[bool] = None,
                    pit_enabled: Optional[bool] = None,
                    project_id: Optional[str] = None,
                    replication_specs: Optional[Sequence[AdvancedClusterReplicationSpecArgs]] = None,
                    root_cert_type: Optional[str] = None,
                    version_release_system: Optional[str] = None)
@overload
def AdvancedCluster(resource_name: str,
                    args: AdvancedClusterArgs,
                    opts: Optional[ResourceOptions] = None)
func NewAdvancedCluster(ctx *Context, name string, args AdvancedClusterArgs, opts ...ResourceOption) (*AdvancedCluster, error)
public AdvancedCluster(string name, AdvancedClusterArgs args, CustomResourceOptions? opts = null)
public AdvancedCluster(String name, AdvancedClusterArgs args)
public AdvancedCluster(String name, AdvancedClusterArgs args, CustomResourceOptions options)
type: mongodbatlas:AdvancedCluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

AdvancedCluster Resource Properties

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

Inputs

The AdvancedCluster resource accepts the following input properties:

ClusterType string

Type of the cluster that you want to create. Accepted values include:

ProjectId string

Unique ID for the project to create the database user.

ReplicationSpecs List<AdvancedClusterReplicationSpecArgs>

Configuration for cluster regions and the hardware provisioned in them. See below

AdvancedConfiguration AdvancedClusterAdvancedConfigurationArgs
BackupEnabled bool

Flag that indicates whether the cluster can perform backups. If true, the cluster can perform backups. You must set this value to true for NVMe clusters.

BiConnector AdvancedClusterBiConnectorArgs

Configuration settings applied to BI Connector for Atlas on this cluster. The MongoDB Connector for Business Intelligence for Atlas (BI Connector) is only available for M10 and larger clusters. The BI Connector is a powerful tool which provides users SQL-based access to their MongoDB databases. As a result, the BI Connector performs operations which may be CPU and memory intensive. Given the limited hardware resources on M10 and M20 cluster tiers, you may experience performance degradation of the cluster when enabling the BI Connector. If this occurs, upgrade to an M30 or larger cluster or disable the BI Connector. See below.

DiskSizeGb double

Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive number. You can't set this value with clusters with local NVMe SSDs. The minimum disk size for dedicated clusters is 10 GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value. If your cluster includes Azure nodes, this value must correspond to an existing Azure disk type (8, 16, 32, 64, 128, 256, 512, 1024, 2048, or 4095)Atlas calculates storage charges differently depending 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 additional storage space beyond this limitation, consider upgrading your cluster to a higher tier. If your cluster spans cloud service providers, this value defaults to the minimum default of the providers involved.

EncryptionAtRestProvider string

Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For Documentation, see AWS, GCP and Azure. Requirements are if replication_specs.#.region_configs.#.<type>Specs.instance_size is M10 or greater and backup_enabled is false or omitted.

Labels List<AdvancedClusterLabelArgs>

Configuration for the collection of key-value pairs that tag and categorize the cluster. See below.

MongoDbMajorVersion string

Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters: 4.0, 4.2, 4.4, or 5.0. If omitted, Atlas deploys a cluster that runs MongoDB 4.4. If replication_specs#.region_configs#.<type>Specs.instance_size: M0, M2 or M5, Atlas deploys MongoDB 4.4. Atlas always deploys the cluster with the latest stable release of the specified version. If you set a value to this parameter and set version_release_system CONTINUOUS, the resource returns an error. Either clear this parameter or set version_release_system: LTS.

Name string

Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed.

Paused bool
PitEnabled bool
  • Flag that indicates if the cluster uses Continuous Cloud Backup.
RootCertType string
  • Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).
VersionReleaseSystem string
  • Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:
  • CONTINUOUS: Atlas creates your cluster using the most recent MongoDB release. Atlas automatically updates your cluster to the latest major and rapid MongoDB releases as they become available.
  • LTS: Atlas creates your cluster using the latest patch release of the MongoDB version that you specify in the mongoDBMajorVersion field. Atlas automatically updates your cluster to subsequent patch releases of this MongoDB version. Atlas doesn't update your cluster to newer rapid or major MongoDB releases as they become available.
ClusterType string

Type of the cluster that you want to create. Accepted values include:

ProjectId string

Unique ID for the project to create the database user.

ReplicationSpecs []AdvancedClusterReplicationSpecArgs

Configuration for cluster regions and the hardware provisioned in them. See below

AdvancedConfiguration AdvancedClusterAdvancedConfigurationArgs
BackupEnabled bool

Flag that indicates whether the cluster can perform backups. If true, the cluster can perform backups. You must set this value to true for NVMe clusters.

BiConnector AdvancedClusterBiConnectorArgs

Configuration settings applied to BI Connector for Atlas on this cluster. The MongoDB Connector for Business Intelligence for Atlas (BI Connector) is only available for M10 and larger clusters. The BI Connector is a powerful tool which provides users SQL-based access to their MongoDB databases. As a result, the BI Connector performs operations which may be CPU and memory intensive. Given the limited hardware resources on M10 and M20 cluster tiers, you may experience performance degradation of the cluster when enabling the BI Connector. If this occurs, upgrade to an M30 or larger cluster or disable the BI Connector. See below.

DiskSizeGb float64

Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive number. You can't set this value with clusters with local NVMe SSDs. The minimum disk size for dedicated clusters is 10 GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value. If your cluster includes Azure nodes, this value must correspond to an existing Azure disk type (8, 16, 32, 64, 128, 256, 512, 1024, 2048, or 4095)Atlas calculates storage charges differently depending 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 additional storage space beyond this limitation, consider upgrading your cluster to a higher tier. If your cluster spans cloud service providers, this value defaults to the minimum default of the providers involved.

EncryptionAtRestProvider string

Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For Documentation, see AWS, GCP and Azure. Requirements are if replication_specs.#.region_configs.#.<type>Specs.instance_size is M10 or greater and backup_enabled is false or omitted.

Labels []AdvancedClusterLabelArgs

Configuration for the collection of key-value pairs that tag and categorize the cluster. See below.

MongoDbMajorVersion string

Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters: 4.0, 4.2, 4.4, or 5.0. If omitted, Atlas deploys a cluster that runs MongoDB 4.4. If replication_specs#.region_configs#.<type>Specs.instance_size: M0, M2 or M5, Atlas deploys MongoDB 4.4. Atlas always deploys the cluster with the latest stable release of the specified version. If you set a value to this parameter and set version_release_system CONTINUOUS, the resource returns an error. Either clear this parameter or set version_release_system: LTS.

Name string

Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed.

Paused bool
PitEnabled bool
  • Flag that indicates if the cluster uses Continuous Cloud Backup.
RootCertType string
  • Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).
VersionReleaseSystem string
  • Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:
  • CONTINUOUS: Atlas creates your cluster using the most recent MongoDB release. Atlas automatically updates your cluster to the latest major and rapid MongoDB releases as they become available.
  • LTS: Atlas creates your cluster using the latest patch release of the MongoDB version that you specify in the mongoDBMajorVersion field. Atlas automatically updates your cluster to subsequent patch releases of this MongoDB version. Atlas doesn't update your cluster to newer rapid or major MongoDB releases as they become available.
clusterType String

Type of the cluster that you want to create. Accepted values include:

projectId String

Unique ID for the project to create the database user.

replicationSpecs List<AdvancedClusterReplicationSpecArgs>

Configuration for cluster regions and the hardware provisioned in them. See below

advancedConfiguration AdvancedClusterAdvancedConfigurationArgs
backupEnabled Boolean

Flag that indicates whether the cluster can perform backups. If true, the cluster can perform backups. You must set this value to true for NVMe clusters.

biConnector AdvancedClusterBiConnectorArgs

Configuration settings applied to BI Connector for Atlas on this cluster. The MongoDB Connector for Business Intelligence for Atlas (BI Connector) is only available for M10 and larger clusters. The BI Connector is a powerful tool which provides users SQL-based access to their MongoDB databases. As a result, the BI Connector performs operations which may be CPU and memory intensive. Given the limited hardware resources on M10 and M20 cluster tiers, you may experience performance degradation of the cluster when enabling the BI Connector. If this occurs, upgrade to an M30 or larger cluster or disable the BI Connector. See below.

diskSizeGb Double

Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive number. You can't set this value with clusters with local NVMe SSDs. The minimum disk size for dedicated clusters is 10 GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value. If your cluster includes Azure nodes, this value must correspond to an existing Azure disk type (8, 16, 32, 64, 128, 256, 512, 1024, 2048, or 4095)Atlas calculates storage charges differently depending 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 additional storage space beyond this limitation, consider upgrading your cluster to a higher tier. If your cluster spans cloud service providers, this value defaults to the minimum default of the providers involved.

encryptionAtRestProvider String

Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For Documentation, see AWS, GCP and Azure. Requirements are if replication_specs.#.region_configs.#.<type>Specs.instance_size is M10 or greater and backup_enabled is false or omitted.

labels List<AdvancedClusterLabelArgs>

Configuration for the collection of key-value pairs that tag and categorize the cluster. See below.

mongoDbMajorVersion String

Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters: 4.0, 4.2, 4.4, or 5.0. If omitted, Atlas deploys a cluster that runs MongoDB 4.4. If replication_specs#.region_configs#.<type>Specs.instance_size: M0, M2 or M5, Atlas deploys MongoDB 4.4. Atlas always deploys the cluster with the latest stable release of the specified version. If you set a value to this parameter and set version_release_system CONTINUOUS, the resource returns an error. Either clear this parameter or set version_release_system: LTS.

name String

Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed.

paused Boolean
pitEnabled Boolean
  • Flag that indicates if the cluster uses Continuous Cloud Backup.
rootCertType String
  • Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).
versionReleaseSystem String
  • Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:
  • CONTINUOUS: Atlas creates your cluster using the most recent MongoDB release. Atlas automatically updates your cluster to the latest major and rapid MongoDB releases as they become available.
  • LTS: Atlas creates your cluster using the latest patch release of the MongoDB version that you specify in the mongoDBMajorVersion field. Atlas automatically updates your cluster to subsequent patch releases of this MongoDB version. Atlas doesn't update your cluster to newer rapid or major MongoDB releases as they become available.
clusterType string

Type of the cluster that you want to create. Accepted values include:

projectId string

Unique ID for the project to create the database user.

replicationSpecs AdvancedClusterReplicationSpecArgs[]

Configuration for cluster regions and the hardware provisioned in them. See below

advancedConfiguration AdvancedClusterAdvancedConfigurationArgs
backupEnabled boolean

Flag that indicates whether the cluster can perform backups. If true, the cluster can perform backups. You must set this value to true for NVMe clusters.

biConnector AdvancedClusterBiConnectorArgs

Configuration settings applied to BI Connector for Atlas on this cluster. The MongoDB Connector for Business Intelligence for Atlas (BI Connector) is only available for M10 and larger clusters. The BI Connector is a powerful tool which provides users SQL-based access to their MongoDB databases. As a result, the BI Connector performs operations which may be CPU and memory intensive. Given the limited hardware resources on M10 and M20 cluster tiers, you may experience performance degradation of the cluster when enabling the BI Connector. If this occurs, upgrade to an M30 or larger cluster or disable the BI Connector. See below.

diskSizeGb number

Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive number. You can't set this value with clusters with local NVMe SSDs. The minimum disk size for dedicated clusters is 10 GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value. If your cluster includes Azure nodes, this value must correspond to an existing Azure disk type (8, 16, 32, 64, 128, 256, 512, 1024, 2048, or 4095)Atlas calculates storage charges differently depending 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 additional storage space beyond this limitation, consider upgrading your cluster to a higher tier. If your cluster spans cloud service providers, this value defaults to the minimum default of the providers involved.

encryptionAtRestProvider string

Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For Documentation, see AWS, GCP and Azure. Requirements are if replication_specs.#.region_configs.#.<type>Specs.instance_size is M10 or greater and backup_enabled is false or omitted.

labels AdvancedClusterLabelArgs[]

Configuration for the collection of key-value pairs that tag and categorize the cluster. See below.

mongoDbMajorVersion string

Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters: 4.0, 4.2, 4.4, or 5.0. If omitted, Atlas deploys a cluster that runs MongoDB 4.4. If replication_specs#.region_configs#.<type>Specs.instance_size: M0, M2 or M5, Atlas deploys MongoDB 4.4. Atlas always deploys the cluster with the latest stable release of the specified version. If you set a value to this parameter and set version_release_system CONTINUOUS, the resource returns an error. Either clear this parameter or set version_release_system: LTS.

name string

Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed.

paused boolean
pitEnabled boolean
  • Flag that indicates if the cluster uses Continuous Cloud Backup.
rootCertType string
  • Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).
versionReleaseSystem string
  • Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:
  • CONTINUOUS: Atlas creates your cluster using the most recent MongoDB release. Atlas automatically updates your cluster to the latest major and rapid MongoDB releases as they become available.
  • LTS: Atlas creates your cluster using the latest patch release of the MongoDB version that you specify in the mongoDBMajorVersion field. Atlas automatically updates your cluster to subsequent patch releases of this MongoDB version. Atlas doesn't update your cluster to newer rapid or major MongoDB releases as they become available.
cluster_type str

Type of the cluster that you want to create. Accepted values include:

project_id str

Unique ID for the project to create the database user.

replication_specs Sequence[AdvancedClusterReplicationSpecArgs]

Configuration for cluster regions and the hardware provisioned in them. See below

advanced_configuration AdvancedClusterAdvancedConfigurationArgs
backup_enabled bool

Flag that indicates whether the cluster can perform backups. If true, the cluster can perform backups. You must set this value to true for NVMe clusters.

bi_connector AdvancedClusterBiConnectorArgs

Configuration settings applied to BI Connector for Atlas on this cluster. The MongoDB Connector for Business Intelligence for Atlas (BI Connector) is only available for M10 and larger clusters. The BI Connector is a powerful tool which provides users SQL-based access to their MongoDB databases. As a result, the BI Connector performs operations which may be CPU and memory intensive. Given the limited hardware resources on M10 and M20 cluster tiers, you may experience performance degradation of the cluster when enabling the BI Connector. If this occurs, upgrade to an M30 or larger cluster or disable the BI Connector. See below.

disk_size_gb float

Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive number. You can't set this value with clusters with local NVMe SSDs. The minimum disk size for dedicated clusters is 10 GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value. If your cluster includes Azure nodes, this value must correspond to an existing Azure disk type (8, 16, 32, 64, 128, 256, 512, 1024, 2048, or 4095)Atlas calculates storage charges differently depending 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 additional storage space beyond this limitation, consider upgrading your cluster to a higher tier. If your cluster spans cloud service providers, this value defaults to the minimum default of the providers involved.

encryption_at_rest_provider str

Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For Documentation, see AWS, GCP and Azure. Requirements are if replication_specs.#.region_configs.#.<type>Specs.instance_size is M10 or greater and backup_enabled is false or omitted.

labels Sequence[AdvancedClusterLabelArgs]

Configuration for the collection of key-value pairs that tag and categorize the cluster. See below.

mongo_db_major_version str

Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters: 4.0, 4.2, 4.4, or 5.0. If omitted, Atlas deploys a cluster that runs MongoDB 4.4. If replication_specs#.region_configs#.<type>Specs.instance_size: M0, M2 or M5, Atlas deploys MongoDB 4.4. Atlas always deploys the cluster with the latest stable release of the specified version. If you set a value to this parameter and set version_release_system CONTINUOUS, the resource returns an error. Either clear this parameter or set version_release_system: LTS.

name str

Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed.

paused bool
pit_enabled bool
  • Flag that indicates if the cluster uses Continuous Cloud Backup.
root_cert_type str
  • Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).
version_release_system str
  • Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:
  • CONTINUOUS: Atlas creates your cluster using the most recent MongoDB release. Atlas automatically updates your cluster to the latest major and rapid MongoDB releases as they become available.
  • LTS: Atlas creates your cluster using the latest patch release of the MongoDB version that you specify in the mongoDBMajorVersion field. Atlas automatically updates your cluster to subsequent patch releases of this MongoDB version. Atlas doesn't update your cluster to newer rapid or major MongoDB releases as they become available.
clusterType String

Type of the cluster that you want to create. Accepted values include:

projectId String

Unique ID for the project to create the database user.

replicationSpecs List<Property Map>

Configuration for cluster regions and the hardware provisioned in them. See below

advancedConfiguration Property Map
backupEnabled Boolean

Flag that indicates whether the cluster can perform backups. If true, the cluster can perform backups. You must set this value to true for NVMe clusters.

biConnector Property Map

Configuration settings applied to BI Connector for Atlas on this cluster. The MongoDB Connector for Business Intelligence for Atlas (BI Connector) is only available for M10 and larger clusters. The BI Connector is a powerful tool which provides users SQL-based access to their MongoDB databases. As a result, the BI Connector performs operations which may be CPU and memory intensive. Given the limited hardware resources on M10 and M20 cluster tiers, you may experience performance degradation of the cluster when enabling the BI Connector. If this occurs, upgrade to an M30 or larger cluster or disable the BI Connector. See below.

diskSizeGb Number

Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive number. You can't set this value with clusters with local NVMe SSDs. The minimum disk size for dedicated clusters is 10 GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value. If your cluster includes Azure nodes, this value must correspond to an existing Azure disk type (8, 16, 32, 64, 128, 256, 512, 1024, 2048, or 4095)Atlas calculates storage charges differently depending 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 additional storage space beyond this limitation, consider upgrading your cluster to a higher tier. If your cluster spans cloud service providers, this value defaults to the minimum default of the providers involved.

encryptionAtRestProvider String

Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For Documentation, see AWS, GCP and Azure. Requirements are if replication_specs.#.region_configs.#.<type>Specs.instance_size is M10 or greater and backup_enabled is false or omitted.

labels List<Property Map>

Configuration for the collection of key-value pairs that tag and categorize the cluster. See below.

mongoDbMajorVersion String

Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters: 4.0, 4.2, 4.4, or 5.0. If omitted, Atlas deploys a cluster that runs MongoDB 4.4. If replication_specs#.region_configs#.<type>Specs.instance_size: M0, M2 or M5, Atlas deploys MongoDB 4.4. Atlas always deploys the cluster with the latest stable release of the specified version. If you set a value to this parameter and set version_release_system CONTINUOUS, the resource returns an error. Either clear this parameter or set version_release_system: LTS.

name String

Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed.

paused Boolean
pitEnabled Boolean
  • Flag that indicates if the cluster uses Continuous Cloud Backup.
rootCertType String
  • Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).
versionReleaseSystem String
  • Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:
  • CONTINUOUS: Atlas creates your cluster using the most recent MongoDB release. Atlas automatically updates your cluster to the latest major and rapid MongoDB releases as they become available.
  • LTS: Atlas creates your cluster using the latest patch release of the MongoDB version that you specify in the mongoDBMajorVersion field. Atlas automatically updates your cluster to subsequent patch releases of this MongoDB version. Atlas doesn't update your cluster to newer rapid or major MongoDB releases as they become available.

Outputs

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

ClusterId string

The cluster ID.

ConnectionStrings List<AdvancedClusterConnectionString>

Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.

CreateDate string
Id string

The provider-assigned unique ID for this managed resource.

MongoDbVersion string

Version of MongoDB the cluster runs, in major-version.minor-version format.

StateName string

Current state of the cluster. The possible states are:

  • IDLE
  • CREATING
  • UPDATING
  • DELETING
  • DELETED
  • REPAIRING
ClusterId string

The cluster ID.

ConnectionStrings []AdvancedClusterConnectionString

Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.

CreateDate string
Id string

The provider-assigned unique ID for this managed resource.

MongoDbVersion string

Version of MongoDB the cluster runs, in major-version.minor-version format.

StateName string

Current state of the cluster. The possible states are:

  • IDLE
  • CREATING
  • UPDATING
  • DELETING
  • DELETED
  • REPAIRING
clusterId String

The cluster ID.

connectionStrings List<AdvancedClusterConnectionString>

Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.

createDate String
id String

The provider-assigned unique ID for this managed resource.

mongoDbVersion String

Version of MongoDB the cluster runs, in major-version.minor-version format.

stateName String

Current state of the cluster. The possible states are:

  • IDLE
  • CREATING
  • UPDATING
  • DELETING
  • DELETED
  • REPAIRING
clusterId string

The cluster ID.

connectionStrings AdvancedClusterConnectionString[]

Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.

createDate string
id string

The provider-assigned unique ID for this managed resource.

mongoDbVersion string

Version of MongoDB the cluster runs, in major-version.minor-version format.

stateName string

Current state of the cluster. The possible states are:

  • IDLE
  • CREATING
  • UPDATING
  • DELETING
  • DELETED
  • REPAIRING
cluster_id str

The cluster ID.

connection_strings Sequence[AdvancedClusterConnectionString]

Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.

create_date str
id str

The provider-assigned unique ID for this managed resource.

mongo_db_version str

Version of MongoDB the cluster runs, in major-version.minor-version format.

state_name str

Current state of the cluster. The possible states are:

  • IDLE
  • CREATING
  • UPDATING
  • DELETING
  • DELETED
  • REPAIRING
clusterId String

The cluster ID.

connectionStrings List<Property Map>

Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.

createDate String
id String

The provider-assigned unique ID for this managed resource.

mongoDbVersion String

Version of MongoDB the cluster runs, in major-version.minor-version format.

stateName String

Current state of the cluster. The possible states are:

  • IDLE
  • CREATING
  • UPDATING
  • DELETING
  • DELETED
  • REPAIRING

Look up an Existing AdvancedCluster Resource

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

public static get(name: string, id: Input<ID>, state?: AdvancedClusterState, opts?: CustomResourceOptions): AdvancedCluster
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        advanced_configuration: Optional[AdvancedClusterAdvancedConfigurationArgs] = None,
        backup_enabled: Optional[bool] = None,
        bi_connector: Optional[AdvancedClusterBiConnectorArgs] = None,
        cluster_id: Optional[str] = None,
        cluster_type: Optional[str] = None,
        connection_strings: Optional[Sequence[AdvancedClusterConnectionStringArgs]] = None,
        create_date: Optional[str] = None,
        disk_size_gb: Optional[float] = None,
        encryption_at_rest_provider: Optional[str] = None,
        labels: Optional[Sequence[AdvancedClusterLabelArgs]] = None,
        mongo_db_major_version: Optional[str] = None,
        mongo_db_version: Optional[str] = None,
        name: Optional[str] = None,
        paused: Optional[bool] = None,
        pit_enabled: Optional[bool] = None,
        project_id: Optional[str] = None,
        replication_specs: Optional[Sequence[AdvancedClusterReplicationSpecArgs]] = None,
        root_cert_type: Optional[str] = None,
        state_name: Optional[str] = None,
        version_release_system: Optional[str] = None) -> AdvancedCluster
func GetAdvancedCluster(ctx *Context, name string, id IDInput, state *AdvancedClusterState, opts ...ResourceOption) (*AdvancedCluster, error)
public static AdvancedCluster Get(string name, Input<string> id, AdvancedClusterState? state, CustomResourceOptions? opts = null)
public static AdvancedCluster get(String name, Output<String> id, AdvancedClusterState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AdvancedConfiguration AdvancedClusterAdvancedConfigurationArgs
BackupEnabled bool

Flag that indicates whether the cluster can perform backups. If true, the cluster can perform backups. You must set this value to true for NVMe clusters.

BiConnector AdvancedClusterBiConnectorArgs

Configuration settings applied to BI Connector for Atlas on this cluster. The MongoDB Connector for Business Intelligence for Atlas (BI Connector) is only available for M10 and larger clusters. The BI Connector is a powerful tool which provides users SQL-based access to their MongoDB databases. As a result, the BI Connector performs operations which may be CPU and memory intensive. Given the limited hardware resources on M10 and M20 cluster tiers, you may experience performance degradation of the cluster when enabling the BI Connector. If this occurs, upgrade to an M30 or larger cluster or disable the BI Connector. See below.

ClusterId string

The cluster ID.

ClusterType string

Type of the cluster that you want to create. Accepted values include:

ConnectionStrings List<AdvancedClusterConnectionStringArgs>

Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.

CreateDate string
DiskSizeGb double

Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive number. You can't set this value with clusters with local NVMe SSDs. The minimum disk size for dedicated clusters is 10 GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value. If your cluster includes Azure nodes, this value must correspond to an existing Azure disk type (8, 16, 32, 64, 128, 256, 512, 1024, 2048, or 4095)Atlas calculates storage charges differently depending 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 additional storage space beyond this limitation, consider upgrading your cluster to a higher tier. If your cluster spans cloud service providers, this value defaults to the minimum default of the providers involved.

EncryptionAtRestProvider string

Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For Documentation, see AWS, GCP and Azure. Requirements are if replication_specs.#.region_configs.#.<type>Specs.instance_size is M10 or greater and backup_enabled is false or omitted.

Labels List<AdvancedClusterLabelArgs>

Configuration for the collection of key-value pairs that tag and categorize the cluster. See below.

MongoDbMajorVersion string

Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters: 4.0, 4.2, 4.4, or 5.0. If omitted, Atlas deploys a cluster that runs MongoDB 4.4. If replication_specs#.region_configs#.<type>Specs.instance_size: M0, M2 or M5, Atlas deploys MongoDB 4.4. Atlas always deploys the cluster with the latest stable release of the specified version. If you set a value to this parameter and set version_release_system CONTINUOUS, the resource returns an error. Either clear this parameter or set version_release_system: LTS.

MongoDbVersion string

Version of MongoDB the cluster runs, in major-version.minor-version format.

Name string

Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed.

Paused bool
PitEnabled bool
  • Flag that indicates if the cluster uses Continuous Cloud Backup.
ProjectId string

Unique ID for the project to create the database user.

ReplicationSpecs List<AdvancedClusterReplicationSpecArgs>

Configuration for cluster regions and the hardware provisioned in them. See below

RootCertType string
  • Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).
StateName string

Current state of the cluster. The possible states are:

  • IDLE
  • CREATING
  • UPDATING
  • DELETING
  • DELETED
  • REPAIRING
VersionReleaseSystem string
  • Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:
  • CONTINUOUS: Atlas creates your cluster using the most recent MongoDB release. Atlas automatically updates your cluster to the latest major and rapid MongoDB releases as they become available.
  • LTS: Atlas creates your cluster using the latest patch release of the MongoDB version that you specify in the mongoDBMajorVersion field. Atlas automatically updates your cluster to subsequent patch releases of this MongoDB version. Atlas doesn't update your cluster to newer rapid or major MongoDB releases as they become available.
AdvancedConfiguration AdvancedClusterAdvancedConfigurationArgs
BackupEnabled bool

Flag that indicates whether the cluster can perform backups. If true, the cluster can perform backups. You must set this value to true for NVMe clusters.

BiConnector AdvancedClusterBiConnectorArgs

Configuration settings applied to BI Connector for Atlas on this cluster. The MongoDB Connector for Business Intelligence for Atlas (BI Connector) is only available for M10 and larger clusters. The BI Connector is a powerful tool which provides users SQL-based access to their MongoDB databases. As a result, the BI Connector performs operations which may be CPU and memory intensive. Given the limited hardware resources on M10 and M20 cluster tiers, you may experience performance degradation of the cluster when enabling the BI Connector. If this occurs, upgrade to an M30 or larger cluster or disable the BI Connector. See below.

ClusterId string

The cluster ID.

ClusterType string

Type of the cluster that you want to create. Accepted values include:

ConnectionStrings []AdvancedClusterConnectionStringArgs

Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.

CreateDate string
DiskSizeGb float64

Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive number. You can't set this value with clusters with local NVMe SSDs. The minimum disk size for dedicated clusters is 10 GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value. If your cluster includes Azure nodes, this value must correspond to an existing Azure disk type (8, 16, 32, 64, 128, 256, 512, 1024, 2048, or 4095)Atlas calculates storage charges differently depending 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 additional storage space beyond this limitation, consider upgrading your cluster to a higher tier. If your cluster spans cloud service providers, this value defaults to the minimum default of the providers involved.

EncryptionAtRestProvider string

Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For Documentation, see AWS, GCP and Azure. Requirements are if replication_specs.#.region_configs.#.<type>Specs.instance_size is M10 or greater and backup_enabled is false or omitted.

Labels []AdvancedClusterLabelArgs

Configuration for the collection of key-value pairs that tag and categorize the cluster. See below.

MongoDbMajorVersion string

Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters: 4.0, 4.2, 4.4, or 5.0. If omitted, Atlas deploys a cluster that runs MongoDB 4.4. If replication_specs#.region_configs#.<type>Specs.instance_size: M0, M2 or M5, Atlas deploys MongoDB 4.4. Atlas always deploys the cluster with the latest stable release of the specified version. If you set a value to this parameter and set version_release_system CONTINUOUS, the resource returns an error. Either clear this parameter or set version_release_system: LTS.

MongoDbVersion string

Version of MongoDB the cluster runs, in major-version.minor-version format.

Name string

Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed.

Paused bool
PitEnabled bool
  • Flag that indicates if the cluster uses Continuous Cloud Backup.
ProjectId string

Unique ID for the project to create the database user.

ReplicationSpecs []AdvancedClusterReplicationSpecArgs

Configuration for cluster regions and the hardware provisioned in them. See below

RootCertType string
  • Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).
StateName string

Current state of the cluster. The possible states are:

  • IDLE
  • CREATING
  • UPDATING
  • DELETING
  • DELETED
  • REPAIRING
VersionReleaseSystem string
  • Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:
  • CONTINUOUS: Atlas creates your cluster using the most recent MongoDB release. Atlas automatically updates your cluster to the latest major and rapid MongoDB releases as they become available.
  • LTS: Atlas creates your cluster using the latest patch release of the MongoDB version that you specify in the mongoDBMajorVersion field. Atlas automatically updates your cluster to subsequent patch releases of this MongoDB version. Atlas doesn't update your cluster to newer rapid or major MongoDB releases as they become available.
advancedConfiguration AdvancedClusterAdvancedConfigurationArgs
backupEnabled Boolean

Flag that indicates whether the cluster can perform backups. If true, the cluster can perform backups. You must set this value to true for NVMe clusters.

biConnector AdvancedClusterBiConnectorArgs

Configuration settings applied to BI Connector for Atlas on this cluster. The MongoDB Connector for Business Intelligence for Atlas (BI Connector) is only available for M10 and larger clusters. The BI Connector is a powerful tool which provides users SQL-based access to their MongoDB databases. As a result, the BI Connector performs operations which may be CPU and memory intensive. Given the limited hardware resources on M10 and M20 cluster tiers, you may experience performance degradation of the cluster when enabling the BI Connector. If this occurs, upgrade to an M30 or larger cluster or disable the BI Connector. See below.

clusterId String

The cluster ID.

clusterType String

Type of the cluster that you want to create. Accepted values include:

connectionStrings List<AdvancedClusterConnectionStringArgs>

Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.

createDate String
diskSizeGb Double

Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive number. You can't set this value with clusters with local NVMe SSDs. The minimum disk size for dedicated clusters is 10 GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value. If your cluster includes Azure nodes, this value must correspond to an existing Azure disk type (8, 16, 32, 64, 128, 256, 512, 1024, 2048, or 4095)Atlas calculates storage charges differently depending 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 additional storage space beyond this limitation, consider upgrading your cluster to a higher tier. If your cluster spans cloud service providers, this value defaults to the minimum default of the providers involved.

encryptionAtRestProvider String

Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For Documentation, see AWS, GCP and Azure. Requirements are if replication_specs.#.region_configs.#.<type>Specs.instance_size is M10 or greater and backup_enabled is false or omitted.

labels List<AdvancedClusterLabelArgs>

Configuration for the collection of key-value pairs that tag and categorize the cluster. See below.

mongoDbMajorVersion String

Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters: 4.0, 4.2, 4.4, or 5.0. If omitted, Atlas deploys a cluster that runs MongoDB 4.4. If replication_specs#.region_configs#.<type>Specs.instance_size: M0, M2 or M5, Atlas deploys MongoDB 4.4. Atlas always deploys the cluster with the latest stable release of the specified version. If you set a value to this parameter and set version_release_system CONTINUOUS, the resource returns an error. Either clear this parameter or set version_release_system: LTS.

mongoDbVersion String

Version of MongoDB the cluster runs, in major-version.minor-version format.

name String

Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed.

paused Boolean
pitEnabled Boolean
  • Flag that indicates if the cluster uses Continuous Cloud Backup.
projectId String

Unique ID for the project to create the database user.

replicationSpecs List<AdvancedClusterReplicationSpecArgs>

Configuration for cluster regions and the hardware provisioned in them. See below

rootCertType String
  • Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).
stateName String

Current state of the cluster. The possible states are:

  • IDLE
  • CREATING
  • UPDATING
  • DELETING
  • DELETED
  • REPAIRING
versionReleaseSystem String
  • Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:
  • CONTINUOUS: Atlas creates your cluster using the most recent MongoDB release. Atlas automatically updates your cluster to the latest major and rapid MongoDB releases as they become available.
  • LTS: Atlas creates your cluster using the latest patch release of the MongoDB version that you specify in the mongoDBMajorVersion field. Atlas automatically updates your cluster to subsequent patch releases of this MongoDB version. Atlas doesn't update your cluster to newer rapid or major MongoDB releases as they become available.
advancedConfiguration AdvancedClusterAdvancedConfigurationArgs
backupEnabled boolean

Flag that indicates whether the cluster can perform backups. If true, the cluster can perform backups. You must set this value to true for NVMe clusters.

biConnector AdvancedClusterBiConnectorArgs

Configuration settings applied to BI Connector for Atlas on this cluster. The MongoDB Connector for Business Intelligence for Atlas (BI Connector) is only available for M10 and larger clusters. The BI Connector is a powerful tool which provides users SQL-based access to their MongoDB databases. As a result, the BI Connector performs operations which may be CPU and memory intensive. Given the limited hardware resources on M10 and M20 cluster tiers, you may experience performance degradation of the cluster when enabling the BI Connector. If this occurs, upgrade to an M30 or larger cluster or disable the BI Connector. See below.

clusterId string

The cluster ID.

clusterType string

Type of the cluster that you want to create. Accepted values include:

connectionStrings AdvancedClusterConnectionStringArgs[]

Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.

createDate string
diskSizeGb number

Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive number. You can't set this value with clusters with local NVMe SSDs. The minimum disk size for dedicated clusters is 10 GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value. If your cluster includes Azure nodes, this value must correspond to an existing Azure disk type (8, 16, 32, 64, 128, 256, 512, 1024, 2048, or 4095)Atlas calculates storage charges differently depending 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 additional storage space beyond this limitation, consider upgrading your cluster to a higher tier. If your cluster spans cloud service providers, this value defaults to the minimum default of the providers involved.

encryptionAtRestProvider string

Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For Documentation, see AWS, GCP and Azure. Requirements are if replication_specs.#.region_configs.#.<type>Specs.instance_size is M10 or greater and backup_enabled is false or omitted.

labels AdvancedClusterLabelArgs[]

Configuration for the collection of key-value pairs that tag and categorize the cluster. See below.

mongoDbMajorVersion string

Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters: 4.0, 4.2, 4.4, or 5.0. If omitted, Atlas deploys a cluster that runs MongoDB 4.4. If replication_specs#.region_configs#.<type>Specs.instance_size: M0, M2 or M5, Atlas deploys MongoDB 4.4. Atlas always deploys the cluster with the latest stable release of the specified version. If you set a value to this parameter and set version_release_system CONTINUOUS, the resource returns an error. Either clear this parameter or set version_release_system: LTS.

mongoDbVersion string

Version of MongoDB the cluster runs, in major-version.minor-version format.

name string

Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed.

paused boolean
pitEnabled boolean
  • Flag that indicates if the cluster uses Continuous Cloud Backup.
projectId string

Unique ID for the project to create the database user.

replicationSpecs AdvancedClusterReplicationSpecArgs[]

Configuration for cluster regions and the hardware provisioned in them. See below

rootCertType string
  • Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).
stateName string

Current state of the cluster. The possible states are:

  • IDLE
  • CREATING
  • UPDATING
  • DELETING
  • DELETED
  • REPAIRING
versionReleaseSystem string
  • Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:
  • CONTINUOUS: Atlas creates your cluster using the most recent MongoDB release. Atlas automatically updates your cluster to the latest major and rapid MongoDB releases as they become available.
  • LTS: Atlas creates your cluster using the latest patch release of the MongoDB version that you specify in the mongoDBMajorVersion field. Atlas automatically updates your cluster to subsequent patch releases of this MongoDB version. Atlas doesn't update your cluster to newer rapid or major MongoDB releases as they become available.
advanced_configuration AdvancedClusterAdvancedConfigurationArgs
backup_enabled bool

Flag that indicates whether the cluster can perform backups. If true, the cluster can perform backups. You must set this value to true for NVMe clusters.

bi_connector AdvancedClusterBiConnectorArgs

Configuration settings applied to BI Connector for Atlas on this cluster. The MongoDB Connector for Business Intelligence for Atlas (BI Connector) is only available for M10 and larger clusters. The BI Connector is a powerful tool which provides users SQL-based access to their MongoDB databases. As a result, the BI Connector performs operations which may be CPU and memory intensive. Given the limited hardware resources on M10 and M20 cluster tiers, you may experience performance degradation of the cluster when enabling the BI Connector. If this occurs, upgrade to an M30 or larger cluster or disable the BI Connector. See below.

cluster_id str

The cluster ID.

cluster_type str

Type of the cluster that you want to create. Accepted values include:

connection_strings Sequence[AdvancedClusterConnectionStringArgs]

Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.

create_date str
disk_size_gb float

Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive number. You can't set this value with clusters with local NVMe SSDs. The minimum disk size for dedicated clusters is 10 GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value. If your cluster includes Azure nodes, this value must correspond to an existing Azure disk type (8, 16, 32, 64, 128, 256, 512, 1024, 2048, or 4095)Atlas calculates storage charges differently depending 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 additional storage space beyond this limitation, consider upgrading your cluster to a higher tier. If your cluster spans cloud service providers, this value defaults to the minimum default of the providers involved.

encryption_at_rest_provider str

Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For Documentation, see AWS, GCP and Azure. Requirements are if replication_specs.#.region_configs.#.<type>Specs.instance_size is M10 or greater and backup_enabled is false or omitted.

labels Sequence[AdvancedClusterLabelArgs]

Configuration for the collection of key-value pairs that tag and categorize the cluster. See below.

mongo_db_major_version str

Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters: 4.0, 4.2, 4.4, or 5.0. If omitted, Atlas deploys a cluster that runs MongoDB 4.4. If replication_specs#.region_configs#.<type>Specs.instance_size: M0, M2 or M5, Atlas deploys MongoDB 4.4. Atlas always deploys the cluster with the latest stable release of the specified version. If you set a value to this parameter and set version_release_system CONTINUOUS, the resource returns an error. Either clear this parameter or set version_release_system: LTS.

mongo_db_version str

Version of MongoDB the cluster runs, in major-version.minor-version format.

name str

Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed.

paused bool
pit_enabled bool
  • Flag that indicates if the cluster uses Continuous Cloud Backup.
project_id str

Unique ID for the project to create the database user.

replication_specs Sequence[AdvancedClusterReplicationSpecArgs]

Configuration for cluster regions and the hardware provisioned in them. See below

root_cert_type str
  • Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).
state_name str

Current state of the cluster. The possible states are:

  • IDLE
  • CREATING
  • UPDATING
  • DELETING
  • DELETED
  • REPAIRING
version_release_system str
  • Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:
  • CONTINUOUS: Atlas creates your cluster using the most recent MongoDB release. Atlas automatically updates your cluster to the latest major and rapid MongoDB releases as they become available.
  • LTS: Atlas creates your cluster using the latest patch release of the MongoDB version that you specify in the mongoDBMajorVersion field. Atlas automatically updates your cluster to subsequent patch releases of this MongoDB version. Atlas doesn't update your cluster to newer rapid or major MongoDB releases as they become available.
advancedConfiguration Property Map
backupEnabled Boolean

Flag that indicates whether the cluster can perform backups. If true, the cluster can perform backups. You must set this value to true for NVMe clusters.

biConnector Property Map

Configuration settings applied to BI Connector for Atlas on this cluster. The MongoDB Connector for Business Intelligence for Atlas (BI Connector) is only available for M10 and larger clusters. The BI Connector is a powerful tool which provides users SQL-based access to their MongoDB databases. As a result, the BI Connector performs operations which may be CPU and memory intensive. Given the limited hardware resources on M10 and M20 cluster tiers, you may experience performance degradation of the cluster when enabling the BI Connector. If this occurs, upgrade to an M30 or larger cluster or disable the BI Connector. See below.

clusterId String

The cluster ID.

clusterType String

Type of the cluster that you want to create. Accepted values include:

connectionStrings List<Property Map>

Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.

createDate String
diskSizeGb Number

Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive number. You can't set this value with clusters with local NVMe SSDs. The minimum disk size for dedicated clusters is 10 GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value. If your cluster includes Azure nodes, this value must correspond to an existing Azure disk type (8, 16, 32, 64, 128, 256, 512, 1024, 2048, or 4095)Atlas calculates storage charges differently depending 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 additional storage space beyond this limitation, consider upgrading your cluster to a higher tier. If your cluster spans cloud service providers, this value defaults to the minimum default of the providers involved.

encryptionAtRestProvider String

Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For Documentation, see AWS, GCP and Azure. Requirements are if replication_specs.#.region_configs.#.<type>Specs.instance_size is M10 or greater and backup_enabled is false or omitted.

labels List<Property Map>

Configuration for the collection of key-value pairs that tag and categorize the cluster. See below.

mongoDbMajorVersion String

Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters: 4.0, 4.2, 4.4, or 5.0. If omitted, Atlas deploys a cluster that runs MongoDB 4.4. If replication_specs#.region_configs#.<type>Specs.instance_size: M0, M2 or M5, Atlas deploys MongoDB 4.4. Atlas always deploys the cluster with the latest stable release of the specified version. If you set a value to this parameter and set version_release_system CONTINUOUS, the resource returns an error. Either clear this parameter or set version_release_system: LTS.

mongoDbVersion String

Version of MongoDB the cluster runs, in major-version.minor-version format.

name String

Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed.

paused Boolean
pitEnabled Boolean
  • Flag that indicates if the cluster uses Continuous Cloud Backup.
projectId String

Unique ID for the project to create the database user.

replicationSpecs List<Property Map>

Configuration for cluster regions and the hardware provisioned in them. See below

rootCertType String
  • Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).
stateName String

Current state of the cluster. The possible states are:

  • IDLE
  • CREATING
  • UPDATING
  • DELETING
  • DELETED
  • REPAIRING
versionReleaseSystem String
  • Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:
  • CONTINUOUS: Atlas creates your cluster using the most recent MongoDB release. Atlas automatically updates your cluster to the latest major and rapid MongoDB releases as they become available.
  • LTS: Atlas creates your cluster using the latest patch release of the MongoDB version that you specify in the mongoDBMajorVersion field. Atlas automatically updates your cluster to subsequent patch releases of this MongoDB version. Atlas doesn't update your cluster to newer rapid or major MongoDB releases as they become available.

Supporting Types

AdvancedClusterAdvancedConfiguration

DefaultReadConcern string

Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available.

DefaultWriteConcern string

Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.

FailIndexKeyTooLong bool

When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.

JavascriptEnabled bool

When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.

MinimumEnabledTlsProtocol string

Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:

NoTableScan bool

When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.

OplogSizeMb int

The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.

SampleRefreshIntervalBiConnector int

Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

SampleSizeBiConnector int

Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

DefaultReadConcern string

Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available.

DefaultWriteConcern string

Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.

FailIndexKeyTooLong bool

When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.

JavascriptEnabled bool

When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.

MinimumEnabledTlsProtocol string

Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:

NoTableScan bool

When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.

OplogSizeMb int

The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.

SampleRefreshIntervalBiConnector int

Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

SampleSizeBiConnector int

Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

defaultReadConcern String

Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available.

defaultWriteConcern String

Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.

failIndexKeyTooLong Boolean

When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.

javascriptEnabled Boolean

When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.

minimumEnabledTlsProtocol String

Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:

noTableScan Boolean

When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.

oplogSizeMb Integer

The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.

sampleRefreshIntervalBiConnector Integer

Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

sampleSizeBiConnector Integer

Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

defaultReadConcern string

Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available.

defaultWriteConcern string

Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.

failIndexKeyTooLong boolean

When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.

javascriptEnabled boolean

When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.

minimumEnabledTlsProtocol string

Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:

noTableScan boolean

When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.

oplogSizeMb number

The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.

sampleRefreshIntervalBiConnector number

Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

sampleSizeBiConnector number

Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

default_read_concern str

Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available.

default_write_concern str

Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.

fail_index_key_too_long bool

When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.

javascript_enabled bool

When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.

minimum_enabled_tls_protocol str

Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:

no_table_scan bool

When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.

oplog_size_mb int

The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.

sample_refresh_interval_bi_connector int

Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

sample_size_bi_connector int

Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

defaultReadConcern String

Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available.

defaultWriteConcern String

Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.

failIndexKeyTooLong Boolean

When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.

javascriptEnabled Boolean

When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.

minimumEnabledTlsProtocol String

Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:

noTableScan Boolean

When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.

oplogSizeMb Number

The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.

sampleRefreshIntervalBiConnector Number

Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

sampleSizeBiConnector Number

Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

AdvancedClusterBiConnector

Enabled bool

Specifies whether or not BI Connector for Atlas is enabled on the cluster.l *

  • Set to true to enable BI Connector for Atlas.
  • Set to false to disable BI Connector for Atlas.
ReadPreference string

Specifies the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. For details on BI Connector for Atlas read preferences, refer to the BI Connector Read Preferences Table.

Enabled bool

Specifies whether or not BI Connector for Atlas is enabled on the cluster.l *

  • Set to true to enable BI Connector for Atlas.
  • Set to false to disable BI Connector for Atlas.
ReadPreference string

Specifies the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. For details on BI Connector for Atlas read preferences, refer to the BI Connector Read Preferences Table.

enabled Boolean

Specifies whether or not BI Connector for Atlas is enabled on the cluster.l *

  • Set to true to enable BI Connector for Atlas.
  • Set to false to disable BI Connector for Atlas.
readPreference String

Specifies the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. For details on BI Connector for Atlas read preferences, refer to the BI Connector Read Preferences Table.

enabled boolean

Specifies whether or not BI Connector for Atlas is enabled on the cluster.l *

  • Set to true to enable BI Connector for Atlas.
  • Set to false to disable BI Connector for Atlas.
readPreference string

Specifies the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. For details on BI Connector for Atlas read preferences, refer to the BI Connector Read Preferences Table.

enabled bool

Specifies whether or not BI Connector for Atlas is enabled on the cluster.l *

  • Set to true to enable BI Connector for Atlas.
  • Set to false to disable BI Connector for Atlas.
read_preference str

Specifies the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. For details on BI Connector for Atlas read preferences, refer to the BI Connector Read Preferences Table.

enabled Boolean

Specifies whether or not BI Connector for Atlas is enabled on the cluster.l *

  • Set to true to enable BI Connector for Atlas.
  • Set to false to disable BI Connector for Atlas.
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.

AdvancedClusterConnectionString

AwsPrivateLink Dictionary<string, object>

Deprecated:

This field is deprecated. Use connection_strings.private_endpoint[n].connection_string instead

AwsPrivateLinkSrv Dictionary<string, object>

Deprecated:

This field is deprecated. Use connection_strings.private_endpoint[n].srv_connection_string instead

Private string
PrivateEndpoints List<AdvancedClusterConnectionStringPrivateEndpoint>
PrivateSrv string
Standard string
StandardSrv string
AwsPrivateLink map[string]interface{}

Deprecated:

This field is deprecated. Use connection_strings.private_endpoint[n].connection_string instead

AwsPrivateLinkSrv map[string]interface{}

Deprecated:

This field is deprecated. Use connection_strings.private_endpoint[n].srv_connection_string instead

Private string
PrivateEndpoints []AdvancedClusterConnectionStringPrivateEndpoint
PrivateSrv string
Standard string
StandardSrv string
awsPrivateLink Map<String,Object>

Deprecated:

This field is deprecated. Use connection_strings.private_endpoint[n].connection_string instead

awsPrivateLinkSrv Map<String,Object>

Deprecated:

This field is deprecated. Use connection_strings.private_endpoint[n].srv_connection_string instead

privateEndpoints List<AdvancedClusterConnectionStringPrivateEndpoint>
privateSrv String
private_ String
standard String
standardSrv String
awsPrivateLink {[key: string]: any}

Deprecated:

This field is deprecated. Use connection_strings.private_endpoint[n].connection_string instead

awsPrivateLinkSrv {[key: string]: any}

Deprecated:

This field is deprecated. Use connection_strings.private_endpoint[n].srv_connection_string instead

private string
privateEndpoints AdvancedClusterConnectionStringPrivateEndpoint[]
privateSrv string
standard string
standardSrv string
aws_private_link Mapping[str, Any]

Deprecated:

This field is deprecated. Use connection_strings.private_endpoint[n].connection_string instead

aws_private_link_srv Mapping[str, Any]

Deprecated:

This field is deprecated. Use connection_strings.private_endpoint[n].srv_connection_string instead

private str
private_endpoints Sequence[AdvancedClusterConnectionStringPrivateEndpoint]
private_srv str
standard str
standard_srv str
awsPrivateLink Map<Any>

Deprecated:

This field is deprecated. Use connection_strings.private_endpoint[n].connection_string instead

awsPrivateLinkSrv Map<Any>

Deprecated:

This field is deprecated. Use connection_strings.private_endpoint[n].srv_connection_string instead

private String
privateEndpoints List<Property Map>
privateSrv String
standard String
standardSrv String

AdvancedClusterConnectionStringPrivateEndpoint

AdvancedClusterConnectionStringPrivateEndpointEndpoint

EndpointId string
ProviderName string

Cloud service provider on which the servers are provisioned. The possible values are:

Region string
EndpointId string
ProviderName string

Cloud service provider on which the servers are provisioned. The possible values are:

Region string
endpointId String
providerName String

Cloud service provider on which the servers are provisioned. The possible values are:

region String
endpointId string
providerName string

Cloud service provider on which the servers are provisioned. The possible values are:

region string
endpoint_id str
provider_name str

Cloud service provider on which the servers are provisioned. The possible values are:

region str
endpointId String
providerName String

Cloud service provider on which the servers are provisioned. The possible values are:

region String

AdvancedClusterLabel

Key string

The key that you want to write.

Value string

The value that you want to write.

Key string

The key that you want to write.

Value string

The value that you want to write.

key String

The key that you want to write.

value String

The value that you want to write.

key string

The key that you want to write.

value string

The value that you want to write.

key str

The key that you want to write.

value str

The value that you want to write.

key String

The key that you want to write.

value String

The value that you want to write.

AdvancedClusterReplicationSpec

RegionConfigs List<AdvancedClusterReplicationSpecRegionConfig>

Configuration for the hardware specifications for nodes set for a given regionEach region_configs object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Each region_configs object must have either an analytics_specs object, electable_specs object, or read_only_specs object. See below

ContainerId Dictionary<string, string>

A key-value map of the Network Peering Container ID(s) for the configuration specified in region_configs. The Container ID is the id of the container either created programmatically by the user before any clusters existed in a project or when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is "providerName:regionName" = "containerId". Example AWS:US_EAST_1" = "61e0797dde08fb498ca11a71.

Id string
NumShards int

Provide this value if you set a cluster_type of SHARDED or GEOSHARDED. Omit this value if you selected a cluster_type of REPLICASET. This API resource accepts 1 through 50, inclusive. This parameter defaults to 1. If you specify a num_shards value of 1 and a cluster_type of SHARDED, Atlas deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.

ZoneName string

Name for the zone in a Global Cluster.

RegionConfigs []AdvancedClusterReplicationSpecRegionConfig

Configuration for the hardware specifications for nodes set for a given regionEach region_configs object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Each region_configs object must have either an analytics_specs object, electable_specs object, or read_only_specs object. See below

ContainerId map[string]string

A key-value map of the Network Peering Container ID(s) for the configuration specified in region_configs. The Container ID is the id of the container either created programmatically by the user before any clusters existed in a project or when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is "providerName:regionName" = "containerId". Example AWS:US_EAST_1" = "61e0797dde08fb498ca11a71.

Id string
NumShards int

Provide this value if you set a cluster_type of SHARDED or GEOSHARDED. Omit this value if you selected a cluster_type of REPLICASET. This API resource accepts 1 through 50, inclusive. This parameter defaults to 1. If you specify a num_shards value of 1 and a cluster_type of SHARDED, Atlas deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.

ZoneName string

Name for the zone in a Global Cluster.

regionConfigs List<AdvancedClusterReplicationSpecRegionConfig>

Configuration for the hardware specifications for nodes set for a given regionEach region_configs object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Each region_configs object must have either an analytics_specs object, electable_specs object, or read_only_specs object. See below

containerId Map<String,String>

A key-value map of the Network Peering Container ID(s) for the configuration specified in region_configs. The Container ID is the id of the container either created programmatically by the user before any clusters existed in a project or when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is "providerName:regionName" = "containerId". Example AWS:US_EAST_1" = "61e0797dde08fb498ca11a71.

id String
numShards Integer

Provide this value if you set a cluster_type of SHARDED or GEOSHARDED. Omit this value if you selected a cluster_type of REPLICASET. This API resource accepts 1 through 50, inclusive. This parameter defaults to 1. If you specify a num_shards value of 1 and a cluster_type of SHARDED, Atlas deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.

zoneName String

Name for the zone in a Global Cluster.

regionConfigs AdvancedClusterReplicationSpecRegionConfig[]

Configuration for the hardware specifications for nodes set for a given regionEach region_configs object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Each region_configs object must have either an analytics_specs object, electable_specs object, or read_only_specs object. See below

containerId {[key: string]: string}

A key-value map of the Network Peering Container ID(s) for the configuration specified in region_configs. The Container ID is the id of the container either created programmatically by the user before any clusters existed in a project or when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is "providerName:regionName" = "containerId". Example AWS:US_EAST_1" = "61e0797dde08fb498ca11a71.

id string
numShards number

Provide this value if you set a cluster_type of SHARDED or GEOSHARDED. Omit this value if you selected a cluster_type of REPLICASET. This API resource accepts 1 through 50, inclusive. This parameter defaults to 1. If you specify a num_shards value of 1 and a cluster_type of SHARDED, Atlas deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.

zoneName string

Name for the zone in a Global Cluster.

region_configs Sequence[AdvancedClusterReplicationSpecRegionConfig]

Configuration for the hardware specifications for nodes set for a given regionEach region_configs object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Each region_configs object must have either an analytics_specs object, electable_specs object, or read_only_specs object. See below

container_id Mapping[str, str]

A key-value map of the Network Peering Container ID(s) for the configuration specified in region_configs. The Container ID is the id of the container either created programmatically by the user before any clusters existed in a project or when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is "providerName:regionName" = "containerId". Example AWS:US_EAST_1" = "61e0797dde08fb498ca11a71.

id str
num_shards int

Provide this value if you set a cluster_type of SHARDED or GEOSHARDED. Omit this value if you selected a cluster_type of REPLICASET. This API resource accepts 1 through 50, inclusive. This parameter defaults to 1. If you specify a num_shards value of 1 and a cluster_type of SHARDED, Atlas deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.

zone_name str

Name for the zone in a Global Cluster.

regionConfigs List<Property Map>

Configuration for the hardware specifications for nodes set for a given regionEach region_configs object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Each region_configs object must have either an analytics_specs object, electable_specs object, or read_only_specs object. See below

containerId Map<String>

A key-value map of the Network Peering Container ID(s) for the configuration specified in region_configs. The Container ID is the id of the container either created programmatically by the user before any clusters existed in a project or when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is "providerName:regionName" = "containerId". Example AWS:US_EAST_1" = "61e0797dde08fb498ca11a71.

id String
numShards Number

Provide this value if you set a cluster_type of SHARDED or GEOSHARDED. Omit this value if you selected a cluster_type of REPLICASET. This API resource accepts 1 through 50, inclusive. This parameter defaults to 1. If you specify a num_shards value of 1 and a cluster_type of SHARDED, Atlas deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.

zoneName String

Name for the zone in a Global Cluster.

AdvancedClusterReplicationSpecRegionConfig

Priority int

Election priority of the region. For regions with only read-only nodes, set this value to 0.

  • If you have multiple region_configs objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is 7.
  • If your region has set region_configs.#.electable_specs.0.node_count to 1 or higher, it must have a priority of exactly one (1) less than another region in the replication_specs.#.region_configs.# array. The highest-priority region must have a priority of 7. The lowest possible priority is 1.
ProviderName string

Cloud service provider on which the servers are provisioned. The possible values are:

RegionName string

Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas region name, see the reference list for AWS, GCP, Azure.

AnalyticsSpecs AdvancedClusterReplicationSpecRegionConfigAnalyticsSpecs

Hardware specifications for analytics nodes needed in the region. Analytics nodes handle analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only and can never become the primary. If you don't specify this parameter, no analytics nodes deploy to this region. See below

AutoScaling AdvancedClusterReplicationSpecRegionConfigAutoScaling

Configuration for the Collection of settings that configures auto-scaling information for the cluster. The values for the auto_scaling parameter must be the same for every item in the replication_specs array. See below

BackingProviderName string

Cloud service provider on which you provision the host for a multi-tenant cluster. Use this only when a provider_name is TENANT and instance_size of a specs is M2 or M5.

ElectableSpecs AdvancedClusterReplicationSpecRegionConfigElectableSpecs

Hardware specifications for electable nodes in the region. Electable nodes can become the primary and can enable local reads. If you do not specify this option, no electable nodes are deployed to the region. See below

ReadOnlySpecs AdvancedClusterReplicationSpecRegionConfigReadOnlySpecs

Hardware specifications for read-only nodes in the region. Read-only nodes can become the primary and can enable local reads. If you don't specify this parameter, no read-only nodes are deployed to the region. See below

Priority int

Election priority of the region. For regions with only read-only nodes, set this value to 0.

  • If you have multiple region_configs objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is 7.
  • If your region has set region_configs.#.electable_specs.0.node_count to 1 or higher, it must have a priority of exactly one (1) less than another region in the replication_specs.#.region_configs.# array. The highest-priority region must have a priority of 7. The lowest possible priority is 1.
ProviderName string

Cloud service provider on which the servers are provisioned. The possible values are:

RegionName string

Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas region name, see the reference list for AWS, GCP, Azure.

AnalyticsSpecs AdvancedClusterReplicationSpecRegionConfigAnalyticsSpecs

Hardware specifications for analytics nodes needed in the region. Analytics nodes handle analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only and can never become the primary. If you don't specify this parameter, no analytics nodes deploy to this region. See below

AutoScaling AdvancedClusterReplicationSpecRegionConfigAutoScaling

Configuration for the Collection of settings that configures auto-scaling information for the cluster. The values for the auto_scaling parameter must be the same for every item in the replication_specs array. See below

BackingProviderName string

Cloud service provider on which you provision the host for a multi-tenant cluster. Use this only when a provider_name is TENANT and instance_size of a specs is M2 or M5.

ElectableSpecs AdvancedClusterReplicationSpecRegionConfigElectableSpecs

Hardware specifications for electable nodes in the region. Electable nodes can become the primary and can enable local reads. If you do not specify this option, no electable nodes are deployed to the region. See below

ReadOnlySpecs AdvancedClusterReplicationSpecRegionConfigReadOnlySpecs

Hardware specifications for read-only nodes in the region. Read-only nodes can become the primary and can enable local reads. If you don't specify this parameter, no read-only nodes are deployed to the region. See below

priority Integer

Election priority of the region. For regions with only read-only nodes, set this value to 0.

  • If you have multiple region_configs objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is 7.
  • If your region has set region_configs.#.electable_specs.0.node_count to 1 or higher, it must have a priority of exactly one (1) less than another region in the replication_specs.#.region_configs.# array. The highest-priority region must have a priority of 7. The lowest possible priority is 1.
providerName String

Cloud service provider on which the servers are provisioned. The possible values are:

regionName String

Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas region name, see the reference list for AWS, GCP, Azure.

analyticsSpecs AdvancedClusterReplicationSpecRegionConfigAnalyticsSpecs

Hardware specifications for analytics nodes needed in the region. Analytics nodes handle analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only and can never become the primary. If you don't specify this parameter, no analytics nodes deploy to this region. See below

autoScaling AdvancedClusterReplicationSpecRegionConfigAutoScaling

Configuration for the Collection of settings that configures auto-scaling information for the cluster. The values for the auto_scaling parameter must be the same for every item in the replication_specs array. See below

backingProviderName String

Cloud service provider on which you provision the host for a multi-tenant cluster. Use this only when a provider_name is TENANT and instance_size of a specs is M2 or M5.

electableSpecs AdvancedClusterReplicationSpecRegionConfigElectableSpecs

Hardware specifications for electable nodes in the region. Electable nodes can become the primary and can enable local reads. If you do not specify this option, no electable nodes are deployed to the region. See below

readOnlySpecs AdvancedClusterReplicationSpecRegionConfigReadOnlySpecs

Hardware specifications for read-only nodes in the region. Read-only nodes can become the primary and can enable local reads. If you don't specify this parameter, no read-only nodes are deployed to the region. See below

priority number

Election priority of the region. For regions with only read-only nodes, set this value to 0.

  • If you have multiple region_configs objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is 7.
  • If your region has set region_configs.#.electable_specs.0.node_count to 1 or higher, it must have a priority of exactly one (1) less than another region in the replication_specs.#.region_configs.# array. The highest-priority region must have a priority of 7. The lowest possible priority is 1.
providerName string

Cloud service provider on which the servers are provisioned. The possible values are:

regionName string

Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas region name, see the reference list for AWS, GCP, Azure.

analyticsSpecs AdvancedClusterReplicationSpecRegionConfigAnalyticsSpecs

Hardware specifications for analytics nodes needed in the region. Analytics nodes handle analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only and can never become the primary. If you don't specify this parameter, no analytics nodes deploy to this region. See below

autoScaling AdvancedClusterReplicationSpecRegionConfigAutoScaling

Configuration for the Collection of settings that configures auto-scaling information for the cluster. The values for the auto_scaling parameter must be the same for every item in the replication_specs array. See below

backingProviderName string

Cloud service provider on which you provision the host for a multi-tenant cluster. Use this only when a provider_name is TENANT and instance_size of a specs is M2 or M5.

electableSpecs AdvancedClusterReplicationSpecRegionConfigElectableSpecs

Hardware specifications for electable nodes in the region. Electable nodes can become the primary and can enable local reads. If you do not specify this option, no electable nodes are deployed to the region. See below

readOnlySpecs AdvancedClusterReplicationSpecRegionConfigReadOnlySpecs

Hardware specifications for read-only nodes in the region. Read-only nodes can become the primary and can enable local reads. If you don't specify this parameter, no read-only nodes are deployed to the region. See below

priority int

Election priority of the region. For regions with only read-only nodes, set this value to 0.

  • If you have multiple region_configs objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is 7.
  • If your region has set region_configs.#.electable_specs.0.node_count to 1 or higher, it must have a priority of exactly one (1) less than another region in the replication_specs.#.region_configs.# array. The highest-priority region must have a priority of 7. The lowest possible priority is 1.
provider_name str

Cloud service provider on which the servers are provisioned. The possible values are:

region_name str

Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas region name, see the reference list for AWS, GCP, Azure.

analytics_specs AdvancedClusterReplicationSpecRegionConfigAnalyticsSpecs

Hardware specifications for analytics nodes needed in the region. Analytics nodes handle analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only and can never become the primary. If you don't specify this parameter, no analytics nodes deploy to this region. See below

auto_scaling AdvancedClusterReplicationSpecRegionConfigAutoScaling

Configuration for the Collection of settings that configures auto-scaling information for the cluster. The values for the auto_scaling parameter must be the same for every item in the replication_specs array. See below

backing_provider_name str

Cloud service provider on which you provision the host for a multi-tenant cluster. Use this only when a provider_name is TENANT and instance_size of a specs is M2 or M5.

electable_specs AdvancedClusterReplicationSpecRegionConfigElectableSpecs

Hardware specifications for electable nodes in the region. Electable nodes can become the primary and can enable local reads. If you do not specify this option, no electable nodes are deployed to the region. See below

read_only_specs AdvancedClusterReplicationSpecRegionConfigReadOnlySpecs

Hardware specifications for read-only nodes in the region. Read-only nodes can become the primary and can enable local reads. If you don't specify this parameter, no read-only nodes are deployed to the region. See below

priority Number

Election priority of the region. For regions with only read-only nodes, set this value to 0.

  • If you have multiple region_configs objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is 7.
  • If your region has set region_configs.#.electable_specs.0.node_count to 1 or higher, it must have a priority of exactly one (1) less than another region in the replication_specs.#.region_configs.# array. The highest-priority region must have a priority of 7. The lowest possible priority is 1.
providerName String

Cloud service provider on which the servers are provisioned. The possible values are:

regionName String

Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas region name, see the reference list for AWS, GCP, Azure.

analyticsSpecs Property Map

Hardware specifications for analytics nodes needed in the region. Analytics nodes handle analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only and can never become the primary. If you don't specify this parameter, no analytics nodes deploy to this region. See below

autoScaling Property Map

Configuration for the Collection of settings that configures auto-scaling information for the cluster. The values for the auto_scaling parameter must be the same for every item in the replication_specs array. See below

backingProviderName String

Cloud service provider on which you provision the host for a multi-tenant cluster. Use this only when a provider_name is TENANT and instance_size of a specs is M2 or M5.

electableSpecs Property Map

Hardware specifications for electable nodes in the region. Electable nodes can become the primary and can enable local reads. If you do not specify this option, no electable nodes are deployed to the region. See below

readOnlySpecs Property Map

Hardware specifications for read-only nodes in the region. Read-only nodes can become the primary and can enable local reads. If you don't specify this parameter, no read-only nodes are deployed to the region. See below

AdvancedClusterReplicationSpecRegionConfigAnalyticsSpecs

InstanceSize string

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.

DiskIops int

Target throughput (IOPS) desired for AWS storage attached to your cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

EbsVolumeType string

Type of storage you want to attach to your AWS-provisioned cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster. Valid values are:

NodeCount int

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can enable local reads.

InstanceSize string

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.

DiskIops int

Target throughput (IOPS) desired for AWS storage attached to your cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

EbsVolumeType string

Type of storage you want to attach to your AWS-provisioned cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster. Valid values are:

NodeCount int

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can enable local reads.

instanceSize String

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.

diskIops Integer

Target throughput (IOPS) desired for AWS storage attached to your cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

ebsVolumeType String

Type of storage you want to attach to your AWS-provisioned cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster. Valid values are:

nodeCount Integer

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can enable local reads.

instanceSize string

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.

diskIops number

Target throughput (IOPS) desired for AWS storage attached to your cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

ebsVolumeType string

Type of storage you want to attach to your AWS-provisioned cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster. Valid values are:

nodeCount number

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can enable local reads.

instance_size str

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.

disk_iops int

Target throughput (IOPS) desired for AWS storage attached to your cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

ebs_volume_type str

Type of storage you want to attach to your AWS-provisioned cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster. Valid values are:

node_count int

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can enable local reads.

instanceSize String

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.

diskIops Number

Target throughput (IOPS) desired for AWS storage attached to your cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

ebsVolumeType String

Type of storage you want to attach to your AWS-provisioned cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster. Valid values are:

nodeCount Number

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can enable local reads.

AdvancedClusterReplicationSpecRegionConfigAutoScaling

ComputeEnabled bool

Flag that indicates whether instance size auto-scaling is enabled. This parameter defaults to false.

ComputeMaxInstanceSize string

Maximum instance size to which your cluster can automatically scale (such as M40). Atlas requires this parameter if replication_specs.#.region_configs.#.auto_scaling.0.compute_enabled is true.

ComputeMinInstanceSize string

Minimum instance size to which your cluster can automatically scale (such as M10). Atlas requires this parameter if replication_specs.#.region_configs.#.auto_scaling.0.compute_scale_down_enabled is true.

ComputeScaleDownEnabled bool

Flag that indicates whether the instance size may scale down. Atlas requires this parameter if replication_specs.#.region_configs.#.auto_scaling.0.compute_enabled : true. If you enable this option, specify a value for replication_specs.#.region_configs.#.auto_scaling.0.compute_min_instance_size.

DiskGbEnabled bool

Flag that indicates whether this cluster enables disk auto-scaling. This parameter defaults to true.

ComputeEnabled bool

Flag that indicates whether instance size auto-scaling is enabled. This parameter defaults to false.

ComputeMaxInstanceSize string

Maximum instance size to which your cluster can automatically scale (such as M40). Atlas requires this parameter if replication_specs.#.region_configs.#.auto_scaling.0.compute_enabled is true.

ComputeMinInstanceSize string

Minimum instance size to which your cluster can automatically scale (such as M10). Atlas requires this parameter if replication_specs.#.region_configs.#.auto_scaling.0.compute_scale_down_enabled is true.

ComputeScaleDownEnabled bool

Flag that indicates whether the instance size may scale down. Atlas requires this parameter if replication_specs.#.region_configs.#.auto_scaling.0.compute_enabled : true. If you enable this option, specify a value for replication_specs.#.region_configs.#.auto_scaling.0.compute_min_instance_size.

DiskGbEnabled bool

Flag that indicates whether this cluster enables disk auto-scaling. This parameter defaults to true.

computeEnabled Boolean

Flag that indicates whether instance size auto-scaling is enabled. This parameter defaults to false.

computeMaxInstanceSize String

Maximum instance size to which your cluster can automatically scale (such as M40). Atlas requires this parameter if replication_specs.#.region_configs.#.auto_scaling.0.compute_enabled is true.

computeMinInstanceSize String

Minimum instance size to which your cluster can automatically scale (such as M10). Atlas requires this parameter if replication_specs.#.region_configs.#.auto_scaling.0.compute_scale_down_enabled is true.

computeScaleDownEnabled Boolean

Flag that indicates whether the instance size may scale down. Atlas requires this parameter if replication_specs.#.region_configs.#.auto_scaling.0.compute_enabled : true. If you enable this option, specify a value for replication_specs.#.region_configs.#.auto_scaling.0.compute_min_instance_size.

diskGbEnabled Boolean

Flag that indicates whether this cluster enables disk auto-scaling. This parameter defaults to true.

computeEnabled boolean

Flag that indicates whether instance size auto-scaling is enabled. This parameter defaults to false.

computeMaxInstanceSize string

Maximum instance size to which your cluster can automatically scale (such as M40). Atlas requires this parameter if replication_specs.#.region_configs.#.auto_scaling.0.compute_enabled is true.

computeMinInstanceSize string

Minimum instance size to which your cluster can automatically scale (such as M10). Atlas requires this parameter if replication_specs.#.region_configs.#.auto_scaling.0.compute_scale_down_enabled is true.

computeScaleDownEnabled boolean

Flag that indicates whether the instance size may scale down. Atlas requires this parameter if replication_specs.#.region_configs.#.auto_scaling.0.compute_enabled : true. If you enable this option, specify a value for replication_specs.#.region_configs.#.auto_scaling.0.compute_min_instance_size.

diskGbEnabled boolean

Flag that indicates whether this cluster enables disk auto-scaling. This parameter defaults to true.

compute_enabled bool

Flag that indicates whether instance size auto-scaling is enabled. This parameter defaults to false.

compute_max_instance_size str

Maximum instance size to which your cluster can automatically scale (such as M40). Atlas requires this parameter if replication_specs.#.region_configs.#.auto_scaling.0.compute_enabled is true.

compute_min_instance_size str

Minimum instance size to which your cluster can automatically scale (such as M10). Atlas requires this parameter if replication_specs.#.region_configs.#.auto_scaling.0.compute_scale_down_enabled is true.

compute_scale_down_enabled bool

Flag that indicates whether the instance size may scale down. Atlas requires this parameter if replication_specs.#.region_configs.#.auto_scaling.0.compute_enabled : true. If you enable this option, specify a value for replication_specs.#.region_configs.#.auto_scaling.0.compute_min_instance_size.

disk_gb_enabled bool

Flag that indicates whether this cluster enables disk auto-scaling. This parameter defaults to true.

computeEnabled Boolean

Flag that indicates whether instance size auto-scaling is enabled. This parameter defaults to false.

computeMaxInstanceSize String

Maximum instance size to which your cluster can automatically scale (such as M40). Atlas requires this parameter if replication_specs.#.region_configs.#.auto_scaling.0.compute_enabled is true.

computeMinInstanceSize String

Minimum instance size to which your cluster can automatically scale (such as M10). Atlas requires this parameter if replication_specs.#.region_configs.#.auto_scaling.0.compute_scale_down_enabled is true.

computeScaleDownEnabled Boolean

Flag that indicates whether the instance size may scale down. Atlas requires this parameter if replication_specs.#.region_configs.#.auto_scaling.0.compute_enabled : true. If you enable this option, specify a value for replication_specs.#.region_configs.#.auto_scaling.0.compute_min_instance_size.

diskGbEnabled Boolean

Flag that indicates whether this cluster enables disk auto-scaling. This parameter defaults to true.

AdvancedClusterReplicationSpecRegionConfigElectableSpecs

InstanceSize string

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.

DiskIops int

Target throughput (IOPS) desired for AWS storage attached to your cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

EbsVolumeType string

Type of storage you want to attach to your AWS-provisioned cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster. Valid values are:

NodeCount int

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can enable local reads.

InstanceSize string

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.

DiskIops int

Target throughput (IOPS) desired for AWS storage attached to your cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

EbsVolumeType string

Type of storage you want to attach to your AWS-provisioned cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster. Valid values are:

NodeCount int

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can enable local reads.

instanceSize String

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.

diskIops Integer

Target throughput (IOPS) desired for AWS storage attached to your cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

ebsVolumeType String

Type of storage you want to attach to your AWS-provisioned cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster. Valid values are:

nodeCount Integer

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can enable local reads.

instanceSize string

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.

diskIops number

Target throughput (IOPS) desired for AWS storage attached to your cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

ebsVolumeType string

Type of storage you want to attach to your AWS-provisioned cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster. Valid values are:

nodeCount number

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can enable local reads.

instance_size str

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.

disk_iops int

Target throughput (IOPS) desired for AWS storage attached to your cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

ebs_volume_type str

Type of storage you want to attach to your AWS-provisioned cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster. Valid values are:

node_count int

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can enable local reads.

instanceSize String

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.

diskIops Number

Target throughput (IOPS) desired for AWS storage attached to your cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

ebsVolumeType String

Type of storage you want to attach to your AWS-provisioned cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster. Valid values are:

nodeCount Number

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can enable local reads.

AdvancedClusterReplicationSpecRegionConfigReadOnlySpecs

InstanceSize string

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.

DiskIops int

Target throughput (IOPS) desired for AWS storage attached to your cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

EbsVolumeType string

Type of storage you want to attach to your AWS-provisioned cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster. Valid values are:

NodeCount int

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can enable local reads.

InstanceSize string

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.

DiskIops int

Target throughput (IOPS) desired for AWS storage attached to your cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

EbsVolumeType string

Type of storage you want to attach to your AWS-provisioned cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster. Valid values are:

NodeCount int

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can enable local reads.

instanceSize String

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.

diskIops Integer

Target throughput (IOPS) desired for AWS storage attached to your cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

ebsVolumeType String

Type of storage you want to attach to your AWS-provisioned cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster. Valid values are:

nodeCount Integer

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can enable local reads.

instanceSize string

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.

diskIops number

Target throughput (IOPS) desired for AWS storage attached to your cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

ebsVolumeType string

Type of storage you want to attach to your AWS-provisioned cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster. Valid values are:

nodeCount number

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can enable local reads.

instance_size str

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.

disk_iops int

Target throughput (IOPS) desired for AWS storage attached to your cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

ebs_volume_type str

Type of storage you want to attach to your AWS-provisioned cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster. Valid values are:

node_count int

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can enable local reads.

instanceSize String

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.

diskIops Number

Target throughput (IOPS) desired for AWS storage attached to your cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

ebsVolumeType String

Type of storage you want to attach to your AWS-provisioned cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster. Valid values are:

nodeCount Number

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can enable local reads.

Package Details

Repository
https://github.com/pulumi/pulumi-mongodbatlas
License
Apache-2.0
Notes

This Pulumi package is based on the mongodbatlas Terraform Provider.