Skip to content

store.md

Latest commit

 

History

History
80 lines (47 loc) · 2.71 KB

store.md

File metadata and controls

80 lines (47 loc) · 2.71 KB

MongoDB::Atlas::FederatedDatabaseInstance Store

Array that contains the data stores for the Atlas Data Federation.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
    "Name" : String,
    "Provider" : String,
    "ClusterName" : String,
    "ProjectId" : String,
    "ReadPreference" : ReadPreference
}

YAML

Name: String
Provider: String
ClusterName: String
ProjectId: String
ReadPreference: ReadPreference

Properties

Name

Human-readable label that identifies the data store. The databases.[n].collections.[n].dataSources.[n].storeName field references this values as part of the mapping configuration. To use MongoDB Cloud as a data store, the Atlas Data Federation requires a serverless instance or an M10 or higher cluster.

Required: No

Type: String

Update requires: No interruption

Provider

Allowed values atlas, http, online_archive, s3 and DataLakeAzureBlobStore.

Required: No

Type: String

Update requires: No interruption

ClusterName

Human-readable label of the MongoDB Cloud cluster on which the store is based.

Required: No

Type: String

Update requires: No interruption

ProjectId

Unique 24-hexadecimal digit string that identifies the project.Regex ^([a-f0-9]{24})$ .

Required: No

Type: String

Update requires: No interruption

ReadPreference

Required: No

Type: ReadPreference

Update requires: No interruption