Skip to content

chore: Generate L1 resources without datalake references #527

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 6, 2025
Merged

chore: Generate L1 resources without datalake references #527

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a01bbba
generate l1 resources without datalake references
lantoli Nov 6, 2025
66ef8f1
API.md
lantoli Nov 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
794 changes: 34 additions & 760 deletions API.md
View file
Open in desktop

Large diffs are not rendered by default.

49 changes: 0 additions & 49 deletions examples/l1-resources/private-endpoint-adl.ts
View file
Open in desktop

This file was deleted.

8 changes: 4 additions & 4 deletions examples/l1-resources/private-endpoint-regional-mode.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,18 @@ export class CdkTestingStack extends cdk.Stack {
super(scope, id, props);

const atlasProps = this.getContextProps();
const myPrivateEndpointAdl = new CfnPrivateEndPointRegionalMode(this, 'MyPrivateEndpointAdl', {
const myPrivateEndpoint = new CfnPrivateEndPointRegionalMode(this, 'MyPrivateEndpoint', {
projectId: atlasProps.projId,
profile: atlasProps.profile,
profile: atlasProps.profile,
});
}

getContextProps(): AtlasStackProps {
const projId = this.node.tryGetContext('projId');
if (!projId){
if (!projId) {
throw "No context value specified for projId. Please specify via the cdk context."
}

const profile = this.node.tryGetContext('profile') ?? 'default';


Expand Down
1 change: 0 additions & 1 deletion src/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ L1 constructs are called Cfn (short for CloudFormation) resources. These resourc
| online-archive | Returns, adds, edits, or removes an online archive. | [README.md](l1-resources/online-archive/README.md) | |
| org-invitation | Returns, adds, and edits organizational units in MongoDB Cloud. | [README.md](l1-resources/org-invitation/README.md) |
| private-endpoint | The Private Endpoint creation flow consists of the creation of three related resources in the next order: 1. Atlas Private Endpoint Service 2. Aws VPC private Endpoint 3. Atlas Private Endpoint | [README.md](l1-resources/private-endpoint/README.md) |
| private-endpoint-adl | Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. To use this resource, the requesting API Key must have the Project Atlas Admin or Project Charts Admin roles. This resource doesn't require the API Key to have an Access List. | [README.md](l1-resources/private-endpoint-adl/README.md) |
| private-endpoint-regional-mode | This resource manages the private enpoint regional mode. | [README.md](l1-resources/private-endpoint-regional-mode/README.md) |
| project | Retrieves or creates projects in any given Atlas organization. | [README.md](l1-resources/project/README.md) |
| project-invitation | Returns, send project invitations. | [README.md](l1-resources/project-invitation/README.md) |
Expand Down
5 changes: 0 additions & 5 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,11 +242,6 @@ export {
PrivateEndpoint,
} from "./l1-resources/private-endpoint";

export {
CfnPrivateEndpointAdl,
CfnPrivateEndpointAdlProps,
} from "./l1-resources/private-endpoint-adl";

export {
CfnPrivateEndpointAwsProps,
CfnPrivateEndpointAws,
Expand Down
2 changes: 1 addition & 1 deletion src/l1-resources/database-user/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ export interface CfnDatabaseUserProps {
readonly roles: RoleDefinition[];

/**
* List that contains clusters and MongoDB Atlas Data Lakes that this database user can access. If omitted, MongoDB Cloud grants the database user access to all the clusters and MongoDB Atlas Data Lakes in the project.
* List that contains clusters and MongoDB Atlas Data Federation that this database user can access. If omitted, MongoDB Cloud grants the database user access to all the clusters and MongoDB Atlas Data Federation in the project.
*
* @schema CfnDatabaseUserProps#Scopes
*/
Expand Down
36 changes: 18 additions & 18 deletions src/l1-resources/federated-database-instance/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ import * as constructs from "constructs";
*/
export interface CfnFederatedDatabaseInstanceProps {
/**
* Cloud provider linked to this data lake.
* Cloud provider linked to this Atlas Data Federation.
*
* @schema CfnFederatedDatabaseInstanceProps#CloudProviderConfig
*/
readonly cloudProviderConfig?: CloudProviderConfig;

/**
* Information about the cloud provider region to which the data lake routes client connections. MongoDB Cloud supports AWS only.
* Information about the cloud provider region to which the Atlas Data Federation routes client connections. MongoDB Cloud supports AWS only.
*
* @schema CfnFederatedDatabaseInstanceProps#DataProcessRegion
*/
Expand Down Expand Up @@ -86,34 +86,34 @@ export function toJson_CfnFederatedDatabaseInstanceProps(
/* eslint-enable max-len, quote-props */

/**
* Cloud provider linked to this data lake..
* Cloud provider linked to this Atlas Data Federation.
*
* @schema CloudProviderConfig
*/
export interface CloudProviderConfig {
/**
* Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig.
* Unique identifier of the role that the Atlas Data Federation can use to access the data stores.Required if specifying cloudProviderConfig.
*
* @schema CloudProviderConfig#ExternalId
*/
readonly externalId?: string;

/**
* Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the data lake assumes when accessing data stores.
* Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the Atlas Data Federation assumes when accessing data stores.
*
* @schema CloudProviderConfig#IamAssumedRoleARN
*/
readonly iamAssumedRoleArn?: string;

/**
* Amazon Resource Name (ARN) of the user that the data lake assumes when accessing data stores.
* Amazon Resource Name (ARN) of the user that the Atlas Data Federation assumes when accessing data stores.
*
* @schema CloudProviderConfig#IamUserARN
*/
readonly iamUserArn?: string;

/**
* Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig.
* Unique identifier of the role that the Atlas Data Federation can use to access the data stores.Required if specifying cloudProviderConfig.
*
* @schema CloudProviderConfig#RoleId
*/
Expand Down Expand Up @@ -153,20 +153,20 @@ export function toJson_CloudProviderConfig(
/* eslint-enable max-len, quote-props */

/**
* Information about the cloud provider region to which the data lake routes client connections. MongoDB Cloud supports AWS only.
* Information about the cloud provider region to which the Atlas Data Federation routes client connections. MongoDB Cloud supports AWS only.
*
* @schema DataProcessRegion
*/
export interface DataProcessRegion {
/**
* Name of the cloud service that hosts the data lake's data stores.
* Name of the cloud service that hosts the Atlas Data Federation data stores.
*
* @schema DataProcessRegion#CloudProvider
*/
readonly cloudProvider?: string;

/**
* Name of the region to which the data lake routes client connections.
* Name of the region to which the Atlas Data Federation routes client connections.
*
* @schema DataProcessRegion#Region
*/
Expand Down Expand Up @@ -202,14 +202,14 @@ export function toJson_DataProcessRegion(
*/
export interface Storage {
/**
* Array that contains the queryable databases and collections for this data lake.
* Array that contains the queryable databases and collections for this Atlas Data Federation.
*
* @schema Storage#Databases
*/
readonly databases?: Database[];

/**
* Array that contains the data stores for the data lake.
* Array that contains the data stores for the Atlas Data Federation.
*
* @schema Storage#Stores
*/
Expand Down Expand Up @@ -257,7 +257,7 @@ export interface Database {
readonly maxWildcardCollections?: string;

/**
* Human-readable label that identifies the database to which the data lake maps data.
* Human-readable label that identifies the database to which the Atlas Data Federation maps data.
*
* @schema Database#Name
*/
Expand Down Expand Up @@ -296,13 +296,13 @@ export function toJson_Database(
/* eslint-enable max-len, quote-props */

/**
* Array that contains the data stores for the data lake.
* Array that contains the data stores for the Atlas Data Federation.
*
* @schema Store
*/
export interface Store {
/**
* 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.
* 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.
*
* @schema Store#Name
*/
Expand Down Expand Up @@ -369,7 +369,7 @@ export function toJson_Store(
*/
export interface Collection {
/**
* Array that contains the data stores that map to a collection for this data lake.
* Array that contains the data stores that map to a collection for this Atlas Data Federation.
*
* @schema Collection#DataSources
*/
Expand Down Expand Up @@ -472,7 +472,7 @@ export interface ReadPreference {
readonly maxStalenessSeconds?: string;

/**
* 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.
* List that contains tag sets or tag specification documents. If specified, Atlas Data Federation routes read requests to replica set member or members that are associated with the specified tags.
*
* @schema ReadPreference#TagSets
*/
Expand Down Expand Up @@ -570,7 +570,7 @@ export interface DataSource {
readonly storeName?: 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.
* 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.
*
* @schema DataSource#Urls
*/
Expand Down
68 changes: 0 additions & 68 deletions src/l1-resources/private-endpoint-adl/README.md
View file
Open in desktop

This file was deleted.

Loading
Loading