1. Packages
  2. MongoDB Atlas
  3. API Docs
  4. getAdvancedCluster
MongoDB Atlas v3.10.1 published on Wednesday, Sep 6, 2023 by Pulumi

mongodbatlas.getAdvancedCluster

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.10.1 published on Wednesday, Sep 6, 2023 by Pulumi

    mongodbatlas.AdvancedCluster describes an Advanced Cluster. The data source requires your Project ID.

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

    IMPORTANT:
    • Changes to cluster configurations can affect costs. Before making changes, please see Billing.
    • If your Atlas project contains a custom role that uses actions introduced in a specific MongoDB version, you cannot create a cluster with a MongoDB version less than that version unless you delete the custom role.

    Using getAdvancedCluster

    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 getAdvancedCluster(args: GetAdvancedClusterArgs, opts?: InvokeOptions): Promise<GetAdvancedClusterResult>
    function getAdvancedClusterOutput(args: GetAdvancedClusterOutputArgs, opts?: InvokeOptions): Output<GetAdvancedClusterResult>
    def get_advanced_cluster(name: Optional[str] = None,
                             pit_enabled: Optional[bool] = None,
                             project_id: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetAdvancedClusterResult
    def get_advanced_cluster_output(name: Optional[pulumi.Input[str]] = None,
                             pit_enabled: Optional[pulumi.Input[bool]] = None,
                             project_id: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetAdvancedClusterResult]
    func LookupAdvancedCluster(ctx *Context, args *LookupAdvancedClusterArgs, opts ...InvokeOption) (*LookupAdvancedClusterResult, error)
    func LookupAdvancedClusterOutput(ctx *Context, args *LookupAdvancedClusterOutputArgs, opts ...InvokeOption) LookupAdvancedClusterResultOutput

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

    public static class GetAdvancedCluster 
    {
        public static Task<GetAdvancedClusterResult> InvokeAsync(GetAdvancedClusterArgs args, InvokeOptions? opts = null)
        public static Output<GetAdvancedClusterResult> Invoke(GetAdvancedClusterInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAdvancedClusterResult> getAdvancedCluster(GetAdvancedClusterArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: mongodbatlas:index/getAdvancedCluster:getAdvancedCluster
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string

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

    ProjectId string

    The unique ID for the project to create the database user.

    PitEnabled bool

    Flag that indicates if the cluster uses Continuous Cloud Backup.

    Name string

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

    ProjectId string

    The unique ID for the project to create the database user.

    PitEnabled bool

    Flag that indicates if the cluster uses Continuous Cloud Backup.

    name String

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

    projectId String

    The unique ID for the project to create the database user.

    pitEnabled Boolean

    Flag that indicates if the cluster uses Continuous Cloud Backup.

    name string

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

    projectId string

    The unique ID for the project to create the database user.

    pitEnabled boolean

    Flag that indicates if the cluster uses Continuous Cloud Backup.

    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.

    pit_enabled bool

    Flag that indicates if the cluster uses Continuous Cloud Backup.

    name String

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

    projectId String

    The unique ID for the project to create the database user.

    pitEnabled Boolean

    Flag that indicates if the cluster uses Continuous Cloud Backup.

    getAdvancedCluster Result

    The following output properties are available:

    AdvancedConfigurations List<GetAdvancedClusterAdvancedConfiguration>

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

    BackupEnabled bool
    BiConnectorConfigs List<GetAdvancedClusterBiConnectorConfig>

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

    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.

    Id string

    The provider-assigned unique ID for this managed resource.

    Labels List<GetAdvancedClusterLabel>

    Configuration for the collection of key-value pairs that tag and categorize the cluster. See below.

    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.

    ProjectId string
    ReplicationSpecs List<GetAdvancedClusterReplicationSpec>

    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:

    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 []GetAdvancedClusterAdvancedConfiguration

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

    BackupEnabled bool
    BiConnectorConfigs []GetAdvancedClusterBiConnectorConfig

    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 []GetAdvancedClusterConnectionString

    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.

    Id string

    The provider-assigned unique ID for this managed resource.

    Labels []GetAdvancedClusterLabel

    Configuration for the collection of key-value pairs that tag and categorize the cluster. See below.

    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.

    ProjectId string
    ReplicationSpecs []GetAdvancedClusterReplicationSpec

    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:

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

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

    backupEnabled Boolean
    biConnectorConfigs List<GetAdvancedClusterBiConnectorConfig>

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

    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.

    id String

    The provider-assigned unique ID for this managed resource.

    labels List<GetAdvancedClusterLabel>

    Configuration for the collection of key-value pairs that tag and categorize the cluster. See below.

    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.

    projectId String
    replicationSpecs List<GetAdvancedClusterReplicationSpec>

    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:

    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 GetAdvancedClusterAdvancedConfiguration[]

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

    backupEnabled boolean
    biConnectorConfigs GetAdvancedClusterBiConnectorConfig[]

    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 GetAdvancedClusterConnectionString[]

    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.

    id string

    The provider-assigned unique ID for this managed resource.

    labels GetAdvancedClusterLabel[]

    Configuration for the collection of key-value pairs that tag and categorize the cluster. See below.

    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.

    projectId string
    replicationSpecs GetAdvancedClusterReplicationSpec[]

    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:

    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[GetAdvancedClusterAdvancedConfiguration]

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

    backup_enabled bool
    bi_connector_configs Sequence[GetAdvancedClusterBiConnectorConfig]

    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[GetAdvancedClusterConnectionString]

    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.

    id str

    The provider-assigned unique ID for this managed resource.

    labels Sequence[GetAdvancedClusterLabel]

    Configuration for the collection of key-value pairs that tag and categorize the cluster. See below.

    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.

    project_id str
    replication_specs Sequence[GetAdvancedClusterReplicationSpec]

    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:

    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.

    id String

    The provider-assigned unique ID for this managed resource.

    labels List<Property Map>

    Configuration for the collection of key-value pairs that tag and categorize the cluster. See below.

    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.

    projectId String
    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:

    terminationProtectionEnabled Boolean

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

    versionReleaseSystem String

    Release cadence that Atlas uses for this cluster.

    Supporting Types

    GetAdvancedClusterAdvancedConfiguration

    DefaultReadConcern string

    Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available.

    DefaultWriteConcern string

    Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.

    FailIndexKeyTooLong bool

    When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.

    JavascriptEnabled bool

    When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.

    MinimumEnabledTlsProtocol string

    Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:

    NoTableScan bool

    When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.

    OplogMinRetentionHours int

    Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.

    OplogSizeMb int

    The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.

    SampleRefreshIntervalBiConnector int

    Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

    SampleSizeBiConnector int

    Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

    TransactionLifetimeLimitSeconds int

    Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.

    DefaultReadConcern string

    Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available.

    DefaultWriteConcern string

    Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.

    FailIndexKeyTooLong bool

    When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.

    JavascriptEnabled bool

    When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.

    MinimumEnabledTlsProtocol string

    Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:

    NoTableScan bool

    When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.

    OplogMinRetentionHours int

    Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.

    OplogSizeMb int

    The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.

    SampleRefreshIntervalBiConnector int

    Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

    SampleSizeBiConnector int

    Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

    TransactionLifetimeLimitSeconds int

    Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.

    defaultReadConcern String

    Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available.

    defaultWriteConcern String

    Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.

    failIndexKeyTooLong Boolean

    When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.

    javascriptEnabled Boolean

    When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.

    minimumEnabledTlsProtocol String

    Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:

    noTableScan Boolean

    When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.

    oplogMinRetentionHours Integer

    Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.

    oplogSizeMb Integer

    The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.

    sampleRefreshIntervalBiConnector Integer

    Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

    sampleSizeBiConnector Integer

    Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

    transactionLifetimeLimitSeconds Integer

    Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.

    defaultReadConcern string

    Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available.

    defaultWriteConcern string

    Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.

    failIndexKeyTooLong boolean

    When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.

    javascriptEnabled boolean

    When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.

    minimumEnabledTlsProtocol string

    Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:

    noTableScan boolean

    When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.

    oplogMinRetentionHours number

    Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.

    oplogSizeMb number

    The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.

    sampleRefreshIntervalBiConnector number

    Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

    sampleSizeBiConnector number

    Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

    transactionLifetimeLimitSeconds number

    Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.

    default_read_concern str

    Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available.

    default_write_concern str

    Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.

    fail_index_key_too_long bool

    When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.

    javascript_enabled bool

    When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.

    minimum_enabled_tls_protocol str

    Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:

    no_table_scan bool

    When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.

    oplog_min_retention_hours int

    Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.

    oplog_size_mb int

    The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.

    sample_refresh_interval_bi_connector int

    Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

    sample_size_bi_connector int

    Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

    transaction_lifetime_limit_seconds int

    Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.

    defaultReadConcern String

    Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available.

    defaultWriteConcern String

    Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.

    failIndexKeyTooLong Boolean

    When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.

    javascriptEnabled Boolean

    When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.

    minimumEnabledTlsProtocol String

    Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:

    noTableScan Boolean

    When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.

    oplogMinRetentionHours Number

    Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.

    oplogSizeMb Number

    The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.

    sampleRefreshIntervalBiConnector Number

    Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

    sampleSizeBiConnector Number

    Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

    transactionLifetimeLimitSeconds Number

    Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.

    GetAdvancedClusterBiConnectorConfig

    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.

    GetAdvancedClusterConnectionString

    AwsPrivateLink Dictionary<string, object>

    Deprecated:

    this parameter is deprecated and will be removed in v1.12.0, please transition to connection_strings.private_endpoint[n].connection_string

    AwsPrivateLinkSrv Dictionary<string, object>

    Deprecated:

    this parameter is deprecated and will be removed in v1.12.0, please transition to connection_strings.private_endpoint[n].srv_connection_string

    Private string
    PrivateEndpoints List<GetAdvancedClusterConnectionStringPrivateEndpoint>
    PrivateSrv string
    Standard string
    StandardSrv string
    AwsPrivateLink map[string]interface{}

    Deprecated:

    this parameter is deprecated and will be removed in v1.12.0, please transition to connection_strings.private_endpoint[n].connection_string

    AwsPrivateLinkSrv map[string]interface{}

    Deprecated:

    this parameter is deprecated and will be removed in v1.12.0, please transition to connection_strings.private_endpoint[n].srv_connection_string

    Private string
    PrivateEndpoints []GetAdvancedClusterConnectionStringPrivateEndpoint
    PrivateSrv string
    Standard string
    StandardSrv string
    awsPrivateLink Map<String,Object>

    Deprecated:

    this parameter is deprecated and will be removed in v1.12.0, please transition to connection_strings.private_endpoint[n].connection_string

    awsPrivateLinkSrv Map<String,Object>

    Deprecated:

    this parameter is deprecated and will be removed in v1.12.0, please transition to connection_strings.private_endpoint[n].srv_connection_string

    privateEndpoints List<GetAdvancedClusterConnectionStringPrivateEndpoint>
    privateSrv String
    private_ String
    standard String
    standardSrv String
    awsPrivateLink {[key: string]: any}

    Deprecated:

    this parameter is deprecated and will be removed in v1.12.0, please transition to connection_strings.private_endpoint[n].connection_string

    awsPrivateLinkSrv {[key: string]: any}

    Deprecated:

    this parameter is deprecated and will be removed in v1.12.0, please transition to connection_strings.private_endpoint[n].srv_connection_string

    private string
    privateEndpoints GetAdvancedClusterConnectionStringPrivateEndpoint[]
    privateSrv string
    standard string
    standardSrv string
    aws_private_link Mapping[str, Any]

    Deprecated:

    this parameter is deprecated and will be removed in v1.12.0, please transition to connection_strings.private_endpoint[n].connection_string

    aws_private_link_srv Mapping[str, Any]

    Deprecated:

    this parameter is deprecated and will be removed in v1.12.0, please transition to connection_strings.private_endpoint[n].srv_connection_string

    private str
    private_endpoints Sequence[GetAdvancedClusterConnectionStringPrivateEndpoint]
    private_srv str
    standard str
    standard_srv str
    awsPrivateLink Map<Any>

    Deprecated:

    this parameter is deprecated and will be removed in v1.12.0, please transition to connection_strings.private_endpoint[n].connection_string

    awsPrivateLinkSrv Map<Any>

    Deprecated:

    this parameter is deprecated and will be removed in v1.12.0, please transition to connection_strings.private_endpoint[n].srv_connection_string

    private String
    privateEndpoints List<Property Map>
    privateSrv String
    standard String
    standardSrv String

    GetAdvancedClusterConnectionStringPrivateEndpoint

    GetAdvancedClusterConnectionStringPrivateEndpointEndpoint

    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

    GetAdvancedClusterLabel

    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.

    GetAdvancedClusterReplicationSpec

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

    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 []GetAdvancedClusterReplicationSpecRegionConfig

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

    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 GetAdvancedClusterReplicationSpecRegionConfig[]

    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[GetAdvancedClusterReplicationSpecRegionConfig]

    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.

    GetAdvancedClusterReplicationSpecRegionConfig

    AnalyticsAutoScalings List<GetAdvancedClusterReplicationSpecRegionConfigAnalyticsAutoScaling>

    Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. See below

    AutoScalings List<GetAdvancedClusterReplicationSpecRegionConfigAutoScaling>

    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 GetAdvancedClusterReplicationSpecRegionConfigAnalyticsSpecs

    Hardware specifications for analytics nodes needed in the region. See below

    ElectableSpecs GetAdvancedClusterReplicationSpecRegionConfigElectableSpecs

    Hardware specifications for electable nodes in the region.

    ReadOnlySpecs GetAdvancedClusterReplicationSpecRegionConfigReadOnlySpecs

    Hardware specifications for read-only nodes in the region. See below

    AnalyticsAutoScalings []GetAdvancedClusterReplicationSpecRegionConfigAnalyticsAutoScaling

    Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. See below

    AutoScalings []GetAdvancedClusterReplicationSpecRegionConfigAutoScaling

    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 GetAdvancedClusterReplicationSpecRegionConfigAnalyticsSpecs

    Hardware specifications for analytics nodes needed in the region. See below

    ElectableSpecs GetAdvancedClusterReplicationSpecRegionConfigElectableSpecs

    Hardware specifications for electable nodes in the region.

    ReadOnlySpecs GetAdvancedClusterReplicationSpecRegionConfigReadOnlySpecs

    Hardware specifications for read-only nodes in the region. See below

    analyticsAutoScalings List<GetAdvancedClusterReplicationSpecRegionConfigAnalyticsAutoScaling>

    Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. See below

    autoScalings List<GetAdvancedClusterReplicationSpecRegionConfigAutoScaling>

    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 GetAdvancedClusterReplicationSpecRegionConfigAnalyticsSpecs

    Hardware specifications for analytics nodes needed in the region. See below

    electableSpecs GetAdvancedClusterReplicationSpecRegionConfigElectableSpecs

    Hardware specifications for electable nodes in the region.

    readOnlySpecs GetAdvancedClusterReplicationSpecRegionConfigReadOnlySpecs

    Hardware specifications for read-only nodes in the region. See below

    analyticsAutoScalings GetAdvancedClusterReplicationSpecRegionConfigAnalyticsAutoScaling[]

    Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. See below

    autoScalings GetAdvancedClusterReplicationSpecRegionConfigAutoScaling[]

    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 GetAdvancedClusterReplicationSpecRegionConfigAnalyticsSpecs

    Hardware specifications for analytics nodes needed in the region. See below

    electableSpecs GetAdvancedClusterReplicationSpecRegionConfigElectableSpecs

    Hardware specifications for electable nodes in the region.

    readOnlySpecs GetAdvancedClusterReplicationSpecRegionConfigReadOnlySpecs

    Hardware specifications for read-only nodes in the region. See below

    analytics_auto_scalings Sequence[GetAdvancedClusterReplicationSpecRegionConfigAnalyticsAutoScaling]

    Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. See below

    auto_scalings Sequence[GetAdvancedClusterReplicationSpecRegionConfigAutoScaling]

    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 GetAdvancedClusterReplicationSpecRegionConfigAnalyticsSpecs

    Hardware specifications for analytics nodes needed in the region. See below

    electable_specs GetAdvancedClusterReplicationSpecRegionConfigElectableSpecs

    Hardware specifications for electable nodes in the region.

    read_only_specs GetAdvancedClusterReplicationSpecRegionConfigReadOnlySpecs

    Hardware specifications for read-only nodes in the region. See below

    analyticsAutoScalings List<Property Map>

    Configuration for the Collection of settings that configures analytics-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

    GetAdvancedClusterReplicationSpecRegionConfigAnalyticsAutoScaling

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

    Advanced Configuration

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

    Advanced Configuration

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

    Advanced Configuration

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

    Advanced Configuration

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

    Advanced Configuration

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

    Advanced Configuration

    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.

    GetAdvancedClusterReplicationSpecRegionConfigAnalyticsSpecs

    InstanceSize string

    Hardware specification for the instance sizes in this region.

    DiskIops int

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

    EbsVolumeType string

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

    NodeCount int

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

    InstanceSize string

    Hardware specification for the instance sizes in this region.

    DiskIops int

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

    EbsVolumeType string

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

    NodeCount int

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

    instanceSize String

    Hardware specification for the instance sizes in this region.

    diskIops Integer

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

    ebsVolumeType String

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

    nodeCount Integer

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

    instanceSize string

    Hardware specification for the instance sizes in this region.

    diskIops number

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

    ebsVolumeType string

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

    nodeCount number

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

    instance_size str

    Hardware specification for the instance sizes in this region.

    disk_iops int

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

    ebs_volume_type str

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

    node_count int

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

    instanceSize String

    Hardware specification for the instance sizes in this region.

    diskIops Number

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

    ebsVolumeType String

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

    nodeCount Number

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

    GetAdvancedClusterReplicationSpecRegionConfigAutoScaling

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

    Advanced Configuration

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

    Advanced Configuration

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

    Advanced Configuration

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

    Advanced Configuration

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

    Advanced Configuration

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

    Advanced Configuration

    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.

    GetAdvancedClusterReplicationSpecRegionConfigElectableSpecs

    InstanceSize string

    Hardware specification for the instance sizes in this region.

    DiskIops int

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

    EbsVolumeType string

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

    NodeCount int

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

    InstanceSize string

    Hardware specification for the instance sizes in this region.

    DiskIops int

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

    EbsVolumeType string

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

    NodeCount int

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

    instanceSize String

    Hardware specification for the instance sizes in this region.

    diskIops Integer

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

    ebsVolumeType String

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

    nodeCount Integer

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

    instanceSize string

    Hardware specification for the instance sizes in this region.

    diskIops number

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

    ebsVolumeType string

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

    nodeCount number

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

    instance_size str

    Hardware specification for the instance sizes in this region.

    disk_iops int

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

    ebs_volume_type str

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

    node_count int

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

    instanceSize String

    Hardware specification for the instance sizes in this region.

    diskIops Number

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

    ebsVolumeType String

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

    nodeCount Number

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

    GetAdvancedClusterReplicationSpecRegionConfigReadOnlySpecs

    InstanceSize string

    Hardware specification for the instance sizes in this region.

    DiskIops int

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

    EbsVolumeType string

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

    NodeCount int

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

    InstanceSize string

    Hardware specification for the instance sizes in this region.

    DiskIops int

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

    EbsVolumeType string

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

    NodeCount int

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

    instanceSize String

    Hardware specification for the instance sizes in this region.

    diskIops Integer

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

    ebsVolumeType String

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

    nodeCount Integer

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

    instanceSize string

    Hardware specification for the instance sizes in this region.

    diskIops number

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

    ebsVolumeType string

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

    nodeCount number

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

    instance_size str

    Hardware specification for the instance sizes in this region.

    disk_iops int

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

    ebs_volume_type str

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

    node_count int

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

    instanceSize String

    Hardware specification for the instance sizes in this region.

    diskIops Number

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

    ebsVolumeType String

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

    nodeCount Number

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

    Package Details

    Repository
    MongoDB Atlas pulumi/pulumi-mongodbatlas
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the mongodbatlas Terraform Provider.

    mongodbatlas logo
    MongoDB Atlas v3.10.1 published on Wednesday, Sep 6, 2023 by Pulumi