airbyte 0.7.0-beta2, Mar 7 25

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

airbyte.SourceMssql

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.SourceMssql;
import com.pulumi.airbyte.SourceMssqlArgs;
import com.pulumi.airbyte.inputs.SourceMssqlConfigurationArgs;
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 mySourceMssql = new SourceMssql("mySourceMssql", SourceMssqlArgs.builder()
            .configuration(SourceMssqlConfigurationArgs.builder()
                .database("master")
                .host("...my_host...")
                .jdbc_url_params("...my_jdbc_url_params...")
                .password("...my_password...")
                .port(1433)
                .replication_method(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .schemas()
                .ssl_method(%!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))
                .username("...my_username...")
                .build())
            .definitionId("3156776f-a553-4f83-b7be-07e1d515092f")
            .secretId("...my_secret_id...")
            .workspaceId("89a5f137-cba1-4f2e-85cc-db4cd4426082")
            .build());

    }
}

resources:
  mySourceMssql:
    type: airbyte:SourceMssql
    properties:
      configuration:
        database: master
        host: '...my_host...'
        jdbc_url_params: '...my_jdbc_url_params...'
        password: '...my_password...'
        port: 1433
        replication_method:
          readChangesUsingChangeDataCaptureCdc:
            initialLoadTimeoutHours: 4
            initialWaitingSeconds: 0
            invalidCdcCursorPositionBehavior: Re-sync data
            queueSize: 9
          scanChangesWithUserDefinedCursor: {}
        schemas: []
        ssl_method:
          encryptedTrustServerCertificate: {}
          encryptedVerifyCertificate:
            certificate: '...my_certificate...'
            hostNameInCertificate: '...my_host_name_in_certificate...'
          unencrypted: {}
        tunnel_method:
          noTunnel: {}
          passwordAuthentication:
            tunnelHost: '...my_tunnel_host...'
            tunnelPort: 22
            tunnelUser: '...my_tunnel_user...'
            tunnelUserPassword: '...my_tunnel_user_password...'
          sshKeyAuthentication:
            sshKey: '...my_ssh_key...'
            tunnelHost: '...my_tunnel_host...'
            tunnelPort: 22
            tunnelUser: '...my_tunnel_user...'
        username: '...my_username...'
      definitionId: 3156776f-a553-4f83-b7be-07e1d515092f
      secretId: '...my_secret_id...'
      workspaceId: 89a5f137-cba1-4f2e-85cc-db4cd4426082

Create SourceMssql Resource

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

Constructor syntax

new SourceMssql(name: string, args: SourceMssqlArgs, opts?: CustomResourceOptions);

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

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

func NewSourceMssql(ctx *Context, name string, args SourceMssqlArgs, opts ...ResourceOption) (*SourceMssql, error)

public SourceMssql(string name, SourceMssqlArgs args, CustomResourceOptions? opts = null)

public SourceMssql(String name, SourceMssqlArgs args)
public SourceMssql(String name, SourceMssqlArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args SourceMssqlArgs: 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 sourceMssqlResource = new Airbyte.SourceMssql("sourceMssqlResource", new()
{
    Configuration = new Airbyte.Inputs.SourceMssqlConfigurationArgs
    {
        Database = "string",
        Host = "string",
        Password = "string",
        Port = 0,
        Username = "string",
        JdbcUrlParams = "string",
        ReplicationMethod = new Airbyte.Inputs.SourceMssqlConfigurationReplicationMethodArgs
        {
            ReadChangesUsingChangeDataCaptureCdc = new Airbyte.Inputs.SourceMssqlConfigurationReplicationMethodReadChangesUsingChangeDataCaptureCdcArgs
            {
                InitialLoadTimeoutHours = 0,
                InitialWaitingSeconds = 0,
                InvalidCdcCursorPositionBehavior = "string",
                QueueSize = 0,
            },
            ScanChangesWithUserDefinedCursor = null,
        },
        Schemas = new[]
        {
            "string",
        },
        SslMethod = new Airbyte.Inputs.SourceMssqlConfigurationSslMethodArgs
        {
            EncryptedTrustServerCertificate = null,
            EncryptedVerifyCertificate = new Airbyte.Inputs.SourceMssqlConfigurationSslMethodEncryptedVerifyCertificateArgs
            {
                Certificate = "string",
                HostNameInCertificate = "string",
            },
            Unencrypted = null,
        },
        TunnelMethod = new Airbyte.Inputs.SourceMssqlConfigurationTunnelMethodArgs
        {
            NoTunnel = null,
            PasswordAuthentication = new Airbyte.Inputs.SourceMssqlConfigurationTunnelMethodPasswordAuthenticationArgs
            {
                TunnelHost = "string",
                TunnelUser = "string",
                TunnelUserPassword = "string",
                TunnelPort = 0,
            },
            SshKeyAuthentication = new Airbyte.Inputs.SourceMssqlConfigurationTunnelMethodSshKeyAuthenticationArgs
            {
                SshKey = "string",
                TunnelHost = "string",
                TunnelUser = "string",
                TunnelPort = 0,
            },
        },
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

example, err := airbyte.NewSourceMssql(ctx, "sourceMssqlResource", &airbyte.SourceMssqlArgs{
Configuration: &.SourceMssqlConfigurationArgs{
Database: pulumi.String("string"),
Host: pulumi.String("string"),
Password: pulumi.String("string"),
Port: pulumi.Float64(0),
Username: pulumi.String("string"),
JdbcUrlParams: pulumi.String("string"),
ReplicationMethod: &.SourceMssqlConfigurationReplicationMethodArgs{
ReadChangesUsingChangeDataCaptureCdc: &.SourceMssqlConfigurationReplicationMethodReadChangesUsingChangeDataCaptureCdcArgs{
InitialLoadTimeoutHours: pulumi.Float64(0),
InitialWaitingSeconds: pulumi.Float64(0),
InvalidCdcCursorPositionBehavior: pulumi.String("string"),
QueueSize: pulumi.Float64(0),
},
ScanChangesWithUserDefinedCursor: &.SourceMssqlConfigurationReplicationMethodScanChangesWithUserDefinedCursorArgs{
},
},
Schemas: pulumi.StringArray{
pulumi.String("string"),
},
SslMethod: &.SourceMssqlConfigurationSslMethodArgs{
EncryptedTrustServerCertificate: &.SourceMssqlConfigurationSslMethodEncryptedTrustServerCertificateArgs{
},
EncryptedVerifyCertificate: &.SourceMssqlConfigurationSslMethodEncryptedVerifyCertificateArgs{
Certificate: pulumi.String("string"),
HostNameInCertificate: pulumi.String("string"),
},
Unencrypted: &.SourceMssqlConfigurationSslMethodUnencryptedArgs{
},
},
TunnelMethod: &.SourceMssqlConfigurationTunnelMethodArgs{
NoTunnel: &.SourceMssqlConfigurationTunnelMethodNoTunnelArgs{
},
PasswordAuthentication: &.SourceMssqlConfigurationTunnelMethodPasswordAuthenticationArgs{
TunnelHost: pulumi.String("string"),
TunnelUser: pulumi.String("string"),
TunnelUserPassword: pulumi.String("string"),
TunnelPort: pulumi.Float64(0),
},
SshKeyAuthentication: &.SourceMssqlConfigurationTunnelMethodSshKeyAuthenticationArgs{
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"),
SecretId: pulumi.String("string"),
})

var sourceMssqlResource = new SourceMssql("sourceMssqlResource", SourceMssqlArgs.builder()
    .configuration(SourceMssqlConfigurationArgs.builder()
        .database("string")
        .host("string")
        .password("string")
        .port(0)
        .username("string")
        .jdbcUrlParams("string")
        .replicationMethod(SourceMssqlConfigurationReplicationMethodArgs.builder()
            .readChangesUsingChangeDataCaptureCdc(SourceMssqlConfigurationReplicationMethodReadChangesUsingChangeDataCaptureCdcArgs.builder()
                .initialLoadTimeoutHours(0)
                .initialWaitingSeconds(0)
                .invalidCdcCursorPositionBehavior("string")
                .queueSize(0)
                .build())
            .scanChangesWithUserDefinedCursor()
            .build())
        .schemas("string")
        .sslMethod(SourceMssqlConfigurationSslMethodArgs.builder()
            .encryptedTrustServerCertificate()
            .encryptedVerifyCertificate(SourceMssqlConfigurationSslMethodEncryptedVerifyCertificateArgs.builder()
                .certificate("string")
                .hostNameInCertificate("string")
                .build())
            .unencrypted()
            .build())
        .tunnelMethod(SourceMssqlConfigurationTunnelMethodArgs.builder()
            .noTunnel()
            .passwordAuthentication(SourceMssqlConfigurationTunnelMethodPasswordAuthenticationArgs.builder()
                .tunnelHost("string")
                .tunnelUser("string")
                .tunnelUserPassword("string")
                .tunnelPort(0)
                .build())
            .sshKeyAuthentication(SourceMssqlConfigurationTunnelMethodSshKeyAuthenticationArgs.builder()
                .sshKey("string")
                .tunnelHost("string")
                .tunnelUser("string")
                .tunnelPort(0)
                .build())
            .build())
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

source_mssql_resource = airbyte.SourceMssql("sourceMssqlResource",
    configuration={
        "database": "string",
        "host": "string",
        "password": "string",
        "port": 0,
        "username": "string",
        "jdbc_url_params": "string",
        "replication_method": {
            "read_changes_using_change_data_capture_cdc": {
                "initial_load_timeout_hours": 0,
                "initial_waiting_seconds": 0,
                "invalid_cdc_cursor_position_behavior": "string",
                "queue_size": 0,
            },
            "scan_changes_with_user_defined_cursor": {},
        },
        "schemas": ["string"],
        "ssl_method": {
            "encrypted_trust_server_certificate": {},
            "encrypted_verify_certificate": {
                "certificate": "string",
                "host_name_in_certificate": "string",
            },
            "unencrypted": {},
        },
        "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",
    secret_id="string")

const sourceMssqlResource = new airbyte.SourceMssql("sourceMssqlResource", {
    configuration: {
        database: "string",
        host: "string",
        password: "string",
        port: 0,
        username: "string",
        jdbcUrlParams: "string",
        replicationMethod: {
            readChangesUsingChangeDataCaptureCdc: {
                initialLoadTimeoutHours: 0,
                initialWaitingSeconds: 0,
                invalidCdcCursorPositionBehavior: "string",
                queueSize: 0,
            },
            scanChangesWithUserDefinedCursor: {},
        },
        schemas: ["string"],
        sslMethod: {
            encryptedTrustServerCertificate: {},
            encryptedVerifyCertificate: {
                certificate: "string",
                hostNameInCertificate: "string",
            },
            unencrypted: {},
        },
        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",
    secretId: "string",
});

type: airbyte:SourceMssql
properties:
    configuration:
        database: string
        host: string
        jdbcUrlParams: string
        password: string
        port: 0
        replicationMethod:
            readChangesUsingChangeDataCaptureCdc:
                initialLoadTimeoutHours: 0
                initialWaitingSeconds: 0
                invalidCdcCursorPositionBehavior: string
                queueSize: 0
            scanChangesWithUserDefinedCursor: {}
        schemas:
            - string
        sslMethod:
            encryptedTrustServerCertificate: {}
            encryptedVerifyCertificate:
                certificate: string
                hostNameInCertificate: string
            unencrypted: {}
        tunnelMethod:
            noTunnel: {}
            passwordAuthentication:
                tunnelHost: string
                tunnelPort: 0
                tunnelUser: string
                tunnelUserPassword: string
            sshKeyAuthentication:
                sshKey: string
                tunnelHost: string
                tunnelPort: 0
                tunnelUser: string
        username: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

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

Configuration SourceMssqlConfiguration
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 SourceMssqlConfigurationArgs
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 SourceMssqlConfiguration
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 SourceMssqlConfiguration
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 SourceMssqlConfigurationArgs
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 SourceMssql 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 SourceMssql Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceMssqlConfigurationArgs] = 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) -> SourceMssql

func GetSourceMssql(ctx *Context, name string, id IDInput, state *SourceMssqlState, opts ...ResourceOption) (*SourceMssql, error)

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

public static SourceMssql get(String name, Output<String> id, SourceMssqlState state, CustomResourceOptions options)

resources:  _:    type: airbyte:SourceMssql    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 SourceMssqlConfiguration
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 SourceMssqlConfigurationArgs
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 SourceMssqlConfiguration
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 SourceMssqlConfiguration
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 SourceMssqlConfigurationArgs
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

SourceMssqlConfiguration, SourceMssqlConfigurationArgs

Database string: The name of the database.
Host string: The hostname of the database.
Password string: The password associated with the username.
Port double: The port of the database.
Username string: The username which is used to access the database.
JdbcUrlParams string: Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3).
ReplicationMethod SourceMssqlConfigurationReplicationMethod: Configures how data is extracted from the database.
Schemas List<string>: The list of schemas to sync from. Defaults to user. Case sensitive.
SslMethod SourceMssqlConfigurationSslMethod: The encryption method which is used when communicating with the database.
TunnelMethod SourceMssqlConfigurationTunnelMethod: Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.

Database string: The name of the database.
Host string: The hostname of the database.
Password string: The password associated with the username.
Port float64: The port of the database.
Username string: The username which is used to access the database.
JdbcUrlParams string: Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3).
ReplicationMethod SourceMssqlConfigurationReplicationMethod: Configures how data is extracted from the database.
Schemas []string: The list of schemas to sync from. Defaults to user. Case sensitive.
SslMethod SourceMssqlConfigurationSslMethod: The encryption method which is used when communicating with the database.
TunnelMethod SourceMssqlConfigurationTunnelMethod: Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.

database String: The name of the database.
host String: The hostname of the database.
password String: The password associated with the username.
port Double: The port of the database.
username String: The username which is used to access the database.
jdbcUrlParams String: Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3).
replicationMethod SourceMssqlConfigurationReplicationMethod: Configures how data is extracted from the database.
schemas List<String>: The list of schemas to sync from. Defaults to user. Case sensitive.
sslMethod SourceMssqlConfigurationSslMethod: The encryption method which is used when communicating with the database.
tunnelMethod SourceMssqlConfigurationTunnelMethod: Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.

database string: The name of the database.
host string: The hostname of the database.
password string: The password associated with the username.
port number: The port of the database.
username string: The username which is used to access the database.
jdbcUrlParams string: Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3).
replicationMethod SourceMssqlConfigurationReplicationMethod: Configures how data is extracted from the database.
schemas string[]: The list of schemas to sync from. Defaults to user. Case sensitive.
sslMethod SourceMssqlConfigurationSslMethod: The encryption method which is used when communicating with the database.
tunnelMethod SourceMssqlConfigurationTunnelMethod: Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.

database str: The name of the database.
host str: The hostname of the database.
password str: The password associated with the username.
port float: The port of the database.
username str: The username which is used to access the database.
jdbc_url_params str: Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3).
replication_method SourceMssqlConfigurationReplicationMethod: Configures how data is extracted from the database.
schemas Sequence[str]: The list of schemas to sync from. Defaults to user. Case sensitive.
ssl_method SourceMssqlConfigurationSslMethod: The encryption method which is used when communicating with the database.
tunnel_method SourceMssqlConfigurationTunnelMethod: Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.

database String: The name of the database.
host String: The hostname of the database.
password String: The password associated with the username.
port Number: The port of the database.
username String: The username which is used to access the database.
jdbcUrlParams String: Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3).
replicationMethod Property Map: Configures how data is extracted from the database.
schemas List<String>: The list of schemas to sync from. Defaults to user. Case sensitive.
sslMethod Property Map: The encryption method which is used when communicating with the database.
tunnelMethod Property Map: Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.

SourceMssqlConfigurationReplicationMethod, SourceMssqlConfigurationReplicationMethodArgs

ReadChangesUsingChangeDataCaptureCdc SourceMssqlConfigurationReplicationMethodReadChangesUsingChangeDataCaptureCdc: \n\nRecommended\n\n - Incrementally reads new inserts, updates, and deletes using the SQL Server's \n\nchange data capture feature\n\n. This must be enabled on your database.
ScanChangesWithUserDefinedCursor SourceMssqlConfigurationReplicationMethodScanChangesWithUserDefinedCursor: Incrementally detects new inserts and updates using the \n\ncursor column\n\n chosen when configuring a connection (e.g. createdat, updatedat).

ReadChangesUsingChangeDataCaptureCdc SourceMssqlConfigurationReplicationMethodReadChangesUsingChangeDataCaptureCdc: \n\nRecommended\n\n - Incrementally reads new inserts, updates, and deletes using the SQL Server's \n\nchange data capture feature\n\n. This must be enabled on your database.
ScanChangesWithUserDefinedCursor SourceMssqlConfigurationReplicationMethodScanChangesWithUserDefinedCursor: Incrementally detects new inserts and updates using the \n\ncursor column\n\n chosen when configuring a connection (e.g. createdat, updatedat).

readChangesUsingChangeDataCaptureCdc SourceMssqlConfigurationReplicationMethodReadChangesUsingChangeDataCaptureCdc: \n\nRecommended\n\n - Incrementally reads new inserts, updates, and deletes using the SQL Server's \n\nchange data capture feature\n\n. This must be enabled on your database.
scanChangesWithUserDefinedCursor SourceMssqlConfigurationReplicationMethodScanChangesWithUserDefinedCursor: Incrementally detects new inserts and updates using the \n\ncursor column\n\n chosen when configuring a connection (e.g. createdat, updatedat).

readChangesUsingChangeDataCaptureCdc SourceMssqlConfigurationReplicationMethodReadChangesUsingChangeDataCaptureCdc: \n\nRecommended\n\n - Incrementally reads new inserts, updates, and deletes using the SQL Server's \n\nchange data capture feature\n\n. This must be enabled on your database.
scanChangesWithUserDefinedCursor SourceMssqlConfigurationReplicationMethodScanChangesWithUserDefinedCursor: Incrementally detects new inserts and updates using the \n\ncursor column\n\n chosen when configuring a connection (e.g. createdat, updatedat).

read_changes_using_change_data_capture_cdc SourceMssqlConfigurationReplicationMethodReadChangesUsingChangeDataCaptureCdc: \n\nRecommended\n\n - Incrementally reads new inserts, updates, and deletes using the SQL Server's \n\nchange data capture feature\n\n. This must be enabled on your database.
scan_changes_with_user_defined_cursor SourceMssqlConfigurationReplicationMethodScanChangesWithUserDefinedCursor: Incrementally detects new inserts and updates using the \n\ncursor column\n\n chosen when configuring a connection (e.g. createdat, updatedat).

readChangesUsingChangeDataCaptureCdc Property Map: \n\nRecommended\n\n - Incrementally reads new inserts, updates, and deletes using the SQL Server's \n\nchange data capture feature\n\n. This must be enabled on your database.
scanChangesWithUserDefinedCursor Property Map: Incrementally detects new inserts and updates using the \n\ncursor column\n\n chosen when configuring a connection (e.g. createdat, updatedat).

SourceMssqlConfigurationReplicationMethodReadChangesUsingChangeDataCaptureCdc, SourceMssqlConfigurationReplicationMethodReadChangesUsingChangeDataCaptureCdcArgs

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 3600 seconds. Read about \n\ninitial waiting time\n\n. 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

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 3600 seconds. Read about \n\ninitial waiting time\n\n. 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

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 3600 seconds. Read about \n\ninitial waiting time\n\n. 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

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 3600 seconds. Read about \n\ninitial waiting time\n\n. 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

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 3600 seconds. Read about \n\ninitial waiting time\n\n. 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

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 3600 seconds. Read about \n\ninitial waiting time\n\n. 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

SourceMssqlConfigurationSslMethod, SourceMssqlConfigurationSslMethodArgs

EncryptedTrustServerCertificate SourceMssqlConfigurationSslMethodEncryptedTrustServerCertificate: Use the certificate provided by the server without verification. (For testing purposes only!)
EncryptedVerifyCertificate SourceMssqlConfigurationSslMethodEncryptedVerifyCertificate: Verify and use the certificate provided by the server.
Unencrypted SourceMssqlConfigurationSslMethodUnencrypted: Data transfer will not be encrypted.

EncryptedTrustServerCertificate SourceMssqlConfigurationSslMethodEncryptedTrustServerCertificate: Use the certificate provided by the server without verification. (For testing purposes only!)
EncryptedVerifyCertificate SourceMssqlConfigurationSslMethodEncryptedVerifyCertificate: Verify and use the certificate provided by the server.
Unencrypted SourceMssqlConfigurationSslMethodUnencrypted: Data transfer will not be encrypted.

encryptedTrustServerCertificate SourceMssqlConfigurationSslMethodEncryptedTrustServerCertificate: Use the certificate provided by the server without verification. (For testing purposes only!)
encryptedVerifyCertificate SourceMssqlConfigurationSslMethodEncryptedVerifyCertificate: Verify and use the certificate provided by the server.
unencrypted SourceMssqlConfigurationSslMethodUnencrypted: Data transfer will not be encrypted.

encryptedTrustServerCertificate SourceMssqlConfigurationSslMethodEncryptedTrustServerCertificate: Use the certificate provided by the server without verification. (For testing purposes only!)
encryptedVerifyCertificate SourceMssqlConfigurationSslMethodEncryptedVerifyCertificate: Verify and use the certificate provided by the server.
unencrypted SourceMssqlConfigurationSslMethodUnencrypted: Data transfer will not be encrypted.

encrypted_trust_server_certificate SourceMssqlConfigurationSslMethodEncryptedTrustServerCertificate: Use the certificate provided by the server without verification. (For testing purposes only!)
encrypted_verify_certificate SourceMssqlConfigurationSslMethodEncryptedVerifyCertificate: Verify and use the certificate provided by the server.
unencrypted SourceMssqlConfigurationSslMethodUnencrypted: Data transfer will not be encrypted.

encryptedTrustServerCertificate Property Map: Use the certificate provided by the server without verification. (For testing purposes only!)
encryptedVerifyCertificate Property Map: Verify and use the certificate provided by the server.
unencrypted Property Map: Data transfer will not be encrypted.

SourceMssqlConfigurationSslMethodEncryptedVerifyCertificate, SourceMssqlConfigurationSslMethodEncryptedVerifyCertificateArgs

Certificate string: certificate of the server, or of the CA that signed the server certificate
HostNameInCertificate string: Specifies the host name of the server. The value of this property must match the subject property of the certificate.

Certificate string: certificate of the server, or of the CA that signed the server certificate
HostNameInCertificate string: Specifies the host name of the server. The value of this property must match the subject property of the certificate.

certificate String: certificate of the server, or of the CA that signed the server certificate
hostNameInCertificate String: Specifies the host name of the server. The value of this property must match the subject property of the certificate.

certificate string: certificate of the server, or of the CA that signed the server certificate
hostNameInCertificate string: Specifies the host name of the server. The value of this property must match the subject property of the certificate.

certificate str: certificate of the server, or of the CA that signed the server certificate
host_name_in_certificate str: Specifies the host name of the server. The value of this property must match the subject property of the certificate.

certificate String: certificate of the server, or of the CA that signed the server certificate
hostNameInCertificate String: Specifies the host name of the server. The value of this property must match the subject property of the certificate.

SourceMssqlConfigurationTunnelMethod, SourceMssqlConfigurationTunnelMethodArgs

NoTunnel SourceMssqlConfigurationTunnelMethodNoTunnel
PasswordAuthentication SourceMssqlConfigurationTunnelMethodPasswordAuthentication
SshKeyAuthentication SourceMssqlConfigurationTunnelMethodSshKeyAuthentication

NoTunnel SourceMssqlConfigurationTunnelMethodNoTunnel
PasswordAuthentication SourceMssqlConfigurationTunnelMethodPasswordAuthentication
SshKeyAuthentication SourceMssqlConfigurationTunnelMethodSshKeyAuthentication

noTunnel SourceMssqlConfigurationTunnelMethodNoTunnel
passwordAuthentication SourceMssqlConfigurationTunnelMethodPasswordAuthentication
sshKeyAuthentication SourceMssqlConfigurationTunnelMethodSshKeyAuthentication

noTunnel SourceMssqlConfigurationTunnelMethodNoTunnel
passwordAuthentication SourceMssqlConfigurationTunnelMethodPasswordAuthentication
sshKeyAuthentication SourceMssqlConfigurationTunnelMethodSshKeyAuthentication

no_tunnel SourceMssqlConfigurationTunnelMethodNoTunnel
password_authentication SourceMssqlConfigurationTunnelMethodPasswordAuthentication
ssh_key_authentication SourceMssqlConfigurationTunnelMethodSshKeyAuthentication

noTunnel Property Map
passwordAuthentication Property Map
sshKeyAuthentication Property Map

SourceMssqlConfigurationTunnelMethodPasswordAuthentication, SourceMssqlConfigurationTunnelMethodPasswordAuthenticationArgs

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

SourceMssqlConfigurationTunnelMethodSshKeyAuthentication, SourceMssqlConfigurationTunnelMethodSshKeyAuthenticationArgs

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

Import

$ pulumi import airbyte:index/sourceMssql:SourceMssql my_airbyte_source_mssql ""

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.SourceMssql

On this page

On this page

Example Usage

Create SourceMssql Resource

Constructor syntax

Parameters

Constructor example

SourceMssql Resource Properties

Inputs

Outputs

Look up Existing SourceMssql Resource

Supporting Types

SourceMssqlConfiguration, SourceMssqlConfigurationArgs

SourceMssqlConfigurationReplicationMethod, SourceMssqlConfigurationReplicationMethodArgs

SourceMssqlConfigurationReplicationMethodReadChangesUsingChangeDataCaptureCdc, SourceMssqlConfigurationReplicationMethodReadChangesUsingChangeDataCaptureCdcArgs

SourceMssqlConfigurationSslMethod, SourceMssqlConfigurationSslMethodArgs

SourceMssqlConfigurationSslMethodEncryptedVerifyCertificate, SourceMssqlConfigurationSslMethodEncryptedVerifyCertificateArgs

SourceMssqlConfigurationTunnelMethod, SourceMssqlConfigurationTunnelMethodArgs

SourceMssqlConfigurationTunnelMethodPasswordAuthentication, SourceMssqlConfigurationTunnelMethodPasswordAuthenticationArgs

SourceMssqlConfigurationTunnelMethodSshKeyAuthentication, SourceMssqlConfigurationTunnelMethodSshKeyAuthenticationArgs

Import

Package Details

On this page

On this page