MongoDB Atlas v3.16.2, Jun 21 24

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

mongodbatlas.getAdvancedClusters

Explore with Pulumi AI

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

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

Coming soon!

Coming soon!

Coming soon!

Coming soon!

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.GetClustersArgs;
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 exampleCluster = new Cluster("exampleCluster", ClusterArgs.builder()
            .projectId("<YOUR-PROJECT-ID>")
            .name("cluster-test")
            .clusterType("REPLICASET")
            .replicationSpecs(ClusterReplicationSpecArgs.builder()
                .regionConfigs(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .build())
            .build());

        final var example = MongodbatlasFunctions.getClusters(GetClustersArgs.builder()
            .projectId(exampleCluster.projectId())
            .build());

    }
}

resources:
  exampleCluster:
    type: mongodbatlas:Cluster
    name: example
    properties:
      projectId: <YOUR-PROJECT-ID>
      name: cluster-test
      clusterType: REPLICASET
      replicationSpecs:
        - regionConfigs:
            - electableSpecs:
                - instanceSize: M5
              providerName: TENANT
              backingProviderName: AWS
              regionName: US_EAST_1
              priority: 7
variables:
  example:
    fn::invoke:
      Function: mongodbatlas:getClusters
      Arguments:
        projectId: ${exampleCluster.projectId}

Using getAdvancedClusters

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 getAdvancedClusters(args: GetAdvancedClustersArgs, opts?: InvokeOptions): Promise<GetAdvancedClustersResult>
function getAdvancedClustersOutput(args: GetAdvancedClustersOutputArgs, opts?: InvokeOptions): Output<GetAdvancedClustersResult>

def get_advanced_clusters(project_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetAdvancedClustersResult
def get_advanced_clusters_output(project_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetAdvancedClustersResult]

func LookupAdvancedClusters(ctx *Context, args *LookupAdvancedClustersArgs, opts ...InvokeOption) (*LookupAdvancedClustersResult, error)
func LookupAdvancedClustersOutput(ctx *Context, args *LookupAdvancedClustersOutputArgs, opts ...InvokeOption) LookupAdvancedClustersResultOutput

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

public static class GetAdvancedClusters 
{
    public static Task<GetAdvancedClustersResult> InvokeAsync(GetAdvancedClustersArgs args, InvokeOptions? opts = null)
    public static Output<GetAdvancedClustersResult> Invoke(GetAdvancedClustersInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAdvancedClustersResult> getAdvancedClusters(GetAdvancedClustersArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

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.

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.

projectId String: The unique ID for the project to get the clusters.

getAdvancedClusters Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
ProjectId string
Results List<GetAdvancedClustersResult>: A list where each represents a Cluster. See below for more details.

Id string: The provider-assigned unique ID for this managed resource.
ProjectId string
Results []GetAdvancedClustersResult: A list where each represents a Cluster. See below for more details.

id String: The provider-assigned unique ID for this managed resource.
projectId String
results List<GetAdvancedClustersResult>: A list where each represents a Cluster. See below for more details.

id string: The provider-assigned unique ID for this managed resource.
projectId string
results GetAdvancedClustersResult[]: A list where each represents a Cluster. See below for more details.

id str: The provider-assigned unique ID for this managed resource.
project_id str
results Sequence[GetAdvancedClustersResult]: A list where each represents a Cluster. See below for more details.

id String: The provider-assigned unique ID for this managed resource.
projectId String
results List<Property Map>: A list where each represents a Cluster. See below for more details.

Supporting Types

GetAdvancedClustersResult

AdvancedConfigurations List<GetAdvancedClustersResultAdvancedConfiguration>: Get the advanced configuration options. See Advanced Configuration below for more details.
BackupEnabled bool
BiConnectorConfigs List<GetAdvancedClustersResultBiConnectorConfig>: Configuration settings applied to BI Connector for Atlas on this cluster. See below. NOTE Prior version of provider had parameter as bi_connector
ClusterType string: Type of the cluster that you want to create.
ConnectionStrings List<GetAdvancedClustersResultConnectionString>: 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.
CreateDate string
DiskSizeGb double: Capacity, in gigabytes, of the host's root volume.
EncryptionAtRestProvider string: Possible values are AWS, GCP, AZURE or NONE.
GlobalClusterSelfManagedSharding bool: Flag that indicates if cluster uses Atlas-Managed Sharding (false) or Self-Managed Sharding (true).
Labels List<GetAdvancedClustersResultLabel>: Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
Deprecated: This parameter is deprecated and will be removed by September 2024. Please transition to tags.
MongoDbMajorVersion string: Version of the cluster to deploy.
MongoDbVersion string: Version of MongoDB the cluster runs, in major-version.minor-version format.
Name string
Paused bool: Flag that indicates whether the cluster is paused or not.
PitEnabled bool: Flag that indicates if the cluster uses Continuous Cloud Backup.
ReplicationSpecs List<GetAdvancedClustersResultReplicationSpec>: Configuration for cluster regions and the hardware provisioned in them. See below
RootCertType string: Certificate Authority that MongoDB Atlas clusters use.
StateName string: Current state of the cluster. The possible states are:
Tags List<GetAdvancedClustersResultTag>: Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
TerminationProtectionEnabled bool: Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
VersionReleaseSystem string: Release cadence that Atlas uses for this cluster.

AdvancedConfigurations []GetAdvancedClustersResultAdvancedConfiguration: Get the advanced configuration options. See Advanced Configuration below for more details.
BackupEnabled bool
BiConnectorConfigs []GetAdvancedClustersResultBiConnectorConfig: Configuration settings applied to BI Connector for Atlas on this cluster. See below. NOTE Prior version of provider had parameter as bi_connector
ClusterType string: Type of the cluster that you want to create.
ConnectionStrings []GetAdvancedClustersResultConnectionString: 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.
CreateDate string
DiskSizeGb float64: Capacity, in gigabytes, of the host's root volume.
EncryptionAtRestProvider string: Possible values are AWS, GCP, AZURE or NONE.
GlobalClusterSelfManagedSharding bool: Flag that indicates if cluster uses Atlas-Managed Sharding (false) or Self-Managed Sharding (true).
Labels []GetAdvancedClustersResultLabel: Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
Deprecated: This parameter is deprecated and will be removed by September 2024. Please transition to tags.
MongoDbMajorVersion string: Version of the cluster to deploy.
MongoDbVersion string: Version of MongoDB the cluster runs, in major-version.minor-version format.
Name string
Paused bool: Flag that indicates whether the cluster is paused or not.
PitEnabled bool: Flag that indicates if the cluster uses Continuous Cloud Backup.
ReplicationSpecs []GetAdvancedClustersResultReplicationSpec: Configuration for cluster regions and the hardware provisioned in them. See below
RootCertType string: Certificate Authority that MongoDB Atlas clusters use.
StateName string: Current state of the cluster. The possible states are:
Tags []GetAdvancedClustersResultTag: Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
TerminationProtectionEnabled bool: Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
VersionReleaseSystem string: Release cadence that Atlas uses for this cluster.

advancedConfigurations List<GetAdvancedClustersResultAdvancedConfiguration>: Get the advanced configuration options. See Advanced Configuration below for more details.
backupEnabled Boolean
biConnectorConfigs List<GetAdvancedClustersResultBiConnectorConfig>: Configuration settings applied to BI Connector for Atlas on this cluster. See below. NOTE Prior version of provider had parameter as bi_connector
clusterType String: Type of the cluster that you want to create.
connectionStrings List<GetAdvancedClustersResultConnectionString>: 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.
createDate String
diskSizeGb Double: Capacity, in gigabytes, of the host's root volume.
encryptionAtRestProvider String: Possible values are AWS, GCP, AZURE or NONE.
globalClusterSelfManagedSharding Boolean: Flag that indicates if cluster uses Atlas-Managed Sharding (false) or Self-Managed Sharding (true).
labels List<GetAdvancedClustersResultLabel>: Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
Deprecated: This parameter is deprecated and will be removed by September 2024. Please transition to tags.
mongoDbMajorVersion String: Version of the cluster to deploy.
mongoDbVersion String: Version of MongoDB the cluster runs, in major-version.minor-version format.
name String
paused Boolean: Flag that indicates whether the cluster is paused or not.
pitEnabled Boolean: Flag that indicates if the cluster uses Continuous Cloud Backup.
replicationSpecs List<GetAdvancedClustersResultReplicationSpec>: Configuration for cluster regions and the hardware provisioned in them. See below
rootCertType String: Certificate Authority that MongoDB Atlas clusters use.
stateName String: Current state of the cluster. The possible states are:
tags List<GetAdvancedClustersResultTag>: Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
terminationProtectionEnabled Boolean: Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
versionReleaseSystem String: Release cadence that Atlas uses for this cluster.

advancedConfigurations GetAdvancedClustersResultAdvancedConfiguration[]: Get the advanced configuration options. See Advanced Configuration below for more details.
backupEnabled boolean
biConnectorConfigs GetAdvancedClustersResultBiConnectorConfig[]: Configuration settings applied to BI Connector for Atlas on this cluster. See below. NOTE Prior version of provider had parameter as bi_connector
clusterType string: Type of the cluster that you want to create.
connectionStrings GetAdvancedClustersResultConnectionString[]: 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.
createDate string
diskSizeGb number: Capacity, in gigabytes, of the host's root volume.
encryptionAtRestProvider string: Possible values are AWS, GCP, AZURE or NONE.
globalClusterSelfManagedSharding boolean: Flag that indicates if cluster uses Atlas-Managed Sharding (false) or Self-Managed Sharding (true).
labels GetAdvancedClustersResultLabel[]: Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
Deprecated: This parameter is deprecated and will be removed by September 2024. Please transition to tags.
mongoDbMajorVersion string: Version of the cluster to deploy.
mongoDbVersion string: Version of MongoDB the cluster runs, in major-version.minor-version format.
name string
paused boolean: Flag that indicates whether the cluster is paused or not.
pitEnabled boolean: Flag that indicates if the cluster uses Continuous Cloud Backup.
replicationSpecs GetAdvancedClustersResultReplicationSpec[]: Configuration for cluster regions and the hardware provisioned in them. See below
rootCertType string: Certificate Authority that MongoDB Atlas clusters use.
stateName string: Current state of the cluster. The possible states are:
tags GetAdvancedClustersResultTag[]: Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
terminationProtectionEnabled boolean: Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
versionReleaseSystem string: Release cadence that Atlas uses for this cluster.

advanced_configurations Sequence[GetAdvancedClustersResultAdvancedConfiguration]: Get the advanced configuration options. See Advanced Configuration below for more details.
backup_enabled bool
bi_connector_configs Sequence[GetAdvancedClustersResultBiConnectorConfig]: Configuration settings applied to BI Connector for Atlas on this cluster. See below. NOTE Prior version of provider had parameter as bi_connector
cluster_type str: Type of the cluster that you want to create.
connection_strings Sequence[GetAdvancedClustersResultConnectionString]: 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.
create_date str
disk_size_gb float: Capacity, in gigabytes, of the host's root volume.
encryption_at_rest_provider str: Possible values are AWS, GCP, AZURE or NONE.
global_cluster_self_managed_sharding bool: Flag that indicates if cluster uses Atlas-Managed Sharding (false) or Self-Managed Sharding (true).
labels Sequence[GetAdvancedClustersResultLabel]: Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
Deprecated: This parameter is deprecated and will be removed by September 2024. Please transition to tags.
mongo_db_major_version str: Version of the cluster to deploy.
mongo_db_version str: Version of MongoDB the cluster runs, in major-version.minor-version format.
name str
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.
replication_specs Sequence[GetAdvancedClustersResultReplicationSpec]: Configuration for cluster regions and the hardware provisioned in them. See below
root_cert_type str: Certificate Authority that MongoDB Atlas clusters use.
state_name str: Current state of the cluster. The possible states are:
tags Sequence[GetAdvancedClustersResultTag]: Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
termination_protection_enabled bool: Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
version_release_system str: Release cadence that Atlas uses for this cluster.

advancedConfigurations List<Property Map>: Get the advanced configuration options. See Advanced Configuration below for more details.
backupEnabled Boolean
biConnectorConfigs List<Property Map>: Configuration settings applied to BI Connector for Atlas on this cluster. See below. NOTE Prior version of provider had parameter as bi_connector
clusterType String: Type of the cluster that you want to create.
connectionStrings 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. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.
createDate String
diskSizeGb Number: Capacity, in gigabytes, of the host's root volume.
encryptionAtRestProvider String: Possible values are AWS, GCP, AZURE or NONE.
globalClusterSelfManagedSharding Boolean: Flag that indicates if cluster uses Atlas-Managed Sharding (false) or Self-Managed Sharding (true).
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: This parameter is deprecated and will be removed by September 2024. Please transition to tags.
mongoDbMajorVersion String: Version of the cluster to deploy.
mongoDbVersion String: Version of MongoDB the cluster runs, in major-version.minor-version format.
name String
paused Boolean: Flag that indicates whether the cluster is paused or not.
pitEnabled Boolean: Flag that indicates if the cluster uses Continuous Cloud Backup.
replicationSpecs List<Property Map>: Configuration for cluster regions and the hardware provisioned in them. See below
rootCertType String: Certificate Authority that MongoDB Atlas clusters use.
stateName String: Current state of the cluster. The possible states are:
tags List<Property Map>: Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
terminationProtectionEnabled Boolean: Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
versionReleaseSystem String: Release cadence that Atlas uses for this cluster.

GetAdvancedClustersResultAdvancedConfiguration

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

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

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

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

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

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

GetAdvancedClustersResultBiConnectorConfig

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

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

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

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

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

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

GetAdvancedClustersResultConnectionString

Private string

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

PrivateEndpoints List<GetAdvancedClustersResultConnectionStringPrivateEndpoint>

Private endpoint connection strings. Each object describes the connection strings you can use to connect to this cluster through a private endpoint. Atlas returns this parameter only if you deployed a private endpoint to all regions to which you deployed this cluster's nodes.

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. 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 connection_strings.private_endpoint[n].connection_string
connection_strings.private_endpoint.#.srv_shard_optimized_connection_string - Private endpoint-aware connection string optimized for sharded clusters that uses the mongodb+srv:// protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString.
connection_strings.private_endpoint.#.type - Type of MongoDB process that you connect to with the connection strings. Atlas returns MONGOD for replica sets, or MONGOS for sharded clusters.
connection_strings.private_endpoint.#.endpoints - Private endpoint through which you connect to Atlas when you use connection_strings.private_endpoint[n].connection_string or connection_strings.private_endpoint[n].srv_connection_string
connection_strings.private_endpoint.#.endpoints.#.endpoint_id - Unique identifier of the private endpoint.
connection_strings.private_endpoint.#.endpoints.#.provider_name - Cloud provider to which you deployed the private endpoint. Atlas returns AWS or AZURE.
connection_strings.private_endpoint.#.endpoints.#.region - Region to which you deployed the private endpoint.

PrivateSrv string

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

Standard string

Public mongodb:// connection string for this cluster.

StandardSrv string

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

Private string

PrivateEndpoints []GetAdvancedClustersResultConnectionStringPrivateEndpoint

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. 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 connection_strings.private_endpoint[n].connection_string
connection_strings.private_endpoint.#.srv_shard_optimized_connection_string - Private endpoint-aware connection string optimized for sharded clusters that uses the mongodb+srv:// protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString.
connection_strings.private_endpoint.#.type - Type of MongoDB process that you connect to with the connection strings. Atlas returns MONGOD for replica sets, or MONGOS for sharded clusters.
connection_strings.private_endpoint.#.endpoints - Private endpoint through which you connect to Atlas when you use connection_strings.private_endpoint[n].connection_string or connection_strings.private_endpoint[n].srv_connection_string
connection_strings.private_endpoint.#.endpoints.#.endpoint_id - Unique identifier of the private endpoint.
connection_strings.private_endpoint.#.endpoints.#.provider_name - Cloud provider to which you deployed the private endpoint. Atlas returns AWS or AZURE.
connection_strings.private_endpoint.#.endpoints.#.region - Region to which you deployed the private endpoint.

PrivateSrv string

Standard string

Public mongodb:// connection string for this cluster.

StandardSrv string

privateEndpoints List<GetAdvancedClustersResultConnectionStringPrivateEndpoint>

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. 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 connection_strings.private_endpoint[n].connection_string
connection_strings.private_endpoint.#.srv_shard_optimized_connection_string - Private endpoint-aware connection string optimized for sharded clusters that uses the mongodb+srv:// protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString.
connection_strings.private_endpoint.#.type - Type of MongoDB process that you connect to with the connection strings. Atlas returns MONGOD for replica sets, or MONGOS for sharded clusters.
connection_strings.private_endpoint.#.endpoints - Private endpoint through which you connect to Atlas when you use connection_strings.private_endpoint[n].connection_string or connection_strings.private_endpoint[n].srv_connection_string
connection_strings.private_endpoint.#.endpoints.#.endpoint_id - Unique identifier of the private endpoint.
connection_strings.private_endpoint.#.endpoints.#.provider_name - Cloud provider to which you deployed the private endpoint. Atlas returns AWS or AZURE.
connection_strings.private_endpoint.#.endpoints.#.region - Region to which you deployed the private endpoint.

privateSrv String

private_ String

standard String

Public mongodb:// connection string for this cluster.

standardSrv String

private string

privateEndpoints GetAdvancedClustersResultConnectionStringPrivateEndpoint[]

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. 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 connection_strings.private_endpoint[n].connection_string
connection_strings.private_endpoint.#.srv_shard_optimized_connection_string - Private endpoint-aware connection string optimized for sharded clusters that uses the mongodb+srv:// protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString.
connection_strings.private_endpoint.#.type - Type of MongoDB process that you connect to with the connection strings. Atlas returns MONGOD for replica sets, or MONGOS for sharded clusters.
connection_strings.private_endpoint.#.endpoints - Private endpoint through which you connect to Atlas when you use connection_strings.private_endpoint[n].connection_string or connection_strings.private_endpoint[n].srv_connection_string
connection_strings.private_endpoint.#.endpoints.#.endpoint_id - Unique identifier of the private endpoint.
connection_strings.private_endpoint.#.endpoints.#.provider_name - Cloud provider to which you deployed the private endpoint. Atlas returns AWS or AZURE.
connection_strings.private_endpoint.#.endpoints.#.region - Region to which you deployed the private endpoint.

privateSrv string

standard string

Public mongodb:// connection string for this cluster.

standardSrv string

private str

private_endpoints Sequence[GetAdvancedClustersResultConnectionStringPrivateEndpoint]

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. 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 connection_strings.private_endpoint[n].connection_string
connection_strings.private_endpoint.#.srv_shard_optimized_connection_string - Private endpoint-aware connection string optimized for sharded clusters that uses the mongodb+srv:// protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString.
connection_strings.private_endpoint.#.type - Type of MongoDB process that you connect to with the connection strings. Atlas returns MONGOD for replica sets, or MONGOS for sharded clusters.
connection_strings.private_endpoint.#.endpoints - Private endpoint through which you connect to Atlas when you use connection_strings.private_endpoint[n].connection_string or connection_strings.private_endpoint[n].srv_connection_string
connection_strings.private_endpoint.#.endpoints.#.endpoint_id - Unique identifier of the private endpoint.
connection_strings.private_endpoint.#.endpoints.#.provider_name - Cloud provider to which you deployed the private endpoint. Atlas returns AWS or AZURE.
connection_strings.private_endpoint.#.endpoints.#.region - Region to which you deployed the private endpoint.

private_srv str

standard str

Public mongodb:// connection string for this cluster.

standard_srv str

private String

privateEndpoints List<Property Map>

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. 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 connection_strings.private_endpoint[n].connection_string
connection_strings.private_endpoint.#.srv_shard_optimized_connection_string - Private endpoint-aware connection string optimized for sharded clusters that uses the mongodb+srv:// protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString.
connection_strings.private_endpoint.#.type - Type of MongoDB process that you connect to with the connection strings. Atlas returns MONGOD for replica sets, or MONGOS for sharded clusters.
connection_strings.private_endpoint.#.endpoints - Private endpoint through which you connect to Atlas when you use connection_strings.private_endpoint[n].connection_string or connection_strings.private_endpoint[n].srv_connection_string
connection_strings.private_endpoint.#.endpoints.#.endpoint_id - Unique identifier of the private endpoint.
connection_strings.private_endpoint.#.endpoints.#.provider_name - Cloud provider to which you deployed the private endpoint. Atlas returns AWS or AZURE.
connection_strings.private_endpoint.#.endpoints.#.region - Region to which you deployed the private endpoint.

privateSrv String

standard String

Public mongodb:// connection string for this cluster.

standardSrv String

GetAdvancedClustersResultConnectionStringPrivateEndpoint

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

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

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

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

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

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

GetAdvancedClustersResultConnectionStringPrivateEndpointEndpoint

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

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

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

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

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

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

GetAdvancedClustersResultLabel

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

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

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

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

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

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

GetAdvancedClustersResultReplicationSpec

ContainerId Dictionary<string, string>: A key-value map of the Network Peering Container ID(s) for the configuration specified in region_configs. The Container ID is the id of the container either created programmatically by the user before any clusters existed in a project or when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is "providerName:regionName" = "containerId". Example AWS:US_EAST_1" = "61e0797dde08fb498ca11a71.
Id string
NumShards int: Provide this value if you set a cluster_type of SHARDED or GEOSHARDED.
RegionConfigs List<GetAdvancedClustersResultReplicationSpecRegionConfig>: Configuration for the hardware specifications for nodes set for a given regionEach region_configs object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Each region_configs object must have either an analytics_specs object, electable_specs object, or read_only_specs object. See below
ZoneName string: Name for the zone in a Global Cluster.

ContainerId map[string]string: A key-value map of the Network Peering Container ID(s) for the configuration specified in region_configs. The Container ID is the id of the container either created programmatically by the user before any clusters existed in a project or when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is "providerName:regionName" = "containerId". Example AWS:US_EAST_1" = "61e0797dde08fb498ca11a71.
Id string
NumShards int: Provide this value if you set a cluster_type of SHARDED or GEOSHARDED.
RegionConfigs []GetAdvancedClustersResultReplicationSpecRegionConfig: Configuration for the hardware specifications for nodes set for a given regionEach region_configs object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Each region_configs object must have either an analytics_specs object, electable_specs object, or read_only_specs object. See below
ZoneName string: Name for the zone in a Global Cluster.

containerId Map<String,String>: A key-value map of the Network Peering Container ID(s) for the configuration specified in region_configs. The Container ID is the id of the container either created programmatically by the user before any clusters existed in a project or when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is "providerName:regionName" = "containerId". Example AWS:US_EAST_1" = "61e0797dde08fb498ca11a71.
id String
numShards Integer: Provide this value if you set a cluster_type of SHARDED or GEOSHARDED.
regionConfigs List<GetAdvancedClustersResultReplicationSpecRegionConfig>: Configuration for the hardware specifications for nodes set for a given regionEach region_configs object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Each region_configs object must have either an analytics_specs object, electable_specs object, or read_only_specs object. See below
zoneName String: Name for the zone in a Global Cluster.

containerId {[key: string]: string}: A key-value map of the Network Peering Container ID(s) for the configuration specified in region_configs. The Container ID is the id of the container either created programmatically by the user before any clusters existed in a project or when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is "providerName:regionName" = "containerId". Example AWS:US_EAST_1" = "61e0797dde08fb498ca11a71.
id string
numShards number: Provide this value if you set a cluster_type of SHARDED or GEOSHARDED.
regionConfigs GetAdvancedClustersResultReplicationSpecRegionConfig[]: Configuration for the hardware specifications for nodes set for a given regionEach region_configs object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Each region_configs object must have either an analytics_specs object, electable_specs object, or read_only_specs object. See below
zoneName string: Name for the zone in a Global Cluster.

container_id Mapping[str, str]: A key-value map of the Network Peering Container ID(s) for the configuration specified in region_configs. The Container ID is the id of the container either created programmatically by the user before any clusters existed in a project or when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is "providerName:regionName" = "containerId". Example AWS:US_EAST_1" = "61e0797dde08fb498ca11a71.
id str
num_shards int: Provide this value if you set a cluster_type of SHARDED or GEOSHARDED.
region_configs Sequence[GetAdvancedClustersResultReplicationSpecRegionConfig]: Configuration for the hardware specifications for nodes set for a given regionEach region_configs object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Each region_configs object must have either an analytics_specs object, electable_specs object, or read_only_specs object. See below
zone_name str: Name for the zone in a Global Cluster.

containerId Map<String>: A key-value map of the Network Peering Container ID(s) for the configuration specified in region_configs. The Container ID is the id of the container either created programmatically by the user before any clusters existed in a project or when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is "providerName:regionName" = "containerId". Example AWS:US_EAST_1" = "61e0797dde08fb498ca11a71.
id String
numShards Number: Provide this value if you set a cluster_type of SHARDED or GEOSHARDED.
regionConfigs List<Property Map>: Configuration for the hardware specifications for nodes set for a given regionEach region_configs object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Each region_configs object must have either an analytics_specs object, electable_specs object, or read_only_specs object. See below
zoneName String: Name for the zone in a Global Cluster.

GetAdvancedClustersResultReplicationSpecRegionConfig

AnalyticsAutoScalings List<GetAdvancedClustersResultReplicationSpecRegionConfigAnalyticsAutoScaling>: Configuration for the Collection of settings that configures analytis-auto-scaling information for the cluster. See below
AutoScalings List<GetAdvancedClustersResultReplicationSpecRegionConfigAutoScaling>: Configuration for the Collection of settings that configures auto-scaling information for the cluster. See below
BackingProviderName string: Cloud service provider on which you provision the host for a multi-tenant cluster.
Priority int: Election priority of the region.
ProviderName string: Cloud service provider on which the servers are provisioned.
RegionName string: Physical location of your MongoDB cluster.
AnalyticsSpecs GetAdvancedClustersResultReplicationSpecRegionConfigAnalyticsSpecs: Hardware specifications for analytics nodes needed in the region. See below
ElectableSpecs GetAdvancedClustersResultReplicationSpecRegionConfigElectableSpecs: Hardware specifications for electable nodes in the region.
ReadOnlySpecs GetAdvancedClustersResultReplicationSpecRegionConfigReadOnlySpecs: Hardware specifications for read-only nodes in the region. See below

AnalyticsAutoScalings []GetAdvancedClustersResultReplicationSpecRegionConfigAnalyticsAutoScaling: Configuration for the Collection of settings that configures analytis-auto-scaling information for the cluster. See below
AutoScalings []GetAdvancedClustersResultReplicationSpecRegionConfigAutoScaling: Configuration for the Collection of settings that configures auto-scaling information for the cluster. See below
BackingProviderName string: Cloud service provider on which you provision the host for a multi-tenant cluster.
Priority int: Election priority of the region.
ProviderName string: Cloud service provider on which the servers are provisioned.
RegionName string: Physical location of your MongoDB cluster.
AnalyticsSpecs GetAdvancedClustersResultReplicationSpecRegionConfigAnalyticsSpecs: Hardware specifications for analytics nodes needed in the region. See below
ElectableSpecs GetAdvancedClustersResultReplicationSpecRegionConfigElectableSpecs: Hardware specifications for electable nodes in the region.
ReadOnlySpecs GetAdvancedClustersResultReplicationSpecRegionConfigReadOnlySpecs: Hardware specifications for read-only nodes in the region. See below

analyticsAutoScalings List<GetAdvancedClustersResultReplicationSpecRegionConfigAnalyticsAutoScaling>: Configuration for the Collection of settings that configures analytis-auto-scaling information for the cluster. See below
autoScalings List<GetAdvancedClustersResultReplicationSpecRegionConfigAutoScaling>: Configuration for the Collection of settings that configures auto-scaling information for the cluster. See below
backingProviderName String: Cloud service provider on which you provision the host for a multi-tenant cluster.
priority Integer: Election priority of the region.
providerName String: Cloud service provider on which the servers are provisioned.
regionName String: Physical location of your MongoDB cluster.
analyticsSpecs GetAdvancedClustersResultReplicationSpecRegionConfigAnalyticsSpecs: Hardware specifications for analytics nodes needed in the region. See below
electableSpecs GetAdvancedClustersResultReplicationSpecRegionConfigElectableSpecs: Hardware specifications for electable nodes in the region.
readOnlySpecs GetAdvancedClustersResultReplicationSpecRegionConfigReadOnlySpecs: Hardware specifications for read-only nodes in the region. See below

analyticsAutoScalings GetAdvancedClustersResultReplicationSpecRegionConfigAnalyticsAutoScaling[]: Configuration for the Collection of settings that configures analytis-auto-scaling information for the cluster. See below
autoScalings GetAdvancedClustersResultReplicationSpecRegionConfigAutoScaling[]: Configuration for the Collection of settings that configures auto-scaling information for the cluster. See below
backingProviderName string: Cloud service provider on which you provision the host for a multi-tenant cluster.
priority number: Election priority of the region.
providerName string: Cloud service provider on which the servers are provisioned.
regionName string: Physical location of your MongoDB cluster.
analyticsSpecs GetAdvancedClustersResultReplicationSpecRegionConfigAnalyticsSpecs: Hardware specifications for analytics nodes needed in the region. See below
electableSpecs GetAdvancedClustersResultReplicationSpecRegionConfigElectableSpecs: Hardware specifications for electable nodes in the region.
readOnlySpecs GetAdvancedClustersResultReplicationSpecRegionConfigReadOnlySpecs: Hardware specifications for read-only nodes in the region. See below

analytics_auto_scalings Sequence[GetAdvancedClustersResultReplicationSpecRegionConfigAnalyticsAutoScaling]: Configuration for the Collection of settings that configures analytis-auto-scaling information for the cluster. See below
auto_scalings Sequence[GetAdvancedClustersResultReplicationSpecRegionConfigAutoScaling]: Configuration for the Collection of settings that configures auto-scaling information for the cluster. See below
backing_provider_name str: Cloud service provider on which you provision the host for a multi-tenant cluster.
priority int: Election priority of the region.
provider_name str: Cloud service provider on which the servers are provisioned.
region_name str: Physical location of your MongoDB cluster.
analytics_specs GetAdvancedClustersResultReplicationSpecRegionConfigAnalyticsSpecs: Hardware specifications for analytics nodes needed in the region. See below
electable_specs GetAdvancedClustersResultReplicationSpecRegionConfigElectableSpecs: Hardware specifications for electable nodes in the region.
read_only_specs GetAdvancedClustersResultReplicationSpecRegionConfigReadOnlySpecs: Hardware specifications for read-only nodes in the region. See below

analyticsAutoScalings List<Property Map>: Configuration for the Collection of settings that configures analytis-auto-scaling information for the cluster. See below
autoScalings List<Property Map>: Configuration for the Collection of settings that configures auto-scaling information for the cluster. See below
backingProviderName String: Cloud service provider on which you provision the host for a multi-tenant cluster.
priority Number: Election priority of the region.
providerName String: Cloud service provider on which the servers are provisioned.
regionName String: Physical location of your MongoDB cluster.
analyticsSpecs Property Map: Hardware specifications for analytics nodes needed in the region. See below
electableSpecs Property Map: Hardware specifications for electable nodes in the region.
readOnlySpecs Property Map: Hardware specifications for read-only nodes in the region. See below

GetAdvancedClustersResultReplicationSpecRegionConfigAnalyticsAutoScaling

ComputeEnabled bool: Flag that indicates whether instance size auto-scaling is enabled.
ComputeMaxInstanceSize string: Maximum instance size to which your cluster can automatically scale (such as M40).
ComputeMinInstanceSize string: Minimum instance size to which your cluster can automatically scale (such as M10).
ComputeScaleDownEnabled bool: Flag that indicates whether the instance size may scale down.
DiskGbEnabled bool: Flag that indicates whether this cluster enables disk auto-scaling.

ComputeEnabled bool: Flag that indicates whether instance size auto-scaling is enabled.
ComputeMaxInstanceSize string: Maximum instance size to which your cluster can automatically scale (such as M40).
ComputeMinInstanceSize string: Minimum instance size to which your cluster can automatically scale (such as M10).
ComputeScaleDownEnabled bool: Flag that indicates whether the instance size may scale down.
DiskGbEnabled bool: Flag that indicates whether this cluster enables disk auto-scaling.

computeEnabled Boolean: Flag that indicates whether instance size auto-scaling is enabled.
computeMaxInstanceSize String: Maximum instance size to which your cluster can automatically scale (such as M40).
computeMinInstanceSize String: Minimum instance size to which your cluster can automatically scale (such as M10).
computeScaleDownEnabled Boolean: Flag that indicates whether the instance size may scale down.
diskGbEnabled Boolean: Flag that indicates whether this cluster enables disk auto-scaling.

computeEnabled boolean: Flag that indicates whether instance size auto-scaling is enabled.
computeMaxInstanceSize string: Maximum instance size to which your cluster can automatically scale (such as M40).
computeMinInstanceSize string: Minimum instance size to which your cluster can automatically scale (such as M10).
computeScaleDownEnabled boolean: Flag that indicates whether the instance size may scale down.
diskGbEnabled boolean: Flag that indicates whether this cluster enables disk auto-scaling.

compute_enabled bool: Flag that indicates whether instance size auto-scaling is enabled.
compute_max_instance_size str: Maximum instance size to which your cluster can automatically scale (such as M40).
compute_min_instance_size str: Minimum instance size to which your cluster can automatically scale (such as M10).
compute_scale_down_enabled bool: Flag that indicates whether the instance size may scale down.
disk_gb_enabled bool: Flag that indicates whether this cluster enables disk auto-scaling.

computeEnabled Boolean: Flag that indicates whether instance size auto-scaling is enabled.
computeMaxInstanceSize String: Maximum instance size to which your cluster can automatically scale (such as M40).
computeMinInstanceSize String: Minimum instance size to which your cluster can automatically scale (such as M10).
computeScaleDownEnabled Boolean: Flag that indicates whether the instance size may scale down.
diskGbEnabled Boolean: Flag that indicates whether this cluster enables disk auto-scaling.

GetAdvancedClustersResultReplicationSpecRegionConfigAnalyticsSpecs

DiskIops int

Target throughput (IOPS) desired for AWS storage attached to your cluster.

InstanceSize string

Hardware specification for the instance sizes in this region.

EbsVolumeType string

Type of storage you want to attach to your AWS-provisioned cluster.

STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.

NodeCount int

Number of nodes of the given type for MongoDB Atlas to deploy to the region.

DiskIops int

Target throughput (IOPS) desired for AWS storage attached to your cluster.

InstanceSize string

Hardware specification for the instance sizes in this region.

EbsVolumeType string

Type of storage you want to attach to your AWS-provisioned cluster.

STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.

NodeCount int

Number of nodes of the given type for MongoDB Atlas to deploy to the region.

diskIops Integer

Target throughput (IOPS) desired for AWS storage attached to your cluster.

instanceSize String

Hardware specification for the instance sizes in this region.

ebsVolumeType String

Type of storage you want to attach to your AWS-provisioned cluster.

STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.

nodeCount Integer

Number of nodes of the given type for MongoDB Atlas to deploy to the region.

diskIops number

Target throughput (IOPS) desired for AWS storage attached to your cluster.

instanceSize string

Hardware specification for the instance sizes in this region.

ebsVolumeType string

Type of storage you want to attach to your AWS-provisioned cluster.

STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.

nodeCount number

Number of nodes of the given type for MongoDB Atlas to deploy to the region.

disk_iops int

Target throughput (IOPS) desired for AWS storage attached to your cluster.

instance_size str

Hardware specification for the instance sizes in this region.

ebs_volume_type str

Type of storage you want to attach to your AWS-provisioned cluster.

STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.

node_count int

Number of nodes of the given type for MongoDB Atlas to deploy to the region.

diskIops Number

Target throughput (IOPS) desired for AWS storage attached to your cluster.

instanceSize String

Hardware specification for the instance sizes in this region.

ebsVolumeType String

Type of storage you want to attach to your AWS-provisioned cluster.

STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.

nodeCount Number

Number of nodes of the given type for MongoDB Atlas to deploy to the region.

GetAdvancedClustersResultReplicationSpecRegionConfigAutoScaling

ComputeEnabled bool: Flag that indicates whether instance size auto-scaling is enabled.
ComputeMaxInstanceSize string: Maximum instance size to which your cluster can automatically scale (such as M40).
ComputeMinInstanceSize string: Minimum instance size to which your cluster can automatically scale (such as M10).
ComputeScaleDownEnabled bool: Flag that indicates whether the instance size may scale down.
DiskGbEnabled bool: Flag that indicates whether this cluster enables disk auto-scaling.

ComputeEnabled bool: Flag that indicates whether instance size auto-scaling is enabled.
ComputeMaxInstanceSize string: Maximum instance size to which your cluster can automatically scale (such as M40).
ComputeMinInstanceSize string: Minimum instance size to which your cluster can automatically scale (such as M10).
ComputeScaleDownEnabled bool: Flag that indicates whether the instance size may scale down.
DiskGbEnabled bool: Flag that indicates whether this cluster enables disk auto-scaling.

computeEnabled Boolean: Flag that indicates whether instance size auto-scaling is enabled.
computeMaxInstanceSize String: Maximum instance size to which your cluster can automatically scale (such as M40).
computeMinInstanceSize String: Minimum instance size to which your cluster can automatically scale (such as M10).
computeScaleDownEnabled Boolean: Flag that indicates whether the instance size may scale down.
diskGbEnabled Boolean: Flag that indicates whether this cluster enables disk auto-scaling.

computeEnabled boolean: Flag that indicates whether instance size auto-scaling is enabled.
computeMaxInstanceSize string: Maximum instance size to which your cluster can automatically scale (such as M40).
computeMinInstanceSize string: Minimum instance size to which your cluster can automatically scale (such as M10).
computeScaleDownEnabled boolean: Flag that indicates whether the instance size may scale down.
diskGbEnabled boolean: Flag that indicates whether this cluster enables disk auto-scaling.

compute_enabled bool: Flag that indicates whether instance size auto-scaling is enabled.
compute_max_instance_size str: Maximum instance size to which your cluster can automatically scale (such as M40).
compute_min_instance_size str: Minimum instance size to which your cluster can automatically scale (such as M10).
compute_scale_down_enabled bool: Flag that indicates whether the instance size may scale down.
disk_gb_enabled bool: Flag that indicates whether this cluster enables disk auto-scaling.

computeEnabled Boolean: Flag that indicates whether instance size auto-scaling is enabled.
computeMaxInstanceSize String: Maximum instance size to which your cluster can automatically scale (such as M40).
computeMinInstanceSize String: Minimum instance size to which your cluster can automatically scale (such as M10).
computeScaleDownEnabled Boolean: Flag that indicates whether the instance size may scale down.
diskGbEnabled Boolean: Flag that indicates whether this cluster enables disk auto-scaling.

GetAdvancedClustersResultReplicationSpecRegionConfigElectableSpecs

DiskIops int

Target throughput (IOPS) desired for AWS storage attached to your cluster.

InstanceSize string

Hardware specification for the instance sizes in this region.

EbsVolumeType string

Type of storage you want to attach to your AWS-provisioned cluster.

STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.

NodeCount int

Number of nodes of the given type for MongoDB Atlas to deploy to the region.

DiskIops int

Target throughput (IOPS) desired for AWS storage attached to your cluster.

InstanceSize string

Hardware specification for the instance sizes in this region.

EbsVolumeType string

Type of storage you want to attach to your AWS-provisioned cluster.

STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.

NodeCount int

Number of nodes of the given type for MongoDB Atlas to deploy to the region.

diskIops Integer

Target throughput (IOPS) desired for AWS storage attached to your cluster.

instanceSize String

Hardware specification for the instance sizes in this region.

ebsVolumeType String

Type of storage you want to attach to your AWS-provisioned cluster.

STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.

nodeCount Integer

Number of nodes of the given type for MongoDB Atlas to deploy to the region.

diskIops number

Target throughput (IOPS) desired for AWS storage attached to your cluster.

instanceSize string

Hardware specification for the instance sizes in this region.

ebsVolumeType string

Type of storage you want to attach to your AWS-provisioned cluster.

STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.

nodeCount number

Number of nodes of the given type for MongoDB Atlas to deploy to the region.

disk_iops int

Target throughput (IOPS) desired for AWS storage attached to your cluster.

instance_size str

Hardware specification for the instance sizes in this region.

ebs_volume_type str

Type of storage you want to attach to your AWS-provisioned cluster.

STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.

node_count int

Number of nodes of the given type for MongoDB Atlas to deploy to the region.

diskIops Number

Target throughput (IOPS) desired for AWS storage attached to your cluster.

instanceSize String

Hardware specification for the instance sizes in this region.

ebsVolumeType String

Type of storage you want to attach to your AWS-provisioned cluster.

STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.

nodeCount Number

Number of nodes of the given type for MongoDB Atlas to deploy to the region.

GetAdvancedClustersResultReplicationSpecRegionConfigReadOnlySpecs

DiskIops int

Target throughput (IOPS) desired for AWS storage attached to your cluster.

InstanceSize string

Hardware specification for the instance sizes in this region.

EbsVolumeType string

Type of storage you want to attach to your AWS-provisioned cluster.

STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.

NodeCount int

Number of nodes of the given type for MongoDB Atlas to deploy to the region.

DiskIops int

Target throughput (IOPS) desired for AWS storage attached to your cluster.

InstanceSize string

Hardware specification for the instance sizes in this region.

EbsVolumeType string

Type of storage you want to attach to your AWS-provisioned cluster.

STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.

NodeCount int

Number of nodes of the given type for MongoDB Atlas to deploy to the region.

diskIops Integer

Target throughput (IOPS) desired for AWS storage attached to your cluster.

instanceSize String

Hardware specification for the instance sizes in this region.

ebsVolumeType String

Type of storage you want to attach to your AWS-provisioned cluster.

STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.

nodeCount Integer

Number of nodes of the given type for MongoDB Atlas to deploy to the region.

diskIops number

Target throughput (IOPS) desired for AWS storage attached to your cluster.

instanceSize string

Hardware specification for the instance sizes in this region.

ebsVolumeType string

Type of storage you want to attach to your AWS-provisioned cluster.

STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.

nodeCount number

Number of nodes of the given type for MongoDB Atlas to deploy to the region.

disk_iops int

Target throughput (IOPS) desired for AWS storage attached to your cluster.

instance_size str

Hardware specification for the instance sizes in this region.

ebs_volume_type str

Type of storage you want to attach to your AWS-provisioned cluster.

STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.

node_count int

Number of nodes of the given type for MongoDB Atlas to deploy to the region.

diskIops Number

Target throughput (IOPS) desired for AWS storage attached to your cluster.

instanceSize String

Hardware specification for the instance sizes in this region.

ebsVolumeType String

Type of storage you want to attach to your AWS-provisioned cluster.

STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.

nodeCount Number

Number of nodes of the given type for MongoDB Atlas to deploy to the region.

GetAdvancedClustersResultTag

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

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

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

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

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

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

Package Details

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

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

pulumi/pulumi-mongodbatlas

mongodbatlas.getAdvancedClusters

On this page

On this page

Example Usage

Using getAdvancedClusters

getAdvancedClusters Result

Supporting Types

GetAdvancedClustersResult

GetAdvancedClustersResultAdvancedConfiguration

GetAdvancedClustersResultBiConnectorConfig

GetAdvancedClustersResultConnectionString

GetAdvancedClustersResultConnectionStringPrivateEndpoint

GetAdvancedClustersResultConnectionStringPrivateEndpointEndpoint

GetAdvancedClustersResultLabel

GetAdvancedClustersResultReplicationSpec

GetAdvancedClustersResultReplicationSpecRegionConfig

GetAdvancedClustersResultReplicationSpecRegionConfigAnalyticsAutoScaling

GetAdvancedClustersResultReplicationSpecRegionConfigAnalyticsSpecs

GetAdvancedClustersResultReplicationSpecRegionConfigAutoScaling

GetAdvancedClustersResultReplicationSpecRegionConfigElectableSpecs

GetAdvancedClustersResultReplicationSpecRegionConfigReadOnlySpecs

GetAdvancedClustersResultTag

Package Details

On this page

On this page