mongodbatlas.getAdvancedCluster
Explore with Pulumi AI
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.
- Project
Id string 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.
- Project
Id string 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.
- project
Id String The unique ID for the project to create the database user.
- pit
Enabled 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.
- project
Id string The unique ID for the project to create the database user.
- pit
Enabled 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.
- project
Id String The unique ID for the project to create the database user.
- pit
Enabled Boolean Flag that indicates if the cluster uses Continuous Cloud Backup.
getAdvancedCluster Result
The following output properties are available:
- Advanced
Configurations List<GetAdvanced Cluster Advanced Configuration> Get the advanced configuration options. See Advanced Configuration below for more details.
- Backup
Enabled bool - Bi
Connector List<GetConfigs Advanced Cluster Bi Connector Config> 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 string Type of the cluster that you want to create.
- Connection
Strings List<GetAdvanced Cluster Connection String> Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.
- Create
Date string - Disk
Size doubleGb Capacity, in gigabytes, of the host's root volume.
- Encryption
At stringRest Provider Possible values are AWS, GCP, AZURE or NONE.
- Id string
The provider-assigned unique ID for this managed resource.
- Labels
List<Get
Advanced Cluster Label> Configuration for the collection of key-value pairs that tag and categorize the cluster. See below.
- Mongo
Db stringMajor Version Version of the cluster to deploy.
- Mongo
Db stringVersion 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.
- Pit
Enabled bool Flag that indicates if the cluster uses Continuous Cloud Backup.
- Project
Id string - Replication
Specs List<GetAdvanced Cluster Replication Spec> Configuration for cluster regions and the hardware provisioned in them. See below
- Root
Cert stringType Certificate Authority that MongoDB Atlas clusters use.
- State
Name string Current state of the cluster. The possible states are:
- Termination
Protection boolEnabled Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
- Version
Release stringSystem Release cadence that Atlas uses for this cluster.
- Advanced
Configurations []GetAdvanced Cluster Advanced Configuration Get the advanced configuration options. See Advanced Configuration below for more details.
- Backup
Enabled bool - Bi
Connector []GetConfigs Advanced Cluster Bi Connector Config 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 string Type of the cluster that you want to create.
- Connection
Strings []GetAdvanced Cluster Connection String Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.
- Create
Date string - Disk
Size float64Gb Capacity, in gigabytes, of the host's root volume.
- Encryption
At stringRest Provider Possible values are AWS, GCP, AZURE or NONE.
- Id string
The provider-assigned unique ID for this managed resource.
- Labels
[]Get
Advanced Cluster Label Configuration for the collection of key-value pairs that tag and categorize the cluster. See below.
- Mongo
Db stringMajor Version Version of the cluster to deploy.
- Mongo
Db stringVersion 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.
- Pit
Enabled bool Flag that indicates if the cluster uses Continuous Cloud Backup.
- Project
Id string - Replication
Specs []GetAdvanced Cluster Replication Spec Configuration for cluster regions and the hardware provisioned in them. See below
- Root
Cert stringType Certificate Authority that MongoDB Atlas clusters use.
- State
Name string Current state of the cluster. The possible states are:
- Termination
Protection boolEnabled Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
- Version
Release stringSystem Release cadence that Atlas uses for this cluster.
- advanced
Configurations List<GetAdvanced Cluster Advanced Configuration> Get the advanced configuration options. See Advanced Configuration below for more details.
- backup
Enabled Boolean - bi
Connector List<GetConfigs Advanced Cluster Bi Connector Config> 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 String Type of the cluster that you want to create.
- connection
Strings List<GetAdvanced Cluster Connection String> Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.
- create
Date String - disk
Size DoubleGb Capacity, in gigabytes, of the host's root volume.
- encryption
At StringRest Provider Possible values are AWS, GCP, AZURE or NONE.
- id String
The provider-assigned unique ID for this managed resource.
- labels
List<Get
Advanced Cluster Label> Configuration for the collection of key-value pairs that tag and categorize the cluster. See below.
- mongo
Db StringMajor Version Version of the cluster to deploy.
- mongo
Db StringVersion 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.
- pit
Enabled Boolean Flag that indicates if the cluster uses Continuous Cloud Backup.
- project
Id String - replication
Specs List<GetAdvanced Cluster Replication Spec> Configuration for cluster regions and the hardware provisioned in them. See below
- root
Cert StringType Certificate Authority that MongoDB Atlas clusters use.
- state
Name String Current state of the cluster. The possible states are:
- termination
Protection BooleanEnabled Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
- version
Release StringSystem Release cadence that Atlas uses for this cluster.
- advanced
Configurations GetAdvanced Cluster Advanced Configuration[] Get the advanced configuration options. See Advanced Configuration below for more details.
- backup
Enabled boolean - bi
Connector GetConfigs Advanced Cluster Bi Connector Config[] 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 string Type of the cluster that you want to create.
- connection
Strings GetAdvanced Cluster Connection String[] Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.
- create
Date string - disk
Size numberGb Capacity, in gigabytes, of the host's root volume.
- encryption
At stringRest Provider Possible values are AWS, GCP, AZURE or NONE.
- id string
The provider-assigned unique ID for this managed resource.
- labels
Get
Advanced Cluster Label[] Configuration for the collection of key-value pairs that tag and categorize the cluster. See below.
- mongo
Db stringMajor Version Version of the cluster to deploy.
- mongo
Db stringVersion 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.
- pit
Enabled boolean Flag that indicates if the cluster uses Continuous Cloud Backup.
- project
Id string - replication
Specs GetAdvanced Cluster Replication Spec[] Configuration for cluster regions and the hardware provisioned in them. See below
- root
Cert stringType Certificate Authority that MongoDB Atlas clusters use.
- state
Name string Current state of the cluster. The possible states are:
- termination
Protection booleanEnabled Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
- version
Release stringSystem Release cadence that Atlas uses for this cluster.
- advanced_
configurations Sequence[GetAdvanced Cluster Advanced Configuration] Get the advanced configuration options. See Advanced Configuration below for more details.
- backup_
enabled bool - bi_
connector_ Sequence[Getconfigs Advanced Cluster Bi Connector Config] 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[GetAdvanced Cluster Connection String] Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.
- create_
date str - disk_
size_ floatgb Capacity, in gigabytes, of the host's root volume.
- encryption_
at_ strrest_ provider Possible values are AWS, GCP, AZURE or NONE.
- id str
The provider-assigned unique ID for this managed resource.
- labels
Sequence[Get
Advanced Cluster Label] Configuration for the collection of key-value pairs that tag and categorize the cluster. See below.
- mongo_
db_ strmajor_ version Version of the cluster to deploy.
- mongo_
db_ strversion 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[GetAdvanced Cluster Replication Spec] Configuration for cluster regions and the hardware provisioned in them. See below
- root_
cert_ strtype Certificate Authority that MongoDB Atlas clusters use.
- state_
name str Current state of the cluster. The possible states are:
- termination_
protection_ boolenabled Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
- version_
release_ strsystem Release cadence that Atlas uses for this cluster.
- advanced
Configurations List<Property Map> Get the advanced configuration options. See Advanced Configuration below for more details.
- backup
Enabled Boolean - bi
Connector List<Property Map>Configs 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 String Type of the cluster that you want to create.
- connection
Strings List<Property Map> Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.
- create
Date String - disk
Size NumberGb Capacity, in gigabytes, of the host's root volume.
- encryption
At StringRest Provider 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.
- mongo
Db StringMajor Version Version of the cluster to deploy.
- mongo
Db StringVersion 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.
- pit
Enabled Boolean Flag that indicates if the cluster uses Continuous Cloud Backup.
- project
Id String - replication
Specs List<Property Map> Configuration for cluster regions and the hardware provisioned in them. See below
- root
Cert StringType Certificate Authority that MongoDB Atlas clusters use.
- state
Name String Current state of the cluster. The possible states are:
- termination
Protection BooleanEnabled Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
- version
Release StringSystem Release cadence that Atlas uses for this cluster.
Supporting Types
GetAdvancedClusterAdvancedConfiguration
- Default
Read stringConcern Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available.
- Default
Write stringConcern Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.
- Fail
Index boolKey Too Long When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.
- Javascript
Enabled bool When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.
- Minimum
Enabled stringTls Protocol Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:
- No
Table boolScan When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.
- Oplog
Min intRetention Hours Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
- Oplog
Size intMb The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.
- Sample
Refresh intInterval Bi Connector Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
- Sample
Size intBi Connector Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
- Transaction
Lifetime intLimit Seconds Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.
- Default
Read stringConcern Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available.
- Default
Write stringConcern Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.
- Fail
Index boolKey Too Long When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.
- Javascript
Enabled bool When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.
- Minimum
Enabled stringTls Protocol Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:
- No
Table boolScan When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.
- Oplog
Min intRetention Hours Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
- Oplog
Size intMb The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.
- Sample
Refresh intInterval Bi Connector Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
- Sample
Size intBi Connector Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
- Transaction
Lifetime intLimit Seconds Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.
- default
Read StringConcern Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available.
- default
Write StringConcern Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.
- fail
Index BooleanKey Too Long When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.
- javascript
Enabled Boolean When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.
- minimum
Enabled StringTls Protocol Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:
- no
Table BooleanScan When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.
- oplog
Min IntegerRetention Hours Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
- oplog
Size IntegerMb The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.
- sample
Refresh IntegerInterval Bi Connector Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
- sample
Size IntegerBi Connector Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
- transaction
Lifetime IntegerLimit Seconds Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.
- default
Read stringConcern Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available.
- default
Write stringConcern Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.
- fail
Index booleanKey Too Long When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.
- javascript
Enabled boolean When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.
- minimum
Enabled stringTls Protocol Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:
- no
Table booleanScan When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.
- oplog
Min numberRetention Hours Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
- oplog
Size numberMb The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.
- sample
Refresh numberInterval Bi Connector Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
- sample
Size numberBi Connector Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
- transaction
Lifetime numberLimit Seconds Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.
- default_
read_ strconcern Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available.
- default_
write_ strconcern Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.
- fail_
index_ boolkey_ too_ long When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.
- javascript_
enabled bool When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.
- minimum_
enabled_ strtls_ protocol Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:
- no_
table_ boolscan When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.
- oplog_
min_ intretention_ hours Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
- oplog_
size_ intmb The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.
- sample_
refresh_ intinterval_ bi_ connector Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
- sample_
size_ intbi_ connector Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
- transaction_
lifetime_ intlimit_ seconds Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.
- default
Read StringConcern Default level of acknowledgment requested from MongoDB for read operations set for this cluster. MongoDB 4.4 clusters default to available.
- default
Write StringConcern Default level of acknowledgment requested from MongoDB for write operations set for this cluster. MongoDB 4.4 clusters default to 1.
- fail
Index BooleanKey Too Long When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.
- javascript
Enabled Boolean When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.
- minimum
Enabled StringTls Protocol Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:
- no
Table BooleanScan When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.
- oplog
Min NumberRetention Hours Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
- oplog
Size NumberMb The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.
- sample
Refresh NumberInterval Bi Connector Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
- sample
Size NumberBi Connector Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
- transaction
Lifetime NumberLimit Seconds Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.
GetAdvancedClusterBiConnectorConfig
- Enabled bool
Specifies whether or not BI Connector for Atlas is enabled on the cluster.l
- Read
Preference 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 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
- read
Preference 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
- read
Preference 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
- read
Preference 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
- Aws
Private Dictionary<string, object>Link this parameter is deprecated and will be removed in v1.12.0, please transition to connection_strings.private_endpoint[n].connection_string
- Aws
Private Dictionary<string, object>Link Srv 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
- Private
Endpoints List<GetAdvanced Cluster Connection String Private Endpoint> - Private
Srv string - Standard string
- Standard
Srv string
- Aws
Private map[string]interface{}Link this parameter is deprecated and will be removed in v1.12.0, please transition to connection_strings.private_endpoint[n].connection_string
- Aws
Private map[string]interface{}Link Srv 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
- Private
Endpoints []GetAdvanced Cluster Connection String Private Endpoint - Private
Srv string - Standard string
- Standard
Srv string
- aws
Private Map<String,Object>Link this parameter is deprecated and will be removed in v1.12.0, please transition to connection_strings.private_endpoint[n].connection_string
- aws
Private Map<String,Object>Link Srv this parameter is deprecated and will be removed in v1.12.0, please transition to connection_strings.private_endpoint[n].srv_connection_string
- private
Endpoints List<GetAdvanced Cluster Connection String Private Endpoint> - private
Srv String - private_ String
- standard String
- standard
Srv String
- aws
Private {[key: string]: any}Link this parameter is deprecated and will be removed in v1.12.0, please transition to connection_strings.private_endpoint[n].connection_string
- aws
Private {[key: string]: any}Link Srv 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
- private
Endpoints GetAdvanced Cluster Connection String Private Endpoint[] - private
Srv string - standard string
- standard
Srv string
- aws_
private_ Mapping[str, Any]link this parameter is deprecated and will be removed in v1.12.0, please transition to connection_strings.private_endpoint[n].connection_string
- aws_
private_ Mapping[str, Any]link_ srv 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[GetAdvanced Cluster Connection String Private Endpoint] - private_
srv str - standard str
- standard_
srv str
- aws
Private Map<Any>Link this parameter is deprecated and will be removed in v1.12.0, please transition to connection_strings.private_endpoint[n].connection_string
- aws
Private Map<Any>Link Srv 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
- private
Endpoints List<Property Map> - private
Srv String - standard String
- standard
Srv String
GetAdvancedClusterConnectionStringPrivateEndpoint
- connection
String String - endpoints List<Property Map>
- srv
Connection StringString - srv
Shard StringOptimized Connection String - type String
GetAdvancedClusterConnectionStringPrivateEndpointEndpoint
- Endpoint
Id string - Provider
Name string Cloud service provider on which the servers are provisioned.
- Region string
- Endpoint
Id string - Provider
Name string Cloud service provider on which the servers are provisioned.
- Region string
- endpoint
Id String - provider
Name String Cloud service provider on which the servers are provisioned.
- region String
- endpoint
Id string - provider
Name 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
- endpoint
Id String - provider
Name String Cloud service provider on which the servers are provisioned.
- region String
GetAdvancedClusterLabel
GetAdvancedClusterReplicationSpec
- Container
Id 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"
. ExampleAWS:US_EAST_1" = "61e0797dde08fb498ca11a71
.- Id string
- Num
Shards int Provide this value if you set a
cluster_type
of SHARDED or GEOSHARDED.- Region
Configs List<GetAdvanced Cluster Replication Spec Region Config> 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. Eachregion_configs
object must have either ananalytics_specs
object,electable_specs
object, orread_only_specs
object. See below- Zone
Name string Name for the zone in a Global Cluster.
- Container
Id 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"
. ExampleAWS:US_EAST_1" = "61e0797dde08fb498ca11a71
.- Id string
- Num
Shards int Provide this value if you set a
cluster_type
of SHARDED or GEOSHARDED.- Region
Configs []GetAdvanced Cluster Replication Spec Region Config 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. Eachregion_configs
object must have either ananalytics_specs
object,electable_specs
object, orread_only_specs
object. See below- Zone
Name string Name for the zone in a Global Cluster.
- container
Id 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"
. ExampleAWS:US_EAST_1" = "61e0797dde08fb498ca11a71
.- id String
- num
Shards Integer Provide this value if you set a
cluster_type
of SHARDED or GEOSHARDED.- region
Configs List<GetAdvanced Cluster Replication Spec Region Config> 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. Eachregion_configs
object must have either ananalytics_specs
object,electable_specs
object, orread_only_specs
object. See below- zone
Name String Name for the zone in a Global Cluster.
- container
Id {[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"
. ExampleAWS:US_EAST_1" = "61e0797dde08fb498ca11a71
.- id string
- num
Shards number Provide this value if you set a
cluster_type
of SHARDED or GEOSHARDED.- region
Configs GetAdvanced Cluster Replication Spec Region Config[] 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. Eachregion_configs
object must have either ananalytics_specs
object,electable_specs
object, orread_only_specs
object. See below- zone
Name 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"
. ExampleAWS: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[GetAdvanced Cluster Replication Spec Region Config] 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. Eachregion_configs
object must have either ananalytics_specs
object,electable_specs
object, orread_only_specs
object. See below- zone_
name str Name for the zone in a Global Cluster.
- container
Id 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"
. ExampleAWS:US_EAST_1" = "61e0797dde08fb498ca11a71
.- id String
- num
Shards Number Provide this value if you set a
cluster_type
of SHARDED or GEOSHARDED.- region
Configs 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. Eachregion_configs
object must have either ananalytics_specs
object,electable_specs
object, orread_only_specs
object. See below- zone
Name String Name for the zone in a Global Cluster.
GetAdvancedClusterReplicationSpecRegionConfig
- Analytics
Auto List<GetScalings Advanced Cluster Replication Spec Region Config Analytics Auto Scaling> Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. See below
- Auto
Scalings List<GetAdvanced Cluster Replication Spec Region Config Auto Scaling> Configuration for the Collection of settings that configures auto-scaling information for the cluster. See below
- Backing
Provider stringName Cloud service provider on which you provision the host for a multi-tenant cluster.
- Priority int
Election priority of the region.
- Provider
Name string Cloud service provider on which the servers are provisioned.
- Region
Name string Physical location of your MongoDB cluster.
- Analytics
Specs GetAdvanced Cluster Replication Spec Region Config Analytics Specs Hardware specifications for analytics nodes needed in the region. See below
- Electable
Specs GetAdvanced Cluster Replication Spec Region Config Electable Specs Hardware specifications for electable nodes in the region.
- Read
Only GetSpecs Advanced Cluster Replication Spec Region Config Read Only Specs Hardware specifications for read-only nodes in the region. See below
- Analytics
Auto []GetScalings Advanced Cluster Replication Spec Region Config Analytics Auto Scaling Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. See below
- Auto
Scalings []GetAdvanced Cluster Replication Spec Region Config Auto Scaling Configuration for the Collection of settings that configures auto-scaling information for the cluster. See below
- Backing
Provider stringName Cloud service provider on which you provision the host for a multi-tenant cluster.
- Priority int
Election priority of the region.
- Provider
Name string Cloud service provider on which the servers are provisioned.
- Region
Name string Physical location of your MongoDB cluster.
- Analytics
Specs GetAdvanced Cluster Replication Spec Region Config Analytics Specs Hardware specifications for analytics nodes needed in the region. See below
- Electable
Specs GetAdvanced Cluster Replication Spec Region Config Electable Specs Hardware specifications for electable nodes in the region.
- Read
Only GetSpecs Advanced Cluster Replication Spec Region Config Read Only Specs Hardware specifications for read-only nodes in the region. See below
- analytics
Auto List<GetScalings Advanced Cluster Replication Spec Region Config Analytics Auto Scaling> Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. See below
- auto
Scalings List<GetAdvanced Cluster Replication Spec Region Config Auto Scaling> Configuration for the Collection of settings that configures auto-scaling information for the cluster. See below
- backing
Provider StringName Cloud service provider on which you provision the host for a multi-tenant cluster.
- priority Integer
Election priority of the region.
- provider
Name String Cloud service provider on which the servers are provisioned.
- region
Name String Physical location of your MongoDB cluster.
- analytics
Specs GetAdvanced Cluster Replication Spec Region Config Analytics Specs Hardware specifications for analytics nodes needed in the region. See below
- electable
Specs GetAdvanced Cluster Replication Spec Region Config Electable Specs Hardware specifications for electable nodes in the region.
- read
Only GetSpecs Advanced Cluster Replication Spec Region Config Read Only Specs Hardware specifications for read-only nodes in the region. See below
- analytics
Auto GetScalings Advanced Cluster Replication Spec Region Config Analytics Auto Scaling[] Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. See below
- auto
Scalings GetAdvanced Cluster Replication Spec Region Config Auto Scaling[] Configuration for the Collection of settings that configures auto-scaling information for the cluster. See below
- backing
Provider stringName Cloud service provider on which you provision the host for a multi-tenant cluster.
- priority number
Election priority of the region.
- provider
Name string Cloud service provider on which the servers are provisioned.
- region
Name string Physical location of your MongoDB cluster.
- analytics
Specs GetAdvanced Cluster Replication Spec Region Config Analytics Specs Hardware specifications for analytics nodes needed in the region. See below
- electable
Specs GetAdvanced Cluster Replication Spec Region Config Electable Specs Hardware specifications for electable nodes in the region.
- read
Only GetSpecs Advanced Cluster Replication Spec Region Config Read Only Specs Hardware specifications for read-only nodes in the region. See below
- analytics_
auto_ Sequence[Getscalings Advanced Cluster Replication Spec Region Config Analytics Auto Scaling] Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. See below
- auto_
scalings Sequence[GetAdvanced Cluster Replication Spec Region Config Auto Scaling] Configuration for the Collection of settings that configures auto-scaling information for the cluster. See below
- backing_
provider_ strname 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 GetAdvanced Cluster Replication Spec Region Config Analytics Specs Hardware specifications for analytics nodes needed in the region. See below
- electable_
specs GetAdvanced Cluster Replication Spec Region Config Electable Specs Hardware specifications for electable nodes in the region.
- read_
only_ Getspecs Advanced Cluster Replication Spec Region Config Read Only Specs Hardware specifications for read-only nodes in the region. See below
- analytics
Auto List<Property Map>Scalings Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. See below
- auto
Scalings List<Property Map> Configuration for the Collection of settings that configures auto-scaling information for the cluster. See below
- backing
Provider StringName Cloud service provider on which you provision the host for a multi-tenant cluster.
- priority Number
Election priority of the region.
- provider
Name String Cloud service provider on which the servers are provisioned.
- region
Name String Physical location of your MongoDB cluster.
- analytics
Specs Property Map Hardware specifications for analytics nodes needed in the region. See below
- electable
Specs Property Map Hardware specifications for electable nodes in the region.
- read
Only Property MapSpecs Hardware specifications for read-only nodes in the region. See below
GetAdvancedClusterReplicationSpecRegionConfigAnalyticsAutoScaling
- Compute
Enabled bool Flag that indicates whether instance size auto-scaling is enabled.
- Compute
Max stringInstance Size Maximum instance size to which your cluster can automatically scale (such as M40).
Advanced Configuration
- Compute
Min stringInstance Size Minimum instance size to which your cluster can automatically scale (such as M10).
- Compute
Scale boolDown Enabled Flag that indicates whether the instance size may scale down.
- Disk
Gb boolEnabled 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 stringInstance Size Maximum instance size to which your cluster can automatically scale (such as M40).
Advanced Configuration
- Compute
Min stringInstance Size Minimum instance size to which your cluster can automatically scale (such as M10).
- Compute
Scale boolDown Enabled Flag that indicates whether the instance size may scale down.
- Disk
Gb boolEnabled Flag that indicates whether this cluster enables disk auto-scaling.
- compute
Enabled Boolean Flag that indicates whether instance size auto-scaling is enabled.
- compute
Max StringInstance Size Maximum instance size to which your cluster can automatically scale (such as M40).
Advanced Configuration
- compute
Min StringInstance Size Minimum instance size to which your cluster can automatically scale (such as M10).
- compute
Scale BooleanDown Enabled Flag that indicates whether the instance size may scale down.
- disk
Gb BooleanEnabled Flag that indicates whether this cluster enables disk auto-scaling.
- compute
Enabled boolean Flag that indicates whether instance size auto-scaling is enabled.
- compute
Max stringInstance Size Maximum instance size to which your cluster can automatically scale (such as M40).
Advanced Configuration
- compute
Min stringInstance Size Minimum instance size to which your cluster can automatically scale (such as M10).
- compute
Scale booleanDown Enabled Flag that indicates whether the instance size may scale down.
- disk
Gb booleanEnabled 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_ strinstance_ size Maximum instance size to which your cluster can automatically scale (such as M40).
Advanced Configuration
- compute_
min_ strinstance_ size Minimum instance size to which your cluster can automatically scale (such as M10).
- compute_
scale_ booldown_ enabled Flag that indicates whether the instance size may scale down.
- disk_
gb_ boolenabled Flag that indicates whether this cluster enables disk auto-scaling.
- compute
Enabled Boolean Flag that indicates whether instance size auto-scaling is enabled.
- compute
Max StringInstance Size Maximum instance size to which your cluster can automatically scale (such as M40).
Advanced Configuration
- compute
Min StringInstance Size Minimum instance size to which your cluster can automatically scale (such as M10).
- compute
Scale BooleanDown Enabled Flag that indicates whether the instance size may scale down.
- disk
Gb BooleanEnabled Flag that indicates whether this cluster enables disk auto-scaling.
GetAdvancedClusterReplicationSpecRegionConfigAnalyticsSpecs
- Instance
Size string 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 stringType 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.
- Instance
Size string 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 stringType 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.
- instance
Size String Hardware specification for the instance sizes in this region.
- disk
Iops Integer Target throughput (IOPS) desired for AWS storage attached to your cluster.
- ebs
Volume StringType Type of storage you want to attach to your AWS-provisioned cluster.
- node
Count Integer Number of nodes of the given type for MongoDB Atlas to deploy to the region.
- instance
Size string Hardware specification for the instance sizes in this region.
- disk
Iops number Target throughput (IOPS) desired for AWS storage attached to your cluster.
- ebs
Volume stringType Type of storage you want to attach to your AWS-provisioned cluster.
- node
Count 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_ strtype 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.
- instance
Size String Hardware specification for the instance sizes in this region.
- disk
Iops Number Target throughput (IOPS) desired for AWS storage attached to your cluster.
- ebs
Volume StringType Type of storage you want to attach to your AWS-provisioned cluster.
- node
Count Number Number of nodes of the given type for MongoDB Atlas to deploy to the region.
GetAdvancedClusterReplicationSpecRegionConfigAutoScaling
- Compute
Enabled bool Flag that indicates whether instance size auto-scaling is enabled.
- Compute
Max stringInstance Size Maximum instance size to which your cluster can automatically scale (such as M40).
Advanced Configuration
- Compute
Min stringInstance Size Minimum instance size to which your cluster can automatically scale (such as M10).
- Compute
Scale boolDown Enabled Flag that indicates whether the instance size may scale down.
- Disk
Gb boolEnabled 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 stringInstance Size Maximum instance size to which your cluster can automatically scale (such as M40).
Advanced Configuration
- Compute
Min stringInstance Size Minimum instance size to which your cluster can automatically scale (such as M10).
- Compute
Scale boolDown Enabled Flag that indicates whether the instance size may scale down.
- Disk
Gb boolEnabled Flag that indicates whether this cluster enables disk auto-scaling.
- compute
Enabled Boolean Flag that indicates whether instance size auto-scaling is enabled.
- compute
Max StringInstance Size Maximum instance size to which your cluster can automatically scale (such as M40).
Advanced Configuration
- compute
Min StringInstance Size Minimum instance size to which your cluster can automatically scale (such as M10).
- compute
Scale BooleanDown Enabled Flag that indicates whether the instance size may scale down.
- disk
Gb BooleanEnabled Flag that indicates whether this cluster enables disk auto-scaling.
- compute
Enabled boolean Flag that indicates whether instance size auto-scaling is enabled.
- compute
Max stringInstance Size Maximum instance size to which your cluster can automatically scale (such as M40).
Advanced Configuration
- compute
Min stringInstance Size Minimum instance size to which your cluster can automatically scale (such as M10).
- compute
Scale booleanDown Enabled Flag that indicates whether the instance size may scale down.
- disk
Gb booleanEnabled 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_ strinstance_ size Maximum instance size to which your cluster can automatically scale (such as M40).
Advanced Configuration
- compute_
min_ strinstance_ size Minimum instance size to which your cluster can automatically scale (such as M10).
- compute_
scale_ booldown_ enabled Flag that indicates whether the instance size may scale down.
- disk_
gb_ boolenabled Flag that indicates whether this cluster enables disk auto-scaling.
- compute
Enabled Boolean Flag that indicates whether instance size auto-scaling is enabled.
- compute
Max StringInstance Size Maximum instance size to which your cluster can automatically scale (such as M40).
Advanced Configuration
- compute
Min StringInstance Size Minimum instance size to which your cluster can automatically scale (such as M10).
- compute
Scale BooleanDown Enabled Flag that indicates whether the instance size may scale down.
- disk
Gb BooleanEnabled Flag that indicates whether this cluster enables disk auto-scaling.
GetAdvancedClusterReplicationSpecRegionConfigElectableSpecs
- Instance
Size string 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 stringType 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.
- Instance
Size string 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 stringType 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.
- instance
Size String Hardware specification for the instance sizes in this region.
- disk
Iops Integer Target throughput (IOPS) desired for AWS storage attached to your cluster.
- ebs
Volume StringType Type of storage you want to attach to your AWS-provisioned cluster.
- node
Count Integer Number of nodes of the given type for MongoDB Atlas to deploy to the region.
- instance
Size string Hardware specification for the instance sizes in this region.
- disk
Iops number Target throughput (IOPS) desired for AWS storage attached to your cluster.
- ebs
Volume stringType Type of storage you want to attach to your AWS-provisioned cluster.
- node
Count 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_ strtype 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.
- instance
Size String Hardware specification for the instance sizes in this region.
- disk
Iops Number Target throughput (IOPS) desired for AWS storage attached to your cluster.
- ebs
Volume StringType Type of storage you want to attach to your AWS-provisioned cluster.
- node
Count Number Number of nodes of the given type for MongoDB Atlas to deploy to the region.
GetAdvancedClusterReplicationSpecRegionConfigReadOnlySpecs
- Instance
Size string 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 stringType 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.
- Instance
Size string 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 stringType 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.
- instance
Size String Hardware specification for the instance sizes in this region.
- disk
Iops Integer Target throughput (IOPS) desired for AWS storage attached to your cluster.
- ebs
Volume StringType Type of storage you want to attach to your AWS-provisioned cluster.
- node
Count Integer Number of nodes of the given type for MongoDB Atlas to deploy to the region.
- instance
Size string Hardware specification for the instance sizes in this region.
- disk
Iops number Target throughput (IOPS) desired for AWS storage attached to your cluster.
- ebs
Volume stringType Type of storage you want to attach to your AWS-provisioned cluster.
- node
Count 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_ strtype 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.
- instance
Size String Hardware specification for the instance sizes in this region.
- disk
Iops Number Target throughput (IOPS) desired for AWS storage attached to your cluster.
- ebs
Volume StringType Type of storage you want to attach to your AWS-provisioned cluster.
- node
Count 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.