mongodbatlas.getCluster
Explore with Pulumi AI
# Data Source: mongodbatlas.Cluster
mongodbatlas.Cluster
describes a Cluster. The data source requires your Project ID.
IMPORTANT:
• Multi Region Cluster: Themongodbatlas.Cluster
data source doesn’t return thecontainer_id
for each region utilized by the cluster. For retrieving thecontainer_id
, we recommend themongodbatlas.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.
NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.
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=[{
"num_shards": 1,
"regions_configs": [{
"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 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.
getCluster Result
The following output properties are available:
- Advanced
Configurations List<GetCluster Advanced Configuration> - Get the advanced configuration options. See Advanced Configuration below for more details.
- Auto
Scaling boolCompute Enabled - Specifies whether cluster tier auto-scaling is enabled. The default is false.
- Auto
Scaling boolCompute Scale Down Enabled - Specifies whether cluster tier auto-down-scaling is enabled.
- Auto
Scaling boolDisk Gb Enabled - Indicates whether disk auto-scaling is enabled.
- Backing
Provider stringName - 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 List<GetConfigs Cluster Bi Connector Config> - 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 string - 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 List<GetCluster Connection String> - Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options.
- Container
Id string - The Network Peering Container ID.
- Disk
Size doubleGb - Indicates the size in gigabytes of the server’s root volume (AWS/GCP Only).
- Encryption
At stringRest Provider - Indicates whether Encryption at Rest is enabled or disabled.
- Id string
- The provider-assigned unique ID for this managed resource.
- Labels
List<Get
Cluster Label> - Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. DEPRECATED Use
tags
instead. - Mongo
Db stringMajor Version - Indicates the version of the cluster to deploy.
- Mongo
Db stringVersion - Version of MongoDB the cluster runs, in
major-version
.minor-version
format. - Mongo
Uri string - Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.
- Mongo
Uri stringUpdated - 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 stringWith Options - 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
- 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 string - Provider
Auto stringScaling Compute Max Instance Size - Maximum instance size to which your cluster can automatically scale.
- Provider
Auto stringScaling Compute Min Instance Size - Minimum instance size to which your cluster can automatically scale.
- Provider
Backup boolEnabled - Provider
Disk intIops - 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 stringType Name - Describes Azure disk type of the server’s root volume (Azure Only).
- Provider
Encrypt boolEbs Volume - (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
Encrypt boolEbs Volume Flag - Provider
Instance stringSize Name - Atlas provides different instance sizes, each with a default storage capacity and RAM size.
- Provider
Name string - Indicates the cloud service provider on which the servers are provisioned.
- Provider
Region stringName - 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 stringType Indicates the type of the volume. The possible values are:
STANDARD
andPROVISIONED
.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 List<GetCluster Replication Spec> - Configuration for cluster regions. See Replication Spec below for more details.
- Snapshot
Backup List<GetPolicies Cluster Snapshot Backup Policy> - current snapshot schedule and retention settings for the cluster.
- Srv
Address 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.
- State
Name string - Indicates the current state of the cluster. The possible states are:
- IDLE
- CREATING
- UPDATING
- DELETING
- DELETED
- REPAIRING
- List<Get
Cluster Tag> - Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
- Termination
Protection boolEnabled - Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
- Version
Release stringSystem - Release cadence that Atlas uses for this cluster.
- Advanced
Configurations []GetCluster Advanced Configuration - Get the advanced configuration options. See Advanced Configuration below for more details.
- Auto
Scaling boolCompute Enabled - Specifies whether cluster tier auto-scaling is enabled. The default is false.
- Auto
Scaling boolCompute Scale Down Enabled - Specifies whether cluster tier auto-down-scaling is enabled.
- Auto
Scaling boolDisk Gb Enabled - Indicates whether disk auto-scaling is enabled.
- Backing
Provider stringName - 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 []GetConfigs Cluster Bi Connector Config - 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 string - 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 []GetCluster Connection String - Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options.
- Container
Id string - The Network Peering Container ID.
- Disk
Size float64Gb - Indicates the size in gigabytes of the server’s root volume (AWS/GCP Only).
- Encryption
At stringRest Provider - Indicates whether Encryption at Rest is enabled or disabled.
- Id string
- The provider-assigned unique ID for this managed resource.
- Labels
[]Get
Cluster Label - Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. DEPRECATED Use
tags
instead. - Mongo
Db stringMajor Version - Indicates the version of the cluster to deploy.
- Mongo
Db stringVersion - Version of MongoDB the cluster runs, in
major-version
.minor-version
format. - Mongo
Uri string - Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.
- Mongo
Uri stringUpdated - 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 stringWith Options - 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
- 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 string - Provider
Auto stringScaling Compute Max Instance Size - Maximum instance size to which your cluster can automatically scale.
- Provider
Auto stringScaling Compute Min Instance Size - Minimum instance size to which your cluster can automatically scale.
- Provider
Backup boolEnabled - Provider
Disk intIops - 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 stringType Name - Describes Azure disk type of the server’s root volume (Azure Only).
- Provider
Encrypt boolEbs Volume - (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
Encrypt boolEbs Volume Flag - Provider
Instance stringSize Name - Atlas provides different instance sizes, each with a default storage capacity and RAM size.
- Provider
Name string - Indicates the cloud service provider on which the servers are provisioned.
- Provider
Region stringName - 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 stringType Indicates the type of the volume. The possible values are:
STANDARD
andPROVISIONED
.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 []GetCluster Replication Spec - Configuration for cluster regions. See Replication Spec below for more details.
- Snapshot
Backup []GetPolicies Cluster Snapshot Backup Policy - current snapshot schedule and retention settings for the cluster.
- Srv
Address 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.
- State
Name string - Indicates the current state of the cluster. The possible states are:
- IDLE
- CREATING
- UPDATING
- DELETING
- DELETED
- REPAIRING
- []Get
Cluster Tag - Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
- Termination
Protection boolEnabled - Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
- Version
Release stringSystem - Release cadence that Atlas uses for this cluster.
- advanced
Configurations List<GetCluster Advanced Configuration> - Get the advanced configuration options. See Advanced Configuration below for more details.
- auto
Scaling BooleanCompute Enabled - Specifies whether cluster tier auto-scaling is enabled. The default is false.
- auto
Scaling BooleanCompute Scale Down Enabled - Specifies whether cluster tier auto-down-scaling is enabled.
- auto
Scaling BooleanDisk Gb Enabled - Indicates whether disk auto-scaling is enabled.
- backing
Provider StringName - Indicates Cloud service provider on which the server for a multi-tenant cluster is provisioned.
- backup
Enabled Boolean - Legacy Option, Indicates whether Atlas continuous backups are enabled for the cluster.
- bi
Connector List<GetConfigs Cluster Bi Connector Config> - 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 String - 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 List<GetCluster Connection String> - Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options.
- container
Id String - The Network Peering Container ID.
- disk
Size DoubleGb - Indicates the size in gigabytes of the server’s root volume (AWS/GCP Only).
- encryption
At StringRest Provider - Indicates whether Encryption at Rest is enabled or disabled.
- id String
- The provider-assigned unique ID for this managed resource.
- labels
List<Get
Cluster Label> - Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. DEPRECATED Use
tags
instead. - mongo
Db StringMajor Version - Indicates the version of the cluster to deploy.
- mongo
Db StringVersion - Version of MongoDB the cluster runs, in
major-version
.minor-version
format. - mongo
Uri String - Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.
- mongo
Uri StringUpdated - 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 StringWith Options - 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
- num
Shards Integer - Number of shards to deploy in the specified zone.
- paused Boolean
- Flag that indicates whether the cluster is paused or not.
- pit
Enabled Boolean - Flag that indicates if the cluster uses Continuous Cloud Backup.
- project
Id String - provider
Auto StringScaling Compute Max Instance Size - Maximum instance size to which your cluster can automatically scale.
- provider
Auto StringScaling Compute Min Instance Size - Minimum instance size to which your cluster can automatically scale.
- provider
Backup BooleanEnabled - provider
Disk IntegerIops - 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 StringType Name - Describes Azure disk type of the server’s root volume (Azure Only).
- provider
Encrypt BooleanEbs Volume - (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
Encrypt BooleanEbs Volume Flag - provider
Instance StringSize Name - Atlas provides different instance sizes, each with a default storage capacity and RAM size.
- provider
Name String - Indicates the cloud service provider on which the servers are provisioned.
- provider
Region StringName - 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 StringType Indicates the type of the volume. The possible values are:
STANDARD
andPROVISIONED
.NOTE:
STANDARD
is not available for NVME clusters.- replication
Factor 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.
- replication
Specs List<GetCluster Replication Spec> - Configuration for cluster regions. See Replication Spec below for more details.
- snapshot
Backup List<GetPolicies Cluster Snapshot Backup Policy> - current snapshot schedule and retention settings for the cluster.
- srv
Address 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.
- state
Name String - Indicates the current state of the cluster. The possible states are:
- IDLE
- CREATING
- UPDATING
- DELETING
- DELETED
- REPAIRING
- List<Get
Cluster Tag> - Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
- termination
Protection BooleanEnabled - Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
- version
Release StringSystem - Release cadence that Atlas uses for this cluster.
- advanced
Configurations GetCluster Advanced Configuration[] - Get the advanced configuration options. See Advanced Configuration below for more details.
- auto
Scaling booleanCompute Enabled - Specifies whether cluster tier auto-scaling is enabled. The default is false.
- auto
Scaling booleanCompute Scale Down Enabled - Specifies whether cluster tier auto-down-scaling is enabled.
- auto
Scaling booleanDisk Gb Enabled - Indicates whether disk auto-scaling is enabled.
- backing
Provider stringName - Indicates Cloud service provider on which the server for a multi-tenant cluster is provisioned.
- backup
Enabled boolean - Legacy Option, Indicates whether Atlas continuous backups are enabled for the cluster.
- bi
Connector GetConfigs Cluster Bi Connector Config[] - 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 string - 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 GetCluster Connection String[] - Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options.
- container
Id string - The Network Peering Container ID.
- disk
Size numberGb - Indicates the size in gigabytes of the server’s root volume (AWS/GCP Only).
- encryption
At stringRest Provider - Indicates whether Encryption at Rest is enabled or disabled.
- id string
- The provider-assigned unique ID for this managed resource.
- labels
Get
Cluster Label[] - Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. DEPRECATED Use
tags
instead. - mongo
Db stringMajor Version - Indicates the version of the cluster to deploy.
- mongo
Db stringVersion - Version of MongoDB the cluster runs, in
major-version
.minor-version
format. - mongo
Uri string - Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.
- mongo
Uri stringUpdated - 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 stringWith Options - 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
- num
Shards number - Number of shards to deploy in the specified zone.
- paused boolean
- Flag that indicates whether the cluster is paused or not.
- pit
Enabled boolean - Flag that indicates if the cluster uses Continuous Cloud Backup.
- project
Id string - provider
Auto stringScaling Compute Max Instance Size - Maximum instance size to which your cluster can automatically scale.
- provider
Auto stringScaling Compute Min Instance Size - Minimum instance size to which your cluster can automatically scale.
- provider
Backup booleanEnabled - provider
Disk numberIops - 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 stringType Name - Describes Azure disk type of the server’s root volume (Azure Only).
- provider
Encrypt booleanEbs Volume - (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
Encrypt booleanEbs Volume Flag - provider
Instance stringSize Name - Atlas provides different instance sizes, each with a default storage capacity and RAM size.
- provider
Name string - Indicates the cloud service provider on which the servers are provisioned.
- provider
Region stringName - 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 stringType Indicates the type of the volume. The possible values are:
STANDARD
andPROVISIONED
.NOTE:
STANDARD
is not available for NVME clusters.- replication
Factor 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.
- replication
Specs GetCluster Replication Spec[] - Configuration for cluster regions. See Replication Spec below for more details.
- snapshot
Backup GetPolicies Cluster Snapshot Backup Policy[] - current snapshot schedule and retention settings for the cluster.
- srv
Address 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.
- state
Name string - Indicates the current state of the cluster. The possible states are:
- IDLE
- CREATING
- UPDATING
- DELETING
- DELETED
- REPAIRING
- Get
Cluster Tag[] - Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
- termination
Protection booleanEnabled - Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
- version
Release stringSystem - Release cadence that Atlas uses for this cluster.
- advanced_
configurations Sequence[GetCluster Advanced Configuration] - Get the advanced configuration options. See Advanced Configuration below for more details.
- auto_
scaling_ boolcompute_ enabled - Specifies whether cluster tier auto-scaling is enabled. The default is false.
- auto_
scaling_ boolcompute_ scale_ down_ enabled - Specifies whether cluster tier auto-down-scaling is enabled.
- auto_
scaling_ booldisk_ gb_ enabled - Indicates whether disk auto-scaling is enabled.
- backing_
provider_ strname - 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_ Sequence[Getconfigs Cluster Bi Connector Config] - 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[GetCluster Connection String] - Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options.
- container_
id str - The Network Peering Container ID.
- disk_
size_ floatgb - Indicates the size in gigabytes of the server’s root volume (AWS/GCP Only).
- encryption_
at_ strrest_ provider - Indicates whether Encryption at Rest is enabled or disabled.
- id str
- The provider-assigned unique ID for this managed resource.
- labels
Sequence[Get
Cluster Label] - Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. DEPRECATED Use
tags
instead. - mongo_
db_ strmajor_ version - Indicates the version of the cluster to deploy.
- mongo_
db_ strversion - 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_ strupdated - 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_ strwith_ options - 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_ strscaling_ compute_ max_ instance_ size - Maximum instance size to which your cluster can automatically scale.
- provider_
auto_ strscaling_ compute_ min_ instance_ size - Minimum instance size to which your cluster can automatically scale.
- provider_
backup_ boolenabled - provider_
disk_ intiops - 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_ strtype_ name - Describes Azure disk type of the server’s root volume (Azure Only).
- provider_
encrypt_ boolebs_ volume - (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_
encrypt_ boolebs_ volume_ flag - provider_
instance_ strsize_ name - 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_ strname - 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_ strtype Indicates the type of the volume. The possible values are:
STANDARD
andPROVISIONED
.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[GetCluster Replication Spec] - Configuration for cluster regions. See Replication Spec below for more details.
- snapshot_
backup_ Sequence[Getpolicies Cluster Snapshot Backup Policy] - 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
- Sequence[Get
Cluster Tag] - Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
- termination_
protection_ boolenabled - Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
- version_
release_ strsystem - Release cadence that Atlas uses for this cluster.
- advanced
Configurations List<Property Map> - Get the advanced configuration options. See Advanced Configuration below for more details.
- auto
Scaling BooleanCompute Enabled - Specifies whether cluster tier auto-scaling is enabled. The default is false.
- auto
Scaling BooleanCompute Scale Down Enabled - Specifies whether cluster tier auto-down-scaling is enabled.
- auto
Scaling BooleanDisk Gb Enabled - Indicates whether disk auto-scaling is enabled.
- backing
Provider StringName - Indicates Cloud service provider on which the server for a multi-tenant cluster is provisioned.
- backup
Enabled Boolean - Legacy Option, Indicates whether Atlas continuous backups are enabled for the cluster.
- bi
Connector List<Property Map>Configs - 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 String - 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 List<Property Map> - Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options.
- container
Id String - The Network Peering Container ID.
- disk
Size NumberGb - Indicates the size in gigabytes of the server’s root volume (AWS/GCP Only).
- encryption
At StringRest Provider - 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. - mongo
Db StringMajor Version - Indicates the version of the cluster to deploy.
- mongo
Db StringVersion - Version of MongoDB the cluster runs, in
major-version
.minor-version
format. - mongo
Uri String - Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.
- mongo
Uri StringUpdated - 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 StringWith Options - 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
- num
Shards Number - Number of shards to deploy in the specified zone.
- paused Boolean
- Flag that indicates whether the cluster is paused or not.
- pit
Enabled Boolean - Flag that indicates if the cluster uses Continuous Cloud Backup.
- project
Id String - provider
Auto StringScaling Compute Max Instance Size - Maximum instance size to which your cluster can automatically scale.
- provider
Auto StringScaling Compute Min Instance Size - Minimum instance size to which your cluster can automatically scale.
- provider
Backup BooleanEnabled - provider
Disk NumberIops - 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 StringType Name - Describes Azure disk type of the server’s root volume (Azure Only).
- provider
Encrypt BooleanEbs Volume - (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
Encrypt BooleanEbs Volume Flag - provider
Instance StringSize Name - Atlas provides different instance sizes, each with a default storage capacity and RAM size.
- provider
Name String - Indicates the cloud service provider on which the servers are provisioned.
- provider
Region StringName - 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 StringType Indicates the type of the volume. The possible values are:
STANDARD
andPROVISIONED
.NOTE:
STANDARD
is not available for NVME clusters.- replication
Factor 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.
- replication
Specs List<Property Map> - Configuration for cluster regions. See Replication Spec below for more details.
- snapshot
Backup List<Property Map>Policies - current snapshot schedule and retention settings for the cluster.
- srv
Address 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.
- state
Name String - Indicates the current state of the cluster. The possible states are:
- IDLE
- CREATING
- UPDATING
- DELETING
- DELETED
- REPAIRING
- List<Property Map>
- Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
- termination
Protection BooleanEnabled - Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
- version
Release StringSystem - Release cadence that Atlas uses for this cluster.
Supporting Types
GetClusterAdvancedConfiguration
- Change
Stream intOptions Pre And Post Images Expire After Seconds - (Optional) The minimum pre- and post-image retention time in seconds.
- Default
Read stringConcern - Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available.
- Default
Write stringConcern - Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.
- Fail
Index boolKey Too Long - When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.
- Javascript
Enabled bool - When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.
- Minimum
Enabled stringTls Protocol - Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:
- No
Table boolScan - When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.
- Oplog
Min intRetention Hours - Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
- Oplog
Size intMb - The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.
- Sample
Refresh intInterval Bi Connector - Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
- Sample
Size intBi Connector - Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
- Transaction
Lifetime intLimit Seconds - Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.
- Change
Stream intOptions Pre And Post Images Expire After Seconds - (Optional) The minimum pre- and post-image retention time in seconds.
- Default
Read stringConcern - Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available.
- Default
Write stringConcern - Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.
- Fail
Index boolKey Too Long - When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.
- Javascript
Enabled bool - When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.
- Minimum
Enabled stringTls Protocol - Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:
- No
Table boolScan - When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.
- Oplog
Min intRetention Hours - Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
- Oplog
Size intMb - The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.
- Sample
Refresh intInterval Bi Connector - Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
- Sample
Size intBi Connector - Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
- Transaction
Lifetime intLimit Seconds - Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.
- change
Stream IntegerOptions Pre And Post Images Expire After Seconds - (Optional) The minimum pre- and post-image retention time in seconds.
- default
Read StringConcern - Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available.
- default
Write StringConcern - Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.
- fail
Index BooleanKey Too Long - When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.
- javascript
Enabled Boolean - When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.
- minimum
Enabled StringTls Protocol - Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:
- no
Table BooleanScan - When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.
- oplog
Min IntegerRetention Hours - Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
- oplog
Size IntegerMb - The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.
- sample
Refresh IntegerInterval Bi Connector - Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
- sample
Size IntegerBi Connector - Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
- transaction
Lifetime IntegerLimit Seconds - Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.
- change
Stream numberOptions Pre And Post Images Expire After Seconds - (Optional) The minimum pre- and post-image retention time in seconds.
- default
Read stringConcern - Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available.
- default
Write stringConcern - Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.
- fail
Index booleanKey Too Long - When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.
- javascript
Enabled boolean - When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.
- minimum
Enabled stringTls Protocol - Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:
- no
Table booleanScan - When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.
- oplog
Min numberRetention Hours - Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
- oplog
Size numberMb - The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.
- sample
Refresh numberInterval Bi Connector - Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
- sample
Size numberBi Connector - Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
- transaction
Lifetime numberLimit Seconds - Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.
- change_
stream_ intoptions_ pre_ and_ post_ images_ expire_ after_ seconds - (Optional) The minimum pre- and post-image retention time in seconds.
- default_
read_ strconcern - Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available.
- default_
write_ strconcern - Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.
- fail_
index_ boolkey_ too_ long - When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.
- javascript_
enabled bool - When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.
- minimum_
enabled_ strtls_ protocol - Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:
- no_
table_ boolscan - When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.
- oplog_
min_ intretention_ hours - Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
- oplog_
size_ intmb - The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.
- sample_
refresh_ intinterval_ bi_ connector - Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
- sample_
size_ intbi_ connector - Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
- transaction_
lifetime_ intlimit_ seconds - Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.
- change
Stream NumberOptions Pre And Post Images Expire After Seconds - (Optional) The minimum pre- and post-image retention time in seconds.
- default
Read StringConcern - Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available.
- default
Write StringConcern - Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.
- fail
Index BooleanKey Too Long - When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.
- javascript
Enabled Boolean - When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.
- minimum
Enabled StringTls Protocol - Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:
- no
Table BooleanScan - When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.
- oplog
Min NumberRetention Hours - Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
- oplog
Size NumberMb - The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.
- sample
Refresh NumberInterval Bi Connector - Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
- sample
Size NumberBi Connector - Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
- transaction
Lifetime NumberLimit Seconds - Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.
GetClusterBiConnectorConfig
- Enabled bool
- Indicates whether or not BI Connector for Atlas is enabled on the cluster.
- Read
Preference 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 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.
- read
Preference 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.
- read
Preference 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.
- read
Preference 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
- Aws
Private Dictionary<string, string>Link - Aws
Private Dictionary<string, string>Link Srv - Private string
- Network-peering-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.
- Private
Endpoints List<GetCluster Connection String Private Endpoint> - Private
Srv string - Network-peering-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.
connection_strings.private_endpoint.#.connection_string
- Private-endpoint-awaremongodb://
connection string for this private endpoint.connection_strings.private_endpoint.#.srv_connection_string
- Private-endpoint-awaremongodb+srv://
connection string for this private endpoint.connection_strings.private_endpoint.#.srv_shard_optimized_connection_string
- Private endpoint-aware connection string optimized for sharded clusters that uses themongodb+srv://
protocol to connect to MongoDB Cloud through a private endpoint.connection_strings.private_endpoint.#.type
- Type of MongoDB process that you connect to with the connection strings. Atlas returnsMONGOD
for replica sets, orMONGOS
for sharded clusters.connection_strings.private_endpoint.#.endpoints
- Private endpoint through which you connect to Atlas when you useconnection_strings.private_endpoint[n].connection_string
orconnection_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 returnsAWS
orAZURE
.connection_strings.private_endpoint.#.endpoints.#.region
- Region to which you deployed the private endpoint.
- Standard string
- Public mongodb:// connection string for this cluster.
- Standard
Srv string - Public mongodb+srv:// connection string for this cluster. The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS. Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don’t need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn’t, use connectionStrings.standard.
- Aws
Private map[string]stringLink - Aws
Private map[string]stringLink Srv - Private string
- Network-peering-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.
- Private
Endpoints []GetCluster Connection String Private Endpoint - Private
Srv string - Network-peering-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.
connection_strings.private_endpoint.#.connection_string
- Private-endpoint-awaremongodb://
connection string for this private endpoint.connection_strings.private_endpoint.#.srv_connection_string
- Private-endpoint-awaremongodb+srv://
connection string for this private endpoint.connection_strings.private_endpoint.#.srv_shard_optimized_connection_string
- Private endpoint-aware connection string optimized for sharded clusters that uses themongodb+srv://
protocol to connect to MongoDB Cloud through a private endpoint.connection_strings.private_endpoint.#.type
- Type of MongoDB process that you connect to with the connection strings. Atlas returnsMONGOD
for replica sets, orMONGOS
for sharded clusters.connection_strings.private_endpoint.#.endpoints
- Private endpoint through which you connect to Atlas when you useconnection_strings.private_endpoint[n].connection_string
orconnection_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 returnsAWS
orAZURE
.connection_strings.private_endpoint.#.endpoints.#.region
- Region to which you deployed the private endpoint.
- Standard string
- Public mongodb:// connection string for this cluster.
- Standard
Srv string - Public mongodb+srv:// connection string for this cluster. The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS. Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don’t need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn’t, use connectionStrings.standard.
- aws
Private Map<String,String>Link - aws
Private Map<String,String>Link Srv - private
Endpoints List<GetCluster Connection String Private Endpoint> - private
Srv String - Network-peering-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.
connection_strings.private_endpoint.#.connection_string
- Private-endpoint-awaremongodb://
connection string for this private endpoint.connection_strings.private_endpoint.#.srv_connection_string
- Private-endpoint-awaremongodb+srv://
connection string for this private endpoint.connection_strings.private_endpoint.#.srv_shard_optimized_connection_string
- Private endpoint-aware connection string optimized for sharded clusters that uses themongodb+srv://
protocol to connect to MongoDB Cloud through a private endpoint.connection_strings.private_endpoint.#.type
- Type of MongoDB process that you connect to with the connection strings. Atlas returnsMONGOD
for replica sets, orMONGOS
for sharded clusters.connection_strings.private_endpoint.#.endpoints
- Private endpoint through which you connect to Atlas when you useconnection_strings.private_endpoint[n].connection_string
orconnection_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 returnsAWS
orAZURE
.connection_strings.private_endpoint.#.endpoints.#.region
- Region to which you deployed the private endpoint.
- private_ String
- Network-peering-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.
- standard String
- Public mongodb:// connection string for this cluster.
- standard
Srv String - Public mongodb+srv:// connection string for this cluster. The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS. Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don’t need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn’t, use connectionStrings.standard.
- aws
Private {[key: string]: string}Link - aws
Private {[key: string]: string}Link Srv - private string
- Network-peering-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.
- private
Endpoints GetCluster Connection String Private Endpoint[] - private
Srv string - Network-peering-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.
connection_strings.private_endpoint.#.connection_string
- Private-endpoint-awaremongodb://
connection string for this private endpoint.connection_strings.private_endpoint.#.srv_connection_string
- Private-endpoint-awaremongodb+srv://
connection string for this private endpoint.connection_strings.private_endpoint.#.srv_shard_optimized_connection_string
- Private endpoint-aware connection string optimized for sharded clusters that uses themongodb+srv://
protocol to connect to MongoDB Cloud through a private endpoint.connection_strings.private_endpoint.#.type
- Type of MongoDB process that you connect to with the connection strings. Atlas returnsMONGOD
for replica sets, orMONGOS
for sharded clusters.connection_strings.private_endpoint.#.endpoints
- Private endpoint through which you connect to Atlas when you useconnection_strings.private_endpoint[n].connection_string
orconnection_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 returnsAWS
orAZURE
.connection_strings.private_endpoint.#.endpoints.#.region
- Region to which you deployed the private endpoint.
- standard string
- Public mongodb:// connection string for this cluster.
- standard
Srv string - Public mongodb+srv:// connection string for this cluster. The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS. Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don’t need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn’t, use connectionStrings.standard.
- aws_
private_ Mapping[str, str]link - aws_
private_ Mapping[str, str]link_ srv - private str
- Network-peering-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.
- private_
endpoints Sequence[GetCluster Connection String Private Endpoint] - private_
srv str - Network-peering-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.
connection_strings.private_endpoint.#.connection_string
- Private-endpoint-awaremongodb://
connection string for this private endpoint.connection_strings.private_endpoint.#.srv_connection_string
- Private-endpoint-awaremongodb+srv://
connection string for this private endpoint.connection_strings.private_endpoint.#.srv_shard_optimized_connection_string
- Private endpoint-aware connection string optimized for sharded clusters that uses themongodb+srv://
protocol to connect to MongoDB Cloud through a private endpoint.connection_strings.private_endpoint.#.type
- Type of MongoDB process that you connect to with the connection strings. Atlas returnsMONGOD
for replica sets, orMONGOS
for sharded clusters.connection_strings.private_endpoint.#.endpoints
- Private endpoint through which you connect to Atlas when you useconnection_strings.private_endpoint[n].connection_string
orconnection_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 returnsAWS
orAZURE
.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 - 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.
- aws
Private Map<String>Link - aws
Private Map<String>Link Srv - private String
- Network-peering-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.
- private
Endpoints List<Property Map> - private
Srv String - Network-peering-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.
connection_strings.private_endpoint.#.connection_string
- Private-endpoint-awaremongodb://
connection string for this private endpoint.connection_strings.private_endpoint.#.srv_connection_string
- Private-endpoint-awaremongodb+srv://
connection string for this private endpoint.connection_strings.private_endpoint.#.srv_shard_optimized_connection_string
- Private endpoint-aware connection string optimized for sharded clusters that uses themongodb+srv://
protocol to connect to MongoDB Cloud through a private endpoint.connection_strings.private_endpoint.#.type
- Type of MongoDB process that you connect to with the connection strings. Atlas returnsMONGOD
for replica sets, orMONGOS
for sharded clusters.connection_strings.private_endpoint.#.endpoints
- Private endpoint through which you connect to Atlas when you useconnection_strings.private_endpoint[n].connection_string
orconnection_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 returnsAWS
orAZURE
.connection_strings.private_endpoint.#.endpoints.#.region
- Region to which you deployed the private endpoint.
- standard String
- Public mongodb:// connection string for this cluster.
- standard
Srv String - Public mongodb+srv:// connection string for this cluster. The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS. Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don’t need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn’t, use connectionStrings.standard.
GetClusterConnectionStringPrivateEndpoint
- connection
String String - endpoints List<Property Map>
- srv
Connection StringString - srv
Shard StringOptimized Connection String - type String
GetClusterConnectionStringPrivateEndpointEndpoint
- Endpoint
Id string - Provider
Name string - Indicates the cloud service provider on which the servers are provisioned.
- Region string
- Endpoint
Id string - Provider
Name string - Indicates the cloud service provider on which the servers are provisioned.
- Region string
- endpoint
Id String - provider
Name String - Indicates the cloud service provider on which the servers are provisioned.
- region String
- endpoint
Id string - provider
Name 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
- endpoint
Id String - provider
Name String - Indicates the cloud service provider on which the servers are provisioned.
- region String
GetClusterLabel
GetClusterReplicationSpec
- Id string
- 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 List<GetCluster Replication Spec Regions Config> - 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 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.
- Num
Shards int - Number of shards to deploy in the specified zone.
- Regions
Configs []GetCluster Replication Spec Regions Config - 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 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.
- num
Shards Integer - Number of shards to deploy in the specified zone.
- regions
Configs List<GetCluster Replication Spec Regions Config> - 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 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.
- num
Shards number - Number of shards to deploy in the specified zone.
- regions
Configs GetCluster Replication Spec Regions Config[] - 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 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[GetCluster Replication Spec Regions Config] - 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.
- num
Shards Number - Number of shards to deploy in the specified zone.
- regions
Configs 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.
- zone
Name String - Indicates the n ame for the zone in a Global Cluster.
GetClusterReplicationSpecRegionsConfig
- 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 intNodes - 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 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 intNodes - 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 string - Name for the region specified.
- analytics
Nodes 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.
- electable
Nodes 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.
- read
Only IntegerNodes - 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 String - Name for the region specified.
- analytics
Nodes 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.
- electable
Nodes 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.
- read
Only numberNodes - 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 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_ intnodes - 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.
- analytics
Nodes 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.
- electable
Nodes 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.
- read
Only NumberNodes - 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 String - Name for the region specified.
GetClusterSnapshotBackupPolicy
- Cluster
Id string - Cluster
Name string - Next
Snapshot string - Policies
List<Get
Cluster Snapshot Backup Policy Policy> - Reference
Hour intOf Day - Reference
Minute intOf Hour - Restore
Window intDays - Update
Snapshots bool
- Cluster
Id string - Cluster
Name string - Next
Snapshot string - Policies
[]Get
Cluster Snapshot Backup Policy Policy - Reference
Hour intOf Day - Reference
Minute intOf Hour - Restore
Window intDays - Update
Snapshots bool
- cluster
Id String - cluster
Name String - next
Snapshot String - policies
List<Get
Cluster Snapshot Backup Policy Policy> - reference
Hour IntegerOf Day - reference
Minute IntegerOf Hour - restore
Window IntegerDays - update
Snapshots Boolean
- cluster
Id string - cluster
Name string - next
Snapshot string - policies
Get
Cluster Snapshot Backup Policy Policy[] - reference
Hour numberOf Day - reference
Minute numberOf Hour - restore
Window numberDays - update
Snapshots boolean
- cluster
Id String - cluster
Name String - next
Snapshot String - policies List<Property Map>
- reference
Hour NumberOf Day - reference
Minute NumberOf Hour - restore
Window NumberDays - update
Snapshots Boolean
GetClusterSnapshotBackupPolicyPolicy
- Id string
- Unique identifer of the replication document for a zone in a Global Cluster.
- Policy
Items List<GetCluster Snapshot Backup Policy Policy Policy Item>
- Id string
- Unique identifer of the replication document for a zone in a Global Cluster.
- Policy
Items []GetCluster Snapshot Backup Policy Policy Policy Item
- id String
- Unique identifer of the replication document for a zone in a Global Cluster.
- policy
Items List<GetCluster Snapshot Backup Policy Policy Policy Item>
- id string
- Unique identifer of the replication document for a zone in a Global Cluster.
- policy
Items GetCluster Snapshot Backup Policy Policy Policy Item[]
- id str
- Unique identifer of the replication document for a zone in a Global Cluster.
- policy_
items Sequence[GetCluster Snapshot Backup Policy Policy Policy Item]
- id String
- Unique identifer of the replication document for a zone in a Global Cluster.
- policy
Items List<Property Map>
GetClusterSnapshotBackupPolicyPolicyPolicyItem
- Frequency
Interval int - Frequency
Type string - Id string
- Unique identifer of the replication document for a zone in a Global Cluster.
- Retention
Unit string - Retention
Value int
- Frequency
Interval int - Frequency
Type string - Id string
- Unique identifer of the replication document for a zone in a Global Cluster.
- Retention
Unit string - Retention
Value int
- frequency
Interval Integer - frequency
Type String - id String
- Unique identifer of the replication document for a zone in a Global Cluster.
- retention
Unit String - retention
Value Integer
- frequency
Interval number - frequency
Type string - id string
- Unique identifer of the replication document for a zone in a Global Cluster.
- retention
Unit string - retention
Value 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
- frequency
Interval Number - frequency
Type String - id String
- Unique identifer of the replication document for a zone in a Global Cluster.
- retention
Unit String - retention
Value Number
GetClusterTag
Package Details
- Repository
- MongoDB Atlas pulumi/pulumi-mongodbatlas
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
mongodbatlas
Terraform Provider.