Docs Home
MongoDB Atlas v3.20.4 published on Wednesday, Oct 30, 2024 by Pulumi
mongodbatlas.FederatedDatabaseInstance
Explore with Pulumi AI
# Resource: mongodbatlas.FederatedDatabaseInstance
mongodbatlas.FederatedDatabaseInstance provides a Federated Database Instance resource.
NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.
Example Usage
S With MongoDB Atlas Cluster As Storage Database
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";
const test = new mongodbatlas.FederatedDatabaseInstance("test", {
projectId: "PROJECT ID",
name: "TENANT NAME OF THE FEDERATED DATABASE INSTANCE",
storageDatabases: [{
name: "VirtualDatabase0",
collections: [{
name: "NAME OF THE COLLECTION",
dataSources: [{
collection: "COLLECTION IN THE CLUSTER",
database: "DB IN THE CLUSTER",
storeName: "CLUSTER NAME",
}],
}],
}],
storageStores: [{
name: "STORE 1 NAME",
clusterName: "CLUSTER NAME",
projectId: "PROJECT ID",
provider: "atlas",
readPreference: {
mode: "secondary",
},
}],
});
import pulumi
import pulumi_mongodbatlas as mongodbatlas
test = mongodbatlas.FederatedDatabaseInstance("test",
project_id="PROJECT ID",
name="TENANT NAME OF THE FEDERATED DATABASE INSTANCE",
storage_databases=[{
"name": "VirtualDatabase0",
"collections": [{
"name": "NAME OF THE COLLECTION",
"data_sources": [{
"collection": "COLLECTION IN THE CLUSTER",
"database": "DB IN THE CLUSTER",
"store_name": "CLUSTER NAME",
}],
}],
}],
storage_stores=[{
"name": "STORE 1 NAME",
"cluster_name": "CLUSTER NAME",
"project_id": "PROJECT ID",
"provider": "atlas",
"read_preference": {
"mode": "secondary",
},
}])
package main
import (
"github.com/pulumi/pulumi-mongodbatlas/sdk/v3/go/mongodbatlas"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := mongodbatlas.NewFederatedDatabaseInstance(ctx, "test", &mongodbatlas.FederatedDatabaseInstanceArgs{
ProjectId: pulumi.String("PROJECT ID"),
Name: pulumi.String("TENANT NAME OF THE FEDERATED DATABASE INSTANCE"),
StorageDatabases: mongodbatlas.FederatedDatabaseInstanceStorageDatabaseArray{
&mongodbatlas.FederatedDatabaseInstanceStorageDatabaseArgs{
Name: pulumi.String("VirtualDatabase0"),
Collections: mongodbatlas.FederatedDatabaseInstanceStorageDatabaseCollectionArray{
&mongodbatlas.FederatedDatabaseInstanceStorageDatabaseCollectionArgs{
Name: pulumi.String("NAME OF THE COLLECTION"),
DataSources: mongodbatlas.FederatedDatabaseInstanceStorageDatabaseCollectionDataSourceArray{
&mongodbatlas.FederatedDatabaseInstanceStorageDatabaseCollectionDataSourceArgs{
Collection: pulumi.String("COLLECTION IN THE CLUSTER"),
Database: pulumi.String("DB IN THE CLUSTER"),
StoreName: pulumi.String("CLUSTER NAME"),
},
},
},
},
},
},
StorageStores: mongodbatlas.FederatedDatabaseInstanceStorageStoreArray{
&mongodbatlas.FederatedDatabaseInstanceStorageStoreArgs{
Name: pulumi.String("STORE 1 NAME"),
ClusterName: pulumi.String("CLUSTER NAME"),
ProjectId: pulumi.String("PROJECT ID"),
Provider: pulumi.String("atlas"),
ReadPreference: &mongodbatlas.FederatedDatabaseInstanceStorageStoreReadPreferenceArgs{
Mode: pulumi.String("secondary"),
},
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;
return await Deployment.RunAsync(() =>
{
var test = new Mongodbatlas.FederatedDatabaseInstance("test", new()
{
ProjectId = "PROJECT ID",
Name = "TENANT NAME OF THE FEDERATED DATABASE INSTANCE",
StorageDatabases = new[]
{
new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageDatabaseArgs
{
Name = "VirtualDatabase0",
Collections = new[]
{
new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageDatabaseCollectionArgs
{
Name = "NAME OF THE COLLECTION",
DataSources = new[]
{
new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageDatabaseCollectionDataSourceArgs
{
Collection = "COLLECTION IN THE CLUSTER",
Database = "DB IN THE CLUSTER",
StoreName = "CLUSTER NAME",
},
},
},
},
},
},
StorageStores = new[]
{
new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageStoreArgs
{
Name = "STORE 1 NAME",
ClusterName = "CLUSTER NAME",
ProjectId = "PROJECT ID",
Provider = "atlas",
ReadPreference = new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageStoreReadPreferenceArgs
{
Mode = "secondary",
},
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.FederatedDatabaseInstance;
import com.pulumi.mongodbatlas.FederatedDatabaseInstanceArgs;
import com.pulumi.mongodbatlas.inputs.FederatedDatabaseInstanceStorageDatabaseArgs;
import com.pulumi.mongodbatlas.inputs.FederatedDatabaseInstanceStorageStoreArgs;
import com.pulumi.mongodbatlas.inputs.FederatedDatabaseInstanceStorageStoreReadPreferenceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var test = new FederatedDatabaseInstance("test", FederatedDatabaseInstanceArgs.builder()
.projectId("PROJECT ID")
.name("TENANT NAME OF THE FEDERATED DATABASE INSTANCE")
.storageDatabases(FederatedDatabaseInstanceStorageDatabaseArgs.builder()
.name("VirtualDatabase0")
.collections(FederatedDatabaseInstanceStorageDatabaseCollectionArgs.builder()
.name("NAME OF THE COLLECTION")
.dataSources(FederatedDatabaseInstanceStorageDatabaseCollectionDataSourceArgs.builder()
.collection("COLLECTION IN THE CLUSTER")
.database("DB IN THE CLUSTER")
.storeName("CLUSTER NAME")
.build())
.build())
.build())
.storageStores(FederatedDatabaseInstanceStorageStoreArgs.builder()
.name("STORE 1 NAME")
.clusterName("CLUSTER NAME")
.projectId("PROJECT ID")
.provider("atlas")
.readPreference(FederatedDatabaseInstanceStorageStoreReadPreferenceArgs.builder()
.mode("secondary")
.build())
.build())
.build());
}
}
resources:
test:
type: mongodbatlas:FederatedDatabaseInstance
properties:
projectId: PROJECT ID
name: TENANT NAME OF THE FEDERATED DATABASE INSTANCE
storageDatabases:
- name: VirtualDatabase0
collections:
- name: NAME OF THE COLLECTION
dataSources:
- collection: COLLECTION IN THE CLUSTER
database: DB IN THE CLUSTER
storeName: CLUSTER NAME
storageStores:
- name: STORE 1 NAME
clusterName: CLUSTER NAME
projectId: PROJECT ID
provider: atlas
readPreference:
mode: secondary
S With Amazon S3 Bucket As Storage Database
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";
const test = new mongodbatlas.FederatedDatabaseInstance("test", {
projectId: "PROJECT ID",
name: "TENANT NAME OF THE FEDERATED DATABASE INSTANCE",
cloudProviderConfig: {
aws: {
roleId: "AWS ROLE ID",
testS3Bucket: "S3 BUCKET NAME",
},
},
storageDatabases: [{
name: "VirtualDatabase0",
collections: [{
name: "NAME OF THE COLLECTION",
dataSources: [
{
collection: "COLLECTION IN THE CLUSTER",
database: "DB IN THE CLUSTER",
storeName: "CLUSTER NAME",
},
{
storeName: "S3 BUCKET NAME",
path: "S3 BUCKET PATH",
},
],
}],
}],
storageStores: [
{
name: "STORE 1 NAME",
clusterName: "CLUSTER NAME",
projectId: "PROJECT ID",
provider: "atlas",
readPreference: {
mode: "secondary",
},
},
{
bucket: "STORE 2 NAME",
delimiter: "/",
name: "S3 BUCKET NAME",
prefix: "S3 BUCKET PREFIX",
provider: "s3",
region: "AWS REGION",
},
],
});
import pulumi
import pulumi_mongodbatlas as mongodbatlas
test = mongodbatlas.FederatedDatabaseInstance("test",
project_id="PROJECT ID",
name="TENANT NAME OF THE FEDERATED DATABASE INSTANCE",
cloud_provider_config={
"aws": {
"role_id": "AWS ROLE ID",
"test_s3_bucket": "S3 BUCKET NAME",
},
},
storage_databases=[{
"name": "VirtualDatabase0",
"collections": [{
"name": "NAME OF THE COLLECTION",
"data_sources": [
{
"collection": "COLLECTION IN THE CLUSTER",
"database": "DB IN THE CLUSTER",
"store_name": "CLUSTER NAME",
},
{
"store_name": "S3 BUCKET NAME",
"path": "S3 BUCKET PATH",
},
],
}],
}],
storage_stores=[
{
"name": "STORE 1 NAME",
"cluster_name": "CLUSTER NAME",
"project_id": "PROJECT ID",
"provider": "atlas",
"read_preference": {
"mode": "secondary",
},
},
{
"bucket": "STORE 2 NAME",
"delimiter": "/",
"name": "S3 BUCKET NAME",
"prefix": "S3 BUCKET PREFIX",
"provider": "s3",
"region": "AWS REGION",
},
])
package main
import (
"github.com/pulumi/pulumi-mongodbatlas/sdk/v3/go/mongodbatlas"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := mongodbatlas.NewFederatedDatabaseInstance(ctx, "test", &mongodbatlas.FederatedDatabaseInstanceArgs{
ProjectId: pulumi.String("PROJECT ID"),
Name: pulumi.String("TENANT NAME OF THE FEDERATED DATABASE INSTANCE"),
CloudProviderConfig: &mongodbatlas.FederatedDatabaseInstanceCloudProviderConfigArgs{
Aws: &mongodbatlas.FederatedDatabaseInstanceCloudProviderConfigAwsArgs{
RoleId: pulumi.String("AWS ROLE ID"),
TestS3Bucket: pulumi.String("S3 BUCKET NAME"),
},
},
StorageDatabases: mongodbatlas.FederatedDatabaseInstanceStorageDatabaseArray{
&mongodbatlas.FederatedDatabaseInstanceStorageDatabaseArgs{
Name: pulumi.String("VirtualDatabase0"),
Collections: mongodbatlas.FederatedDatabaseInstanceStorageDatabaseCollectionArray{
&mongodbatlas.FederatedDatabaseInstanceStorageDatabaseCollectionArgs{
Name: pulumi.String("NAME OF THE COLLECTION"),
DataSources: mongodbatlas.FederatedDatabaseInstanceStorageDatabaseCollectionDataSourceArray{
&mongodbatlas.FederatedDatabaseInstanceStorageDatabaseCollectionDataSourceArgs{
Collection: pulumi.String("COLLECTION IN THE CLUSTER"),
Database: pulumi.String("DB IN THE CLUSTER"),
StoreName: pulumi.String("CLUSTER NAME"),
},
&mongodbatlas.FederatedDatabaseInstanceStorageDatabaseCollectionDataSourceArgs{
StoreName: pulumi.String("S3 BUCKET NAME"),
Path: pulumi.String("S3 BUCKET PATH"),
},
},
},
},
},
},
StorageStores: mongodbatlas.FederatedDatabaseInstanceStorageStoreArray{
&mongodbatlas.FederatedDatabaseInstanceStorageStoreArgs{
Name: pulumi.String("STORE 1 NAME"),
ClusterName: pulumi.String("CLUSTER NAME"),
ProjectId: pulumi.String("PROJECT ID"),
Provider: pulumi.String("atlas"),
ReadPreference: &mongodbatlas.FederatedDatabaseInstanceStorageStoreReadPreferenceArgs{
Mode: pulumi.String("secondary"),
},
},
&mongodbatlas.FederatedDatabaseInstanceStorageStoreArgs{
Bucket: pulumi.String("STORE 2 NAME"),
Delimiter: pulumi.String("/"),
Name: pulumi.String("S3 BUCKET NAME"),
Prefix: pulumi.String("S3 BUCKET PREFIX"),
Provider: pulumi.String("s3"),
Region: pulumi.String("AWS REGION"),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;
return await Deployment.RunAsync(() =>
{
var test = new Mongodbatlas.FederatedDatabaseInstance("test", new()
{
ProjectId = "PROJECT ID",
Name = "TENANT NAME OF THE FEDERATED DATABASE INSTANCE",
CloudProviderConfig = new Mongodbatlas.Inputs.FederatedDatabaseInstanceCloudProviderConfigArgs
{
Aws = new Mongodbatlas.Inputs.FederatedDatabaseInstanceCloudProviderConfigAwsArgs
{
RoleId = "AWS ROLE ID",
TestS3Bucket = "S3 BUCKET NAME",
},
},
StorageDatabases = new[]
{
new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageDatabaseArgs
{
Name = "VirtualDatabase0",
Collections = new[]
{
new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageDatabaseCollectionArgs
{
Name = "NAME OF THE COLLECTION",
DataSources = new[]
{
new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageDatabaseCollectionDataSourceArgs
{
Collection = "COLLECTION IN THE CLUSTER",
Database = "DB IN THE CLUSTER",
StoreName = "CLUSTER NAME",
},
new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageDatabaseCollectionDataSourceArgs
{
StoreName = "S3 BUCKET NAME",
Path = "S3 BUCKET PATH",
},
},
},
},
},
},
StorageStores = new[]
{
new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageStoreArgs
{
Name = "STORE 1 NAME",
ClusterName = "CLUSTER NAME",
ProjectId = "PROJECT ID",
Provider = "atlas",
ReadPreference = new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageStoreReadPreferenceArgs
{
Mode = "secondary",
},
},
new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageStoreArgs
{
Bucket = "STORE 2 NAME",
Delimiter = "/",
Name = "S3 BUCKET NAME",
Prefix = "S3 BUCKET PREFIX",
Provider = "s3",
Region = "AWS REGION",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.FederatedDatabaseInstance;
import com.pulumi.mongodbatlas.FederatedDatabaseInstanceArgs;
import com.pulumi.mongodbatlas.inputs.FederatedDatabaseInstanceCloudProviderConfigArgs;
import com.pulumi.mongodbatlas.inputs.FederatedDatabaseInstanceCloudProviderConfigAwsArgs;
import com.pulumi.mongodbatlas.inputs.FederatedDatabaseInstanceStorageDatabaseArgs;
import com.pulumi.mongodbatlas.inputs.FederatedDatabaseInstanceStorageStoreArgs;
import com.pulumi.mongodbatlas.inputs.FederatedDatabaseInstanceStorageStoreReadPreferenceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var test = new FederatedDatabaseInstance("test", FederatedDatabaseInstanceArgs.builder()
.projectId("PROJECT ID")
.name("TENANT NAME OF THE FEDERATED DATABASE INSTANCE")
.cloudProviderConfig(FederatedDatabaseInstanceCloudProviderConfigArgs.builder()
.aws(FederatedDatabaseInstanceCloudProviderConfigAwsArgs.builder()
.roleId("AWS ROLE ID")
.testS3Bucket("S3 BUCKET NAME")
.build())
.build())
.storageDatabases(FederatedDatabaseInstanceStorageDatabaseArgs.builder()
.name("VirtualDatabase0")
.collections(FederatedDatabaseInstanceStorageDatabaseCollectionArgs.builder()
.name("NAME OF THE COLLECTION")
.dataSources(
FederatedDatabaseInstanceStorageDatabaseCollectionDataSourceArgs.builder()
.collection("COLLECTION IN THE CLUSTER")
.database("DB IN THE CLUSTER")
.storeName("CLUSTER NAME")
.build(),
FederatedDatabaseInstanceStorageDatabaseCollectionDataSourceArgs.builder()
.storeName("S3 BUCKET NAME")
.path("S3 BUCKET PATH")
.build())
.build())
.build())
.storageStores(
FederatedDatabaseInstanceStorageStoreArgs.builder()
.name("STORE 1 NAME")
.clusterName("CLUSTER NAME")
.projectId("PROJECT ID")
.provider("atlas")
.readPreference(FederatedDatabaseInstanceStorageStoreReadPreferenceArgs.builder()
.mode("secondary")
.build())
.build(),
FederatedDatabaseInstanceStorageStoreArgs.builder()
.bucket("STORE 2 NAME")
.delimiter("/")
.name("S3 BUCKET NAME")
.prefix("S3 BUCKET PREFIX")
.provider("s3")
.region("AWS REGION")
.build())
.build());
}
}
resources:
test:
type: mongodbatlas:FederatedDatabaseInstance
properties:
projectId: PROJECT ID
name: TENANT NAME OF THE FEDERATED DATABASE INSTANCE
cloudProviderConfig:
aws:
roleId: AWS ROLE ID
testS3Bucket: S3 BUCKET NAME
storageDatabases:
- name: VirtualDatabase0
collections:
- name: NAME OF THE COLLECTION
dataSources:
- collection: COLLECTION IN THE CLUSTER
database: DB IN THE CLUSTER
storeName: CLUSTER NAME
- storeName: S3 BUCKET NAME
path: S3 BUCKET PATH
storageStores:
- name: STORE 1 NAME
clusterName: CLUSTER NAME
projectId: PROJECT ID
provider: atlas
readPreference:
mode: secondary
- bucket: STORE 2 NAME
delimiter: /
name: S3 BUCKET NAME
prefix: S3 BUCKET PREFIX
provider: s3
region: AWS REGION
Example specifying data process region and provider
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";
const test = new mongodbatlas.FederatedDatabaseInstance("test", {
projectId: "PROJECT ID",
name: "NAME OF THE FEDERATED DATABASE INSTANCE",
dataProcessRegion: {
cloudProvider: "AWS",
region: "OREGON_USA",
},
});
import pulumi
import pulumi_mongodbatlas as mongodbatlas
test = mongodbatlas.FederatedDatabaseInstance("test",
project_id="PROJECT ID",
name="NAME OF THE FEDERATED DATABASE INSTANCE",
data_process_region={
"cloud_provider": "AWS",
"region": "OREGON_USA",
})
package main
import (
"github.com/pulumi/pulumi-mongodbatlas/sdk/v3/go/mongodbatlas"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := mongodbatlas.NewFederatedDatabaseInstance(ctx, "test", &mongodbatlas.FederatedDatabaseInstanceArgs{
ProjectId: pulumi.String("PROJECT ID"),
Name: pulumi.String("NAME OF THE FEDERATED DATABASE INSTANCE"),
DataProcessRegion: &mongodbatlas.FederatedDatabaseInstanceDataProcessRegionArgs{
CloudProvider: pulumi.String("AWS"),
Region: pulumi.String("OREGON_USA"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;
return await Deployment.RunAsync(() =>
{
var test = new Mongodbatlas.FederatedDatabaseInstance("test", new()
{
ProjectId = "PROJECT ID",
Name = "NAME OF THE FEDERATED DATABASE INSTANCE",
DataProcessRegion = new Mongodbatlas.Inputs.FederatedDatabaseInstanceDataProcessRegionArgs
{
CloudProvider = "AWS",
Region = "OREGON_USA",
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.FederatedDatabaseInstance;
import com.pulumi.mongodbatlas.FederatedDatabaseInstanceArgs;
import com.pulumi.mongodbatlas.inputs.FederatedDatabaseInstanceDataProcessRegionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var test = new FederatedDatabaseInstance("test", FederatedDatabaseInstanceArgs.builder()
.projectId("PROJECT ID")
.name("NAME OF THE FEDERATED DATABASE INSTANCE")
.dataProcessRegion(FederatedDatabaseInstanceDataProcessRegionArgs.builder()
.cloudProvider("AWS")
.region("OREGON_USA")
.build())
.build());
}
}
resources:
test:
type: mongodbatlas:FederatedDatabaseInstance
properties:
projectId: PROJECT ID
name: NAME OF THE FEDERATED DATABASE INSTANCE
dataProcessRegion:
cloudProvider: AWS
region: OREGON_USA
Create FederatedDatabaseInstance Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new FederatedDatabaseInstance(name: string, args: FederatedDatabaseInstanceArgs, opts?: CustomResourceOptions);@overload
def FederatedDatabaseInstance(resource_name: str,
args: FederatedDatabaseInstanceArgs,
opts: Optional[ResourceOptions] = None)
@overload
def FederatedDatabaseInstance(resource_name: str,
opts: Optional[ResourceOptions] = None,
project_id: Optional[str] = None,
cloud_provider_config: Optional[FederatedDatabaseInstanceCloudProviderConfigArgs] = None,
data_process_region: Optional[FederatedDatabaseInstanceDataProcessRegionArgs] = None,
name: Optional[str] = None,
storage_databases: Optional[Sequence[FederatedDatabaseInstanceStorageDatabaseArgs]] = None,
storage_stores: Optional[Sequence[FederatedDatabaseInstanceStorageStoreArgs]] = None)func NewFederatedDatabaseInstance(ctx *Context, name string, args FederatedDatabaseInstanceArgs, opts ...ResourceOption) (*FederatedDatabaseInstance, error)public FederatedDatabaseInstance(string name, FederatedDatabaseInstanceArgs args, CustomResourceOptions? opts = null)
public FederatedDatabaseInstance(String name, FederatedDatabaseInstanceArgs args)
public FederatedDatabaseInstance(String name, FederatedDatabaseInstanceArgs args, CustomResourceOptions options)
type: mongodbatlas:FederatedDatabaseInstance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args FederatedDatabaseInstanceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args FederatedDatabaseInstanceArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args FederatedDatabaseInstanceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FederatedDatabaseInstanceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FederatedDatabaseInstanceArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var federatedDatabaseInstanceResource = new Mongodbatlas.FederatedDatabaseInstance("federatedDatabaseInstanceResource", new()
{
ProjectId = "string",
CloudProviderConfig = new Mongodbatlas.Inputs.FederatedDatabaseInstanceCloudProviderConfigArgs
{
Aws = new Mongodbatlas.Inputs.FederatedDatabaseInstanceCloudProviderConfigAwsArgs
{
RoleId = "string",
TestS3Bucket = "string",
ExternalId = "string",
IamAssumedRoleArn = "string",
IamUserArn = "string",
},
},
DataProcessRegion = new Mongodbatlas.Inputs.FederatedDatabaseInstanceDataProcessRegionArgs
{
CloudProvider = "string",
Region = "string",
},
Name = "string",
StorageDatabases = new[]
{
new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageDatabaseArgs
{
Collections = new[]
{
new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageDatabaseCollectionArgs
{
DataSources = new[]
{
new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageDatabaseCollectionDataSourceArgs
{
AllowInsecure = false,
Collection = "string",
CollectionRegex = "string",
Database = "string",
DatabaseRegex = "string",
DatasetName = "string",
DefaultFormat = "string",
Path = "string",
ProvenanceFieldName = "string",
StoreName = "string",
Urls = new[]
{
"string",
},
},
},
Name = "string",
},
},
MaxWildcardCollections = 0,
Name = "string",
Views = new[]
{
new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageDatabaseViewArgs
{
Name = "string",
Pipeline = "string",
Source = "string",
},
},
},
},
StorageStores = new[]
{
new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageStoreArgs
{
AdditionalStorageClasses = new[]
{
"string",
},
AllowInsecure = false,
Bucket = "string",
ClusterName = "string",
DefaultFormat = "string",
Delimiter = "string",
IncludeTags = false,
Name = "string",
Prefix = "string",
ProjectId = "string",
Provider = "string",
Public = "string",
ReadPreference = new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageStoreReadPreferenceArgs
{
MaxStalenessSeconds = 0,
Mode = "string",
TagSets = new[]
{
new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageStoreReadPreferenceTagSetArgs
{
Tags = new[]
{
new Mongodbatlas.Inputs.FederatedDatabaseInstanceStorageStoreReadPreferenceTagSetTagArgs
{
Name = "string",
Value = "string",
},
},
},
},
},
Region = "string",
Urls = new[]
{
"string",
},
},
},
});
example, err := mongodbatlas.NewFederatedDatabaseInstance(ctx, "federatedDatabaseInstanceResource", &mongodbatlas.FederatedDatabaseInstanceArgs{
ProjectId: pulumi.String("string"),
CloudProviderConfig: &mongodbatlas.FederatedDatabaseInstanceCloudProviderConfigArgs{
Aws: &mongodbatlas.FederatedDatabaseInstanceCloudProviderConfigAwsArgs{
RoleId: pulumi.String("string"),
TestS3Bucket: pulumi.String("string"),
ExternalId: pulumi.String("string"),
IamAssumedRoleArn: pulumi.String("string"),
IamUserArn: pulumi.String("string"),
},
},
DataProcessRegion: &mongodbatlas.FederatedDatabaseInstanceDataProcessRegionArgs{
CloudProvider: pulumi.String("string"),
Region: pulumi.String("string"),
},
Name: pulumi.String("string"),
StorageDatabases: mongodbatlas.FederatedDatabaseInstanceStorageDatabaseArray{
&mongodbatlas.FederatedDatabaseInstanceStorageDatabaseArgs{
Collections: mongodbatlas.FederatedDatabaseInstanceStorageDatabaseCollectionArray{
&mongodbatlas.FederatedDatabaseInstanceStorageDatabaseCollectionArgs{
DataSources: mongodbatlas.FederatedDatabaseInstanceStorageDatabaseCollectionDataSourceArray{
&mongodbatlas.FederatedDatabaseInstanceStorageDatabaseCollectionDataSourceArgs{
AllowInsecure: pulumi.Bool(false),
Collection: pulumi.String("string"),
CollectionRegex: pulumi.String("string"),
Database: pulumi.String("string"),
DatabaseRegex: pulumi.String("string"),
DatasetName: pulumi.String("string"),
DefaultFormat: pulumi.String("string"),
Path: pulumi.String("string"),
ProvenanceFieldName: pulumi.String("string"),
StoreName: pulumi.String("string"),
Urls: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Name: pulumi.String("string"),
},
},
MaxWildcardCollections: pulumi.Int(0),
Name: pulumi.String("string"),
Views: mongodbatlas.FederatedDatabaseInstanceStorageDatabaseViewArray{
&mongodbatlas.FederatedDatabaseInstanceStorageDatabaseViewArgs{
Name: pulumi.String("string"),
Pipeline: pulumi.String("string"),
Source: pulumi.String("string"),
},
},
},
},
StorageStores: mongodbatlas.FederatedDatabaseInstanceStorageStoreArray{
&mongodbatlas.FederatedDatabaseInstanceStorageStoreArgs{
AdditionalStorageClasses: pulumi.StringArray{
pulumi.String("string"),
},
AllowInsecure: pulumi.Bool(false),
Bucket: pulumi.String("string"),
ClusterName: pulumi.String("string"),
DefaultFormat: pulumi.String("string"),
Delimiter: pulumi.String("string"),
IncludeTags: pulumi.Bool(false),
Name: pulumi.String("string"),
Prefix: pulumi.String("string"),
ProjectId: pulumi.String("string"),
Provider: pulumi.String("string"),
Public: pulumi.String("string"),
ReadPreference: &mongodbatlas.FederatedDatabaseInstanceStorageStoreReadPreferenceArgs{
MaxStalenessSeconds: pulumi.Int(0),
Mode: pulumi.String("string"),
TagSets: mongodbatlas.FederatedDatabaseInstanceStorageStoreReadPreferenceTagSetArray{
&mongodbatlas.FederatedDatabaseInstanceStorageStoreReadPreferenceTagSetArgs{
Tags: mongodbatlas.FederatedDatabaseInstanceStorageStoreReadPreferenceTagSetTagArray{
&mongodbatlas.FederatedDatabaseInstanceStorageStoreReadPreferenceTagSetTagArgs{
Name: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
},
},
},
Region: pulumi.String("string"),
Urls: pulumi.StringArray{
pulumi.String("string"),
},
},
},
})
var federatedDatabaseInstanceResource = new FederatedDatabaseInstance("federatedDatabaseInstanceResource", FederatedDatabaseInstanceArgs.builder()
.projectId("string")
.cloudProviderConfig(FederatedDatabaseInstanceCloudProviderConfigArgs.builder()
.aws(FederatedDatabaseInstanceCloudProviderConfigAwsArgs.builder()
.roleId("string")
.testS3Bucket("string")
.externalId("string")
.iamAssumedRoleArn("string")
.iamUserArn("string")
.build())
.build())
.dataProcessRegion(FederatedDatabaseInstanceDataProcessRegionArgs.builder()
.cloudProvider("string")
.region("string")
.build())
.name("string")
.storageDatabases(FederatedDatabaseInstanceStorageDatabaseArgs.builder()
.collections(FederatedDatabaseInstanceStorageDatabaseCollectionArgs.builder()
.dataSources(FederatedDatabaseInstanceStorageDatabaseCollectionDataSourceArgs.builder()
.allowInsecure(false)
.collection("string")
.collectionRegex("string")
.database("string")
.databaseRegex("string")
.datasetName("string")
.defaultFormat("string")
.path("string")
.provenanceFieldName("string")
.storeName("string")
.urls("string")
.build())
.name("string")
.build())
.maxWildcardCollections(0)
.name("string")
.views(FederatedDatabaseInstanceStorageDatabaseViewArgs.builder()
.name("string")
.pipeline("string")
.source("string")
.build())
.build())
.storageStores(FederatedDatabaseInstanceStorageStoreArgs.builder()
.additionalStorageClasses("string")
.allowInsecure(false)
.bucket("string")
.clusterName("string")
.defaultFormat("string")
.delimiter("string")
.includeTags(false)
.name("string")
.prefix("string")
.projectId("string")
.provider("string")
.public_("string")
.readPreference(FederatedDatabaseInstanceStorageStoreReadPreferenceArgs.builder()
.maxStalenessSeconds(0)
.mode("string")
.tagSets(FederatedDatabaseInstanceStorageStoreReadPreferenceTagSetArgs.builder()
.tags(FederatedDatabaseInstanceStorageStoreReadPreferenceTagSetTagArgs.builder()
.name("string")
.value("string")
.build())
.build())
.build())
.region("string")
.urls("string")
.build())
.build());
federated_database_instance_resource = mongodbatlas.FederatedDatabaseInstance("federatedDatabaseInstanceResource",
project_id="string",
cloud_provider_config={
"aws": {
"role_id": "string",
"test_s3_bucket": "string",
"external_id": "string",
"iam_assumed_role_arn": "string",
"iam_user_arn": "string",
},
},
data_process_region={
"cloud_provider": "string",
"region": "string",
},
name="string",
storage_databases=[{
"collections": [{
"data_sources": [{
"allow_insecure": False,
"collection": "string",
"collection_regex": "string",
"database": "string",
"database_regex": "string",
"dataset_name": "string",
"default_format": "string",
"path": "string",
"provenance_field_name": "string",
"store_name": "string",
"urls": ["string"],
}],
"name": "string",
}],
"max_wildcard_collections": 0,
"name": "string",
"views": [{
"name": "string",
"pipeline": "string",
"source": "string",
}],
}],
storage_stores=[{
"additional_storage_classes": ["string"],
"allow_insecure": False,
"bucket": "string",
"cluster_name": "string",
"default_format": "string",
"delimiter": "string",
"include_tags": False,
"name": "string",
"prefix": "string",
"project_id": "string",
"provider": "string",
"public": "string",
"read_preference": {
"max_staleness_seconds": 0,
"mode": "string",
"tag_sets": [{
"tags": [{
"name": "string",
"value": "string",
}],
}],
},
"region": "string",
"urls": ["string"],
}])
const federatedDatabaseInstanceResource = new mongodbatlas.FederatedDatabaseInstance("federatedDatabaseInstanceResource", {
projectId: "string",
cloudProviderConfig: {
aws: {
roleId: "string",
testS3Bucket: "string",
externalId: "string",
iamAssumedRoleArn: "string",
iamUserArn: "string",
},
},
dataProcessRegion: {
cloudProvider: "string",
region: "string",
},
name: "string",
storageDatabases: [{
collections: [{
dataSources: [{
allowInsecure: false,
collection: "string",
collectionRegex: "string",
database: "string",
databaseRegex: "string",
datasetName: "string",
defaultFormat: "string",
path: "string",
provenanceFieldName: "string",
storeName: "string",
urls: ["string"],
}],
name: "string",
}],
maxWildcardCollections: 0,
name: "string",
views: [{
name: "string",
pipeline: "string",
source: "string",
}],
}],
storageStores: [{
additionalStorageClasses: ["string"],
allowInsecure: false,
bucket: "string",
clusterName: "string",
defaultFormat: "string",
delimiter: "string",
includeTags: false,
name: "string",
prefix: "string",
projectId: "string",
provider: "string",
"public": "string",
readPreference: {
maxStalenessSeconds: 0,
mode: "string",
tagSets: [{
tags: [{
name: "string",
value: "string",
}],
}],
},
region: "string",
urls: ["string"],
}],
});
type: mongodbatlas:FederatedDatabaseInstance
properties:
cloudProviderConfig:
aws:
externalId: string
iamAssumedRoleArn: string
iamUserArn: string
roleId: string
testS3Bucket: string
dataProcessRegion:
cloudProvider: string
region: string
name: string
projectId: string
storageDatabases:
- collections:
- dataSources:
- allowInsecure: false
collection: string
collectionRegex: string
database: string
databaseRegex: string
datasetName: string
defaultFormat: string
path: string
provenanceFieldName: string
storeName: string
urls:
- string
name: string
maxWildcardCollections: 0
name: string
views:
- name: string
pipeline: string
source: string
storageStores:
- additionalStorageClasses:
- string
allowInsecure: false
bucket: string
clusterName: string
defaultFormat: string
delimiter: string
includeTags: false
name: string
prefix: string
projectId: string
provider: string
public: string
readPreference:
maxStalenessSeconds: 0
mode: string
tagSets:
- tags:
- name: string
value: string
region: string
urls:
- string
FederatedDatabaseInstance Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The FederatedDatabaseInstance resource accepts the following input properties:
- Project
Id string - The unique ID for the project to create a Federated Database Instance.
- Cloud
Provider FederatedConfig Database Instance Cloud Provider Config - Cloud provider linked to this data federated instance.
cloud_provider_config.aws- (Required) AWS provider of the cloud service where the Federated Database Instance can access the S3 Bucket. Note this parameter is only required if usingcloud_provider_configsince AWS is currently the only supported Cloud vendor on this feature at this time.cloud_provider_config.aws.role_id- (Required) Unique identifier of the role that the Federated Instance can use to access the data stores. If necessary, use the Atlas UI or API to retrieve the role ID. You must also specify thetest_s3_bucket.cloud_provider_config.aws.test_s3_bucket- (Required) Name of the S3 data bucket that the provided role ID is authorized to access. You must also specify therole_id.
- Data
Process FederatedRegion Database Instance Data Process Region - The cloud provider region to which the Federated Instance routes client connections for data processing.
data_process_region.cloud_provider- (Required) Name of the cloud service provider. Atlas Federated Database only supports AWS.data_process_region.region- (Required) Name of the region to which the Federanted Instnace routes client connections for data processing. See the documention for the available region.
- Name string
- Name of the Atlas Federated Database Instance.
- Storage
Databases List<FederatedDatabase Instance Storage Database> - 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 List<FederatedDatabase Instance Storage Store> - 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 separatesstorage_databases.#.collections.#.data_sources.#.pathsegments in the data store.storage_stores.#.include_tags- Determines whether or not to use S3 tags on the files in the given path as additional partition attributes.storage_stores.#.cluster_name- Human-readable label of the MongoDB Cloud cluster on which the store is based.storage_stores.#.allow_insecure- Flag that validates the scheme in the specified URLs.storage_stores.#.public- Flag that indicates whether the bucket is public.storage_stores.#.default_format- Default format that Data Lake assumes if it encounters a file without an extension while searching the storeName.storage_stores.#.urls- Comma-separated list of publicly accessible HTTP URLs where data is stored.storage_stores.#.read_preference- MongoDB Cloud cluster read preference, which describes how to route read requests to the cluster.storage_stores.#.read_preference.maxStalenessSeconds- Maximum replication lag, or staleness, for reads from secondaries.storage_stores.#.read_preference.mode- Read preference mode that specifies to which replica set member to route the read requests.storage_stores.#.read_preference.tag_sets- List that contains tag sets or tag specification documents.storage_stores.#.read_preference.tags- List of all tags within a tag setstorage_stores.#.read_preference.tags.name- Human-readable label of the tag.storage_stores.#.read_preference.tags.value- Value of the tag.
- Project
Id string - The unique ID for the project to create a Federated Database Instance.
- Cloud
Provider FederatedConfig Database Instance Cloud Provider Config Args - Cloud provider linked to this data federated instance.
cloud_provider_config.aws- (Required) AWS provider of the cloud service where the Federated Database Instance can access the S3 Bucket. Note this parameter is only required if usingcloud_provider_configsince AWS is currently the only supported Cloud vendor on this feature at this time.cloud_provider_config.aws.role_id- (Required) Unique identifier of the role that the Federated Instance can use to access the data stores. If necessary, use the Atlas UI or API to retrieve the role ID. You must also specify thetest_s3_bucket.cloud_provider_config.aws.test_s3_bucket- (Required) Name of the S3 data bucket that the provided role ID is authorized to access. You must also specify therole_id.
- Data
Process FederatedRegion Database Instance Data Process Region Args - The cloud provider region to which the Federated Instance routes client connections for data processing.
data_process_region.cloud_provider- (Required) Name of the cloud service provider. Atlas Federated Database only supports AWS.data_process_region.region- (Required) Name of the region to which the Federanted Instnace routes client connections for data processing. See the documention for the available region.
- Name string
- Name of the Atlas Federated Database Instance.
- Storage
Databases []FederatedDatabase Instance Storage Database Args - 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 []FederatedDatabase Instance Storage Store Args - 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 separatesstorage_databases.#.collections.#.data_sources.#.pathsegments in the data store.storage_stores.#.include_tags- Determines whether or not to use S3 tags on the files in the given path as additional partition attributes.storage_stores.#.cluster_name- Human-readable label of the MongoDB Cloud cluster on which the store is based.storage_stores.#.allow_insecure- Flag that validates the scheme in the specified URLs.storage_stores.#.public- Flag that indicates whether the bucket is public.storage_stores.#.default_format- Default format that Data Lake assumes if it encounters a file without an extension while searching the storeName.storage_stores.#.urls- Comma-separated list of publicly accessible HTTP URLs where data is stored.storage_stores.#.read_preference- MongoDB Cloud cluster read preference, which describes how to route read requests to the cluster.storage_stores.#.read_preference.maxStalenessSeconds- Maximum replication lag, or staleness, for reads from secondaries.storage_stores.#.read_preference.mode- Read preference mode that specifies to which replica set member to route the read requests.storage_stores.#.read_preference.tag_sets- List that contains tag sets or tag specification documents.storage_stores.#.read_preference.tags- List of all tags within a tag setstorage_stores.#.read_preference.tags.name- Human-readable label of the tag.storage_stores.#.read_preference.tags.value- Value of the tag.
- project
Id String - The unique ID for the project to create a Federated Database Instance.
- cloud
Provider FederatedConfig Database Instance Cloud Provider Config - Cloud provider linked to this data federated instance.
cloud_provider_config.aws- (Required) AWS provider of the cloud service where the Federated Database Instance can access the S3 Bucket. Note this parameter is only required if usingcloud_provider_configsince AWS is currently the only supported Cloud vendor on this feature at this time.cloud_provider_config.aws.role_id- (Required) Unique identifier of the role that the Federated Instance can use to access the data stores. If necessary, use the Atlas UI or API to retrieve the role ID. You must also specify thetest_s3_bucket.cloud_provider_config.aws.test_s3_bucket- (Required) Name of the S3 data bucket that the provided role ID is authorized to access. You must also specify therole_id.
- data
Process FederatedRegion Database Instance Data Process Region - The cloud provider region to which the Federated Instance routes client connections for data processing.
data_process_region.cloud_provider- (Required) Name of the cloud service provider. Atlas Federated Database only supports AWS.data_process_region.region- (Required) Name of the region to which the Federanted Instnace routes client connections for data processing. See the documention for the available region.
- name String
- Name of the Atlas Federated Database Instance.
- storage
Databases List<FederatedDatabase Instance Storage Database> - 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 List<FederatedDatabase Instance Storage Store> - 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 separatesstorage_databases.#.collections.#.data_sources.#.pathsegments in the data store.storage_stores.#.include_tags- Determines whether or not to use S3 tags on the files in the given path as additional partition attributes.storage_stores.#.cluster_name- Human-readable label of the MongoDB Cloud cluster on which the store is based.storage_stores.#.allow_insecure- Flag that validates the scheme in the specified URLs.storage_stores.#.public- Flag that indicates whether the bucket is public.storage_stores.#.default_format- Default format that Data Lake assumes if it encounters a file without an extension while searching the storeName.storage_stores.#.urls- Comma-separated list of publicly accessible HTTP URLs where data is stored.storage_stores.#.read_preference- MongoDB Cloud cluster read preference, which describes how to route read requests to the cluster.storage_stores.#.read_preference.maxStalenessSeconds- Maximum replication lag, or staleness, for reads from secondaries.storage_stores.#.read_preference.mode- Read preference mode that specifies to which replica set member to route the read requests.storage_stores.#.read_preference.tag_sets- List that contains tag sets or tag specification documents.storage_stores.#.read_preference.tags- List of all tags within a tag setstorage_stores.#.read_preference.tags.name- Human-readable label of the tag.storage_stores.#.read_preference.tags.value- Value of the tag.
- project
Id string - The unique ID for the project to create a Federated Database Instance.
- cloud
Provider FederatedConfig Database Instance Cloud Provider Config - Cloud provider linked to this data federated instance.
cloud_provider_config.aws- (Required) AWS provider of the cloud service where the Federated Database Instance can access the S3 Bucket. Note this parameter is only required if usingcloud_provider_configsince AWS is currently the only supported Cloud vendor on this feature at this time.cloud_provider_config.aws.role_id- (Required) Unique identifier of the role that the Federated Instance can use to access the data stores. If necessary, use the Atlas UI or API to retrieve the role ID. You must also specify thetest_s3_bucket.cloud_provider_config.aws.test_s3_bucket- (Required) Name of the S3 data bucket that the provided role ID is authorized to access. You must also specify therole_id.
- data
Process FederatedRegion Database Instance Data Process Region - The cloud provider region to which the Federated Instance routes client connections for data processing.
data_process_region.cloud_provider- (Required) Name of the cloud service provider. Atlas Federated Database only supports AWS.data_process_region.region- (Required) Name of the region to which the Federanted Instnace routes client connections for data processing. See the documention for the available region.
- name string
- Name of the Atlas Federated Database Instance.
- storage
Databases FederatedDatabase Instance Storage Database[] - 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 FederatedDatabase Instance Storage Store[] - 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 separatesstorage_databases.#.collections.#.data_sources.#.pathsegments in the data store.storage_stores.#.include_tags- Determines whether or not to use S3 tags on the files in the given path as additional partition attributes.storage_stores.#.cluster_name- Human-readable label of the MongoDB Cloud cluster on which the store is based.storage_stores.#.allow_insecure- Flag that validates the scheme in the specified URLs.storage_stores.#.public- Flag that indicates whether the bucket is public.storage_stores.#.default_format- Default format that Data Lake assumes if it encounters a file without an extension while searching the storeName.storage_stores.#.urls- Comma-separated list of publicly accessible HTTP URLs where data is stored.storage_stores.#.read_preference- MongoDB Cloud cluster read preference, which describes how to route read requests to the cluster.storage_stores.#.read_preference.maxStalenessSeconds- Maximum replication lag, or staleness, for reads from secondaries.storage_stores.#.read_preference.mode- Read preference mode that specifies to which replica set member to route the read requests.storage_stores.#.read_preference.tag_sets- List that contains tag sets or tag specification documents.storage_stores.#.read_preference.tags- List of all tags within a tag setstorage_stores.#.read_preference.tags.name- Human-readable label of the tag.storage_stores.#.read_preference.tags.value- Value of the tag.
- project_
id str - The unique ID for the project to create a Federated Database Instance.
- cloud_
provider_ Federatedconfig Database Instance Cloud Provider Config Args - Cloud provider linked to this data federated instance.
cloud_provider_config.aws- (Required) AWS provider of the cloud service where the Federated Database Instance can access the S3 Bucket. Note this parameter is only required if usingcloud_provider_configsince AWS is currently the only supported Cloud vendor on this feature at this time.cloud_provider_config.aws.role_id- (Required) Unique identifier of the role that the Federated Instance can use to access the data stores. If necessary, use the Atlas UI or API to retrieve the role ID. You must also specify thetest_s3_bucket.cloud_provider_config.aws.test_s3_bucket- (Required) Name of the S3 data bucket that the provided role ID is authorized to access. You must also specify therole_id.
- data_
process_ Federatedregion Database Instance Data Process Region Args - The cloud provider region to which the Federated Instance routes client connections for data processing.
data_process_region.cloud_provider- (Required) Name of the cloud service provider. Atlas Federated Database only supports AWS.data_process_region.region- (Required) Name of the region to which the Federanted Instnace routes client connections for data processing. See the documention for the available region.
- name str
- Name of the Atlas Federated Database Instance.
- storage_
databases Sequence[FederatedDatabase Instance Storage Database Args] - 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[FederatedDatabase Instance Storage Store Args] - 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 separatesstorage_databases.#.collections.#.data_sources.#.pathsegments in the data store.storage_stores.#.include_tags- Determines whether or not to use S3 tags on the files in the given path as additional partition attributes.storage_stores.#.cluster_name- Human-readable label of the MongoDB Cloud cluster on which the store is based.storage_stores.#.allow_insecure- Flag that validates the scheme in the specified URLs.storage_stores.#.public- Flag that indicates whether the bucket is public.storage_stores.#.default_format- Default format that Data Lake assumes if it encounters a file without an extension while searching the storeName.storage_stores.#.urls- Comma-separated list of publicly accessible HTTP URLs where data is stored.storage_stores.#.read_preference- MongoDB Cloud cluster read preference, which describes how to route read requests to the cluster.storage_stores.#.read_preference.maxStalenessSeconds- Maximum replication lag, or staleness, for reads from secondaries.storage_stores.#.read_preference.mode- Read preference mode that specifies to which replica set member to route the read requests.storage_stores.#.read_preference.tag_sets- List that contains tag sets or tag specification documents.storage_stores.#.read_preference.tags- List of all tags within a tag setstorage_stores.#.read_preference.tags.name- Human-readable label of the tag.storage_stores.#.read_preference.tags.value- Value of the tag.
- project
Id String - The unique ID for the project to create a Federated Database Instance.
- cloud
Provider Property MapConfig - Cloud provider linked to this data federated instance.
cloud_provider_config.aws- (Required) AWS provider of the cloud service where the Federated Database Instance can access the S3 Bucket. Note this parameter is only required if usingcloud_provider_configsince AWS is currently the only supported Cloud vendor on this feature at this time.cloud_provider_config.aws.role_id- (Required) Unique identifier of the role that the Federated Instance can use to access the data stores. If necessary, use the Atlas UI or API to retrieve the role ID. You must also specify thetest_s3_bucket.cloud_provider_config.aws.test_s3_bucket- (Required) Name of the S3 data bucket that the provided role ID is authorized to access. You must also specify therole_id.
- data
Process Property MapRegion - The cloud provider region to which the Federated Instance routes client connections for data processing.
data_process_region.cloud_provider- (Required) Name of the cloud service provider. Atlas Federated Database only supports AWS.data_process_region.region- (Required) Name of the region to which the Federanted Instnace routes client connections for data processing. See the documention for the available region.
- name String
- Name of the Atlas Federated Database Instance.
- storage
Databases 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.
- storage
Stores 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 separatesstorage_databases.#.collections.#.data_sources.#.pathsegments in the data store.storage_stores.#.include_tags- Determines whether or not to use S3 tags on the files in the given path as additional partition attributes.storage_stores.#.cluster_name- Human-readable label of the MongoDB Cloud cluster on which the store is based.storage_stores.#.allow_insecure- Flag that validates the scheme in the specified URLs.storage_stores.#.public- Flag that indicates whether the bucket is public.storage_stores.#.default_format- Default format that Data Lake assumes if it encounters a file without an extension while searching the storeName.storage_stores.#.urls- Comma-separated list of publicly accessible HTTP URLs where data is stored.storage_stores.#.read_preference- MongoDB Cloud cluster read preference, which describes how to route read requests to the cluster.storage_stores.#.read_preference.maxStalenessSeconds- Maximum replication lag, or staleness, for reads from secondaries.storage_stores.#.read_preference.mode- Read preference mode that specifies to which replica set member to route the read requests.storage_stores.#.read_preference.tag_sets- List that contains tag sets or tag specification documents.storage_stores.#.read_preference.tags- List of all tags within a tag setstorage_stores.#.read_preference.tags.name- Human-readable label of the tag.storage_stores.#.read_preference.tags.value- Value of the tag.
Outputs
All input properties are implicitly available as output properties. Additionally, the FederatedDatabaseInstance resource produces the following output properties:
- Hostnames List<string>
- The list of hostnames assigned to the Federated Database Instance. Each string in the array is a hostname assigned to the Federated Database Instance.
- Id string
- The provider-assigned unique ID for this managed resource.
- State string
- Current state of the Federated Database Instance:
ACTIVE- The Federated Database Instance is active and verified. You can query the data stores associated with the Federated Database Instance.DELETED- The Federated Database Instance was deleted.
- Hostnames []string
- The list of hostnames assigned to the Federated Database Instance. Each string in the array is a hostname assigned to the Federated Database Instance.
- Id string
- The provider-assigned unique ID for this managed resource.
- State string
- Current state of the Federated Database Instance:
ACTIVE- The Federated Database Instance is active and verified. You can query the data stores associated with the Federated Database Instance.DELETED- The Federated Database Instance was deleted.
- hostnames List<String>
- The list of hostnames assigned to the Federated Database Instance. Each string in the array is a hostname assigned to the Federated Database Instance.
- id String
- The provider-assigned unique ID for this managed resource.
- state String
- Current state of the Federated Database Instance:
ACTIVE- The Federated Database Instance is active and verified. You can query the data stores associated with the Federated Database Instance.DELETED- The Federated Database Instance was deleted.
- hostnames string[]
- The list of hostnames assigned to the Federated Database Instance. Each string in the array is a hostname assigned to the Federated Database Instance.
- id string
- The provider-assigned unique ID for this managed resource.
- state string
- Current state of the Federated Database Instance:
ACTIVE- The Federated Database Instance is active and verified. You can query the data stores associated with the Federated Database Instance.DELETED- The Federated Database Instance was deleted.
- hostnames Sequence[str]
- The list of hostnames assigned to the Federated Database Instance. Each string in the array is a hostname assigned to the Federated Database Instance.
- id str
- The provider-assigned unique ID for this managed resource.
- state str
- Current state of the Federated Database Instance:
ACTIVE- The Federated Database Instance is active and verified. You can query the data stores associated with the Federated Database Instance.DELETED- The Federated Database Instance was deleted.
- hostnames List<String>
- The list of hostnames assigned to the Federated Database Instance. Each string in the array is a hostname assigned to the Federated Database Instance.
- id String
- The provider-assigned unique ID for this managed resource.
- state String
- Current state of the Federated Database Instance:
ACTIVE- The Federated Database Instance is active and verified. You can query the data stores associated with the Federated Database Instance.DELETED- The Federated Database Instance was deleted.
Look up Existing FederatedDatabaseInstance Resource
Get an existing FederatedDatabaseInstance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: FederatedDatabaseInstanceState, opts?: CustomResourceOptions): FederatedDatabaseInstance@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
cloud_provider_config: Optional[FederatedDatabaseInstanceCloudProviderConfigArgs] = None,
data_process_region: Optional[FederatedDatabaseInstanceDataProcessRegionArgs] = None,
hostnames: Optional[Sequence[str]] = None,
name: Optional[str] = None,
project_id: Optional[str] = None,
state: Optional[str] = None,
storage_databases: Optional[Sequence[FederatedDatabaseInstanceStorageDatabaseArgs]] = None,
storage_stores: Optional[Sequence[FederatedDatabaseInstanceStorageStoreArgs]] = None) -> FederatedDatabaseInstancefunc GetFederatedDatabaseInstance(ctx *Context, name string, id IDInput, state *FederatedDatabaseInstanceState, opts ...ResourceOption) (*FederatedDatabaseInstance, error)public static FederatedDatabaseInstance Get(string name, Input<string> id, FederatedDatabaseInstanceState? state, CustomResourceOptions? opts = null)public static FederatedDatabaseInstance get(String name, Output<String> id, FederatedDatabaseInstanceState state, CustomResourceOptions options)Resource lookup is not supported in YAML- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Cloud
Provider FederatedConfig Database Instance Cloud Provider Config - Cloud provider linked to this data federated instance.
cloud_provider_config.aws- (Required) AWS provider of the cloud service where the Federated Database Instance can access the S3 Bucket. Note this parameter is only required if usingcloud_provider_configsince AWS is currently the only supported Cloud vendor on this feature at this time.cloud_provider_config.aws.role_id- (Required) Unique identifier of the role that the Federated Instance can use to access the data stores. If necessary, use the Atlas UI or API to retrieve the role ID. You must also specify thetest_s3_bucket.cloud_provider_config.aws.test_s3_bucket- (Required) Name of the S3 data bucket that the provided role ID is authorized to access. You must also specify therole_id.
- Data
Process FederatedRegion Database Instance Data Process Region - The cloud provider region to which the Federated Instance routes client connections for data processing.
data_process_region.cloud_provider- (Required) Name of the cloud service provider. Atlas Federated Database only supports AWS.data_process_region.region- (Required) Name of the region to which the Federanted Instnace routes client connections for data processing. See the documention for the available region.
- Hostnames List<string>
- The list of hostnames assigned to the Federated Database Instance. Each string in the array is a hostname assigned to the Federated Database Instance.
- Name string
- Name of the Atlas Federated Database Instance.
- Project
Id 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.
- Storage
Databases List<FederatedDatabase Instance Storage Database> - 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 List<FederatedDatabase Instance Storage Store> - 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 separatesstorage_databases.#.collections.#.data_sources.#.pathsegments in the data store.storage_stores.#.include_tags- Determines whether or not to use S3 tags on the files in the given path as additional partition attributes.storage_stores.#.cluster_name- Human-readable label of the MongoDB Cloud cluster on which the store is based.storage_stores.#.allow_insecure- Flag that validates the scheme in the specified URLs.storage_stores.#.public- Flag that indicates whether the bucket is public.storage_stores.#.default_format- Default format that Data Lake assumes if it encounters a file without an extension while searching the storeName.storage_stores.#.urls- Comma-separated list of publicly accessible HTTP URLs where data is stored.storage_stores.#.read_preference- MongoDB Cloud cluster read preference, which describes how to route read requests to the cluster.storage_stores.#.read_preference.maxStalenessSeconds- Maximum replication lag, or staleness, for reads from secondaries.storage_stores.#.read_preference.mode- Read preference mode that specifies to which replica set member to route the read requests.storage_stores.#.read_preference.tag_sets- List that contains tag sets or tag specification documents.storage_stores.#.read_preference.tags- List of all tags within a tag setstorage_stores.#.read_preference.tags.name- Human-readable label of the tag.storage_stores.#.read_preference.tags.value- Value of the tag.
- Cloud
Provider FederatedConfig Database Instance Cloud Provider Config Args - Cloud provider linked to this data federated instance.
cloud_provider_config.aws- (Required) AWS provider of the cloud service where the Federated Database Instance can access the S3 Bucket. Note this parameter is only required if usingcloud_provider_configsince AWS is currently the only supported Cloud vendor on this feature at this time.cloud_provider_config.aws.role_id- (Required) Unique identifier of the role that the Federated Instance can use to access the data stores. If necessary, use the Atlas UI or API to retrieve the role ID. You must also specify thetest_s3_bucket.cloud_provider_config.aws.test_s3_bucket- (Required) Name of the S3 data bucket that the provided role ID is authorized to access. You must also specify therole_id.
- Data
Process FederatedRegion Database Instance Data Process Region Args - The cloud provider region to which the Federated Instance routes client connections for data processing.
data_process_region.cloud_provider- (Required) Name of the cloud service provider. Atlas Federated Database only supports AWS.data_process_region.region- (Required) Name of the region to which the Federanted Instnace routes client connections for data processing. See the documention for the available region.
- Hostnames []string
- The list of hostnames assigned to the Federated Database Instance. Each string in the array is a hostname assigned to the Federated Database Instance.
- Name string
- Name of the Atlas Federated Database Instance.
- Project
Id 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.
- Storage
Databases []FederatedDatabase Instance Storage Database Args - 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 []FederatedDatabase Instance Storage Store Args - 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 separatesstorage_databases.#.collections.#.data_sources.#.pathsegments in the data store.storage_stores.#.include_tags- Determines whether or not to use S3 tags on the files in the given path as additional partition attributes.storage_stores.#.cluster_name- Human-readable label of the MongoDB Cloud cluster on which the store is based.storage_stores.#.allow_insecure- Flag that validates the scheme in the specified URLs.storage_stores.#.public- Flag that indicates whether the bucket is public.storage_stores.#.default_format- Default format that Data Lake assumes if it encounters a file without an extension while searching the storeName.storage_stores.#.urls- Comma-separated list of publicly accessible HTTP URLs where data is stored.storage_stores.#.read_preference- MongoDB Cloud cluster read preference, which describes how to route read requests to the cluster.storage_stores.#.read_preference.maxStalenessSeconds- Maximum replication lag, or staleness, for reads from secondaries.storage_stores.#.read_preference.mode- Read preference mode that specifies to which replica set member to route the read requests.storage_stores.#.read_preference.tag_sets- List that contains tag sets or tag specification documents.storage_stores.#.read_preference.tags- List of all tags within a tag setstorage_stores.#.read_preference.tags.name- Human-readable label of the tag.storage_stores.#.read_preference.tags.value- Value of the tag.
- cloud
Provider FederatedConfig Database Instance Cloud Provider Config - Cloud provider linked to this data federated instance.
cloud_provider_config.aws- (Required) AWS provider of the cloud service where the Federated Database Instance can access the S3 Bucket. Note this parameter is only required if usingcloud_provider_configsince AWS is currently the only supported Cloud vendor on this feature at this time.cloud_provider_config.aws.role_id- (Required) Unique identifier of the role that the Federated Instance can use to access the data stores. If necessary, use the Atlas UI or API to retrieve the role ID. You must also specify thetest_s3_bucket.cloud_provider_config.aws.test_s3_bucket- (Required) Name of the S3 data bucket that the provided role ID is authorized to access. You must also specify therole_id.
- data
Process FederatedRegion Database Instance Data Process Region - The cloud provider region to which the Federated Instance routes client connections for data processing.
data_process_region.cloud_provider- (Required) Name of the cloud service provider. Atlas Federated Database only supports AWS.data_process_region.region- (Required) Name of the region to which the Federanted Instnace routes client connections for data processing. See the documention for the available region.
- hostnames List<String>
- The list of hostnames assigned to the Federated Database Instance. Each string in the array is a hostname assigned to the Federated Database Instance.
- name String
- Name of the Atlas Federated Database Instance.
- project
Id 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.
- storage
Databases List<FederatedDatabase Instance Storage Database> - 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 List<FederatedDatabase Instance Storage Store> - 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 separatesstorage_databases.#.collections.#.data_sources.#.pathsegments in the data store.storage_stores.#.include_tags- Determines whether or not to use S3 tags on the files in the given path as additional partition attributes.storage_stores.#.cluster_name- Human-readable label of the MongoDB Cloud cluster on which the store is based.storage_stores.#.allow_insecure- Flag that validates the scheme in the specified URLs.storage_stores.#.public- Flag that indicates whether the bucket is public.storage_stores.#.default_format- Default format that Data Lake assumes if it encounters a file without an extension while searching the storeName.storage_stores.#.urls- Comma-separated list of publicly accessible HTTP URLs where data is stored.storage_stores.#.read_preference- MongoDB Cloud cluster read preference, which describes how to route read requests to the cluster.storage_stores.#.read_preference.maxStalenessSeconds- Maximum replication lag, or staleness, for reads from secondaries.storage_stores.#.read_preference.mode- Read preference mode that specifies to which replica set member to route the read requests.storage_stores.#.read_preference.tag_sets- List that contains tag sets or tag specification documents.storage_stores.#.read_preference.tags- List of all tags within a tag setstorage_stores.#.read_preference.tags.name- Human-readable label of the tag.storage_stores.#.read_preference.tags.value- Value of the tag.
- cloud
Provider FederatedConfig Database Instance Cloud Provider Config - Cloud provider linked to this data federated instance.
cloud_provider_config.aws- (Required) AWS provider of the cloud service where the Federated Database Instance can access the S3 Bucket. Note this parameter is only required if usingcloud_provider_configsince AWS is currently the only supported Cloud vendor on this feature at this time.cloud_provider_config.aws.role_id- (Required) Unique identifier of the role that the Federated Instance can use to access the data stores. If necessary, use the Atlas UI or API to retrieve the role ID. You must also specify thetest_s3_bucket.cloud_provider_config.aws.test_s3_bucket- (Required) Name of the S3 data bucket that the provided role ID is authorized to access. You must also specify therole_id.
- data
Process FederatedRegion Database Instance Data Process Region - The cloud provider region to which the Federated Instance routes client connections for data processing.
data_process_region.cloud_provider- (Required) Name of the cloud service provider. Atlas Federated Database only supports AWS.data_process_region.region- (Required) Name of the region to which the Federanted Instnace routes client connections for data processing. See the documention for the available region.
- hostnames string[]
- The list of hostnames assigned to the Federated Database Instance. Each string in the array is a hostname assigned to the Federated Database Instance.
- name string
- Name of the Atlas Federated Database Instance.
- project
Id 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.
- storage
Databases FederatedDatabase Instance Storage Database[] - 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 FederatedDatabase Instance Storage Store[] - 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 separatesstorage_databases.#.collections.#.data_sources.#.pathsegments in the data store.storage_stores.#.include_tags- Determines whether or not to use S3 tags on the files in the given path as additional partition attributes.storage_stores.#.cluster_name- Human-readable label of the MongoDB Cloud cluster on which the store is based.storage_stores.#.allow_insecure- Flag that validates the scheme in the specified URLs.storage_stores.#.public- Flag that indicates whether the bucket is public.storage_stores.#.default_format- Default format that Data Lake assumes if it encounters a file without an extension while searching the storeName.storage_stores.#.urls- Comma-separated list of publicly accessible HTTP URLs where data is stored.storage_stores.#.read_preference- MongoDB Cloud cluster read preference, which describes how to route read requests to the cluster.storage_stores.#.read_preference.maxStalenessSeconds- Maximum replication lag, or staleness, for reads from secondaries.storage_stores.#.read_preference.mode- Read preference mode that specifies to which replica set member to route the read requests.storage_stores.#.read_preference.tag_sets- List that contains tag sets or tag specification documents.storage_stores.#.read_preference.tags- List of all tags within a tag setstorage_stores.#.read_preference.tags.name- Human-readable label of the tag.storage_stores.#.read_preference.tags.value- Value of the tag.
- cloud_
provider_ Federatedconfig Database Instance Cloud Provider Config Args - Cloud provider linked to this data federated instance.
cloud_provider_config.aws- (Required) AWS provider of the cloud service where the Federated Database Instance can access the S3 Bucket. Note this parameter is only required if usingcloud_provider_configsince AWS is currently the only supported Cloud vendor on this feature at this time.cloud_provider_config.aws.role_id- (Required) Unique identifier of the role that the Federated Instance can use to access the data stores. If necessary, use the Atlas UI or API to retrieve the role ID. You must also specify thetest_s3_bucket.cloud_provider_config.aws.test_s3_bucket- (Required) Name of the S3 data bucket that the provided role ID is authorized to access. You must also specify therole_id.
- data_
process_ Federatedregion Database Instance Data Process Region Args - The cloud provider region to which the Federated Instance routes client connections for data processing.
data_process_region.cloud_provider- (Required) Name of the cloud service provider. Atlas Federated Database only supports AWS.data_process_region.region- (Required) Name of the region to which the Federanted Instnace routes client connections for data processing. See the documention for the available region.
- hostnames Sequence[str]
- The list of hostnames assigned to the Federated Database Instance. Each string in the array is a hostname assigned to the Federated Database Instance.
- name str
- Name of the Atlas Federated Database Instance.
- project_
id str - The unique ID for the project to create a Federated Database Instance.
- state str
- Current state of the Federated Database Instance:
ACTIVE- The Federated Database Instance is active and verified. You can query the data stores associated with the Federated Database Instance.DELETED- The Federated Database Instance was deleted.
- storage_
databases Sequence[FederatedDatabase Instance Storage Database Args] - 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[FederatedDatabase Instance Storage Store Args] - 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 separatesstorage_databases.#.collections.#.data_sources.#.pathsegments in the data store.storage_stores.#.include_tags- Determines whether or not to use S3 tags on the files in the given path as additional partition attributes.storage_stores.#.cluster_name- Human-readable label of the MongoDB Cloud cluster on which the store is based.storage_stores.#.allow_insecure- Flag that validates the scheme in the specified URLs.storage_stores.#.public- Flag that indicates whether the bucket is public.storage_stores.#.default_format- Default format that Data Lake assumes if it encounters a file without an extension while searching the storeName.storage_stores.#.urls- Comma-separated list of publicly accessible HTTP URLs where data is stored.storage_stores.#.read_preference- MongoDB Cloud cluster read preference, which describes how to route read requests to the cluster.storage_stores.#.read_preference.maxStalenessSeconds- Maximum replication lag, or staleness, for reads from secondaries.storage_stores.#.read_preference.mode- Read preference mode that specifies to which replica set member to route the read requests.storage_stores.#.read_preference.tag_sets- List that contains tag sets or tag specification documents.storage_stores.#.read_preference.tags- List of all tags within a tag setstorage_stores.#.read_preference.tags.name- Human-readable label of the tag.storage_stores.#.read_preference.tags.value- Value of the tag.
- cloud
Provider Property MapConfig - Cloud provider linked to this data federated instance.
cloud_provider_config.aws- (Required) AWS provider of the cloud service where the Federated Database Instance can access the S3 Bucket. Note this parameter is only required if usingcloud_provider_configsince AWS is currently the only supported Cloud vendor on this feature at this time.cloud_provider_config.aws.role_id- (Required) Unique identifier of the role that the Federated Instance can use to access the data stores. If necessary, use the Atlas UI or API to retrieve the role ID. You must also specify thetest_s3_bucket.cloud_provider_config.aws.test_s3_bucket- (Required) Name of the S3 data bucket that the provided role ID is authorized to access. You must also specify therole_id.
- data
Process Property MapRegion - The cloud provider region to which the Federated Instance routes client connections for data processing.
data_process_region.cloud_provider- (Required) Name of the cloud service provider. Atlas Federated Database only supports AWS.data_process_region.region- (Required) Name of the region to which the Federanted Instnace routes client connections for data processing. See the documention for the available region.
- hostnames List<String>
- The list of hostnames assigned to the Federated Database Instance. Each string in the array is a hostname assigned to the Federated Database Instance.
- name String
- Name of the Atlas Federated Database Instance.
- project
Id 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.
- storage
Databases 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.
- storage
Stores 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 separatesstorage_databases.#.collections.#.data_sources.#.pathsegments in the data store.storage_stores.#.include_tags- Determines whether or not to use S3 tags on the files in the given path as additional partition attributes.storage_stores.#.cluster_name- Human-readable label of the MongoDB Cloud cluster on which the store is based.storage_stores.#.allow_insecure- Flag that validates the scheme in the specified URLs.storage_stores.#.public- Flag that indicates whether the bucket is public.storage_stores.#.default_format- Default format that Data Lake assumes if it encounters a file without an extension while searching the storeName.storage_stores.#.urls- Comma-separated list of publicly accessible HTTP URLs where data is stored.storage_stores.#.read_preference- MongoDB Cloud cluster read preference, which describes how to route read requests to the cluster.storage_stores.#.read_preference.maxStalenessSeconds- Maximum replication lag, or staleness, for reads from secondaries.storage_stores.#.read_preference.mode- Read preference mode that specifies to which replica set member to route the read requests.storage_stores.#.read_preference.tag_sets- List that contains tag sets or tag specification documents.storage_stores.#.read_preference.tags- List of all tags within a tag setstorage_stores.#.read_preference.tags.name- Human-readable label of the tag.storage_stores.#.read_preference.tags.value- Value of the tag.
Supporting Types
FederatedDatabaseInstanceCloudProviderConfig, FederatedDatabaseInstanceCloudProviderConfigArgs
- Aws
Federated
Database Instance Cloud Provider Config Aws - Name of the cloud service that hosts the data lake's data stores.
- Aws
Federated
Database Instance Cloud Provider Config Aws - Name of the cloud service that hosts the data lake's data stores.
- aws
Federated
Database Instance Cloud Provider Config Aws - Name of the cloud service that hosts the data lake's data stores.
- aws
Federated
Database Instance Cloud Provider Config Aws - Name of the cloud service that hosts the data lake's data stores.
- aws
Federated
Database Instance Cloud Provider Config Aws - Name of the cloud service that hosts the data lake's data stores.
- aws Property Map
- Name of the cloud service that hosts the data lake's data stores.
FederatedDatabaseInstanceCloudProviderConfigAws, FederatedDatabaseInstanceCloudProviderConfigAwsArgs
- Role
Id string - Test
S3Bucket string - External
Id string - Unique identifier associated with the IAM Role that the Federated Database Instance assumes when accessing the data stores.
- Iam
Assumed stringRole Arn - 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:GetObjects3:ListBuckets3:GetObjectVersion
- Iam
User stringArn - Amazon Resource Name (ARN) of the user that the Federated Database Instance assumes when accessing S3 Bucket data stores.
- Role
Id string - Test
S3Bucket string - External
Id string - Unique identifier associated with the IAM Role that the Federated Database Instance assumes when accessing the data stores.
- Iam
Assumed stringRole Arn - 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:GetObjects3:ListBuckets3:GetObjectVersion
- Iam
User stringArn - Amazon Resource Name (ARN) of the user that the Federated Database Instance assumes when accessing S3 Bucket data stores.
- role
Id String - test
S3Bucket String - external
Id String - Unique identifier associated with the IAM Role that the Federated Database Instance assumes when accessing the data stores.
- iam
Assumed StringRole Arn - 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:GetObjects3:ListBuckets3:GetObjectVersion
- iam
User StringArn - Amazon Resource Name (ARN) of the user that the Federated Database Instance assumes when accessing S3 Bucket data stores.
- role
Id string - test
S3Bucket string - external
Id string - Unique identifier associated with the IAM Role that the Federated Database Instance assumes when accessing the data stores.
- iam
Assumed stringRole Arn - 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:GetObjects3:ListBuckets3:GetObjectVersion
- iam
User stringArn - Amazon Resource Name (ARN) of the user that the Federated Database Instance assumes when accessing S3 Bucket data stores.
- role_
id str - test_
s3_ strbucket - external_
id str - Unique identifier associated with the IAM Role that the Federated Database Instance assumes when accessing the data stores.
- iam_
assumed_ strrole_ arn - 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:GetObjects3:ListBuckets3:GetObjectVersion
- iam_
user_ strarn - Amazon Resource Name (ARN) of the user that the Federated Database Instance assumes when accessing S3 Bucket data stores.
- role
Id String - test
S3Bucket String - external
Id String - Unique identifier associated with the IAM Role that the Federated Database Instance assumes when accessing the data stores.
- iam
Assumed StringRole Arn - 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:GetObjects3:ListBuckets3:GetObjectVersion
- iam
User StringArn - Amazon Resource Name (ARN) of the user that the Federated Database Instance assumes when accessing S3 Bucket data stores.
FederatedDatabaseInstanceDataProcessRegion, FederatedDatabaseInstanceDataProcessRegionArgs
- Cloud
Provider string - Region string
- Cloud
Provider string - Region string
- cloud
Provider String - region String
- cloud
Provider string - region string
- cloud_
provider str - region str
- cloud
Provider String - region String
FederatedDatabaseInstanceStorageDatabase, FederatedDatabaseInstanceStorageDatabaseArgs
- Collections
List<Federated
Database Instance Storage Database Collection> - Max
Wildcard intCollections - Name string
- Name of the Atlas Federated Database Instance.
- Views
List<Federated
Database Instance Storage Database View>
- Collections
[]Federated
Database Instance Storage Database Collection - Max
Wildcard intCollections - Name string
- Name of the Atlas Federated Database Instance.
- Views
[]Federated
Database Instance Storage Database View
- collections
List<Federated
Database Instance Storage Database Collection> - max
Wildcard IntegerCollections - name String
- Name of the Atlas Federated Database Instance.
- views
List<Federated
Database Instance Storage Database View>
- collections
Federated
Database Instance Storage Database Collection[] - max
Wildcard numberCollections - name string
- Name of the Atlas Federated Database Instance.
- views
Federated
Database Instance Storage Database View[]
- collections
Sequence[Federated
Database Instance Storage Database Collection] - max_
wildcard_ intcollections - name str
- Name of the Atlas Federated Database Instance.
- views
Sequence[Federated
Database Instance Storage Database View]
- collections List<Property Map>
- max
Wildcard NumberCollections - name String
- Name of the Atlas Federated Database Instance.
- views List<Property Map>
FederatedDatabaseInstanceStorageDatabaseCollection, FederatedDatabaseInstanceStorageDatabaseCollectionArgs
- Data
Sources List<FederatedDatabase Instance Storage Database Collection Data Source> - Name string
- Name of the Atlas Federated Database Instance.
- Data
Sources []FederatedDatabase Instance Storage Database Collection Data Source - Name string
- Name of the Atlas Federated Database Instance.
- data
Sources List<FederatedDatabase Instance Storage Database Collection Data Source> - name String
- Name of the Atlas Federated Database Instance.
- data
Sources FederatedDatabase Instance Storage Database Collection Data Source[] - name string
- Name of the Atlas Federated Database Instance.
- data_
sources Sequence[FederatedDatabase Instance Storage Database Collection Data Source] - name str
- Name of the Atlas Federated Database Instance.
- data
Sources List<Property Map> - name String
- Name of the Atlas Federated Database Instance.
FederatedDatabaseInstanceStorageDatabaseCollectionDataSource, FederatedDatabaseInstanceStorageDatabaseCollectionDataSourceArgs
- Allow
Insecure bool - Collection string
- Collection
Regex string - Database string
- Database
Regex string - Dataset
Name string - Default
Format string - Path string
- Provenance
Field stringName - Store
Name string - Urls List<string>
- Allow
Insecure bool - Collection string
- Collection
Regex string - Database string
- Database
Regex string - Dataset
Name string - Default
Format string - Path string
- Provenance
Field stringName - Store
Name string - Urls []string
- allow
Insecure Boolean - collection String
- collection
Regex String - database String
- database
Regex String - dataset
Name String - default
Format String - path String
- provenance
Field StringName - store
Name String - urls List<String>
- allow
Insecure boolean - collection string
- collection
Regex string - database string
- database
Regex string - dataset
Name string - default
Format string - path string
- provenance
Field stringName - store
Name 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_ strname - store_
name str - urls Sequence[str]
- allow
Insecure Boolean - collection String
- collection
Regex String - database String
- database
Regex String - dataset
Name String - default
Format String - path String
- provenance
Field StringName - store
Name String - urls List<String>
FederatedDatabaseInstanceStorageDatabaseView, FederatedDatabaseInstanceStorageDatabaseViewArgs
FederatedDatabaseInstanceStorageStore, FederatedDatabaseInstanceStorageStoreArgs
- Additional
Storage List<string>Classes - Allow
Insecure bool - Bucket string
- Cluster
Name string - Default
Format string - Delimiter string
- bool
- Name string
- Name of the Atlas Federated Database Instance.
- Prefix string
- Project
Id string - The unique ID for the project to create a Federated Database Instance.
- Provider string
- Public string
- Read
Preference FederatedDatabase Instance Storage Store Read Preference - Region string
- Urls List<string>
- Additional
Storage []stringClasses - Allow
Insecure bool - Bucket string
- Cluster
Name string - Default
Format string - Delimiter string
- bool
- Name string
- Name of the Atlas Federated Database Instance.
- Prefix string
- Project
Id string - The unique ID for the project to create a Federated Database Instance.
- Provider string
- Public string
- Read
Preference FederatedDatabase Instance Storage Store Read Preference - Region string
- Urls []string
- additional
Storage List<String>Classes - allow
Insecure Boolean - bucket String
- cluster
Name String - default
Format String - delimiter String
- Boolean
- name String
- Name of the Atlas Federated Database Instance.
- prefix String
- project
Id String - The unique ID for the project to create a Federated Database Instance.
- provider String
- public_ String
- read
Preference FederatedDatabase Instance Storage Store Read Preference - region String
- urls List<String>
- additional
Storage string[]Classes - allow
Insecure boolean - bucket string
- cluster
Name string - default
Format string - delimiter string
- boolean
- name string
- Name of the Atlas Federated Database Instance.
- prefix string
- project
Id string - The unique ID for the project to create a Federated Database Instance.
- provider string
- public string
- read
Preference FederatedDatabase Instance Storage Store Read Preference - region string
- urls string[]
- additional_
storage_ Sequence[str]classes - allow_
insecure bool - bucket str
- cluster_
name str - default_
format str - delimiter str
- bool
- name str
- Name of the Atlas Federated Database Instance.
- prefix str
- project_
id str - The unique ID for the project to create a Federated Database Instance.
- provider str
- public str
- read_
preference FederatedDatabase Instance Storage Store Read Preference - region str
- urls Sequence[str]
- additional
Storage List<String>Classes - allow
Insecure Boolean - bucket String
- cluster
Name String - default
Format String - delimiter String
- Boolean
- name String
- Name of the Atlas Federated Database Instance.
- prefix String
- project
Id String - The unique ID for the project to create a Federated Database Instance.
- provider String
- public String
- read
Preference Property Map - region String
- urls List<String>
FederatedDatabaseInstanceStorageStoreReadPreference, FederatedDatabaseInstanceStorageStoreReadPreferenceArgs
- max
Staleness NumberSeconds - mode String
- List<Property Map>
FederatedDatabaseInstanceStorageStoreReadPreferenceTagSet, FederatedDatabaseInstanceStorageStoreReadPreferenceTagSetArgs
FederatedDatabaseInstanceStorageStoreReadPreferenceTagSetTag, FederatedDatabaseInstanceStorageStoreReadPreferenceTagSetTagArgs
Import
- The Federated Database Instance can be imported using project ID, name of the instance, in the format
project_id–name, e.g.
$ pulumi import mongodbatlas:index/federatedDatabaseInstance:FederatedDatabaseInstance mongodbatlas_federated_database_instance.example 1112222b3bf99403840e8934--test
- The Federated Database Instance can be imported using project ID, name of the instance and name of the AWS S3 bucket, in the format
project_id–name–aws_test_s3_bucket, e.g.
$ pulumi import mongodbatlas:index/federatedDatabaseInstance:FederatedDatabaseInstance mongodbatlas_federated_database_instance.example 1112222b3bf99403840e8934--test--s3-test
See MongoDB Atlas API Documentation for more information.
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- MongoDB Atlas pulumi/pulumi-mongodbatlas
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
mongodbatlasTerraform Provider.