Skip to content

datasource.md

Latest commit

 

History

History
137 lines (81 loc) · 5.64 KB

datasource.md

File metadata and controls

137 lines (81 loc) · 5.64 KB

MongoDB::Atlas::FederatedDatabaseInstance DataSource

Syntax

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

JSON

{
    "AllowInsecure" : Boolean,
    "Collection" : Collection,
    "CollectionRegex" : String,
    "Database" : Database,
    "DatabaseRegex" : String,
    "DefaultFormat" : String,
    "Path" : String,
    "ProvenanceFieldName" : String,
    "StoreName" : String,
    "Urls" : [ String, ... ]
}

YAML

AllowInsecure: Boolean
Collection: Collection
CollectionRegex: String
Database: Database
DatabaseRegex: String
DefaultFormat: String
Path: String
ProvenanceFieldName: String
StoreName: String
Urls: 
      - String

Properties

AllowInsecure

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.

Required: No

Type: Boolean

Update requires: No interruption

Collection

Required: No

Type: Collection

Update requires: No interruption

CollectionRegex

Regex pattern to use for creating the wildcard (*) collection. To learn more about the regex syntax, see Go programming language.( https://pkg.go.dev/regexp ).

Required: No

Type: String

Update requires: No interruption

Database

Required: No

Type: Database

Update requires: No interruption

DatabaseRegex

Regex pattern to use for creating the wildcard (*) collection. To learn more about the regex syntax, see Go programming language.( https://pkg.go.dev/regexp ).

Required: No

Type: String

Update requires: No interruption

DefaultFormat

File format that MongoDB Cloud uses if it encounters a file without a file extension while searching storeName.Enum: ".avro" ".avro.bz2" ".avro.gz" ".bson" ".bson.bz2" ".bson.gz" ".bsonx" ".csv" ".csv.bz2" ".csv.gz" ".json" ".json.bz2" ".json.gz" ".orc" ".parquet" ".tsv" ".tsv.bz2" ".tsv.gz"

Required: No

Type: String

Update requires: No interruption

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.

Required: No

Type: String

Update requires: No interruption

ProvenanceFieldName

Name for the field that includes the provenance of the documents in the results. MongoDB Cloud returns different fields in the results for each supported provider.

Required: No

Type: String

Update requires: No interruption

StoreName

Human-readable label that identifies the data store that MongoDB Cloud maps to the collection.

Required: No

Type: String

Update requires: No interruption

Urls

URLs of the publicly accessible data files. You can't specify URLs that require authentication. Atlas Data Federation creates a partition for each URL. If empty or omitted, Data Federation uses the URLs from the store specified in the dataSources.storeName parameter.

Required: No

Type: List of String

Update requires: No interruption