1. Packages
  2. MongoDB Atlas
  3. API Docs
  4. FederatedDatabaseInstance
MongoDB Atlas v3.16.2 published on Friday, Jun 21, 2024 by Pulumi

mongodbatlas.FederatedDatabaseInstance

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.16.2 published on Friday, Jun 21, 2024 by Pulumi

    mongodbatlas.FederatedDatabaseInstance provides a Federated Database Instance resource.

    NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.

    Example Usage

    S With MongoDB Atlas Cluster As Storage Database

    import * as pulumi from "@pulumi/pulumi";
    import * as mongodbatlas from "@pulumi/mongodbatlas";
    
    const test = new mongodbatlas.FederatedDatabaseInstance("test", {
        projectId: "PROJECT ID",
        name: "TENANT NAME OF THE FEDERATED DATABASE INSTANCE",
        storageDatabases: [{
            name: "VirtualDatabase0",
            collections: [{
                name: "NAME OF THE COLLECTION",
                dataSources: [{
                    collection: "COLLECTION IN THE CLUSTER",
                    database: "DB IN THE CLUSTER",
                    storeName: "CLUSTER NAME",
                }],
            }],
        }],
        storageStores: [{
            name: "STORE 1 NAME",
            clusterName: "CLUSTER NAME",
            projectId: "PROJECT ID",
            provider: "atlas",
            readPreference: {
                mode: "secondary",
            },
        }],
    });
    
    import pulumi
    import pulumi_mongodbatlas as mongodbatlas
    
    test = mongodbatlas.FederatedDatabaseInstance("test",
        project_id="PROJECT ID",
        name="TENANT NAME OF THE FEDERATED DATABASE INSTANCE",
        storage_databases=[mongodbatlas.FederatedDatabaseInstanceStorageDatabaseArgs(
            name="VirtualDatabase0",
            collections=[mongodbatlas.FederatedDatabaseInstanceStorageDatabaseCollectionArgs(
                name="NAME OF THE COLLECTION",
                data_sources=[mongodbatlas.FederatedDatabaseInstanceStorageDatabaseCollectionDataSourceArgs(
                    collection="COLLECTION IN THE CLUSTER",
                    database="DB IN THE CLUSTER",
                    store_name="CLUSTER NAME",
                )],
            )],
        )],
        storage_stores=[mongodbatlas.FederatedDatabaseInstanceStorageStoreArgs(
            name="STORE 1 NAME",
            cluster_name="CLUSTER NAME",
            project_id="PROJECT ID",
            provider="atlas",
            read_preference=mongodbatlas.FederatedDatabaseInstanceStorageStoreReadPreferenceArgs(
                mode="secondary",
            ),
        )])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-mongodbatlas/sdk/v3/go/mongodbatlas"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := mongodbatlas.NewFederatedDatabaseInstance(ctx, "test", &mongodbatlas.FederatedDatabaseInstanceArgs{
    			ProjectId: pulumi.String("PROJECT ID"),
    			Name:      pulumi.String("TENANT NAME OF THE FEDERATED DATABASE INSTANCE"),
    			StorageDatabases: mongodbatlas.FederatedDatabaseInstanceStorageDatabaseArray{
    				&mongodbatlas.FederatedDatabaseInstanceStorageDatabaseArgs{
    					Name: pulumi.String("VirtualDatabase0"),
    					Collections: mongodbatlas.FederatedDatabaseInstanceStorageDatabaseCollectionArray{
    						&mongodbatlas.FederatedDatabaseInstanceStorageDatabaseCollectionArgs{
    							Name: pulumi.String("NAME OF THE COLLECTION"),
    							DataSources: mongodbatlas.FederatedDatabaseInstanceStorageDatabaseCollectionDataSourceArray{
    								&mongodbatlas.FederatedDatabaseInstanceStorageDatabaseCollectionDataSourceArgs{
    									Collection: pulumi.String("COLLECTION IN THE CLUSTER"),
    									Database:   pulumi.String("DB IN THE CLUSTER"),
    									StoreName:  pulumi.String("CLUSTER NAME"),
    								},
    							},
    						},
    					},
    				},
    			},
    			StorageStores: mongodbatlas.FederatedDatabaseInstanceStorageStoreArray{
    				&mongodbatlas.FederatedDatabaseInstanceStorageStoreArgs{
    					Name:        pulumi.String("STORE 1 NAME"),
    					ClusterName: pulumi.String("CLUSTER NAME"),
    					ProjectId:   pulumi.String("PROJECT ID"),
    					Provider:    pulumi.String("atlas"),
    					ReadPreference: &mongodbatlas.FederatedDatabaseInstanceStorageStoreReadPreferenceArgs{
    						Mode: pulumi.String("secondary"),
    					},
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Mongodbatlas = Pulumi.Mongodbatlas;
    
    return await Deployment.RunAsync(() => 
    {
        var test = new Mongodbatlas.FederatedDatabaseInstance("test", new()
        {
            ProjectId = "PROJECT ID",
            Name = "TENANT NAME OF THE FEDERATED DATABASE INSTANCE",
            StorageDatabases = new[]
            {
                new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageDatabaseArgs
                {
                    Name = "VirtualDatabase0",
                    Collections = new[]
                    {
                        new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageDatabaseCollectionArgs
                        {
                            Name = "NAME OF THE COLLECTION",
                            DataSources = new[]
                            {
                                new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageDatabaseCollectionDataSourceArgs
                                {
                                    Collection = "COLLECTION IN THE CLUSTER",
                                    Database = "DB IN THE CLUSTER",
                                    StoreName = "CLUSTER NAME",
                                },
                            },
                        },
                    },
                },
            },
            StorageStores = new[]
            {
                new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageStoreArgs
                {
                    Name = "STORE 1 NAME",
                    ClusterName = "CLUSTER NAME",
                    ProjectId = "PROJECT ID",
                    Provider = "atlas",
                    ReadPreference = new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageStoreReadPreferenceArgs
                    {
                        Mode = "secondary",
                    },
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.mongodbatlas.FederatedDatabaseInstance;
    import com.pulumi.mongodbatlas.FederatedDatabaseInstanceArgs;
    import com.pulumi.mongodbatlas.inputs.FederatedDatabaseInstanceStorageDatabaseArgs;
    import com.pulumi.mongodbatlas.inputs.FederatedDatabaseInstanceStorageStoreArgs;
    import com.pulumi.mongodbatlas.inputs.FederatedDatabaseInstanceStorageStoreReadPreferenceArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var test = new FederatedDatabaseInstance("test", FederatedDatabaseInstanceArgs.builder()
                .projectId("PROJECT ID")
                .name("TENANT NAME OF THE FEDERATED DATABASE INSTANCE")
                .storageDatabases(FederatedDatabaseInstanceStorageDatabaseArgs.builder()
                    .name("VirtualDatabase0")
                    .collections(FederatedDatabaseInstanceStorageDatabaseCollectionArgs.builder()
                        .name("NAME OF THE COLLECTION")
                        .dataSources(FederatedDatabaseInstanceStorageDatabaseCollectionDataSourceArgs.builder()
                            .collection("COLLECTION IN THE CLUSTER")
                            .database("DB IN THE CLUSTER")
                            .storeName("CLUSTER NAME")
                            .build())
                        .build())
                    .build())
                .storageStores(FederatedDatabaseInstanceStorageStoreArgs.builder()
                    .name("STORE 1 NAME")
                    .clusterName("CLUSTER NAME")
                    .projectId("PROJECT ID")
                    .provider("atlas")
                    .readPreference(FederatedDatabaseInstanceStorageStoreReadPreferenceArgs.builder()
                        .mode("secondary")
                        .build())
                    .build())
                .build());
    
        }
    }
    
    resources:
      test:
        type: mongodbatlas:FederatedDatabaseInstance
        properties:
          projectId: PROJECT ID
          name: TENANT NAME OF THE FEDERATED DATABASE INSTANCE
          storageDatabases:
            - name: VirtualDatabase0
              collections:
                - name: NAME OF THE COLLECTION
                  dataSources:
                    - collection: COLLECTION IN THE CLUSTER
                      database: DB IN THE CLUSTER
                      storeName: CLUSTER NAME
          storageStores:
            - name: STORE 1 NAME
              clusterName: CLUSTER NAME
              projectId: PROJECT ID
              provider: atlas
              readPreference:
                mode: secondary
    

    S With Amazon S3 Bucket As Storage Database

    import * as pulumi from "@pulumi/pulumi";
    import * as mongodbatlas from "@pulumi/mongodbatlas";
    
    const test = new mongodbatlas.FederatedDatabaseInstance("test", {
        projectId: "PROJECT ID",
        name: "TENANT NAME OF THE FEDERATED DATABASE INSTANCE",
        cloudProviderConfig: {
            aws: {
                roleId: "AWS ROLE ID",
                testS3Bucket: "S3 BUCKET NAME",
            },
        },
        storageDatabases: [{
            name: "VirtualDatabase0",
            collections: [{
                name: "NAME OF THE COLLECTION",
                dataSources: [
                    {
                        collection: "COLLECTION IN THE CLUSTER",
                        database: "DB IN THE CLUSTER",
                        storeName: "CLUSTER NAME",
                    },
                    {
                        storeName: "S3 BUCKET NAME",
                        path: "S3 BUCKET PATH",
                    },
                ],
            }],
        }],
        storageStores: [
            {
                name: "STORE 1 NAME",
                clusterName: "CLUSTER 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 pulumi
    import pulumi_mongodbatlas as mongodbatlas
    
    test = mongodbatlas.FederatedDatabaseInstance("test",
        project_id="PROJECT ID",
        name="TENANT NAME OF THE FEDERATED DATABASE INSTANCE",
        cloud_provider_config=mongodbatlas.FederatedDatabaseInstanceCloudProviderConfigArgs(
            aws=mongodbatlas.FederatedDatabaseInstanceCloudProviderConfigAwsArgs(
                role_id="AWS ROLE ID",
                test_s3_bucket="S3 BUCKET NAME",
            ),
        ),
        storage_databases=[mongodbatlas.FederatedDatabaseInstanceStorageDatabaseArgs(
            name="VirtualDatabase0",
            collections=[mongodbatlas.FederatedDatabaseInstanceStorageDatabaseCollectionArgs(
                name="NAME OF THE COLLECTION",
                data_sources=[
                    mongodbatlas.FederatedDatabaseInstanceStorageDatabaseCollectionDataSourceArgs(
                        collection="COLLECTION IN THE CLUSTER",
                        database="DB IN THE CLUSTER",
                        store_name="CLUSTER NAME",
                    ),
                    mongodbatlas.FederatedDatabaseInstanceStorageDatabaseCollectionDataSourceArgs(
                        store_name="S3 BUCKET NAME",
                        path="S3 BUCKET PATH",
                    ),
                ],
            )],
        )],
        storage_stores=[
            mongodbatlas.FederatedDatabaseInstanceStorageStoreArgs(
                name="STORE 1 NAME",
                cluster_name="CLUSTER NAME",
                project_id="PROJECT ID",
                provider="atlas",
                read_preference=mongodbatlas.FederatedDatabaseInstanceStorageStoreReadPreferenceArgs(
                    mode="secondary",
                ),
            ),
            mongodbatlas.FederatedDatabaseInstanceStorageStoreArgs(
                bucket="STORE 2 NAME",
                delimiter="/",
                name="S3 BUCKET NAME",
                prefix="S3 BUCKET PREFIX",
                provider="s3",
                region="AWS REGION",
            ),
        ])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-mongodbatlas/sdk/v3/go/mongodbatlas"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := mongodbatlas.NewFederatedDatabaseInstance(ctx, "test", &mongodbatlas.FederatedDatabaseInstanceArgs{
    			ProjectId: pulumi.String("PROJECT ID"),
    			Name:      pulumi.String("TENANT NAME OF THE FEDERATED DATABASE INSTANCE"),
    			CloudProviderConfig: &mongodbatlas.FederatedDatabaseInstanceCloudProviderConfigArgs{
    				Aws: &mongodbatlas.FederatedDatabaseInstanceCloudProviderConfigAwsArgs{
    					RoleId:       pulumi.String("AWS ROLE ID"),
    					TestS3Bucket: pulumi.String("S3 BUCKET NAME"),
    				},
    			},
    			StorageDatabases: mongodbatlas.FederatedDatabaseInstanceStorageDatabaseArray{
    				&mongodbatlas.FederatedDatabaseInstanceStorageDatabaseArgs{
    					Name: pulumi.String("VirtualDatabase0"),
    					Collections: mongodbatlas.FederatedDatabaseInstanceStorageDatabaseCollectionArray{
    						&mongodbatlas.FederatedDatabaseInstanceStorageDatabaseCollectionArgs{
    							Name: pulumi.String("NAME OF THE COLLECTION"),
    							DataSources: mongodbatlas.FederatedDatabaseInstanceStorageDatabaseCollectionDataSourceArray{
    								&mongodbatlas.FederatedDatabaseInstanceStorageDatabaseCollectionDataSourceArgs{
    									Collection: pulumi.String("COLLECTION IN THE CLUSTER"),
    									Database:   pulumi.String("DB IN THE CLUSTER"),
    									StoreName:  pulumi.String("CLUSTER NAME"),
    								},
    								&mongodbatlas.FederatedDatabaseInstanceStorageDatabaseCollectionDataSourceArgs{
    									StoreName: pulumi.String("S3 BUCKET NAME"),
    									Path:      pulumi.String("S3 BUCKET PATH"),
    								},
    							},
    						},
    					},
    				},
    			},
    			StorageStores: mongodbatlas.FederatedDatabaseInstanceStorageStoreArray{
    				&mongodbatlas.FederatedDatabaseInstanceStorageStoreArgs{
    					Name:        pulumi.String("STORE 1 NAME"),
    					ClusterName: pulumi.String("CLUSTER NAME"),
    					ProjectId:   pulumi.String("PROJECT ID"),
    					Provider:    pulumi.String("atlas"),
    					ReadPreference: &mongodbatlas.FederatedDatabaseInstanceStorageStoreReadPreferenceArgs{
    						Mode: pulumi.String("secondary"),
    					},
    				},
    				&mongodbatlas.FederatedDatabaseInstanceStorageStoreArgs{
    					Bucket:    pulumi.String("STORE 2 NAME"),
    					Delimiter: pulumi.String("/"),
    					Name:      pulumi.String("S3 BUCKET NAME"),
    					Prefix:    pulumi.String("S3 BUCKET PREFIX"),
    					Provider:  pulumi.String("s3"),
    					Region:    pulumi.String("AWS REGION"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Mongodbatlas = Pulumi.Mongodbatlas;
    
    return await Deployment.RunAsync(() => 
    {
        var test = new Mongodbatlas.FederatedDatabaseInstance("test", new()
        {
            ProjectId = "PROJECT ID",
            Name = "TENANT NAME OF THE FEDERATED DATABASE INSTANCE",
            CloudProviderConfig = new Mongodbatlas.Inputs.FederatedDatabaseInstanceCloudProviderConfigArgs
            {
                Aws = new Mongodbatlas.Inputs.FederatedDatabaseInstanceCloudProviderConfigAwsArgs
                {
                    RoleId = "AWS ROLE ID",
                    TestS3Bucket = "S3 BUCKET NAME",
                },
            },
            StorageDatabases = new[]
            {
                new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageDatabaseArgs
                {
                    Name = "VirtualDatabase0",
                    Collections = new[]
                    {
                        new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageDatabaseCollectionArgs
                        {
                            Name = "NAME OF THE COLLECTION",
                            DataSources = new[]
                            {
                                new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageDatabaseCollectionDataSourceArgs
                                {
                                    Collection = "COLLECTION IN THE CLUSTER",
                                    Database = "DB IN THE CLUSTER",
                                    StoreName = "CLUSTER NAME",
                                },
                                new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageDatabaseCollectionDataSourceArgs
                                {
                                    StoreName = "S3 BUCKET NAME",
                                    Path = "S3 BUCKET PATH",
                                },
                            },
                        },
                    },
                },
            },
            StorageStores = new[]
            {
                new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageStoreArgs
                {
                    Name = "STORE 1 NAME",
                    ClusterName = "CLUSTER NAME",
                    ProjectId = "PROJECT ID",
                    Provider = "atlas",
                    ReadPreference = new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageStoreReadPreferenceArgs
                    {
                        Mode = "secondary",
                    },
                },
                new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageStoreArgs
                {
                    Bucket = "STORE 2 NAME",
                    Delimiter = "/",
                    Name = "S3 BUCKET NAME",
                    Prefix = "S3 BUCKET PREFIX",
                    Provider = "s3",
                    Region = "AWS REGION",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.mongodbatlas.FederatedDatabaseInstance;
    import com.pulumi.mongodbatlas.FederatedDatabaseInstanceArgs;
    import com.pulumi.mongodbatlas.inputs.FederatedDatabaseInstanceCloudProviderConfigArgs;
    import com.pulumi.mongodbatlas.inputs.FederatedDatabaseInstanceCloudProviderConfigAwsArgs;
    import com.pulumi.mongodbatlas.inputs.FederatedDatabaseInstanceStorageDatabaseArgs;
    import com.pulumi.mongodbatlas.inputs.FederatedDatabaseInstanceStorageStoreArgs;
    import com.pulumi.mongodbatlas.inputs.FederatedDatabaseInstanceStorageStoreReadPreferenceArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var test = new FederatedDatabaseInstance("test", FederatedDatabaseInstanceArgs.builder()
                .projectId("PROJECT ID")
                .name("TENANT NAME OF THE FEDERATED DATABASE INSTANCE")
                .cloudProviderConfig(FederatedDatabaseInstanceCloudProviderConfigArgs.builder()
                    .aws(FederatedDatabaseInstanceCloudProviderConfigAwsArgs.builder()
                        .roleId("AWS ROLE ID")
                        .testS3Bucket("S3 BUCKET NAME")
                        .build())
                    .build())
                .storageDatabases(FederatedDatabaseInstanceStorageDatabaseArgs.builder()
                    .name("VirtualDatabase0")
                    .collections(FederatedDatabaseInstanceStorageDatabaseCollectionArgs.builder()
                        .name("NAME OF THE COLLECTION")
                        .dataSources(                    
                            FederatedDatabaseInstanceStorageDatabaseCollectionDataSourceArgs.builder()
                                .collection("COLLECTION IN THE CLUSTER")
                                .database("DB IN THE CLUSTER")
                                .storeName("CLUSTER NAME")
                                .build(),
                            FederatedDatabaseInstanceStorageDatabaseCollectionDataSourceArgs.builder()
                                .storeName("S3 BUCKET NAME")
                                .path("S3 BUCKET PATH")
                                .build())
                        .build())
                    .build())
                .storageStores(            
                    FederatedDatabaseInstanceStorageStoreArgs.builder()
                        .name("STORE 1 NAME")
                        .clusterName("CLUSTER NAME")
                        .projectId("PROJECT ID")
                        .provider("atlas")
                        .readPreference(FederatedDatabaseInstanceStorageStoreReadPreferenceArgs.builder()
                            .mode("secondary")
                            .build())
                        .build(),
                    FederatedDatabaseInstanceStorageStoreArgs.builder()
                        .bucket("STORE 2 NAME")
                        .delimiter("/")
                        .name("S3 BUCKET NAME")
                        .prefix("S3 BUCKET PREFIX")
                        .provider("s3")
                        .region("AWS REGION")
                        .build())
                .build());
    
        }
    }
    
    resources:
      test:
        type: mongodbatlas:FederatedDatabaseInstance
        properties:
          projectId: PROJECT ID
          name: TENANT NAME OF THE FEDERATED DATABASE INSTANCE
          cloudProviderConfig:
            aws:
              roleId: AWS ROLE ID
              testS3Bucket: S3 BUCKET NAME
          storageDatabases:
            - name: VirtualDatabase0
              collections:
                - name: NAME OF THE COLLECTION
                  dataSources:
                    - collection: COLLECTION IN THE CLUSTER
                      database: DB IN THE CLUSTER
                      storeName: CLUSTER NAME
                    - storeName: S3 BUCKET NAME
                      path: S3 BUCKET PATH
          storageStores:
            - name: STORE 1 NAME
              clusterName: CLUSTER 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
    

    Example specifying data process region and provider

    import * as pulumi from "@pulumi/pulumi";
    import * as mongodbatlas from "@pulumi/mongodbatlas";
    
    const test = new mongodbatlas.FederatedDatabaseInstance("test", {
        projectId: "PROJECT ID",
        name: "NAME OF THE FEDERATED DATABASE INSTANCE",
        dataProcessRegion: {
            cloudProvider: "AWS",
            region: "OREGON_USA",
        },
    });
    
    import pulumi
    import pulumi_mongodbatlas as mongodbatlas
    
    test = mongodbatlas.FederatedDatabaseInstance("test",
        project_id="PROJECT ID",
        name="NAME OF THE FEDERATED DATABASE INSTANCE",
        data_process_region=mongodbatlas.FederatedDatabaseInstanceDataProcessRegionArgs(
            cloud_provider="AWS",
            region="OREGON_USA",
        ))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-mongodbatlas/sdk/v3/go/mongodbatlas"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := mongodbatlas.NewFederatedDatabaseInstance(ctx, "test", &mongodbatlas.FederatedDatabaseInstanceArgs{
    			ProjectId: pulumi.String("PROJECT ID"),
    			Name:      pulumi.String("NAME OF THE FEDERATED DATABASE INSTANCE"),
    			DataProcessRegion: &mongodbatlas.FederatedDatabaseInstanceDataProcessRegionArgs{
    				CloudProvider: pulumi.String("AWS"),
    				Region:        pulumi.String("OREGON_USA"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Mongodbatlas = Pulumi.Mongodbatlas;
    
    return await Deployment.RunAsync(() => 
    {
        var test = new Mongodbatlas.FederatedDatabaseInstance("test", new()
        {
            ProjectId = "PROJECT ID",
            Name = "NAME OF THE FEDERATED DATABASE INSTANCE",
            DataProcessRegion = new Mongodbatlas.Inputs.FederatedDatabaseInstanceDataProcessRegionArgs
            {
                CloudProvider = "AWS",
                Region = "OREGON_USA",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.mongodbatlas.FederatedDatabaseInstance;
    import com.pulumi.mongodbatlas.FederatedDatabaseInstanceArgs;
    import com.pulumi.mongodbatlas.inputs.FederatedDatabaseInstanceDataProcessRegionArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var test = new FederatedDatabaseInstance("test", FederatedDatabaseInstanceArgs.builder()
                .projectId("PROJECT ID")
                .name("NAME OF THE FEDERATED DATABASE INSTANCE")
                .dataProcessRegion(FederatedDatabaseInstanceDataProcessRegionArgs.builder()
                    .cloudProvider("AWS")
                    .region("OREGON_USA")
                    .build())
                .build());
    
        }
    }
    
    resources:
      test:
        type: mongodbatlas:FederatedDatabaseInstance
        properties:
          projectId: PROJECT ID
          name: NAME OF THE FEDERATED DATABASE INSTANCE
          dataProcessRegion:
            cloudProvider: AWS
            region: OREGON_USA
    

    Create FederatedDatabaseInstance Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new FederatedDatabaseInstance(name: string, args: FederatedDatabaseInstanceArgs, opts?: CustomResourceOptions);
    @overload
    def FederatedDatabaseInstance(resource_name: str,
                                  args: FederatedDatabaseInstanceArgs,
                                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def FederatedDatabaseInstance(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  project_id: Optional[str] = None,
                                  cloud_provider_config: Optional[FederatedDatabaseInstanceCloudProviderConfigArgs] = None,
                                  data_process_region: Optional[FederatedDatabaseInstanceDataProcessRegionArgs] = None,
                                  name: Optional[str] = None,
                                  storage_databases: Optional[Sequence[FederatedDatabaseInstanceStorageDatabaseArgs]] = None,
                                  storage_stores: Optional[Sequence[FederatedDatabaseInstanceStorageStoreArgs]] = None)
    func NewFederatedDatabaseInstance(ctx *Context, name string, args FederatedDatabaseInstanceArgs, opts ...ResourceOption) (*FederatedDatabaseInstance, error)
    public FederatedDatabaseInstance(string name, FederatedDatabaseInstanceArgs args, CustomResourceOptions? opts = null)
    public FederatedDatabaseInstance(String name, FederatedDatabaseInstanceArgs args)
    public FederatedDatabaseInstance(String name, FederatedDatabaseInstanceArgs args, CustomResourceOptions options)
    
    type: mongodbatlas:FederatedDatabaseInstance
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args FederatedDatabaseInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args FederatedDatabaseInstanceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args FederatedDatabaseInstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FederatedDatabaseInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FederatedDatabaseInstanceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var federatedDatabaseInstanceResource = new Mongodbatlas.FederatedDatabaseInstance("federatedDatabaseInstanceResource", new()
    {
        ProjectId = "string",
        CloudProviderConfig = new Mongodbatlas.Inputs.FederatedDatabaseInstanceCloudProviderConfigArgs
        {
            Aws = new Mongodbatlas.Inputs.FederatedDatabaseInstanceCloudProviderConfigAwsArgs
            {
                RoleId = "string",
                TestS3Bucket = "string",
                ExternalId = "string",
                IamAssumedRoleArn = "string",
                IamUserArn = "string",
            },
        },
        DataProcessRegion = new Mongodbatlas.Inputs.FederatedDatabaseInstanceDataProcessRegionArgs
        {
            CloudProvider = "string",
            Region = "string",
        },
        Name = "string",
        StorageDatabases = new[]
        {
            new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageDatabaseArgs
            {
                Collections = new[]
                {
                    new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageDatabaseCollectionArgs
                    {
                        DataSources = new[]
                        {
                            new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageDatabaseCollectionDataSourceArgs
                            {
                                AllowInsecure = false,
                                Collection = "string",
                                CollectionRegex = "string",
                                Database = "string",
                                DatabaseRegex = "string",
                                DatasetName = "string",
                                DefaultFormat = "string",
                                Path = "string",
                                ProvenanceFieldName = "string",
                                StoreName = "string",
                                Urls = new[]
                                {
                                    "string",
                                },
                            },
                        },
                        Name = "string",
                    },
                },
                MaxWildcardCollections = 0,
                Name = "string",
                Views = new[]
                {
                    new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageDatabaseViewArgs
                    {
                        Name = "string",
                        Pipeline = "string",
                        Source = "string",
                    },
                },
            },
        },
        StorageStores = new[]
        {
            new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageStoreArgs
            {
                AdditionalStorageClasses = new[]
                {
                    "string",
                },
                AllowInsecure = false,
                Bucket = "string",
                ClusterName = "string",
                DefaultFormat = "string",
                Delimiter = "string",
                IncludeTags = false,
                Name = "string",
                Prefix = "string",
                ProjectId = "string",
                Provider = "string",
                Public = "string",
                ReadPreference = new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageStoreReadPreferenceArgs
                {
                    MaxStalenessSeconds = 0,
                    Mode = "string",
                    TagSets = new[]
                    {
                        new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageStoreReadPreferenceTagSetArgs
                        {
                            Tags = new[]
                            {
                                new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageStoreReadPreferenceTagSetTagArgs
                                {
                                    Name = "string",
                                    Value = "string",
                                },
                            },
                        },
                    },
                },
                Region = "string",
                Urls = new[]
                {
                    "string",
                },
            },
        },
    });
    
    example, err := mongodbatlas.NewFederatedDatabaseInstance(ctx, "federatedDatabaseInstanceResource", &mongodbatlas.FederatedDatabaseInstanceArgs{
    	ProjectId: pulumi.String("string"),
    	CloudProviderConfig: &mongodbatlas.FederatedDatabaseInstanceCloudProviderConfigArgs{
    		Aws: &mongodbatlas.FederatedDatabaseInstanceCloudProviderConfigAwsArgs{
    			RoleId:            pulumi.String("string"),
    			TestS3Bucket:      pulumi.String("string"),
    			ExternalId:        pulumi.String("string"),
    			IamAssumedRoleArn: pulumi.String("string"),
    			IamUserArn:        pulumi.String("string"),
    		},
    	},
    	DataProcessRegion: &mongodbatlas.FederatedDatabaseInstanceDataProcessRegionArgs{
    		CloudProvider: pulumi.String("string"),
    		Region:        pulumi.String("string"),
    	},
    	Name: pulumi.String("string"),
    	StorageDatabases: mongodbatlas.FederatedDatabaseInstanceStorageDatabaseArray{
    		&mongodbatlas.FederatedDatabaseInstanceStorageDatabaseArgs{
    			Collections: mongodbatlas.FederatedDatabaseInstanceStorageDatabaseCollectionArray{
    				&mongodbatlas.FederatedDatabaseInstanceStorageDatabaseCollectionArgs{
    					DataSources: mongodbatlas.FederatedDatabaseInstanceStorageDatabaseCollectionDataSourceArray{
    						&mongodbatlas.FederatedDatabaseInstanceStorageDatabaseCollectionDataSourceArgs{
    							AllowInsecure:       pulumi.Bool(false),
    							Collection:          pulumi.String("string"),
    							CollectionRegex:     pulumi.String("string"),
    							Database:            pulumi.String("string"),
    							DatabaseRegex:       pulumi.String("string"),
    							DatasetName:         pulumi.String("string"),
    							DefaultFormat:       pulumi.String("string"),
    							Path:                pulumi.String("string"),
    							ProvenanceFieldName: pulumi.String("string"),
    							StoreName:           pulumi.String("string"),
    							Urls: pulumi.StringArray{
    								pulumi.String("string"),
    							},
    						},
    					},
    					Name: pulumi.String("string"),
    				},
    			},
    			MaxWildcardCollections: pulumi.Int(0),
    			Name:                   pulumi.String("string"),
    			Views: mongodbatlas.FederatedDatabaseInstanceStorageDatabaseViewArray{
    				&mongodbatlas.FederatedDatabaseInstanceStorageDatabaseViewArgs{
    					Name:     pulumi.String("string"),
    					Pipeline: pulumi.String("string"),
    					Source:   pulumi.String("string"),
    				},
    			},
    		},
    	},
    	StorageStores: mongodbatlas.FederatedDatabaseInstanceStorageStoreArray{
    		&mongodbatlas.FederatedDatabaseInstanceStorageStoreArgs{
    			AdditionalStorageClasses: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			AllowInsecure: pulumi.Bool(false),
    			Bucket:        pulumi.String("string"),
    			ClusterName:   pulumi.String("string"),
    			DefaultFormat: pulumi.String("string"),
    			Delimiter:     pulumi.String("string"),
    			IncludeTags:   pulumi.Bool(false),
    			Name:          pulumi.String("string"),
    			Prefix:        pulumi.String("string"),
    			ProjectId:     pulumi.String("string"),
    			Provider:      pulumi.String("string"),
    			Public:        pulumi.String("string"),
    			ReadPreference: &mongodbatlas.FederatedDatabaseInstanceStorageStoreReadPreferenceArgs{
    				MaxStalenessSeconds: pulumi.Int(0),
    				Mode:                pulumi.String("string"),
    				TagSets: mongodbatlas.FederatedDatabaseInstanceStorageStoreReadPreferenceTagSetArray{
    					&mongodbatlas.FederatedDatabaseInstanceStorageStoreReadPreferenceTagSetArgs{
    						Tags: mongodbatlas.FederatedDatabaseInstanceStorageStoreReadPreferenceTagSetTagArray{
    							&mongodbatlas.FederatedDatabaseInstanceStorageStoreReadPreferenceTagSetTagArgs{
    								Name:  pulumi.String("string"),
    								Value: pulumi.String("string"),
    							},
    						},
    					},
    				},
    			},
    			Region: pulumi.String("string"),
    			Urls: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    		},
    	},
    })
    
    var federatedDatabaseInstanceResource = new FederatedDatabaseInstance("federatedDatabaseInstanceResource", FederatedDatabaseInstanceArgs.builder()
        .projectId("string")
        .cloudProviderConfig(FederatedDatabaseInstanceCloudProviderConfigArgs.builder()
            .aws(FederatedDatabaseInstanceCloudProviderConfigAwsArgs.builder()
                .roleId("string")
                .testS3Bucket("string")
                .externalId("string")
                .iamAssumedRoleArn("string")
                .iamUserArn("string")
                .build())
            .build())
        .dataProcessRegion(FederatedDatabaseInstanceDataProcessRegionArgs.builder()
            .cloudProvider("string")
            .region("string")
            .build())
        .name("string")
        .storageDatabases(FederatedDatabaseInstanceStorageDatabaseArgs.builder()
            .collections(FederatedDatabaseInstanceStorageDatabaseCollectionArgs.builder()
                .dataSources(FederatedDatabaseInstanceStorageDatabaseCollectionDataSourceArgs.builder()
                    .allowInsecure(false)
                    .collection("string")
                    .collectionRegex("string")
                    .database("string")
                    .databaseRegex("string")
                    .datasetName("string")
                    .defaultFormat("string")
                    .path("string")
                    .provenanceFieldName("string")
                    .storeName("string")
                    .urls("string")
                    .build())
                .name("string")
                .build())
            .maxWildcardCollections(0)
            .name("string")
            .views(FederatedDatabaseInstanceStorageDatabaseViewArgs.builder()
                .name("string")
                .pipeline("string")
                .source("string")
                .build())
            .build())
        .storageStores(FederatedDatabaseInstanceStorageStoreArgs.builder()
            .additionalStorageClasses("string")
            .allowInsecure(false)
            .bucket("string")
            .clusterName("string")
            .defaultFormat("string")
            .delimiter("string")
            .includeTags(false)
            .name("string")
            .prefix("string")
            .projectId("string")
            .provider("string")
            .public_("string")
            .readPreference(FederatedDatabaseInstanceStorageStoreReadPreferenceArgs.builder()
                .maxStalenessSeconds(0)
                .mode("string")
                .tagSets(FederatedDatabaseInstanceStorageStoreReadPreferenceTagSetArgs.builder()
                    .tags(FederatedDatabaseInstanceStorageStoreReadPreferenceTagSetTagArgs.builder()
                        .name("string")
                        .value("string")
                        .build())
                    .build())
                .build())
            .region("string")
            .urls("string")
            .build())
        .build());
    
    federated_database_instance_resource = mongodbatlas.FederatedDatabaseInstance("federatedDatabaseInstanceResource",
        project_id="string",
        cloud_provider_config=mongodbatlas.FederatedDatabaseInstanceCloudProviderConfigArgs(
            aws=mongodbatlas.FederatedDatabaseInstanceCloudProviderConfigAwsArgs(
                role_id="string",
                test_s3_bucket="string",
                external_id="string",
                iam_assumed_role_arn="string",
                iam_user_arn="string",
            ),
        ),
        data_process_region=mongodbatlas.FederatedDatabaseInstanceDataProcessRegionArgs(
            cloud_provider="string",
            region="string",
        ),
        name="string",
        storage_databases=[mongodbatlas.FederatedDatabaseInstanceStorageDatabaseArgs(
            collections=[mongodbatlas.FederatedDatabaseInstanceStorageDatabaseCollectionArgs(
                data_sources=[mongodbatlas.FederatedDatabaseInstanceStorageDatabaseCollectionDataSourceArgs(
                    allow_insecure=False,
                    collection="string",
                    collection_regex="string",
                    database="string",
                    database_regex="string",
                    dataset_name="string",
                    default_format="string",
                    path="string",
                    provenance_field_name="string",
                    store_name="string",
                    urls=["string"],
                )],
                name="string",
            )],
            max_wildcard_collections=0,
            name="string",
            views=[mongodbatlas.FederatedDatabaseInstanceStorageDatabaseViewArgs(
                name="string",
                pipeline="string",
                source="string",
            )],
        )],
        storage_stores=[mongodbatlas.FederatedDatabaseInstanceStorageStoreArgs(
            additional_storage_classes=["string"],
            allow_insecure=False,
            bucket="string",
            cluster_name="string",
            default_format="string",
            delimiter="string",
            include_tags=False,
            name="string",
            prefix="string",
            project_id="string",
            provider="string",
            public="string",
            read_preference=mongodbatlas.FederatedDatabaseInstanceStorageStoreReadPreferenceArgs(
                max_staleness_seconds=0,
                mode="string",
                tag_sets=[mongodbatlas.FederatedDatabaseInstanceStorageStoreReadPreferenceTagSetArgs(
                    tags=[mongodbatlas.FederatedDatabaseInstanceStorageStoreReadPreferenceTagSetTagArgs(
                        name="string",
                        value="string",
                    )],
                )],
            ),
            region="string",
            urls=["string"],
        )])
    
    const federatedDatabaseInstanceResource = new mongodbatlas.FederatedDatabaseInstance("federatedDatabaseInstanceResource", {
        projectId: "string",
        cloudProviderConfig: {
            aws: {
                roleId: "string",
                testS3Bucket: "string",
                externalId: "string",
                iamAssumedRoleArn: "string",
                iamUserArn: "string",
            },
        },
        dataProcessRegion: {
            cloudProvider: "string",
            region: "string",
        },
        name: "string",
        storageDatabases: [{
            collections: [{
                dataSources: [{
                    allowInsecure: false,
                    collection: "string",
                    collectionRegex: "string",
                    database: "string",
                    databaseRegex: "string",
                    datasetName: "string",
                    defaultFormat: "string",
                    path: "string",
                    provenanceFieldName: "string",
                    storeName: "string",
                    urls: ["string"],
                }],
                name: "string",
            }],
            maxWildcardCollections: 0,
            name: "string",
            views: [{
                name: "string",
                pipeline: "string",
                source: "string",
            }],
        }],
        storageStores: [{
            additionalStorageClasses: ["string"],
            allowInsecure: false,
            bucket: "string",
            clusterName: "string",
            defaultFormat: "string",
            delimiter: "string",
            includeTags: false,
            name: "string",
            prefix: "string",
            projectId: "string",
            provider: "string",
            "public": "string",
            readPreference: {
                maxStalenessSeconds: 0,
                mode: "string",
                tagSets: [{
                    tags: [{
                        name: "string",
                        value: "string",
                    }],
                }],
            },
            region: "string",
            urls: ["string"],
        }],
    });
    
    type: mongodbatlas:FederatedDatabaseInstance
    properties:
        cloudProviderConfig:
            aws:
                externalId: string
                iamAssumedRoleArn: string
                iamUserArn: string
                roleId: string
                testS3Bucket: string
        dataProcessRegion:
            cloudProvider: string
            region: string
        name: string
        projectId: string
        storageDatabases:
            - collections:
                - dataSources:
                    - allowInsecure: false
                      collection: string
                      collectionRegex: string
                      database: string
                      databaseRegex: string
                      datasetName: string
                      defaultFormat: string
                      path: string
                      provenanceFieldName: string
                      storeName: string
                      urls:
                        - string
                  name: string
              maxWildcardCollections: 0
              name: string
              views:
                - name: string
                  pipeline: string
                  source: string
        storageStores:
            - additionalStorageClasses:
                - string
              allowInsecure: false
              bucket: string
              clusterName: string
              defaultFormat: string
              delimiter: string
              includeTags: false
              name: string
              prefix: string
              projectId: string
              provider: string
              public: string
              readPreference:
                maxStalenessSeconds: 0
                mode: string
                tagSets:
                    - tags:
                        - name: string
                          value: string
              region: string
              urls:
                - string
    

    FederatedDatabaseInstance Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The FederatedDatabaseInstance resource accepts the following input properties:

    ProjectId string
    The unique ID for the project to create a Federated Database Instance.
    CloudProviderConfig FederatedDatabaseInstanceCloudProviderConfig
    Cloud provider linked to this data federated instance.

    • cloud_provider_config.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 cloud_provider_config since AWS is currently the only supported Cloud vendor on this feature at this time.
    • cloud_provider_config.aws.role_id - (Required) Unique identifier of the role that the Federated Instance can use to access the data stores. If necessary, use the Atlas UI or API to retrieve the role ID. You must also specify the test_s3_bucket.
    • cloud_provider_config.aws.test_s3_bucket - (Required) Name of the S3 data bucket that the provided role ID is authorized to access. You must also specify the role_id.
    DataProcessRegion FederatedDatabaseInstanceDataProcessRegion
    The cloud provider region to which the Federated Instance routes client connections for data processing.

    • data_process_region.cloud_provider - (Required) Name of the cloud service provider. Atlas Federated Database only supports AWS.
    • data_process_region.region - (Required) Name of the region to which the Federanted Instnace routes client connections for data processing. See the documention for the available region.
    Name string
    Name of the Atlas Federated Database Instance.
    StorageDatabases List<FederatedDatabaseInstanceStorageDatabase>
    Configuration details for mapping each data store to queryable databases and collections. For complete documentation on this object and its nested fields, see databases. 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 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.#.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.
    • 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 on a collection. To learn more about views, see 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.
    StorageStores List<FederatedDatabaseInstanceStorageStore>
    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. 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.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.
    ProjectId string
    The unique ID for the project to create a Federated Database Instance.
    CloudProviderConfig FederatedDatabaseInstanceCloudProviderConfigArgs
    Cloud provider linked to this data federated instance.

    • cloud_provider_config.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 cloud_provider_config since AWS is currently the only supported Cloud vendor on this feature at this time.
    • cloud_provider_config.aws.role_id - (Required) Unique identifier of the role that the Federated Instance can use to access the data stores. If necessary, use the Atlas UI or API to retrieve the role ID. You must also specify the test_s3_bucket.
    • cloud_provider_config.aws.test_s3_bucket - (Required) Name of the S3 data bucket that the provided role ID is authorized to access. You must also specify the role_id.
    DataProcessRegion FederatedDatabaseInstanceDataProcessRegionArgs
    The cloud provider region to which the Federated Instance routes client connections for data processing.

    • data_process_region.cloud_provider - (Required) Name of the cloud service provider. Atlas Federated Database only supports AWS.
    • data_process_region.region - (Required) Name of the region to which the Federanted Instnace routes client connections for data processing. See the documention for the available region.
    Name string
    Name of the Atlas Federated Database Instance.
    StorageDatabases []FederatedDatabaseInstanceStorageDatabaseArgs
    Configuration details for mapping each data store to queryable databases and collections. For complete documentation on this object and its nested fields, see databases. 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 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.#.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.
    • 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 on a collection. To learn more about views, see 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.
    StorageStores []FederatedDatabaseInstanceStorageStoreArgs
    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. 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.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.
    projectId String
    The unique ID for the project to create a Federated Database Instance.
    cloudProviderConfig FederatedDatabaseInstanceCloudProviderConfig
    Cloud provider linked to this data federated instance.

    • cloud_provider_config.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 cloud_provider_config since AWS is currently the only supported Cloud vendor on this feature at this time.
    • cloud_provider_config.aws.role_id - (Required) Unique identifier of the role that the Federated Instance can use to access the data stores. If necessary, use the Atlas UI or API to retrieve the role ID. You must also specify the test_s3_bucket.
    • cloud_provider_config.aws.test_s3_bucket - (Required) Name of the S3 data bucket that the provided role ID is authorized to access. You must also specify the role_id.
    dataProcessRegion FederatedDatabaseInstanceDataProcessRegion
    The cloud provider region to which the Federated Instance routes client connections for data processing.

    • data_process_region.cloud_provider - (Required) Name of the cloud service provider. Atlas Federated Database only supports AWS.
    • data_process_region.region - (Required) Name of the region to which the Federanted Instnace routes client connections for data processing. See the documention for the available region.
    name String
    Name of the Atlas Federated Database Instance.
    storageDatabases List<FederatedDatabaseInstanceStorageDatabase>
    Configuration details for mapping each data store to queryable databases and collections. For complete documentation on this object and its nested fields, see databases. 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 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.#.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.
    • 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 on a collection. To learn more about views, see 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.
    storageStores List<FederatedDatabaseInstanceStorageStore>
    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. 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.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.
    projectId string
    The unique ID for the project to create a Federated Database Instance.
    cloudProviderConfig FederatedDatabaseInstanceCloudProviderConfig
    Cloud provider linked to this data federated instance.

    • cloud_provider_config.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 cloud_provider_config since AWS is currently the only supported Cloud vendor on this feature at this time.
    • cloud_provider_config.aws.role_id - (Required) Unique identifier of the role that the Federated Instance can use to access the data stores. If necessary, use the Atlas UI or API to retrieve the role ID. You must also specify the test_s3_bucket.
    • cloud_provider_config.aws.test_s3_bucket - (Required) Name of the S3 data bucket that the provided role ID is authorized to access. You must also specify the role_id.
    dataProcessRegion FederatedDatabaseInstanceDataProcessRegion
    The cloud provider region to which the Federated Instance routes client connections for data processing.

    • data_process_region.cloud_provider - (Required) Name of the cloud service provider. Atlas Federated Database only supports AWS.
    • data_process_region.region - (Required) Name of the region to which the Federanted Instnace routes client connections for data processing. See the documention for the available region.
    name string
    Name of the Atlas Federated Database Instance.
    storageDatabases FederatedDatabaseInstanceStorageDatabase[]
    Configuration details for mapping each data store to queryable databases and collections. For complete documentation on this object and its nested fields, see databases. 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 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.#.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.
    • 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 on a collection. To learn more about views, see 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.
    storageStores FederatedDatabaseInstanceStorageStore[]
    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. 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.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.
    project_id str
    The unique ID for the project to create a Federated Database Instance.
    cloud_provider_config FederatedDatabaseInstanceCloudProviderConfigArgs
    Cloud provider linked to this data federated instance.

    • cloud_provider_config.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 cloud_provider_config since AWS is currently the only supported Cloud vendor on this feature at this time.
    • cloud_provider_config.aws.role_id - (Required) Unique identifier of the role that the Federated Instance can use to access the data stores. If necessary, use the Atlas UI or API to retrieve the role ID. You must also specify the test_s3_bucket.
    • cloud_provider_config.aws.test_s3_bucket - (Required) Name of the S3 data bucket that the provided role ID is authorized to access. You must also specify the role_id.
    data_process_region FederatedDatabaseInstanceDataProcessRegionArgs
    The cloud provider region to which the Federated Instance routes client connections for data processing.

    • data_process_region.cloud_provider - (Required) Name of the cloud service provider. Atlas Federated Database only supports AWS.
    • data_process_region.region - (Required) Name of the region to which the Federanted Instnace routes client connections for data processing. See the documention for the available region.
    name str
    Name of the Atlas Federated Database Instance.
    storage_databases Sequence[FederatedDatabaseInstanceStorageDatabaseArgs]
    Configuration details for mapping each data store to queryable databases and collections. For complete documentation on this object and its nested fields, see databases. 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 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.#.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.
    • 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 on a collection. To learn more about views, see 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.
    storage_stores Sequence[FederatedDatabaseInstanceStorageStoreArgs]
    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. 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.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.
    projectId String
    The unique ID for the project to create a Federated Database Instance.
    cloudProviderConfig Property Map
    Cloud provider linked to this data federated instance.

    • cloud_provider_config.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 cloud_provider_config since AWS is currently the only supported Cloud vendor on this feature at this time.
    • cloud_provider_config.aws.role_id - (Required) Unique identifier of the role that the Federated Instance can use to access the data stores. If necessary, use the Atlas UI or API to retrieve the role ID. You must also specify the test_s3_bucket.
    • cloud_provider_config.aws.test_s3_bucket - (Required) Name of the S3 data bucket that the provided role ID is authorized to access. You must also specify the role_id.
    dataProcessRegion Property Map
    The cloud provider region to which the Federated Instance routes client connections for data processing.

    • data_process_region.cloud_provider - (Required) Name of the cloud service provider. Atlas Federated Database only supports AWS.
    • data_process_region.region - (Required) Name of the region to which the Federanted Instnace routes client connections for data processing. See the documention for the available region.
    name String
    Name of the Atlas Federated Database Instance.
    storageDatabases List<Property Map>
    Configuration details for mapping each data store to queryable databases and collections. For complete documentation on this object and its nested fields, see databases. 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 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.#.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.
    • 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 on a collection. To learn more about views, see 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.
    storageStores List<Property Map>
    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. 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.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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the FederatedDatabaseInstance resource produces the following output properties:

    Hostnames List<string>
    The list of hostnames assigned to the Federated Database Instance. Each string in the array is a hostname assigned to the Federated Database Instance.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    Current state of the Federated Database Instance:

    • ACTIVE - The Federated Database Instance is active and verified. You can query the data stores associated with the Federated Database Instance.
    • DELETED - The Federated Database Instance was deleted.
    Hostnames []string
    The list of hostnames assigned to the Federated Database Instance. Each string in the array is a hostname assigned to the Federated Database Instance.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    Current state of the Federated Database Instance:

    • ACTIVE - The Federated Database Instance is active and verified. You can query the data stores associated with the Federated Database Instance.
    • DELETED - The Federated Database Instance was deleted.
    hostnames List<String>
    The list of hostnames assigned to the Federated Database Instance. Each string in the array is a hostname assigned to the Federated Database Instance.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    Current state of the Federated Database Instance:

    • ACTIVE - The Federated Database Instance is active and verified. You can query the data stores associated with the Federated Database Instance.
    • DELETED - The Federated Database Instance was deleted.
    hostnames string[]
    The list of hostnames assigned to the Federated Database Instance. Each string in the array is a hostname assigned to the Federated Database Instance.
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    Current state of the Federated Database Instance:

    • ACTIVE - The Federated Database Instance is active and verified. You can query the data stores associated with the Federated Database Instance.
    • DELETED - The Federated Database Instance was deleted.
    hostnames Sequence[str]
    The list of hostnames assigned to the Federated Database Instance. Each string in the array is a hostname assigned to the Federated Database Instance.
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    Current state of the Federated Database Instance:

    • ACTIVE - The Federated Database Instance is active and verified. You can query the data stores associated with the Federated Database Instance.
    • DELETED - The Federated Database Instance was deleted.
    hostnames List<String>
    The list of hostnames assigned to the Federated Database Instance. Each string in the array is a hostname assigned to the Federated Database Instance.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    Current state of the Federated Database Instance:

    • ACTIVE - The Federated Database Instance is active and verified. You can query the data stores associated with the Federated Database Instance.
    • DELETED - The Federated Database Instance was deleted.

    Look up Existing FederatedDatabaseInstance Resource

    Get an existing FederatedDatabaseInstance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: FederatedDatabaseInstanceState, opts?: CustomResourceOptions): FederatedDatabaseInstance
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            cloud_provider_config: Optional[FederatedDatabaseInstanceCloudProviderConfigArgs] = None,
            data_process_region: Optional[FederatedDatabaseInstanceDataProcessRegionArgs] = None,
            hostnames: Optional[Sequence[str]] = None,
            name: Optional[str] = None,
            project_id: Optional[str] = None,
            state: Optional[str] = None,
            storage_databases: Optional[Sequence[FederatedDatabaseInstanceStorageDatabaseArgs]] = None,
            storage_stores: Optional[Sequence[FederatedDatabaseInstanceStorageStoreArgs]] = None) -> FederatedDatabaseInstance
    func GetFederatedDatabaseInstance(ctx *Context, name string, id IDInput, state *FederatedDatabaseInstanceState, opts ...ResourceOption) (*FederatedDatabaseInstance, error)
    public static FederatedDatabaseInstance Get(string name, Input<string> id, FederatedDatabaseInstanceState? state, CustomResourceOptions? opts = null)
    public static FederatedDatabaseInstance get(String name, Output<String> id, FederatedDatabaseInstanceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CloudProviderConfig FederatedDatabaseInstanceCloudProviderConfig
    Cloud provider linked to this data federated instance.

    • cloud_provider_config.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 cloud_provider_config since AWS is currently the only supported Cloud vendor on this feature at this time.
    • cloud_provider_config.aws.role_id - (Required) Unique identifier of the role that the Federated Instance can use to access the data stores. If necessary, use the Atlas UI or API to retrieve the role ID. You must also specify the test_s3_bucket.
    • cloud_provider_config.aws.test_s3_bucket - (Required) Name of the S3 data bucket that the provided role ID is authorized to access. You must also specify the role_id.
    DataProcessRegion FederatedDatabaseInstanceDataProcessRegion
    The cloud provider region to which the Federated Instance routes client connections for data processing.

    • data_process_region.cloud_provider - (Required) Name of the cloud service provider. Atlas Federated Database only supports AWS.
    • data_process_region.region - (Required) Name of the region to which the Federanted Instnace routes client connections for data processing. See the documention for the available region.
    Hostnames List<string>
    The list of hostnames assigned to the Federated Database Instance. Each string in the array is a hostname assigned to the Federated Database Instance.
    Name string
    Name of the Atlas Federated Database Instance.
    ProjectId string
    The unique ID for the project to create a Federated Database Instance.
    State string
    Current state of the Federated Database Instance:

    • ACTIVE - The Federated Database Instance is active and verified. You can query the data stores associated with the Federated Database Instance.
    • DELETED - The Federated Database Instance was deleted.
    StorageDatabases List<FederatedDatabaseInstanceStorageDatabase>
    Configuration details for mapping each data store to queryable databases and collections. For complete documentation on this object and its nested fields, see databases. 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 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.#.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.
    • 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 on a collection. To learn more about views, see 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.
    StorageStores List<FederatedDatabaseInstanceStorageStore>
    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. 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.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.
    CloudProviderConfig FederatedDatabaseInstanceCloudProviderConfigArgs
    Cloud provider linked to this data federated instance.

    • cloud_provider_config.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 cloud_provider_config since AWS is currently the only supported Cloud vendor on this feature at this time.
    • cloud_provider_config.aws.role_id - (Required) Unique identifier of the role that the Federated Instance can use to access the data stores. If necessary, use the Atlas UI or API to retrieve the role ID. You must also specify the test_s3_bucket.
    • cloud_provider_config.aws.test_s3_bucket - (Required) Name of the S3 data bucket that the provided role ID is authorized to access. You must also specify the role_id.
    DataProcessRegion FederatedDatabaseInstanceDataProcessRegionArgs
    The cloud provider region to which the Federated Instance routes client connections for data processing.

    • data_process_region.cloud_provider - (Required) Name of the cloud service provider. Atlas Federated Database only supports AWS.
    • data_process_region.region - (Required) Name of the region to which the Federanted Instnace routes client connections for data processing. See the documention for the available region.
    Hostnames []string
    The list of hostnames assigned to the Federated Database Instance. Each string in the array is a hostname assigned to the Federated Database Instance.
    Name string
    Name of the Atlas Federated Database Instance.
    ProjectId string
    The unique ID for the project to create a Federated Database Instance.
    State string
    Current state of the Federated Database Instance:

    • ACTIVE - The Federated Database Instance is active and verified. You can query the data stores associated with the Federated Database Instance.
    • DELETED - The Federated Database Instance was deleted.
    StorageDatabases []FederatedDatabaseInstanceStorageDatabaseArgs
    Configuration details for mapping each data store to queryable databases and collections. For complete documentation on this object and its nested fields, see databases. 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 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.#.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.
    • 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 on a collection. To learn more about views, see 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.
    StorageStores []FederatedDatabaseInstanceStorageStoreArgs
    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. 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.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.
    cloudProviderConfig FederatedDatabaseInstanceCloudProviderConfig
    Cloud provider linked to this data federated instance.

    • cloud_provider_config.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 cloud_provider_config since AWS is currently the only supported Cloud vendor on this feature at this time.
    • cloud_provider_config.aws.role_id - (Required) Unique identifier of the role that the Federated Instance can use to access the data stores. If necessary, use the Atlas UI or API to retrieve the role ID. You must also specify the test_s3_bucket.
    • cloud_provider_config.aws.test_s3_bucket - (Required) Name of the S3 data bucket that the provided role ID is authorized to access. You must also specify the role_id.
    dataProcessRegion FederatedDatabaseInstanceDataProcessRegion
    The cloud provider region to which the Federated Instance routes client connections for data processing.

    • data_process_region.cloud_provider - (Required) Name of the cloud service provider. Atlas Federated Database only supports AWS.
    • data_process_region.region - (Required) Name of the region to which the Federanted Instnace routes client connections for data processing. See the documention for the available region.
    hostnames List<String>
    The list of hostnames assigned to the Federated Database Instance. Each string in the array is a hostname assigned to the Federated Database Instance.
    name String
    Name of the Atlas Federated Database Instance.
    projectId String
    The unique ID for the project to create a Federated Database Instance.
    state String
    Current state of the Federated Database Instance:

    • ACTIVE - The Federated Database Instance is active and verified. You can query the data stores associated with the Federated Database Instance.
    • DELETED - The Federated Database Instance was deleted.
    storageDatabases List<FederatedDatabaseInstanceStorageDatabase>
    Configuration details for mapping each data store to queryable databases and collections. For complete documentation on this object and its nested fields, see databases. 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 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.#.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.
    • 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 on a collection. To learn more about views, see 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.
    storageStores List<FederatedDatabaseInstanceStorageStore>
    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. 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.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.
    cloudProviderConfig FederatedDatabaseInstanceCloudProviderConfig
    Cloud provider linked to this data federated instance.

    • cloud_provider_config.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 cloud_provider_config since AWS is currently the only supported Cloud vendor on this feature at this time.
    • cloud_provider_config.aws.role_id - (Required) Unique identifier of the role that the Federated Instance can use to access the data stores. If necessary, use the Atlas UI or API to retrieve the role ID. You must also specify the test_s3_bucket.
    • cloud_provider_config.aws.test_s3_bucket - (Required) Name of the S3 data bucket that the provided role ID is authorized to access. You must also specify the role_id.
    dataProcessRegion FederatedDatabaseInstanceDataProcessRegion
    The cloud provider region to which the Federated Instance routes client connections for data processing.

    • data_process_region.cloud_provider - (Required) Name of the cloud service provider. Atlas Federated Database only supports AWS.
    • data_process_region.region - (Required) Name of the region to which the Federanted Instnace routes client connections for data processing. See the documention for the available region.
    hostnames string[]
    The list of hostnames assigned to the Federated Database Instance. Each string in the array is a hostname assigned to the Federated Database Instance.
    name string
    Name of the Atlas Federated Database Instance.
    projectId string
    The unique ID for the project to create a Federated Database Instance.
    state string
    Current state of the Federated Database Instance:

    • ACTIVE - The Federated Database Instance is active and verified. You can query the data stores associated with the Federated Database Instance.
    • DELETED - The Federated Database Instance was deleted.
    storageDatabases FederatedDatabaseInstanceStorageDatabase[]
    Configuration details for mapping each data store to queryable databases and collections. For complete documentation on this object and its nested fields, see databases. 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 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.#.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.
    • 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 on a collection. To learn more about views, see 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.
    storageStores FederatedDatabaseInstanceStorageStore[]
    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. 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.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.
    cloud_provider_config FederatedDatabaseInstanceCloudProviderConfigArgs
    Cloud provider linked to this data federated instance.

    • cloud_provider_config.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 cloud_provider_config since AWS is currently the only supported Cloud vendor on this feature at this time.
    • cloud_provider_config.aws.role_id - (Required) Unique identifier of the role that the Federated Instance can use to access the data stores. If necessary, use the Atlas UI or API to retrieve the role ID. You must also specify the test_s3_bucket.
    • cloud_provider_config.aws.test_s3_bucket - (Required) Name of the S3 data bucket that the provided role ID is authorized to access. You must also specify the role_id.
    data_process_region FederatedDatabaseInstanceDataProcessRegionArgs
    The cloud provider region to which the Federated Instance routes client connections for data processing.

    • data_process_region.cloud_provider - (Required) Name of the cloud service provider. Atlas Federated Database only supports AWS.
    • data_process_region.region - (Required) Name of the region to which the Federanted Instnace routes client connections for data processing. See the documention for the available region.
    hostnames Sequence[str]
    The list of hostnames assigned to the Federated Database Instance. Each string in the array is a hostname assigned to the Federated Database Instance.
    name str
    Name of the Atlas Federated Database Instance.
    project_id str
    The unique ID for the project to create a Federated Database Instance.
    state str
    Current state of the Federated Database Instance:

    • ACTIVE - The Federated Database Instance is active and verified. You can query the data stores associated with the Federated Database Instance.
    • DELETED - The Federated Database Instance was deleted.
    storage_databases Sequence[FederatedDatabaseInstanceStorageDatabaseArgs]
    Configuration details for mapping each data store to queryable databases and collections. For complete documentation on this object and its nested fields, see databases. 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 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.#.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.
    • 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 on a collection. To learn more about views, see 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.
    storage_stores Sequence[FederatedDatabaseInstanceStorageStoreArgs]
    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. 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.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.
    cloudProviderConfig Property Map
    Cloud provider linked to this data federated instance.

    • cloud_provider_config.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 cloud_provider_config since AWS is currently the only supported Cloud vendor on this feature at this time.
    • cloud_provider_config.aws.role_id - (Required) Unique identifier of the role that the Federated Instance can use to access the data stores. If necessary, use the Atlas UI or API to retrieve the role ID. You must also specify the test_s3_bucket.
    • cloud_provider_config.aws.test_s3_bucket - (Required) Name of the S3 data bucket that the provided role ID is authorized to access. You must also specify the role_id.
    dataProcessRegion Property Map
    The cloud provider region to which the Federated Instance routes client connections for data processing.

    • data_process_region.cloud_provider - (Required) Name of the cloud service provider. Atlas Federated Database only supports AWS.
    • data_process_region.region - (Required) Name of the region to which the Federanted Instnace routes client connections for data processing. See the documention for the available region.
    hostnames List<String>
    The list of hostnames assigned to the Federated Database Instance. Each string in the array is a hostname assigned to the Federated Database Instance.
    name String
    Name of the Atlas Federated Database Instance.
    projectId String
    The unique ID for the project to create a Federated Database Instance.
    state String
    Current state of the Federated Database Instance:

    • ACTIVE - The Federated Database Instance is active and verified. You can query the data stores associated with the Federated Database Instance.
    • DELETED - The Federated Database Instance was deleted.
    storageDatabases List<Property Map>
    Configuration details for mapping each data store to queryable databases and collections. For complete documentation on this object and its nested fields, see databases. 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 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.#.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.
    • 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 on a collection. To learn more about views, see 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.
    storageStores List<Property Map>
    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. 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.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.

    Supporting Types

    FederatedDatabaseInstanceCloudProviderConfig, FederatedDatabaseInstanceCloudProviderConfigArgs

    Aws FederatedDatabaseInstanceCloudProviderConfigAws
    Name of the cloud service that hosts the data lake's data stores.
    Aws FederatedDatabaseInstanceCloudProviderConfigAws
    Name of the cloud service that hosts the data lake's data stores.
    aws FederatedDatabaseInstanceCloudProviderConfigAws
    Name of the cloud service that hosts the data lake's data stores.
    aws FederatedDatabaseInstanceCloudProviderConfigAws
    Name of the cloud service that hosts the data lake's data stores.
    aws FederatedDatabaseInstanceCloudProviderConfigAws
    Name of the cloud service that hosts the data lake's data stores.
    aws Property Map
    Name of the cloud service that hosts the data lake's data stores.

    FederatedDatabaseInstanceCloudProviderConfigAws, FederatedDatabaseInstanceCloudProviderConfigAwsArgs

    RoleId string
    TestS3Bucket string
    ExternalId string
    Unique identifier associated with the IAM Role that the Federated Database Instance assumes when accessing the data stores.
    IamAssumedRoleArn string
    Amazon Resource Name (ARN) of the IAM Role that the Federated Database Instance assumes when accessing S3 Bucket data stores. The IAM Role must support the following actions against each S3 bucket:

    • s3:GetObject
    • s3:ListBucket
    • s3:GetObjectVersion
    IamUserArn string
    Amazon Resource Name (ARN) of the user that the Federated Database Instance assumes when accessing S3 Bucket data stores.
    RoleId string
    TestS3Bucket string
    ExternalId string
    Unique identifier associated with the IAM Role that the Federated Database Instance assumes when accessing the data stores.
    IamAssumedRoleArn string
    Amazon Resource Name (ARN) of the IAM Role that the Federated Database Instance assumes when accessing S3 Bucket data stores. The IAM Role must support the following actions against each S3 bucket:

    • s3:GetObject
    • s3:ListBucket
    • s3:GetObjectVersion
    IamUserArn string
    Amazon Resource Name (ARN) of the user that the Federated Database Instance assumes when accessing S3 Bucket data stores.
    roleId String
    testS3Bucket String
    externalId String
    Unique identifier associated with the IAM Role that the Federated Database Instance assumes when accessing the data stores.
    iamAssumedRoleArn String
    Amazon Resource Name (ARN) of the IAM Role that the Federated Database Instance assumes when accessing S3 Bucket data stores. The IAM Role must support the following actions against each S3 bucket:

    • s3:GetObject
    • s3:ListBucket
    • s3:GetObjectVersion
    iamUserArn String
    Amazon Resource Name (ARN) of the user that the Federated Database Instance assumes when accessing S3 Bucket data stores.
    roleId string
    testS3Bucket string
    externalId string
    Unique identifier associated with the IAM Role that the Federated Database Instance assumes when accessing the data stores.
    iamAssumedRoleArn string
    Amazon Resource Name (ARN) of the IAM Role that the Federated Database Instance assumes when accessing S3 Bucket data stores. The IAM Role must support the following actions against each S3 bucket:

    • s3:GetObject
    • s3:ListBucket
    • s3:GetObjectVersion
    iamUserArn string
    Amazon Resource Name (ARN) of the user that the Federated Database Instance assumes when accessing S3 Bucket data stores.
    role_id str
    test_s3_bucket str
    external_id str
    Unique identifier associated with the IAM Role that the Federated Database Instance assumes when accessing the data stores.
    iam_assumed_role_arn str
    Amazon Resource Name (ARN) of the IAM Role that the Federated Database Instance assumes when accessing S3 Bucket data stores. The IAM Role must support the following actions against each S3 bucket:

    • s3:GetObject
    • s3:ListBucket
    • s3:GetObjectVersion
    iam_user_arn str
    Amazon Resource Name (ARN) of the user that the Federated Database Instance assumes when accessing S3 Bucket data stores.
    roleId String
    testS3Bucket String
    externalId String
    Unique identifier associated with the IAM Role that the Federated Database Instance assumes when accessing the data stores.
    iamAssumedRoleArn String
    Amazon Resource Name (ARN) of the IAM Role that the Federated Database Instance assumes when accessing S3 Bucket data stores. The IAM Role must support the following actions against each S3 bucket:

    • s3:GetObject
    • s3:ListBucket
    • s3:GetObjectVersion
    iamUserArn String
    Amazon Resource Name (ARN) of the user that the Federated Database Instance assumes when accessing S3 Bucket data stores.

    FederatedDatabaseInstanceDataProcessRegion, FederatedDatabaseInstanceDataProcessRegionArgs

    CloudProvider string
    Region string
    CloudProvider string
    Region string
    cloudProvider String
    region String
    cloudProvider string
    region string
    cloudProvider String
    region String

    FederatedDatabaseInstanceStorageDatabase, FederatedDatabaseInstanceStorageDatabaseArgs

    collections List<Property Map>
    maxWildcardCollections Number
    name String
    Name of the Atlas Federated Database Instance.
    views List<Property Map>

    FederatedDatabaseInstanceStorageDatabaseCollection, FederatedDatabaseInstanceStorageDatabaseCollectionArgs

    DataSources List<FederatedDatabaseInstanceStorageDatabaseCollectionDataSource>
    Name string
    Name of the Atlas Federated Database Instance.
    DataSources []FederatedDatabaseInstanceStorageDatabaseCollectionDataSource
    Name string
    Name of the Atlas Federated Database Instance.
    dataSources List<FederatedDatabaseInstanceStorageDatabaseCollectionDataSource>
    name String
    Name of the Atlas Federated Database Instance.
    dataSources FederatedDatabaseInstanceStorageDatabaseCollectionDataSource[]
    name string
    Name of the Atlas Federated Database Instance.
    dataSources List<Property Map>
    name String
    Name of the Atlas Federated Database Instance.

    FederatedDatabaseInstanceStorageDatabaseCollectionDataSource, FederatedDatabaseInstanceStorageDatabaseCollectionDataSourceArgs

    AllowInsecure bool
    Collection string
    CollectionRegex string
    Database string
    DatabaseRegex string
    DatasetName string
    DefaultFormat string
    Path string
    ProvenanceFieldName string
    StoreName string
    Urls List<string>
    allowInsecure Boolean
    collection String
    collectionRegex String
    database String
    databaseRegex String
    datasetName String
    defaultFormat String
    path String
    provenanceFieldName String
    storeName String
    urls List<String>
    allowInsecure boolean
    collection string
    collectionRegex string
    database string
    databaseRegex string
    datasetName string
    defaultFormat string
    path string
    provenanceFieldName string
    storeName string
    urls string[]
    allowInsecure Boolean
    collection String
    collectionRegex String
    database String
    databaseRegex String
    datasetName String
    defaultFormat String
    path String
    provenanceFieldName String
    storeName String
    urls List<String>

    FederatedDatabaseInstanceStorageDatabaseView, FederatedDatabaseInstanceStorageDatabaseViewArgs

    Name string
    Name of the Atlas Federated Database Instance.
    Pipeline string
    Source string
    Name string
    Name of the Atlas Federated Database Instance.
    Pipeline string
    Source string
    name String
    Name of the Atlas Federated Database Instance.
    pipeline String
    source String
    name string
    Name of the Atlas Federated Database Instance.
    pipeline string
    source string
    name str
    Name of the Atlas Federated Database Instance.
    pipeline str
    source str
    name String
    Name of the Atlas Federated Database Instance.
    pipeline String
    source String

    FederatedDatabaseInstanceStorageStore, FederatedDatabaseInstanceStorageStoreArgs

    AdditionalStorageClasses List<string>
    AllowInsecure bool
    Bucket string
    ClusterId string

    Deprecated: This parameter is deprecated and will be removed by September 2024.

    ClusterName string
    DefaultFormat string
    Delimiter string
    IncludeTags bool
    Name string
    Name of the Atlas Federated Database Instance.
    Prefix string
    ProjectId string
    The unique ID for the project to create a Federated Database Instance.
    Provider string
    Public string
    ReadPreference FederatedDatabaseInstanceStorageStoreReadPreference
    Region string
    Urls List<string>
    AdditionalStorageClasses []string
    AllowInsecure bool
    Bucket string
    ClusterId string

    Deprecated: This parameter is deprecated and will be removed by September 2024.

    ClusterName string
    DefaultFormat string
    Delimiter string
    IncludeTags bool
    Name string
    Name of the Atlas Federated Database Instance.
    Prefix string
    ProjectId string
    The unique ID for the project to create a Federated Database Instance.
    Provider string
    Public string
    ReadPreference FederatedDatabaseInstanceStorageStoreReadPreference
    Region string
    Urls []string
    additionalStorageClasses List<String>
    allowInsecure Boolean
    bucket String
    clusterId String

    Deprecated: This parameter is deprecated and will be removed by September 2024.

    clusterName String
    defaultFormat String
    delimiter String
    includeTags Boolean
    name String
    Name of the Atlas Federated Database Instance.
    prefix String
    projectId String
    The unique ID for the project to create a Federated Database Instance.
    provider String
    public_ String
    readPreference FederatedDatabaseInstanceStorageStoreReadPreference
    region String
    urls List<String>
    additionalStorageClasses string[]
    allowInsecure boolean
    bucket string
    clusterId string

    Deprecated: This parameter is deprecated and will be removed by September 2024.

    clusterName string
    defaultFormat string
    delimiter string
    includeTags boolean
    name string
    Name of the Atlas Federated Database Instance.
    prefix string
    projectId string
    The unique ID for the project to create a Federated Database Instance.
    provider string
    public string
    readPreference FederatedDatabaseInstanceStorageStoreReadPreference
    region string
    urls string[]
    additional_storage_classes Sequence[str]
    allow_insecure bool
    bucket str
    cluster_id str

    Deprecated: This parameter is deprecated and will be removed by September 2024.

    cluster_name str
    default_format str
    delimiter str
    include_tags bool
    name str
    Name of the Atlas Federated Database Instance.
    prefix str
    project_id str
    The unique ID for the project to create a Federated Database Instance.
    provider str
    public str
    read_preference FederatedDatabaseInstanceStorageStoreReadPreference
    region str
    urls Sequence[str]
    additionalStorageClasses List<String>
    allowInsecure Boolean
    bucket String
    clusterId String

    Deprecated: This parameter is deprecated and will be removed by September 2024.

    clusterName String
    defaultFormat String
    delimiter String
    includeTags Boolean
    name String
    Name of the Atlas Federated Database Instance.
    prefix String
    projectId String
    The unique ID for the project to create a Federated Database Instance.
    provider String
    public String
    readPreference Property Map
    region String
    urls List<String>

    FederatedDatabaseInstanceStorageStoreReadPreference, FederatedDatabaseInstanceStorageStoreReadPreferenceArgs

    FederatedDatabaseInstanceStorageStoreReadPreferenceTagSet, FederatedDatabaseInstanceStorageStoreReadPreferenceTagSetArgs

    FederatedDatabaseInstanceStorageStoreReadPreferenceTagSetTag, FederatedDatabaseInstanceStorageStoreReadPreferenceTagSetTagArgs

    Name string
    Name of the Atlas Federated Database Instance.
    Value string
    Name string
    Name of the Atlas Federated Database Instance.
    Value string
    name String
    Name of the Atlas Federated Database Instance.
    value String
    name string
    Name of the Atlas Federated Database Instance.
    value string
    name str
    Name of the Atlas Federated Database Instance.
    value str
    name String
    Name of the Atlas Federated Database Instance.
    value String

    Import

    • The Federated Database Instance can be imported using project ID, name of the instance, in the format project_idname, e.g.
    $ 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_idnameaws_test_s3_bucket, e.g.
    $ pulumi import mongodbatlas:index/federatedDatabaseInstance:FederatedDatabaseInstance mongodbatlas_federated_database_instance.example 1112222b3bf99403840e8934--test--s3-test
    

    See MongoDB Atlas API Documentation for more information.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    MongoDB Atlas pulumi/pulumi-mongodbatlas
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the mongodbatlas Terraform Provider.
    mongodbatlas logo
    MongoDB Atlas v3.16.2 published on Friday, Jun 21, 2024 by Pulumi