airbyte 0.8.0-beta2, Mar 27 25

airbyte 0.8.0-beta2 published on Thursday, Mar 27, 2025 by airbytehq

airbyte.DestinationMongodb

Explore with Pulumi AI

airbyte 0.8.0-beta2 published on Thursday, Mar 27, 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.DestinationMongodb;
import com.pulumi.airbyte.DestinationMongodbArgs;
import com.pulumi.airbyte.inputs.DestinationMongodbConfigurationArgs;
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 myDestinationMongodb = new DestinationMongodb("myDestinationMongodb", DestinationMongodbArgs.builder()
            .configuration(DestinationMongodbConfigurationArgs.builder()
                .auth_type(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .database("...my_database...")
                .instance_type(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .tunnel_method(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .build())
            .definitionId("ecb670c3-9030-4c95-a447-d69ea2c1371e")
            .workspaceId("63ac2b57-1c99-4294-8b40-d92cdc44ffaf")
            .build());

    }
}

resources:
  myDestinationMongodb:
    type: airbyte:DestinationMongodb
    properties:
      configuration:
        auth_type:
          none: {}
        database: '...my_database...'
        instance_type:
          mongoDbAtlas:
            clusterUrl: '...my_cluster_url...'
            instance: atlas
        tunnel_method:
          passwordAuthentication:
            tunnelHost: '...my_tunnel_host...'
            tunnelPort: 22
            tunnelUser: '...my_tunnel_user...'
            tunnelUserPassword: '...my_tunnel_user_password...'
      definitionId: ecb670c3-9030-4c95-a447-d69ea2c1371e
      workspaceId: 63ac2b57-1c99-4294-8b40-d92cdc44ffaf

Create DestinationMongodb Resource

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

Constructor syntax

new DestinationMongodb(name: string, args: DestinationMongodbArgs, opts?: CustomResourceOptions);

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

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

func NewDestinationMongodb(ctx *Context, name string, args DestinationMongodbArgs, opts ...ResourceOption) (*DestinationMongodb, error)

public DestinationMongodb(string name, DestinationMongodbArgs args, CustomResourceOptions? opts = null)

public DestinationMongodb(String name, DestinationMongodbArgs args)
public DestinationMongodb(String name, DestinationMongodbArgs args, CustomResourceOptions options)

type: airbyte:DestinationMongodb
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 DestinationMongodbArgs: 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 DestinationMongodbArgs: 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 DestinationMongodbArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args DestinationMongodbArgs: 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 destinationMongodbResource = new Airbyte.DestinationMongodb("destinationMongodbResource", new()
{
    Configuration = new Airbyte.Inputs.DestinationMongodbConfigurationArgs
    {
        AuthType = new Airbyte.Inputs.DestinationMongodbConfigurationAuthTypeArgs
        {
            LoginPassword = new Airbyte.Inputs.DestinationMongodbConfigurationAuthTypeLoginPasswordArgs
            {
                Password = "string",
                Username = "string",
            },
            None = null,
        },
        Database = "string",
        InstanceType = new Airbyte.Inputs.DestinationMongodbConfigurationInstanceTypeArgs
        {
            MongoDbAtlas = new Airbyte.Inputs.DestinationMongodbConfigurationInstanceTypeMongoDbAtlasArgs
            {
                ClusterUrl = "string",
                Instance = "string",
            },
            ReplicaSet = new Airbyte.Inputs.DestinationMongodbConfigurationInstanceTypeReplicaSetArgs
            {
                ServerAddresses = "string",
                Instance = "string",
                ReplicaSet = "string",
            },
            StandaloneMongoDbInstance = new Airbyte.Inputs.DestinationMongodbConfigurationInstanceTypeStandaloneMongoDbInstanceArgs
            {
                Host = "string",
                Instance = "string",
                Port = 0,
                Tls = false,
            },
        },
        TunnelMethod = new Airbyte.Inputs.DestinationMongodbConfigurationTunnelMethodArgs
        {
            NoTunnel = null,
            PasswordAuthentication = new Airbyte.Inputs.DestinationMongodbConfigurationTunnelMethodPasswordAuthenticationArgs
            {
                TunnelHost = "string",
                TunnelUser = "string",
                TunnelUserPassword = "string",
                TunnelPort = 0,
            },
            SshKeyAuthentication = new Airbyte.Inputs.DestinationMongodbConfigurationTunnelMethodSshKeyAuthenticationArgs
            {
                SshKey = "string",
                TunnelHost = "string",
                TunnelUser = "string",
                TunnelPort = 0,
            },
        },
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
});

example, err := airbyte.NewDestinationMongodb(ctx, "destinationMongodbResource", &airbyte.DestinationMongodbArgs{
Configuration: &.DestinationMongodbConfigurationArgs{
AuthType: &.DestinationMongodbConfigurationAuthTypeArgs{
LoginPassword: &.DestinationMongodbConfigurationAuthTypeLoginPasswordArgs{
Password: pulumi.String("string"),
Username: pulumi.String("string"),
},
None: &.DestinationMongodbConfigurationAuthTypeNoneArgs{
},
},
Database: pulumi.String("string"),
InstanceType: &.DestinationMongodbConfigurationInstanceTypeArgs{
MongoDbAtlas: &.DestinationMongodbConfigurationInstanceTypeMongoDbAtlasArgs{
ClusterUrl: pulumi.String("string"),
Instance: pulumi.String("string"),
},
ReplicaSet: &.DestinationMongodbConfigurationInstanceTypeReplicaSetArgs{
ServerAddresses: pulumi.String("string"),
Instance: pulumi.String("string"),
ReplicaSet: pulumi.String("string"),
},
StandaloneMongoDbInstance: &.DestinationMongodbConfigurationInstanceTypeStandaloneMongoDbInstanceArgs{
Host: pulumi.String("string"),
Instance: pulumi.String("string"),
Port: pulumi.Float64(0),
Tls: pulumi.Bool(false),
},
},
TunnelMethod: &.DestinationMongodbConfigurationTunnelMethodArgs{
NoTunnel: &.DestinationMongodbConfigurationTunnelMethodNoTunnelArgs{
},
PasswordAuthentication: &.DestinationMongodbConfigurationTunnelMethodPasswordAuthenticationArgs{
TunnelHost: pulumi.String("string"),
TunnelUser: pulumi.String("string"),
TunnelUserPassword: pulumi.String("string"),
TunnelPort: pulumi.Float64(0),
},
SshKeyAuthentication: &.DestinationMongodbConfigurationTunnelMethodSshKeyAuthenticationArgs{
SshKey: pulumi.String("string"),
TunnelHost: pulumi.String("string"),
TunnelUser: pulumi.String("string"),
TunnelPort: pulumi.Float64(0),
},
},
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
})

var destinationMongodbResource = new DestinationMongodb("destinationMongodbResource", DestinationMongodbArgs.builder()
    .configuration(DestinationMongodbConfigurationArgs.builder()
        .authType(DestinationMongodbConfigurationAuthTypeArgs.builder()
            .loginPassword(DestinationMongodbConfigurationAuthTypeLoginPasswordArgs.builder()
                .password("string")
                .username("string")
                .build())
            .none()
            .build())
        .database("string")
        .instanceType(DestinationMongodbConfigurationInstanceTypeArgs.builder()
            .mongoDbAtlas(DestinationMongodbConfigurationInstanceTypeMongoDbAtlasArgs.builder()
                .clusterUrl("string")
                .instance("string")
                .build())
            .replicaSet(DestinationMongodbConfigurationInstanceTypeReplicaSetArgs.builder()
                .serverAddresses("string")
                .instance("string")
                .replicaSet("string")
                .build())
            .standaloneMongoDbInstance(DestinationMongodbConfigurationInstanceTypeStandaloneMongoDbInstanceArgs.builder()
                .host("string")
                .instance("string")
                .port(0)
                .tls(false)
                .build())
            .build())
        .tunnelMethod(DestinationMongodbConfigurationTunnelMethodArgs.builder()
            .noTunnel()
            .passwordAuthentication(DestinationMongodbConfigurationTunnelMethodPasswordAuthenticationArgs.builder()
                .tunnelHost("string")
                .tunnelUser("string")
                .tunnelUserPassword("string")
                .tunnelPort(0)
                .build())
            .sshKeyAuthentication(DestinationMongodbConfigurationTunnelMethodSshKeyAuthenticationArgs.builder()
                .sshKey("string")
                .tunnelHost("string")
                .tunnelUser("string")
                .tunnelPort(0)
                .build())
            .build())
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .build());

destination_mongodb_resource = airbyte.DestinationMongodb("destinationMongodbResource",
    configuration={
        "auth_type": {
            "login_password": {
                "password": "string",
                "username": "string",
            },
            "none": {},
        },
        "database": "string",
        "instance_type": {
            "mongo_db_atlas": {
                "cluster_url": "string",
                "instance": "string",
            },
            "replica_set": {
                "server_addresses": "string",
                "instance": "string",
                "replica_set": "string",
            },
            "standalone_mongo_db_instance": {
                "host": "string",
                "instance": "string",
                "port": 0,
                "tls": False,
            },
        },
        "tunnel_method": {
            "no_tunnel": {},
            "password_authentication": {
                "tunnel_host": "string",
                "tunnel_user": "string",
                "tunnel_user_password": "string",
                "tunnel_port": 0,
            },
            "ssh_key_authentication": {
                "ssh_key": "string",
                "tunnel_host": "string",
                "tunnel_user": "string",
                "tunnel_port": 0,
            },
        },
    },
    workspace_id="string",
    definition_id="string",
    name="string")

const destinationMongodbResource = new airbyte.DestinationMongodb("destinationMongodbResource", {
    configuration: {
        authType: {
            loginPassword: {
                password: "string",
                username: "string",
            },
            none: {},
        },
        database: "string",
        instanceType: {
            mongoDbAtlas: {
                clusterUrl: "string",
                instance: "string",
            },
            replicaSet: {
                serverAddresses: "string",
                instance: "string",
                replicaSet: "string",
            },
            standaloneMongoDbInstance: {
                host: "string",
                instance: "string",
                port: 0,
                tls: false,
            },
        },
        tunnelMethod: {
            noTunnel: {},
            passwordAuthentication: {
                tunnelHost: "string",
                tunnelUser: "string",
                tunnelUserPassword: "string",
                tunnelPort: 0,
            },
            sshKeyAuthentication: {
                sshKey: "string",
                tunnelHost: "string",
                tunnelUser: "string",
                tunnelPort: 0,
            },
        },
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
});

type: airbyte:DestinationMongodb
properties:
    configuration:
        authType:
            loginPassword:
                password: string
                username: string
            none: {}
        database: string
        instanceType:
            mongoDbAtlas:
                clusterUrl: string
                instance: string
            replicaSet:
                instance: string
                replicaSet: string
                serverAddresses: string
            standaloneMongoDbInstance:
                host: string
                instance: string
                port: 0
                tls: false
        tunnelMethod:
            noTunnel: {}
            passwordAuthentication:
                tunnelHost: string
                tunnelPort: 0
                tunnelUser: string
                tunnelUserPassword: string
            sshKeyAuthentication:
                sshKey: string
                tunnelHost: string
                tunnelPort: 0
                tunnelUser: string
    definitionId: string
    name: string
    workspaceId: string

DestinationMongodb 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 DestinationMongodb resource accepts the following input properties:

Configuration DestinationMongodbConfiguration
WorkspaceId string
DefinitionId string: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the destination e.g. dev-mysql-instance.

Configuration DestinationMongodbConfigurationArgs
WorkspaceId string
DefinitionId string: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the destination e.g. dev-mysql-instance.

configuration DestinationMongodbConfiguration
workspaceId String
definitionId String: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
name String: Name of the destination e.g. dev-mysql-instance.

configuration DestinationMongodbConfiguration
workspaceId string
definitionId string: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
name string: Name of the destination e.g. dev-mysql-instance.

configuration DestinationMongodbConfigurationArgs
workspace_id str
definition_id str: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
name str: Name of the destination e.g. dev-mysql-instance.

configuration Property Map
workspaceId String
definitionId String: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
name String: Name of the destination e.g. dev-mysql-instance.

Outputs

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

CreatedAt double
DestinationId string
DestinationType string
Id string: The provider-assigned unique ID for this managed resource.
ResourceAllocation DestinationMongodbResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.

CreatedAt float64
DestinationId string
DestinationType string
Id string: The provider-assigned unique ID for this managed resource.
ResourceAllocation DestinationMongodbResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.

createdAt Double
destinationId String
destinationType String
id String: The provider-assigned unique ID for this managed resource.
resourceAllocation DestinationMongodbResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.

createdAt number
destinationId string
destinationType string
id string: The provider-assigned unique ID for this managed resource.
resourceAllocation DestinationMongodbResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.

created_at float
destination_id str
destination_type str
id str: The provider-assigned unique ID for this managed resource.
resource_allocation DestinationMongodbResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.

createdAt Number
destinationId String
destinationType String
id String: The provider-assigned unique ID for this managed resource.
resourceAllocation Property Map: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.

Look up Existing DestinationMongodb Resource

Get an existing DestinationMongodb 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?: DestinationMongodbState, opts?: CustomResourceOptions): DestinationMongodb

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[DestinationMongodbConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        destination_id: Optional[str] = None,
        destination_type: Optional[str] = None,
        name: Optional[str] = None,
        resource_allocation: Optional[DestinationMongodbResourceAllocationArgs] = None,
        workspace_id: Optional[str] = None) -> DestinationMongodb

func GetDestinationMongodb(ctx *Context, name string, id IDInput, state *DestinationMongodbState, opts ...ResourceOption) (*DestinationMongodb, error)

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

public static DestinationMongodb get(String name, Output<String> id, DestinationMongodbState state, CustomResourceOptions options)

resources:  _:    type: airbyte:DestinationMongodb    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 DestinationMongodbConfiguration
CreatedAt double
DefinitionId string: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
DestinationId string
DestinationType string
Name string: Name of the destination e.g. dev-mysql-instance.
ResourceAllocation DestinationMongodbResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
WorkspaceId string

Configuration DestinationMongodbConfigurationArgs
CreatedAt float64
DefinitionId string: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
DestinationId string
DestinationType string
Name string: Name of the destination e.g. dev-mysql-instance.
ResourceAllocation DestinationMongodbResourceAllocationArgs: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
WorkspaceId string

configuration DestinationMongodbConfiguration
createdAt Double
definitionId String: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
destinationId String
destinationType String
name String: Name of the destination e.g. dev-mysql-instance.
resourceAllocation DestinationMongodbResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
workspaceId String

configuration DestinationMongodbConfiguration
createdAt number
definitionId string: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
destinationId string
destinationType string
name string: Name of the destination e.g. dev-mysql-instance.
resourceAllocation DestinationMongodbResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
workspaceId string

configuration DestinationMongodbConfigurationArgs
created_at float
definition_id str: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
destination_id str
destination_type str
name str: Name of the destination e.g. dev-mysql-instance.
resource_allocation DestinationMongodbResourceAllocationArgs: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
workspace_id str

configuration Property Map
createdAt Number
definitionId String: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
destinationId String
destinationType String
name String: Name of the destination e.g. dev-mysql-instance.
resourceAllocation Property Map: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
workspaceId String

Supporting Types

DestinationMongodbConfiguration, DestinationMongodbConfigurationArgs

AuthType DestinationMongodbConfigurationAuthType: Authorization type.
Database string: Name of the database.
InstanceType DestinationMongodbConfigurationInstanceType: MongoDb instance to connect to. For MongoDB Atlas and Replica Set TLS connection is used by default.
TunnelMethod DestinationMongodbConfigurationTunnelMethod: Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.

AuthType DestinationMongodbConfigurationAuthType: Authorization type.
Database string: Name of the database.
InstanceType DestinationMongodbConfigurationInstanceType: MongoDb instance to connect to. For MongoDB Atlas and Replica Set TLS connection is used by default.
TunnelMethod DestinationMongodbConfigurationTunnelMethod: Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.

authType DestinationMongodbConfigurationAuthType: Authorization type.
database String: Name of the database.
instanceType DestinationMongodbConfigurationInstanceType: MongoDb instance to connect to. For MongoDB Atlas and Replica Set TLS connection is used by default.
tunnelMethod DestinationMongodbConfigurationTunnelMethod: Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.

authType DestinationMongodbConfigurationAuthType: Authorization type.
database string: Name of the database.
instanceType DestinationMongodbConfigurationInstanceType: MongoDb instance to connect to. For MongoDB Atlas and Replica Set TLS connection is used by default.
tunnelMethod DestinationMongodbConfigurationTunnelMethod: Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.

auth_type DestinationMongodbConfigurationAuthType: Authorization type.
database str: Name of the database.
instance_type DestinationMongodbConfigurationInstanceType: MongoDb instance to connect to. For MongoDB Atlas and Replica Set TLS connection is used by default.
tunnel_method DestinationMongodbConfigurationTunnelMethod: Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.

authType Property Map: Authorization type.
database String: Name of the database.
instanceType Property Map: MongoDb instance to connect to. For MongoDB Atlas and Replica Set TLS connection is used by default.
tunnelMethod Property Map: Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.

DestinationMongodbConfigurationAuthType, DestinationMongodbConfigurationAuthTypeArgs

LoginPassword DestinationMongodbConfigurationAuthTypeLoginPassword: Login/Password.
None DestinationMongodbConfigurationAuthTypeNone: None.

LoginPassword DestinationMongodbConfigurationAuthTypeLoginPassword: Login/Password.
None DestinationMongodbConfigurationAuthTypeNone: None.

loginPassword DestinationMongodbConfigurationAuthTypeLoginPassword: Login/Password.
none DestinationMongodbConfigurationAuthTypeNone: None.

loginPassword DestinationMongodbConfigurationAuthTypeLoginPassword: Login/Password.
none DestinationMongodbConfigurationAuthTypeNone: None.

login_password DestinationMongodbConfigurationAuthTypeLoginPassword: Login/Password.
none DestinationMongodbConfigurationAuthTypeNone: None.

loginPassword Property Map: Login/Password.
none Property Map: None.

DestinationMongodbConfigurationAuthTypeLoginPassword, DestinationMongodbConfigurationAuthTypeLoginPasswordArgs

Password string: Password associated with the username.
Username string: Username to use to access the database.

Password string: Password associated with the username.
Username string: Username to use to access the database.

password String: Password associated with the username.
username String: Username to use to access the database.

password string: Password associated with the username.
username string: Username to use to access the database.

password str: Password associated with the username.
username str: Username to use to access the database.

password String: Password associated with the username.
username String: Username to use to access the database.

DestinationMongodbConfigurationInstanceType, DestinationMongodbConfigurationInstanceTypeArgs

MongoDbAtlas DestinationMongodbConfigurationInstanceTypeMongoDbAtlas
ReplicaSet DestinationMongodbConfigurationInstanceTypeReplicaSet
StandaloneMongoDbInstance DestinationMongodbConfigurationInstanceTypeStandaloneMongoDbInstance

MongoDbAtlas DestinationMongodbConfigurationInstanceTypeMongoDbAtlas
ReplicaSet DestinationMongodbConfigurationInstanceTypeReplicaSet
StandaloneMongoDbInstance DestinationMongodbConfigurationInstanceTypeStandaloneMongoDbInstance

mongoDbAtlas DestinationMongodbConfigurationInstanceTypeMongoDbAtlas
replicaSet DestinationMongodbConfigurationInstanceTypeReplicaSet
standaloneMongoDbInstance DestinationMongodbConfigurationInstanceTypeStandaloneMongoDbInstance

mongoDbAtlas DestinationMongodbConfigurationInstanceTypeMongoDbAtlas
replicaSet DestinationMongodbConfigurationInstanceTypeReplicaSet
standaloneMongoDbInstance DestinationMongodbConfigurationInstanceTypeStandaloneMongoDbInstance

mongo_db_atlas DestinationMongodbConfigurationInstanceTypeMongoDbAtlas
replica_set DestinationMongodbConfigurationInstanceTypeReplicaSet
standalone_mongo_db_instance DestinationMongodbConfigurationInstanceTypeStandaloneMongoDbInstance

mongoDbAtlas Property Map
replicaSet Property Map
standaloneMongoDbInstance Property Map

DestinationMongodbConfigurationInstanceTypeMongoDbAtlas, DestinationMongodbConfigurationInstanceTypeMongoDbAtlasArgs

ClusterUrl string: URL of a cluster to connect to.
Instance string: Default: "atlas"; must be "atlas"

ClusterUrl string: URL of a cluster to connect to.
Instance string: Default: "atlas"; must be "atlas"

clusterUrl String: URL of a cluster to connect to.
instance String: Default: "atlas"; must be "atlas"

clusterUrl string: URL of a cluster to connect to.
instance string: Default: "atlas"; must be "atlas"

cluster_url str: URL of a cluster to connect to.
instance str: Default: "atlas"; must be "atlas"

clusterUrl String: URL of a cluster to connect to.
instance String: Default: "atlas"; must be "atlas"

DestinationMongodbConfigurationInstanceTypeReplicaSet, DestinationMongodbConfigurationInstanceTypeReplicaSetArgs

ServerAddresses string: The members of a replica set. Please specify host:port of each member seperated by comma.
Instance string: Default: "replica"; must be "replica"
ReplicaSet string: A replica set name.

ServerAddresses string: The members of a replica set. Please specify host:port of each member seperated by comma.
Instance string: Default: "replica"; must be "replica"
ReplicaSet string: A replica set name.

serverAddresses String: The members of a replica set. Please specify host:port of each member seperated by comma.
instance String: Default: "replica"; must be "replica"
replicaSet String: A replica set name.

serverAddresses string: The members of a replica set. Please specify host:port of each member seperated by comma.
instance string: Default: "replica"; must be "replica"
replicaSet string: A replica set name.

server_addresses str: The members of a replica set. Please specify host:port of each member seperated by comma.
instance str: Default: "replica"; must be "replica"
replica_set str: A replica set name.

serverAddresses String: The members of a replica set. Please specify host:port of each member seperated by comma.
instance String: Default: "replica"; must be "replica"
replicaSet String: A replica set name.

DestinationMongodbConfigurationInstanceTypeStandaloneMongoDbInstance, DestinationMongodbConfigurationInstanceTypeStandaloneMongoDbInstanceArgs

Host string: The Host of a Mongo database to be replicated.
Instance string: Default: "standalone"; must be "standalone"
Port double: The Port of a Mongo database to be replicated. Default: 27017
Tls bool: Indicates whether TLS encryption protocol will be used to connect to MongoDB. It is recommended to use TLS connection if possible. For more information see \n\ndocumentation\n\n. Default: false

Host string: The Host of a Mongo database to be replicated.
Instance string: Default: "standalone"; must be "standalone"
Port float64: The Port of a Mongo database to be replicated. Default: 27017
Tls bool: Indicates whether TLS encryption protocol will be used to connect to MongoDB. It is recommended to use TLS connection if possible. For more information see \n\ndocumentation\n\n. Default: false

host String: The Host of a Mongo database to be replicated.
instance String: Default: "standalone"; must be "standalone"
port Double: The Port of a Mongo database to be replicated. Default: 27017
tls Boolean: Indicates whether TLS encryption protocol will be used to connect to MongoDB. It is recommended to use TLS connection if possible. For more information see \n\ndocumentation\n\n. Default: false

host string: The Host of a Mongo database to be replicated.
instance string: Default: "standalone"; must be "standalone"
port number: The Port of a Mongo database to be replicated. Default: 27017
tls boolean: Indicates whether TLS encryption protocol will be used to connect to MongoDB. It is recommended to use TLS connection if possible. For more information see \n\ndocumentation\n\n. Default: false

host str: The Host of a Mongo database to be replicated.
instance str: Default: "standalone"; must be "standalone"
port float: The Port of a Mongo database to be replicated. Default: 27017
tls bool: Indicates whether TLS encryption protocol will be used to connect to MongoDB. It is recommended to use TLS connection if possible. For more information see \n\ndocumentation\n\n. Default: false

host String: The Host of a Mongo database to be replicated.
instance String: Default: "standalone"; must be "standalone"
port Number: The Port of a Mongo database to be replicated. Default: 27017
tls Boolean: Indicates whether TLS encryption protocol will be used to connect to MongoDB. It is recommended to use TLS connection if possible. For more information see \n\ndocumentation\n\n. Default: false

DestinationMongodbConfigurationTunnelMethod, DestinationMongodbConfigurationTunnelMethodArgs

NoTunnel DestinationMongodbConfigurationTunnelMethodNoTunnel
PasswordAuthentication DestinationMongodbConfigurationTunnelMethodPasswordAuthentication
SshKeyAuthentication DestinationMongodbConfigurationTunnelMethodSshKeyAuthentication

NoTunnel DestinationMongodbConfigurationTunnelMethodNoTunnel
PasswordAuthentication DestinationMongodbConfigurationTunnelMethodPasswordAuthentication
SshKeyAuthentication DestinationMongodbConfigurationTunnelMethodSshKeyAuthentication

noTunnel DestinationMongodbConfigurationTunnelMethodNoTunnel
passwordAuthentication DestinationMongodbConfigurationTunnelMethodPasswordAuthentication
sshKeyAuthentication DestinationMongodbConfigurationTunnelMethodSshKeyAuthentication

noTunnel DestinationMongodbConfigurationTunnelMethodNoTunnel
passwordAuthentication DestinationMongodbConfigurationTunnelMethodPasswordAuthentication
sshKeyAuthentication DestinationMongodbConfigurationTunnelMethodSshKeyAuthentication

no_tunnel DestinationMongodbConfigurationTunnelMethodNoTunnel
password_authentication DestinationMongodbConfigurationTunnelMethodPasswordAuthentication
ssh_key_authentication DestinationMongodbConfigurationTunnelMethodSshKeyAuthentication

noTunnel Property Map
passwordAuthentication Property Map
sshKeyAuthentication Property Map

DestinationMongodbConfigurationTunnelMethodPasswordAuthentication, DestinationMongodbConfigurationTunnelMethodPasswordAuthenticationArgs

TunnelHost string: Hostname of the jump server host that allows inbound ssh tunnel.
TunnelUser string: OS-level username for logging into the jump server host
TunnelUserPassword string: OS-level password for logging into the jump server host
TunnelPort double: Port on the proxy/jump server that accepts inbound ssh connections. Default: 22

TunnelHost string: Hostname of the jump server host that allows inbound ssh tunnel.
TunnelUser string: OS-level username for logging into the jump server host
TunnelUserPassword string: OS-level password for logging into the jump server host
TunnelPort float64: Port on the proxy/jump server that accepts inbound ssh connections. Default: 22

tunnelHost String: Hostname of the jump server host that allows inbound ssh tunnel.
tunnelUser String: OS-level username for logging into the jump server host
tunnelUserPassword String: OS-level password for logging into the jump server host
tunnelPort Double: Port on the proxy/jump server that accepts inbound ssh connections. Default: 22

tunnelHost string: Hostname of the jump server host that allows inbound ssh tunnel.
tunnelUser string: OS-level username for logging into the jump server host
tunnelUserPassword string: OS-level password for logging into the jump server host
tunnelPort number: Port on the proxy/jump server that accepts inbound ssh connections. Default: 22

tunnel_host str: Hostname of the jump server host that allows inbound ssh tunnel.
tunnel_user str: OS-level username for logging into the jump server host
tunnel_user_password str: OS-level password for logging into the jump server host
tunnel_port float: Port on the proxy/jump server that accepts inbound ssh connections. Default: 22

tunnelHost String: Hostname of the jump server host that allows inbound ssh tunnel.
tunnelUser String: OS-level username for logging into the jump server host
tunnelUserPassword String: OS-level password for logging into the jump server host
tunnelPort Number: Port on the proxy/jump server that accepts inbound ssh connections. Default: 22

DestinationMongodbConfigurationTunnelMethodSshKeyAuthentication, DestinationMongodbConfigurationTunnelMethodSshKeyAuthenticationArgs

SshKey string: OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )
TunnelHost string: Hostname of the jump server host that allows inbound ssh tunnel.
TunnelUser string: OS-level username for logging into the jump server host.
TunnelPort double: Port on the proxy/jump server that accepts inbound ssh connections. Default: 22

SshKey string: OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )
TunnelHost string: Hostname of the jump server host that allows inbound ssh tunnel.
TunnelUser string: OS-level username for logging into the jump server host.
TunnelPort float64: Port on the proxy/jump server that accepts inbound ssh connections. Default: 22

sshKey String: OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )
tunnelHost String: Hostname of the jump server host that allows inbound ssh tunnel.
tunnelUser String: OS-level username for logging into the jump server host.
tunnelPort Double: Port on the proxy/jump server that accepts inbound ssh connections. Default: 22

sshKey string: OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )
tunnelHost string: Hostname of the jump server host that allows inbound ssh tunnel.
tunnelUser string: OS-level username for logging into the jump server host.
tunnelPort number: Port on the proxy/jump server that accepts inbound ssh connections. Default: 22

ssh_key str: OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )
tunnel_host str: Hostname of the jump server host that allows inbound ssh tunnel.
tunnel_user str: OS-level username for logging into the jump server host.
tunnel_port float: Port on the proxy/jump server that accepts inbound ssh connections. Default: 22

sshKey String: OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )
tunnelHost String: Hostname of the jump server host that allows inbound ssh tunnel.
tunnelUser String: OS-level username for logging into the jump server host.
tunnelPort Number: Port on the proxy/jump server that accepts inbound ssh connections. Default: 22

DestinationMongodbResourceAllocation, DestinationMongodbResourceAllocationArgs

Default DestinationMongodbResourceAllocationDefault: optional resource requirements to run workers (blank for unbounded allocations)
JobSpecifics List<DestinationMongodbResourceAllocationJobSpecific>

Default DestinationMongodbResourceAllocationDefault: optional resource requirements to run workers (blank for unbounded allocations)
JobSpecifics []DestinationMongodbResourceAllocationJobSpecific

default_ DestinationMongodbResourceAllocationDefault: optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics List<DestinationMongodbResourceAllocationJobSpecific>

default DestinationMongodbResourceAllocationDefault: optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics DestinationMongodbResourceAllocationJobSpecific[]

default DestinationMongodbResourceAllocationDefault: optional resource requirements to run workers (blank for unbounded allocations)
job_specifics Sequence[DestinationMongodbResourceAllocationJobSpecific]

default Property Map: optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics List<Property Map>

DestinationMongodbResourceAllocationDefault, DestinationMongodbResourceAllocationDefaultArgs

CpuLimit string
CpuRequest string
EphemeralStorageLimit string
EphemeralStorageRequest string
MemoryLimit string
MemoryRequest string

CpuLimit string
CpuRequest string
EphemeralStorageLimit string
EphemeralStorageRequest string
MemoryLimit string
MemoryRequest string

cpuLimit String
cpuRequest String
ephemeralStorageLimit String
ephemeralStorageRequest String
memoryLimit String
memoryRequest String

cpuLimit string
cpuRequest string
ephemeralStorageLimit string
ephemeralStorageRequest string
memoryLimit string
memoryRequest string

cpu_limit str
cpu_request str
ephemeral_storage_limit str
ephemeral_storage_request str
memory_limit str
memory_request str

cpuLimit String
cpuRequest String
ephemeralStorageLimit String
ephemeralStorageRequest String
memoryLimit String
memoryRequest String

DestinationMongodbResourceAllocationJobSpecific, DestinationMongodbResourceAllocationJobSpecificArgs

JobType string: enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
ResourceRequirements DestinationMongodbResourceAllocationJobSpecificResourceRequirements: optional resource requirements to run workers (blank for unbounded allocations)

JobType string: enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
ResourceRequirements DestinationMongodbResourceAllocationJobSpecificResourceRequirements: optional resource requirements to run workers (blank for unbounded allocations)

jobType String: enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resourceRequirements DestinationMongodbResourceAllocationJobSpecificResourceRequirements: optional resource requirements to run workers (blank for unbounded allocations)

jobType string: enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resourceRequirements DestinationMongodbResourceAllocationJobSpecificResourceRequirements: optional resource requirements to run workers (blank for unbounded allocations)

job_type str: enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resource_requirements DestinationMongodbResourceAllocationJobSpecificResourceRequirements: optional resource requirements to run workers (blank for unbounded allocations)

jobType String: enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resourceRequirements Property Map: optional resource requirements to run workers (blank for unbounded allocations)

DestinationMongodbResourceAllocationJobSpecificResourceRequirements, DestinationMongodbResourceAllocationJobSpecificResourceRequirementsArgs

CpuLimit string
CpuRequest string
EphemeralStorageLimit string
EphemeralStorageRequest string
MemoryLimit string
MemoryRequest string

CpuLimit string
CpuRequest string
EphemeralStorageLimit string
EphemeralStorageRequest string
MemoryLimit string
MemoryRequest string

cpuLimit String
cpuRequest String
ephemeralStorageLimit String
ephemeralStorageRequest String
memoryLimit String
memoryRequest String

cpuLimit string
cpuRequest string
ephemeralStorageLimit string
ephemeralStorageRequest string
memoryLimit string
memoryRequest string

cpu_limit str
cpu_request str
ephemeral_storage_limit str
ephemeral_storage_request str
memory_limit str
memory_request str

cpuLimit String
cpuRequest String
ephemeralStorageLimit String
ephemeralStorageRequest String
memoryLimit String
memoryRequest String

Import

$ pulumi import airbyte:index/destinationMongodb:DestinationMongodb my_airbyte_destination_mongodb ""

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.8.0-beta2 published on Thursday, Mar 27, 2025 by airbytehq

airbytehq/terraform-provider-airbyte

airbyte.DestinationMongodb

On this page

On this page

Example Usage

Create DestinationMongodb Resource

Constructor syntax

Parameters

Constructor example

DestinationMongodb Resource Properties

Inputs

Outputs

Look up Existing DestinationMongodb Resource

Supporting Types

DestinationMongodbConfiguration, DestinationMongodbConfigurationArgs

DestinationMongodbConfigurationAuthType, DestinationMongodbConfigurationAuthTypeArgs

DestinationMongodbConfigurationAuthTypeLoginPassword, DestinationMongodbConfigurationAuthTypeLoginPasswordArgs

DestinationMongodbConfigurationInstanceType, DestinationMongodbConfigurationInstanceTypeArgs

DestinationMongodbConfigurationInstanceTypeMongoDbAtlas, DestinationMongodbConfigurationInstanceTypeMongoDbAtlasArgs

DestinationMongodbConfigurationInstanceTypeReplicaSet, DestinationMongodbConfigurationInstanceTypeReplicaSetArgs

DestinationMongodbConfigurationInstanceTypeStandaloneMongoDbInstance, DestinationMongodbConfigurationInstanceTypeStandaloneMongoDbInstanceArgs

DestinationMongodbConfigurationTunnelMethod, DestinationMongodbConfigurationTunnelMethodArgs

DestinationMongodbConfigurationTunnelMethodPasswordAuthentication, DestinationMongodbConfigurationTunnelMethodPasswordAuthenticationArgs

DestinationMongodbConfigurationTunnelMethodSshKeyAuthentication, DestinationMongodbConfigurationTunnelMethodSshKeyAuthenticationArgs

DestinationMongodbResourceAllocation, DestinationMongodbResourceAllocationArgs

DestinationMongodbResourceAllocationDefault, DestinationMongodbResourceAllocationDefaultArgs

DestinationMongodbResourceAllocationJobSpecific, DestinationMongodbResourceAllocationJobSpecificArgs

DestinationMongodbResourceAllocationJobSpecificResourceRequirements, DestinationMongodbResourceAllocationJobSpecificResourceRequirementsArgs

Import

Package Details

On this page

On this page