# mongodb

> For the complete documentation index, see [llms.txt](https://docs.redpanda.com/llms.txt). Component-specific: [cloud-data-platform-full.txt](https://docs.redpanda.com/cloud-data-platform-full.txt)

---
title: mongodb
latest-operator-version: v26.2.5
latest-console-tag: v3.14.0
latest-connect-version: 4.117.0
latest-redpanda-tag: v26.2.6
docname: connect/components/processors/mongodb
page-component-name: cloud-data-platform
page-version: master
page-component-version: master
page-component-title: Cloud
page-relative-src-path: connect/components/processors/mongodb.adoc
page-edit-url: https://github.com/redpanda-data/cloud-docs/edit/main/modules/develop/pages/connect/components/processors/mongodb.adoc
description: Performs operations against MongoDB for each message, allowing you to store or retrieve data within message payloads.
page-git-created-date: "2025-06-25"
page-git-modified-date: "2026-10-19"
page-generated-sources:
  - include: connect:components:partial$descriptions/processors/mongodb.adoc
    generator: null
    version: null
    source: the component specs in https://github.com/redpanda-data/connect
page-generated-content: partial
---

<!-- Source: https://docs.redpanda.com/cloud-data-platform/develop/connect/components/processors/mongodb.md -->

Performs operations against MongoDB for each message, allowing you to store or retrieve data within message payloads.

> 📝 **NOTE**
>
> If the service only accepts connections from allowlisted IP addresses, add your cluster’s egress addresses to its allowlist before you deploy the pipeline. On BYOC clusters, see [Allow Pipeline Traffic Through External Firewalls](https://docs.redpanda.com/cloud-data-platform/networking/connect-external-allowlist/) to find the addresses. For Dedicated or Serverless clusters, contact Redpanda support for the addresses.

#### Common

```yml
processor:
  label: ""
  mongodb:
    url: "" # No default (required)
    database: "" # No default (required)
    username: ""
    password: ""
    collection: "" # No default (required)
    operation: insert-one
    write_concern:
      w: majority
      j: false
      w_timeout: ""
    document_map: ""
    filter_map: ""
    hint_map: ""
    upsert: false
```

#### Advanced

```yml
processor:
  label: ""
  mongodb:
    url: "" # No default (required)
    database: "" # No default (required)
    username: ""
    password: ""
    app_name: benthos
    aws:
      enabled: false
      region: "" # No default (optional)
      session_duration: 1h
      id: "" # No default (optional)
      secret: "" # No default (optional)
      token: "" # No default (optional)
      role: "" # No default (optional)
      role_external_id: "" # No default (optional)
      roles: [] # No default (optional)
    collection: "" # No default (required)
    operation: insert-one
    write_concern:
      w: majority
      j: false
      w_timeout: ""
    document_map: ""
    filter_map: ""
    hint_map: ""
    upsert: false
    json_marshal_mode: canonical
```

## [](#fields)Fields

### [](#app_name)`app_name`

The client application name.

**Type**: `string`

**Default**: `benthos`

### [](#aws)`aws`

AWS IAM authentication using the `MONGODB-AWS` mechanism, for example against MongoDB Atlas. When enabled, IAM credentials are used instead of a static username and password. Role-derived session credentials are resolved when the component connects and are re-resolved whenever it reconnects. The `mongodb` processor and cache establish their client once at creation and cannot refresh expiring session credentials, so `role`, `roles` and session tokens are rejected for those components; use the ambient credential chain or long-lived access keys with them. For long-running pipelines, prefer the ambient credential chain (leave keys and roles unset), which the driver refreshes automatically.

**Type**: `object`

### [](#aws-enabled)`aws.enabled`

Enable AWS IAM authentication using the driver-native `MONGODB-AWS` mechanism. The MongoDB Atlas database user must be created with the AWS IAM authentication type, and connections require TLS. When no static credentials or roles are configured, the ambient AWS credential chain (environment variables, EC2 instance profile, EKS pod role) is used and expiring credentials are refreshed automatically.

**Type**: `bool`

**Default**: `false`

### [](#aws-id)`aws.id`

The AWS access key ID to authenticate with. When empty, the default AWS credential chain is used.

**Type**: `string`

### [](#aws-region)`aws.region`

The AWS region used when assuming roles (for STS calls). Only used when `role` or `roles` are configured; the ambient and static-key paths ignore it. If no region is specified then the environment default is used.

**Type**: `string`

### [](#aws-role)`aws.role`

Optional AWS IAM role ARN to assume for authentication. Cannot be combined with `roles`; use the `roles` array instead when chaining multiple roles.

**Type**: `string`

### [](#aws-role_external_id)`aws.role_external_id`

Optional external ID to use when assuming the role set in `role`. Each entry in `roles` sets its own external ID.

**Type**: `string`

### [](#aws-roles)`aws.roles[]`

Optional array of AWS IAM roles to assume for authentication. Roles are assumed in sequence, each using the credentials of the previous one, enabling chaining for purposes such as cross-account access. Each role can optionally specify an external ID. Cannot be combined with `role`.

**Type**: `array<object>`

### [](#aws-roles-role)`aws.roles[].role`

AWS IAM role ARN to assume.

**Type**: `string`

**Default**: `""`

### [](#aws-roles-role_external_id)`aws.roles[].role_external_id`

Optional external ID for the role assumption.

**Type**: `string`

**Default**: `""`

### [](#aws-secret)`aws.secret`

The AWS secret access key that pairs with `id`.

> ⚠️ **CAUTION**
>
> This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see [Manage Secrets](https://docs.redpanda.com/cloud-data-platform/develop/connect/configuration/secret-management/) before adding it to your configuration.

**Type**: `string`

### [](#aws-session_duration)`aws.session_duration`

The duration of the STS session requested when assuming roles. AWS requires at least 15 minutes and caps sessions created through role chaining at one hour. Only used when `role` or `roles` are configured. For long-running pipelines, prefer the ambient credential chain over a fixed session duration, since the driver refreshes ambient credentials automatically as they near expiry.

**Type**: `string`

**Default**: `1h`

### [](#aws-token)`aws.token`

The AWS session token to use with `id` and `secret`. Required only when using short-term credentials.

**Type**: `string`

### [](#collection)`collection`

The name of the target collection.

**Type**: `string`

### [](#database)`database`

The name of the target MongoDB database.

**Type**: `string`

### [](#document_map)`document_map`

A Bloblang map that represents a document to store in MongoDB, expressed as [extended JSON in canonical form](https://www.mongodb.com/docs/manual/reference/mongodb-extended-json/). The `document_map` parameter is required for the following database operations: `insert-one`, `replace-one`, `update-one`, and `aggregate`.

**Type**: `string`

**Default**: `""`

```yaml
# Examples:
document_map: |-
  root.a = this.foo
  root.b = this.bar
```

### [](#filter_map)`filter_map`

A Bloblang map that represents a filter for a MongoDB command, expressed as [extended JSON in canonical form](https://www.mongodb.com/docs/manual/reference/mongodb-extended-json/). The `filter_map` parameter is required for all database operations except `insert-one`.

The `filter_map` is used to find documents for the specified operation. For example, for a `delete-one` operation, the filter map should include the fields required to locate the document for deletion.

**Type**: `string`

**Default**: `""`

```yaml
# Examples:
filter_map: |-
  root.a = this.foo
  root.b = this.bar
```

### [](#hint_map)`hint_map`

A Bloblang map that represents a hint or index for a MongoDB command to use, expressed as [extended JSON in canonical form](https://www.mongodb.com/docs/manual/reference/mongodb-extended-json/). This map is optional, and is used with all operations except `insert-one`.

Define a `hint_map` to improve performance when finding documents in the MongoDB database.

**Type**: `string`

**Default**: `""`

```yaml
# Examples:
hint_map: |-
  root.a = this.foo
  root.b = this.bar
```

### [](#json_marshal_mode)`json_marshal_mode`

Controls the format used to convert BSON documents to JSON in the output message.

**Type**: `string`

**Default**: `canonical`

| Option | Summary |
| --- | --- |
| canonical | A string format that emphasizes type preservation at the expense of readability and interoperability. That is, conversion from canonical to BSON will generally preserve type information except in certain specific cases. |
| relaxed | A string format that emphasizes readability and interoperability at the expense of type preservation. That is, conversion from relaxed format to BSON can lose type information. |

### [](#operation)`operation`

The MongoDB database operation to perform.

**Type**: `string`

**Default**: `insert-one`

**Options**: `insert-one`, `delete-one`, `delete-many`, `replace-one`, `update-one`, `find-one`, `aggregate`

### [](#password)`password`

The password to use for authentication. Used together with `username` for basic authentication.

> ⚠️ **CAUTION**
>
> This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see [Manage Secrets](https://docs.redpanda.com/cloud-data-platform/develop/connect/configuration/secret-management/) before adding it to your configuration.

**Type**: `string`

**Default**: `""`

### [](#upsert)`upsert`

The `upsert` parameter is optional, and only applies for `update-one` and `replace-one` operations. If the filter specified in `filter_map` matches an existing document, this operation updates or replaces the document, otherwise a new document is created.

**Type**: `bool`

**Default**: `false`

### [](#url)`url`

The URL of the target MongoDB server.

**Type**: `string`

```yaml
# Examples:
url: mongodb://localhost:27017
```

### [](#username)`username`

The username to connect to the database.

**Type**: `string`

**Default**: `""`

### [](#write_concern)`write_concern`

The [write concern settings](https://www.mongodb.com/docs/manual/reference/write-concern/) for the MongoDB connection.

**Type**: `object`

### [](#write_concern-j)`write_concern.j`

The `j` option requests acknowledgement from MongoDB that write operations are written to the journal.

**Type**: `bool`

**Default**: `false`

### [](#write_concern-w)`write_concern.w`

The `w` option requests acknowledgement that write operations propagate to the specified number of MongoDB instances. Set it to `majority` to wait for a calculated majority of nodes to acknowledge the write operation, to an integer to specify the minimum number of nodes that must acknowledge the operation, or to the name of a custom write concern configured in the cluster.

**Type**: `string`

**Default**: `majority`

### [](#write_concern-w_timeout)`write_concern.w_timeout`

The write concern timeout.

**Type**: `string`

**Default**: `""`