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:

ProjectId string

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

ProviderInstanceSizeName string

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.

ProviderName string

Cloud service provider on which the servers are provisioned.

AdvancedConfiguration ClusterAdvancedConfigurationArgs

AutoScalingComputeEnabled bool

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 for providerSettings.autoScaling.compute.maxInstanceSize.
Set to false to disable cluster tier auto-scaling.

AutoScalingComputeScaleDownEnabled bool

Set to true to enable the cluster tier to scale down. This option is only available if autoScaling.compute.enabled is true.

If this option is enabled, you must specify a value for providerSettings.autoScaling.compute.minInstanceSize

AutoScalingDiskGbEnabled bool

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.

BackingProviderName string

Cloud service provider on which the server for a multi-tenant cluster is provisioned.

BackupEnabled bool

Clusters running MongoDB FCV 4.2 or later and any new Atlas clusters of any type do not support this parameter

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

Deprecated:

use bi_connector_config instead

BiConnectorConfig ClusterBiConnectorConfigArgs

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.

CloudBackup bool

Flag indicating if the cluster uses Cloud Backup for backups.

ClusterType string

Specifies the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.

DiskSizeGb double

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

EncryptionAtRestProvider string

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

MongoDbMajorVersion string

Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters: 4.2, 4.4, 5.0, or 6.0. If omitted, Atlas deploys a cluster that runs MongoDB 5.0. If provider_instance_size_name: M0, M2 or M5, 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.

NumShards 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

PitEnabled bool

Flag that indicates if the cluster uses Continuous Cloud Backup. If set to true, cloud_backup must also be set to true.

ProviderAutoScalingComputeMaxInstanceSize string

Maximum instance size to which your cluster can automatically scale (e.g., M40). Required if autoScaling.compute.enabled is true.

ProviderAutoScalingComputeMinInstanceSize string

Minimum instance size to which your cluster can automatically scale (e.g., M10). Required if autoScaling.compute.scaleDownEnabled is true.

ProviderBackupEnabled bool

Flag indicating if the cluster uses Cloud Backup for backups. Deprecated use cloud_backup instead.

Deprecated:

This field is deprecated,please use cloud_backup instead

ProviderDiskIops int

The maximum input/output operations per second (IOPS) the system can perform. The possible values depend on the selected provider_instance_size_name and disk_size_gb. This setting requires that provider_instance_size_name to be M30 or greater and cannot be used with clusters with local NVMe SSDs. The default value for provider_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.

ProviderDiskTypeName string

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

ProviderEncryptEbsVolume bool

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

Deprecated:

All EBS volumes are encrypted by default, the option to disable encryption has been removed

ProviderRegionName 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. Do not specify this field when creating a multi-region cluster using the replicationSpec document or a Global Cluster with the replicationSpecs array.

ProviderVolumeType string

The type of the volume. The possible values are: STANDARD and PROVISIONED. PROVISIONED is ONLY required if setting IOPS higher than the default instance IOPS.

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

ReplicationSpecs List<ClusterReplicationSpecArgs>

Configuration for cluster regions. See Replication Spec below for more details.

TerminationProtectionEnabled bool

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

VersionReleaseSystem string

Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:

ProjectId string

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

ProviderInstanceSizeName string

ProviderName string

Cloud service provider on which the servers are provisioned.

AdvancedConfiguration ClusterAdvancedConfigurationArgs

AutoScalingComputeEnabled bool

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 for providerSettings.autoScaling.compute.maxInstanceSize.
Set to false to disable cluster tier auto-scaling.

AutoScalingComputeScaleDownEnabled bool

Set to true to enable the cluster tier to scale down. This option is only available if autoScaling.compute.enabled is true.

If this option is enabled, you must specify a value for providerSettings.autoScaling.compute.minInstanceSize

AutoScalingDiskGbEnabled bool

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.

BackingProviderName string

Cloud service provider on which the server for a multi-tenant cluster is provisioned.

BackupEnabled bool

Clusters running MongoDB FCV 4.2 or later and any new Atlas clusters of any type do not support this parameter

BiConnector map[string]string

Deprecated:

use bi_connector_config instead

BiConnectorConfig ClusterBiConnectorConfigArgs

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.

CloudBackup bool

Flag indicating if the cluster uses Cloud Backup for backups.

ClusterType string

Specifies the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.

DiskSizeGb float64

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

EncryptionAtRestProvider string

Labels []ClusterLabelArgs

MongoDbMajorVersion string

Name string

NumShards 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

PitEnabled bool

Flag that indicates if the cluster uses Continuous Cloud Backup. If set to true, cloud_backup must also be set to true.

ProviderAutoScalingComputeMaxInstanceSize string

Maximum instance size to which your cluster can automatically scale (e.g., M40). Required if autoScaling.compute.enabled is true.

ProviderAutoScalingComputeMinInstanceSize string

Minimum instance size to which your cluster can automatically scale (e.g., M10). Required if autoScaling.compute.scaleDownEnabled is true.

ProviderBackupEnabled bool

Flag indicating if the cluster uses Cloud Backup for backups. Deprecated use cloud_backup instead.

Deprecated:

This field is deprecated,please use cloud_backup instead

ProviderDiskIops int

You do not need to configure IOPS for a STANDARD disk configuration but only for a PROVISIONED configuration.

ProviderDiskTypeName string

ProviderEncryptEbsVolume bool

Deprecated:

All EBS volumes are encrypted by default, the option to disable encryption has been removed

ProviderRegionName string

ProviderVolumeType string

The type of the volume. The possible values are: STANDARD and PROVISIONED. PROVISIONED is ONLY required if setting IOPS higher than the default instance IOPS.

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

ReplicationSpecs []ClusterReplicationSpecArgs

Configuration for cluster regions. See Replication Spec below for more details.

TerminationProtectionEnabled bool

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

VersionReleaseSystem string

Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:

projectId String

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

providerInstanceSizeName String

providerName String

Cloud service provider on which the servers are provisioned.

advancedConfiguration ClusterAdvancedConfigurationArgs

autoScalingComputeEnabled Boolean

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 for providerSettings.autoScaling.compute.maxInstanceSize.
Set to false to disable cluster tier auto-scaling.

autoScalingComputeScaleDownEnabled Boolean

Set to true to enable the cluster tier to scale down. This option is only available if autoScaling.compute.enabled is true.

If this option is enabled, you must specify a value for providerSettings.autoScaling.compute.minInstanceSize

autoScalingDiskGbEnabled Boolean

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.

backingProviderName String

Cloud service provider on which the server for a multi-tenant cluster is provisioned.

backupEnabled Boolean

Clusters running MongoDB FCV 4.2 or later and any new Atlas clusters of any type do not support this parameter

biConnector Map<String,String>

Deprecated:

use bi_connector_config instead

biConnectorConfig ClusterBiConnectorConfigArgs

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.

cloudBackup Boolean

Flag indicating if the cluster uses Cloud Backup for backups.

clusterType String

Specifies the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.

diskSizeGb Double

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

encryptionAtRestProvider String

labels List<ClusterLabelArgs>

mongoDbMajorVersion String

name String

numShards 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

pitEnabled Boolean

Flag that indicates if the cluster uses Continuous Cloud Backup. If set to true, cloud_backup must also be set to true.

providerAutoScalingComputeMaxInstanceSize String

Maximum instance size to which your cluster can automatically scale (e.g., M40). Required if autoScaling.compute.enabled is true.

providerAutoScalingComputeMinInstanceSize String

Minimum instance size to which your cluster can automatically scale (e.g., M10). Required if autoScaling.compute.scaleDownEnabled is true.

providerBackupEnabled Boolean

Flag indicating if the cluster uses Cloud Backup for backups. Deprecated use cloud_backup instead.

Deprecated:

This field is deprecated,please use cloud_backup instead

providerDiskIops Integer

You do not need to configure IOPS for a STANDARD disk configuration but only for a PROVISIONED configuration.

providerDiskTypeName String

providerEncryptEbsVolume Boolean

Deprecated:

All EBS volumes are encrypted by default, the option to disable encryption has been removed

providerRegionName String

providerVolumeType String

The type of the volume. The possible values are: STANDARD and PROVISIONED. PROVISIONED is ONLY required if setting IOPS higher than the default instance IOPS.

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

replicationSpecs List<ClusterReplicationSpecArgs>

Configuration for cluster regions. See Replication Spec below for more details.

terminationProtectionEnabled Boolean

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

versionReleaseSystem String

Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:

projectId string

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

providerInstanceSizeName string

providerName string

Cloud service provider on which the servers are provisioned.

advancedConfiguration ClusterAdvancedConfigurationArgs

autoScalingComputeEnabled boolean

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 for providerSettings.autoScaling.compute.maxInstanceSize.
Set to false to disable cluster tier auto-scaling.

autoScalingComputeScaleDownEnabled boolean

Set to true to enable the cluster tier to scale down. This option is only available if autoScaling.compute.enabled is true.

If this option is enabled, you must specify a value for providerSettings.autoScaling.compute.minInstanceSize

autoScalingDiskGbEnabled boolean

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.

backingProviderName string

Cloud service provider on which the server for a multi-tenant cluster is provisioned.

backupEnabled boolean

Clusters running MongoDB FCV 4.2 or later and any new Atlas clusters of any type do not support this parameter

biConnector {[key: string]: string}

Deprecated:

use bi_connector_config instead

biConnectorConfig ClusterBiConnectorConfigArgs

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.

cloudBackup boolean

Flag indicating if the cluster uses Cloud Backup for backups.

clusterType string

Specifies the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.

diskSizeGb number

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

encryptionAtRestProvider string

labels ClusterLabelArgs[]

mongoDbMajorVersion string

name string

numShards 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

pitEnabled boolean

Flag that indicates if the cluster uses Continuous Cloud Backup. If set to true, cloud_backup must also be set to true.

providerAutoScalingComputeMaxInstanceSize string

Maximum instance size to which your cluster can automatically scale (e.g., M40). Required if autoScaling.compute.enabled is true.

providerAutoScalingComputeMinInstanceSize string

Minimum instance size to which your cluster can automatically scale (e.g., M10). Required if autoScaling.compute.scaleDownEnabled is true.

providerBackupEnabled boolean

Flag indicating if the cluster uses Cloud Backup for backups. Deprecated use cloud_backup instead.

Deprecated:

This field is deprecated,please use cloud_backup instead

providerDiskIops number

You do not need to configure IOPS for a STANDARD disk configuration but only for a PROVISIONED configuration.

providerDiskTypeName string

providerEncryptEbsVolume boolean

Deprecated:

All EBS volumes are encrypted by default, the option to disable encryption has been removed

providerRegionName string

providerVolumeType string

The type of the volume. The possible values are: STANDARD and PROVISIONED. PROVISIONED is ONLY required if setting IOPS higher than the default instance IOPS.

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

replicationSpecs ClusterReplicationSpecArgs[]

Configuration for cluster regions. See Replication Spec below for more details.

terminationProtectionEnabled boolean

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

versionReleaseSystem string

Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:

project_id str

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

provider_instance_size_name str

provider_name str

Cloud service provider on which the servers are provisioned.

advanced_configuration ClusterAdvancedConfigurationArgs

auto_scaling_compute_enabled bool

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 for providerSettings.autoScaling.compute.maxInstanceSize.
Set to false to disable cluster tier auto-scaling.

auto_scaling_compute_scale_down_enabled bool

Set to true to enable the cluster tier to scale down. This option is only available if autoScaling.compute.enabled is true.

If this option is enabled, you must specify a value for providerSettings.autoScaling.compute.minInstanceSize

auto_scaling_disk_gb_enabled bool

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.

backing_provider_name str

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]

Deprecated:

use bi_connector_config instead

bi_connector_config ClusterBiConnectorConfigArgs

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_gb float

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_rest_provider str

labels Sequence[ClusterLabelArgs]

mongo_db_major_version str

name str

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_scaling_compute_max_instance_size str

Maximum instance size to which your cluster can automatically scale (e.g., M40). Required if autoScaling.compute.enabled is true.

provider_auto_scaling_compute_min_instance_size str

Minimum instance size to which your cluster can automatically scale (e.g., M10). Required if autoScaling.compute.scaleDownEnabled is true.

provider_backup_enabled bool

Flag indicating if the cluster uses Cloud Backup for backups. Deprecated use cloud_backup instead.

Deprecated:

This field is deprecated,please use cloud_backup instead

provider_disk_iops int

You do not need to configure IOPS for a STANDARD disk configuration but only for a PROVISIONED configuration.

provider_disk_type_name str

provider_encrypt_ebs_volume bool

Deprecated:

All EBS volumes are encrypted by default, the option to disable encryption has been removed

provider_region_name str

provider_volume_type str

The type of the volume. The possible values are: STANDARD and PROVISIONED. 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[ClusterReplicationSpecArgs]

Configuration for cluster regions. See Replication Spec below for more details.

termination_protection_enabled bool

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

version_release_system str

Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:

projectId String

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

providerInstanceSizeName String

providerName String

Cloud service provider on which the servers are provisioned.

advancedConfiguration Property Map

autoScalingComputeEnabled Boolean

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 for providerSettings.autoScaling.compute.maxInstanceSize.
Set to false to disable cluster tier auto-scaling.

autoScalingComputeScaleDownEnabled Boolean

Set to true to enable the cluster tier to scale down. This option is only available if autoScaling.compute.enabled is true.

If this option is enabled, you must specify a value for providerSettings.autoScaling.compute.minInstanceSize

autoScalingDiskGbEnabled Boolean

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.

backingProviderName String

Cloud service provider on which the server for a multi-tenant cluster is provisioned.

backupEnabled Boolean

Clusters running MongoDB FCV 4.2 or later and any new Atlas clusters of any type do not support this parameter

biConnector Map<String>

Deprecated:

use bi_connector_config instead

biConnectorConfig Property Map

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.

cloudBackup Boolean

Flag indicating if the cluster uses Cloud Backup for backups.

clusterType String

Specifies the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.

diskSizeGb Number

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

encryptionAtRestProvider String

labels List<Property Map>

mongoDbMajorVersion String

name String

numShards 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

pitEnabled Boolean

Flag that indicates if the cluster uses Continuous Cloud Backup. If set to true, cloud_backup must also be set to true.

providerAutoScalingComputeMaxInstanceSize String

Maximum instance size to which your cluster can automatically scale (e.g., M40). Required if autoScaling.compute.enabled is true.

providerAutoScalingComputeMinInstanceSize String

Minimum instance size to which your cluster can automatically scale (e.g., M10). Required if autoScaling.compute.scaleDownEnabled is true.

providerBackupEnabled Boolean

Flag indicating if the cluster uses Cloud Backup for backups. Deprecated use cloud_backup instead.

Deprecated:

This field is deprecated,please use cloud_backup instead

providerDiskIops Number

You do not need to configure IOPS for a STANDARD disk configuration but only for a PROVISIONED configuration.

providerDiskTypeName String

providerEncryptEbsVolume Boolean

Deprecated:

All EBS volumes are encrypted by default, the option to disable encryption has been removed

providerRegionName String

providerVolumeType String

The type of the volume. The possible values are: STANDARD and PROVISIONED. PROVISIONED is ONLY required if setting IOPS higher than the default instance IOPS.

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

replicationSpecs List<Property Map>

Configuration for cluster regions. See Replication Spec below for more details.

terminationProtectionEnabled Boolean

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

versionReleaseSystem String

Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_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:

ClusterId string

The cluster ID.

ConnectionStrings List<ClusterConnectionString>

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.

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

MongoDbVersion string

Version of MongoDB the cluster runs, in major-version.minor-version format.

MongoUri string

Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.

MongoUriUpdated string

Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.

MongoUriWithOptions string

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.

ProviderEncryptEbsVolumeFlag bool

SnapshotBackupPolicies List<ClusterSnapshotBackupPolicy>

current snapshot schedule and retention settings for the cluster.

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

StateName string

Current state of the cluster. The possible states are:

IDLE
CREATING
UPDATING
DELETING
DELETED
REPAIRING

ClusterId string

The cluster ID.

ConnectionStrings []ClusterConnectionString

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

MongoDbVersion string

Version of MongoDB the cluster runs, in major-version.minor-version format.

MongoUri string

Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.

MongoUriUpdated string

Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.

MongoUriWithOptions string

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.

ProviderEncryptEbsVolumeFlag bool

SnapshotBackupPolicies []ClusterSnapshotBackupPolicy

current snapshot schedule and retention settings for the cluster.

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

StateName string

Current state of the cluster. The possible states are:

IDLE
CREATING
UPDATING
DELETING
DELETED
REPAIRING

clusterId String

The cluster ID.

connectionStrings List<ClusterConnectionString>

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

mongoDbVersion String

Version of MongoDB the cluster runs, in major-version.minor-version format.

mongoUri String

Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.

mongoUriUpdated String

Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.

mongoUriWithOptions String

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.

providerEncryptEbsVolumeFlag Boolean

snapshotBackupPolicies List<ClusterSnapshotBackupPolicy>

current snapshot schedule and retention settings for the cluster.

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

stateName String

Current state of the cluster. The possible states are:

IDLE
CREATING
UPDATING
DELETING
DELETED
REPAIRING

clusterId string

The cluster ID.

connectionStrings ClusterConnectionString[]

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

mongoDbVersion string

Version of MongoDB the cluster runs, in major-version.minor-version format.

mongoUri string

Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.

mongoUriUpdated string

Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.

mongoUriWithOptions string

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.

providerEncryptEbsVolumeFlag boolean

snapshotBackupPolicies ClusterSnapshotBackupPolicy[]

current snapshot schedule and retention settings for the cluster.

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

stateName 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[ClusterConnectionString]

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_version str

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_updated str

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_with_options str

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_ebs_volume_flag bool

snapshot_backup_policies Sequence[ClusterSnapshotBackupPolicy]

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

clusterId String

The cluster ID.

connectionStrings List<Property Map>

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

mongoDbVersion String

Version of MongoDB the cluster runs, in major-version.minor-version format.

mongoUri String

Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.

mongoUriUpdated String

Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.

mongoUriWithOptions String

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.

providerEncryptEbsVolumeFlag Boolean

snapshotBackupPolicies List<Property Map>

current snapshot schedule and retention settings for the cluster.

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

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

The following state arguments are supported:

AdvancedConfiguration ClusterAdvancedConfigurationArgs

AutoScalingComputeEnabled bool

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 for providerSettings.autoScaling.compute.maxInstanceSize.
Set to false to disable cluster tier auto-scaling.

AutoScalingComputeScaleDownEnabled bool

Set to true to enable the cluster tier to scale down. This option is only available if autoScaling.compute.enabled is true.

If this option is enabled, you must specify a value for providerSettings.autoScaling.compute.minInstanceSize

AutoScalingDiskGbEnabled bool

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.

BackingProviderName string

Cloud service provider on which the server for a multi-tenant cluster is provisioned.

BackupEnabled bool

Clusters running MongoDB FCV 4.2 or later and any new Atlas clusters of any type do not support this parameter

BiConnector Dictionary<string, string>

Deprecated:

use bi_connector_config instead

BiConnectorConfig ClusterBiConnectorConfigArgs

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.

CloudBackup bool

Flag indicating if the cluster uses Cloud Backup for backups.

ClusterId string

The cluster ID.

ClusterType string

Specifies the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.

ConnectionStrings List<ClusterConnectionStringArgs>

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

DiskSizeGb double

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

EncryptionAtRestProvider string

Labels List<ClusterLabelArgs>

MongoDbMajorVersion string

MongoDbVersion string

Version of MongoDB the cluster runs, in major-version.minor-version format.

MongoUri string

Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.

MongoUriUpdated string

Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.

MongoUriWithOptions string

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

NumShards 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

PitEnabled bool

Flag that indicates if the cluster uses Continuous Cloud Backup. If set to true, cloud_backup must also be set to true.

ProjectId string

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

ProviderAutoScalingComputeMaxInstanceSize string

Maximum instance size to which your cluster can automatically scale (e.g., M40). Required if autoScaling.compute.enabled is true.

ProviderAutoScalingComputeMinInstanceSize string

Minimum instance size to which your cluster can automatically scale (e.g., M10). Required if autoScaling.compute.scaleDownEnabled is true.

ProviderBackupEnabled bool

Flag indicating if the cluster uses Cloud Backup for backups. Deprecated use cloud_backup instead.

Deprecated:

This field is deprecated,please use cloud_backup instead

ProviderDiskIops int

You do not need to configure IOPS for a STANDARD disk configuration but only for a PROVISIONED configuration.

ProviderDiskTypeName string

ProviderEncryptEbsVolume bool

Deprecated:

All EBS volumes are encrypted by default, the option to disable encryption has been removed

ProviderEncryptEbsVolumeFlag bool

ProviderInstanceSizeName string

ProviderName string

Cloud service provider on which the servers are provisioned.

ProviderRegionName string

ProviderVolumeType string

The type of the volume. The possible values are: STANDARD and PROVISIONED. PROVISIONED is ONLY required if setting IOPS higher than the default instance IOPS.

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

ReplicationSpecs List<ClusterReplicationSpecArgs>

Configuration for cluster regions. See Replication Spec below for more details.

SnapshotBackupPolicies List<ClusterSnapshotBackupPolicyArgs>

current snapshot schedule and retention settings for the cluster.

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

StateName string

Current state of the cluster. The possible states are:

IDLE
CREATING
UPDATING
DELETING
DELETED
REPAIRING

TerminationProtectionEnabled bool

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

VersionReleaseSystem string

Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:

AdvancedConfiguration ClusterAdvancedConfigurationArgs

AutoScalingComputeEnabled bool

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 for providerSettings.autoScaling.compute.maxInstanceSize.
Set to false to disable cluster tier auto-scaling.

AutoScalingComputeScaleDownEnabled bool

Set to true to enable the cluster tier to scale down. This option is only available if autoScaling.compute.enabled is true.

If this option is enabled, you must specify a value for providerSettings.autoScaling.compute.minInstanceSize

AutoScalingDiskGbEnabled bool

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.

BackingProviderName string

Cloud service provider on which the server for a multi-tenant cluster is provisioned.

BackupEnabled bool

Clusters running MongoDB FCV 4.2 or later and any new Atlas clusters of any type do not support this parameter

BiConnector map[string]string

Deprecated:

use bi_connector_config instead

BiConnectorConfig ClusterBiConnectorConfigArgs

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.

CloudBackup bool

Flag indicating if the cluster uses Cloud Backup for backups.

ClusterId string

The cluster ID.

ClusterType string

Specifies the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.

ConnectionStrings []ClusterConnectionStringArgs

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

DiskSizeGb float64

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

EncryptionAtRestProvider string

Labels []ClusterLabelArgs

MongoDbMajorVersion string

MongoDbVersion string

Version of MongoDB the cluster runs, in major-version.minor-version format.

MongoUri string

Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.

MongoUriUpdated string

Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.

MongoUriWithOptions string

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

NumShards 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

PitEnabled bool

Flag that indicates if the cluster uses Continuous Cloud Backup. If set to true, cloud_backup must also be set to true.

ProjectId string

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

ProviderAutoScalingComputeMaxInstanceSize string

Maximum instance size to which your cluster can automatically scale (e.g., M40). Required if autoScaling.compute.enabled is true.

ProviderAutoScalingComputeMinInstanceSize string

Minimum instance size to which your cluster can automatically scale (e.g., M10). Required if autoScaling.compute.scaleDownEnabled is true.

ProviderBackupEnabled bool

Flag indicating if the cluster uses Cloud Backup for backups. Deprecated use cloud_backup instead.

Deprecated:

This field is deprecated,please use cloud_backup instead

ProviderDiskIops int

You do not need to configure IOPS for a STANDARD disk configuration but only for a PROVISIONED configuration.

ProviderDiskTypeName string

ProviderEncryptEbsVolume bool

Deprecated:

All EBS volumes are encrypted by default, the option to disable encryption has been removed

ProviderEncryptEbsVolumeFlag bool

ProviderInstanceSizeName string

ProviderName string

Cloud service provider on which the servers are provisioned.

ProviderRegionName string

ProviderVolumeType string

The type of the volume. The possible values are: STANDARD and PROVISIONED. PROVISIONED is ONLY required if setting IOPS higher than the default instance IOPS.

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

ReplicationSpecs []ClusterReplicationSpecArgs

Configuration for cluster regions. See Replication Spec below for more details.

SnapshotBackupPolicies []ClusterSnapshotBackupPolicyArgs

current snapshot schedule and retention settings for the cluster.

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

StateName string

Current state of the cluster. The possible states are:

IDLE
CREATING
UPDATING
DELETING
DELETED
REPAIRING

TerminationProtectionEnabled bool

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

VersionReleaseSystem string

Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:

advancedConfiguration ClusterAdvancedConfigurationArgs

autoScalingComputeEnabled Boolean

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 for providerSettings.autoScaling.compute.maxInstanceSize.
Set to false to disable cluster tier auto-scaling.

autoScalingComputeScaleDownEnabled Boolean

Set to true to enable the cluster tier to scale down. This option is only available if autoScaling.compute.enabled is true.

If this option is enabled, you must specify a value for providerSettings.autoScaling.compute.minInstanceSize

autoScalingDiskGbEnabled Boolean

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.

backingProviderName String

Cloud service provider on which the server for a multi-tenant cluster is provisioned.

backupEnabled Boolean

Clusters running MongoDB FCV 4.2 or later and any new Atlas clusters of any type do not support this parameter

biConnector Map<String,String>

Deprecated:

use bi_connector_config instead

biConnectorConfig ClusterBiConnectorConfigArgs

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.

cloudBackup Boolean

Flag indicating if the cluster uses Cloud Backup for backups.

clusterId String

The cluster ID.

clusterType String

Specifies the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.

connectionStrings List<ClusterConnectionStringArgs>

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

diskSizeGb Double

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

encryptionAtRestProvider String

labels List<ClusterLabelArgs>

mongoDbMajorVersion String

mongoDbVersion String

Version of MongoDB the cluster runs, in major-version.minor-version format.

mongoUri String

Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.

mongoUriUpdated String

Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.

mongoUriWithOptions String

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

numShards 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

pitEnabled Boolean

Flag that indicates if the cluster uses Continuous Cloud Backup. If set to true, cloud_backup must also be set to true.

projectId String

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

providerAutoScalingComputeMaxInstanceSize String

Maximum instance size to which your cluster can automatically scale (e.g., M40). Required if autoScaling.compute.enabled is true.

providerAutoScalingComputeMinInstanceSize String

Minimum instance size to which your cluster can automatically scale (e.g., M10). Required if autoScaling.compute.scaleDownEnabled is true.

providerBackupEnabled Boolean

Flag indicating if the cluster uses Cloud Backup for backups. Deprecated use cloud_backup instead.

Deprecated:

This field is deprecated,please use cloud_backup instead

providerDiskIops Integer

You do not need to configure IOPS for a STANDARD disk configuration but only for a PROVISIONED configuration.

providerDiskTypeName String

providerEncryptEbsVolume Boolean

Deprecated:

All EBS volumes are encrypted by default, the option to disable encryption has been removed

providerEncryptEbsVolumeFlag Boolean

providerInstanceSizeName String

providerName String

Cloud service provider on which the servers are provisioned.

providerRegionName String

providerVolumeType String

The type of the volume. The possible values are: STANDARD and PROVISIONED. PROVISIONED is ONLY required if setting IOPS higher than the default instance IOPS.

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

replicationSpecs List<ClusterReplicationSpecArgs>

Configuration for cluster regions. See Replication Spec below for more details.

snapshotBackupPolicies List<ClusterSnapshotBackupPolicyArgs>

current snapshot schedule and retention settings for the cluster.

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

stateName String

Current state of the cluster. The possible states are:

IDLE
CREATING
UPDATING
DELETING
DELETED
REPAIRING

terminationProtectionEnabled Boolean

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

versionReleaseSystem String

Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:

advancedConfiguration ClusterAdvancedConfigurationArgs

autoScalingComputeEnabled boolean

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 for providerSettings.autoScaling.compute.maxInstanceSize.
Set to false to disable cluster tier auto-scaling.

autoScalingComputeScaleDownEnabled boolean

Set to true to enable the cluster tier to scale down. This option is only available if autoScaling.compute.enabled is true.

If this option is enabled, you must specify a value for providerSettings.autoScaling.compute.minInstanceSize

autoScalingDiskGbEnabled boolean

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.

backingProviderName string

Cloud service provider on which the server for a multi-tenant cluster is provisioned.

backupEnabled boolean

Clusters running MongoDB FCV 4.2 or later and any new Atlas clusters of any type do not support this parameter

biConnector {[key: string]: string}

Deprecated:

use bi_connector_config instead

biConnectorConfig ClusterBiConnectorConfigArgs

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.

cloudBackup boolean

Flag indicating if the cluster uses Cloud Backup for backups.

clusterId string

The cluster ID.

clusterType string

Specifies the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.

connectionStrings ClusterConnectionStringArgs[]

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

diskSizeGb number

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

encryptionAtRestProvider string

labels ClusterLabelArgs[]

mongoDbMajorVersion string

mongoDbVersion string

Version of MongoDB the cluster runs, in major-version.minor-version format.

mongoUri string

Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.

mongoUriUpdated string

Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.

mongoUriWithOptions string

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

numShards 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

pitEnabled boolean

Flag that indicates if the cluster uses Continuous Cloud Backup. If set to true, cloud_backup must also be set to true.

projectId string

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

providerAutoScalingComputeMaxInstanceSize string

Maximum instance size to which your cluster can automatically scale (e.g., M40). Required if autoScaling.compute.enabled is true.

providerAutoScalingComputeMinInstanceSize string

Minimum instance size to which your cluster can automatically scale (e.g., M10). Required if autoScaling.compute.scaleDownEnabled is true.

providerBackupEnabled boolean

Flag indicating if the cluster uses Cloud Backup for backups. Deprecated use cloud_backup instead.

Deprecated:

This field is deprecated,please use cloud_backup instead

providerDiskIops number

You do not need to configure IOPS for a STANDARD disk configuration but only for a PROVISIONED configuration.

providerDiskTypeName string

providerEncryptEbsVolume boolean

Deprecated:

All EBS volumes are encrypted by default, the option to disable encryption has been removed

providerEncryptEbsVolumeFlag boolean

providerInstanceSizeName string

providerName string

Cloud service provider on which the servers are provisioned.

providerRegionName string

providerVolumeType string

The type of the volume. The possible values are: STANDARD and PROVISIONED. PROVISIONED is ONLY required if setting IOPS higher than the default instance IOPS.

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

replicationSpecs ClusterReplicationSpecArgs[]

Configuration for cluster regions. See Replication Spec below for more details.

snapshotBackupPolicies ClusterSnapshotBackupPolicyArgs[]

current snapshot schedule and retention settings for the cluster.

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

stateName string

Current state of the cluster. The possible states are:

IDLE
CREATING
UPDATING
DELETING
DELETED
REPAIRING

terminationProtectionEnabled boolean

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

versionReleaseSystem string

Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:

advanced_configuration ClusterAdvancedConfigurationArgs

auto_scaling_compute_enabled bool

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 for providerSettings.autoScaling.compute.maxInstanceSize.
Set to false to disable cluster tier auto-scaling.

auto_scaling_compute_scale_down_enabled bool

Set to true to enable the cluster tier to scale down. This option is only available if autoScaling.compute.enabled is true.

If this option is enabled, you must specify a value for providerSettings.autoScaling.compute.minInstanceSize

auto_scaling_disk_gb_enabled bool

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.

backing_provider_name str

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]

Deprecated:

use bi_connector_config instead

bi_connector_config ClusterBiConnectorConfigArgs

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

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_gb float

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_rest_provider str

labels Sequence[ClusterLabelArgs]

mongo_db_major_version str

mongo_db_version str

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_updated str

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_with_options str

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

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_scaling_compute_max_instance_size str

Maximum instance size to which your cluster can automatically scale (e.g., M40). Required if autoScaling.compute.enabled is true.

provider_auto_scaling_compute_min_instance_size str

Minimum instance size to which your cluster can automatically scale (e.g., M10). Required if autoScaling.compute.scaleDownEnabled is true.

provider_backup_enabled bool

Flag indicating if the cluster uses Cloud Backup for backups. Deprecated use cloud_backup instead.

Deprecated:

This field is deprecated,please use cloud_backup instead

provider_disk_iops int

You do not need to configure IOPS for a STANDARD disk configuration but only for a PROVISIONED configuration.

provider_disk_type_name str

provider_encrypt_ebs_volume bool

Deprecated:

All EBS volumes are encrypted by default, the option to disable encryption has been removed

provider_encrypt_ebs_volume_flag bool

provider_instance_size_name str

provider_name str

Cloud service provider on which the servers are provisioned.

provider_region_name str

provider_volume_type str

The type of the volume. The possible values are: STANDARD and PROVISIONED. 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[ClusterReplicationSpecArgs]

Configuration for cluster regions. See Replication Spec below for more details.

snapshot_backup_policies Sequence[ClusterSnapshotBackupPolicyArgs]

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_enabled bool

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

version_release_system str

Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:

advancedConfiguration Property Map

autoScalingComputeEnabled Boolean

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 for providerSettings.autoScaling.compute.maxInstanceSize.
Set to false to disable cluster tier auto-scaling.

autoScalingComputeScaleDownEnabled Boolean

Set to true to enable the cluster tier to scale down. This option is only available if autoScaling.compute.enabled is true.

If this option is enabled, you must specify a value for providerSettings.autoScaling.compute.minInstanceSize

autoScalingDiskGbEnabled Boolean

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.

backingProviderName String

Cloud service provider on which the server for a multi-tenant cluster is provisioned.

backupEnabled Boolean

Clusters running MongoDB FCV 4.2 or later and any new Atlas clusters of any type do not support this parameter

biConnector Map<String>

Deprecated:

use bi_connector_config instead

biConnectorConfig Property Map

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.

cloudBackup Boolean

Flag indicating if the cluster uses Cloud Backup for backups.

clusterId String

The cluster ID.

clusterType String

Specifies the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.

connectionStrings List<Property Map>

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

diskSizeGb Number

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

encryptionAtRestProvider String

labels List<Property Map>

mongoDbMajorVersion String

mongoDbVersion String

Version of MongoDB the cluster runs, in major-version.minor-version format.

mongoUri String

Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.

mongoUriUpdated String

Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.

mongoUriWithOptions String

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

numShards 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

pitEnabled Boolean

Flag that indicates if the cluster uses Continuous Cloud Backup. If set to true, cloud_backup must also be set to true.

projectId String

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

providerAutoScalingComputeMaxInstanceSize String

Maximum instance size to which your cluster can automatically scale (e.g., M40). Required if autoScaling.compute.enabled is true.

providerAutoScalingComputeMinInstanceSize String

Minimum instance size to which your cluster can automatically scale (e.g., M10). Required if autoScaling.compute.scaleDownEnabled is true.

providerBackupEnabled Boolean

Flag indicating if the cluster uses Cloud Backup for backups. Deprecated use cloud_backup instead.

Deprecated:

This field is deprecated,please use cloud_backup instead

providerDiskIops Number

You do not need to configure IOPS for a STANDARD disk configuration but only for a PROVISIONED configuration.

providerDiskTypeName String

providerEncryptEbsVolume Boolean

Deprecated:

All EBS volumes are encrypted by default, the option to disable encryption has been removed

providerEncryptEbsVolumeFlag Boolean

providerInstanceSizeName String

providerName String

Cloud service provider on which the servers are provisioned.

providerRegionName String

providerVolumeType String

The type of the volume. The possible values are: STANDARD and PROVISIONED. PROVISIONED is ONLY required if setting IOPS higher than the default instance IOPS.

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

replicationSpecs List<Property Map>

Configuration for cluster regions. See Replication Spec below for more details.

snapshotBackupPolicies List<Property Map>

current snapshot schedule and retention settings for the cluster.

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

stateName String

Current state of the cluster. The possible states are:

IDLE
CREATING
UPDATING
DELETING
DELETED
REPAIRING

terminationProtectionEnabled Boolean

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

versionReleaseSystem String

Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:

Supporting Types

ClusterAdvancedConfiguration

DefaultReadConcern string

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

DefaultWriteConcern string

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

FailIndexKeyTooLong bool

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

JavascriptEnabled bool

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

MinimumEnabledTlsProtocol string

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

NoTableScan bool

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

OplogMinRetentionHours int

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

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

OplogSizeMb int

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

SampleRefreshIntervalBiConnector int

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

SampleSizeBiConnector int

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

DefaultReadConcern string

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

DefaultWriteConcern string

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

FailIndexKeyTooLong bool

JavascriptEnabled bool

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

MinimumEnabledTlsProtocol string

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

NoTableScan bool

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

OplogMinRetentionHours int

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

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

OplogSizeMb int

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

SampleRefreshIntervalBiConnector int

SampleSizeBiConnector int

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

defaultReadConcern String

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

defaultWriteConcern String

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

failIndexKeyTooLong Boolean

javascriptEnabled Boolean

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

minimumEnabledTlsProtocol String

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

noTableScan Boolean

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

oplogMinRetentionHours Integer

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

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

oplogSizeMb Integer

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

sampleRefreshIntervalBiConnector Integer

sampleSizeBiConnector Integer

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

defaultReadConcern string

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

defaultWriteConcern string

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

failIndexKeyTooLong boolean

javascriptEnabled boolean

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

minimumEnabledTlsProtocol string

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

noTableScan boolean

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

oplogMinRetentionHours number

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

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

oplogSizeMb number

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

sampleRefreshIntervalBiConnector number

sampleSizeBiConnector number

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

default_read_concern str

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

default_write_concern str

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

fail_index_key_too_long bool

javascript_enabled bool

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

minimum_enabled_tls_protocol str

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

no_table_scan bool

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

oplog_min_retention_hours int

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

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

oplog_size_mb int

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

sample_refresh_interval_bi_connector int

sample_size_bi_connector int

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

defaultReadConcern String

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

defaultWriteConcern String

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

failIndexKeyTooLong Boolean

javascriptEnabled Boolean

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

minimumEnabledTlsProtocol String

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

noTableScan Boolean

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

oplogMinRetentionHours Number

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

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

oplogSizeMb Number

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

sampleRefreshIntervalBiConnector Number

sampleSizeBiConnector Number

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

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.

ReadPreference string

Specifies the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. For details on BI Connector for Atlas read preferences, refer to the BI Connector Read Preferences Table.

Enabled bool

Specifies whether or not BI Connector for Atlas is enabled on the cluster.l *

Set to true to enable BI Connector for Atlas.
Set to false to disable BI Connector for Atlas.

ReadPreference string

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.

readPreference String

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.

readPreference string

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.

read_preference str

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.

readPreference String

ClusterConnectionString

AwsPrivateLink Dictionary<string, object>

Deprecated:

This field is deprecated. Use connection_strings.private_endpoint[n].connection_string instead

AwsPrivateLinkSrv Dictionary<string, object>

Deprecated:

This field is deprecated. Use connection_strings.private_endpoint[n].srv_connection_string instead

Private string

PrivateEndpoints List<ClusterConnectionStringPrivateEndpoint>

PrivateSrv string

Standard string

StandardSrv string

AwsPrivateLink map[string]interface{}

Deprecated:

This field is deprecated. Use connection_strings.private_endpoint[n].connection_string instead

AwsPrivateLinkSrv map[string]interface{}

Deprecated:

This field is deprecated. Use connection_strings.private_endpoint[n].srv_connection_string instead

Private string

PrivateEndpoints []ClusterConnectionStringPrivateEndpoint

PrivateSrv string

Standard string

StandardSrv string

awsPrivateLink Map<String,Object>

Deprecated:

This field is deprecated. Use connection_strings.private_endpoint[n].connection_string instead

awsPrivateLinkSrv Map<String,Object>

Deprecated:

This field is deprecated. Use connection_strings.private_endpoint[n].srv_connection_string instead

privateEndpoints List<ClusterConnectionStringPrivateEndpoint>

privateSrv String

private_ String

standard String

standardSrv String

awsPrivateLink {[key: string]: any}

Deprecated:

This field is deprecated. Use connection_strings.private_endpoint[n].connection_string instead

awsPrivateLinkSrv {[key: string]: any}

Deprecated:

This field is deprecated. Use connection_strings.private_endpoint[n].srv_connection_string instead

private string

privateEndpoints ClusterConnectionStringPrivateEndpoint[]

privateSrv string

standard string

standardSrv string

aws_private_link Mapping[str, Any]

Deprecated:

This field is deprecated. Use connection_strings.private_endpoint[n].connection_string instead

aws_private_link_srv Mapping[str, Any]

Deprecated:

This field is deprecated. Use connection_strings.private_endpoint[n].srv_connection_string instead

private str

private_endpoints Sequence[ClusterConnectionStringPrivateEndpoint]

private_srv str

standard str

standard_srv str

awsPrivateLink Map<Any>

Deprecated:

This field is deprecated. Use connection_strings.private_endpoint[n].connection_string instead

awsPrivateLinkSrv Map<Any>

Deprecated:

This field is deprecated. Use connection_strings.private_endpoint[n].srv_connection_string instead

private String

privateEndpoints List<Property Map>

privateSrv String

standard String

standardSrv String

ClusterConnectionStringPrivateEndpoint

ConnectionString string
Endpoints List<ClusterConnectionStringPrivateEndpointEndpoint>
SrvConnectionString string
Type string

ConnectionString string
Endpoints []ClusterConnectionStringPrivateEndpointEndpoint
SrvConnectionString string
Type string

connectionString String
endpoints List<ClusterConnectionStringPrivateEndpointEndpoint>
srvConnectionString String
type String

connectionString string
endpoints ClusterConnectionStringPrivateEndpointEndpoint[]
srvConnectionString string
type string

connection_string str
endpoints Sequence[ClusterConnectionStringPrivateEndpointEndpoint]
srv_connection_string str
type str

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

ClusterConnectionStringPrivateEndpointEndpoint

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

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

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

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

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

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

ClusterLabel

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

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

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

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

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

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

ClusterReplicationSpec

NumShards 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.
RegionsConfigs List<ClusterReplicationSpecRegionsConfig>: 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.
ZoneName string: Name for the zone in a Global Cluster.

NumShards 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.
RegionsConfigs []ClusterReplicationSpecRegionsConfig: 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.
ZoneName string: Name for the zone in a Global Cluster.

numShards 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.
regionsConfigs List<ClusterReplicationSpecRegionsConfig>: 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.
zoneName String: Name for the zone in a Global Cluster.

numShards 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.
regionsConfigs ClusterReplicationSpecRegionsConfig[]: 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.
zoneName 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[ClusterReplicationSpecRegionsConfig]: 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.

numShards 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.
regionsConfigs 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.
zoneName String: Name for the zone in a Global Cluster.

ClusterReplicationSpecRegionsConfig

RegionName string

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

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

ReadOnlyNodes int

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.

RegionName string

AnalyticsNodes int

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

ReadOnlyNodes int

regionName String

analyticsNodes Integer

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

readOnlyNodes Integer

regionName string

analyticsNodes number

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

readOnlyNodes number

region_name str

analytics_nodes int

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.

read_only_nodes int

regionName String

analyticsNodes Number

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

readOnlyNodes Number

ClusterSnapshotBackupPolicy

ClusterId string: The cluster ID.
ClusterName string
NextSnapshot string
Policies List<ClusterSnapshotBackupPolicyPolicy>
ReferenceHourOfDay int
ReferenceMinuteOfHour int
RestoreWindowDays int
UpdateSnapshots bool

ClusterId string: The cluster ID.
ClusterName string
NextSnapshot string
Policies []ClusterSnapshotBackupPolicyPolicy
ReferenceHourOfDay int
ReferenceMinuteOfHour int
RestoreWindowDays int
UpdateSnapshots bool

clusterId String: The cluster ID.
clusterName String
nextSnapshot String
policies List<ClusterSnapshotBackupPolicyPolicy>
referenceHourOfDay Integer
referenceMinuteOfHour Integer
restoreWindowDays Integer
updateSnapshots Boolean

clusterId string: The cluster ID.
clusterName string
nextSnapshot string
policies ClusterSnapshotBackupPolicyPolicy[]
referenceHourOfDay number
referenceMinuteOfHour number
restoreWindowDays number
updateSnapshots boolean

cluster_id str: The cluster ID.
cluster_name str
next_snapshot str
policies Sequence[ClusterSnapshotBackupPolicyPolicy]
reference_hour_of_day int
reference_minute_of_hour int
restore_window_days int
update_snapshots bool

clusterId String: The cluster ID.
clusterName String
nextSnapshot String
policies List<Property Map>
referenceHourOfDay Number
referenceMinuteOfHour Number
restoreWindowDays Number
updateSnapshots Boolean

ClusterSnapshotBackupPolicyPolicy

Id string: Unique identifer of the replication document for a zone in a Global Cluster.
PolicyItems List<ClusterSnapshotBackupPolicyPolicyPolicyItem>

Id string: Unique identifer of the replication document for a zone in a Global Cluster.
PolicyItems []ClusterSnapshotBackupPolicyPolicyPolicyItem

id String: Unique identifer of the replication document for a zone in a Global Cluster.
policyItems List<ClusterSnapshotBackupPolicyPolicyPolicyItem>

id string: Unique identifer of the replication document for a zone in a Global Cluster.
policyItems ClusterSnapshotBackupPolicyPolicyPolicyItem[]

id str: Unique identifer of the replication document for a zone in a Global Cluster.
policy_items Sequence[ClusterSnapshotBackupPolicyPolicyPolicyItem]

id String: Unique identifer of the replication document for a zone in a Global Cluster.
policyItems List<Property Map>

ClusterSnapshotBackupPolicyPolicyPolicyItem

FrequencyInterval int
FrequencyType string
Id string: Unique identifer of the replication document for a zone in a Global Cluster.
RetentionUnit string
RetentionValue int

FrequencyInterval int
FrequencyType string
Id string: Unique identifer of the replication document for a zone in a Global Cluster.
RetentionUnit string
RetentionValue int

frequencyInterval Integer
frequencyType String
id String: Unique identifer of the replication document for a zone in a Global Cluster.
retentionUnit String
retentionValue Integer

frequencyInterval number
frequencyType string
id string: Unique identifer of the replication document for a zone in a Global Cluster.
retentionUnit string
retentionValue 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

frequencyInterval Number
frequencyType String
id String: Unique identifer of the replication document for a zone in a Global Cluster.
retentionUnit String
retentionValue Number

Package Details

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

mongodbatlas.Cluster

Import

Create Cluster Resource

Cluster Resource Properties

Inputs

Outputs

Look up Existing Cluster Resource

Supporting Types

ClusterAdvancedConfiguration

ClusterBiConnectorConfig

ClusterConnectionString

ClusterConnectionStringPrivateEndpoint

ClusterConnectionStringPrivateEndpointEndpoint

ClusterLabel

ClusterReplicationSpec

ClusterReplicationSpecRegionsConfig

ClusterSnapshotBackupPolicy

ClusterSnapshotBackupPolicyPolicy

ClusterSnapshotBackupPolicyPolicyPolicyItem

Package Details

On this page

On this page