{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/mongodb/main/json-schema/mongodb-data-lake-tenant-schema.json", "title": "DataLakeTenant", "x-generated": "2026-10-03", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/mongodb-data-federation-api-openapi.yml#/components/schemas/DataLakeTenant", "properties": { "cloudProviderConfig": { "$ref": "#/$defs/DataLakeCloudProviderConfig" }, "dataProcessRegion": { "$ref": "#/$defs/DataLakeDataProcessRegion" }, "groupId": { "description": "Unique 24-hexadecimal character string that identifies the project.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "hostnames": { "description": "List that contains the hostnames assigned to the Federated Database Instance.", "items": { "description": "Unique hostname assigned to the Federated Database Instance.", "readOnly": true, "type": "string" }, "readOnly": true, "type": "array" }, "name": { "description": "Human-readable label that identifies the Federated Database Instance.", "type": "string" }, "privateEndpointHostnames": { "description": "List that contains the sets of private endpoints and hostnames.", "items": { "$ref": "#/$defs/PrivateEndpointHostname" }, "readOnly": true, "type": "array" }, "state": { "description": "Label that indicates the status of the Federated Database Instance.", "enum": [ "UNVERIFIED", "ACTIVE", "DELETED" ], "readOnly": true, "type": "string" }, "storage": { "$ref": "#/$defs/DataLakeStorage" } }, "type": "object", "$defs": { "ApiAtlasDataLakeAWSRegionView": { "description": "Atlas Data Federation AWS Regions.", "enum": [ "SYDNEY_AUS", "MUMBAI_IND", "FRANKFURT_DEU", "DUBLIN_IRL", "LONDON_GBR", "VIRGINIA_USA", "OREGON_USA", "SAOPAULO_BRA", "MONTREAL_CAN", "TOKYO_JPN", "SEOUL_KOR", "SINGAPORE_SGP" ], "type": "string" }, "AtlasDataFederationAzureRegion": { "description": "Atlas Data Federation Azure Regions.", "enum": [ "VIRGINIA_USA", "AMSTERDAM_NLD", "SAOPAULO_BRA" ], "type": "string" }, "AtlasDataFederationGCPRegion": { "description": "Atlas Data Federation GCP Regions.", "enum": [ "IOWA_USA", "BELGIUM_EU" ], "type": "string" }, "BaseAtlasDataLakeRegion": { "description": "Name of the region to which the data lake routes client connections.", "oneOf": [ { "$ref": "#/$defs/ApiAtlasDataLakeAWSRegionView" }, { "$ref": "#/$defs/AtlasDataFederationAzureRegion" }, { "$ref": "#/$defs/AtlasDataFederationGCPRegion" } ], "type": "object" }, "DataFederationAzureCloudProviderConfig": { "description": "Configuration for running Data Federation in Azure.", "properties": { "atlasAppId": { "description": "The App ID generated by Atlas for the Service Principal's access policy.", "readOnly": true, "type": "string" }, "roleId": { "description": "Unique identifier of the role that Data Federation can use to access the data stores. Required if specifying `cloudProviderConfig`.", "pattern": "^([a-f0-9]{24})$", "type": "string" }, "servicePrincipalId": { "description": "The ID of the Service Principal for which there is an access policy for Atlas to access Azure resources.", "readOnly": true, "type": "string" }, "tenantId": { "description": "The Azure Active Directory / Entra ID tenant ID associated with the Service Principal.", "readOnly": true, "type": "string" } }, "required": [ "roleId" ], "type": "object" }, "DataFederationGCPCloudProviderConfig": { "description": "Configuration for running Data Federation in GCP.", "properties": { "gcpServiceAccount": { "description": "The email address of the Google Cloud Platform (GCP) service account created by Atlas which should be authorized to allow Atlas to access Google Cloud Storage.", "readOnly": true, "type": "string" }, "roleId": { "description": "Unique identifier of the role that Data Federation can use to access the data stores. Required if specifying `cloudProviderConfig`.", "pattern": "^([a-f0-9]{24})$", "type": "string" } }, "required": [ "roleId" ], "type": "object" }, "DataLakeAWSCloudProviderConfig": { "description": "Configuration for running Data Federation in AWS.", "properties": { "externalId": { "description": "Unique identifier associated with the Identity and Access Management (IAM) role that the data lake assumes when accessing the data stores.", "readOnly": true, "type": "string" }, "iamAssumedRoleARN": { "description": "Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the data lake assumes when accessing data stores.", "maxLength": 2048, "minLength": 20, "readOnly": true, "type": "string" }, "iamUserARN": { "description": "Amazon Resource Name (ARN) of the user that the data lake assumes when accessing data stores.", "readOnly": true, "type": "string" }, "roleId": { "description": "Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig.", "pattern": "^([a-f0-9]{24})$", "type": "string" }, "testS3Bucket": { "description": "Name of the S3 data bucket that the provided role ID is authorized to access. Required if specifying `cloudProviderConfig`.", "type": "string", "writeOnly": true } }, "required": [ "roleId", "testS3Bucket" ], "type": "object" }, "DataLakeApiBase": { "description": "An aggregation pipeline that applies to the collection.", "properties": { "name": { "description": "Human-readable label that identifies the view, which corresponds to an aggregation pipeline on a collection.", "type": "string" }, "pipeline": { "description": "Aggregation pipeline stages to apply to the source collection.", "type": "string" }, "source": { "description": "Human-readable label that identifies the source collection for the view.", "type": "string" } }, "type": "object" }, "DataLakeAtlasStoreInstance": { "allOf": [ { "$ref": "#/$defs/DataLakeStoreSettings" }, { "properties": { "clusterName": { "description": "Human-readable label of the MongoDB Cloud cluster on which the store is based.", "type": "string" }, "projectId": { "description": "Unique 24-hexadecimal digit string that identifies the project.", "maxLength": 24, "minLength": 24, "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "readConcern": { "$ref": "#/$defs/DataLakeAtlasStoreReadConcern" }, "readPreference": { "$ref": "#/$defs/DataLakeAtlasStoreReadPreference" } }, "type": "object" } ], "type": "object" }, "DataLakeAtlasStoreReadConcern": { "description": "MongoDB Cloud cluster read concern, which determines the consistency and isolation properties of the data read from an Atlas cluster.", "properties": { "level": { "description": "Read Concern level that specifies the consistency and availability of the data read.", "enum": [ "LOCAL", "MAJORITY", "LINEARIZABLE", "SNAPSHOT", "AVAILABLE" ], "type": "string" } }, "type": "object" }, "DataLakeAtlasStoreReadPreference": { "description": "MongoDB Cloud cluster read preference, which describes how to route read requests to the cluster.", "properties": { "maxStalenessSeconds": { "description": "Maximum replication lag, or **staleness**, for reads from secondaries.", "format": "int32", "type": "integer" }, "mode": { "description": "Read preference mode that specifies to which replica set member to route the read requests.", "enum": [ "primary", "primaryPreferred", "secondary", "secondaryPreferred", "nearest" ], "type": "string" }, "tagSets": { "description": "List that contains tag sets or tag specification documents. If specified, Atlas Data Lake routes read requests to replica set member or members that are associated with the specified tags.", "items": { "items": { "$ref": "#/$defs/DataLakeAtlasStoreReadPreferenceTag" }, "type": "array" }, "type": "array" } }, "type": "object" }, "DataLakeAtlasStoreReadPreferenceTag": { "properties": { "name": { "description": "Human-readable label of the tag.", "type": "string" }, "value": { "description": "Value of the tag.", "type": "string" } }, "type": "object" }, "DataLakeAzureBlobStore": { "allOf": [ { "$ref": "#/$defs/DataLakeStoreSettings" }, { "properties": { "containerName": { "description": "Human-readable label that identifies the name of the container.", "type": "string" }, "delimiter": { "description": "Delimiter.", "type": "string" }, "prefix": { "description": "Prefix.", "type": "string" }, "public": { "default": false, "description": "Flag that indicates whether the blob store is public. If set to `true`, MongoDB Cloud doesn't use the configured Azure service principal to access the blob store. If set to `false`, the configured Azure service principal must include permissions to access the blob store.", "type": "boolean" }, "region": { "description": "Microsoft Azure Regions.", "enum": [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], "title": "Azure Regions", "type": "string" }, "replacementDelimiter": { "description": "Replacement Delimiter.", "type": "string" }, "serviceURL": { "description": "Service URL.", "type": "string" } }, "type": "object" } ], "type": "object" }, "DataLakeCloudProviderConfig": { "description": "Cloud provider where this Federated Database Instance is hosted.", "properties": { "aws": { "$ref": "#/$defs/DataLakeAWSCloudProviderConfig" }, "azure": { "$ref": "#/$defs/DataFederationAzureCloudProviderConfig" }, "gcp": { "$ref": "#/$defs/DataFederationGCPCloudProviderConfig" } }, "title": "Data Federation Cloud Provider", "type": "object" }, "DataLakeDLSAWSStore": { "allOf": [ { "$ref": "#/$defs/DataLakeStoreSettings" }, { "properties": { "region": { "description": "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", "enum": [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], "title": "AWS Regions", "type": "string" } }, "type": "object" } ], "type": "object" }, "DataLakeDLSAzureStore": { "allOf": [ { "$ref": "#/$defs/DataLakeStoreSettings" }, { "properties": { "region": { "description": "Microsoft Azure Regions.", "enum": [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], "title": "Azure Regions", "type": "string" } }, "type": "object" } ], "type": "object" }, "DataLakeDLSGCPStore": { "allOf": [ { "$ref": "#/$defs/DataLakeStoreSettings" }, { "properties": { "region": { "description": "Google Cloud Platform Regions.", "enum": [ "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "CENTRAL_US", "EASTERN_ASIA_PACIFIC", "EASTERN_US", "EUROPE_CENTRAL_2", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_10", "EUROPE_WEST_12", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "NORTHEASTERN_ASIA_PACIFIC", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "SOUTHEASTERN_ASIA_PACIFIC", "US_EAST_4", "US_EAST_5", "US_WEST_2", "US_WEST_3", "US_WEST_4", "US_SOUTH_1", "WESTERN_EUROPE", "WESTERN_US" ], "title": "GCP Regions", "type": "string" } }, "type": "object" } ], "type": "object" }, "DataLakeDataProcessRegion": { "description": "Information about the cloud provider region to which the Federated Database Instance routes client connections.", "properties": { "cloudProvider": { "description": "Name of the cloud service that hosts the Federated Database Instance's infrastructure.", "enum": [ "AWS", "AZURE", "GCP" ], "type": "string" }, "region": { "$ref": "#/$defs/BaseAtlasDataLakeRegion" } }, "required": [ "cloudProvider", "region" ], "type": "object" }, "DataLakeDatabaseCollection": { "description": "A collection and data sources that map to a ``stores`` data store.", "properties": { "dataSources": { "description": "Array that contains the data stores that map to a collection for this data lake.", "items": { "$ref": "#/$defs/DataLakeDatabaseDataSourceSettings" }, "type": "array" }, "name": { "description": "Human-readable label that identifies the collection to which MongoDB Cloud maps the data in the data stores.", "type": "string" } }, "type": "object" }, "DataLakeDatabaseDataSourceSettings": { "description": "Data store that maps to a collection for this data lake.", "properties": { "allowInsecure": { "default": false, "description": "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.", "type": "boolean" }, "collection": { "description": "Human-readable label that identifies the collection in the database. For creating a wildcard (`*`) collection, you must omit this parameter.", "type": "string" }, "collectionRegex": { "description": "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).", "type": "string" }, "database": { "description": "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.", "type": "string" }, "databaseRegex": { "description": "Regex pattern to use for creating the wildcard (*) database. To learn more about the regex syntax, see [Go programming language](https://pkg.go.dev/regexp).", "type": "string" }, "datasetName": { "description": "Human-readable label that identifies the dataset that Atlas generates for an ingestion pipeline run or Online Archive.", "type": "string" }, "datasetPrefix": { "description": "Human-readable label that matches against the dataset names for ingestion pipeline runs or Online Archives.", "type": "string" }, "defaultFormat": { "description": "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" ], "type": "string" }, "path": { "description": "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.", "type": "string" }, "provenanceFieldName": { "description": "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.", "type": "string" }, "storeName": { "description": "Human-readable label that identifies the data store that MongoDB Cloud maps to the collection.", "type": "string" }, "trimLevel": { "description": "Unsigned integer that specifies how many fields of the dataset name to trim from the left of the dataset name before mapping the remaining fields to a wildcard collection name.", "format": "int32", "type": "integer" }, "urls": { "description": "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.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "DataLakeDatabaseInstance": { "description": "Database associated with this data lake. Databases contain collections and views.", "properties": { "collections": { "description": "Array of collections and data sources that map to a ``stores`` data store.", "items": { "$ref": "#/$defs/DataLakeDatabaseCollection" }, "type": "array" }, "maxWildcardCollections": { "default": 100, "description": "Maximum number of wildcard collections in the database. This only applies to S3 data sources.", "format": "int32", "maximum": 1000, "minimum": 1, "type": "integer" }, "name": { "description": "Human-readable label that identifies the database to which the data lake maps data.", "type": "string" }, "views": { "description": "Array of aggregation pipelines that apply to the collection. This only applies to S3 data sources.", "items": { "$ref": "#/$defs/DataLakeApiBase" }, "type": "array" } }, "type": "object" }, "DataLakeGoogleCloudStorageStore": { "allOf": [ { "$ref": "#/$defs/DataLakeStoreSettings" }, { "properties": { "bucket": { "description": "Human-readable label that identifies the Google Cloud Storage bucket.", "type": "string" }, "delimiter": { "description": "Delimiter.", "type": "string" }, "prefix": { "description": "Prefix.", "type": "string" }, "public": { "default": false, "description": "Flag that indicates whether the bucket is public. If set to `true`, MongoDB Cloud doesn't use the configured GCP service account to access the bucket. If set to `false`, the configured GCP service acccount must include permissions to access the bucket.", "type": "boolean" }, "region": { "description": "Google Cloud Platform Regions.", "enum": [ "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "CENTRAL_US", "EASTERN_ASIA_PACIFIC", "EASTERN_US", "EUROPE_CENTRAL_2", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_10", "EUROPE_WEST_12", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "NORTHEASTERN_ASIA_PACIFIC", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "SOUTHEASTERN_ASIA_PACIFIC", "US_EAST_4", "US_EAST_5", "US_WEST_2", "US_WEST_3", "US_WEST_4", "US_SOUTH_1", "WESTERN_EUROPE", "WESTERN_US" ], "title": "GCP Regions", "type": "string" }, "replacementDelimiter": { "description": "Replacement Delimiter.", "type": "string" } }, "type": "object" } ], "type": "object" }, "DataLakeHTTPStore": { "allOf": [ { "$ref": "#/$defs/DataLakeStoreSettings" }, { "properties": { "allowInsecure": { "default": false, "description": "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.", "type": "boolean" }, "defaultFormat": { "description": "Default format that Data Lake assumes if it encounters a file without an extension while searching the `storeName`. If omitted, Data Lake attempts to detect the file type by processing a few bytes of the file. The specified format only applies to the URLs specified in the **databases.[n].collections.[n].dataSources** object.", "type": "string" }, "urls": { "description": "Comma-separated list of publicly accessible HTTP URLs where data is stored. You can't specify URLs that require authentication.", "items": { "description": "Comma-separated list of publicly accessible HTTP URLs where data is stored. You can't specify URLs that require authentication.", "type": "string" }, "type": "array" } }, "type": "object" } ], "type": "object" }, "DataLakeS3StoreSettings": { "allOf": [ { "$ref": "#/$defs/DataLakeStoreSettings" }, { "properties": { "additionalStorageClasses": { "description": "Collection of AWS S3 [storage classes](https://aws.amazon.com/s3/storage-classes/). Atlas Data Lake includes the files in these storage classes in the query results.", "items": { "description": "AWS S3 [storage class](https://aws.amazon.com/s3/storage-classes/) where the files to include in the results are stored.", "enum": [ "STANDARD", "INTELLIGENT_TIERING", "STANDARD_IA" ], "type": "string" }, "type": "array" }, "bucket": { "description": "Human-readable label that identifies the AWS S3 bucket. This label must exactly match the name of an S3 bucket that the data lake can access with the configured AWS Identity and Access Management (IAM) credentials.", "type": "string" }, "delimiter": { "description": "The delimiter that separates **databases.[n].collections.[n].dataSources.[n].path** segments in the data store. MongoDB Cloud uses the delimiter to efficiently traverse S3 buckets with a hierarchical directory structure. You can specify any character supported by the S3 object keys as the delimiter. For example, you can specify an underscore (_) or a plus sign (+) or multiple characters, such as double underscores (__) as the delimiter. If omitted, defaults to `/`.", "type": "string" }, "includeTags": { "default": false, "description": "Flag that indicates whether to use S3 tags on the files in the given path as additional partition attributes. If set to `true`, data lake adds the S3 tags as additional partition attributes and adds new top-level BSON elements associating each tag to each document.", "type": "boolean" }, "prefix": { "description": "Prefix that MongoDB Cloud applies when searching for files in the S3 bucket. The data store prepends the value of prefix to the **databases.[n].collections.[n].dataSources.[n].path** to create the full path for files to ingest. If omitted, MongoDB Cloud searches all files from the root of the S3 bucket.", "type": "string" }, "public": { "default": false, "description": "Flag that indicates whether the bucket is public. If set to `true`, MongoDB Cloud doesn't use the configured AWS Identity and Access Management (IAM) role to access the S3 bucket. If set to `false`, the configured AWS IAM role must include permissions to access the S3 bucket.", "type": "boolean" }, "region": { "description": "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", "enum": [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], "title": "AWS Regions", "type": "string" } }, "type": "object" } ], "type": "object" }, "DataLakeStorage": { "description": "Configuration information for each data store and its mapping to MongoDB Cloud databases.", "properties": { "databases": { "description": "Array that contains the queryable databases and collections for this data lake.", "items": { "$ref": "#/$defs/DataLakeDatabaseInstance" }, "type": "array" }, "stores": { "description": "Array that contains the data stores for the data lake.", "items": { "$ref": "#/$defs/DataLakeStoreSettings" }, "type": "array" } }, "type": "object" }, "DataLakeStoreSettings": { "description": "Group of settings that define where the data is stored.", "oneOf": [ { "$ref": "#/$defs/DataLakeS3StoreSettings" }, { "$ref": "#/$defs/DataLakeDLSAWSStore" }, { "$ref": "#/$defs/DataLakeDLSAzureStore" }, { "$ref": "#/$defs/DataLakeDLSGCPStore" }, { "$ref": "#/$defs/DataLakeAtlasStoreInstance" }, { "$ref": "#/$defs/DataLakeHTTPStore" }, { "$ref": "#/$defs/DataLakeAzureBlobStore" }, { "$ref": "#/$defs/DataLakeGoogleCloudStorageStore" } ], "properties": { "name": { "description": "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.", "type": "string" }, "provider": { "type": "string" } }, "required": [ "provider" ], "type": "object" }, "PrivateEndpointHostname": { "description": "Set of Private endpoint and hostnames.", "properties": { "hostname": { "description": "Human-readable label that identifies the hostname.", "readOnly": true, "type": "string" }, "privateEndpoint": { "description": "Human-readable label that identifies private endpoint.", "readOnly": true, "type": "string" } }, "readOnly": true, "type": "object" } } }