getConnection

airbyte 1.0.0, Mar 4 26

Viewing docs for airbyte 1.0.0
published on Wednesday, Mar 4, 2026 by airbytehq

Schema (JSON)

airbytehq/terraform-provider-airbyte

Viewing docs for airbyte 1.0.0
published on Wednesday, Mar 4, 2026 by airbytehq

Schema (JSON)

airbytehq/terraform-provider-airbyte

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as airbyte from "@pulumi/airbyte";

const myConnection = airbyte.getConnection({
    connectionId: "...my_connection_id...",
});

import pulumi
import pulumi_airbyte as airbyte

my_connection = airbyte.get_connection(connection_id="...my_connection_id...")

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/airbyte/airbyte"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := airbyte.LookupConnection(ctx, &airbyte.LookupConnectionArgs{
			ConnectionId: "...my_connection_id...",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Airbyte = Pulumi.Airbyte;

return await Deployment.RunAsync(() => 
{
    var myConnection = Airbyte.GetConnection.Invoke(new()
    {
        ConnectionId = "...my_connection_id...",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.airbyte.AirbyteFunctions;
import com.pulumi.airbyte.inputs.GetConnectionArgs;
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) {
        final var myConnection = AirbyteFunctions.getConnection(GetConnectionArgs.builder()
            .connectionId("...my_connection_id...")
            .build());

    }
}

variables:
  myConnection:
    fn::invoke:
      function: airbyte:getConnection
      arguments:
        connectionId: '...my_connection_id...'

Using getConnection

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getConnection(args: GetConnectionArgs, opts?: InvokeOptions): Promise<GetConnectionResult>
function getConnectionOutput(args: GetConnectionOutputArgs, opts?: InvokeOptions): Output<GetConnectionResult>

def get_connection(connection_id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetConnectionResult
def get_connection_output(connection_id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetConnectionResult]

func LookupConnection(ctx *Context, args *LookupConnectionArgs, opts ...InvokeOption) (*LookupConnectionResult, error)
func LookupConnectionOutput(ctx *Context, args *LookupConnectionOutputArgs, opts ...InvokeOption) LookupConnectionResultOutput

> Note: This function is named LookupConnection in the Go SDK.

public static class GetConnection 
{
    public static Task<GetConnectionResult> InvokeAsync(GetConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetConnectionResult> Invoke(GetConnectionInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetConnectionResult> getConnection(GetConnectionArgs args, InvokeOptions options)
public static Output<GetConnectionResult> getConnection(GetConnectionArgs args, InvokeOptions options)

fn::invoke:
  function: airbyte:index/getConnection:getConnection
  arguments:
    # arguments dictionary

The following arguments are supported:

ConnectionId string

ConnectionId string

connectionId String

connectionId string

connection_id str

connectionId String

getConnection Result

The following output properties are available:

Configurations GetConnectionConfigurations: A list of configured stream options for a connection.
ConnectionId string
CreatedAt double
DestinationId string
Id string: The provider-assigned unique ID for this managed resource.
Name string
NamespaceDefinition string: Define the location where the data will be stored in the destination
NamespaceFormat string
NonBreakingSchemaUpdatesBehavior string: Set how Airbyte handles syncs when it detects a non-breaking schema change in the source
Prefix string
Schedule GetConnectionSchedule: schedule for when the the connection should run, per the schedule type
SourceId string
Status string
StatusReason string
Tags List<GetConnectionTag>
WorkspaceId string

Configurations GetConnectionConfigurations: A list of configured stream options for a connection.
ConnectionId string
CreatedAt float64
DestinationId string
Id string: The provider-assigned unique ID for this managed resource.
Name string
NamespaceDefinition string: Define the location where the data will be stored in the destination
NamespaceFormat string
NonBreakingSchemaUpdatesBehavior string: Set how Airbyte handles syncs when it detects a non-breaking schema change in the source
Prefix string
Schedule GetConnectionSchedule: schedule for when the the connection should run, per the schedule type
SourceId string
Status string
StatusReason string
Tags []GetConnectionTag
WorkspaceId string

configurations GetConnectionConfigurations: A list of configured stream options for a connection.
connectionId String
createdAt Double
destinationId String
id String: The provider-assigned unique ID for this managed resource.
name String
namespaceDefinition String: Define the location where the data will be stored in the destination
namespaceFormat String
nonBreakingSchemaUpdatesBehavior String: Set how Airbyte handles syncs when it detects a non-breaking schema change in the source
prefix String
schedule GetConnectionSchedule: schedule for when the the connection should run, per the schedule type
sourceId String
status String
statusReason String
tags List<GetConnectionTag>
workspaceId String

configurations GetConnectionConfigurations: A list of configured stream options for a connection.
connectionId string
createdAt number
destinationId string
id string: The provider-assigned unique ID for this managed resource.
name string
namespaceDefinition string: Define the location where the data will be stored in the destination
namespaceFormat string
nonBreakingSchemaUpdatesBehavior string: Set how Airbyte handles syncs when it detects a non-breaking schema change in the source
prefix string
schedule GetConnectionSchedule: schedule for when the the connection should run, per the schedule type
sourceId string
status string
statusReason string
tags GetConnectionTag[]
workspaceId string

configurations GetConnectionConfigurations: A list of configured stream options for a connection.
connection_id str
created_at float
destination_id str
id str: The provider-assigned unique ID for this managed resource.
name str
namespace_definition str: Define the location where the data will be stored in the destination
namespace_format str
non_breaking_schema_updates_behavior str: Set how Airbyte handles syncs when it detects a non-breaking schema change in the source
prefix str
schedule GetConnectionSchedule: schedule for when the the connection should run, per the schedule type
source_id str
status str
status_reason str
tags Sequence[GetConnectionTag]
workspace_id str

configurations Property Map: A list of configured stream options for a connection.
connectionId String
createdAt Number
destinationId String
id String: The provider-assigned unique ID for this managed resource.
name String
namespaceDefinition String: Define the location where the data will be stored in the destination
namespaceFormat String
nonBreakingSchemaUpdatesBehavior String: Set how Airbyte handles syncs when it detects a non-breaking schema change in the source
prefix String
schedule Property Map: schedule for when the the connection should run, per the schedule type
sourceId String
status String
statusReason String
tags List<Property Map>
workspaceId String

Supporting Types

GetConnectionConfigurations

Streams List<GetConnectionConfigurationsStream>

Streams []GetConnectionConfigurationsStream

streams List<GetConnectionConfigurationsStream>

streams GetConnectionConfigurationsStream[]

streams Sequence[GetConnectionConfigurationsStream]

streams List<Property Map>

GetConnectionConfigurationsStream

CursorFields List<string>: Path to the field that will be used to determine if a record is new or modified since the last sync. This field is REQUIRED if sync_mode is incremental unless there is a default.
DestinationObjectName string: The name of the destination object that this stream will be written to, used for data activation destinations.
IncludeFiles bool: Whether to move raw files from the source to the destination during the sync.
Mappers List<GetConnectionConfigurationsStreamMapper>: Mappers that should be applied to the stream before writing to the destination.
Name string
Namespace string: Namespace of the stream.
PrimaryKeys List<ImmutableArray<string>>: Paths to the fields that will be used as primary key. This field is REQUIRED if destination_sync_mode is *_dedup unless it is already supplied by the source schema.
SelectedFields List<GetConnectionConfigurationsStreamSelectedField>: Paths to the fields that will be included in the configured catalog.
SyncMode string

CursorFields []string: Path to the field that will be used to determine if a record is new or modified since the last sync. This field is REQUIRED if sync_mode is incremental unless there is a default.
DestinationObjectName string: The name of the destination object that this stream will be written to, used for data activation destinations.
IncludeFiles bool: Whether to move raw files from the source to the destination during the sync.
Mappers []GetConnectionConfigurationsStreamMapper: Mappers that should be applied to the stream before writing to the destination.
Name string
Namespace string: Namespace of the stream.
PrimaryKeys [][]string: Paths to the fields that will be used as primary key. This field is REQUIRED if destination_sync_mode is *_dedup unless it is already supplied by the source schema.
SelectedFields []GetConnectionConfigurationsStreamSelectedField: Paths to the fields that will be included in the configured catalog.
SyncMode string

cursorFields List<String>: Path to the field that will be used to determine if a record is new or modified since the last sync. This field is REQUIRED if sync_mode is incremental unless there is a default.
destinationObjectName String: The name of the destination object that this stream will be written to, used for data activation destinations.
includeFiles Boolean: Whether to move raw files from the source to the destination during the sync.
mappers List<GetConnectionConfigurationsStreamMapper>: Mappers that should be applied to the stream before writing to the destination.
name String
namespace String: Namespace of the stream.
primaryKeys List<List<String>>: Paths to the fields that will be used as primary key. This field is REQUIRED if destination_sync_mode is *_dedup unless it is already supplied by the source schema.
selectedFields List<GetConnectionConfigurationsStreamSelectedField>: Paths to the fields that will be included in the configured catalog.
syncMode String

cursorFields string[]: Path to the field that will be used to determine if a record is new or modified since the last sync. This field is REQUIRED if sync_mode is incremental unless there is a default.
destinationObjectName string: The name of the destination object that this stream will be written to, used for data activation destinations.
includeFiles boolean: Whether to move raw files from the source to the destination during the sync.
mappers GetConnectionConfigurationsStreamMapper[]: Mappers that should be applied to the stream before writing to the destination.
name string
namespace string: Namespace of the stream.
primaryKeys string[][]: Paths to the fields that will be used as primary key. This field is REQUIRED if destination_sync_mode is *_dedup unless it is already supplied by the source schema.
selectedFields GetConnectionConfigurationsStreamSelectedField[]: Paths to the fields that will be included in the configured catalog.
syncMode string

cursor_fields Sequence[str]: Path to the field that will be used to determine if a record is new or modified since the last sync. This field is REQUIRED if sync_mode is incremental unless there is a default.
destination_object_name str: The name of the destination object that this stream will be written to, used for data activation destinations.
include_files bool: Whether to move raw files from the source to the destination during the sync.
mappers Sequence[GetConnectionConfigurationsStreamMapper]: Mappers that should be applied to the stream before writing to the destination.
name str
namespace str: Namespace of the stream.
primary_keys Sequence[Sequence[str]]: Paths to the fields that will be used as primary key. This field is REQUIRED if destination_sync_mode is *_dedup unless it is already supplied by the source schema.
selected_fields Sequence[GetConnectionConfigurationsStreamSelectedField]: Paths to the fields that will be included in the configured catalog.
sync_mode str

cursorFields List<String>: Path to the field that will be used to determine if a record is new or modified since the last sync. This field is REQUIRED if sync_mode is incremental unless there is a default.
destinationObjectName String: The name of the destination object that this stream will be written to, used for data activation destinations.
includeFiles Boolean: Whether to move raw files from the source to the destination during the sync.
mappers List<Property Map>: Mappers that should be applied to the stream before writing to the destination.
name String
namespace String: Namespace of the stream.
primaryKeys List<List<String>>: Paths to the fields that will be used as primary key. This field is REQUIRED if destination_sync_mode is *_dedup unless it is already supplied by the source schema.
selectedFields List<Property Map>: Paths to the fields that will be included in the configured catalog.
syncMode String

GetConnectionConfigurationsStreamMapper

Id string
MapperConfiguration GetConnectionConfigurationsStreamMapperMapperConfiguration: The values required to configure the mapper.
Type string

Id string
MapperConfiguration GetConnectionConfigurationsStreamMapperMapperConfiguration: The values required to configure the mapper.
Type string

id String
mapperConfiguration GetConnectionConfigurationsStreamMapperMapperConfiguration: The values required to configure the mapper.
type String

id string
mapperConfiguration GetConnectionConfigurationsStreamMapperMapperConfiguration: The values required to configure the mapper.
type string

id str
mapper_configuration GetConnectionConfigurationsStreamMapperMapperConfiguration: The values required to configure the mapper.
type str

id String
mapperConfiguration Property Map: The values required to configure the mapper.
type String

GetConnectionConfigurationsStreamMapperMapperConfigurationFieldFiltering

TargetField string: The name of the field to filter.

TargetField string: The name of the field to filter.

targetField String: The name of the field to filter.

targetField string: The name of the field to filter.

target_field str: The name of the field to filter.

targetField String: The name of the field to filter.

GetConnectionConfigurationsStreamMapperMapperConfigurationFieldRenaming

NewFieldName string: The new name for the field after renaming.
OriginalFieldName string: The current name of the field to rename.

NewFieldName string: The new name for the field after renaming.
OriginalFieldName string: The current name of the field to rename.

newFieldName String: The new name for the field after renaming.
originalFieldName String: The current name of the field to rename.

newFieldName string: The new name for the field after renaming.
originalFieldName string: The current name of the field to rename.

new_field_name str: The new name for the field after renaming.
original_field_name str: The current name of the field to rename.

newFieldName String: The new name for the field after renaming.
originalFieldName String: The current name of the field to rename.

GetConnectionConfigurationsStreamMapperMapperConfigurationHashing

FieldNameSuffix string: The suffix to append to the field name after hashing.
Method string: The hashing algorithm to use.
TargetField string: The name of the field to be hashed.

FieldNameSuffix string: The suffix to append to the field name after hashing.
Method string: The hashing algorithm to use.
TargetField string: The name of the field to be hashed.

fieldNameSuffix String: The suffix to append to the field name after hashing.
method String: The hashing algorithm to use.
targetField String: The name of the field to be hashed.

fieldNameSuffix string: The suffix to append to the field name after hashing.
method string: The hashing algorithm to use.
targetField string: The name of the field to be hashed.

field_name_suffix str: The suffix to append to the field name after hashing.
method str: The hashing algorithm to use.
target_field str: The name of the field to be hashed.

fieldNameSuffix String: The suffix to append to the field name after hashing.
method String: The hashing algorithm to use.
targetField String: The name of the field to be hashed.