Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--mongodb-atlas-datalakes.json
Parent schema serverless-framework-configuration
Type: object

Returns, adds, edits, and removes Federated Database Instances.. Source:- https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git

Properties

CloudProviderConfig object
1 nested properties
Aws object
5 nested properties
ExternalId string | Aws_CF_FunctionString

Unique identifier associated with the Identity and Access Management (IAM) role that the data lake assumes when accessing the data stores.

IamAssumedRoleARN string | Aws_CF_FunctionString

Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the data lake assumes when accessing data stores.

IamUserARN string | Aws_CF_FunctionString

Amazon Resource Name (ARN) of the user that the data lake assumes when accessing data stores.

RoleId string | Aws_CF_FunctionString

Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig.

TestS3Bucket string | Aws_CF_FunctionString

Name of the S3 data bucket that the provided role ID is authorized to access.Required if specifying cloudProviderConfig.

DataProcessRegion object
2 nested properties
CloudProvider string | Aws_CF_FunctionString

Name of the cloud service that hosts the data lake's data stores.

Region string | Aws_CF_FunctionString

Name of the region to which the data lake routes client connections.

EndDate number

Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.

ProjectId string | Aws_CF_FunctionString

Unique 24-hexadecimal digit string that identifies your project.

Profile string | Aws_CF_FunctionString

The profile is defined in AWS Secret manager. See Secret Manager Profile setup.

SkipRoleValidation boolean

Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check.

TenantName string | Aws_CF_FunctionString

Human-readable label that identifies the Federated Database to remove.

Definitions

DataLakeAWSCloudProviderConfigView object
ExternalId string | Aws_CF_FunctionString

Unique identifier associated with the Identity and Access Management (IAM) role that the data lake assumes when accessing the data stores.

IamAssumedRoleARN string | Aws_CF_FunctionString

Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the data lake assumes when accessing data stores.

IamUserARN string | Aws_CF_FunctionString

Amazon Resource Name (ARN) of the user that the data lake assumes when accessing data stores.

RoleId string | Aws_CF_FunctionString

Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig.

TestS3Bucket string | Aws_CF_FunctionString

Name of the S3 data bucket that the provided role ID is authorized to access.Required if specifying cloudProviderConfig.

DataLakeCloudProviderConfigView object
Aws object
5 nested properties
ExternalId string | Aws_CF_FunctionString

Unique identifier associated with the Identity and Access Management (IAM) role that the data lake assumes when accessing the data stores.

IamAssumedRoleARN string | Aws_CF_FunctionString

Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the data lake assumes when accessing data stores.

IamUserARN string | Aws_CF_FunctionString

Amazon Resource Name (ARN) of the user that the data lake assumes when accessing data stores.

RoleId string | Aws_CF_FunctionString

Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig.

TestS3Bucket string | Aws_CF_FunctionString

Name of the S3 data bucket that the provided role ID is authorized to access.Required if specifying cloudProviderConfig.

DataLakeDataProcessRegionView object
CloudProvider string | Aws_CF_FunctionString

Name of the cloud service that hosts the data lake's data stores.

Region string | Aws_CF_FunctionString

Name of the region to which the data lake routes client connections.

DataLakeDatabaseCollectionView object
DataSources object[]

Array that contains the data stores that map to a collection for this data lake.

Name string | Aws_CF_FunctionString

Human-readable label that identifies the collection to which MongoDB Cloud maps the data in the data stores.

DataLakeDatabaseDataSourceView object
AllowInsecure boolean

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.

Collection string | Aws_CF_FunctionString

Human-readable label that identifies the collection in the database. For creating a wildcard (*) collection, you must omit this parameter.

CollectionRegex string | Aws_CF_FunctionString

Regex pattern to use for creating the wildcard (*) collection. To learn more about the regex syntax, see Go programming language.

Database string | Aws_CF_FunctionString

Human-readable label that identifies the database, which contains the collection in the cluster. You must omit this parameter to generate wildcard (*) collections for dynamically generated databases.

DefaultFormat string | Aws_CF_FunctionString

File format that MongoDB Cloud uses if it encounters a file without a file extension while searching storeName.

Path string | Aws_CF_FunctionString

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.

StoreName string | Aws_CF_FunctionString

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

Urls string[]

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

DataLakeDatabaseView object
Collections object[]

Array of collections and data sources that map to a stores data store.

MaxWildcardCollections integer

Maximum number of wildcard collections in the database. This only applies to S3 data sources.

Name string | Aws_CF_FunctionString

Human-readable label that identifies the database to which the data lake maps data.

Views object[]

Array of aggregation pipelines that apply to the collection. This only applies to S3 data sources.

DataLakeStorageView object
Databases object[]

Array that contains the queryable databases and collections for this data lake.

Stores object[]

Array that contains the data stores for the data lake.

StoreDetail object

Configuration information for each data store and its mapping to MongoDB Cloud databases.

Name string | Aws_CF_FunctionString

Human-readable label that identifies the data store.

Provider string | Aws_CF_FunctionString

Human-readable label that identifies the Federated Database to update.

Region string | Aws_CF_FunctionString

Human-readable label that identifies the Federated Database to update.

Bucket string | Aws_CF_FunctionString

Human-readable label that identifies the Federated Database to update.

Prefix string | Aws_CF_FunctionString

Human-readable label that identifies the Federated Database to update.

Delimiter string | Aws_CF_FunctionString

Human-readable label that identifies the Federated Database to update.

IncludeTags boolean

Human-readable label that identifies the Federated Database to update.

AdditionalStorageClasses string[]

Human-readable label that identifies the Federated Database to update.

DataLakeViewView object
Name string | Aws_CF_FunctionString

Human-readable label that identifies the view, which corresponds to an aggregation pipeline on a collection.

Pipeline string | Aws_CF_FunctionString

Aggregation pipeline stages to apply to the source collection.

Source string | Aws_CF_FunctionString

Human-readable label that identifies the source collection for the view.

NDSDataLakeAWSCloudProviderConfigView object
RoleId string | Aws_CF_FunctionString

Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig.

TestS3Bucket string | Aws_CF_FunctionString

Name of the S3 data bucket that the provided role ID is authorized to access.Required if specifying cloudProviderConfig.

NDSDataLakeCloudProviderConfigView object
Aws object
2 nested properties
RoleId string | Aws_CF_FunctionString

Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig.

TestS3Bucket string | Aws_CF_FunctionString

Name of the S3 data bucket that the provided role ID is authorized to access.Required if specifying cloudProviderConfig.

NDSDataLakeDataProcessRegionView object
CloudProvider string | Aws_CF_FunctionString

Name of the cloud service that hosts the data lake's data stores.

Region string | Aws_CF_FunctionString

Name of the region to which the data lake routes connections for data processing.

NDSDataLakeDatabaseCollectionView object
DataSources object[]

Array that contains the data stores that map to a collection for this data lake.

Name string | Aws_CF_FunctionString

Human-readable label that identifies the collection to which MongoDB Cloud maps the data in the data stores.

NDSDataLakeDatabaseDataSourceView object
AllowInsecure boolean

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.

Collection string | Aws_CF_FunctionString

Human-readable label that identifies the collection in the database. For creating a wildcard (*) collection, you must omit this parameter.

CollectionRegex string | Aws_CF_FunctionString

Regex pattern to use for creating the wildcard (*) collection. To learn more about the regex syntax, see Go programming language.

Database string | Aws_CF_FunctionString

Human-readable label that identifies the database, which contains the collection in the cluster. You must omit this parameter to generate wildcard (*) collections for dynamically generated databases.

DefaultFormat string | Aws_CF_FunctionString

File format that MongoDB Cloud uses if it encounters a file without a file extension while searching storeName.

Path string | Aws_CF_FunctionString

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.

StoreName string | Aws_CF_FunctionString

Human-readable label that identifies the data store to map to the collection. Must match the name of an object in the stores array.

Urls string[]

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

NDSDataLakeDatabaseView object
Collections object[]

Array of collections and data sources that map to a stores data store.

MaxWildcardCollections integer

Maximum number of wildcard collections in the database.

Name string | Aws_CF_FunctionString

Human-readable label that identifies the database to which the data lake maps data.

Views object[]

Array of aggregation pipelines that apply to the collection.

NDSDataLakeStorageView object
Databases object[]

Array that contains the queryable databases and collections for this data lake.

Stores object[]

Array that contains the data stores for the data lake.

NDSDataLakeViewView object
Name string | Aws_CF_FunctionString

Human-readable label that identifies the view, which corresponds to an aggregation pipeline on a collection.

Pipeline string | Aws_CF_FunctionString

Aggregation pipeline stages to apply to the source collection.

Source string | Aws_CF_FunctionString

Human-readable label that identifies the source collection for the view.

Provider object
Name string | Aws_CF_FunctionString

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 data lake requires a serverless instance or an M10 or higher cluster.

Provider string | Aws_CF_FunctionString