@pulumi/mongodbatlas 3.9.0-alpha.1687672134 → 3.9.0

package/dataLakePipeline.d.ts

@@ -0,0 +1,181 @@
+import * as pulumi from "@pulumi/pulumi";
+import * as inputs from "./types/input";
+import * as outputs from "./types/output";
+/**
+ * `mongodbatlas.DataLakePipeline` provides a Data Lake Pipeline resource.
+ *
+ * > **NOTE:** Groups and projects are synonymous terms. You may find `groupId` in the official documentation.
+ *
+ * ## Example Usage
+ *
+ * ## Import
+ *
+ * Data Lake Pipeline can be imported using project ID, name of the data lake and name of the AWS s3 bucket, in the format `project_id`--`name`, e.g.
+ *
+ * ```sh
+ *  $ pulumi import mongodbatlas:index/dataLakePipeline:DataLakePipeline example 1112222b3bf99403840e8934--test-data-lake-pipeline-test
+ * ```
+ *
+ *  See [MongoDB Atlas API](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Data-Lake-Pipelines) Documentation for more information.
+ */
+export declare class DataLakePipeline extends pulumi.CustomResource {
+    /**
+     * Get an existing DataLakePipeline resource's state with the given name, ID, and optional extra
+     * properties used to qualify the lookup.
+     *
+     * @param name The _unique_ name of the resulting resource.
+     * @param id The _unique_ provider ID of the resource to lookup.
+     * @param state Any extra arguments used during the lookup.
+     * @param opts Optional settings to control the behavior of the CustomResource.
+     */
+    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DataLakePipelineState, opts?: pulumi.CustomResourceOptions): DataLakePipeline;
+    /**
+     * Returns true if the given object is an instance of DataLakePipeline.  This is designed to work even
+     * when multiple copies of the Pulumi SDK have been loaded into the same process.
+     */
+    static isInstance(obj: any): obj is DataLakePipeline;
+    /**
+     * Timestamp that indicates when the Data Lake Pipeline was created.
+     */
+    readonly createdDate: pulumi.Output<string>;
+    /**
+     * List of backup schedule policy items that you can use as a Data Lake Pipeline source.
+     * * `ingestion_schedules.#.id` - Unique 24-hexadecimal digit string that identifies this backup policy item.
+     * * `ingestion_schedules.#.frequency_type` - Human-readable label that identifies the frequency type associated with the backup policy.
+     * * `ingestion_schedules.#.frequency_interval` - Number that indicates the frequency interval for a set of snapshots.
+     * * `ingestion_schedules.#.retention_unit` - Unit of time in which MongoDB Atlas measures snapshot retention.
+     * * `ingestion_schedules.#.retention_value` - Duration in days, weeks, or months that MongoDB Atlas retains the snapshot.
+     */
+    readonly ingestionSchedules: pulumi.Output<outputs.DataLakePipelineIngestionSchedule[]>;
+    /**
+     * Timestamp that indicates the last time that the Data Lake Pipeline was updated.
+     */
+    readonly lastUpdatedDate: pulumi.Output<string>;
+    /**
+     * Name of the Atlas Data Lake Pipeline.
+     */
+    readonly name: pulumi.Output<string>;
+    /**
+     * The unique ID for the project to create a data lake pipeline.
+     */
+    readonly projectId: pulumi.Output<string>;
+    readonly sink: pulumi.Output<outputs.DataLakePipelineSink | undefined>;
+    /**
+     * List of backup snapshots that you can use to trigger an on demand pipeline run.
+     * * `snapshots.#.id` - Unique 24-hexadecimal digit string that identifies the snapshot.
+     * * `snapshots.#.provider` - Human-readable label that identifies the cloud provider that stores this snapshot.
+     * * `snapshots.#.created_at` - Date and time when MongoDB Atlas took the snapshot.
+     * * `snapshots.#.expires_at` - Date and time when MongoDB Atlas deletes the snapshot.
+     * * `snapshots.#.frequency_type` - Human-readable label that identifies how often this snapshot triggers.
+     * * `snapshots.#.master_key` - Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot.
+     * * `snapshots.#.mongod_version` - Version of the MongoDB host that this snapshot backs up.
+     * * `snapshots.#.replica_set_name` - Human-readable label that identifies the replica set from which MongoDB Atlas took this snapshot.
+     * * `snapshots.#.type` - Human-readable label that categorizes the cluster as a replica set or sharded cluster.
+     * * `snapshots.#.snapshot_type` - Human-readable label that identifies when this snapshot triggers.
+     * * `snapshots.#.status` - Human-readable label that indicates the stage of the backup process for this snapshot.
+     * * `snapshots.#.size` - List of backup snapshots that you can use to trigger an on demand pipeline run.
+     * * `snapshots.#.copy_region` - List that identifies the regions to which MongoDB Atlas copies the snapshot.
+     * * `snapshots.#.policies` - List that contains unique identifiers for the policy items.
+     */
+    readonly snapshots: pulumi.Output<outputs.DataLakePipelineSnapshot[]>;
+    readonly source: pulumi.Output<outputs.DataLakePipelineSource | undefined>;
+    /**
+     * State of this Data Lake Pipeline.
+     */
+    readonly state: pulumi.Output<string>;
+    /**
+     * Fields to be excluded for this Data Lake Pipeline.
+     * * `transformations.#.field` - Key in the document.
+     * * `transformations.#.type` - Type of transformation applied during the export of the namespace in a Data Lake Pipeline.
+     */
+    readonly transformations: pulumi.Output<outputs.DataLakePipelineTransformation[] | undefined>;
+    /**
+     * Create a DataLakePipeline resource with the given unique name, arguments, and options.
+     *
+     * @param name The _unique_ name of the resource.
+     * @param args The arguments to use to populate this resource's properties.
+     * @param opts A bag of options that control this resource's behavior.
+     */
+    constructor(name: string, args: DataLakePipelineArgs, opts?: pulumi.CustomResourceOptions);
+}
+/**
+ * Input properties used for looking up and filtering DataLakePipeline resources.
+ */
+export interface DataLakePipelineState {
+    /**
+     * Timestamp that indicates when the Data Lake Pipeline was created.
+     */
+    createdDate?: pulumi.Input<string>;
+    /**
+     * List of backup schedule policy items that you can use as a Data Lake Pipeline source.
+     * * `ingestion_schedules.#.id` - Unique 24-hexadecimal digit string that identifies this backup policy item.
+     * * `ingestion_schedules.#.frequency_type` - Human-readable label that identifies the frequency type associated with the backup policy.
+     * * `ingestion_schedules.#.frequency_interval` - Number that indicates the frequency interval for a set of snapshots.
+     * * `ingestion_schedules.#.retention_unit` - Unit of time in which MongoDB Atlas measures snapshot retention.
+     * * `ingestion_schedules.#.retention_value` - Duration in days, weeks, or months that MongoDB Atlas retains the snapshot.
+     */
+    ingestionSchedules?: pulumi.Input<pulumi.Input<inputs.DataLakePipelineIngestionSchedule>[]>;
+    /**
+     * Timestamp that indicates the last time that the Data Lake Pipeline was updated.
+     */
+    lastUpdatedDate?: pulumi.Input<string>;
+    /**
+     * Name of the Atlas Data Lake Pipeline.
+     */
+    name?: pulumi.Input<string>;
+    /**
+     * The unique ID for the project to create a data lake pipeline.
+     */
+    projectId?: pulumi.Input<string>;
+    sink?: pulumi.Input<inputs.DataLakePipelineSink>;
+    /**
+     * List of backup snapshots that you can use to trigger an on demand pipeline run.
+     * * `snapshots.#.id` - Unique 24-hexadecimal digit string that identifies the snapshot.
+     * * `snapshots.#.provider` - Human-readable label that identifies the cloud provider that stores this snapshot.
+     * * `snapshots.#.created_at` - Date and time when MongoDB Atlas took the snapshot.
+     * * `snapshots.#.expires_at` - Date and time when MongoDB Atlas deletes the snapshot.
+     * * `snapshots.#.frequency_type` - Human-readable label that identifies how often this snapshot triggers.
+     * * `snapshots.#.master_key` - Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot.
+     * * `snapshots.#.mongod_version` - Version of the MongoDB host that this snapshot backs up.
+     * * `snapshots.#.replica_set_name` - Human-readable label that identifies the replica set from which MongoDB Atlas took this snapshot.
+     * * `snapshots.#.type` - Human-readable label that categorizes the cluster as a replica set or sharded cluster.
+     * * `snapshots.#.snapshot_type` - Human-readable label that identifies when this snapshot triggers.
+     * * `snapshots.#.status` - Human-readable label that indicates the stage of the backup process for this snapshot.
+     * * `snapshots.#.size` - List of backup snapshots that you can use to trigger an on demand pipeline run.
+     * * `snapshots.#.copy_region` - List that identifies the regions to which MongoDB Atlas copies the snapshot.
+     * * `snapshots.#.policies` - List that contains unique identifiers for the policy items.
+     */
+    snapshots?: pulumi.Input<pulumi.Input<inputs.DataLakePipelineSnapshot>[]>;
+    source?: pulumi.Input<inputs.DataLakePipelineSource>;
+    /**
+     * State of this Data Lake Pipeline.
+     */
+    state?: pulumi.Input<string>;
+    /**
+     * Fields to be excluded for this Data Lake Pipeline.
+     * * `transformations.#.field` - Key in the document.
+     * * `transformations.#.type` - Type of transformation applied during the export of the namespace in a Data Lake Pipeline.
+     */
+    transformations?: pulumi.Input<pulumi.Input<inputs.DataLakePipelineTransformation>[]>;
+}
+/**
+ * The set of arguments for constructing a DataLakePipeline resource.
+ */
+export interface DataLakePipelineArgs {
+    /**
+     * Name of the Atlas Data Lake Pipeline.
+     */
+    name?: pulumi.Input<string>;
+    /**
+     * The unique ID for the project to create a data lake pipeline.
+     */
+    projectId: pulumi.Input<string>;
+    sink?: pulumi.Input<inputs.DataLakePipelineSink>;
+    source?: pulumi.Input<inputs.DataLakePipelineSource>;
+    /**
+     * Fields to be excluded for this Data Lake Pipeline.
+     * * `transformations.#.field` - Key in the document.
+     * * `transformations.#.type` - Type of transformation applied during the export of the namespace in a Data Lake Pipeline.
+     */
+    transformations?: pulumi.Input<pulumi.Input<inputs.DataLakePipelineTransformation>[]>;
+}

package/dataLakePipeline.js

@@ -0,0 +1,87 @@
+"use strict";
+// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
+// *** Do not edit by hand unless you're certain you know what you are doing! ***
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DataLakePipeline = void 0;
+const pulumi = require("@pulumi/pulumi");
+const utilities = require("./utilities");
+/**
+ * `mongodbatlas.DataLakePipeline` provides a Data Lake Pipeline resource.
+ *
+ * > **NOTE:** Groups and projects are synonymous terms. You may find `groupId` in the official documentation.
+ *
+ * ## Example Usage
+ *
+ * ## Import
+ *
+ * Data Lake Pipeline can be imported using project ID, name of the data lake and name of the AWS s3 bucket, in the format `project_id`--`name`, e.g.
+ *
+ * ```sh
+ *  $ pulumi import mongodbatlas:index/dataLakePipeline:DataLakePipeline example 1112222b3bf99403840e8934--test-data-lake-pipeline-test
+ * ```
+ *
+ *  See [MongoDB Atlas API](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Data-Lake-Pipelines) Documentation for more information.
+ */
+class DataLakePipeline extends pulumi.CustomResource {
+    /**
+     * Get an existing DataLakePipeline resource's state with the given name, ID, and optional extra
+     * properties used to qualify the lookup.
+     *
+     * @param name The _unique_ name of the resulting resource.
+     * @param id The _unique_ provider ID of the resource to lookup.
+     * @param state Any extra arguments used during the lookup.
+     * @param opts Optional settings to control the behavior of the CustomResource.
+     */
+    static get(name, id, state, opts) {
+        return new DataLakePipeline(name, state, Object.assign(Object.assign({}, opts), { id: id }));
+    }
+    /**
+     * Returns true if the given object is an instance of DataLakePipeline.  This is designed to work even
+     * when multiple copies of the Pulumi SDK have been loaded into the same process.
+     */
+    static isInstance(obj) {
+        if (obj === undefined || obj === null) {
+            return false;
+        }
+        return obj['__pulumiType'] === DataLakePipeline.__pulumiType;
+    }
+    constructor(name, argsOrState, opts) {
+        let resourceInputs = {};
+        opts = opts || {};
+        if (opts.id) {
+            const state = argsOrState;
+            resourceInputs["createdDate"] = state ? state.createdDate : undefined;
+            resourceInputs["ingestionSchedules"] = state ? state.ingestionSchedules : undefined;
+            resourceInputs["lastUpdatedDate"] = state ? state.lastUpdatedDate : undefined;
+            resourceInputs["name"] = state ? state.name : undefined;
+            resourceInputs["projectId"] = state ? state.projectId : undefined;
+            resourceInputs["sink"] = state ? state.sink : undefined;
+            resourceInputs["snapshots"] = state ? state.snapshots : undefined;
+            resourceInputs["source"] = state ? state.source : undefined;
+            resourceInputs["state"] = state ? state.state : undefined;
+            resourceInputs["transformations"] = state ? state.transformations : undefined;
+        }
+        else {
+            const args = argsOrState;
+            if ((!args || args.projectId === undefined) && !opts.urn) {
+                throw new Error("Missing required property 'projectId'");
+            }
+            resourceInputs["name"] = args ? args.name : undefined;
+            resourceInputs["projectId"] = args ? args.projectId : undefined;
+            resourceInputs["sink"] = args ? args.sink : undefined;
+            resourceInputs["source"] = args ? args.source : undefined;
+            resourceInputs["transformations"] = args ? args.transformations : undefined;
+            resourceInputs["createdDate"] = undefined /*out*/;
+            resourceInputs["ingestionSchedules"] = undefined /*out*/;
+            resourceInputs["lastUpdatedDate"] = undefined /*out*/;
+            resourceInputs["snapshots"] = undefined /*out*/;
+            resourceInputs["state"] = undefined /*out*/;
+        }
+        opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
+        super(DataLakePipeline.__pulumiType, name, resourceInputs, opts);
+    }
+}
+exports.DataLakePipeline = DataLakePipeline;
+/** @internal */
+DataLakePipeline.__pulumiType = 'mongodbatlas:index/dataLakePipeline:DataLakePipeline';
+//# sourceMappingURL=dataLakePipeline.js.map

package/dataLakePipeline.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dataLakePipeline.js","sourceRoot":"","sources":["../dataLakePipeline.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;GAgBG;AACH,MAAa,gBAAiB,SAAQ,MAAM,CAAC,cAAc;IACvD;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAA6B,EAAE,IAAmC;QAC3H,OAAO,IAAI,gBAAgB,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IACvE,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,gBAAgB,CAAC,YAAY,CAAC;IACjE,CAAC;IAkED,YAAY,IAAY,EAAE,WAA0D,EAAE,IAAmC;QACrH,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAgD,CAAC;YAC/D,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,oBAAoB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,CAAC,SAAS,CAAC;YACpF,cAAc,CAAC,iBAAiB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9E,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,cAAc,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,cAAc,CAAC,iBAAiB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC;SACjF;aAAM;YACH,MAAM,IAAI,GAAG,WAA+C,CAAC;YAC7D,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACtD,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;aAC5D;YACD,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,cAAc,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5E,cAAc,CAAC,aAAa,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAClD,cAAc,CAAC,oBAAoB,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YACzD,cAAc,CAAC,iBAAiB,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YACtD,cAAc,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAChD,cAAc,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SAC/C;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,gBAAgB,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IACrE,CAAC;;AA7HL,4CA8HC;AAhHG,gBAAgB;AACO,6BAAY,GAAG,sDAAsD,CAAC"}

package/federatedDatabaseInstance.d.ts

@@ -0,0 +1,333 @@
+import * as pulumi from "@pulumi/pulumi";
+import * as inputs from "./types/input";
+import * as outputs from "./types/output";
+/**
+ * `mongodbatlas.FederatedDatabaseInstance` provides a Federated Database Instance resource.
+ *
+ * > **NOTE:** Groups and projects are synonymous terms. You may find groupId in the official documentation.
+ *
+ * ## Example Usage
+ * ### S With MongoDB Atlas Cluster As Storage Database
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as mongodbatlas from "@pulumi/mongodbatlas";
+ *
+ * const test = new mongodbatlas.FederatedDatabaseInstance("test", {
+ *     projectId: "PROJECT ID",
+ *     storageDatabases: [{
+ *         collections: [{
+ *             dataSources: [{
+ *                 collection: "COLLECTION IN THE CLUSTER",
+ *                 database: "DB IN THE CLUSTER",
+ *                 storeName: "CLUSTER NAME",
+ *             }],
+ *             name: "NAME OF THE COLLECTION",
+ *         }],
+ *         name: "VirtualDatabase0",
+ *     }],
+ *     storageStores: [{
+ *         clusterName: "CLUSTER NAME",
+ *         name: "STORE 1 NAME",
+ *         projectId: "PROJECT ID",
+ *         provider: "atlas",
+ *         readPreference: {
+ *             mode: "secondary",
+ *         },
+ *     }],
+ * });
+ * ```
+ * ### S With Amazon S3 Bucket As Storage Database
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as mongodbatlas from "@pulumi/mongodbatlas";
+ *
+ * const test = new mongodbatlas.FederatedDatabaseInstance("test", {
+ *     cloudProviderConfig: {
+ *         aws: {
+ *             roleId: "AWS ROLE ID",
+ *             testS3Bucket: "S3 BUCKET NAME",
+ *         },
+ *     },
+ *     projectId: "PROJECT ID",
+ *     storageDatabases: [{
+ *         collections: [{
+ *             dataSources: [
+ *                 {
+ *                     collection: "COLLECTION IN THE CLUSTER",
+ *                     database: "DB IN THE CLUSTER",
+ *                     storeName: "CLUSTER NAME",
+ *                 },
+ *                 {
+ *                     path: "S3 BUCKET PATH",
+ *                     storeName: "S3 BUCKET NAME",
+ *                 },
+ *             ],
+ *             name: "NAME OF THE COLLECTION",
+ *         }],
+ *         name: "VirtualDatabase0",
+ *     }],
+ *     storageStores: [
+ *         {
+ *             clusterName: "CLUSTER NAME",
+ *             name: "STORE 1 NAME",
+ *             projectId: "PROJECT ID",
+ *             provider: "atlas",
+ *             readPreference: {
+ *                 mode: "secondary",
+ *             },
+ *         },
+ *         {
+ *             bucket: "STORE 2 NAME",
+ *             delimiter: "/",
+ *             name: "S3 BUCKET NAME",
+ *             prefix: "S3 BUCKET PREFIX",
+ *             provider: "s3",
+ *             region: "AWS REGION",
+ *         },
+ *     ],
+ * });
+ * ```
+ *
+ * ## Import
+ *
+ * - The Federated Database Instance can be imported using project ID, name of the instance, in the format `project_id`--`name`, e.g.
+ *
+ * ```sh
+ *  $ pulumi import mongodbatlas:index/federatedDatabaseInstance:FederatedDatabaseInstance mongodbatlas_federated_database_instance.example 1112222b3bf99403840e8934--test
+ * ```
+ *
+ *  - The Federated Database Instance can be imported using project ID, name of the instance and name of the AWS S3 bucket, in the format `project_id`--`name`--`aws_test_s3_bucket`, e.g.
+ *
+ * ```sh
+ *  $ pulumi import mongodbatlas:index/federatedDatabaseInstance:FederatedDatabaseInstance mongodbatlas_federated_database_instance.example 1112222b3bf99403840e8934--test--s3-test
+ * ```
+ *
+ *  See [MongoDB Atlas API](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Data-Federation) Documentation for more information.
+ */
+export declare class FederatedDatabaseInstance extends pulumi.CustomResource {
+    /**
+     * Get an existing FederatedDatabaseInstance resource's state with the given name, ID, and optional extra
+     * properties used to qualify the lookup.
+     *
+     * @param name The _unique_ name of the resulting resource.
+     * @param id The _unique_ provider ID of the resource to lookup.
+     * @param state Any extra arguments used during the lookup.
+     * @param opts Optional settings to control the behavior of the CustomResource.
+     */
+    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: FederatedDatabaseInstanceState, opts?: pulumi.CustomResourceOptions): FederatedDatabaseInstance;
+    /**
+     * Returns true if the given object is an instance of FederatedDatabaseInstance.  This is designed to work even
+     * when multiple copies of the Pulumi SDK have been loaded into the same process.
+     */
+    static isInstance(obj: any): obj is FederatedDatabaseInstance;
+    readonly cloudProviderConfig: pulumi.Output<outputs.FederatedDatabaseInstanceCloudProviderConfig | undefined>;
+    readonly dataProcessRegion: pulumi.Output<outputs.FederatedDatabaseInstanceDataProcessRegion | undefined>;
+    /**
+     * The list of hostnames assigned to the Federated Database Instance. Each string in the array is a hostname assigned to the Federated Database Instance.
+     */
+    readonly hostnames: pulumi.Output<string[]>;
+    /**
+     * Name of the Atlas Federated Database Instance.
+     * ### `cloudProviderConfig` - (Optional) Cloud provider linked to this data federated instance.
+     * #### `aws` - (Required) AWS provider of the cloud service where the Federated Database Instance can access the S3 Bucket. Note this parameter is only required if using `cloudProviderConfig` since AWS is currently the only supported Cloud vendor on this feature at this time.
+     */
+    readonly name: pulumi.Output<string>;
+    /**
+     * The unique ID for the project to create a Federated Database Instance.
+     */
+    readonly projectId: pulumi.Output<string>;
+    /**
+     * Current state of the Federated Database Instance:
+     */
+    readonly state: pulumi.Output<string>;
+    /**
+     * Configuration details for mapping each data store to queryable databases and collections. For complete documentation on this object and its nested fields, see [databases](https://docs.mongodb.com/datalake/reference/format/data-lake-configuration#std-label-datalake-databases-reference). An empty object indicates that the Federated Database Instance has no mapping configuration for any data store.
+     * * `storage_databases.#.name` - Name of the database to which the Federated Database Instance maps the data contained in the data store.
+     * * `storage_databases.#.collections` -     Array of objects where each object represents a collection and data sources that map to a [stores](https://docs.mongodb.com/datalake/reference/format/data-lake-configuration#mongodb-datalakeconf-datalakeconf.stores) data store.
+     * * `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.#.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.
+     * * `storage_databases.#.collections.#.data_sources.#.allow_insecure` - Flag that validates the scheme in the specified URLs. If true, allows insecure HTTP scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server. If false, allows secure HTTPS scheme only.
+     * * `storage_databases.#.collections.#.data_sources.#.database_regex` - Regex pattern to use for creating the wildcard database.
+     * * `storage_databases.#.collections.#.data_sources.#.collection` - Human-readable label that identifies the collection in the database.
+     * * `storage_databases.#.collections.#.data_sources.#.collection_regex` - Regex pattern to use for creating the wildcard (*) collection.
+     * * `storage_databases.#.collections.#.data_sources.#.provenance_field_name` - Name for the field that includes the provenance of the documents in the results.
+     * * `storage_databases.#.collections.#.data_sources.#.storeName` - Human-readable label that identifies the data store that MongoDB Cloud maps to the collection.
+     * * `storage_databases.#.collections.#.data_sources.#.urls` - URLs of the publicly accessible data files. You can't specify URLs that require authentication.
+     * * `storage_databases.#.views` -     Array of objects where each object represents an [aggregation pipeline](https://docs.mongodb.com/manual/core/aggregation-pipeline/#id1) on a collection. To learn more about views, see [Views](https://docs.mongodb.com/manual/core/views/).
+     * * `storage_databases.#.views.#.name` - Name of the view.
+     * * `storage_databases.#.views.#.source` -  Name of the source collection for the view.
+     * * `storage_databases.#.views.#.pipeline`- Aggregation pipeline stage(s) to apply to the source collection.
+     */
+    readonly storageDatabases: pulumi.Output<outputs.FederatedDatabaseInstanceStorageDatabase[] | undefined>;
+    /**
+     * Each object in the array represents a data store. Federated Database uses the storage.databases configuration details to map data in each data store to queryable databases and collections. For complete documentation on this object and its nested fields, see [stores](https://docs.mongodb.com/datalake/reference/format/data-lake-configuration#std-label-datalake-stores-reference). An empty object indicates that the Federated Database Instance has no configured data stores.
+     * * `storage_stores.#.name` - Name of the data store.
+     * * `storage_stores.#.provider` - Defines where the data is stored.
+     * * `storage_stores.#.region` - Name of the AWS region in which the S3 bucket is hosted.
+     * * `storage_stores.#.bucket` - Name of the AWS S3 bucket.
+     * * `storage_stores.#.prefix` - Prefix the Federated Database Instance applies when searching for files in the S3 bucket.
+     * * `storage_stores.#.delimiter` - The delimiter that separates `storage_databases.#.collections.#.data_sources.#.path` segments in the data store.
+     * * `storage_stores.#.include_tags` - Determines whether or not to use S3 tags on the files in the given path as additional partition attributes.
+     * * `storage_stores.#.cluster_name` - Human-readable label of the MongoDB Cloud cluster on which the store is based.
+     * * `storage_stores.#.cluster_id` - ID of the Cluster the Online Archive belongs to.
+     * * `storage_stores.#.allow_insecure` - Flag that validates the scheme in the specified URLs.
+     * * `storage_stores.#.public` - Flag that indicates whether the bucket is public.
+     * * `storage_stores.#.default_format` - Default format that Data Lake assumes if it encounters a file without an extension while searching the storeName.
+     * * `storage_stores.#.urls` - Comma-separated list of publicly accessible HTTP URLs where data is stored.
+     * * `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.
+     */
+    readonly storageStores: pulumi.Output<outputs.FederatedDatabaseInstanceStorageStore[]>;
+    /**
+     * Create a FederatedDatabaseInstance resource with the given unique name, arguments, and options.
+     *
+     * @param name The _unique_ name of the resource.
+     * @param args The arguments to use to populate this resource's properties.
+     * @param opts A bag of options that control this resource's behavior.
+     */
+    constructor(name: string, args: FederatedDatabaseInstanceArgs, opts?: pulumi.CustomResourceOptions);
+}
+/**
+ * Input properties used for looking up and filtering FederatedDatabaseInstance resources.
+ */
+export interface FederatedDatabaseInstanceState {
+    cloudProviderConfig?: pulumi.Input<inputs.FederatedDatabaseInstanceCloudProviderConfig>;
+    dataProcessRegion?: pulumi.Input<inputs.FederatedDatabaseInstanceDataProcessRegion>;
+    /**
+     * The list of hostnames assigned to the Federated Database Instance. Each string in the array is a hostname assigned to the Federated Database Instance.
+     */
+    hostnames?: pulumi.Input<pulumi.Input<string>[]>;
+    /**
+     * Name of the Atlas Federated Database Instance.
+     * ### `cloudProviderConfig` - (Optional) Cloud provider linked to this data federated instance.
+     * #### `aws` - (Required) AWS provider of the cloud service where the Federated Database Instance can access the S3 Bucket. Note this parameter is only required if using `cloudProviderConfig` since AWS is currently the only supported Cloud vendor on this feature at this time.
+     */
+    name?: pulumi.Input<string>;
+    /**
+     * The unique ID for the project to create a Federated Database Instance.
+     */
+    projectId?: pulumi.Input<string>;
+    /**
+     * Current state of the Federated Database Instance:
+     */
+    state?: pulumi.Input<string>;
+    /**
+     * Configuration details for mapping each data store to queryable databases and collections. For complete documentation on this object and its nested fields, see [databases](https://docs.mongodb.com/datalake/reference/format/data-lake-configuration#std-label-datalake-databases-reference). An empty object indicates that the Federated Database Instance has no mapping configuration for any data store.
+     * * `storage_databases.#.name` - Name of the database to which the Federated Database Instance maps the data contained in the data store.
+     * * `storage_databases.#.collections` -     Array of objects where each object represents a collection and data sources that map to a [stores](https://docs.mongodb.com/datalake/reference/format/data-lake-configuration#mongodb-datalakeconf-datalakeconf.stores) data store.
+     * * `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.#.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.
+     * * `storage_databases.#.collections.#.data_sources.#.allow_insecure` - Flag that validates the scheme in the specified URLs. If true, allows insecure HTTP scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server. If false, allows secure HTTPS scheme only.
+     * * `storage_databases.#.collections.#.data_sources.#.database_regex` - Regex pattern to use for creating the wildcard database.
+     * * `storage_databases.#.collections.#.data_sources.#.collection` - Human-readable label that identifies the collection in the database.
+     * * `storage_databases.#.collections.#.data_sources.#.collection_regex` - Regex pattern to use for creating the wildcard (*) collection.
+     * * `storage_databases.#.collections.#.data_sources.#.provenance_field_name` - Name for the field that includes the provenance of the documents in the results.
+     * * `storage_databases.#.collections.#.data_sources.#.storeName` - Human-readable label that identifies the data store that MongoDB Cloud maps to the collection.
+     * * `storage_databases.#.collections.#.data_sources.#.urls` - URLs of the publicly accessible data files. You can't specify URLs that require authentication.
+     * * `storage_databases.#.views` -     Array of objects where each object represents an [aggregation pipeline](https://docs.mongodb.com/manual/core/aggregation-pipeline/#id1) on a collection. To learn more about views, see [Views](https://docs.mongodb.com/manual/core/views/).
+     * * `storage_databases.#.views.#.name` - Name of the view.
+     * * `storage_databases.#.views.#.source` -  Name of the source collection for the view.
+     * * `storage_databases.#.views.#.pipeline`- Aggregation pipeline stage(s) to apply to the source collection.
+     */
+    storageDatabases?: pulumi.Input<pulumi.Input<inputs.FederatedDatabaseInstanceStorageDatabase>[]>;
+    /**
+     * Each object in the array represents a data store. Federated Database uses the storage.databases configuration details to map data in each data store to queryable databases and collections. For complete documentation on this object and its nested fields, see [stores](https://docs.mongodb.com/datalake/reference/format/data-lake-configuration#std-label-datalake-stores-reference). An empty object indicates that the Federated Database Instance has no configured data stores.
+     * * `storage_stores.#.name` - Name of the data store.
+     * * `storage_stores.#.provider` - Defines where the data is stored.
+     * * `storage_stores.#.region` - Name of the AWS region in which the S3 bucket is hosted.
+     * * `storage_stores.#.bucket` - Name of the AWS S3 bucket.
+     * * `storage_stores.#.prefix` - Prefix the Federated Database Instance applies when searching for files in the S3 bucket.
+     * * `storage_stores.#.delimiter` - The delimiter that separates `storage_databases.#.collections.#.data_sources.#.path` segments in the data store.
+     * * `storage_stores.#.include_tags` - Determines whether or not to use S3 tags on the files in the given path as additional partition attributes.
+     * * `storage_stores.#.cluster_name` - Human-readable label of the MongoDB Cloud cluster on which the store is based.
+     * * `storage_stores.#.cluster_id` - ID of the Cluster the Online Archive belongs to.
+     * * `storage_stores.#.allow_insecure` - Flag that validates the scheme in the specified URLs.
+     * * `storage_stores.#.public` - Flag that indicates whether the bucket is public.
+     * * `storage_stores.#.default_format` - Default format that Data Lake assumes if it encounters a file without an extension while searching the storeName.
+     * * `storage_stores.#.urls` - Comma-separated list of publicly accessible HTTP URLs where data is stored.
+     * * `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.
+     */
+    storageStores?: pulumi.Input<pulumi.Input<inputs.FederatedDatabaseInstanceStorageStore>[]>;
+}
+/**
+ * The set of arguments for constructing a FederatedDatabaseInstance resource.
+ */
+export interface FederatedDatabaseInstanceArgs {
+    cloudProviderConfig?: pulumi.Input<inputs.FederatedDatabaseInstanceCloudProviderConfig>;
+    dataProcessRegion?: pulumi.Input<inputs.FederatedDatabaseInstanceDataProcessRegion>;
+    /**
+     * Name of the Atlas Federated Database Instance.
+     * ### `cloudProviderConfig` - (Optional) Cloud provider linked to this data federated instance.
+     * #### `aws` - (Required) AWS provider of the cloud service where the Federated Database Instance can access the S3 Bucket. Note this parameter is only required if using `cloudProviderConfig` since AWS is currently the only supported Cloud vendor on this feature at this time.
+     */
+    name?: pulumi.Input<string>;
+    /**
+     * The unique ID for the project to create a Federated Database Instance.
+     */
+    projectId: pulumi.Input<string>;
+    /**
+     * Configuration details for mapping each data store to queryable databases and collections. For complete documentation on this object and its nested fields, see [databases](https://docs.mongodb.com/datalake/reference/format/data-lake-configuration#std-label-datalake-databases-reference). An empty object indicates that the Federated Database Instance has no mapping configuration for any data store.
+     * * `storage_databases.#.name` - Name of the database to which the Federated Database Instance maps the data contained in the data store.
+     * * `storage_databases.#.collections` -     Array of objects where each object represents a collection and data sources that map to a [stores](https://docs.mongodb.com/datalake/reference/format/data-lake-configuration#mongodb-datalakeconf-datalakeconf.stores) data store.
+     * * `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.#.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.
+     * * `storage_databases.#.collections.#.data_sources.#.allow_insecure` - Flag that validates the scheme in the specified URLs. If true, allows insecure HTTP scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server. If false, allows secure HTTPS scheme only.
+     * * `storage_databases.#.collections.#.data_sources.#.database_regex` - Regex pattern to use for creating the wildcard database.
+     * * `storage_databases.#.collections.#.data_sources.#.collection` - Human-readable label that identifies the collection in the database.
+     * * `storage_databases.#.collections.#.data_sources.#.collection_regex` - Regex pattern to use for creating the wildcard (*) collection.
+     * * `storage_databases.#.collections.#.data_sources.#.provenance_field_name` - Name for the field that includes the provenance of the documents in the results.
+     * * `storage_databases.#.collections.#.data_sources.#.storeName` - Human-readable label that identifies the data store that MongoDB Cloud maps to the collection.
+     * * `storage_databases.#.collections.#.data_sources.#.urls` - URLs of the publicly accessible data files. You can't specify URLs that require authentication.
+     * * `storage_databases.#.views` -     Array of objects where each object represents an [aggregation pipeline](https://docs.mongodb.com/manual/core/aggregation-pipeline/#id1) on a collection. To learn more about views, see [Views](https://docs.mongodb.com/manual/core/views/).
+     * * `storage_databases.#.views.#.name` - Name of the view.
+     * * `storage_databases.#.views.#.source` -  Name of the source collection for the view.
+     * * `storage_databases.#.views.#.pipeline`- Aggregation pipeline stage(s) to apply to the source collection.
+     */
+    storageDatabases?: pulumi.Input<pulumi.Input<inputs.FederatedDatabaseInstanceStorageDatabase>[]>;
+    /**
+     * Each object in the array represents a data store. Federated Database uses the storage.databases configuration details to map data in each data store to queryable databases and collections. For complete documentation on this object and its nested fields, see [stores](https://docs.mongodb.com/datalake/reference/format/data-lake-configuration#std-label-datalake-stores-reference). An empty object indicates that the Federated Database Instance has no configured data stores.
+     * * `storage_stores.#.name` - Name of the data store.
+     * * `storage_stores.#.provider` - Defines where the data is stored.
+     * * `storage_stores.#.region` - Name of the AWS region in which the S3 bucket is hosted.
+     * * `storage_stores.#.bucket` - Name of the AWS S3 bucket.
+     * * `storage_stores.#.prefix` - Prefix the Federated Database Instance applies when searching for files in the S3 bucket.
+     * * `storage_stores.#.delimiter` - The delimiter that separates `storage_databases.#.collections.#.data_sources.#.path` segments in the data store.
+     * * `storage_stores.#.include_tags` - Determines whether or not to use S3 tags on the files in the given path as additional partition attributes.
+     * * `storage_stores.#.cluster_name` - Human-readable label of the MongoDB Cloud cluster on which the store is based.
+     * * `storage_stores.#.cluster_id` - ID of the Cluster the Online Archive belongs to.
+     * * `storage_stores.#.allow_insecure` - Flag that validates the scheme in the specified URLs.
+     * * `storage_stores.#.public` - Flag that indicates whether the bucket is public.
+     * * `storage_stores.#.default_format` - Default format that Data Lake assumes if it encounters a file without an extension while searching the storeName.
+     * * `storage_stores.#.urls` - Comma-separated list of publicly accessible HTTP URLs where data is stored.
+     * * `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.
+     */
+    storageStores?: pulumi.Input<pulumi.Input<inputs.FederatedDatabaseInstanceStorageStore>[]>;
+}