Want to learn about running containers in Lambda? Join our free hands-on workshop. Register Now

Cluster

mongodbatlas.Cluster provides a Cluster resource. The resource lets you create, edit and delete clusters. The resource requires your Project ID.

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

NOTE: A network container is created for a cluster to reside in if one does not yet exist in the project. To use this automatically created container with another resource, such as peering, the container_id is exported after creation.

IMPORTANT:
• Free tier cluster creation (M0) is not supported via API or by this Provider.
• Shared tier clusters (M2, M5) cannot be upgraded to higher tiers via API or by this Provider.
• Changes to cluster configurations can affect costs. Before making changes, please see Billing.

• If your Atlas project contains a custom role that uses actions introduced in a specific MongoDB version, you cannot create a cluster with a MongoDB version less than that version unless you delete the custom role.

Example Usage

Example AWS cluster

using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

class MyStack : Stack
{
    public MyStack()
    {
        var cluster_test = new Mongodbatlas.Cluster("cluster-test", new Mongodbatlas.ClusterArgs
        {
            AutoScalingDiskGbEnabled = true,
            DiskSizeGb = 100,
            MongoDbMajorVersion = "4.2",
            NumShards = 1,
            ProjectId = "<YOUR-PROJECT-ID>",
            ProviderBackupEnabled = true,
            ProviderDiskIops = 300,
            ProviderEncryptEbsVolume = true,
            ProviderInstanceSizeName = "M40",
            ProviderName = "AWS",
            ProviderRegionName = "US_EAST_1",
            ProviderVolumeType = "STANDARD",
            ReplicationFactor = 3,
        });
    }

}
package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := mongodbatlas.NewCluster(ctx, "cluster_test", &mongodbatlas.ClusterArgs{
            AutoScalingDiskGbEnabled: pulumi.Bool(true),
            DiskSizeGb:               pulumi.Float64(100),
            MongoDbMajorVersion:      pulumi.String("4.2"),
            NumShards:                pulumi.Int(1),
            ProjectId:                pulumi.String("<YOUR-PROJECT-ID>"),
            ProviderBackupEnabled:    pulumi.Bool(true),
            ProviderDiskIops:         pulumi.Int(300),
            ProviderEncryptEbsVolume: pulumi.Bool(true),
            ProviderInstanceSizeName: pulumi.String("M40"),
            ProviderName:             pulumi.String("AWS"),
            ProviderRegionName:       pulumi.String("US_EAST_1"),
            ProviderVolumeType:       pulumi.String("STANDARD"),
            ReplicationFactor:        pulumi.Int(3),
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_mongodbatlas as mongodbatlas

cluster_test = mongodbatlas.Cluster("cluster-test",
    auto_scaling_disk_gb_enabled=True,
    disk_size_gb=100,
    mongo_db_major_version="4.2",
    num_shards=1,
    project_id="<YOUR-PROJECT-ID>",
    provider_backup_enabled=True,
    provider_disk_iops=300,
    provider_encrypt_ebs_volume=True,
    provider_instance_size_name="M40",
    provider_name="AWS",
    provider_region_name="US_EAST_1",
    provider_volume_type="STANDARD",
    replication_factor=3)
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const cluster_test = new mongodbatlas.Cluster("cluster-test", {
    autoScalingDiskGbEnabled: true,
    diskSizeGb: 100,
    mongoDbMajorVersion: "4.2",
    numShards: 1,
    projectId: "<YOUR-PROJECT-ID>",
    providerBackupEnabled: true,
    providerDiskIops: 300,
    providerEncryptEbsVolume: true,
    providerInstanceSizeName: "M40",
    //Provider Settings "block"
    providerName: "AWS",
    providerRegionName: "US_EAST_1",
    providerVolumeType: "STANDARD",
    replicationFactor: 3,
});

Example Azure cluster.

using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

class MyStack : Stack
{
    public MyStack()
    {
        var test = new Mongodbatlas.Cluster("test", new Mongodbatlas.ClusterArgs
        {
            AutoScalingDiskGbEnabled = true,
            MongoDbMajorVersion = "4.2",
            NumShards = 1,
            ProjectId = "<YOUR-PROJECT-ID>",
            ProviderBackupEnabled = true,
            ProviderDiskTypeName = "P6",
            ProviderInstanceSizeName = "M30",
            ProviderName = "AZURE",
            ProviderRegionName = "US_EAST_2",
            ReplicationFactor = 3,
        });
    }

}
package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := mongodbatlas.NewCluster(ctx, "test", &mongodbatlas.ClusterArgs{
            AutoScalingDiskGbEnabled: pulumi.Bool(true),
            MongoDbMajorVersion:      pulumi.String("4.2"),
            NumShards:                pulumi.Int(1),
            ProjectId:                pulumi.String("<YOUR-PROJECT-ID>"),
            ProviderBackupEnabled:    pulumi.Bool(true),
            ProviderDiskTypeName:     pulumi.String("P6"),
            ProviderInstanceSizeName: pulumi.String("M30"),
            ProviderName:             pulumi.String("AZURE"),
            ProviderRegionName:       pulumi.String("US_EAST_2"),
            ReplicationFactor:        pulumi.Int(3),
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.Cluster("test",
    auto_scaling_disk_gb_enabled=True,
    mongo_db_major_version="4.2",
    num_shards=1,
    project_id="<YOUR-PROJECT-ID>",
    provider_backup_enabled=True,
    provider_disk_type_name="P6",
    provider_instance_size_name="M30",
    provider_name="AZURE",
    provider_region_name="US_EAST_2",
    replication_factor=3)
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const test = new mongodbatlas.Cluster("test", {
    autoScalingDiskGbEnabled: true,
    mongoDbMajorVersion: "4.2",
    numShards: 1,
    projectId: "<YOUR-PROJECT-ID>",
    providerBackupEnabled: true,
    providerDiskTypeName: "P6",
    providerInstanceSizeName: "M30",
    //Provider Settings "block"
    providerName: "AZURE",
    providerRegionName: "US_EAST_2",
    replicationFactor: 3,
});

Example GCP cluster

using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

class MyStack : Stack
{
    public MyStack()
    {
        var test = new Mongodbatlas.Cluster("test", new Mongodbatlas.ClusterArgs
        {
            AutoScalingDiskGbEnabled = true,
            DiskSizeGb = 40,
            MongoDbMajorVersion = "4.2",
            NumShards = 1,
            ProjectId = "<YOUR-PROJECT-ID>",
            ProviderBackupEnabled = true,
            ProviderInstanceSizeName = "M30",
            ProviderName = "GCP",
            ProviderRegionName = "US_EAST_4",
            ReplicationFactor = 3,
        });
    }

}
package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := mongodbatlas.NewCluster(ctx, "test", &mongodbatlas.ClusterArgs{
            AutoScalingDiskGbEnabled: pulumi.Bool(true),
            DiskSizeGb:               pulumi.Float64(40),
            MongoDbMajorVersion:      pulumi.String("4.2"),
            NumShards:                pulumi.Int(1),
            ProjectId:                pulumi.String("<YOUR-PROJECT-ID>"),
            ProviderBackupEnabled:    pulumi.Bool(true),
            ProviderInstanceSizeName: pulumi.String("M30"),
            ProviderName:             pulumi.String("GCP"),
            ProviderRegionName:       pulumi.String("US_EAST_4"),
            ReplicationFactor:        pulumi.Int(3),
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.Cluster("test",
    auto_scaling_disk_gb_enabled=True,
    disk_size_gb=40,
    mongo_db_major_version="4.2",
    num_shards=1,
    project_id="<YOUR-PROJECT-ID>",
    provider_backup_enabled=True,
    provider_instance_size_name="M30",
    provider_name="GCP",
    provider_region_name="US_EAST_4",
    replication_factor=3)
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const test = new mongodbatlas.Cluster("test", {
    autoScalingDiskGbEnabled: true,
    diskSizeGb: 40,
    mongoDbMajorVersion: "4.2",
    numShards: 1,
    projectId: "<YOUR-PROJECT-ID>",
    providerBackupEnabled: true,
    providerInstanceSizeName: "M30",
    //Provider Settings "block"
    providerName: "GCP",
    providerRegionName: "US_EAST_4",
    replicationFactor: 3,
});

Example Multi Region cluster

using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

class MyStack : Stack
{
    public MyStack()
    {
        var cluster_test = new Mongodbatlas.Cluster("cluster-test", new Mongodbatlas.ClusterArgs
        {
            ClusterType = "REPLICASET",
            DiskSizeGb = 100,
            NumShards = 1,
            ProjectId = "<YOUR-PROJECT-ID>",
            ProviderBackupEnabled = true,
            ProviderDiskIops = 300,
            ProviderInstanceSizeName = "M10",
            ProviderName = "AWS",
            ProviderVolumeType = "STANDARD",
            ReplicationSpecs = 
            {
                new Mongodbatlas.Inputs.ClusterReplicationSpecArgs
                {
                    NumShards = 1,
                    RegionsConfigs = 
                    {
                        new Mongodbatlas.Inputs.ClusterReplicationSpecRegionsConfigArgs
                        {
                            ElectableNodes = 3,
                            Priority = 7,
                            ReadOnlyNodes = 0,
                            RegionName = "US_EAST_1",
                        },
                        new Mongodbatlas.Inputs.ClusterReplicationSpecRegionsConfigArgs
                        {
                            ElectableNodes = 2,
                            Priority = 6,
                            ReadOnlyNodes = 0,
                            RegionName = "US_EAST_2",
                        },
                        new Mongodbatlas.Inputs.ClusterReplicationSpecRegionsConfigArgs
                        {
                            ElectableNodes = 2,
                            Priority = 5,
                            ReadOnlyNodes = 2,
                            RegionName = "US_WEST_1",
                        },
                    },
                },
            },
        });
    }

}
package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := mongodbatlas.NewCluster(ctx, "cluster_test", &mongodbatlas.ClusterArgs{
            ClusterType:              pulumi.String("REPLICASET"),
            DiskSizeGb:               pulumi.Float64(100),
            NumShards:                pulumi.Int(1),
            ProjectId:                pulumi.String("<YOUR-PROJECT-ID>"),
            ProviderBackupEnabled:    pulumi.Bool(true),
            ProviderDiskIops:         pulumi.Int(300),
            ProviderInstanceSizeName: pulumi.String("M10"),
            ProviderName:             pulumi.String("AWS"),
            ProviderVolumeType:       pulumi.String("STANDARD"),
            ReplicationSpecs: mongodbatlas.ClusterReplicationSpecArray{
                &mongodbatlas.ClusterReplicationSpecArgs{
                    NumShards: pulumi.Int(1),
                    RegionsConfigs: mongodbatlas.ClusterReplicationSpecRegionsConfigArray{
                        &mongodbatlas.ClusterReplicationSpecRegionsConfigArgs{
                            ElectableNodes: pulumi.Int(3),
                            Priority:       pulumi.Int(7),
                            ReadOnlyNodes:  pulumi.Int(0),
                            RegionName:     pulumi.String("US_EAST_1"),
                        },
                        &mongodbatlas.ClusterReplicationSpecRegionsConfigArgs{
                            ElectableNodes: pulumi.Int(2),
                            Priority:       pulumi.Int(6),
                            ReadOnlyNodes:  pulumi.Int(0),
                            RegionName:     pulumi.String("US_EAST_2"),
                        },
                        &mongodbatlas.ClusterReplicationSpecRegionsConfigArgs{
                            ElectableNodes: pulumi.Int(2),
                            Priority:       pulumi.Int(5),
                            ReadOnlyNodes:  pulumi.Int(2),
                            RegionName:     pulumi.String("US_WEST_1"),
                        },
                    },
                },
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_mongodbatlas as mongodbatlas

cluster_test = mongodbatlas.Cluster("cluster-test",
    cluster_type="REPLICASET",
    disk_size_gb=100,
    num_shards=1,
    project_id="<YOUR-PROJECT-ID>",
    provider_backup_enabled=True,
    provider_disk_iops=300,
    provider_instance_size_name="M10",
    provider_name="AWS",
    provider_volume_type="STANDARD",
    replication_specs=[mongodbatlas.ClusterReplicationSpecArgs(
        num_shards=1,
        regions_configs=[
            mongodbatlas.ClusterReplicationSpecRegionsConfigArgs(
                electable_nodes=3,
                priority=7,
                read_only_nodes=0,
                region_name="US_EAST_1",
            ),
            mongodbatlas.ClusterReplicationSpecRegionsConfigArgs(
                electable_nodes=2,
                priority=6,
                read_only_nodes=0,
                region_name="US_EAST_2",
            ),
            mongodbatlas.ClusterReplicationSpecRegionsConfigArgs(
                electable_nodes=2,
                priority=5,
                read_only_nodes=2,
                region_name="US_WEST_1",
            ),
        ],
    )])
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const cluster_test = new mongodbatlas.Cluster("cluster-test", {
    clusterType: "REPLICASET",
    diskSizeGb: 100,
    numShards: 1,
    projectId: "<YOUR-PROJECT-ID>",
    providerBackupEnabled: true,
    providerDiskIops: 300,
    providerInstanceSizeName: "M10",
    //Provider Settings "block"
    providerName: "AWS",
    providerVolumeType: "STANDARD",
    replicationSpecs: [{
        numShards: 1,
        regionsConfigs: [
            {
                electableNodes: 3,
                priority: 7,
                readOnlyNodes: 0,
                regionName: "US_EAST_1",
            },
            {
                electableNodes: 2,
                priority: 6,
                readOnlyNodes: 0,
                regionName: "US_EAST_2",
            },
            {
                electableNodes: 2,
                priority: 5,
                readOnlyNodes: 2,
                regionName: "US_WEST_1",
            },
        ],
    }],
});

Example Global cluster

using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

class MyStack : Stack
{
    public MyStack()
    {
        var cluster_test = new Mongodbatlas.Cluster("cluster-test", new Mongodbatlas.ClusterArgs
        {
            ClusterType = "GEOSHARDED",
            DiskSizeGb = 80,
            NumShards = 1,
            ProjectId = "<YOUR-PROJECT-ID>",
            ProviderBackupEnabled = true,
            ProviderDiskIops = 240,
            ProviderInstanceSizeName = "M30",
            ProviderName = "AWS",
            ProviderVolumeType = "STANDARD",
            ReplicationSpecs = 
            {
                new Mongodbatlas.Inputs.ClusterReplicationSpecArgs
                {
                    NumShards = 2,
                    RegionsConfigs = 
                    {
                        new Mongodbatlas.Inputs.ClusterReplicationSpecRegionsConfigArgs
                        {
                            ElectableNodes = 3,
                            Priority = 7,
                            ReadOnlyNodes = 0,
                            RegionName = "US_EAST_1",
                        },
                    },
                    ZoneName = "Zone 1",
                },
                new Mongodbatlas.Inputs.ClusterReplicationSpecArgs
                {
                    NumShards = 2,
                    RegionsConfigs = 
                    {
                        new Mongodbatlas.Inputs.ClusterReplicationSpecRegionsConfigArgs
                        {
                            ElectableNodes = 3,
                            Priority = 7,
                            ReadOnlyNodes = 0,
                            RegionName = "EU_CENTRAL_1",
                        },
                    },
                    ZoneName = "Zone 2",
                },
            },
        });
    }

}
package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := mongodbatlas.NewCluster(ctx, "cluster_test", &mongodbatlas.ClusterArgs{
            ClusterType:              pulumi.String("GEOSHARDED"),
            DiskSizeGb:               pulumi.Float64(80),
            NumShards:                pulumi.Int(1),
            ProjectId:                pulumi.String("<YOUR-PROJECT-ID>"),
            ProviderBackupEnabled:    pulumi.Bool(true),
            ProviderDiskIops:         pulumi.Int(240),
            ProviderInstanceSizeName: pulumi.String("M30"),
            ProviderName:             pulumi.String("AWS"),
            ProviderVolumeType:       pulumi.String("STANDARD"),
            ReplicationSpecs: mongodbatlas.ClusterReplicationSpecArray{
                &mongodbatlas.ClusterReplicationSpecArgs{
                    NumShards: pulumi.Int(2),
                    RegionsConfigs: mongodbatlas.ClusterReplicationSpecRegionsConfigArray{
                        &mongodbatlas.ClusterReplicationSpecRegionsConfigArgs{
                            ElectableNodes: pulumi.Int(3),
                            Priority:       pulumi.Int(7),
                            ReadOnlyNodes:  pulumi.Int(0),
                            RegionName:     pulumi.String("US_EAST_1"),
                        },
                    },
                    ZoneName: pulumi.String("Zone 1"),
                },
                &mongodbatlas.ClusterReplicationSpecArgs{
                    NumShards: pulumi.Int(2),
                    RegionsConfigs: mongodbatlas.ClusterReplicationSpecRegionsConfigArray{
                        &mongodbatlas.ClusterReplicationSpecRegionsConfigArgs{
                            ElectableNodes: pulumi.Int(3),
                            Priority:       pulumi.Int(7),
                            ReadOnlyNodes:  pulumi.Int(0),
                            RegionName:     pulumi.String("EU_CENTRAL_1"),
                        },
                    },
                    ZoneName: pulumi.String("Zone 2"),
                },
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_mongodbatlas as mongodbatlas

cluster_test = mongodbatlas.Cluster("cluster-test",
    cluster_type="GEOSHARDED",
    disk_size_gb=80,
    num_shards=1,
    project_id="<YOUR-PROJECT-ID>",
    provider_backup_enabled=True,
    provider_disk_iops=240,
    provider_instance_size_name="M30",
    provider_name="AWS",
    provider_volume_type="STANDARD",
    replication_specs=[
        mongodbatlas.ClusterReplicationSpecArgs(
            num_shards=2,
            regions_configs=[mongodbatlas.ClusterReplicationSpecRegionsConfigArgs(
                electable_nodes=3,
                priority=7,
                read_only_nodes=0,
                region_name="US_EAST_1",
            )],
            zone_name="Zone 1",
        ),
        mongodbatlas.ClusterReplicationSpecArgs(
            num_shards=2,
            regions_configs=[mongodbatlas.ClusterReplicationSpecRegionsConfigArgs(
                electable_nodes=3,
                priority=7,
                read_only_nodes=0,
                region_name="EU_CENTRAL_1",
            )],
            zone_name="Zone 2",
        ),
    ])
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const cluster_test = new mongodbatlas.Cluster("cluster-test", {
    clusterType: "GEOSHARDED",
    diskSizeGb: 80,
    numShards: 1,
    projectId: "<YOUR-PROJECT-ID>",
    providerBackupEnabled: true,
    providerDiskIops: 240,
    providerInstanceSizeName: "M30",
    //Provider Settings "block"
    providerName: "AWS",
    providerVolumeType: "STANDARD",
    replicationSpecs: [
        {
            numShards: 2,
            regionsConfigs: [{
                electableNodes: 3,
                priority: 7,
                readOnlyNodes: 0,
                regionName: "US_EAST_1",
            }],
            zoneName: "Zone 1",
        },
        {
            numShards: 2,
            regionsConfigs: [{
                electableNodes: 3,
                priority: 7,
                readOnlyNodes: 0,
                regionName: "EU_CENTRAL_1",
            }],
            zoneName: "Zone 2",
        },
    ],
});

Example AWS Shared Tier cluster

using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

class MyStack : Stack
{
    public MyStack()
    {
        var cluster_test = new Mongodbatlas.Cluster("cluster-test", new Mongodbatlas.ClusterArgs
        {
            AutoScalingDiskGbEnabled = false,
            BackingProviderName = "AWS",
            DiskSizeGb = 2,
            MongoDbMajorVersion = "4.2",
            ProjectId = "<YOUR-PROJECT-ID>",
            ProviderInstanceSizeName = "M2",
            ProviderName = "TENANT",
            ProviderRegionName = "US_EAST_1",
        });
    }

}
package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := mongodbatlas.NewCluster(ctx, "cluster_test", &mongodbatlas.ClusterArgs{
            AutoScalingDiskGbEnabled: pulumi.Bool(false),
            BackingProviderName:      pulumi.String("AWS"),
            DiskSizeGb:               pulumi.Float64(2),
            MongoDbMajorVersion:      pulumi.String("4.2"),
            ProjectId:                pulumi.String("<YOUR-PROJECT-ID>"),
            ProviderInstanceSizeName: pulumi.String("M2"),
            ProviderName:             pulumi.String("TENANT"),
            ProviderRegionName:       pulumi.String("US_EAST_1"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_mongodbatlas as mongodbatlas

cluster_test = mongodbatlas.Cluster("cluster-test",
    auto_scaling_disk_gb_enabled=False,
    backing_provider_name="AWS",
    disk_size_gb=2,
    mongo_db_major_version="4.2",
    project_id="<YOUR-PROJECT-ID>",
    provider_instance_size_name="M2",
    provider_name="TENANT",
    provider_region_name="US_EAST_1")
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const cluster_test = new mongodbatlas.Cluster("cluster-test", {
    autoScalingDiskGbEnabled: false,
    backingProviderName: "AWS",
    diskSizeGb: 2,
    //These must be the following values
    mongoDbMajorVersion: "4.2",
    projectId: "<YOUR-PROJECT-ID>",
    providerInstanceSizeName: "M2",
    //Provider Settings "block"
    providerName: "TENANT",
    providerRegionName: "US_EAST_1",
});

Create a Cluster Resource

new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
def Cluster(resource_name: str, opts: Optional[ResourceOptions] = None, advanced_configuration: Optional[ClusterAdvancedConfigurationArgs] = None, auto_scaling_compute_enabled: Optional[bool] = None, auto_scaling_compute_scale_down_enabled: Optional[bool] = None, auto_scaling_disk_gb_enabled: Optional[bool] = None, backing_provider_name: Optional[str] = None, backup_enabled: Optional[bool] = None, bi_connector: Optional[ClusterBiConnectorArgs] = None, cluster_type: Optional[str] = None, disk_size_gb: Optional[float] = None, encryption_at_rest_provider: Optional[str] = None, labels: Optional[Sequence[ClusterLabelArgs]] = None, mongo_db_major_version: Optional[str] = None, name: Optional[str] = None, num_shards: Optional[int] = None, pit_enabled: Optional[bool] = None, project_id: Optional[str] = None, provider_auto_scaling_compute_max_instance_size: Optional[str] = None, provider_auto_scaling_compute_min_instance_size: Optional[str] = None, provider_backup_enabled: Optional[bool] = None, provider_disk_iops: Optional[int] = None, provider_disk_type_name: Optional[str] = None, provider_encrypt_ebs_volume: Optional[bool] = None, provider_instance_size_name: Optional[str] = None, provider_name: Optional[str] = None, provider_region_name: Optional[str] = None, provider_volume_type: Optional[str] = None, replication_factor: Optional[int] = None, replication_specs: Optional[Sequence[ClusterReplicationSpecArgs]] = None)
func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)
public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args ClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ClusterArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Cluster Resource Properties

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

Inputs

The Cluster resource accepts the following input properties:

ProjectId string

The unique ID for the project to create the database user.

ProviderInstanceSizeName string

Atlas provides different instance sizes, each with a default storage capacity and RAM size. The instance size you select is used for all the data-bearing servers in your cluster. See Create a Cluster providerSettings.instanceSizeName for valid values and default resources. Note free tier (M0) creation is not supported by the Atlas API and hence not supported by this provider.)

ProviderName string

Cloud service provider on which the servers are provisioned.

AdvancedConfiguration ClusterAdvancedConfigurationArgs
AutoScalingComputeEnabled bool

Specifies whether cluster tier auto-scaling is enabled. The default is false. - Set to true to enable cluster tier auto-scaling. If enabled, you must specify a value for providerSettings.autoScaling.compute.maxInstanceSize. - Set to false to disable cluster tier auto-scaling.

AutoScalingComputeScaleDownEnabled bool

Set to true to enable the cluster tier to scale down. This option is only available if autoScaling.compute.enabled is true. - If this option is enabled, you must specify a value for providerSettings.autoScaling.compute.minInstanceSize

AutoScalingDiskGbEnabled bool

Specifies whether disk auto-scaling is enabled. The default is true. - Set to true to enable disk auto-scaling. - Set to false to disable disk auto-scaling.

BackingProviderName string

Cloud service provider on which the server for a multi-tenant cluster is provisioned.

BackupEnabled bool
BiConnector ClusterBiConnectorArgs

Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details.

ClusterType string

Specifies the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.

DiskSizeGb double

Capacity, in gigabytes, of the host’s root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive integer. * The minimum disk size for dedicated clusters is 10GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value. * Note: 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. * Cannot be used with clusters with local NVMe SSDs * Cannot be used with Azure clusters

EncryptionAtRestProvider string

Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For complete documentation on configuring Encryption at Rest, see Encryption at Rest using Customer Key Management. Requires M10 or greater. and for legacy backups, backup_enabled, to be false or omitted. Note: Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default.

Labels List<ClusterLabelArgs>
MongoDbMajorVersion string

Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters: 3.6, 4.0, or 4.2. You must set this value to 4.2 if provider_instance_size_name is either M2 or M5.

Name string

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

NumShards int

Number of shards to deploy in the specified zone, minimum 1.

PitEnabled bool
  • Flag that indicates if the cluster uses Continuous Cloud Backup. If set to true, provider_backup_enabled must also be set to true.
ProviderAutoScalingComputeMaxInstanceSize string

Maximum instance size to which your cluster can automatically scale (e.g., M40). Required if autoScaling.compute.enabled is true.

ProviderAutoScalingComputeMinInstanceSize string

Minimum instance size to which your cluster can automatically scale (e.g., M10). Required if autoScaling.compute.scaleDownEnabled is true.

ProviderBackupEnabled bool

Flag indicating if the cluster uses Cloud Backup for backups.

ProviderDiskIops int

The maximum input/output operations per second (IOPS) the system can perform. The possible values depend on the selected provider_instance_size_name and disk_size_gb.

ProviderDiskTypeName string

Azure disk type of the server’s root volume. If omitted, Atlas uses the default disk type for the selected providerSettings.instanceSizeName. Example disk types and associated storage sizes: P4 - 32GB, P6 - 64GB, P10 - 128GB, P15 - 256GB, P20 - 512GB, P30 - 1024GB, P40 - 2048GB, P50 - 4095GB. More information and the most update to date disk types/storage sizes can be located at https://docs.atlas.mongodb.com/reference/api/clusters-create-one/.

ProviderEncryptEbsVolume bool

If enabled, the Amazon EBS encryption feature encrypts the server’s root volume for both data at rest within the volume and for data moving between the volume and the cluster. Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default.

ProviderRegionName 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. Do not specify this field when creating a multi-region cluster using the replicationSpec document or a Global Cluster with the replicationSpecs array.

ProviderVolumeType string

The type of the volume. The possible values are: STANDARD and PROVISIONED. PROVISIONED required if setting IOPS higher than the default instance IOPS.

ReplicationFactor int

Number of replica set members. Each member keeps a copy of your databases, providing high availability and data redundancy. The possible values are 3, 5, or 7. The default value is 3.

ReplicationSpecs List<ClusterReplicationSpecArgs>

Configuration for cluster regions. See Replication Spec below for more details.

ProjectId string

The unique ID for the project to create the database user.

ProviderInstanceSizeName string

Atlas provides different instance sizes, each with a default storage capacity and RAM size. The instance size you select is used for all the data-bearing servers in your cluster. See Create a Cluster providerSettings.instanceSizeName for valid values and default resources. Note free tier (M0) creation is not supported by the Atlas API and hence not supported by this provider.)

ProviderName string

Cloud service provider on which the servers are provisioned.

AdvancedConfiguration ClusterAdvancedConfiguration
AutoScalingComputeEnabled bool

Specifies whether cluster tier auto-scaling is enabled. The default is false. - Set to true to enable cluster tier auto-scaling. If enabled, you must specify a value for providerSettings.autoScaling.compute.maxInstanceSize. - Set to false to disable cluster tier auto-scaling.

AutoScalingComputeScaleDownEnabled bool

Set to true to enable the cluster tier to scale down. This option is only available if autoScaling.compute.enabled is true. - If this option is enabled, you must specify a value for providerSettings.autoScaling.compute.minInstanceSize

AutoScalingDiskGbEnabled bool

Specifies whether disk auto-scaling is enabled. The default is true. - Set to true to enable disk auto-scaling. - Set to false to disable disk auto-scaling.

BackingProviderName string

Cloud service provider on which the server for a multi-tenant cluster is provisioned.

BackupEnabled bool
BiConnector ClusterBiConnector

Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details.

ClusterType string

Specifies the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.

DiskSizeGb float64

Capacity, in gigabytes, of the host’s root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive integer. * The minimum disk size for dedicated clusters is 10GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value. * Note: 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. * Cannot be used with clusters with local NVMe SSDs * Cannot be used with Azure clusters

EncryptionAtRestProvider string

Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For complete documentation on configuring Encryption at Rest, see Encryption at Rest using Customer Key Management. Requires M10 or greater. and for legacy backups, backup_enabled, to be false or omitted. Note: Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default.

Labels []ClusterLabel
MongoDbMajorVersion string

Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters: 3.6, 4.0, or 4.2. You must set this value to 4.2 if provider_instance_size_name is either M2 or M5.

Name string

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

NumShards int

Number of shards to deploy in the specified zone, minimum 1.

PitEnabled bool
  • Flag that indicates if the cluster uses Continuous Cloud Backup. If set to true, provider_backup_enabled must also be set to true.
ProviderAutoScalingComputeMaxInstanceSize string

Maximum instance size to which your cluster can automatically scale (e.g., M40). Required if autoScaling.compute.enabled is true.

ProviderAutoScalingComputeMinInstanceSize string

Minimum instance size to which your cluster can automatically scale (e.g., M10). Required if autoScaling.compute.scaleDownEnabled is true.

ProviderBackupEnabled bool

Flag indicating if the cluster uses Cloud Backup for backups.

ProviderDiskIops int

The maximum input/output operations per second (IOPS) the system can perform. The possible values depend on the selected provider_instance_size_name and disk_size_gb.

ProviderDiskTypeName string

Azure disk type of the server’s root volume. If omitted, Atlas uses the default disk type for the selected providerSettings.instanceSizeName. Example disk types and associated storage sizes: P4 - 32GB, P6 - 64GB, P10 - 128GB, P15 - 256GB, P20 - 512GB, P30 - 1024GB, P40 - 2048GB, P50 - 4095GB. More information and the most update to date disk types/storage sizes can be located at https://docs.atlas.mongodb.com/reference/api/clusters-create-one/.

ProviderEncryptEbsVolume bool

If enabled, the Amazon EBS encryption feature encrypts the server’s root volume for both data at rest within the volume and for data moving between the volume and the cluster. Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default.

ProviderRegionName 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. Do not specify this field when creating a multi-region cluster using the replicationSpec document or a Global Cluster with the replicationSpecs array.

ProviderVolumeType string

The type of the volume. The possible values are: STANDARD and PROVISIONED. PROVISIONED required if setting IOPS higher than the default instance IOPS.

ReplicationFactor int

Number of replica set members. Each member keeps a copy of your databases, providing high availability and data redundancy. The possible values are 3, 5, or 7. The default value is 3.

ReplicationSpecs []ClusterReplicationSpec

Configuration for cluster regions. See Replication Spec below for more details.

projectId string

The unique ID for the project to create the database user.

providerInstanceSizeName string

Atlas provides different instance sizes, each with a default storage capacity and RAM size. The instance size you select is used for all the data-bearing servers in your cluster. See Create a Cluster providerSettings.instanceSizeName for valid values and default resources. Note free tier (M0) creation is not supported by the Atlas API and hence not supported by this provider.)

providerName string

Cloud service provider on which the servers are provisioned.

advancedConfiguration ClusterAdvancedConfiguration
autoScalingComputeEnabled boolean

Specifies whether cluster tier auto-scaling is enabled. The default is false. - Set to true to enable cluster tier auto-scaling. If enabled, you must specify a value for providerSettings.autoScaling.compute.maxInstanceSize. - Set to false to disable cluster tier auto-scaling.

autoScalingComputeScaleDownEnabled boolean

Set to true to enable the cluster tier to scale down. This option is only available if autoScaling.compute.enabled is true. - If this option is enabled, you must specify a value for providerSettings.autoScaling.compute.minInstanceSize

autoScalingDiskGbEnabled boolean

Specifies whether disk auto-scaling is enabled. The default is true. - Set to true to enable disk auto-scaling. - Set to false to disable disk auto-scaling.

backingProviderName string

Cloud service provider on which the server for a multi-tenant cluster is provisioned.

backupEnabled boolean
biConnector ClusterBiConnector

Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details.

clusterType string

Specifies the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.

diskSizeGb number

Capacity, in gigabytes, of the host’s root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive integer. * The minimum disk size for dedicated clusters is 10GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value. * Note: 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. * Cannot be used with clusters with local NVMe SSDs * Cannot be used with Azure clusters

encryptionAtRestProvider string

Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For complete documentation on configuring Encryption at Rest, see Encryption at Rest using Customer Key Management. Requires M10 or greater. and for legacy backups, backup_enabled, to be false or omitted. Note: Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default.

labels ClusterLabel[]
mongoDbMajorVersion string

Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters: 3.6, 4.0, or 4.2. You must set this value to 4.2 if provider_instance_size_name is either M2 or M5.

name string

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

numShards number

Number of shards to deploy in the specified zone, minimum 1.

pitEnabled boolean
  • Flag that indicates if the cluster uses Continuous Cloud Backup. If set to true, provider_backup_enabled must also be set to true.
providerAutoScalingComputeMaxInstanceSize string

Maximum instance size to which your cluster can automatically scale (e.g., M40). Required if autoScaling.compute.enabled is true.

providerAutoScalingComputeMinInstanceSize string

Minimum instance size to which your cluster can automatically scale (e.g., M10). Required if autoScaling.compute.scaleDownEnabled is true.

providerBackupEnabled boolean

Flag indicating if the cluster uses Cloud Backup for backups.

providerDiskIops number

The maximum input/output operations per second (IOPS) the system can perform. The possible values depend on the selected provider_instance_size_name and disk_size_gb.

providerDiskTypeName string

Azure disk type of the server’s root volume. If omitted, Atlas uses the default disk type for the selected providerSettings.instanceSizeName. Example disk types and associated storage sizes: P4 - 32GB, P6 - 64GB, P10 - 128GB, P15 - 256GB, P20 - 512GB, P30 - 1024GB, P40 - 2048GB, P50 - 4095GB. More information and the most update to date disk types/storage sizes can be located at https://docs.atlas.mongodb.com/reference/api/clusters-create-one/.

providerEncryptEbsVolume boolean

If enabled, the Amazon EBS encryption feature encrypts the server’s root volume for both data at rest within the volume and for data moving between the volume and the cluster. Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default.

providerRegionName 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. Do not specify this field when creating a multi-region cluster using the replicationSpec document or a Global Cluster with the replicationSpecs array.

providerVolumeType string

The type of the volume. The possible values are: STANDARD and PROVISIONED. PROVISIONED required if setting IOPS higher than the default instance IOPS.

replicationFactor number

Number of replica set members. Each member keeps a copy of your databases, providing high availability and data redundancy. The possible values are 3, 5, or 7. The default value is 3.

replicationSpecs ClusterReplicationSpec[]

Configuration for cluster regions. See Replication Spec below for more details.

project_id str

The unique ID for the project to create the database user.

provider_instance_size_name str

Atlas provides different instance sizes, each with a default storage capacity and RAM size. The instance size you select is used for all the data-bearing servers in your cluster. See Create a Cluster providerSettings.instanceSizeName for valid values and default resources. Note free tier (M0) creation is not supported by the Atlas API and hence not supported by this provider.)

provider_name str

Cloud service provider on which the servers are provisioned.

advanced_configuration ClusterAdvancedConfigurationArgs
auto_scaling_compute_enabled bool

Specifies whether cluster tier auto-scaling is enabled. The default is false. - Set to true to enable cluster tier auto-scaling. If enabled, you must specify a value for providerSettings.autoScaling.compute.maxInstanceSize. - Set to false to disable cluster tier auto-scaling.

auto_scaling_compute_scale_down_enabled bool

Set to true to enable the cluster tier to scale down. This option is only available if autoScaling.compute.enabled is true. - If this option is enabled, you must specify a value for providerSettings.autoScaling.compute.minInstanceSize

auto_scaling_disk_gb_enabled bool

Specifies whether disk auto-scaling is enabled. The default is true. - Set to true to enable disk auto-scaling. - Set to false to disable disk auto-scaling.

backing_provider_name str

Cloud service provider on which the server for a multi-tenant cluster is provisioned.

backup_enabled bool
bi_connector ClusterBiConnectorArgs

Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details.

cluster_type str

Specifies the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.

disk_size_gb float

Capacity, in gigabytes, of the host’s root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive integer. * The minimum disk size for dedicated clusters is 10GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value. * Note: 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. * Cannot be used with clusters with local NVMe SSDs * Cannot be used with Azure clusters

encryption_at_rest_provider str

Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For complete documentation on configuring Encryption at Rest, see Encryption at Rest using Customer Key Management. Requires M10 or greater. and for legacy backups, backup_enabled, to be false or omitted. Note: Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default.

labels Sequence[ClusterLabelArgs]
mongo_db_major_version str

Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters: 3.6, 4.0, or 4.2. You must set this value to 4.2 if provider_instance_size_name is either M2 or M5.

name str

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

num_shards int

Number of shards to deploy in the specified zone, minimum 1.

pit_enabled bool
  • Flag that indicates if the cluster uses Continuous Cloud Backup. If set to true, provider_backup_enabled must also be set to true.
provider_auto_scaling_compute_max_instance_size str

Maximum instance size to which your cluster can automatically scale (e.g., M40). Required if autoScaling.compute.enabled is true.

provider_auto_scaling_compute_min_instance_size str

Minimum instance size to which your cluster can automatically scale (e.g., M10). Required if autoScaling.compute.scaleDownEnabled is true.

provider_backup_enabled bool

Flag indicating if the cluster uses Cloud Backup for backups.

provider_disk_iops int

The maximum input/output operations per second (IOPS) the system can perform. The possible values depend on the selected provider_instance_size_name and disk_size_gb.

provider_disk_type_name str

Azure disk type of the server’s root volume. If omitted, Atlas uses the default disk type for the selected providerSettings.instanceSizeName. Example disk types and associated storage sizes: P4 - 32GB, P6 - 64GB, P10 - 128GB, P15 - 256GB, P20 - 512GB, P30 - 1024GB, P40 - 2048GB, P50 - 4095GB. More information and the most update to date disk types/storage sizes can be located at https://docs.atlas.mongodb.com/reference/api/clusters-create-one/.

provider_encrypt_ebs_volume bool

If enabled, the Amazon EBS encryption feature encrypts the server’s root volume for both data at rest within the volume and for data moving between the volume and the cluster. Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default.

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. Do not specify this field when creating a multi-region cluster using the replicationSpec document or a Global Cluster with the replicationSpecs array.

provider_volume_type str

The type of the volume. The possible values are: STANDARD and PROVISIONED. PROVISIONED required if setting IOPS higher than the default instance IOPS.

replication_factor int

Number of replica set members. Each member keeps a copy of your databases, providing high availability and data redundancy. The possible values are 3, 5, or 7. The default value is 3.

replication_specs Sequence[ClusterReplicationSpecArgs]

Configuration for cluster regions. See Replication Spec below for more details.

Outputs

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

ClusterId string

The cluster ID.

ConnectionStrings ClusterConnectionStrings

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.

ContainerId string

The Network Peering Container ID. The id of the container either created programmatically by the user before any clusters existed in the project or when the first cluster in the region (AWS/Azure) or project (GCP) was created.

Id string
The provider-assigned unique ID for this managed resource.
MongoDbVersion string

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

MongoUri string

Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.

MongoUriUpdated string

Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.

MongoUriWithOptions string

connection string for connecting to the Atlas cluster. Includes the replicaSet, ssl, and authSource query parameters in the connection string with values appropriate for the cluster.

Paused bool

Flag that indicates whether the cluster is paused or not.

SnapshotBackupPolicies List<ClusterSnapshotBackupPolicy>

current snapshot schedule and retention settings for the cluster.

SrvAddress string

Connection string for connecting to the Atlas cluster. The +srv modifier forces the connection to use TLS/SSL. See the mongoURI for additional options.

StateName string

Current state of the cluster. The possible states are: - IDLE - CREATING - UPDATING - DELETING - DELETED - REPAIRING

ClusterId string

The cluster ID.

ConnectionStrings ClusterConnectionStrings

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.

ContainerId string

The Network Peering Container ID. The id of the container either created programmatically by the user before any clusters existed in the project or when the first cluster in the region (AWS/Azure) or project (GCP) was created.

Id string
The provider-assigned unique ID for this managed resource.
MongoDbVersion string

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

MongoUri string

Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.

MongoUriUpdated string

Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.

MongoUriWithOptions string

connection string for connecting to the Atlas cluster. Includes the replicaSet, ssl, and authSource query parameters in the connection string with values appropriate for the cluster.

Paused bool

Flag that indicates whether the cluster is paused or not.

SnapshotBackupPolicies []ClusterSnapshotBackupPolicy

current snapshot schedule and retention settings for the cluster.

SrvAddress string

Connection string for connecting to the Atlas cluster. The +srv modifier forces the connection to use TLS/SSL. See the mongoURI for additional options.

StateName string

Current state of the cluster. The possible states are: - IDLE - CREATING - UPDATING - DELETING - DELETED - REPAIRING

clusterId string

The cluster ID.

connectionStrings ClusterConnectionStrings

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.

containerId string

The Network Peering Container ID. The id of the container either created programmatically by the user before any clusters existed in the project or when the first cluster in the region (AWS/Azure) or project (GCP) was created.

id string
The provider-assigned unique ID for this managed resource.
mongoDbVersion string

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

mongoUri string

Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.

mongoUriUpdated string

Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.

mongoUriWithOptions string

connection string for connecting to the Atlas cluster. Includes the replicaSet, ssl, and authSource query parameters in the connection string with values appropriate for the cluster.

paused boolean

Flag that indicates whether the cluster is paused or not.

snapshotBackupPolicies ClusterSnapshotBackupPolicy[]

current snapshot schedule and retention settings for the cluster.

srvAddress string

Connection string for connecting to the Atlas cluster. The +srv modifier forces the connection to use TLS/SSL. See the mongoURI for additional options.

stateName string

Current state of the cluster. The possible states are: - IDLE - CREATING - UPDATING - DELETING - DELETED - REPAIRING

cluster_id str

The cluster ID.

connection_strings ClusterConnectionStrings

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.

container_id str

The Network Peering Container ID. The id of the container either created programmatically by the user before any clusters existed in the project or when the first cluster in the region (AWS/Azure) or project (GCP) was created.

id str
The provider-assigned unique ID for this managed resource.
mongo_db_version str

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

mongo_uri str

Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.

mongo_uri_updated str

Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.

mongo_uri_with_options str

connection string for connecting to the Atlas cluster. Includes the replicaSet, ssl, and authSource query parameters in the connection string with values appropriate for the cluster.

paused bool

Flag that indicates whether the cluster is paused or not.

snapshot_backup_policies Sequence[ClusterSnapshotBackupPolicy]

current snapshot schedule and retention settings for the cluster.

srv_address str

Connection string for connecting to the Atlas cluster. The +srv modifier forces the connection to use TLS/SSL. See the mongoURI for additional options.

state_name str

Current state of the cluster. The possible states are: - IDLE - CREATING - UPDATING - DELETING - DELETED - REPAIRING

Look up an Existing Cluster Resource

Get an existing Cluster 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?: ClusterState, opts?: CustomResourceOptions): Cluster
@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, advanced_configuration: Optional[ClusterAdvancedConfigurationArgs] = None, auto_scaling_compute_enabled: Optional[bool] = None, auto_scaling_compute_scale_down_enabled: Optional[bool] = None, auto_scaling_disk_gb_enabled: Optional[bool] = None, backing_provider_name: Optional[str] = None, backup_enabled: Optional[bool] = None, bi_connector: Optional[ClusterBiConnectorArgs] = None, cluster_id: Optional[str] = None, cluster_type: Optional[str] = None, connection_strings: Optional[ClusterConnectionStringsArgs] = None, container_id: Optional[str] = None, disk_size_gb: Optional[float] = None, encryption_at_rest_provider: Optional[str] = None, labels: Optional[Sequence[ClusterLabelArgs]] = None, mongo_db_major_version: Optional[str] = None, mongo_db_version: Optional[str] = None, mongo_uri: Optional[str] = None, mongo_uri_updated: Optional[str] = None, mongo_uri_with_options: Optional[str] = None, name: Optional[str] = None, num_shards: Optional[int] = None, paused: Optional[bool] = None, pit_enabled: Optional[bool] = None, project_id: Optional[str] = None, provider_auto_scaling_compute_max_instance_size: Optional[str] = None, provider_auto_scaling_compute_min_instance_size: Optional[str] = None, provider_backup_enabled: Optional[bool] = None, provider_disk_iops: Optional[int] = None, provider_disk_type_name: Optional[str] = None, provider_encrypt_ebs_volume: Optional[bool] = None, provider_instance_size_name: Optional[str] = None, provider_name: Optional[str] = None, provider_region_name: Optional[str] = None, provider_volume_type: Optional[str] = None, replication_factor: Optional[int] = None, replication_specs: Optional[Sequence[ClusterReplicationSpecArgs]] = None, snapshot_backup_policies: Optional[Sequence[ClusterSnapshotBackupPolicyArgs]] = None, srv_address: Optional[str] = None, state_name: Optional[str] = None) -> Cluster
func GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)
public static Cluster Get(string name, Input<string> id, ClusterState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

AdvancedConfiguration ClusterAdvancedConfigurationArgs
AutoScalingComputeEnabled bool

Specifies whether cluster tier auto-scaling is enabled. The default is false. - Set to true to enable cluster tier auto-scaling. If enabled, you must specify a value for providerSettings.autoScaling.compute.maxInstanceSize. - Set to false to disable cluster tier auto-scaling.

AutoScalingComputeScaleDownEnabled bool

Set to true to enable the cluster tier to scale down. This option is only available if autoScaling.compute.enabled is true. - If this option is enabled, you must specify a value for providerSettings.autoScaling.compute.minInstanceSize

AutoScalingDiskGbEnabled bool

Specifies whether disk auto-scaling is enabled. The default is true. - Set to true to enable disk auto-scaling. - Set to false to disable disk auto-scaling.

BackingProviderName string

Cloud service provider on which the server for a multi-tenant cluster is provisioned.

BackupEnabled bool
BiConnector ClusterBiConnectorArgs

Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details.

ClusterId string

The cluster ID.

ClusterType string

Specifies the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.

ConnectionStrings ClusterConnectionStringsArgs

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.

ContainerId string

The Network Peering Container ID. The id of the container either created programmatically by the user before any clusters existed in the project or when the first cluster in the region (AWS/Azure) or project (GCP) was created.

DiskSizeGb double

Capacity, in gigabytes, of the host’s root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive integer. * The minimum disk size for dedicated clusters is 10GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value. * Note: 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. * Cannot be used with clusters with local NVMe SSDs * Cannot be used with Azure clusters

EncryptionAtRestProvider string

Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For complete documentation on configuring Encryption at Rest, see Encryption at Rest using Customer Key Management. Requires M10 or greater. and for legacy backups, backup_enabled, to be false or omitted. Note: Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default.

Labels List<ClusterLabelArgs>
MongoDbMajorVersion string

Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters: 3.6, 4.0, or 4.2. You must set this value to 4.2 if provider_instance_size_name is either M2 or M5.

MongoDbVersion string

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

MongoUri string

Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.

MongoUriUpdated string

Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.

MongoUriWithOptions string

connection string for connecting to the Atlas cluster. Includes the replicaSet, ssl, and authSource query parameters in the connection string with values appropriate for the cluster.

Name string

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

NumShards int

Number of shards to deploy in the specified zone, minimum 1.

Paused bool

Flag that indicates whether the cluster is paused or not.

PitEnabled bool
  • Flag that indicates if the cluster uses Continuous Cloud Backup. If set to true, provider_backup_enabled must also be set to true.
ProjectId string

The unique ID for the project to create the database user.

ProviderAutoScalingComputeMaxInstanceSize string

Maximum instance size to which your cluster can automatically scale (e.g., M40). Required if autoScaling.compute.enabled is true.

ProviderAutoScalingComputeMinInstanceSize string

Minimum instance size to which your cluster can automatically scale (e.g., M10). Required if autoScaling.compute.scaleDownEnabled is true.

ProviderBackupEnabled bool

Flag indicating if the cluster uses Cloud Backup for backups.

ProviderDiskIops int

The maximum input/output operations per second (IOPS) the system can perform. The possible values depend on the selected provider_instance_size_name and disk_size_gb.

ProviderDiskTypeName string

Azure disk type of the server’s root volume. If omitted, Atlas uses the default disk type for the selected providerSettings.instanceSizeName. Example disk types and associated storage sizes: P4 - 32GB, P6 - 64GB, P10 - 128GB, P15 - 256GB, P20 - 512GB, P30 - 1024GB, P40 - 2048GB, P50 - 4095GB. More information and the most update to date disk types/storage sizes can be located at https://docs.atlas.mongodb.com/reference/api/clusters-create-one/.

ProviderEncryptEbsVolume bool

If enabled, the Amazon EBS encryption feature encrypts the server’s root volume for both data at rest within the volume and for data moving between the volume and the cluster. Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default.

ProviderInstanceSizeName string

Atlas provides different instance sizes, each with a default storage capacity and RAM size. The instance size you select is used for all the data-bearing servers in your cluster. See Create a Cluster providerSettings.instanceSizeName for valid values and default resources. Note free tier (M0) creation is not supported by the Atlas API and hence not supported by this provider.)

ProviderName string

Cloud service provider on which the servers are provisioned.

ProviderRegionName 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. Do not specify this field when creating a multi-region cluster using the replicationSpec document or a Global Cluster with the replicationSpecs array.

ProviderVolumeType string

The type of the volume. The possible values are: STANDARD and PROVISIONED. PROVISIONED required if setting IOPS higher than the default instance IOPS.

ReplicationFactor int

Number of replica set members. Each member keeps a copy of your databases, providing high availability and data redundancy. The possible values are 3, 5, or 7. The default value is 3.

ReplicationSpecs List<ClusterReplicationSpecArgs>

Configuration for cluster regions. See Replication Spec below for more details.

SnapshotBackupPolicies List<ClusterSnapshotBackupPolicyArgs>

current snapshot schedule and retention settings for the cluster.

SrvAddress string

Connection string for connecting to the Atlas cluster. The +srv modifier forces the connection to use TLS/SSL. See the mongoURI for additional options.

StateName string

Current state of the cluster. The possible states are: - IDLE - CREATING - UPDATING - DELETING - DELETED - REPAIRING

AdvancedConfiguration ClusterAdvancedConfiguration
AutoScalingComputeEnabled bool

Specifies whether cluster tier auto-scaling is enabled. The default is false. - Set to true to enable cluster tier auto-scaling. If enabled, you must specify a value for providerSettings.autoScaling.compute.maxInstanceSize. - Set to false to disable cluster tier auto-scaling.

AutoScalingComputeScaleDownEnabled bool

Set to true to enable the cluster tier to scale down. This option is only available if autoScaling.compute.enabled is true. - If this option is enabled, you must specify a value for providerSettings.autoScaling.compute.minInstanceSize

AutoScalingDiskGbEnabled bool

Specifies whether disk auto-scaling is enabled. The default is true. - Set to true to enable disk auto-scaling. - Set to false to disable disk auto-scaling.

BackingProviderName string

Cloud service provider on which the server for a multi-tenant cluster is provisioned.

BackupEnabled bool
BiConnector ClusterBiConnector

Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details.

ClusterId string

The cluster ID.

ClusterType string

Specifies the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.

ConnectionStrings ClusterConnectionStrings

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.

ContainerId string

The Network Peering Container ID. The id of the container either created programmatically by the user before any clusters existed in the project or when the first cluster in the region (AWS/Azure) or project (GCP) was created.

DiskSizeGb float64

Capacity, in gigabytes, of the host’s root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive integer. * The minimum disk size for dedicated clusters is 10GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value. * Note: 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. * Cannot be used with clusters with local NVMe SSDs * Cannot be used with Azure clusters

EncryptionAtRestProvider string

Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For complete documentation on configuring Encryption at Rest, see Encryption at Rest using Customer Key Management. Requires M10 or greater. and for legacy backups, backup_enabled, to be false or omitted. Note: Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default.

Labels []ClusterLabel
MongoDbMajorVersion string

Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters: 3.6, 4.0, or 4.2. You must set this value to 4.2 if provider_instance_size_name is either M2 or M5.

MongoDbVersion string

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

MongoUri string

Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.

MongoUriUpdated string

Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.

MongoUriWithOptions string

connection string for connecting to the Atlas cluster. Includes the replicaSet, ssl, and authSource query parameters in the connection string with values appropriate for the cluster.

Name string

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

NumShards int

Number of shards to deploy in the specified zone, minimum 1.

Paused bool

Flag that indicates whether the cluster is paused or not.

PitEnabled bool
  • Flag that indicates if the cluster uses Continuous Cloud Backup. If set to true, provider_backup_enabled must also be set to true.
ProjectId string

The unique ID for the project to create the database user.

ProviderAutoScalingComputeMaxInstanceSize string

Maximum instance size to which your cluster can automatically scale (e.g., M40). Required if autoScaling.compute.enabled is true.

ProviderAutoScalingComputeMinInstanceSize string

Minimum instance size to which your cluster can automatically scale (e.g., M10). Required if autoScaling.compute.scaleDownEnabled is true.

ProviderBackupEnabled bool

Flag indicating if the cluster uses Cloud Backup for backups.

ProviderDiskIops int

The maximum input/output operations per second (IOPS) the system can perform. The possible values depend on the selected provider_instance_size_name and disk_size_gb.

ProviderDiskTypeName string

Azure disk type of the server’s root volume. If omitted, Atlas uses the default disk type for the selected providerSettings.instanceSizeName. Example disk types and associated storage sizes: P4 - 32GB, P6 - 64GB, P10 - 128GB, P15 - 256GB, P20 - 512GB, P30 - 1024GB, P40 - 2048GB, P50 - 4095GB. More information and the most update to date disk types/storage sizes can be located at https://docs.atlas.mongodb.com/reference/api/clusters-create-one/.

ProviderEncryptEbsVolume bool

If enabled, the Amazon EBS encryption feature encrypts the server’s root volume for both data at rest within the volume and for data moving between the volume and the cluster. Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default.

ProviderInstanceSizeName string

Atlas provides different instance sizes, each with a default storage capacity and RAM size. The instance size you select is used for all the data-bearing servers in your cluster. See Create a Cluster providerSettings.instanceSizeName for valid values and default resources. Note free tier (M0) creation is not supported by the Atlas API and hence not supported by this provider.)

ProviderName string

Cloud service provider on which the servers are provisioned.

ProviderRegionName 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. Do not specify this field when creating a multi-region cluster using the replicationSpec document or a Global Cluster with the replicationSpecs array.

ProviderVolumeType string

The type of the volume. The possible values are: STANDARD and PROVISIONED. PROVISIONED required if setting IOPS higher than the default instance IOPS.

ReplicationFactor int

Number of replica set members. Each member keeps a copy of your databases, providing high availability and data redundancy. The possible values are 3, 5, or 7. The default value is 3.

ReplicationSpecs []ClusterReplicationSpec

Configuration for cluster regions. See Replication Spec below for more details.

SnapshotBackupPolicies []ClusterSnapshotBackupPolicy

current snapshot schedule and retention settings for the cluster.

SrvAddress string

Connection string for connecting to the Atlas cluster. The +srv modifier forces the connection to use TLS/SSL. See the mongoURI for additional options.

StateName string

Current state of the cluster. The possible states are: - IDLE - CREATING - UPDATING - DELETING - DELETED - REPAIRING

advancedConfiguration ClusterAdvancedConfiguration
autoScalingComputeEnabled boolean

Specifies whether cluster tier auto-scaling is enabled. The default is false. - Set to true to enable cluster tier auto-scaling. If enabled, you must specify a value for providerSettings.autoScaling.compute.maxInstanceSize. - Set to false to disable cluster tier auto-scaling.

autoScalingComputeScaleDownEnabled boolean

Set to true to enable the cluster tier to scale down. This option is only available if autoScaling.compute.enabled is true. - If this option is enabled, you must specify a value for providerSettings.autoScaling.compute.minInstanceSize

autoScalingDiskGbEnabled boolean

Specifies whether disk auto-scaling is enabled. The default is true. - Set to true to enable disk auto-scaling. - Set to false to disable disk auto-scaling.

backingProviderName string

Cloud service provider on which the server for a multi-tenant cluster is provisioned.

backupEnabled boolean
biConnector ClusterBiConnector

Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details.

clusterId string

The cluster ID.

clusterType string

Specifies the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.

connectionStrings ClusterConnectionStrings

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.

containerId string

The Network Peering Container ID. The id of the container either created programmatically by the user before any clusters existed in the project or when the first cluster in the region (AWS/Azure) or project (GCP) was created.

diskSizeGb number

Capacity, in gigabytes, of the host’s root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive integer. * The minimum disk size for dedicated clusters is 10GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value. * Note: 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. * Cannot be used with clusters with local NVMe SSDs * Cannot be used with Azure clusters

encryptionAtRestProvider string

Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For complete documentation on configuring Encryption at Rest, see Encryption at Rest using Customer Key Management. Requires M10 or greater. and for legacy backups, backup_enabled, to be false or omitted. Note: Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default.

labels ClusterLabel[]
mongoDbMajorVersion string

Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters: 3.6, 4.0, or 4.2. You must set this value to 4.2 if provider_instance_size_name is either M2 or M5.

mongoDbVersion string

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

mongoUri string

Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.

mongoUriUpdated string

Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.

mongoUriWithOptions string

connection string for connecting to the Atlas cluster. Includes the replicaSet, ssl, and authSource query parameters in the connection string with values appropriate for the cluster.

name string

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

numShards number

Number of shards to deploy in the specified zone, minimum 1.

paused boolean

Flag that indicates whether the cluster is paused or not.

pitEnabled boolean
  • Flag that indicates if the cluster uses Continuous Cloud Backup. If set to true, provider_backup_enabled must also be set to true.
projectId string

The unique ID for the project to create the database user.

providerAutoScalingComputeMaxInstanceSize string

Maximum instance size to which your cluster can automatically scale (e.g., M40). Required if autoScaling.compute.enabled is true.

providerAutoScalingComputeMinInstanceSize string

Minimum instance size to which your cluster can automatically scale (e.g., M10). Required if autoScaling.compute.scaleDownEnabled is true.

providerBackupEnabled boolean

Flag indicating if the cluster uses Cloud Backup for backups.

providerDiskIops number

The maximum input/output operations per second (IOPS) the system can perform. The possible values depend on the selected provider_instance_size_name and disk_size_gb.

providerDiskTypeName string

Azure disk type of the server’s root volume. If omitted, Atlas uses the default disk type for the selected providerSettings.instanceSizeName. Example disk types and associated storage sizes: P4 - 32GB, P6 - 64GB, P10 - 128GB, P15 - 256GB, P20 - 512GB, P30 - 1024GB, P40 - 2048GB, P50 - 4095GB. More information and the most update to date disk types/storage sizes can be located at https://docs.atlas.mongodb.com/reference/api/clusters-create-one/.

providerEncryptEbsVolume boolean

If enabled, the Amazon EBS encryption feature encrypts the server’s root volume for both data at rest within the volume and for data moving between the volume and the cluster. Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default.

providerInstanceSizeName string

Atlas provides different instance sizes, each with a default storage capacity and RAM size. The instance size you select is used for all the data-bearing servers in your cluster. See Create a Cluster providerSettings.instanceSizeName for valid values and default resources. Note free tier (M0) creation is not supported by the Atlas API and hence not supported by this provider.)

providerName string

Cloud service provider on which the servers are provisioned.

providerRegionName 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. Do not specify this field when creating a multi-region cluster using the replicationSpec document or a Global Cluster with the replicationSpecs array.

providerVolumeType string

The type of the volume. The possible values are: STANDARD and PROVISIONED. PROVISIONED required if setting IOPS higher than the default instance IOPS.

replicationFactor number

Number of replica set members. Each member keeps a copy of your databases, providing high availability and data redundancy. The possible values are 3, 5, or 7. The default value is 3.

replicationSpecs ClusterReplicationSpec[]

Configuration for cluster regions. See Replication Spec below for more details.

snapshotBackupPolicies ClusterSnapshotBackupPolicy[]

current snapshot schedule and retention settings for the cluster.

srvAddress string

Connection string for connecting to the Atlas cluster. The +srv modifier forces the connection to use TLS/SSL. See the mongoURI for additional options.

stateName string

Current state of the cluster. The possible states are: - IDLE - CREATING - UPDATING - DELETING - DELETED - REPAIRING

advanced_configuration ClusterAdvancedConfigurationArgs
auto_scaling_compute_enabled bool

Specifies whether cluster tier auto-scaling is enabled. The default is false. - Set to true to enable cluster tier auto-scaling. If enabled, you must specify a value for providerSettings.autoScaling.compute.maxInstanceSize. - Set to false to disable cluster tier auto-scaling.

auto_scaling_compute_scale_down_enabled bool

Set to true to enable the cluster tier to scale down. This option is only available if autoScaling.compute.enabled is true. - If this option is enabled, you must specify a value for providerSettings.autoScaling.compute.minInstanceSize

auto_scaling_disk_gb_enabled bool

Specifies whether disk auto-scaling is enabled. The default is true. - Set to true to enable disk auto-scaling. - Set to false to disable disk auto-scaling.

backing_provider_name str

Cloud service provider on which the server for a multi-tenant cluster is provisioned.

backup_enabled bool
bi_connector ClusterBiConnectorArgs

Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details.

cluster_id str

The cluster ID.

cluster_type str

Specifies the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.

connection_strings ClusterConnectionStringsArgs

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.

container_id str

The Network Peering Container ID. The id of the container either created programmatically by the user before any clusters existed in the project or when the first cluster in the region (AWS/Azure) or project (GCP) was created.

disk_size_gb float

Capacity, in gigabytes, of the host’s root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive integer. * The minimum disk size for dedicated clusters is 10GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value. * Note: 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. * Cannot be used with clusters with local NVMe SSDs * Cannot be used with Azure clusters

encryption_at_rest_provider str

Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For complete documentation on configuring Encryption at Rest, see Encryption at Rest using Customer Key Management. Requires M10 or greater. and for legacy backups, backup_enabled, to be false or omitted. Note: Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default.

labels Sequence[ClusterLabelArgs]
mongo_db_major_version str

Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters: 3.6, 4.0, or 4.2. You must set this value to 4.2 if provider_instance_size_name is either M2 or M5.

mongo_db_version str

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

mongo_uri str

Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.

mongo_uri_updated str

Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.

mongo_uri_with_options str

connection string for connecting to the Atlas cluster. Includes the replicaSet, ssl, and authSource query parameters in the connection string with values appropriate for the cluster.

name str

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

num_shards int

Number of shards to deploy in the specified zone, minimum 1.

paused bool

Flag that indicates whether the cluster is paused or not.

pit_enabled bool
  • Flag that indicates if the cluster uses Continuous Cloud Backup. If set to true, provider_backup_enabled must also be set to true.
project_id str

The unique ID for the project to create the database user.

provider_auto_scaling_compute_max_instance_size str

Maximum instance size to which your cluster can automatically scale (e.g., M40). Required if autoScaling.compute.enabled is true.

provider_auto_scaling_compute_min_instance_size str

Minimum instance size to which your cluster can automatically scale (e.g., M10). Required if autoScaling.compute.scaleDownEnabled is true.

provider_backup_enabled bool

Flag indicating if the cluster uses Cloud Backup for backups.

provider_disk_iops int

The maximum input/output operations per second (IOPS) the system can perform. The possible values depend on the selected provider_instance_size_name and disk_size_gb.

provider_disk_type_name str

Azure disk type of the server’s root volume. If omitted, Atlas uses the default disk type for the selected providerSettings.instanceSizeName. Example disk types and associated storage sizes: P4 - 32GB, P6 - 64GB, P10 - 128GB, P15 - 256GB, P20 - 512GB, P30 - 1024GB, P40 - 2048GB, P50 - 4095GB. More information and the most update to date disk types/storage sizes can be located at https://docs.atlas.mongodb.com/reference/api/clusters-create-one/.

provider_encrypt_ebs_volume bool

If enabled, the Amazon EBS encryption feature encrypts the server’s root volume for both data at rest within the volume and for data moving between the volume and the cluster. Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default.

provider_instance_size_name str

Atlas provides different instance sizes, each with a default storage capacity and RAM size. The instance size you select is used for all the data-bearing servers in your cluster. See Create a Cluster providerSettings.instanceSizeName for valid values and default resources. Note free tier (M0) creation is not supported by the Atlas API and hence not supported by this provider.)

provider_name str

Cloud service provider on which the servers are provisioned.

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. Do not specify this field when creating a multi-region cluster using the replicationSpec document or a Global Cluster with the replicationSpecs array.

provider_volume_type str

The type of the volume. The possible values are: STANDARD and PROVISIONED. PROVISIONED required if setting IOPS higher than the default instance IOPS.

replication_factor int

Number of replica set members. Each member keeps a copy of your databases, providing high availability and data redundancy. The possible values are 3, 5, or 7. The default value is 3.

replication_specs Sequence[ClusterReplicationSpecArgs]

Configuration for cluster regions. See Replication Spec below for more details.

snapshot_backup_policies Sequence[ClusterSnapshotBackupPolicyArgs]

current snapshot schedule and retention settings for the cluster.

srv_address str

Connection string for connecting to the Atlas cluster. The +srv modifier forces the connection to use TLS/SSL. See the mongoURI for additional options.

state_name str

Current state of the cluster. The possible states are: - IDLE - CREATING - UPDATING - DELETING - DELETED - REPAIRING

Supporting Types

ClusterAdvancedConfiguration

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

FailIndexKeyTooLong bool

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

JavascriptEnabled bool

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

MinimumEnabledTlsProtocol string

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

NoTableScan bool

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

OplogSizeMb int

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

SampleRefreshIntervalBiConnector int

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

SampleSizeBiConnector int

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

FailIndexKeyTooLong bool

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

JavascriptEnabled bool

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

MinimumEnabledTlsProtocol string

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

NoTableScan bool

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

OplogSizeMb int

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

SampleRefreshIntervalBiConnector int

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

SampleSizeBiConnector int

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

failIndexKeyTooLong boolean

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

javascriptEnabled boolean

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

minimumEnabledTlsProtocol string

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

noTableScan boolean

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

oplogSizeMb number

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

sampleRefreshIntervalBiConnector number

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

sampleSizeBiConnector number

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

fail_index_key_too_long bool

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

javascript_enabled bool

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

minimum_enabled_tls_protocol str

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

no_table_scan bool

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

oplog_size_mb int

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

sample_refresh_interval_bi_connector int

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

sample_size_bi_connector int

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

ClusterBiConnector

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Enabled string

Specifies whether or not BI Connector for Atlas is enabled on the cluster.l * - Set to true to enable BI Connector for Atlas. - Set to false to disable BI Connector for Atlas.

ReadPreference string

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

Enabled string

Specifies whether or not BI Connector for Atlas is enabled on the cluster.l * - Set to true to enable BI Connector for Atlas. - Set to false to disable BI Connector for Atlas.

ReadPreference string

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

enabled string

Specifies whether or not BI Connector for Atlas is enabled on the cluster.l * - Set to true to enable BI Connector for Atlas. - Set to false to disable BI Connector for Atlas.

readPreference string

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

enabled str

Specifies whether or not BI Connector for Atlas is enabled on the cluster.l * - Set to true to enable BI Connector for Atlas. - Set to false to disable BI Connector for Atlas.

read_preference str

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

ClusterConnectionStrings

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

AwsPrivateLink Dictionary<string, object>
AwsPrivateLinkSrv Dictionary<string, object>
Private string
PrivateSrv string
Standard string
StandardSrv string
AwsPrivateLink map[string]interface{}
AwsPrivateLinkSrv map[string]interface{}
Private string
PrivateSrv string
Standard string
StandardSrv string
awsPrivateLink {[key: string]: any}
awsPrivateLinkSrv {[key: string]: any}
private string
privateSrv string
standard string
standardSrv string
aws_private_link Mapping[str, Any]
aws_private_link_srv Mapping[str, Any]
private str
private_srv str
standard str
standard_srv str

ClusterLabel

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Key string

The key that you want to write.

Value string

The value that you want to write.

Key string

The key that you want to write.

Value string

The value that you want to write.

key string

The key that you want to write.

value string

The value that you want to write.

key str

The key that you want to write.

value str

The value that you want to write.

ClusterReplicationSpec

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

NumShards int

Number of shards to deploy in the specified zone, minimum 1.

Id string

Unique identifer of the replication document for a zone in a Global Cluster.

RegionsConfigs List<ClusterReplicationSpecRegionsConfigArgs>

Physical location of the region. Each regionsConfig document describes the region’s priority in elections and the number and type of MongoDB nodes Atlas deploys to the region. You must order each regionsConfigs document by regionsConfig.priority, descending. See Region Config below for more details.

ZoneName string

Name for the zone in a Global Cluster.

NumShards int

Number of shards to deploy in the specified zone, minimum 1.

Id string

Unique identifer of the replication document for a zone in a Global Cluster.

RegionsConfigs []ClusterReplicationSpecRegionsConfig

Physical location of the region. Each regionsConfig document describes the region’s priority in elections and the number and type of MongoDB nodes Atlas deploys to the region. You must order each regionsConfigs document by regionsConfig.priority, descending. See Region Config below for more details.

ZoneName string

Name for the zone in a Global Cluster.

numShards number

Number of shards to deploy in the specified zone, minimum 1.

id string

Unique identifer of the replication document for a zone in a Global Cluster.

regionsConfigs ClusterReplicationSpecRegionsConfig[]

Physical location of the region. Each regionsConfig document describes the region’s priority in elections and the number and type of MongoDB nodes Atlas deploys to the region. You must order each regionsConfigs document by regionsConfig.priority, descending. See Region Config below for more details.

zoneName string

Name for the zone in a Global Cluster.

num_shards int

Number of shards to deploy in the specified zone, minimum 1.

id str

Unique identifer of the replication document for a zone in a Global Cluster.

regions_configs Sequence[ClusterReplicationSpecRegionsConfigArgs]

Physical location of the region. Each regionsConfig document describes the region’s priority in elections and the number and type of MongoDB nodes Atlas deploys to the region. You must order each regionsConfigs document by regionsConfig.priority, descending. See Region Config below for more details.

zone_name str

Name for the zone in a Global Cluster.

ClusterReplicationSpecRegionsConfig

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

AnalyticsNodes int

The number of analytics nodes for Atlas to deploy to the region. Analytics nodes are useful for handling analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only, and can never become the primary. If you do not specify this option, no analytics nodes are deployed to the region.

ElectableNodes int

Number of electable nodes for Atlas to deploy to the region. Electable nodes can become the primary and can facilitate local reads. * The total number of electableNodes across all replication spec regions must total 3, 5, or 7. * Specify 0 if you do not want any electable nodes in the region. * You cannot create electable nodes in a region if priority is 0.

Priority int

Election priority of the region. For regions with only read-only nodes, set this value to 0. * For regions where electable_nodes is at least 1, each region must have a priority of exactly one (1) less than the previous region. The first region must have a priority of 7. The lowest possible priority is 1. * The priority 7 region identifies the Preferred Region of the cluster. Atlas places the primary node in the Preferred Region. Priorities 1 through 7 are exclusive - no more than one region per cluster can be assigned a given priority. * Example: If you have three regions, their priorities would be 7, 6, and 5 respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be 4 and 3 respectively.

ReadOnlyNodes int

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can facilitate local-reads. Specify 0 if you do not want any read-only nodes in the region.

RegionName string

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

AnalyticsNodes int

The number of analytics nodes for Atlas to deploy to the region. Analytics nodes are useful for handling analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only, and can never become the primary. If you do not specify this option, no analytics nodes are deployed to the region.

ElectableNodes int

Number of electable nodes for Atlas to deploy to the region. Electable nodes can become the primary and can facilitate local reads. * The total number of electableNodes across all replication spec regions must total 3, 5, or 7. * Specify 0 if you do not want any electable nodes in the region. * You cannot create electable nodes in a region if priority is 0.

Priority int

Election priority of the region. For regions with only read-only nodes, set this value to 0. * For regions where electable_nodes is at least 1, each region must have a priority of exactly one (1) less than the previous region. The first region must have a priority of 7. The lowest possible priority is 1. * The priority 7 region identifies the Preferred Region of the cluster. Atlas places the primary node in the Preferred Region. Priorities 1 through 7 are exclusive - no more than one region per cluster can be assigned a given priority. * Example: If you have three regions, their priorities would be 7, 6, and 5 respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be 4 and 3 respectively.

ReadOnlyNodes int

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can facilitate local-reads. Specify 0 if you do not want any read-only nodes in the region.

RegionName string

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

analyticsNodes number

The number of analytics nodes for Atlas to deploy to the region. Analytics nodes are useful for handling analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only, and can never become the primary. If you do not specify this option, no analytics nodes are deployed to the region.

electableNodes number

Number of electable nodes for Atlas to deploy to the region. Electable nodes can become the primary and can facilitate local reads. * The total number of electableNodes across all replication spec regions must total 3, 5, or 7. * Specify 0 if you do not want any electable nodes in the region. * You cannot create electable nodes in a region if priority is 0.

priority number

Election priority of the region. For regions with only read-only nodes, set this value to 0. * For regions where electable_nodes is at least 1, each region must have a priority of exactly one (1) less than the previous region. The first region must have a priority of 7. The lowest possible priority is 1. * The priority 7 region identifies the Preferred Region of the cluster. Atlas places the primary node in the Preferred Region. Priorities 1 through 7 are exclusive - no more than one region per cluster can be assigned a given priority. * Example: If you have three regions, their priorities would be 7, 6, and 5 respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be 4 and 3 respectively.

readOnlyNodes number

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can facilitate local-reads. Specify 0 if you do not want any read-only nodes in the region.

regionName string

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

analytics_nodes int

The number of analytics nodes for Atlas to deploy to the region. Analytics nodes are useful for handling analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only, and can never become the primary. If you do not specify this option, no analytics nodes are deployed to the region.

electable_nodes int

Number of electable nodes for Atlas to deploy to the region. Electable nodes can become the primary and can facilitate local reads. * The total number of electableNodes across all replication spec regions must total 3, 5, or 7. * Specify 0 if you do not want any electable nodes in the region. * You cannot create electable nodes in a region if priority is 0.

priority int

Election priority of the region. For regions with only read-only nodes, set this value to 0. * For regions where electable_nodes is at least 1, each region must have a priority of exactly one (1) less than the previous region. The first region must have a priority of 7. The lowest possible priority is 1. * The priority 7 region identifies the Preferred Region of the cluster. Atlas places the primary node in the Preferred Region. Priorities 1 through 7 are exclusive - no more than one region per cluster can be assigned a given priority. * Example: If you have three regions, their priorities would be 7, 6, and 5 respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be 4 and 3 respectively.

read_only_nodes int

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can facilitate local-reads. Specify 0 if you do not want any read-only nodes in the region.

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.

ClusterSnapshotBackupPolicy

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

ClusterId string

The cluster ID.

ClusterName string
NextSnapshot string
Policies List<ClusterSnapshotBackupPolicyPolicyArgs>
ReferenceHourOfDay int
ReferenceMinuteOfHour int
RestoreWindowDays int
UpdateSnapshots bool
ClusterId string

The cluster ID.

ClusterName string
NextSnapshot string
Policies []ClusterSnapshotBackupPolicyPolicy
ReferenceHourOfDay int
ReferenceMinuteOfHour int
RestoreWindowDays int
UpdateSnapshots bool
clusterId string

The cluster ID.

clusterName string
nextSnapshot string
policies ClusterSnapshotBackupPolicyPolicy[]
referenceHourOfDay number
referenceMinuteOfHour number
restoreWindowDays number
updateSnapshots boolean
cluster_id str

The cluster ID.

cluster_name str
next_snapshot str
policies Sequence[ClusterSnapshotBackupPolicyPolicyArgs]
reference_hour_of_day int
reference_minute_of_hour int
restore_window_days int
update_snapshots bool

ClusterSnapshotBackupPolicyPolicy

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

Id string

Unique identifer of the replication document for a zone in a Global Cluster.

PolicyItems List<ClusterSnapshotBackupPolicyPolicyPolicyItemArgs>
Id string

Unique identifer of the replication document for a zone in a Global Cluster.

PolicyItems []ClusterSnapshotBackupPolicyPolicyPolicyItem
id string

Unique identifer of the replication document for a zone in a Global Cluster.

policyItems ClusterSnapshotBackupPolicyPolicyPolicyItem[]
id str

Unique identifer of the replication document for a zone in a Global Cluster.

policy_items Sequence[ClusterSnapshotBackupPolicyPolicyPolicyItemArgs]

ClusterSnapshotBackupPolicyPolicyPolicyItem

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

FrequencyInterval int
FrequencyType string
Id string

Unique identifer of the replication document for a zone in a Global Cluster.

RetentionUnit string
RetentionValue int
FrequencyInterval int
FrequencyType string
Id string

Unique identifer of the replication document for a zone in a Global Cluster.

RetentionUnit string
RetentionValue int
frequencyInterval number
frequencyType string
id string

Unique identifer of the replication document for a zone in a Global Cluster.

retentionUnit string
retentionValue number
frequency_interval int
frequency_type str
id str

Unique identifer of the replication document for a zone in a Global Cluster.

retention_unit str
retention_value int

Package Details

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