MongoDB Atlas v3.7.2, Mar 31 23
MongoDB Atlas v3.7.2, Mar 31 23
mongodbatlas.Cluster
Explore with Pulumi AI
Import
Clusters can be imported using project ID and cluster name, in the format PROJECTID-CLUSTERNAME
, e.g.
$ pulumi import mongodbatlas:index/cluster:Cluster my_cluster 1112222b3bf99403840e8934-Cluster0
See detailed information for arguments and attributesMongoDB API Clusters
Create Cluster Resource
new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
@overload
def Cluster(resource_name: str,
opts: Optional[ResourceOptions] = None,
advanced_configuration: Optional[ClusterAdvancedConfigurationArgs] = None,
auto_scaling_compute_enabled: Optional[bool] = None,
auto_scaling_compute_scale_down_enabled: Optional[bool] = None,
auto_scaling_disk_gb_enabled: Optional[bool] = None,
backing_provider_name: Optional[str] = None,
backup_enabled: Optional[bool] = None,
bi_connector: Optional[Mapping[str, str]] = None,
bi_connector_config: Optional[ClusterBiConnectorConfigArgs] = None,
cloud_backup: Optional[bool] = None,
cluster_type: Optional[str] = None,
disk_size_gb: Optional[float] = None,
encryption_at_rest_provider: Optional[str] = None,
labels: Optional[Sequence[ClusterLabelArgs]] = None,
mongo_db_major_version: Optional[str] = None,
name: Optional[str] = None,
num_shards: Optional[int] = None,
paused: Optional[bool] = None,
pit_enabled: Optional[bool] = None,
project_id: Optional[str] = None,
provider_auto_scaling_compute_max_instance_size: Optional[str] = None,
provider_auto_scaling_compute_min_instance_size: Optional[str] = None,
provider_backup_enabled: Optional[bool] = None,
provider_disk_iops: Optional[int] = None,
provider_disk_type_name: Optional[str] = None,
provider_encrypt_ebs_volume: Optional[bool] = None,
provider_instance_size_name: Optional[str] = None,
provider_name: Optional[str] = None,
provider_region_name: Optional[str] = None,
provider_volume_type: Optional[str] = None,
replication_factor: Optional[int] = None,
replication_specs: Optional[Sequence[ClusterReplicationSpecArgs]] = None,
termination_protection_enabled: Optional[bool] = None,
version_release_system: Optional[str] = None)
@overload
def Cluster(resource_name: str,
args: ClusterArgs,
opts: Optional[ResourceOptions] = None)
func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)
public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)
public Cluster(String name, ClusterArgs args)
public Cluster(String name, ClusterArgs args, CustomResourceOptions options)
type: mongodbatlas:Cluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ClusterArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ClusterArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ClusterArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ClusterArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ClusterArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Cluster Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Cluster resource accepts the following input properties:
- Project
Id string The unique ID for the project to create the database user.
- Provider
Instance stringSize Name Atlas provides different instance sizes, each with a default storage capacity and RAM size. The instance size you select is used for all the data-bearing servers in your cluster. See Create a Cluster
providerSettings.instanceSizeName
for valid values and default resources.- Provider
Name string Cloud service provider on which the servers are provisioned.
- Advanced
Configuration ClusterAdvanced Configuration Args - Auto
Scaling boolCompute Enabled Specifies whether cluster tier auto-scaling is enabled. The default is false.
- Set to
true
to enable cluster tier auto-scaling. If enabled, you must specify a value forproviderSettings.autoScaling.compute.maxInstanceSize
. - Set to
false
to disable cluster tier auto-scaling.
- Set to
- Auto
Scaling boolCompute Scale Down Enabled Set to
true
to enable the cluster tier to scale down. This option is only available ifautoScaling.compute.enabled
istrue
.- If this option is enabled, you must specify a value for
providerSettings.autoScaling.compute.minInstanceSize
- If this option is enabled, you must specify a value for
- Auto
Scaling boolDisk Gb Enabled Specifies whether disk auto-scaling is enabled. The default is true.
- Set to
true
to enable disk auto-scaling. - Set to
false
to disable disk auto-scaling.
- Set to
- Backing
Provider stringName Cloud service provider on which the server for a multi-tenant cluster is provisioned.
- Backup
Enabled bool Clusters running MongoDB FCV 4.2 or later and any new Atlas clusters of any type do not support this parameter
- Bi
Connector Dictionary<string, string> Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details. DEPRECATED Use
bi_connector_config
instead.use bi_connector_config instead
- Bi
Connector ClusterConfig Bi Connector Config Args Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details.
- Cloud
Backup bool Flag indicating if the cluster uses Cloud Backup for backups.
- Cluster
Type string Specifies the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.
- Disk
Size doubleGb Capacity, in gigabytes, of the host’s root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive integer.
- The minimum disk size for dedicated clusters is 10GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value.
- Note: The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require additional storage space beyond this limitation, consider upgrading your cluster to a higher tier.
- Cannot be used with clusters with local NVMe SSDs
- Cannot be used with Azure clusters
- Encryption
At stringRest Provider Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For complete documentation on configuring Encryption at Rest, see Encryption at Rest using Customer Key Management. Requires M10 or greater. and for legacy backups, backup_enabled, to be false or omitted. Note: Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default.
- Labels
List<Cluster
Label Args> - Mongo
Db stringMajor Version Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters:
4.2
,4.4
,5.0
, or6.0
. If omitted, Atlas deploys a cluster that runs MongoDB 5.0. Ifprovider_instance_size_name
:M0
,M2
orM5
, Atlas deploys MongoDB 5.0. Atlas always deploys the cluster with the latest stable release of the specified version. See Release Notes for latest Current Stable Release.- Name string
Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed. WARNING Changing the name will result in destruction of the existing cluster and the creation of a new cluster.
- Num
Shards int Selects whether the cluster is a replica set or a sharded cluster. If you use the replicationSpecs parameter, you must set num_shards.
- Paused bool
- Pit
Enabled bool Flag that indicates if the cluster uses Continuous Cloud Backup. If set to true, cloud_backup must also be set to true.
- Provider
Auto stringScaling Compute Max Instance Size Maximum instance size to which your cluster can automatically scale (e.g., M40). Required if
autoScaling.compute.enabled
istrue
.- Provider
Auto stringScaling Compute Min Instance Size Minimum instance size to which your cluster can automatically scale (e.g., M10). Required if
autoScaling.compute.scaleDownEnabled
istrue
.- Provider
Backup boolEnabled Flag indicating if the cluster uses Cloud Backup for backups. Deprecated use
cloud_backup
instead.This field is deprecated,please use cloud_backup instead
- Provider
Disk intIops The maximum input/output operations per second (IOPS) the system can perform. The possible values depend on the selected
provider_instance_size_name
anddisk_size_gb
. This setting requires thatprovider_instance_size_name
to be M30 or greater and cannot be used with clusters with local NVMe SSDs. The default value forprovider_disk_iops
is the same as the cluster tier's Standard IOPS value, as viewable in the Atlas console. It is used in cases where a higher number of IOPS is needed and possible. If a value is submitted that is lower or equal to the default IOPS value for the cluster tier Atlas ignores the requested value and uses the default. More details available under the providerSettings.diskIOPS parameter: MongoDB API Clusters- You do not need to configure IOPS for a STANDARD disk configuration but only for a PROVISIONED configuration.
- Provider
Disk stringType Name Azure disk type of the server’s root volume. If omitted, Atlas uses the default disk type for the selected providerSettings.instanceSizeName. Example disk types and associated storage sizes: P4 - 32GB, P6 - 64GB, P10 - 128GB, P15 - 256GB, P20 - 512GB, P30 - 1024GB, P40 - 2048GB, P50 - 4095GB. More information and the most update to date disk types/storage sizes can be located at https://docs.atlas.mongodb.com/reference/api/clusters-create-one/.
- Provider
Encrypt boolEbs Volume (Deprecated) The Flag is always true. Flag that indicates whether the Amazon EBS encryption feature encrypts the host's root volume for both data at rest within the volume and for data moving between the volume and the cluster. Note: This setting is always enabled for clusters with local NVMe SSDs. Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default..
All EBS volumes are encrypted by default, the option to disable encryption has been removed
- Provider
Region stringName Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas region name, see the reference list for AWS, GCP, Azure. Do not specify this field when creating a multi-region cluster using the replicationSpec document or a Global Cluster with the replicationSpecs array.
- Provider
Volume stringType The type of the volume. The possible values are:
STANDARD
andPROVISIONED
.PROVISIONED
is ONLY required if setting IOPS higher than the default instance IOPS.- Replication
Factor int Number of replica set members. Each member keeps a copy of your databases, providing high availability and data redundancy. The possible values are 3, 5, or 7. The default value is 3.
- Replication
Specs List<ClusterReplication Spec Args> Configuration for cluster regions. See Replication Spec below for more details.
- 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. This parameter defaults to
LTS
. If you set this field toCONTINUOUS
, you must omit themongo_db_major_version
field. Atlas accepts:
- Project
Id string The unique ID for the project to create the database user.
- Provider
Instance stringSize Name Atlas provides different instance sizes, each with a default storage capacity and RAM size. The instance size you select is used for all the data-bearing servers in your cluster. See Create a Cluster
providerSettings.instanceSizeName
for valid values and default resources.- Provider
Name string Cloud service provider on which the servers are provisioned.
- Advanced
Configuration ClusterAdvanced Configuration Args - Auto
Scaling boolCompute Enabled Specifies whether cluster tier auto-scaling is enabled. The default is false.
- Set to
true
to enable cluster tier auto-scaling. If enabled, you must specify a value forproviderSettings.autoScaling.compute.maxInstanceSize
. - Set to
false
to disable cluster tier auto-scaling.
- Set to
- Auto
Scaling boolCompute Scale Down Enabled Set to
true
to enable the cluster tier to scale down. This option is only available ifautoScaling.compute.enabled
istrue
.- If this option is enabled, you must specify a value for
providerSettings.autoScaling.compute.minInstanceSize
- If this option is enabled, you must specify a value for
- Auto
Scaling boolDisk Gb Enabled Specifies whether disk auto-scaling is enabled. The default is true.
- Set to
true
to enable disk auto-scaling. - Set to
false
to disable disk auto-scaling.
- Set to
- Backing
Provider stringName Cloud service provider on which the server for a multi-tenant cluster is provisioned.
- Backup
Enabled bool Clusters running MongoDB FCV 4.2 or later and any new Atlas clusters of any type do not support this parameter
- Bi
Connector map[string]string Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details. DEPRECATED Use
bi_connector_config
instead.use bi_connector_config instead
- Bi
Connector ClusterConfig Bi Connector Config Args Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details.
- Cloud
Backup bool Flag indicating if the cluster uses Cloud Backup for backups.
- Cluster
Type string Specifies the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.
- Disk
Size float64Gb Capacity, in gigabytes, of the host’s root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive integer.
- The minimum disk size for dedicated clusters is 10GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value.
- Note: The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require additional storage space beyond this limitation, consider upgrading your cluster to a higher tier.
- Cannot be used with clusters with local NVMe SSDs
- Cannot be used with Azure clusters
- Encryption
At stringRest Provider Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For complete documentation on configuring Encryption at Rest, see Encryption at Rest using Customer Key Management. Requires M10 or greater. and for legacy backups, backup_enabled, to be false or omitted. Note: Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default.
- Labels
[]Cluster
Label Args - Mongo
Db stringMajor Version Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters:
4.2
,4.4
,5.0
, or6.0
. If omitted, Atlas deploys a cluster that runs MongoDB 5.0. Ifprovider_instance_size_name
:M0
,M2
orM5
, Atlas deploys MongoDB 5.0. Atlas always deploys the cluster with the latest stable release of the specified version. See Release Notes for latest Current Stable Release.- Name string
Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed. WARNING Changing the name will result in destruction of the existing cluster and the creation of a new cluster.
- Num
Shards int Selects whether the cluster is a replica set or a sharded cluster. If you use the replicationSpecs parameter, you must set num_shards.
- Paused bool
- Pit
Enabled bool Flag that indicates if the cluster uses Continuous Cloud Backup. If set to true, cloud_backup must also be set to true.
- Provider
Auto stringScaling Compute Max Instance Size Maximum instance size to which your cluster can automatically scale (e.g., M40). Required if
autoScaling.compute.enabled
istrue
.- Provider
Auto stringScaling Compute Min Instance Size Minimum instance size to which your cluster can automatically scale (e.g., M10). Required if
autoScaling.compute.scaleDownEnabled
istrue
.- Provider
Backup boolEnabled Flag indicating if the cluster uses Cloud Backup for backups. Deprecated use
cloud_backup
instead.This field is deprecated,please use cloud_backup instead
- Provider
Disk intIops The maximum input/output operations per second (IOPS) the system can perform. The possible values depend on the selected
provider_instance_size_name
anddisk_size_gb
. This setting requires thatprovider_instance_size_name
to be M30 or greater and cannot be used with clusters with local NVMe SSDs. The default value forprovider_disk_iops
is the same as the cluster tier's Standard IOPS value, as viewable in the Atlas console. It is used in cases where a higher number of IOPS is needed and possible. If a value is submitted that is lower or equal to the default IOPS value for the cluster tier Atlas ignores the requested value and uses the default. More details available under the providerSettings.diskIOPS parameter: MongoDB API Clusters- You do not need to configure IOPS for a STANDARD disk configuration but only for a PROVISIONED configuration.
- Provider
Disk stringType Name Azure disk type of the server’s root volume. If omitted, Atlas uses the default disk type for the selected providerSettings.instanceSizeName. Example disk types and associated storage sizes: P4 - 32GB, P6 - 64GB, P10 - 128GB, P15 - 256GB, P20 - 512GB, P30 - 1024GB, P40 - 2048GB, P50 - 4095GB. More information and the most update to date disk types/storage sizes can be located at https://docs.atlas.mongodb.com/reference/api/clusters-create-one/.
- Provider
Encrypt boolEbs Volume (Deprecated) The Flag is always true. Flag that indicates whether the Amazon EBS encryption feature encrypts the host's root volume for both data at rest within the volume and for data moving between the volume and the cluster. Note: This setting is always enabled for clusters with local NVMe SSDs. Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default..
All EBS volumes are encrypted by default, the option to disable encryption has been removed
- Provider
Region stringName Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas region name, see the reference list for AWS, GCP, Azure. Do not specify this field when creating a multi-region cluster using the replicationSpec document or a Global Cluster with the replicationSpecs array.
- Provider
Volume stringType The type of the volume. The possible values are:
STANDARD
andPROVISIONED
.PROVISIONED
is ONLY required if setting IOPS higher than the default instance IOPS.- Replication
Factor int Number of replica set members. Each member keeps a copy of your databases, providing high availability and data redundancy. The possible values are 3, 5, or 7. The default value is 3.
- Replication
Specs []ClusterReplication Spec Args Configuration for cluster regions. See Replication Spec below for more details.
- 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. This parameter defaults to
LTS
. If you set this field toCONTINUOUS
, you must omit themongo_db_major_version
field. Atlas accepts:
- project
Id String The unique ID for the project to create the database user.
- provider
Instance StringSize Name Atlas provides different instance sizes, each with a default storage capacity and RAM size. The instance size you select is used for all the data-bearing servers in your cluster. See Create a Cluster
providerSettings.instanceSizeName
for valid values and default resources.- provider
Name String Cloud service provider on which the servers are provisioned.
- advanced
Configuration ClusterAdvanced Configuration Args - auto
Scaling BooleanCompute Enabled Specifies whether cluster tier auto-scaling is enabled. The default is false.
- Set to
true
to enable cluster tier auto-scaling. If enabled, you must specify a value forproviderSettings.autoScaling.compute.maxInstanceSize
. - Set to
false
to disable cluster tier auto-scaling.
- Set to
- auto
Scaling BooleanCompute Scale Down Enabled Set to
true
to enable the cluster tier to scale down. This option is only available ifautoScaling.compute.enabled
istrue
.- If this option is enabled, you must specify a value for
providerSettings.autoScaling.compute.minInstanceSize
- If this option is enabled, you must specify a value for
- auto
Scaling BooleanDisk Gb Enabled Specifies whether disk auto-scaling is enabled. The default is true.
- Set to
true
to enable disk auto-scaling. - Set to
false
to disable disk auto-scaling.
- Set to
- backing
Provider StringName Cloud service provider on which the server for a multi-tenant cluster is provisioned.
- backup
Enabled Boolean Clusters running MongoDB FCV 4.2 or later and any new Atlas clusters of any type do not support this parameter
- bi
Connector Map<String,String> Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details. DEPRECATED Use
bi_connector_config
instead.use bi_connector_config instead
- bi
Connector ClusterConfig Bi Connector Config Args Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details.
- cloud
Backup Boolean Flag indicating if the cluster uses Cloud Backup for backups.
- cluster
Type String Specifies the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.
- disk
Size DoubleGb Capacity, in gigabytes, of the host’s root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive integer.
- The minimum disk size for dedicated clusters is 10GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value.
- Note: The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require additional storage space beyond this limitation, consider upgrading your cluster to a higher tier.
- Cannot be used with clusters with local NVMe SSDs
- Cannot be used with Azure clusters
- encryption
At StringRest Provider Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For complete documentation on configuring Encryption at Rest, see Encryption at Rest using Customer Key Management. Requires M10 or greater. and for legacy backups, backup_enabled, to be false or omitted. Note: Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default.
- labels
List<Cluster
Label Args> - mongo
Db StringMajor Version Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters:
4.2
,4.4
,5.0
, or6.0
. If omitted, Atlas deploys a cluster that runs MongoDB 5.0. Ifprovider_instance_size_name
:M0
,M2
orM5
, Atlas deploys MongoDB 5.0. Atlas always deploys the cluster with the latest stable release of the specified version. See Release Notes for latest Current Stable Release.- name String
Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed. WARNING Changing the name will result in destruction of the existing cluster and the creation of a new cluster.
- num
Shards Integer Selects whether the cluster is a replica set or a sharded cluster. If you use the replicationSpecs parameter, you must set num_shards.
- paused Boolean
- pit
Enabled Boolean Flag that indicates if the cluster uses Continuous Cloud Backup. If set to true, cloud_backup must also be set to true.
- provider
Auto StringScaling Compute Max Instance Size Maximum instance size to which your cluster can automatically scale (e.g., M40). Required if
autoScaling.compute.enabled
istrue
.- provider
Auto StringScaling Compute Min Instance Size Minimum instance size to which your cluster can automatically scale (e.g., M10). Required if
autoScaling.compute.scaleDownEnabled
istrue
.- provider
Backup BooleanEnabled Flag indicating if the cluster uses Cloud Backup for backups. Deprecated use
cloud_backup
instead.This field is deprecated,please use cloud_backup instead
- provider
Disk IntegerIops The maximum input/output operations per second (IOPS) the system can perform. The possible values depend on the selected
provider_instance_size_name
anddisk_size_gb
. This setting requires thatprovider_instance_size_name
to be M30 or greater and cannot be used with clusters with local NVMe SSDs. The default value forprovider_disk_iops
is the same as the cluster tier's Standard IOPS value, as viewable in the Atlas console. It is used in cases where a higher number of IOPS is needed and possible. If a value is submitted that is lower or equal to the default IOPS value for the cluster tier Atlas ignores the requested value and uses the default. More details available under the providerSettings.diskIOPS parameter: MongoDB API Clusters- You do not need to configure IOPS for a STANDARD disk configuration but only for a PROVISIONED configuration.
- provider
Disk StringType Name Azure disk type of the server’s root volume. If omitted, Atlas uses the default disk type for the selected providerSettings.instanceSizeName. Example disk types and associated storage sizes: P4 - 32GB, P6 - 64GB, P10 - 128GB, P15 - 256GB, P20 - 512GB, P30 - 1024GB, P40 - 2048GB, P50 - 4095GB. More information and the most update to date disk types/storage sizes can be located at https://docs.atlas.mongodb.com/reference/api/clusters-create-one/.
- provider
Encrypt BooleanEbs Volume (Deprecated) The Flag is always true. Flag that indicates whether the Amazon EBS encryption feature encrypts the host's root volume for both data at rest within the volume and for data moving between the volume and the cluster. Note: This setting is always enabled for clusters with local NVMe SSDs. Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default..
All EBS volumes are encrypted by default, the option to disable encryption has been removed
- provider
Region StringName Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas region name, see the reference list for AWS, GCP, Azure. Do not specify this field when creating a multi-region cluster using the replicationSpec document or a Global Cluster with the replicationSpecs array.
- provider
Volume StringType The type of the volume. The possible values are:
STANDARD
andPROVISIONED
.PROVISIONED
is ONLY required if setting IOPS higher than the default instance IOPS.- replication
Factor Integer Number of replica set members. Each member keeps a copy of your databases, providing high availability and data redundancy. The possible values are 3, 5, or 7. The default value is 3.
- replication
Specs List<ClusterReplication Spec Args> Configuration for cluster regions. See Replication Spec below for more details.
- 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. This parameter defaults to
LTS
. If you set this field toCONTINUOUS
, you must omit themongo_db_major_version
field. Atlas accepts:
- project
Id string The unique ID for the project to create the database user.
- provider
Instance stringSize Name Atlas provides different instance sizes, each with a default storage capacity and RAM size. The instance size you select is used for all the data-bearing servers in your cluster. See Create a Cluster
providerSettings.instanceSizeName
for valid values and default resources.- provider
Name string Cloud service provider on which the servers are provisioned.
- advanced
Configuration ClusterAdvanced Configuration Args - auto
Scaling booleanCompute Enabled Specifies whether cluster tier auto-scaling is enabled. The default is false.
- Set to
true
to enable cluster tier auto-scaling. If enabled, you must specify a value forproviderSettings.autoScaling.compute.maxInstanceSize
. - Set to
false
to disable cluster tier auto-scaling.
- Set to
- auto
Scaling booleanCompute Scale Down Enabled Set to
true
to enable the cluster tier to scale down. This option is only available ifautoScaling.compute.enabled
istrue
.- If this option is enabled, you must specify a value for
providerSettings.autoScaling.compute.minInstanceSize
- If this option is enabled, you must specify a value for
- auto
Scaling booleanDisk Gb Enabled Specifies whether disk auto-scaling is enabled. The default is true.
- Set to
true
to enable disk auto-scaling. - Set to
false
to disable disk auto-scaling.
- Set to
- backing
Provider stringName Cloud service provider on which the server for a multi-tenant cluster is provisioned.
- backup
Enabled boolean Clusters running MongoDB FCV 4.2 or later and any new Atlas clusters of any type do not support this parameter
- bi
Connector {[key: string]: string} Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details. DEPRECATED Use
bi_connector_config
instead.use bi_connector_config instead
- bi
Connector ClusterConfig Bi Connector Config Args Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details.
- cloud
Backup boolean Flag indicating if the cluster uses Cloud Backup for backups.
- cluster
Type string Specifies the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.
- disk
Size numberGb Capacity, in gigabytes, of the host’s root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive integer.
- The minimum disk size for dedicated clusters is 10GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value.
- Note: The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require additional storage space beyond this limitation, consider upgrading your cluster to a higher tier.
- Cannot be used with clusters with local NVMe SSDs
- Cannot be used with Azure clusters
- encryption
At stringRest Provider Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For complete documentation on configuring Encryption at Rest, see Encryption at Rest using Customer Key Management. Requires M10 or greater. and for legacy backups, backup_enabled, to be false or omitted. Note: Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default.
- labels
Cluster
Label Args[] - mongo
Db stringMajor Version Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters:
4.2
,4.4
,5.0
, or6.0
. If omitted, Atlas deploys a cluster that runs MongoDB 5.0. Ifprovider_instance_size_name
:M0
,M2
orM5
, Atlas deploys MongoDB 5.0. Atlas always deploys the cluster with the latest stable release of the specified version. See Release Notes for latest Current Stable Release.- name string
Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed. WARNING Changing the name will result in destruction of the existing cluster and the creation of a new cluster.
- num
Shards number Selects whether the cluster is a replica set or a sharded cluster. If you use the replicationSpecs parameter, you must set num_shards.
- paused boolean
- pit
Enabled boolean Flag that indicates if the cluster uses Continuous Cloud Backup. If set to true, cloud_backup must also be set to true.
- provider
Auto stringScaling Compute Max Instance Size Maximum instance size to which your cluster can automatically scale (e.g., M40). Required if
autoScaling.compute.enabled
istrue
.- provider
Auto stringScaling Compute Min Instance Size Minimum instance size to which your cluster can automatically scale (e.g., M10). Required if
autoScaling.compute.scaleDownEnabled
istrue
.- provider
Backup booleanEnabled Flag indicating if the cluster uses Cloud Backup for backups. Deprecated use
cloud_backup
instead.This field is deprecated,please use cloud_backup instead
- provider
Disk numberIops The maximum input/output operations per second (IOPS) the system can perform. The possible values depend on the selected
provider_instance_size_name
anddisk_size_gb
. This setting requires thatprovider_instance_size_name
to be M30 or greater and cannot be used with clusters with local NVMe SSDs. The default value forprovider_disk_iops
is the same as the cluster tier's Standard IOPS value, as viewable in the Atlas console. It is used in cases where a higher number of IOPS is needed and possible. If a value is submitted that is lower or equal to the default IOPS value for the cluster tier Atlas ignores the requested value and uses the default. More details available under the providerSettings.diskIOPS parameter: MongoDB API Clusters- You do not need to configure IOPS for a STANDARD disk configuration but only for a PROVISIONED configuration.
- provider
Disk stringType Name Azure disk type of the server’s root volume. If omitted, Atlas uses the default disk type for the selected providerSettings.instanceSizeName. Example disk types and associated storage sizes: P4 - 32GB, P6 - 64GB, P10 - 128GB, P15 - 256GB, P20 - 512GB, P30 - 1024GB, P40 - 2048GB, P50 - 4095GB. More information and the most update to date disk types/storage sizes can be located at https://docs.atlas.mongodb.com/reference/api/clusters-create-one/.
- provider
Encrypt booleanEbs Volume (Deprecated) The Flag is always true. Flag that indicates whether the Amazon EBS encryption feature encrypts the host's root volume for both data at rest within the volume and for data moving between the volume and the cluster. Note: This setting is always enabled for clusters with local NVMe SSDs. Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default..
All EBS volumes are encrypted by default, the option to disable encryption has been removed
- provider
Region stringName Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas region name, see the reference list for AWS, GCP, Azure. Do not specify this field when creating a multi-region cluster using the replicationSpec document or a Global Cluster with the replicationSpecs array.
- provider
Volume stringType The type of the volume. The possible values are:
STANDARD
andPROVISIONED
.PROVISIONED
is ONLY required if setting IOPS higher than the default instance IOPS.- replication
Factor number Number of replica set members. Each member keeps a copy of your databases, providing high availability and data redundancy. The possible values are 3, 5, or 7. The default value is 3.
- replication
Specs ClusterReplication Spec Args[] Configuration for cluster regions. See Replication Spec below for more details.
- 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. This parameter defaults to
LTS
. If you set this field toCONTINUOUS
, you must omit themongo_db_major_version
field. Atlas accepts:
- project_
id str The unique ID for the project to create the database user.
- provider_
instance_ strsize_ name Atlas provides different instance sizes, each with a default storage capacity and RAM size. The instance size you select is used for all the data-bearing servers in your cluster. See Create a Cluster
providerSettings.instanceSizeName
for valid values and default resources.- provider_
name str Cloud service provider on which the servers are provisioned.
- advanced_
configuration ClusterAdvanced Configuration Args - auto_
scaling_ boolcompute_ enabled Specifies whether cluster tier auto-scaling is enabled. The default is false.
- Set to
true
to enable cluster tier auto-scaling. If enabled, you must specify a value forproviderSettings.autoScaling.compute.maxInstanceSize
. - Set to
false
to disable cluster tier auto-scaling.
- Set to
- auto_
scaling_ boolcompute_ scale_ down_ enabled Set to
true
to enable the cluster tier to scale down. This option is only available ifautoScaling.compute.enabled
istrue
.- If this option is enabled, you must specify a value for
providerSettings.autoScaling.compute.minInstanceSize
- If this option is enabled, you must specify a value for
- auto_
scaling_ booldisk_ gb_ enabled Specifies whether disk auto-scaling is enabled. The default is true.
- Set to
true
to enable disk auto-scaling. - Set to
false
to disable disk auto-scaling.
- Set to
- backing_
provider_ strname Cloud service provider on which the server for a multi-tenant cluster is provisioned.
- backup_
enabled bool Clusters running MongoDB FCV 4.2 or later and any new Atlas clusters of any type do not support this parameter
- bi_
connector Mapping[str, str] Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details. DEPRECATED Use
bi_connector_config
instead.use bi_connector_config instead
- bi_
connector_ Clusterconfig Bi Connector Config Args Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details.
- cloud_
backup bool Flag indicating if the cluster uses Cloud Backup for backups.
- cluster_
type str Specifies the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.
- disk_
size_ floatgb Capacity, in gigabytes, of the host’s root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive integer.
- The minimum disk size for dedicated clusters is 10GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value.
- Note: The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require additional storage space beyond this limitation, consider upgrading your cluster to a higher tier.
- Cannot be used with clusters with local NVMe SSDs
- Cannot be used with Azure clusters
- encryption_
at_ strrest_ provider Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For complete documentation on configuring Encryption at Rest, see Encryption at Rest using Customer Key Management. Requires M10 or greater. and for legacy backups, backup_enabled, to be false or omitted. Note: Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default.
- labels
Sequence[Cluster
Label Args] - mongo_
db_ strmajor_ version Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters:
4.2
,4.4
,5.0
, or6.0
. If omitted, Atlas deploys a cluster that runs MongoDB 5.0. Ifprovider_instance_size_name
:M0
,M2
orM5
, Atlas deploys MongoDB 5.0. Atlas always deploys the cluster with the latest stable release of the specified version. See Release Notes for latest Current Stable Release.- name str
Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed. WARNING Changing the name will result in destruction of the existing cluster and the creation of a new cluster.
- num_
shards int Selects whether the cluster is a replica set or a sharded cluster. If you use the replicationSpecs parameter, you must set num_shards.
- paused bool
- pit_
enabled bool Flag that indicates if the cluster uses Continuous Cloud Backup. If set to true, cloud_backup must also be set to true.
- provider_
auto_ strscaling_ compute_ max_ instance_ size Maximum instance size to which your cluster can automatically scale (e.g., M40). Required if
autoScaling.compute.enabled
istrue
.- provider_
auto_ strscaling_ compute_ min_ instance_ size Minimum instance size to which your cluster can automatically scale (e.g., M10). Required if
autoScaling.compute.scaleDownEnabled
istrue
.- provider_
backup_ boolenabled Flag indicating if the cluster uses Cloud Backup for backups. Deprecated use
cloud_backup
instead.This field is deprecated,please use cloud_backup instead
- provider_
disk_ intiops The maximum input/output operations per second (IOPS) the system can perform. The possible values depend on the selected
provider_instance_size_name
anddisk_size_gb
. This setting requires thatprovider_instance_size_name
to be M30 or greater and cannot be used with clusters with local NVMe SSDs. The default value forprovider_disk_iops
is the same as the cluster tier's Standard IOPS value, as viewable in the Atlas console. It is used in cases where a higher number of IOPS is needed and possible. If a value is submitted that is lower or equal to the default IOPS value for the cluster tier Atlas ignores the requested value and uses the default. More details available under the providerSettings.diskIOPS parameter: MongoDB API Clusters- You do not need to configure IOPS for a STANDARD disk configuration but only for a PROVISIONED configuration.
- provider_
disk_ strtype_ name Azure disk type of the server’s root volume. If omitted, Atlas uses the default disk type for the selected providerSettings.instanceSizeName. Example disk types and associated storage sizes: P4 - 32GB, P6 - 64GB, P10 - 128GB, P15 - 256GB, P20 - 512GB, P30 - 1024GB, P40 - 2048GB, P50 - 4095GB. More information and the most update to date disk types/storage sizes can be located at https://docs.atlas.mongodb.com/reference/api/clusters-create-one/.
- provider_
encrypt_ boolebs_ volume (Deprecated) The Flag is always true. Flag that indicates whether the Amazon EBS encryption feature encrypts the host's root volume for both data at rest within the volume and for data moving between the volume and the cluster. Note: This setting is always enabled for clusters with local NVMe SSDs. Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default..
All EBS volumes are encrypted by default, the option to disable encryption has been removed
- provider_
region_ strname Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas region name, see the reference list for AWS, GCP, Azure. Do not specify this field when creating a multi-region cluster using the replicationSpec document or a Global Cluster with the replicationSpecs array.
- provider_
volume_ strtype The type of the volume. The possible values are:
STANDARD
andPROVISIONED
.PROVISIONED
is ONLY required if setting IOPS higher than the default instance IOPS.- replication_
factor int Number of replica set members. Each member keeps a copy of your databases, providing high availability and data redundancy. The possible values are 3, 5, or 7. The default value is 3.
- replication_
specs Sequence[ClusterReplication Spec Args] Configuration for cluster regions. See Replication Spec below for more details.
- 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. This parameter defaults to
LTS
. If you set this field toCONTINUOUS
, you must omit themongo_db_major_version
field. Atlas accepts:
- project
Id String The unique ID for the project to create the database user.
- provider
Instance StringSize Name Atlas provides different instance sizes, each with a default storage capacity and RAM size. The instance size you select is used for all the data-bearing servers in your cluster. See Create a Cluster
providerSettings.instanceSizeName
for valid values and default resources.- provider
Name String Cloud service provider on which the servers are provisioned.
- advanced
Configuration Property Map - auto
Scaling BooleanCompute Enabled Specifies whether cluster tier auto-scaling is enabled. The default is false.
- Set to
true
to enable cluster tier auto-scaling. If enabled, you must specify a value forproviderSettings.autoScaling.compute.maxInstanceSize
. - Set to
false
to disable cluster tier auto-scaling.
- Set to
- auto
Scaling BooleanCompute Scale Down Enabled Set to
true
to enable the cluster tier to scale down. This option is only available ifautoScaling.compute.enabled
istrue
.- If this option is enabled, you must specify a value for
providerSettings.autoScaling.compute.minInstanceSize
- If this option is enabled, you must specify a value for
- auto
Scaling BooleanDisk Gb Enabled Specifies whether disk auto-scaling is enabled. The default is true.
- Set to
true
to enable disk auto-scaling. - Set to
false
to disable disk auto-scaling.
- Set to
- backing
Provider StringName Cloud service provider on which the server for a multi-tenant cluster is provisioned.
- backup
Enabled Boolean Clusters running MongoDB FCV 4.2 or later and any new Atlas clusters of any type do not support this parameter
- bi
Connector Map<String> Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details. DEPRECATED Use
bi_connector_config
instead.use bi_connector_config instead
- bi
Connector Property MapConfig Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details.
- cloud
Backup Boolean Flag indicating if the cluster uses Cloud Backup for backups.
- cluster
Type String Specifies the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.
- disk
Size NumberGb Capacity, in gigabytes, of the host’s root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive integer.
- The minimum disk size for dedicated clusters is 10GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value.
- Note: The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require additional storage space beyond this limitation, consider upgrading your cluster to a higher tier.
- Cannot be used with clusters with local NVMe SSDs
- Cannot be used with Azure clusters
- encryption
At StringRest Provider Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For complete documentation on configuring Encryption at Rest, see Encryption at Rest using Customer Key Management. Requires M10 or greater. and for legacy backups, backup_enabled, to be false or omitted. Note: Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default.
- labels List<Property Map>
- mongo
Db StringMajor Version Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters:
4.2
,4.4
,5.0
, or6.0
. If omitted, Atlas deploys a cluster that runs MongoDB 5.0. Ifprovider_instance_size_name
:M0
,M2
orM5
, Atlas deploys MongoDB 5.0. Atlas always deploys the cluster with the latest stable release of the specified version. See Release Notes for latest Current Stable Release.- name String
Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed. WARNING Changing the name will result in destruction of the existing cluster and the creation of a new cluster.
- num
Shards Number Selects whether the cluster is a replica set or a sharded cluster. If you use the replicationSpecs parameter, you must set num_shards.
- paused Boolean
- pit
Enabled Boolean Flag that indicates if the cluster uses Continuous Cloud Backup. If set to true, cloud_backup must also be set to true.
- provider
Auto StringScaling Compute Max Instance Size Maximum instance size to which your cluster can automatically scale (e.g., M40). Required if
autoScaling.compute.enabled
istrue
.- provider
Auto StringScaling Compute Min Instance Size Minimum instance size to which your cluster can automatically scale (e.g., M10). Required if
autoScaling.compute.scaleDownEnabled
istrue
.- provider
Backup BooleanEnabled Flag indicating if the cluster uses Cloud Backup for backups. Deprecated use
cloud_backup
instead.This field is deprecated,please use cloud_backup instead
- provider
Disk NumberIops The maximum input/output operations per second (IOPS) the system can perform. The possible values depend on the selected
provider_instance_size_name
anddisk_size_gb
. This setting requires thatprovider_instance_size_name
to be M30 or greater and cannot be used with clusters with local NVMe SSDs. The default value forprovider_disk_iops
is the same as the cluster tier's Standard IOPS value, as viewable in the Atlas console. It is used in cases where a higher number of IOPS is needed and possible. If a value is submitted that is lower or equal to the default IOPS value for the cluster tier Atlas ignores the requested value and uses the default. More details available under the providerSettings.diskIOPS parameter: MongoDB API Clusters- You do not need to configure IOPS for a STANDARD disk configuration but only for a PROVISIONED configuration.
- provider
Disk StringType Name Azure disk type of the server’s root volume. If omitted, Atlas uses the default disk type for the selected providerSettings.instanceSizeName. Example disk types and associated storage sizes: P4 - 32GB, P6 - 64GB, P10 - 128GB, P15 - 256GB, P20 - 512GB, P30 - 1024GB, P40 - 2048GB, P50 - 4095GB. More information and the most update to date disk types/storage sizes can be located at https://docs.atlas.mongodb.com/reference/api/clusters-create-one/.
- provider
Encrypt BooleanEbs Volume (Deprecated) The Flag is always true. Flag that indicates whether the Amazon EBS encryption feature encrypts the host's root volume for both data at rest within the volume and for data moving between the volume and the cluster. Note: This setting is always enabled for clusters with local NVMe SSDs. Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default..
All EBS volumes are encrypted by default, the option to disable encryption has been removed
- provider
Region StringName Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas region name, see the reference list for AWS, GCP, Azure. Do not specify this field when creating a multi-region cluster using the replicationSpec document or a Global Cluster with the replicationSpecs array.
- provider
Volume StringType The type of the volume. The possible values are:
STANDARD
andPROVISIONED
.PROVISIONED
is ONLY required if setting IOPS higher than the default instance IOPS.- replication
Factor Number Number of replica set members. Each member keeps a copy of your databases, providing high availability and data redundancy. The possible values are 3, 5, or 7. The default value is 3.
- replication
Specs List<Property Map> Configuration for cluster regions. See Replication Spec below for more details.
- 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. This parameter defaults to
LTS
. If you set this field toCONTINUOUS
, you must omit themongo_db_major_version
field. Atlas accepts:
Outputs
All input properties are implicitly available as output properties. Additionally, the Cluster resource produces the following output properties:
- Cluster
Id string The cluster ID.
- Connection
Strings List<ClusterConnection 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.
- Container
Id string The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created.
- Id string
The provider-assigned unique ID for this managed resource.
- Mongo
Db stringVersion Version of MongoDB the cluster runs, in
major-version
.minor-version
format.- Mongo
Uri string Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.
- Mongo
Uri stringUpdated Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.
- Mongo
Uri stringWith Options connection string for connecting to the Atlas cluster. Includes the replicaSet, ssl, and authSource query parameters in the connection string with values appropriate for the cluster.
- Provider
Encrypt boolEbs Volume Flag - Snapshot
Backup List<ClusterPolicies Snapshot Backup Policy> current snapshot schedule and retention settings for the cluster.
- Srv
Address string Connection string for connecting to the Atlas cluster. The +srv modifier forces the connection to use TLS/SSL. See the mongoURI for additional options.
- State
Name string Current state of the cluster. The possible states are:
- IDLE
- CREATING
- UPDATING
- DELETING
- DELETED
- REPAIRING
- Cluster
Id string The cluster ID.
- Connection
Strings []ClusterConnection 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.
- Container
Id string The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created.
- Id string
The provider-assigned unique ID for this managed resource.
- Mongo
Db stringVersion Version of MongoDB the cluster runs, in
major-version
.minor-version
format.- Mongo
Uri string Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.
- Mongo
Uri stringUpdated Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.
- Mongo
Uri stringWith Options connection string for connecting to the Atlas cluster. Includes the replicaSet, ssl, and authSource query parameters in the connection string with values appropriate for the cluster.
- Provider
Encrypt boolEbs Volume Flag - Snapshot
Backup []ClusterPolicies Snapshot Backup Policy current snapshot schedule and retention settings for the cluster.
- Srv
Address string Connection string for connecting to the Atlas cluster. The +srv modifier forces the connection to use TLS/SSL. See the mongoURI for additional options.
- State
Name string Current state of the cluster. The possible states are:
- IDLE
- CREATING
- UPDATING
- DELETING
- DELETED
- REPAIRING
- cluster
Id String The cluster ID.
- connection
Strings List<ClusterConnection 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.
- container
Id String The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created.
- id String
The provider-assigned unique ID for this managed resource.
- mongo
Db StringVersion Version of MongoDB the cluster runs, in
major-version
.minor-version
format.- mongo
Uri String Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.
- mongo
Uri StringUpdated Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.
- mongo
Uri StringWith Options connection string for connecting to the Atlas cluster. Includes the replicaSet, ssl, and authSource query parameters in the connection string with values appropriate for the cluster.
- provider
Encrypt BooleanEbs Volume Flag - snapshot
Backup List<ClusterPolicies Snapshot Backup Policy> current snapshot schedule and retention settings for the cluster.
- srv
Address String Connection string for connecting to the Atlas cluster. The +srv modifier forces the connection to use TLS/SSL. See the mongoURI for additional options.
- state
Name String Current state of the cluster. The possible states are:
- IDLE
- CREATING
- UPDATING
- DELETING
- DELETED
- REPAIRING
- cluster
Id string The cluster ID.
- connection
Strings ClusterConnection 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.
- container
Id string The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created.
- id string
The provider-assigned unique ID for this managed resource.
- mongo
Db stringVersion Version of MongoDB the cluster runs, in
major-version
.minor-version
format.- mongo
Uri string Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.
- mongo
Uri stringUpdated Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.
- mongo
Uri stringWith Options connection string for connecting to the Atlas cluster. Includes the replicaSet, ssl, and authSource query parameters in the connection string with values appropriate for the cluster.
- provider
Encrypt booleanEbs Volume Flag - snapshot
Backup ClusterPolicies Snapshot Backup Policy[] current snapshot schedule and retention settings for the cluster.
- srv
Address string Connection string for connecting to the Atlas cluster. The +srv modifier forces the connection to use TLS/SSL. See the mongoURI for additional options.
- state
Name string Current state of the cluster. The possible states are:
- IDLE
- CREATING
- UPDATING
- DELETING
- DELETED
- REPAIRING
- cluster_
id str The cluster ID.
- connection_
strings Sequence[ClusterConnection 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.
- container_
id str The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created.
- id str
The provider-assigned unique ID for this managed resource.
- mongo_
db_ strversion Version of MongoDB the cluster runs, in
major-version
.minor-version
format.- mongo_
uri str Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.
- mongo_
uri_ strupdated Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.
- mongo_
uri_ strwith_ options connection string for connecting to the Atlas cluster. Includes the replicaSet, ssl, and authSource query parameters in the connection string with values appropriate for the cluster.
- provider_
encrypt_ boolebs_ volume_ flag - snapshot_
backup_ Sequence[Clusterpolicies Snapshot Backup Policy] current snapshot schedule and retention settings for the cluster.
- srv_
address str Connection string for connecting to the Atlas cluster. The +srv modifier forces the connection to use TLS/SSL. See the mongoURI for additional options.
- state_
name str Current state of the cluster. The possible states are:
- IDLE
- CREATING
- UPDATING
- DELETING
- DELETED
- REPAIRING
- cluster
Id String The cluster ID.
- 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.
- container
Id String The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created.
- id String
The provider-assigned unique ID for this managed resource.
- mongo
Db StringVersion Version of MongoDB the cluster runs, in
major-version
.minor-version
format.- mongo
Uri String Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.
- mongo
Uri StringUpdated Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.
- mongo
Uri StringWith Options connection string for connecting to the Atlas cluster. Includes the replicaSet, ssl, and authSource query parameters in the connection string with values appropriate for the cluster.
- provider
Encrypt BooleanEbs Volume Flag - snapshot
Backup List<Property Map>Policies current snapshot schedule and retention settings for the cluster.
- srv
Address String Connection string for connecting to the Atlas cluster. The +srv modifier forces the connection to use TLS/SSL. See the mongoURI for additional options.
- state
Name String Current state of the cluster. The possible states are:
- IDLE
- CREATING
- UPDATING
- DELETING
- DELETED
- REPAIRING
Look up Existing Cluster Resource
Get an existing Cluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ClusterState, opts?: CustomResourceOptions): Cluster
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
advanced_configuration: Optional[ClusterAdvancedConfigurationArgs] = None,
auto_scaling_compute_enabled: Optional[bool] = None,
auto_scaling_compute_scale_down_enabled: Optional[bool] = None,
auto_scaling_disk_gb_enabled: Optional[bool] = None,
backing_provider_name: Optional[str] = None,
backup_enabled: Optional[bool] = None,
bi_connector: Optional[Mapping[str, str]] = None,
bi_connector_config: Optional[ClusterBiConnectorConfigArgs] = None,
cloud_backup: Optional[bool] = None,
cluster_id: Optional[str] = None,
cluster_type: Optional[str] = None,
connection_strings: Optional[Sequence[ClusterConnectionStringArgs]] = None,
container_id: Optional[str] = None,
disk_size_gb: Optional[float] = None,
encryption_at_rest_provider: Optional[str] = None,
labels: Optional[Sequence[ClusterLabelArgs]] = None,
mongo_db_major_version: Optional[str] = None,
mongo_db_version: Optional[str] = None,
mongo_uri: Optional[str] = None,
mongo_uri_updated: Optional[str] = None,
mongo_uri_with_options: Optional[str] = None,
name: Optional[str] = None,
num_shards: Optional[int] = None,
paused: Optional[bool] = None,
pit_enabled: Optional[bool] = None,
project_id: Optional[str] = None,
provider_auto_scaling_compute_max_instance_size: Optional[str] = None,
provider_auto_scaling_compute_min_instance_size: Optional[str] = None,
provider_backup_enabled: Optional[bool] = None,
provider_disk_iops: Optional[int] = None,
provider_disk_type_name: Optional[str] = None,
provider_encrypt_ebs_volume: Optional[bool] = None,
provider_encrypt_ebs_volume_flag: Optional[bool] = None,
provider_instance_size_name: Optional[str] = None,
provider_name: Optional[str] = None,
provider_region_name: Optional[str] = None,
provider_volume_type: Optional[str] = None,
replication_factor: Optional[int] = None,
replication_specs: Optional[Sequence[ClusterReplicationSpecArgs]] = None,
snapshot_backup_policies: Optional[Sequence[ClusterSnapshotBackupPolicyArgs]] = None,
srv_address: Optional[str] = None,
state_name: Optional[str] = None,
termination_protection_enabled: Optional[bool] = None,
version_release_system: Optional[str] = None) -> Cluster
func GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)
public static Cluster Get(string name, Input<string> id, ClusterState? state, CustomResourceOptions? opts = null)
public static Cluster get(String name, Output<String> id, ClusterState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Advanced
Configuration ClusterAdvanced Configuration Args - Auto
Scaling boolCompute Enabled Specifies whether cluster tier auto-scaling is enabled. The default is false.
- Set to
true
to enable cluster tier auto-scaling. If enabled, you must specify a value forproviderSettings.autoScaling.compute.maxInstanceSize
. - Set to
false
to disable cluster tier auto-scaling.
- Set to
- Auto
Scaling boolCompute Scale Down Enabled Set to
true
to enable the cluster tier to scale down. This option is only available ifautoScaling.compute.enabled
istrue
.- If this option is enabled, you must specify a value for
providerSettings.autoScaling.compute.minInstanceSize
- If this option is enabled, you must specify a value for
- Auto
Scaling boolDisk Gb Enabled Specifies whether disk auto-scaling is enabled. The default is true.
- Set to
true
to enable disk auto-scaling. - Set to
false
to disable disk auto-scaling.
- Set to
- Backing
Provider stringName Cloud service provider on which the server for a multi-tenant cluster is provisioned.
- Backup
Enabled bool Clusters running MongoDB FCV 4.2 or later and any new Atlas clusters of any type do not support this parameter
- Bi
Connector Dictionary<string, string> Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details. DEPRECATED Use
bi_connector_config
instead.use bi_connector_config instead
- Bi
Connector ClusterConfig Bi Connector Config Args Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details.
- Cloud
Backup bool Flag indicating if the cluster uses Cloud Backup for backups.
- Cluster
Id string The cluster ID.
- Cluster
Type string Specifies the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.
- Connection
Strings List<ClusterConnection String Args> 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.
- Container
Id string The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created.
- Disk
Size doubleGb Capacity, in gigabytes, of the host’s root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive integer.
- The minimum disk size for dedicated clusters is 10GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value.
- Note: The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require additional storage space beyond this limitation, consider upgrading your cluster to a higher tier.
- Cannot be used with clusters with local NVMe SSDs
- Cannot be used with Azure clusters
- Encryption
At stringRest Provider Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For complete documentation on configuring Encryption at Rest, see Encryption at Rest using Customer Key Management. Requires M10 or greater. and for legacy backups, backup_enabled, to be false or omitted. Note: Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default.
- Labels
List<Cluster
Label Args> - Mongo
Db stringMajor Version Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters:
4.2
,4.4
,5.0
, or6.0
. If omitted, Atlas deploys a cluster that runs MongoDB 5.0. Ifprovider_instance_size_name
:M0
,M2
orM5
, Atlas deploys MongoDB 5.0. Atlas always deploys the cluster with the latest stable release of the specified version. See Release Notes for latest Current Stable Release.- Mongo
Db stringVersion Version of MongoDB the cluster runs, in
major-version
.minor-version
format.- Mongo
Uri string Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.
- Mongo
Uri stringUpdated Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.
- Mongo
Uri stringWith Options connection string for connecting to the Atlas cluster. Includes the replicaSet, ssl, and authSource query parameters in the connection string with values appropriate for the cluster.
- Name string
Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed. WARNING Changing the name will result in destruction of the existing cluster and the creation of a new cluster.
- Num
Shards int Selects whether the cluster is a replica set or a sharded cluster. If you use the replicationSpecs parameter, you must set num_shards.
- Paused bool
- Pit
Enabled bool Flag that indicates if the cluster uses Continuous Cloud Backup. If set to true, cloud_backup must also be set to true.
- Project
Id string The unique ID for the project to create the database user.
- Provider
Auto stringScaling Compute Max Instance Size Maximum instance size to which your cluster can automatically scale (e.g., M40). Required if
autoScaling.compute.enabled
istrue
.- Provider
Auto stringScaling Compute Min Instance Size Minimum instance size to which your cluster can automatically scale (e.g., M10). Required if
autoScaling.compute.scaleDownEnabled
istrue
.- Provider
Backup boolEnabled Flag indicating if the cluster uses Cloud Backup for backups. Deprecated use
cloud_backup
instead.This field is deprecated,please use cloud_backup instead
- Provider
Disk intIops The maximum input/output operations per second (IOPS) the system can perform. The possible values depend on the selected
provider_instance_size_name
anddisk_size_gb
. This setting requires thatprovider_instance_size_name
to be M30 or greater and cannot be used with clusters with local NVMe SSDs. The default value forprovider_disk_iops
is the same as the cluster tier's Standard IOPS value, as viewable in the Atlas console. It is used in cases where a higher number of IOPS is needed and possible. If a value is submitted that is lower or equal to the default IOPS value for the cluster tier Atlas ignores the requested value and uses the default. More details available under the providerSettings.diskIOPS parameter: MongoDB API Clusters- You do not need to configure IOPS for a STANDARD disk configuration but only for a PROVISIONED configuration.
- Provider
Disk stringType Name Azure disk type of the server’s root volume. If omitted, Atlas uses the default disk type for the selected providerSettings.instanceSizeName. Example disk types and associated storage sizes: P4 - 32GB, P6 - 64GB, P10 - 128GB, P15 - 256GB, P20 - 512GB, P30 - 1024GB, P40 - 2048GB, P50 - 4095GB. More information and the most update to date disk types/storage sizes can be located at https://docs.atlas.mongodb.com/reference/api/clusters-create-one/.
- Provider
Encrypt boolEbs Volume (Deprecated) The Flag is always true. Flag that indicates whether the Amazon EBS encryption feature encrypts the host's root volume for both data at rest within the volume and for data moving between the volume and the cluster. Note: This setting is always enabled for clusters with local NVMe SSDs. Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default..
All EBS volumes are encrypted by default, the option to disable encryption has been removed
- Provider
Encrypt boolEbs Volume Flag - Provider
Instance stringSize Name Atlas provides different instance sizes, each with a default storage capacity and RAM size. The instance size you select is used for all the data-bearing servers in your cluster. See Create a Cluster
providerSettings.instanceSizeName
for valid values and default resources.- Provider
Name string Cloud service provider on which the servers are provisioned.
- Provider
Region stringName Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas region name, see the reference list for AWS, GCP, Azure. Do not specify this field when creating a multi-region cluster using the replicationSpec document or a Global Cluster with the replicationSpecs array.
- Provider
Volume stringType The type of the volume. The possible values are:
STANDARD
andPROVISIONED
.PROVISIONED
is ONLY required if setting IOPS higher than the default instance IOPS.- Replication
Factor int Number of replica set members. Each member keeps a copy of your databases, providing high availability and data redundancy. The possible values are 3, 5, or 7. The default value is 3.
- Replication
Specs List<ClusterReplication Spec Args> Configuration for cluster regions. See Replication Spec below for more details.
- Snapshot
Backup List<ClusterPolicies Snapshot Backup Policy Args> current snapshot schedule and retention settings for the cluster.
- Srv
Address string Connection string for connecting to the Atlas cluster. The +srv modifier forces the connection to use TLS/SSL. See the mongoURI for additional options.
- State
Name string Current state of the cluster. The possible states are:
- IDLE
- CREATING
- UPDATING
- DELETING
- DELETED
- REPAIRING
- 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. This parameter defaults to
LTS
. If you set this field toCONTINUOUS
, you must omit themongo_db_major_version
field. Atlas accepts:
- Advanced
Configuration ClusterAdvanced Configuration Args - Auto
Scaling boolCompute Enabled Specifies whether cluster tier auto-scaling is enabled. The default is false.
- Set to
true
to enable cluster tier auto-scaling. If enabled, you must specify a value forproviderSettings.autoScaling.compute.maxInstanceSize
. - Set to
false
to disable cluster tier auto-scaling.
- Set to
- Auto
Scaling boolCompute Scale Down Enabled Set to
true
to enable the cluster tier to scale down. This option is only available ifautoScaling.compute.enabled
istrue
.- If this option is enabled, you must specify a value for
providerSettings.autoScaling.compute.minInstanceSize
- If this option is enabled, you must specify a value for
- Auto
Scaling boolDisk Gb Enabled Specifies whether disk auto-scaling is enabled. The default is true.
- Set to
true
to enable disk auto-scaling. - Set to
false
to disable disk auto-scaling.
- Set to
- Backing
Provider stringName Cloud service provider on which the server for a multi-tenant cluster is provisioned.
- Backup
Enabled bool Clusters running MongoDB FCV 4.2 or later and any new Atlas clusters of any type do not support this parameter
- Bi
Connector map[string]string Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details. DEPRECATED Use
bi_connector_config
instead.use bi_connector_config instead
- Bi
Connector ClusterConfig Bi Connector Config Args Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details.
- Cloud
Backup bool Flag indicating if the cluster uses Cloud Backup for backups.
- Cluster
Id string The cluster ID.
- Cluster
Type string Specifies the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.
- Connection
Strings []ClusterConnection String Args 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.
- Container
Id string The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created.
- Disk
Size float64Gb Capacity, in gigabytes, of the host’s root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive integer.
- The minimum disk size for dedicated clusters is 10GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value.
- Note: The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require additional storage space beyond this limitation, consider upgrading your cluster to a higher tier.
- Cannot be used with clusters with local NVMe SSDs
- Cannot be used with Azure clusters
- Encryption
At stringRest Provider Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For complete documentation on configuring Encryption at Rest, see Encryption at Rest using Customer Key Management. Requires M10 or greater. and for legacy backups, backup_enabled, to be false or omitted. Note: Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default.
- Labels
[]Cluster
Label Args - Mongo
Db stringMajor Version Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters:
4.2
,4.4
,5.0
, or6.0
. If omitted, Atlas deploys a cluster that runs MongoDB 5.0. Ifprovider_instance_size_name
:M0
,M2
orM5
, Atlas deploys MongoDB 5.0. Atlas always deploys the cluster with the latest stable release of the specified version. See Release Notes for latest Current Stable Release.- Mongo
Db stringVersion Version of MongoDB the cluster runs, in
major-version
.minor-version
format.- Mongo
Uri string Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.
- Mongo
Uri stringUpdated Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.
- Mongo
Uri stringWith Options connection string for connecting to the Atlas cluster. Includes the replicaSet, ssl, and authSource query parameters in the connection string with values appropriate for the cluster.
- Name string
Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed. WARNING Changing the name will result in destruction of the existing cluster and the creation of a new cluster.
- Num
Shards int Selects whether the cluster is a replica set or a sharded cluster. If you use the replicationSpecs parameter, you must set num_shards.
- Paused bool
- Pit
Enabled bool Flag that indicates if the cluster uses Continuous Cloud Backup. If set to true, cloud_backup must also be set to true.
- Project
Id string The unique ID for the project to create the database user.
- Provider
Auto stringScaling Compute Max Instance Size Maximum instance size to which your cluster can automatically scale (e.g., M40). Required if
autoScaling.compute.enabled
istrue
.- Provider
Auto stringScaling Compute Min Instance Size Minimum instance size to which your cluster can automatically scale (e.g., M10). Required if
autoScaling.compute.scaleDownEnabled
istrue
.- Provider
Backup boolEnabled Flag indicating if the cluster uses Cloud Backup for backups. Deprecated use
cloud_backup
instead.This field is deprecated,please use cloud_backup instead
- Provider
Disk intIops The maximum input/output operations per second (IOPS) the system can perform. The possible values depend on the selected
provider_instance_size_name
anddisk_size_gb
. This setting requires thatprovider_instance_size_name
to be M30 or greater and cannot be used with clusters with local NVMe SSDs. The default value forprovider_disk_iops
is the same as the cluster tier's Standard IOPS value, as viewable in the Atlas console. It is used in cases where a higher number of IOPS is needed and possible. If a value is submitted that is lower or equal to the default IOPS value for the cluster tier Atlas ignores the requested value and uses the default. More details available under the providerSettings.diskIOPS parameter: MongoDB API Clusters- You do not need to configure IOPS for a STANDARD disk configuration but only for a PROVISIONED configuration.
- Provider
Disk stringType Name Azure disk type of the server’s root volume. If omitted, Atlas uses the default disk type for the selected providerSettings.instanceSizeName. Example disk types and associated storage sizes: P4 - 32GB, P6 - 64GB, P10 - 128GB, P15 - 256GB, P20 - 512GB, P30 - 1024GB, P40 - 2048GB, P50 - 4095GB. More information and the most update to date disk types/storage sizes can be located at https://docs.atlas.mongodb.com/reference/api/clusters-create-one/.
- Provider
Encrypt boolEbs Volume (Deprecated) The Flag is always true. Flag that indicates whether the Amazon EBS encryption feature encrypts the host's root volume for both data at rest within the volume and for data moving between the volume and the cluster. Note: This setting is always enabled for clusters with local NVMe SSDs. Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default..
All EBS volumes are encrypted by default, the option to disable encryption has been removed
- Provider
Encrypt boolEbs Volume Flag - Provider
Instance stringSize Name Atlas provides different instance sizes, each with a default storage capacity and RAM size. The instance size you select is used for all the data-bearing servers in your cluster. See Create a Cluster
providerSettings.instanceSizeName
for valid values and default resources.- Provider
Name string Cloud service provider on which the servers are provisioned.
- Provider
Region stringName Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas region name, see the reference list for AWS, GCP, Azure. Do not specify this field when creating a multi-region cluster using the replicationSpec document or a Global Cluster with the replicationSpecs array.
- Provider
Volume stringType The type of the volume. The possible values are:
STANDARD
andPROVISIONED
.PROVISIONED
is ONLY required if setting IOPS higher than the default instance IOPS.- Replication
Factor int Number of replica set members. Each member keeps a copy of your databases, providing high availability and data redundancy. The possible values are 3, 5, or 7. The default value is 3.
- Replication
Specs []ClusterReplication Spec Args Configuration for cluster regions. See Replication Spec below for more details.
- Snapshot
Backup []ClusterPolicies Snapshot Backup Policy Args current snapshot schedule and retention settings for the cluster.
- Srv
Address string Connection string for connecting to the Atlas cluster. The +srv modifier forces the connection to use TLS/SSL. See the mongoURI for additional options.
- State
Name string Current state of the cluster. The possible states are:
- IDLE
- CREATING
- UPDATING
- DELETING
- DELETED
- REPAIRING
- 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. This parameter defaults to
LTS
. If you set this field toCONTINUOUS
, you must omit themongo_db_major_version
field. Atlas accepts:
- advanced
Configuration ClusterAdvanced Configuration Args - auto
Scaling BooleanCompute Enabled Specifies whether cluster tier auto-scaling is enabled. The default is false.
- Set to
true
to enable cluster tier auto-scaling. If enabled, you must specify a value forproviderSettings.autoScaling.compute.maxInstanceSize
. - Set to
false
to disable cluster tier auto-scaling.
- Set to
- auto
Scaling BooleanCompute Scale Down Enabled Set to
true
to enable the cluster tier to scale down. This option is only available ifautoScaling.compute.enabled
istrue
.- If this option is enabled, you must specify a value for
providerSettings.autoScaling.compute.minInstanceSize
- If this option is enabled, you must specify a value for
- auto
Scaling BooleanDisk Gb Enabled Specifies whether disk auto-scaling is enabled. The default is true.
- Set to
true
to enable disk auto-scaling. - Set to
false
to disable disk auto-scaling.
- Set to
- backing
Provider StringName Cloud service provider on which the server for a multi-tenant cluster is provisioned.
- backup
Enabled Boolean Clusters running MongoDB FCV 4.2 or later and any new Atlas clusters of any type do not support this parameter
- bi
Connector Map<String,String> Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details. DEPRECATED Use
bi_connector_config
instead.use bi_connector_config instead
- bi
Connector ClusterConfig Bi Connector Config Args Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details.
- cloud
Backup Boolean Flag indicating if the cluster uses Cloud Backup for backups.
- cluster
Id String The cluster ID.
- cluster
Type String Specifies the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.
- connection
Strings List<ClusterConnection String Args> 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.
- container
Id String The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created.
- disk
Size DoubleGb Capacity, in gigabytes, of the host’s root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive integer.
- The minimum disk size for dedicated clusters is 10GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value.
- Note: The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require additional storage space beyond this limitation, consider upgrading your cluster to a higher tier.
- Cannot be used with clusters with local NVMe SSDs
- Cannot be used with Azure clusters
- encryption
At StringRest Provider Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For complete documentation on configuring Encryption at Rest, see Encryption at Rest using Customer Key Management. Requires M10 or greater. and for legacy backups, backup_enabled, to be false or omitted. Note: Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default.
- labels
List<Cluster
Label Args> - mongo
Db StringMajor Version Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters:
4.2
,4.4
,5.0
, or6.0
. If omitted, Atlas deploys a cluster that runs MongoDB 5.0. Ifprovider_instance_size_name
:M0
,M2
orM5
, Atlas deploys MongoDB 5.0. Atlas always deploys the cluster with the latest stable release of the specified version. See Release Notes for latest Current Stable Release.- mongo
Db StringVersion Version of MongoDB the cluster runs, in
major-version
.minor-version
format.- mongo
Uri String Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.
- mongo
Uri StringUpdated Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.
- mongo
Uri StringWith Options connection string for connecting to the Atlas cluster. Includes the replicaSet, ssl, and authSource query parameters in the connection string with values appropriate for the cluster.
- name String
Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed. WARNING Changing the name will result in destruction of the existing cluster and the creation of a new cluster.
- num
Shards Integer Selects whether the cluster is a replica set or a sharded cluster. If you use the replicationSpecs parameter, you must set num_shards.
- paused Boolean
- pit
Enabled Boolean Flag that indicates if the cluster uses Continuous Cloud Backup. If set to true, cloud_backup must also be set to true.
- project
Id String The unique ID for the project to create the database user.
- provider
Auto StringScaling Compute Max Instance Size Maximum instance size to which your cluster can automatically scale (e.g., M40). Required if
autoScaling.compute.enabled
istrue
.- provider
Auto StringScaling Compute Min Instance Size Minimum instance size to which your cluster can automatically scale (e.g., M10). Required if
autoScaling.compute.scaleDownEnabled
istrue
.- provider
Backup BooleanEnabled Flag indicating if the cluster uses Cloud Backup for backups. Deprecated use
cloud_backup
instead.This field is deprecated,please use cloud_backup instead
- provider
Disk IntegerIops The maximum input/output operations per second (IOPS) the system can perform. The possible values depend on the selected
provider_instance_size_name
anddisk_size_gb
. This setting requires thatprovider_instance_size_name
to be M30 or greater and cannot be used with clusters with local NVMe SSDs. The default value forprovider_disk_iops
is the same as the cluster tier's Standard IOPS value, as viewable in the Atlas console. It is used in cases where a higher number of IOPS is needed and possible. If a value is submitted that is lower or equal to the default IOPS value for the cluster tier Atlas ignores the requested value and uses the default. More details available under the providerSettings.diskIOPS parameter: MongoDB API Clusters- You do not need to configure IOPS for a STANDARD disk configuration but only for a PROVISIONED configuration.
- provider
Disk StringType Name Azure disk type of the server’s root volume. If omitted, Atlas uses the default disk type for the selected providerSettings.instanceSizeName. Example disk types and associated storage sizes: P4 - 32GB, P6 - 64GB, P10 - 128GB, P15 - 256GB, P20 - 512GB, P30 - 1024GB, P40 - 2048GB, P50 - 4095GB. More information and the most update to date disk types/storage sizes can be located at https://docs.atlas.mongodb.com/reference/api/clusters-create-one/.
- provider
Encrypt BooleanEbs Volume (Deprecated) The Flag is always true. Flag that indicates whether the Amazon EBS encryption feature encrypts the host's root volume for both data at rest within the volume and for data moving between the volume and the cluster. Note: This setting is always enabled for clusters with local NVMe SSDs. Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default..
All EBS volumes are encrypted by default, the option to disable encryption has been removed
- provider
Encrypt BooleanEbs Volume Flag - provider
Instance StringSize Name Atlas provides different instance sizes, each with a default storage capacity and RAM size. The instance size you select is used for all the data-bearing servers in your cluster. See Create a Cluster
providerSettings.instanceSizeName
for valid values and default resources.- provider
Name String Cloud service provider on which the servers are provisioned.
- provider
Region StringName Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas region name, see the reference list for AWS, GCP, Azure. Do not specify this field when creating a multi-region cluster using the replicationSpec document or a Global Cluster with the replicationSpecs array.
- provider
Volume StringType The type of the volume. The possible values are:
STANDARD
andPROVISIONED
.PROVISIONED
is ONLY required if setting IOPS higher than the default instance IOPS.- replication
Factor Integer Number of replica set members. Each member keeps a copy of your databases, providing high availability and data redundancy. The possible values are 3, 5, or 7. The default value is 3.
- replication
Specs List<ClusterReplication Spec Args> Configuration for cluster regions. See Replication Spec below for more details.
- snapshot
Backup List<ClusterPolicies Snapshot Backup Policy Args> current snapshot schedule and retention settings for the cluster.
- srv
Address String Connection string for connecting to the Atlas cluster. The +srv modifier forces the connection to use TLS/SSL. See the mongoURI for additional options.
- state
Name String Current state of the cluster. The possible states are:
- IDLE
- CREATING
- UPDATING
- DELETING
- DELETED
- REPAIRING
- 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. This parameter defaults to
LTS
. If you set this field toCONTINUOUS
, you must omit themongo_db_major_version
field. Atlas accepts:
- advanced
Configuration ClusterAdvanced Configuration Args - auto
Scaling booleanCompute Enabled Specifies whether cluster tier auto-scaling is enabled. The default is false.
- Set to
true
to enable cluster tier auto-scaling. If enabled, you must specify a value forproviderSettings.autoScaling.compute.maxInstanceSize
. - Set to
false
to disable cluster tier auto-scaling.
- Set to
- auto
Scaling booleanCompute Scale Down Enabled Set to
true
to enable the cluster tier to scale down. This option is only available ifautoScaling.compute.enabled
istrue
.- If this option is enabled, you must specify a value for
providerSettings.autoScaling.compute.minInstanceSize
- If this option is enabled, you must specify a value for
- auto
Scaling booleanDisk Gb Enabled Specifies whether disk auto-scaling is enabled. The default is true.
- Set to
true
to enable disk auto-scaling. - Set to
false
to disable disk auto-scaling.
- Set to
- backing
Provider stringName Cloud service provider on which the server for a multi-tenant cluster is provisioned.
- backup
Enabled boolean Clusters running MongoDB FCV 4.2 or later and any new Atlas clusters of any type do not support this parameter
- bi
Connector {[key: string]: string} Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details. DEPRECATED Use
bi_connector_config
instead.use bi_connector_config instead
- bi
Connector ClusterConfig Bi Connector Config Args Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details.
- cloud
Backup boolean Flag indicating if the cluster uses Cloud Backup for backups.
- cluster
Id string The cluster ID.
- cluster
Type string Specifies the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.
- connection
Strings ClusterConnection String Args[] 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.
- container
Id string The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created.
- disk
Size numberGb Capacity, in gigabytes, of the host’s root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive integer.
- The minimum disk size for dedicated clusters is 10GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value.
- Note: The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require additional storage space beyond this limitation, consider upgrading your cluster to a higher tier.
- Cannot be used with clusters with local NVMe SSDs
- Cannot be used with Azure clusters
- encryption
At stringRest Provider Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For complete documentation on configuring Encryption at Rest, see Encryption at Rest using Customer Key Management. Requires M10 or greater. and for legacy backups, backup_enabled, to be false or omitted. Note: Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default.
- labels
Cluster
Label Args[] - mongo
Db stringMajor Version Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters:
4.2
,4.4
,5.0
, or6.0
. If omitted, Atlas deploys a cluster that runs MongoDB 5.0. Ifprovider_instance_size_name
:M0
,M2
orM5
, Atlas deploys MongoDB 5.0. Atlas always deploys the cluster with the latest stable release of the specified version. See Release Notes for latest Current Stable Release.- mongo
Db stringVersion Version of MongoDB the cluster runs, in
major-version
.minor-version
format.- mongo
Uri string Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.
- mongo
Uri stringUpdated Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.
- mongo
Uri stringWith Options connection string for connecting to the Atlas cluster. Includes the replicaSet, ssl, and authSource query parameters in the connection string with values appropriate for the cluster.
- name string
Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed. WARNING Changing the name will result in destruction of the existing cluster and the creation of a new cluster.
- num
Shards number Selects whether the cluster is a replica set or a sharded cluster. If you use the replicationSpecs parameter, you must set num_shards.
- paused boolean
- pit
Enabled boolean Flag that indicates if the cluster uses Continuous Cloud Backup. If set to true, cloud_backup must also be set to true.
- project
Id string The unique ID for the project to create the database user.
- provider
Auto stringScaling Compute Max Instance Size Maximum instance size to which your cluster can automatically scale (e.g., M40). Required if
autoScaling.compute.enabled
istrue
.- provider
Auto stringScaling Compute Min Instance Size Minimum instance size to which your cluster can automatically scale (e.g., M10). Required if
autoScaling.compute.scaleDownEnabled
istrue
.- provider
Backup booleanEnabled Flag indicating if the cluster uses Cloud Backup for backups. Deprecated use
cloud_backup
instead.This field is deprecated,please use cloud_backup instead
- provider
Disk numberIops The maximum input/output operations per second (IOPS) the system can perform. The possible values depend on the selected
provider_instance_size_name
anddisk_size_gb
. This setting requires thatprovider_instance_size_name
to be M30 or greater and cannot be used with clusters with local NVMe SSDs. The default value forprovider_disk_iops
is the same as the cluster tier's Standard IOPS value, as viewable in the Atlas console. It is used in cases where a higher number of IOPS is needed and possible. If a value is submitted that is lower or equal to the default IOPS value for the cluster tier Atlas ignores the requested value and uses the default. More details available under the providerSettings.diskIOPS parameter: MongoDB API Clusters- You do not need to configure IOPS for a STANDARD disk configuration but only for a PROVISIONED configuration.
- provider
Disk stringType Name Azure disk type of the server’s root volume. If omitted, Atlas uses the default disk type for the selected providerSettings.instanceSizeName. Example disk types and associated storage sizes: P4 - 32GB, P6 - 64GB, P10 - 128GB, P15 - 256GB, P20 - 512GB, P30 - 1024GB, P40 - 2048GB, P50 - 4095GB. More information and the most update to date disk types/storage sizes can be located at https://docs.atlas.mongodb.com/reference/api/clusters-create-one/.
- provider
Encrypt booleanEbs Volume (Deprecated) The Flag is always true. Flag that indicates whether the Amazon EBS encryption feature encrypts the host's root volume for both data at rest within the volume and for data moving between the volume and the cluster. Note: This setting is always enabled for clusters with local NVMe SSDs. Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default..
All EBS volumes are encrypted by default, the option to disable encryption has been removed
- provider
Encrypt booleanEbs Volume Flag - provider
Instance stringSize Name Atlas provides different instance sizes, each with a default storage capacity and RAM size. The instance size you select is used for all the data-bearing servers in your cluster. See Create a Cluster
providerSettings.instanceSizeName
for valid values and default resources.- provider
Name string Cloud service provider on which the servers are provisioned.
- provider
Region stringName Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas region name, see the reference list for AWS, GCP, Azure. Do not specify this field when creating a multi-region cluster using the replicationSpec document or a Global Cluster with the replicationSpecs array.
- provider
Volume stringType The type of the volume. The possible values are:
STANDARD
andPROVISIONED
.PROVISIONED
is ONLY required if setting IOPS higher than the default instance IOPS.- replication
Factor number Number of replica set members. Each member keeps a copy of your databases, providing high availability and data redundancy. The possible values are 3, 5, or 7. The default value is 3.
- replication
Specs ClusterReplication Spec Args[] Configuration for cluster regions. See Replication Spec below for more details.
- snapshot
Backup ClusterPolicies Snapshot Backup Policy Args[] current snapshot schedule and retention settings for the cluster.
- srv
Address string Connection string for connecting to the Atlas cluster. The +srv modifier forces the connection to use TLS/SSL. See the mongoURI for additional options.
- state
Name string Current state of the cluster. The possible states are:
- IDLE
- CREATING
- UPDATING
- DELETING
- DELETED
- REPAIRING
- 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. This parameter defaults to
LTS
. If you set this field toCONTINUOUS
, you must omit themongo_db_major_version
field. Atlas accepts:
- advanced_
configuration ClusterAdvanced Configuration Args - auto_
scaling_ boolcompute_ enabled Specifies whether cluster tier auto-scaling is enabled. The default is false.
- Set to
true
to enable cluster tier auto-scaling. If enabled, you must specify a value forproviderSettings.autoScaling.compute.maxInstanceSize
. - Set to
false
to disable cluster tier auto-scaling.
- Set to
- auto_
scaling_ boolcompute_ scale_ down_ enabled Set to
true
to enable the cluster tier to scale down. This option is only available ifautoScaling.compute.enabled
istrue
.- If this option is enabled, you must specify a value for
providerSettings.autoScaling.compute.minInstanceSize
- If this option is enabled, you must specify a value for
- auto_
scaling_ booldisk_ gb_ enabled Specifies whether disk auto-scaling is enabled. The default is true.
- Set to
true
to enable disk auto-scaling. - Set to
false
to disable disk auto-scaling.
- Set to
- backing_
provider_ strname Cloud service provider on which the server for a multi-tenant cluster is provisioned.
- backup_
enabled bool Clusters running MongoDB FCV 4.2 or later and any new Atlas clusters of any type do not support this parameter
- bi_
connector Mapping[str, str] Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details. DEPRECATED Use
bi_connector_config
instead.use bi_connector_config instead
- bi_
connector_ Clusterconfig Bi Connector Config Args Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details.
- cloud_
backup bool Flag indicating if the cluster uses Cloud Backup for backups.
- cluster_
id str The cluster ID.
- cluster_
type str Specifies the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.
- connection_
strings Sequence[ClusterConnection String Args] 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.
- container_
id str The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created.
- disk_
size_ floatgb Capacity, in gigabytes, of the host’s root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive integer.
- The minimum disk size for dedicated clusters is 10GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value.
- Note: The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require additional storage space beyond this limitation, consider upgrading your cluster to a higher tier.
- Cannot be used with clusters with local NVMe SSDs
- Cannot be used with Azure clusters
- encryption_
at_ strrest_ provider Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For complete documentation on configuring Encryption at Rest, see Encryption at Rest using Customer Key Management. Requires M10 or greater. and for legacy backups, backup_enabled, to be false or omitted. Note: Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default.
- labels
Sequence[Cluster
Label Args] - mongo_
db_ strmajor_ version Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters:
4.2
,4.4
,5.0
, or6.0
. If omitted, Atlas deploys a cluster that runs MongoDB 5.0. Ifprovider_instance_size_name
:M0
,M2
orM5
, Atlas deploys MongoDB 5.0. Atlas always deploys the cluster with the latest stable release of the specified version. See Release Notes for latest Current Stable Release.- mongo_
db_ strversion Version of MongoDB the cluster runs, in
major-version
.minor-version
format.- mongo_
uri str Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.
- mongo_
uri_ strupdated Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.
- mongo_
uri_ strwith_ options connection string for connecting to the Atlas cluster. Includes the replicaSet, ssl, and authSource query parameters in the connection string with values appropriate for the cluster.
- name str
Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed. WARNING Changing the name will result in destruction of the existing cluster and the creation of a new cluster.
- num_
shards int Selects whether the cluster is a replica set or a sharded cluster. If you use the replicationSpecs parameter, you must set num_shards.
- paused bool
- pit_
enabled bool Flag that indicates if the cluster uses Continuous Cloud Backup. If set to true, cloud_backup must also be set to true.
- project_
id str The unique ID for the project to create the database user.
- provider_
auto_ strscaling_ compute_ max_ instance_ size Maximum instance size to which your cluster can automatically scale (e.g., M40). Required if
autoScaling.compute.enabled
istrue
.- provider_
auto_ strscaling_ compute_ min_ instance_ size Minimum instance size to which your cluster can automatically scale (e.g., M10). Required if
autoScaling.compute.scaleDownEnabled
istrue
.- provider_
backup_ boolenabled Flag indicating if the cluster uses Cloud Backup for backups. Deprecated use
cloud_backup
instead.This field is deprecated,please use cloud_backup instead
- provider_
disk_ intiops The maximum input/output operations per second (IOPS) the system can perform. The possible values depend on the selected
provider_instance_size_name
anddisk_size_gb
. This setting requires thatprovider_instance_size_name
to be M30 or greater and cannot be used with clusters with local NVMe SSDs. The default value forprovider_disk_iops
is the same as the cluster tier's Standard IOPS value, as viewable in the Atlas console. It is used in cases where a higher number of IOPS is needed and possible. If a value is submitted that is lower or equal to the default IOPS value for the cluster tier Atlas ignores the requested value and uses the default. More details available under the providerSettings.diskIOPS parameter: MongoDB API Clusters- You do not need to configure IOPS for a STANDARD disk configuration but only for a PROVISIONED configuration.
- provider_
disk_ strtype_ name Azure disk type of the server’s root volume. If omitted, Atlas uses the default disk type for the selected providerSettings.instanceSizeName. Example disk types and associated storage sizes: P4 - 32GB, P6 - 64GB, P10 - 128GB, P15 - 256GB, P20 - 512GB, P30 - 1024GB, P40 - 2048GB, P50 - 4095GB. More information and the most update to date disk types/storage sizes can be located at https://docs.atlas.mongodb.com/reference/api/clusters-create-one/.
- provider_
encrypt_ boolebs_ volume (Deprecated) The Flag is always true. Flag that indicates whether the Amazon EBS encryption feature encrypts the host's root volume for both data at rest within the volume and for data moving between the volume and the cluster. Note: This setting is always enabled for clusters with local NVMe SSDs. Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default..
All EBS volumes are encrypted by default, the option to disable encryption has been removed
- provider_
encrypt_ boolebs_ volume_ flag - provider_
instance_ strsize_ name Atlas provides different instance sizes, each with a default storage capacity and RAM size. The instance size you select is used for all the data-bearing servers in your cluster. See Create a Cluster
providerSettings.instanceSizeName
for valid values and default resources.- provider_
name str Cloud service provider on which the servers are provisioned.
- provider_
region_ strname Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas region name, see the reference list for AWS, GCP, Azure. Do not specify this field when creating a multi-region cluster using the replicationSpec document or a Global Cluster with the replicationSpecs array.
- provider_
volume_ strtype The type of the volume. The possible values are:
STANDARD
andPROVISIONED
.PROVISIONED
is ONLY required if setting IOPS higher than the default instance IOPS.- replication_
factor int Number of replica set members. Each member keeps a copy of your databases, providing high availability and data redundancy. The possible values are 3, 5, or 7. The default value is 3.
- replication_
specs Sequence[ClusterReplication Spec Args] Configuration for cluster regions. See Replication Spec below for more details.
- snapshot_
backup_ Sequence[Clusterpolicies Snapshot Backup Policy Args] current snapshot schedule and retention settings for the cluster.
- srv_
address str Connection string for connecting to the Atlas cluster. The +srv modifier forces the connection to use TLS/SSL. See the mongoURI for additional options.
- state_
name str Current state of the cluster. The possible states are:
- IDLE
- CREATING
- UPDATING
- DELETING
- DELETED
- REPAIRING
- 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. This parameter defaults to
LTS
. If you set this field toCONTINUOUS
, you must omit themongo_db_major_version
field. Atlas accepts:
- advanced
Configuration Property Map - auto
Scaling BooleanCompute Enabled Specifies whether cluster tier auto-scaling is enabled. The default is false.
- Set to
true
to enable cluster tier auto-scaling. If enabled, you must specify a value forproviderSettings.autoScaling.compute.maxInstanceSize
. - Set to
false
to disable cluster tier auto-scaling.
- Set to
- auto
Scaling BooleanCompute Scale Down Enabled Set to
true
to enable the cluster tier to scale down. This option is only available ifautoScaling.compute.enabled
istrue
.- If this option is enabled, you must specify a value for
providerSettings.autoScaling.compute.minInstanceSize
- If this option is enabled, you must specify a value for
- auto
Scaling BooleanDisk Gb Enabled Specifies whether disk auto-scaling is enabled. The default is true.
- Set to
true
to enable disk auto-scaling. - Set to
false
to disable disk auto-scaling.
- Set to
- backing
Provider StringName Cloud service provider on which the server for a multi-tenant cluster is provisioned.
- backup
Enabled Boolean Clusters running MongoDB FCV 4.2 or later and any new Atlas clusters of any type do not support this parameter
- bi
Connector Map<String> Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details. DEPRECATED Use
bi_connector_config
instead.use bi_connector_config instead
- bi
Connector Property MapConfig Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details.
- cloud
Backup Boolean Flag indicating if the cluster uses Cloud Backup for backups.
- cluster
Id String The cluster ID.
- cluster
Type String Specifies the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.
- connection
Strings List<Property Map> Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.
- container
Id String The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created.
- disk
Size NumberGb Capacity, in gigabytes, of the host’s root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive integer.
- The minimum disk size for dedicated clusters is 10GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value.
- Note: The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require additional storage space beyond this limitation, consider upgrading your cluster to a higher tier.
- Cannot be used with clusters with local NVMe SSDs
- Cannot be used with Azure clusters
- encryption
At StringRest Provider Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For complete documentation on configuring Encryption at Rest, see Encryption at Rest using Customer Key Management. Requires M10 or greater. and for legacy backups, backup_enabled, to be false or omitted. Note: Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default.
- labels List<Property Map>
- mongo
Db StringMajor Version Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters:
4.2
,4.4
,5.0
, or6.0
. If omitted, Atlas deploys a cluster that runs MongoDB 5.0. Ifprovider_instance_size_name
:M0
,M2
orM5
, Atlas deploys MongoDB 5.0. Atlas always deploys the cluster with the latest stable release of the specified version. See Release Notes for latest Current Stable Release.- mongo
Db StringVersion Version of MongoDB the cluster runs, in
major-version
.minor-version
format.- mongo
Uri String Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.
- mongo
Uri StringUpdated Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.
- mongo
Uri StringWith Options connection string for connecting to the Atlas cluster. Includes the replicaSet, ssl, and authSource query parameters in the connection string with values appropriate for the cluster.
- name String
Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed. WARNING Changing the name will result in destruction of the existing cluster and the creation of a new cluster.
- num
Shards Number Selects whether the cluster is a replica set or a sharded cluster. If you use the replicationSpecs parameter, you must set num_shards.
- paused Boolean
- pit
Enabled Boolean Flag that indicates if the cluster uses Continuous Cloud Backup. If set to true, cloud_backup must also be set to true.
- project
Id String The unique ID for the project to create the database user.
- provider
Auto StringScaling Compute Max Instance Size Maximum instance size to which your cluster can automatically scale (e.g., M40). Required if
autoScaling.compute.enabled
istrue
.- provider
Auto StringScaling Compute Min Instance Size Minimum instance size to which your cluster can automatically scale (e.g., M10). Required if
autoScaling.compute.scaleDownEnabled
istrue
.- provider
Backup BooleanEnabled Flag indicating if the cluster uses Cloud Backup for backups. Deprecated use
cloud_backup
instead.This field is deprecated,please use cloud_backup instead
- provider
Disk NumberIops The maximum input/output operations per second (IOPS) the system can perform. The possible values depend on the selected
provider_instance_size_name
anddisk_size_gb
. This setting requires thatprovider_instance_size_name
to be M30 or greater and cannot be used with clusters with local NVMe SSDs. The default value forprovider_disk_iops
is the same as the cluster tier's Standard IOPS value, as viewable in the Atlas console. It is used in cases where a higher number of IOPS is needed and possible. If a value is submitted that is lower or equal to the default IOPS value for the cluster tier Atlas ignores the requested value and uses the default. More details available under the providerSettings.diskIOPS parameter: MongoDB API Clusters- You do not need to configure IOPS for a STANDARD disk configuration but only for a PROVISIONED configuration.
- provider
Disk StringType Name Azure disk type of the server’s root volume. If omitted, Atlas uses the default disk type for the selected providerSettings.instanceSizeName. Example disk types and associated storage sizes: P4 - 32GB, P6 - 64GB, P10 - 128GB, P15 - 256GB, P20 - 512GB, P30 - 1024GB, P40 - 2048GB, P50 - 4095GB. More information and the most update to date disk types/storage sizes can be located at https://docs.atlas.mongodb.com/reference/api/clusters-create-one/.
- provider
Encrypt BooleanEbs Volume (Deprecated) The Flag is always true. Flag that indicates whether the Amazon EBS encryption feature encrypts the host's root volume for both data at rest within the volume and for data moving between the volume and the cluster. Note: This setting is always enabled for clusters with local NVMe SSDs. Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default..
All EBS volumes are encrypted by default, the option to disable encryption has been removed
- provider
Encrypt BooleanEbs Volume Flag - provider
Instance StringSize Name Atlas provides different instance sizes, each with a default storage capacity and RAM size. The instance size you select is used for all the data-bearing servers in your cluster. See Create a Cluster
providerSettings.instanceSizeName
for valid values and default resources.- provider
Name String Cloud service provider on which the servers are provisioned.
- provider
Region StringName Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas region name, see the reference list for AWS, GCP, Azure. Do not specify this field when creating a multi-region cluster using the replicationSpec document or a Global Cluster with the replicationSpecs array.
- provider
Volume StringType The type of the volume. The possible values are:
STANDARD
andPROVISIONED
.PROVISIONED
is ONLY required if setting IOPS higher than the default instance IOPS.- replication
Factor Number Number of replica set members. Each member keeps a copy of your databases, providing high availability and data redundancy. The possible values are 3, 5, or 7. The default value is 3.
- replication
Specs List<Property Map> Configuration for cluster regions. See Replication Spec below for more details.
- snapshot
Backup List<Property Map>Policies current snapshot schedule and retention settings for the cluster.
- srv
Address String Connection string for connecting to the Atlas cluster. The +srv modifier forces the connection to use TLS/SSL. See the mongoURI for additional options.
- state
Name String Current state of the cluster. The possible states are:
- IDLE
- CREATING
- UPDATING
- DELETING
- DELETED
- REPAIRING
- 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. This parameter defaults to
LTS
. If you set this field toCONTINUOUS
, you must omit themongo_db_major_version
field. Atlas accepts:
Supporting Types
ClusterAdvancedConfiguration
- 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.
- Note A minimum oplog retention is required when seeking to change a cluster's class to Local NVMe SSD. To learn more and for latest guidance see
oplogMinRetentionHours
- Note A minimum oplog retention is required when seeking to change a cluster's class to Local NVMe SSD. To learn more and for latest guidance see
- 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.
- 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.
- Note A minimum oplog retention is required when seeking to change a cluster's class to Local NVMe SSD. To learn more and for latest guidance see
oplogMinRetentionHours
- Note A minimum oplog retention is required when seeking to change a cluster's class to Local NVMe SSD. To learn more and for latest guidance see
- 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.
- 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.
- Note A minimum oplog retention is required when seeking to change a cluster's class to Local NVMe SSD. To learn more and for latest guidance see
oplogMinRetentionHours
- Note A minimum oplog retention is required when seeking to change a cluster's class to Local NVMe SSD. To learn more and for latest guidance see
- 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.
- 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.
- Note A minimum oplog retention is required when seeking to change a cluster's class to Local NVMe SSD. To learn more and for latest guidance see
oplogMinRetentionHours
- Note A minimum oplog retention is required when seeking to change a cluster's class to Local NVMe SSD. To learn more and for latest guidance see
- 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.
- 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.
- Note A minimum oplog retention is required when seeking to change a cluster's class to Local NVMe SSD. To learn more and for latest guidance see
oplogMinRetentionHours
- Note A minimum oplog retention is required when seeking to change a cluster's class to Local NVMe SSD. To learn more and for latest guidance see
- 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.
- 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.
- Note A minimum oplog retention is required when seeking to change a cluster's class to Local NVMe SSD. To learn more and for latest guidance see
oplogMinRetentionHours
- Note A minimum oplog retention is required when seeking to change a cluster's class to Local NVMe SSD. To learn more and for latest guidance see
- 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.
ClusterBiConnectorConfig
- Enabled bool
Specifies whether or not BI Connector for Atlas is enabled on the cluster.l *
- Set to
true
to enable BI Connector for Atlas. - Set to
false
to disable BI Connector for Atlas.
- Set to
- 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 *
- Set to
true
to enable BI Connector for Atlas. - Set to
false
to disable BI Connector for Atlas.
- Set to
- 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 *
- Set to
true
to enable BI Connector for Atlas. - Set to
false
to disable BI Connector for Atlas.
- Set to
- 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 *
- Set to
true
to enable BI Connector for Atlas. - Set to
false
to disable BI Connector for Atlas.
- Set to
- 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 *
- Set to
true
to enable BI Connector for Atlas. - Set to
false
to disable BI Connector for Atlas.
- Set to
- 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 *
- Set to
true
to enable BI Connector for Atlas. - Set to
false
to disable BI Connector for Atlas.
- Set to
- 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.
ClusterConnectionString
- Aws
Private Dictionary<string, object>Link This field is deprecated. Use connection_strings.private_endpoint[n].connection_string instead
- Aws
Private Dictionary<string, object>Link Srv This field is deprecated. Use connection_strings.private_endpoint[n].srv_connection_string instead
- Private string
- Private
Endpoints List<ClusterConnection String Private Endpoint> - Private
Srv string - Standard string
- Standard
Srv string
- Aws
Private map[string]interface{}Link This field is deprecated. Use connection_strings.private_endpoint[n].connection_string instead
- Aws
Private map[string]interface{}Link Srv This field is deprecated. Use connection_strings.private_endpoint[n].srv_connection_string instead
- Private string
- Private
Endpoints []ClusterConnection String Private Endpoint - Private
Srv string - Standard string
- Standard
Srv string
- aws
Private Map<String,Object>Link This field is deprecated. Use connection_strings.private_endpoint[n].connection_string instead
- aws
Private Map<String,Object>Link Srv This field is deprecated. Use connection_strings.private_endpoint[n].srv_connection_string instead
- private
Endpoints List<ClusterConnection String Private Endpoint> - private
Srv String - private_ String
- standard String
- standard
Srv String
- aws
Private {[key: string]: any}Link This field is deprecated. Use connection_strings.private_endpoint[n].connection_string instead
- aws
Private {[key: string]: any}Link Srv This field is deprecated. Use connection_strings.private_endpoint[n].srv_connection_string instead
- private string
- private
Endpoints ClusterConnection String Private Endpoint[] - private
Srv string - standard string
- standard
Srv string
- aws_
private_ Mapping[str, Any]link This field is deprecated. Use connection_strings.private_endpoint[n].connection_string instead
- aws_
private_ Mapping[str, Any]link_ srv This field is deprecated. Use connection_strings.private_endpoint[n].srv_connection_string instead
- private str
- private_
endpoints Sequence[ClusterConnection String Private Endpoint] - private_
srv str - standard str
- standard_
srv str
- aws
Private Map<Any>Link This field is deprecated. Use connection_strings.private_endpoint[n].connection_string instead
- aws
Private Map<Any>Link Srv This field is deprecated. Use connection_strings.private_endpoint[n].srv_connection_string instead
- private String
- private
Endpoints List<Property Map> - private
Srv String - standard String
- standard
Srv String
ClusterConnectionStringPrivateEndpoint
- connection
String String - endpoints List<Property Map>
- srv
Connection StringString - type String
ClusterConnectionStringPrivateEndpointEndpoint
- 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
ClusterLabel
ClusterReplicationSpec
- Num
Shards int Selects whether the cluster is a replica set or a sharded cluster. If you use the replicationSpecs parameter, you must set num_shards.
- Id string
Unique identifer of the replication document for a zone in a Global Cluster.
- Regions
Configs List<ClusterReplication Spec Regions Config> Physical location of the region. Each regionsConfig document describes the region’s priority in elections and the number and type of MongoDB nodes Atlas deploys to the region. You must order each regionsConfigs document by regionsConfig.priority, descending. See Region Config below for more details.
- Zone
Name string Name for the zone in a Global Cluster.
- Num
Shards int Selects whether the cluster is a replica set or a sharded cluster. If you use the replicationSpecs parameter, you must set num_shards.
- Id string
Unique identifer of the replication document for a zone in a Global Cluster.
- Regions
Configs []ClusterReplication Spec Regions Config Physical location of the region. Each regionsConfig document describes the region’s priority in elections and the number and type of MongoDB nodes Atlas deploys to the region. You must order each regionsConfigs document by regionsConfig.priority, descending. See Region Config below for more details.
- Zone
Name string Name for the zone in a Global Cluster.
- num
Shards Integer Selects whether the cluster is a replica set or a sharded cluster. If you use the replicationSpecs parameter, you must set num_shards.
- id String
Unique identifer of the replication document for a zone in a Global Cluster.
- regions
Configs List<ClusterReplication Spec Regions Config> Physical location of the region. Each regionsConfig document describes the region’s priority in elections and the number and type of MongoDB nodes Atlas deploys to the region. You must order each regionsConfigs document by regionsConfig.priority, descending. See Region Config below for more details.
- zone
Name String Name for the zone in a Global Cluster.
- num
Shards number Selects whether the cluster is a replica set or a sharded cluster. If you use the replicationSpecs parameter, you must set num_shards.
- id string
Unique identifer of the replication document for a zone in a Global Cluster.
- regions
Configs ClusterReplication Spec Regions Config[] Physical location of the region. Each regionsConfig document describes the region’s priority in elections and the number and type of MongoDB nodes Atlas deploys to the region. You must order each regionsConfigs document by regionsConfig.priority, descending. See Region Config below for more details.
- zone
Name string Name for the zone in a Global Cluster.
- num_
shards int Selects whether the cluster is a replica set or a sharded cluster. If you use the replicationSpecs parameter, you must set num_shards.
- id str
Unique identifer of the replication document for a zone in a Global Cluster.
- regions_
configs Sequence[ClusterReplication Spec Regions Config] Physical location of the region. Each regionsConfig document describes the region’s priority in elections and the number and type of MongoDB nodes Atlas deploys to the region. You must order each regionsConfigs document by regionsConfig.priority, descending. See Region Config below for more details.
- zone_
name str Name for the zone in a Global Cluster.
- num
Shards Number Selects whether the cluster is a replica set or a sharded cluster. If you use the replicationSpecs parameter, you must set num_shards.
- id String
Unique identifer of the replication document for a zone in a Global Cluster.
- regions
Configs List<Property Map> Physical location of the region. Each regionsConfig document describes the region’s priority in elections and the number and type of MongoDB nodes Atlas deploys to the region. You must order each regionsConfigs document by regionsConfig.priority, descending. See Region Config below for more details.
- zone
Name String Name for the zone in a Global Cluster.
ClusterReplicationSpecRegionsConfig
- Region
Name string Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas region name, see the reference list for AWS, GCP, Azure.
- Analytics
Nodes int The number of analytics nodes for Atlas to deploy to the region. Analytics nodes are useful for handling analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only, and can never become the primary. If you do not specify this option, no analytics nodes are deployed to the region.
- Electable
Nodes int Number of electable nodes for Atlas to deploy to the region. Electable nodes can become the primary and can facilitate local reads.
- The total number of electableNodes across all replication spec regions must total 3, 5, or 7.
- Specify 0 if you do not want any electable nodes in the region.
- You cannot create electable nodes in a region if
priority
is 0.
- Priority int
Election priority of the region. For regions with only read-only nodes, set this value to 0.
- For regions where
electable_nodes
is at least 1, each region must have a priority of exactly one (1) less than the previous region. The first region must have a priority of 7. The lowest possible priority is 1. - The priority 7 region identifies the Preferred Region of the cluster. Atlas places the primary node in the Preferred Region. Priorities 1 through 7 are exclusive - no more than one region per cluster can be assigned a given priority.
- Example: If you have three regions, their priorities would be 7, 6, and 5 respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be 4 and 3 respectively.
- For regions where
- Read
Only intNodes Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can facilitate local-reads. Specify 0 if you do not want any read-only nodes in the region.
- Region
Name string Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas region name, see the reference list for AWS, GCP, Azure.
- Analytics
Nodes int The number of analytics nodes for Atlas to deploy to the region. Analytics nodes are useful for handling analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only, and can never become the primary. If you do not specify this option, no analytics nodes are deployed to the region.
- Electable
Nodes int Number of electable nodes for Atlas to deploy to the region. Electable nodes can become the primary and can facilitate local reads.
- The total number of electableNodes across all replication spec regions must total 3, 5, or 7.
- Specify 0 if you do not want any electable nodes in the region.
- You cannot create electable nodes in a region if
priority
is 0.
- Priority int
Election priority of the region. For regions with only read-only nodes, set this value to 0.
- For regions where
electable_nodes
is at least 1, each region must have a priority of exactly one (1) less than the previous region. The first region must have a priority of 7. The lowest possible priority is 1. - The priority 7 region identifies the Preferred Region of the cluster. Atlas places the primary node in the Preferred Region. Priorities 1 through 7 are exclusive - no more than one region per cluster can be assigned a given priority.
- Example: If you have three regions, their priorities would be 7, 6, and 5 respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be 4 and 3 respectively.
- For regions where
- Read
Only intNodes Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can facilitate local-reads. Specify 0 if you do not want any read-only nodes in the region.
- region
Name String Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas region name, see the reference list for AWS, GCP, Azure.
- analytics
Nodes Integer The number of analytics nodes for Atlas to deploy to the region. Analytics nodes are useful for handling analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only, and can never become the primary. If you do not specify this option, no analytics nodes are deployed to the region.
- electable
Nodes Integer Number of electable nodes for Atlas to deploy to the region. Electable nodes can become the primary and can facilitate local reads.
- The total number of electableNodes across all replication spec regions must total 3, 5, or 7.
- Specify 0 if you do not want any electable nodes in the region.
- You cannot create electable nodes in a region if
priority
is 0.
- priority Integer
Election priority of the region. For regions with only read-only nodes, set this value to 0.
- For regions where
electable_nodes
is at least 1, each region must have a priority of exactly one (1) less than the previous region. The first region must have a priority of 7. The lowest possible priority is 1. - The priority 7 region identifies the Preferred Region of the cluster. Atlas places the primary node in the Preferred Region. Priorities 1 through 7 are exclusive - no more than one region per cluster can be assigned a given priority.
- Example: If you have three regions, their priorities would be 7, 6, and 5 respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be 4 and 3 respectively.
- For regions where
- read
Only IntegerNodes Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can facilitate local-reads. Specify 0 if you do not want any read-only nodes in the region.
- region
Name string Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas region name, see the reference list for AWS, GCP, Azure.
- analytics
Nodes number The number of analytics nodes for Atlas to deploy to the region. Analytics nodes are useful for handling analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only, and can never become the primary. If you do not specify this option, no analytics nodes are deployed to the region.
- electable
Nodes number Number of electable nodes for Atlas to deploy to the region. Electable nodes can become the primary and can facilitate local reads.
- The total number of electableNodes across all replication spec regions must total 3, 5, or 7.
- Specify 0 if you do not want any electable nodes in the region.
- You cannot create electable nodes in a region if
priority
is 0.
- priority number
Election priority of the region. For regions with only read-only nodes, set this value to 0.
- For regions where
electable_nodes
is at least 1, each region must have a priority of exactly one (1) less than the previous region. The first region must have a priority of 7. The lowest possible priority is 1. - The priority 7 region identifies the Preferred Region of the cluster. Atlas places the primary node in the Preferred Region. Priorities 1 through 7 are exclusive - no more than one region per cluster can be assigned a given priority.
- Example: If you have three regions, their priorities would be 7, 6, and 5 respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be 4 and 3 respectively.
- For regions where
- read
Only numberNodes Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can facilitate local-reads. Specify 0 if you do not want any read-only nodes in the region.
- region_
name str Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas region name, see the reference list for AWS, GCP, Azure.
- analytics_
nodes int The number of analytics nodes for Atlas to deploy to the region. Analytics nodes are useful for handling analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only, and can never become the primary. If you do not specify this option, no analytics nodes are deployed to the region.
- electable_
nodes int Number of electable nodes for Atlas to deploy to the region. Electable nodes can become the primary and can facilitate local reads.
- The total number of electableNodes across all replication spec regions must total 3, 5, or 7.
- Specify 0 if you do not want any electable nodes in the region.
- You cannot create electable nodes in a region if
priority
is 0.
- priority int
Election priority of the region. For regions with only read-only nodes, set this value to 0.
- For regions where
electable_nodes
is at least 1, each region must have a priority of exactly one (1) less than the previous region. The first region must have a priority of 7. The lowest possible priority is 1. - The priority 7 region identifies the Preferred Region of the cluster. Atlas places the primary node in the Preferred Region. Priorities 1 through 7 are exclusive - no more than one region per cluster can be assigned a given priority.
- Example: If you have three regions, their priorities would be 7, 6, and 5 respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be 4 and 3 respectively.
- For regions where
- read_
only_ intnodes Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can facilitate local-reads. Specify 0 if you do not want any read-only nodes in the region.
- region
Name String Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas region name, see the reference list for AWS, GCP, Azure.
- analytics
Nodes Number The number of analytics nodes for Atlas to deploy to the region. Analytics nodes are useful for handling analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only, and can never become the primary. If you do not specify this option, no analytics nodes are deployed to the region.
- electable
Nodes Number Number of electable nodes for Atlas to deploy to the region. Electable nodes can become the primary and can facilitate local reads.
- The total number of electableNodes across all replication spec regions must total 3, 5, or 7.
- Specify 0 if you do not want any electable nodes in the region.
- You cannot create electable nodes in a region if
priority
is 0.
- priority Number
Election priority of the region. For regions with only read-only nodes, set this value to 0.
- For regions where
electable_nodes
is at least 1, each region must have a priority of exactly one (1) less than the previous region. The first region must have a priority of 7. The lowest possible priority is 1. - The priority 7 region identifies the Preferred Region of the cluster. Atlas places the primary node in the Preferred Region. Priorities 1 through 7 are exclusive - no more than one region per cluster can be assigned a given priority.
- Example: If you have three regions, their priorities would be 7, 6, and 5 respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be 4 and 3 respectively.
- For regions where
- read
Only NumberNodes Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can facilitate local-reads. Specify 0 if you do not want any read-only nodes in the region.
ClusterSnapshotBackupPolicy
- Cluster
Id string The cluster ID.
- Cluster
Name string - Next
Snapshot string - Policies
List<Cluster
Snapshot Backup Policy Policy> - Reference
Hour intOf Day - Reference
Minute intOf Hour - Restore
Window intDays - Update
Snapshots bool
- Cluster
Id string The cluster ID.
- Cluster
Name string - Next
Snapshot string - Policies
[]Cluster
Snapshot Backup Policy Policy - Reference
Hour intOf Day - Reference
Minute intOf Hour - Restore
Window intDays - Update
Snapshots bool
- cluster
Id String The cluster ID.
- cluster
Name String - next
Snapshot String - policies
List<Cluster
Snapshot Backup Policy Policy> - reference
Hour IntegerOf Day - reference
Minute IntegerOf Hour - restore
Window IntegerDays - update
Snapshots Boolean
- cluster
Id string The cluster ID.
- cluster
Name string - next
Snapshot string - policies
Cluster
Snapshot Backup Policy Policy[] - reference
Hour numberOf Day - reference
Minute numberOf Hour - restore
Window numberDays - update
Snapshots boolean
- cluster_
id str The cluster ID.
- cluster_
name str - next_
snapshot str - policies
Sequence[Cluster
Snapshot Backup Policy Policy] - reference_
hour_ intof_ day - reference_
minute_ intof_ hour - restore_
window_ intdays - update_
snapshots bool
- cluster
Id String The cluster ID.
- cluster
Name String - next
Snapshot String - policies List<Property Map>
- reference
Hour NumberOf Day - reference
Minute NumberOf Hour - restore
Window NumberDays - update
Snapshots Boolean
ClusterSnapshotBackupPolicyPolicy
- Id string
Unique identifer of the replication document for a zone in a Global Cluster.
- Policy
Items List<ClusterSnapshot Backup Policy Policy Policy Item>
- Id string
Unique identifer of the replication document for a zone in a Global Cluster.
- Policy
Items []ClusterSnapshot Backup Policy Policy Policy Item
- id String
Unique identifer of the replication document for a zone in a Global Cluster.
- policy
Items List<ClusterSnapshot Backup Policy Policy Policy Item>
- id string
Unique identifer of the replication document for a zone in a Global Cluster.
- policy
Items ClusterSnapshot Backup Policy Policy Policy Item[]
- id str
Unique identifer of the replication document for a zone in a Global Cluster.
- policy_
items Sequence[ClusterSnapshot Backup Policy Policy Policy Item]
- id String
Unique identifer of the replication document for a zone in a Global Cluster.
- policy
Items List<Property Map>
ClusterSnapshotBackupPolicyPolicyPolicyItem
- Frequency
Interval int - Frequency
Type string - Id string
Unique identifer of the replication document for a zone in a Global Cluster.
- Retention
Unit string - Retention
Value int
- Frequency
Interval int - Frequency
Type string - Id string
Unique identifer of the replication document for a zone in a Global Cluster.
- Retention
Unit string - Retention
Value int
- frequency
Interval Integer - frequency
Type String - id String
Unique identifer of the replication document for a zone in a Global Cluster.
- retention
Unit String - retention
Value Integer
- frequency
Interval number - frequency
Type string - id string
Unique identifer of the replication document for a zone in a Global Cluster.
- retention
Unit string - retention
Value number
- frequency_
interval int - frequency_
type str - id str
Unique identifer of the replication document for a zone in a Global Cluster.
- retention_
unit str - retention_
value int
- frequency
Interval Number - frequency
Type String - id String
Unique identifer of the replication document for a zone in a Global Cluster.
- retention
Unit String - retention
Value Number
Package Details
- Repository
- MongoDB Atlas pulumi/pulumi-mongodbatlas
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
mongodbatlas
Terraform Provider.