@pulumi/mongodbatlas 3.15.0-alpha.1714110856 → 3.15.0-alpha.1714507216
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 +6 -6
- package/alertConfiguration.d.ts +21 -0
- package/alertConfiguration.js +21 -0
- package/alertConfiguration.js.map +1 -1
- package/backupCompliancePolicy.d.ts +13 -0
- package/backupCompliancePolicy.js +12 -0
- package/backupCompliancePolicy.js.map +1 -1
- package/cloudBackupSchedule.d.ts +18 -9
- package/cloudBackupSchedule.js +2 -0
- package/cloudBackupSchedule.js.map +1 -1
- package/cluster.d.ts +9 -9
- package/cluster.js +3 -3
- package/federatedDatabaseInstance.d.ts +33 -6
- package/federatedDatabaseInstance.js.map +1 -1
- package/federatedSettingsIdentityProvider.d.ts +1 -3
- package/federatedSettingsIdentityProvider.js +1 -3
- package/federatedSettingsIdentityProvider.js.map +1 -1
- package/getAdvancedCluster.d.ts +1 -1
- package/getBackupCompliancePolicy.d.ts +21 -0
- package/getBackupCompliancePolicy.js +20 -0
- package/getBackupCompliancePolicy.js.map +1 -1
- package/getCloudBackupSchedule.d.ts +6 -0
- package/getCloudBackupSchedule.js.map +1 -1
- package/getCluster.d.ts +1 -1
- package/getDatabaseUser.d.ts +0 -4
- package/getDatabaseUser.js.map +1 -1
- package/getFederatedSettingsIdentityProvider.d.ts +8 -2
- package/getFederatedSettingsIdentityProvider.js +2 -2
- package/getFederatedSettingsIdentityProvider.js.map +1 -1
- package/getFederatedSettingsIdentityProviders.d.ts +20 -6
- package/getFederatedSettingsIdentityProviders.js +2 -2
- package/getFederatedSettingsIdentityProviders.js.map +1 -1
- package/getOrganizations.d.ts +0 -12
- package/getOrganizations.js +0 -1
- package/getOrganizations.js.map +1 -1
- package/getPrivatelinkEndpointsServiceServerless.d.ts +6 -6
- package/getProject.d.ts +6 -0
- package/getProject.js.map +1 -1
- package/getPushBasedLogExport.d.ts +115 -0
- package/getPushBasedLogExport.js +95 -0
- package/getPushBasedLogExport.js.map +1 -0
- package/getServerlessInstance.d.ts +12 -0
- package/getServerlessInstance.js +1 -0
- package/getServerlessInstance.js.map +1 -1
- package/getStreamConnection.d.ts +109 -0
- package/getStreamConnection.js +53 -0
- package/getStreamConnection.js.map +1 -0
- package/getStreamConnections.d.ts +100 -0
- package/getStreamConnections.js +52 -0
- package/getStreamConnections.js.map +1 -0
- package/getStreamInstance.d.ts +80 -0
- package/getStreamInstance.js +50 -0
- package/getStreamInstance.js.map +1 -0
- package/getStreamInstances.d.ts +86 -0
- package/getStreamInstances.js +49 -0
- package/getStreamInstances.js.map +1 -0
- package/getThirdPartyIntegration.d.ts +12 -7
- package/getThirdPartyIntegration.js +2 -0
- package/getThirdPartyIntegration.js.map +1 -1
- package/getThirdPartyIntegrations.d.ts +1 -1
- package/globalClusterConfig.d.ts +1 -1
- package/globalClusterConfig.js +1 -1
- package/index.d.ts +24 -0
- package/index.js +32 -2
- package/index.js.map +1 -1
- package/networkPeering.d.ts +3 -3
- package/networkPeering.js +3 -3
- package/onlineArchive.d.ts +26 -0
- package/onlineArchive.js +26 -0
- package/onlineArchive.js.map +1 -1
- package/package.json +1 -1
- package/project.d.ts +18 -0
- package/project.js +2 -0
- package/project.js.map +1 -1
- package/projectApiKey.d.ts +0 -24
- package/projectApiKey.js +0 -2
- package/projectApiKey.js.map +1 -1
- package/pushBasedLogExport.d.ts +142 -0
- package/pushBasedLogExport.js +107 -0
- package/pushBasedLogExport.js.map +1 -0
- package/serverlessInstance.d.ts +12 -0
- package/serverlessInstance.js +2 -0
- package/serverlessInstance.js.map +1 -1
- package/streamConnection.d.ts +168 -0
- package/streamConnection.js +137 -0
- package/streamConnection.js.map +1 -0
- package/streamInstance.d.ts +107 -0
- package/streamInstance.js +79 -0
- package/streamInstance.js.map +1 -0
- package/thirdPartyIntegration.d.ts +9 -0
- package/thirdPartyIntegration.js.map +1 -1
- package/types/input.d.ts +135 -36
- package/types/output.d.ts +418 -87
package/types/output.d.ts
CHANGED
|
@@ -266,6 +266,7 @@ export interface AlertConfigurationNotification {
|
|
|
266
266
|
delayMin: number;
|
|
267
267
|
emailAddress?: string;
|
|
268
268
|
emailEnabled: boolean;
|
|
269
|
+
integrationId?: string;
|
|
269
270
|
intervalMin: number;
|
|
270
271
|
microsoftTeamsWebhookUrl?: string;
|
|
271
272
|
mobileNumber?: string;
|
|
@@ -291,11 +292,11 @@ export interface AlertConfigurationThresholdConfig {
|
|
|
291
292
|
}
|
|
292
293
|
export interface BackupCompliancePolicyOnDemandPolicyItem {
|
|
293
294
|
/**
|
|
294
|
-
* Desired frequency of the new backup policy item specified by `frequencyType` (
|
|
295
|
+
* Desired frequency of the new backup policy item specified by `frequencyType` (yearly in this case). The supported values for yearly policies are
|
|
295
296
|
*/
|
|
296
297
|
frequencyInterval: number;
|
|
297
298
|
/**
|
|
298
|
-
* Frequency associated with the backup policy item. For
|
|
299
|
+
* Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as `yearly`. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
|
|
299
300
|
*/
|
|
300
301
|
frequencyType: string;
|
|
301
302
|
/**
|
|
@@ -303,21 +304,21 @@ export interface BackupCompliancePolicyOnDemandPolicyItem {
|
|
|
303
304
|
*/
|
|
304
305
|
id: string;
|
|
305
306
|
/**
|
|
306
|
-
* Scope of the backup policy item: `days`, `weeks`, or `
|
|
307
|
+
* Scope of the backup policy item: `days`, `weeks`, `months`, or `years`.
|
|
307
308
|
*/
|
|
308
309
|
retentionUnit: string;
|
|
309
310
|
/**
|
|
310
|
-
* Value to associate with `retentionUnit`.
|
|
311
|
+
* Value to associate with `retentionUnit`. Yearly policy must have retention of at least 1 year.
|
|
311
312
|
*/
|
|
312
313
|
retentionValue: number;
|
|
313
314
|
}
|
|
314
315
|
export interface BackupCompliancePolicyPolicyItemDaily {
|
|
315
316
|
/**
|
|
316
|
-
* Desired frequency of the new backup policy item specified by `frequencyType` (
|
|
317
|
+
* Desired frequency of the new backup policy item specified by `frequencyType` (yearly in this case). The supported values for yearly policies are
|
|
317
318
|
*/
|
|
318
319
|
frequencyInterval: number;
|
|
319
320
|
/**
|
|
320
|
-
* Frequency associated with the backup policy item. For
|
|
321
|
+
* Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as `yearly`. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
|
|
321
322
|
*/
|
|
322
323
|
frequencyType: string;
|
|
323
324
|
/**
|
|
@@ -325,21 +326,21 @@ export interface BackupCompliancePolicyPolicyItemDaily {
|
|
|
325
326
|
*/
|
|
326
327
|
id: string;
|
|
327
328
|
/**
|
|
328
|
-
* Scope of the backup policy item: `days`, `weeks`, or `
|
|
329
|
+
* Scope of the backup policy item: `days`, `weeks`, `months`, or `years`.
|
|
329
330
|
*/
|
|
330
331
|
retentionUnit: string;
|
|
331
332
|
/**
|
|
332
|
-
* Value to associate with `retentionUnit`.
|
|
333
|
+
* Value to associate with `retentionUnit`. Yearly policy must have retention of at least 1 year.
|
|
333
334
|
*/
|
|
334
335
|
retentionValue: number;
|
|
335
336
|
}
|
|
336
337
|
export interface BackupCompliancePolicyPolicyItemHourly {
|
|
337
338
|
/**
|
|
338
|
-
* Desired frequency of the new backup policy item specified by `frequencyType` (
|
|
339
|
+
* Desired frequency of the new backup policy item specified by `frequencyType` (yearly in this case). The supported values for yearly policies are
|
|
339
340
|
*/
|
|
340
341
|
frequencyInterval: number;
|
|
341
342
|
/**
|
|
342
|
-
* Frequency associated with the backup policy item. For
|
|
343
|
+
* Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as `yearly`. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
|
|
343
344
|
*/
|
|
344
345
|
frequencyType: string;
|
|
345
346
|
/**
|
|
@@ -347,21 +348,21 @@ export interface BackupCompliancePolicyPolicyItemHourly {
|
|
|
347
348
|
*/
|
|
348
349
|
id: string;
|
|
349
350
|
/**
|
|
350
|
-
* Scope of the backup policy item: `days`, `weeks`, or `
|
|
351
|
+
* Scope of the backup policy item: `days`, `weeks`, `months`, or `years`.
|
|
351
352
|
*/
|
|
352
353
|
retentionUnit: string;
|
|
353
354
|
/**
|
|
354
|
-
* Value to associate with `retentionUnit`.
|
|
355
|
+
* Value to associate with `retentionUnit`. Yearly policy must have retention of at least 1 year.
|
|
355
356
|
*/
|
|
356
357
|
retentionValue: number;
|
|
357
358
|
}
|
|
358
359
|
export interface BackupCompliancePolicyPolicyItemMonthly {
|
|
359
360
|
/**
|
|
360
|
-
* Desired frequency of the new backup policy item specified by `frequencyType` (
|
|
361
|
+
* Desired frequency of the new backup policy item specified by `frequencyType` (yearly in this case). The supported values for yearly policies are
|
|
361
362
|
*/
|
|
362
363
|
frequencyInterval: number;
|
|
363
364
|
/**
|
|
364
|
-
* Frequency associated with the backup policy item. For
|
|
365
|
+
* Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as `yearly`. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
|
|
365
366
|
*/
|
|
366
367
|
frequencyType: string;
|
|
367
368
|
/**
|
|
@@ -369,21 +370,21 @@ export interface BackupCompliancePolicyPolicyItemMonthly {
|
|
|
369
370
|
*/
|
|
370
371
|
id: string;
|
|
371
372
|
/**
|
|
372
|
-
* Scope of the backup policy item: `days`, `weeks`, or `
|
|
373
|
+
* Scope of the backup policy item: `days`, `weeks`, `months`, or `years`.
|
|
373
374
|
*/
|
|
374
375
|
retentionUnit: string;
|
|
375
376
|
/**
|
|
376
|
-
* Value to associate with `retentionUnit`.
|
|
377
|
+
* Value to associate with `retentionUnit`. Yearly policy must have retention of at least 1 year.
|
|
377
378
|
*/
|
|
378
379
|
retentionValue: number;
|
|
379
380
|
}
|
|
380
381
|
export interface BackupCompliancePolicyPolicyItemWeekly {
|
|
381
382
|
/**
|
|
382
|
-
* Desired frequency of the new backup policy item specified by `frequencyType` (
|
|
383
|
+
* Desired frequency of the new backup policy item specified by `frequencyType` (yearly in this case). The supported values for yearly policies are
|
|
383
384
|
*/
|
|
384
385
|
frequencyInterval: number;
|
|
385
386
|
/**
|
|
386
|
-
* Frequency associated with the backup policy item. For
|
|
387
|
+
* Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as `yearly`. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
|
|
387
388
|
*/
|
|
388
389
|
frequencyType: string;
|
|
389
390
|
/**
|
|
@@ -391,11 +392,33 @@ export interface BackupCompliancePolicyPolicyItemWeekly {
|
|
|
391
392
|
*/
|
|
392
393
|
id: string;
|
|
393
394
|
/**
|
|
394
|
-
* Scope of the backup policy item: `days`, `weeks`, or `
|
|
395
|
+
* Scope of the backup policy item: `days`, `weeks`, `months`, or `years`.
|
|
395
396
|
*/
|
|
396
397
|
retentionUnit: string;
|
|
397
398
|
/**
|
|
398
|
-
* Value to associate with `retentionUnit`.
|
|
399
|
+
* Value to associate with `retentionUnit`. Yearly policy must have retention of at least 1 year.
|
|
400
|
+
*/
|
|
401
|
+
retentionValue: number;
|
|
402
|
+
}
|
|
403
|
+
export interface BackupCompliancePolicyPolicyItemYearly {
|
|
404
|
+
/**
|
|
405
|
+
* Desired frequency of the new backup policy item specified by `frequencyType` (yearly in this case). The supported values for yearly policies are
|
|
406
|
+
*/
|
|
407
|
+
frequencyInterval: number;
|
|
408
|
+
/**
|
|
409
|
+
* Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as `yearly`. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
|
|
410
|
+
*/
|
|
411
|
+
frequencyType: string;
|
|
412
|
+
/**
|
|
413
|
+
* Unique identifier of the backup policy item.
|
|
414
|
+
*/
|
|
415
|
+
id: string;
|
|
416
|
+
/**
|
|
417
|
+
* Scope of the backup policy item: `days`, `weeks`, `months`, or `years`.
|
|
418
|
+
*/
|
|
419
|
+
retentionUnit: string;
|
|
420
|
+
/**
|
|
421
|
+
* Value to associate with `retentionUnit`. Yearly policy must have retention of at least 1 year.
|
|
399
422
|
*/
|
|
400
423
|
retentionValue: number;
|
|
401
424
|
}
|
|
@@ -430,7 +453,7 @@ export interface CloudBackupSchedulePolicyItemDaily {
|
|
|
430
453
|
*/
|
|
431
454
|
id: string;
|
|
432
455
|
/**
|
|
433
|
-
* Scope of the backup policy item: `days`, `weeks`, or `
|
|
456
|
+
* Scope of the backup policy item: `days`, `weeks`, `months`, or `years`.
|
|
434
457
|
*/
|
|
435
458
|
retentionUnit: string;
|
|
436
459
|
/**
|
|
@@ -452,7 +475,7 @@ export interface CloudBackupSchedulePolicyItemHourly {
|
|
|
452
475
|
*/
|
|
453
476
|
id: string;
|
|
454
477
|
/**
|
|
455
|
-
* Scope of the backup policy item: `days`, `weeks`, or `
|
|
478
|
+
* Scope of the backup policy item: `days`, `weeks`, `months`, or `years`.
|
|
456
479
|
*/
|
|
457
480
|
retentionUnit: string;
|
|
458
481
|
/**
|
|
@@ -474,7 +497,7 @@ export interface CloudBackupSchedulePolicyItemMonthly {
|
|
|
474
497
|
*/
|
|
475
498
|
id: string;
|
|
476
499
|
/**
|
|
477
|
-
* Scope of the backup policy item: `days`, `weeks`, or `
|
|
500
|
+
* Scope of the backup policy item: `days`, `weeks`, `months`, or `years`.
|
|
478
501
|
*/
|
|
479
502
|
retentionUnit: string;
|
|
480
503
|
/**
|
|
@@ -496,7 +519,7 @@ export interface CloudBackupSchedulePolicyItemWeekly {
|
|
|
496
519
|
*/
|
|
497
520
|
id: string;
|
|
498
521
|
/**
|
|
499
|
-
* Scope of the backup policy item: `days`, `weeks`, or `
|
|
522
|
+
* Scope of the backup policy item: `days`, `weeks`, `months`, or `years`.
|
|
500
523
|
*/
|
|
501
524
|
retentionUnit: string;
|
|
502
525
|
/**
|
|
@@ -504,6 +527,28 @@ export interface CloudBackupSchedulePolicyItemWeekly {
|
|
|
504
527
|
*/
|
|
505
528
|
retentionValue: number;
|
|
506
529
|
}
|
|
530
|
+
export interface CloudBackupSchedulePolicyItemYearly {
|
|
531
|
+
/**
|
|
532
|
+
* Desired frequency of the new backup policy item specified by `frequencyType` (yearly in this case). The supported values for yearly policies are
|
|
533
|
+
*/
|
|
534
|
+
frequencyInterval: number;
|
|
535
|
+
/**
|
|
536
|
+
* Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as `yearly`. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
|
|
537
|
+
*/
|
|
538
|
+
frequencyType: string;
|
|
539
|
+
/**
|
|
540
|
+
* Unique identifier of the backup policy item.
|
|
541
|
+
*/
|
|
542
|
+
id: string;
|
|
543
|
+
/**
|
|
544
|
+
* Scope of the backup policy item: `days`, `weeks`, `months`, or `years`.
|
|
545
|
+
*/
|
|
546
|
+
retentionUnit: string;
|
|
547
|
+
/**
|
|
548
|
+
* Value to associate with `retentionUnit`. Yearly policy must have retention of at least 1 year.
|
|
549
|
+
*/
|
|
550
|
+
retentionValue: number;
|
|
551
|
+
}
|
|
507
552
|
export interface CloudBackupSnapshotExportJobComponent {
|
|
508
553
|
/**
|
|
509
554
|
* _Returned for sharded clusters only._ Export job details for each replica set in the sharded cluster.
|
|
@@ -962,6 +1007,9 @@ export interface EventTriggerEventProcessorsAwsEventbridge {
|
|
|
962
1007
|
configRegion?: string;
|
|
963
1008
|
}
|
|
964
1009
|
export interface FederatedDatabaseInstanceCloudProviderConfig {
|
|
1010
|
+
/**
|
|
1011
|
+
* Name of the cloud service that hosts the data lake's data stores.
|
|
1012
|
+
*/
|
|
965
1013
|
aws: outputs.FederatedDatabaseInstanceCloudProviderConfigAws;
|
|
966
1014
|
}
|
|
967
1015
|
export interface FederatedDatabaseInstanceCloudProviderConfigAws {
|
|
@@ -995,8 +1043,6 @@ export interface FederatedDatabaseInstanceStorageDatabase {
|
|
|
995
1043
|
maxWildcardCollections: number;
|
|
996
1044
|
/**
|
|
997
1045
|
* Name of the Atlas Federated Database Instance.
|
|
998
|
-
* ### `cloudProviderConfig` - (Optional) Cloud provider linked to this data federated instance.
|
|
999
|
-
* #### `aws` - (Required) AWS provider of the cloud service where the Federated Database Instance can access the S3 Bucket. Note this parameter is only required if using `cloudProviderConfig` since AWS is currently the only supported Cloud vendor on this feature at this time.
|
|
1000
1046
|
*/
|
|
1001
1047
|
name: string;
|
|
1002
1048
|
views: outputs.FederatedDatabaseInstanceStorageDatabaseView[];
|
|
@@ -1005,8 +1051,6 @@ export interface FederatedDatabaseInstanceStorageDatabaseCollection {
|
|
|
1005
1051
|
dataSources?: outputs.FederatedDatabaseInstanceStorageDatabaseCollectionDataSource[];
|
|
1006
1052
|
/**
|
|
1007
1053
|
* Name of the Atlas Federated Database Instance.
|
|
1008
|
-
* ### `cloudProviderConfig` - (Optional) Cloud provider linked to this data federated instance.
|
|
1009
|
-
* #### `aws` - (Required) AWS provider of the cloud service where the Federated Database Instance can access the S3 Bucket. Note this parameter is only required if using `cloudProviderConfig` since AWS is currently the only supported Cloud vendor on this feature at this time.
|
|
1010
1054
|
*/
|
|
1011
1055
|
name: string;
|
|
1012
1056
|
}
|
|
@@ -1026,8 +1070,6 @@ export interface FederatedDatabaseInstanceStorageDatabaseCollectionDataSource {
|
|
|
1026
1070
|
export interface FederatedDatabaseInstanceStorageDatabaseView {
|
|
1027
1071
|
/**
|
|
1028
1072
|
* Name of the Atlas Federated Database Instance.
|
|
1029
|
-
* ### `cloudProviderConfig` - (Optional) Cloud provider linked to this data federated instance.
|
|
1030
|
-
* #### `aws` - (Required) AWS provider of the cloud service where the Federated Database Instance can access the S3 Bucket. Note this parameter is only required if using `cloudProviderConfig` since AWS is currently the only supported Cloud vendor on this feature at this time.
|
|
1031
1073
|
*/
|
|
1032
1074
|
name: string;
|
|
1033
1075
|
pipeline: string;
|
|
@@ -1038,7 +1080,7 @@ export interface FederatedDatabaseInstanceStorageStore {
|
|
|
1038
1080
|
allowInsecure: boolean;
|
|
1039
1081
|
bucket: string;
|
|
1040
1082
|
/**
|
|
1041
|
-
* @deprecated
|
|
1083
|
+
* @deprecated This parameter is deprecated and will be removed by September 2024.
|
|
1042
1084
|
*/
|
|
1043
1085
|
clusterId: string;
|
|
1044
1086
|
clusterName: string;
|
|
@@ -1047,8 +1089,6 @@ export interface FederatedDatabaseInstanceStorageStore {
|
|
|
1047
1089
|
includeTags: boolean;
|
|
1048
1090
|
/**
|
|
1049
1091
|
* Name of the Atlas Federated Database Instance.
|
|
1050
|
-
* ### `cloudProviderConfig` - (Optional) Cloud provider linked to this data federated instance.
|
|
1051
|
-
* #### `aws` - (Required) AWS provider of the cloud service where the Federated Database Instance can access the S3 Bucket. Note this parameter is only required if using `cloudProviderConfig` since AWS is currently the only supported Cloud vendor on this feature at this time.
|
|
1052
1092
|
*/
|
|
1053
1093
|
name: string;
|
|
1054
1094
|
prefix: string;
|
|
@@ -1073,8 +1113,6 @@ export interface FederatedDatabaseInstanceStorageStoreReadPreferenceTagSet {
|
|
|
1073
1113
|
export interface FederatedDatabaseInstanceStorageStoreReadPreferenceTagSetTag {
|
|
1074
1114
|
/**
|
|
1075
1115
|
* Name of the Atlas Federated Database Instance.
|
|
1076
|
-
* ### `cloudProviderConfig` - (Optional) Cloud provider linked to this data federated instance.
|
|
1077
|
-
* #### `aws` - (Required) AWS provider of the cloud service where the Federated Database Instance can access the S3 Bucket. Note this parameter is only required if using `cloudProviderConfig` since AWS is currently the only supported Cloud vendor on this feature at this time.
|
|
1078
1116
|
*/
|
|
1079
1117
|
name: string;
|
|
1080
1118
|
value: string;
|
|
@@ -1419,7 +1457,7 @@ export interface GetAdvancedClustersResult {
|
|
|
1419
1457
|
/**
|
|
1420
1458
|
* Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
|
|
1421
1459
|
*
|
|
1422
|
-
* @deprecated
|
|
1460
|
+
* @deprecated This parameter is deprecated and will be removed by September 2024. Please transition to tags.
|
|
1423
1461
|
*/
|
|
1424
1462
|
labels: outputs.GetAdvancedClustersResultLabel[];
|
|
1425
1463
|
/**
|
|
@@ -1807,6 +1845,10 @@ export interface GetAlertConfigurationNotification {
|
|
|
1807
1845
|
* Flag indicating email notifications should be sent. Atlas returns this value if `typeName` is set to `ORG`, `GROUP`, or `USER`.
|
|
1808
1846
|
*/
|
|
1809
1847
|
emailEnabled: boolean;
|
|
1848
|
+
/**
|
|
1849
|
+
* The ID of the associated integration, the credentials of which to use for requests.
|
|
1850
|
+
*/
|
|
1851
|
+
integrationId: string;
|
|
1810
1852
|
/**
|
|
1811
1853
|
* Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. The minimum value is 5.
|
|
1812
1854
|
*/
|
|
@@ -1820,7 +1862,7 @@ export interface GetAlertConfigurationNotification {
|
|
|
1820
1862
|
*/
|
|
1821
1863
|
mobileNumber: string;
|
|
1822
1864
|
/**
|
|
1823
|
-
* The notifier
|
|
1865
|
+
* The notifier ID is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
|
|
1824
1866
|
*/
|
|
1825
1867
|
notifierId: string;
|
|
1826
1868
|
/**
|
|
@@ -2018,6 +2060,10 @@ export interface GetAlertConfigurationsResultNotification {
|
|
|
2018
2060
|
* Flag indicating email notifications should be sent. Atlas returns this value if `typeName` is set to `ORG`, `GROUP`, or `USER`.
|
|
2019
2061
|
*/
|
|
2020
2062
|
emailEnabled: boolean;
|
|
2063
|
+
/**
|
|
2064
|
+
* The ID of the associated integration, the credentials of which to use for requests.
|
|
2065
|
+
*/
|
|
2066
|
+
integrationId: string;
|
|
2021
2067
|
/**
|
|
2022
2068
|
* Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. The minimum value is 5.
|
|
2023
2069
|
*/
|
|
@@ -2031,7 +2077,7 @@ export interface GetAlertConfigurationsResultNotification {
|
|
|
2031
2077
|
*/
|
|
2032
2078
|
mobileNumber: string;
|
|
2033
2079
|
/**
|
|
2034
|
-
* The notifier
|
|
2080
|
+
* The notifier ID is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
|
|
2035
2081
|
*/
|
|
2036
2082
|
notifierId: string;
|
|
2037
2083
|
/**
|
|
@@ -2191,11 +2237,11 @@ export interface GetAtlasUsersResultRole {
|
|
|
2191
2237
|
}
|
|
2192
2238
|
export interface GetBackupCompliancePolicyOnDemandPolicyItem {
|
|
2193
2239
|
/**
|
|
2194
|
-
* Desired frequency of the new backup policy item specified by `frequencyType` (
|
|
2240
|
+
* Desired frequency of the new backup policy item specified by `frequencyType` (yearly in this case). The supported values for yearly policies are
|
|
2195
2241
|
*/
|
|
2196
2242
|
frequencyInterval: number;
|
|
2197
2243
|
/**
|
|
2198
|
-
* Frequency associated with the backup policy item. For
|
|
2244
|
+
* Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as `yearly`. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
|
|
2199
2245
|
*/
|
|
2200
2246
|
frequencyType: string;
|
|
2201
2247
|
/**
|
|
@@ -2203,21 +2249,21 @@ export interface GetBackupCompliancePolicyOnDemandPolicyItem {
|
|
|
2203
2249
|
*/
|
|
2204
2250
|
id: string;
|
|
2205
2251
|
/**
|
|
2206
|
-
* Scope of the backup policy item: `days`, `weeks`, or `
|
|
2252
|
+
* Scope of the backup policy item: `days`, `weeks`, `months`, or `years`.
|
|
2207
2253
|
*/
|
|
2208
2254
|
retentionUnit: string;
|
|
2209
2255
|
/**
|
|
2210
|
-
* Value to associate with `retentionUnit`.
|
|
2256
|
+
* Value to associate with `retentionUnit`. Yearly policy must have retention of at least 1 year.
|
|
2211
2257
|
*/
|
|
2212
2258
|
retentionValue: number;
|
|
2213
2259
|
}
|
|
2214
2260
|
export interface GetBackupCompliancePolicyPolicyItemDaily {
|
|
2215
2261
|
/**
|
|
2216
|
-
* Desired frequency of the new backup policy item specified by `frequencyType` (
|
|
2262
|
+
* Desired frequency of the new backup policy item specified by `frequencyType` (yearly in this case). The supported values for yearly policies are
|
|
2217
2263
|
*/
|
|
2218
2264
|
frequencyInterval: number;
|
|
2219
2265
|
/**
|
|
2220
|
-
* Frequency associated with the backup policy item. For
|
|
2266
|
+
* Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as `yearly`. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
|
|
2221
2267
|
*/
|
|
2222
2268
|
frequencyType: string;
|
|
2223
2269
|
/**
|
|
@@ -2225,21 +2271,21 @@ export interface GetBackupCompliancePolicyPolicyItemDaily {
|
|
|
2225
2271
|
*/
|
|
2226
2272
|
id: string;
|
|
2227
2273
|
/**
|
|
2228
|
-
* Scope of the backup policy item: `days`, `weeks`, or `
|
|
2274
|
+
* Scope of the backup policy item: `days`, `weeks`, `months`, or `years`.
|
|
2229
2275
|
*/
|
|
2230
2276
|
retentionUnit: string;
|
|
2231
2277
|
/**
|
|
2232
|
-
* Value to associate with `retentionUnit`.
|
|
2278
|
+
* Value to associate with `retentionUnit`. Yearly policy must have retention of at least 1 year.
|
|
2233
2279
|
*/
|
|
2234
2280
|
retentionValue: number;
|
|
2235
2281
|
}
|
|
2236
2282
|
export interface GetBackupCompliancePolicyPolicyItemHourly {
|
|
2237
2283
|
/**
|
|
2238
|
-
* Desired frequency of the new backup policy item specified by `frequencyType` (
|
|
2284
|
+
* Desired frequency of the new backup policy item specified by `frequencyType` (yearly in this case). The supported values for yearly policies are
|
|
2239
2285
|
*/
|
|
2240
2286
|
frequencyInterval: number;
|
|
2241
2287
|
/**
|
|
2242
|
-
* Frequency associated with the backup policy item. For
|
|
2288
|
+
* Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as `yearly`. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
|
|
2243
2289
|
*/
|
|
2244
2290
|
frequencyType: string;
|
|
2245
2291
|
/**
|
|
@@ -2247,21 +2293,21 @@ export interface GetBackupCompliancePolicyPolicyItemHourly {
|
|
|
2247
2293
|
*/
|
|
2248
2294
|
id: string;
|
|
2249
2295
|
/**
|
|
2250
|
-
* Scope of the backup policy item: `days`, `weeks`, or `
|
|
2296
|
+
* Scope of the backup policy item: `days`, `weeks`, `months`, or `years`.
|
|
2251
2297
|
*/
|
|
2252
2298
|
retentionUnit: string;
|
|
2253
2299
|
/**
|
|
2254
|
-
* Value to associate with `retentionUnit`.
|
|
2300
|
+
* Value to associate with `retentionUnit`. Yearly policy must have retention of at least 1 year.
|
|
2255
2301
|
*/
|
|
2256
2302
|
retentionValue: number;
|
|
2257
2303
|
}
|
|
2258
2304
|
export interface GetBackupCompliancePolicyPolicyItemMonthly {
|
|
2259
2305
|
/**
|
|
2260
|
-
* Desired frequency of the new backup policy item specified by `frequencyType` (
|
|
2306
|
+
* Desired frequency of the new backup policy item specified by `frequencyType` (yearly in this case). The supported values for yearly policies are
|
|
2261
2307
|
*/
|
|
2262
2308
|
frequencyInterval: number;
|
|
2263
2309
|
/**
|
|
2264
|
-
* Frequency associated with the backup policy item. For
|
|
2310
|
+
* Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as `yearly`. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
|
|
2265
2311
|
*/
|
|
2266
2312
|
frequencyType: string;
|
|
2267
2313
|
/**
|
|
@@ -2269,21 +2315,21 @@ export interface GetBackupCompliancePolicyPolicyItemMonthly {
|
|
|
2269
2315
|
*/
|
|
2270
2316
|
id: string;
|
|
2271
2317
|
/**
|
|
2272
|
-
* Scope of the backup policy item: `days`, `weeks`, or `
|
|
2318
|
+
* Scope of the backup policy item: `days`, `weeks`, `months`, or `years`.
|
|
2273
2319
|
*/
|
|
2274
2320
|
retentionUnit: string;
|
|
2275
2321
|
/**
|
|
2276
|
-
* Value to associate with `retentionUnit`.
|
|
2322
|
+
* Value to associate with `retentionUnit`. Yearly policy must have retention of at least 1 year.
|
|
2277
2323
|
*/
|
|
2278
2324
|
retentionValue: number;
|
|
2279
2325
|
}
|
|
2280
2326
|
export interface GetBackupCompliancePolicyPolicyItemWeekly {
|
|
2281
2327
|
/**
|
|
2282
|
-
* Desired frequency of the new backup policy item specified by `frequencyType` (
|
|
2328
|
+
* Desired frequency of the new backup policy item specified by `frequencyType` (yearly in this case). The supported values for yearly policies are
|
|
2283
2329
|
*/
|
|
2284
2330
|
frequencyInterval: number;
|
|
2285
2331
|
/**
|
|
2286
|
-
* Frequency associated with the backup policy item. For
|
|
2332
|
+
* Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as `yearly`. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
|
|
2287
2333
|
*/
|
|
2288
2334
|
frequencyType: string;
|
|
2289
2335
|
/**
|
|
@@ -2291,11 +2337,33 @@ export interface GetBackupCompliancePolicyPolicyItemWeekly {
|
|
|
2291
2337
|
*/
|
|
2292
2338
|
id: string;
|
|
2293
2339
|
/**
|
|
2294
|
-
* Scope of the backup policy item: `days`, `weeks`, or `
|
|
2340
|
+
* Scope of the backup policy item: `days`, `weeks`, `months`, or `years`.
|
|
2295
2341
|
*/
|
|
2296
2342
|
retentionUnit: string;
|
|
2297
2343
|
/**
|
|
2298
|
-
* Value to associate with `retentionUnit`.
|
|
2344
|
+
* Value to associate with `retentionUnit`. Yearly policy must have retention of at least 1 year.
|
|
2345
|
+
*/
|
|
2346
|
+
retentionValue: number;
|
|
2347
|
+
}
|
|
2348
|
+
export interface GetBackupCompliancePolicyPolicyItemYearly {
|
|
2349
|
+
/**
|
|
2350
|
+
* Desired frequency of the new backup policy item specified by `frequencyType` (yearly in this case). The supported values for yearly policies are
|
|
2351
|
+
*/
|
|
2352
|
+
frequencyInterval: number;
|
|
2353
|
+
/**
|
|
2354
|
+
* Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as `yearly`. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
|
|
2355
|
+
*/
|
|
2356
|
+
frequencyType: string;
|
|
2357
|
+
/**
|
|
2358
|
+
* Unique identifier of the backup policy item.
|
|
2359
|
+
*/
|
|
2360
|
+
id: string;
|
|
2361
|
+
/**
|
|
2362
|
+
* Scope of the backup policy item: `days`, `weeks`, `months`, or `years`.
|
|
2363
|
+
*/
|
|
2364
|
+
retentionUnit: string;
|
|
2365
|
+
/**
|
|
2366
|
+
* Value to associate with `retentionUnit`. Yearly policy must have retention of at least 1 year.
|
|
2299
2367
|
*/
|
|
2300
2368
|
retentionValue: number;
|
|
2301
2369
|
}
|
|
@@ -2305,7 +2373,7 @@ export interface GetCloudBackupScheduleCopySetting {
|
|
|
2305
2373
|
*/
|
|
2306
2374
|
cloudProvider: string;
|
|
2307
2375
|
/**
|
|
2308
|
-
* List that describes which types of snapshots to copy. i.e. "HOURLY" "DAILY" "WEEKLY" "MONTHLY" "ON_DEMAND"
|
|
2376
|
+
* List that describes which types of snapshots to copy. i.e. "HOURLY" "DAILY" "WEEKLY" "MONTHLY" "YEARLY" "ON_DEMAND"
|
|
2309
2377
|
*/
|
|
2310
2378
|
frequencies: string[];
|
|
2311
2379
|
/**
|
|
@@ -2327,17 +2395,17 @@ export interface GetCloudBackupScheduleExport {
|
|
|
2327
2395
|
*/
|
|
2328
2396
|
exportBucketId: string;
|
|
2329
2397
|
/**
|
|
2330
|
-
* Frequency associated with the backup policy item. For
|
|
2398
|
+
* Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as `yearly`. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
|
|
2331
2399
|
*/
|
|
2332
2400
|
frequencyType: string;
|
|
2333
2401
|
}
|
|
2334
2402
|
export interface GetCloudBackupSchedulePolicyItemDaily {
|
|
2335
2403
|
/**
|
|
2336
|
-
* Desired frequency of the new backup policy item specified by `frequencyType` (
|
|
2404
|
+
* Desired frequency of the new backup policy item specified by `frequencyType` (yearly in this case). The supported values for yearly policies are
|
|
2337
2405
|
*/
|
|
2338
2406
|
frequencyInterval: number;
|
|
2339
2407
|
/**
|
|
2340
|
-
* Frequency associated with the backup policy item. For
|
|
2408
|
+
* Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as `yearly`. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
|
|
2341
2409
|
*/
|
|
2342
2410
|
frequencyType: string;
|
|
2343
2411
|
/**
|
|
@@ -2345,21 +2413,21 @@ export interface GetCloudBackupSchedulePolicyItemDaily {
|
|
|
2345
2413
|
*/
|
|
2346
2414
|
id: string;
|
|
2347
2415
|
/**
|
|
2348
|
-
* Scope of the backup policy item: `days`, `weeks`, or `
|
|
2416
|
+
* Scope of the backup policy item: `days`, `weeks`, `months`, or `years`.
|
|
2349
2417
|
*/
|
|
2350
2418
|
retentionUnit: string;
|
|
2351
2419
|
/**
|
|
2352
|
-
* Value to associate with `retentionUnit`.
|
|
2420
|
+
* Value to associate with `retentionUnit`. Yearly policy must have retention of at least 1 year.
|
|
2353
2421
|
*/
|
|
2354
2422
|
retentionValue: number;
|
|
2355
2423
|
}
|
|
2356
2424
|
export interface GetCloudBackupSchedulePolicyItemHourly {
|
|
2357
2425
|
/**
|
|
2358
|
-
* Desired frequency of the new backup policy item specified by `frequencyType` (
|
|
2426
|
+
* Desired frequency of the new backup policy item specified by `frequencyType` (yearly in this case). The supported values for yearly policies are
|
|
2359
2427
|
*/
|
|
2360
2428
|
frequencyInterval: number;
|
|
2361
2429
|
/**
|
|
2362
|
-
* Frequency associated with the backup policy item. For
|
|
2430
|
+
* Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as `yearly`. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
|
|
2363
2431
|
*/
|
|
2364
2432
|
frequencyType: string;
|
|
2365
2433
|
/**
|
|
@@ -2367,21 +2435,21 @@ export interface GetCloudBackupSchedulePolicyItemHourly {
|
|
|
2367
2435
|
*/
|
|
2368
2436
|
id: string;
|
|
2369
2437
|
/**
|
|
2370
|
-
* Scope of the backup policy item: `days`, `weeks`, or `
|
|
2438
|
+
* Scope of the backup policy item: `days`, `weeks`, `months`, or `years`.
|
|
2371
2439
|
*/
|
|
2372
2440
|
retentionUnit: string;
|
|
2373
2441
|
/**
|
|
2374
|
-
* Value to associate with `retentionUnit`.
|
|
2442
|
+
* Value to associate with `retentionUnit`. Yearly policy must have retention of at least 1 year.
|
|
2375
2443
|
*/
|
|
2376
2444
|
retentionValue: number;
|
|
2377
2445
|
}
|
|
2378
2446
|
export interface GetCloudBackupSchedulePolicyItemMonthly {
|
|
2379
2447
|
/**
|
|
2380
|
-
* Desired frequency of the new backup policy item specified by `frequencyType` (
|
|
2448
|
+
* Desired frequency of the new backup policy item specified by `frequencyType` (yearly in this case). The supported values for yearly policies are
|
|
2381
2449
|
*/
|
|
2382
2450
|
frequencyInterval: number;
|
|
2383
2451
|
/**
|
|
2384
|
-
* Frequency associated with the backup policy item. For
|
|
2452
|
+
* Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as `yearly`. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
|
|
2385
2453
|
*/
|
|
2386
2454
|
frequencyType: string;
|
|
2387
2455
|
/**
|
|
@@ -2389,21 +2457,21 @@ export interface GetCloudBackupSchedulePolicyItemMonthly {
|
|
|
2389
2457
|
*/
|
|
2390
2458
|
id: string;
|
|
2391
2459
|
/**
|
|
2392
|
-
* Scope of the backup policy item: `days`, `weeks`, or `
|
|
2460
|
+
* Scope of the backup policy item: `days`, `weeks`, `months`, or `years`.
|
|
2393
2461
|
*/
|
|
2394
2462
|
retentionUnit: string;
|
|
2395
2463
|
/**
|
|
2396
|
-
* Value to associate with `retentionUnit`.
|
|
2464
|
+
* Value to associate with `retentionUnit`. Yearly policy must have retention of at least 1 year.
|
|
2397
2465
|
*/
|
|
2398
2466
|
retentionValue: number;
|
|
2399
2467
|
}
|
|
2400
2468
|
export interface GetCloudBackupSchedulePolicyItemWeekly {
|
|
2401
2469
|
/**
|
|
2402
|
-
* Desired frequency of the new backup policy item specified by `frequencyType` (
|
|
2470
|
+
* Desired frequency of the new backup policy item specified by `frequencyType` (yearly in this case). The supported values for yearly policies are
|
|
2403
2471
|
*/
|
|
2404
2472
|
frequencyInterval: number;
|
|
2405
2473
|
/**
|
|
2406
|
-
* Frequency associated with the backup policy item. For
|
|
2474
|
+
* Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as `yearly`. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
|
|
2407
2475
|
*/
|
|
2408
2476
|
frequencyType: string;
|
|
2409
2477
|
/**
|
|
@@ -2411,11 +2479,33 @@ export interface GetCloudBackupSchedulePolicyItemWeekly {
|
|
|
2411
2479
|
*/
|
|
2412
2480
|
id: string;
|
|
2413
2481
|
/**
|
|
2414
|
-
* Scope of the backup policy item: `days`, `weeks`, or `
|
|
2482
|
+
* Scope of the backup policy item: `days`, `weeks`, `months`, or `years`.
|
|
2415
2483
|
*/
|
|
2416
2484
|
retentionUnit: string;
|
|
2417
2485
|
/**
|
|
2418
|
-
* Value to associate with `retentionUnit`.
|
|
2486
|
+
* Value to associate with `retentionUnit`. Yearly policy must have retention of at least 1 year.
|
|
2487
|
+
*/
|
|
2488
|
+
retentionValue: number;
|
|
2489
|
+
}
|
|
2490
|
+
export interface GetCloudBackupSchedulePolicyItemYearly {
|
|
2491
|
+
/**
|
|
2492
|
+
* Desired frequency of the new backup policy item specified by `frequencyType` (yearly in this case). The supported values for yearly policies are
|
|
2493
|
+
*/
|
|
2494
|
+
frequencyInterval: number;
|
|
2495
|
+
/**
|
|
2496
|
+
* Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as `yearly`. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
|
|
2497
|
+
*/
|
|
2498
|
+
frequencyType: string;
|
|
2499
|
+
/**
|
|
2500
|
+
* Unique identifier of the backup policy item.
|
|
2501
|
+
*/
|
|
2502
|
+
id: string;
|
|
2503
|
+
/**
|
|
2504
|
+
* Scope of the backup policy item: `days`, `weeks`, `months`, or `years`.
|
|
2505
|
+
*/
|
|
2506
|
+
retentionUnit: string;
|
|
2507
|
+
/**
|
|
2508
|
+
* Value to associate with `retentionUnit`. Yearly policy must have retention of at least 1 year.
|
|
2419
2509
|
*/
|
|
2420
2510
|
retentionValue: number;
|
|
2421
2511
|
}
|
|
@@ -2939,7 +3029,7 @@ export interface GetClustersResult {
|
|
|
2939
3029
|
/**
|
|
2940
3030
|
* Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. **DEPRECATED** Use `tags` instead.
|
|
2941
3031
|
*
|
|
2942
|
-
* @deprecated
|
|
3032
|
+
* @deprecated This parameter is deprecated and will be removed by September 2024. Please transition to tags.
|
|
2943
3033
|
*/
|
|
2944
3034
|
labels: outputs.GetClustersResultLabel[];
|
|
2945
3035
|
/**
|
|
@@ -3597,10 +3687,6 @@ export interface GetDatabaseUsersResult {
|
|
|
3597
3687
|
* (Optional) Human-readable label that indicates whether the new database user authenticates with OIDC (OpenID Connect) federated authentication. If no value is given, Atlas uses the default value of `NONE`. The accepted types are:
|
|
3598
3688
|
*/
|
|
3599
3689
|
oidcAuthType: string;
|
|
3600
|
-
/**
|
|
3601
|
-
* @deprecated this parameter is deprecated and will be removed in version 1.16.0
|
|
3602
|
-
*/
|
|
3603
|
-
password: string;
|
|
3604
3690
|
/**
|
|
3605
3691
|
* The unique ID for the project to get all database users.
|
|
3606
3692
|
*/
|
|
@@ -3829,7 +3915,7 @@ export interface GetFederatedDatabaseInstanceStorageStore {
|
|
|
3829
3915
|
allowInsecure: boolean;
|
|
3830
3916
|
bucket: string;
|
|
3831
3917
|
/**
|
|
3832
|
-
* @deprecated
|
|
3918
|
+
* @deprecated This parameter is deprecated and will be removed by September 2024.
|
|
3833
3919
|
*/
|
|
3834
3920
|
clusterId: string;
|
|
3835
3921
|
clusterName: string;
|
|
@@ -4003,7 +4089,7 @@ export interface GetFederatedDatabaseInstancesResultStorageStore {
|
|
|
4003
4089
|
allowInsecure: boolean;
|
|
4004
4090
|
bucket: string;
|
|
4005
4091
|
/**
|
|
4006
|
-
* @deprecated
|
|
4092
|
+
* @deprecated This parameter is deprecated and will be removed by September 2024.
|
|
4007
4093
|
*/
|
|
4008
4094
|
clusterId: string;
|
|
4009
4095
|
clusterName: string;
|
|
@@ -4069,6 +4155,9 @@ export interface GetFederatedSettingsIdentityProviderAssociatedOrg {
|
|
|
4069
4155
|
* Flag that indicates whether domain restriction is enabled for the connected organization.
|
|
4070
4156
|
*/
|
|
4071
4157
|
domainRestrictionEnabled: boolean;
|
|
4158
|
+
/**
|
|
4159
|
+
* Unique 24-hexadecimal digit string that identifies the IdP.
|
|
4160
|
+
*/
|
|
4072
4161
|
identityProviderId: string;
|
|
4073
4162
|
/**
|
|
4074
4163
|
* Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
|
|
@@ -4182,7 +4271,7 @@ export interface GetFederatedSettingsIdentityProvidersResult {
|
|
|
4182
4271
|
*/
|
|
4183
4272
|
groupsClaim: string;
|
|
4184
4273
|
/**
|
|
4185
|
-
* Unique
|
|
4274
|
+
* Unique 24-hexadecimal digit string that identifies the IdP.
|
|
4186
4275
|
*/
|
|
4187
4276
|
idpId: string;
|
|
4188
4277
|
/**
|
|
@@ -4931,6 +5020,9 @@ export interface GetProjectsResult {
|
|
|
4931
5020
|
orgId: string;
|
|
4932
5021
|
projectId: string;
|
|
4933
5022
|
regionUsageRestrictions: string;
|
|
5023
|
+
tags: {
|
|
5024
|
+
[key: string]: string;
|
|
5025
|
+
};
|
|
4934
5026
|
teams: outputs.GetProjectsResultTeam[];
|
|
4935
5027
|
}
|
|
4936
5028
|
export interface GetProjectsResultIpAddresses {
|
|
@@ -5080,6 +5172,10 @@ export interface GetServerlessInstanceTag {
|
|
|
5080
5172
|
value: string;
|
|
5081
5173
|
}
|
|
5082
5174
|
export interface GetServerlessInstancesResult {
|
|
5175
|
+
/**
|
|
5176
|
+
* Flag that indicates whether the serverless instance uses [Serverless Auto Indexing](https://www.mongodb.com/docs/atlas/performance-advisor/auto-index-serverless/).
|
|
5177
|
+
*/
|
|
5178
|
+
autoIndexing: boolean;
|
|
5083
5179
|
connectionStringsPrivateEndpointSrvs: string[];
|
|
5084
5180
|
/**
|
|
5085
5181
|
* Public `mongodb+srv://` connection string that you can use to connect to this serverless instance.
|
|
@@ -5168,6 +5264,174 @@ export interface GetSharedTierSnapshotsResult {
|
|
|
5168
5264
|
startTime: string;
|
|
5169
5265
|
status: string;
|
|
5170
5266
|
}
|
|
5267
|
+
export interface GetStreamConnectionAuthentication {
|
|
5268
|
+
/**
|
|
5269
|
+
* Style of authentication. Can be one of `PLAIN`, `SCRAM-256`, or `SCRAM-512`.
|
|
5270
|
+
*/
|
|
5271
|
+
mechanism: string;
|
|
5272
|
+
/**
|
|
5273
|
+
* Password of the account to connect to the Kafka cluster.
|
|
5274
|
+
*/
|
|
5275
|
+
password: string;
|
|
5276
|
+
/**
|
|
5277
|
+
* Username of the account to connect to the Kafka cluster.
|
|
5278
|
+
*/
|
|
5279
|
+
username: string;
|
|
5280
|
+
}
|
|
5281
|
+
export interface GetStreamConnectionDbRoleToExecute {
|
|
5282
|
+
/**
|
|
5283
|
+
* The name of the role to use. Can be a built in role or a custom role.
|
|
5284
|
+
*/
|
|
5285
|
+
role: string;
|
|
5286
|
+
/**
|
|
5287
|
+
* Type of the DB role. Can be either BUILT_IN or CUSTOM.
|
|
5288
|
+
*/
|
|
5289
|
+
type: string;
|
|
5290
|
+
}
|
|
5291
|
+
export interface GetStreamConnectionSecurity {
|
|
5292
|
+
/**
|
|
5293
|
+
* A trusted, public x509 certificate for connecting to Kafka over SSL. String value of the certificate must be defined in the attribute.
|
|
5294
|
+
*/
|
|
5295
|
+
brokerPublicCertificate: string;
|
|
5296
|
+
/**
|
|
5297
|
+
* Describes the transport type. Can be either `PLAINTEXT` or `SSL`.
|
|
5298
|
+
*/
|
|
5299
|
+
protocol: string;
|
|
5300
|
+
}
|
|
5301
|
+
export interface GetStreamConnectionsResult {
|
|
5302
|
+
/**
|
|
5303
|
+
* User credentials required to connect to a Kafka cluster. Includes the authentication type, as well as the parameters for that authentication mode. See authentication.
|
|
5304
|
+
*/
|
|
5305
|
+
authentication: outputs.GetStreamConnectionsResultAuthentication;
|
|
5306
|
+
/**
|
|
5307
|
+
* Comma separated list of server addresses.
|
|
5308
|
+
*/
|
|
5309
|
+
bootstrapServers: string;
|
|
5310
|
+
/**
|
|
5311
|
+
* Name of the cluster configured for this connection.
|
|
5312
|
+
*/
|
|
5313
|
+
clusterName: string;
|
|
5314
|
+
/**
|
|
5315
|
+
* A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.
|
|
5316
|
+
*/
|
|
5317
|
+
config: {
|
|
5318
|
+
[key: string]: string;
|
|
5319
|
+
};
|
|
5320
|
+
/**
|
|
5321
|
+
* Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source.
|
|
5322
|
+
*/
|
|
5323
|
+
connectionName: string;
|
|
5324
|
+
/**
|
|
5325
|
+
* The name of a Built in or Custom DB Role to connect to an Atlas Cluster. See DBRoleToExecute.
|
|
5326
|
+
*/
|
|
5327
|
+
dbRoleToExecute: outputs.GetStreamConnectionsResultDbRoleToExecute;
|
|
5328
|
+
id: string;
|
|
5329
|
+
/**
|
|
5330
|
+
* Human-readable label that identifies the stream instance.
|
|
5331
|
+
*/
|
|
5332
|
+
instanceName: string;
|
|
5333
|
+
/**
|
|
5334
|
+
* Unique 24-hexadecimal digit string that identifies your project.
|
|
5335
|
+
*/
|
|
5336
|
+
projectId: string;
|
|
5337
|
+
/**
|
|
5338
|
+
* Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use. See security.
|
|
5339
|
+
*/
|
|
5340
|
+
security: outputs.GetStreamConnectionsResultSecurity;
|
|
5341
|
+
/**
|
|
5342
|
+
* Type of the DB role. Can be either BUILT_IN or CUSTOM.
|
|
5343
|
+
*/
|
|
5344
|
+
type: string;
|
|
5345
|
+
}
|
|
5346
|
+
export interface GetStreamConnectionsResultAuthentication {
|
|
5347
|
+
/**
|
|
5348
|
+
* Style of authentication. Can be one of `PLAIN`, `SCRAM-256`, or `SCRAM-512`.
|
|
5349
|
+
*/
|
|
5350
|
+
mechanism: string;
|
|
5351
|
+
/**
|
|
5352
|
+
* Password of the account to connect to the Kafka cluster.
|
|
5353
|
+
*/
|
|
5354
|
+
password: string;
|
|
5355
|
+
/**
|
|
5356
|
+
* Username of the account to connect to the Kafka cluster.
|
|
5357
|
+
*/
|
|
5358
|
+
username: string;
|
|
5359
|
+
}
|
|
5360
|
+
export interface GetStreamConnectionsResultDbRoleToExecute {
|
|
5361
|
+
/**
|
|
5362
|
+
* The name of the role to use. Can be a built in role or a custom role.
|
|
5363
|
+
*/
|
|
5364
|
+
role: string;
|
|
5365
|
+
/**
|
|
5366
|
+
* Type of the DB role. Can be either BUILT_IN or CUSTOM.
|
|
5367
|
+
*/
|
|
5368
|
+
type: string;
|
|
5369
|
+
}
|
|
5370
|
+
export interface GetStreamConnectionsResultSecurity {
|
|
5371
|
+
/**
|
|
5372
|
+
* A trusted, public x509 certificate for connecting to Kafka over SSL. String value of the certificate must be defined in the attribute.
|
|
5373
|
+
*/
|
|
5374
|
+
brokerPublicCertificate: string;
|
|
5375
|
+
/**
|
|
5376
|
+
* Describes the transport type. Can be either `PLAINTEXT` or `SSL`.
|
|
5377
|
+
*/
|
|
5378
|
+
protocol: string;
|
|
5379
|
+
}
|
|
5380
|
+
export interface GetStreamInstanceDataProcessRegion {
|
|
5381
|
+
/**
|
|
5382
|
+
* Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. The [MongoDB Atlas API](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Streams/operation/createStreamInstance) describes the valid values.
|
|
5383
|
+
*/
|
|
5384
|
+
cloudProvider: string;
|
|
5385
|
+
/**
|
|
5386
|
+
* Name of the cloud provider region hosting Atlas Stream Processing. The [MongoDB Atlas API](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Streams/operation/createStreamInstance) describes the valid values.
|
|
5387
|
+
*/
|
|
5388
|
+
region: string;
|
|
5389
|
+
}
|
|
5390
|
+
export interface GetStreamInstanceStreamConfig {
|
|
5391
|
+
/**
|
|
5392
|
+
* Selected tier for the Stream Instance. Configures Memory / VCPU allowances. The [MongoDB Atlas API](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Streams/operation/createStreamInstance) describes the valid values.
|
|
5393
|
+
*/
|
|
5394
|
+
tier: string;
|
|
5395
|
+
}
|
|
5396
|
+
export interface GetStreamInstancesResult {
|
|
5397
|
+
/**
|
|
5398
|
+
* Defines the cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
|
|
5399
|
+
*/
|
|
5400
|
+
dataProcessRegion: outputs.GetStreamInstancesResultDataProcessRegion;
|
|
5401
|
+
/**
|
|
5402
|
+
* List that contains the hostnames assigned to the stream instance.
|
|
5403
|
+
*/
|
|
5404
|
+
hostnames: string[];
|
|
5405
|
+
id: string;
|
|
5406
|
+
/**
|
|
5407
|
+
* Human-readable label that identifies the stream instance.
|
|
5408
|
+
*/
|
|
5409
|
+
instanceName: string;
|
|
5410
|
+
/**
|
|
5411
|
+
* Unique 24-hexadecimal digit string that identifies your project.
|
|
5412
|
+
*/
|
|
5413
|
+
projectId: string;
|
|
5414
|
+
/**
|
|
5415
|
+
* Defines the configuration options for an Atlas Stream Processing Instance. See stream config
|
|
5416
|
+
*/
|
|
5417
|
+
streamConfig: outputs.GetStreamInstancesResultStreamConfig;
|
|
5418
|
+
}
|
|
5419
|
+
export interface GetStreamInstancesResultDataProcessRegion {
|
|
5420
|
+
/**
|
|
5421
|
+
* Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. The [MongoDB Atlas API](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Streams/operation/createStreamInstance) describes the valid values.
|
|
5422
|
+
*/
|
|
5423
|
+
cloudProvider: string;
|
|
5424
|
+
/**
|
|
5425
|
+
* Name of the cloud provider region hosting Atlas Stream Processing. The [MongoDB Atlas API](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Streams/operation/createStreamInstance) describes the valid values.
|
|
5426
|
+
*/
|
|
5427
|
+
region: string;
|
|
5428
|
+
}
|
|
5429
|
+
export interface GetStreamInstancesResultStreamConfig {
|
|
5430
|
+
/**
|
|
5431
|
+
* Selected tier for the Stream Instance. Configures Memory / VCPU allowances. The [MongoDB Atlas API](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Streams/operation/createStreamInstance) describes the valid values.
|
|
5432
|
+
*/
|
|
5433
|
+
tier: string;
|
|
5434
|
+
}
|
|
5171
5435
|
export interface GetThirdPartyIntegrationsResult {
|
|
5172
5436
|
accountId: string;
|
|
5173
5437
|
/**
|
|
@@ -5179,6 +5443,10 @@ export interface GetThirdPartyIntegrationsResult {
|
|
|
5179
5443
|
* Whether your cluster has Prometheus enabled.
|
|
5180
5444
|
*/
|
|
5181
5445
|
enabled?: boolean;
|
|
5446
|
+
/**
|
|
5447
|
+
* Unique identifier of the integration.
|
|
5448
|
+
*/
|
|
5449
|
+
id: string;
|
|
5182
5450
|
/**
|
|
5183
5451
|
* Your Microsoft Teams incoming webhook URL.
|
|
5184
5452
|
*/
|
|
@@ -5196,7 +5464,9 @@ export interface GetThirdPartyIntegrationsResult {
|
|
|
5196
5464
|
*/
|
|
5197
5465
|
routingKey: string;
|
|
5198
5466
|
/**
|
|
5199
|
-
* Your Prometheus protocol scheme configured for requests.
|
|
5467
|
+
* Your Prometheus protocol scheme configured for requests. **Note** This attribute is deprecated as it is not being used.
|
|
5468
|
+
*
|
|
5469
|
+
* @deprecated This parameter is deprecated and will be removed in version 1.18.0.
|
|
5200
5470
|
*/
|
|
5201
5471
|
scheme?: string;
|
|
5202
5472
|
/**
|
|
@@ -5213,7 +5483,7 @@ export interface GetThirdPartyIntegrationsResult {
|
|
|
5213
5483
|
serviceKey: string;
|
|
5214
5484
|
teamName: string;
|
|
5215
5485
|
/**
|
|
5216
|
-
*
|
|
5486
|
+
* Thirt-Party service integration type.
|
|
5217
5487
|
*/
|
|
5218
5488
|
type: string;
|
|
5219
5489
|
/**
|
|
@@ -5295,7 +5565,7 @@ export interface OnlineArchiveDataExpirationRule {
|
|
|
5295
5565
|
}
|
|
5296
5566
|
export interface OnlineArchiveDataProcessRegion {
|
|
5297
5567
|
/**
|
|
5298
|
-
* Human-readable label that identifies the Cloud service provider where you wish to store your archived data.
|
|
5568
|
+
* Human-readable label that identifies the Cloud service provider where you wish to store your archived data. `AZURE` may be selected only if Azure is the Cloud service provider for the cluster and no AWS online archive has been created for the cluster.
|
|
5299
5569
|
*/
|
|
5300
5570
|
cloudProvider: string;
|
|
5301
5571
|
/**
|
|
@@ -5412,6 +5682,20 @@ export interface ProjectTeam {
|
|
|
5412
5682
|
*/
|
|
5413
5683
|
teamId: string;
|
|
5414
5684
|
}
|
|
5685
|
+
export interface PushBasedLogExportTimeouts {
|
|
5686
|
+
/**
|
|
5687
|
+
* A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
|
|
5688
|
+
*/
|
|
5689
|
+
create?: string;
|
|
5690
|
+
/**
|
|
5691
|
+
* A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
|
|
5692
|
+
*/
|
|
5693
|
+
delete?: string;
|
|
5694
|
+
/**
|
|
5695
|
+
* A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
|
|
5696
|
+
*/
|
|
5697
|
+
update?: string;
|
|
5698
|
+
}
|
|
5415
5699
|
export interface SearchDeploymentSpec {
|
|
5416
5700
|
/**
|
|
5417
5701
|
* Hardware specification for the search node instance sizes. The [MongoDB Atlas API](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Atlas-Search/operation/createAtlasSearchDeployment) describes the valid values. More details can also be found in the [Search Node Documentation](https://www.mongodb.com/docs/atlas/cluster-config/multi-cloud-distribution/#search-tier).
|
|
@@ -5466,6 +5750,53 @@ export interface ServerlessInstanceTag {
|
|
|
5466
5750
|
*/
|
|
5467
5751
|
value: string;
|
|
5468
5752
|
}
|
|
5753
|
+
export interface StreamConnectionAuthentication {
|
|
5754
|
+
/**
|
|
5755
|
+
* Style of authentication. Can be one of `PLAIN`, `SCRAM-256`, or `SCRAM-512`.
|
|
5756
|
+
*/
|
|
5757
|
+
mechanism?: string;
|
|
5758
|
+
/**
|
|
5759
|
+
* Password of the account to connect to the Kafka cluster.
|
|
5760
|
+
*/
|
|
5761
|
+
password?: string;
|
|
5762
|
+
/**
|
|
5763
|
+
* Username of the account to connect to the Kafka cluster.
|
|
5764
|
+
*/
|
|
5765
|
+
username?: string;
|
|
5766
|
+
}
|
|
5767
|
+
export interface StreamConnectionDbRoleToExecute {
|
|
5768
|
+
role: string;
|
|
5769
|
+
/**
|
|
5770
|
+
* Type of connection. Can be either `Cluster`, `Kafka` or `Sample`.
|
|
5771
|
+
*/
|
|
5772
|
+
type: string;
|
|
5773
|
+
}
|
|
5774
|
+
export interface StreamConnectionSecurity {
|
|
5775
|
+
/**
|
|
5776
|
+
* A trusted, public x509 certificate for connecting to Kafka over SSL. String value of the certificate must be defined in the attribute.
|
|
5777
|
+
*/
|
|
5778
|
+
brokerPublicCertificate?: string;
|
|
5779
|
+
/**
|
|
5780
|
+
* Describes the transport type. Can be either `PLAINTEXT` or `SSL`.
|
|
5781
|
+
*/
|
|
5782
|
+
protocol?: string;
|
|
5783
|
+
}
|
|
5784
|
+
export interface StreamInstanceDataProcessRegion {
|
|
5785
|
+
/**
|
|
5786
|
+
* Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. The [MongoDB Atlas API](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Streams/operation/createStreamInstance) describes the valid values.
|
|
5787
|
+
*/
|
|
5788
|
+
cloudProvider: string;
|
|
5789
|
+
/**
|
|
5790
|
+
* Name of the cloud provider region hosting Atlas Stream Processing. The [MongoDB Atlas API](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Streams/operation/createStreamInstance) describes the valid values.
|
|
5791
|
+
*/
|
|
5792
|
+
region: string;
|
|
5793
|
+
}
|
|
5794
|
+
export interface StreamInstanceStreamConfig {
|
|
5795
|
+
/**
|
|
5796
|
+
* Selected tier for the Stream Instance. Configures Memory / VCPU allowances. The [MongoDB Atlas API](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Streams/operation/createStreamInstance) describes the valid values.
|
|
5797
|
+
*/
|
|
5798
|
+
tier: string;
|
|
5799
|
+
}
|
|
5469
5800
|
export interface X509AuthenticationDatabaseUserCertificate {
|
|
5470
5801
|
createdAt: string;
|
|
5471
5802
|
groupId: string;
|