MongoDB Atlas v3.16.2, Jun 21 24

MongoDB Atlas v3.16.2 published on Friday, Jun 21, 2024 by Pulumi

mongodbatlas.getCluster

Explore with Pulumi AI

MongoDB Atlas v3.16.2 published on Friday, Jun 21, 2024 by Pulumi

IMPORTANT:
• Multi Region Cluster: The mongodbatlas.Cluster data source doesn’t return the container_id for each region utilized by the cluster. For retrieving the container_id, we recommend the mongodbatlas.AdvancedCluster data source instead.
• 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

import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const testCluster = new mongodbatlas.Cluster("test", {
    projectId: "<YOUR-PROJECT-ID>",
    name: "cluster-test",
    clusterType: "REPLICASET",
    replicationSpecs: [{
        numShards: 1,
        regionsConfigs: [{
            regionName: "US_EAST_1",
            electableNodes: 3,
            priority: 7,
            readOnlyNodes: 0,
        }],
    }],
    cloudBackup: true,
    autoScalingDiskGbEnabled: true,
    providerName: "AWS",
    providerInstanceSizeName: "M40",
});
const test = mongodbatlas.getClusterOutput({
    projectId: testCluster.projectId,
    name: testCluster.name,
});

import pulumi
import pulumi_mongodbatlas as mongodbatlas

test_cluster = mongodbatlas.Cluster("test",
    project_id="<YOUR-PROJECT-ID>",
    name="cluster-test",
    cluster_type="REPLICASET",
    replication_specs=[mongodbatlas.ClusterReplicationSpecArgs(
        num_shards=1,
        regions_configs=[mongodbatlas.ClusterReplicationSpecRegionsConfigArgs(
            region_name="US_EAST_1",
            electable_nodes=3,
            priority=7,
            read_only_nodes=0,
        )],
    )],
    cloud_backup=True,
    auto_scaling_disk_gb_enabled=True,
    provider_name="AWS",
    provider_instance_size_name="M40")
test = mongodbatlas.get_cluster_output(project_id=test_cluster.project_id,
    name=test_cluster.name)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		testCluster, err := mongodbatlas.NewCluster(ctx, "test", &mongodbatlas.ClusterArgs{
			ProjectId:   pulumi.String("<YOUR-PROJECT-ID>"),
			Name:        pulumi.String("cluster-test"),
			ClusterType: pulumi.String("REPLICASET"),
			ReplicationSpecs: mongodbatlas.ClusterReplicationSpecArray{
				&mongodbatlas.ClusterReplicationSpecArgs{
					NumShards: pulumi.Int(1),
					RegionsConfigs: mongodbatlas.ClusterReplicationSpecRegionsConfigArray{
						&mongodbatlas.ClusterReplicationSpecRegionsConfigArgs{
							RegionName:     pulumi.String("US_EAST_1"),
							ElectableNodes: pulumi.Int(3),
							Priority:       pulumi.Int(7),
							ReadOnlyNodes:  pulumi.Int(0),
						},
					},
				},
			},
			CloudBackup:              pulumi.Bool(true),
			AutoScalingDiskGbEnabled: pulumi.Bool(true),
			ProviderName:             pulumi.String("AWS"),
			ProviderInstanceSizeName: pulumi.String("M40"),
		})
		if err != nil {
			return err
		}
		_ = mongodbatlas.LookupClusterOutput(ctx, mongodbatlas.GetClusterOutputArgs{
			ProjectId: testCluster.ProjectId,
			Name:      testCluster.Name,
		}, nil)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testCluster = new Mongodbatlas.Cluster("test", new()
    {
        ProjectId = "<YOUR-PROJECT-ID>",
        Name = "cluster-test",
        ClusterType = "REPLICASET",
        ReplicationSpecs = new[]
        {
            new Mongodbatlas.Inputs.ClusterReplicationSpecArgs
            {
                NumShards = 1,
                RegionsConfigs = new[]
                {
                    new Mongodbatlas.Inputs.ClusterReplicationSpecRegionsConfigArgs
                    {
                        RegionName = "US_EAST_1",
                        ElectableNodes = 3,
                        Priority = 7,
                        ReadOnlyNodes = 0,
                    },
                },
            },
        },
        CloudBackup = true,
        AutoScalingDiskGbEnabled = true,
        ProviderName = "AWS",
        ProviderInstanceSizeName = "M40",
    });

    var test = Mongodbatlas.GetCluster.Invoke(new()
    {
        ProjectId = testCluster.ProjectId,
        Name = testCluster.Name,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.Cluster;
import com.pulumi.mongodbatlas.ClusterArgs;
import com.pulumi.mongodbatlas.inputs.ClusterReplicationSpecArgs;
import com.pulumi.mongodbatlas.MongodbatlasFunctions;
import com.pulumi.mongodbatlas.inputs.GetClusterArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var testCluster = new Cluster("testCluster", ClusterArgs.builder()
            .projectId("<YOUR-PROJECT-ID>")
            .name("cluster-test")
            .clusterType("REPLICASET")
            .replicationSpecs(ClusterReplicationSpecArgs.builder()
                .numShards(1)
                .regionsConfigs(ClusterReplicationSpecRegionsConfigArgs.builder()
                    .regionName("US_EAST_1")
                    .electableNodes(3)
                    .priority(7)
                    .readOnlyNodes(0)
                    .build())
                .build())
            .cloudBackup(true)
            .autoScalingDiskGbEnabled(true)
            .providerName("AWS")
            .providerInstanceSizeName("M40")
            .build());

        final var test = MongodbatlasFunctions.getCluster(GetClusterArgs.builder()
            .projectId(testCluster.projectId())
            .name(testCluster.name())
            .build());

    }
}

resources:
  testCluster:
    type: mongodbatlas:Cluster
    name: test
    properties:
      projectId: <YOUR-PROJECT-ID>
      name: cluster-test
      clusterType: REPLICASET
      replicationSpecs:
        - numShards: 1
          regionsConfigs:
            - regionName: US_EAST_1
              electableNodes: 3
              priority: 7
              readOnlyNodes: 0
      cloudBackup: true
      autoScalingDiskGbEnabled: true # Provider Settings "block"
      providerName: AWS
      providerInstanceSizeName: M40
variables:
  test:
    fn::invoke:
      Function: mongodbatlas:getCluster
      Arguments:
        projectId: ${testCluster.projectId}
        name: ${testCluster.name}

Using getCluster

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOptions): Output<GetClusterResult>

def get_cluster(name: Optional[str] = None,
                project_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(name: Optional[pulumi.Input[str]] = None,
                project_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetClusterResult]

func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput

> Note: This function is named LookupCluster in the Go SDK.

public static class GetCluster 
{
    public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetClusterResult> Invoke(GetClusterInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: mongodbatlas:index/getCluster:getCluster
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed.
ProjectId string: The unique ID for the project to create the database user.

Name string: Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed.
ProjectId string: The unique ID for the project to create the database user.

name String: Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed.
projectId String: The unique ID for the project to create the database user.

name string: Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed.
projectId string: The unique ID for the project to create the database user.

name str: Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed.
project_id str: The unique ID for the project to create the database user.

name String: Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed.
projectId String: The unique ID for the project to create the database user.

getCluster Result

The following output properties are available:

AdvancedConfigurations List<GetClusterAdvancedConfiguration>

Get the advanced configuration options. See Advanced Configuration below for more details.

AutoScalingComputeEnabled bool

Specifies whether cluster tier auto-scaling is enabled. The default is false.

AutoScalingComputeScaleDownEnabled bool

Specifies whether cluster tier auto-down-scaling is enabled.

AutoScalingDiskGbEnabled bool

Indicates whether disk auto-scaling is enabled.

BackingProviderName string

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

BackupEnabled bool

Legacy Option, Indicates whether Atlas continuous backups are enabled for the cluster.

BiConnectorConfigs List<GetClusterBiConnectorConfig>

Indicates 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

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

ConnectionStrings List<GetClusterConnectionString>

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.

ContainerId string

The Network Peering Container ID.

DiskSizeGb double

Indicates the size in gigabytes of the server’s root volume (AWS/GCP Only).

EncryptionAtRestProvider string

Indicates whether Encryption at Rest is enabled or disabled.

Id string

The provider-assigned unique ID for this managed resource.

Labels List<GetClusterLabel>

Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. DEPRECATED Use tags instead.

Deprecated: This parameter is deprecated and will be removed by September 2024. Please transition to tags.

MongoDbMajorVersion string

Indicates the version of the cluster to deploy.

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

Describes 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

The name of the current plugin

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 Continuous Cloud Backup.

ProjectId string

ProviderAutoScalingComputeMaxInstanceSize string

Maximum instance size to which your cluster can automatically scale.

ProviderAutoScalingComputeMinInstanceSize string

Minimum instance size to which your cluster can automatically scale.

ProviderBackupEnabled bool

ProviderDiskIops int

Indicates 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

Describes Azure disk type of the server’s root volume (Azure Only).

ProviderEncryptEbsVolume bool

(DEPRECATED) Indicates whether the Amazon EBS encryption is enabled. This feature encrypts the server’s root volume for both data at rest within the volume and data moving between the volume and the instance. By default this attribute is always enabled, per deprecation process showing the real value at provider_encrypt_ebs_volume_flag computed attribute.

ProviderEncryptEbsVolumeFlag bool

ProviderInstanceSizeName string

Atlas provides different instance sizes, each with a default storage capacity and RAM size.

ProviderName string

Indicates the cloud service provider on which the servers are provisioned.

ProviderRegionName string

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

ProviderVolumeType string

Indicates the type of the volume. The possible values are: STANDARD and PROVISIONED.

NOTE: STANDARD is not available for NVME clusters.

ReplicationFactor int

(Deprecated) 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<GetClusterReplicationSpec>

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

SnapshotBackupPolicies List<GetClusterSnapshotBackupPolicy>

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

Indicates the current state of the cluster. The possible states are:

IDLE
CREATING
UPDATING
DELETING
DELETED
REPAIRING

Tags List<GetClusterTag>

Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.

TerminationProtectionEnabled bool

Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

VersionReleaseSystem string

Release cadence that Atlas uses for this cluster.

AdvancedConfigurations []GetClusterAdvancedConfiguration

Get the advanced configuration options. See Advanced Configuration below for more details.

AutoScalingComputeEnabled bool

Specifies whether cluster tier auto-scaling is enabled. The default is false.

AutoScalingComputeScaleDownEnabled bool

Specifies whether cluster tier auto-down-scaling is enabled.

AutoScalingDiskGbEnabled bool

Indicates whether disk auto-scaling is enabled.

BackingProviderName string

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

BackupEnabled bool

Legacy Option, Indicates whether Atlas continuous backups are enabled for the cluster.

BiConnectorConfigs []GetClusterBiConnectorConfig

Indicates 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

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

ConnectionStrings []GetClusterConnectionString

ContainerId string

The Network Peering Container ID.

DiskSizeGb float64

Indicates the size in gigabytes of the server’s root volume (AWS/GCP Only).

EncryptionAtRestProvider string

Indicates whether Encryption at Rest is enabled or disabled.

Id string

The provider-assigned unique ID for this managed resource.

Labels []GetClusterLabel

Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. DEPRECATED Use tags instead.

Deprecated: This parameter is deprecated and will be removed by September 2024. Please transition to tags.

MongoDbMajorVersion string

Indicates the version of the cluster to deploy.

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

Describes 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

The name of the current plugin

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 Continuous Cloud Backup.

ProjectId string

ProviderAutoScalingComputeMaxInstanceSize string

Maximum instance size to which your cluster can automatically scale.

ProviderAutoScalingComputeMinInstanceSize string

Minimum instance size to which your cluster can automatically scale.

ProviderBackupEnabled bool

ProviderDiskIops int

Indicates 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

Describes Azure disk type of the server’s root volume (Azure Only).

ProviderEncryptEbsVolume bool

ProviderEncryptEbsVolumeFlag bool

ProviderInstanceSizeName string

Atlas provides different instance sizes, each with a default storage capacity and RAM size.

ProviderName string

Indicates the cloud service provider on which the servers are provisioned.

ProviderRegionName string

ProviderVolumeType string

Indicates the type of the volume. The possible values are: STANDARD and PROVISIONED.

NOTE: STANDARD is not available for NVME clusters.

ReplicationFactor int

(Deprecated) 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 []GetClusterReplicationSpec

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

SnapshotBackupPolicies []GetClusterSnapshotBackupPolicy

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

Indicates the current state of the cluster. The possible states are:

IDLE
CREATING
UPDATING
DELETING
DELETED
REPAIRING

Tags []GetClusterTag

Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.

TerminationProtectionEnabled bool

Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

VersionReleaseSystem string

Release cadence that Atlas uses for this cluster.

advancedConfigurations List<GetClusterAdvancedConfiguration>

Get the advanced configuration options. See Advanced Configuration below for more details.

autoScalingComputeEnabled Boolean

Specifies whether cluster tier auto-scaling is enabled. The default is false.

autoScalingComputeScaleDownEnabled Boolean

Specifies whether cluster tier auto-down-scaling is enabled.

autoScalingDiskGbEnabled Boolean

Indicates whether disk auto-scaling is enabled.

backingProviderName String

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

backupEnabled Boolean

Legacy Option, Indicates whether Atlas continuous backups are enabled for the cluster.

biConnectorConfigs List<GetClusterBiConnectorConfig>

Indicates 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

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

connectionStrings List<GetClusterConnectionString>

containerId String

The Network Peering Container ID.

diskSizeGb Double

Indicates the size in gigabytes of the server’s root volume (AWS/GCP Only).

encryptionAtRestProvider String

Indicates whether Encryption at Rest is enabled or disabled.

id String

The provider-assigned unique ID for this managed resource.

labels List<GetClusterLabel>

Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. DEPRECATED Use tags instead.

Deprecated: This parameter is deprecated and will be removed by September 2024. Please transition to tags.

mongoDbMajorVersion String

Indicates the version of the cluster to deploy.

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

Describes 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

The name of the current plugin

numShards Integer

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 Continuous Cloud Backup.

projectId String

providerAutoScalingComputeMaxInstanceSize String

Maximum instance size to which your cluster can automatically scale.

providerAutoScalingComputeMinInstanceSize String

Minimum instance size to which your cluster can automatically scale.

providerBackupEnabled Boolean

providerDiskIops Integer

Indicates 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

Describes Azure disk type of the server’s root volume (Azure Only).

providerEncryptEbsVolume Boolean

providerEncryptEbsVolumeFlag Boolean

providerInstanceSizeName String

Atlas provides different instance sizes, each with a default storage capacity and RAM size.

providerName String

Indicates the cloud service provider on which the servers are provisioned.

providerRegionName String

providerVolumeType String

Indicates the type of the volume. The possible values are: STANDARD and PROVISIONED.

NOTE: STANDARD is not available for NVME clusters.

replicationFactor Integer

(Deprecated) 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<GetClusterReplicationSpec>

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

snapshotBackupPolicies List<GetClusterSnapshotBackupPolicy>

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

Indicates the current state of the cluster. The possible states are:

IDLE
CREATING
UPDATING
DELETING
DELETED
REPAIRING

tags List<GetClusterTag>

Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.

terminationProtectionEnabled Boolean

Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

versionReleaseSystem String

Release cadence that Atlas uses for this cluster.

advancedConfigurations GetClusterAdvancedConfiguration[]

Get the advanced configuration options. See Advanced Configuration below for more details.

autoScalingComputeEnabled boolean

Specifies whether cluster tier auto-scaling is enabled. The default is false.

autoScalingComputeScaleDownEnabled boolean

Specifies whether cluster tier auto-down-scaling is enabled.

autoScalingDiskGbEnabled boolean

Indicates whether disk auto-scaling is enabled.

backingProviderName string

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

backupEnabled boolean

Legacy Option, Indicates whether Atlas continuous backups are enabled for the cluster.

biConnectorConfigs GetClusterBiConnectorConfig[]

Indicates 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

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

connectionStrings GetClusterConnectionString[]

containerId string

The Network Peering Container ID.

diskSizeGb number

Indicates the size in gigabytes of the server’s root volume (AWS/GCP Only).

encryptionAtRestProvider string

Indicates whether Encryption at Rest is enabled or disabled.

id string

The provider-assigned unique ID for this managed resource.

labels GetClusterLabel[]

Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. DEPRECATED Use tags instead.

Deprecated: This parameter is deprecated and will be removed by September 2024. Please transition to tags.

mongoDbMajorVersion string

Indicates the version of the cluster to deploy.

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

Describes 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

The name of the current plugin

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 Continuous Cloud Backup.

projectId string

providerAutoScalingComputeMaxInstanceSize string

Maximum instance size to which your cluster can automatically scale.

providerAutoScalingComputeMinInstanceSize string

Minimum instance size to which your cluster can automatically scale.

providerBackupEnabled boolean

providerDiskIops number

Indicates 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

Describes Azure disk type of the server’s root volume (Azure Only).

providerEncryptEbsVolume boolean

providerEncryptEbsVolumeFlag boolean

providerInstanceSizeName string

Atlas provides different instance sizes, each with a default storage capacity and RAM size.

providerName string

Indicates the cloud service provider on which the servers are provisioned.

providerRegionName string

providerVolumeType string

Indicates the type of the volume. The possible values are: STANDARD and PROVISIONED.

NOTE: STANDARD is not available for NVME clusters.

replicationFactor number

(Deprecated) 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 GetClusterReplicationSpec[]

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

snapshotBackupPolicies GetClusterSnapshotBackupPolicy[]

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

Indicates the current state of the cluster. The possible states are:

IDLE
CREATING
UPDATING
DELETING
DELETED
REPAIRING

tags GetClusterTag[]

Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.

terminationProtectionEnabled boolean

Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

versionReleaseSystem string

Release cadence that Atlas uses for this cluster.

advanced_configurations Sequence[GetClusterAdvancedConfiguration]

Get the advanced configuration options. See Advanced Configuration below for more details.

auto_scaling_compute_enabled bool

Specifies whether cluster tier auto-scaling is enabled. The default is false.

auto_scaling_compute_scale_down_enabled bool

Specifies whether cluster tier auto-down-scaling is enabled.

auto_scaling_disk_gb_enabled bool

Indicates whether disk auto-scaling is enabled.

backing_provider_name str

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

backup_enabled bool

Legacy Option, Indicates whether Atlas continuous backups are enabled for the cluster.

bi_connector_configs Sequence[GetClusterBiConnectorConfig]

Indicates 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

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

connection_strings Sequence[GetClusterConnectionString]

container_id str

The Network Peering Container ID.

disk_size_gb float

Indicates the size in gigabytes of the server’s root volume (AWS/GCP Only).

encryption_at_rest_provider str

Indicates whether Encryption at Rest is enabled or disabled.

id str

The provider-assigned unique ID for this managed resource.

labels Sequence[GetClusterLabel]

Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. DEPRECATED Use tags instead.

Deprecated: This parameter is deprecated and will be removed by September 2024. Please transition to tags.

mongo_db_major_version str

Indicates the version of the cluster to deploy.

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

Describes 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

The name of the current plugin

num_shards int

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 Continuous Cloud Backup.

project_id str

provider_auto_scaling_compute_max_instance_size str

Maximum instance size to which your cluster can automatically scale.

provider_auto_scaling_compute_min_instance_size str

Minimum instance size to which your cluster can automatically scale.

provider_backup_enabled bool

provider_disk_iops int

Indicates 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

Describes Azure disk type of the server’s root volume (Azure Only).

provider_encrypt_ebs_volume bool

provider_encrypt_ebs_volume_flag bool

provider_instance_size_name str

Atlas provides different instance sizes, each with a default storage capacity and RAM size.

provider_name str

Indicates the cloud service provider on which the servers are provisioned.

provider_region_name str

provider_volume_type str

Indicates the type of the volume. The possible values are: STANDARD and PROVISIONED.

NOTE: STANDARD is not available for NVME clusters.

replication_factor int

(Deprecated) 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[GetClusterReplicationSpec]

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

snapshot_backup_policies Sequence[GetClusterSnapshotBackupPolicy]

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

Indicates the current state of the cluster. The possible states are:

IDLE
CREATING
UPDATING
DELETING
DELETED
REPAIRING

tags Sequence[GetClusterTag]

Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.

termination_protection_enabled bool

Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

version_release_system str

Release cadence that Atlas uses for this cluster.

advancedConfigurations List<Property Map>

Get the advanced configuration options. See Advanced Configuration below for more details.

autoScalingComputeEnabled Boolean

Specifies whether cluster tier auto-scaling is enabled. The default is false.

autoScalingComputeScaleDownEnabled Boolean

Specifies whether cluster tier auto-down-scaling is enabled.

autoScalingDiskGbEnabled Boolean

Indicates whether disk auto-scaling is enabled.

backingProviderName String

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

backupEnabled Boolean

Legacy Option, Indicates whether Atlas continuous backups are enabled for the cluster.

biConnectorConfigs List<Property Map>

Indicates 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

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

connectionStrings List<Property Map>

containerId String

The Network Peering Container ID.

diskSizeGb Number

Indicates the size in gigabytes of the server’s root volume (AWS/GCP Only).

encryptionAtRestProvider String

Indicates whether Encryption at Rest is enabled or disabled.

id String

The provider-assigned unique ID for this managed resource.

labels List<Property Map>

Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. DEPRECATED Use tags instead.

Deprecated: This parameter is deprecated and will be removed by September 2024. Please transition to tags.

mongoDbMajorVersion String

Indicates the version of the cluster to deploy.

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

Describes 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

The name of the current plugin

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 Continuous Cloud Backup.

projectId String

providerAutoScalingComputeMaxInstanceSize String

Maximum instance size to which your cluster can automatically scale.

providerAutoScalingComputeMinInstanceSize String

Minimum instance size to which your cluster can automatically scale.

providerBackupEnabled Boolean

providerDiskIops Number

Indicates 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

Describes Azure disk type of the server’s root volume (Azure Only).

providerEncryptEbsVolume Boolean

providerEncryptEbsVolumeFlag Boolean

providerInstanceSizeName String

Atlas provides different instance sizes, each with a default storage capacity and RAM size.

providerName String

Indicates the cloud service provider on which the servers are provisioned.

providerRegionName String

providerVolumeType String

Indicates the type of the volume. The possible values are: STANDARD and PROVISIONED.

NOTE: STANDARD is not available for NVME clusters.

replicationFactor Number

(Deprecated) 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<Property Map>

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

snapshotBackupPolicies List<Property Map>

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

Indicates the current state of the cluster. The possible states are:

IDLE
CREATING
UPDATING
DELETING
DELETED
REPAIRING

tags List<Property Map>

Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.

terminationProtectionEnabled Boolean

Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

versionReleaseSystem String

Release cadence that Atlas uses for this cluster.

Supporting Types

GetClusterAdvancedConfiguration

DefaultReadConcern string: Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available.
DefaultWriteConcern string: Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.
FailIndexKeyTooLong bool: When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.
JavascriptEnabled bool: When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.
MinimumEnabledTlsProtocol string: Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:
NoTableScan bool: When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.
OplogMinRetentionHours int: Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
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.
TransactionLifetimeLimitSeconds int: Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.

DefaultReadConcern string: Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available.
DefaultWriteConcern string: Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.
FailIndexKeyTooLong bool: When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.
JavascriptEnabled bool: When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.
MinimumEnabledTlsProtocol string: Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:
NoTableScan bool: When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.
OplogMinRetentionHours int: Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
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.
TransactionLifetimeLimitSeconds int: Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.

defaultReadConcern String: Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available.
defaultWriteConcern String: Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.
failIndexKeyTooLong Boolean: When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.
javascriptEnabled Boolean: When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.
minimumEnabledTlsProtocol String: Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:
noTableScan Boolean: When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.
oplogMinRetentionHours Integer: Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
oplogSizeMb Integer: The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.
sampleRefreshIntervalBiConnector Integer: Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
sampleSizeBiConnector Integer: Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
transactionLifetimeLimitSeconds Integer: Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.

defaultReadConcern string: Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available.
defaultWriteConcern string: Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.
failIndexKeyTooLong boolean: When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.
javascriptEnabled boolean: When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.
minimumEnabledTlsProtocol string: Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:
noTableScan boolean: When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.
oplogMinRetentionHours number: Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
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.
transactionLifetimeLimitSeconds number: Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.

default_read_concern str: Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available.
default_write_concern str: Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.
fail_index_key_too_long bool: When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.
javascript_enabled bool: When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.
minimum_enabled_tls_protocol str: Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:
no_table_scan bool: When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.
oplog_min_retention_hours int: Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
oplog_size_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.
transaction_lifetime_limit_seconds int: Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.

defaultReadConcern String: Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available.
defaultWriteConcern String: Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.
failIndexKeyTooLong Boolean: When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.
javascriptEnabled Boolean: When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.
minimumEnabledTlsProtocol String: Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:
noTableScan Boolean: When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.
oplogMinRetentionHours Number: Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
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.
transactionLifetimeLimitSeconds Number: Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.

GetClusterBiConnectorConfig

Enabled bool: Indicates whether or not BI Connector for Atlas is enabled on the cluster.
ReadPreference string: Indicates the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. For details on BI Connector for Atlas read preferences, refer to the BI Connector Read Preferences Table.

Enabled bool: Indicates whether or not BI Connector for Atlas is enabled on the cluster.
ReadPreference string: Indicates the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. For details on BI Connector for Atlas read preferences, refer to the BI Connector Read Preferences Table.

enabled Boolean: Indicates whether or not BI Connector for Atlas is enabled on the cluster.
readPreference String: Indicates the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. For details on BI Connector for Atlas read preferences, refer to the BI Connector Read Preferences Table.

enabled boolean: Indicates whether or not BI Connector for Atlas is enabled on the cluster.
readPreference string: Indicates the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. For details on BI Connector for Atlas read preferences, refer to the BI Connector Read Preferences Table.

enabled bool: Indicates whether or not BI Connector for Atlas is enabled on the cluster.
read_preference str: Indicates the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. For details on BI Connector for Atlas read preferences, refer to the BI Connector Read Preferences Table.

enabled Boolean: Indicates whether or not BI Connector for Atlas is enabled on the cluster.
readPreference String: Indicates 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.

GetClusterConnectionString

AwsPrivateLink Dictionary<string, object>

AwsPrivateLinkSrv Dictionary<string, object>

Private string

Network-peering-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.

PrivateEndpoints List<GetClusterConnectionStringPrivateEndpoint>

PrivateSrv string

Network-peering-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.

connection_strings.private_endpoint.#.connection_string - Private-endpoint-aware mongodb://connection string for this private endpoint.
connection_strings.private_endpoint.#.srv_connection_string - Private-endpoint-aware mongodb+srv:// connection string for this private endpoint.
connection_strings.private_endpoint.#.srv_shard_optimized_connection_string - Private endpoint-aware connection string optimized for sharded clusters that uses the mongodb+srv:// protocol to connect to MongoDB Cloud through a private endpoint.
connection_strings.private_endpoint.#.type - Type of MongoDB process that you connect to with the connection strings. Atlas returns MONGOD for replica sets, or MONGOS for sharded clusters.
connection_strings.private_endpoint.#.endpoints - Private endpoint through which you connect to Atlas when you use connection_strings.private_endpoint[n].connection_string or connection_strings.private_endpoint[n].srv_connection_string
connection_strings.private_endpoint.#.endpoints.#.endpoint_id - Unique identifier of the private endpoint.
connection_strings.private_endpoint.#.endpoints.#.provider_name - Cloud provider to which you deployed the private endpoint. Atlas returns AWS or AZURE.
connection_strings.private_endpoint.#.endpoints.#.region - Region to which you deployed the private endpoint.

Standard string

Public mongodb:// connection string for this cluster.

StandardSrv string

Public mongodb+srv:// connection string for this cluster. The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS. Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don’t need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn’t, use connectionStrings.standard.

AwsPrivateLink map[string]interface{}

AwsPrivateLinkSrv map[string]interface{}

Private string

PrivateEndpoints []GetClusterConnectionStringPrivateEndpoint

PrivateSrv string

connection_strings.private_endpoint.#.connection_string - Private-endpoint-aware mongodb://connection string for this private endpoint.
connection_strings.private_endpoint.#.srv_connection_string - Private-endpoint-aware mongodb+srv:// connection string for this private endpoint.
connection_strings.private_endpoint.#.srv_shard_optimized_connection_string - Private endpoint-aware connection string optimized for sharded clusters that uses the mongodb+srv:// protocol to connect to MongoDB Cloud through a private endpoint.
connection_strings.private_endpoint.#.type - Type of MongoDB process that you connect to with the connection strings. Atlas returns MONGOD for replica sets, or MONGOS for sharded clusters.
connection_strings.private_endpoint.#.endpoints - Private endpoint through which you connect to Atlas when you use connection_strings.private_endpoint[n].connection_string or connection_strings.private_endpoint[n].srv_connection_string
connection_strings.private_endpoint.#.endpoints.#.endpoint_id - Unique identifier of the private endpoint.
connection_strings.private_endpoint.#.endpoints.#.provider_name - Cloud provider to which you deployed the private endpoint. Atlas returns AWS or AZURE.
connection_strings.private_endpoint.#.endpoints.#.region - Region to which you deployed the private endpoint.

Standard string

Public mongodb:// connection string for this cluster.

StandardSrv string

awsPrivateLink Map<String,Object>

awsPrivateLinkSrv Map<String,Object>

privateEndpoints List<GetClusterConnectionStringPrivateEndpoint>

privateSrv String

connection_strings.private_endpoint.#.connection_string - Private-endpoint-aware mongodb://connection string for this private endpoint.
connection_strings.private_endpoint.#.srv_connection_string - Private-endpoint-aware mongodb+srv:// connection string for this private endpoint.
connection_strings.private_endpoint.#.srv_shard_optimized_connection_string - Private endpoint-aware connection string optimized for sharded clusters that uses the mongodb+srv:// protocol to connect to MongoDB Cloud through a private endpoint.
connection_strings.private_endpoint.#.type - Type of MongoDB process that you connect to with the connection strings. Atlas returns MONGOD for replica sets, or MONGOS for sharded clusters.
connection_strings.private_endpoint.#.endpoints - Private endpoint through which you connect to Atlas when you use connection_strings.private_endpoint[n].connection_string or connection_strings.private_endpoint[n].srv_connection_string
connection_strings.private_endpoint.#.endpoints.#.endpoint_id - Unique identifier of the private endpoint.
connection_strings.private_endpoint.#.endpoints.#.provider_name - Cloud provider to which you deployed the private endpoint. Atlas returns AWS or AZURE.
connection_strings.private_endpoint.#.endpoints.#.region - Region to which you deployed the private endpoint.

private_ String

standard String

Public mongodb:// connection string for this cluster.

standardSrv String

awsPrivateLink {[key: string]: any}

awsPrivateLinkSrv {[key: string]: any}

private string

privateEndpoints GetClusterConnectionStringPrivateEndpoint[]

privateSrv string

connection_strings.private_endpoint.#.connection_string - Private-endpoint-aware mongodb://connection string for this private endpoint.
connection_strings.private_endpoint.#.srv_connection_string - Private-endpoint-aware mongodb+srv:// connection string for this private endpoint.
connection_strings.private_endpoint.#.srv_shard_optimized_connection_string - Private endpoint-aware connection string optimized for sharded clusters that uses the mongodb+srv:// protocol to connect to MongoDB Cloud through a private endpoint.
connection_strings.private_endpoint.#.type - Type of MongoDB process that you connect to with the connection strings. Atlas returns MONGOD for replica sets, or MONGOS for sharded clusters.
connection_strings.private_endpoint.#.endpoints - Private endpoint through which you connect to Atlas when you use connection_strings.private_endpoint[n].connection_string or connection_strings.private_endpoint[n].srv_connection_string
connection_strings.private_endpoint.#.endpoints.#.endpoint_id - Unique identifier of the private endpoint.
connection_strings.private_endpoint.#.endpoints.#.provider_name - Cloud provider to which you deployed the private endpoint. Atlas returns AWS or AZURE.
connection_strings.private_endpoint.#.endpoints.#.region - Region to which you deployed the private endpoint.

standard string

Public mongodb:// connection string for this cluster.

standardSrv string

aws_private_link Mapping[str, Any]

aws_private_link_srv Mapping[str, Any]

private str

private_endpoints Sequence[GetClusterConnectionStringPrivateEndpoint]

private_srv str

connection_strings.private_endpoint.#.connection_string - Private-endpoint-aware mongodb://connection string for this private endpoint.
connection_strings.private_endpoint.#.srv_connection_string - Private-endpoint-aware mongodb+srv:// connection string for this private endpoint.
connection_strings.private_endpoint.#.srv_shard_optimized_connection_string - Private endpoint-aware connection string optimized for sharded clusters that uses the mongodb+srv:// protocol to connect to MongoDB Cloud through a private endpoint.
connection_strings.private_endpoint.#.type - Type of MongoDB process that you connect to with the connection strings. Atlas returns MONGOD for replica sets, or MONGOS for sharded clusters.
connection_strings.private_endpoint.#.endpoints - Private endpoint through which you connect to Atlas when you use connection_strings.private_endpoint[n].connection_string or connection_strings.private_endpoint[n].srv_connection_string
connection_strings.private_endpoint.#.endpoints.#.endpoint_id - Unique identifier of the private endpoint.
connection_strings.private_endpoint.#.endpoints.#.provider_name - Cloud provider to which you deployed the private endpoint. Atlas returns AWS or AZURE.
connection_strings.private_endpoint.#.endpoints.#.region - Region to which you deployed the private endpoint.

standard str

Public mongodb:// connection string for this cluster.

standard_srv str

awsPrivateLink Map<Any>

awsPrivateLinkSrv Map<Any>

private String

privateEndpoints List<Property Map>

privateSrv String

connection_strings.private_endpoint.#.connection_string - Private-endpoint-aware mongodb://connection string for this private endpoint.
connection_strings.private_endpoint.#.srv_connection_string - Private-endpoint-aware mongodb+srv:// connection string for this private endpoint.
connection_strings.private_endpoint.#.srv_shard_optimized_connection_string - Private endpoint-aware connection string optimized for sharded clusters that uses the mongodb+srv:// protocol to connect to MongoDB Cloud through a private endpoint.
connection_strings.private_endpoint.#.type - Type of MongoDB process that you connect to with the connection strings. Atlas returns MONGOD for replica sets, or MONGOS for sharded clusters.
connection_strings.private_endpoint.#.endpoints - Private endpoint through which you connect to Atlas when you use connection_strings.private_endpoint[n].connection_string or connection_strings.private_endpoint[n].srv_connection_string
connection_strings.private_endpoint.#.endpoints.#.endpoint_id - Unique identifier of the private endpoint.
connection_strings.private_endpoint.#.endpoints.#.provider_name - Cloud provider to which you deployed the private endpoint. Atlas returns AWS or AZURE.
connection_strings.private_endpoint.#.endpoints.#.region - Region to which you deployed the private endpoint.

standard String

Public mongodb:// connection string for this cluster.

standardSrv String

GetClusterConnectionStringPrivateEndpoint

ConnectionString string
Endpoints List<GetClusterConnectionStringPrivateEndpointEndpoint>
SrvConnectionString string
SrvShardOptimizedConnectionString string
Type string

ConnectionString string
Endpoints []GetClusterConnectionStringPrivateEndpointEndpoint
SrvConnectionString string
SrvShardOptimizedConnectionString string
Type string

connectionString String
endpoints List<GetClusterConnectionStringPrivateEndpointEndpoint>
srvConnectionString String
srvShardOptimizedConnectionString String
type String

connectionString string
endpoints GetClusterConnectionStringPrivateEndpointEndpoint[]
srvConnectionString string
srvShardOptimizedConnectionString string
type string

connection_string str
endpoints Sequence[GetClusterConnectionStringPrivateEndpointEndpoint]
srv_connection_string str
srv_shard_optimized_connection_string str
type str

connectionString String
endpoints List<Property Map>
srvConnectionString String
srvShardOptimizedConnectionString String
type String

GetClusterConnectionStringPrivateEndpointEndpoint

EndpointId string
ProviderName string: Indicates the cloud service provider on which the servers are provisioned.
Region string

EndpointId string
ProviderName string: Indicates the cloud service provider on which the servers are provisioned.
Region string

endpointId String
providerName String: Indicates the cloud service provider on which the servers are provisioned.
region String

endpointId string
providerName string: Indicates the cloud service provider on which the servers are provisioned.
region string

endpoint_id str
provider_name str: Indicates the cloud service provider on which the servers are provisioned.
region str

endpointId String
providerName String: Indicates the cloud service provider on which the servers are provisioned.
region String

GetClusterLabel

Key string: The key that you want to write.
Value string: The value that you want to write.

Key string: The key that you want to write.
Value string: The value that you want to write.

key String: The key that you want to write.
value String: The value that you want to write.

key string: The key that you want to write.
value string: The value that you want to write.

key str: The key that you want to write.
value str: The value that you want to write.

key String: The key that you want to write.
value String: The value that you want to write.

GetClusterReplicationSpec

Id string: Unique identifer of the replication document for a zone in a Global Cluster.
NumShards int: Number of shards to deploy in the specified zone.
RegionsConfigs List<GetClusterReplicationSpecRegionsConfig>: Describes the 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: Indicates the n ame for the zone in a Global Cluster.

Id string: Unique identifer of the replication document for a zone in a Global Cluster.
NumShards int: Number of shards to deploy in the specified zone.
RegionsConfigs []GetClusterReplicationSpecRegionsConfig: Describes the 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: Indicates the n ame for the zone in a Global Cluster.

id String: Unique identifer of the replication document for a zone in a Global Cluster.
numShards Integer: Number of shards to deploy in the specified zone.
regionsConfigs List<GetClusterReplicationSpecRegionsConfig>: Describes the 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: Indicates the n ame for the zone in a Global Cluster.

id string: Unique identifer of the replication document for a zone in a Global Cluster.
numShards number: Number of shards to deploy in the specified zone.
regionsConfigs GetClusterReplicationSpecRegionsConfig[]: Describes the 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: Indicates the n ame for the zone in a Global Cluster.

id str: Unique identifer of the replication document for a zone in a Global Cluster.
num_shards int: Number of shards to deploy in the specified zone.
regions_configs Sequence[GetClusterReplicationSpecRegionsConfig]: Describes the 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: Indicates the n ame for the zone in a Global Cluster.

id String: Unique identifer of the replication document for a zone in a Global Cluster.
numShards Number: Number of shards to deploy in the specified zone.
regionsConfigs List<Property Map>: Describes the 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: Indicates the n ame for the zone in a Global Cluster.

GetClusterReplicationSpecRegionsConfig

AnalyticsNodes int: Indicates 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.
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: Indicates 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.
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 Integer: Indicates 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 Integer: Number of electable nodes for Atlas to deploy to the region.
priority Integer: Election priority of the region. For regions with only read-only nodes, set this value to 0.
readOnlyNodes Integer: 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: Indicates 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.
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.

analytics_nodes int: Indicates 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.
electable_nodes int: Number of electable nodes for Atlas to deploy to the region.
priority int: Election priority of the region. For regions with only read-only nodes, set this value to 0.
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: Name for the region specified.

analyticsNodes Number: Indicates 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.
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.

GetClusterSnapshotBackupPolicy

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

ClusterId string
ClusterName string
NextSnapshot string
Policies []GetClusterSnapshotBackupPolicyPolicy
ReferenceHourOfDay int
ReferenceMinuteOfHour int
RestoreWindowDays int
UpdateSnapshots bool

clusterId String
clusterName String
nextSnapshot String
policies List<GetClusterSnapshotBackupPolicyPolicy>
referenceHourOfDay Integer
referenceMinuteOfHour Integer
restoreWindowDays Integer
updateSnapshots Boolean

clusterId string
clusterName string
nextSnapshot string
policies GetClusterSnapshotBackupPolicyPolicy[]
referenceHourOfDay number
referenceMinuteOfHour number
restoreWindowDays number
updateSnapshots boolean

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

clusterId String
clusterName String
nextSnapshot String
policies List<Property Map>
referenceHourOfDay Number
referenceMinuteOfHour Number
restoreWindowDays Number
updateSnapshots Boolean

GetClusterSnapshotBackupPolicyPolicy

Id string: Unique identifer of the replication document for a zone in a Global Cluster.
PolicyItems List<GetClusterSnapshotBackupPolicyPolicyPolicyItem>

Id string: Unique identifer of the replication document for a zone in a Global Cluster.
PolicyItems []GetClusterSnapshotBackupPolicyPolicyPolicyItem

id String: Unique identifer of the replication document for a zone in a Global Cluster.
policyItems List<GetClusterSnapshotBackupPolicyPolicyPolicyItem>

id string: Unique identifer of the replication document for a zone in a Global Cluster.
policyItems GetClusterSnapshotBackupPolicyPolicyPolicyItem[]

id str: Unique identifer of the replication document for a zone in a Global Cluster.
policy_items Sequence[GetClusterSnapshotBackupPolicyPolicyPolicyItem]

id String: Unique identifer of the replication document for a zone in a Global Cluster.
policyItems List<Property Map>

GetClusterSnapshotBackupPolicyPolicyPolicyItem

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 Integer
frequencyType String
id String: Unique identifer of the replication document for a zone in a Global Cluster.
retentionUnit String
retentionValue Integer

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

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

GetClusterTag

Key string: The key that you want to write.
Value string: The value that you want to write.

Key string: The key that you want to write.
Value string: The value that you want to write.

key String: The key that you want to write.
value String: The value that you want to write.

key string: The key that you want to write.
value string: The value that you want to write.

key str: The key that you want to write.
value str: The value that you want to write.

key String: The key that you want to write.
value String: The value that you want to write.

Package Details

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

MongoDB Atlas v3.16.2 published on Friday, Jun 21, 2024 by Pulumi

pulumi/pulumi-mongodbatlas

mongodbatlas.getCluster

On this page

On this page

Example Usage

Using getCluster

getCluster Result

Supporting Types

GetClusterAdvancedConfiguration

GetClusterBiConnectorConfig

GetClusterConnectionString

GetClusterConnectionStringPrivateEndpoint

GetClusterConnectionStringPrivateEndpointEndpoint

GetClusterLabel

GetClusterReplicationSpec

GetClusterReplicationSpecRegionsConfig

GetClusterSnapshotBackupPolicy

GetClusterSnapshotBackupPolicyPolicy

GetClusterSnapshotBackupPolicyPolicyPolicyItem

GetClusterTag

Package Details

On this page

On this page