Docs Home
MongoDB Atlas v3.20.4 published on Wednesday, Oct 30, 2024 by Pulumi
mongodbatlas.AdvancedCluster
Explore with Pulumi AI
Example Usage
Example single provider and single region
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";
const test = new mongodbatlas.AdvancedCluster("test", {
projectId: "PROJECT ID",
name: "NAME OF CLUSTER",
clusterType: "REPLICASET",
replicationSpecs: [{
regionConfigs: [{
electableSpecs: {
instanceSize: "M10",
nodeCount: 3,
},
analyticsSpecs: {
instanceSize: "M10",
nodeCount: 1,
},
providerName: "AWS",
priority: 7,
regionName: "US_EAST_1",
}],
}],
});
import pulumi
import pulumi_mongodbatlas as mongodbatlas
test = mongodbatlas.AdvancedCluster("test",
project_id="PROJECT ID",
name="NAME OF CLUSTER",
cluster_type="REPLICASET",
replication_specs=[{
"region_configs": [{
"electable_specs": {
"instance_size": "M10",
"node_count": 3,
},
"analytics_specs": {
"instance_size": "M10",
"node_count": 1,
},
"provider_name": "AWS",
"priority": 7,
"region_name": "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{
ProjectId: pulumi.String("PROJECT ID"),
Name: pulumi.String("NAME OF CLUSTER"),
ClusterType: pulumi.String("REPLICASET"),
ReplicationSpecs: mongodbatlas.AdvancedClusterReplicationSpecArray{
&mongodbatlas.AdvancedClusterReplicationSpecArgs{
RegionConfigs: mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArray{
&mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArgs{
ElectableSpecs: &mongodbatlas.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs{
InstanceSize: pulumi.String("M10"),
NodeCount: pulumi.Int(3),
},
AnalyticsSpecs: &mongodbatlas.AdvancedClusterReplicationSpecRegionConfigAnalyticsSpecsArgs{
InstanceSize: pulumi.String("M10"),
NodeCount: pulumi.Int(1),
},
ProviderName: pulumi.String("AWS"),
Priority: pulumi.Int(7),
RegionName: pulumi.String("US_EAST_1"),
},
},
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;
return await Deployment.RunAsync(() =>
{
var test = new Mongodbatlas.AdvancedCluster("test", new()
{
ProjectId = "PROJECT ID",
Name = "NAME OF CLUSTER",
ClusterType = "REPLICASET",
ReplicationSpecs = new[]
{
new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecArgs
{
RegionConfigs = new[]
{
new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigArgs
{
ElectableSpecs = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs
{
InstanceSize = "M10",
NodeCount = 3,
},
AnalyticsSpecs = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigAnalyticsSpecsArgs
{
InstanceSize = "M10",
NodeCount = 1,
},
ProviderName = "AWS",
Priority = 7,
RegionName = "US_EAST_1",
},
},
},
},
});
});
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()
.projectId("PROJECT ID")
.name("NAME OF CLUSTER")
.clusterType("REPLICASET")
.replicationSpecs(AdvancedClusterReplicationSpecArgs.builder()
.regionConfigs(AdvancedClusterReplicationSpecRegionConfigArgs.builder()
.electableSpecs(AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs.builder()
.instanceSize("M10")
.nodeCount(3)
.build())
.analyticsSpecs(AdvancedClusterReplicationSpecRegionConfigAnalyticsSpecsArgs.builder()
.instanceSize("M10")
.nodeCount(1)
.build())
.providerName("AWS")
.priority(7)
.regionName("US_EAST_1")
.build())
.build())
.build());
}
}
resources:
test:
type: mongodbatlas:AdvancedCluster
properties:
projectId: PROJECT ID
name: NAME OF CLUSTER
clusterType: REPLICASET
replicationSpecs:
- regionConfigs:
- electableSpecs:
instanceSize: M10
nodeCount: 3
analyticsSpecs:
instanceSize: M10
nodeCount: 1
providerName: AWS
priority: 7
regionName: US_EAST_1
Example Tenant Cluster
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";
const test = new mongodbatlas.AdvancedCluster("test", {
projectId: "PROJECT ID",
name: "NAME OF CLUSTER",
clusterType: "REPLICASET",
replicationSpecs: [{
regionConfigs: [{
electableSpecs: {
instanceSize: "M5",
},
providerName: "TENANT",
backingProviderName: "AWS",
regionName: "US_EAST_1",
priority: 7,
}],
}],
});
import pulumi
import pulumi_mongodbatlas as mongodbatlas
test = mongodbatlas.AdvancedCluster("test",
project_id="PROJECT ID",
name="NAME OF CLUSTER",
cluster_type="REPLICASET",
replication_specs=[{
"region_configs": [{
"electable_specs": {
"instance_size": "M5",
},
"provider_name": "TENANT",
"backing_provider_name": "AWS",
"region_name": "US_EAST_1",
"priority": 7,
}],
}])
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{
ProjectId: pulumi.String("PROJECT ID"),
Name: pulumi.String("NAME OF CLUSTER"),
ClusterType: pulumi.String("REPLICASET"),
ReplicationSpecs: mongodbatlas.AdvancedClusterReplicationSpecArray{
&mongodbatlas.AdvancedClusterReplicationSpecArgs{
RegionConfigs: mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArray{
&mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArgs{
ElectableSpecs: &mongodbatlas.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs{
InstanceSize: pulumi.String("M5"),
},
ProviderName: pulumi.String("TENANT"),
BackingProviderName: pulumi.String("AWS"),
RegionName: pulumi.String("US_EAST_1"),
Priority: pulumi.Int(7),
},
},
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;
return await Deployment.RunAsync(() =>
{
var test = new Mongodbatlas.AdvancedCluster("test", new()
{
ProjectId = "PROJECT ID",
Name = "NAME OF CLUSTER",
ClusterType = "REPLICASET",
ReplicationSpecs = new[]
{
new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecArgs
{
RegionConfigs = new[]
{
new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigArgs
{
ElectableSpecs = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs
{
InstanceSize = "M5",
},
ProviderName = "TENANT",
BackingProviderName = "AWS",
RegionName = "US_EAST_1",
Priority = 7,
},
},
},
},
});
});
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()
.projectId("PROJECT ID")
.name("NAME OF CLUSTER")
.clusterType("REPLICASET")
.replicationSpecs(AdvancedClusterReplicationSpecArgs.builder()
.regionConfigs(AdvancedClusterReplicationSpecRegionConfigArgs.builder()
.electableSpecs(AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs.builder()
.instanceSize("M5")
.build())
.providerName("TENANT")
.backingProviderName("AWS")
.regionName("US_EAST_1")
.priority(7)
.build())
.build())
.build());
}
}
resources:
test:
type: mongodbatlas:AdvancedCluster
properties:
projectId: PROJECT ID
name: NAME OF CLUSTER
clusterType: REPLICASET
replicationSpecs:
- regionConfigs:
- electableSpecs:
instanceSize: M5
providerName: TENANT
backingProviderName: AWS
regionName: US_EAST_1
priority: 7
NOTE: Upgrading the shared tier is supported. Any change from a shared tier cluster (a tenant) to a different instance size will be considered a tenant upgrade. When upgrading from the shared tier, change the provider_name from “TENANT” to your preferred provider (AWS, GCP or Azure) and remove the variable backing_provider_name. See the Example Tenant Cluster Upgrade below. You can upgrade a shared tier cluster only to a single provider on an M10-tier cluster or greater.
When upgrading from the shared tier, only the upgrade changes will be applied. This helps avoid a corrupt state file in the event that the upgrade succeeds but subsequent updates fail within the same pulumi up. To apply additional cluster changes, run a secondary pulumi up after the upgrade succeeds.
Example Tenant Cluster Upgrade
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";
const test = new mongodbatlas.AdvancedCluster("test", {
projectId: "PROJECT ID",
name: "NAME OF CLUSTER",
clusterType: "REPLICASET",
replicationSpecs: [{
regionConfigs: [{
electableSpecs: {
instanceSize: "M10",
},
providerName: "AWS",
regionName: "US_EAST_1",
priority: 7,
}],
}],
});
import pulumi
import pulumi_mongodbatlas as mongodbatlas
test = mongodbatlas.AdvancedCluster("test",
project_id="PROJECT ID",
name="NAME OF CLUSTER",
cluster_type="REPLICASET",
replication_specs=[{
"region_configs": [{
"electable_specs": {
"instance_size": "M10",
},
"provider_name": "AWS",
"region_name": "US_EAST_1",
"priority": 7,
}],
}])
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{
ProjectId: pulumi.String("PROJECT ID"),
Name: pulumi.String("NAME OF CLUSTER"),
ClusterType: pulumi.String("REPLICASET"),
ReplicationSpecs: mongodbatlas.AdvancedClusterReplicationSpecArray{
&mongodbatlas.AdvancedClusterReplicationSpecArgs{
RegionConfigs: mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArray{
&mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArgs{
ElectableSpecs: &mongodbatlas.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs{
InstanceSize: pulumi.String("M10"),
},
ProviderName: pulumi.String("AWS"),
RegionName: pulumi.String("US_EAST_1"),
Priority: pulumi.Int(7),
},
},
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;
return await Deployment.RunAsync(() =>
{
var test = new Mongodbatlas.AdvancedCluster("test", new()
{
ProjectId = "PROJECT ID",
Name = "NAME OF CLUSTER",
ClusterType = "REPLICASET",
ReplicationSpecs = new[]
{
new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecArgs
{
RegionConfigs = new[]
{
new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigArgs
{
ElectableSpecs = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs
{
InstanceSize = "M10",
},
ProviderName = "AWS",
RegionName = "US_EAST_1",
Priority = 7,
},
},
},
},
});
});
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()
.projectId("PROJECT ID")
.name("NAME OF CLUSTER")
.clusterType("REPLICASET")
.replicationSpecs(AdvancedClusterReplicationSpecArgs.builder()
.regionConfigs(AdvancedClusterReplicationSpecRegionConfigArgs.builder()
.electableSpecs(AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs.builder()
.instanceSize("M10")
.build())
.providerName("AWS")
.regionName("US_EAST_1")
.priority(7)
.build())
.build())
.build());
}
}
resources:
test:
type: mongodbatlas:AdvancedCluster
properties:
projectId: PROJECT ID
name: NAME OF CLUSTER
clusterType: REPLICASET
replicationSpecs:
- regionConfigs:
- electableSpecs:
instanceSize: M10
providerName: AWS
regionName: US_EAST_1
priority: 7
Example Multi-Cloud Cluster
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";
const test = new mongodbatlas.AdvancedCluster("test", {
projectId: "PROJECT ID",
name: "NAME OF CLUSTER",
clusterType: "REPLICASET",
replicationSpecs: [{
regionConfigs: [
{
electableSpecs: {
instanceSize: "M10",
nodeCount: 3,
},
analyticsSpecs: {
instanceSize: "M10",
nodeCount: 1,
},
providerName: "AWS",
priority: 7,
regionName: "US_EAST_1",
},
{
electableSpecs: {
instanceSize: "M10",
nodeCount: 2,
},
providerName: "GCP",
priority: 6,
regionName: "NORTH_AMERICA_NORTHEAST_1",
},
],
}],
});
import pulumi
import pulumi_mongodbatlas as mongodbatlas
test = mongodbatlas.AdvancedCluster("test",
project_id="PROJECT ID",
name="NAME OF CLUSTER",
cluster_type="REPLICASET",
replication_specs=[{
"region_configs": [
{
"electable_specs": {
"instance_size": "M10",
"node_count": 3,
},
"analytics_specs": {
"instance_size": "M10",
"node_count": 1,
},
"provider_name": "AWS",
"priority": 7,
"region_name": "US_EAST_1",
},
{
"electable_specs": {
"instance_size": "M10",
"node_count": 2,
},
"provider_name": "GCP",
"priority": 6,
"region_name": "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{
ProjectId: pulumi.String("PROJECT ID"),
Name: pulumi.String("NAME OF CLUSTER"),
ClusterType: pulumi.String("REPLICASET"),
ReplicationSpecs: mongodbatlas.AdvancedClusterReplicationSpecArray{
&mongodbatlas.AdvancedClusterReplicationSpecArgs{
RegionConfigs: mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArray{
&mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArgs{
ElectableSpecs: &mongodbatlas.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs{
InstanceSize: pulumi.String("M10"),
NodeCount: pulumi.Int(3),
},
AnalyticsSpecs: &mongodbatlas.AdvancedClusterReplicationSpecRegionConfigAnalyticsSpecsArgs{
InstanceSize: pulumi.String("M10"),
NodeCount: pulumi.Int(1),
},
ProviderName: pulumi.String("AWS"),
Priority: pulumi.Int(7),
RegionName: pulumi.String("US_EAST_1"),
},
&mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArgs{
ElectableSpecs: &mongodbatlas.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs{
InstanceSize: pulumi.String("M10"),
NodeCount: pulumi.Int(2),
},
ProviderName: pulumi.String("GCP"),
Priority: pulumi.Int(6),
RegionName: pulumi.String("NORTH_AMERICA_NORTHEAST_1"),
},
},
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;
return await Deployment.RunAsync(() =>
{
var test = new Mongodbatlas.AdvancedCluster("test", new()
{
ProjectId = "PROJECT ID",
Name = "NAME OF CLUSTER",
ClusterType = "REPLICASET",
ReplicationSpecs = new[]
{
new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecArgs
{
RegionConfigs = new[]
{
new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigArgs
{
ElectableSpecs = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs
{
InstanceSize = "M10",
NodeCount = 3,
},
AnalyticsSpecs = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigAnalyticsSpecsArgs
{
InstanceSize = "M10",
NodeCount = 1,
},
ProviderName = "AWS",
Priority = 7,
RegionName = "US_EAST_1",
},
new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigArgs
{
ElectableSpecs = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs
{
InstanceSize = "M10",
NodeCount = 2,
},
ProviderName = "GCP",
Priority = 6,
RegionName = "NORTH_AMERICA_NORTHEAST_1",
},
},
},
},
});
});
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()
.projectId("PROJECT ID")
.name("NAME OF CLUSTER")
.clusterType("REPLICASET")
.replicationSpecs(AdvancedClusterReplicationSpecArgs.builder()
.regionConfigs(
AdvancedClusterReplicationSpecRegionConfigArgs.builder()
.electableSpecs(AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs.builder()
.instanceSize("M10")
.nodeCount(3)
.build())
.analyticsSpecs(AdvancedClusterReplicationSpecRegionConfigAnalyticsSpecsArgs.builder()
.instanceSize("M10")
.nodeCount(1)
.build())
.providerName("AWS")
.priority(7)
.regionName("US_EAST_1")
.build(),
AdvancedClusterReplicationSpecRegionConfigArgs.builder()
.electableSpecs(AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs.builder()
.instanceSize("M10")
.nodeCount(2)
.build())
.providerName("GCP")
.priority(6)
.regionName("NORTH_AMERICA_NORTHEAST_1")
.build())
.build())
.build());
}
}
resources:
test:
type: mongodbatlas:AdvancedCluster
properties:
projectId: PROJECT ID
name: NAME OF CLUSTER
clusterType: REPLICASET
replicationSpecs:
- regionConfigs:
- electableSpecs:
instanceSize: M10
nodeCount: 3
analyticsSpecs:
instanceSize: M10
nodeCount: 1
providerName: AWS
priority: 7
regionName: US_EAST_1
- electableSpecs:
instanceSize: M10
nodeCount: 2
providerName: GCP
priority: 6
regionName: NORTH_AMERICA_NORTHEAST_1
Example of a Multi Cloud Sharded Cluster with 2 shards
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";
const cluster = new mongodbatlas.AdvancedCluster("cluster", {
projectId: project.id,
name: clusterName,
clusterType: "SHARDED",
backupEnabled: true,
replicationSpecs: [
{
regionConfigs: [
{
electableSpecs: {
instanceSize: "M30",
nodeCount: 3,
},
providerName: "AWS",
priority: 7,
regionName: "US_EAST_1",
},
{
electableSpecs: {
instanceSize: "M30",
nodeCount: 2,
},
providerName: "AZURE",
priority: 6,
regionName: "US_EAST_2",
},
],
},
{
regionConfigs: [
{
electableSpecs: {
instanceSize: "M30",
nodeCount: 3,
},
providerName: "AWS",
priority: 7,
regionName: "US_EAST_1",
},
{
electableSpecs: {
instanceSize: "M30",
nodeCount: 2,
},
providerName: "AZURE",
priority: 6,
regionName: "US_EAST_2",
},
],
},
],
advancedConfiguration: {
javascriptEnabled: true,
oplogSizeMb: 991,
sampleRefreshIntervalBiConnector: 300,
},
});
import pulumi
import pulumi_mongodbatlas as mongodbatlas
cluster = mongodbatlas.AdvancedCluster("cluster",
project_id=project["id"],
name=cluster_name,
cluster_type="SHARDED",
backup_enabled=True,
replication_specs=[
{
"region_configs": [
{
"electable_specs": {
"instance_size": "M30",
"node_count": 3,
},
"provider_name": "AWS",
"priority": 7,
"region_name": "US_EAST_1",
},
{
"electable_specs": {
"instance_size": "M30",
"node_count": 2,
},
"provider_name": "AZURE",
"priority": 6,
"region_name": "US_EAST_2",
},
],
},
{
"region_configs": [
{
"electable_specs": {
"instance_size": "M30",
"node_count": 3,
},
"provider_name": "AWS",
"priority": 7,
"region_name": "US_EAST_1",
},
{
"electable_specs": {
"instance_size": "M30",
"node_count": 2,
},
"provider_name": "AZURE",
"priority": 6,
"region_name": "US_EAST_2",
},
],
},
],
advanced_configuration={
"javascript_enabled": True,
"oplog_size_mb": 991,
"sample_refresh_interval_bi_connector": 300,
})
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, "cluster", &mongodbatlas.AdvancedClusterArgs{
ProjectId: pulumi.Any(project.Id),
Name: pulumi.Any(clusterName),
ClusterType: pulumi.String("SHARDED"),
BackupEnabled: pulumi.Bool(true),
ReplicationSpecs: mongodbatlas.AdvancedClusterReplicationSpecArray{
&mongodbatlas.AdvancedClusterReplicationSpecArgs{
RegionConfigs: mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArray{
&mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArgs{
ElectableSpecs: &mongodbatlas.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs{
InstanceSize: pulumi.String("M30"),
NodeCount: pulumi.Int(3),
},
ProviderName: pulumi.String("AWS"),
Priority: pulumi.Int(7),
RegionName: pulumi.String("US_EAST_1"),
},
&mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArgs{
ElectableSpecs: &mongodbatlas.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs{
InstanceSize: pulumi.String("M30"),
NodeCount: pulumi.Int(2),
},
ProviderName: pulumi.String("AZURE"),
Priority: pulumi.Int(6),
RegionName: pulumi.String("US_EAST_2"),
},
},
},
&mongodbatlas.AdvancedClusterReplicationSpecArgs{
RegionConfigs: mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArray{
&mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArgs{
ElectableSpecs: &mongodbatlas.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs{
InstanceSize: pulumi.String("M30"),
NodeCount: pulumi.Int(3),
},
ProviderName: pulumi.String("AWS"),
Priority: pulumi.Int(7),
RegionName: pulumi.String("US_EAST_1"),
},
&mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArgs{
ElectableSpecs: &mongodbatlas.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs{
InstanceSize: pulumi.String("M30"),
NodeCount: pulumi.Int(2),
},
ProviderName: pulumi.String("AZURE"),
Priority: pulumi.Int(6),
RegionName: pulumi.String("US_EAST_2"),
},
},
},
},
AdvancedConfiguration: &mongodbatlas.AdvancedClusterAdvancedConfigurationArgs{
JavascriptEnabled: pulumi.Bool(true),
OplogSizeMb: pulumi.Int(991),
SampleRefreshIntervalBiConnector: pulumi.Int(300),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;
return await Deployment.RunAsync(() =>
{
var cluster = new Mongodbatlas.AdvancedCluster("cluster", new()
{
ProjectId = project.Id,
Name = clusterName,
ClusterType = "SHARDED",
BackupEnabled = true,
ReplicationSpecs = new[]
{
new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecArgs
{
RegionConfigs = new[]
{
new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigArgs
{
ElectableSpecs = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs
{
InstanceSize = "M30",
NodeCount = 3,
},
ProviderName = "AWS",
Priority = 7,
RegionName = "US_EAST_1",
},
new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigArgs
{
ElectableSpecs = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs
{
InstanceSize = "M30",
NodeCount = 2,
},
ProviderName = "AZURE",
Priority = 6,
RegionName = "US_EAST_2",
},
},
},
new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecArgs
{
RegionConfigs = new[]
{
new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigArgs
{
ElectableSpecs = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs
{
InstanceSize = "M30",
NodeCount = 3,
},
ProviderName = "AWS",
Priority = 7,
RegionName = "US_EAST_1",
},
new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigArgs
{
ElectableSpecs = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs
{
InstanceSize = "M30",
NodeCount = 2,
},
ProviderName = "AZURE",
Priority = 6,
RegionName = "US_EAST_2",
},
},
},
},
AdvancedConfiguration = new Mongodbatlas.Inputs.AdvancedClusterAdvancedConfigurationArgs
{
JavascriptEnabled = true,
OplogSizeMb = 991,
SampleRefreshIntervalBiConnector = 300,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.AdvancedCluster;
import com.pulumi.mongodbatlas.AdvancedClusterArgs;
import com.pulumi.mongodbatlas.inputs.AdvancedClusterReplicationSpecArgs;
import com.pulumi.mongodbatlas.inputs.AdvancedClusterAdvancedConfigurationArgs;
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 cluster = new AdvancedCluster("cluster", AdvancedClusterArgs.builder()
.projectId(project.id())
.name(clusterName)
.clusterType("SHARDED")
.backupEnabled(true)
.replicationSpecs(
AdvancedClusterReplicationSpecArgs.builder()
.regionConfigs(
AdvancedClusterReplicationSpecRegionConfigArgs.builder()
.electableSpecs(AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs.builder()
.instanceSize("M30")
.nodeCount(3)
.build())
.providerName("AWS")
.priority(7)
.regionName("US_EAST_1")
.build(),
AdvancedClusterReplicationSpecRegionConfigArgs.builder()
.electableSpecs(AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs.builder()
.instanceSize("M30")
.nodeCount(2)
.build())
.providerName("AZURE")
.priority(6)
.regionName("US_EAST_2")
.build())
.build(),
AdvancedClusterReplicationSpecArgs.builder()
.regionConfigs(
AdvancedClusterReplicationSpecRegionConfigArgs.builder()
.electableSpecs(AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs.builder()
.instanceSize("M30")
.nodeCount(3)
.build())
.providerName("AWS")
.priority(7)
.regionName("US_EAST_1")
.build(),
AdvancedClusterReplicationSpecRegionConfigArgs.builder()
.electableSpecs(AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs.builder()
.instanceSize("M30")
.nodeCount(2)
.build())
.providerName("AZURE")
.priority(6)
.regionName("US_EAST_2")
.build())
.build())
.advancedConfiguration(AdvancedClusterAdvancedConfigurationArgs.builder()
.javascriptEnabled(true)
.oplogSizeMb(991)
.sampleRefreshIntervalBiConnector(300)
.build())
.build());
}
}
resources:
cluster:
type: mongodbatlas:AdvancedCluster
properties:
projectId: ${project.id}
name: ${clusterName}
clusterType: SHARDED
backupEnabled: true
replicationSpecs:
- regionConfigs:
- electableSpecs:
instanceSize: M30
nodeCount: 3
providerName: AWS
priority: 7
regionName: US_EAST_1
- electableSpecs:
instanceSize: M30
nodeCount: 2
providerName: AZURE
priority: 6
regionName: US_EAST_2
- regionConfigs:
- electableSpecs:
instanceSize: M30
nodeCount: 3
providerName: AWS
priority: 7
regionName: US_EAST_1
- electableSpecs:
instanceSize: M30
nodeCount: 2
providerName: AZURE
priority: 6
regionName: US_EAST_2
advancedConfiguration:
javascriptEnabled: true
oplogSizeMb: 991
sampleRefreshIntervalBiConnector: 300
Example of a Global Cluster with 2 zones
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";
const cluster = new mongodbatlas.AdvancedCluster("cluster", {
projectId: project.id,
name: clusterName,
clusterType: "GEOSHARDED",
backupEnabled: true,
replicationSpecs: [
{
zoneName: "zone n1",
regionConfigs: [
{
electableSpecs: {
instanceSize: "M30",
nodeCount: 3,
},
providerName: "AWS",
priority: 7,
regionName: "US_EAST_1",
},
{
electableSpecs: {
instanceSize: "M30",
nodeCount: 2,
},
providerName: "AZURE",
priority: 6,
regionName: "US_EAST_2",
},
],
},
{
zoneName: "zone n1",
regionConfigs: [
{
electableSpecs: {
instanceSize: "M30",
nodeCount: 3,
},
providerName: "AWS",
priority: 7,
regionName: "US_EAST_1",
},
{
electableSpecs: {
instanceSize: "M30",
nodeCount: 2,
},
providerName: "AZURE",
priority: 6,
regionName: "US_EAST_2",
},
],
},
{
zoneName: "zone n2",
regionConfigs: [
{
electableSpecs: {
instanceSize: "M30",
nodeCount: 3,
},
providerName: "AWS",
priority: 7,
regionName: "EU_WEST_1",
},
{
electableSpecs: {
instanceSize: "M30",
nodeCount: 2,
},
providerName: "AZURE",
priority: 6,
regionName: "EUROPE_NORTH",
},
],
},
{
zoneName: "zone n2",
regionConfigs: [
{
electableSpecs: {
instanceSize: "M30",
nodeCount: 3,
},
providerName: "AWS",
priority: 7,
regionName: "EU_WEST_1",
},
{
electableSpecs: {
instanceSize: "M30",
nodeCount: 2,
},
providerName: "AZURE",
priority: 6,
regionName: "EUROPE_NORTH",
},
],
},
],
advancedConfiguration: {
javascriptEnabled: true,
oplogSizeMb: 999,
sampleRefreshIntervalBiConnector: 300,
},
});
import pulumi
import pulumi_mongodbatlas as mongodbatlas
cluster = mongodbatlas.AdvancedCluster("cluster",
project_id=project["id"],
name=cluster_name,
cluster_type="GEOSHARDED",
backup_enabled=True,
replication_specs=[
{
"zone_name": "zone n1",
"region_configs": [
{
"electable_specs": {
"instance_size": "M30",
"node_count": 3,
},
"provider_name": "AWS",
"priority": 7,
"region_name": "US_EAST_1",
},
{
"electable_specs": {
"instance_size": "M30",
"node_count": 2,
},
"provider_name": "AZURE",
"priority": 6,
"region_name": "US_EAST_2",
},
],
},
{
"zone_name": "zone n1",
"region_configs": [
{
"electable_specs": {
"instance_size": "M30",
"node_count": 3,
},
"provider_name": "AWS",
"priority": 7,
"region_name": "US_EAST_1",
},
{
"electable_specs": {
"instance_size": "M30",
"node_count": 2,
},
"provider_name": "AZURE",
"priority": 6,
"region_name": "US_EAST_2",
},
],
},
{
"zone_name": "zone n2",
"region_configs": [
{
"electable_specs": {
"instance_size": "M30",
"node_count": 3,
},
"provider_name": "AWS",
"priority": 7,
"region_name": "EU_WEST_1",
},
{
"electable_specs": {
"instance_size": "M30",
"node_count": 2,
},
"provider_name": "AZURE",
"priority": 6,
"region_name": "EUROPE_NORTH",
},
],
},
{
"zone_name": "zone n2",
"region_configs": [
{
"electable_specs": {
"instance_size": "M30",
"node_count": 3,
},
"provider_name": "AWS",
"priority": 7,
"region_name": "EU_WEST_1",
},
{
"electable_specs": {
"instance_size": "M30",
"node_count": 2,
},
"provider_name": "AZURE",
"priority": 6,
"region_name": "EUROPE_NORTH",
},
],
},
],
advanced_configuration={
"javascript_enabled": True,
"oplog_size_mb": 999,
"sample_refresh_interval_bi_connector": 300,
})
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, "cluster", &mongodbatlas.AdvancedClusterArgs{
ProjectId: pulumi.Any(project.Id),
Name: pulumi.Any(clusterName),
ClusterType: pulumi.String("GEOSHARDED"),
BackupEnabled: pulumi.Bool(true),
ReplicationSpecs: mongodbatlas.AdvancedClusterReplicationSpecArray{
&mongodbatlas.AdvancedClusterReplicationSpecArgs{
ZoneName: pulumi.String("zone n1"),
RegionConfigs: mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArray{
&mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArgs{
ElectableSpecs: &mongodbatlas.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs{
InstanceSize: pulumi.String("M30"),
NodeCount: pulumi.Int(3),
},
ProviderName: pulumi.String("AWS"),
Priority: pulumi.Int(7),
RegionName: pulumi.String("US_EAST_1"),
},
&mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArgs{
ElectableSpecs: &mongodbatlas.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs{
InstanceSize: pulumi.String("M30"),
NodeCount: pulumi.Int(2),
},
ProviderName: pulumi.String("AZURE"),
Priority: pulumi.Int(6),
RegionName: pulumi.String("US_EAST_2"),
},
},
},
&mongodbatlas.AdvancedClusterReplicationSpecArgs{
ZoneName: pulumi.String("zone n1"),
RegionConfigs: mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArray{
&mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArgs{
ElectableSpecs: &mongodbatlas.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs{
InstanceSize: pulumi.String("M30"),
NodeCount: pulumi.Int(3),
},
ProviderName: pulumi.String("AWS"),
Priority: pulumi.Int(7),
RegionName: pulumi.String("US_EAST_1"),
},
&mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArgs{
ElectableSpecs: &mongodbatlas.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs{
InstanceSize: pulumi.String("M30"),
NodeCount: pulumi.Int(2),
},
ProviderName: pulumi.String("AZURE"),
Priority: pulumi.Int(6),
RegionName: pulumi.String("US_EAST_2"),
},
},
},
&mongodbatlas.AdvancedClusterReplicationSpecArgs{
ZoneName: pulumi.String("zone n2"),
RegionConfigs: mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArray{
&mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArgs{
ElectableSpecs: &mongodbatlas.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs{
InstanceSize: pulumi.String("M30"),
NodeCount: pulumi.Int(3),
},
ProviderName: pulumi.String("AWS"),
Priority: pulumi.Int(7),
RegionName: pulumi.String("EU_WEST_1"),
},
&mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArgs{
ElectableSpecs: &mongodbatlas.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs{
InstanceSize: pulumi.String("M30"),
NodeCount: pulumi.Int(2),
},
ProviderName: pulumi.String("AZURE"),
Priority: pulumi.Int(6),
RegionName: pulumi.String("EUROPE_NORTH"),
},
},
},
&mongodbatlas.AdvancedClusterReplicationSpecArgs{
ZoneName: pulumi.String("zone n2"),
RegionConfigs: mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArray{
&mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArgs{
ElectableSpecs: &mongodbatlas.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs{
InstanceSize: pulumi.String("M30"),
NodeCount: pulumi.Int(3),
},
ProviderName: pulumi.String("AWS"),
Priority: pulumi.Int(7),
RegionName: pulumi.String("EU_WEST_1"),
},
&mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArgs{
ElectableSpecs: &mongodbatlas.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs{
InstanceSize: pulumi.String("M30"),
NodeCount: pulumi.Int(2),
},
ProviderName: pulumi.String("AZURE"),
Priority: pulumi.Int(6),
RegionName: pulumi.String("EUROPE_NORTH"),
},
},
},
},
AdvancedConfiguration: &mongodbatlas.AdvancedClusterAdvancedConfigurationArgs{
JavascriptEnabled: pulumi.Bool(true),
OplogSizeMb: pulumi.Int(999),
SampleRefreshIntervalBiConnector: pulumi.Int(300),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;
return await Deployment.RunAsync(() =>
{
var cluster = new Mongodbatlas.AdvancedCluster("cluster", new()
{
ProjectId = project.Id,
Name = clusterName,
ClusterType = "GEOSHARDED",
BackupEnabled = true,
ReplicationSpecs = new[]
{
new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecArgs
{
ZoneName = "zone n1",
RegionConfigs = new[]
{
new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigArgs
{
ElectableSpecs = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs
{
InstanceSize = "M30",
NodeCount = 3,
},
ProviderName = "AWS",
Priority = 7,
RegionName = "US_EAST_1",
},
new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigArgs
{
ElectableSpecs = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs
{
InstanceSize = "M30",
NodeCount = 2,
},
ProviderName = "AZURE",
Priority = 6,
RegionName = "US_EAST_2",
},
},
},
new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecArgs
{
ZoneName = "zone n1",
RegionConfigs = new[]
{
new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigArgs
{
ElectableSpecs = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs
{
InstanceSize = "M30",
NodeCount = 3,
},
ProviderName = "AWS",
Priority = 7,
RegionName = "US_EAST_1",
},
new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigArgs
{
ElectableSpecs = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs
{
InstanceSize = "M30",
NodeCount = 2,
},
ProviderName = "AZURE",
Priority = 6,
RegionName = "US_EAST_2",
},
},
},
new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecArgs
{
ZoneName = "zone n2",
RegionConfigs = new[]
{
new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigArgs
{
ElectableSpecs = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs
{
InstanceSize = "M30",
NodeCount = 3,
},
ProviderName = "AWS",
Priority = 7,
RegionName = "EU_WEST_1",
},
new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigArgs
{
ElectableSpecs = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs
{
InstanceSize = "M30",
NodeCount = 2,
},
ProviderName = "AZURE",
Priority = 6,
RegionName = "EUROPE_NORTH",
},
},
},
new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecArgs
{
ZoneName = "zone n2",
RegionConfigs = new[]
{
new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigArgs
{
ElectableSpecs = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs
{
InstanceSize = "M30",
NodeCount = 3,
},
ProviderName = "AWS",
Priority = 7,
RegionName = "EU_WEST_1",
},
new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigArgs
{
ElectableSpecs = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs
{
InstanceSize = "M30",
NodeCount = 2,
},
ProviderName = "AZURE",
Priority = 6,
RegionName = "EUROPE_NORTH",
},
},
},
},
AdvancedConfiguration = new Mongodbatlas.Inputs.AdvancedClusterAdvancedConfigurationArgs
{
JavascriptEnabled = true,
OplogSizeMb = 999,
SampleRefreshIntervalBiConnector = 300,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.AdvancedCluster;
import com.pulumi.mongodbatlas.AdvancedClusterArgs;
import com.pulumi.mongodbatlas.inputs.AdvancedClusterReplicationSpecArgs;
import com.pulumi.mongodbatlas.inputs.AdvancedClusterAdvancedConfigurationArgs;
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 cluster = new AdvancedCluster("cluster", AdvancedClusterArgs.builder()
.projectId(project.id())
.name(clusterName)
.clusterType("GEOSHARDED")
.backupEnabled(true)
.replicationSpecs(
AdvancedClusterReplicationSpecArgs.builder()
.zoneName("zone n1")
.regionConfigs(
AdvancedClusterReplicationSpecRegionConfigArgs.builder()
.electableSpecs(AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs.builder()
.instanceSize("M30")
.nodeCount(3)
.build())
.providerName("AWS")
.priority(7)
.regionName("US_EAST_1")
.build(),
AdvancedClusterReplicationSpecRegionConfigArgs.builder()
.electableSpecs(AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs.builder()
.instanceSize("M30")
.nodeCount(2)
.build())
.providerName("AZURE")
.priority(6)
.regionName("US_EAST_2")
.build())
.build(),
AdvancedClusterReplicationSpecArgs.builder()
.zoneName("zone n1")
.regionConfigs(
AdvancedClusterReplicationSpecRegionConfigArgs.builder()
.electableSpecs(AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs.builder()
.instanceSize("M30")
.nodeCount(3)
.build())
.providerName("AWS")
.priority(7)
.regionName("US_EAST_1")
.build(),
AdvancedClusterReplicationSpecRegionConfigArgs.builder()
.electableSpecs(AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs.builder()
.instanceSize("M30")
.nodeCount(2)
.build())
.providerName("AZURE")
.priority(6)
.regionName("US_EAST_2")
.build())
.build(),
AdvancedClusterReplicationSpecArgs.builder()
.zoneName("zone n2")
.regionConfigs(
AdvancedClusterReplicationSpecRegionConfigArgs.builder()
.electableSpecs(AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs.builder()
.instanceSize("M30")
.nodeCount(3)
.build())
.providerName("AWS")
.priority(7)
.regionName("EU_WEST_1")
.build(),
AdvancedClusterReplicationSpecRegionConfigArgs.builder()
.electableSpecs(AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs.builder()
.instanceSize("M30")
.nodeCount(2)
.build())
.providerName("AZURE")
.priority(6)
.regionName("EUROPE_NORTH")
.build())
.build(),
AdvancedClusterReplicationSpecArgs.builder()
.zoneName("zone n2")
.regionConfigs(
AdvancedClusterReplicationSpecRegionConfigArgs.builder()
.electableSpecs(AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs.builder()
.instanceSize("M30")
.nodeCount(3)
.build())
.providerName("AWS")
.priority(7)
.regionName("EU_WEST_1")
.build(),
AdvancedClusterReplicationSpecRegionConfigArgs.builder()
.electableSpecs(AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs.builder()
.instanceSize("M30")
.nodeCount(2)
.build())
.providerName("AZURE")
.priority(6)
.regionName("EUROPE_NORTH")
.build())
.build())
.advancedConfiguration(AdvancedClusterAdvancedConfigurationArgs.builder()
.javascriptEnabled(true)
.oplogSizeMb(999)
.sampleRefreshIntervalBiConnector(300)
.build())
.build());
}
}
resources:
cluster:
type: mongodbatlas:AdvancedCluster
properties:
projectId: ${project.id}
name: ${clusterName}
clusterType: GEOSHARDED
backupEnabled: true
replicationSpecs:
- zoneName: zone n1
regionConfigs:
- electableSpecs:
instanceSize: M30
nodeCount: 3
providerName: AWS
priority: 7
regionName: US_EAST_1
- electableSpecs:
instanceSize: M30
nodeCount: 2
providerName: AZURE
priority: 6
regionName: US_EAST_2
- zoneName: zone n1
regionConfigs:
- electableSpecs:
instanceSize: M30
nodeCount: 3
providerName: AWS
priority: 7
regionName: US_EAST_1
- electableSpecs:
instanceSize: M30
nodeCount: 2
providerName: AZURE
priority: 6
regionName: US_EAST_2
- zoneName: zone n2
regionConfigs:
- electableSpecs:
instanceSize: M30
nodeCount: 3
providerName: AWS
priority: 7
regionName: EU_WEST_1
- electableSpecs:
instanceSize: M30
nodeCount: 2
providerName: AZURE
priority: 6
regionName: EUROPE_NORTH
- zoneName: zone n2
regionConfigs:
- electableSpecs:
instanceSize: M30
nodeCount: 3
providerName: AWS
priority: 7
regionName: EU_WEST_1
- electableSpecs:
instanceSize: M30
nodeCount: 2
providerName: AZURE
priority: 6
regionName: EUROPE_NORTH
advancedConfiguration:
javascriptEnabled: true
oplogSizeMb: 999
sampleRefreshIntervalBiConnector: 300
Example - Return a Connection String
Standard
import * as pulumi from "@pulumi/pulumi";
export const standard = cluster.connectionStrings[0].standard;
import pulumi
pulumi.export("standard", cluster["connectionStrings"][0]["standard"])
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
ctx.Export("standard", cluster.ConnectionStrings[0].Standard)
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
return await Deployment.RunAsync(() =>
{
return new Dictionary<string, object?>
{
["standard"] = cluster.ConnectionStrings[0].Standard,
};
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
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) {
ctx.export("standard", cluster.connectionStrings()[0].standard());
}
}
outputs:
standard: ${cluster.connectionStrings[0].standard}
Standard srv
import * as pulumi from "@pulumi/pulumi";
export const standardSrv = cluster.connectionStrings[0].standardSrv;
import pulumi
pulumi.export("standardSrv", cluster["connectionStrings"][0]["standardSrv"])
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
ctx.Export("standardSrv", cluster.ConnectionStrings[0].StandardSrv)
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
return await Deployment.RunAsync(() =>
{
return new Dictionary<string, object?>
{
["standardSrv"] = cluster.ConnectionStrings[0].StandardSrv,
};
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
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) {
ctx.export("standardSrv", cluster.connectionStrings()[0].standardSrv());
}
}
outputs:
standardSrv: ${cluster.connectionStrings[0].standardSrv}
Private with Network peering and Custom DNS AWS enabled
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 attributes: MongoDB API Advanced Clusters
~> IMPORTANT:
\n\n • When a cluster is imported, the resulting schema structure will always return the new schema including replication_specs per independent shards of the cluster.
\n\n • Note: The first time pulumi up command is run after updating the configuration of an imported cluster, you may receive a 500 Internal Server Error (Error code: "SERVICE_UNAVAILABLE") error. This is a known temporary issue. If you encounter this, please re-run pulumi up and this time the update should succeed.
Create AdvancedCluster Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AdvancedCluster(name: string, args: AdvancedClusterArgs, opts?: CustomResourceOptions);@overload
def AdvancedCluster(resource_name: str,
args: AdvancedClusterArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AdvancedCluster(resource_name: str,
opts: Optional[ResourceOptions] = None,
cluster_type: Optional[str] = None,
replication_specs: Optional[Sequence[AdvancedClusterReplicationSpecArgs]] = None,
project_id: Optional[str] = None,
mongo_db_major_version: Optional[str] = None,
paused: Optional[bool] = None,
config_server_management_mode: Optional[str] = None,
disk_size_gb: Optional[float] = None,
encryption_at_rest_provider: Optional[str] = None,
global_cluster_self_managed_sharding: Optional[bool] = None,
labels: Optional[Sequence[AdvancedClusterLabelArgs]] = None,
accept_data_risks_and_force_replica_set_reconfig: Optional[str] = None,
name: Optional[str] = None,
bi_connector_config: Optional[AdvancedClusterBiConnectorConfigArgs] = None,
pit_enabled: Optional[bool] = None,
backup_enabled: Optional[bool] = None,
redact_client_log_data: Optional[bool] = None,
replica_set_scaling_strategy: Optional[str] = None,
advanced_configuration: Optional[AdvancedClusterAdvancedConfigurationArgs] = None,
retain_backups_enabled: Optional[bool] = None,
root_cert_type: Optional[str] = None,
tags: Optional[Sequence[AdvancedClusterTagArgs]] = None,
termination_protection_enabled: Optional[bool] = None,
version_release_system: Optional[str] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var advancedClusterResource = new Mongodbatlas.AdvancedCluster("advancedClusterResource", new()
{
ClusterType = "string",
ReplicationSpecs = new[]
{
new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecArgs
{
RegionConfigs = new[]
{
new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigArgs
{
Priority = 0,
ProviderName = "string",
RegionName = "string",
AnalyticsAutoScaling = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigAnalyticsAutoScalingArgs
{
ComputeEnabled = false,
ComputeMaxInstanceSize = "string",
ComputeMinInstanceSize = "string",
ComputeScaleDownEnabled = false,
DiskGbEnabled = false,
},
AnalyticsSpecs = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigAnalyticsSpecsArgs
{
InstanceSize = "string",
DiskIops = 0,
DiskSizeGb = 0,
EbsVolumeType = "string",
NodeCount = 0,
},
AutoScaling = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigAutoScalingArgs
{
ComputeEnabled = false,
ComputeMaxInstanceSize = "string",
ComputeMinInstanceSize = "string",
ComputeScaleDownEnabled = false,
DiskGbEnabled = false,
},
BackingProviderName = "string",
ElectableSpecs = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs
{
InstanceSize = "string",
DiskIops = 0,
DiskSizeGb = 0,
EbsVolumeType = "string",
NodeCount = 0,
},
ReadOnlySpecs = new Mongodbatlas.Inputs.AdvancedClusterReplicationSpecRegionConfigReadOnlySpecsArgs
{
InstanceSize = "string",
DiskIops = 0,
DiskSizeGb = 0,
EbsVolumeType = "string",
NodeCount = 0,
},
},
},
ContainerId =
{
{ "string", "string" },
},
ExternalId = "string",
ZoneId = "string",
ZoneName = "string",
},
},
ProjectId = "string",
MongoDbMajorVersion = "string",
Paused = false,
ConfigServerManagementMode = "string",
EncryptionAtRestProvider = "string",
GlobalClusterSelfManagedSharding = false,
Labels = new[]
{
new Mongodbatlas.Inputs.AdvancedClusterLabelArgs
{
Key = "string",
Value = "string",
},
},
AcceptDataRisksAndForceReplicaSetReconfig = "string",
Name = "string",
BiConnectorConfig = new Mongodbatlas.Inputs.AdvancedClusterBiConnectorConfigArgs
{
Enabled = false,
ReadPreference = "string",
},
PitEnabled = false,
BackupEnabled = false,
RedactClientLogData = false,
ReplicaSetScalingStrategy = "string",
AdvancedConfiguration = new Mongodbatlas.Inputs.AdvancedClusterAdvancedConfigurationArgs
{
ChangeStreamOptionsPreAndPostImagesExpireAfterSeconds = 0,
DefaultWriteConcern = "string",
JavascriptEnabled = false,
MinimumEnabledTlsProtocol = "string",
NoTableScan = false,
OplogMinRetentionHours = 0,
OplogSizeMb = 0,
SampleRefreshIntervalBiConnector = 0,
SampleSizeBiConnector = 0,
TransactionLifetimeLimitSeconds = 0,
},
RetainBackupsEnabled = false,
RootCertType = "string",
Tags = new[]
{
new Mongodbatlas.Inputs.AdvancedClusterTagArgs
{
Key = "string",
Value = "string",
},
},
TerminationProtectionEnabled = false,
VersionReleaseSystem = "string",
});
example, err := mongodbatlas.NewAdvancedCluster(ctx, "advancedClusterResource", &mongodbatlas.AdvancedClusterArgs{
ClusterType: pulumi.String("string"),
ReplicationSpecs: mongodbatlas.AdvancedClusterReplicationSpecArray{
&mongodbatlas.AdvancedClusterReplicationSpecArgs{
RegionConfigs: mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArray{
&mongodbatlas.AdvancedClusterReplicationSpecRegionConfigArgs{
Priority: pulumi.Int(0),
ProviderName: pulumi.String("string"),
RegionName: pulumi.String("string"),
AnalyticsAutoScaling: &mongodbatlas.AdvancedClusterReplicationSpecRegionConfigAnalyticsAutoScalingArgs{
ComputeEnabled: pulumi.Bool(false),
ComputeMaxInstanceSize: pulumi.String("string"),
ComputeMinInstanceSize: pulumi.String("string"),
ComputeScaleDownEnabled: pulumi.Bool(false),
DiskGbEnabled: pulumi.Bool(false),
},
AnalyticsSpecs: &mongodbatlas.AdvancedClusterReplicationSpecRegionConfigAnalyticsSpecsArgs{
InstanceSize: pulumi.String("string"),
DiskIops: pulumi.Int(0),
DiskSizeGb: pulumi.Float64(0),
EbsVolumeType: pulumi.String("string"),
NodeCount: pulumi.Int(0),
},
AutoScaling: &mongodbatlas.AdvancedClusterReplicationSpecRegionConfigAutoScalingArgs{
ComputeEnabled: pulumi.Bool(false),
ComputeMaxInstanceSize: pulumi.String("string"),
ComputeMinInstanceSize: pulumi.String("string"),
ComputeScaleDownEnabled: pulumi.Bool(false),
DiskGbEnabled: pulumi.Bool(false),
},
BackingProviderName: pulumi.String("string"),
ElectableSpecs: &mongodbatlas.AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs{
InstanceSize: pulumi.String("string"),
DiskIops: pulumi.Int(0),
DiskSizeGb: pulumi.Float64(0),
EbsVolumeType: pulumi.String("string"),
NodeCount: pulumi.Int(0),
},
ReadOnlySpecs: &mongodbatlas.AdvancedClusterReplicationSpecRegionConfigReadOnlySpecsArgs{
InstanceSize: pulumi.String("string"),
DiskIops: pulumi.Int(0),
DiskSizeGb: pulumi.Float64(0),
EbsVolumeType: pulumi.String("string"),
NodeCount: pulumi.Int(0),
},
},
},
ContainerId: pulumi.StringMap{
"string": pulumi.String("string"),
},
ExternalId: pulumi.String("string"),
ZoneId: pulumi.String("string"),
ZoneName: pulumi.String("string"),
},
},
ProjectId: pulumi.String("string"),
MongoDbMajorVersion: pulumi.String("string"),
Paused: pulumi.Bool(false),
ConfigServerManagementMode: pulumi.String("string"),
EncryptionAtRestProvider: pulumi.String("string"),
GlobalClusterSelfManagedSharding: pulumi.Bool(false),
Labels: mongodbatlas.AdvancedClusterLabelArray{
&mongodbatlas.AdvancedClusterLabelArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
AcceptDataRisksAndForceReplicaSetReconfig: pulumi.String("string"),
Name: pulumi.String("string"),
BiConnectorConfig: &mongodbatlas.AdvancedClusterBiConnectorConfigArgs{
Enabled: pulumi.Bool(false),
ReadPreference: pulumi.String("string"),
},
PitEnabled: pulumi.Bool(false),
BackupEnabled: pulumi.Bool(false),
RedactClientLogData: pulumi.Bool(false),
ReplicaSetScalingStrategy: pulumi.String("string"),
AdvancedConfiguration: &mongodbatlas.AdvancedClusterAdvancedConfigurationArgs{
ChangeStreamOptionsPreAndPostImagesExpireAfterSeconds: pulumi.Int(0),
DefaultWriteConcern: pulumi.String("string"),
JavascriptEnabled: pulumi.Bool(false),
MinimumEnabledTlsProtocol: pulumi.String("string"),
NoTableScan: pulumi.Bool(false),
OplogMinRetentionHours: pulumi.Float64(0),
OplogSizeMb: pulumi.Int(0),
SampleRefreshIntervalBiConnector: pulumi.Int(0),
SampleSizeBiConnector: pulumi.Int(0),
TransactionLifetimeLimitSeconds: pulumi.Int(0),
},
RetainBackupsEnabled: pulumi.Bool(false),
RootCertType: pulumi.String("string"),
Tags: mongodbatlas.AdvancedClusterTagArray{
&mongodbatlas.AdvancedClusterTagArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
TerminationProtectionEnabled: pulumi.Bool(false),
VersionReleaseSystem: pulumi.String("string"),
})
var advancedClusterResource = new AdvancedCluster("advancedClusterResource", AdvancedClusterArgs.builder()
.clusterType("string")
.replicationSpecs(AdvancedClusterReplicationSpecArgs.builder()
.regionConfigs(AdvancedClusterReplicationSpecRegionConfigArgs.builder()
.priority(0)
.providerName("string")
.regionName("string")
.analyticsAutoScaling(AdvancedClusterReplicationSpecRegionConfigAnalyticsAutoScalingArgs.builder()
.computeEnabled(false)
.computeMaxInstanceSize("string")
.computeMinInstanceSize("string")
.computeScaleDownEnabled(false)
.diskGbEnabled(false)
.build())
.analyticsSpecs(AdvancedClusterReplicationSpecRegionConfigAnalyticsSpecsArgs.builder()
.instanceSize("string")
.diskIops(0)
.diskSizeGb(0)
.ebsVolumeType("string")
.nodeCount(0)
.build())
.autoScaling(AdvancedClusterReplicationSpecRegionConfigAutoScalingArgs.builder()
.computeEnabled(false)
.computeMaxInstanceSize("string")
.computeMinInstanceSize("string")
.computeScaleDownEnabled(false)
.diskGbEnabled(false)
.build())
.backingProviderName("string")
.electableSpecs(AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs.builder()
.instanceSize("string")
.diskIops(0)
.diskSizeGb(0)
.ebsVolumeType("string")
.nodeCount(0)
.build())
.readOnlySpecs(AdvancedClusterReplicationSpecRegionConfigReadOnlySpecsArgs.builder()
.instanceSize("string")
.diskIops(0)
.diskSizeGb(0)
.ebsVolumeType("string")
.nodeCount(0)
.build())
.build())
.containerId(Map.of("string", "string"))
.externalId("string")
.zoneId("string")
.zoneName("string")
.build())
.projectId("string")
.mongoDbMajorVersion("string")
.paused(false)
.configServerManagementMode("string")
.encryptionAtRestProvider("string")
.globalClusterSelfManagedSharding(false)
.labels(AdvancedClusterLabelArgs.builder()
.key("string")
.value("string")
.build())
.acceptDataRisksAndForceReplicaSetReconfig("string")
.name("string")
.biConnectorConfig(AdvancedClusterBiConnectorConfigArgs.builder()
.enabled(false)
.readPreference("string")
.build())
.pitEnabled(false)
.backupEnabled(false)
.redactClientLogData(false)
.replicaSetScalingStrategy("string")
.advancedConfiguration(AdvancedClusterAdvancedConfigurationArgs.builder()
.changeStreamOptionsPreAndPostImagesExpireAfterSeconds(0)
.defaultWriteConcern("string")
.javascriptEnabled(false)
.minimumEnabledTlsProtocol("string")
.noTableScan(false)
.oplogMinRetentionHours(0)
.oplogSizeMb(0)
.sampleRefreshIntervalBiConnector(0)
.sampleSizeBiConnector(0)
.transactionLifetimeLimitSeconds(0)
.build())
.retainBackupsEnabled(false)
.rootCertType("string")
.tags(AdvancedClusterTagArgs.builder()
.key("string")
.value("string")
.build())
.terminationProtectionEnabled(false)
.versionReleaseSystem("string")
.build());
advanced_cluster_resource = mongodbatlas.AdvancedCluster("advancedClusterResource",
cluster_type="string",
replication_specs=[{
"region_configs": [{
"priority": 0,
"provider_name": "string",
"region_name": "string",
"analytics_auto_scaling": {
"compute_enabled": False,
"compute_max_instance_size": "string",
"compute_min_instance_size": "string",
"compute_scale_down_enabled": False,
"disk_gb_enabled": False,
},
"analytics_specs": {
"instance_size": "string",
"disk_iops": 0,
"disk_size_gb": 0,
"ebs_volume_type": "string",
"node_count": 0,
},
"auto_scaling": {
"compute_enabled": False,
"compute_max_instance_size": "string",
"compute_min_instance_size": "string",
"compute_scale_down_enabled": False,
"disk_gb_enabled": False,
},
"backing_provider_name": "string",
"electable_specs": {
"instance_size": "string",
"disk_iops": 0,
"disk_size_gb": 0,
"ebs_volume_type": "string",
"node_count": 0,
},
"read_only_specs": {
"instance_size": "string",
"disk_iops": 0,
"disk_size_gb": 0,
"ebs_volume_type": "string",
"node_count": 0,
},
}],
"container_id": {
"string": "string",
},
"external_id": "string",
"zone_id": "string",
"zone_name": "string",
}],
project_id="string",
mongo_db_major_version="string",
paused=False,
config_server_management_mode="string",
encryption_at_rest_provider="string",
global_cluster_self_managed_sharding=False,
labels=[{
"key": "string",
"value": "string",
}],
accept_data_risks_and_force_replica_set_reconfig="string",
name="string",
bi_connector_config={
"enabled": False,
"read_preference": "string",
},
pit_enabled=False,
backup_enabled=False,
redact_client_log_data=False,
replica_set_scaling_strategy="string",
advanced_configuration={
"change_stream_options_pre_and_post_images_expire_after_seconds": 0,
"default_write_concern": "string",
"javascript_enabled": False,
"minimum_enabled_tls_protocol": "string",
"no_table_scan": False,
"oplog_min_retention_hours": 0,
"oplog_size_mb": 0,
"sample_refresh_interval_bi_connector": 0,
"sample_size_bi_connector": 0,
"transaction_lifetime_limit_seconds": 0,
},
retain_backups_enabled=False,
root_cert_type="string",
tags=[{
"key": "string",
"value": "string",
}],
termination_protection_enabled=False,
version_release_system="string")
const advancedClusterResource = new mongodbatlas.AdvancedCluster("advancedClusterResource", {
clusterType: "string",
replicationSpecs: [{
regionConfigs: [{
priority: 0,
providerName: "string",
regionName: "string",
analyticsAutoScaling: {
computeEnabled: false,
computeMaxInstanceSize: "string",
computeMinInstanceSize: "string",
computeScaleDownEnabled: false,
diskGbEnabled: false,
},
analyticsSpecs: {
instanceSize: "string",
diskIops: 0,
diskSizeGb: 0,
ebsVolumeType: "string",
nodeCount: 0,
},
autoScaling: {
computeEnabled: false,
computeMaxInstanceSize: "string",
computeMinInstanceSize: "string",
computeScaleDownEnabled: false,
diskGbEnabled: false,
},
backingProviderName: "string",
electableSpecs: {
instanceSize: "string",
diskIops: 0,
diskSizeGb: 0,
ebsVolumeType: "string",
nodeCount: 0,
},
readOnlySpecs: {
instanceSize: "string",
diskIops: 0,
diskSizeGb: 0,
ebsVolumeType: "string",
nodeCount: 0,
},
}],
containerId: {
string: "string",
},
externalId: "string",
zoneId: "string",
zoneName: "string",
}],
projectId: "string",
mongoDbMajorVersion: "string",
paused: false,
configServerManagementMode: "string",
encryptionAtRestProvider: "string",
globalClusterSelfManagedSharding: false,
labels: [{
key: "string",
value: "string",
}],
acceptDataRisksAndForceReplicaSetReconfig: "string",
name: "string",
biConnectorConfig: {
enabled: false,
readPreference: "string",
},
pitEnabled: false,
backupEnabled: false,
redactClientLogData: false,
replicaSetScalingStrategy: "string",
advancedConfiguration: {
changeStreamOptionsPreAndPostImagesExpireAfterSeconds: 0,
defaultWriteConcern: "string",
javascriptEnabled: false,
minimumEnabledTlsProtocol: "string",
noTableScan: false,
oplogMinRetentionHours: 0,
oplogSizeMb: 0,
sampleRefreshIntervalBiConnector: 0,
sampleSizeBiConnector: 0,
transactionLifetimeLimitSeconds: 0,
},
retainBackupsEnabled: false,
rootCertType: "string",
tags: [{
key: "string",
value: "string",
}],
terminationProtectionEnabled: false,
versionReleaseSystem: "string",
});
type: mongodbatlas:AdvancedCluster
properties:
acceptDataRisksAndForceReplicaSetReconfig: string
advancedConfiguration:
changeStreamOptionsPreAndPostImagesExpireAfterSeconds: 0
defaultWriteConcern: string
javascriptEnabled: false
minimumEnabledTlsProtocol: string
noTableScan: false
oplogMinRetentionHours: 0
oplogSizeMb: 0
sampleRefreshIntervalBiConnector: 0
sampleSizeBiConnector: 0
transactionLifetimeLimitSeconds: 0
backupEnabled: false
biConnectorConfig:
enabled: false
readPreference: string
clusterType: string
configServerManagementMode: string
encryptionAtRestProvider: string
globalClusterSelfManagedSharding: false
labels:
- key: string
value: string
mongoDbMajorVersion: string
name: string
paused: false
pitEnabled: false
projectId: string
redactClientLogData: false
replicaSetScalingStrategy: string
replicationSpecs:
- containerId:
string: string
externalId: string
regionConfigs:
- analyticsAutoScaling:
computeEnabled: false
computeMaxInstanceSize: string
computeMinInstanceSize: string
computeScaleDownEnabled: false
diskGbEnabled: false
analyticsSpecs:
diskIops: 0
diskSizeGb: 0
ebsVolumeType: string
instanceSize: string
nodeCount: 0
autoScaling:
computeEnabled: false
computeMaxInstanceSize: string
computeMinInstanceSize: string
computeScaleDownEnabled: false
diskGbEnabled: false
backingProviderName: string
electableSpecs:
diskIops: 0
diskSizeGb: 0
ebsVolumeType: string
instanceSize: string
nodeCount: 0
priority: 0
providerName: string
readOnlySpecs:
diskIops: 0
diskSizeGb: 0
ebsVolumeType: string
instanceSize: string
nodeCount: 0
regionName: string
zoneId: string
zoneName: string
retainBackupsEnabled: false
rootCertType: string
tags:
- key: string
value: string
terminationProtectionEnabled: false
versionReleaseSystem: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The AdvancedCluster resource accepts the following input properties:
- Cluster
Type string - Type of the cluster that you want to create.
Accepted values include:
REPLICASETReplica setSHARDEDSharded clusterGEOSHARDEDGlobal Cluster
- Project
Id string - Unique ID for the project to create the database user.
- Replication
Specs List<AdvancedCluster Replication Spec> - List of settings that configure your cluster regions. This attribute has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. If for each replication_spec
num_shardsis configured with a value greater than 1 (using deprecated sharding configurations), then each object represents a zone with one or more shards. See below - Accept
Data stringRisks And Force Replica Set Reconfig - If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set
accept_data_risks_and_force_replica_set_reconfigto the current date. Learn more about Reconfiguring a Replica Set during a regional outage here. - Advanced
Configuration AdvancedCluster Advanced Configuration - Backup
Enabled bool Flag that indicates whether the cluster can perform backups. If
true, the cluster can perform backups. You must set this value totruefor NVMe clusters.Backup uses: Cloud Backups for dedicated clusters. Shared Cluster Backups for tenant clusters. If "
backup_enabled" :false, the cluster doesn't use Atlas backups.This parameter defaults to false.
- Bi
Connector AdvancedConfig Cluster Bi Connector Config - 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.
- Config
Server stringManagement Mode - Config Server Management Mode for creating or updating a sharded cluster. Valid values are
ATLAS_MANAGED(default) andFIXED_TO_DEDICATED. When configured asATLAS_MANAGED, Atlas may automatically switch the cluster's config server type for optimal performance and savings. When configured asFIXED_TO_DEDICATED, the cluster will always use a dedicated config server. To learn more, see the Sharded Cluster Config Servers documentation. - Disk
Size doubleGb - Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (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. (DEPRECATED) Use
replication_specs.#.region_config.#.(analytics_specs|electable_specs|read_only_specs).disk_size_gbinstead. To learn more, see the 1.18.0 upgrade guide. - Encryption
At stringRest Provider - 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_sizeis M10 or greater andbackup_enabledis false or omitted. - Global
Cluster boolSelf Managed Sharding - Flag that indicates if cluster uses Atlas-Managed Sharding (false, default) or Self-Managed Sharding (true). It can only be enabled for Global Clusters (
GEOSHARDED). It cannot be changed once the cluster is created. Use this mode if you're an advanced user and the default configuration is too restrictive for your workload. If you select this option, you must manually configure the sharding strategy, more info here. - Labels
List<Advanced
Cluster Label> - Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. DEPRECATED Use
tagsinstead. - Mongo
Db stringMajor Version - Version of the cluster to deploy. Atlas supports all the MongoDB versions that have not reached End of Live for M10+ clusters. If omitted, Atlas deploys the cluster with the default version. For more details, see documentation. 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_systemCONTINUOUS, the resource returns an error. Either clear this parameter or setversion_release_system:LTS. - Name string
- Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed. WARNING Changing the name will result in destruction of the existing cluster and the creation of a new cluster.
- Paused bool
- Pit
Enabled bool - Flag that indicates if the cluster uses Continuous Cloud Backup.
- Redact
Client boolLog Data - Flag that enables or disables log redaction, see the manual for more info. Use this in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements. Note: Changing this setting on a cluster will trigger a rolling restart as soon as the cluster is updated.
- Replica
Set stringScaling Strategy - Replica set scaling mode for your cluster. Valid values are
WORKLOAD_TYPE,SEQUENTIALandNODE_TYPE. By default, Atlas scales underWORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. When configured asSEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. When configured asNODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. Modify the Replica Set Scaling Mode - Retain
Backups boolEnabled - Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster
- Root
Cert stringType - Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).
-
List<Advanced
Cluster Tag> - Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
- Termination
Protection boolEnabled - Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
- Version
Release stringSystem - Release cadence that Atlas uses for this cluster. This parameter defaults to
LTS. If you set this field toCONTINUOUS, you must omit themongo_db_major_versionfield. 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 string - Type of the cluster that you want to create.
Accepted values include:
REPLICASETReplica setSHARDEDSharded clusterGEOSHARDEDGlobal Cluster
- Project
Id string - Unique ID for the project to create the database user.
- Replication
Specs []AdvancedCluster Replication Spec Args - List of settings that configure your cluster regions. This attribute has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. If for each replication_spec
num_shardsis configured with a value greater than 1 (using deprecated sharding configurations), then each object represents a zone with one or more shards. See below - Accept
Data stringRisks And Force Replica Set Reconfig - If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set
accept_data_risks_and_force_replica_set_reconfigto the current date. Learn more about Reconfiguring a Replica Set during a regional outage here. - Advanced
Configuration AdvancedCluster Advanced Configuration Args - Backup
Enabled bool Flag that indicates whether the cluster can perform backups. If
true, the cluster can perform backups. You must set this value totruefor NVMe clusters.Backup uses: Cloud Backups for dedicated clusters. Shared Cluster Backups for tenant clusters. If "
backup_enabled" :false, the cluster doesn't use Atlas backups.This parameter defaults to false.
- Bi
Connector AdvancedConfig Cluster Bi Connector Config Args - 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.
- Config
Server stringManagement Mode - Config Server Management Mode for creating or updating a sharded cluster. Valid values are
ATLAS_MANAGED(default) andFIXED_TO_DEDICATED. When configured asATLAS_MANAGED, Atlas may automatically switch the cluster's config server type for optimal performance and savings. When configured asFIXED_TO_DEDICATED, the cluster will always use a dedicated config server. To learn more, see the Sharded Cluster Config Servers documentation. - Disk
Size float64Gb - Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (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. (DEPRECATED) Use
replication_specs.#.region_config.#.(analytics_specs|electable_specs|read_only_specs).disk_size_gbinstead. To learn more, see the 1.18.0 upgrade guide. - Encryption
At stringRest Provider - 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_sizeis M10 or greater andbackup_enabledis false or omitted. - Global
Cluster boolSelf Managed Sharding - Flag that indicates if cluster uses Atlas-Managed Sharding (false, default) or Self-Managed Sharding (true). It can only be enabled for Global Clusters (
GEOSHARDED). It cannot be changed once the cluster is created. Use this mode if you're an advanced user and the default configuration is too restrictive for your workload. If you select this option, you must manually configure the sharding strategy, more info here. - Labels
[]Advanced
Cluster Label Args - Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. DEPRECATED Use
tagsinstead. - Mongo
Db stringMajor Version - Version of the cluster to deploy. Atlas supports all the MongoDB versions that have not reached End of Live for M10+ clusters. If omitted, Atlas deploys the cluster with the default version. For more details, see documentation. 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_systemCONTINUOUS, the resource returns an error. Either clear this parameter or setversion_release_system:LTS. - Name string
- Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed. WARNING Changing the name will result in destruction of the existing cluster and the creation of a new cluster.
- Paused bool
- Pit
Enabled bool - Flag that indicates if the cluster uses Continuous Cloud Backup.
- Redact
Client boolLog Data - Flag that enables or disables log redaction, see the manual for more info. Use this in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements. Note: Changing this setting on a cluster will trigger a rolling restart as soon as the cluster is updated.
- Replica
Set stringScaling Strategy - Replica set scaling mode for your cluster. Valid values are
WORKLOAD_TYPE,SEQUENTIALandNODE_TYPE. By default, Atlas scales underWORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. When configured asSEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. When configured asNODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. Modify the Replica Set Scaling Mode - Retain
Backups boolEnabled - Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster
- Root
Cert stringType - Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).
-
[]Advanced
Cluster Tag Args - Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
- Termination
Protection boolEnabled - Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
- Version
Release stringSystem - Release cadence that Atlas uses for this cluster. This parameter defaults to
LTS. If you set this field toCONTINUOUS, you must omit themongo_db_major_versionfield. 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 String - Type of the cluster that you want to create.
Accepted values include:
REPLICASETReplica setSHARDEDSharded clusterGEOSHARDEDGlobal Cluster
- project
Id String - Unique ID for the project to create the database user.
- replication
Specs List<AdvancedCluster Replication Spec> - List of settings that configure your cluster regions. This attribute has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. If for each replication_spec
num_shardsis configured with a value greater than 1 (using deprecated sharding configurations), then each object represents a zone with one or more shards. See below - accept
Data StringRisks And Force Replica Set Reconfig - If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set
accept_data_risks_and_force_replica_set_reconfigto the current date. Learn more about Reconfiguring a Replica Set during a regional outage here. - advanced
Configuration AdvancedCluster Advanced Configuration - backup
Enabled Boolean Flag that indicates whether the cluster can perform backups. If
true, the cluster can perform backups. You must set this value totruefor NVMe clusters.Backup uses: Cloud Backups for dedicated clusters. Shared Cluster Backups for tenant clusters. If "
backup_enabled" :false, the cluster doesn't use Atlas backups.This parameter defaults to false.
- bi
Connector AdvancedConfig Cluster Bi Connector Config - 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.
- config
Server StringManagement Mode - Config Server Management Mode for creating or updating a sharded cluster. Valid values are
ATLAS_MANAGED(default) andFIXED_TO_DEDICATED. When configured asATLAS_MANAGED, Atlas may automatically switch the cluster's config server type for optimal performance and savings. When configured asFIXED_TO_DEDICATED, the cluster will always use a dedicated config server. To learn more, see the Sharded Cluster Config Servers documentation. - disk
Size DoubleGb - Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (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. (DEPRECATED) Use
replication_specs.#.region_config.#.(analytics_specs|electable_specs|read_only_specs).disk_size_gbinstead. To learn more, see the 1.18.0 upgrade guide. - encryption
At StringRest Provider - 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_sizeis M10 or greater andbackup_enabledis false or omitted. - global
Cluster BooleanSelf Managed Sharding - Flag that indicates if cluster uses Atlas-Managed Sharding (false, default) or Self-Managed Sharding (true). It can only be enabled for Global Clusters (
GEOSHARDED). It cannot be changed once the cluster is created. Use this mode if you're an advanced user and the default configuration is too restrictive for your workload. If you select this option, you must manually configure the sharding strategy, more info here. - labels
List<Advanced
Cluster Label> - Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. DEPRECATED Use
tagsinstead. - mongo
Db StringMajor Version - Version of the cluster to deploy. Atlas supports all the MongoDB versions that have not reached End of Live for M10+ clusters. If omitted, Atlas deploys the cluster with the default version. For more details, see documentation. 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_systemCONTINUOUS, the resource returns an error. Either clear this parameter or setversion_release_system:LTS. - name String
- Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed. WARNING Changing the name will result in destruction of the existing cluster and the creation of a new cluster.
- paused Boolean
- pit
Enabled Boolean - Flag that indicates if the cluster uses Continuous Cloud Backup.
- redact
Client BooleanLog Data - Flag that enables or disables log redaction, see the manual for more info. Use this in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements. Note: Changing this setting on a cluster will trigger a rolling restart as soon as the cluster is updated.
- replica
Set StringScaling Strategy - Replica set scaling mode for your cluster. Valid values are
WORKLOAD_TYPE,SEQUENTIALandNODE_TYPE. By default, Atlas scales underWORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. When configured asSEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. When configured asNODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. Modify the Replica Set Scaling Mode - retain
Backups BooleanEnabled - Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster
- root
Cert StringType - Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).
-
List<Advanced
Cluster Tag> - Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
- termination
Protection BooleanEnabled - Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
- version
Release StringSystem - Release cadence that Atlas uses for this cluster. This parameter defaults to
LTS. If you set this field toCONTINUOUS, you must omit themongo_db_major_versionfield. 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 string - Type of the cluster that you want to create.
Accepted values include:
REPLICASETReplica setSHARDEDSharded clusterGEOSHARDEDGlobal Cluster
- project
Id string - Unique ID for the project to create the database user.
- replication
Specs AdvancedCluster Replication Spec[] - List of settings that configure your cluster regions. This attribute has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. If for each replication_spec
num_shardsis configured with a value greater than 1 (using deprecated sharding configurations), then each object represents a zone with one or more shards. See below - accept
Data stringRisks And Force Replica Set Reconfig - If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set
accept_data_risks_and_force_replica_set_reconfigto the current date. Learn more about Reconfiguring a Replica Set during a regional outage here. - advanced
Configuration AdvancedCluster Advanced Configuration - backup
Enabled boolean Flag that indicates whether the cluster can perform backups. If
true, the cluster can perform backups. You must set this value totruefor NVMe clusters.Backup uses: Cloud Backups for dedicated clusters. Shared Cluster Backups for tenant clusters. If "
backup_enabled" :false, the cluster doesn't use Atlas backups.This parameter defaults to false.
- bi
Connector AdvancedConfig Cluster Bi Connector Config - 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.
- config
Server stringManagement Mode - Config Server Management Mode for creating or updating a sharded cluster. Valid values are
ATLAS_MANAGED(default) andFIXED_TO_DEDICATED. When configured asATLAS_MANAGED, Atlas may automatically switch the cluster's config server type for optimal performance and savings. When configured asFIXED_TO_DEDICATED, the cluster will always use a dedicated config server. To learn more, see the Sharded Cluster Config Servers documentation. - disk
Size numberGb - Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (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. (DEPRECATED) Use
replication_specs.#.region_config.#.(analytics_specs|electable_specs|read_only_specs).disk_size_gbinstead. To learn more, see the 1.18.0 upgrade guide. - encryption
At stringRest Provider - 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_sizeis M10 or greater andbackup_enabledis false or omitted. - global
Cluster booleanSelf Managed Sharding - Flag that indicates if cluster uses Atlas-Managed Sharding (false, default) or Self-Managed Sharding (true). It can only be enabled for Global Clusters (
GEOSHARDED). It cannot be changed once the cluster is created. Use this mode if you're an advanced user and the default configuration is too restrictive for your workload. If you select this option, you must manually configure the sharding strategy, more info here. - labels
Advanced
Cluster Label[] - Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. DEPRECATED Use
tagsinstead. - mongo
Db stringMajor Version - Version of the cluster to deploy. Atlas supports all the MongoDB versions that have not reached End of Live for M10+ clusters. If omitted, Atlas deploys the cluster with the default version. For more details, see documentation. 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_systemCONTINUOUS, the resource returns an error. Either clear this parameter or setversion_release_system:LTS. - name string
- Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed. WARNING Changing the name will result in destruction of the existing cluster and the creation of a new cluster.
- paused boolean
- pit
Enabled boolean - Flag that indicates if the cluster uses Continuous Cloud Backup.
- redact
Client booleanLog Data - Flag that enables or disables log redaction, see the manual for more info. Use this in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements. Note: Changing this setting on a cluster will trigger a rolling restart as soon as the cluster is updated.
- replica
Set stringScaling Strategy - Replica set scaling mode for your cluster. Valid values are
WORKLOAD_TYPE,SEQUENTIALandNODE_TYPE. By default, Atlas scales underWORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. When configured asSEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. When configured asNODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. Modify the Replica Set Scaling Mode - retain
Backups booleanEnabled - Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster
- root
Cert stringType - Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).
-
Advanced
Cluster Tag[] - Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
- termination
Protection booleanEnabled - Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
- version
Release stringSystem - Release cadence that Atlas uses for this cluster. This parameter defaults to
LTS. If you set this field toCONTINUOUS, you must omit themongo_db_major_versionfield. 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:
REPLICASETReplica setSHARDEDSharded clusterGEOSHARDEDGlobal Cluster
- project_
id str - Unique ID for the project to create the database user.
- replication_
specs Sequence[AdvancedCluster Replication Spec Args] - List of settings that configure your cluster regions. This attribute has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. If for each replication_spec
num_shardsis configured with a value greater than 1 (using deprecated sharding configurations), then each object represents a zone with one or more shards. See below - accept_
data_ strrisks_ and_ force_ replica_ set_ reconfig - If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set
accept_data_risks_and_force_replica_set_reconfigto the current date. Learn more about Reconfiguring a Replica Set during a regional outage here. - advanced_
configuration AdvancedCluster Advanced Configuration Args - backup_
enabled bool Flag that indicates whether the cluster can perform backups. If
true, the cluster can perform backups. You must set this value totruefor NVMe clusters.Backup uses: Cloud Backups for dedicated clusters. Shared Cluster Backups for tenant clusters. If "
backup_enabled" :false, the cluster doesn't use Atlas backups.This parameter defaults to false.
- bi_
connector_ Advancedconfig Cluster Bi Connector Config Args - 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.
- config_
server_ strmanagement_ mode - Config Server Management Mode for creating or updating a sharded cluster. Valid values are
ATLAS_MANAGED(default) andFIXED_TO_DEDICATED. When configured asATLAS_MANAGED, Atlas may automatically switch the cluster's config server type for optimal performance and savings. When configured asFIXED_TO_DEDICATED, the cluster will always use a dedicated config server. To learn more, see the Sharded Cluster Config Servers documentation. - disk_
size_ floatgb - Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (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. (DEPRECATED) Use
replication_specs.#.region_config.#.(analytics_specs|electable_specs|read_only_specs).disk_size_gbinstead. To learn more, see the 1.18.0 upgrade guide. - encryption_
at_ strrest_ provider - 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_sizeis M10 or greater andbackup_enabledis false or omitted. - global_
cluster_ boolself_ managed_ sharding - Flag that indicates if cluster uses Atlas-Managed Sharding (false, default) or Self-Managed Sharding (true). It can only be enabled for Global Clusters (
GEOSHARDED). It cannot be changed once the cluster is created. Use this mode if you're an advanced user and the default configuration is too restrictive for your workload. If you select this option, you must manually configure the sharding strategy, more info here. - labels
Sequence[Advanced
Cluster Label Args] - Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. DEPRECATED Use
tagsinstead. - mongo_
db_ strmajor_ version - Version of the cluster to deploy. Atlas supports all the MongoDB versions that have not reached End of Live for M10+ clusters. If omitted, Atlas deploys the cluster with the default version. For more details, see documentation. 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_systemCONTINUOUS, the resource returns an error. Either clear this parameter or setversion_release_system:LTS. - name str
- Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed. WARNING Changing the name will result in destruction of the existing cluster and the creation of a new cluster.
- paused bool
- pit_
enabled bool - Flag that indicates if the cluster uses Continuous Cloud Backup.
- redact_
client_ boollog_ data - Flag that enables or disables log redaction, see the manual for more info. Use this in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements. Note: Changing this setting on a cluster will trigger a rolling restart as soon as the cluster is updated.
- replica_
set_ strscaling_ strategy - Replica set scaling mode for your cluster. Valid values are
WORKLOAD_TYPE,SEQUENTIALandNODE_TYPE. By default, Atlas scales underWORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. When configured asSEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. When configured asNODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. Modify the Replica Set Scaling Mode - retain_
backups_ boolenabled - Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster
- root_
cert_ strtype - Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).
-
Sequence[Advanced
Cluster Tag Args] - Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
- termination_
protection_ boolenabled - Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
- version_
release_ strsystem - Release cadence that Atlas uses for this cluster. This parameter defaults to
LTS. If you set this field toCONTINUOUS, you must omit themongo_db_major_versionfield. 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 String - Type of the cluster that you want to create.
Accepted values include:
REPLICASETReplica setSHARDEDSharded clusterGEOSHARDEDGlobal Cluster
- project
Id String - Unique ID for the project to create the database user.
- replication
Specs List<Property Map> - List of settings that configure your cluster regions. This attribute has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. If for each replication_spec
num_shardsis configured with a value greater than 1 (using deprecated sharding configurations), then each object represents a zone with one or more shards. See below - accept
Data StringRisks And Force Replica Set Reconfig - If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set
accept_data_risks_and_force_replica_set_reconfigto the current date. Learn more about Reconfiguring a Replica Set during a regional outage here. - advanced
Configuration Property Map - backup
Enabled Boolean Flag that indicates whether the cluster can perform backups. If
true, the cluster can perform backups. You must set this value totruefor NVMe clusters.Backup uses: Cloud Backups for dedicated clusters. Shared Cluster Backups for tenant clusters. If "
backup_enabled" :false, the cluster doesn't use Atlas backups.This parameter defaults to false.
- bi
Connector Property MapConfig - 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.
- config
Server StringManagement Mode - Config Server Management Mode for creating or updating a sharded cluster. Valid values are
ATLAS_MANAGED(default) andFIXED_TO_DEDICATED. When configured asATLAS_MANAGED, Atlas may automatically switch the cluster's config server type for optimal performance and savings. When configured asFIXED_TO_DEDICATED, the cluster will always use a dedicated config server. To learn more, see the Sharded Cluster Config Servers documentation. - disk
Size NumberGb - Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (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. (DEPRECATED) Use
replication_specs.#.region_config.#.(analytics_specs|electable_specs|read_only_specs).disk_size_gbinstead. To learn more, see the 1.18.0 upgrade guide. - encryption
At StringRest Provider - 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_sizeis M10 or greater andbackup_enabledis false or omitted. - global
Cluster BooleanSelf Managed Sharding - Flag that indicates if cluster uses Atlas-Managed Sharding (false, default) or Self-Managed Sharding (true). It can only be enabled for Global Clusters (
GEOSHARDED). It cannot be changed once the cluster is created. Use this mode if you're an advanced user and the default configuration is too restrictive for your workload. If you select this option, you must manually configure the sharding strategy, more info here. - labels List<Property Map>
- Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. DEPRECATED Use
tagsinstead. - mongo
Db StringMajor Version - Version of the cluster to deploy. Atlas supports all the MongoDB versions that have not reached End of Live for M10+ clusters. If omitted, Atlas deploys the cluster with the default version. For more details, see documentation. 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_systemCONTINUOUS, the resource returns an error. Either clear this parameter or setversion_release_system:LTS. - name String
- Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed. WARNING Changing the name will result in destruction of the existing cluster and the creation of a new cluster.
- paused Boolean
- pit
Enabled Boolean - Flag that indicates if the cluster uses Continuous Cloud Backup.
- redact
Client BooleanLog Data - Flag that enables or disables log redaction, see the manual for more info. Use this in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements. Note: Changing this setting on a cluster will trigger a rolling restart as soon as the cluster is updated.
- replica
Set StringScaling Strategy - Replica set scaling mode for your cluster. Valid values are
WORKLOAD_TYPE,SEQUENTIALandNODE_TYPE. By default, Atlas scales underWORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. When configured asSEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. When configured asNODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. Modify the Replica Set Scaling Mode - retain
Backups BooleanEnabled - Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster
- root
Cert StringType - Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).
- List<Property Map>
- Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
- termination
Protection BooleanEnabled - Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
- version
Release StringSystem - Release cadence that Atlas uses for this cluster. This parameter defaults to
LTS. If you set this field toCONTINUOUS, you must omit themongo_db_major_versionfield. 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:
- Cluster
Id string - The cluster ID.
- Config
Server stringType - Describes a sharded cluster's config server type. Valid values are
DEDICATEDandEMBEDDED. To learn more, see the Sharded Cluster Config Servers documentation. - Connection
Strings List<AdvancedCluster Connection String> - 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 string - Id string
- The provider-assigned unique ID for this managed resource.
- Mongo
Db stringVersion - Version of MongoDB the cluster runs, in
major-version.minor-versionformat. - State
Name string - Current state of the cluster. The possible states are:
- IDLE
- CREATING
- UPDATING
- DELETING
- DELETED
- REPAIRING
replication_specs.#.container_id- A key-value map of the Network Peering Container ID(s) for the configuration specified inregion_configs. The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is"providerName:regionName" = "containerId". ExampleAWS:US_EAST_1" = "61e0797dde08fb498ca11a71.
- Cluster
Id string - The cluster ID.
- Config
Server stringType - Describes a sharded cluster's config server type. Valid values are
DEDICATEDandEMBEDDED. To learn more, see the Sharded Cluster Config Servers documentation. - Connection
Strings []AdvancedCluster Connection String - 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 string - Id string
- The provider-assigned unique ID for this managed resource.
- Mongo
Db stringVersion - Version of MongoDB the cluster runs, in
major-version.minor-versionformat. - State
Name string - Current state of the cluster. The possible states are:
- IDLE
- CREATING
- UPDATING
- DELETING
- DELETED
- REPAIRING
replication_specs.#.container_id- A key-value map of the Network Peering Container ID(s) for the configuration specified inregion_configs. The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is"providerName:regionName" = "containerId". ExampleAWS:US_EAST_1" = "61e0797dde08fb498ca11a71.
- cluster
Id String - The cluster ID.
- config
Server StringType - Describes a sharded cluster's config server type. Valid values are
DEDICATEDandEMBEDDED. To learn more, see the Sharded Cluster Config Servers documentation. - connection
Strings List<AdvancedCluster Connection String> - 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 String - id String
- The provider-assigned unique ID for this managed resource.
- mongo
Db StringVersion - Version of MongoDB the cluster runs, in
major-version.minor-versionformat. - state
Name String - Current state of the cluster. The possible states are:
- IDLE
- CREATING
- UPDATING
- DELETING
- DELETED
- REPAIRING
replication_specs.#.container_id- A key-value map of the Network Peering Container ID(s) for the configuration specified inregion_configs. The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is"providerName:regionName" = "containerId". ExampleAWS:US_EAST_1" = "61e0797dde08fb498ca11a71.
- cluster
Id string - The cluster ID.
- config
Server stringType - Describes a sharded cluster's config server type. Valid values are
DEDICATEDandEMBEDDED. To learn more, see the Sharded Cluster Config Servers documentation. - connection
Strings AdvancedCluster Connection String[] - 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 string - id string
- The provider-assigned unique ID for this managed resource.
- mongo
Db stringVersion - Version of MongoDB the cluster runs, in
major-version.minor-versionformat. - state
Name string - Current state of the cluster. The possible states are:
- IDLE
- CREATING
- UPDATING
- DELETING
- DELETED
- REPAIRING
replication_specs.#.container_id- A key-value map of the Network Peering Container ID(s) for the configuration specified inregion_configs. The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is"providerName:regionName" = "containerId". ExampleAWS:US_EAST_1" = "61e0797dde08fb498ca11a71.
- cluster_
id str - The cluster ID.
- config_
server_ strtype - Describes a sharded cluster's config server type. Valid values are
DEDICATEDandEMBEDDED. To learn more, see the Sharded Cluster Config Servers documentation. - connection_
strings Sequence[AdvancedCluster Connection String] - 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_ strversion - Version of MongoDB the cluster runs, in
major-version.minor-versionformat. - state_
name str - Current state of the cluster. The possible states are:
- IDLE
- CREATING
- UPDATING
- DELETING
- DELETED
- REPAIRING
replication_specs.#.container_id- A key-value map of the Network Peering Container ID(s) for the configuration specified inregion_configs. The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is"providerName:regionName" = "containerId". ExampleAWS:US_EAST_1" = "61e0797dde08fb498ca11a71.
- cluster
Id String - The cluster ID.
- config
Server StringType - Describes a sharded cluster's config server type. Valid values are
DEDICATEDandEMBEDDED. To learn more, see the Sharded Cluster Config Servers documentation. - connection
Strings 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.
- create
Date String - id String
- The provider-assigned unique ID for this managed resource.
- mongo
Db StringVersion - Version of MongoDB the cluster runs, in
major-version.minor-versionformat. - state
Name String - Current state of the cluster. The possible states are:
- IDLE
- CREATING
- UPDATING
- DELETING
- DELETED
- REPAIRING
replication_specs.#.container_id- A key-value map of the Network Peering Container ID(s) for the configuration specified inregion_configs. The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is"providerName:regionName" = "containerId". ExampleAWS:US_EAST_1" = "61e0797dde08fb498ca11a71.
Look up 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,
accept_data_risks_and_force_replica_set_reconfig: Optional[str] = None,
advanced_configuration: Optional[AdvancedClusterAdvancedConfigurationArgs] = None,
backup_enabled: Optional[bool] = None,
bi_connector_config: Optional[AdvancedClusterBiConnectorConfigArgs] = None,
cluster_id: Optional[str] = None,
cluster_type: Optional[str] = None,
config_server_management_mode: Optional[str] = None,
config_server_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,
global_cluster_self_managed_sharding: Optional[bool] = 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,
redact_client_log_data: Optional[bool] = None,
replica_set_scaling_strategy: Optional[str] = None,
replication_specs: Optional[Sequence[AdvancedClusterReplicationSpecArgs]] = None,
retain_backups_enabled: Optional[bool] = None,
root_cert_type: Optional[str] = None,
state_name: Optional[str] = None,
tags: Optional[Sequence[AdvancedClusterTagArgs]] = None,
termination_protection_enabled: Optional[bool] = None,
version_release_system: Optional[str] = None) -> AdvancedClusterfunc 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.
- Accept
Data stringRisks And Force Replica Set Reconfig - If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set
accept_data_risks_and_force_replica_set_reconfigto the current date. Learn more about Reconfiguring a Replica Set during a regional outage here. - Advanced
Configuration AdvancedCluster Advanced Configuration - Backup
Enabled bool Flag that indicates whether the cluster can perform backups. If
true, the cluster can perform backups. You must set this value totruefor NVMe clusters.Backup uses: Cloud Backups for dedicated clusters. Shared Cluster Backups for tenant clusters. If "
backup_enabled" :false, the cluster doesn't use Atlas backups.This parameter defaults to false.
- Bi
Connector AdvancedConfig Cluster Bi Connector Config - 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 string - The cluster ID.
- Cluster
Type string - Type of the cluster that you want to create.
Accepted values include:
REPLICASETReplica setSHARDEDSharded clusterGEOSHARDEDGlobal Cluster
- Config
Server stringManagement Mode - Config Server Management Mode for creating or updating a sharded cluster. Valid values are
ATLAS_MANAGED(default) andFIXED_TO_DEDICATED. When configured asATLAS_MANAGED, Atlas may automatically switch the cluster's config server type for optimal performance and savings. When configured asFIXED_TO_DEDICATED, the cluster will always use a dedicated config server. To learn more, see the Sharded Cluster Config Servers documentation. - Config
Server stringType - Describes a sharded cluster's config server type. Valid values are
DEDICATEDandEMBEDDED. To learn more, see the Sharded Cluster Config Servers documentation. - Connection
Strings List<AdvancedCluster Connection String> - 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 string - Disk
Size doubleGb - Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (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. (DEPRECATED) Use
replication_specs.#.region_config.#.(analytics_specs|electable_specs|read_only_specs).disk_size_gbinstead. To learn more, see the 1.18.0 upgrade guide. - Encryption
At stringRest Provider - 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_sizeis M10 or greater andbackup_enabledis false or omitted. - Global
Cluster boolSelf Managed Sharding - Flag that indicates if cluster uses Atlas-Managed Sharding (false, default) or Self-Managed Sharding (true). It can only be enabled for Global Clusters (
GEOSHARDED). It cannot be changed once the cluster is created. Use this mode if you're an advanced user and the default configuration is too restrictive for your workload. If you select this option, you must manually configure the sharding strategy, more info here. - Labels
List<Advanced
Cluster Label> - Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. DEPRECATED Use
tagsinstead. - Mongo
Db stringMajor Version - Version of the cluster to deploy. Atlas supports all the MongoDB versions that have not reached End of Live for M10+ clusters. If omitted, Atlas deploys the cluster with the default version. For more details, see documentation. 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_systemCONTINUOUS, the resource returns an error. Either clear this parameter or setversion_release_system:LTS. - Mongo
Db stringVersion - Version of MongoDB the cluster runs, in
major-version.minor-versionformat. - Name string
- Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed. WARNING Changing the name will result in destruction of the existing cluster and the creation of a new cluster.
- Paused bool
- Pit
Enabled bool - Flag that indicates if the cluster uses Continuous Cloud Backup.
- Project
Id string - Unique ID for the project to create the database user.
- Redact
Client boolLog Data - Flag that enables or disables log redaction, see the manual for more info. Use this in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements. Note: Changing this setting on a cluster will trigger a rolling restart as soon as the cluster is updated.
- Replica
Set stringScaling Strategy - Replica set scaling mode for your cluster. Valid values are
WORKLOAD_TYPE,SEQUENTIALandNODE_TYPE. By default, Atlas scales underWORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. When configured asSEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. When configured asNODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. Modify the Replica Set Scaling Mode - Replication
Specs List<AdvancedCluster Replication Spec> - List of settings that configure your cluster regions. This attribute has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. If for each replication_spec
num_shardsis configured with a value greater than 1 (using deprecated sharding configurations), then each object represents a zone with one or more shards. See below - Retain
Backups boolEnabled - Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster
- Root
Cert stringType - Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).
- State
Name string - Current state of the cluster. The possible states are:
- IDLE
- CREATING
- UPDATING
- DELETING
- DELETED
- REPAIRING
replication_specs.#.container_id- A key-value map of the Network Peering Container ID(s) for the configuration specified inregion_configs. The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is"providerName:regionName" = "containerId". ExampleAWS:US_EAST_1" = "61e0797dde08fb498ca11a71.
-
List<Advanced
Cluster Tag> - Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
- Termination
Protection boolEnabled - Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
- Version
Release stringSystem - Release cadence that Atlas uses for this cluster. This parameter defaults to
LTS. If you set this field toCONTINUOUS, you must omit themongo_db_major_versionfield. 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.
- Accept
Data stringRisks And Force Replica Set Reconfig - If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set
accept_data_risks_and_force_replica_set_reconfigto the current date. Learn more about Reconfiguring a Replica Set during a regional outage here. - Advanced
Configuration AdvancedCluster Advanced Configuration Args - Backup
Enabled bool Flag that indicates whether the cluster can perform backups. If
true, the cluster can perform backups. You must set this value totruefor NVMe clusters.Backup uses: Cloud Backups for dedicated clusters. Shared Cluster Backups for tenant clusters. If "
backup_enabled" :false, the cluster doesn't use Atlas backups.This parameter defaults to false.
- Bi
Connector AdvancedConfig Cluster Bi Connector Config Args - 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 string - The cluster ID.
- Cluster
Type string - Type of the cluster that you want to create.
Accepted values include:
REPLICASETReplica setSHARDEDSharded clusterGEOSHARDEDGlobal Cluster
- Config
Server stringManagement Mode - Config Server Management Mode for creating or updating a sharded cluster. Valid values are
ATLAS_MANAGED(default) andFIXED_TO_DEDICATED. When configured asATLAS_MANAGED, Atlas may automatically switch the cluster's config server type for optimal performance and savings. When configured asFIXED_TO_DEDICATED, the cluster will always use a dedicated config server. To learn more, see the Sharded Cluster Config Servers documentation. - Config
Server stringType - Describes a sharded cluster's config server type. Valid values are
DEDICATEDandEMBEDDED. To learn more, see the Sharded Cluster Config Servers documentation. - Connection
Strings []AdvancedCluster Connection String Args - 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 string - Disk
Size float64Gb - Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (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. (DEPRECATED) Use
replication_specs.#.region_config.#.(analytics_specs|electable_specs|read_only_specs).disk_size_gbinstead. To learn more, see the 1.18.0 upgrade guide. - Encryption
At stringRest Provider - 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_sizeis M10 or greater andbackup_enabledis false or omitted. - Global
Cluster boolSelf Managed Sharding - Flag that indicates if cluster uses Atlas-Managed Sharding (false, default) or Self-Managed Sharding (true). It can only be enabled for Global Clusters (
GEOSHARDED). It cannot be changed once the cluster is created. Use this mode if you're an advanced user and the default configuration is too restrictive for your workload. If you select this option, you must manually configure the sharding strategy, more info here. - Labels
[]Advanced
Cluster Label Args - Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. DEPRECATED Use
tagsinstead. - Mongo
Db stringMajor Version - Version of the cluster to deploy. Atlas supports all the MongoDB versions that have not reached End of Live for M10+ clusters. If omitted, Atlas deploys the cluster with the default version. For more details, see documentation. 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_systemCONTINUOUS, the resource returns an error. Either clear this parameter or setversion_release_system:LTS. - Mongo
Db stringVersion - Version of MongoDB the cluster runs, in
major-version.minor-versionformat. - Name string
- Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed. WARNING Changing the name will result in destruction of the existing cluster and the creation of a new cluster.
- Paused bool
- Pit
Enabled bool - Flag that indicates if the cluster uses Continuous Cloud Backup.
- Project
Id string - Unique ID for the project to create the database user.
- Redact
Client boolLog Data - Flag that enables or disables log redaction, see the manual for more info. Use this in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements. Note: Changing this setting on a cluster will trigger a rolling restart as soon as the cluster is updated.
- Replica
Set stringScaling Strategy - Replica set scaling mode for your cluster. Valid values are
WORKLOAD_TYPE,SEQUENTIALandNODE_TYPE. By default, Atlas scales underWORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. When configured asSEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. When configured asNODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. Modify the Replica Set Scaling Mode - Replication
Specs []AdvancedCluster Replication Spec Args - List of settings that configure your cluster regions. This attribute has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. If for each replication_spec
num_shardsis configured with a value greater than 1 (using deprecated sharding configurations), then each object represents a zone with one or more shards. See below - Retain
Backups boolEnabled - Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster
- Root
Cert stringType - Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).
- State
Name string - Current state of the cluster. The possible states are:
- IDLE
- CREATING
- UPDATING
- DELETING
- DELETED
- REPAIRING
replication_specs.#.container_id- A key-value map of the Network Peering Container ID(s) for the configuration specified inregion_configs. The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is"providerName:regionName" = "containerId". ExampleAWS:US_EAST_1" = "61e0797dde08fb498ca11a71.
-
[]Advanced
Cluster Tag Args - Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
- Termination
Protection boolEnabled - Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
- Version
Release stringSystem - Release cadence that Atlas uses for this cluster. This parameter defaults to
LTS. If you set this field toCONTINUOUS, you must omit themongo_db_major_versionfield. 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.
- accept
Data StringRisks And Force Replica Set Reconfig - If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set
accept_data_risks_and_force_replica_set_reconfigto the current date. Learn more about Reconfiguring a Replica Set during a regional outage here. - advanced
Configuration AdvancedCluster Advanced Configuration - backup
Enabled Boolean Flag that indicates whether the cluster can perform backups. If
true, the cluster can perform backups. You must set this value totruefor NVMe clusters.Backup uses: Cloud Backups for dedicated clusters. Shared Cluster Backups for tenant clusters. If "
backup_enabled" :false, the cluster doesn't use Atlas backups.This parameter defaults to false.
- bi
Connector AdvancedConfig Cluster Bi Connector Config - 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 String - The cluster ID.
- cluster
Type String - Type of the cluster that you want to create.
Accepted values include:
REPLICASETReplica setSHARDEDSharded clusterGEOSHARDEDGlobal Cluster
- config
Server StringManagement Mode - Config Server Management Mode for creating or updating a sharded cluster. Valid values are
ATLAS_MANAGED(default) andFIXED_TO_DEDICATED. When configured asATLAS_MANAGED, Atlas may automatically switch the cluster's config server type for optimal performance and savings. When configured asFIXED_TO_DEDICATED, the cluster will always use a dedicated config server. To learn more, see the Sharded Cluster Config Servers documentation. - config
Server StringType - Describes a sharded cluster's config server type. Valid values are
DEDICATEDandEMBEDDED. To learn more, see the Sharded Cluster Config Servers documentation. - connection
Strings List<AdvancedCluster Connection String> - 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 String - disk
Size DoubleGb - Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (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. (DEPRECATED) Use
replication_specs.#.region_config.#.(analytics_specs|electable_specs|read_only_specs).disk_size_gbinstead. To learn more, see the 1.18.0 upgrade guide. - encryption
At StringRest Provider - 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_sizeis M10 or greater andbackup_enabledis false or omitted. - global
Cluster BooleanSelf Managed Sharding - Flag that indicates if cluster uses Atlas-Managed Sharding (false, default) or Self-Managed Sharding (true). It can only be enabled for Global Clusters (
GEOSHARDED). It cannot be changed once the cluster is created. Use this mode if you're an advanced user and the default configuration is too restrictive for your workload. If you select this option, you must manually configure the sharding strategy, more info here. - labels
List<Advanced
Cluster Label> - Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. DEPRECATED Use
tagsinstead. - mongo
Db StringMajor Version - Version of the cluster to deploy. Atlas supports all the MongoDB versions that have not reached End of Live for M10+ clusters. If omitted, Atlas deploys the cluster with the default version. For more details, see documentation. 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_systemCONTINUOUS, the resource returns an error. Either clear this parameter or setversion_release_system:LTS. - mongo
Db StringVersion - Version of MongoDB the cluster runs, in
major-version.minor-versionformat. - name String
- Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed. WARNING Changing the name will result in destruction of the existing cluster and the creation of a new cluster.
- paused Boolean
- pit
Enabled Boolean - Flag that indicates if the cluster uses Continuous Cloud Backup.
- project
Id String - Unique ID for the project to create the database user.
- redact
Client BooleanLog Data - Flag that enables or disables log redaction, see the manual for more info. Use this in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements. Note: Changing this setting on a cluster will trigger a rolling restart as soon as the cluster is updated.
- replica
Set StringScaling Strategy - Replica set scaling mode for your cluster. Valid values are
WORKLOAD_TYPE,SEQUENTIALandNODE_TYPE. By default, Atlas scales underWORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. When configured asSEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. When configured asNODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. Modify the Replica Set Scaling Mode - replication
Specs List<AdvancedCluster Replication Spec> - List of settings that configure your cluster regions. This attribute has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. If for each replication_spec
num_shardsis configured with a value greater than 1 (using deprecated sharding configurations), then each object represents a zone with one or more shards. See below - retain
Backups BooleanEnabled - Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster
- root
Cert StringType - Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).
- state
Name String - Current state of the cluster. The possible states are:
- IDLE
- CREATING
- UPDATING
- DELETING
- DELETED
- REPAIRING
replication_specs.#.container_id- A key-value map of the Network Peering Container ID(s) for the configuration specified inregion_configs. The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is"providerName:regionName" = "containerId". ExampleAWS:US_EAST_1" = "61e0797dde08fb498ca11a71.
-
List<Advanced
Cluster Tag> - Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
- termination
Protection BooleanEnabled - Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
- version
Release StringSystem - Release cadence that Atlas uses for this cluster. This parameter defaults to
LTS. If you set this field toCONTINUOUS, you must omit themongo_db_major_versionfield. 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.
- accept
Data stringRisks And Force Replica Set Reconfig - If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set
accept_data_risks_and_force_replica_set_reconfigto the current date. Learn more about Reconfiguring a Replica Set during a regional outage here. - advanced
Configuration AdvancedCluster Advanced Configuration - backup
Enabled boolean Flag that indicates whether the cluster can perform backups. If
true, the cluster can perform backups. You must set this value totruefor NVMe clusters.Backup uses: Cloud Backups for dedicated clusters. Shared Cluster Backups for tenant clusters. If "
backup_enabled" :false, the cluster doesn't use Atlas backups.This parameter defaults to false.
- bi
Connector AdvancedConfig Cluster Bi Connector Config - 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 string - The cluster ID.
- cluster
Type string - Type of the cluster that you want to create.
Accepted values include:
REPLICASETReplica setSHARDEDSharded clusterGEOSHARDEDGlobal Cluster
- config
Server stringManagement Mode - Config Server Management Mode for creating or updating a sharded cluster. Valid values are
ATLAS_MANAGED(default) andFIXED_TO_DEDICATED. When configured asATLAS_MANAGED, Atlas may automatically switch the cluster's config server type for optimal performance and savings. When configured asFIXED_TO_DEDICATED, the cluster will always use a dedicated config server. To learn more, see the Sharded Cluster Config Servers documentation. - config
Server stringType - Describes a sharded cluster's config server type. Valid values are
DEDICATEDandEMBEDDED. To learn more, see the Sharded Cluster Config Servers documentation. - connection
Strings AdvancedCluster Connection String[] - 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 string - disk
Size numberGb - Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (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. (DEPRECATED) Use
replication_specs.#.region_config.#.(analytics_specs|electable_specs|read_only_specs).disk_size_gbinstead. To learn more, see the 1.18.0 upgrade guide. - encryption
At stringRest Provider - 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_sizeis M10 or greater andbackup_enabledis false or omitted. - global
Cluster booleanSelf Managed Sharding - Flag that indicates if cluster uses Atlas-Managed Sharding (false, default) or Self-Managed Sharding (true). It can only be enabled for Global Clusters (
GEOSHARDED). It cannot be changed once the cluster is created. Use this mode if you're an advanced user and the default configuration is too restrictive for your workload. If you select this option, you must manually configure the sharding strategy, more info here. - labels
Advanced
Cluster Label[] - Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. DEPRECATED Use
tagsinstead. - mongo
Db stringMajor Version - Version of the cluster to deploy. Atlas supports all the MongoDB versions that have not reached End of Live for M10+ clusters. If omitted, Atlas deploys the cluster with the default version. For more details, see documentation. 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_systemCONTINUOUS, the resource returns an error. Either clear this parameter or setversion_release_system:LTS. - mongo
Db stringVersion - Version of MongoDB the cluster runs, in
major-version.minor-versionformat. - name string
- Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed. WARNING Changing the name will result in destruction of the existing cluster and the creation of a new cluster.
- paused boolean
- pit
Enabled boolean - Flag that indicates if the cluster uses Continuous Cloud Backup.
- project
Id string - Unique ID for the project to create the database user.
- redact
Client booleanLog Data - Flag that enables or disables log redaction, see the manual for more info. Use this in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements. Note: Changing this setting on a cluster will trigger a rolling restart as soon as the cluster is updated.
- replica
Set stringScaling Strategy - Replica set scaling mode for your cluster. Valid values are
WORKLOAD_TYPE,SEQUENTIALandNODE_TYPE. By default, Atlas scales underWORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. When configured asSEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. When configured asNODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. Modify the Replica Set Scaling Mode - replication
Specs AdvancedCluster Replication Spec[] - List of settings that configure your cluster regions. This attribute has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. If for each replication_spec
num_shardsis configured with a value greater than 1 (using deprecated sharding configurations), then each object represents a zone with one or more shards. See below - retain
Backups booleanEnabled - Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster
- root
Cert stringType - Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).
- state
Name string - Current state of the cluster. The possible states are:
- IDLE
- CREATING
- UPDATING
- DELETING
- DELETED
- REPAIRING
replication_specs.#.container_id- A key-value map of the Network Peering Container ID(s) for the configuration specified inregion_configs. The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is"providerName:regionName" = "containerId". ExampleAWS:US_EAST_1" = "61e0797dde08fb498ca11a71.
-
Advanced
Cluster Tag[] - Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
- termination
Protection booleanEnabled - Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
- version
Release stringSystem - Release cadence that Atlas uses for this cluster. This parameter defaults to
LTS. If you set this field toCONTINUOUS, you must omit themongo_db_major_versionfield. 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.
- accept_
data_ strrisks_ and_ force_ replica_ set_ reconfig - If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set
accept_data_risks_and_force_replica_set_reconfigto the current date. Learn more about Reconfiguring a Replica Set during a regional outage here. - advanced_
configuration AdvancedCluster Advanced Configuration Args - backup_
enabled bool Flag that indicates whether the cluster can perform backups. If
true, the cluster can perform backups. You must set this value totruefor NVMe clusters.Backup uses: Cloud Backups for dedicated clusters. Shared Cluster Backups for tenant clusters. If "
backup_enabled" :false, the cluster doesn't use Atlas backups.This parameter defaults to false.
- bi_
connector_ Advancedconfig Cluster Bi Connector Config Args - 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:
REPLICASETReplica setSHARDEDSharded clusterGEOSHARDEDGlobal Cluster
- config_
server_ strmanagement_ mode - Config Server Management Mode for creating or updating a sharded cluster. Valid values are
ATLAS_MANAGED(default) andFIXED_TO_DEDICATED. When configured asATLAS_MANAGED, Atlas may automatically switch the cluster's config server type for optimal performance and savings. When configured asFIXED_TO_DEDICATED, the cluster will always use a dedicated config server. To learn more, see the Sharded Cluster Config Servers documentation. - config_
server_ strtype - Describes a sharded cluster's config server type. Valid values are
DEDICATEDandEMBEDDED. To learn more, see the Sharded Cluster Config Servers documentation. - connection_
strings Sequence[AdvancedCluster Connection String Args] - 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_ floatgb - Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (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. (DEPRECATED) Use
replication_specs.#.region_config.#.(analytics_specs|electable_specs|read_only_specs).disk_size_gbinstead. To learn more, see the 1.18.0 upgrade guide. - encryption_
at_ strrest_ provider - 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_sizeis M10 or greater andbackup_enabledis false or omitted. - global_
cluster_ boolself_ managed_ sharding - Flag that indicates if cluster uses Atlas-Managed Sharding (false, default) or Self-Managed Sharding (true). It can only be enabled for Global Clusters (
GEOSHARDED). It cannot be changed once the cluster is created. Use this mode if you're an advanced user and the default configuration is too restrictive for your workload. If you select this option, you must manually configure the sharding strategy, more info here. - labels
Sequence[Advanced
Cluster Label Args] - Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. DEPRECATED Use
tagsinstead. - mongo_
db_ strmajor_ version - Version of the cluster to deploy. Atlas supports all the MongoDB versions that have not reached End of Live for M10+ clusters. If omitted, Atlas deploys the cluster with the default version. For more details, see documentation. 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_systemCONTINUOUS, the resource returns an error. Either clear this parameter or setversion_release_system:LTS. - mongo_
db_ strversion - Version of MongoDB the cluster runs, in
major-version.minor-versionformat. - name str
- Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed. WARNING Changing the name will result in destruction of the existing cluster and the creation of a new cluster.
- 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.
- redact_
client_ boollog_ data - Flag that enables or disables log redaction, see the manual for more info. Use this in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements. Note: Changing this setting on a cluster will trigger a rolling restart as soon as the cluster is updated.
- replica_
set_ strscaling_ strategy - Replica set scaling mode for your cluster. Valid values are
WORKLOAD_TYPE,SEQUENTIALandNODE_TYPE. By default, Atlas scales underWORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. When configured asSEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. When configured asNODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. Modify the Replica Set Scaling Mode - replication_
specs Sequence[AdvancedCluster Replication Spec Args] - List of settings that configure your cluster regions. This attribute has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. If for each replication_spec
num_shardsis configured with a value greater than 1 (using deprecated sharding configurations), then each object represents a zone with one or more shards. See below - retain_
backups_ boolenabled - Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster
- root_
cert_ strtype - 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
replication_specs.#.container_id- A key-value map of the Network Peering Container ID(s) for the configuration specified inregion_configs. The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is"providerName:regionName" = "containerId". ExampleAWS:US_EAST_1" = "61e0797dde08fb498ca11a71.
-
Sequence[Advanced
Cluster Tag Args] - Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
- termination_
protection_ boolenabled - Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
- version_
release_ strsystem - Release cadence that Atlas uses for this cluster. This parameter defaults to
LTS. If you set this field toCONTINUOUS, you must omit themongo_db_major_versionfield. 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.
- accept
Data StringRisks And Force Replica Set Reconfig - If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set
accept_data_risks_and_force_replica_set_reconfigto the current date. Learn more about Reconfiguring a Replica Set during a regional outage here. - advanced
Configuration Property Map - backup
Enabled Boolean Flag that indicates whether the cluster can perform backups. If
true, the cluster can perform backups. You must set this value totruefor NVMe clusters.Backup uses: Cloud Backups for dedicated clusters. Shared Cluster Backups for tenant clusters. If "
backup_enabled" :false, the cluster doesn't use Atlas backups.This parameter defaults to false.
- bi
Connector Property MapConfig - 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 String - The cluster ID.
- cluster
Type String - Type of the cluster that you want to create.
Accepted values include:
REPLICASETReplica setSHARDEDSharded clusterGEOSHARDEDGlobal Cluster
- config
Server StringManagement Mode - Config Server Management Mode for creating or updating a sharded cluster. Valid values are
ATLAS_MANAGED(default) andFIXED_TO_DEDICATED. When configured asATLAS_MANAGED, Atlas may automatically switch the cluster's config server type for optimal performance and savings. When configured asFIXED_TO_DEDICATED, the cluster will always use a dedicated config server. To learn more, see the Sharded Cluster Config Servers documentation. - config
Server StringType - Describes a sharded cluster's config server type. Valid values are
DEDICATEDandEMBEDDED. To learn more, see the Sharded Cluster Config Servers documentation. - connection
Strings 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.
- create
Date String - disk
Size NumberGb - Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (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. (DEPRECATED) Use
replication_specs.#.region_config.#.(analytics_specs|electable_specs|read_only_specs).disk_size_gbinstead. To learn more, see the 1.18.0 upgrade guide. - encryption
At StringRest Provider - 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_sizeis M10 or greater andbackup_enabledis false or omitted. - global
Cluster BooleanSelf Managed Sharding - Flag that indicates if cluster uses Atlas-Managed Sharding (false, default) or Self-Managed Sharding (true). It can only be enabled for Global Clusters (
GEOSHARDED). It cannot be changed once the cluster is created. Use this mode if you're an advanced user and the default configuration is too restrictive for your workload. If you select this option, you must manually configure the sharding strategy, more info here. - labels List<Property Map>
- Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. DEPRECATED Use
tagsinstead. - mongo
Db StringMajor Version - Version of the cluster to deploy. Atlas supports all the MongoDB versions that have not reached End of Live for M10+ clusters. If omitted, Atlas deploys the cluster with the default version. For more details, see documentation. 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_systemCONTINUOUS, the resource returns an error. Either clear this parameter or setversion_release_system:LTS. - mongo
Db StringVersion - Version of MongoDB the cluster runs, in
major-version.minor-versionformat. - name String
- Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed. WARNING Changing the name will result in destruction of the existing cluster and the creation of a new cluster.
- paused Boolean
- pit
Enabled Boolean - Flag that indicates if the cluster uses Continuous Cloud Backup.
- project
Id String - Unique ID for the project to create the database user.
- redact
Client BooleanLog Data - Flag that enables or disables log redaction, see the manual for more info. Use this in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements. Note: Changing this setting on a cluster will trigger a rolling restart as soon as the cluster is updated.
- replica
Set StringScaling Strategy - Replica set scaling mode for your cluster. Valid values are
WORKLOAD_TYPE,SEQUENTIALandNODE_TYPE. By default, Atlas scales underWORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. When configured asSEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. When configured asNODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. Modify the Replica Set Scaling Mode - replication
Specs List<Property Map> - List of settings that configure your cluster regions. This attribute has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. If for each replication_spec
num_shardsis configured with a value greater than 1 (using deprecated sharding configurations), then each object represents a zone with one or more shards. See below - retain
Backups BooleanEnabled - Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster
- root
Cert StringType - Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).
- state
Name String - Current state of the cluster. The possible states are:
- IDLE
- CREATING
- UPDATING
- DELETING
- DELETED
- REPAIRING
replication_specs.#.container_id- A key-value map of the Network Peering Container ID(s) for the configuration specified inregion_configs. The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is"providerName:regionName" = "containerId". ExampleAWS:US_EAST_1" = "61e0797dde08fb498ca11a71.
- List<Property Map>
- Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
- termination
Protection BooleanEnabled - Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
- version
Release StringSystem - Release cadence that Atlas uses for this cluster. This parameter defaults to
LTS. If you set this field toCONTINUOUS, you must omit themongo_db_major_versionfield. 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, AdvancedClusterAdvancedConfigurationArgs
- Change
Stream intOptions Pre And Post Images Expire After Seconds - The minimum pre- and post-image retention time in seconds. This option corresponds to the
changeStreamOptions.preAndPostImages.expireAfterSecondscluster parameter. Defaults to-1(off). This setting controls the retention policy of change stream pre- and post-images. Pre- and post-images are the versions of a document before and after document modification, respectively.expireAfterSecondscontrols how long MongoDB retains pre- and post-images. When set to -1 (off), MongoDB uses the default retention policy: pre- and post-images are retained until the corresponding change stream events are removed from the oplog. To set the minimum pre- and post-image retention time, specify an integer value greater than zero. Setting this too low could increase the risk of interrupting Realm sync or triggers processing. This parameter is only supported for MongoDB version 6.0 and above. - Default
Read stringConcern - Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available. (DEPRECATED) MongoDB 5.0 and later clusters default to
local. To use a custom read concern level, please refer to your driver documentation. - Default
Write stringConcern - Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.
- Fail
Index boolKey Too Long - When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them. (DEPRECATED) This parameter has been removed as of MongoDB 4.4.
- Javascript
Enabled bool - When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.
- Minimum
Enabled stringTls Protocol - Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:
- TLS1_0
- TLS1_1
- TLS1_2
- No
Table boolScan - When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.
- Oplog
Min doubleRetention Hours - Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
- Note A minimum oplog retention is required when seeking to change a cluster's class to Local NVMe SSD. To learn more and for latest guidance see
oplogMinRetentionHours
- Note A minimum oplog retention is required when seeking to change a cluster's class to Local NVMe SSD. To learn more and for latest guidance see
- Oplog
Size intMb - The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.
- Sample
Refresh intInterval Bi Connector - Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
- Sample
Size intBi Connector - Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
- Transaction
Lifetime intLimit Seconds - Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.
- Change
Stream intOptions Pre And Post Images Expire After Seconds - The minimum pre- and post-image retention time in seconds. This option corresponds to the
changeStreamOptions.preAndPostImages.expireAfterSecondscluster parameter. Defaults to-1(off). This setting controls the retention policy of change stream pre- and post-images. Pre- and post-images are the versions of a document before and after document modification, respectively.expireAfterSecondscontrols how long MongoDB retains pre- and post-images. When set to -1 (off), MongoDB uses the default retention policy: pre- and post-images are retained until the corresponding change stream events are removed from the oplog. To set the minimum pre- and post-image retention time, specify an integer value greater than zero. Setting this too low could increase the risk of interrupting Realm sync or triggers processing. This parameter is only supported for MongoDB version 6.0 and above. - Default
Read stringConcern - Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available. (DEPRECATED) MongoDB 5.0 and later clusters default to
local. To use a custom read concern level, please refer to your driver documentation. - Default
Write stringConcern - Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.
- Fail
Index boolKey Too Long - When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them. (DEPRECATED) This parameter has been removed as of MongoDB 4.4.
- Javascript
Enabled bool - When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.
- Minimum
Enabled stringTls Protocol - Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:
- TLS1_0
- TLS1_1
- TLS1_2
- No
Table boolScan - When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.
- Oplog
Min float64Retention Hours - Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
- Note A minimum oplog retention is required when seeking to change a cluster's class to Local NVMe SSD. To learn more and for latest guidance see
oplogMinRetentionHours
- Note A minimum oplog retention is required when seeking to change a cluster's class to Local NVMe SSD. To learn more and for latest guidance see
- Oplog
Size intMb - The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.
- Sample
Refresh intInterval Bi Connector - Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
- Sample
Size intBi Connector - Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
- Transaction
Lifetime intLimit Seconds - Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.
- change
Stream IntegerOptions Pre And Post Images Expire After Seconds - The minimum pre- and post-image retention time in seconds. This option corresponds to the
changeStreamOptions.preAndPostImages.expireAfterSecondscluster parameter. Defaults to-1(off). This setting controls the retention policy of change stream pre- and post-images. Pre- and post-images are the versions of a document before and after document modification, respectively.expireAfterSecondscontrols how long MongoDB retains pre- and post-images. When set to -1 (off), MongoDB uses the default retention policy: pre- and post-images are retained until the corresponding change stream events are removed from the oplog. To set the minimum pre- and post-image retention time, specify an integer value greater than zero. Setting this too low could increase the risk of interrupting Realm sync or triggers processing. This parameter is only supported for MongoDB version 6.0 and above. - default
Read StringConcern - Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available. (DEPRECATED) MongoDB 5.0 and later clusters default to
local. To use a custom read concern level, please refer to your driver documentation. - default
Write StringConcern - Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.
- fail
Index BooleanKey Too Long - When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them. (DEPRECATED) This parameter has been removed as of MongoDB 4.4.
- javascript
Enabled 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.
- minimum
Enabled StringTls Protocol - Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:
- TLS1_0
- TLS1_1
- TLS1_2
- no
Table BooleanScan - When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.
- oplog
Min DoubleRetention Hours - Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
- Note A minimum oplog retention is required when seeking to change a cluster's class to Local NVMe SSD. To learn more and for latest guidance see
oplogMinRetentionHours
- Note A minimum oplog retention is required when seeking to change a cluster's class to Local NVMe SSD. To learn more and for latest guidance see
- oplog
Size IntegerMb - 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 IntegerInterval Bi Connector - Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
- sample
Size IntegerBi Connector - Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
- transaction
Lifetime IntegerLimit Seconds - Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.
- change
Stream numberOptions Pre And Post Images Expire After Seconds - The minimum pre- and post-image retention time in seconds. This option corresponds to the
changeStreamOptions.preAndPostImages.expireAfterSecondscluster parameter. Defaults to-1(off). This setting controls the retention policy of change stream pre- and post-images. Pre- and post-images are the versions of a document before and after document modification, respectively.expireAfterSecondscontrols how long MongoDB retains pre- and post-images. When set to -1 (off), MongoDB uses the default retention policy: pre- and post-images are retained until the corresponding change stream events are removed from the oplog. To set the minimum pre- and post-image retention time, specify an integer value greater than zero. Setting this too low could increase the risk of interrupting Realm sync or triggers processing. This parameter is only supported for MongoDB version 6.0 and above. - default
Read stringConcern - Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available. (DEPRECATED) MongoDB 5.0 and later clusters default to
local. To use a custom read concern level, please refer to your driver documentation. - default
Write stringConcern - Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.
- fail
Index booleanKey Too Long - When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them. (DEPRECATED) This parameter has been removed as of MongoDB 4.4.
- javascript
Enabled 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.
- minimum
Enabled stringTls Protocol - Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:
- TLS1_0
- TLS1_1
- TLS1_2
- no
Table booleanScan - When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.
- oplog
Min numberRetention Hours - Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
- Note A minimum oplog retention is required when seeking to change a cluster's class to Local NVMe SSD. To learn more and for latest guidance see
oplogMinRetentionHours
- Note A minimum oplog retention is required when seeking to change a cluster's class to Local NVMe SSD. To learn more and for latest guidance see
- oplog
Size numberMb - 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 numberInterval Bi Connector - Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
- sample
Size numberBi Connector - Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
- transaction
Lifetime numberLimit Seconds - Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.
- change_
stream_ intoptions_ pre_ and_ post_ images_ expire_ after_ seconds - The minimum pre- and post-image retention time in seconds. This option corresponds to the
changeStreamOptions.preAndPostImages.expireAfterSecondscluster parameter. Defaults to-1(off). This setting controls the retention policy of change stream pre- and post-images. Pre- and post-images are the versions of a document before and after document modification, respectively.expireAfterSecondscontrols how long MongoDB retains pre- and post-images. When set to -1 (off), MongoDB uses the default retention policy: pre- and post-images are retained until the corresponding change stream events are removed from the oplog. To set the minimum pre- and post-image retention time, specify an integer value greater than zero. Setting this too low could increase the risk of interrupting Realm sync or triggers processing. This parameter is only supported for MongoDB version 6.0 and above. - default_
read_ strconcern - Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available. (DEPRECATED) MongoDB 5.0 and later clusters default to
local. To use a custom read concern level, please refer to your driver documentation. - default_
write_ strconcern - Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.
- fail_
index_ boolkey_ too_ long - When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them. (DEPRECATED) This parameter has been removed as of MongoDB 4.4.
- javascript_
enabled bool - When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.
- minimum_
enabled_ strtls_ protocol - Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:
- TLS1_0
- TLS1_1
- TLS1_2
- no_
table_ boolscan - When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.
- oplog_
min_ floatretention_ hours - Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
- Note A minimum oplog retention is required when seeking to change a cluster's class to Local NVMe SSD. To learn more and for latest guidance see
oplogMinRetentionHours
- Note A minimum oplog retention is required when seeking to change a cluster's class to Local NVMe SSD. To learn more and for latest guidance see
- oplog_
size_ intmb - The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.
- sample_
refresh_ intinterval_ bi_ connector - Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
- sample_
size_ intbi_ connector - Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
- transaction_
lifetime_ intlimit_ seconds - Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.
- change
Stream NumberOptions Pre And Post Images Expire After Seconds - The minimum pre- and post-image retention time in seconds. This option corresponds to the
changeStreamOptions.preAndPostImages.expireAfterSecondscluster parameter. Defaults to-1(off). This setting controls the retention policy of change stream pre- and post-images. Pre- and post-images are the versions of a document before and after document modification, respectively.expireAfterSecondscontrols how long MongoDB retains pre- and post-images. When set to -1 (off), MongoDB uses the default retention policy: pre- and post-images are retained until the corresponding change stream events are removed from the oplog. To set the minimum pre- and post-image retention time, specify an integer value greater than zero. Setting this too low could increase the risk of interrupting Realm sync or triggers processing. This parameter is only supported for MongoDB version 6.0 and above. - default
Read StringConcern - Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available. (DEPRECATED) MongoDB 5.0 and later clusters default to
local. To use a custom read concern level, please refer to your driver documentation. - default
Write StringConcern - Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.
- fail
Index BooleanKey Too Long - When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them. (DEPRECATED) This parameter has been removed as of MongoDB 4.4.
- javascript
Enabled 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.
- minimum
Enabled StringTls Protocol - Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:
- TLS1_0
- TLS1_1
- TLS1_2
- no
Table BooleanScan - When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.
- oplog
Min NumberRetention Hours - Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
- Note A minimum oplog retention is required when seeking to change a cluster's class to Local NVMe SSD. To learn more and for latest guidance see
oplogMinRetentionHours
- Note A minimum oplog retention is required when seeking to change a cluster's class to Local NVMe SSD. To learn more and for latest guidance see
- oplog
Size NumberMb - 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 NumberInterval Bi Connector - Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
- sample
Size NumberBi Connector - Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
- transaction
Lifetime NumberLimit Seconds - Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.
AdvancedClusterBiConnectorConfig, AdvancedClusterBiConnectorConfigArgs
- Enabled bool
- Specifies whether or not BI Connector for Atlas is enabled on the cluster.l
*
- Set to
trueto enable BI Connector for Atlas. - Set to
falseto disable BI Connector for Atlas.
- Set to
- Read
Preference 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.
Set to "primary" to have BI Connector for Atlas read from the primary.
Set to "secondary" to have BI Connector for Atlas read from a secondary member. Default if there are no analytics nodes in the cluster.
Set to "analytics" to have BI Connector for Atlas read from an analytics node. Default if the cluster contains analytics nodes.
- Enabled bool
- Specifies whether or not BI Connector for Atlas is enabled on the cluster.l
*
- Set to
trueto enable BI Connector for Atlas. - Set to
falseto disable BI Connector for Atlas.
- Set to
- Read
Preference 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.
Set to "primary" to have BI Connector for Atlas read from the primary.
Set to "secondary" to have BI Connector for Atlas read from a secondary member. Default if there are no analytics nodes in the cluster.
Set to "analytics" to have BI Connector for Atlas read from an analytics node. Default if the cluster contains analytics nodes.
- enabled Boolean
- Specifies whether or not BI Connector for Atlas is enabled on the cluster.l
*
- Set to
trueto enable BI Connector for Atlas. - Set to
falseto disable BI Connector for Atlas.
- Set to
- read
Preference 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.
Set to "primary" to have BI Connector for Atlas read from the primary.
Set to "secondary" to have BI Connector for Atlas read from a secondary member. Default if there are no analytics nodes in the cluster.
Set to "analytics" to have BI Connector for Atlas read from an analytics node. Default if the cluster contains analytics nodes.
- enabled boolean
- Specifies whether or not BI Connector for Atlas is enabled on the cluster.l
*
- Set to
trueto enable BI Connector for Atlas. - Set to
falseto disable BI Connector for Atlas.
- Set to
- read
Preference 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.
Set to "primary" to have BI Connector for Atlas read from the primary.
Set to "secondary" to have BI Connector for Atlas read from a secondary member. Default if there are no analytics nodes in the cluster.
Set to "analytics" to have BI Connector for Atlas read from an analytics node. Default if the cluster contains analytics nodes.
- enabled bool
- Specifies whether or not BI Connector for Atlas is enabled on the cluster.l
*
- Set to
trueto enable BI Connector for Atlas. - Set to
falseto disable BI Connector for Atlas.
- Set to
- 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.
Set to "primary" to have BI Connector for Atlas read from the primary.
Set to "secondary" to have BI Connector for Atlas read from a secondary member. Default if there are no analytics nodes in the cluster.
Set to "analytics" to have BI Connector for Atlas read from an analytics node. Default if the cluster contains analytics nodes.
- enabled Boolean
- Specifies whether or not BI Connector for Atlas is enabled on the cluster.l
*
- Set to
trueto enable BI Connector for Atlas. - Set to
falseto disable BI Connector for Atlas.
- Set to
- read
Preference 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.
Set to "primary" to have BI Connector for Atlas read from the primary.
Set to "secondary" to have BI Connector for Atlas read from a secondary member. Default if there are no analytics nodes in the cluster.
Set to "analytics" to have BI Connector for Atlas read from an analytics node. Default if the cluster contains analytics nodes.
AdvancedClusterConnectionString, AdvancedClusterConnectionStringArgs
- Private string
- Network-peering-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.
- Private
Endpoints List<AdvancedCluster Connection String Private Endpoint> - Private endpoint connection strings. Each object describes the connection strings you can use to connect to this cluster through a private endpoint. Atlas returns this parameter only if you deployed a private endpoint to all regions to which you deployed this cluster's nodes.
connection_strings.private_endpoint.#.connection_string- Private-endpoint-awaremongodb://connection string for this private endpoint.connection_strings.private_endpoint.#.srv_connection_string- Private-endpoint-awaremongodb+srv://connection string for this private endpoint. Themongodb+srvprotocol tells the driver to look up the seed list of hosts in DNS . Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don't need to: Append the seed list or Change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn't, useconnection_strings.private_endpoint[n].connection_stringconnection_strings.private_endpoint.#.srv_shard_optimized_connection_string- Private endpoint-aware connection string optimized for sharded clusters that uses themongodb+srv://protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString.connection_strings.private_endpoint.#.type- Type of MongoDB process that you connect to with the connection strings. Atlas returnsMONGODfor replica sets, orMONGOSfor sharded clusters.connection_strings.private_endpoint.#.endpoints- Private endpoint through which you connect to Atlas when you useconnection_strings.private_endpoint[n].connection_stringorconnection_strings.private_endpoint[n].srv_connection_stringconnection_strings.private_endpoint.#.endpoints.#.endpoint_id- Unique identifier of the private endpoint.connection_strings.private_endpoint.#.endpoints.#.provider_name- Cloud provider to which you deployed the private endpoint. Atlas returnsAWSorAZURE.connection_strings.private_endpoint.#.endpoints.#.region- Region to which you deployed the private endpoint.
- Private
Srv string - Network-peering-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.
- Standard string
- Public mongodb:// connection string for this cluster.
- Standard
Srv string - Public mongodb+srv:// connection string for this cluster. The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS. Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don’t need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn’t , use connectionStrings.standard.
- Private string
- Network-peering-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.
- Private
Endpoints []AdvancedCluster Connection String Private Endpoint - Private endpoint connection strings. Each object describes the connection strings you can use to connect to this cluster through a private endpoint. Atlas returns this parameter only if you deployed a private endpoint to all regions to which you deployed this cluster's nodes.
connection_strings.private_endpoint.#.connection_string- Private-endpoint-awaremongodb://connection string for this private endpoint.connection_strings.private_endpoint.#.srv_connection_string- Private-endpoint-awaremongodb+srv://connection string for this private endpoint. Themongodb+srvprotocol tells the driver to look up the seed list of hosts in DNS . Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don't need to: Append the seed list or Change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn't, useconnection_strings.private_endpoint[n].connection_stringconnection_strings.private_endpoint.#.srv_shard_optimized_connection_string- Private endpoint-aware connection string optimized for sharded clusters that uses themongodb+srv://protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString.connection_strings.private_endpoint.#.type- Type of MongoDB process that you connect to with the connection strings. Atlas returnsMONGODfor replica sets, orMONGOSfor sharded clusters.connection_strings.private_endpoint.#.endpoints- Private endpoint through which you connect to Atlas when you useconnection_strings.private_endpoint[n].connection_stringorconnection_strings.private_endpoint[n].srv_connection_stringconnection_strings.private_endpoint.#.endpoints.#.endpoint_id- Unique identifier of the private endpoint.connection_strings.private_endpoint.#.endpoints.#.provider_name- Cloud provider to which you deployed the private endpoint. Atlas returnsAWSorAZURE.connection_strings.private_endpoint.#.endpoints.#.region- Region to which you deployed the private endpoint.
- Private
Srv string - Network-peering-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.
- Standard string
- Public mongodb:// connection string for this cluster.
- Standard
Srv string - Public mongodb+srv:// connection string for this cluster. The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS. Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don’t need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn’t , use connectionStrings.standard.
- private
Endpoints List<AdvancedCluster Connection String Private Endpoint> - Private endpoint connection strings. Each object describes the connection strings you can use to connect to this cluster through a private endpoint. Atlas returns this parameter only if you deployed a private endpoint to all regions to which you deployed this cluster's nodes.
connection_strings.private_endpoint.#.connection_string- Private-endpoint-awaremongodb://connection string for this private endpoint.connection_strings.private_endpoint.#.srv_connection_string- Private-endpoint-awaremongodb+srv://connection string for this private endpoint. Themongodb+srvprotocol tells the driver to look up the seed list of hosts in DNS . Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don't need to: Append the seed list or Change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn't, useconnection_strings.private_endpoint[n].connection_stringconnection_strings.private_endpoint.#.srv_shard_optimized_connection_string- Private endpoint-aware connection string optimized for sharded clusters that uses themongodb+srv://protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString.connection_strings.private_endpoint.#.type- Type of MongoDB process that you connect to with the connection strings. Atlas returnsMONGODfor replica sets, orMONGOSfor sharded clusters.connection_strings.private_endpoint.#.endpoints- Private endpoint through which you connect to Atlas when you useconnection_strings.private_endpoint[n].connection_stringorconnection_strings.private_endpoint[n].srv_connection_stringconnection_strings.private_endpoint.#.endpoints.#.endpoint_id- Unique identifier of the private endpoint.connection_strings.private_endpoint.#.endpoints.#.provider_name- Cloud provider to which you deployed the private endpoint. Atlas returnsAWSorAZURE.connection_strings.private_endpoint.#.endpoints.#.region- Region to which you deployed the private endpoint.
- private
Srv String - Network-peering-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.
- private_ String
- Network-peering-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.
- standard String
- Public mongodb:// connection string for this cluster.
- standard
Srv String - Public mongodb+srv:// connection string for this cluster. The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS. Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don’t need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn’t , use connectionStrings.standard.
- private string
- Network-peering-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.
- private
Endpoints AdvancedCluster Connection String Private Endpoint[] - Private endpoint connection strings. Each object describes the connection strings you can use to connect to this cluster through a private endpoint. Atlas returns this parameter only if you deployed a private endpoint to all regions to which you deployed this cluster's nodes.
connection_strings.private_endpoint.#.connection_string- Private-endpoint-awaremongodb://connection string for this private endpoint.connection_strings.private_endpoint.#.srv_connection_string- Private-endpoint-awaremongodb+srv://connection string for this private endpoint. Themongodb+srvprotocol tells the driver to look up the seed list of hosts in DNS . Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don't need to: Append the seed list or Change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn't, useconnection_strings.private_endpoint[n].connection_stringconnection_strings.private_endpoint.#.srv_shard_optimized_connection_string- Private endpoint-aware connection string optimized for sharded clusters that uses themongodb+srv://protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString.connection_strings.private_endpoint.#.type- Type of MongoDB process that you connect to with the connection strings. Atlas returnsMONGODfor replica sets, orMONGOSfor sharded clusters.connection_strings.private_endpoint.#.endpoints- Private endpoint through which you connect to Atlas when you useconnection_strings.private_endpoint[n].connection_stringorconnection_strings.private_endpoint[n].srv_connection_stringconnection_strings.private_endpoint.#.endpoints.#.endpoint_id- Unique identifier of the private endpoint.connection_strings.private_endpoint.#.endpoints.#.provider_name- Cloud provider to which you deployed the private endpoint. Atlas returnsAWSorAZURE.connection_strings.private_endpoint.#.endpoints.#.region- Region to which you deployed the private endpoint.
- private
Srv string - Network-peering-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.
- standard string
- Public mongodb:// connection string for this cluster.
- standard
Srv string - Public mongodb+srv:// connection string for this cluster. The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS. Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don’t need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn’t , use connectionStrings.standard.
- private str
- Network-peering-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.
- private_
endpoints Sequence[AdvancedCluster Connection String Private Endpoint] - Private endpoint connection strings. Each object describes the connection strings you can use to connect to this cluster through a private endpoint. Atlas returns this parameter only if you deployed a private endpoint to all regions to which you deployed this cluster's nodes.
connection_strings.private_endpoint.#.connection_string- Private-endpoint-awaremongodb://connection string for this private endpoint.connection_strings.private_endpoint.#.srv_connection_string- Private-endpoint-awaremongodb+srv://connection string for this private endpoint. Themongodb+srvprotocol tells the driver to look up the seed list of hosts in DNS . Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don't need to: Append the seed list or Change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn't, useconnection_strings.private_endpoint[n].connection_stringconnection_strings.private_endpoint.#.srv_shard_optimized_connection_string- Private endpoint-aware connection string optimized for sharded clusters that uses themongodb+srv://protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString.connection_strings.private_endpoint.#.type- Type of MongoDB process that you connect to with the connection strings. Atlas returnsMONGODfor replica sets, orMONGOSfor sharded clusters.connection_strings.private_endpoint.#.endpoints- Private endpoint through which you connect to Atlas when you useconnection_strings.private_endpoint[n].connection_stringorconnection_strings.private_endpoint[n].srv_connection_stringconnection_strings.private_endpoint.#.endpoints.#.endpoint_id- Unique identifier of the private endpoint.connection_strings.private_endpoint.#.endpoints.#.provider_name- Cloud provider to which you deployed the private endpoint. Atlas returnsAWSorAZURE.connection_strings.private_endpoint.#.endpoints.#.region- Region to which you deployed the private endpoint.
- private_
srv str - Network-peering-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.
- standard str
- Public mongodb:// connection string for this cluster.
- standard_
srv str - Public mongodb+srv:// connection string for this cluster. The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS. Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don’t need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn’t , use connectionStrings.standard.
- private String
- Network-peering-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.
- private
Endpoints List<Property Map> - Private endpoint connection strings. Each object describes the connection strings you can use to connect to this cluster through a private endpoint. Atlas returns this parameter only if you deployed a private endpoint to all regions to which you deployed this cluster's nodes.
connection_strings.private_endpoint.#.connection_string- Private-endpoint-awaremongodb://connection string for this private endpoint.connection_strings.private_endpoint.#.srv_connection_string- Private-endpoint-awaremongodb+srv://connection string for this private endpoint. Themongodb+srvprotocol tells the driver to look up the seed list of hosts in DNS . Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don't need to: Append the seed list or Change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn't, useconnection_strings.private_endpoint[n].connection_stringconnection_strings.private_endpoint.#.srv_shard_optimized_connection_string- Private endpoint-aware connection string optimized for sharded clusters that uses themongodb+srv://protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString.connection_strings.private_endpoint.#.type- Type of MongoDB process that you connect to with the connection strings. Atlas returnsMONGODfor replica sets, orMONGOSfor sharded clusters.connection_strings.private_endpoint.#.endpoints- Private endpoint through which you connect to Atlas when you useconnection_strings.private_endpoint[n].connection_stringorconnection_strings.private_endpoint[n].srv_connection_stringconnection_strings.private_endpoint.#.endpoints.#.endpoint_id- Unique identifier of the private endpoint.connection_strings.private_endpoint.#.endpoints.#.provider_name- Cloud provider to which you deployed the private endpoint. Atlas returnsAWSorAZURE.connection_strings.private_endpoint.#.endpoints.#.region- Region to which you deployed the private endpoint.
- private
Srv String - Network-peering-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.
- standard String
- Public mongodb:// connection string for this cluster.
- standard
Srv String - Public mongodb+srv:// connection string for this cluster. The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS. Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don’t need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn’t , use connectionStrings.standard.
AdvancedClusterConnectionStringPrivateEndpoint, AdvancedClusterConnectionStringPrivateEndpointArgs
- connection
String String - endpoints List<Property Map>
- srv
Connection StringString - srv
Shard StringOptimized Connection String - type String
AdvancedClusterConnectionStringPrivateEndpointEndpoint, AdvancedClusterConnectionStringPrivateEndpointEndpointArgs
- Endpoint
Id string - Provider
Name string - Cloud service provider on which the servers are provisioned.
The possible values are:
AWS- Amazon AWSGCP- Google Cloud PlatformAZURE- Microsoft AzureTENANT- M0, M2 or M5 multi-tenant cluster. Usereplication_specs.#.region_configs.#.backing_provider_nameto set the cloud service provider.
- Region string
- Endpoint
Id string - Provider
Name string - Cloud service provider on which the servers are provisioned.
The possible values are:
AWS- Amazon AWSGCP- Google Cloud PlatformAZURE- Microsoft AzureTENANT- M0, M2 or M5 multi-tenant cluster. Usereplication_specs.#.region_configs.#.backing_provider_nameto set the cloud service provider.
- Region string
- endpoint
Id String - provider
Name String - Cloud service provider on which the servers are provisioned.
The possible values are:
AWS- Amazon AWSGCP- Google Cloud PlatformAZURE- Microsoft AzureTENANT- M0, M2 or M5 multi-tenant cluster. Usereplication_specs.#.region_configs.#.backing_provider_nameto set the cloud service provider.
- region String
- endpoint
Id string - provider
Name string - Cloud service provider on which the servers are provisioned.
The possible values are:
AWS- Amazon AWSGCP- Google Cloud PlatformAZURE- Microsoft AzureTENANT- M0, M2 or M5 multi-tenant cluster. Usereplication_specs.#.region_configs.#.backing_provider_nameto set the cloud service provider.
- region string
- endpoint_
id str - provider_
name str - Cloud service provider on which the servers are provisioned.
The possible values are:
AWS- Amazon AWSGCP- Google Cloud PlatformAZURE- Microsoft AzureTENANT- M0, M2 or M5 multi-tenant cluster. Usereplication_specs.#.region_configs.#.backing_provider_nameto set the cloud service provider.
- region str
- endpoint
Id String - provider
Name String - Cloud service provider on which the servers are provisioned.
The possible values are:
AWS- Amazon AWSGCP- Google Cloud PlatformAZURE- Microsoft AzureTENANT- M0, M2 or M5 multi-tenant cluster. Usereplication_specs.#.region_configs.#.backing_provider_nameto set the cloud service provider.
- region String
AdvancedClusterLabel, AdvancedClusterLabelArgs
AdvancedClusterReplicationSpec, AdvancedClusterReplicationSpecArgs
- Region
Configs List<AdvancedCluster Replication Spec Region Config> - Configuration for the hardware specifications for nodes set for a given regionEach
region_configsobject describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Eachregion_configsobject must have either ananalytics_specsobject,electable_specsobject, orread_only_specsobject. See below - Container
Id Dictionary<string, string> - External
Id string - Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. This value corresponds to Shard ID displayed in the UI. When using old sharding configuration (replication spec with
num_shardsgreater than 1) this value is not populated. - Id string
- (DEPRECATED) Unique identifer of the replication document for a zone in a Global Cluster. This value corresponds to the legacy sharding schema (no independent shard scaling) and is different from the Shard ID you may see in the Atlas UI.
- Num
Shards int - Provide this value if you set a
cluster_typeof SHARDED or GEOSHARDED. Omit this value if you selected acluster_typeof REPLICASET. This API resource accepts 1 through 50, inclusive. This parameter defaults to 1. If you specify anum_shardsvalue of 1 and acluster_typeof 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. If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards. To learn more, see Convert a replica set to a sharded cluster documentation and Convert a replica set to a sharded cluster tutorial. (DEPRECATED) To learn more, see the 1.18.0 Upgrade Guide. - Zone
Id string - Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. If clusterType is GEOSHARDED, this value indicates the zone that the given shard belongs to and can be used to configure Global Cluster backup policies.
- Zone
Name string - Name for the zone in a Global Cluster.
- Region
Configs []AdvancedCluster Replication Spec Region Config - Configuration for the hardware specifications for nodes set for a given regionEach
region_configsobject describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Eachregion_configsobject must have either ananalytics_specsobject,electable_specsobject, orread_only_specsobject. See below - Container
Id map[string]string - External
Id string - Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. This value corresponds to Shard ID displayed in the UI. When using old sharding configuration (replication spec with
num_shardsgreater than 1) this value is not populated. - Id string
- (DEPRECATED) Unique identifer of the replication document for a zone in a Global Cluster. This value corresponds to the legacy sharding schema (no independent shard scaling) and is different from the Shard ID you may see in the Atlas UI.
- Num
Shards int - Provide this value if you set a
cluster_typeof SHARDED or GEOSHARDED. Omit this value if you selected acluster_typeof REPLICASET. This API resource accepts 1 through 50, inclusive. This parameter defaults to 1. If you specify anum_shardsvalue of 1 and acluster_typeof 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. If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards. To learn more, see Convert a replica set to a sharded cluster documentation and Convert a replica set to a sharded cluster tutorial. (DEPRECATED) To learn more, see the 1.18.0 Upgrade Guide. - Zone
Id string - Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. If clusterType is GEOSHARDED, this value indicates the zone that the given shard belongs to and can be used to configure Global Cluster backup policies.
- Zone
Name string - Name for the zone in a Global Cluster.
- region
Configs List<AdvancedCluster Replication Spec Region Config> - Configuration for the hardware specifications for nodes set for a given regionEach
region_configsobject describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Eachregion_configsobject must have either ananalytics_specsobject,electable_specsobject, orread_only_specsobject. See below - container
Id Map<String,String> - external
Id String - Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. This value corresponds to Shard ID displayed in the UI. When using old sharding configuration (replication spec with
num_shardsgreater than 1) this value is not populated. - id String
- (DEPRECATED) Unique identifer of the replication document for a zone in a Global Cluster. This value corresponds to the legacy sharding schema (no independent shard scaling) and is different from the Shard ID you may see in the Atlas UI.
- num
Shards Integer - Provide this value if you set a
cluster_typeof SHARDED or GEOSHARDED. Omit this value if you selected acluster_typeof REPLICASET. This API resource accepts 1 through 50, inclusive. This parameter defaults to 1. If you specify anum_shardsvalue of 1 and acluster_typeof 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. If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards. To learn more, see Convert a replica set to a sharded cluster documentation and Convert a replica set to a sharded cluster tutorial. (DEPRECATED) To learn more, see the 1.18.0 Upgrade Guide. - zone
Id String - Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. If clusterType is GEOSHARDED, this value indicates the zone that the given shard belongs to and can be used to configure Global Cluster backup policies.
- zone
Name String - Name for the zone in a Global Cluster.
- region
Configs AdvancedCluster Replication Spec Region Config[] - Configuration for the hardware specifications for nodes set for a given regionEach
region_configsobject describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Eachregion_configsobject must have either ananalytics_specsobject,electable_specsobject, orread_only_specsobject. See below - container
Id {[key: string]: string} - external
Id string - Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. This value corresponds to Shard ID displayed in the UI. When using old sharding configuration (replication spec with
num_shardsgreater than 1) this value is not populated. - id string
- (DEPRECATED) Unique identifer of the replication document for a zone in a Global Cluster. This value corresponds to the legacy sharding schema (no independent shard scaling) and is different from the Shard ID you may see in the Atlas UI.
- num
Shards number - Provide this value if you set a
cluster_typeof SHARDED or GEOSHARDED. Omit this value if you selected acluster_typeof REPLICASET. This API resource accepts 1 through 50, inclusive. This parameter defaults to 1. If you specify anum_shardsvalue of 1 and acluster_typeof 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. If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards. To learn more, see Convert a replica set to a sharded cluster documentation and Convert a replica set to a sharded cluster tutorial. (DEPRECATED) To learn more, see the 1.18.0 Upgrade Guide. - zone
Id string - Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. If clusterType is GEOSHARDED, this value indicates the zone that the given shard belongs to and can be used to configure Global Cluster backup policies.
- zone
Name string - Name for the zone in a Global Cluster.
- region_
configs Sequence[AdvancedCluster Replication Spec Region Config] - Configuration for the hardware specifications for nodes set for a given regionEach
region_configsobject describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Eachregion_configsobject must have either ananalytics_specsobject,electable_specsobject, orread_only_specsobject. See below - container_
id Mapping[str, str] - external_
id str - Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. This value corresponds to Shard ID displayed in the UI. When using old sharding configuration (replication spec with
num_shardsgreater than 1) this value is not populated. - id str
- (DEPRECATED) Unique identifer of the replication document for a zone in a Global Cluster. This value corresponds to the legacy sharding schema (no independent shard scaling) and is different from the Shard ID you may see in the Atlas UI.
- num_
shards int - Provide this value if you set a
cluster_typeof SHARDED or GEOSHARDED. Omit this value if you selected acluster_typeof REPLICASET. This API resource accepts 1 through 50, inclusive. This parameter defaults to 1. If you specify anum_shardsvalue of 1 and acluster_typeof 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. If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards. To learn more, see Convert a replica set to a sharded cluster documentation and Convert a replica set to a sharded cluster tutorial. (DEPRECATED) To learn more, see the 1.18.0 Upgrade Guide. - zone_
id str - Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. If clusterType is GEOSHARDED, this value indicates the zone that the given shard belongs to and can be used to configure Global Cluster backup policies.
- zone_
name str - Name for the zone in a Global Cluster.
- region
Configs List<Property Map> - Configuration for the hardware specifications for nodes set for a given regionEach
region_configsobject describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Eachregion_configsobject must have either ananalytics_specsobject,electable_specsobject, orread_only_specsobject. See below - container
Id Map<String> - external
Id String - Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. This value corresponds to Shard ID displayed in the UI. When using old sharding configuration (replication spec with
num_shardsgreater than 1) this value is not populated. - id String
- (DEPRECATED) Unique identifer of the replication document for a zone in a Global Cluster. This value corresponds to the legacy sharding schema (no independent shard scaling) and is different from the Shard ID you may see in the Atlas UI.
- num
Shards Number - Provide this value if you set a
cluster_typeof SHARDED or GEOSHARDED. Omit this value if you selected acluster_typeof REPLICASET. This API resource accepts 1 through 50, inclusive. This parameter defaults to 1. If you specify anum_shardsvalue of 1 and acluster_typeof 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. If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards. To learn more, see Convert a replica set to a sharded cluster documentation and Convert a replica set to a sharded cluster tutorial. (DEPRECATED) To learn more, see the 1.18.0 Upgrade Guide. - zone
Id String - Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. If clusterType is GEOSHARDED, this value indicates the zone that the given shard belongs to and can be used to configure Global Cluster backup policies.
- zone
Name String - Name for the zone in a Global Cluster.
AdvancedClusterReplicationSpecRegionConfig, AdvancedClusterReplicationSpecRegionConfigArgs
- Priority int
- Election priority of the region. For regions with only read-only nodes, set this value to 0.
- If you have multiple
region_configsobjects (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_countto 1 or higher, it must have a priority of exactly one (1) less than another region in thereplication_specs.#.region_configs.#array. The highest-priority region must have a priority of 7. The lowest possible priority is 1.
- If you have multiple
- Provider
Name string - Cloud service provider on which the servers are provisioned.
The possible values are:
AWS- Amazon AWSGCP- Google Cloud PlatformAZURE- Microsoft AzureTENANT- M0, M2 or M5 multi-tenant cluster. Usereplication_specs.#.region_configs.#.backing_provider_nameto set the cloud service provider.
- Region
Name 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.
- Analytics
Auto AdvancedScaling Cluster Replication Spec Region Config Analytics Auto Scaling - Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. The values for the
analytics_auto_scalingparameter must be the same for allregion_configsin allreplication_specs. See below - Analytics
Specs AdvancedCluster Replication Spec Region Config Analytics Specs - 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 AdvancedCluster Replication Spec Region Config Auto Scaling - Configuration for the Collection of settings that configures auto-scaling information for the cluster. The values for the
auto_scalingparameter must be the same for allregion_configsin allreplication_specs. See below - Backing
Provider stringName - Cloud service provider on which you provision the host for a multi-tenant cluster. Use this only when a
provider_nameisTENANTandinstance_sizeof a specs isM2orM5. - Electable
Specs AdvancedCluster Replication Spec Region Config Electable Specs - 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 AdvancedSpecs Cluster Replication Spec Region Config Read Only Specs - 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_configsobjects (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_countto 1 or higher, it must have a priority of exactly one (1) less than another region in thereplication_specs.#.region_configs.#array. The highest-priority region must have a priority of 7. The lowest possible priority is 1.
- If you have multiple
- Provider
Name string - Cloud service provider on which the servers are provisioned.
The possible values are:
AWS- Amazon AWSGCP- Google Cloud PlatformAZURE- Microsoft AzureTENANT- M0, M2 or M5 multi-tenant cluster. Usereplication_specs.#.region_configs.#.backing_provider_nameto set the cloud service provider.
- Region
Name 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.
- Analytics
Auto AdvancedScaling Cluster Replication Spec Region Config Analytics Auto Scaling - Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. The values for the
analytics_auto_scalingparameter must be the same for allregion_configsin allreplication_specs. See below - Analytics
Specs AdvancedCluster Replication Spec Region Config Analytics Specs - 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 AdvancedCluster Replication Spec Region Config Auto Scaling - Configuration for the Collection of settings that configures auto-scaling information for the cluster. The values for the
auto_scalingparameter must be the same for allregion_configsin allreplication_specs. See below - Backing
Provider stringName - Cloud service provider on which you provision the host for a multi-tenant cluster. Use this only when a
provider_nameisTENANTandinstance_sizeof a specs isM2orM5. - Electable
Specs AdvancedCluster Replication Spec Region Config Electable Specs - 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 AdvancedSpecs Cluster Replication Spec Region Config Read Only Specs - 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_configsobjects (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_countto 1 or higher, it must have a priority of exactly one (1) less than another region in thereplication_specs.#.region_configs.#array. The highest-priority region must have a priority of 7. The lowest possible priority is 1.
- If you have multiple
- provider
Name String - Cloud service provider on which the servers are provisioned.
The possible values are:
AWS- Amazon AWSGCP- Google Cloud PlatformAZURE- Microsoft AzureTENANT- M0, M2 or M5 multi-tenant cluster. Usereplication_specs.#.region_configs.#.backing_provider_nameto set the cloud service provider.
- region
Name 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.
- analytics
Auto AdvancedScaling Cluster Replication Spec Region Config Analytics Auto Scaling - Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. The values for the
analytics_auto_scalingparameter must be the same for allregion_configsin allreplication_specs. See below - analytics
Specs AdvancedCluster Replication Spec Region Config Analytics Specs - 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 AdvancedCluster Replication Spec Region Config Auto Scaling - Configuration for the Collection of settings that configures auto-scaling information for the cluster. The values for the
auto_scalingparameter must be the same for allregion_configsin allreplication_specs. See below - backing
Provider StringName - Cloud service provider on which you provision the host for a multi-tenant cluster. Use this only when a
provider_nameisTENANTandinstance_sizeof a specs isM2orM5. - electable
Specs AdvancedCluster Replication Spec Region Config Electable Specs - 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 AdvancedSpecs Cluster Replication Spec Region Config Read Only Specs - 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_configsobjects (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_countto 1 or higher, it must have a priority of exactly one (1) less than another region in thereplication_specs.#.region_configs.#array. The highest-priority region must have a priority of 7. The lowest possible priority is 1.
- If you have multiple
- provider
Name string - Cloud service provider on which the servers are provisioned.
The possible values are:
AWS- Amazon AWSGCP- Google Cloud PlatformAZURE- Microsoft AzureTENANT- M0, M2 or M5 multi-tenant cluster. Usereplication_specs.#.region_configs.#.backing_provider_nameto set the cloud service provider.
- region
Name 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.
- analytics
Auto AdvancedScaling Cluster Replication Spec Region Config Analytics Auto Scaling - Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. The values for the
analytics_auto_scalingparameter must be the same for allregion_configsin allreplication_specs. See below - analytics
Specs AdvancedCluster Replication Spec Region Config Analytics Specs - 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 AdvancedCluster Replication Spec Region Config Auto Scaling - Configuration for the Collection of settings that configures auto-scaling information for the cluster. The values for the
auto_scalingparameter must be the same for allregion_configsin allreplication_specs. See below - backing
Provider stringName - Cloud service provider on which you provision the host for a multi-tenant cluster. Use this only when a
provider_nameisTENANTandinstance_sizeof a specs isM2orM5. - electable
Specs AdvancedCluster Replication Spec Region Config Electable Specs - 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 AdvancedSpecs Cluster Replication Spec Region Config Read Only Specs - 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_configsobjects (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_countto 1 or higher, it must have a priority of exactly one (1) less than another region in thereplication_specs.#.region_configs.#array. The highest-priority region must have a priority of 7. The lowest possible priority is 1.
- If you have multiple
- provider_
name str - Cloud service provider on which the servers are provisioned.
The possible values are:
AWS- Amazon AWSGCP- Google Cloud PlatformAZURE- Microsoft AzureTENANT- M0, M2 or M5 multi-tenant cluster. Usereplication_specs.#.region_configs.#.backing_provider_nameto set the cloud service provider.
- 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_
auto_ Advancedscaling Cluster Replication Spec Region Config Analytics Auto Scaling - Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. The values for the
analytics_auto_scalingparameter must be the same for allregion_configsin allreplication_specs. See below - analytics_
specs AdvancedCluster Replication Spec Region Config Analytics Specs - 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 AdvancedCluster Replication Spec Region Config Auto Scaling - Configuration for the Collection of settings that configures auto-scaling information for the cluster. The values for the
auto_scalingparameter must be the same for allregion_configsin allreplication_specs. See below - backing_
provider_ strname - Cloud service provider on which you provision the host for a multi-tenant cluster. Use this only when a
provider_nameisTENANTandinstance_sizeof a specs isM2orM5. - electable_
specs AdvancedCluster Replication Spec Region Config Electable Specs - 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_ Advancedspecs Cluster Replication Spec Region Config Read Only Specs - 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_configsobjects (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_countto 1 or higher, it must have a priority of exactly one (1) less than another region in thereplication_specs.#.region_configs.#array. The highest-priority region must have a priority of 7. The lowest possible priority is 1.
- If you have multiple
- provider
Name String - Cloud service provider on which the servers are provisioned.
The possible values are:
AWS- Amazon AWSGCP- Google Cloud PlatformAZURE- Microsoft AzureTENANT- M0, M2 or M5 multi-tenant cluster. Usereplication_specs.#.region_configs.#.backing_provider_nameto set the cloud service provider.
- region
Name 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.
- analytics
Auto Property MapScaling - Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. The values for the
analytics_auto_scalingparameter must be the same for allregion_configsin allreplication_specs. See below - analytics
Specs 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
- auto
Scaling Property Map - Configuration for the Collection of settings that configures auto-scaling information for the cluster. The values for the
auto_scalingparameter must be the same for allregion_configsin allreplication_specs. See below - backing
Provider StringName - Cloud service provider on which you provision the host for a multi-tenant cluster. Use this only when a
provider_nameisTENANTandinstance_sizeof a specs isM2orM5. - electable
Specs 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
- read
Only Property MapSpecs - 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
AdvancedClusterReplicationSpecRegionConfigAnalyticsAutoScaling, AdvancedClusterReplicationSpecRegionConfigAnalyticsAutoScalingArgs
- Compute
Enabled bool - Compute
Max stringInstance Size - Maximum instance size to which your cluster can automatically scale (such as M40). Atlas requires this parameter if
replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_enabledis true. - Compute
Min stringInstance Size - Minimum instance size to which your cluster can automatically scale (such as M10). Atlas requires this parameter if
replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_scale_down_enabledis true. - Compute
Scale boolDown Enabled - Flag that indicates whether the instance size may scale down. Atlas requires this parameter if
replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_enabled: true. If you enable this option, specify a value forreplication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_min_instance_size. - Disk
Gb boolEnabled - Flag that indicates whether this cluster enables disk auto-scaling. This parameter defaults to false.
- Compute
Enabled bool - Compute
Max stringInstance Size - Maximum instance size to which your cluster can automatically scale (such as M40). Atlas requires this parameter if
replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_enabledis true. - Compute
Min stringInstance Size - Minimum instance size to which your cluster can automatically scale (such as M10). Atlas requires this parameter if
replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_scale_down_enabledis true. - Compute
Scale boolDown Enabled - Flag that indicates whether the instance size may scale down. Atlas requires this parameter if
replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_enabled: true. If you enable this option, specify a value forreplication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_min_instance_size. - Disk
Gb boolEnabled - Flag that indicates whether this cluster enables disk auto-scaling. This parameter defaults to false.
- compute
Enabled Boolean - compute
Max StringInstance Size - Maximum instance size to which your cluster can automatically scale (such as M40). Atlas requires this parameter if
replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_enabledis true. - compute
Min StringInstance Size - Minimum instance size to which your cluster can automatically scale (such as M10). Atlas requires this parameter if
replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_scale_down_enabledis true. - compute
Scale BooleanDown Enabled - Flag that indicates whether the instance size may scale down. Atlas requires this parameter if
replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_enabled: true. If you enable this option, specify a value forreplication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_min_instance_size. - disk
Gb BooleanEnabled - Flag that indicates whether this cluster enables disk auto-scaling. This parameter defaults to false.
- compute
Enabled boolean - compute
Max stringInstance Size - Maximum instance size to which your cluster can automatically scale (such as M40). Atlas requires this parameter if
replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_enabledis true. - compute
Min stringInstance Size - Minimum instance size to which your cluster can automatically scale (such as M10). Atlas requires this parameter if
replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_scale_down_enabledis true. - compute
Scale booleanDown Enabled - Flag that indicates whether the instance size may scale down. Atlas requires this parameter if
replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_enabled: true. If you enable this option, specify a value forreplication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_min_instance_size. - disk
Gb booleanEnabled - Flag that indicates whether this cluster enables disk auto-scaling. This parameter defaults to false.
- compute_
enabled bool - compute_
max_ strinstance_ size - Maximum instance size to which your cluster can automatically scale (such as M40). Atlas requires this parameter if
replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_enabledis true. - compute_
min_ strinstance_ size - Minimum instance size to which your cluster can automatically scale (such as M10). Atlas requires this parameter if
replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_scale_down_enabledis true. - compute_
scale_ booldown_ enabled - Flag that indicates whether the instance size may scale down. Atlas requires this parameter if
replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_enabled: true. If you enable this option, specify a value forreplication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_min_instance_size. - disk_
gb_ boolenabled - Flag that indicates whether this cluster enables disk auto-scaling. This parameter defaults to false.
- compute
Enabled Boolean - compute
Max StringInstance Size - Maximum instance size to which your cluster can automatically scale (such as M40). Atlas requires this parameter if
replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_enabledis true. - compute
Min StringInstance Size - Minimum instance size to which your cluster can automatically scale (such as M10). Atlas requires this parameter if
replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_scale_down_enabledis true. - compute
Scale BooleanDown Enabled - Flag that indicates whether the instance size may scale down. Atlas requires this parameter if
replication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_enabled: true. If you enable this option, specify a value forreplication_specs.#.region_configs.#.analytics_auto_scaling.0.compute_min_instance_size. - disk
Gb BooleanEnabled - Flag that indicates whether this cluster enables disk auto-scaling. This parameter defaults to false.
AdvancedClusterReplicationSpecRegionConfigAnalyticsSpecs, AdvancedClusterReplicationSpecRegionConfigAnalyticsSpecsArgs
- Instance
Size 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. Electable nodes and read-only nodes (known as "base nodes") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.
- Disk
Iops int - Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. Define this attribute only if you selected AWS as your cloud service provider,
instance_sizeis set to "M30" or greater (not including "Mxx_NVME" tiers), andebs_volume_typeis "PROVISIONED". You can't set this attribute for a multi-cloud cluster. - Disk
Size doubleGb - Storage capacity that the host's root volume possesses expressed in gigabytes. This value must be equal for all shards and node types. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier. Note: Using
disk_size_gbwith Standard IOPS could lead to errors and configuration issues. Therefore, it should be used only with the Provisioned IOPS volume type. When using Provisioned IOPS, the disk_size_gb parameter specifies the storage capacity, but the IOPS are set independently. Ensuring thatdisk_size_gbis used exclusively with Provisioned IOPS will help avoid these issues. - Ebs
Volume stringType - 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:
STANDARDvolume types can't exceed the default IOPS rate for the selected volume size.PROVISIONEDvolume types must fall within the allowable IOPS range for the selected volume size.
- Node
Count int - Number of nodes of the given type for MongoDB Atlas to deploy to the region.
- Instance
Size 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. Electable nodes and read-only nodes (known as "base nodes") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.
- Disk
Iops int - Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. Define this attribute only if you selected AWS as your cloud service provider,
instance_sizeis set to "M30" or greater (not including "Mxx_NVME" tiers), andebs_volume_typeis "PROVISIONED". You can't set this attribute for a multi-cloud cluster. - Disk
Size float64Gb - Storage capacity that the host's root volume possesses expressed in gigabytes. This value must be equal for all shards and node types. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier. Note: Using
disk_size_gbwith Standard IOPS could lead to errors and configuration issues. Therefore, it should be used only with the Provisioned IOPS volume type. When using Provisioned IOPS, the disk_size_gb parameter specifies the storage capacity, but the IOPS are set independently. Ensuring thatdisk_size_gbis used exclusively with Provisioned IOPS will help avoid these issues. - Ebs
Volume stringType - 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:
STANDARDvolume types can't exceed the default IOPS rate for the selected volume size.PROVISIONEDvolume types must fall within the allowable IOPS range for the selected volume size.
- Node
Count int - Number of nodes of the given type for MongoDB Atlas to deploy to the region.
- instance
Size 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. Electable nodes and read-only nodes (known as "base nodes") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.
- disk
Iops Integer - Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. Define this attribute only if you selected AWS as your cloud service provider,
instance_sizeis set to "M30" or greater (not including "Mxx_NVME" tiers), andebs_volume_typeis "PROVISIONED". You can't set this attribute for a multi-cloud cluster. - disk
Size DoubleGb - Storage capacity that the host's root volume possesses expressed in gigabytes. This value must be equal for all shards and node types. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier. Note: Using
disk_size_gbwith Standard IOPS could lead to errors and configuration issues. Therefore, it should be used only with the Provisioned IOPS volume type. When using Provisioned IOPS, the disk_size_gb parameter specifies the storage capacity, but the IOPS are set independently. Ensuring thatdisk_size_gbis used exclusively with Provisioned IOPS will help avoid these issues. - ebs
Volume StringType - 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:
STANDARDvolume types can't exceed the default IOPS rate for the selected volume size.PROVISIONEDvolume types must fall within the allowable IOPS range for the selected volume size.
- node
Count Integer - Number of nodes of the given type for MongoDB Atlas to deploy to the region.
- instance
Size 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. Electable nodes and read-only nodes (known as "base nodes") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.
- disk
Iops number - Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. Define this attribute only if you selected AWS as your cloud service provider,
instance_sizeis set to "M30" or greater (not including "Mxx_NVME" tiers), andebs_volume_typeis "PROVISIONED". You can't set this attribute for a multi-cloud cluster. - disk
Size numberGb - Storage capacity that the host's root volume possesses expressed in gigabytes. This value must be equal for all shards and node types. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier. Note: Using
disk_size_gbwith Standard IOPS could lead to errors and configuration issues. Therefore, it should be used only with the Provisioned IOPS volume type. When using Provisioned IOPS, the disk_size_gb parameter specifies the storage capacity, but the IOPS are set independently. Ensuring thatdisk_size_gbis used exclusively with Provisioned IOPS will help avoid these issues. - ebs
Volume stringType - 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:
STANDARDvolume types can't exceed the default IOPS rate for the selected volume size.PROVISIONEDvolume types must fall within the allowable IOPS range for the selected volume size.
- node
Count number - Number of nodes of the given type for MongoDB Atlas to deploy to the region.
- 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. Electable nodes and read-only nodes (known as "base nodes") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.
- disk_
iops int - Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. Define this attribute only if you selected AWS as your cloud service provider,
instance_sizeis set to "M30" or greater (not including "Mxx_NVME" tiers), andebs_volume_typeis "PROVISIONED". You can't set this attribute for a multi-cloud cluster. - disk_
size_ floatgb - Storage capacity that the host's root volume possesses expressed in gigabytes. This value must be equal for all shards and node types. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier. Note: Using
disk_size_gbwith Standard IOPS could lead to errors and configuration issues. Therefore, it should be used only with the Provisioned IOPS volume type. When using Provisioned IOPS, the disk_size_gb parameter specifies the storage capacity, but the IOPS are set independently. Ensuring thatdisk_size_gbis used exclusively with Provisioned IOPS will help avoid these issues. - ebs_
volume_ strtype - 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:
STANDARDvolume types can't exceed the default IOPS rate for the selected volume size.PROVISIONEDvolume types must fall within the allowable IOPS range for the selected volume size.
- node_
count int - Number of nodes of the given type for MongoDB Atlas to deploy to the region.
- instance
Size 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. Electable nodes and read-only nodes (known as "base nodes") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.
- disk
Iops Number - Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. Define this attribute only if you selected AWS as your cloud service provider,
instance_sizeis set to "M30" or greater (not including "Mxx_NVME" tiers), andebs_volume_typeis "PROVISIONED". You can't set this attribute for a multi-cloud cluster. - disk
Size NumberGb - Storage capacity that the host's root volume possesses expressed in gigabytes. This value must be equal for all shards and node types. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier. Note: Using
disk_size_gbwith Standard IOPS could lead to errors and configuration issues. Therefore, it should be used only with the Provisioned IOPS volume type. When using Provisioned IOPS, the disk_size_gb parameter specifies the storage capacity, but the IOPS are set independently. Ensuring thatdisk_size_gbis used exclusively with Provisioned IOPS will help avoid these issues. - ebs
Volume StringType - 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:
STANDARDvolume types can't exceed the default IOPS rate for the selected volume size.PROVISIONEDvolume types must fall within the allowable IOPS range for the selected volume size.
- node
Count Number - Number of nodes of the given type for MongoDB Atlas to deploy to the region.
AdvancedClusterReplicationSpecRegionConfigAutoScaling, AdvancedClusterReplicationSpecRegionConfigAutoScalingArgs
- Compute
Enabled bool - Compute
Max stringInstance Size - 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_enabledis true. - Compute
Min stringInstance Size - 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_enabledis true. - Compute
Scale boolDown Enabled - 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 forreplication_specs.#.region_configs.#.auto_scaling.0.compute_min_instance_size. - Disk
Gb boolEnabled
- Compute
Enabled bool - Compute
Max stringInstance Size - 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_enabledis true. - Compute
Min stringInstance Size - 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_enabledis true. - Compute
Scale boolDown Enabled - 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 forreplication_specs.#.region_configs.#.auto_scaling.0.compute_min_instance_size. - Disk
Gb boolEnabled
- compute
Enabled Boolean - compute
Max StringInstance Size - 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_enabledis true. - compute
Min StringInstance Size - 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_enabledis true. - compute
Scale BooleanDown Enabled - 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 forreplication_specs.#.region_configs.#.auto_scaling.0.compute_min_instance_size. - disk
Gb BooleanEnabled
- compute
Enabled boolean - compute
Max stringInstance Size - 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_enabledis true. - compute
Min stringInstance Size - 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_enabledis true. - compute
Scale booleanDown Enabled - 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 forreplication_specs.#.region_configs.#.auto_scaling.0.compute_min_instance_size. - disk
Gb booleanEnabled
- compute_
enabled bool - compute_
max_ strinstance_ size - 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_enabledis true. - compute_
min_ strinstance_ size - 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_enabledis true. - compute_
scale_ booldown_ enabled - 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 forreplication_specs.#.region_configs.#.auto_scaling.0.compute_min_instance_size. - disk_
gb_ boolenabled
- compute
Enabled Boolean - compute
Max StringInstance Size - 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_enabledis true. - compute
Min StringInstance Size - 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_enabledis true. - compute
Scale BooleanDown Enabled - 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 forreplication_specs.#.region_configs.#.auto_scaling.0.compute_min_instance_size. - disk
Gb BooleanEnabled
AdvancedClusterReplicationSpecRegionConfigElectableSpecs, AdvancedClusterReplicationSpecRegionConfigElectableSpecsArgs
- Instance
Size 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. Electable nodes and read-only nodes (known as "base nodes") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.
- Disk
Iops int - Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. Define this attribute only if you selected AWS as your cloud service provider,
instance_sizeis set to "M30" or greater (not including "Mxx_NVME" tiers), andebs_volume_typeis "PROVISIONED". You can't set this attribute for a multi-cloud cluster. - Disk
Size doubleGb - Storage capacity that the host's root volume possesses expressed in gigabytes. This value must be equal for all shards and node types. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier. Note: Using
disk_size_gbwith Standard IOPS could lead to errors and configuration issues. Therefore, it should be used only with the Provisioned IOPS volume type. When using Provisioned IOPS, the disk_size_gb parameter specifies the storage capacity, but the IOPS are set independently. Ensuring thatdisk_size_gbis used exclusively with Provisioned IOPS will help avoid these issues. - Ebs
Volume stringType - 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:
STANDARDvolume types can't exceed the default IOPS rate for the selected volume size.PROVISIONEDvolume types must fall within the allowable IOPS range for the selected volume size.
- Node
Count int - Number of nodes of the given type for MongoDB Atlas to deploy to the region.
- Instance
Size 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. Electable nodes and read-only nodes (known as "base nodes") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.
- Disk
Iops int - Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. Define this attribute only if you selected AWS as your cloud service provider,
instance_sizeis set to "M30" or greater (not including "Mxx_NVME" tiers), andebs_volume_typeis "PROVISIONED". You can't set this attribute for a multi-cloud cluster. - Disk
Size float64Gb - Storage capacity that the host's root volume possesses expressed in gigabytes. This value must be equal for all shards and node types. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier. Note: Using
disk_size_gbwith Standard IOPS could lead to errors and configuration issues. Therefore, it should be used only with the Provisioned IOPS volume type. When using Provisioned IOPS, the disk_size_gb parameter specifies the storage capacity, but the IOPS are set independently. Ensuring thatdisk_size_gbis used exclusively with Provisioned IOPS will help avoid these issues. - Ebs
Volume stringType - 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:
STANDARDvolume types can't exceed the default IOPS rate for the selected volume size.PROVISIONEDvolume types must fall within the allowable IOPS range for the selected volume size.
- Node
Count int - Number of nodes of the given type for MongoDB Atlas to deploy to the region.
- instance
Size 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. Electable nodes and read-only nodes (known as "base nodes") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.
- disk
Iops Integer - Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. Define this attribute only if you selected AWS as your cloud service provider,
instance_sizeis set to "M30" or greater (not including "Mxx_NVME" tiers), andebs_volume_typeis "PROVISIONED". You can't set this attribute for a multi-cloud cluster. - disk
Size DoubleGb - Storage capacity that the host's root volume possesses expressed in gigabytes. This value must be equal for all shards and node types. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier. Note: Using
disk_size_gbwith Standard IOPS could lead to errors and configuration issues. Therefore, it should be used only with the Provisioned IOPS volume type. When using Provisioned IOPS, the disk_size_gb parameter specifies the storage capacity, but the IOPS are set independently. Ensuring thatdisk_size_gbis used exclusively with Provisioned IOPS will help avoid these issues. - ebs
Volume StringType - 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:
STANDARDvolume types can't exceed the default IOPS rate for the selected volume size.PROVISIONEDvolume types must fall within the allowable IOPS range for the selected volume size.
- node
Count Integer - Number of nodes of the given type for MongoDB Atlas to deploy to the region.
- instance
Size 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. Electable nodes and read-only nodes (known as "base nodes") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.
- disk
Iops number - Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. Define this attribute only if you selected AWS as your cloud service provider,
instance_sizeis set to "M30" or greater (not including "Mxx_NVME" tiers), andebs_volume_typeis "PROVISIONED". You can't set this attribute for a multi-cloud cluster. - disk
Size numberGb - Storage capacity that the host's root volume possesses expressed in gigabytes. This value must be equal for all shards and node types. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier. Note: Using
disk_size_gbwith Standard IOPS could lead to errors and configuration issues. Therefore, it should be used only with the Provisioned IOPS volume type. When using Provisioned IOPS, the disk_size_gb parameter specifies the storage capacity, but the IOPS are set independently. Ensuring thatdisk_size_gbis used exclusively with Provisioned IOPS will help avoid these issues. - ebs
Volume stringType - 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:
STANDARDvolume types can't exceed the default IOPS rate for the selected volume size.PROVISIONEDvolume types must fall within the allowable IOPS range for the selected volume size.
- node
Count number - Number of nodes of the given type for MongoDB Atlas to deploy to the region.
- 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. Electable nodes and read-only nodes (known as "base nodes") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.
- disk_
iops int - Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. Define this attribute only if you selected AWS as your cloud service provider,
instance_sizeis set to "M30" or greater (not including "Mxx_NVME" tiers), andebs_volume_typeis "PROVISIONED". You can't set this attribute for a multi-cloud cluster. - disk_
size_ floatgb - Storage capacity that the host's root volume possesses expressed in gigabytes. This value must be equal for all shards and node types. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier. Note: Using
disk_size_gbwith Standard IOPS could lead to errors and configuration issues. Therefore, it should be used only with the Provisioned IOPS volume type. When using Provisioned IOPS, the disk_size_gb parameter specifies the storage capacity, but the IOPS are set independently. Ensuring thatdisk_size_gbis used exclusively with Provisioned IOPS will help avoid these issues. - ebs_
volume_ strtype - 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:
STANDARDvolume types can't exceed the default IOPS rate for the selected volume size.PROVISIONEDvolume types must fall within the allowable IOPS range for the selected volume size.
- node_
count int - Number of nodes of the given type for MongoDB Atlas to deploy to the region.
- instance
Size 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. Electable nodes and read-only nodes (known as "base nodes") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.
- disk
Iops Number - Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. Define this attribute only if you selected AWS as your cloud service provider,
instance_sizeis set to "M30" or greater (not including "Mxx_NVME" tiers), andebs_volume_typeis "PROVISIONED". You can't set this attribute for a multi-cloud cluster. - disk
Size NumberGb - Storage capacity that the host's root volume possesses expressed in gigabytes. This value must be equal for all shards and node types. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier. Note: Using
disk_size_gbwith Standard IOPS could lead to errors and configuration issues. Therefore, it should be used only with the Provisioned IOPS volume type. When using Provisioned IOPS, the disk_size_gb parameter specifies the storage capacity, but the IOPS are set independently. Ensuring thatdisk_size_gbis used exclusively with Provisioned IOPS will help avoid these issues. - ebs
Volume StringType - 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:
STANDARDvolume types can't exceed the default IOPS rate for the selected volume size.PROVISIONEDvolume types must fall within the allowable IOPS range for the selected volume size.
- node
Count Number - Number of nodes of the given type for MongoDB Atlas to deploy to the region.
AdvancedClusterReplicationSpecRegionConfigReadOnlySpecs, AdvancedClusterReplicationSpecRegionConfigReadOnlySpecsArgs
- Instance
Size 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. Electable nodes and read-only nodes (known as "base nodes") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.
- Disk
Iops int - Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. Define this attribute only if you selected AWS as your cloud service provider,
instance_sizeis set to "M30" or greater (not including "Mxx_NVME" tiers), andebs_volume_typeis "PROVISIONED". You can't set this attribute for a multi-cloud cluster. This parameter defaults to the cluster tier's standard IOPS value. - Disk
Size doubleGb - Storage capacity that the host's root volume possesses expressed in gigabytes. This value must be equal for all shards and node types. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier. Note: Using
disk_size_gbwith Standard IOPS could lead to errors and configuration issues. Therefore, it should be used only with the Provisioned IOPS volume type. When using Provisioned IOPS, the disk_size_gb parameter specifies the storage capacity, but the IOPS are set independently. Ensuring thatdisk_size_gbis used exclusively with Provisioned IOPS will help avoid these issues. - Ebs
Volume stringType - 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:
STANDARDvolume types can't exceed the default IOPS rate for the selected volume size.PROVISIONEDvolume types must fall within the allowable IOPS range for the selected volume size.
- Node
Count int - Number of nodes of the given type for MongoDB Atlas to deploy to the region.
- Instance
Size 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. Electable nodes and read-only nodes (known as "base nodes") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.
- Disk
Iops int - Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. Define this attribute only if you selected AWS as your cloud service provider,
instance_sizeis set to "M30" or greater (not including "Mxx_NVME" tiers), andebs_volume_typeis "PROVISIONED". You can't set this attribute for a multi-cloud cluster. This parameter defaults to the cluster tier's standard IOPS value. - Disk
Size float64Gb - Storage capacity that the host's root volume possesses expressed in gigabytes. This value must be equal for all shards and node types. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier. Note: Using
disk_size_gbwith Standard IOPS could lead to errors and configuration issues. Therefore, it should be used only with the Provisioned IOPS volume type. When using Provisioned IOPS, the disk_size_gb parameter specifies the storage capacity, but the IOPS are set independently. Ensuring thatdisk_size_gbis used exclusively with Provisioned IOPS will help avoid these issues. - Ebs
Volume stringType - 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:
STANDARDvolume types can't exceed the default IOPS rate for the selected volume size.PROVISIONEDvolume types must fall within the allowable IOPS range for the selected volume size.
- Node
Count int - Number of nodes of the given type for MongoDB Atlas to deploy to the region.
- instance
Size 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. Electable nodes and read-only nodes (known as "base nodes") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.
- disk
Iops Integer - Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. Define this attribute only if you selected AWS as your cloud service provider,
instance_sizeis set to "M30" or greater (not including "Mxx_NVME" tiers), andebs_volume_typeis "PROVISIONED". You can't set this attribute for a multi-cloud cluster. This parameter defaults to the cluster tier's standard IOPS value. - disk
Size DoubleGb - Storage capacity that the host's root volume possesses expressed in gigabytes. This value must be equal for all shards and node types. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier. Note: Using
disk_size_gbwith Standard IOPS could lead to errors and configuration issues. Therefore, it should be used only with the Provisioned IOPS volume type. When using Provisioned IOPS, the disk_size_gb parameter specifies the storage capacity, but the IOPS are set independently. Ensuring thatdisk_size_gbis used exclusively with Provisioned IOPS will help avoid these issues. - ebs
Volume StringType - 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:
STANDARDvolume types can't exceed the default IOPS rate for the selected volume size.PROVISIONEDvolume types must fall within the allowable IOPS range for the selected volume size.
- node
Count Integer - Number of nodes of the given type for MongoDB Atlas to deploy to the region.
- instance
Size 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. Electable nodes and read-only nodes (known as "base nodes") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.
- disk
Iops number - Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. Define this attribute only if you selected AWS as your cloud service provider,
instance_sizeis set to "M30" or greater (not including "Mxx_NVME" tiers), andebs_volume_typeis "PROVISIONED". You can't set this attribute for a multi-cloud cluster. This parameter defaults to the cluster tier's standard IOPS value. - disk
Size numberGb - Storage capacity that the host's root volume possesses expressed in gigabytes. This value must be equal for all shards and node types. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier. Note: Using
disk_size_gbwith Standard IOPS could lead to errors and configuration issues. Therefore, it should be used only with the Provisioned IOPS volume type. When using Provisioned IOPS, the disk_size_gb parameter specifies the storage capacity, but the IOPS are set independently. Ensuring thatdisk_size_gbis used exclusively with Provisioned IOPS will help avoid these issues. - ebs
Volume stringType - 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:
STANDARDvolume types can't exceed the default IOPS rate for the selected volume size.PROVISIONEDvolume types must fall within the allowable IOPS range for the selected volume size.
- node
Count number - Number of nodes of the given type for MongoDB Atlas to deploy to the region.
- 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. Electable nodes and read-only nodes (known as "base nodes") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.
- disk_
iops int - Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. Define this attribute only if you selected AWS as your cloud service provider,
instance_sizeis set to "M30" or greater (not including "Mxx_NVME" tiers), andebs_volume_typeis "PROVISIONED". You can't set this attribute for a multi-cloud cluster. This parameter defaults to the cluster tier's standard IOPS value. - disk_
size_ floatgb - Storage capacity that the host's root volume possesses expressed in gigabytes. This value must be equal for all shards and node types. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier. Note: Using
disk_size_gbwith Standard IOPS could lead to errors and configuration issues. Therefore, it should be used only with the Provisioned IOPS volume type. When using Provisioned IOPS, the disk_size_gb parameter specifies the storage capacity, but the IOPS are set independently. Ensuring thatdisk_size_gbis used exclusively with Provisioned IOPS will help avoid these issues. - ebs_
volume_ strtype - 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:
STANDARDvolume types can't exceed the default IOPS rate for the selected volume size.PROVISIONEDvolume types must fall within the allowable IOPS range for the selected volume size.
- node_
count int - Number of nodes of the given type for MongoDB Atlas to deploy to the region.
- instance
Size 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. Electable nodes and read-only nodes (known as "base nodes") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.
- disk
Iops Number - Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. Define this attribute only if you selected AWS as your cloud service provider,
instance_sizeis set to "M30" or greater (not including "Mxx_NVME" tiers), andebs_volume_typeis "PROVISIONED". You can't set this attribute for a multi-cloud cluster. This parameter defaults to the cluster tier's standard IOPS value. - disk
Size NumberGb - Storage capacity that the host's root volume possesses expressed in gigabytes. This value must be equal for all shards and node types. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier. Note: Using
disk_size_gbwith Standard IOPS could lead to errors and configuration issues. Therefore, it should be used only with the Provisioned IOPS volume type. When using Provisioned IOPS, the disk_size_gb parameter specifies the storage capacity, but the IOPS are set independently. Ensuring thatdisk_size_gbis used exclusively with Provisioned IOPS will help avoid these issues. - ebs
Volume StringType - 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:
STANDARDvolume types can't exceed the default IOPS rate for the selected volume size.PROVISIONEDvolume types must fall within the allowable IOPS range for the selected volume size.
- node
Count Number - Number of nodes of the given type for MongoDB Atlas to deploy to the region.
AdvancedClusterTag, AdvancedClusterTagArgs
- Key string
- Constant that defines the set of the tag.
- Value string
Variable that belongs to the set of the tag.
To learn more, see Resource Tags.
- Key string
- Constant that defines the set of the tag.
- Value string
Variable that belongs to the set of the tag.
To learn more, see Resource Tags.
- key String
- Constant that defines the set of the tag.
- value String
Variable that belongs to the set of the tag.
To learn more, see Resource Tags.
- key string
- Constant that defines the set of the tag.
- value string
Variable that belongs to the set of the tag.
To learn more, see Resource Tags.
- key str
- Constant that defines the set of the tag.
- value str
Variable that belongs to the set of the tag.
To learn more, see Resource Tags.
- key String
- Constant that defines the set of the tag.
- value String
Variable that belongs to the set of the tag.
To learn more, see Resource Tags.
Package Details
- Repository
- MongoDB Atlas pulumi/pulumi-mongodbatlas
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
mongodbatlasTerraform Provider.