Docs Packages
  1. Packages
  2. MongoDB Atlas
  3. API Docs
  4. getFederatedDatabaseInstances
MongoDB Atlas v3.16.2 published on Friday, Jun 21, 2024 by Pulumi
pulumi/pulumi-mongodbatlas

mongodbatlas.getFederatedDatabaseInstances

Explore with Pulumi AI

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

    mongodbatlas_federated_database_instancess 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

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    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.GetFederatedDatabaseInstancesArgs;
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.getFederatedDatabaseInstances(GetFederatedDatabaseInstancesArgs.builder()
            .projectId("PROJECT ID")
            .name("TENANT NAME OF THE FEDERATED DATABASE INSTANCE")
            .build());

    }
}

    variables:
  test:
    fn::invoke:
      Function: mongodbatlas:getFederatedDatabaseInstances
      Arguments:
        projectId: PROJECT ID
        name: TENANT NAME OF THE FEDERATED DATABASE INSTANCE

    Using getFederatedDatabaseInstances

    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.

    function getFederatedDatabaseInstances(args: GetFederatedDatabaseInstancesArgs, opts?: InvokeOptions): Promise<GetFederatedDatabaseInstancesResult>
function getFederatedDatabaseInstancesOutput(args: GetFederatedDatabaseInstancesOutputArgs, opts?: InvokeOptions): Output<GetFederatedDatabaseInstancesResult>
    def get_federated_database_instances(project_id: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetFederatedDatabaseInstancesResult
def get_federated_database_instances_output(project_id: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetFederatedDatabaseInstancesResult]
    func LookupFederatedDatabaseInstances(ctx *Context, args *LookupFederatedDatabaseInstancesArgs, opts ...InvokeOption) (*LookupFederatedDatabaseInstancesResult, error)
func LookupFederatedDatabaseInstancesOutput(ctx *Context, args *LookupFederatedDatabaseInstancesOutputArgs, opts ...InvokeOption) LookupFederatedDatabaseInstancesResultOutput

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

    public static class GetFederatedDatabaseInstances 
{
    public static Task<GetFederatedDatabaseInstancesResult> InvokeAsync(GetFederatedDatabaseInstancesArgs args, InvokeOptions? opts = null)
    public static Output<GetFederatedDatabaseInstancesResult> Invoke(GetFederatedDatabaseInstancesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetFederatedDatabaseInstancesResult> getFederatedDatabaseInstances(GetFederatedDatabaseInstancesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    ProjectId string
    The unique ID for the project to create a Federated Database Instance.
    ProjectId string
    The unique ID for the project to create a Federated Database Instance.
    projectId String
    The unique ID for the project to create a Federated Database Instance.
    projectId string
    The unique ID for the project to create a Federated Database Instance.
    project_id str
    The unique ID for the project to create a Federated Database Instance.
    projectId String
    The unique ID for the project to create a Federated Database Instance.

    getFederatedDatabaseInstances Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    ProjectId string
    Results List<GetFederatedDatabaseInstancesResult>
    Includes Federated Database instance for each item detailed in the results array section.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProjectId string
    Results []GetFederatedDatabaseInstancesResult
    Includes Federated Database instance for each item detailed in the results array section.
    id String
    The provider-assigned unique ID for this managed resource.
    projectId String
    results List<GetFederatedDatabaseInstancesResult>
    Includes Federated Database instance for each item detailed in the results array section.
    id string
    The provider-assigned unique ID for this managed resource.
    projectId string
    results GetFederatedDatabaseInstancesResult[]
    Includes Federated Database instance for each item detailed in the results array section.
    id str
    The provider-assigned unique ID for this managed resource.
    project_id str
    results Sequence[GetFederatedDatabaseInstancesResult]
    Includes Federated Database instance for each item detailed in the results array section.
    id String
    The provider-assigned unique ID for this managed resource.
    projectId String
    results List<Property Map>
    Includes Federated Database instance for each item detailed in the results array section.

    Supporting Types

    GetFederatedDatabaseInstancesResult

    CloudProviderConfig GetFederatedDatabaseInstancesResultCloudProviderConfig
    DataProcessRegions List<GetFederatedDatabaseInstancesResultDataProcessRegion>
    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
    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<GetFederatedDatabaseInstancesResultStorageDatabase>
    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<GetFederatedDatabaseInstancesResultStorageStore>
    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 GetFederatedDatabaseInstancesResultCloudProviderConfig
    DataProcessRegions []GetFederatedDatabaseInstancesResultDataProcessRegion
    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
    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 []GetFederatedDatabaseInstancesResultStorageDatabase
    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 []GetFederatedDatabaseInstancesResultStorageStore
    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 GetFederatedDatabaseInstancesResultCloudProviderConfig
    dataProcessRegions List<GetFederatedDatabaseInstancesResultDataProcessRegion>
    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
    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<GetFederatedDatabaseInstancesResultStorageDatabase>
    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<GetFederatedDatabaseInstancesResultStorageStore>
    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 GetFederatedDatabaseInstancesResultCloudProviderConfig
    dataProcessRegions GetFederatedDatabaseInstancesResultDataProcessRegion[]
    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
    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 GetFederatedDatabaseInstancesResultStorageDatabase[]
    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 GetFederatedDatabaseInstancesResultStorageStore[]
    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 GetFederatedDatabaseInstancesResultCloudProviderConfig
    data_process_regions Sequence[GetFederatedDatabaseInstancesResultDataProcessRegion]
    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
    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[GetFederatedDatabaseInstancesResultStorageDatabase]
    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[GetFederatedDatabaseInstancesResultStorageStore]
    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
    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.
    name String
    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.

    GetFederatedDatabaseInstancesResultCloudProviderConfig

    GetFederatedDatabaseInstancesResultCloudProviderConfigAws

    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.

    data_process_region - The cloud provider region to which the Federated Instance routes client connections for data processing.

    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.

    data_process_region - The cloud provider region to which the Federated Instance routes client connections for data processing.

    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.

    data_process_region - The cloud provider region to which the Federated Instance routes client connections for data processing.

    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.

    data_process_region - The cloud provider region to which the Federated Instance routes client connections for data processing.

    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.

    data_process_region - The cloud provider region to which the Federated Instance routes client connections for data processing.

    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.

    data_process_region - The cloud provider region to which the Federated Instance routes client connections for data processing.

    testS3Bucket String

    GetFederatedDatabaseInstancesResultDataProcessRegion

    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.

    GetFederatedDatabaseInstancesResultStorageDatabase

    GetFederatedDatabaseInstancesResultStorageDatabaseCollection

    GetFederatedDatabaseInstancesResultStorageDatabaseCollectionDataSource

    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>

    GetFederatedDatabaseInstancesResultStorageDatabaseView

    Name string
    Pipeline string
    Source string
    Name string
    Pipeline string
    Source string
    name String
    pipeline String
    source String
    name string
    pipeline string
    source string
    name str
    pipeline str
    source str
    name String
    pipeline String
    source String

    GetFederatedDatabaseInstancesResultStorageStore

    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
    Prefix string
    ProjectId string
    The unique ID for the project to create a Federated Database Instance.
    Provider string
    Public string
    ReadPreferences List<GetFederatedDatabaseInstancesResultStorageStoreReadPreference>
    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
    ClusterId string

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

    ClusterName string
    DefaultFormat string
    Delimiter string
    IncludeTags bool
    Name string
    Prefix string
    ProjectId string
    The unique ID for the project to create a Federated Database Instance.
    Provider string
    Public string
    ReadPreferences []GetFederatedDatabaseInstancesResultStorageStoreReadPreference
    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
    clusterId String

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

    clusterName String
    defaultFormat String
    delimiter String
    includeTags Boolean
    name String
    prefix String
    projectId String
    The unique ID for the project to create a Federated Database Instance.
    provider String
    public_ String
    readPreferences List<GetFederatedDatabaseInstancesResultStorageStoreReadPreference>
    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
    clusterId string

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

    clusterName string
    defaultFormat string
    delimiter string
    includeTags boolean
    name string
    prefix string
    projectId string
    The unique ID for the project to create a Federated Database Instance.
    provider string
    public string
    readPreferences GetFederatedDatabaseInstancesResultStorageStoreReadPreference[]
    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_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
    prefix str
    project_id str
    The unique ID for the project to create a Federated Database Instance.
    provider str
    public str
    read_preferences Sequence[GetFederatedDatabaseInstancesResultStorageStoreReadPreference]
    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
    clusterId String

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

    clusterName String
    defaultFormat String
    delimiter String
    includeTags Boolean
    name String
    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>

    GetFederatedDatabaseInstancesResultStorageStoreReadPreference

    GetFederatedDatabaseInstancesResultStorageStoreReadPreferenceTagSet

    GetFederatedDatabaseInstancesResultStorageStoreReadPreferenceTagSetTag

    Name string
    Value string
    Name string
    Value string
    name String
    value String
    name string
    value string
    name str
    value str
    name String
    value String

    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
    pulumi/pulumi-mongodbatlas