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.
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.0",
            NumShards = 1,
            ProjectId = "<YOUR-PROJECT-ID>",
            ProviderBackupEnabled = true,
            ProviderDiskIops = 300,
            ProviderEncryptEbsVolume = true,
            ProviderInstanceSizeName = "M40",
            ProviderName = "AWS",
            ProviderRegionName = "US_EAST_1",
            ProviderVolumeType = "STANDARD",
            ReplicationFactor = 3,
        });
    }

}

Coming soon!

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.0",
    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.0",
    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.0",
            NumShards = 1,
            ProjectId = "<YOUR-PROJECT-ID>",
            ProviderBackupEnabled = true,
            ProviderDiskTypeName = "P6",
            ProviderInstanceSizeName = "M30",
            ProviderName = "AZURE",
            ProviderRegionName = "US_EAST_2",
            ReplicationFactor = 3,
        });
    }

}

Coming soon!

import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.Cluster("test",
    auto_scaling_disk_gb_enabled=True,
    mongo_db_major_version="4.0",
    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.0",
    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.0",
            NumShards = 1,
            ProjectId = "<YOUR-PROJECT-ID>",
            ProviderBackupEnabled = true,
            ProviderInstanceSizeName = "M30",
            ProviderName = "GCP",
            ProviderRegionName = "US_EAST_4",
            ReplicationFactor = 3,
        });
    }

}

Coming soon!

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.0",
    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.0",
    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,
                    RegionsConfig = 
                    {
                        
                        {
                            { "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" },
                        },
                    },
                },
            },
        });
    }

}

Coming soon!

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=[{
        "num_shards": 1,
        "regionsConfig": [
            {
                "electableNodes": 3,
                "priority": 7,
                "readOnlyNodes": 0,
                "region_name": "US_EAST_1",
            },
            {
                "electableNodes": 2,
                "priority": 6,
                "readOnlyNodes": 0,
                "region_name": "US_EAST_2",
            },
            {
                "electableNodes": 2,
                "priority": 5,
                "readOnlyNodes": 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,
                    RegionsConfig = 
                    {
                        
                        {
                            { "electableNodes", 3 },
                            { "priority", 7 },
                            { "readOnlyNodes", 0 },
                            { "regionName", "US_EAST_1" },
                        },
                    },
                    ZoneName = "Zone 1",
                },
                new Mongodbatlas.Inputs.ClusterReplicationSpecArgs
                {
                    NumShards = 2,
                    RegionsConfig = 
                    {
                        
                        {
                            { "electableNodes", 3 },
                            { "priority", 7 },
                            { "readOnlyNodes", 0 },
                            { "regionName", "EU_CENTRAL_1" },
                        },
                    },
                    ZoneName = "Zone 2",
                },
            },
        });
    }

}

Coming soon!

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=[
        {
            "num_shards": 2,
            "regionsConfig": [{
                "electableNodes": 3,
                "priority": 7,
                "readOnlyNodes": 0,
                "region_name": "US_EAST_1",
            }],
            "zoneName": "Zone 1",
        },
        {
            "num_shards": 2,
            "regionsConfig": [{
                "electableNodes": 3,
                "priority": 7,
                "readOnlyNodes": 0,
                "region_name": "EU_CENTRAL_1",
            }],
            "zoneName": "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",
        });
    }

}

Coming soon!

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, opts=None, advanced_configuration=None, auto_scaling_disk_gb_enabled=None, backing_provider_name=None, backup_enabled=None, bi_connector=None, cluster_type=None, disk_size_gb=None, encryption_at_rest_provider=None, labels=None, mongo_db_major_version=None, name=None, num_shards=None, pit_enabled=None, project_id=None, provider_backup_enabled=None, provider_disk_iops=None, provider_disk_type_name=None, provider_encrypt_ebs_volume=None, provider_instance_size_name=None, provider_name=None, provider_region_name=None, provider_volume_type=None, replication_factor=None, replication_specs=None, __props__=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.

ProviderName string

Cloud service provider on which the servers are provisioned.

AdvancedConfiguration ClusterAdvancedConfigurationArgs

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

Legacy Option - Set to true to enable Atlas continuous backups for the cluster.

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

The size in gigabytes of the server’s root volume. You can add capacity by increasing this number, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive integer.

EncryptionAtRestProvider string

Set the Encryption at Rest parameter. Possible values are AWS, GCP, AZURE or NONE. Requires M10 or greater and for backup_enabled to be false or omitted.

Labels List<ClusterLabelArgs>

Array containing key-value pairs that tag and categorize the cluster. Each key and value has a maximum length of 255 characters. You cannot set the key Infrastructure Tool, it is used for internal purposes to track aggregate usage.

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.

PitEnabled bool

Flag that indicates if the cluster uses Point-in-Time backups. If set to true, provider_backup_enabled must also be set to true.

ProviderBackupEnabled bool

Flag indicating if the cluster uses Cloud Provider Snapshots for backups.

ProviderDiskIops int

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

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, 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 instance.

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

ProviderName string

Cloud service provider on which the servers are provisioned.

AdvancedConfiguration ClusterAdvancedConfiguration

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

Legacy Option - Set to true to enable Atlas continuous backups for the cluster.

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

The size in gigabytes of the server’s root volume. You can add capacity by increasing this number, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive integer.

EncryptionAtRestProvider string

Set the Encryption at Rest parameter. Possible values are AWS, GCP, AZURE or NONE. Requires M10 or greater and for backup_enabled to be false or omitted.

Labels []ClusterLabel

MongoDbMajorVersion string

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.

PitEnabled bool

Flag that indicates if the cluster uses Point-in-Time backups. If set to true, provider_backup_enabled must also be set to true.

ProviderBackupEnabled bool

Flag indicating if the cluster uses Cloud Provider Snapshots for backups.

ProviderDiskIops int

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

ProviderDiskTypeName string

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 instance.

ProviderRegionName string

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

providerName string

Cloud service provider on which the servers are provisioned.

advancedConfiguration ClusterAdvancedConfiguration

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

Legacy Option - Set to true to enable Atlas continuous backups for the cluster.

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

The size in gigabytes of the server’s root volume. You can add capacity by increasing this number, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive integer.

encryptionAtRestProvider string

Set the Encryption at Rest parameter. Possible values are AWS, GCP, AZURE or NONE. Requires M10 or greater and for backup_enabled to be false or omitted.

labels ClusterLabel[]

mongoDbMajorVersion string

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.

pitEnabled boolean

Flag that indicates if the cluster uses Point-in-Time backups. If set to true, provider_backup_enabled must also be set to true.

providerBackupEnabled boolean

Flag indicating if the cluster uses Cloud Provider Snapshots for backups.

providerDiskIops number

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

providerDiskTypeName string

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 instance.

providerRegionName string

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

provider_name str

Cloud service provider on which the servers are provisioned.

advanced_configuration Dict[ClusterAdvancedConfiguration]

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

Legacy Option - Set to true to enable Atlas continuous backups for the cluster.

bi_connector Dict[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.

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

The size in gigabytes of the server’s root volume. You can add capacity by increasing this number, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive integer.

encryption_at_rest_provider str

Set the Encryption at Rest parameter. Possible values are AWS, GCP, AZURE or NONE. Requires M10 or greater and for backup_enabled to be false or omitted.

labels List[ClusterLabel]

mongo_db_major_version str

name str

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

num_shards float

Number of shards to deploy in the specified zone.

pit_enabled bool

Flag that indicates if the cluster uses Point-in-Time backups. If set to true, provider_backup_enabled must also be set to true.

provider_backup_enabled bool

Flag indicating if the cluster uses Cloud Provider Snapshots for backups.

provider_disk_iops float

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

provider_disk_type_name str

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 instance.

provider_region_name str

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 float

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 List[ClusterReplicationSpec]

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. - connection_strings.standard - Public mongodb:// connection string for this cluster. - connection_strings.standard_srv - Public mongodb+srv:// connection string for this cluster. The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS. Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don’t need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn’t, use connectionStrings.standard. - connection_strings.aws_private_link - Private-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a AWS PrivateLink connection to this cluster. - connection_strings.aws_private_link_srv - Private-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a AWS PrivateLink connection to this cluster. Use this URI format if your driver supports it. If it doesn’t, use connectionStrings.awsPrivateLink. - connection_strings.private - Network-peering-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster. - connection_strings.private_srv - Network-peering-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.
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. - connection_strings.standard - Public mongodb:// connection string for this cluster. - connection_strings.standard_srv - Public mongodb+srv:// connection string for this cluster. The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS. Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don’t need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn’t, use connectionStrings.standard. - connection_strings.aws_private_link - Private-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a AWS PrivateLink connection to this cluster. - connection_strings.aws_private_link_srv - Private-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a AWS PrivateLink connection to this cluster. Use this URI format if your driver supports it. If it doesn’t, use connectionStrings.awsPrivateLink. - connection_strings.private - Network-peering-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster. - connection_strings.private_srv - Network-peering-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.
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. - connection_strings.standard - Public mongodb:// connection string for this cluster. - connection_strings.standard_srv - Public mongodb+srv:// connection string for this cluster. The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS. Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don’t need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn’t, use connectionStrings.standard. - connection_strings.aws_private_link - Private-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a AWS PrivateLink connection to this cluster. - connection_strings.aws_private_link_srv - Private-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a AWS PrivateLink connection to this cluster. Use this URI format if your driver supports it. If it doesn’t, use connectionStrings.awsPrivateLink. - connection_strings.private - Network-peering-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster. - connection_strings.private_srv - Network-peering-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.
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 Dict[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. - connection_strings.standard - Public mongodb:// connection string for this cluster. - connection_strings.standard_srv - Public mongodb+srv:// connection string for this cluster. The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS. Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don’t need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn’t, use connectionStrings.standard. - connection_strings.aws_private_link - Private-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a AWS PrivateLink connection to this cluster. - connection_strings.aws_private_link_srv - Private-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a AWS PrivateLink connection to this cluster. Use this URI format if your driver supports it. If it doesn’t, use connectionStrings.awsPrivateLink. - connection_strings.private - Network-peering-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster. - connection_strings.private_srv - Network-peering-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.
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 List[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

static get(resource_name, id, opts=None, advanced_configuration=None, auto_scaling_disk_gb_enabled=None, backing_provider_name=None, backup_enabled=None, bi_connector=None, cluster_id=None, cluster_type=None, connection_strings=None, disk_size_gb=None, encryption_at_rest_provider=None, labels=None, mongo_db_major_version=None, mongo_db_version=None, mongo_uri=None, mongo_uri_updated=None, mongo_uri_with_options=None, name=None, num_shards=None, paused=None, pit_enabled=None, project_id=None, provider_backup_enabled=None, provider_disk_iops=None, provider_disk_type_name=None, provider_encrypt_ebs_volume=None, provider_instance_size_name=None, provider_name=None, provider_region_name=None, provider_volume_type=None, replication_factor=None, replication_specs=None, snapshot_backup_policies=None, srv_address=None, state_name=None, __props__=None);

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

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

Legacy Option - Set to true to enable Atlas continuous backups for the cluster.

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. - connection_strings.standard - Public mongodb:// connection string for this cluster. - connection_strings.standard_srv - Public mongodb+srv:// connection string for this cluster. The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS. Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don’t need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn’t, use connectionStrings.standard. - connection_strings.aws_private_link - Private-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a AWS PrivateLink connection to this cluster. - connection_strings.aws_private_link_srv - Private-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a AWS PrivateLink connection to this cluster. Use this URI format if your driver supports it. If it doesn’t, use connectionStrings.awsPrivateLink. - connection_strings.private - Network-peering-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster. - connection_strings.private_srv - Network-peering-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.

DiskSizeGb double

The size in gigabytes of the server’s root volume. You can add capacity by increasing this number, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive integer.

EncryptionAtRestProvider string

Set the Encryption at Rest parameter. Possible values are AWS, GCP, AZURE or NONE. Requires M10 or greater and for backup_enabled to be false or omitted.

Labels List<ClusterLabelArgs>

MongoDbMajorVersion string

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.

Paused bool

Flag that indicates whether the cluster is paused or not.

PitEnabled bool

Flag that indicates if the cluster uses Point-in-Time backups. 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.

ProviderBackupEnabled bool

Flag indicating if the cluster uses Cloud Provider Snapshots for backups.

ProviderDiskIops int

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

ProviderDiskTypeName string

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 instance.

ProviderInstanceSizeName string

ProviderName string

Cloud service provider on which the servers are provisioned.

ProviderRegionName string

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

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

Legacy Option - Set to true to enable Atlas continuous backups for the cluster.

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

DiskSizeGb float64

The size in gigabytes of the server’s root volume. You can add capacity by increasing this number, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive integer.

EncryptionAtRestProvider string

Set the Encryption at Rest parameter. Possible values are AWS, GCP, AZURE or NONE. Requires M10 or greater and for backup_enabled to be false or omitted.

Labels []ClusterLabel

MongoDbMajorVersion string

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.

Paused bool

Flag that indicates whether the cluster is paused or not.

PitEnabled bool

Flag that indicates if the cluster uses Point-in-Time backups. 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.

ProviderBackupEnabled bool

Flag indicating if the cluster uses Cloud Provider Snapshots for backups.

ProviderDiskIops int

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

ProviderDiskTypeName string

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 instance.

ProviderInstanceSizeName string

ProviderName string

Cloud service provider on which the servers are provisioned.

ProviderRegionName string

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

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

Legacy Option - Set to true to enable Atlas continuous backups for the cluster.

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

diskSizeGb number

The size in gigabytes of the server’s root volume. You can add capacity by increasing this number, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive integer.

encryptionAtRestProvider string

Set the Encryption at Rest parameter. Possible values are AWS, GCP, AZURE or NONE. Requires M10 or greater and for backup_enabled to be false or omitted.

labels ClusterLabel[]

mongoDbMajorVersion string

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.

paused boolean

Flag that indicates whether the cluster is paused or not.

pitEnabled boolean

Flag that indicates if the cluster uses Point-in-Time backups. 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.

providerBackupEnabled boolean

Flag indicating if the cluster uses Cloud Provider Snapshots for backups.

providerDiskIops number

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

providerDiskTypeName string

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 instance.

providerInstanceSizeName string

providerName string

Cloud service provider on which the servers are provisioned.

providerRegionName string

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 Dict[ClusterAdvancedConfiguration]

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

Legacy Option - Set to true to enable Atlas continuous backups for the cluster.

bi_connector Dict[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.

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 Dict[ClusterConnectionStrings]

disk_size_gb float

The size in gigabytes of the server’s root volume. You can add capacity by increasing this number, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive integer.

encryption_at_rest_provider str

Set the Encryption at Rest parameter. Possible values are AWS, GCP, AZURE or NONE. Requires M10 or greater and for backup_enabled to be false or omitted.

labels List[ClusterLabel]

mongo_db_major_version str

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 float

Number of shards to deploy in the specified zone.

paused bool

Flag that indicates whether the cluster is paused or not.

pit_enabled bool

Flag that indicates if the cluster uses Point-in-Time backups. 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_backup_enabled bool

Flag indicating if the cluster uses Cloud Provider Snapshots for backups.

provider_disk_iops float

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

provider_disk_type_name str

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 instance.

provider_instance_size_name str

provider_name str

Cloud service provider on which the servers are provisioned.

provider_region_name str

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 float

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 List[ClusterReplicationSpec]

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

snapshot_backup_policies List[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

Supporting Types

ClusterAdvancedConfiguration

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 float: 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 float: 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 float: 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.

Enabled string: Specifies whether or not BI Connector for Atlas is enabled on the cluster. - 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. - 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. - 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. - 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.

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

awsPrivateLink Dict[str, Any]
awsPrivateLinkSrv Dict[str, Any]
private str
privateSrv str
standard str
standardSrv str

ClusterLabel

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.

NumShards int: Number of shards to deploy in the specified zone.
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.
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.
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 float: Number of shards to deploy in the specified zone.
id str: Unique identifer of the replication document for a zone in a Global Cluster.
regionsConfigs List[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 str: Name for the zone in a Global Cluster.

ClusterReplicationSpecRegionsConfig

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.
ElectableNodes int: Number of electable nodes for Atlas to deploy to the region. Electable nodes can become the primary and can facilitate local reads.
Priority int: Election priority of the region. For regions with only read-only nodes, set this value to 0.
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: Name for the region specified.

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.
ElectableNodes int: Number of electable nodes for Atlas to deploy to the region. Electable nodes can become the primary and can facilitate local reads.
Priority int: Election priority of the region. For regions with only read-only nodes, set this value to 0.
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: Name for the region specified.

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.
electableNodes number: Number of electable nodes for Atlas to deploy to the region. Electable nodes can become the primary and can facilitate local reads.
priority number: Election priority of the region. For regions with only read-only nodes, set this value to 0.
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: Name for the region specified.

analyticsNodes float: 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.
electableNodes float: Number of electable nodes for Atlas to deploy to the region. Electable nodes can become the primary and can facilitate local reads.
priority float: Election priority of the region. For regions with only read-only nodes, set this value to 0.
readOnlyNodes float: 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: Name for the region specified.

ClusterSnapshotBackupPolicy

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 List[ClusterSnapshotBackupPolicyPolicy]
reference_hour_of_day float
reference_minute_of_hour float
restore_window_days float
update_snapshots bool

ClusterSnapshotBackupPolicyPolicy

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.
policyItems List[ClusterSnapshotBackupPolicyPolicyPolicyItem]

ClusterSnapshotBackupPolicyPolicyPolicyItem

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

frequencyInterval float
frequencyType str
id str: Unique identifer of the replication document for a zone in a Global Cluster.
retentionUnit str
retentionValue float

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Cluster

Example Usage

Example AWS cluster

Example Azure cluster.

Example GCP cluster

Example Multi Region cluster

Example Global cluster

Example AWS Shared Tier cluster

Create a Cluster Resource

Cluster Resource Properties

Inputs

Outputs

Look up an Existing Cluster Resource

Supporting Types

ClusterAdvancedConfiguration

ClusterBiConnector

ClusterConnectionStrings

ClusterLabel

ClusterReplicationSpec

ClusterReplicationSpecRegionsConfig

ClusterSnapshotBackupPolicy

ClusterSnapshotBackupPolicyPolicy

ClusterSnapshotBackupPolicyPolicyPolicyItem

Package Details

On This Page