Welcome to Pulumi Registry, your window into the cloud. Read the announcement.

MongoDB Atlas

v3.0.1 published on Monday, Nov 1, 2021 by Pulumi

getClusters

mongodbatlas.Cluster describes all Clusters by the provided project_id. The data source requires your Project ID.

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

IMPORTANT:
• 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

using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

class MyStack : Stack
{
    public MyStack()
    {
        var testCluster = new Mongodbatlas.Cluster("testCluster", new Mongodbatlas.ClusterArgs
        {
            ProjectId = "<YOUR-PROJECT-ID>",
            DiskSizeGb = 100,
            ClusterType = "REPLICASET",
            ReplicationSpecs = 
            {
                new Mongodbatlas.Inputs.ClusterReplicationSpecArgs
                {
                    NumShards = 1,
                    RegionsConfigs = 
                    {
                        new Mongodbatlas.Inputs.ClusterReplicationSpecRegionsConfigArgs
                        {
                            RegionName = "US_EAST_1",
                            ElectableNodes = 3,
                            Priority = 7,
                            ReadOnlyNodes = 0,
                        },
                    },
                },
            },
            CloudBackup = true,
            AutoScalingDiskGbEnabled = true,
            ProviderName = "AWS",
            ProviderInstanceSizeName = "M40",
        });
        var testClusters = testCluster.ProjectId.Apply(projectId => Mongodbatlas.GetClusters.InvokeAsync(new Mongodbatlas.GetClustersArgs
        {
            ProjectId = projectId,
        }));
    }

}
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, "testCluster", &mongodbatlas.ClusterArgs{
			ProjectId:   pulumi.String("<YOUR-PROJECT-ID>"),
			DiskSizeGb:  pulumi.Float64(100),
			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
		}
		return nil
	})
}
import pulumi
import pulumi_mongodbatlas as mongodbatlas

test_cluster = mongodbatlas.Cluster("testCluster",
    project_id="<YOUR-PROJECT-ID>",
    disk_size_gb=100,
    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_clusters = test_cluster.project_id.apply(lambda project_id: mongodbatlas.get_clusters(project_id=project_id))
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const testCluster = new mongodbatlas.Cluster("testCluster", {
    projectId: "<YOUR-PROJECT-ID>",
    diskSizeGb: 100,
    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 testClusters = testCluster.projectId.apply(projectId => mongodbatlas.getClusters({
    projectId: projectId,
}));

Using getClusters

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 getClusters(args: GetClustersArgs, opts?: InvokeOptions): Promise<GetClustersResult>
function getClustersOutput(args: GetClustersOutputArgs, opts?: InvokeOptions): Output<GetClustersResult>
def get_clusters(project_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetClustersResult
def get_clusters_output(project_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetClustersResult]
func GetClusters(ctx *Context, args *GetClustersArgs, opts ...InvokeOption) (*GetClustersResult, error)
func GetClustersOutput(ctx *Context, args *GetClustersOutputArgs, opts ...InvokeOption) GetClustersResultOutput

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

public static class GetClusters 
{
    public static Task<GetClustersResult> InvokeAsync(GetClustersArgs args, InvokeOptions? opts = null)
    public static Output<GetClustersResult> Invoke(GetClustersInvokeArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

ProjectId string
The unique ID for the project to get the clusters.
ProjectId string
The unique ID for the project to get the clusters.
projectId string
The unique ID for the project to get the clusters.
project_id str
The unique ID for the project to get the clusters.

getClusters Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
ProjectId string
Results List<GetClustersResult>
A list where each represents a Cluster. See Cluster below for more details.
Id string
The provider-assigned unique ID for this managed resource.
ProjectId string
Results []GetClustersResult
A list where each represents a Cluster. See Cluster below for more details.
id string
The provider-assigned unique ID for this managed resource.
projectId string
results GetClustersResult[]
A list where each represents a Cluster. See Cluster below for more details.
id str
The provider-assigned unique ID for this managed resource.
project_id str
results Sequence[GetClustersResult]
A list where each represents a Cluster. See Cluster below for more details.

Supporting Types

GetClustersResult

AutoScalingComputeEnabled bool
(Optional) Specifies whether cluster tier auto-scaling is enabled. The default is false.
AutoScalingComputeScaleDownEnabled bool
(Optional) Set to true to enable the cluster tier to scale down.
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.
BiConnector Dictionary<string, string>
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. DEPRECATED Use bi_connector_config instead.

Deprecated: use bi_connector_config instead

BiConnectorConfigs List<GetClustersResultBiConnectorConfig>
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<GetClustersResultConnectionString>

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. DEPRECATED Use connection_strings.private_endpoint[n].connection_string instead.
  • 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. DEPRECATED connection_strings.private_endpoint[n].srv_connection_string instead.
  • 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.
  • 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.#.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_endoint.#.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.
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.
Labels List<GetClustersResultLabel>
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.
ProviderAutoScalingComputeMaxInstanceSize string
(Optional) Maximum instance size to which your cluster can automatically scale.
ProviderAutoScalingComputeMinInstanceSize string
(Optional) Minimum instance size to which your cluster can automatically scale.
ProviderBackupEnabled bool
Flag indicating if the cluster uses Cloud Backup Snapshots for backups. DEPRECATED Use cloud_backup instead.
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.
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.
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<GetClustersResultReplicationSpec>
Configuration for cluster regions. See Replication Spec below for more details.
SnapshotBackupPolicies List<GetClustersResultSnapshotBackupPolicy>
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
AutoScalingComputeEnabled bool
(Optional) Specifies whether cluster tier auto-scaling is enabled. The default is false.
AutoScalingComputeScaleDownEnabled bool
(Optional) Set to true to enable the cluster tier to scale down.
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.
BiConnector map[string]string
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. DEPRECATED Use bi_connector_config instead.

Deprecated: use bi_connector_config instead

BiConnectorConfigs []GetClustersResultBiConnectorConfig
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 []GetClustersResultConnectionString

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. DEPRECATED Use connection_strings.private_endpoint[n].connection_string instead.
  • 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. DEPRECATED connection_strings.private_endpoint[n].srv_connection_string instead.
  • 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.
  • 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.#.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_endoint.#.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.
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.
Labels []GetClustersResultLabel
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.
ProviderAutoScalingComputeMaxInstanceSize string
(Optional) Maximum instance size to which your cluster can automatically scale.
ProviderAutoScalingComputeMinInstanceSize string
(Optional) Minimum instance size to which your cluster can automatically scale.
ProviderBackupEnabled bool
Flag indicating if the cluster uses Cloud Backup Snapshots for backups. DEPRECATED Use cloud_backup instead.
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.
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.
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 []GetClustersResultReplicationSpec
Configuration for cluster regions. See Replication Spec below for more details.
SnapshotBackupPolicies []GetClustersResultSnapshotBackupPolicy
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
autoScalingComputeEnabled boolean
(Optional) Specifies whether cluster tier auto-scaling is enabled. The default is false.
autoScalingComputeScaleDownEnabled boolean
(Optional) Set to true to enable the cluster tier to scale down.
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.
biConnector {[key: string]: string}
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. DEPRECATED Use bi_connector_config instead.

Deprecated: use bi_connector_config instead

biConnectorConfigs GetClustersResultBiConnectorConfig[]
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 GetClustersResultConnectionString[]

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. DEPRECATED Use connection_strings.private_endpoint[n].connection_string instead.
  • 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. DEPRECATED connection_strings.private_endpoint[n].srv_connection_string instead.
  • 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.
  • 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.#.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_endoint.#.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.
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.
labels GetClustersResultLabel[]
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.
providerAutoScalingComputeMaxInstanceSize string
(Optional) Maximum instance size to which your cluster can automatically scale.
providerAutoScalingComputeMinInstanceSize string
(Optional) Minimum instance size to which your cluster can automatically scale.
providerBackupEnabled boolean
Flag indicating if the cluster uses Cloud Backup Snapshots for backups. DEPRECATED Use cloud_backup instead.
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
(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.
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.
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 GetClustersResultReplicationSpec[]
Configuration for cluster regions. See Replication Spec below for more details.
snapshotBackupPolicies GetClustersResultSnapshotBackupPolicy[]
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
auto_scaling_compute_enabled bool
(Optional) Specifies whether cluster tier auto-scaling is enabled. The default is false.
auto_scaling_compute_scale_down_enabled bool
(Optional) Set to true to enable the cluster tier to scale down.
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 Mapping[str, str]
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. DEPRECATED Use bi_connector_config instead.

Deprecated: use bi_connector_config instead

bi_connector_configs Sequence[GetClustersResultBiConnectorConfig]
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[GetClustersResultConnectionString]

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. DEPRECATED Use connection_strings.private_endpoint[n].connection_string instead.
  • 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. DEPRECATED connection_strings.private_endpoint[n].srv_connection_string instead.
  • 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.
  • 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.#.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_endoint.#.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.
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.
labels Sequence[GetClustersResultLabel]
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.
provider_auto_scaling_compute_max_instance_size str
(Optional) Maximum instance size to which your cluster can automatically scale.
provider_auto_scaling_compute_min_instance_size str
(Optional) Minimum instance size to which your cluster can automatically scale.
provider_backup_enabled bool
Flag indicating if the cluster uses Cloud Backup Snapshots for backups. DEPRECATED Use cloud_backup instead.
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
(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.
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
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.
provider_volume_type str
Indicates the type of the volume. The possible values are: STANDARD and PROVISIONED.
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[GetClustersResultReplicationSpec]
Configuration for cluster regions. See Replication Spec below for more details.
snapshot_backup_policies Sequence[GetClustersResultSnapshotBackupPolicy]
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

GetClustersResultBiConnectorConfig

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

GetClustersResultConnectionString

GetClustersResultConnectionStringPrivateEndpoint

GetClustersResultConnectionStringPrivateEndpointEndpoint

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

GetClustersResultLabel

Key string
The key that was set.
Value string
The value that represents the key.
Key string
The key that was set.
Value string
The value that represents the key.
key string
The key that was set.
value string
The value that represents the key.
key str
The key that was set.
value str
The value that represents the key.

GetClustersResultReplicationSpec

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<GetClustersResultReplicationSpecRegionsConfig>
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 []GetClustersResultReplicationSpecRegionsConfig
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 GetClustersResultReplicationSpecRegionsConfig[]
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[GetClustersResultReplicationSpecRegionsConfig]
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.

GetClustersResultReplicationSpecRegionsConfig

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

GetClustersResultSnapshotBackupPolicy

GetClustersResultSnapshotBackupPolicyPolicy

Id string
Unique identifer of the replication document for a zone in a Global Cluster.
PolicyItems List<GetClustersResultSnapshotBackupPolicyPolicyPolicyItem>
Id string
Unique identifer of the replication document for a zone in a Global Cluster.
PolicyItems []GetClustersResultSnapshotBackupPolicyPolicyPolicyItem
id string
Unique identifer of the replication document for a zone in a Global Cluster.
policyItems GetClustersResultSnapshotBackupPolicyPolicyPolicyItem[]
id str
Unique identifer of the replication document for a zone in a Global Cluster.
policy_items Sequence[GetClustersResultSnapshotBackupPolicyPolicyPolicyItem]

GetClustersResultSnapshotBackupPolicyPolicyPolicyItem

FrequencyInterval int
FrequencyType string
Id string
Unique identifer of the replication document for a zone in a Global Cluster.
RetentionUnit string
RetentionValue int
FrequencyInterval int
FrequencyType string
Id string
Unique identifer of the replication document for a zone in a Global Cluster.
RetentionUnit string
RetentionValue int
frequencyInterval number
frequencyType string
id string
Unique identifer of the replication document for a zone in a Global Cluster.
retentionUnit string
retentionValue number
frequency_interval int
frequency_type str
id str
Unique identifer of the replication document for a zone in a Global Cluster.
retention_unit str
retention_value int

Package Details

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