Connect Amazon EC2 automatically - Amazon DocumentDB
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Connect Amazon EC2 automatically

Before setting up a connection between an EC2 instance and a new Amazon DocumentDB database, make sure you meet the requirements described in Overview of automatic connectivity with an EC2 instance. If you make changes to security groups after you configure connectivity, the changes might affect the connection between the EC2 instance and the Amazon DocumentDB database.

Note

You can only set up a connection between an EC2 instance and an Amazon DocumentDB database automatically by using the Amazon Web Services Management Console. You can't set up a connection automatically with the Amazon CLI or Amazon DocumentDB API.

Automatically connect an EC2 instance to a new Amazon DocumentDB database

The following process assume you have completed the steps in the Prerequisites topic.

Step 1: Create an Amazon EC2 instance

In this step, you will create an Amazon EC2 instance in the same Region and Amazon VPC that you will later use to provision your Amazon DocumentDB cluster.

  1. On the Amazon EC2 console, choose Launch instance.

  2. Enter a name or identifier in the Name field located in the Name and tags section.

  3. In the Amazon Machine Image (AMI) drop-down list, locate Amazon Linux 2 AMI and choose it.

  4. Locate and choose t3.micro in the Instance type drop-down list.

  5. In the Key pair (login) section, enter the identifier of an existing key-pair, or choose Create new key pair.

    You must provide an Amazon EC2 key pair.

    If you do have an Amazon EC2 key pair:

    1. Select a key pair, choose your key pair from the list.

    2. You must already have the private key file (.pem or .ppk file) available to log in to your Amazon EC2 instance.

    If you do not have an Amazon EC2 key pair:

    1. Choose Create new key pair, the Create key pair dialog box appears.

    2. Enter a name in the Key pair name field.

    3. Choose the Key pair type and Private key file format.

    4. Choose Create key pair.

    Note

    For security purposes, we highly recommand using a key-pair for both SSH and internet connectivity to your EC2 instance.

  6. Optional: In the Network seetings section, under Firewall (security groups), choose either Create security group or Select existing security group.

    If you chose to select an existing security group, select one from the Common security groups drop-down list.

    If you chose to create a new security group, check all the traffic allow rules that apply to your EC2 connectivity.

  7. In the Summary section, review your EC2 configuration and choose Launch instance if correct.Edit security groups.

Step 2: Create an Amazon DocumentDB cluster

While the Amazon EC2 instance is being provisioned, you will create your Amazon DocumentDB cluster.

  1. Navigate to the Amazon DocumentDB console and choose Clusters from the navigation pane.

  2. Choose Create.

  3. Leave the Cluster type setting at it's default of Instance Based Cluster.

  4. For Number of instances, choose 1. This will minimize cost. Leave the other settings at their default.

  5. For Connectivity, choose Connect to an EC2 compute resource. This is the EC2 instance you created in Step 1.

    Note

    Connecting to an EC2 compute resource automatically creates a security group for your EC2 compute resource connection to your Amazon DocumentDB cluster. When you have completed creating your cluster and you want to see the newly created security group, navigate to the cluster list and choose your cluster's identifier. In the Connectivity & security tab, go to Security Groups and find your group under Security group name (ID). It will contain the the name of your cluster and look similar to this: docdb-ec2-docdb-2023-12-11-21-33-41:i-0e4bb09985d2bbc4c (sg-0238e0b0bf0f73877).

  6. For Authentication, enter sign-in credentials. Important: You will need the sign-in credentials to authenticate your cluster in a later step.

  7. Turn on Show advanced settings.

  8. In the Network settings section, for Amazon VPC security groups, choose demoDocDB.

  9. Choose Create cluster.

Step 3: Connect to your Amazon EC2 instance

To install the mongo shell, you must first connect to your Amazon EC2 instance. Installing the mongo shell enables you to connect to and query your Amazon DocumentDB cluster. Complete the following steps:

  1. On the Amazon EC2 console, navigate to your instances and see if the instance you just created is running. If it is, select the instance by clicking the instance ID.

  2. Choose Connect.

  3. There are four tabbed options for your connection method: Amazon EC2 Instance Connect, Session Manager, SSH client, or EC2 serial console. You must choose one and follow its instructions. When complete, choose Connect.

Note

If your IP address changed after you started this walkthrough, or you are coming back to your environment at a later time, you must update your demoEC2 security group inbound rule to enable inbound traffic from your new API address.

Step 4: Install the mongo shell

You can now install the mongo shell, which is a command-line utility that you use to connect and query your Amazon DocumentDB cluster. Follow the instructions below to install the mongo shell for your operating system.

On Amazon Linux
To install the mongo shell on Amazon Linux
  1. Create the repository file. At the command line of your EC2 instance, execute the follow command:

    echo -e "[mongodb-org-5.0] \nname=MongoDB Repository\nbaseurl=https://repo.mongodb.org/yum/amazon/2/mongodb-org/5.0/x86_64/\ngpgcheck=1 \nenabled=1 \ngpgkey=https://www.mongodb.org/static/pgp/server-5.0.asc" | sudo tee /etc/yum.repos.d/mongodb-org-5.0.repo
  2. When it is complete, install the mongo shell by executing the following command:

    sudo yum install -y mongodb-org-shell
On Ubuntu 18.04
To install the mongo shell on Ubuntu 18.04
  1. Import the public key that will be used by the package management system.

    sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 2930ADAE8CAF5059EE73BB4B58712A2291FA4AD5
  2. Create the list file /etc/apt/sources.list.d/mongodb-org-3.6.list for MongoDB using the command appropriate for your version of Ubuntu.

    Ubuntu 18.04

    echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu xenial/mongodb-org/3.6 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-3.6.list
    Note

    The command above will install the mongo 3.6 shell for both Bionic and Xenial.

  3. Reload the local package database using the following command:

    sudo apt-get update
  4. Install the MongoDB shell.

    sudo apt-get install -y mongodb-org-shell

For information about installing earlier versions of MongoDB on your Ubuntu system, see Install MongoDB Community Edition on Ubuntu.

 

On other operating systems

To install the mongo shell on other operating systems, see Install MongoDB Community Edition in the MongoDB documentation.

Step 5: Manage Amazon DocumentDB TLS

Download the CA certificate for Amazon DocumentDB with the following code: wget https://rds-truststore.s3.cn-north-1.amazonaws.com.cn/global/global-bundle.pem

Note

Transport Layer Security (TLS) is enabled by default for any new Amazon DocumentDB clusters. For more information, see Managing Amazon DocumentDB cluster TLS settings.

Step 6: Connect to your Amazon DocumentDB cluster

  1. On the Amazon DocumentDB console, under Clusters, locate your cluster. Choose the cluster you created by clicking the Cluster identifier.

  2. In the Connectivity and security tab, locate Connect to this cluster with the mongo shell in the Connect box:

    Copy the connection string provided and paste it into your terminal.

    Make the following changes to it:

    1. Make sure you have the correct username in the string.

    2. Omit <insertYourPassword> so that you are prompted for the password by the mongo shell when you connect.

    Your connection string should look similar to the following:

    mongo --ssl host docdb-2020-02-08-14-15-11. cluster.region.docdb.amazonaws.com:27107 --sslCAFile rds-combined-ca-cn-bundle.pem --username demoUser --password

  3. Press enter in your terminal. You are now be prompted for your password. Enter your password.

  4. When you enter your password and can see the rs0:PRIMARY> prompt, you are successfully connected to your Amazon DocumentDB cluster.

Having problems connecting? See Troubleshooting Amazon DocumentDB.

Step 7: Insert and query data

Now that you are connected to your cluster, you can run a few queries to get familiar with using a document database.

  1. To insert a single document, enter the following:

    db.collection.insert({"hello":"DocumentDB"})
  2. You get the following output:

    WriteResult({ "nInserted" : 1 })

  3. You can read the document that you wrote with the findOne() command (because it only returns a single document). Input the following:

    db.collection.findOne()
  4. You get the following output:

    { "_id" : ObjectId("5e401fe56056fda7321fbd67"), "hello" : "DocumentDB" }

  5. To perform a few more queries, consider a gaming profiles use case. First, insert a few entries into a collection titled profiles. Input the following:

    db.profiles.insertMany([ { "_id" : 1, "name" : "Matt", "status": "active", "level": 12, "score":202}, { "_id" : 2, "name" : "Frank", "status": "inactive", "level": 2, "score":9}, { "_id" : 3, "name" : "Karen", "status": "active", "level": 7, "score":87}, { "_id" : 4, "name" : "Katie", "status": "active", "level": 3, "score":27} ])
  6. You get the following output:

    { "acknowledged" : true, "insertedIds" : [ 1, 2, 3, 4 ] }

  7. Use the find() command to return all the documents in the profiles collection. Input the following:

    db.profiles.find()
  8. You will get an output that will match the data you typed in Step 5.

  9. Use a query for a single document using a filter. Input the following:

    db.profiles.find({name: "Katie"})
  10. You should get back this output:

    { "_id" : 4, "name" : "Katie", "status": "active", "level": 3, "score":27}

  11. Now let’s try to find a profile and modify it using the findAndModify command. We’ll give the user Matt an extra ten points with the following code:

    db.profiles.findAndModify({ query: { name: "Matt", status: "active"}, update: { $inc: { score: 10 } } })
  12. You get the following output (note that his score hasn’t increased yet):

    { "_id" : 1, "name" : "Matt", "status" : "active", "level" : 12, "score" : 202 }
  13. You can verify that his score has changed with the following query:

    db.profiles.find({name: "Matt"})

  14. You get the following output:

    { "_id" : 1, "name" : "Matt", "status" : "active", "level" : 12, "score" : 212 }

Step 8: Explore

Congratulations! You have successfully completed the Quick Start Guide to Amazon DocumentDB.

What’s next? Learn how to fully leverage this powerful database with some of its popular features:

Note

To save on cost, you can either stop your Amazon DocumentDB cluster to reduce costs or delete the cluster. By default, after 30 minutes of inactivity, your Amazon Cloud9 environment will stop the underlying Amazon EC2 instance.

Automatically connect an EC2 instance to an existing Amazon DocumentDB database

The following procedure assumes you have an existing Amazon DocumentDB cluster and an existing Amazon EC2 instance.

Access your Amazon DocumentDB cluster and set up the Amazon EC2 connection
  1. Access your Amazon DocumentDB cluster.

    1. Sign in to the Amazon Web Services Management Console, and open the Amazon DocumentDB console at https://console.amazonaws.cn/docdb.

    2. In the navigation pane, choose Clusters.

      Tip

      If you don't see the navigation pane on the left side of your screen, choose the menu icon () in the upper-left corner of the page.

    3. Specify the cluster that you want by choosing the button to the left of the cluster's name.

  2. Set up the Amazon EC2 connection.

    1. Choose Actions, and then choose Set up EC2 connection.

      The Set up EC2 connection dialog appears.

    2. In the EC2 instance field, choose the EC2 instance you want connected to your cluster.

    3. Choose Continue.

      The Review and confirm dialog appears.

    4. Make sure the changes are correct. Then choose Set up connection.

If successful, the following verification appears:

Overview of automatic connectivity with an EC2 instance

When you set up a connection between an EC2 instance and an Amazon DocumentDB database, Amazon DocumentDB automatically configures the VPC security group for your EC2 instance and for your Amazon DocumentDB database.

The following are requirements for connecting an EC2 instance with an Amazon DocumentDB database:

  • The EC2 instance must exist in the same VPC as the Amazon DocumentDB database.

    If no EC2 instances exist in the same VPC, then the console provides a link to create one.

  • The user who sets up connectivity must have permissions to perform the following Amazon EC2 operations:

    • ec2:AuthorizeSecurityGroupEgress

    • ec2:AuthorizeSecurityGroupIngress

    • ec2:CreateSecurityGroup

    • ec2:DescribeInstances

    • ec2:DescribeNetworkInterfaces

    • ec2:DescribeSecurityGroups

    • ec2:ModifyNetworkInterfaceAttribute

    • ec2:RevokeSecurityGroupEgress

If the DB instance and EC2 instance are in different Availability Zones, your account may incur cross-Availability Zone costs.

When you set up a connection to an EC2 instance, Amazon DocumentDB acts according to the current configuration of the security groups associated with the Amazon DocumentDB database and EC2 instance, as described in the following table:

Current Amazon DocumentDB security group configuration Current EC2 security group configuration Amazon DocumentDB action
There are one or more security groups associated with the Amazon DocumentDB database with a name that matches the pattern DocumentDB-ec2-n. A security group that matches the pattern hasn't been modified. This security group has only one inbound rule with the VPC security group of the EC2 instance as the source. There are one or more security groups associated with the EC2 instance with a name that matches the pattern DocumentDB-ec2-n (where n is a number). A security group that matches the pattern hasn't been modified. This security group has only one outbound rule with the VPC security group of the Amazon DocumentDB database as the source. Amazon DocumentDB takes no action. A connection was already configured automatically between the EC2 instance and the Amazon DocumentDB database. Because a connection already exists between the EC2 instance and the Amazon DocumentDB database, the security groups aren't modified.
Either of the following conditions apply:
  • There is no security group associated with the Amazon DocumentDB database with a name that matches the pattern DocumentDB-ec2-n.

  • There are one or more security groups associated with the Amazon DocumentDB with a name that matches the pattern DocumentDB-ec2-n. However, Amazon DocumentDB can't use any of these security groups for the connection with the EC2 instance. Amazon DocumentDB can't use a security group that doesn't have one inbound rule with the VPC security group of the EC2 instance as the source. Amazon DocumentDB also can't use a security group that has been modified. Examples of modifications include adding a rule or changing the port of an existing rule.

Either of the following conditions apply:
  • There is no security group associated with the EC2 instance with a name that matches the pattern ec2-DocumentDB-n.

  • There are one or more security groups associated with the EC2 instance with a name that matches the pattern ec2-DocumentDB-n. However, Amazon DocumentDB can't use any of these security groups for the connection with the Amazon DocumentDB database. Amazon DocumentDB can't use a security group that doesn't have one outbound rule with the VPC security group of the Amazon DocumentDB database as the source. Amazon DocumentDB also can't use a security group that has been modified.

Amazon DocumentDB action: create new security groups
There are one or more security groups associated with the Amazon DocumentDB database with a name that matches the pattern DocumentDB-ec2-n. A security group that matches the pattern hasn't been modified. This security group has only one inbound rule with the VPC security group of the EC2 instance as the source. There are one or more security groups associated with the EC2 instance with a name that matches the pattern ec2-DocumentDB-n. However, Amazon DocumentDB can't use any of these security groups for the connection with the Amazon DocumentDB database. Amazon DocumentDB can't use a security group that doesn't have one outbound rule with the VPC security group of the Amazon DocumentDB database as the source. Amazon DocumentDB also can't use a security group that has been modified. Amazon DocumentDB action: create new security groups
There are one or more security groups associated with the Amazon DocumentDB database with a name that matches the pattern DocumentDB-ec2-n. A security group that matches the pattern hasn't been modified. This security group has only one inbound rule with the VPC security group of the EC2 instance as the source. A valid EC2 security group for the connection exists, but it is not associated with the EC2 instance. This security group has a name that matches the pattern DocumentDB-ec2-n. It hasn't been modified. It has only one outbound rule with the VPC security group of the Amazon DocumentDB database as the source. Amazon DocumentDB action: associate EC2 security group
Either of the following conditions apply:
  • There is no security group associated with the Amazon DocumentDB database with a name that matches the pattern DocumentDB-ec2-n.

  • There are one or more security groups associated with the Amazon DocumentDB database with a name that matches the pattern DocumentDB-ec2-n. However, Amazon DocumentDB can't use any of these security groups for the connection with the EC2 instance. Amazon DocumentDB can't use a security group that doesn't have one inbound rule with the VPC security group of the EC2 instance as the source. Amazon DocumentDB also can't use security group that has been modified.

There are one or more security groups associated with the EC2 instance with a name that matches the pattern DocumentDB-ec2-n. A security group that matches the pattern hasn't been modified. This security group has only one outbound rule with the VPC security group of the Amazon DocumentDB database as the source. Amazon DocumentDB action: create new security groups

Amazon DocumentDB action: create new security groups

Amazon DocumentDB takes the following actions:

  • Creates a new security group that matches the pattern DocumentDB-ec2-n. This security group has an inbound rule with the VPC security group of the EC2 instance as the source. This security group is associated with the Amazon DocumentDB database and allows the EC2 instance to access the Amazon DocumentDB database.

  • Creates a new security group that matches the pattern ec2-DocumentDB-n. This security group has an outbound rule with the VPC security group of the Amazon DocumentDB database as the source. This security group is associated with the EC2 instance and allows the EC2 instance to send traffic to the Amazon DocumentDB database.

Amazon DocumentDB action: associate EC2 security group

Amazon DocumentDB associates the valid, existing EC2 security group with the EC2 instance. This security group allows the EC2 instance to send traffic to the Amazon DocumentDB database.

Viewing connected compute resources

You can use the Amazon Web Services Management Console to view the compute resources that are connected to an Amazon DocumentDB database. The resources shown include compute resource connections that were set up automatically. You can set up connectivity with compute resources automatically in the following ways:

The listed compute resources don't include ones that were connected to the database manually. For example, you can allow a compute resource to access a database manually by adding a rule to the VPC security group associated with the database.

For a compute resource to be listed, the following conditions must apply:

  • The name of the security group associated with the compute resource matches the pattern ec2-DocumentDB-n (where n is a number).

  • The security group associated with the compute resource has an outbound rule with the port range set to the port that the Amazon DocumentDB database uses.

  • The security group associated with the compute resource has an outbound rule with the source set to a security group associated with the Amazon DocumentDB database.

  • The name of the security group associated with the Amazon DocumentDB database matches the pattern DocumentDB-ec2-n (where n is a number).

  • The security group associated with the Amazon DocumentDB database has an inbound rule with the port range set to the port that the Amazon DocumentDB database uses.

  • The security group associated with the Amazon DocumentDB database has an inbound rule with the source set to a security group associated with the compute resource.

To view compute resources connected to an Amazon DocumentDB database

  1. Sign in to the Amazon Web Services Management Console, and open the Amazon DocumentDB console at https://console.amazonaws.cn/docdb.

  2. In the navigation pane, choose Databases, and then choose the name of the Amazon DocumentDB database.

  3. On the Connectivity & security tab, view the compute resources in the Connected compute resources section.