1. Packages
  2. Airbyte Provider
  3. API Docs
  4. SourcePostgres
airbyte 0.8.1-beta published on Saturday, Mar 29, 2025 by airbytehq

airbyte.SourcePostgres

Explore with Pulumi AI

SourcePostgres Resource

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.SourcePostgres;
import com.pulumi.airbyte.SourcePostgresArgs;
import com.pulumi.airbyte.inputs.SourcePostgresConfigurationArgs;
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 mySourcePostgres = new SourcePostgres("mySourcePostgres", SourcePostgresArgs.builder()
            .configuration(SourcePostgresConfigurationArgs.builder()
                .database("...my_database...")
                .host("...my_host...")
                .jdbc_url_params("...my_jdbc_url_params...")
                .password("...my_password...")
                .port(5432)
                .replication_method()
                .schemas()
                .ssl_mode()
                .tunnel_method(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .username("...my_username...")
                .build())
            .definitionId("be56435e-cbaf-420b-889d-1d220ff21125")
            .secretId("...my_secret_id...")
            .workspaceId("d122fa45-e536-42be-a02d-5e851e4eb0a6")
            .build());

    }
}
Copy
resources:
  mySourcePostgres:
    type: airbyte:SourcePostgres
    properties:
      configuration:
        database: '...my_database...'
        host: '...my_host...'
        jdbc_url_params: '...my_jdbc_url_params...'
        password: '...my_password...'
        port: 5432
        replication_method: {}
        schemas: []
        ssl_mode: {}
        tunnel_method:
          passwordAuthentication:
            tunnelHost: '...my_tunnel_host...'
            tunnelPort: 22
            tunnelUser: '...my_tunnel_user...'
            tunnelUserPassword: '...my_tunnel_user_password...'
        username: '...my_username...'
      definitionId: be56435e-cbaf-420b-889d-1d220ff21125
      secretId: '...my_secret_id...'
      workspaceId: d122fa45-e536-42be-a02d-5e851e4eb0a6
Copy

Create SourcePostgres Resource

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

Constructor syntax

new SourcePostgres(name: string, args: SourcePostgresArgs, opts?: CustomResourceOptions);
@overload
def SourcePostgres(resource_name: str,
                   args: SourcePostgresArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def SourcePostgres(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   configuration: Optional[SourcePostgresConfigurationArgs] = None,
                   workspace_id: Optional[str] = None,
                   definition_id: Optional[str] = None,
                   name: Optional[str] = None,
                   secret_id: Optional[str] = None)
func NewSourcePostgres(ctx *Context, name string, args SourcePostgresArgs, opts ...ResourceOption) (*SourcePostgres, error)
public SourcePostgres(string name, SourcePostgresArgs args, CustomResourceOptions? opts = null)
public SourcePostgres(String name, SourcePostgresArgs args)
public SourcePostgres(String name, SourcePostgresArgs args, CustomResourceOptions options)
type: airbyte:SourcePostgres
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SourcePostgresArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SourcePostgresArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SourcePostgresArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SourcePostgresArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SourcePostgresArgs
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 sourcePostgresResource = new Airbyte.SourcePostgres("sourcePostgresResource", new()
{
    Configuration = new Airbyte.Inputs.SourcePostgresConfigurationArgs
    {
        Database = "string",
        Host = "string",
        Username = "string",
        JdbcUrlParams = "string",
        Password = "string",
        Port = 0,
        ReplicationMethod = new Airbyte.Inputs.SourcePostgresConfigurationReplicationMethodArgs
        {
            DetectChangesWithXminSystemColumn = null,
            ReadChangesUsingWriteAheadLogCdc = new Airbyte.Inputs.SourcePostgresConfigurationReplicationMethodReadChangesUsingWriteAheadLogCdcArgs
            {
                Publication = "string",
                ReplicationSlot = "string",
                AdditionalProperties = "string",
                HeartbeatActionQuery = "string",
                InitialLoadTimeoutHours = 0,
                InitialWaitingSeconds = 0,
                InvalidCdcCursorPositionBehavior = "string",
                LsnCommitBehaviour = "string",
                Plugin = "string",
                QueueSize = 0,
            },
            ScanChangesWithUserDefinedCursor = null,
        },
        Schemas = new[]
        {
            "string",
        },
        SslMode = new Airbyte.Inputs.SourcePostgresConfigurationSslModeArgs
        {
            Allow = new Airbyte.Inputs.SourcePostgresConfigurationSslModeAllowArgs
            {
                AdditionalProperties = "string",
            },
            Disable = new Airbyte.Inputs.SourcePostgresConfigurationSslModeDisableArgs
            {
                AdditionalProperties = "string",
            },
            Prefer = new Airbyte.Inputs.SourcePostgresConfigurationSslModePreferArgs
            {
                AdditionalProperties = "string",
            },
            Require = new Airbyte.Inputs.SourcePostgresConfigurationSslModeRequireArgs
            {
                AdditionalProperties = "string",
            },
            VerifyCa = new Airbyte.Inputs.SourcePostgresConfigurationSslModeVerifyCaArgs
            {
                CaCertificate = "string",
                AdditionalProperties = "string",
                ClientCertificate = "string",
                ClientKey = "string",
                ClientKeyPassword = "string",
            },
            VerifyFull = new Airbyte.Inputs.SourcePostgresConfigurationSslModeVerifyFullArgs
            {
                CaCertificate = "string",
                AdditionalProperties = "string",
                ClientCertificate = "string",
                ClientKey = "string",
                ClientKeyPassword = "string",
            },
        },
        TunnelMethod = new Airbyte.Inputs.SourcePostgresConfigurationTunnelMethodArgs
        {
            NoTunnel = null,
            PasswordAuthentication = new Airbyte.Inputs.SourcePostgresConfigurationTunnelMethodPasswordAuthenticationArgs
            {
                TunnelHost = "string",
                TunnelUser = "string",
                TunnelUserPassword = "string",
                TunnelPort = 0,
            },
            SshKeyAuthentication = new Airbyte.Inputs.SourcePostgresConfigurationTunnelMethodSshKeyAuthenticationArgs
            {
                SshKey = "string",
                TunnelHost = "string",
                TunnelUser = "string",
                TunnelPort = 0,
            },
        },
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});
Copy
example, err := airbyte.NewSourcePostgres(ctx, "sourcePostgresResource", &airbyte.SourcePostgresArgs{
Configuration: &.SourcePostgresConfigurationArgs{
Database: pulumi.String("string"),
Host: pulumi.String("string"),
Username: pulumi.String("string"),
JdbcUrlParams: pulumi.String("string"),
Password: pulumi.String("string"),
Port: pulumi.Float64(0),
ReplicationMethod: &.SourcePostgresConfigurationReplicationMethodArgs{
DetectChangesWithXminSystemColumn: &.SourcePostgresConfigurationReplicationMethodDetectChangesWithXminSystemColumnArgs{
},
ReadChangesUsingWriteAheadLogCdc: &.SourcePostgresConfigurationReplicationMethodReadChangesUsingWriteAheadLogCdcArgs{
Publication: pulumi.String("string"),
ReplicationSlot: pulumi.String("string"),
AdditionalProperties: pulumi.String("string"),
HeartbeatActionQuery: pulumi.String("string"),
InitialLoadTimeoutHours: pulumi.Float64(0),
InitialWaitingSeconds: pulumi.Float64(0),
InvalidCdcCursorPositionBehavior: pulumi.String("string"),
LsnCommitBehaviour: pulumi.String("string"),
Plugin: pulumi.String("string"),
QueueSize: pulumi.Float64(0),
},
ScanChangesWithUserDefinedCursor: &.SourcePostgresConfigurationReplicationMethodScanChangesWithUserDefinedCursorArgs{
},
},
Schemas: pulumi.StringArray{
pulumi.String("string"),
},
SslMode: &.SourcePostgresConfigurationSslModeArgs{
Allow: &.SourcePostgresConfigurationSslModeAllowArgs{
AdditionalProperties: pulumi.String("string"),
},
Disable: &.SourcePostgresConfigurationSslModeDisableArgs{
AdditionalProperties: pulumi.String("string"),
},
Prefer: &.SourcePostgresConfigurationSslModePreferArgs{
AdditionalProperties: pulumi.String("string"),
},
Require: &.SourcePostgresConfigurationSslModeRequireArgs{
AdditionalProperties: pulumi.String("string"),
},
VerifyCa: &.SourcePostgresConfigurationSslModeVerifyCaArgs{
CaCertificate: pulumi.String("string"),
AdditionalProperties: pulumi.String("string"),
ClientCertificate: pulumi.String("string"),
ClientKey: pulumi.String("string"),
ClientKeyPassword: pulumi.String("string"),
},
VerifyFull: &.SourcePostgresConfigurationSslModeVerifyFullArgs{
CaCertificate: pulumi.String("string"),
AdditionalProperties: pulumi.String("string"),
ClientCertificate: pulumi.String("string"),
ClientKey: pulumi.String("string"),
ClientKeyPassword: pulumi.String("string"),
},
},
TunnelMethod: &.SourcePostgresConfigurationTunnelMethodArgs{
NoTunnel: &.SourcePostgresConfigurationTunnelMethodNoTunnelArgs{
},
PasswordAuthentication: &.SourcePostgresConfigurationTunnelMethodPasswordAuthenticationArgs{
TunnelHost: pulumi.String("string"),
TunnelUser: pulumi.String("string"),
TunnelUserPassword: pulumi.String("string"),
TunnelPort: pulumi.Float64(0),
},
SshKeyAuthentication: &.SourcePostgresConfigurationTunnelMethodSshKeyAuthenticationArgs{
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"),
})
Copy
var sourcePostgresResource = new SourcePostgres("sourcePostgresResource", SourcePostgresArgs.builder()
    .configuration(SourcePostgresConfigurationArgs.builder()
        .database("string")
        .host("string")
        .username("string")
        .jdbcUrlParams("string")
        .password("string")
        .port(0)
        .replicationMethod(SourcePostgresConfigurationReplicationMethodArgs.builder()
            .detectChangesWithXminSystemColumn()
            .readChangesUsingWriteAheadLogCdc(SourcePostgresConfigurationReplicationMethodReadChangesUsingWriteAheadLogCdcArgs.builder()
                .publication("string")
                .replicationSlot("string")
                .additionalProperties("string")
                .heartbeatActionQuery("string")
                .initialLoadTimeoutHours(0)
                .initialWaitingSeconds(0)
                .invalidCdcCursorPositionBehavior("string")
                .lsnCommitBehaviour("string")
                .plugin("string")
                .queueSize(0)
                .build())
            .scanChangesWithUserDefinedCursor()
            .build())
        .schemas("string")
        .sslMode(SourcePostgresConfigurationSslModeArgs.builder()
            .allow(SourcePostgresConfigurationSslModeAllowArgs.builder()
                .additionalProperties("string")
                .build())
            .disable(SourcePostgresConfigurationSslModeDisableArgs.builder()
                .additionalProperties("string")
                .build())
            .prefer(SourcePostgresConfigurationSslModePreferArgs.builder()
                .additionalProperties("string")
                .build())
            .require(SourcePostgresConfigurationSslModeRequireArgs.builder()
                .additionalProperties("string")
                .build())
            .verifyCa(SourcePostgresConfigurationSslModeVerifyCaArgs.builder()
                .caCertificate("string")
                .additionalProperties("string")
                .clientCertificate("string")
                .clientKey("string")
                .clientKeyPassword("string")
                .build())
            .verifyFull(SourcePostgresConfigurationSslModeVerifyFullArgs.builder()
                .caCertificate("string")
                .additionalProperties("string")
                .clientCertificate("string")
                .clientKey("string")
                .clientKeyPassword("string")
                .build())
            .build())
        .tunnelMethod(SourcePostgresConfigurationTunnelMethodArgs.builder()
            .noTunnel()
            .passwordAuthentication(SourcePostgresConfigurationTunnelMethodPasswordAuthenticationArgs.builder()
                .tunnelHost("string")
                .tunnelUser("string")
                .tunnelUserPassword("string")
                .tunnelPort(0)
                .build())
            .sshKeyAuthentication(SourcePostgresConfigurationTunnelMethodSshKeyAuthenticationArgs.builder()
                .sshKey("string")
                .tunnelHost("string")
                .tunnelUser("string")
                .tunnelPort(0)
                .build())
            .build())
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());
Copy
source_postgres_resource = airbyte.SourcePostgres("sourcePostgresResource",
    configuration={
        "database": "string",
        "host": "string",
        "username": "string",
        "jdbc_url_params": "string",
        "password": "string",
        "port": 0,
        "replication_method": {
            "detect_changes_with_xmin_system_column": {},
            "read_changes_using_write_ahead_log_cdc": {
                "publication": "string",
                "replication_slot": "string",
                "additional_properties": "string",
                "heartbeat_action_query": "string",
                "initial_load_timeout_hours": 0,
                "initial_waiting_seconds": 0,
                "invalid_cdc_cursor_position_behavior": "string",
                "lsn_commit_behaviour": "string",
                "plugin": "string",
                "queue_size": 0,
            },
            "scan_changes_with_user_defined_cursor": {},
        },
        "schemas": ["string"],
        "ssl_mode": {
            "allow": {
                "additional_properties": "string",
            },
            "disable": {
                "additional_properties": "string",
            },
            "prefer": {
                "additional_properties": "string",
            },
            "require": {
                "additional_properties": "string",
            },
            "verify_ca": {
                "ca_certificate": "string",
                "additional_properties": "string",
                "client_certificate": "string",
                "client_key": "string",
                "client_key_password": "string",
            },
            "verify_full": {
                "ca_certificate": "string",
                "additional_properties": "string",
                "client_certificate": "string",
                "client_key": "string",
                "client_key_password": "string",
            },
        },
        "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")
Copy
const sourcePostgresResource = new airbyte.SourcePostgres("sourcePostgresResource", {
    configuration: {
        database: "string",
        host: "string",
        username: "string",
        jdbcUrlParams: "string",
        password: "string",
        port: 0,
        replicationMethod: {
            detectChangesWithXminSystemColumn: {},
            readChangesUsingWriteAheadLogCdc: {
                publication: "string",
                replicationSlot: "string",
                additionalProperties: "string",
                heartbeatActionQuery: "string",
                initialLoadTimeoutHours: 0,
                initialWaitingSeconds: 0,
                invalidCdcCursorPositionBehavior: "string",
                lsnCommitBehaviour: "string",
                plugin: "string",
                queueSize: 0,
            },
            scanChangesWithUserDefinedCursor: {},
        },
        schemas: ["string"],
        sslMode: {
            allow: {
                additionalProperties: "string",
            },
            disable: {
                additionalProperties: "string",
            },
            prefer: {
                additionalProperties: "string",
            },
            require: {
                additionalProperties: "string",
            },
            verifyCa: {
                caCertificate: "string",
                additionalProperties: "string",
                clientCertificate: "string",
                clientKey: "string",
                clientKeyPassword: "string",
            },
            verifyFull: {
                caCertificate: "string",
                additionalProperties: "string",
                clientCertificate: "string",
                clientKey: "string",
                clientKeyPassword: "string",
            },
        },
        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",
});
Copy
type: airbyte:SourcePostgres
properties:
    configuration:
        database: string
        host: string
        jdbcUrlParams: string
        password: string
        port: 0
        replicationMethod:
            detectChangesWithXminSystemColumn: {}
            readChangesUsingWriteAheadLogCdc:
                additionalProperties: string
                heartbeatActionQuery: string
                initialLoadTimeoutHours: 0
                initialWaitingSeconds: 0
                invalidCdcCursorPositionBehavior: string
                lsnCommitBehaviour: string
                plugin: string
                publication: string
                queueSize: 0
                replicationSlot: string
            scanChangesWithUserDefinedCursor: {}
        schemas:
            - string
        sslMode:
            allow:
                additionalProperties: string
            disable:
                additionalProperties: string
            prefer:
                additionalProperties: string
            require:
                additionalProperties: string
            verifyCa:
                additionalProperties: string
                caCertificate: string
                clientCertificate: string
                clientKey: string
                clientKeyPassword: string
            verifyFull:
                additionalProperties: string
                caCertificate: string
                clientCertificate: string
                clientKey: string
                clientKeyPassword: string
        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
Copy

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

Configuration This property is required. SourcePostgresConfiguration
WorkspaceId This property is required. 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 This property is required. SourcePostgresConfigurationArgs
WorkspaceId This property is required. 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 This property is required. SourcePostgresConfiguration
workspaceId This property is required. 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 This property is required. SourcePostgresConfiguration
workspaceId This property is required. 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 This property is required. SourcePostgresConfigurationArgs
workspace_id This property is required. 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 This property is required. Property Map
workspaceId This property is required. 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 SourcePostgres resource produces the following output properties:

CreatedAt double
Id string
The provider-assigned unique ID for this managed resource.
ResourceAllocation SourcePostgresResourceAllocation
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.
SourceId string
SourceType string
CreatedAt float64
Id string
The provider-assigned unique ID for this managed resource.
ResourceAllocation SourcePostgresResourceAllocation
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.
SourceId string
SourceType string
createdAt Double
id String
The provider-assigned unique ID for this managed resource.
resourceAllocation SourcePostgresResourceAllocation
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.
sourceId String
sourceType String
createdAt number
id string
The provider-assigned unique ID for this managed resource.
resourceAllocation SourcePostgresResourceAllocation
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.
sourceId string
sourceType string
created_at float
id str
The provider-assigned unique ID for this managed resource.
resource_allocation SourcePostgresResourceAllocation
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.
source_id str
source_type str
createdAt Number
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.
sourceId String
sourceType String

Look up Existing SourcePostgres Resource

Get an existing SourcePostgres 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?: SourcePostgresState, opts?: CustomResourceOptions): SourcePostgres
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourcePostgresConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        resource_allocation: Optional[SourcePostgresResourceAllocationArgs] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourcePostgres
func GetSourcePostgres(ctx *Context, name string, id IDInput, state *SourcePostgresState, opts ...ResourceOption) (*SourcePostgres, error)
public static SourcePostgres Get(string name, Input<string> id, SourcePostgresState? state, CustomResourceOptions? opts = null)
public static SourcePostgres get(String name, Output<String> id, SourcePostgresState state, CustomResourceOptions options)
resources:  _:    type: airbyte:SourcePostgres    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 SourcePostgresConfiguration
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.
ResourceAllocation SourcePostgresResourceAllocation
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.
SecretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string
Configuration SourcePostgresConfigurationArgs
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.
ResourceAllocation SourcePostgresResourceAllocationArgs
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.
SecretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string
configuration SourcePostgresConfiguration
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.
resourceAllocation SourcePostgresResourceAllocation
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.
secretId String
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String
configuration SourcePostgresConfiguration
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.
resourceAllocation SourcePostgresResourceAllocation
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.
secretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId string
sourceType string
workspaceId string
configuration SourcePostgresConfigurationArgs
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.
resource_allocation SourcePostgresResourceAllocationArgs
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.
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.
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.
secretId String
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

Supporting Types

SourcePostgresConfiguration
, SourcePostgresConfigurationArgs

Database This property is required. string
Name of the database.
Host This property is required. string
Hostname of the database.
Username This property is required. string
Username 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 '&'. (Eg. key1=value1&key2=value2&key3=value3). For more information read about \n\nJDBC URL parameters\n\n.
Password string
Password associated with the username.
Port double
Port of the database. Default: 5432
ReplicationMethod SourcePostgresConfigurationReplicationMethod
Configures how data is extracted from the database.
Schemas List<string>
The list of schemas (case sensitive) to sync from. Defaults to public.
SslMode SourcePostgresConfigurationSslMode
SSL connection modes. Read more \n\n in the docs\n\n.
TunnelMethod SourcePostgresConfigurationTunnelMethod
Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.
Database This property is required. string
Name of the database.
Host This property is required. string
Hostname of the database.
Username This property is required. string
Username 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 '&'. (Eg. key1=value1&key2=value2&key3=value3). For more information read about \n\nJDBC URL parameters\n\n.
Password string
Password associated with the username.
Port float64
Port of the database. Default: 5432
ReplicationMethod SourcePostgresConfigurationReplicationMethod
Configures how data is extracted from the database.
Schemas []string
The list of schemas (case sensitive) to sync from. Defaults to public.
SslMode SourcePostgresConfigurationSslMode
SSL connection modes. Read more \n\n in the docs\n\n.
TunnelMethod SourcePostgresConfigurationTunnelMethod
Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.
database This property is required. String
Name of the database.
host This property is required. String
Hostname of the database.
username This property is required. String
Username 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 '&'. (Eg. key1=value1&key2=value2&key3=value3). For more information read about \n\nJDBC URL parameters\n\n.
password String
Password associated with the username.
port Double
Port of the database. Default: 5432
replicationMethod SourcePostgresConfigurationReplicationMethod
Configures how data is extracted from the database.
schemas List<String>
The list of schemas (case sensitive) to sync from. Defaults to public.
sslMode SourcePostgresConfigurationSslMode
SSL connection modes. Read more \n\n in the docs\n\n.
tunnelMethod SourcePostgresConfigurationTunnelMethod
Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.
database This property is required. string
Name of the database.
host This property is required. string
Hostname of the database.
username This property is required. string
Username 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 '&'. (Eg. key1=value1&key2=value2&key3=value3). For more information read about \n\nJDBC URL parameters\n\n.
password string
Password associated with the username.
port number
Port of the database. Default: 5432
replicationMethod SourcePostgresConfigurationReplicationMethod
Configures how data is extracted from the database.
schemas string[]
The list of schemas (case sensitive) to sync from. Defaults to public.
sslMode SourcePostgresConfigurationSslMode
SSL connection modes. Read more \n\n in the docs\n\n.
tunnelMethod SourcePostgresConfigurationTunnelMethod
Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.
database This property is required. str
Name of the database.
host This property is required. str
Hostname of the database.
username This property is required. str
Username 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 '&'. (Eg. key1=value1&key2=value2&key3=value3). For more information read about \n\nJDBC URL parameters\n\n.
password str
Password associated with the username.
port float
Port of the database. Default: 5432
replication_method SourcePostgresConfigurationReplicationMethod
Configures how data is extracted from the database.
schemas Sequence[str]
The list of schemas (case sensitive) to sync from. Defaults to public.
ssl_mode SourcePostgresConfigurationSslMode
SSL connection modes. Read more \n\n in the docs\n\n.
tunnel_method SourcePostgresConfigurationTunnelMethod
Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.
database This property is required. String
Name of the database.
host This property is required. String
Hostname of the database.
username This property is required. String
Username 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 '&'. (Eg. key1=value1&key2=value2&key3=value3). For more information read about \n\nJDBC URL parameters\n\n.
password String
Password associated with the username.
port Number
Port of the database. Default: 5432
replicationMethod Property Map
Configures how data is extracted from the database.
schemas List<String>
The list of schemas (case sensitive) to sync from. Defaults to public.
sslMode Property Map
SSL connection modes. Read more \n\n in the docs\n\n.
tunnelMethod Property Map
Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.

SourcePostgresConfigurationReplicationMethod
, SourcePostgresConfigurationReplicationMethodArgs

DetectChangesWithXminSystemColumn SourcePostgresConfigurationReplicationMethodDetectChangesWithXminSystemColumn
\n\nRecommended\n\n - Incrementally reads new inserts and updates via Postgres \n\nXmin system column\n\n. Suitable for databases that have low transaction pressure.
ReadChangesUsingWriteAheadLogCdc SourcePostgresConfigurationReplicationMethodReadChangesUsingWriteAheadLogCdc
\n\nRecommended\n\n - Incrementally reads new inserts, updates, and deletes using the Postgres \n\nwrite-ahead log (WAL)\n\n. This needs to be configured on the source database itself. Recommended for tables of any size.
ScanChangesWithUserDefinedCursor SourcePostgresConfigurationReplicationMethodScanChangesWithUserDefinedCursor
Incrementally detects new inserts and updates using the \n\ncursor column\n\n chosen when configuring a connection (e.g. createdat, updatedat).
DetectChangesWithXminSystemColumn SourcePostgresConfigurationReplicationMethodDetectChangesWithXminSystemColumn
\n\nRecommended\n\n - Incrementally reads new inserts and updates via Postgres \n\nXmin system column\n\n. Suitable for databases that have low transaction pressure.
ReadChangesUsingWriteAheadLogCdc SourcePostgresConfigurationReplicationMethodReadChangesUsingWriteAheadLogCdc
\n\nRecommended\n\n - Incrementally reads new inserts, updates, and deletes using the Postgres \n\nwrite-ahead log (WAL)\n\n. This needs to be configured on the source database itself. Recommended for tables of any size.
ScanChangesWithUserDefinedCursor SourcePostgresConfigurationReplicationMethodScanChangesWithUserDefinedCursor
Incrementally detects new inserts and updates using the \n\ncursor column\n\n chosen when configuring a connection (e.g. createdat, updatedat).
detectChangesWithXminSystemColumn SourcePostgresConfigurationReplicationMethodDetectChangesWithXminSystemColumn
\n\nRecommended\n\n - Incrementally reads new inserts and updates via Postgres \n\nXmin system column\n\n. Suitable for databases that have low transaction pressure.
readChangesUsingWriteAheadLogCdc SourcePostgresConfigurationReplicationMethodReadChangesUsingWriteAheadLogCdc
\n\nRecommended\n\n - Incrementally reads new inserts, updates, and deletes using the Postgres \n\nwrite-ahead log (WAL)\n\n. This needs to be configured on the source database itself. Recommended for tables of any size.
scanChangesWithUserDefinedCursor SourcePostgresConfigurationReplicationMethodScanChangesWithUserDefinedCursor
Incrementally detects new inserts and updates using the \n\ncursor column\n\n chosen when configuring a connection (e.g. createdat, updatedat).
detectChangesWithXminSystemColumn SourcePostgresConfigurationReplicationMethodDetectChangesWithXminSystemColumn
\n\nRecommended\n\n - Incrementally reads new inserts and updates via Postgres \n\nXmin system column\n\n. Suitable for databases that have low transaction pressure.
readChangesUsingWriteAheadLogCdc SourcePostgresConfigurationReplicationMethodReadChangesUsingWriteAheadLogCdc
\n\nRecommended\n\n - Incrementally reads new inserts, updates, and deletes using the Postgres \n\nwrite-ahead log (WAL)\n\n. This needs to be configured on the source database itself. Recommended for tables of any size.
scanChangesWithUserDefinedCursor SourcePostgresConfigurationReplicationMethodScanChangesWithUserDefinedCursor
Incrementally detects new inserts and updates using the \n\ncursor column\n\n chosen when configuring a connection (e.g. createdat, updatedat).
detect_changes_with_xmin_system_column SourcePostgresConfigurationReplicationMethodDetectChangesWithXminSystemColumn
\n\nRecommended\n\n - Incrementally reads new inserts and updates via Postgres \n\nXmin system column\n\n. Suitable for databases that have low transaction pressure.
read_changes_using_write_ahead_log_cdc SourcePostgresConfigurationReplicationMethodReadChangesUsingWriteAheadLogCdc
\n\nRecommended\n\n - Incrementally reads new inserts, updates, and deletes using the Postgres \n\nwrite-ahead log (WAL)\n\n. This needs to be configured on the source database itself. Recommended for tables of any size.
scan_changes_with_user_defined_cursor SourcePostgresConfigurationReplicationMethodScanChangesWithUserDefinedCursor
Incrementally detects new inserts and updates using the \n\ncursor column\n\n chosen when configuring a connection (e.g. createdat, updatedat).
detectChangesWithXminSystemColumn Property Map
\n\nRecommended\n\n - Incrementally reads new inserts and updates via Postgres \n\nXmin system column\n\n. Suitable for databases that have low transaction pressure.
readChangesUsingWriteAheadLogCdc Property Map
\n\nRecommended\n\n - Incrementally reads new inserts, updates, and deletes using the Postgres \n\nwrite-ahead log (WAL)\n\n. This needs to be configured on the source database itself. Recommended for tables of any size.
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).

SourcePostgresConfigurationReplicationMethodReadChangesUsingWriteAheadLogCdc
, SourcePostgresConfigurationReplicationMethodReadChangesUsingWriteAheadLogCdcArgs

Publication This property is required. string
A Postgres publication used for consuming changes. Read about \n\npublications and replication identities\n\n.
ReplicationSlot This property is required. string
A plugin logical replication slot. Read about \n\nreplication slots\n\n.
AdditionalProperties string
Parsed as JSON.
HeartbeatActionQuery string
Specifies a query that the connector executes on the source database when the connector sends a heartbeat message. Please see the \n\nsetup guide\n\n for how and when to configure this setting. Default: ""
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 1200 seconds. Valid range: 120 seconds to 2400 seconds. Read about \n\ninitial waiting time\n\n. Default: 1200
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"]
LsnCommitBehaviour string
Determines when Airbyte should flush the LSN of processed WAL logs in the source database. After loading Data in the destination is default. If While reading Data is selected, in case of a downstream failure (while loading data into the destination), next sync would result in a full sync. Default: "After loading Data in the destination"; must be one of ["While reading Data", "After loading Data in the destination"]
Plugin string
A logical decoding plugin installed on the PostgreSQL server. Default: "pgoutput"; must be "pgoutput"
QueueSize double
The size of the internal queue. This may interfere with memory consumption and efficiency of the connector, please be careful. Default: 10000
Publication This property is required. string
A Postgres publication used for consuming changes. Read about \n\npublications and replication identities\n\n.
ReplicationSlot This property is required. string
A plugin logical replication slot. Read about \n\nreplication slots\n\n.
AdditionalProperties string
Parsed as JSON.
HeartbeatActionQuery string
Specifies a query that the connector executes on the source database when the connector sends a heartbeat message. Please see the \n\nsetup guide\n\n for how and when to configure this setting. Default: ""
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 1200 seconds. Valid range: 120 seconds to 2400 seconds. Read about \n\ninitial waiting time\n\n. Default: 1200
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"]
LsnCommitBehaviour string
Determines when Airbyte should flush the LSN of processed WAL logs in the source database. After loading Data in the destination is default. If While reading Data is selected, in case of a downstream failure (while loading data into the destination), next sync would result in a full sync. Default: "After loading Data in the destination"; must be one of ["While reading Data", "After loading Data in the destination"]
Plugin string
A logical decoding plugin installed on the PostgreSQL server. Default: "pgoutput"; must be "pgoutput"
QueueSize float64
The size of the internal queue. This may interfere with memory consumption and efficiency of the connector, please be careful. Default: 10000
publication This property is required. String
A Postgres publication used for consuming changes. Read about \n\npublications and replication identities\n\n.
replicationSlot This property is required. String
A plugin logical replication slot. Read about \n\nreplication slots\n\n.
additionalProperties String
Parsed as JSON.
heartbeatActionQuery String
Specifies a query that the connector executes on the source database when the connector sends a heartbeat message. Please see the \n\nsetup guide\n\n for how and when to configure this setting. Default: ""
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 1200 seconds. Valid range: 120 seconds to 2400 seconds. Read about \n\ninitial waiting time\n\n. Default: 1200
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"]
lsnCommitBehaviour String
Determines when Airbyte should flush the LSN of processed WAL logs in the source database. After loading Data in the destination is default. If While reading Data is selected, in case of a downstream failure (while loading data into the destination), next sync would result in a full sync. Default: "After loading Data in the destination"; must be one of ["While reading Data", "After loading Data in the destination"]
plugin String
A logical decoding plugin installed on the PostgreSQL server. Default: "pgoutput"; must be "pgoutput"
queueSize Double
The size of the internal queue. This may interfere with memory consumption and efficiency of the connector, please be careful. Default: 10000
publication This property is required. string
A Postgres publication used for consuming changes. Read about \n\npublications and replication identities\n\n.
replicationSlot This property is required. string
A plugin logical replication slot. Read about \n\nreplication slots\n\n.
additionalProperties string
Parsed as JSON.
heartbeatActionQuery string
Specifies a query that the connector executes on the source database when the connector sends a heartbeat message. Please see the \n\nsetup guide\n\n for how and when to configure this setting. Default: ""
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 1200 seconds. Valid range: 120 seconds to 2400 seconds. Read about \n\ninitial waiting time\n\n. Default: 1200
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"]
lsnCommitBehaviour string
Determines when Airbyte should flush the LSN of processed WAL logs in the source database. After loading Data in the destination is default. If While reading Data is selected, in case of a downstream failure (while loading data into the destination), next sync would result in a full sync. Default: "After loading Data in the destination"; must be one of ["While reading Data", "After loading Data in the destination"]
plugin string
A logical decoding plugin installed on the PostgreSQL server. Default: "pgoutput"; must be "pgoutput"
queueSize number
The size of the internal queue. This may interfere with memory consumption and efficiency of the connector, please be careful. Default: 10000
publication This property is required. str
A Postgres publication used for consuming changes. Read about \n\npublications and replication identities\n\n.
replication_slot This property is required. str
A plugin logical replication slot. Read about \n\nreplication slots\n\n.
additional_properties str
Parsed as JSON.
heartbeat_action_query str
Specifies a query that the connector executes on the source database when the connector sends a heartbeat message. Please see the \n\nsetup guide\n\n for how and when to configure this setting. Default: ""
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 1200 seconds. Valid range: 120 seconds to 2400 seconds. Read about \n\ninitial waiting time\n\n. Default: 1200
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"]
lsn_commit_behaviour str
Determines when Airbyte should flush the LSN of processed WAL logs in the source database. After loading Data in the destination is default. If While reading Data is selected, in case of a downstream failure (while loading data into the destination), next sync would result in a full sync. Default: "After loading Data in the destination"; must be one of ["While reading Data", "After loading Data in the destination"]
plugin str
A logical decoding plugin installed on the PostgreSQL server. Default: "pgoutput"; must be "pgoutput"
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
publication This property is required. String
A Postgres publication used for consuming changes. Read about \n\npublications and replication identities\n\n.
replicationSlot This property is required. String
A plugin logical replication slot. Read about \n\nreplication slots\n\n.
additionalProperties String
Parsed as JSON.
heartbeatActionQuery String
Specifies a query that the connector executes on the source database when the connector sends a heartbeat message. Please see the \n\nsetup guide\n\n for how and when to configure this setting. Default: ""
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 1200 seconds. Valid range: 120 seconds to 2400 seconds. Read about \n\ninitial waiting time\n\n. Default: 1200
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"]
lsnCommitBehaviour String
Determines when Airbyte should flush the LSN of processed WAL logs in the source database. After loading Data in the destination is default. If While reading Data is selected, in case of a downstream failure (while loading data into the destination), next sync would result in a full sync. Default: "After loading Data in the destination"; must be one of ["While reading Data", "After loading Data in the destination"]
plugin String
A logical decoding plugin installed on the PostgreSQL server. Default: "pgoutput"; must be "pgoutput"
queueSize Number
The size of the internal queue. This may interfere with memory consumption and efficiency of the connector, please be careful. Default: 10000

SourcePostgresConfigurationSslMode
, SourcePostgresConfigurationSslModeArgs

Allow SourcePostgresConfigurationSslModeAllow
Enables encryption only when required by the source database.
Disable SourcePostgresConfigurationSslModeDisable
Disables encryption of communication between Airbyte and source database.
Prefer SourcePostgresConfigurationSslModePrefer
Allows unencrypted connection only if the source database does not support encryption.
Require SourcePostgresConfigurationSslModeRequire
Always require encryption. If the source database server does not support encryption, connection will fail.
VerifyCa SourcePostgresConfigurationSslModeVerifyCa
Always require encryption and verifies that the source database server has a valid SSL certificate.
VerifyFull SourcePostgresConfigurationSslModeVerifyFull
This is the most secure mode. Always require encryption and verifies the identity of the source database server.
Allow SourcePostgresConfigurationSslModeAllow
Enables encryption only when required by the source database.
Disable SourcePostgresConfigurationSslModeDisable
Disables encryption of communication between Airbyte and source database.
Prefer SourcePostgresConfigurationSslModePrefer
Allows unencrypted connection only if the source database does not support encryption.
Require SourcePostgresConfigurationSslModeRequire
Always require encryption. If the source database server does not support encryption, connection will fail.
VerifyCa SourcePostgresConfigurationSslModeVerifyCa
Always require encryption and verifies that the source database server has a valid SSL certificate.
VerifyFull SourcePostgresConfigurationSslModeVerifyFull
This is the most secure mode. Always require encryption and verifies the identity of the source database server.
allow SourcePostgresConfigurationSslModeAllow
Enables encryption only when required by the source database.
disable SourcePostgresConfigurationSslModeDisable
Disables encryption of communication between Airbyte and source database.
prefer SourcePostgresConfigurationSslModePrefer
Allows unencrypted connection only if the source database does not support encryption.
require SourcePostgresConfigurationSslModeRequire
Always require encryption. If the source database server does not support encryption, connection will fail.
verifyCa SourcePostgresConfigurationSslModeVerifyCa
Always require encryption and verifies that the source database server has a valid SSL certificate.
verifyFull SourcePostgresConfigurationSslModeVerifyFull
This is the most secure mode. Always require encryption and verifies the identity of the source database server.
allow SourcePostgresConfigurationSslModeAllow
Enables encryption only when required by the source database.
disable SourcePostgresConfigurationSslModeDisable
Disables encryption of communication between Airbyte and source database.
prefer SourcePostgresConfigurationSslModePrefer
Allows unencrypted connection only if the source database does not support encryption.
require SourcePostgresConfigurationSslModeRequire
Always require encryption. If the source database server does not support encryption, connection will fail.
verifyCa SourcePostgresConfigurationSslModeVerifyCa
Always require encryption and verifies that the source database server has a valid SSL certificate.
verifyFull SourcePostgresConfigurationSslModeVerifyFull
This is the most secure mode. Always require encryption and verifies the identity of the source database server.
allow SourcePostgresConfigurationSslModeAllow
Enables encryption only when required by the source database.
disable SourcePostgresConfigurationSslModeDisable
Disables encryption of communication between Airbyte and source database.
prefer SourcePostgresConfigurationSslModePrefer
Allows unencrypted connection only if the source database does not support encryption.
require SourcePostgresConfigurationSslModeRequire
Always require encryption. If the source database server does not support encryption, connection will fail.
verify_ca SourcePostgresConfigurationSslModeVerifyCa
Always require encryption and verifies that the source database server has a valid SSL certificate.
verify_full SourcePostgresConfigurationSslModeVerifyFull
This is the most secure mode. Always require encryption and verifies the identity of the source database server.
allow Property Map
Enables encryption only when required by the source database.
disable Property Map
Disables encryption of communication between Airbyte and source database.
prefer Property Map
Allows unencrypted connection only if the source database does not support encryption.
require Property Map
Always require encryption. If the source database server does not support encryption, connection will fail.
verifyCa Property Map
Always require encryption and verifies that the source database server has a valid SSL certificate.
verifyFull Property Map
This is the most secure mode. Always require encryption and verifies the identity of the source database server.

SourcePostgresConfigurationSslModeAllow
, SourcePostgresConfigurationSslModeAllowArgs

AdditionalProperties string
Parsed as JSON.
AdditionalProperties string
Parsed as JSON.
additionalProperties String
Parsed as JSON.
additionalProperties string
Parsed as JSON.
additional_properties str
Parsed as JSON.
additionalProperties String
Parsed as JSON.

SourcePostgresConfigurationSslModeDisable
, SourcePostgresConfigurationSslModeDisableArgs

AdditionalProperties string
Parsed as JSON.
AdditionalProperties string
Parsed as JSON.
additionalProperties String
Parsed as JSON.
additionalProperties string
Parsed as JSON.
additional_properties str
Parsed as JSON.
additionalProperties String
Parsed as JSON.

SourcePostgresConfigurationSslModePrefer
, SourcePostgresConfigurationSslModePreferArgs

AdditionalProperties string
Parsed as JSON.
AdditionalProperties string
Parsed as JSON.
additionalProperties String
Parsed as JSON.
additionalProperties string
Parsed as JSON.
additional_properties str
Parsed as JSON.
additionalProperties String
Parsed as JSON.

SourcePostgresConfigurationSslModeRequire
, SourcePostgresConfigurationSslModeRequireArgs

AdditionalProperties string
Parsed as JSON.
AdditionalProperties string
Parsed as JSON.
additionalProperties String
Parsed as JSON.
additionalProperties string
Parsed as JSON.
additional_properties str
Parsed as JSON.
additionalProperties String
Parsed as JSON.

SourcePostgresConfigurationSslModeVerifyCa
, SourcePostgresConfigurationSslModeVerifyCaArgs

CaCertificate This property is required. string
CA certificate
AdditionalProperties string
Parsed as JSON.
ClientCertificate string
Client certificate
ClientKey string
Client key
ClientKeyPassword string
Password for keystorage. If you do not add it - the password will be generated automatically.
CaCertificate This property is required. string
CA certificate
AdditionalProperties string
Parsed as JSON.
ClientCertificate string
Client certificate
ClientKey string
Client key
ClientKeyPassword string
Password for keystorage. If you do not add it - the password will be generated automatically.
caCertificate This property is required. String
CA certificate
additionalProperties String
Parsed as JSON.
clientCertificate String
Client certificate
clientKey String
Client key
clientKeyPassword String
Password for keystorage. If you do not add it - the password will be generated automatically.
caCertificate This property is required. string
CA certificate
additionalProperties string
Parsed as JSON.
clientCertificate string
Client certificate
clientKey string
Client key
clientKeyPassword string
Password for keystorage. If you do not add it - the password will be generated automatically.
ca_certificate This property is required. str
CA certificate
additional_properties str
Parsed as JSON.
client_certificate str
Client certificate
client_key str
Client key
client_key_password str
Password for keystorage. If you do not add it - the password will be generated automatically.
caCertificate This property is required. String
CA certificate
additionalProperties String
Parsed as JSON.
clientCertificate String
Client certificate
clientKey String
Client key
clientKeyPassword String
Password for keystorage. If you do not add it - the password will be generated automatically.

SourcePostgresConfigurationSslModeVerifyFull
, SourcePostgresConfigurationSslModeVerifyFullArgs

CaCertificate This property is required. string
CA certificate
AdditionalProperties string
Parsed as JSON.
ClientCertificate string
Client certificate
ClientKey string
Client key
ClientKeyPassword string
Password for keystorage. If you do not add it - the password will be generated automatically.
CaCertificate This property is required. string
CA certificate
AdditionalProperties string
Parsed as JSON.
ClientCertificate string
Client certificate
ClientKey string
Client key
ClientKeyPassword string
Password for keystorage. If you do not add it - the password will be generated automatically.
caCertificate This property is required. String
CA certificate
additionalProperties String
Parsed as JSON.
clientCertificate String
Client certificate
clientKey String
Client key
clientKeyPassword String
Password for keystorage. If you do not add it - the password will be generated automatically.
caCertificate This property is required. string
CA certificate
additionalProperties string
Parsed as JSON.
clientCertificate string
Client certificate
clientKey string
Client key
clientKeyPassword string
Password for keystorage. If you do not add it - the password will be generated automatically.
ca_certificate This property is required. str
CA certificate
additional_properties str
Parsed as JSON.
client_certificate str
Client certificate
client_key str
Client key
client_key_password str
Password for keystorage. If you do not add it - the password will be generated automatically.
caCertificate This property is required. String
CA certificate
additionalProperties String
Parsed as JSON.
clientCertificate String
Client certificate
clientKey String
Client key
clientKeyPassword String
Password for keystorage. If you do not add it - the password will be generated automatically.

SourcePostgresConfigurationTunnelMethod
, SourcePostgresConfigurationTunnelMethodArgs

SourcePostgresConfigurationTunnelMethodPasswordAuthentication
, SourcePostgresConfigurationTunnelMethodPasswordAuthenticationArgs

TunnelHost This property is required. string
Hostname of the jump server host that allows inbound ssh tunnel.
TunnelUser This property is required. string
OS-level username for logging into the jump server host
TunnelUserPassword This property is required. 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 This property is required. string
Hostname of the jump server host that allows inbound ssh tunnel.
TunnelUser This property is required. string
OS-level username for logging into the jump server host
TunnelUserPassword This property is required. 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 This property is required. String
Hostname of the jump server host that allows inbound ssh tunnel.
tunnelUser This property is required. String
OS-level username for logging into the jump server host
tunnelUserPassword This property is required. 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 This property is required. string
Hostname of the jump server host that allows inbound ssh tunnel.
tunnelUser This property is required. string
OS-level username for logging into the jump server host
tunnelUserPassword This property is required. 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 This property is required. str
Hostname of the jump server host that allows inbound ssh tunnel.
tunnel_user This property is required. str
OS-level username for logging into the jump server host
tunnel_user_password This property is required. 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 This property is required. String
Hostname of the jump server host that allows inbound ssh tunnel.
tunnelUser This property is required. String
OS-level username for logging into the jump server host
tunnelUserPassword This property is required. 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

SourcePostgresConfigurationTunnelMethodSshKeyAuthentication
, SourcePostgresConfigurationTunnelMethodSshKeyAuthenticationArgs

SshKey This property is required. string
OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )
TunnelHost This property is required. string
Hostname of the jump server host that allows inbound ssh tunnel.
TunnelUser This property is required. 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 This property is required. string
OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )
TunnelHost This property is required. string
Hostname of the jump server host that allows inbound ssh tunnel.
TunnelUser This property is required. 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 This property is required. String
OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )
tunnelHost This property is required. String
Hostname of the jump server host that allows inbound ssh tunnel.
tunnelUser This property is required. 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 This property is required. string
OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )
tunnelHost This property is required. string
Hostname of the jump server host that allows inbound ssh tunnel.
tunnelUser This property is required. 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 This property is required. 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 This property is required. str
Hostname of the jump server host that allows inbound ssh tunnel.
tunnel_user This property is required. 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 This property is required. String
OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )
tunnelHost This property is required. String
Hostname of the jump server host that allows inbound ssh tunnel.
tunnelUser This property is required. 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

SourcePostgresResourceAllocation
, SourcePostgresResourceAllocationArgs

Default SourcePostgresResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
JobSpecifics List<SourcePostgresResourceAllocationJobSpecific>
Default SourcePostgresResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
JobSpecifics []SourcePostgresResourceAllocationJobSpecific
default_ SourcePostgresResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics List<SourcePostgresResourceAllocationJobSpecific>
default SourcePostgresResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics SourcePostgresResourceAllocationJobSpecific[]
default SourcePostgresResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
job_specifics Sequence[SourcePostgresResourceAllocationJobSpecific]
default Property Map
optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics List<Property Map>

SourcePostgresResourceAllocationDefault
, SourcePostgresResourceAllocationDefaultArgs

SourcePostgresResourceAllocationJobSpecific
, SourcePostgresResourceAllocationJobSpecificArgs

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 SourcePostgresResourceAllocationJobSpecificResourceRequirements
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 SourcePostgresResourceAllocationJobSpecificResourceRequirements
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 SourcePostgresResourceAllocationJobSpecificResourceRequirements
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 SourcePostgresResourceAllocationJobSpecificResourceRequirements
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 SourcePostgresResourceAllocationJobSpecificResourceRequirements
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)

SourcePostgresResourceAllocationJobSpecificResourceRequirements
, SourcePostgresResourceAllocationJobSpecificResourceRequirementsArgs

Import

$ pulumi import airbyte:index/sourcePostgres:SourcePostgres my_airbyte_source_postgres ""
Copy

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.