mongodbatlas.getFederatedDatabaseInstance

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.

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

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

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

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

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

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>

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.

Aws GetFederatedDatabaseInstanceCloudProviderConfigAws

Aws GetFederatedDatabaseInstanceCloudProviderConfigAws

aws GetFederatedDatabaseInstanceCloudProviderConfigAws

aws GetFederatedDatabaseInstanceCloudProviderConfigAws

aws GetFederatedDatabaseInstanceCloudProviderConfigAws

aws Property Map

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

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.

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>

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.

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>

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

AdditionalStorageClasses List<string>

AllowInsecure bool

Bucket string

ClusterId string

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

ClusterName string

DefaultFormat string

Delimiter string

IncludeTags bool

Name string

Name of the Atlas Federated Database Instance.

Prefix string

ProjectId string

The unique ID for the project to create a Federated Database Instance.

Provider string

Public string

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

ClusterId string

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

ClusterName string

DefaultFormat string

Delimiter string

IncludeTags bool

Name string

Name of the Atlas Federated Database Instance.

Prefix string

ProjectId string

The unique ID for the project to create a Federated Database Instance.

Provider string

Public string

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

clusterId String

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

clusterName String

defaultFormat String

delimiter String

includeTags Boolean

name String

Name of the Atlas Federated Database Instance.

prefix String

projectId String

The unique ID for the project to create a Federated Database Instance.

provider String

public_ String

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

clusterId string

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

clusterName string

defaultFormat string

delimiter string

includeTags boolean

name string

Name of the Atlas Federated Database Instance.

prefix string

projectId string

The unique ID for the project to create a Federated Database Instance.

provider string

public string

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_id str

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

cluster_name str

default_format str

delimiter str

include_tags bool

name str

Name of the Atlas Federated Database Instance.

prefix str

project_id str

The unique ID for the project to create a Federated Database Instance.

provider str

public str

read_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

clusterId String

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

clusterName String

defaultFormat String

delimiter String

includeTags Boolean

name String

Name of the Atlas Federated Database Instance.

prefix String

projectId String

The unique ID for the project to create a Federated Database Instance.

provider String

public String

readPreferences List<Property Map>

region String

Name of the region to which the Federanted Instnace routes client connections for data processing.

urls List<String>

MaxStalenessSeconds int

Mode string

TagSets List<GetFederatedDatabaseInstanceStorageStoreReadPreferenceTagSet>

MaxStalenessSeconds int

Mode string

TagSets []GetFederatedDatabaseInstanceStorageStoreReadPreferenceTagSet

maxStalenessSeconds Integer

mode String

tagSets List<GetFederatedDatabaseInstanceStorageStoreReadPreferenceTagSet>

maxStalenessSeconds number

mode string

tagSets GetFederatedDatabaseInstanceStorageStoreReadPreferenceTagSet[]

max_staleness_seconds int

mode str

tag_sets Sequence[GetFederatedDatabaseInstanceStorageStoreReadPreferenceTagSet]

maxStalenessSeconds Number

mode String

tagSets List<Property Map>

Tags List<GetFederatedDatabaseInstanceStorageStoreReadPreferenceTagSetTag>

Tags []GetFederatedDatabaseInstanceStorageStoreReadPreferenceTagSetTag

tags List<GetFederatedDatabaseInstanceStorageStoreReadPreferenceTagSetTag>

tags GetFederatedDatabaseInstanceStorageStoreReadPreferenceTagSetTag[]

tags Sequence[GetFederatedDatabaseInstanceStorageStoreReadPreferenceTagSetTag]

tags List<Property Map>

Name string

Name of the Atlas Federated Database Instance.

Value string

Name string

Name of the Atlas Federated Database Instance.

Value string

name String

Name of the Atlas Federated Database Instance.

value String

name string

Name of the Atlas Federated Database Instance.

value string

name str

Name of the Atlas Federated Database Instance.

value str

name String

Name of the Atlas Federated Database Instance.

value String