{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/mongodb/main/json-schema/mongodb-atlas-tenant-cluster-upgrade-request20240805-schema.json", "title": "Tenant Cluster Upgrade Request", "description": "Request containing target state of tenant cluster to be upgraded.", "x-generated": "2026-10-03", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/mongodb-flex-clusters-api-openapi.yml#/components/schemas/AtlasTenantClusterUpgradeRequest20240805", "properties": { "acceptDataRisksAndForceReplicaSetReconfig": { "description": "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set `acceptDataRisksAndForceReplicaSetReconfig` to the current date. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "type": "string" }, "advancedConfiguration": { "$ref": "#/$defs/ApiAtlasClusterAdvancedConfigurationView" }, "backupEnabled": { "default": false, "description": "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and [Shared Cluster Backups](https://docs.atlas.mongodb.com/backup/shared-tier/overview/) for tenant clusters. If set to `false`, the cluster doesn't use backups.", "type": "boolean" }, "biConnector": { "$ref": "#/$defs/BiConnector" }, "clusterType": { "description": "Configuration of nodes that comprise the cluster.", "enum": [ "REPLICASET", "SHARDED", "GEOSHARDED" ], "type": "string" }, "configServerManagementMode": { "default": "ATLAS_MANAGED", "description": "Config Server Management Mode for creating or updating a sharded cluster. When configured as `ATLAS_MANAGED`, Atlas may automatically switch the cluster's config server type for optimal performance and savings. When configured as `FIXED_TO_DEDICATED`, the cluster will always use a dedicated config server.", "enum": [ "ATLAS_MANAGED", "FIXED_TO_DEDICATED" ], "type": "string" }, "configServerType": { "description": "Describes a sharded cluster's config server type.", "enum": [ "DEDICATED", "EMBEDDED" ], "readOnly": true, "type": "string" }, "connectionStrings": { "$ref": "#/$defs/ClusterConnectionStrings" }, "createDate": { "description": "Date and time when MongoDB Cloud created this cluster. This parameter expresses its value in ISO 8601 format in UTC.", "format": "date-time", "readOnly": true, "type": "string" }, "diskWarmingMode": { "default": "FULLY_WARMED", "description": "Disk warming mode selection.", "enum": [ "FULLY_WARMED", "VISIBLE_EARLIER" ], "type": "string" }, "effectiveReplicationSpecs": { "description": "List of settings that represent the actual cluster state. This is read-only and always returned in the response. It reflects the current cluster configuration, which may differ from `replicationSpecs` due to system-managed changes.", "items": { "$ref": "#/$defs/ReplicationSpec20240805" }, "readOnly": true, "type": "array" }, "encryptionAtRestProvider": { "description": "Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster `replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize` setting must be `M10` or higher and `\"backupEnabled\" : false` or omitted entirely.", "enum": [ "NONE", "AWS", "AZURE", "GCP" ], "type": "string" }, "featureCompatibilityVersion": { "description": "Feature compatibility version of the cluster. This will always appear regardless of whether FCV is pinned.", "readOnly": true, "type": "string" }, "featureCompatibilityVersionExpirationDate": { "description": "Feature compatibility version expiration date. Will only appear if FCV is pinned. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "readOnly": true, "type": "string" }, "globalClusterSelfManagedSharding": { "description": "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", "type": "boolean" }, "groupId": { "description": "Unique 24-hexadecimal character string that identifies the project.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "id": { "description": "Unique 24-hexadecimal digit string that identifies the cluster.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "internalClusterRole": { "description": "Internal classification of the cluster's role. Possible values: `NONE` (regular user cluster), `SYSTEM_CLUSTER` (system cluster for backup), `INTERNAL_SHADOW_CLUSTER` (internal use shadow cluster for testing).", "enum": [ "NONE", "SYSTEM_CLUSTER", "INTERNAL_SHADOW_CLUSTER" ], "readOnly": true, "type": "string" }, "labels": { "deprecated": true, "description": "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use Resource Tags instead.", "items": { "$ref": "#/$defs/ComponentLabel" }, "type": "array" }, "links": { "description": "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", "items": { "$ref": "#/$defs/Link" }, "readOnly": true, "type": "array" }, "mongoDBEmployeeAccessGrant": { "$ref": "#/$defs/EmployeeAccessGrantView" }, "mongoDBMajorVersion": { "description": "MongoDB major version of the cluster. Set to the binary major version. \n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLtsVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", "type": "string" }, "mongoDBVersion": { "description": "Version of MongoDB that the cluster runs.", "pattern": "([\\d]+\\.[\\d]+\\.[\\d]+)", "readOnly": true, "type": "string" }, "name": { "description": "Human-readable label that identifies the cluster.", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", "type": "string" }, "paused": { "description": "Flag that indicates whether the cluster is paused.", "type": "boolean" }, "pitEnabled": { "description": "Flag that indicates whether the cluster uses continuous cloud backups.", "type": "boolean" }, "redactClientLogData": { "description": "Enable or disable log redaction.\n\nThis setting configures the ``mongod`` or ``mongos`` to redact any document field contents from a message accompanying a given log event before logging. This prevents the program from writing potentially sensitive data stored on the database to the diagnostic log. Metadata such as error or operation codes, line numbers, and source file names are still visible in the logs.\n\nUse ``redactClientLogData`` in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements.\n\n*Note*: changing this setting on a cluster will trigger a rolling restart as soon as the cluster is updated.", "type": "boolean" }, "replicaSetScalingStrategy": { "default": "WORKLOAD_TYPE", "description": "Set this field to configure the replica set scaling mode for your cluster.\n\nBy default, Atlas scales under `WORKLOAD_TYPE`. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as `SEQUENTIAL`, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen configured as `NODE_TYPE`, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.", "enum": [ "SEQUENTIAL", "WORKLOAD_TYPE", "NODE_TYPE" ], "type": "string" }, "replicationSpecs": { "description": "List of settings that configure your cluster regions. This array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations.", "items": { "$ref": "#/$defs/ReplicationSpec20240805" }, "type": "array" }, "retainBackups": { "default": false, "description": "Flag that indicates whether the cluster retains backups.", "type": "boolean" }, "rootCertType": { "default": "ISRGROOTX1", "description": "Root Certificate Authority that MongoDB Atlas cluster uses. MongoDB Cloud supports Internet Security Research Group.", "enum": [ "ISRGROOTX1" ], "type": "string" }, "stateName": { "description": "Human-readable label that indicates any current activity being taken on this cluster by the Atlas control plane. With the exception of CREATING and DELETING states, clusters should always be available and have a Primary node even when in states indicating ongoing activity.\n\n - `IDLE`: Atlas is making no changes to this cluster and all changes requested via the UI or API can be assumed to have been applied.\n - `CREATING`: A cluster being provisioned for the very first time returns state CREATING until it is ready for connections. Ensure IP Access List and DB Users are configured before attempting to connect.\n - `UPDATING`: A change requested via the UI, API, AutoScaling, or other scheduled activity is taking place.\n - `DELETING`: The cluster is in the process of deletion and will soon be deleted.\n - `REPAIRING`: One or more nodes in the cluster are being returned to service by the Atlas control plane. Other nodes should continue to provide service as normal.", "enum": [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], "readOnly": true, "type": "string" }, "tags": { "description": "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", "items": { "$ref": "#/$defs/ResourceTag" }, "type": "array" }, "terminationProtectionEnabled": { "default": false, "description": "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.", "type": "boolean" }, "useAwsTimeBasedSnapshotCopyForFastInitialSync": { "default": false, "description": "Flag that indicates whether AWS time-based snapshot copies will be used instead of slower standard snapshot copies during fast Atlas cross-region initial syncs. This flag is only relevant for clusters containing AWS nodes.", "type": "boolean" }, "versionReleaseSystem": { "default": "LTS", "description": "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify `mongoDBMajorVersion`.", "enum": [ "LTS", "CONTINUOUS" ], "type": "string" } }, "required": [ "name" ], "type": "object", "$defs": { "AWSHardwareSpec20240805": { "description": "Hardware specifications for nodes deployed in the region.", "properties": { "diskIOPS": { "description": "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n You can set different IOPS values on different shards when provisioned IOPS are supported.\n\n Change this parameter if you:\n\n- set `replicationSpecs[n].regionConfigs[m].providerName` to `AWS`.\n- set `replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize` to `M30` or greater (not including `Mxx_NVME` tiers).\n\n- set `replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType` to `PROVISIONED`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected `.instanceSize` and `.diskSizeGB`.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1.", "format": "int32", "type": "integer" }, "diskSizeGB": { "description": "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set `replicationSpecs`.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", "format": "double", "type": "number" }, "ebsVolumeType": { "default": "STANDARD", "description": "Type of storage you want to attach to your AWS-provisioned cluster.\n\n- `STANDARD` volume types can't exceed the default input/output operations per second (IOPS) rate for the selected volume size. \n\n- `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size. You must set this value to (`PROVISIONED`) for NVMe clusters.", "enum": [ "STANDARD", "PROVISIONED" ], "type": "string" }, "instanceSize": { "description": "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", "enum": [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], "title": "AWS Instance Sizes", "type": "string" }, "nodeCount": { "description": "Number of nodes of the given type for MongoDB Cloud to deploy to the region.", "format": "int32", "type": "integer" } }, "title": "AWS Cluster Hardware Settings", "type": "object" }, "AWSRegionConfig20240805": { "allOf": [ { "$ref": "#/$defs/CloudRegionConfig20240805" }, { "properties": { "analyticsAutoScaling": { "$ref": "#/$defs/AdvancedAutoScalingSettings" }, "analyticsSpecs": { "$ref": "#/$defs/DedicatedHardwareSpec20240805" }, "autoScaling": { "$ref": "#/$defs/AdvancedAutoScalingSettings" }, "effectiveAnalyticsSpecs": { "$ref": "#/$defs/DedicatedHardwareSpec20240805" }, "effectiveElectableSpecs": { "$ref": "#/$defs/DedicatedHardwareSpec20240805" }, "effectiveReadOnlySpecs": { "$ref": "#/$defs/DedicatedHardwareSpec20240805" }, "readOnlySpecs": { "$ref": "#/$defs/DedicatedHardwareSpec20240805" } }, "type": "object" } ], "description": "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", "title": "AWS Regional Replication Specifications", "type": "object" }, "AdvancedAutoScalingSettings": { "description": "Options that determine how this cluster handles resource scaling.", "properties": { "compute": { "$ref": "#/$defs/AdvancedComputeAutoScaling" }, "diskGB": { "$ref": "#/$defs/DiskGBAutoScaling" } }, "title": "Automatic Scaling Settings", "type": "object" }, "AdvancedComputeAutoScaling": { "description": "Options that determine how this cluster handles CPU scaling.", "properties": { "enabled": { "description": "Flag that indicates whether instance size reactive auto-scaling is enabled.\n\n- Set to `true` to enable instance size reactive auto-scaling. If enabled, you must specify a value for `replicationSpecs[n].regionConfigs[m].autoScaling.compute.maxInstanceSize`.\n- Set to `false` to disable instance size reactive auto-scaling.", "type": "boolean" }, "maxInstanceSize": { "$ref": "#/$defs/BaseCloudProviderInstanceSize" }, "minInstanceSize": { "$ref": "#/$defs/BaseCloudProviderInstanceSize" }, "scaleDownEnabled": { "description": "Flag that indicates whether the instance size may scale down via reactive auto-scaling. MongoDB Cloud requires this parameter if `replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled` is `true`. If you enable this option, specify a value for `replicationSpecs[n].regionConfigs[m].autoScaling.compute.minInstanceSize`.", "type": "boolean" } }, "title": "Automatic Compute Scaling Settings", "type": "object" }, "ApiAtlasClusterAdvancedConfigurationView": { "description": "Group of settings that configures a subset of the advanced configuration details.", "properties": { "customOpensslCipherConfigTls12": { "description": "The custom OpenSSL cipher suite list for TLS 1.2. This field is only valid when `tlsCipherConfigMode` is set to `CUSTOM`.", "items": { "enum": [ "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256" ], "type": "string" }, "type": "array" }, "customOpensslCipherConfigTls13": { "description": "The custom OpenSSL cipher suite list for TLS 1.3. This field is only valid when `tlsCipherConfigMode` is set to `CUSTOM`.", "items": { "enum": [ "TLS_AES_256_GCM_SHA384", "TLS_CHACHA20_POLY1305_SHA256", "TLS_AES_128_GCM_SHA256", "TLS_AES_128_CCM_SHA256" ], "type": "string" }, "maxItems": 4, "type": "array" }, "minimumEnabledTlsProtocol": { "description": "Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version.", "enum": [ "TLS1_0", "TLS1_1", "TLS1_2", "TLS1_3" ], "type": "string" }, "tlsCipherConfigMode": { "description": "The TLS cipher suite configuration mode. The default mode uses the default cipher suites. The custom mode allows you to specify custom cipher suites for both TLS 1.2 and TLS 1.3.", "enum": [ "CUSTOM", "DEFAULT" ], "type": "string" } }, "type": "object" }, "AzureHardwareSpec20240805": { "properties": { "diskIOPS": { "description": "Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you:\n\n- set `replicationSpecs[n].regionConfigs[m].providerName` : `Azure`.\n- set `replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize` : `M40` or greater not including `Mxx_NVME` tiers.\n\nThe maximum input/output operations per second (IOPS) depend on the selected `.instanceSize` and `.diskSizeGB`.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.", "format": "int32", "type": "integer" }, "diskSizeGB": { "description": "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set `replicationSpecs`.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", "format": "double", "type": "number" }, "instanceSize": { "description": "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", "enum": [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], "title": "Azure Instance Sizes", "type": "string" }, "nodeCount": { "description": "Number of nodes of the given type for MongoDB Cloud to deploy to the region.", "format": "int32", "type": "integer" } }, "type": "object" }, "AzureRegionConfig20240805": { "allOf": [ { "$ref": "#/$defs/CloudRegionConfig20240805" }, { "properties": { "analyticsAutoScaling": { "$ref": "#/$defs/AdvancedAutoScalingSettings" }, "analyticsSpecs": { "$ref": "#/$defs/DedicatedHardwareSpec20240805" }, "autoScaling": { "$ref": "#/$defs/AdvancedAutoScalingSettings" }, "effectiveAnalyticsSpecs": { "$ref": "#/$defs/DedicatedHardwareSpec20240805" }, "effectiveElectableSpecs": { "$ref": "#/$defs/DedicatedHardwareSpec20240805" }, "effectiveReadOnlySpecs": { "$ref": "#/$defs/DedicatedHardwareSpec20240805" }, "readOnlySpecs": { "$ref": "#/$defs/DedicatedHardwareSpec20240805" } }, "type": "object" } ], "description": "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", "title": "Azure Regional Replication Specifications", "type": "object" }, "BaseCloudProviderInstanceSize": { "description": "Instance size boundary to which your cluster can automatically scale.", "oneOf": [ { "enum": [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], "title": "AWS Instance Sizes", "type": "string" }, { "enum": [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], "title": "Azure Instance Sizes", "type": "string" }, { "enum": [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], "title": "GCP Instance Sizes", "type": "string" } ], "readOnly": true, "type": "object" }, "BiConnector": { "description": "Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster.", "properties": { "enabled": { "description": "Flag that indicates whether MongoDB Connector for Business Intelligence is enabled on the specified cluster.", "type": "boolean" }, "readPreference": { "description": "Data source node designated for the MongoDB Connector for Business Intelligence on MongoDB Cloud. The MongoDB Connector for Business Intelligence on MongoDB Cloud reads data from the primary, secondary, or analytics node based on your read preferences. Defaults to `ANALYTICS` node, or `SECONDARY` if there are no `ANALYTICS` nodes.", "enum": [ "PRIMARY", "SECONDARY", "ANALYTICS" ], "type": "string" } }, "title": "MongoDB Connector for Business Intelligence Settings", "type": "object" }, "CloudRegionConfig20240805": { "description": "Cloud service provider on which MongoDB Cloud provisions the hosts.", "oneOf": [ { "$ref": "#/$defs/AWSRegionConfig20240805" }, { "$ref": "#/$defs/AzureRegionConfig20240805" }, { "$ref": "#/$defs/GCPRegionConfig20240805" }, { "$ref": "#/$defs/TenantRegionConfig20240805" } ], "properties": { "electableSpecs": { "$ref": "#/$defs/HardwareSpec20240805" }, "priority": { "description": "Precedence is given to this region when a primary election occurs. If your `regionConfigs` has only `readOnlySpecs`, `analyticsSpecs`, or both, set this value to `0`. If you have multiple `regionConfigs` objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is `7`.\n\n**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.", "format": "int32", "maximum": 7, "minimum": 0, "type": "integer" }, "providerName": { "description": "Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.", "enum": [ "AWS", "AZURE", "GCP", "TENANT" ], "type": "string" }, "regionName": { "description": "Physical location of your MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. The region name is only returned in the response for single-region clusters. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. It assigns the VPC a Classless Inter-Domain Routing (CIDR) block. To limit a new VPC peering connection to one Classless Inter-Domain Routing (CIDR) block and region, create the connection first. Deploy the cluster after the connection starts. GCP Clusters and Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC.", "oneOf": [ { "description": "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", "enum": [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_EAST_2", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTHEAST_5", "AP_SOUTHEAST_6", "AP_SOUTHEAST_7", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "MX_CENTRAL_1", "GLOBAL" ], "title": "AWS Regions", "type": "string" }, { "description": "Microsoft Azure Regions.", "enum": [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL", "POLAND_CENTRAL", "ISRAEL_CENTRAL", "ITALY_NORTH", "SPAIN_CENTRAL", "MEXICO_CENTRAL", "NEW_ZEALAND_NORTH", "US_GOV_VIRGINIA", "US_GOV_ARIZONA", "US_GOV_TEXAS" ], "title": "Azure Regions", "type": "string" }, { "description": "Google Compute Regions.", "enum": [ "EASTERN_US", "EASTERN_US_AW", "US_EAST_4", "US_EAST_4_AW", "US_EAST_5", "US_EAST_5_AW", "US_WEST_2", "US_WEST_2_AW", "US_WEST_3", "US_WEST_3_AW", "US_WEST_4", "US_WEST_4_AW", "US_SOUTH_1", "US_SOUTH_1_AW", "CENTRAL_US", "CENTRAL_US_AW", "WESTERN_US", "WESTERN_US_AW", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "NORTH_AMERICA_SOUTH_1", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "WESTERN_EUROPE", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_8", "EUROPE_WEST_9", "EUROPE_WEST_10", "EUROPE_WEST_12", "EUROPE_SOUTHWEST_1", "EUROPE_CENTRAL_2", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "AFRICA_SOUTH_1", "EASTERN_ASIA_PACIFIC", "NORTHEASTERN_ASIA_PACIFIC", "SOUTHEASTERN_ASIA_PACIFIC", "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2" ], "title": "GCP Regions", "type": "string" } ], "type": "object" } }, "title": "Cloud Service Provider Settings", "type": "object" }, "ClusterConnectionStrings": { "description": "Collection of Uniform Resource Locators that point to the MongoDB database.", "properties": { "awsPrivateLink": { "additionalProperties": { "description": "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to MongoDB Cloud through the interface endpoint that the key names.", "readOnly": true, "type": "string" }, "description": "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to MongoDB Cloud through the interface endpoint that the key names.", "readOnly": true, "type": "object" }, "awsPrivateLinkSrv": { "additionalProperties": { "description": "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names. If the cluster uses an optimized connection string, `awsPrivateLinkSrv` contains the optimized connection string. If the cluster has the non-optimized (legacy) connection string, `awsPrivateLinkSrv` contains the non-optimized connection string even if an optimized connection string is also present.", "readOnly": true, "type": "string" }, "description": "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names. If the cluster uses an optimized connection string, `awsPrivateLinkSrv` contains the optimized connection string. If the cluster has the non-optimized (legacy) connection string, `awsPrivateLinkSrv` contains the non-optimized connection string even if an optimized connection string is also present.", "readOnly": true, "type": "object" }, "private": { "description": "Network peering connection strings for each interface Virtual Private Cloud (VPC) endpoint that you configured to connect to this cluster. This connection string uses the `mongodb+srv://` protocol. The resource returns this parameter once someone creates a network peering connection to this cluster. This protocol tells the application to look up the host seed list in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn't, use `connectionStrings.private`. For Amazon Web Services (AWS) clusters, this resource returns this parameter only if you enable custom DNS.", "readOnly": true, "type": "string" }, "privateEndpoint": { "description": "List of private endpoint-aware connection strings that you can use to connect to this cluster through a private endpoint. This parameter returns only if you deployed a private endpoint to all regions to which you deployed this clusters' nodes.", "items": { "$ref": "#/$defs/ClusterDescriptionConnectionStringsPrivateEndpoint" }, "readOnly": true, "type": "array" }, "privateSrv": { "description": "Network peering connection strings for each interface Virtual Private Cloud (VPC) endpoint that you configured to connect to this cluster. This connection string uses the `mongodb+srv://` protocol. The resource returns this parameter when someone creates a network peering connection to this cluster. This protocol tells the application to look up the host seed list in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your driver supports it. If it doesn't, use `connectionStrings.private`. For Amazon Web Services (AWS) clusters, this parameter returns only if you [enable custom DNS](https://docs.atlas.mongodb.com/reference/api/aws-custom-dns-update/).", "readOnly": true, "type": "string" }, "standard": { "description": "Public connection string that you can use to connect to this cluster. This connection string uses the `mongodb://` protocol.", "readOnly": true, "type": "string" }, "standardSrv": { "description": "Public connection string that you can use to connect to this cluster. This connection string uses the `mongodb+srv://` protocol.", "readOnly": true, "type": "string" } }, "readOnly": true, "title": "Cluster Connection Strings", "type": "object" }, "ClusterDescriptionConnectionStringsPrivateEndpoint": { "description": "Private endpoint-aware connection string that you can use to connect to this cluster through a private endpoint.", "properties": { "connectionString": { "description": "Private endpoint-aware connection string that uses the `mongodb://` protocol to connect to MongoDB Cloud through a private endpoint.", "readOnly": true, "type": "string" }, "endpoints": { "description": "List that contains the private endpoints through which you connect to MongoDB Cloud when you use `connectionStrings.privateEndpoint[n].connectionString` or `connectionStrings.privateEndpoint[n].srvConnectionString`.", "items": { "$ref": "#/$defs/ClusterDescriptionConnectionStringsPrivateEndpointEndpoint" }, "readOnly": true, "type": "array" }, "srvConnectionString": { "description": "Private endpoint-aware connection string that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. The `mongodb+srv` protocol tells the driver to look up the seed list of hosts in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application supports it. If it doesn't, use `connectionStrings.privateEndpoint[n].connectionString`.", "readOnly": true, "type": "string" }, "srvShardOptimizedConnectionString": { "description": "Private endpoint-aware connection string optimized for sharded clusters that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for `connectionStrings.privateEndpoint[n].srvConnectionString`.", "readOnly": true, "type": "string" }, "type": { "description": "MongoDB process type to which your application connects. Use `MONGOD` for replica sets and `MONGOS` for sharded clusters.", "enum": [ "MONGOD", "MONGOS" ], "readOnly": true, "type": "string" } }, "title": "Cluster Private Endpoint Connection String", "type": "object" }, "ClusterDescriptionConnectionStringsPrivateEndpointEndpoint": { "description": "Details of a private endpoint deployed for this cluster.", "properties": { "endpointId": { "description": "Unique string that the cloud provider uses to identify the private endpoint.", "readOnly": true, "type": "string" }, "providerName": { "description": "Cloud provider in which MongoDB Cloud deploys the private endpoint.", "enum": [ "AWS", "AZURE", "GCP" ], "readOnly": true, "type": "string" }, "region": { "description": "Region where the private endpoint is deployed.", "readOnly": true, "type": "string" } }, "title": "Cluster Private Endpoint Connection Strings Endpoint", "type": "object" }, "ComponentLabel": { "description": "Human-readable labels applied to this MongoDB Cloud component.", "properties": { "key": { "description": "Key applied to tag and categorize this component.", "maxLength": 255, "minLength": 1, "type": "string" }, "value": { "description": "Value set to the Key applied to tag and categorize this component.", "maxLength": 255, "minLength": 1, "type": "string" } }, "title": "Component Label", "type": "object" }, "DedicatedHardwareSpec20240805": { "description": "The current hardware specifications for read only nodes in the region.", "oneOf": [ { "$ref": "#/$defs/AWSHardwareSpec20240805" }, { "$ref": "#/$defs/AzureHardwareSpec20240805" }, { "$ref": "#/$defs/GCPHardwareSpec20240805" } ], "properties": { "diskSizeGB": { "description": "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set `replicationSpecs`.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", "format": "double", "type": "number" }, "nodeCount": { "description": "Number of nodes of the given type for MongoDB Cloud to deploy to the region.", "format": "int32", "type": "integer" } }, "readOnly": true, "type": "object" }, "DiskGBAutoScaling": { "description": "Setting that enables disk auto-scaling.", "properties": { "enabled": { "description": "Flag that indicates whether this cluster enables disk auto-scaling. The maximum memory allowed for the selected cluster tier and the oplog size can limit storage auto-scaling.", "type": "boolean" } }, "type": "object" }, "EmployeeAccessGrantView": { "description": "MongoDB employee granted access level and expiration for a cluster.", "properties": { "expirationTime": { "description": "Expiration date for the employee access grant. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "type": "string" }, "grantType": { "description": "Level of access to grant to MongoDB Employees.", "enum": [ "CLUSTER_DATABASE_LOGS", "CLUSTER_INFRASTRUCTURE", "CLUSTER_INFRASTRUCTURE_AND_APP_SERVICES_SYNC_DATA" ], "type": "string" }, "links": { "description": "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", "items": { "$ref": "#/$defs/Link" }, "readOnly": true, "type": "array" } }, "required": [ "expirationTime", "grantType" ], "type": "object" }, "GCPHardwareSpec20240805": { "properties": { "diskSizeGB": { "description": "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set `replicationSpecs`.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", "format": "double", "type": "number" }, "instanceSize": { "description": "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", "enum": [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], "title": "GCP Instance Sizes", "type": "string" }, "nodeCount": { "description": "Number of nodes of the given type for MongoDB Cloud to deploy to the region.", "format": "int32", "type": "integer" } }, "type": "object" }, "GCPRegionConfig20240805": { "allOf": [ { "$ref": "#/$defs/CloudRegionConfig20240805" }, { "properties": { "analyticsAutoScaling": { "$ref": "#/$defs/AdvancedAutoScalingSettings" }, "analyticsSpecs": { "$ref": "#/$defs/DedicatedHardwareSpec20240805" }, "autoScaling": { "$ref": "#/$defs/AdvancedAutoScalingSettings" }, "effectiveAnalyticsSpecs": { "$ref": "#/$defs/DedicatedHardwareSpec20240805" }, "effectiveElectableSpecs": { "$ref": "#/$defs/DedicatedHardwareSpec20240805" }, "effectiveReadOnlySpecs": { "$ref": "#/$defs/DedicatedHardwareSpec20240805" }, "readOnlySpecs": { "$ref": "#/$defs/DedicatedHardwareSpec20240805" } }, "type": "object" } ], "description": "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", "title": "GCP Regional Replication Specifications", "type": "object" }, "HardwareSpec20240805": { "description": "Hardware specifications for all electable nodes deployed in the region. Electable nodes can become the primary and can enable local reads. If you don't specify this option, MongoDB Cloud deploys no electable nodes to the region.", "oneOf": [ { "$ref": "#/$defs/AWSHardwareSpec20240805" }, { "$ref": "#/$defs/AzureHardwareSpec20240805" }, { "$ref": "#/$defs/GCPHardwareSpec20240805" }, { "$ref": "#/$defs/TenantHardwareSpec20240805" } ], "properties": { "diskSizeGB": { "description": "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set `replicationSpecs`.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", "format": "double", "type": "number" } }, "type": "object" }, "Link": { "properties": { "href": { "description": "Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", "type": "string" }, "rel": { "description": "Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", "type": "string" } }, "type": "object" }, "ReplicationSpec20240805": { "description": "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", "properties": { "id": { "description": "Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. If you include existing shard replication configurations in the request, you must specify this parameter. If you add a new shard to an existing Cluster, you may specify this parameter. The request deletes any existing shards in the Cluster that you exclude from the request. This corresponds to Shard ID displayed in the UI.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "regionConfigs": { "description": "Hardware specifications for nodes set for a given region. Each `regionConfigs` object must be unique by region and cloud provider within the `replicationSpec`. Each `regionConfigs` object describes the region's priority in elections and the number and type of MongoDB nodes that MongoDB Cloud deploys to the region. Each `regionConfigs` object must have either an `analyticsSpecs` object, `electableSpecs` object, or `readOnlySpecs` object. Tenant clusters only require `electableSpecs`. Dedicated clusters can specify any of these specifications, but must have at least one `electableSpecs` object within a `replicationSpec`.\n\n**Example:**\n\nIf you set `replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize` : `M30`, set `replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize` : `M30` if you have electable nodes and `replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize` : `M30` if you have read-only nodes.", "items": { "$ref": "#/$defs/CloudRegionConfig20240805" }, "type": "array" }, "zoneId": { "description": "Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. This value can be used to configure Global Cluster backup policies.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "zoneName": { "description": "Human-readable label that describes the zone this shard belongs to in a Global Cluster. Provide this value only if `clusterType` : `GEOSHARDED` but not `selfManagedSharding` : `true`.", "type": "string" } }, "title": "Replication Specifications", "type": "object" }, "ResourceTag": { "description": "Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, `environment : production`.", "properties": { "key": { "description": "Constant that defines the set of the tag. For example, `environment` in the `environment : production` tag.", "maxLength": 255, "minLength": 1, "type": "string" }, "value": { "description": "Variable that belongs to the set of the tag. For example, `production` in the `environment : production` tag.", "maxLength": 255, "minLength": 1, "type": "string" } }, "required": [ "key", "value" ], "title": "Resource Tag", "type": "object" }, "TenantHardwareSpec20240805": { "properties": { "diskSizeGB": { "description": "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set `replicationSpecs`.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", "format": "double", "type": "number" }, "effectiveInstanceSize": { "description": "The true tenant instance size. This is present to support backwards compatibility for deprecated provider types and/or instance sizes.", "enum": [ "FLEX", "M2", "M5", "M0" ], "readOnly": true, "type": "string" }, "instanceSize": { "description": "Hardware specification for the instances in this M0/M2/M5 tier cluster.", "enum": [ "M0", "M2", "M5" ], "title": "Tenant Instance Sizes", "type": "string" } }, "type": "object" }, "TenantRegionConfig20240805": { "allOf": [ { "$ref": "#/$defs/CloudRegionConfig20240805" }, { "properties": { "backingProviderName": { "description": "Cloud service provider on which MongoDB Cloud provisioned the multi-tenant cluster. The resource returns this parameter when `providerName` is `TENANT` and `electableSpecs.instanceSize` is `M0`, `M2` or `M5`. \n\nPlease note that using an `instanceSize` of `M2` or `M5` will create a Flex cluster instead. Support for the `instanceSize` of `M2` or `M5` will be discontinued in January 2026. We recommend using the Create Flex Cluster API for such configurations moving forward.", "enum": [ "AWS", "GCP", "AZURE" ], "type": "string" } }, "type": "object" } ], "description": "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", "title": "Tenant Regional Replication Specifications", "type": "object" } } }