@pulumi/mongodbatlas 3.16.3 → 3.16.4-alpha.1722019657

package/types/output.d.ts

@@ -1,15 +1,53 @@
 import * as outputs from "../types/output";
 export interface AdvancedClusterAdvancedConfiguration {
+    /**
+     * [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/).
+     */
     defaultReadConcern: string;
+    /**
+     * [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/).
+     */
     defaultWriteConcern: string;
+    /**
+     * 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.
+     */
     failIndexKeyTooLong: boolean;
+    /**
+     * When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.
+     */
     javascriptEnabled: boolean;
+    /**
+     * Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:
+     *
+     * - TLS1_0
+     * - TLS1_1
+     * - TLS1_2
+     */
     minimumEnabledTlsProtocol: string;
+    /**
+     * 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.
+     */
     noTableScan: boolean;
+    /**
+     * 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.
+     * * **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)
+     */
     oplogMinRetentionHours?: number;
+    /**
+     * The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.
+     */
     oplogSizeMb: number;
+    /**
+     * 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.
+     */
     sampleRefreshIntervalBiConnector: number;
+    /**
+     * 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.
+     */
     sampleSizeBiConnector: number;
+    /**
+     * Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.
+     */
     transactionLifetimeLimitSeconds: number;
 }
 export interface AdvancedClusterBiConnectorConfig {
@@ -70,6 +108,15 @@ export interface AdvancedClusterConnectionStringPrivateEndpoint {
 }
 export interface AdvancedClusterConnectionStringPrivateEndpointEndpoint {
     endpointId: string;
+    /**
+     * Cloud service provider on which the servers are provisioned.
+     * The possible values are:
+     *
+     * - `AWS` - Amazon AWS
+     * - `GCP` - Google Cloud Platform
+     * - `AZURE` - Microsoft Azure
+     * - `TENANT` - M2 or M5 multi-tenant cluster. Use `replication_specs.#.region_configs.#.backing_provider_name` to set the cloud service provider.
+     */
     providerName: string;
     region: string;
 }
@@ -258,42 +305,170 @@ export interface AdvancedClusterTag {
     value: string;
 }
 export interface AlertConfigurationMatcher {
+    /**
+     * Name of the field in the target object to match on.
+     *
+     * | Host alerts         | Replica set alerts  |  Sharded cluster alerts |
+     * |:----------           |:-------------       |:------                 |
+     * | `TYPE_NAME`         | `REPLICA_SET_NAME`  | `CLUSTER_NAME`          |
+     * | `HOSTNAME`          | `SHARD_NAME`        | `SHARD_NAME`            |
+     * | `PORT`              | `CLUSTER_NAME`      |                         |
+     * | `HOSTNAME_AND_PORT` |                     |                         |
+     * | `REPLICA_SET_NAME`  |                     |                         |
+     *
+     *
+     *
+     * All other types of alerts do not support matchers.
+     */
     fieldName: string;
     operator: string;
+    /**
+     * Value to test with the specified operator. If `fieldName` is set to TYPE_NAME, you can match on the following values:
+     * - `PRIMARY`
+     * - `SECONDARY`
+     * - `STANDALONE`
+     * - `CONFIG`
+     * - `MONGOS`
+     */
     value: string;
 }
 export interface AlertConfigurationMetricThresholdConfig {
+    /**
+     * 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)
+     */
     metricName: string;
+    /**
+     * This must be set to AVERAGE. Atlas computes the current metric value as an average.
+     */
     mode?: string;
     operator?: string;
     threshold: number;
     units?: string;
 }
 export interface AlertConfigurationNotification {
+    /**
+     * 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.
+     */
     apiToken?: string;
+    /**
+     * Slack channel name. Required for the SLACK notifications type.
+     */
     channelName?: string;
+    /**
+     * Datadog API Key. Found in the Datadog dashboard. Required for the DATADOG notifications type.
+     */
     datadogApiKey?: string;
+    /**
+     * 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.
+     */
     datadogRegion?: string;
+    /**
+     * Number of minutes to wait after an alert condition is detected before sending out the first notification.
+     */
     delayMin: number;
+    /**
+     * Email address to which alert notifications are sent. Required for the EMAIL notifications type.
+     */
     emailAddress?: string;
+    /**
+     * Flag indicating email notifications should be sent. This flag is only valid if `typeName` is set to `ORG`, `GROUP`, or `USER`.
+     */
     emailEnabled: boolean;
+    /**
+     * The ID of the associated integration, the credentials of which to use for requests.
+     */
     integrationId?: string;
+    /**
+     * 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.
+     */
     intervalMin: number;
+    /**
+     * 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.
+     */
     microsoftTeamsWebhookUrl?: string;
+    /**
+     * Mobile number to which alert notifications are sent. Required for the SMS notifications type.
+     */
     mobileNumber?: string;
+    /**
+     * 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.
+     */
     notifierId: string;
+    /**
+     * 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.
+     */
     opsGenieApiKey?: string;
+    /**
+     * Region that indicates which API URL to use. Accepted regions are: `US` ,`EU`. The default Opsgenie region is US.
+     */
     opsGenieRegion?: string;
+    /**
+     * 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`.
+     * Accepted values are:
+     *
+     * | Project roles                   | Organization roles  |
+     * |:----------                      |:-----------         |
+     * | `GROUP_CLUSTER_MANAGER`         | `ORG_OWNER`         |
+     * | `GROUP_DATA_ACCESS_ADMIN`       | `ORG_MEMBER`        |
+     * | `GROUP_DATA_ACCESS_READ_ONLY`   | `ORG_GROUP_CREATOR` |
+     * | `GROUP_DATA_ACCESS_READ_WRITE`  | `ORG_BILLING_ADMIN` |
+     * | `GROUP_OWNER`                   | `ORG_READ_ONLY`     |
+     * | `GROUP_READ_ONLY`               |                     |
+     */
     roles?: string[];
+    /**
+     * 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.
+     */
     serviceKey?: string;
+    /**
+     * 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`.
+     */
     smsEnabled: boolean;
+    /**
+     * Unique identifier of a team.
+     */
     teamId?: string;
+    /**
+     * Label for the team that receives this notification.
+     */
     teamName: string;
+    /**
+     * Type of alert notification.
+     * Accepted values are:
+     * - `DATADOG`
+     * - `EMAIL`
+     * - `GROUP` (Project)
+     * - `OPS_GENIE`
+     * - `ORG`
+     * - `PAGER_DUTY`
+     * - `SLACK`
+     * - `SMS`
+     * - `TEAM`
+     * - `USER`
+     * - `VICTOR_OPS`
+     * - `WEBHOOK`
+     * - `MICROSOFT_TEAMS`
+     */
     typeName: string;
+    /**
+     * 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.
+     */
     username?: string;
+    /**
+     * 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.
+     */
     victorOpsApiKey?: string;
+    /**
+     * 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.
+     */
     victorOpsRoutingKey?: string;
+    /**
+     * Optional authentication secret for the `WEBHOOK` notifications type.
+     */
     webhookSecret?: string;
+    /**
+     * Target URL  for the `WEBHOOK` notifications type.
+     */
     webhookUrl?: string;
 }
 export interface AlertConfigurationThresholdConfig {
@@ -434,10 +609,25 @@ export interface BackupCompliancePolicyPolicyItemYearly {
     retentionValue: number;
 }
 export interface CloudBackupScheduleCopySetting {
+    /**
+     * Human-readable label that identifies the cloud provider that stores the snapshot copy. i.e. "AWS" "AZURE" "GCP"
+     */
     cloudProvider: string;
+    /**
+     * List that describes which types of snapshots to copy. i.e. "HOURLY" "DAILY" "WEEKLY" "MONTHLY" "ON_DEMAND"
+     */
     frequencies: string[];
+    /**
+     * 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
+     */
     regionName: string;
+    /**
+     * 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).
+     */
     replicationSpecId: string;
+    /**
+     * Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores.
+     */
     shouldCopyOplogs: boolean;
 }
 export interface CloudBackupScheduleExport {
@@ -634,20 +824,73 @@ export interface CloudProviderAccessSetupAzureConfig {
     tenantId: string;
 }
 export interface ClusterAdvancedConfiguration {
+    /**
+     * [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/).
+     */
     defaultReadConcern: string;
+    /**
+     * [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/).
+     */
     defaultWriteConcern: string;
+    /**
+     * 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.
+     */
     failIndexKeyTooLong: boolean;
+    /**
+     * When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.
+     */
     javascriptEnabled: boolean;
+    /**
+     * Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:
+     *
+     * - TLS1_0
+     * - TLS1_1
+     * - TLS1_2
+     */
     minimumEnabledTlsProtocol: string;
+    /**
+     * 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.
+     */
     noTableScan: boolean;
+    /**
+     * 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.
+     * * **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)
+     */
     oplogMinRetentionHours?: number;
+    /**
+     * The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.
+     */
     oplogSizeMb: number;
+    /**
+     * 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.
+     */
     sampleRefreshIntervalBiConnector: number;
+    /**
+     * 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.
+     */
     sampleSizeBiConnector: number;
+    /**
+     * Lifetime, in seconds, of multi-document transactions. Defaults to 60 seconds.
+     */
     transactionLifetimeLimitSeconds: number;
 }
 export interface ClusterBiConnectorConfig {
+    /**
+     * Specifies whether or not BI Connector for Atlas is enabled on the cluster.l
+     * *
+     * - Set to `true` to enable BI Connector for Atlas.
+     * - Set to `false` to disable BI Connector for Atlas.
+     */
     enabled: boolean;
+    /**
+     * 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).
+     *
+     * - Set to "primary" to have BI Connector for Atlas read from the primary.
+     *
+     * - Set to "secondary" to have BI Connector for Atlas read from a secondary member. Default if there are no analytics nodes in the cluster.
+     *
+     * - Set to "analytics" to have BI Connector for Atlas read from an analytics node. Default if the cluster contains analytics nodes.
+     */
     readPreference: string;
 }
 export interface ClusterConnectionString {
@@ -733,19 +976,52 @@ export interface ClusterOutageSimulationOutageFilter {
     type: string;
 }
 export interface ClusterReplicationSpec {
+    /**
+     * Unique identifer of the replication document for a zone in a Global Cluster.
+     */
     id: string;
     /**
      * Selects whether the cluster is a replica set or a sharded cluster. If you use the replicationSpecs parameter, you must set num_shards.
      */
     numShards: number;
+    /**
+     * 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.
+     */
     regionsConfigs: outputs.ClusterReplicationSpecRegionsConfig[];
+    /**
+     * Name for the zone in a Global Cluster.
+     *
+     *
+     * **Region Config**
+     */
     zoneName?: string;
 }
 export interface ClusterReplicationSpecRegionsConfig {
+    /**
+     * 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.
+     */
     analyticsNodes?: number;
+    /**
+     * Number of electable nodes for Atlas to deploy to the region. Electable nodes can become the primary and can facilitate local reads.
+     * * The total number of electableNodes across all replication spec regions  must total 3, 5, or 7.
+     * * Specify 0 if you do not want any electable nodes in the region.
+     * * You cannot create electable nodes in a region if `priority` is 0.
+     */
     electableNodes: number;
+    /**
+     * Election priority of the region. For regions with only read-only nodes, set this value to 0.
+     * * 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.
+     * * 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.
+     * * 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.
+     */
     priority: number;
+    /**
+     * 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.
+     */
     readOnlyNodes?: number;
+    /**
+     * 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/).
+     */
     regionName: string;
 }
 export interface ClusterSnapshotBackupPolicy {
@@ -762,12 +1038,18 @@ export interface ClusterSnapshotBackupPolicy {
     updateSnapshots: boolean;
 }
 export interface ClusterSnapshotBackupPolicyPolicy {
+    /**
+     * Unique identifer of the replication document for a zone in a Global Cluster.
+     */
     id: string;
     policyItems: outputs.ClusterSnapshotBackupPolicyPolicyPolicyItem[];
 }
 export interface ClusterSnapshotBackupPolicyPolicyPolicyItem {
     frequencyInterval: number;
     frequencyType: string;
+    /**
+     * Unique identifer of the replication document for a zone in a Global Cluster.
+     */
     id: string;
     retentionUnit: string;
     retentionValue: number;
@@ -810,6 +1092,11 @@ export interface CustomDbRoleAction {
 export interface CustomDbRoleActionResource {
     cluster?: boolean;
     collectionName?: string;
+    /**
+     * Database on which the inherited role is granted.
+     *
+     * > **NOTE** This value should be admin for all roles except read and readWrite.
+     */
     databaseName?: string;
 }
 export interface CustomDbRoleInheritedRole {
@@ -1180,8 +1467,14 @@ export interface Get509AuthenticationDatabaseUserCertificate {
 }
 export interface GetAccessListApiKeysResult {
     accessCount: number;
+    /**
+     * Range of IP addresses in CIDR notation to be added to the access list.
+     */
     cidrBlock: string;
     created: string;
+    /**
+     * Single IP address to be added to the access list.
+     */
     ipAddress: string;
     lastUsed: string;
     lastUsedAddress: string;
@@ -2272,9 +2565,27 @@ export interface GetAlertConfigurationsResultThresholdConfig {
     units: string;
 }
 export interface GetApiKeysResult {
+    /**
+     * 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.
+     */
     apiKeyId: string;
+    /**
+     * Description of this Organization API key.
+     */
     description: string;
     publicKey: string;
+    /**
+     * Name of the role. This resource returns all the roles the user has in Atlas.
+     *
+     * The following are valid roles:
+     * * `ORG_OWNER`
+     * * `ORG_GROUP_CREATOR`
+     * * `ORG_BILLING_ADMIN`
+     * * `ORG_READ_ONLY`
+     * * `ORG_MEMBER`
+     *
+     * See [MongoDB Atlas API - Return All Organization API Keys](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Programmatic-API-Keys/operation/listApiKeys) - Documentation for more information.
+     */
     roleNames: string[];
 }
 export interface GetAtlasUserLink {
@@ -5030,15 +5341,32 @@ export interface GetOrganizationLink {
     rel: string;
 }
 export interface GetOrganizationsResult {
+    /**
+     * Flag that indicates whether to require API operations to originate from an IP Address added to the API access list for the specified organization.
+     */
     apiAccessListRequired: boolean;
     /**
      * Autogenerated Unique ID for this data source.
      */
     id: string;
+    /**
+     * Flag that indicates whether this organization has been deleted.
+     */
     isDeleted: boolean;
     links: outputs.GetOrganizationsResultLink[];
+    /**
+     * 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/.
+     */
     multiFactorAuthRequired: boolean;
+    /**
+     * Human-readable label that identifies the organization.
+     */
     name: string;
+    /**
+     * 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/.
+     *
+     * See [MongoDB Atlas API - Organizations](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Organizations/operation/listOrganizations)  Documentation for more information.
+     */
     restrictEmployeeAccess: boolean;
 }
 export interface GetOrganizationsResultLink {
@@ -5199,27 +5527,69 @@ export interface GetProjectTeam {
     teamId: string;
 }
 export interface GetProjectsResult {
+    /**
+     * The number of Atlas clusters deployed in the project.
+     */
     clusterCount: number;
+    /**
+     * The ISO-8601-formatted timestamp of when Atlas created the project.
+     */
     created: string;
     /**
      * Autogenerated Unique ID for this data source.
      */
     id: string;
+    /**
+     * IP addresses in a project categorized by services. See IP Addresses.
+     */
     ipAddresses: outputs.GetProjectsResultIpAddresses;
+    /**
+     * Flag that indicates whether to enable statistics in [cluster metrics](https://www.mongodb.com/docs/atlas/monitor-cluster-metrics/) collection for the project.
+     */
     isCollectDatabaseSpecificsStatisticsEnabled: boolean;
+    /**
+     * Flag that indicates whether to enable Data Explorer for the project. If enabled, you can query your database with an easy to use interface.
+     */
     isDataExplorerEnabled: boolean;
+    /**
+     * Flag that indicates whether to enable extended storage sizes for the specified project.
+     */
     isExtendedStorageSizesEnabled: boolean;
+    /**
+     * Flag that indicates whether to enable Performance Advisor and Profiler for the project. If enabled, you can analyze database logs to recommend performance improvements.
+     */
     isPerformanceAdvisorEnabled: boolean;
+    /**
+     * 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.
+     */
     isRealtimePerformancePanelEnabled: boolean;
+    /**
+     * 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).
+     */
     isSchemaAdvisorEnabled: boolean;
+    /**
+     * The limits for the specified project. See Limits.
+     */
     limits: outputs.GetProjectsResultLimit[];
     name: string;
+    /**
+     * The ID of the organization you want to create the project within.
+     */
     orgId: string;
     projectId: string;
+    /**
+     * 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).
+     */
     regionUsageRestrictions: string;
+    /**
+     * Map that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project. To learn more, see [Resource Tags](https://www.mongodb.com/docs/atlas/tags/)
+     */
     tags: {
         [key: string]: string;
     };
+    /**
+     * Returns all teams to which the authenticated user has access in the project. See Teams.
+     */
     teams: outputs.GetProjectsResultTeam[];
 }
 export interface GetProjectsResultIpAddresses {
@@ -5290,11 +5660,11 @@ export interface GetSearchIndexesResult {
     /**
      * [Analyzer](https://docs.atlas.mongodb.com/reference/atlas-search/analyzers/#std-label-analyzers-ref) to use when creating the index.
      */
-    analyzer?: string;
+    analyzer: string;
     /**
      * [Custom analyzers](https://docs.atlas.mongodb.com/reference/atlas-search/analyzers/custom/#std-label-custom-analyzers) to use in this index (this is an array of objects).
      */
-    analyzers?: string;
+    analyzers: string;
     /**
      * Name of the cluster containing the collection with one or more Atlas Search indexes.
      */
@@ -5307,16 +5677,19 @@ export interface GetSearchIndexesResult {
      * (Required) Name of the database the collection is in.
      */
     database: string;
-    fields?: string;
+    fields: string;
+    /**
+     * The unique identifier of the Atlas Search index.
+     */
     indexId: string;
     /**
      * Flag indicating whether the index uses dynamic or static mappings.
      */
-    mappingsDynamic?: boolean;
+    mappingsDynamic: boolean;
     /**
      * Object containing one or more field specifications.
      */
-    mappingsFields?: string;
+    mappingsFields: string;
     /**
      * Name of the index.
      */
@@ -5328,20 +5701,23 @@ export interface GetSearchIndexesResult {
     /**
      * [Analyzer](https://docs.atlas.mongodb.com/reference/atlas-search/analyzers/#std-label-analyzers-ref) to use when searching the index.
      */
-    searchAnalyzer?: string;
+    searchAnalyzer: string;
     /**
      * Current status of the index.
      */
     status: string;
+    /**
+     * String that can be "true" (store all fields), "false" (default, don't store any field), or a JSON string that contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see [Stored Source Fields](https://www.mongodb.com/docs/atlas/atlas-search/stored-source-definition/).
+     */
+    storedSource: string;
     /**
      * Synonyms mapping definition to use in this index.
      * * `synonyms.#.name` - Name of the [synonym mapping definition](https://docs.atlas.mongodb.com/reference/atlas-search/synonyms/#std-label-synonyms-ref).
      * * `synonyms.#.source_collection` - Name of the source MongoDB collection for the synonyms.
      * * `synonyms.#.analyzer` - Name of the [analyzer](https://docs.atlas.mongodb.com/reference/atlas-search/analyzers/#std-label-analyzers-ref) to use with this synonym mapping.
      */
-    synonyms?: outputs.GetSearchIndexesResultSynonym[];
-    type?: string;
-    waitForIndexBuildCompletion?: boolean;
+    synonyms: outputs.GetSearchIndexesResultSynonym[];
+    type: string;
 }
 export interface GetSearchIndexesResultSynonym {
     /**
@@ -5705,14 +6081,35 @@ export interface GetX509AuthenticationDatabaseUserCertificate {
     subject: string;
 }
 export interface GlobalClusterConfigCustomZoneMapping {
+    /**
+     * 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).
+     */
     location: string;
+    /**
+     * The name of the zone in your Global Cluster that you want to map to location.
+     */
     zone: string;
 }
 export interface GlobalClusterConfigManagedNamespace {
+    /**
+     * The name of the collection associated with the managed namespace.
+     */
     collection: string;
+    /**
+     * 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.
+     */
     customShardKey: string;
+    /**
+     * The name of the database containing the collection.
+     */
     db: string;
+    /**
+     * 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.
+     */
     isCustomShardKeyHashed: boolean;
+    /**
+     * 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).
+     */
     isShardKeyUnique: boolean;
 }
 export interface LdapConfigurationUserToDnMapping {
@@ -5776,8 +6173,17 @@ export interface OnlineArchiveDataProcessRegion {
     region: string;
 }
 export interface OnlineArchivePartitionField {
+    /**
+     * Human-readable label that identifies the parameter that MongoDB Cloud uses to partition data. To specify a nested parameter, use the dot notation.
+     */
     fieldName: string;
+    /**
+     * 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`.
+     */
     fieldType: string;
+    /**
+     * 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.
+     */
     order: number;
 }
 export interface OnlineArchiveSchedule {
@@ -5969,6 +6375,9 @@ export interface StreamConnectionAuthentication {
     username?: string;
 }
 export interface StreamConnectionDbRoleToExecute {
+    /**
+     * The name of the role to use. Can be a built in role or a custom role.
+     */
     role: string;
     /**
      * Type of connection. Can be either `Cluster`, `Kafka` or `Sample`.