airbyte 0.7.0-beta2, Mar 7 25

airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

airbyte.SourceMongodbV2

Explore with Pulumi AI

airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.airbyte.SourceMongodbV2;
import com.pulumi.airbyte.SourceMongodbV2Args;
import com.pulumi.airbyte.inputs.SourceMongodbV2ConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var mySourceMongodbv2 = new SourceMongodbV2("mySourceMongodbv2", SourceMongodbV2Args.builder()
            .configuration(SourceMongodbV2ConfigurationArgs.builder()
                .database_config(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .discover_sample_size(95684)
                .initial_load_timeout_hours(0)
                .initial_waiting_seconds(7)
                .invalid_cdc_cursor_position_behavior("Fail sync")
                .queue_size(4)
                .update_capture_mode("Lookup")
                .build())
            .definitionId("e30b0d99-fa62-4e68-8f19-2a57eaddc53f")
            .secretId("...my_secret_id...")
            .workspaceId("fa7bf7db-d8dc-4773-80b5-3e3a9ea84f0d")
            .build());

    }
}

resources:
  mySourceMongodbv2:
    type: airbyte:SourceMongodbV2
    properties:
      configuration:
        database_config:
          mongoDbAtlasReplicaSet:
            additionalProperties: '{ "see": "documentation" }'
            authSource: admin
            connectionString: mongodb+srv://cluster0.abcd1.mongodb.net/
            database: '...my_database...'
            password: '...my_password...'
            schemaEnforced: true
            username: '...my_username...'
          selfManagedReplicaSet:
            additionalProperties: '{ "see": "documentation" }'
            authSource: admin
            connectionString: mongodb://example1.host.com:27017,example2.host.com:27017,example3.host.com:27017/
            database: '...my_database...'
            password: '...my_password...'
            schemaEnforced: false
            username: '...my_username...'
        discover_sample_size: 95684
        initial_load_timeout_hours: 0
        initial_waiting_seconds: 7
        invalid_cdc_cursor_position_behavior: Fail sync
        queue_size: 4
        update_capture_mode: Lookup
      definitionId: e30b0d99-fa62-4e68-8f19-2a57eaddc53f
      secretId: '...my_secret_id...'
      workspaceId: fa7bf7db-d8dc-4773-80b5-3e3a9ea84f0d

Create SourceMongodbV2 Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SourceMongodbV2(name: string, args: SourceMongodbV2Args, opts?: CustomResourceOptions);

@overload
def SourceMongodbV2(resource_name: str,
                    args: SourceMongodbV2Args,
                    opts: Optional[ResourceOptions] = None)

@overload
def SourceMongodbV2(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    configuration: Optional[SourceMongodbV2ConfigurationArgs] = None,
                    workspace_id: Optional[str] = None,
                    definition_id: Optional[str] = None,
                    name: Optional[str] = None,
                    secret_id: Optional[str] = None)

func NewSourceMongodbV2(ctx *Context, name string, args SourceMongodbV2Args, opts ...ResourceOption) (*SourceMongodbV2, error)

public SourceMongodbV2(string name, SourceMongodbV2Args args, CustomResourceOptions? opts = null)

public SourceMongodbV2(String name, SourceMongodbV2Args args)
public SourceMongodbV2(String name, SourceMongodbV2Args args, CustomResourceOptions options)

type: airbyte:SourceMongodbV2
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args SourceMongodbV2Args: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args SourceMongodbV2Args: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args SourceMongodbV2Args: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SourceMongodbV2Args: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SourceMongodbV2Args: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var sourceMongodbV2Resource = new Airbyte.SourceMongodbV2("sourceMongodbV2Resource", new()
{
    Configuration = new Airbyte.Inputs.SourceMongodbV2ConfigurationArgs
    {
        DatabaseConfig = new Airbyte.Inputs.SourceMongodbV2ConfigurationDatabaseConfigArgs
        {
            MongoDbAtlasReplicaSet = new Airbyte.Inputs.SourceMongodbV2ConfigurationDatabaseConfigMongoDbAtlasReplicaSetArgs
            {
                ConnectionString = "string",
                Database = "string",
                Password = "string",
                Username = "string",
                AdditionalProperties = "string",
                AuthSource = "string",
                SchemaEnforced = false,
            },
            SelfManagedReplicaSet = new Airbyte.Inputs.SourceMongodbV2ConfigurationDatabaseConfigSelfManagedReplicaSetArgs
            {
                ConnectionString = "string",
                Database = "string",
                AdditionalProperties = "string",
                AuthSource = "string",
                Password = "string",
                SchemaEnforced = false,
                Username = "string",
            },
        },
        DiscoverSampleSize = 0,
        InitialLoadTimeoutHours = 0,
        InitialWaitingSeconds = 0,
        InvalidCdcCursorPositionBehavior = "string",
        QueueSize = 0,
        UpdateCaptureMode = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

example, err := airbyte.NewSourceMongodbV2(ctx, "sourceMongodbV2Resource", &airbyte.SourceMongodbV2Args{
Configuration: &.SourceMongodbV2ConfigurationArgs{
DatabaseConfig: &.SourceMongodbV2ConfigurationDatabaseConfigArgs{
MongoDbAtlasReplicaSet: &.SourceMongodbV2ConfigurationDatabaseConfigMongoDbAtlasReplicaSetArgs{
ConnectionString: pulumi.String("string"),
Database: pulumi.String("string"),
Password: pulumi.String("string"),
Username: pulumi.String("string"),
AdditionalProperties: pulumi.String("string"),
AuthSource: pulumi.String("string"),
SchemaEnforced: pulumi.Bool(false),
},
SelfManagedReplicaSet: &.SourceMongodbV2ConfigurationDatabaseConfigSelfManagedReplicaSetArgs{
ConnectionString: pulumi.String("string"),
Database: pulumi.String("string"),
AdditionalProperties: pulumi.String("string"),
AuthSource: pulumi.String("string"),
Password: pulumi.String("string"),
SchemaEnforced: pulumi.Bool(false),
Username: pulumi.String("string"),
},
},
DiscoverSampleSize: pulumi.Float64(0),
InitialLoadTimeoutHours: pulumi.Float64(0),
InitialWaitingSeconds: pulumi.Float64(0),
InvalidCdcCursorPositionBehavior: pulumi.String("string"),
QueueSize: pulumi.Float64(0),
UpdateCaptureMode: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

var sourceMongodbV2Resource = new SourceMongodbV2("sourceMongodbV2Resource", SourceMongodbV2Args.builder()
    .configuration(SourceMongodbV2ConfigurationArgs.builder()
        .databaseConfig(SourceMongodbV2ConfigurationDatabaseConfigArgs.builder()
            .mongoDbAtlasReplicaSet(SourceMongodbV2ConfigurationDatabaseConfigMongoDbAtlasReplicaSetArgs.builder()
                .connectionString("string")
                .database("string")
                .password("string")
                .username("string")
                .additionalProperties("string")
                .authSource("string")
                .schemaEnforced(false)
                .build())
            .selfManagedReplicaSet(SourceMongodbV2ConfigurationDatabaseConfigSelfManagedReplicaSetArgs.builder()
                .connectionString("string")
                .database("string")
                .additionalProperties("string")
                .authSource("string")
                .password("string")
                .schemaEnforced(false)
                .username("string")
                .build())
            .build())
        .discoverSampleSize(0)
        .initialLoadTimeoutHours(0)
        .initialWaitingSeconds(0)
        .invalidCdcCursorPositionBehavior("string")
        .queueSize(0)
        .updateCaptureMode("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

source_mongodb_v2_resource = airbyte.SourceMongodbV2("sourceMongodbV2Resource",
    configuration={
        "database_config": {
            "mongo_db_atlas_replica_set": {
                "connection_string": "string",
                "database": "string",
                "password": "string",
                "username": "string",
                "additional_properties": "string",
                "auth_source": "string",
                "schema_enforced": False,
            },
            "self_managed_replica_set": {
                "connection_string": "string",
                "database": "string",
                "additional_properties": "string",
                "auth_source": "string",
                "password": "string",
                "schema_enforced": False,
                "username": "string",
            },
        },
        "discover_sample_size": 0,
        "initial_load_timeout_hours": 0,
        "initial_waiting_seconds": 0,
        "invalid_cdc_cursor_position_behavior": "string",
        "queue_size": 0,
        "update_capture_mode": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

const sourceMongodbV2Resource = new airbyte.SourceMongodbV2("sourceMongodbV2Resource", {
    configuration: {
        databaseConfig: {
            mongoDbAtlasReplicaSet: {
                connectionString: "string",
                database: "string",
                password: "string",
                username: "string",
                additionalProperties: "string",
                authSource: "string",
                schemaEnforced: false,
            },
            selfManagedReplicaSet: {
                connectionString: "string",
                database: "string",
                additionalProperties: "string",
                authSource: "string",
                password: "string",
                schemaEnforced: false,
                username: "string",
            },
        },
        discoverSampleSize: 0,
        initialLoadTimeoutHours: 0,
        initialWaitingSeconds: 0,
        invalidCdcCursorPositionBehavior: "string",
        queueSize: 0,
        updateCaptureMode: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

type: airbyte:SourceMongodbV2
properties:
    configuration:
        databaseConfig:
            mongoDbAtlasReplicaSet:
                additionalProperties: string
                authSource: string
                connectionString: string
                database: string
                password: string
                schemaEnforced: false
                username: string
            selfManagedReplicaSet:
                additionalProperties: string
                authSource: string
                connectionString: string
                database: string
                password: string
                schemaEnforced: false
                username: string
        discoverSampleSize: 0
        initialLoadTimeoutHours: 0
        initialWaitingSeconds: 0
        invalidCdcCursorPositionBehavior: string
        queueSize: 0
        updateCaptureMode: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

SourceMongodbV2 Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SourceMongodbV2 resource accepts the following input properties:

Configuration SourceMongodbV2Configuration
WorkspaceId string
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Configuration SourceMongodbV2ConfigurationArgs
WorkspaceId string
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration SourceMongodbV2Configuration
workspaceId String
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration SourceMongodbV2Configuration
workspaceId string
definitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name string: Name of the source e.g. dev-mysql-instance.
secretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration SourceMongodbV2ConfigurationArgs
workspace_id str
definition_id str: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name str: Name of the source e.g. dev-mysql-instance.
secret_id str: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration Property Map
workspaceId String
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Outputs

All input properties are implicitly available as output properties. Additionally, the SourceMongodbV2 resource produces the following output properties:

CreatedAt double
Id string: The provider-assigned unique ID for this managed resource.
SourceId string
SourceType string

CreatedAt float64
Id string: The provider-assigned unique ID for this managed resource.
SourceId string
SourceType string

createdAt Double
id String: The provider-assigned unique ID for this managed resource.
sourceId String
sourceType String

createdAt number
id string: The provider-assigned unique ID for this managed resource.
sourceId string
sourceType string

created_at float
id str: The provider-assigned unique ID for this managed resource.
source_id str
source_type str

createdAt Number
id String: The provider-assigned unique ID for this managed resource.
sourceId String
sourceType String

Look up Existing SourceMongodbV2 Resource

Get an existing SourceMongodbV2 resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SourceMongodbV2State, opts?: CustomResourceOptions): SourceMongodbV2

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceMongodbV2ConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourceMongodbV2

func GetSourceMongodbV2(ctx *Context, name string, id IDInput, state *SourceMongodbV2State, opts ...ResourceOption) (*SourceMongodbV2, error)

public static SourceMongodbV2 Get(string name, Input<string> id, SourceMongodbV2State? state, CustomResourceOptions? opts = null)

public static SourceMongodbV2 get(String name, Output<String> id, SourceMongodbV2State state, CustomResourceOptions options)

resources:  _:    type: airbyte:SourceMongodbV2    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Configuration SourceMongodbV2Configuration
CreatedAt double
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string

Configuration SourceMongodbV2ConfigurationArgs
CreatedAt float64
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string

configuration SourceMongodbV2Configuration
createdAt Double
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

configuration SourceMongodbV2Configuration
createdAt number
definitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name string: Name of the source e.g. dev-mysql-instance.
secretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId string
sourceType string
workspaceId string

configuration SourceMongodbV2ConfigurationArgs
created_at float
definition_id str: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name str: Name of the source e.g. dev-mysql-instance.
secret_id str: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
source_id str
source_type str
workspace_id str

configuration Property Map
createdAt Number
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

Supporting Types

SourceMongodbV2Configuration, SourceMongodbV2ConfigurationArgs

DatabaseConfig SourceMongodbV2ConfigurationDatabaseConfig: Configures the MongoDB cluster type.
DiscoverSampleSize double: The maximum number of documents to sample when attempting to discover the unique fields for a collection. Default: 10000
InitialLoadTimeoutHours double: The amount of time an initial load is allowed to continue for before catching up on CDC logs. Default: 8
InitialWaitingSeconds double: The amount of time the connector will wait when it launches to determine if there is new data to sync or not. Defaults to 300 seconds. Valid range: 120 seconds to 1200 seconds. Default: 300
InvalidCdcCursorPositionBehavior string: Determines whether Airbyte should fail or re-sync data in case of an stale/invalid cursor value into the WAL. If 'Fail sync' is chosen, a user will have to manually reset the connection before being able to continue syncing data. If 'Re-sync data' is chosen, Airbyte will automatically trigger a refresh but could lead to higher cloud costs and data loss. Default: "Fail sync"; must be one of ["Fail sync", "Re-sync data"]
QueueSize double: The size of the internal queue. This may interfere with memory consumption and efficiency of the connector, please be careful. Default: 10000
UpdateCaptureMode string: Determines how Airbyte looks up the value of an updated document. If 'Lookup' is chosen, the current value of the document will be read. If 'Post Image' is chosen, then the version of the document immediately after an update will be read. WARNING : Severe data loss will occur if this option is chosen and the appropriate settings are not set on your Mongo instance : https://www.mongodb.com/docs/manual/changeStreams/#change-streams-with-document-pre-and-post-images. Default: "Lookup"; must be one of ["Lookup", "Post Image"]

DatabaseConfig SourceMongodbV2ConfigurationDatabaseConfig: Configures the MongoDB cluster type.
DiscoverSampleSize float64: The maximum number of documents to sample when attempting to discover the unique fields for a collection. Default: 10000
InitialLoadTimeoutHours float64: The amount of time an initial load is allowed to continue for before catching up on CDC logs. Default: 8
InitialWaitingSeconds float64: The amount of time the connector will wait when it launches to determine if there is new data to sync or not. Defaults to 300 seconds. Valid range: 120 seconds to 1200 seconds. Default: 300
InvalidCdcCursorPositionBehavior string: Determines whether Airbyte should fail or re-sync data in case of an stale/invalid cursor value into the WAL. If 'Fail sync' is chosen, a user will have to manually reset the connection before being able to continue syncing data. If 'Re-sync data' is chosen, Airbyte will automatically trigger a refresh but could lead to higher cloud costs and data loss. Default: "Fail sync"; must be one of ["Fail sync", "Re-sync data"]
QueueSize float64: The size of the internal queue. This may interfere with memory consumption and efficiency of the connector, please be careful. Default: 10000
UpdateCaptureMode string: Determines how Airbyte looks up the value of an updated document. If 'Lookup' is chosen, the current value of the document will be read. If 'Post Image' is chosen, then the version of the document immediately after an update will be read. WARNING : Severe data loss will occur if this option is chosen and the appropriate settings are not set on your Mongo instance : https://www.mongodb.com/docs/manual/changeStreams/#change-streams-with-document-pre-and-post-images. Default: "Lookup"; must be one of ["Lookup", "Post Image"]

databaseConfig SourceMongodbV2ConfigurationDatabaseConfig: Configures the MongoDB cluster type.
discoverSampleSize Double: The maximum number of documents to sample when attempting to discover the unique fields for a collection. Default: 10000
initialLoadTimeoutHours Double: The amount of time an initial load is allowed to continue for before catching up on CDC logs. Default: 8
initialWaitingSeconds Double: The amount of time the connector will wait when it launches to determine if there is new data to sync or not. Defaults to 300 seconds. Valid range: 120 seconds to 1200 seconds. Default: 300
invalidCdcCursorPositionBehavior String: Determines whether Airbyte should fail or re-sync data in case of an stale/invalid cursor value into the WAL. If 'Fail sync' is chosen, a user will have to manually reset the connection before being able to continue syncing data. If 'Re-sync data' is chosen, Airbyte will automatically trigger a refresh but could lead to higher cloud costs and data loss. Default: "Fail sync"; must be one of ["Fail sync", "Re-sync data"]
queueSize Double: The size of the internal queue. This may interfere with memory consumption and efficiency of the connector, please be careful. Default: 10000
updateCaptureMode String: Determines how Airbyte looks up the value of an updated document. If 'Lookup' is chosen, the current value of the document will be read. If 'Post Image' is chosen, then the version of the document immediately after an update will be read. WARNING : Severe data loss will occur if this option is chosen and the appropriate settings are not set on your Mongo instance : https://www.mongodb.com/docs/manual/changeStreams/#change-streams-with-document-pre-and-post-images. Default: "Lookup"; must be one of ["Lookup", "Post Image"]

databaseConfig SourceMongodbV2ConfigurationDatabaseConfig: Configures the MongoDB cluster type.
discoverSampleSize number: The maximum number of documents to sample when attempting to discover the unique fields for a collection. Default: 10000
initialLoadTimeoutHours number: The amount of time an initial load is allowed to continue for before catching up on CDC logs. Default: 8
initialWaitingSeconds number: The amount of time the connector will wait when it launches to determine if there is new data to sync or not. Defaults to 300 seconds. Valid range: 120 seconds to 1200 seconds. Default: 300
invalidCdcCursorPositionBehavior string: Determines whether Airbyte should fail or re-sync data in case of an stale/invalid cursor value into the WAL. If 'Fail sync' is chosen, a user will have to manually reset the connection before being able to continue syncing data. If 'Re-sync data' is chosen, Airbyte will automatically trigger a refresh but could lead to higher cloud costs and data loss. Default: "Fail sync"; must be one of ["Fail sync", "Re-sync data"]
queueSize number: The size of the internal queue. This may interfere with memory consumption and efficiency of the connector, please be careful. Default: 10000
updateCaptureMode string: Determines how Airbyte looks up the value of an updated document. If 'Lookup' is chosen, the current value of the document will be read. If 'Post Image' is chosen, then the version of the document immediately after an update will be read. WARNING : Severe data loss will occur if this option is chosen and the appropriate settings are not set on your Mongo instance : https://www.mongodb.com/docs/manual/changeStreams/#change-streams-with-document-pre-and-post-images. Default: "Lookup"; must be one of ["Lookup", "Post Image"]

database_config SourceMongodbV2ConfigurationDatabaseConfig: Configures the MongoDB cluster type.
discover_sample_size float: The maximum number of documents to sample when attempting to discover the unique fields for a collection. Default: 10000
initial_load_timeout_hours float: The amount of time an initial load is allowed to continue for before catching up on CDC logs. Default: 8
initial_waiting_seconds float: The amount of time the connector will wait when it launches to determine if there is new data to sync or not. Defaults to 300 seconds. Valid range: 120 seconds to 1200 seconds. Default: 300
invalid_cdc_cursor_position_behavior str: Determines whether Airbyte should fail or re-sync data in case of an stale/invalid cursor value into the WAL. If 'Fail sync' is chosen, a user will have to manually reset the connection before being able to continue syncing data. If 'Re-sync data' is chosen, Airbyte will automatically trigger a refresh but could lead to higher cloud costs and data loss. Default: "Fail sync"; must be one of ["Fail sync", "Re-sync data"]
queue_size float: The size of the internal queue. This may interfere with memory consumption and efficiency of the connector, please be careful. Default: 10000
update_capture_mode str: Determines how Airbyte looks up the value of an updated document. If 'Lookup' is chosen, the current value of the document will be read. If 'Post Image' is chosen, then the version of the document immediately after an update will be read. WARNING : Severe data loss will occur if this option is chosen and the appropriate settings are not set on your Mongo instance : https://www.mongodb.com/docs/manual/changeStreams/#change-streams-with-document-pre-and-post-images. Default: "Lookup"; must be one of ["Lookup", "Post Image"]

databaseConfig Property Map: Configures the MongoDB cluster type.
discoverSampleSize Number: The maximum number of documents to sample when attempting to discover the unique fields for a collection. Default: 10000
initialLoadTimeoutHours Number: The amount of time an initial load is allowed to continue for before catching up on CDC logs. Default: 8
initialWaitingSeconds Number: The amount of time the connector will wait when it launches to determine if there is new data to sync or not. Defaults to 300 seconds. Valid range: 120 seconds to 1200 seconds. Default: 300
invalidCdcCursorPositionBehavior String: Determines whether Airbyte should fail or re-sync data in case of an stale/invalid cursor value into the WAL. If 'Fail sync' is chosen, a user will have to manually reset the connection before being able to continue syncing data. If 'Re-sync data' is chosen, Airbyte will automatically trigger a refresh but could lead to higher cloud costs and data loss. Default: "Fail sync"; must be one of ["Fail sync", "Re-sync data"]
queueSize Number: The size of the internal queue. This may interfere with memory consumption and efficiency of the connector, please be careful. Default: 10000
updateCaptureMode String: Determines how Airbyte looks up the value of an updated document. If 'Lookup' is chosen, the current value of the document will be read. If 'Post Image' is chosen, then the version of the document immediately after an update will be read. WARNING : Severe data loss will occur if this option is chosen and the appropriate settings are not set on your Mongo instance : https://www.mongodb.com/docs/manual/changeStreams/#change-streams-with-document-pre-and-post-images. Default: "Lookup"; must be one of ["Lookup", "Post Image"]

SourceMongodbV2ConfigurationDatabaseConfig, SourceMongodbV2ConfigurationDatabaseConfigArgs

MongoDbAtlasReplicaSet SourceMongodbV2ConfigurationDatabaseConfigMongoDbAtlasReplicaSet: MongoDB Atlas-hosted cluster configured as a replica set
SelfManagedReplicaSet SourceMongodbV2ConfigurationDatabaseConfigSelfManagedReplicaSet: MongoDB self-hosted cluster configured as a replica set

MongoDbAtlasReplicaSet SourceMongodbV2ConfigurationDatabaseConfigMongoDbAtlasReplicaSet: MongoDB Atlas-hosted cluster configured as a replica set
SelfManagedReplicaSet SourceMongodbV2ConfigurationDatabaseConfigSelfManagedReplicaSet: MongoDB self-hosted cluster configured as a replica set

mongoDbAtlasReplicaSet SourceMongodbV2ConfigurationDatabaseConfigMongoDbAtlasReplicaSet: MongoDB Atlas-hosted cluster configured as a replica set
selfManagedReplicaSet SourceMongodbV2ConfigurationDatabaseConfigSelfManagedReplicaSet: MongoDB self-hosted cluster configured as a replica set

mongoDbAtlasReplicaSet SourceMongodbV2ConfigurationDatabaseConfigMongoDbAtlasReplicaSet: MongoDB Atlas-hosted cluster configured as a replica set
selfManagedReplicaSet SourceMongodbV2ConfigurationDatabaseConfigSelfManagedReplicaSet: MongoDB self-hosted cluster configured as a replica set

mongo_db_atlas_replica_set SourceMongodbV2ConfigurationDatabaseConfigMongoDbAtlasReplicaSet: MongoDB Atlas-hosted cluster configured as a replica set
self_managed_replica_set SourceMongodbV2ConfigurationDatabaseConfigSelfManagedReplicaSet: MongoDB self-hosted cluster configured as a replica set

mongoDbAtlasReplicaSet Property Map: MongoDB Atlas-hosted cluster configured as a replica set
selfManagedReplicaSet Property Map: MongoDB self-hosted cluster configured as a replica set

SourceMongodbV2ConfigurationDatabaseConfigMongoDbAtlasReplicaSet, SourceMongodbV2ConfigurationDatabaseConfigMongoDbAtlasReplicaSetArgs

ConnectionString string: The connection string of the cluster that you want to replicate.
Database string: The name of the MongoDB database that contains the collection(s) to replicate.
Password string: The password associated with this username.
Username string: The username which is used to access the database.
AdditionalProperties string: Parsed as JSON.
AuthSource string: The authentication source where the user information is stored. See https://www.mongodb.com/docs/manual/reference/connection-string/#mongodb-urioption-urioption.authSource for more details. Default: "admin"
SchemaEnforced bool: When enabled, syncs will validate and structure records against the stream's schema. Default: true

ConnectionString string: The connection string of the cluster that you want to replicate.
Database string: The name of the MongoDB database that contains the collection(s) to replicate.
Password string: The password associated with this username.
Username string: The username which is used to access the database.
AdditionalProperties string: Parsed as JSON.
AuthSource string: The authentication source where the user information is stored. See https://www.mongodb.com/docs/manual/reference/connection-string/#mongodb-urioption-urioption.authSource for more details. Default: "admin"
SchemaEnforced bool: When enabled, syncs will validate and structure records against the stream's schema. Default: true

connectionString String: The connection string of the cluster that you want to replicate.
database String: The name of the MongoDB database that contains the collection(s) to replicate.
password String: The password associated with this username.
username String: The username which is used to access the database.
additionalProperties String: Parsed as JSON.
authSource String: The authentication source where the user information is stored. See https://www.mongodb.com/docs/manual/reference/connection-string/#mongodb-urioption-urioption.authSource for more details. Default: "admin"
schemaEnforced Boolean: When enabled, syncs will validate and structure records against the stream's schema. Default: true

connectionString string: The connection string of the cluster that you want to replicate.
database string: The name of the MongoDB database that contains the collection(s) to replicate.
password string: The password associated with this username.
username string: The username which is used to access the database.
additionalProperties string: Parsed as JSON.
authSource string: The authentication source where the user information is stored. See https://www.mongodb.com/docs/manual/reference/connection-string/#mongodb-urioption-urioption.authSource for more details. Default: "admin"
schemaEnforced boolean: When enabled, syncs will validate and structure records against the stream's schema. Default: true

connection_string str: The connection string of the cluster that you want to replicate.
database str: The name of the MongoDB database that contains the collection(s) to replicate.
password str: The password associated with this username.
username str: The username which is used to access the database.
additional_properties str: Parsed as JSON.
auth_source str: The authentication source where the user information is stored. See https://www.mongodb.com/docs/manual/reference/connection-string/#mongodb-urioption-urioption.authSource for more details. Default: "admin"
schema_enforced bool: When enabled, syncs will validate and structure records against the stream's schema. Default: true

connectionString String: The connection string of the cluster that you want to replicate.
database String: The name of the MongoDB database that contains the collection(s) to replicate.
password String: The password associated with this username.
username String: The username which is used to access the database.
additionalProperties String: Parsed as JSON.
authSource String: The authentication source where the user information is stored. See https://www.mongodb.com/docs/manual/reference/connection-string/#mongodb-urioption-urioption.authSource for more details. Default: "admin"
schemaEnforced Boolean: When enabled, syncs will validate and structure records against the stream's schema. Default: true

SourceMongodbV2ConfigurationDatabaseConfigSelfManagedReplicaSet, SourceMongodbV2ConfigurationDatabaseConfigSelfManagedReplicaSetArgs

ConnectionString string: The connection string of the cluster that you want to replicate. https://www.mongodb.com/docs/manual/reference/connection-string/#find-your-self-hosted-deployment-s-connection-string for more information.
Database string: The name of the MongoDB database that contains the collection(s) to replicate.
AdditionalProperties string: Parsed as JSON.
AuthSource string: The authentication source where the user information is stored. Default: "admin"
Password string: The password associated with this username.
SchemaEnforced bool: When enabled, syncs will validate and structure records against the stream's schema. Default: true
Username string: The username which is used to access the database.

ConnectionString string: The connection string of the cluster that you want to replicate. https://www.mongodb.com/docs/manual/reference/connection-string/#find-your-self-hosted-deployment-s-connection-string for more information.
Database string: The name of the MongoDB database that contains the collection(s) to replicate.
AdditionalProperties string: Parsed as JSON.
AuthSource string: The authentication source where the user information is stored. Default: "admin"
Password string: The password associated with this username.
SchemaEnforced bool: When enabled, syncs will validate and structure records against the stream's schema. Default: true
Username string: The username which is used to access the database.

connectionString String: The connection string of the cluster that you want to replicate. https://www.mongodb.com/docs/manual/reference/connection-string/#find-your-self-hosted-deployment-s-connection-string for more information.
database String: The name of the MongoDB database that contains the collection(s) to replicate.
additionalProperties String: Parsed as JSON.
authSource String: The authentication source where the user information is stored. Default: "admin"
password String: The password associated with this username.
schemaEnforced Boolean: When enabled, syncs will validate and structure records against the stream's schema. Default: true
username String: The username which is used to access the database.

connectionString string: The connection string of the cluster that you want to replicate. https://www.mongodb.com/docs/manual/reference/connection-string/#find-your-self-hosted-deployment-s-connection-string for more information.
database string: The name of the MongoDB database that contains the collection(s) to replicate.
additionalProperties string: Parsed as JSON.
authSource string: The authentication source where the user information is stored. Default: "admin"
password string: The password associated with this username.
schemaEnforced boolean: When enabled, syncs will validate and structure records against the stream's schema. Default: true
username string: The username which is used to access the database.

connection_string str: The connection string of the cluster that you want to replicate. https://www.mongodb.com/docs/manual/reference/connection-string/#find-your-self-hosted-deployment-s-connection-string for more information.
database str: The name of the MongoDB database that contains the collection(s) to replicate.
additional_properties str: Parsed as JSON.
auth_source str: The authentication source where the user information is stored. Default: "admin"
password str: The password associated with this username.
schema_enforced bool: When enabled, syncs will validate and structure records against the stream's schema. Default: true
username str: The username which is used to access the database.

connectionString String: The connection string of the cluster that you want to replicate. https://www.mongodb.com/docs/manual/reference/connection-string/#find-your-self-hosted-deployment-s-connection-string for more information.
database String: The name of the MongoDB database that contains the collection(s) to replicate.
additionalProperties String: Parsed as JSON.
authSource String: The authentication source where the user information is stored. Default: "admin"
password String: The password associated with this username.
schemaEnforced Boolean: When enabled, syncs will validate and structure records against the stream's schema. Default: true
username String: The username which is used to access the database.

Import

$ pulumi import airbyte:index/sourceMongodbV2:SourceMongodbV2 my_airbyte_source_mongodb_v2 ""

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: airbyte airbytehq/terraform-provider-airbyte
License
Notes: This Pulumi package is based on the airbyte Terraform Provider.

airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

airbytehq/terraform-provider-airbyte

airbyte.SourceMongodbV2

On this page

On this page

Example Usage

Create SourceMongodbV2 Resource

Constructor syntax

Parameters

Constructor example

SourceMongodbV2 Resource Properties

Inputs

Outputs

Look up Existing SourceMongodbV2 Resource

Supporting Types

SourceMongodbV2Configuration, SourceMongodbV2ConfigurationArgs

SourceMongodbV2ConfigurationDatabaseConfig, SourceMongodbV2ConfigurationDatabaseConfigArgs

SourceMongodbV2ConfigurationDatabaseConfigMongoDbAtlasReplicaSet, SourceMongodbV2ConfigurationDatabaseConfigMongoDbAtlasReplicaSetArgs

SourceMongodbV2ConfigurationDatabaseConfigSelfManagedReplicaSet, SourceMongodbV2ConfigurationDatabaseConfigSelfManagedReplicaSetArgs

Import

Package Details

On this page

On this page