@pulumi/mongodbatlas 3.29.0-alpha.1741845855 → 3.29.0
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 +17 -397
- package/advancedCluster.js +0 -380
- package/advancedCluster.js.map +1 -1
- package/backupCompliancePolicy.d.ts +56 -2
- package/backupCompliancePolicy.js +0 -3
- package/backupCompliancePolicy.js.map +1 -1
- package/cloudBackupSnapshot.d.ts +2 -2
- package/cluster.d.ts +25 -8
- package/cluster.js +17 -0
- package/cluster.js.map +1 -1
- package/customDbRole.d.ts +3 -3
- package/getAdvancedCluster.d.ts +11 -14
- package/getAdvancedCluster.js +6 -6
- package/getAdvancedCluster.js.map +1 -1
- package/getAdvancedClusters.d.ts +6 -6
- package/getAdvancedClusters.js +6 -6
- package/getAuditing.d.ts +2 -2
- package/getBackupCompliancePolicy.d.ts +18 -0
- package/getBackupCompliancePolicy.js.map +1 -1
- package/getCluster.d.ts +4 -4
- package/getCustomDbRole.d.ts +2 -2
- package/getGlobalClusterConfig.d.ts +2 -2
- package/getNetworkContainer.d.ts +2 -2
- package/getNetworkContainers.d.ts +2 -2
- package/getNetworkPeering.d.ts +2 -2
- package/getNetworkPeerings.d.ts +2 -2
- package/getStreamConnection.d.ts +4 -0
- package/getStreamConnection.js.map +1 -1
- package/globalClusterConfig.d.ts +4 -4
- package/globalClusterConfig.js +1 -1
- package/networkPeering.d.ts +3 -3
- package/package.json +2 -2
- package/streamConnection.d.ts +6 -3
- package/streamConnection.js +2 -0
- package/streamConnection.js.map +1 -1
- package/types/input.d.ts +26 -21
- package/types/output.d.ts +78 -60
package/advancedCluster.d.ts
CHANGED
|
@@ -2,386 +2,6 @@ import * as pulumi from "@pulumi/pulumi";
|
|
|
2
2
|
import * as inputs from "./types/input";
|
|
3
3
|
import * as outputs from "./types/output";
|
|
4
4
|
/**
|
|
5
|
-
* ## Example Usage
|
|
6
|
-
*
|
|
7
|
-
* ### Example single provider and single region
|
|
8
|
-
*
|
|
9
|
-
* ```typescript
|
|
10
|
-
* import * as pulumi from "@pulumi/pulumi";
|
|
11
|
-
* import * as mongodbatlas from "@pulumi/mongodbatlas";
|
|
12
|
-
*
|
|
13
|
-
* const test = new mongodbatlas.AdvancedCluster("test", {
|
|
14
|
-
* projectId: "PROJECT ID",
|
|
15
|
-
* name: "NAME OF CLUSTER",
|
|
16
|
-
* clusterType: "REPLICASET",
|
|
17
|
-
* replicationSpecs: [{
|
|
18
|
-
* regionConfigs: [{
|
|
19
|
-
* electableSpecs: {
|
|
20
|
-
* instanceSize: "M10",
|
|
21
|
-
* nodeCount: 3,
|
|
22
|
-
* },
|
|
23
|
-
* analyticsSpecs: {
|
|
24
|
-
* instanceSize: "M10",
|
|
25
|
-
* nodeCount: 1,
|
|
26
|
-
* },
|
|
27
|
-
* providerName: "AWS",
|
|
28
|
-
* priority: 7,
|
|
29
|
-
* regionName: "US_EAST_1",
|
|
30
|
-
* }],
|
|
31
|
-
* }],
|
|
32
|
-
* });
|
|
33
|
-
* ```
|
|
34
|
-
*
|
|
35
|
-
* ### Example Tenant Cluster
|
|
36
|
-
*
|
|
37
|
-
* ```typescript
|
|
38
|
-
* import * as pulumi from "@pulumi/pulumi";
|
|
39
|
-
* import * as mongodbatlas from "@pulumi/mongodbatlas";
|
|
40
|
-
*
|
|
41
|
-
* const test = new mongodbatlas.AdvancedCluster("test", {
|
|
42
|
-
* projectId: "PROJECT ID",
|
|
43
|
-
* name: "NAME OF CLUSTER",
|
|
44
|
-
* clusterType: "REPLICASET",
|
|
45
|
-
* replicationSpecs: [{
|
|
46
|
-
* regionConfigs: [{
|
|
47
|
-
* electableSpecs: {
|
|
48
|
-
* instanceSize: "M0",
|
|
49
|
-
* },
|
|
50
|
-
* providerName: "TENANT",
|
|
51
|
-
* backingProviderName: "AWS",
|
|
52
|
-
* regionName: "US_EAST_1",
|
|
53
|
-
* priority: 7,
|
|
54
|
-
* }],
|
|
55
|
-
* }],
|
|
56
|
-
* });
|
|
57
|
-
* ```
|
|
58
|
-
*
|
|
59
|
-
* **NOTE:** There can only be one M0 cluster per project.
|
|
60
|
-
*
|
|
61
|
-
* **NOTE**: Upgrading the tenant cluster to a Flex cluster or a dedicated cluster is supported. When upgrading to a Flex cluster, change the `providerName` from "TENANT" to "FLEX". See Example Tenant Cluster Upgrade to Flex below. When upgrading to a dedicated cluster, change the `providerName` to your preferred provider (AWS, GCP or Azure) and remove the variable `backingProviderName`. See the Example Tenant Cluster Upgrade below. You can upgrade a tenant cluster only to a single provider on an M10-tier cluster or greater.
|
|
62
|
-
*
|
|
63
|
-
* When upgrading from the tenant, *only* the upgrade changes will be applied. This helps avoid a corrupt state file in the event that the upgrade succeeds but subsequent updates fail within the same `pulumi up`. To apply additional cluster changes, run a secondary `pulumi up` after the upgrade succeeds.
|
|
64
|
-
*
|
|
65
|
-
* ### Example Tenant Cluster Upgrade
|
|
66
|
-
*
|
|
67
|
-
* ```typescript
|
|
68
|
-
* import * as pulumi from "@pulumi/pulumi";
|
|
69
|
-
* import * as mongodbatlas from "@pulumi/mongodbatlas";
|
|
70
|
-
*
|
|
71
|
-
* const test = new mongodbatlas.AdvancedCluster("test", {
|
|
72
|
-
* projectId: "PROJECT ID",
|
|
73
|
-
* name: "NAME OF CLUSTER",
|
|
74
|
-
* clusterType: "REPLICASET",
|
|
75
|
-
* replicationSpecs: [{
|
|
76
|
-
* regionConfigs: [{
|
|
77
|
-
* electableSpecs: {
|
|
78
|
-
* instanceSize: "M10",
|
|
79
|
-
* },
|
|
80
|
-
* providerName: "AWS",
|
|
81
|
-
* regionName: "US_EAST_1",
|
|
82
|
-
* priority: 7,
|
|
83
|
-
* }],
|
|
84
|
-
* }],
|
|
85
|
-
* });
|
|
86
|
-
* ```
|
|
87
|
-
*
|
|
88
|
-
* ### Example Tenant Cluster Upgrade to Flex
|
|
89
|
-
*
|
|
90
|
-
* ```typescript
|
|
91
|
-
* import * as pulumi from "@pulumi/pulumi";
|
|
92
|
-
* import * as mongodbatlas from "@pulumi/mongodbatlas";
|
|
93
|
-
*
|
|
94
|
-
* const example_flex = new mongodbatlas.AdvancedCluster("example-flex", {
|
|
95
|
-
* projectId: "PROJECT ID",
|
|
96
|
-
* name: "NAME OF CLUSTER",
|
|
97
|
-
* clusterType: "REPLICASET",
|
|
98
|
-
* replicationSpecs: [{
|
|
99
|
-
* regionConfigs: [{
|
|
100
|
-
* providerName: "FLEX",
|
|
101
|
-
* backingProviderName: "AWS",
|
|
102
|
-
* regionName: "US_EAST_1",
|
|
103
|
-
* priority: 7,
|
|
104
|
-
* }],
|
|
105
|
-
* }],
|
|
106
|
-
* });
|
|
107
|
-
* ```
|
|
108
|
-
*
|
|
109
|
-
* ### Example Flex Cluster
|
|
110
|
-
*
|
|
111
|
-
* ```typescript
|
|
112
|
-
* import * as pulumi from "@pulumi/pulumi";
|
|
113
|
-
* import * as mongodbatlas from "@pulumi/mongodbatlas";
|
|
114
|
-
*
|
|
115
|
-
* const example_flex = new mongodbatlas.AdvancedCluster("example-flex", {
|
|
116
|
-
* projectId: "PROJECT ID",
|
|
117
|
-
* name: "NAME OF CLUSTER",
|
|
118
|
-
* clusterType: "REPLICASET",
|
|
119
|
-
* replicationSpecs: [{
|
|
120
|
-
* regionConfigs: [{
|
|
121
|
-
* providerName: "FLEX",
|
|
122
|
-
* backingProviderName: "AWS",
|
|
123
|
-
* regionName: "US_EAST_1",
|
|
124
|
-
* priority: 7,
|
|
125
|
-
* }],
|
|
126
|
-
* }],
|
|
127
|
-
* });
|
|
128
|
-
* ```
|
|
129
|
-
*
|
|
130
|
-
* **NOTE**: Upgrading the Flex cluster is supported. When upgrading from a Flex cluster, change the `providerName` from "TENANT" to your preferred provider (AWS, GCP or Azure) and remove the variable `backingProviderName`. See the Example Flex Cluster Upgrade below. You can upgrade a Flex cluster only to a single provider on an M10-tier cluster or greater.
|
|
131
|
-
*
|
|
132
|
-
* When upgrading from a flex cluster, *only* the upgrade changes will be applied. This helps avoid a corrupt state file in the event that the upgrade succeeds but subsequent updates fail within the same `pulumi up`. To apply additional cluster changes, run a secondary `pulumi up` after the upgrade succeeds.
|
|
133
|
-
*
|
|
134
|
-
* ### Example Flex Cluster Upgrade
|
|
135
|
-
*
|
|
136
|
-
* ```typescript
|
|
137
|
-
* import * as pulumi from "@pulumi/pulumi";
|
|
138
|
-
* import * as mongodbatlas from "@pulumi/mongodbatlas";
|
|
139
|
-
*
|
|
140
|
-
* const test = new mongodbatlas.AdvancedCluster("test", {
|
|
141
|
-
* projectId: "PROJECT ID",
|
|
142
|
-
* name: "NAME OF CLUSTER",
|
|
143
|
-
* clusterType: "REPLICASET",
|
|
144
|
-
* replicationSpecs: [{
|
|
145
|
-
* regionConfigs: [{
|
|
146
|
-
* electableSpecs: {
|
|
147
|
-
* instanceSize: "M10",
|
|
148
|
-
* },
|
|
149
|
-
* providerName: "AWS",
|
|
150
|
-
* regionName: "US_EAST_1",
|
|
151
|
-
* priority: 7,
|
|
152
|
-
* }],
|
|
153
|
-
* }],
|
|
154
|
-
* });
|
|
155
|
-
* ```
|
|
156
|
-
*
|
|
157
|
-
* ### Example Multi-Cloud Cluster
|
|
158
|
-
* ```typescript
|
|
159
|
-
* import * as pulumi from "@pulumi/pulumi";
|
|
160
|
-
* import * as mongodbatlas from "@pulumi/mongodbatlas";
|
|
161
|
-
*
|
|
162
|
-
* const test = new mongodbatlas.AdvancedCluster("test", {
|
|
163
|
-
* projectId: "PROJECT ID",
|
|
164
|
-
* name: "NAME OF CLUSTER",
|
|
165
|
-
* clusterType: "REPLICASET",
|
|
166
|
-
* replicationSpecs: [{
|
|
167
|
-
* regionConfigs: [
|
|
168
|
-
* {
|
|
169
|
-
* electableSpecs: {
|
|
170
|
-
* instanceSize: "M10",
|
|
171
|
-
* nodeCount: 3,
|
|
172
|
-
* },
|
|
173
|
-
* analyticsSpecs: {
|
|
174
|
-
* instanceSize: "M10",
|
|
175
|
-
* nodeCount: 1,
|
|
176
|
-
* },
|
|
177
|
-
* providerName: "AWS",
|
|
178
|
-
* priority: 7,
|
|
179
|
-
* regionName: "US_EAST_1",
|
|
180
|
-
* },
|
|
181
|
-
* {
|
|
182
|
-
* electableSpecs: {
|
|
183
|
-
* instanceSize: "M10",
|
|
184
|
-
* nodeCount: 2,
|
|
185
|
-
* },
|
|
186
|
-
* providerName: "GCP",
|
|
187
|
-
* priority: 6,
|
|
188
|
-
* regionName: "NORTH_AMERICA_NORTHEAST_1",
|
|
189
|
-
* },
|
|
190
|
-
* ],
|
|
191
|
-
* }],
|
|
192
|
-
* });
|
|
193
|
-
* ```
|
|
194
|
-
* ### Example of a Multi Cloud Sharded Cluster with 2 shards
|
|
195
|
-
*
|
|
196
|
-
* ```typescript
|
|
197
|
-
* import * as pulumi from "@pulumi/pulumi";
|
|
198
|
-
* import * as mongodbatlas from "@pulumi/mongodbatlas";
|
|
199
|
-
*
|
|
200
|
-
* const cluster = new mongodbatlas.AdvancedCluster("cluster", {
|
|
201
|
-
* projectId: project.id,
|
|
202
|
-
* name: clusterName,
|
|
203
|
-
* clusterType: "SHARDED",
|
|
204
|
-
* backupEnabled: true,
|
|
205
|
-
* replicationSpecs: [
|
|
206
|
-
* {
|
|
207
|
-
* regionConfigs: [
|
|
208
|
-
* {
|
|
209
|
-
* electableSpecs: {
|
|
210
|
-
* instanceSize: "M30",
|
|
211
|
-
* nodeCount: 3,
|
|
212
|
-
* },
|
|
213
|
-
* providerName: "AWS",
|
|
214
|
-
* priority: 7,
|
|
215
|
-
* regionName: "US_EAST_1",
|
|
216
|
-
* },
|
|
217
|
-
* {
|
|
218
|
-
* electableSpecs: {
|
|
219
|
-
* instanceSize: "M30",
|
|
220
|
-
* nodeCount: 2,
|
|
221
|
-
* },
|
|
222
|
-
* providerName: "AZURE",
|
|
223
|
-
* priority: 6,
|
|
224
|
-
* regionName: "US_EAST_2",
|
|
225
|
-
* },
|
|
226
|
-
* ],
|
|
227
|
-
* },
|
|
228
|
-
* {
|
|
229
|
-
* regionConfigs: [
|
|
230
|
-
* {
|
|
231
|
-
* electableSpecs: {
|
|
232
|
-
* instanceSize: "M30",
|
|
233
|
-
* nodeCount: 3,
|
|
234
|
-
* },
|
|
235
|
-
* providerName: "AWS",
|
|
236
|
-
* priority: 7,
|
|
237
|
-
* regionName: "US_EAST_1",
|
|
238
|
-
* },
|
|
239
|
-
* {
|
|
240
|
-
* electableSpecs: {
|
|
241
|
-
* instanceSize: "M30",
|
|
242
|
-
* nodeCount: 2,
|
|
243
|
-
* },
|
|
244
|
-
* providerName: "AZURE",
|
|
245
|
-
* priority: 6,
|
|
246
|
-
* regionName: "US_EAST_2",
|
|
247
|
-
* },
|
|
248
|
-
* ],
|
|
249
|
-
* },
|
|
250
|
-
* ],
|
|
251
|
-
* advancedConfiguration: {
|
|
252
|
-
* javascriptEnabled: true,
|
|
253
|
-
* oplogSizeMb: 991,
|
|
254
|
-
* sampleRefreshIntervalBiConnector: 300,
|
|
255
|
-
* },
|
|
256
|
-
* });
|
|
257
|
-
* ```
|
|
258
|
-
*
|
|
259
|
-
* ### Example of a Global Cluster with 2 zones
|
|
260
|
-
* ```typescript
|
|
261
|
-
* import * as pulumi from "@pulumi/pulumi";
|
|
262
|
-
* import * as mongodbatlas from "@pulumi/mongodbatlas";
|
|
263
|
-
*
|
|
264
|
-
* const cluster = new mongodbatlas.AdvancedCluster("cluster", {
|
|
265
|
-
* projectId: project.id,
|
|
266
|
-
* name: clusterName,
|
|
267
|
-
* clusterType: "GEOSHARDED",
|
|
268
|
-
* backupEnabled: true,
|
|
269
|
-
* replicationSpecs: [
|
|
270
|
-
* {
|
|
271
|
-
* zoneName: "zone n1",
|
|
272
|
-
* regionConfigs: [
|
|
273
|
-
* {
|
|
274
|
-
* electableSpecs: {
|
|
275
|
-
* instanceSize: "M30",
|
|
276
|
-
* nodeCount: 3,
|
|
277
|
-
* },
|
|
278
|
-
* providerName: "AWS",
|
|
279
|
-
* priority: 7,
|
|
280
|
-
* regionName: "US_EAST_1",
|
|
281
|
-
* },
|
|
282
|
-
* {
|
|
283
|
-
* electableSpecs: {
|
|
284
|
-
* instanceSize: "M30",
|
|
285
|
-
* nodeCount: 2,
|
|
286
|
-
* },
|
|
287
|
-
* providerName: "AZURE",
|
|
288
|
-
* priority: 6,
|
|
289
|
-
* regionName: "US_EAST_2",
|
|
290
|
-
* },
|
|
291
|
-
* ],
|
|
292
|
-
* },
|
|
293
|
-
* {
|
|
294
|
-
* zoneName: "zone n1",
|
|
295
|
-
* regionConfigs: [
|
|
296
|
-
* {
|
|
297
|
-
* electableSpecs: {
|
|
298
|
-
* instanceSize: "M30",
|
|
299
|
-
* nodeCount: 3,
|
|
300
|
-
* },
|
|
301
|
-
* providerName: "AWS",
|
|
302
|
-
* priority: 7,
|
|
303
|
-
* regionName: "US_EAST_1",
|
|
304
|
-
* },
|
|
305
|
-
* {
|
|
306
|
-
* electableSpecs: {
|
|
307
|
-
* instanceSize: "M30",
|
|
308
|
-
* nodeCount: 2,
|
|
309
|
-
* },
|
|
310
|
-
* providerName: "AZURE",
|
|
311
|
-
* priority: 6,
|
|
312
|
-
* regionName: "US_EAST_2",
|
|
313
|
-
* },
|
|
314
|
-
* ],
|
|
315
|
-
* },
|
|
316
|
-
* {
|
|
317
|
-
* zoneName: "zone n2",
|
|
318
|
-
* regionConfigs: [
|
|
319
|
-
* {
|
|
320
|
-
* electableSpecs: {
|
|
321
|
-
* instanceSize: "M30",
|
|
322
|
-
* nodeCount: 3,
|
|
323
|
-
* },
|
|
324
|
-
* providerName: "AWS",
|
|
325
|
-
* priority: 7,
|
|
326
|
-
* regionName: "EU_WEST_1",
|
|
327
|
-
* },
|
|
328
|
-
* {
|
|
329
|
-
* electableSpecs: {
|
|
330
|
-
* instanceSize: "M30",
|
|
331
|
-
* nodeCount: 2,
|
|
332
|
-
* },
|
|
333
|
-
* providerName: "AZURE",
|
|
334
|
-
* priority: 6,
|
|
335
|
-
* regionName: "EUROPE_NORTH",
|
|
336
|
-
* },
|
|
337
|
-
* ],
|
|
338
|
-
* },
|
|
339
|
-
* {
|
|
340
|
-
* zoneName: "zone n2",
|
|
341
|
-
* regionConfigs: [
|
|
342
|
-
* {
|
|
343
|
-
* electableSpecs: {
|
|
344
|
-
* instanceSize: "M30",
|
|
345
|
-
* nodeCount: 3,
|
|
346
|
-
* },
|
|
347
|
-
* providerName: "AWS",
|
|
348
|
-
* priority: 7,
|
|
349
|
-
* regionName: "EU_WEST_1",
|
|
350
|
-
* },
|
|
351
|
-
* {
|
|
352
|
-
* electableSpecs: {
|
|
353
|
-
* instanceSize: "M30",
|
|
354
|
-
* nodeCount: 2,
|
|
355
|
-
* },
|
|
356
|
-
* providerName: "AZURE",
|
|
357
|
-
* priority: 6,
|
|
358
|
-
* regionName: "EUROPE_NORTH",
|
|
359
|
-
* },
|
|
360
|
-
* ],
|
|
361
|
-
* },
|
|
362
|
-
* ],
|
|
363
|
-
* advancedConfiguration: {
|
|
364
|
-
* javascriptEnabled: true,
|
|
365
|
-
* oplogSizeMb: 999,
|
|
366
|
-
* sampleRefreshIntervalBiConnector: 300,
|
|
367
|
-
* },
|
|
368
|
-
* });
|
|
369
|
-
* ```
|
|
370
|
-
*
|
|
371
|
-
* ### Example - Return a Connection String
|
|
372
|
-
* Standard
|
|
373
|
-
* ```typescript
|
|
374
|
-
* import * as pulumi from "@pulumi/pulumi";
|
|
375
|
-
*
|
|
376
|
-
* export const standard = cluster.connectionStrings[0].standard;
|
|
377
|
-
* ```
|
|
378
|
-
* Standard srv
|
|
379
|
-
* ```typescript
|
|
380
|
-
* import * as pulumi from "@pulumi/pulumi";
|
|
381
|
-
*
|
|
382
|
-
* export const standardSrv = cluster.connectionStrings[0].standardSrv;
|
|
383
|
-
* ```
|
|
384
|
-
* Private with Network peering and Custom DNS AWS enabled
|
|
385
5
|
* ## Import
|
|
386
6
|
*
|
|
387
7
|
* Clusters can be imported using project ID and cluster name, in the format `PROJECTID-CLUSTERNAME`, e.g.
|
|
@@ -453,12 +73,12 @@ export declare class AdvancedCluster extends pulumi.CustomResource {
|
|
|
453
73
|
*/
|
|
454
74
|
readonly configServerType: pulumi.Output<string>;
|
|
455
75
|
/**
|
|
456
|
-
* Set of connection strings that your applications use to connect to this cluster. More
|
|
76
|
+
* Set of connection strings that your applications use to connect to this cluster. More information in [Connection-strings](https://docs.mongodb.com/manual/reference/connection-string/). Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see [Connection String Options](https://docs.atlas.mongodb.com/reference/faq/connection-changes/). NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.
|
|
457
77
|
*/
|
|
458
78
|
readonly connectionStrings: pulumi.Output<outputs.AdvancedClusterConnectionString[]>;
|
|
459
79
|
readonly createDate: pulumi.Output<string>;
|
|
460
80
|
/**
|
|
461
|
-
* Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (4 TB). This value must be a positive number. You can't set this value with clusters with local [NVMe SSDs](https://docs.atlas.mongodb.com/cluster-tier/#std-label-nvme-storage). The minimum disk size for dedicated clusters is 10 GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value. If your cluster includes Azure nodes, this value must correspond to an existing Azure disk type (8, 16, 32, 64, 128, 256, 512, 1024, 2048, or 4095)Atlas calculates storage charges differently depending 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 additional storage space beyond this limitation, consider [upgrading your cluster](https://docs.atlas.mongodb.com/scale-cluster/#std-label-scale-cluster-instance) to a higher tier. If your cluster spans cloud service providers, this value defaults to the minimum default of the providers involved. **(DEPRECATED)** Use `replication_specs.#.
|
|
81
|
+
* Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (4 TB). This value must be a positive number. You can't set this value with clusters with local [NVMe SSDs](https://docs.atlas.mongodb.com/cluster-tier/#std-label-nvme-storage). The minimum disk size for dedicated clusters is 10 GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value. If your cluster includes Azure nodes, this value must correspond to an existing Azure disk type (8, 16, 32, 64, 128, 256, 512, 1024, 2048, or 4095). Atlas calculates storage charges differently depending 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 additional storage space beyond this limitation, consider [upgrading your cluster](https://docs.atlas.mongodb.com/scale-cluster/#std-label-scale-cluster-instance) to a higher tier. If your cluster spans cloud service providers, this value defaults to the minimum default of the providers involved. **(DEPRECATED)** Use `replication_specs.#.region_configs.#.(analytics_specs|electable_specs|read_only_specs).disk_size_gb` instead. To learn more, see the 1.18.0 upgrade guide.
|
|
462
82
|
*
|
|
463
83
|
* @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
|
|
464
84
|
*/
|
|
@@ -468,7 +88,7 @@ export declare class AdvancedCluster extends pulumi.CustomResource {
|
|
|
468
88
|
*/
|
|
469
89
|
readonly encryptionAtRestProvider: pulumi.Output<string>;
|
|
470
90
|
/**
|
|
471
|
-
* Flag that indicates if cluster uses Atlas-Managed Sharding (false, default) or Self-Managed Sharding (true). It can only be enabled for Global Clusters (`GEOSHARDED`). It cannot be changed once the cluster is created. Use this mode if you're an advanced user and the default configuration is too restrictive for your workload. If you select this option, you must manually configure the sharding strategy, more
|
|
91
|
+
* Flag that indicates if cluster uses Atlas-Managed Sharding (false, default) or Self-Managed Sharding (true). It can only be enabled for Global Clusters (`GEOSHARDED`). It cannot be changed once the cluster is created. Use this mode if you're an advanced user and the default configuration is too restrictive for your workload. If you select this option, you must manually configure the sharding strategy, more information [here](https://www.mongodb.com/docs/atlas/tutorial/create-global-cluster/#select-your-sharding-configuration).
|
|
472
92
|
*/
|
|
473
93
|
readonly globalClusterSelfManagedSharding: pulumi.Output<boolean>;
|
|
474
94
|
/**
|
|
@@ -497,11 +117,11 @@ export declare class AdvancedCluster extends pulumi.CustomResource {
|
|
|
497
117
|
*/
|
|
498
118
|
readonly pitEnabled: pulumi.Output<boolean>;
|
|
499
119
|
/**
|
|
500
|
-
* Unique ID for the project to create the
|
|
120
|
+
* Unique ID for the project to create the cluster.
|
|
501
121
|
*/
|
|
502
122
|
readonly projectId: pulumi.Output<string>;
|
|
503
123
|
/**
|
|
504
|
-
* Flag that enables or disables log redaction, see the [manual](https://www.mongodb.com/docs/manual/administration/monitoring/#log-redaction) for more
|
|
124
|
+
* Flag that enables or disables log redaction, see the [manual](https://www.mongodb.com/docs/manual/administration/monitoring/#log-redaction) for more information. Use this in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements. **Note**: Changing this setting on a cluster will trigger a rolling restart as soon as the cluster is updated.
|
|
505
125
|
*/
|
|
506
126
|
readonly redactClientLogData: pulumi.Output<boolean>;
|
|
507
127
|
/**
|
|
@@ -509,7 +129,7 @@ export declare class AdvancedCluster extends pulumi.CustomResource {
|
|
|
509
129
|
*/
|
|
510
130
|
readonly replicaSetScalingStrategy: pulumi.Output<string>;
|
|
511
131
|
/**
|
|
512
|
-
* List of settings that configure your cluster regions. This attribute has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. If for each
|
|
132
|
+
* List of settings that configure your cluster regions. This attribute has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. If for each `replicationSpecs` a `numShards` is configured with a value greater than 1 (using deprecated sharding configurations), then each object represents a zone with one or more shards. The `replicationSpecs` configuration for all shards within the same zone must be the same, with the exception of `instanceSize` and `diskIops` that can scale independently. Note that independent `diskIops` values are only supported for AWS provisioned IOPS, or Azure regions that support Extended IOPS. See below.
|
|
513
133
|
*/
|
|
514
134
|
readonly replicationSpecs: pulumi.Output<outputs.AdvancedClusterReplicationSpec[]>;
|
|
515
135
|
/**
|
|
@@ -600,12 +220,12 @@ export interface AdvancedClusterState {
|
|
|
600
220
|
*/
|
|
601
221
|
configServerType?: pulumi.Input<string>;
|
|
602
222
|
/**
|
|
603
|
-
* Set of connection strings that your applications use to connect to this cluster. More
|
|
223
|
+
* Set of connection strings that your applications use to connect to this cluster. More information in [Connection-strings](https://docs.mongodb.com/manual/reference/connection-string/). Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see [Connection String Options](https://docs.atlas.mongodb.com/reference/faq/connection-changes/). NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.
|
|
604
224
|
*/
|
|
605
225
|
connectionStrings?: pulumi.Input<pulumi.Input<inputs.AdvancedClusterConnectionString>[]>;
|
|
606
226
|
createDate?: pulumi.Input<string>;
|
|
607
227
|
/**
|
|
608
|
-
* Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (4 TB). This value must be a positive number. You can't set this value with clusters with local [NVMe SSDs](https://docs.atlas.mongodb.com/cluster-tier/#std-label-nvme-storage). The minimum disk size for dedicated clusters is 10 GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value. If your cluster includes Azure nodes, this value must correspond to an existing Azure disk type (8, 16, 32, 64, 128, 256, 512, 1024, 2048, or 4095)Atlas calculates storage charges differently depending 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 additional storage space beyond this limitation, consider [upgrading your cluster](https://docs.atlas.mongodb.com/scale-cluster/#std-label-scale-cluster-instance) to a higher tier. If your cluster spans cloud service providers, this value defaults to the minimum default of the providers involved. **(DEPRECATED)** Use `replication_specs.#.
|
|
228
|
+
* Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (4 TB). This value must be a positive number. You can't set this value with clusters with local [NVMe SSDs](https://docs.atlas.mongodb.com/cluster-tier/#std-label-nvme-storage). The minimum disk size for dedicated clusters is 10 GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value. If your cluster includes Azure nodes, this value must correspond to an existing Azure disk type (8, 16, 32, 64, 128, 256, 512, 1024, 2048, or 4095). Atlas calculates storage charges differently depending 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 additional storage space beyond this limitation, consider [upgrading your cluster](https://docs.atlas.mongodb.com/scale-cluster/#std-label-scale-cluster-instance) to a higher tier. If your cluster spans cloud service providers, this value defaults to the minimum default of the providers involved. **(DEPRECATED)** Use `replication_specs.#.region_configs.#.(analytics_specs|electable_specs|read_only_specs).disk_size_gb` instead. To learn more, see the 1.18.0 upgrade guide.
|
|
609
229
|
*
|
|
610
230
|
* @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
|
|
611
231
|
*/
|
|
@@ -615,7 +235,7 @@ export interface AdvancedClusterState {
|
|
|
615
235
|
*/
|
|
616
236
|
encryptionAtRestProvider?: pulumi.Input<string>;
|
|
617
237
|
/**
|
|
618
|
-
* Flag that indicates if cluster uses Atlas-Managed Sharding (false, default) or Self-Managed Sharding (true). It can only be enabled for Global Clusters (`GEOSHARDED`). It cannot be changed once the cluster is created. Use this mode if you're an advanced user and the default configuration is too restrictive for your workload. If you select this option, you must manually configure the sharding strategy, more
|
|
238
|
+
* Flag that indicates if cluster uses Atlas-Managed Sharding (false, default) or Self-Managed Sharding (true). It can only be enabled for Global Clusters (`GEOSHARDED`). It cannot be changed once the cluster is created. Use this mode if you're an advanced user and the default configuration is too restrictive for your workload. If you select this option, you must manually configure the sharding strategy, more information [here](https://www.mongodb.com/docs/atlas/tutorial/create-global-cluster/#select-your-sharding-configuration).
|
|
619
239
|
*/
|
|
620
240
|
globalClusterSelfManagedSharding?: pulumi.Input<boolean>;
|
|
621
241
|
/**
|
|
@@ -644,11 +264,11 @@ export interface AdvancedClusterState {
|
|
|
644
264
|
*/
|
|
645
265
|
pitEnabled?: pulumi.Input<boolean>;
|
|
646
266
|
/**
|
|
647
|
-
* Unique ID for the project to create the
|
|
267
|
+
* Unique ID for the project to create the cluster.
|
|
648
268
|
*/
|
|
649
269
|
projectId?: pulumi.Input<string>;
|
|
650
270
|
/**
|
|
651
|
-
* Flag that enables or disables log redaction, see the [manual](https://www.mongodb.com/docs/manual/administration/monitoring/#log-redaction) for more
|
|
271
|
+
* Flag that enables or disables log redaction, see the [manual](https://www.mongodb.com/docs/manual/administration/monitoring/#log-redaction) for more information. Use this in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements. **Note**: Changing this setting on a cluster will trigger a rolling restart as soon as the cluster is updated.
|
|
652
272
|
*/
|
|
653
273
|
redactClientLogData?: pulumi.Input<boolean>;
|
|
654
274
|
/**
|
|
@@ -656,7 +276,7 @@ export interface AdvancedClusterState {
|
|
|
656
276
|
*/
|
|
657
277
|
replicaSetScalingStrategy?: pulumi.Input<string>;
|
|
658
278
|
/**
|
|
659
|
-
* List of settings that configure your cluster regions. This attribute has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. If for each
|
|
279
|
+
* List of settings that configure your cluster regions. This attribute has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. If for each `replicationSpecs` a `numShards` is configured with a value greater than 1 (using deprecated sharding configurations), then each object represents a zone with one or more shards. The `replicationSpecs` configuration for all shards within the same zone must be the same, with the exception of `instanceSize` and `diskIops` that can scale independently. Note that independent `diskIops` values are only supported for AWS provisioned IOPS, or Azure regions that support Extended IOPS. See below.
|
|
660
280
|
*/
|
|
661
281
|
replicationSpecs?: pulumi.Input<pulumi.Input<inputs.AdvancedClusterReplicationSpec>[]>;
|
|
662
282
|
/**
|
|
@@ -731,7 +351,7 @@ export interface AdvancedClusterArgs {
|
|
|
731
351
|
*/
|
|
732
352
|
configServerManagementMode?: pulumi.Input<string>;
|
|
733
353
|
/**
|
|
734
|
-
* Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (4 TB). This value must be a positive number. You can't set this value with clusters with local [NVMe SSDs](https://docs.atlas.mongodb.com/cluster-tier/#std-label-nvme-storage). The minimum disk size for dedicated clusters is 10 GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value. If your cluster includes Azure nodes, this value must correspond to an existing Azure disk type (8, 16, 32, 64, 128, 256, 512, 1024, 2048, or 4095)Atlas calculates storage charges differently depending 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 additional storage space beyond this limitation, consider [upgrading your cluster](https://docs.atlas.mongodb.com/scale-cluster/#std-label-scale-cluster-instance) to a higher tier. If your cluster spans cloud service providers, this value defaults to the minimum default of the providers involved. **(DEPRECATED)** Use `replication_specs.#.
|
|
354
|
+
* Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (4 TB). This value must be a positive number. You can't set this value with clusters with local [NVMe SSDs](https://docs.atlas.mongodb.com/cluster-tier/#std-label-nvme-storage). The minimum disk size for dedicated clusters is 10 GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value. If your cluster includes Azure nodes, this value must correspond to an existing Azure disk type (8, 16, 32, 64, 128, 256, 512, 1024, 2048, or 4095). Atlas calculates storage charges differently depending 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 additional storage space beyond this limitation, consider [upgrading your cluster](https://docs.atlas.mongodb.com/scale-cluster/#std-label-scale-cluster-instance) to a higher tier. If your cluster spans cloud service providers, this value defaults to the minimum default of the providers involved. **(DEPRECATED)** Use `replication_specs.#.region_configs.#.(analytics_specs|electable_specs|read_only_specs).disk_size_gb` instead. To learn more, see the 1.18.0 upgrade guide.
|
|
735
355
|
*
|
|
736
356
|
* @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
|
|
737
357
|
*/
|
|
@@ -741,7 +361,7 @@ export interface AdvancedClusterArgs {
|
|
|
741
361
|
*/
|
|
742
362
|
encryptionAtRestProvider?: pulumi.Input<string>;
|
|
743
363
|
/**
|
|
744
|
-
* Flag that indicates if cluster uses Atlas-Managed Sharding (false, default) or Self-Managed Sharding (true). It can only be enabled for Global Clusters (`GEOSHARDED`). It cannot be changed once the cluster is created. Use this mode if you're an advanced user and the default configuration is too restrictive for your workload. If you select this option, you must manually configure the sharding strategy, more
|
|
364
|
+
* Flag that indicates if cluster uses Atlas-Managed Sharding (false, default) or Self-Managed Sharding (true). It can only be enabled for Global Clusters (`GEOSHARDED`). It cannot be changed once the cluster is created. Use this mode if you're an advanced user and the default configuration is too restrictive for your workload. If you select this option, you must manually configure the sharding strategy, more information [here](https://www.mongodb.com/docs/atlas/tutorial/create-global-cluster/#select-your-sharding-configuration).
|
|
745
365
|
*/
|
|
746
366
|
globalClusterSelfManagedSharding?: pulumi.Input<boolean>;
|
|
747
367
|
/**
|
|
@@ -766,11 +386,11 @@ export interface AdvancedClusterArgs {
|
|
|
766
386
|
*/
|
|
767
387
|
pitEnabled?: pulumi.Input<boolean>;
|
|
768
388
|
/**
|
|
769
|
-
* Unique ID for the project to create the
|
|
389
|
+
* Unique ID for the project to create the cluster.
|
|
770
390
|
*/
|
|
771
391
|
projectId: pulumi.Input<string>;
|
|
772
392
|
/**
|
|
773
|
-
* Flag that enables or disables log redaction, see the [manual](https://www.mongodb.com/docs/manual/administration/monitoring/#log-redaction) for more
|
|
393
|
+
* Flag that enables or disables log redaction, see the [manual](https://www.mongodb.com/docs/manual/administration/monitoring/#log-redaction) for more information. Use this in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements. **Note**: Changing this setting on a cluster will trigger a rolling restart as soon as the cluster is updated.
|
|
774
394
|
*/
|
|
775
395
|
redactClientLogData?: pulumi.Input<boolean>;
|
|
776
396
|
/**
|
|
@@ -778,7 +398,7 @@ export interface AdvancedClusterArgs {
|
|
|
778
398
|
*/
|
|
779
399
|
replicaSetScalingStrategy?: pulumi.Input<string>;
|
|
780
400
|
/**
|
|
781
|
-
* List of settings that configure your cluster regions. This attribute has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. If for each
|
|
401
|
+
* List of settings that configure your cluster regions. This attribute has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. If for each `replicationSpecs` a `numShards` is configured with a value greater than 1 (using deprecated sharding configurations), then each object represents a zone with one or more shards. The `replicationSpecs` configuration for all shards within the same zone must be the same, with the exception of `instanceSize` and `diskIops` that can scale independently. Note that independent `diskIops` values are only supported for AWS provisioned IOPS, or Azure regions that support Extended IOPS. See below.
|
|
782
402
|
*/
|
|
783
403
|
replicationSpecs: pulumi.Input<pulumi.Input<inputs.AdvancedClusterReplicationSpec>[]>;
|
|
784
404
|
/**
|