@pulumi/mongodbatlas 3.15.0-alpha.1713461951 → 3.15.0-alpha.1713899327
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/accessListApiKey.d.ts +0 -4
- package/accessListApiKey.js +0 -4
- package/accessListApiKey.js.map +1 -1
- package/advancedCluster.d.ts +0 -16
- package/advancedCluster.js +0 -16
- package/advancedCluster.js.map +1 -1
- package/alertConfiguration.d.ts +0 -6
- package/alertConfiguration.js +0 -6
- package/alertConfiguration.js.map +1 -1
- package/apiKey.d.ts +0 -2
- package/apiKey.js +0 -2
- package/apiKey.js.map +1 -1
- package/auditing.d.ts +0 -2
- package/auditing.js +0 -2
- package/auditing.js.map +1 -1
- package/backupCompliancePolicy.d.ts +0 -2
- package/backupCompliancePolicy.js +0 -2
- package/backupCompliancePolicy.js.map +1 -1
- package/cloudBackupSnapshot.d.ts +0 -2
- package/cloudBackupSnapshot.js +0 -2
- package/cloudBackupSnapshot.js.map +1 -1
- package/cloudBackupSnapshotExportBucket.d.ts +0 -2
- package/cloudBackupSnapshotExportBucket.js +0 -2
- package/cloudBackupSnapshotExportBucket.js.map +1 -1
- package/cloudBackupSnapshotExportJob.d.ts +0 -4
- package/cloudBackupSnapshotExportJob.js +0 -4
- package/cloudBackupSnapshotExportJob.js.map +1 -1
- package/cloudBackupSnapshotRestoreJob.d.ts +0 -6
- package/cloudBackupSnapshotRestoreJob.js +0 -6
- package/cloudBackupSnapshotRestoreJob.js.map +1 -1
- package/cluster.d.ts +0 -18
- package/cluster.js +0 -18
- package/cluster.js.map +1 -1
- package/clusterOutageSimulation.d.ts +0 -2
- package/clusterOutageSimulation.js +0 -2
- package/clusterOutageSimulation.js.map +1 -1
- package/customDbRole.d.ts +0 -4
- package/customDbRole.js +0 -4
- package/customDbRole.js.map +1 -1
- package/customDnsConfigurationClusterAws.d.ts +0 -2
- package/customDnsConfigurationClusterAws.js +0 -2
- package/customDnsConfigurationClusterAws.js.map +1 -1
- package/databaseUser.d.ts +0 -8
- package/databaseUser.js +0 -8
- package/databaseUser.js.map +1 -1
- package/eventTrigger.d.ts +0 -8
- package/eventTrigger.js +0 -8
- package/eventTrigger.js.map +1 -1
- package/federatedDatabaseInstance.d.ts +0 -4
- package/federatedDatabaseInstance.js +0 -4
- package/federatedDatabaseInstance.js.map +1 -1
- package/federatedQueryLimit.d.ts +0 -2
- package/federatedQueryLimit.js +0 -2
- package/federatedQueryLimit.js.map +1 -1
- package/federatedSettingsIdentityProvider.d.ts +0 -2
- package/federatedSettingsIdentityProvider.js +0 -2
- package/federatedSettingsIdentityProvider.js.map +1 -1
- package/federatedSettingsOrgRoleMapping.d.ts +0 -2
- package/federatedSettingsOrgRoleMapping.js +0 -2
- package/federatedSettingsOrgRoleMapping.js.map +1 -1
- package/get509AuthenticationDatabaseUser.d.ts +0 -4
- package/get509AuthenticationDatabaseUser.js +0 -4
- package/get509AuthenticationDatabaseUser.js.map +1 -1
- package/getAccessListApiKeys.d.ts +0 -16
- package/getAccessListApiKeys.js.map +1 -1
- package/getAdvancedCluster.d.ts +0 -4
- package/getAdvancedCluster.js +0 -4
- package/getAdvancedCluster.js.map +1 -1
- package/getAlertConfiguration.d.ts +0 -12
- package/getAlertConfiguration.js +0 -12
- package/getAlertConfiguration.js.map +1 -1
- package/getAtlasUser.d.ts +0 -8
- package/getAtlasUser.js +0 -8
- package/getAtlasUser.js.map +1 -1
- package/getAtlasUsers.d.ts +0 -12
- package/getAtlasUsers.js +0 -12
- package/getAtlasUsers.js.map +1 -1
- package/getAuditing.d.ts +0 -4
- package/getAuditing.js +0 -4
- package/getAuditing.js.map +1 -1
- package/getBackupCompliancePolicy.d.ts +0 -4
- package/getBackupCompliancePolicy.js +0 -4
- package/getBackupCompliancePolicy.js.map +1 -1
- package/getCloudBackupSchedule.d.ts +0 -4
- package/getCloudBackupSchedule.js +0 -4
- package/getCloudBackupSchedule.js.map +1 -1
- package/getCloudBackupSnapshot.d.ts +0 -4
- package/getCloudBackupSnapshot.js +0 -4
- package/getCloudBackupSnapshot.js.map +1 -1
- package/getCloudBackupSnapshotExportBucket.d.ts +0 -4
- package/getCloudBackupSnapshotExportBucket.js +0 -4
- package/getCloudBackupSnapshotExportBucket.js.map +1 -1
- package/getCloudBackupSnapshotExportBuckets.d.ts +0 -4
- package/getCloudBackupSnapshotExportBuckets.js +0 -4
- package/getCloudBackupSnapshotExportBuckets.js.map +1 -1
- package/getCloudBackupSnapshotExportJob.d.ts +0 -4
- package/getCloudBackupSnapshotExportJob.js +0 -4
- package/getCloudBackupSnapshotExportJob.js.map +1 -1
- package/getCloudBackupSnapshotExportJobs.d.ts +0 -4
- package/getCloudBackupSnapshotExportJobs.js +0 -4
- package/getCloudBackupSnapshotExportJobs.js.map +1 -1
- package/getCloudBackupSnapshotRestoreJobs.d.ts +0 -4
- package/getCloudBackupSnapshotRestoreJobs.js +0 -4
- package/getCloudBackupSnapshotRestoreJobs.js.map +1 -1
- package/getCloudProviderAccessSetup.d.ts +0 -8
- package/getCloudProviderAccessSetup.js +0 -8
- package/getCloudProviderAccessSetup.js.map +1 -1
- package/getCluster.d.ts +0 -4
- package/getCluster.js +0 -4
- package/getCluster.js.map +1 -1
- package/getClusterOutageSimulation.d.ts +0 -4
- package/getClusterOutageSimulation.js +0 -4
- package/getClusterOutageSimulation.js.map +1 -1
- package/getClusters.d.ts +0 -4
- package/getClusters.js +0 -4
- package/getClusters.js.map +1 -1
- package/getCustomDbRole.d.ts +0 -4
- package/getCustomDbRole.js +0 -4
- package/getCustomDbRole.js.map +1 -1
- package/getCustomDnsConfigurationClusterAws.d.ts +0 -4
- package/getCustomDnsConfigurationClusterAws.js +0 -4
- package/getCustomDnsConfigurationClusterAws.js.map +1 -1
- package/getDatabaseUser.d.ts +0 -8
- package/getDatabaseUser.js +0 -8
- package/getDatabaseUser.js.map +1 -1
- package/getDatabaseUsers.d.ts +0 -8
- package/getDatabaseUsers.js +0 -8
- package/getDatabaseUsers.js.map +1 -1
- package/getFederatedDatabaseInstance.d.ts +0 -8
- package/getFederatedDatabaseInstance.js +0 -8
- package/getFederatedDatabaseInstance.js.map +1 -1
- package/getFederatedQueryLimit.d.ts +0 -4
- package/getFederatedQueryLimit.js +0 -4
- package/getFederatedQueryLimit.js.map +1 -1
- package/getFederatedQueryLimits.d.ts +0 -4
- package/getFederatedQueryLimits.js +0 -4
- package/getFederatedQueryLimits.js.map +1 -1
- package/getFederatedSettings.d.ts +0 -4
- package/getFederatedSettings.js +0 -4
- package/getFederatedSettings.js.map +1 -1
- package/getFederatedSettingsIdentityProvider.d.ts +0 -4
- package/getFederatedSettingsIdentityProvider.js +0 -4
- package/getFederatedSettingsIdentityProvider.js.map +1 -1
- package/getFederatedSettingsIdentityProviders.d.ts +0 -4
- package/getFederatedSettingsIdentityProviders.js +0 -4
- package/getFederatedSettingsIdentityProviders.js.map +1 -1
- package/getFederatedSettingsOrgConfig.d.ts +0 -4
- package/getFederatedSettingsOrgConfig.js +0 -4
- package/getFederatedSettingsOrgConfig.js.map +1 -1
- package/getFederatedSettingsOrgConfigs.d.ts +0 -4
- package/getFederatedSettingsOrgConfigs.js +0 -4
- package/getFederatedSettingsOrgConfigs.js.map +1 -1
- package/getFederatedSettingsOrgRoleMapping.d.ts +0 -4
- package/getFederatedSettingsOrgRoleMapping.js +0 -4
- package/getFederatedSettingsOrgRoleMapping.js.map +1 -1
- package/getGlobalClusterConfig.d.ts +0 -4
- package/getGlobalClusterConfig.js +0 -4
- package/getGlobalClusterConfig.js.map +1 -1
- package/getLdapConfiguration.d.ts +0 -4
- package/getLdapConfiguration.js +0 -4
- package/getLdapConfiguration.js.map +1 -1
- package/getLdapVerify.d.ts +0 -4
- package/getLdapVerify.js +0 -4
- package/getLdapVerify.js.map +1 -1
- package/getMaintenanceWindow.d.ts +0 -8
- package/getMaintenanceWindow.js +0 -8
- package/getMaintenanceWindow.js.map +1 -1
- package/getNetworkContainer.d.ts +0 -4
- package/getNetworkContainer.js +0 -4
- package/getNetworkContainer.js.map +1 -1
- package/getNetworkContainers.d.ts +0 -4
- package/getNetworkContainers.js +0 -4
- package/getNetworkContainers.js.map +1 -1
- package/getNetworkPeering.d.ts +0 -4
- package/getNetworkPeering.js +0 -4
- package/getNetworkPeering.js.map +1 -1
- package/getNetworkPeerings.d.ts +0 -4
- package/getNetworkPeerings.js +0 -4
- package/getNetworkPeerings.js.map +1 -1
- package/getOrganization.d.ts +0 -4
- package/getOrganization.js +0 -4
- package/getOrganization.js.map +1 -1
- package/getOrganizations.d.ts +0 -10
- package/getOrganizations.js +0 -4
- package/getOrganizations.js.map +1 -1
- package/getPrivateLinkEndpoint.d.ts +0 -4
- package/getPrivateLinkEndpoint.js +0 -4
- package/getPrivateLinkEndpoint.js.map +1 -1
- package/getPrivatelinkEndpointServiceDataFederationOnlineArchive.d.ts +0 -4
- package/getPrivatelinkEndpointServiceDataFederationOnlineArchive.js +0 -4
- package/getPrivatelinkEndpointServiceDataFederationOnlineArchive.js.map +1 -1
- package/getPrivatelinkEndpointServiceDataFederationOnlineArchives.d.ts +0 -4
- package/getPrivatelinkEndpointServiceDataFederationOnlineArchives.js +0 -4
- package/getPrivatelinkEndpointServiceDataFederationOnlineArchives.js.map +1 -1
- package/getPrivatelinkEndpointServiceServerless.d.ts +0 -8
- package/getPrivatelinkEndpointServiceServerless.js +0 -8
- package/getPrivatelinkEndpointServiceServerless.js.map +1 -1
- package/getPrivatelinkEndpointsServiceServerless.d.ts +0 -8
- package/getPrivatelinkEndpointsServiceServerless.js +0 -8
- package/getPrivatelinkEndpointsServiceServerless.js.map +1 -1
- package/getProject.d.ts +0 -8
- package/getProject.js +0 -8
- package/getProject.js.map +1 -1
- package/getProjectApiKey.d.ts +0 -4
- package/getProjectApiKey.js +0 -4
- package/getProjectApiKey.js.map +1 -1
- package/getProjectApiKeys.d.ts +0 -4
- package/getProjectApiKeys.js +0 -4
- package/getProjectApiKeys.js.map +1 -1
- package/getProjectInvitation.d.ts +0 -4
- package/getProjectInvitation.js +0 -4
- package/getProjectInvitation.js.map +1 -1
- package/getProjectIpAccessList.d.ts +0 -12
- package/getProjectIpAccessList.js +0 -12
- package/getProjectIpAccessList.js.map +1 -1
- package/getProjects.d.ts +0 -4
- package/getProjects.js +0 -4
- package/getProjects.js.map +1 -1
- package/getRolesOrgId.d.ts +0 -4
- package/getRolesOrgId.js +0 -4
- package/getRolesOrgId.js.map +1 -1
- package/getSearchIndex.d.ts +0 -4
- package/getSearchIndex.js +0 -4
- package/getSearchIndex.js.map +1 -1
- package/getServerlessInstance.d.ts +0 -4
- package/getServerlessInstance.js +0 -4
- package/getServerlessInstance.js.map +1 -1
- package/getServerlessInstances.d.ts +0 -4
- package/getServerlessInstances.js +0 -4
- package/getServerlessInstances.js.map +1 -1
- package/getThirdPartyIntegration.d.ts +0 -4
- package/getThirdPartyIntegration.js +0 -4
- package/getThirdPartyIntegration.js.map +1 -1
- package/getThirdPartyIntegrations.d.ts +0 -4
- package/getThirdPartyIntegrations.js +0 -4
- package/getThirdPartyIntegrations.js.map +1 -1
- package/getX509AuthenticationDatabaseUser.d.ts +0 -4
- package/getX509AuthenticationDatabaseUser.js +0 -4
- package/getX509AuthenticationDatabaseUser.js.map +1 -1
- package/globalClusterConfig.d.ts +0 -4
- package/globalClusterConfig.js +0 -4
- package/globalClusterConfig.js.map +1 -1
- package/ldapConfiguration.d.ts +0 -4
- package/ldapConfiguration.js +0 -4
- package/ldapConfiguration.js.map +1 -1
- package/ldapVerify.d.ts +0 -2
- package/ldapVerify.js +0 -2
- package/ldapVerify.js.map +1 -1
- package/maintenanceWindow.d.ts +0 -4
- package/maintenanceWindow.js +0 -4
- package/maintenanceWindow.js.map +1 -1
- package/networkContainer.d.ts +0 -6
- package/networkContainer.js +0 -6
- package/networkContainer.js.map +1 -1
- package/networkPeering.d.ts +0 -8
- package/networkPeering.js +0 -8
- package/networkPeering.js.map +1 -1
- package/onlineArchive.d.ts +0 -4
- package/onlineArchive.js +0 -4
- package/onlineArchive.js.map +1 -1
- package/orgInvitation.d.ts +0 -6
- package/orgInvitation.js +0 -6
- package/orgInvitation.js.map +1 -1
- package/organization.d.ts +0 -2
- package/organization.js +0 -2
- package/organization.js.map +1 -1
- package/package.json +1 -1
- package/privateLinkEndpoint.d.ts +0 -2
- package/privateLinkEndpoint.js +0 -2
- package/privateLinkEndpoint.js.map +1 -1
- package/privateLinkEndpointService.d.ts +0 -6
- package/privateLinkEndpointService.js +0 -6
- package/privateLinkEndpointService.js.map +1 -1
- package/privatelinkEndpointServerless.d.ts +0 -2
- package/privatelinkEndpointServerless.js +0 -2
- package/privatelinkEndpointServerless.js.map +1 -1
- package/privatelinkEndpointServiceDataFederationOnlineArchive.d.ts +0 -2
- package/privatelinkEndpointServiceDataFederationOnlineArchive.js +0 -2
- package/privatelinkEndpointServiceDataFederationOnlineArchive.js.map +1 -1
- package/privatelinkEndpointServiceServerless.d.ts +0 -4
- package/privatelinkEndpointServiceServerless.js +0 -4
- package/privatelinkEndpointServiceServerless.js.map +1 -1
- package/project.d.ts +0 -2
- package/project.js +0 -2
- package/project.js.map +1 -1
- package/projectApiKey.d.ts +0 -4
- package/projectApiKey.js +0 -4
- package/projectApiKey.js.map +1 -1
- package/projectInvitation.d.ts +0 -4
- package/projectInvitation.js +0 -4
- package/projectInvitation.js.map +1 -1
- package/projectIpAccessList.d.ts +0 -6
- package/projectIpAccessList.js +0 -6
- package/projectIpAccessList.js.map +1 -1
- package/searchIndex.d.ts +3 -9
- package/searchIndex.js +3 -9
- package/searchIndex.js.map +1 -1
- package/serverlessInstance.d.ts +0 -2
- package/serverlessInstance.js +0 -2
- package/serverlessInstance.js.map +1 -1
- package/thirdPartyIntegration.d.ts +0 -110
- package/thirdPartyIntegration.js +0 -2
- package/thirdPartyIntegration.js.map +1 -1
- package/types/input.d.ts +1 -332
- package/types/output.d.ts +13 -408
package/types/output.d.ts
CHANGED
|
@@ -1,53 +1,15 @@
|
|
|
1
1
|
import * as outputs from "../types/output";
|
|
2
2
|
export interface AdvancedClusterAdvancedConfiguration {
|
|
3
|
-
/**
|
|
4
|
-
* [Default level of acknowledgment requested from MongoDB for read operations](https://docs.mongodb.com/manual/reference/read-concern/) set for this cluster. MongoDB 4.4 clusters default to [available](https://docs.mongodb.com/manual/reference/read-concern-available/).
|
|
5
|
-
*/
|
|
6
3
|
defaultReadConcern: string;
|
|
7
|
-
/**
|
|
8
|
-
* [Default level of acknowledgment requested from MongoDB for write operations](https://docs.mongodb.com/manual/reference/write-concern/) set for this cluster. MongoDB 4.4 clusters default to [1](https://docs.mongodb.com/manual/reference/write-concern/).
|
|
9
|
-
*/
|
|
10
4
|
defaultWriteConcern: string;
|
|
11
|
-
/**
|
|
12
|
-
* When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.
|
|
13
|
-
*/
|
|
14
5
|
failIndexKeyTooLong: boolean;
|
|
15
|
-
/**
|
|
16
|
-
* When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.
|
|
17
|
-
*/
|
|
18
6
|
javascriptEnabled: boolean;
|
|
19
|
-
/**
|
|
20
|
-
* Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:
|
|
21
|
-
*
|
|
22
|
-
* - TLS1_0
|
|
23
|
-
* - TLS1_1
|
|
24
|
-
* - TLS1_2
|
|
25
|
-
*/
|
|
26
7
|
minimumEnabledTlsProtocol: string;
|
|
27
|
-
/**
|
|
28
|
-
* When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.
|
|
29
|
-
*/
|
|
30
8
|
noTableScan: boolean;
|
|
31
|
-
/**
|
|
32
|
-
* Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
|
|
33
|
-
* * **Note** A minimum oplog retention is required when seeking to change a cluster's class to Local NVMe SSD. To learn more and for latest guidance see [`oplogMinRetentionHours`](https://www.mongodb.com/docs/manual/core/replica-set-oplog/#std-label-replica-set-minimum-oplog-size)
|
|
34
|
-
*/
|
|
35
9
|
oplogMinRetentionHours?: number;
|
|
36
|
-
/**
|
|
37
|
-
* The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.
|
|
38
|
-
*/
|
|
39
10
|
oplogSizeMb: number;
|
|
40
|
-
/**
|
|
41
|
-
* Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
|
|
42
|
-
*/
|
|
43
11
|
sampleRefreshIntervalBiConnector: number;
|
|
44
|
-
/**
|
|
45
|
-
* Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
|
|
46
|
-
*/
|
|
47
12
|
sampleSizeBiConnector: number;
|
|
48
|
-
/**
|
|
49
|
-
* Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.
|
|
50
|
-
*/
|
|
51
13
|
transactionLifetimeLimitSeconds: number;
|
|
52
14
|
}
|
|
53
15
|
export interface AdvancedClusterBiConnectorConfig {
|
|
@@ -108,10 +70,6 @@ export interface AdvancedClusterConnectionStringPrivateEndpoint {
|
|
|
108
70
|
}
|
|
109
71
|
export interface AdvancedClusterConnectionStringPrivateEndpointEndpoint {
|
|
110
72
|
endpointId: string;
|
|
111
|
-
/**
|
|
112
|
-
* Cloud service provider on which the servers are provisioned.
|
|
113
|
-
* The possible values are:
|
|
114
|
-
*/
|
|
115
73
|
providerName: string;
|
|
116
74
|
region: string;
|
|
117
75
|
}
|
|
@@ -289,180 +247,46 @@ export interface AdvancedClusterTag {
|
|
|
289
247
|
value: string;
|
|
290
248
|
}
|
|
291
249
|
export interface AlertConfigurationMatcher {
|
|
292
|
-
/**
|
|
293
|
-
* Name of the field in the target object to match on.
|
|
294
|
-
*
|
|
295
|
-
* | Host alerts | Replica set alerts | Sharded cluster alerts |
|
|
296
|
-
* |:---------- |:------------- |:------ |
|
|
297
|
-
* | `TYPE_NAME` | `REPLICA_SET_NAME` | `CLUSTER_NAME` |
|
|
298
|
-
* | `HOSTNAME` | `SHARD_NAME` | `SHARD_NAME` |
|
|
299
|
-
* | `PORT` | `CLUSTER_NAME` | |
|
|
300
|
-
* | `HOSTNAME_AND_PORT` | | |
|
|
301
|
-
* | `REPLICA_SET_NAME` | | |
|
|
302
|
-
*
|
|
303
|
-
*
|
|
304
|
-
*
|
|
305
|
-
* All other types of alerts do not support matchers.
|
|
306
|
-
*/
|
|
307
250
|
fieldName: string;
|
|
308
|
-
/**
|
|
309
|
-
* The operator to test the field’s value.
|
|
310
|
-
* Accepted values are:
|
|
311
|
-
*/
|
|
312
251
|
operator: string;
|
|
313
|
-
/**
|
|
314
|
-
* Value to test with the specified operator. If `fieldName` is set to TYPE_NAME, you can match on the following values:
|
|
315
|
-
*/
|
|
316
252
|
value: string;
|
|
317
253
|
}
|
|
318
254
|
export interface AlertConfigurationMetricThresholdConfig {
|
|
319
|
-
/**
|
|
320
|
-
* Name of the metric to check. The full list being quite large, please refer to atlas docs [here for general metrics](https://docs.atlas.mongodb.com/reference/alert-host-metrics/#measurement-types) and [here for serverless metrics](https://www.mongodb.com/docs/atlas/reference/api/alert-configurations-create-config/#serverless-measurements)
|
|
321
|
-
*/
|
|
322
255
|
metricName: string;
|
|
323
|
-
/**
|
|
324
|
-
* This must be set to AVERAGE. Atlas computes the current metric value as an average.
|
|
325
|
-
*/
|
|
326
256
|
mode?: string;
|
|
327
|
-
/**
|
|
328
|
-
* The operator to test the field’s value.
|
|
329
|
-
* Accepted values are:
|
|
330
|
-
*/
|
|
331
257
|
operator?: string;
|
|
332
|
-
/**
|
|
333
|
-
* Threshold value outside of which an alert will be triggered.
|
|
334
|
-
*/
|
|
335
258
|
threshold: number;
|
|
336
|
-
/**
|
|
337
|
-
* The units for the threshold value. Depends on the type of metric.
|
|
338
|
-
* Refer to the [MongoDB API Alert Configuration documentation](https://www.mongodb.com/docs/atlas/reference/api/alert-configurations-get-config/#request-body-parameters) for a list of accepted values.
|
|
339
|
-
*/
|
|
340
259
|
units?: string;
|
|
341
260
|
}
|
|
342
261
|
export interface AlertConfigurationNotification {
|
|
343
|
-
/**
|
|
344
|
-
* Slack API token. Required for the SLACK notifications type. If the token later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.
|
|
345
|
-
*/
|
|
346
262
|
apiToken?: string;
|
|
347
|
-
/**
|
|
348
|
-
* Slack channel name. Required for the SLACK notifications type.
|
|
349
|
-
*/
|
|
350
263
|
channelName?: string;
|
|
351
|
-
/**
|
|
352
|
-
* Datadog API Key. Found in the Datadog dashboard. Required for the DATADOG notifications type.
|
|
353
|
-
*/
|
|
354
264
|
datadogApiKey?: string;
|
|
355
|
-
/**
|
|
356
|
-
* Region that indicates which API URL to use. See the `datadogRegion` field in the `notifications` request parameter of [MongoDB API Alert Configuration documentation](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/createAlertConfiguration) for more details. The default Datadog region is US.
|
|
357
|
-
*/
|
|
358
265
|
datadogRegion?: string;
|
|
359
|
-
/**
|
|
360
|
-
* Number of minutes to wait after an alert condition is detected before sending out the first notification.
|
|
361
|
-
*/
|
|
362
266
|
delayMin: number;
|
|
363
|
-
/**
|
|
364
|
-
* Email address to which alert notifications are sent. Required for the EMAIL notifications type.
|
|
365
|
-
*/
|
|
366
267
|
emailAddress?: string;
|
|
367
|
-
/**
|
|
368
|
-
* Flag indicating email notifications should be sent. This flag is only valid if `typeName` is set to `ORG`, `GROUP`, or `USER`.
|
|
369
|
-
*/
|
|
370
268
|
emailEnabled: boolean;
|
|
371
|
-
/**
|
|
372
|
-
* Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. The minimum value is 5. **NOTE** `PAGER_DUTY`, `VICTOR_OPS`, and `OPS_GENIE` notifications do not return this value. The notification interval must be configured and managed within each external service.
|
|
373
|
-
*/
|
|
374
269
|
intervalMin: number;
|
|
375
|
-
/**
|
|
376
|
-
* Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams. Required if `typeName` is `MICROSOFT_TEAMS`. If the URL later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.
|
|
377
|
-
*/
|
|
378
270
|
microsoftTeamsWebhookUrl?: string;
|
|
379
|
-
/**
|
|
380
|
-
* Mobile number to which alert notifications are sent. Required for the SMS notifications type.
|
|
381
|
-
*/
|
|
382
271
|
mobileNumber?: string;
|
|
383
|
-
/**
|
|
384
|
-
* 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.
|
|
385
|
-
*/
|
|
386
272
|
notifierId: string;
|
|
387
|
-
/**
|
|
388
|
-
* Opsgenie API Key. Required for the `OPS_GENIE` notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.
|
|
389
|
-
*/
|
|
390
273
|
opsGenieApiKey?: string;
|
|
391
|
-
/**
|
|
392
|
-
* Region that indicates which API URL to use. Accepted regions are: `US` ,`EU`. The default Opsgenie region is US.
|
|
393
|
-
*/
|
|
394
274
|
opsGenieRegion?: string;
|
|
395
|
-
/**
|
|
396
|
-
* Optional. One or more roles that receive the configured alert. If you include this field, Atlas sends alerts only to users assigned the roles you specify in the array. If you omit this field, Atlas sends alerts to users assigned any role. This parameter is only valid if `typeName` is set to `ORG`, `GROUP`, or `USER`.
|
|
397
|
-
* Accepted values are:
|
|
398
|
-
*
|
|
399
|
-
* | Project roles | Organization roles |
|
|
400
|
-
* |:---------- |:----------- |
|
|
401
|
-
* | `GROUP_CHARTS_ADMIN` | `ORG_OWNER` |
|
|
402
|
-
* | `GROUP_CLUSTER_MANAGER` | `ORG_MEMBER` |
|
|
403
|
-
* | `GROUP_DATA_ACCESS_ADMIN` | `ORG_GROUP_CREATOR` |
|
|
404
|
-
* | `GROUP_DATA_ACCESS_READ_ONLY` | `ORG_BILLING_ADMIN` |
|
|
405
|
-
* | `GROUP_DATA_ACCESS_READ_WRITE` | `ORG_READ_ONLY` |
|
|
406
|
-
* | `GROUP_OWNER` | |
|
|
407
|
-
* | `GROUP_READ_ONLY` | |
|
|
408
|
-
*/
|
|
409
275
|
roles?: string[];
|
|
410
|
-
/**
|
|
411
|
-
* PagerDuty service key. Required for the PAGER_DUTY notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.
|
|
412
|
-
*/
|
|
413
276
|
serviceKey?: string;
|
|
414
|
-
/**
|
|
415
|
-
* Flag indicating if text message notifications should be sent to this user's mobile phone. This flag is only valid if `typeName` is set to `ORG`, `GROUP`, or `USER`.
|
|
416
|
-
*/
|
|
417
277
|
smsEnabled: boolean;
|
|
418
|
-
/**
|
|
419
|
-
* Unique identifier of a team.
|
|
420
|
-
*/
|
|
421
278
|
teamId?: string;
|
|
422
|
-
/**
|
|
423
|
-
* Label for the team that receives this notification.
|
|
424
|
-
*/
|
|
425
279
|
teamName: string;
|
|
426
|
-
/**
|
|
427
|
-
* Type of alert notification.
|
|
428
|
-
* Accepted values are:
|
|
429
|
-
*/
|
|
430
280
|
typeName: string;
|
|
431
|
-
/**
|
|
432
|
-
* Name of the Atlas user to which to send notifications. Only a user in the project that owns the alert configuration is allowed here. Required for the `USER` notifications type.
|
|
433
|
-
*/
|
|
434
281
|
username?: string;
|
|
435
|
-
/**
|
|
436
|
-
* VictorOps API key. Required for the `VICTOR_OPS` notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.
|
|
437
|
-
*/
|
|
438
282
|
victorOpsApiKey?: string;
|
|
439
|
-
/**
|
|
440
|
-
* VictorOps routing key. Optional for the `VICTOR_OPS` notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.
|
|
441
|
-
*/
|
|
442
283
|
victorOpsRoutingKey?: string;
|
|
443
|
-
/**
|
|
444
|
-
* Optional authentication secret for the `WEBHOOK` notifications type.
|
|
445
|
-
*/
|
|
446
284
|
webhookSecret?: string;
|
|
447
|
-
/**
|
|
448
|
-
* Target URL for the `WEBHOOK` notifications type.
|
|
449
|
-
*/
|
|
450
285
|
webhookUrl?: string;
|
|
451
286
|
}
|
|
452
287
|
export interface AlertConfigurationThresholdConfig {
|
|
453
|
-
/**
|
|
454
|
-
* The operator to test the field’s value.
|
|
455
|
-
* Accepted values are:
|
|
456
|
-
*/
|
|
457
288
|
operator?: string;
|
|
458
|
-
/**
|
|
459
|
-
* Threshold value outside of which an alert will be triggered.
|
|
460
|
-
*/
|
|
461
289
|
threshold: number;
|
|
462
|
-
/**
|
|
463
|
-
* The units for the threshold value. Depends on the type of metric.
|
|
464
|
-
* Refer to the [MongoDB API Alert Configuration documentation](https://www.mongodb.com/docs/atlas/reference/api/alert-configurations-get-config/#request-body-parameters) for a list of accepted values.
|
|
465
|
-
*/
|
|
466
290
|
units?: string;
|
|
467
291
|
}
|
|
468
292
|
export interface BackupCompliancePolicyOnDemandPolicyItem {
|
|
@@ -576,25 +400,10 @@ export interface BackupCompliancePolicyPolicyItemWeekly {
|
|
|
576
400
|
retentionValue: number;
|
|
577
401
|
}
|
|
578
402
|
export interface CloudBackupScheduleCopySetting {
|
|
579
|
-
/**
|
|
580
|
-
* Human-readable label that identifies the cloud provider that stores the snapshot copy. i.e. "AWS" "AZURE" "GCP"
|
|
581
|
-
*/
|
|
582
403
|
cloudProvider: string;
|
|
583
|
-
/**
|
|
584
|
-
* List that describes which types of snapshots to copy. i.e. "HOURLY" "DAILY" "WEEKLY" "MONTHLY" "ON_DEMAND"
|
|
585
|
-
*/
|
|
586
404
|
frequencies: string[];
|
|
587
|
-
/**
|
|
588
|
-
* Target region to copy snapshots belonging to replicationSpecId to. Please supply the 'Atlas Region' which can be found under https://www.mongodb.com/docs/atlas/reference/cloud-providers/ 'regions' link
|
|
589
|
-
*/
|
|
590
405
|
regionName: string;
|
|
591
|
-
/**
|
|
592
|
-
* Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Replication Spec Id, consult the replicationSpecs array returned from [Return One Multi-Cloud Cluster in One Project](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getCluster).
|
|
593
|
-
*/
|
|
594
406
|
replicationSpecId: string;
|
|
595
|
-
/**
|
|
596
|
-
* Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores.
|
|
597
|
-
*/
|
|
598
407
|
shouldCopyOplogs: boolean;
|
|
599
408
|
}
|
|
600
409
|
export interface CloudBackupScheduleExport {
|
|
@@ -769,73 +578,20 @@ export interface CloudProviderAccessSetupAzureConfig {
|
|
|
769
578
|
tenantId: string;
|
|
770
579
|
}
|
|
771
580
|
export interface ClusterAdvancedConfiguration {
|
|
772
|
-
/**
|
|
773
|
-
* [Default level of acknowledgment requested from MongoDB for read operations](https://docs.mongodb.com/manual/reference/read-concern/) set for this cluster. MongoDB 4.4 clusters default to [available](https://docs.mongodb.com/manual/reference/read-concern-available/).
|
|
774
|
-
*/
|
|
775
581
|
defaultReadConcern: string;
|
|
776
|
-
/**
|
|
777
|
-
* [Default level of acknowledgment requested from MongoDB for write operations](https://docs.mongodb.com/manual/reference/write-concern/) set for this cluster. MongoDB 4.4 clusters default to [1](https://docs.mongodb.com/manual/reference/write-concern/).
|
|
778
|
-
*/
|
|
779
582
|
defaultWriteConcern: string;
|
|
780
|
-
/**
|
|
781
|
-
* When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.
|
|
782
|
-
*/
|
|
783
583
|
failIndexKeyTooLong: boolean;
|
|
784
|
-
/**
|
|
785
|
-
* When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.
|
|
786
|
-
*/
|
|
787
584
|
javascriptEnabled: boolean;
|
|
788
|
-
/**
|
|
789
|
-
* Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:
|
|
790
|
-
*
|
|
791
|
-
* - TLS1_0
|
|
792
|
-
* - TLS1_1
|
|
793
|
-
* - TLS1_2
|
|
794
|
-
*/
|
|
795
585
|
minimumEnabledTlsProtocol: string;
|
|
796
|
-
/**
|
|
797
|
-
* When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.
|
|
798
|
-
*/
|
|
799
586
|
noTableScan: boolean;
|
|
800
|
-
/**
|
|
801
|
-
* Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
|
|
802
|
-
* * **Note** A minimum oplog retention is required when seeking to change a cluster's class to Local NVMe SSD. To learn more and for latest guidance see [`oplogMinRetentionHours`](https://www.mongodb.com/docs/manual/core/replica-set-oplog/#std-label-replica-set-minimum-oplog-size)
|
|
803
|
-
*/
|
|
804
587
|
oplogMinRetentionHours?: number;
|
|
805
|
-
/**
|
|
806
|
-
* The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.
|
|
807
|
-
*/
|
|
808
588
|
oplogSizeMb: number;
|
|
809
|
-
/**
|
|
810
|
-
* Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
|
|
811
|
-
*/
|
|
812
589
|
sampleRefreshIntervalBiConnector: number;
|
|
813
|
-
/**
|
|
814
|
-
* Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
|
|
815
|
-
*/
|
|
816
590
|
sampleSizeBiConnector: number;
|
|
817
|
-
/**
|
|
818
|
-
* Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.
|
|
819
|
-
*/
|
|
820
591
|
transactionLifetimeLimitSeconds: number;
|
|
821
592
|
}
|
|
822
593
|
export interface ClusterBiConnectorConfig {
|
|
823
|
-
/**
|
|
824
|
-
* Specifies whether or not BI Connector for Atlas is enabled on the cluster.l
|
|
825
|
-
* *
|
|
826
|
-
* - Set to `true` to enable BI Connector for Atlas.
|
|
827
|
-
* - Set to `false` to disable BI Connector for Atlas.
|
|
828
|
-
*/
|
|
829
594
|
enabled: boolean;
|
|
830
|
-
/**
|
|
831
|
-
* Specifies the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of [readPreference](https://docs.mongodb.com/manual/core/read-preference/) and [readPreferenceTags](https://docs.mongodb.com/manual/core/read-preference/#tag-sets) options. For details on BI Connector for Atlas read preferences, refer to the [BI Connector Read Preferences Table](https://docs.atlas.mongodb.com/tutorial/create-global-writes-cluster/#bic-read-preferences).
|
|
832
|
-
*
|
|
833
|
-
* - Set to "primary" to have BI Connector for Atlas read from the primary.
|
|
834
|
-
*
|
|
835
|
-
* - Set to "secondary" to have BI Connector for Atlas read from a secondary member. Default if there are no analytics nodes in the cluster.
|
|
836
|
-
*
|
|
837
|
-
* - Set to "analytics" to have BI Connector for Atlas read from an analytics node. Default if the cluster contains analytics nodes.
|
|
838
|
-
*/
|
|
839
595
|
readPreference: string;
|
|
840
596
|
}
|
|
841
597
|
export interface ClusterConnectionString {
|
|
@@ -912,52 +668,19 @@ export interface ClusterOutageSimulationOutageFilter {
|
|
|
912
668
|
type: string;
|
|
913
669
|
}
|
|
914
670
|
export interface ClusterReplicationSpec {
|
|
915
|
-
/**
|
|
916
|
-
* Unique identifer of the replication document for a zone in a Global Cluster.
|
|
917
|
-
*/
|
|
918
671
|
id: string;
|
|
919
672
|
/**
|
|
920
673
|
* Selects whether the cluster is a replica set or a sharded cluster. If you use the replicationSpecs parameter, you must set num_shards.
|
|
921
674
|
*/
|
|
922
675
|
numShards: number;
|
|
923
|
-
/**
|
|
924
|
-
* Physical location of the region. Each regionsConfig document describes the region’s priority in elections and the number and type of MongoDB nodes Atlas deploys to the region. You must order each regionsConfigs document by regionsConfig.priority, descending. See Region Config below for more details.
|
|
925
|
-
*/
|
|
926
676
|
regionsConfigs: outputs.ClusterReplicationSpecRegionsConfig[];
|
|
927
|
-
/**
|
|
928
|
-
* Name for the zone in a Global Cluster.
|
|
929
|
-
*
|
|
930
|
-
*
|
|
931
|
-
* **Region Config**
|
|
932
|
-
*/
|
|
933
677
|
zoneName?: string;
|
|
934
678
|
}
|
|
935
679
|
export interface ClusterReplicationSpecRegionsConfig {
|
|
936
|
-
/**
|
|
937
|
-
* The number of analytics nodes for Atlas to deploy to the region. Analytics nodes are useful for handling analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only, and can never become the primary. If you do not specify this option, no analytics nodes are deployed to the region.
|
|
938
|
-
*/
|
|
939
680
|
analyticsNodes?: number;
|
|
940
|
-
/**
|
|
941
|
-
* Number of electable nodes for Atlas to deploy to the region. Electable nodes can become the primary and can facilitate local reads.
|
|
942
|
-
* * The total number of electableNodes across all replication spec regions must total 3, 5, or 7.
|
|
943
|
-
* * Specify 0 if you do not want any electable nodes in the region.
|
|
944
|
-
* * You cannot create electable nodes in a region if `priority` is 0.
|
|
945
|
-
*/
|
|
946
681
|
electableNodes: number;
|
|
947
|
-
/**
|
|
948
|
-
* Election priority of the region. For regions with only read-only nodes, set this value to 0.
|
|
949
|
-
* * For regions where `electableNodes` is at least 1, each region must have a priority of exactly one (1) less than the previous region. The first region must have a priority of 7. The lowest possible priority is 1.
|
|
950
|
-
* * The priority 7 region identifies the Preferred Region of the cluster. Atlas places the primary node in the Preferred Region. Priorities 1 through 7 are exclusive - no more than one region per cluster can be assigned a given priority.
|
|
951
|
-
* * Example: If you have three regions, their priorities would be 7, 6, and 5 respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be 4 and 3 respectively.
|
|
952
|
-
*/
|
|
953
682
|
priority: number;
|
|
954
|
-
/**
|
|
955
|
-
* Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can facilitate local-reads. Specify 0 if you do not want any read-only nodes in the region.
|
|
956
|
-
*/
|
|
957
683
|
readOnlyNodes?: number;
|
|
958
|
-
/**
|
|
959
|
-
* Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the **Atlas region name**, see the reference list for [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).
|
|
960
|
-
*/
|
|
961
684
|
regionName: string;
|
|
962
685
|
}
|
|
963
686
|
export interface ClusterSnapshotBackupPolicy {
|
|
@@ -974,18 +697,12 @@ export interface ClusterSnapshotBackupPolicy {
|
|
|
974
697
|
updateSnapshots: boolean;
|
|
975
698
|
}
|
|
976
699
|
export interface ClusterSnapshotBackupPolicyPolicy {
|
|
977
|
-
/**
|
|
978
|
-
* Unique identifer of the replication document for a zone in a Global Cluster.
|
|
979
|
-
*/
|
|
980
700
|
id: string;
|
|
981
701
|
policyItems: outputs.ClusterSnapshotBackupPolicyPolicyPolicyItem[];
|
|
982
702
|
}
|
|
983
703
|
export interface ClusterSnapshotBackupPolicyPolicyPolicyItem {
|
|
984
704
|
frequencyInterval: number;
|
|
985
705
|
frequencyType: string;
|
|
986
|
-
/**
|
|
987
|
-
* Unique identifer of the replication document for a zone in a Global Cluster.
|
|
988
|
-
*/
|
|
989
706
|
id: string;
|
|
990
707
|
retentionUnit: string;
|
|
991
708
|
retentionValue: number;
|
|
@@ -1028,11 +745,6 @@ export interface CustomDbRoleAction {
|
|
|
1028
745
|
export interface CustomDbRoleActionResource {
|
|
1029
746
|
cluster?: boolean;
|
|
1030
747
|
collectionName?: string;
|
|
1031
|
-
/**
|
|
1032
|
-
* Database on which the inherited role is granted.
|
|
1033
|
-
*
|
|
1034
|
-
* > **NOTE** This value should be admin for all roles except read and readWrite.
|
|
1035
|
-
*/
|
|
1036
748
|
databaseName?: string;
|
|
1037
749
|
}
|
|
1038
750
|
export interface CustomDbRoleInheritedRole {
|
|
@@ -1269,23 +981,13 @@ export interface FederatedDatabaseInstanceCloudProviderConfigAws {
|
|
|
1269
981
|
*/
|
|
1270
982
|
iamUserArn: string;
|
|
1271
983
|
/**
|
|
1272
|
-
* Unique identifier of the role that the
|
|
984
|
+
* Unique identifier of the role that the data lake can use to access the data stores.
|
|
1273
985
|
*/
|
|
1274
986
|
roleId: string;
|
|
1275
|
-
/**
|
|
1276
|
-
* Name of the S3 data bucket that the provided role ID is authorized to access. You must also specify the `roleId`.
|
|
1277
|
-
* ### `dataProcessRegion` - (Optional) The cloud provider region to which the Federated Instance routes client connections for data processing.
|
|
1278
|
-
*/
|
|
1279
987
|
testS3Bucket: string;
|
|
1280
988
|
}
|
|
1281
989
|
export interface FederatedDatabaseInstanceDataProcessRegion {
|
|
1282
|
-
/**
|
|
1283
|
-
* Name of the cloud service provider. Atlas Federated Database only supports AWS.
|
|
1284
|
-
*/
|
|
1285
990
|
cloudProvider: string;
|
|
1286
|
-
/**
|
|
1287
|
-
* Name of the region to which the Federanted Instnace routes client connections for data processing. See the [documention](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Data-Federation/operation/createFederatedDatabase) for the available region.
|
|
1288
|
-
*/
|
|
1289
991
|
region: string;
|
|
1290
992
|
}
|
|
1291
993
|
export interface FederatedDatabaseInstanceStorageDatabase {
|
|
@@ -1357,9 +1059,6 @@ export interface FederatedDatabaseInstanceStorageStore {
|
|
|
1357
1059
|
provider: string;
|
|
1358
1060
|
public: string;
|
|
1359
1061
|
readPreference: outputs.FederatedDatabaseInstanceStorageStoreReadPreference;
|
|
1360
|
-
/**
|
|
1361
|
-
* Name of the region to which the Federanted Instnace routes client connections for data processing. See the [documention](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Data-Federation/operation/createFederatedDatabase) for the available region.
|
|
1362
|
-
*/
|
|
1363
1062
|
region: string;
|
|
1364
1063
|
urls: string[];
|
|
1365
1064
|
}
|
|
@@ -1404,14 +1103,8 @@ export interface Get509AuthenticationDatabaseUserCertificate {
|
|
|
1404
1103
|
}
|
|
1405
1104
|
export interface GetAccessListApiKeysResult {
|
|
1406
1105
|
accessCount: number;
|
|
1407
|
-
/**
|
|
1408
|
-
* Range of IP addresses in CIDR notation to be added to the access list.
|
|
1409
|
-
*/
|
|
1410
1106
|
cidrBlock: string;
|
|
1411
1107
|
created: string;
|
|
1412
|
-
/**
|
|
1413
|
-
* Single IP address to be added to the access list.
|
|
1414
|
-
*/
|
|
1415
1108
|
ipAddress: string;
|
|
1416
1109
|
lastUsed: string;
|
|
1417
1110
|
lastUsedAddress: string;
|
|
@@ -2420,20 +2113,9 @@ export interface GetAlertConfigurationsResultThresholdConfig {
|
|
|
2420
2113
|
units: string;
|
|
2421
2114
|
}
|
|
2422
2115
|
export interface GetApiKeysResult {
|
|
2423
|
-
/**
|
|
2424
|
-
* Unique identifier for the API key you want to update. Use the /orgs/{ORG-ID}/apiKeys endpoint to retrieve all API keys to which the authenticated user has access for the specified organization.
|
|
2425
|
-
*/
|
|
2426
2116
|
apiKeyId: string;
|
|
2427
|
-
/**
|
|
2428
|
-
* Description of this Organization API key.
|
|
2429
|
-
*/
|
|
2430
2117
|
description: string;
|
|
2431
2118
|
publicKey: string;
|
|
2432
|
-
/**
|
|
2433
|
-
* Name of the role. This resource returns all the roles the user has in Atlas.
|
|
2434
|
-
*
|
|
2435
|
-
* The following are valid roles:
|
|
2436
|
-
*/
|
|
2437
2119
|
roleNames: string[];
|
|
2438
2120
|
}
|
|
2439
2121
|
export interface GetAtlasUserLink {
|
|
@@ -3975,7 +3657,13 @@ export interface GetEventTriggerEventProcessor {
|
|
|
3975
3657
|
awsEventbridges: outputs.GetEventTriggerEventProcessorAwsEventbridge[];
|
|
3976
3658
|
}
|
|
3977
3659
|
export interface GetEventTriggerEventProcessorAwsEventbridge {
|
|
3660
|
+
/**
|
|
3661
|
+
* AWS Account ID.
|
|
3662
|
+
*/
|
|
3978
3663
|
configAccountId: string;
|
|
3664
|
+
/**
|
|
3665
|
+
* Region of AWS Account.
|
|
3666
|
+
*/
|
|
3979
3667
|
configRegion: string;
|
|
3980
3668
|
}
|
|
3981
3669
|
export interface GetEventTriggersResult {
|
|
@@ -4055,7 +3743,13 @@ export interface GetEventTriggersResultEventProcessor {
|
|
|
4055
3743
|
awsEventbridges: outputs.GetEventTriggersResultEventProcessorAwsEventbridge[];
|
|
4056
3744
|
}
|
|
4057
3745
|
export interface GetEventTriggersResultEventProcessorAwsEventbridge {
|
|
3746
|
+
/**
|
|
3747
|
+
* AWS Account ID.
|
|
3748
|
+
*/
|
|
4058
3749
|
configAccountId: string;
|
|
3750
|
+
/**
|
|
3751
|
+
* Region of AWS Account.
|
|
3752
|
+
*/
|
|
4059
3753
|
configRegion: string;
|
|
4060
3754
|
}
|
|
4061
3755
|
export interface GetFederatedDatabaseInstanceCloudProviderConfig {
|
|
@@ -5050,32 +4744,15 @@ export interface GetOrganizationLink {
|
|
|
5050
4744
|
rel: string;
|
|
5051
4745
|
}
|
|
5052
4746
|
export interface GetOrganizationsResult {
|
|
5053
|
-
/**
|
|
5054
|
-
* Flag that indicates whether to require API operations to originate from an IP Address added to the API access list for the specified organization.
|
|
5055
|
-
*/
|
|
5056
4747
|
apiAccessListRequired: boolean;
|
|
5057
4748
|
/**
|
|
5058
4749
|
* Autogenerated Unique ID for this data source.
|
|
5059
4750
|
*/
|
|
5060
4751
|
id: string;
|
|
5061
|
-
/**
|
|
5062
|
-
* Flag that indicates whether this organization has been deleted.
|
|
5063
|
-
*/
|
|
5064
4752
|
isDeleted: boolean;
|
|
5065
4753
|
links: outputs.GetOrganizationsResultLink[];
|
|
5066
|
-
/**
|
|
5067
|
-
* Flag that indicates whether to require users to set up Multi-Factor Authentication (MFA) before accessing the specified organization. To learn more, see: https://www.mongodb.com/docs/atlas/security-multi-factor-authentication/.
|
|
5068
|
-
*/
|
|
5069
4754
|
multiFactorAuthRequired: boolean;
|
|
5070
|
-
/**
|
|
5071
|
-
* Human-readable label that identifies the organization.
|
|
5072
|
-
*/
|
|
5073
4755
|
name: string;
|
|
5074
|
-
/**
|
|
5075
|
-
* Flag that indicates whether to block MongoDB Support from accessing Atlas infrastructure for any deployment in the specified organization without explicit permission. Once this setting is turned on, you can grant MongoDB Support a 24-hour bypass access to the Atlas deployment to resolve support issues. To learn more, see: https://www.mongodb.com/docs/atlas/security-restrict-support-access/.
|
|
5076
|
-
*
|
|
5077
|
-
* See [MongoDB Atlas API - Organizations](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Organizations/operation/listOrganizations) Documentation for more information.
|
|
5078
|
-
*/
|
|
5079
4756
|
restrictEmployeeAccess: boolean;
|
|
5080
4757
|
}
|
|
5081
4758
|
export interface GetOrganizationsResultLink {
|
|
@@ -5236,66 +4913,24 @@ export interface GetProjectTeam {
|
|
|
5236
4913
|
teamId: string;
|
|
5237
4914
|
}
|
|
5238
4915
|
export interface GetProjectsResult {
|
|
5239
|
-
/**
|
|
5240
|
-
* The number of Atlas clusters deployed in the project.
|
|
5241
|
-
*/
|
|
5242
4916
|
clusterCount: number;
|
|
5243
|
-
/**
|
|
5244
|
-
* The ISO-8601-formatted timestamp of when Atlas created the project.
|
|
5245
|
-
*/
|
|
5246
4917
|
created: string;
|
|
5247
4918
|
/**
|
|
5248
4919
|
* Autogenerated Unique ID for this data source.
|
|
5249
4920
|
*/
|
|
5250
4921
|
id: string;
|
|
5251
|
-
/**
|
|
5252
|
-
* IP addresses in a project categorized by services. See IP Addresses.
|
|
5253
|
-
*/
|
|
5254
4922
|
ipAddresses: outputs.GetProjectsResultIpAddresses;
|
|
5255
|
-
/**
|
|
5256
|
-
* Flag that indicates whether to enable statistics in [cluster metrics](https://www.mongodb.com/docs/atlas/monitor-cluster-metrics/) collection for the project.
|
|
5257
|
-
*/
|
|
5258
4923
|
isCollectDatabaseSpecificsStatisticsEnabled: boolean;
|
|
5259
|
-
/**
|
|
5260
|
-
* Flag that indicates whether to enable Data Explorer for the project. If enabled, you can query your database with an easy to use interface.
|
|
5261
|
-
*/
|
|
5262
4924
|
isDataExplorerEnabled: boolean;
|
|
5263
|
-
/**
|
|
5264
|
-
* Flag that indicates whether to enable extended storage sizes for the specified project.
|
|
5265
|
-
*/
|
|
5266
4925
|
isExtendedStorageSizesEnabled: boolean;
|
|
5267
|
-
/**
|
|
5268
|
-
* Flag that indicates whether to enable Performance Advisor and Profiler for the project. If enabled, you can analyze database logs to recommend performance improvements.
|
|
5269
|
-
*/
|
|
5270
4926
|
isPerformanceAdvisorEnabled: boolean;
|
|
5271
|
-
/**
|
|
5272
|
-
* Flag that indicates whether to enable Real Time Performance Panel for the project. If enabled, you can see real time metrics from your MongoDB database.
|
|
5273
|
-
*/
|
|
5274
4927
|
isRealtimePerformancePanelEnabled: boolean;
|
|
5275
|
-
/**
|
|
5276
|
-
* Flag that indicates whether to enable Schema Advisor for the project. If enabled, you receive customized recommendations to optimize your data model and enhance performance. Disable this setting to disable schema suggestions in the [Performance Advisor](https://www.mongodb.com/docs/atlas/performance-advisor/#std-label-performance-advisor) and the [Data Explorer](https://www.mongodb.com/docs/atlas/atlas-ui/#std-label-atlas-ui).
|
|
5277
|
-
*/
|
|
5278
4928
|
isSchemaAdvisorEnabled: boolean;
|
|
5279
|
-
/**
|
|
5280
|
-
* The limits for the specified project. See Limits.
|
|
5281
|
-
*/
|
|
5282
4929
|
limits: outputs.GetProjectsResultLimit[];
|
|
5283
|
-
/**
|
|
5284
|
-
* Human-readable label that identifies this project limit.
|
|
5285
|
-
*/
|
|
5286
4930
|
name: string;
|
|
5287
|
-
/**
|
|
5288
|
-
* The ID of the organization you want to create the project within.
|
|
5289
|
-
*/
|
|
5290
4931
|
orgId: string;
|
|
5291
4932
|
projectId: string;
|
|
5292
|
-
/**
|
|
5293
|
-
* If GOV_REGIONS_ONLY the project can be used for government regions only, otherwise defaults to standard regions. For more information see [MongoDB Atlas for Government](https://www.mongodb.com/docs/atlas/government/api/#creating-a-project).
|
|
5294
|
-
*/
|
|
5295
4933
|
regionUsageRestrictions: string;
|
|
5296
|
-
/**
|
|
5297
|
-
* Returns all teams to which the authenticated user has access in the project. See Teams.
|
|
5298
|
-
*/
|
|
5299
4934
|
teams: outputs.GetProjectsResultTeam[];
|
|
5300
4935
|
}
|
|
5301
4936
|
export interface GetProjectsResultIpAddresses {
|
|
@@ -5598,35 +5233,14 @@ export interface GetX509AuthenticationDatabaseUserCertificate {
|
|
|
5598
5233
|
subject: string;
|
|
5599
5234
|
}
|
|
5600
5235
|
export interface GlobalClusterConfigCustomZoneMapping {
|
|
5601
|
-
/**
|
|
5602
|
-
* The ISO location code to which you want to map a zone in your Global Cluster. You can find a list of all supported location codes [here](https://cloud.mongodb.com/static/atlas/country_iso_codes.txt).
|
|
5603
|
-
*/
|
|
5604
5236
|
location: string;
|
|
5605
|
-
/**
|
|
5606
|
-
* The name of the zone in your Global Cluster that you want to map to location.
|
|
5607
|
-
*/
|
|
5608
5237
|
zone: string;
|
|
5609
5238
|
}
|
|
5610
5239
|
export interface GlobalClusterConfigManagedNamespace {
|
|
5611
|
-
/**
|
|
5612
|
-
* The name of the collection associated with the managed namespace.
|
|
5613
|
-
*/
|
|
5614
5240
|
collection: string;
|
|
5615
|
-
/**
|
|
5616
|
-
* The custom shard key for the collection. Global Clusters require a compound shard key consisting of a location field and a user-selected second key, the custom shard key.
|
|
5617
|
-
*/
|
|
5618
5241
|
customShardKey: string;
|
|
5619
|
-
/**
|
|
5620
|
-
* The name of the database containing the collection.
|
|
5621
|
-
*/
|
|
5622
5242
|
db: string;
|
|
5623
|
-
/**
|
|
5624
|
-
* Specifies whether the custom shard key for the collection is [hashed](https://docs.mongodb.com/manual/reference/method/sh.shardCollection/#hashed-shard-keys). If omitted, defaults to `false`. If `false`, Atlas uses [ranged sharding](https://docs.mongodb.com/manual/core/ranged-sharding/). This is only available for Atlas clusters with MongoDB v4.4 and later.
|
|
5625
|
-
*/
|
|
5626
5243
|
isCustomShardKeyHashed: boolean;
|
|
5627
|
-
/**
|
|
5628
|
-
* Specifies whether the underlying index enforces a unique constraint. If omitted, defaults to false. You cannot specify true when using [hashed shard keys](https://docs.mongodb.com/manual/core/hashed-sharding/#std-label-sharding-hashed).
|
|
5629
|
-
*/
|
|
5630
5244
|
isShardKeyUnique: boolean;
|
|
5631
5245
|
}
|
|
5632
5246
|
export interface LdapConfigurationUserToDnMapping {
|
|
@@ -5690,17 +5304,8 @@ export interface OnlineArchiveDataProcessRegion {
|
|
|
5690
5304
|
region: string;
|
|
5691
5305
|
}
|
|
5692
5306
|
export interface OnlineArchivePartitionField {
|
|
5693
|
-
/**
|
|
5694
|
-
* Human-readable label that identifies the parameter that MongoDB Cloud uses to partition data. To specify a nested parameter, use the dot notation.
|
|
5695
|
-
*/
|
|
5696
5307
|
fieldName: string;
|
|
5697
|
-
/**
|
|
5698
|
-
* Data type of the parameter that that MongoDB Cloud uses to partition data. Partition parameters of type UUID must be of binary subtype 4. MongoDB Cloud skips partition parameters of type UUID with subtype 3. Valid values: `date`, `int`, `long`, `objectId`, `string`, `uuid`.
|
|
5699
|
-
*/
|
|
5700
5308
|
fieldType: string;
|
|
5701
|
-
/**
|
|
5702
|
-
* Sequence in which MongoDB Cloud slices the collection data to create partitions. The resource expresses this sequence starting with zero. The value of the `criteria.dateField` parameter defaults as the first item in the partition sequence.
|
|
5703
|
-
*/
|
|
5704
5309
|
order: number;
|
|
5705
5310
|
}
|
|
5706
5311
|
export interface OnlineArchiveSchedule {
|