@pulumi/mongodbatlas 3.10.0 → 3.10.1

package/types/output.d.ts

@@ -90,13 +90,13 @@ export interface AdvancedClusterBiConnectorConfig {
 }
 export interface AdvancedClusterConnectionString {
     /**
-     * @deprecated This field is deprecated. Use connection_strings.private_endpoint[n].connection_string instead
+     * @deprecated this parameter is deprecated and will be removed in v1.12.0, please transition to connection_strings.private_endpoint[n].connection_string
      */
     awsPrivateLink: {
         [key: string]: any;
     };
     /**
-     * @deprecated This field is deprecated. Use connection_strings.private_endpoint[n].srv_connection_string instead
+     * @deprecated this parameter is deprecated and will be removed in v1.12.0, please transition to connection_strings.private_endpoint[n].srv_connection_string
      */
     awsPrivateLinkSrv: {
         [key: string]: any;
@@ -130,6 +130,9 @@ export interface AdvancedClusterLabel {
     key: string;
     /**
      * The value that you want to write.
+     *
+     * > **NOTE:** MongoDB Atlas doesn't display your labels.
+     * > **NOTE:** Cluster labels are not the same as [resource TAGs](https://www.mongodb.com/docs/atlas/tags/). We plan to add [resource TAGs](https://www.mongodb.com/docs/atlas/tags/) support in a future release.
      */
     value: string;
 }
@@ -586,7 +589,7 @@ export interface CloudBackupScheduleCopySetting {
      */
     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, do a GET request to Return One Cluster in One Project and consult the replicationSpecs array https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#operation/returnOneCluster
+     * 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;
     /**
@@ -843,13 +846,13 @@ export interface ClusterBiConnectorConfig {
 }
 export interface ClusterConnectionString {
     /**
-     * @deprecated This field is deprecated. Use connection_strings.private_endpoint[n].connection_string instead
+     * @deprecated this parameter is deprecated and will be removed in v1.12.0, please transition to connection_strings.private_endpoint[n].connection_string
      */
     awsPrivateLink: {
         [key: string]: any;
     };
     /**
-     * @deprecated This field is deprecated. Use connection_strings.private_endpoint[n].srv_connection_string instead
+     * @deprecated this parameter is deprecated and will be removed in v1.12.0, please transition to connection_strings.private_endpoint[n].srv_connection_string
      */
     awsPrivateLinkSrv: {
         [key: string]: any;
@@ -884,6 +887,9 @@ export interface ClusterLabel {
     key: string;
     /**
      * The value that you want to write.
+     *
+     * > **NOTE:** MongoDB Atlas doesn't display your labels.
+     * > **NOTE:** Cluster labels are not the same as [resource TAGs](https://www.mongodb.com/docs/atlas/tags/). We plan to add [resource TAGs](https://www.mongodb.com/docs/atlas/tags/) support in a future release.
      */
     value: string;
 }
@@ -1345,6 +1351,7 @@ export interface FederatedDatabaseInstanceStorageDatabaseCollectionDataSource {
     collectionRegex?: string;
     database?: string;
     databaseRegex?: string;
+    datasetName?: string;
     defaultFormat?: string;
     path?: string;
     provenanceFieldName?: string;
@@ -1365,6 +1372,9 @@ export interface FederatedDatabaseInstanceStorageStore {
     additionalStorageClasses?: string[];
     allowInsecure?: boolean;
     bucket?: string;
+    /**
+     * @deprecated this parameter is deprecated and will be removed by September 2024
+     */
     clusterId?: string;
     clusterName?: string;
     defaultFormat?: string;
@@ -1393,9 +1403,12 @@ export interface FederatedDatabaseInstanceStorageStore {
 export interface FederatedDatabaseInstanceStorageStoreReadPreference {
     maxStalenessSeconds?: number;
     mode?: string;
-    tags: outputs.FederatedDatabaseInstanceStorageStoreReadPreferenceTag[];
+    tagSets?: outputs.FederatedDatabaseInstanceStorageStoreReadPreferenceTagSet[];
+}
+export interface FederatedDatabaseInstanceStorageStoreReadPreferenceTagSet {
+    tags: outputs.FederatedDatabaseInstanceStorageStoreReadPreferenceTagSetTag[];
 }
-export interface FederatedDatabaseInstanceStorageStoreReadPreferenceTag {
+export interface FederatedDatabaseInstanceStorageStoreReadPreferenceTagSetTag {
     /**
      * Name of the Atlas Federated Database Instance.
      * ### `cloudProviderConfig` - (Optional) Cloud provider linked to this data federated instance.
@@ -1498,13 +1511,13 @@ export interface GetAdvancedClusterBiConnectorConfig {
 }
 export interface GetAdvancedClusterConnectionString {
     /**
-     * @deprecated This field is deprecated. Use connection_strings.private_endpoint[n].connection_string instead
+     * @deprecated this parameter is deprecated and will be removed in v1.12.0, please transition to connection_strings.private_endpoint[n].connection_string
      */
     awsPrivateLink: {
         [key: string]: any;
     };
     /**
-     * @deprecated This field is deprecated. Use connection_strings.private_endpoint[n].srv_connection_string instead
+     * @deprecated this parameter is deprecated and will be removed in v1.12.0, please transition to connection_strings.private_endpoint[n].srv_connection_string
      */
     awsPrivateLinkSrv: {
         [key: string]: any;
@@ -1823,13 +1836,13 @@ export interface GetAdvancedClustersResultBiConnectorConfig {
 }
 export interface GetAdvancedClustersResultConnectionString {
     /**
-     * @deprecated This field is deprecated. Use connection_strings.private_endpoint[n].connection_string instead
+     * @deprecated this parameter is deprecated and will be removed in v1.12.0, please transition to connection_strings.private_endpoint[n].connection_string
      */
     awsPrivateLink: {
         [key: string]: any;
     };
     /**
-     * @deprecated This field is deprecated. Use connection_strings.private_endpoint[n].srv_connection_string instead
+     * @deprecated this parameter is deprecated and will be removed in v1.12.0, please transition to connection_strings.private_endpoint[n].srv_connection_string
      */
     awsPrivateLinkSrv: {
         [key: string]: any;
@@ -2422,7 +2435,7 @@ export interface GetCloudBackupScheduleCopySetting {
      */
     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, do a GET request to Return One Cluster in One Project and consult the replicationSpecs array https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#operation/returnOneCluster
+     * 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;
     /**
@@ -2917,11 +2930,11 @@ export interface GetClusterConnectionStringPrivateEndpointEndpoint {
 }
 export interface GetClusterLabel {
     /**
-     * The key that was set.
+     * The key that you want to write.
      */
     key: string;
     /**
-     * The value that represents the key.
+     * The value that you want to write.
      */
     value: string;
 }
@@ -3152,6 +3165,7 @@ export interface GetClustersResult {
     providerRegionName: string;
     /**
      * Indicates the type of the volume. The possible values are: `STANDARD` and `PROVISIONED`.
+     * > **NOTE:** `STANDARD` is not available for NVME clusters.
      */
     providerVolumeType: string;
     /**
@@ -3272,11 +3286,11 @@ export interface GetClustersResultConnectionStringPrivateEndpointEndpoint {
 }
 export interface GetClustersResultLabel {
     /**
-     * The key that was set.
+     * The key that you want to write.
      */
     key: string;
     /**
-     * The value that represents the key.
+     * The value that you want to write.
      */
     value: string;
 }
@@ -3832,6 +3846,10 @@ export interface GetDatabaseUsersResult {
      * Method by which the provided username is authenticated. Default is `NONE`. Other valid values are: `USER`, `GROUP`.
      */
     ldapAuthType: string;
+    /**
+     * (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:
+     */
+    oidcAuthType: string;
     /**
      * The unique ID for the project to get all database users.
      */
@@ -4030,6 +4048,7 @@ export interface GetFederatedDatabaseInstanceStorageDatabaseCollectionDataSource
     collectionRegex: string;
     database: string;
     databaseRegex: string;
+    datasetName: string;
     defaultFormat: string;
     path: string;
     provenanceFieldName: string;
@@ -4048,6 +4067,9 @@ export interface GetFederatedDatabaseInstanceStorageStore {
     additionalStorageClasses: string[];
     allowInsecure: boolean;
     bucket: string;
+    /**
+     * @deprecated this parameter is deprecated and will be removed by September 2024
+     */
     clusterId: string;
     clusterName: string;
     defaultFormat: string;
@@ -4074,9 +4096,12 @@ export interface GetFederatedDatabaseInstanceStorageStore {
 export interface GetFederatedDatabaseInstanceStorageStoreReadPreference {
     maxStalenessSeconds: number;
     mode: string;
-    tags: outputs.GetFederatedDatabaseInstanceStorageStoreReadPreferenceTag[];
+    tagSets: outputs.GetFederatedDatabaseInstanceStorageStoreReadPreferenceTagSet[];
+}
+export interface GetFederatedDatabaseInstanceStorageStoreReadPreferenceTagSet {
+    tags: outputs.GetFederatedDatabaseInstanceStorageStoreReadPreferenceTagSetTag[];
 }
-export interface GetFederatedDatabaseInstanceStorageStoreReadPreferenceTag {
+export interface GetFederatedDatabaseInstanceStorageStoreReadPreferenceTagSetTag {
     /**
      * Name of the Atlas Federated Database Instance.
      */
@@ -4106,6 +4131,7 @@ export interface GetFederatedDatabaseInstancesResult {
      * * `storage_databases.#.collections.#.name` - Name of the collection.
      * * `storage_databases.#.collections.#.data_sources` -     Array of objects where each object represents a stores data store to map with the collection.
      * * `storage_databases.#.collections.#.data_sources.#.store_name` -     Name of a data store to map to the `<collection>`. Must match the name of an object in the stores array.
+     * * `storage_databases.#.collections.#.data_sources.#.dataset_name` -     Human-readable label that identifies the dataset that Atlas generates for an ingestion pipeline run or Online Archive.
      * * `storage_databases.#.collections.#.data_sources.#.default_format` - Default format that Federated Database assumes if it encounters a file without an extension while searching the storeName.
      * * `storage_databases.#.collections.#.data_sources.#.path` - File path that controls how MongoDB Cloud searches for and parses files in the storeName before mapping them to a collection. Specify / to capture all files and folders from the prefix path.
      * * `storage_databases.#.collections.#.data_sources.#.database` - Human-readable label that identifies the database, which contains the collection in the cluster.
@@ -4140,9 +4166,10 @@ export interface GetFederatedDatabaseInstancesResult {
      * * `storage_stores.#.read_preference` - MongoDB Cloud cluster read preference, which describes how to route read requests to the cluster.
      * * `storage_stores.#.read_preference.maxStalenessSeconds` - Maximum replication lag, or staleness, for reads from secondaries.
      * * `storage_stores.#.read_preference.mode` - Read preference mode that specifies to which replica set member to route the read requests.
-     * * `storage_stores.#.read_preference.tagSets` - List that contains tag sets or tag specification documents.
-     * * `storage_stores.#.read_preference.tagSets.name` - Human-readable label of the tag.
-     * * `storage_stores.#.read_preference.tagSets.value` - Value of the tag.
+     * * `storage_stores.#.read_preference.tag_sets` - List that contains tag sets or tag specification documents.
+     * * `storage_stores.#.read_preference.tags` - List of all tags within a tag set
+     * * `storage_stores.#.read_preference.tags.name` - Human-readable label of the tag.
+     * * `storage_stores.#.read_preference.tags.value` - Value of the tag.
      */
     storageStores: outputs.GetFederatedDatabaseInstancesResultStorageStore[];
 }
@@ -4198,6 +4225,7 @@ export interface GetFederatedDatabaseInstancesResultStorageDatabaseCollectionDat
     collectionRegex: string;
     database: string;
     databaseRegex: string;
+    datasetName: string;
     defaultFormat: string;
     path: string;
     provenanceFieldName: string;
@@ -4213,6 +4241,9 @@ export interface GetFederatedDatabaseInstancesResultStorageStore {
     additionalStorageClasses: string[];
     allowInsecure: boolean;
     bucket: string;
+    /**
+     * @deprecated this parameter is deprecated and will be removed by September 2024
+     */
     clusterId: string;
     clusterName: string;
     defaultFormat: string;
@@ -4236,9 +4267,12 @@ export interface GetFederatedDatabaseInstancesResultStorageStore {
 export interface GetFederatedDatabaseInstancesResultStorageStoreReadPreference {
     maxStalenessSeconds: number;
     mode: string;
-    tags: outputs.GetFederatedDatabaseInstancesResultStorageStoreReadPreferenceTag[];
+    tagSets: outputs.GetFederatedDatabaseInstancesResultStorageStoreReadPreferenceTagSet[];
 }
-export interface GetFederatedDatabaseInstancesResultStorageStoreReadPreferenceTag {
+export interface GetFederatedDatabaseInstancesResultStorageStoreReadPreferenceTagSet {
+    tags: outputs.GetFederatedDatabaseInstancesResultStorageStoreReadPreferenceTagSetTag[];
+}
+export interface GetFederatedDatabaseInstancesResultStorageStoreReadPreferenceTagSetTag {
     name: string;
     value: string;
 }
@@ -5438,6 +5472,8 @@ export interface OnlineArchiveCriteria {
     /**
      * Number of days after the value in the criteria.dateField when MongoDB Cloud archives data in the specified cluster.
      *
+     * **_NOTE: if `DATE` is selected, the `partition_fields.field_name` must be completed with the `dateField` value_**
+     *
      * The only field required for criteria type `CUSTOM`
      */
     expireAfterDays?: number;
@@ -5606,7 +5642,7 @@ export declare namespace config {
     interface AssumeRole {
         duration?: string;
         /**
-         * @deprecated Use assume_role.duration instead
+         * @deprecated this parameter is deprecated and will be removed in v1.12.0, please transition to assume_role.duration
          */
         durationSeconds?: number;
         externalId?: string;

package/x509authenticationDatabaseUser.d.ts

@@ -89,13 +89,13 @@ import * as outputs from "./types/output";
  * ```sh
  *  $ pulumi import mongodbatlas:index/x509AuthenticationDatabaseUser:X509AuthenticationDatabaseUser test 1112222b3bf99403840e8934-myUsername
  * ```
+ *  For more information see[MongoDB Atlas API Reference.](https://docs.atlas.mongodb.com/reference/api/x509-configuration-get-certificates/)
  *
- *  For more information see[MongoDB Atlas API Reference.](https://docs.atlas.mongodb.com/reference/api/x509-configuration-get-certificates/) Current X.509 Configuration can be imported using project ID, in the format `project_id`, e.g.
+ * Current X.509 Configuration can be imported using project ID, in the format `project_id`, e.g.
  *
  * ```sh
  *  $ pulumi import mongodbatlas:index/x509AuthenticationDatabaseUser:X509AuthenticationDatabaseUser test 1112222b3bf99403840e8934
  * ```
- *
  *  For more information see[MongoDB Atlas API Reference.](https://docs.atlas.mongodb.com/reference/api/x509-configuration-get-certificates/)
  */
 export declare class X509AuthenticationDatabaseUser extends pulumi.CustomResource {

package/x509authenticationDatabaseUser.js

@@ -93,13 +93,13 @@ const utilities = require("./utilities");
  * ```sh
  *  $ pulumi import mongodbatlas:index/x509AuthenticationDatabaseUser:X509AuthenticationDatabaseUser test 1112222b3bf99403840e8934-myUsername
  * ```
+ *  For more information see[MongoDB Atlas API Reference.](https://docs.atlas.mongodb.com/reference/api/x509-configuration-get-certificates/)
  *
- *  For more information see[MongoDB Atlas API Reference.](https://docs.atlas.mongodb.com/reference/api/x509-configuration-get-certificates/) Current X.509 Configuration can be imported using project ID, in the format `project_id`, e.g.
+ * Current X.509 Configuration can be imported using project ID, in the format `project_id`, e.g.
  *
  * ```sh
  *  $ pulumi import mongodbatlas:index/x509AuthenticationDatabaseUser:X509AuthenticationDatabaseUser test 1112222b3bf99403840e8934
  * ```
- *
  *  For more information see[MongoDB Atlas API Reference.](https://docs.atlas.mongodb.com/reference/api/x509-configuration-get-certificates/)
  */
 class X509AuthenticationDatabaseUser extends pulumi.CustomResource {