For the complete documentation index, see llms.txt. This page is also available as Markdown.

AWS DocumentDB

Create an integration to manage access to an AWS DocumentDB cluster

The AWS DocumentDB integration helps you to securely discover and manage your AWS DocumentDB resources through Apono.

After integrating AWS DocumentDB with Apono, you'll be able to:

  • Automate resource discovery and mapping across your AWS DocumentDB infrastructure

  • Enable administrators to implement just-in-time, least-privilege access policies and securely manage permissions

  • Allow users to request temporary access to specific clusters and databases


Prerequisites

Item
Description

Apono Connector

On-prem connection serving as a bridge between an AWS DocumentDB cluster and Apono:

AWS DocumentDB Information

Information for the AWS DocumentDB cluster to be integrated:

  • Hostname

  • Port

This information can be obtained from a connection string.

AWS DocumentDB Access

Primary user or another user account with permission to create users


Create a user

You must create an AWS DocumentDB user for the Apono connector.

Follow these steps to create a user:

  1. In your AWS DocumentDB cluster, switch to the admin database.

use admin;
  1. Create a user (user) and password (pwd) for the Apono connector.

For more information on creating a user, refer to Amazon's Managing Amazon DocumentDB users.

  1. Create a secret with the credentials from step 2. Use the following key-value pair structure when generating the secret. Be sure to replace #PASSWORD with the actual value. If you used a different name for the user, replace apono-connector with the name you assigned to the user.

lightbulb

Integrate AWS DocumentDB

lightbulb

Follow these steps to complete the integration:

  1. On the Catalog tab, click AWS DocumentDB. The Connect Integration page appears.

  2. Under Discovery, select one or multiple resource types.

Apono automatically discovers and syncs all the instances in the environment. After syncing, you can manage access flows to these resources.

  1. Click Next. The Apono connector section expands.

  2. From the dropdown menu, select a connector. Choosing a connector links Apono to all the services available on the account where the connector is located.

  1. Click Next. The Integration Config section expands.

  2. Define the Integration Config settings.

    Setting
    Description

    Integration Name

    Unique, alphanumeric, user-friendly name used to identify this integration when constructing an access flow

    Hostname

    Cluster endpoint for the AWS DocumentDB cluster

    Port

    Network port the AWS DocumentDB cluster is listening on for connections

    By default, AWS DocumentDB uses port 27017.

  3. Click Next. The Secret Store section expands.

  4. Associate the secret or credentials.

    If you select the Apono secret manager, enter the AWS DocumentDB Username and Password for the Apono Connector.

  5. Click Next. The Get more with Apono section expands.

  6. Define the Get more with Apono settings.

    Setting
    Description

    Credential Rotation

    (Optional) Number of days after which the database credentials must be rotated Learn more about the Credentials Rotation Policy.

    User cleanup after access is revoked (in days)

    (Optional) Defines the number of days after access has been revoked that the user should be deleted

    Learn more about Periodic User Cleanup & Deletion.

    Custom Access Details

    (Optional) Instructions explaining how to access this integration's resources Upon accessing an integration, a message with these instructions will be displayed to end users in the User Portal. The message may include up to 400 characters. To view the message as it appears to end users, click Preview.

    Integration Owner

    (Optional) Fallback approver if no resource owner is found Follow these steps to define one or several integration owners:

    1. From the Attribute dropdown menu, select User or Group under the relevant identity provider (IdP) platform.

    2. From the Value dropdown menu, select one or multiple users or groups.

    NOTE: When Resource Owner is defined, an Integration Owner must be defined.

    Resource Owner

    (Optional) Group or role responsible for managing access approvals or rejections for the resource Follow these steps to define one or several resource owners:

    1. Enter a Key name. This value is the name of the tag created in your cloud environment.

    2. From the Attribute dropdown menu, select an attribute under the IdP platform to which the key name is associated. Apono will use the value associated with the key (tag) to identify the resource owner. When you update the membership of the group or role in your IdP platform, this change is also reflected in Apono.

    NOTE: When this setting is defined, an Integration Owner must also be defined.

  7. (Recommended) Click Test Integration to validate the integration.

Test Integration is available after you have entered or selected values for all required integration fields.

During the test, Apono runs the following validation checks:

  • Connectivity: The connector can reach the integration.

  • Configuration: The integration is set up correctly.

  • Authentication: The credentials are valid.

  • Discovery: Resources can be fetched.

The Test Validation checklist shows the result of each check.

If a check fails, Apono identifies the failed check and highlights the fields that need correction.

  1. Click Confirm.

💡Are you integrating with Apono using Terraform?

If you want to integrate with Apono using Terraform, follow these steps instead of clicking Confirm:

  1. At the top of the screen, click View as Code. A modal appears with the completed Terraform configuration code.

  2. Click to copy the code.

  3. Make any additional edits.

  4. Deploy the code in your Terraform.

Refer to Integration Config Metadata for more details about the schema definition.

Usage

Now that the integration is complete, you can add AWS DocumentDB clusters and databases as resources in an access flow. This allows requesters to securely request temporary access to those resources based on your approval and provisioning rules.

Follow the guidance in these articles to define AWS DocumentDB resources:

Last updated

Was this helpful?