A MongoDB Atlas cluster is a schema-less, NoSQL database that is fully managed by MongoDB. Although it is not an AWS-native service, Stacktape seamlessly integrates it into your stacks.

MongoDB Atlas clusters are secure, scalable, and highly available. They have built-in replication and support backups and point-in-time recovery. Each stack that includes a MongoDB Atlas cluster will also create a new MongoDB Atlas project, which ensures isolation between stacks.

Advantages

• Secure: Your data is protected by multiple layers of security.
• Scalable: You can scale your cluster up or down as your needs change.
• Performant: MongoDB Atlas is designed for high performance.
• Backups and point-in-time recovery: You can restore your data to a previous state in case of an accident.
• High availability: Your data is replicated across multiple servers to ensure that it is always available.
• ACID transactions: MongoDB supports multi-document ACID transactions.

Disadvantages

• Separate billing: Although Stacktape integrates with MongoDB Atlas, you will still need to manage your billing separately.

Provider configuration

To use MongoDB Atlas with Stacktape, you will need to:

1. Create a MongoDB Atlas account.
2. Follow our step-by-step guide to get your organizationId, publicKey, and privateKey.
3. Store your credentials in a secret.

providerConfig:
  mongoDbAtlas:
    privateKey: 'xxxxfa523543fxxxx42543xx'
    publicKey: 'xxxxxxx'
    organizationId: 'xxxxxxxxxxx07a593cbe63dd'

resources:
  myMongoCluster:
    type: 'mongo-db-atlas-cluster'
    properties:
      clusterTier: M2

Basic usage

resources:
  myMongoDbCluster:
    type: mongo-db-atlas-cluster
    properties:
      clusterTier: M2
  myLambda:
    type: function
    properties:
      packaging:
        type: stacktape-lambda-buildpack
        properties:
          entryfilePath: path/to/my/lambda.ts
      environment:
        - name: MONGODB_CONNECTION_STRING
          value: $ResourceParam('myMongoDbCluster', 'connectionString')
      connectTo:
        - myMongoDbCluster

import { MongoClient } from 'mongodb';

const client = new MongoClient(process.env.MONGODB_CONNECTION_STRING);

const handler = async (event, context) => {
  await client.connect();

  const db = client.db('mydb');

  await db.collection('posts').insertOne({
    title: 'My first post',
    content: 'Hello!'
  });

  const post = await db.collection('posts').findOne({ title: 'My first post' });

  await client.close();
};

Cluster tier

The cluster tier determines the resources (memory, storage, IOPS) for each data-bearing node in your cluster. To learn more, see the MongoDB Atlas documentation.

resources:
  myMongoCluster:
    type: 'mongo-db-atlas-cluster'
    properties:
      clusterTier: M2

Disk size

Each cluster tier comes with a default amount of storage. All M10+ clusters automatically scale their storage, but you can disable this behavior. You can also customize the storage capacity for all M10+ clusters.

resources:
  myMongoCluster:
    type: mongo-db-atlas-cluster
    properties:
      clusterTier: M2
      diskSizeGB: 60

Auto-scaling

resources:
  myMongoDbCluster:
    type: mongo-db-atlas-cluster
    properties:
      clusterTier: M10
      autoScaling:
        minClusterTier: M10
        maxClusterTier: M30
        disableDiskScaling: true
        disableScaleDown: true

Sharding

resources:
  myMongoCluster:
    type: mongo-db-atlas-cluster
    properties:
      clusterTier: M30
      numShards: 3

Backups

There are different types of snapshots with different retention periods and frequencies:

• Hourly: Every 6 hours, retained for 2 days.
• Daily: Every day, retained for 7 days.
• Weekly: Every Saturday, retained for 4 weeks.
• Monthly: Last day of the month, retained for 12 months.

resources:
  myMongoDbCluster:
    type: mongo-db-atlas-cluster
    properties:
      clusterTier: M10
      enableBackups: true

Point-in-time recovery

resources:
  myMongoDbCluster:
    type: mongo-db-atlas-cluster
    properties:
      clusterTier: M10
      enablePointInTimeRecovery: true

Accessing clusters from workloads

You can grant a compute resource permission to access a cluster by listing it in the resource's connectTo property. This will inject the necessary credentials into the resource.

resources:
  myMongoCluster:
    type: 'mongo-db-atlas-cluster'
    properties:
      clusterTier: M2

  myMongoFunction:
    type: function
    properties:
      packaging:
        type: stacktape-lambda-buildpack
        properties:
          entryfilePath: 'lambdas/mongo-lambda.ts'
      memory: 512
      # by allowing access to cluster, lambda receives permissions for reading and writing into cluster databases
      connectTo:
        - myMongoCluster
      environment:
        # injecting the connection string as environment variable
        - name: MONGODB_CONNECTION_STRING
          value: $ResourceParam('myMongoCluster', 'connectionString')

Accessibility

You can restrict access to your cluster to specific resources or IP addresses. Unlike other database resources, accessibility is set globally in the provider configuration, not on the resource itself. This means that all clusters in a given stack will have the same accessibility mode.

Internet mode

This is the default and least restrictive mode. The cluster can be accessed from anywhere on the internet. However, your cluster is still protected by IAM permissions.

VPC mode

In addition to IAM permissions, the cluster is also protected at the network level. This means that only resources within your stack's default VPC can access the cluster. Any IP addresses in the whitelistedIps list can also access the cluster. Traffic between your stack's resources and the cluster never leaves the AWS network, which is more secure and can be cheaper.

providerConfig:
  mongoDbAtlas:
    privateKey: 'xxxxfa523543fxxxx42543xx'
    publicKey: 'xxxxxxx'
    # "accessibility" option is shared between "mongo-db-atlas-cluster" resources of your stack
    accessibility:
      accessibilityMode: vpc
    organizationId: 'xxxxxxxxxxx07a593cbe63dd'

resources:
  myMongoCluster:
    type: mongo-db-atlas-cluster
    properties:
      clusterTier: M10

Scoped VPC mode

This mode is similar to VPC mode, but even more restrictive. In this mode, the connectTo property not only grants IAM permissions, but also grants access at the network level.

providerConfig:
  mongoDbAtlas:
    privateKey: 'xxxxfa523543fxxxx42543xx'
    publicKey: 'xxxxxxx'
    # "accessibility" option is shared between "mongo-db-atlas-cluster" resources of your stack
    accessibility:
      accessibilityMode: scoping-workloads-in-vpc
    organizationId: 'xxxxxxxxxxx07a593cbe63dd'

resources:
  # functionOne does NOT have access to database eventhough it is joined in vpc
  functionOne:
    type: function
    properties:
      packaging:
        type: stacktape-lambda-buildpack
        properties:
          entryfilePath: 'path/to/my-lambda.ts'
      joinDefaultVpc: true

  # functionTwo does have access to database, because it is scoping the database in connectTo list
  functionTwo:
    type: function
    properties:
      packaging:
        type: stacktape-lambda-buildpack
        properties:
          entryfilePath: 'path/to/my-lambda-2.ts'
      joinDefaultVpc: true
      connectTo:
        - myMongoCluster

  myMongoCluster:
    type: mongo-db-atlas-cluster
    properties:
      clusterTier: M10

Whitelisted IPs only mode

The cluster can only be accessed from the IP addresses and CIDR blocks in the whitelistedIps list.

providerConfig:
  mongoDbAtlas:
    privateKey: 'xxxxfa523543fxxxx42543xx'
    publicKey: 'xxxxxxx'
    # "accessibility" option is shared between "mongo-db-atlas-cluster" resources of your stack
    accessibility:
      accessibilityMode: whitelisted-ips-only
      whitelistedIps:
        - 193.12.16.4
    organizationId: 'xxxxxxxxxxx07a593cbe63dd'
resources:
  myMongoCluster:
    type: mongo-db-atlas-cluster
    properties:
      clusterTier: M10

Admin user

resources:
  myMongoCluster:
    type: 'mongo-db-atlas-cluster'
    properties:
      clusterTier: M2
      adminUserCredentials:
        userName: my-master-user
        password: $Secret('mongo-master-password')

Business Intelligence Connector for SQL

The MongoDB Connector for BI allows you to use SQL to query your MongoDB data with tools like Tableau, Power BI, and Excel.

resources:
  myMongoCluster:
    type: 'mongo-db-atlas-cluster'
    properties:
      clusterTier: 'M10'
      biConnector:
        enabled: true

Referenceable parameters

Pricing

You are charged for:

• Cluster tier: Starting at $8.60/month for an M2 shared cluster.
• Data transfer: For most customers, data transfer fees are less than 10% of their bill. There are no data transfer fees for M0, M2, and M5 clusters.

For a more detailed overview, see the MongoDB documentation.

API reference