MongoDB Atlas v3.30.0, Mar 21 25

MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi

mongodbatlas.getFederatedDatabaseInstance

Explore with Pulumi AI

MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi

# Data Source: mongodbatlas.FederatedDatabaseInstance

mongodbatlas.FederatedDatabaseInstance provides a Federated Database Instance data source.

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

IMPORTANT: All arguments including the password will be stored in the raw state as plain text. Read more about sensitive data in state.

Example Usage

S With MongoDB Atlas Cluster As Storage Database

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const test = mongodbatlas.getFederatedDatabaseInstance({
    projectId: "PROJECT ID",
    name: "TENANT NAME OF THE FEDERATED DATABASE INSTANCE",
});

import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.get_federated_database_instance(project_id="PROJECT ID",
    name="TENANT NAME OF THE FEDERATED DATABASE INSTANCE")

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.LookupFederatedDatabaseInstance(ctx, &mongodbatlas.LookupFederatedDatabaseInstanceArgs{
			ProjectId: "PROJECT ID",
			Name:      "TENANT NAME OF THE FEDERATED DATABASE INSTANCE",
		}, nil)
		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 = Mongodbatlas.GetFederatedDatabaseInstance.Invoke(new()
    {
        ProjectId = "PROJECT ID",
        Name = "TENANT NAME OF THE FEDERATED DATABASE INSTANCE",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.MongodbatlasFunctions;
import com.pulumi.mongodbatlas.inputs.GetFederatedDatabaseInstanceArgs;
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) {
        final var test = MongodbatlasFunctions.getFederatedDatabaseInstance(GetFederatedDatabaseInstanceArgs.builder()
            .projectId("PROJECT ID")
            .name("TENANT NAME OF THE FEDERATED DATABASE INSTANCE")
            .build());

    }
}

variables:
  test:
    fn::invoke:
      function: mongodbatlas:getFederatedDatabaseInstance
      arguments:
        projectId: PROJECT ID
        name: TENANT NAME OF THE FEDERATED DATABASE INSTANCE

S With Amazon S3 Bucket As Storage Database

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const test = mongodbatlas.getFederatedDatabaseInstance({
    projectId: "PROJECT ID",
    name: "TENANT NAME OF THE FEDERATED DATABASE INSTANCE",
    cloudProviderConfig: {
        aws: {
            testS3Bucket: "Amazon S3 Bucket Name",
        },
    },
});

import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.get_federated_database_instance(project_id="PROJECT ID",
    name="TENANT NAME OF THE FEDERATED DATABASE INSTANCE",
    cloud_provider_config={
        "aws": {
            "test_s3_bucket": "Amazon S3 Bucket Name",
        },
    })

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.LookupFederatedDatabaseInstance(ctx, &mongodbatlas.LookupFederatedDatabaseInstanceArgs{
			ProjectId: "PROJECT ID",
			Name:      "TENANT NAME OF THE FEDERATED DATABASE INSTANCE",
			CloudProviderConfig: mongodbatlas.GetFederatedDatabaseInstanceCloudProviderConfig{
				Aws: mongodbatlas.GetFederatedDatabaseInstanceCloudProviderConfigAws{
					TestS3Bucket: "Amazon S3 Bucket Name",
				},
			},
		}, nil)
		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 = Mongodbatlas.GetFederatedDatabaseInstance.Invoke(new()
    {
        ProjectId = "PROJECT ID",
        Name = "TENANT NAME OF THE FEDERATED DATABASE INSTANCE",
        CloudProviderConfig = new Mongodbatlas.Inputs.GetFederatedDatabaseInstanceCloudProviderConfigInputArgs
        {
            Aws = new Mongodbatlas.Inputs.GetFederatedDatabaseInstanceCloudProviderConfigAwsInputArgs
            {
                TestS3Bucket = "Amazon S3 Bucket Name",
            },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.MongodbatlasFunctions;
import com.pulumi.mongodbatlas.inputs.GetFederatedDatabaseInstanceArgs;
import com.pulumi.mongodbatlas.inputs.GetFederatedDatabaseInstanceCloudProviderConfigArgs;
import com.pulumi.mongodbatlas.inputs.GetFederatedDatabaseInstanceCloudProviderConfigAwsArgs;
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) {
        final var test = MongodbatlasFunctions.getFederatedDatabaseInstance(GetFederatedDatabaseInstanceArgs.builder()
            .projectId("PROJECT ID")
            .name("TENANT NAME OF THE FEDERATED DATABASE INSTANCE")
            .cloudProviderConfig(GetFederatedDatabaseInstanceCloudProviderConfigArgs.builder()
                .aws(GetFederatedDatabaseInstanceCloudProviderConfigAwsArgs.builder()
                    .testS3Bucket("Amazon S3 Bucket Name")
                    .build())
                .build())
            .build());

    }
}

variables:
  test:
    fn::invoke:
      function: mongodbatlas:getFederatedDatabaseInstance
      arguments:
        projectId: PROJECT ID
        name: TENANT NAME OF THE FEDERATED DATABASE INSTANCE
        cloudProviderConfig:
          aws:
            testS3Bucket: Amazon S3 Bucket Name

Using getFederatedDatabaseInstance

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getFederatedDatabaseInstance(args: GetFederatedDatabaseInstanceArgs, opts?: InvokeOptions): Promise<GetFederatedDatabaseInstanceResult>
function getFederatedDatabaseInstanceOutput(args: GetFederatedDatabaseInstanceOutputArgs, opts?: InvokeOptions): Output<GetFederatedDatabaseInstanceResult>

def get_federated_database_instance(cloud_provider_config: Optional[GetFederatedDatabaseInstanceCloudProviderConfig] = None,
                                    name: Optional[str] = None,
                                    project_id: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetFederatedDatabaseInstanceResult
def get_federated_database_instance_output(cloud_provider_config: Optional[pulumi.Input[GetFederatedDatabaseInstanceCloudProviderConfigArgs]] = None,
                                    name: Optional[pulumi.Input[str]] = None,
                                    project_id: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetFederatedDatabaseInstanceResult]

func LookupFederatedDatabaseInstance(ctx *Context, args *LookupFederatedDatabaseInstanceArgs, opts ...InvokeOption) (*LookupFederatedDatabaseInstanceResult, error)
func LookupFederatedDatabaseInstanceOutput(ctx *Context, args *LookupFederatedDatabaseInstanceOutputArgs, opts ...InvokeOption) LookupFederatedDatabaseInstanceResultOutput

> Note: This function is named LookupFederatedDatabaseInstance in the Go SDK.

public static class GetFederatedDatabaseInstance 
{
    public static Task<GetFederatedDatabaseInstanceResult> InvokeAsync(GetFederatedDatabaseInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetFederatedDatabaseInstanceResult> Invoke(GetFederatedDatabaseInstanceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetFederatedDatabaseInstanceResult> getFederatedDatabaseInstance(GetFederatedDatabaseInstanceArgs args, InvokeOptions options)
public static Output<GetFederatedDatabaseInstanceResult> getFederatedDatabaseInstance(GetFederatedDatabaseInstanceArgs args, InvokeOptions options)

fn::invoke:
  function: mongodbatlas:index/getFederatedDatabaseInstance:getFederatedDatabaseInstance
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: Name of the Atlas Federated Database Instance.
ProjectId string: The unique ID for the project to create a Federated Database Instance.
CloudProviderConfig GetFederatedDatabaseInstanceCloudProviderConfig

Name string: Name of the Atlas Federated Database Instance.
ProjectId string: The unique ID for the project to create a Federated Database Instance.
CloudProviderConfig GetFederatedDatabaseInstanceCloudProviderConfig

name String: Name of the Atlas Federated Database Instance.
projectId String: The unique ID for the project to create a Federated Database Instance.
cloudProviderConfig GetFederatedDatabaseInstanceCloudProviderConfig

name string: Name of the Atlas Federated Database Instance.
projectId string: The unique ID for the project to create a Federated Database Instance.
cloudProviderConfig GetFederatedDatabaseInstanceCloudProviderConfig

name str: Name of the Atlas Federated Database Instance.
project_id str: The unique ID for the project to create a Federated Database Instance.
cloud_provider_config GetFederatedDatabaseInstanceCloudProviderConfig

name String: Name of the Atlas Federated Database Instance.
projectId String: The unique ID for the project to create a Federated Database Instance.
cloudProviderConfig Property Map

getFederatedDatabaseInstance Result

The following output properties are available:

CloudProviderConfig GetFederatedDatabaseInstanceCloudProviderConfig

DataProcessRegions List<GetFederatedDatabaseInstanceDataProcessRegion>

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.

Name string

ProjectId string

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<GetFederatedDatabaseInstanceStorageDatabase>

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<GetFederatedDatabaseInstanceStorageStore>

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.#.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 GetFederatedDatabaseInstanceCloudProviderConfig

DataProcessRegions []GetFederatedDatabaseInstanceDataProcessRegion

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.

Name string

ProjectId string

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 []GetFederatedDatabaseInstanceStorageDatabase

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 []GetFederatedDatabaseInstanceStorageStore

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.#.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 GetFederatedDatabaseInstanceCloudProviderConfig

dataProcessRegions List<GetFederatedDatabaseInstanceDataProcessRegion>

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.

name String

projectId String

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<GetFederatedDatabaseInstanceStorageDatabase>

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<GetFederatedDatabaseInstanceStorageStore>

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.#.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 GetFederatedDatabaseInstanceCloudProviderConfig

dataProcessRegions GetFederatedDatabaseInstanceDataProcessRegion[]

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.

name string

projectId string

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 GetFederatedDatabaseInstanceStorageDatabase[]

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 GetFederatedDatabaseInstanceStorageStore[]

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.#.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 GetFederatedDatabaseInstanceCloudProviderConfig

data_process_regions Sequence[GetFederatedDatabaseInstanceDataProcessRegion]

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.

name str

project_id str

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[GetFederatedDatabaseInstanceStorageDatabase]

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[GetFederatedDatabaseInstanceStorageStore]

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.#.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

dataProcessRegions List<Property Map>

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.

name String

projectId String

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>

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>

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.#.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

GetFederatedDatabaseInstanceCloudProviderConfig

Aws GetFederatedDatabaseInstanceCloudProviderConfigAws

Aws GetFederatedDatabaseInstanceCloudProviderConfigAws

aws GetFederatedDatabaseInstanceCloudProviderConfigAws

aws GetFederatedDatabaseInstanceCloudProviderConfigAws

aws GetFederatedDatabaseInstanceCloudProviderConfigAws

aws Property Map

GetFederatedDatabaseInstanceCloudProviderConfigAws

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

Unique identifier of the role that the data lake can use to access the data stores.

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

Unique identifier of the role that the data lake can use to access the data stores.

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

Unique identifier of the role that the data lake can use to access the data stores.

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

Unique identifier of the role that the data lake can use to access the data stores.

testS3Bucket string

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.

role_id str

Unique identifier of the role that the data lake can use to access the data stores.

test_s3_bucket str

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

Unique identifier of the role that the data lake can use to access the data stores.

testS3Bucket String

GetFederatedDatabaseInstanceDataProcessRegion

CloudProvider string: Name of the cloud service provider. Atlas Federated Database only supports AWS.
Region string: Name of the region to which the Federanted Instnace routes client connections for data processing.

CloudProvider string: Name of the cloud service provider. Atlas Federated Database only supports AWS.
Region string: Name of the region to which the Federanted Instnace routes client connections for data processing.

cloudProvider String: Name of the cloud service provider. Atlas Federated Database only supports AWS.
region String: Name of the region to which the Federanted Instnace routes client connections for data processing.

cloudProvider string: Name of the cloud service provider. Atlas Federated Database only supports AWS.
region string: Name of the region to which the Federanted Instnace routes client connections for data processing.

cloud_provider str: Name of the cloud service provider. Atlas Federated Database only supports AWS.
region str: Name of the region to which the Federanted Instnace routes client connections for data processing.

cloudProvider String: Name of the cloud service provider. Atlas Federated Database only supports AWS.
region String: Name of the region to which the Federanted Instnace routes client connections for data processing.

GetFederatedDatabaseInstanceStorageDatabase

Collections List<GetFederatedDatabaseInstanceStorageDatabaseCollection>
MaxWildcardCollections int
Name string: Name of the Atlas Federated Database Instance.
Views List<GetFederatedDatabaseInstanceStorageDatabaseView>

Collections []GetFederatedDatabaseInstanceStorageDatabaseCollection
MaxWildcardCollections int
Name string: Name of the Atlas Federated Database Instance.
Views []GetFederatedDatabaseInstanceStorageDatabaseView

collections List<GetFederatedDatabaseInstanceStorageDatabaseCollection>
maxWildcardCollections Integer
name String: Name of the Atlas Federated Database Instance.
views List<GetFederatedDatabaseInstanceStorageDatabaseView>

collections GetFederatedDatabaseInstanceStorageDatabaseCollection[]
maxWildcardCollections number
name string: Name of the Atlas Federated Database Instance.
views GetFederatedDatabaseInstanceStorageDatabaseView[]

collections Sequence[GetFederatedDatabaseInstanceStorageDatabaseCollection]
max_wildcard_collections int
name str: Name of the Atlas Federated Database Instance.
views Sequence[GetFederatedDatabaseInstanceStorageDatabaseView]

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

GetFederatedDatabaseInstanceStorageDatabaseCollection

DataSources List<GetFederatedDatabaseInstanceStorageDatabaseCollectionDataSource>
Name string: Name of the Atlas Federated Database Instance.

DataSources []GetFederatedDatabaseInstanceStorageDatabaseCollectionDataSource
Name string: Name of the Atlas Federated Database Instance.

dataSources List<GetFederatedDatabaseInstanceStorageDatabaseCollectionDataSource>
name String: Name of the Atlas Federated Database Instance.

dataSources GetFederatedDatabaseInstanceStorageDatabaseCollectionDataSource[]
name string: Name of the Atlas Federated Database Instance.

data_sources Sequence[GetFederatedDatabaseInstanceStorageDatabaseCollectionDataSource]
name str: Name of the Atlas Federated Database Instance.

dataSources List<Property Map>
name String: Name of the Atlas Federated Database Instance.

GetFederatedDatabaseInstanceStorageDatabaseCollectionDataSource

AllowInsecure bool
Collection string
CollectionRegex string
Database string
DatabaseRegex string
DatasetName string
DefaultFormat string
Path string
ProvenanceFieldName string
StoreName string
Urls List<string>

AllowInsecure bool
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>

allowInsecure boolean
collection string
collectionRegex string
database string
databaseRegex string
datasetName string
defaultFormat string
path string
provenanceFieldName string
storeName string
urls string[]

allow_insecure bool
collection str
collection_regex str
database str
database_regex str
dataset_name str
default_format str
path str
provenance_field_name str
store_name str
urls Sequence[str]

allowInsecure Boolean
collection String
collectionRegex String
database String
databaseRegex String
datasetName String
defaultFormat String
path String
provenanceFieldName String
storeName String
urls List<String>

GetFederatedDatabaseInstanceStorageDatabaseView

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

GetFederatedDatabaseInstanceStorageStore

AdditionalStorageClasses List<string>
AllowInsecure bool
Bucket string
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
ReadPreferences List<GetFederatedDatabaseInstanceStorageStoreReadPreference>
Region string: Name of the region to which the Federanted Instnace routes client connections for data processing.
Urls List<string>

AdditionalStorageClasses []string
AllowInsecure bool
Bucket string
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
ReadPreferences []GetFederatedDatabaseInstanceStorageStoreReadPreference
Region string: Name of the region to which the Federanted Instnace routes client connections for data processing.
Urls []string

additionalStorageClasses List<String>
allowInsecure Boolean
bucket String
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
readPreferences List<GetFederatedDatabaseInstanceStorageStoreReadPreference>
region String: Name of the region to which the Federanted Instnace routes client connections for data processing.
urls List<String>

additionalStorageClasses string[]
allowInsecure boolean
bucket string
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
readPreferences GetFederatedDatabaseInstanceStorageStoreReadPreference[]
region string: Name of the region to which the Federanted Instnace routes client connections for data processing.
urls string[]

additional_storage_classes Sequence[str]
allow_insecure bool
bucket str
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_preferences Sequence[GetFederatedDatabaseInstanceStorageStoreReadPreference]
region str: Name of the region to which the Federanted Instnace routes client connections for data processing.
urls Sequence[str]

additionalStorageClasses List<String>
allowInsecure Boolean
bucket String
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
readPreferences List<Property Map>
region String: Name of the region to which the Federanted Instnace routes client connections for data processing.
urls List<String>