@pulumi/mongodbatlas 3.17.0-alpha.1723454188 → 3.17.0-alpha.1723714844
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/advancedCluster.d.ts +95 -80
- package/advancedCluster.js +81 -74
- package/advancedCluster.js.map +1 -1
- package/cloudBackupSchedule.d.ts +33 -15
- package/cloudBackupSchedule.js.map +1 -1
- package/cloudBackupSnapshotExportBucket.d.ts +65 -11
- package/cloudBackupSnapshotExportBucket.js +24 -3
- package/cloudBackupSnapshotExportBucket.js.map +1 -1
- package/cloudBackupSnapshotRestoreJob.d.ts +0 -12
- package/cloudBackupSnapshotRestoreJob.js +0 -2
- package/cloudBackupSnapshotRestoreJob.js.map +1 -1
- package/getAdvancedCluster.d.ts +104 -3
- package/getAdvancedCluster.js +91 -0
- package/getAdvancedCluster.js.map +1 -1
- package/getAdvancedClusters.d.ts +99 -0
- package/getAdvancedClusters.js +91 -0
- package/getAdvancedClusters.js.map +1 -1
- package/getCloudBackupSchedule.d.ts +20 -77
- package/getCloudBackupSchedule.js +1 -72
- package/getCloudBackupSchedule.js.map +1 -1
- package/getCloudBackupSnapshotExportBucket.d.ts +15 -14
- package/getCloudBackupSnapshotExportBucket.js +0 -1
- package/getCloudBackupSnapshotExportBucket.js.map +1 -1
- package/getCloudBackupSnapshotExportJob.d.ts +0 -11
- package/getCloudBackupSnapshotExportJob.js +0 -1
- package/getCloudBackupSnapshotExportJob.js.map +1 -1
- package/getCloudBackupSnapshotRestoreJob.d.ts +5 -27
- package/getCloudBackupSnapshotRestoreJob.js +0 -1
- package/getCloudBackupSnapshotRestoreJob.js.map +1 -1
- package/getCluster.d.ts +4 -4
- package/getCluster.js +4 -4
- package/getClusters.d.ts +4 -4
- package/getClusters.js +4 -4
- package/getFederatedSettingsIdentityProviders.d.ts +2 -70
- package/getFederatedSettingsIdentityProviders.js +2 -40
- package/getFederatedSettingsIdentityProviders.js.map +1 -1
- package/getGlobalClusterConfig.d.ts +76 -24
- package/getGlobalClusterConfig.js +76 -24
- package/getGlobalClusterConfig.js.map +1 -1
- package/getNetworkPeering.d.ts +0 -4
- package/getNetworkPeering.js +0 -4
- package/getNetworkPeering.js.map +1 -1
- package/getThirdPartyIntegration.d.ts +0 -18
- package/getThirdPartyIntegration.js +0 -1
- package/getThirdPartyIntegration.js.map +1 -1
- package/globalClusterConfig.d.ts +16 -14
- package/globalClusterConfig.js +16 -14
- package/globalClusterConfig.js.map +1 -1
- package/networkContainer.d.ts +0 -2
- package/networkContainer.js +0 -2
- package/networkContainer.js.map +1 -1
- package/networkPeering.d.ts +7 -2
- package/networkPeering.js +7 -2
- package/networkPeering.js.map +1 -1
- package/package.json +2 -2
- package/thirdPartyIntegration.d.ts +0 -12
- package/thirdPartyIntegration.js +0 -2
- package/thirdPartyIntegration.js.map +1 -1
- package/types/input.d.ts +48 -18
- package/types/output.d.ts +164 -70
package/types/output.d.ts
CHANGED
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
import * as outputs from "../types/output";
|
|
2
2
|
export interface AdvancedClusterAdvancedConfiguration {
|
|
3
3
|
/**
|
|
4
|
-
* [Default level of acknowledgment requested from MongoDB for read operations](https://docs.mongodb.com/manual/reference/read-concern/) set for this cluster. MongoDB 4.4 clusters default to [available](https://docs.mongodb.com/manual/reference/read-concern-available/).
|
|
4
|
+
* [Default level of acknowledgment requested from MongoDB for read operations](https://docs.mongodb.com/manual/reference/read-concern/) set for this cluster. MongoDB 4.4 clusters default to [available](https://docs.mongodb.com/manual/reference/read-concern-available/). **(DEPRECATED)** MongoDB 5.0 and later clusters default to `local`. To use a custom read concern level, please refer to your driver documentation.
|
|
5
|
+
*
|
|
6
|
+
* @deprecated This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
|
|
5
7
|
*/
|
|
6
8
|
defaultReadConcern: string;
|
|
7
9
|
/**
|
|
@@ -9,7 +11,9 @@ export interface AdvancedClusterAdvancedConfiguration {
|
|
|
9
11
|
*/
|
|
10
12
|
defaultWriteConcern: string;
|
|
11
13
|
/**
|
|
12
|
-
* 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.
|
|
14
|
+
* 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. **(DEPRECATED)** This parameter has been removed as of [MongoDB 4.4](https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong).
|
|
15
|
+
*
|
|
16
|
+
* @deprecated This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
|
|
13
17
|
*/
|
|
14
18
|
failIndexKeyTooLong: boolean;
|
|
15
19
|
/**
|
|
@@ -136,16 +140,26 @@ export interface AdvancedClusterReplicationSpec {
|
|
|
136
140
|
containerId: {
|
|
137
141
|
[key: string]: string;
|
|
138
142
|
};
|
|
143
|
+
externalId: string;
|
|
144
|
+
/**
|
|
145
|
+
* @deprecated This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
|
|
146
|
+
*/
|
|
139
147
|
id: string;
|
|
140
148
|
/**
|
|
141
149
|
* Provide this value if you set a `clusterType` of SHARDED or GEOSHARDED. Omit this value if you selected a `clusterType` of REPLICASET. This API resource accepts 1 through 50, inclusive. This parameter defaults to 1. If you specify a `numShards` value of 1 and a `clusterType` of SHARDED, Atlas deploys a single-shard [sharded cluster](https://docs.atlas.mongodb.com/reference/glossary/#std-term-sharded-cluster). Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.
|
|
142
|
-
* If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards. To learn more, see [Convert a replica set to a sharded cluster documentation](https://www.mongodb.com/docs/atlas/scale-cluster/#convert-a-replica-set-to-a-sharded-cluster) and [Convert a replica set to a sharded cluster tutorial](https://www.mongodb.com/docs/upcoming/tutorial/convert-replica-set-to-replicated-shard-cluster).
|
|
150
|
+
* If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards. To learn more, see [Convert a replica set to a sharded cluster documentation](https://www.mongodb.com/docs/atlas/scale-cluster/#convert-a-replica-set-to-a-sharded-cluster) and [Convert a replica set to a sharded cluster tutorial](https://www.mongodb.com/docs/upcoming/tutorial/convert-replica-set-to-replicated-shard-cluster). **(DEPRECATED)** To learn more, see the 1.18.0 Upgrade Guide.
|
|
151
|
+
*
|
|
152
|
+
* @deprecated This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
|
|
143
153
|
*/
|
|
144
154
|
numShards?: number;
|
|
145
155
|
/**
|
|
146
156
|
* Configuration for the hardware specifications for nodes set for a given regionEach `regionConfigs` object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Each `regionConfigs` object must have either an `analyticsSpecs` object, `electableSpecs` object, or `readOnlySpecs` object. See below
|
|
147
157
|
*/
|
|
148
158
|
regionConfigs: outputs.AdvancedClusterReplicationSpecRegionConfig[];
|
|
159
|
+
/**
|
|
160
|
+
* Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. If clusterType is GEOSHARDED, this value indicates the zone that the given shard belongs to and can be used to configure Global Cluster backup policies.
|
|
161
|
+
*/
|
|
162
|
+
zoneId: string;
|
|
149
163
|
/**
|
|
150
164
|
* Name for the zone in a Global Cluster.
|
|
151
165
|
*/
|
|
@@ -153,15 +167,15 @@ export interface AdvancedClusterReplicationSpec {
|
|
|
153
167
|
}
|
|
154
168
|
export interface AdvancedClusterReplicationSpecRegionConfig {
|
|
155
169
|
/**
|
|
156
|
-
* Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. The values for the `analyticsAutoScaling` parameter must be the same for
|
|
170
|
+
* Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. The values for the `analyticsAutoScaling` parameter must be the same for all `regionConfigs` in all `replicationSpecs`. See below
|
|
157
171
|
*/
|
|
158
172
|
analyticsAutoScaling: outputs.AdvancedClusterReplicationSpecRegionConfigAnalyticsAutoScaling;
|
|
159
173
|
/**
|
|
160
174
|
* Hardware specifications for [analytics nodes](https://docs.atlas.mongodb.com/reference/faq/deployment/#std-label-analytics-nodes-overview) needed in the region. Analytics nodes handle analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only and can never become the [primary](https://docs.atlas.mongodb.com/reference/glossary/#std-term-primary). If you don't specify this parameter, no analytics nodes deploy to this region. See below
|
|
161
175
|
*/
|
|
162
|
-
analyticsSpecs
|
|
176
|
+
analyticsSpecs: outputs.AdvancedClusterReplicationSpecRegionConfigAnalyticsSpecs;
|
|
163
177
|
/**
|
|
164
|
-
* Configuration for the Collection of settings that configures auto-scaling information for the cluster. The values for the `autoScaling` parameter must be the same for
|
|
178
|
+
* Configuration for the Collection of settings that configures auto-scaling information for the cluster. The values for the `autoScaling` parameter must be the same for all `regionConfigs` in all `replicationSpecs`. See below
|
|
165
179
|
*/
|
|
166
180
|
autoScaling: outputs.AdvancedClusterReplicationSpecRegionConfigAutoScaling;
|
|
167
181
|
/**
|
|
@@ -171,7 +185,7 @@ export interface AdvancedClusterReplicationSpecRegionConfig {
|
|
|
171
185
|
/**
|
|
172
186
|
* Hardware specifications for electable nodes in the region. Electable nodes can become the [primary](https://docs.atlas.mongodb.com/reference/glossary/#std-term-primary) and can enable local reads. If you do not specify this option, no electable nodes are deployed to the region. See below
|
|
173
187
|
*/
|
|
174
|
-
electableSpecs
|
|
188
|
+
electableSpecs: outputs.AdvancedClusterReplicationSpecRegionConfigElectableSpecs;
|
|
175
189
|
/**
|
|
176
190
|
* Election priority of the region. For regions with only read-only nodes, set this value to 0.
|
|
177
191
|
* * 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.
|
|
@@ -191,7 +205,7 @@ export interface AdvancedClusterReplicationSpecRegionConfig {
|
|
|
191
205
|
/**
|
|
192
206
|
* Hardware specifications for read-only nodes in the region. Read-only nodes can become the [primary](https://docs.atlas.mongodb.com/reference/glossary/#std-term-primary) and can enable local reads. If you don't specify this parameter, no read-only nodes are deployed to the region. See below
|
|
193
207
|
*/
|
|
194
|
-
readOnlySpecs
|
|
208
|
+
readOnlySpecs: outputs.AdvancedClusterReplicationSpecRegionConfigReadOnlySpecs;
|
|
195
209
|
/**
|
|
196
210
|
* 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](https://docs.atlas.mongodb.com/reference/amazon-aws/), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).
|
|
197
211
|
*/
|
|
@@ -218,17 +232,21 @@ export interface AdvancedClusterReplicationSpecRegionConfigAnalyticsAutoScaling
|
|
|
218
232
|
}
|
|
219
233
|
export interface AdvancedClusterReplicationSpecRegionConfigAnalyticsSpecs {
|
|
220
234
|
/**
|
|
221
|
-
* Target
|
|
235
|
+
* Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. Define this attribute only if you selected AWS as your cloud service provider, `instanceSize` is set to "M30" or greater (not including "Mxx_NVME" tiers), and `ebsVolumeType` is "PROVISIONED". You can't set this attribute for a multi-cloud cluster.
|
|
222
236
|
*/
|
|
223
237
|
diskIops: number;
|
|
238
|
+
/**
|
|
239
|
+
* Storage capacity that the host's root volume possesses expressed in gigabytes. This value must be equal for all shards and node types. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. 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. **Note:** Using `diskSizeGb` with Standard IOPS could lead to errors and configuration issues. Therefore, it should be used only with the Provisioned IOPS volume type. When using Provisioned IOPS, the diskSizeGb parameter specifies the storage capacity, but the IOPS are set independently. Ensuring that `diskSizeGb` is used exclusively with Provisioned IOPS will help avoid these issues.
|
|
240
|
+
*/
|
|
241
|
+
diskSizeGb: number;
|
|
224
242
|
/**
|
|
225
243
|
* Type of storage you want to attach to your AWS-provisioned cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster. Valid values are:
|
|
226
244
|
* * `STANDARD` volume types can't exceed the default IOPS rate for the selected volume size.
|
|
227
245
|
* * `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size.
|
|
228
246
|
*/
|
|
229
|
-
ebsVolumeType
|
|
247
|
+
ebsVolumeType: string;
|
|
230
248
|
/**
|
|
231
|
-
* Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.
|
|
249
|
+
* Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size. 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.
|
|
232
250
|
*/
|
|
233
251
|
instanceSize: string;
|
|
234
252
|
/**
|
|
@@ -254,17 +272,21 @@ export interface AdvancedClusterReplicationSpecRegionConfigAutoScaling {
|
|
|
254
272
|
}
|
|
255
273
|
export interface AdvancedClusterReplicationSpecRegionConfigElectableSpecs {
|
|
256
274
|
/**
|
|
257
|
-
* Target
|
|
275
|
+
* Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. Define this attribute only if you selected AWS as your cloud service provider, `instanceSize` is set to "M30" or greater (not including "Mxx_NVME" tiers), and `ebsVolumeType` is "PROVISIONED". You can't set this attribute for a multi-cloud cluster.
|
|
258
276
|
*/
|
|
259
277
|
diskIops: number;
|
|
278
|
+
/**
|
|
279
|
+
* Storage capacity that the host's root volume possesses expressed in gigabytes. This value must be equal for all shards and node types. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. 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. **Note:** Using `diskSizeGb` with Standard IOPS could lead to errors and configuration issues. Therefore, it should be used only with the Provisioned IOPS volume type. When using Provisioned IOPS, the diskSizeGb parameter specifies the storage capacity, but the IOPS are set independently. Ensuring that `diskSizeGb` is used exclusively with Provisioned IOPS will help avoid these issues.
|
|
280
|
+
*/
|
|
281
|
+
diskSizeGb: number;
|
|
260
282
|
/**
|
|
261
283
|
* Type of storage you want to attach to your AWS-provisioned cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster. Valid values are:
|
|
262
284
|
* * `STANDARD` volume types can't exceed the default IOPS rate for the selected volume size.
|
|
263
285
|
* * `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size.
|
|
264
286
|
*/
|
|
265
|
-
ebsVolumeType
|
|
287
|
+
ebsVolumeType: string;
|
|
266
288
|
/**
|
|
267
|
-
* Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.
|
|
289
|
+
* Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size. 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.
|
|
268
290
|
*/
|
|
269
291
|
instanceSize: string;
|
|
270
292
|
/**
|
|
@@ -274,17 +296,21 @@ export interface AdvancedClusterReplicationSpecRegionConfigElectableSpecs {
|
|
|
274
296
|
}
|
|
275
297
|
export interface AdvancedClusterReplicationSpecRegionConfigReadOnlySpecs {
|
|
276
298
|
/**
|
|
277
|
-
* Target
|
|
299
|
+
* Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. Define this attribute only if you selected AWS as your cloud service provider, `instanceSize` is set to "M30" or greater (not including "Mxx_NVME" tiers), and `ebsVolumeType` is "PROVISIONED". You can't set this attribute for a multi-cloud cluster. This parameter defaults to the cluster tier's standard IOPS value.
|
|
278
300
|
*/
|
|
279
301
|
diskIops: number;
|
|
302
|
+
/**
|
|
303
|
+
* Storage capacity that the host's root volume possesses expressed in gigabytes. This value must be equal for all shards and node types. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. 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. **Note:** Using `diskSizeGb` with Standard IOPS could lead to errors and configuration issues. Therefore, it should be used only with the Provisioned IOPS volume type. When using Provisioned IOPS, the diskSizeGb parameter specifies the storage capacity, but the IOPS are set independently. Ensuring that `diskSizeGb` is used exclusively with Provisioned IOPS will help avoid these issues.
|
|
304
|
+
*/
|
|
305
|
+
diskSizeGb: number;
|
|
280
306
|
/**
|
|
281
307
|
* Type of storage you want to attach to your AWS-provisioned cluster. Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster. Valid values are:
|
|
282
308
|
* * `STANDARD` volume types can't exceed the default IOPS rate for the selected volume size.
|
|
283
309
|
* * `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size.
|
|
284
310
|
*/
|
|
285
|
-
ebsVolumeType
|
|
311
|
+
ebsVolumeType: string;
|
|
286
312
|
/**
|
|
287
|
-
* Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.
|
|
313
|
+
* Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size. 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.
|
|
288
314
|
*/
|
|
289
315
|
instanceSize: string;
|
|
290
316
|
/**
|
|
@@ -622,13 +648,19 @@ export interface CloudBackupScheduleCopySetting {
|
|
|
622
648
|
*/
|
|
623
649
|
regionName: string;
|
|
624
650
|
/**
|
|
625
|
-
* Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Replication Spec Id, consult the replicationSpecs array returned from [Return One Multi-Cloud Cluster in One Project](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getCluster).
|
|
651
|
+
* Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Replication Spec Id, consult the replicationSpecs array returned from [Return One Multi-Cloud Cluster in One Project](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getCluster). **(DEPRECATED)** Use `zoneId` instead. To learn more, see the 1.18.0 upgrade guide.
|
|
652
|
+
*
|
|
653
|
+
* @deprecated This parameter is deprecated. Please transition to `copy_settings.#.zone_id`. To learn more, see our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
|
|
626
654
|
*/
|
|
627
655
|
replicationSpecId: string;
|
|
628
656
|
/**
|
|
629
657
|
* Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores.
|
|
630
658
|
*/
|
|
631
659
|
shouldCopyOplogs: boolean;
|
|
660
|
+
/**
|
|
661
|
+
* Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find appropriate value for `zoneId`, do a GET request to Return One Cluster from One Project and consult the replicationSpecs array Return One Cluster From One Project. Alternately, use `mongodbatlas.AdvancedCluster` data source or resource and reference `replication_specs.#.zone_id`.
|
|
662
|
+
*/
|
|
663
|
+
zoneId: string;
|
|
632
664
|
}
|
|
633
665
|
export interface CloudBackupScheduleExport {
|
|
634
666
|
/**
|
|
@@ -826,6 +858,8 @@ export interface CloudProviderAccessSetupAzureConfig {
|
|
|
826
858
|
export interface ClusterAdvancedConfiguration {
|
|
827
859
|
/**
|
|
828
860
|
* [Default level of acknowledgment requested from MongoDB for read operations](https://docs.mongodb.com/manual/reference/read-concern/) set for this cluster. MongoDB 4.4 clusters default to [available](https://docs.mongodb.com/manual/reference/read-concern-available/).
|
|
861
|
+
*
|
|
862
|
+
* @deprecated This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
|
|
829
863
|
*/
|
|
830
864
|
defaultReadConcern: string;
|
|
831
865
|
/**
|
|
@@ -834,6 +868,8 @@ export interface ClusterAdvancedConfiguration {
|
|
|
834
868
|
defaultWriteConcern: string;
|
|
835
869
|
/**
|
|
836
870
|
* 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.
|
|
871
|
+
*
|
|
872
|
+
* @deprecated This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
|
|
837
873
|
*/
|
|
838
874
|
failIndexKeyTooLong: boolean;
|
|
839
875
|
/**
|
|
@@ -1481,7 +1517,9 @@ export interface GetAccessListApiKeysResult {
|
|
|
1481
1517
|
}
|
|
1482
1518
|
export interface GetAdvancedClusterAdvancedConfiguration {
|
|
1483
1519
|
/**
|
|
1484
|
-
* [Default level of acknowledgment requested from MongoDB for read operations](https://docs.mongodb.com/manual/reference/read-concern/) set for this cluster. MongoDB 4.4 clusters default to [available](https://docs.mongodb.com/manual/reference/read-concern-available/).
|
|
1520
|
+
* [Default level of acknowledgment requested from MongoDB for read operations](https://docs.mongodb.com/manual/reference/read-concern/) set for this cluster. MongoDB 4.4 clusters default to [available](https://docs.mongodb.com/manual/reference/read-concern-available/). **(DEPRECATED.)** MongoDB 5.0 and later clusters default to `local`. To use a custom read concern level, please refer to your driver documentation.
|
|
1521
|
+
*
|
|
1522
|
+
* @deprecated This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
|
|
1485
1523
|
*/
|
|
1486
1524
|
defaultReadConcern: string;
|
|
1487
1525
|
/**
|
|
@@ -1489,7 +1527,9 @@ export interface GetAdvancedClusterAdvancedConfiguration {
|
|
|
1489
1527
|
*/
|
|
1490
1528
|
defaultWriteConcern: string;
|
|
1491
1529
|
/**
|
|
1492
|
-
* 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.
|
|
1530
|
+
* 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. **(DEPRECATED.)** This parameter has been removed as of [MongoDB 4.4](https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong).
|
|
1531
|
+
*
|
|
1532
|
+
* @deprecated This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
|
|
1493
1533
|
*/
|
|
1494
1534
|
failIndexKeyTooLong: boolean;
|
|
1495
1535
|
/**
|
|
@@ -1597,15 +1637,25 @@ export interface GetAdvancedClusterReplicationSpec {
|
|
|
1597
1637
|
containerId: {
|
|
1598
1638
|
[key: string]: string;
|
|
1599
1639
|
};
|
|
1640
|
+
externalId: string;
|
|
1641
|
+
/**
|
|
1642
|
+
* @deprecated This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
|
|
1643
|
+
*/
|
|
1600
1644
|
id: string;
|
|
1601
1645
|
/**
|
|
1602
|
-
* Provide this value if you set a `clusterType` of SHARDED or GEOSHARDED.
|
|
1646
|
+
* Provide this value if you set a `clusterType` of `SHARDED` or `GEOSHARDED`. **(DEPRECATED.)** To learn more, see the Migration Guide.
|
|
1647
|
+
*
|
|
1648
|
+
* @deprecated This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
|
|
1603
1649
|
*/
|
|
1604
1650
|
numShards: number;
|
|
1605
1651
|
/**
|
|
1606
1652
|
* Configuration for the hardware specifications for nodes set for a given regionEach `regionConfigs` object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Each `regionConfigs` object must have either an `analyticsSpecs` object, `electableSpecs` object, or `readOnlySpecs` object. See below
|
|
1607
1653
|
*/
|
|
1608
1654
|
regionConfigs: outputs.GetAdvancedClusterReplicationSpecRegionConfig[];
|
|
1655
|
+
/**
|
|
1656
|
+
* Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. If clusterType is GEOSHARDED, this value indicates the zone that the given shard belongs to and can be used to configure Global Cluster backup policies.
|
|
1657
|
+
*/
|
|
1658
|
+
zoneId: string;
|
|
1609
1659
|
/**
|
|
1610
1660
|
* Name for the zone in a Global Cluster.
|
|
1611
1661
|
*/
|
|
@@ -1619,7 +1669,7 @@ export interface GetAdvancedClusterReplicationSpecRegionConfig {
|
|
|
1619
1669
|
/**
|
|
1620
1670
|
* Hardware specifications for [analytics nodes](https://docs.atlas.mongodb.com/reference/faq/deployment/#std-label-analytics-nodes-overview) needed in the region. See below
|
|
1621
1671
|
*/
|
|
1622
|
-
analyticsSpecs
|
|
1672
|
+
analyticsSpecs: outputs.GetAdvancedClusterReplicationSpecRegionConfigAnalyticsSpecs;
|
|
1623
1673
|
/**
|
|
1624
1674
|
* Configuration for the Collection of settings that configures auto-scaling information for the cluster. See below
|
|
1625
1675
|
*/
|
|
@@ -1631,7 +1681,7 @@ export interface GetAdvancedClusterReplicationSpecRegionConfig {
|
|
|
1631
1681
|
/**
|
|
1632
1682
|
* Hardware specifications for electable nodes in the region.
|
|
1633
1683
|
*/
|
|
1634
|
-
electableSpecs
|
|
1684
|
+
electableSpecs: outputs.GetAdvancedClusterReplicationSpecRegionConfigElectableSpecs;
|
|
1635
1685
|
/**
|
|
1636
1686
|
* Election priority of the region.
|
|
1637
1687
|
*/
|
|
@@ -1643,7 +1693,7 @@ export interface GetAdvancedClusterReplicationSpecRegionConfig {
|
|
|
1643
1693
|
/**
|
|
1644
1694
|
* Hardware specifications for read-only nodes in the region. See below
|
|
1645
1695
|
*/
|
|
1646
|
-
readOnlySpecs
|
|
1696
|
+
readOnlySpecs: outputs.GetAdvancedClusterReplicationSpecRegionConfigReadOnlySpecs;
|
|
1647
1697
|
/**
|
|
1648
1698
|
* Physical location of your MongoDB cluster.
|
|
1649
1699
|
*/
|
|
@@ -1674,15 +1724,19 @@ export interface GetAdvancedClusterReplicationSpecRegionConfigAnalyticsAutoScali
|
|
|
1674
1724
|
}
|
|
1675
1725
|
export interface GetAdvancedClusterReplicationSpecRegionConfigAnalyticsSpecs {
|
|
1676
1726
|
/**
|
|
1677
|
-
* Target
|
|
1727
|
+
* Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. This parameter defaults to the cluster tier's standard IOPS value.
|
|
1678
1728
|
*/
|
|
1679
1729
|
diskIops: number;
|
|
1730
|
+
/**
|
|
1731
|
+
* Storage capacity that the host's root volume possesses expressed in gigabytes. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. 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.
|
|
1732
|
+
*/
|
|
1733
|
+
diskSizeGb: number;
|
|
1680
1734
|
/**
|
|
1681
1735
|
* Type of storage you want to attach to your AWS-provisioned cluster.
|
|
1682
1736
|
* * `STANDARD` volume types can't exceed the default IOPS rate for the selected volume size.
|
|
1683
1737
|
* * `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size.
|
|
1684
1738
|
*/
|
|
1685
|
-
ebsVolumeType
|
|
1739
|
+
ebsVolumeType: string;
|
|
1686
1740
|
/**
|
|
1687
1741
|
* Hardware specification for the instance sizes in this region.
|
|
1688
1742
|
*/
|
|
@@ -1717,15 +1771,19 @@ export interface GetAdvancedClusterReplicationSpecRegionConfigAutoScaling {
|
|
|
1717
1771
|
}
|
|
1718
1772
|
export interface GetAdvancedClusterReplicationSpecRegionConfigElectableSpecs {
|
|
1719
1773
|
/**
|
|
1720
|
-
* Target
|
|
1774
|
+
* Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. This parameter defaults to the cluster tier's standard IOPS value.
|
|
1721
1775
|
*/
|
|
1722
1776
|
diskIops: number;
|
|
1777
|
+
/**
|
|
1778
|
+
* Storage capacity that the host's root volume possesses expressed in gigabytes. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. 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.
|
|
1779
|
+
*/
|
|
1780
|
+
diskSizeGb: number;
|
|
1723
1781
|
/**
|
|
1724
1782
|
* Type of storage you want to attach to your AWS-provisioned cluster.
|
|
1725
1783
|
* * `STANDARD` volume types can't exceed the default IOPS rate for the selected volume size.
|
|
1726
1784
|
* * `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size.
|
|
1727
1785
|
*/
|
|
1728
|
-
ebsVolumeType
|
|
1786
|
+
ebsVolumeType: string;
|
|
1729
1787
|
/**
|
|
1730
1788
|
* Hardware specification for the instance sizes in this region.
|
|
1731
1789
|
*/
|
|
@@ -1737,15 +1795,19 @@ export interface GetAdvancedClusterReplicationSpecRegionConfigElectableSpecs {
|
|
|
1737
1795
|
}
|
|
1738
1796
|
export interface GetAdvancedClusterReplicationSpecRegionConfigReadOnlySpecs {
|
|
1739
1797
|
/**
|
|
1740
|
-
* Target
|
|
1798
|
+
* Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. This parameter defaults to the cluster tier's standard IOPS value.
|
|
1741
1799
|
*/
|
|
1742
1800
|
diskIops: number;
|
|
1801
|
+
/**
|
|
1802
|
+
* Storage capacity that the host's root volume possesses expressed in gigabytes. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. 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.
|
|
1803
|
+
*/
|
|
1804
|
+
diskSizeGb: number;
|
|
1743
1805
|
/**
|
|
1744
1806
|
* Type of storage you want to attach to your AWS-provisioned cluster.
|
|
1745
1807
|
* * `STANDARD` volume types can't exceed the default IOPS rate for the selected volume size.
|
|
1746
1808
|
* * `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size.
|
|
1747
1809
|
*/
|
|
1748
|
-
ebsVolumeType
|
|
1810
|
+
ebsVolumeType: string;
|
|
1749
1811
|
/**
|
|
1750
1812
|
* Hardware specification for the instance sizes in this region.
|
|
1751
1813
|
*/
|
|
@@ -1785,7 +1847,9 @@ export interface GetAdvancedClustersResult {
|
|
|
1785
1847
|
connectionStrings: outputs.GetAdvancedClustersResultConnectionString[];
|
|
1786
1848
|
createDate: string;
|
|
1787
1849
|
/**
|
|
1788
|
-
*
|
|
1850
|
+
* Storage capacity that the host's root volume possesses expressed in gigabytes. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. 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.
|
|
1851
|
+
*
|
|
1852
|
+
* @deprecated This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
|
|
1789
1853
|
*/
|
|
1790
1854
|
diskSizeGb: number;
|
|
1791
1855
|
/**
|
|
@@ -1820,7 +1884,7 @@ export interface GetAdvancedClustersResult {
|
|
|
1820
1884
|
*/
|
|
1821
1885
|
pitEnabled: boolean;
|
|
1822
1886
|
/**
|
|
1823
|
-
*
|
|
1887
|
+
* List of settings that configure your cluster regions. If `useReplicationSpecPerShard = true`, this array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. See below
|
|
1824
1888
|
*/
|
|
1825
1889
|
replicationSpecs: outputs.GetAdvancedClustersResultReplicationSpec[];
|
|
1826
1890
|
/**
|
|
@@ -1846,7 +1910,9 @@ export interface GetAdvancedClustersResult {
|
|
|
1846
1910
|
}
|
|
1847
1911
|
export interface GetAdvancedClustersResultAdvancedConfiguration {
|
|
1848
1912
|
/**
|
|
1849
|
-
* [Default level of acknowledgment requested from MongoDB for read operations](https://docs.mongodb.com/manual/reference/read-concern/) set for this cluster. MongoDB 4.4 clusters default to [available](https://docs.mongodb.com/manual/reference/read-concern-available/).
|
|
1913
|
+
* [Default level of acknowledgment requested from MongoDB for read operations](https://docs.mongodb.com/manual/reference/read-concern/) set for this cluster. MongoDB 4.4 clusters default to [available](https://docs.mongodb.com/manual/reference/read-concern-available/). **(DEPRECATED.)** MongoDB 5.0 and later clusters default to `local`. To use a custom read concern level, please refer to your driver documentation.
|
|
1914
|
+
*
|
|
1915
|
+
* @deprecated This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
|
|
1850
1916
|
*/
|
|
1851
1917
|
defaultReadConcern: string;
|
|
1852
1918
|
/**
|
|
@@ -1854,7 +1920,9 @@ export interface GetAdvancedClustersResultAdvancedConfiguration {
|
|
|
1854
1920
|
*/
|
|
1855
1921
|
defaultWriteConcern: string;
|
|
1856
1922
|
/**
|
|
1857
|
-
* 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.
|
|
1923
|
+
* 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. **(DEPRECATED.)** This parameter has been removed as of [MongoDB 4.4](https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong).
|
|
1924
|
+
*
|
|
1925
|
+
* @deprecated This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
|
|
1858
1926
|
*/
|
|
1859
1927
|
failIndexKeyTooLong: boolean;
|
|
1860
1928
|
/**
|
|
@@ -1959,15 +2027,25 @@ export interface GetAdvancedClustersResultReplicationSpec {
|
|
|
1959
2027
|
containerId: {
|
|
1960
2028
|
[key: string]: string;
|
|
1961
2029
|
};
|
|
2030
|
+
externalId: string;
|
|
2031
|
+
/**
|
|
2032
|
+
* @deprecated This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
|
|
2033
|
+
*/
|
|
1962
2034
|
id: string;
|
|
1963
2035
|
/**
|
|
1964
|
-
* Provide this value if you set a `clusterType` of SHARDED or GEOSHARDED.
|
|
2036
|
+
* Provide this value if you set a `clusterType` of SHARDED or GEOSHARDED. **(DEPRECATED.)** To learn more, see the Migration Guide for more details.
|
|
2037
|
+
*
|
|
2038
|
+
* @deprecated This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
|
|
1965
2039
|
*/
|
|
1966
2040
|
numShards: number;
|
|
1967
2041
|
/**
|
|
1968
2042
|
* Configuration for the hardware specifications for nodes set for a given regionEach `regionConfigs` object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Each `regionConfigs` object must have either an `analyticsSpecs` object, `electableSpecs` object, or `readOnlySpecs` object. See below
|
|
1969
2043
|
*/
|
|
1970
2044
|
regionConfigs: outputs.GetAdvancedClustersResultReplicationSpecRegionConfig[];
|
|
2045
|
+
/**
|
|
2046
|
+
* Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. If clusterType is GEOSHARDED, this value indicates the zone that the given shard belongs to and can be used to configure Global Cluster backup policies.
|
|
2047
|
+
*/
|
|
2048
|
+
zoneId: string;
|
|
1971
2049
|
/**
|
|
1972
2050
|
* Name for the zone in a Global Cluster.
|
|
1973
2051
|
*/
|
|
@@ -1981,7 +2059,7 @@ export interface GetAdvancedClustersResultReplicationSpecRegionConfig {
|
|
|
1981
2059
|
/**
|
|
1982
2060
|
* Hardware specifications for [analytics nodes](https://docs.atlas.mongodb.com/reference/faq/deployment/#std-label-analytics-nodes-overview) needed in the region. See below
|
|
1983
2061
|
*/
|
|
1984
|
-
analyticsSpecs
|
|
2062
|
+
analyticsSpecs: outputs.GetAdvancedClustersResultReplicationSpecRegionConfigAnalyticsSpecs;
|
|
1985
2063
|
/**
|
|
1986
2064
|
* Configuration for the Collection of settings that configures auto-scaling information for the cluster. See below
|
|
1987
2065
|
*/
|
|
@@ -1993,7 +2071,7 @@ export interface GetAdvancedClustersResultReplicationSpecRegionConfig {
|
|
|
1993
2071
|
/**
|
|
1994
2072
|
* Hardware specifications for electable nodes in the region.
|
|
1995
2073
|
*/
|
|
1996
|
-
electableSpecs
|
|
2074
|
+
electableSpecs: outputs.GetAdvancedClustersResultReplicationSpecRegionConfigElectableSpecs;
|
|
1997
2075
|
/**
|
|
1998
2076
|
* Election priority of the region.
|
|
1999
2077
|
*/
|
|
@@ -2005,7 +2083,7 @@ export interface GetAdvancedClustersResultReplicationSpecRegionConfig {
|
|
|
2005
2083
|
/**
|
|
2006
2084
|
* Hardware specifications for read-only nodes in the region. See below
|
|
2007
2085
|
*/
|
|
2008
|
-
readOnlySpecs
|
|
2086
|
+
readOnlySpecs: outputs.GetAdvancedClustersResultReplicationSpecRegionConfigReadOnlySpecs;
|
|
2009
2087
|
/**
|
|
2010
2088
|
* Physical location of your MongoDB cluster.
|
|
2011
2089
|
*/
|
|
@@ -2035,15 +2113,19 @@ export interface GetAdvancedClustersResultReplicationSpecRegionConfigAnalyticsAu
|
|
|
2035
2113
|
}
|
|
2036
2114
|
export interface GetAdvancedClustersResultReplicationSpecRegionConfigAnalyticsSpecs {
|
|
2037
2115
|
/**
|
|
2038
|
-
* Target
|
|
2116
|
+
* Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. This parameter defaults to the cluster tier's standard IOPS value.
|
|
2039
2117
|
*/
|
|
2040
2118
|
diskIops: number;
|
|
2119
|
+
/**
|
|
2120
|
+
* Storage capacity that the host's root volume possesses expressed in gigabytes. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. 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.
|
|
2121
|
+
*/
|
|
2122
|
+
diskSizeGb: number;
|
|
2041
2123
|
/**
|
|
2042
2124
|
* Type of storage you want to attach to your AWS-provisioned cluster.
|
|
2043
2125
|
* * `STANDARD` volume types can't exceed the default IOPS rate for the selected volume size.
|
|
2044
2126
|
* * `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size.
|
|
2045
2127
|
*/
|
|
2046
|
-
ebsVolumeType
|
|
2128
|
+
ebsVolumeType: string;
|
|
2047
2129
|
/**
|
|
2048
2130
|
* Hardware specification for the instance sizes in this region.
|
|
2049
2131
|
*/
|
|
@@ -2077,15 +2159,19 @@ export interface GetAdvancedClustersResultReplicationSpecRegionConfigAutoScaling
|
|
|
2077
2159
|
}
|
|
2078
2160
|
export interface GetAdvancedClustersResultReplicationSpecRegionConfigElectableSpecs {
|
|
2079
2161
|
/**
|
|
2080
|
-
* Target
|
|
2162
|
+
* Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. This parameter defaults to the cluster tier's standard IOPS value.
|
|
2081
2163
|
*/
|
|
2082
2164
|
diskIops: number;
|
|
2165
|
+
/**
|
|
2166
|
+
* Storage capacity that the host's root volume possesses expressed in gigabytes. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. 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.
|
|
2167
|
+
*/
|
|
2168
|
+
diskSizeGb: number;
|
|
2083
2169
|
/**
|
|
2084
2170
|
* Type of storage you want to attach to your AWS-provisioned cluster.
|
|
2085
2171
|
* * `STANDARD` volume types can't exceed the default IOPS rate for the selected volume size.
|
|
2086
2172
|
* * `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size.
|
|
2087
2173
|
*/
|
|
2088
|
-
ebsVolumeType
|
|
2174
|
+
ebsVolumeType: string;
|
|
2089
2175
|
/**
|
|
2090
2176
|
* Hardware specification for the instance sizes in this region.
|
|
2091
2177
|
*/
|
|
@@ -2097,15 +2183,19 @@ export interface GetAdvancedClustersResultReplicationSpecRegionConfigElectableSp
|
|
|
2097
2183
|
}
|
|
2098
2184
|
export interface GetAdvancedClustersResultReplicationSpecRegionConfigReadOnlySpecs {
|
|
2099
2185
|
/**
|
|
2100
|
-
* Target
|
|
2186
|
+
* Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. This parameter defaults to the cluster tier's standard IOPS value.
|
|
2101
2187
|
*/
|
|
2102
2188
|
diskIops: number;
|
|
2189
|
+
/**
|
|
2190
|
+
* Storage capacity that the host's root volume possesses expressed in gigabytes. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. 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.
|
|
2191
|
+
*/
|
|
2192
|
+
diskSizeGb: number;
|
|
2103
2193
|
/**
|
|
2104
2194
|
* Type of storage you want to attach to your AWS-provisioned cluster.
|
|
2105
2195
|
* * `STANDARD` volume types can't exceed the default IOPS rate for the selected volume size.
|
|
2106
2196
|
* * `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size.
|
|
2107
2197
|
*/
|
|
2108
|
-
ebsVolumeType
|
|
2198
|
+
ebsVolumeType: string;
|
|
2109
2199
|
/**
|
|
2110
2200
|
* Hardware specification for the instance sizes in this region.
|
|
2111
2201
|
*/
|
|
@@ -2805,13 +2895,19 @@ export interface GetCloudBackupScheduleCopySetting {
|
|
|
2805
2895
|
*/
|
|
2806
2896
|
regionName: string;
|
|
2807
2897
|
/**
|
|
2808
|
-
* Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Replication Spec Id, consult the replicationSpecs array returned from [Return One Multi-Cloud Cluster in One Project](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getCluster).
|
|
2898
|
+
* Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Replication Spec Id, consult the replicationSpecs array returned from [Return One Multi-Cloud Cluster in One Project](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getCluster). **(DEPRECATED)** Use `zoneId` instead. To learn more, see the 1.18.0 upgrade guide.
|
|
2899
|
+
*
|
|
2900
|
+
* @deprecated This parameter is deprecated. Please transition to `copy_settings.#.zone_id`. To learn more, see our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
|
|
2809
2901
|
*/
|
|
2810
2902
|
replicationSpecId: string;
|
|
2811
2903
|
/**
|
|
2812
2904
|
* Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores.
|
|
2813
2905
|
*/
|
|
2814
2906
|
shouldCopyOplogs: boolean;
|
|
2907
|
+
/**
|
|
2908
|
+
* Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster.
|
|
2909
|
+
*/
|
|
2910
|
+
zoneId: string;
|
|
2815
2911
|
}
|
|
2816
2912
|
export interface GetCloudBackupScheduleExport {
|
|
2817
2913
|
/**
|
|
@@ -2935,11 +3031,11 @@ export interface GetCloudBackupSchedulePolicyItemYearly {
|
|
|
2935
3031
|
}
|
|
2936
3032
|
export interface GetCloudBackupSnapshotExportBucketsResult {
|
|
2937
3033
|
/**
|
|
2938
|
-
* Name of the bucket that the provided role ID is authorized to access.
|
|
3034
|
+
* Name of the bucket that the provided role ID is authorized to access.
|
|
2939
3035
|
*/
|
|
2940
3036
|
bucketName: string;
|
|
2941
3037
|
/**
|
|
2942
|
-
* Name of the provider of the cloud service where Atlas can access the S3 bucket.
|
|
3038
|
+
* Name of the provider of the cloud service where Atlas can access the S3 bucket.
|
|
2943
3039
|
*/
|
|
2944
3040
|
cloudProvider: string;
|
|
2945
3041
|
/**
|
|
@@ -2947,9 +3043,21 @@ export interface GetCloudBackupSnapshotExportBucketsResult {
|
|
|
2947
3043
|
*/
|
|
2948
3044
|
exportBucketId: string;
|
|
2949
3045
|
/**
|
|
2950
|
-
* Unique identifier of the role that Atlas can use to access the bucket.
|
|
3046
|
+
* Unique identifier of the role that Atlas can use to access the bucket.
|
|
2951
3047
|
*/
|
|
2952
3048
|
iamRoleId: string;
|
|
3049
|
+
/**
|
|
3050
|
+
* Unique identifier of the Azure Service Principal that Atlas can use to access the Azure Blob Storage Container.
|
|
3051
|
+
*/
|
|
3052
|
+
roleId: string;
|
|
3053
|
+
/**
|
|
3054
|
+
* URL that identifies the blob Endpoint of the Azure Blob Storage Account.
|
|
3055
|
+
*/
|
|
3056
|
+
serviceUrl: string;
|
|
3057
|
+
/**
|
|
3058
|
+
* UUID that identifies the Azure Active Directory Tenant ID.
|
|
3059
|
+
*/
|
|
3060
|
+
tenantId: string;
|
|
2953
3061
|
}
|
|
2954
3062
|
export interface GetCloudBackupSnapshotExportJobComponent {
|
|
2955
3063
|
/**
|
|
@@ -3058,12 +3166,6 @@ export interface GetCloudBackupSnapshotRestoreJobsResult {
|
|
|
3058
3166
|
* Indicates whether the restore job was canceled.
|
|
3059
3167
|
*/
|
|
3060
3168
|
cancelled: boolean;
|
|
3061
|
-
/**
|
|
3062
|
-
* UTC ISO 8601 formatted point in time when Atlas created the restore job.
|
|
3063
|
-
*
|
|
3064
|
-
* @deprecated This parameter is deprecated and will be removed in version 1.18.0.
|
|
3065
|
-
*/
|
|
3066
|
-
createdAt: string;
|
|
3067
3169
|
/**
|
|
3068
3170
|
* Type of restore job to create. Possible values are: automated and download.
|
|
3069
3171
|
*/
|
|
@@ -3210,6 +3312,8 @@ export interface GetCloudProviderAccessSetupAzureConfig {
|
|
|
3210
3312
|
export interface GetClusterAdvancedConfiguration {
|
|
3211
3313
|
/**
|
|
3212
3314
|
* [Default level of acknowledgment requested from MongoDB for read operations](https://docs.mongodb.com/manual/reference/read-concern/) set for this cluster. MongoDB 4.4 clusters default to [available](https://docs.mongodb.com/manual/reference/read-concern-available/).
|
|
3315
|
+
*
|
|
3316
|
+
* @deprecated This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
|
|
3213
3317
|
*/
|
|
3214
3318
|
defaultReadConcern: string;
|
|
3215
3319
|
/**
|
|
@@ -3218,6 +3322,8 @@ export interface GetClusterAdvancedConfiguration {
|
|
|
3218
3322
|
defaultWriteConcern: string;
|
|
3219
3323
|
/**
|
|
3220
3324
|
* 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.
|
|
3325
|
+
*
|
|
3326
|
+
* @deprecated This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
|
|
3221
3327
|
*/
|
|
3222
3328
|
failIndexKeyTooLong: boolean;
|
|
3223
3329
|
/**
|
|
@@ -3590,6 +3696,8 @@ export interface GetClustersResult {
|
|
|
3590
3696
|
export interface GetClustersResultAdvancedConfiguration {
|
|
3591
3697
|
/**
|
|
3592
3698
|
* [Default level of acknowledgment requested from MongoDB for read operations](https://docs.mongodb.com/manual/reference/read-concern/) set for this cluster. MongoDB 4.4 clusters default to [available](https://docs.mongodb.com/manual/reference/read-concern-available/).
|
|
3699
|
+
*
|
|
3700
|
+
* @deprecated This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
|
|
3593
3701
|
*/
|
|
3594
3702
|
defaultReadConcern: string;
|
|
3595
3703
|
/**
|
|
@@ -3598,6 +3706,8 @@ export interface GetClustersResultAdvancedConfiguration {
|
|
|
3598
3706
|
defaultWriteConcern: string;
|
|
3599
3707
|
/**
|
|
3600
3708
|
* 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.
|
|
3709
|
+
*
|
|
3710
|
+
* @deprecated This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide.html.markdown
|
|
3601
3711
|
*/
|
|
3602
3712
|
failIndexKeyTooLong: boolean;
|
|
3603
3713
|
/**
|
|
@@ -5384,10 +5494,6 @@ export interface GetPrivateLinkEndpointServiceEndpoint {
|
|
|
5384
5494
|
* Private IP address of the network endpoint group you created in GCP.
|
|
5385
5495
|
*/
|
|
5386
5496
|
ipAddress: string;
|
|
5387
|
-
/**
|
|
5388
|
-
* Unique alphanumeric and special character strings that identify the service attachment associated with the endpoint.
|
|
5389
|
-
*/
|
|
5390
|
-
serviceAttachmentName: string;
|
|
5391
5497
|
/**
|
|
5392
5498
|
* Status of the endpoint. Atlas returns one of the [values shown above](https://docs.atlas.mongodb.com/reference/api/private-endpoints-endpoint-create-one/#std-label-ref-status-field).
|
|
5393
5499
|
*/
|
|
@@ -6041,12 +6147,6 @@ export interface GetThirdPartyIntegrationsResult {
|
|
|
6041
6147
|
* * `WEBHOOK`
|
|
6042
6148
|
*/
|
|
6043
6149
|
routingKey: string;
|
|
6044
|
-
/**
|
|
6045
|
-
* Your Prometheus protocol scheme configured for requests. **Note** This attribute is deprecated as it is not being used.
|
|
6046
|
-
*
|
|
6047
|
-
* @deprecated This parameter is deprecated and will be removed in version 1.18.0.
|
|
6048
|
-
*/
|
|
6049
|
-
scheme?: string;
|
|
6050
6150
|
/**
|
|
6051
6151
|
* An optional field for your webhook secret.
|
|
6052
6152
|
* * `MICROSOFT_TEAMS`
|
|
@@ -6227,12 +6327,6 @@ export interface PrivateLinkEndpointServiceEndpoint {
|
|
|
6227
6327
|
* Private IP address of the endpoint you created in GCP.
|
|
6228
6328
|
*/
|
|
6229
6329
|
ipAddress?: string;
|
|
6230
|
-
/**
|
|
6231
|
-
* Unique alphanumeric and special character strings that identify the service attachment associated with the endpoint.
|
|
6232
|
-
*
|
|
6233
|
-
* @deprecated This parameter is deprecated and will be removed in version 1.18.0.
|
|
6234
|
-
*/
|
|
6235
|
-
serviceAttachmentName: string;
|
|
6236
6330
|
/**
|
|
6237
6331
|
* Status of the endpoint. Atlas returns one of the [values shown above](https://docs.atlas.mongodb.com/reference/api/private-endpoints-endpoint-create-one/#std-label-ref-status-field).
|
|
6238
6332
|
*/
|