1. Packages
  2. Airbyte Provider
  3. API Docs
  4. getConnection
airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

airbyte.getConnection

Explore with Pulumi AI

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

Connection DataSource

Example Usage

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

const myConnection = airbyte.getConnection({
    connectionId: "...my_connection_id...",
});
Copy
import pulumi
import pulumi_airbyte as airbyte

my_connection = airbyte.get_connection(connection_id="...my_connection_id...")
Copy
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
	})
}
Copy
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...",
    });

});
Copy
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());

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

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>
Copy
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]
Copy
func LookupConnection(ctx *Context, args *LookupConnectionArgs, opts ...InvokeOption) (*LookupConnectionResult, error)
func LookupConnectionOutput(ctx *Context, args *LookupConnectionOutputArgs, opts ...InvokeOption) LookupConnectionResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetConnectionResult> getConnection(GetConnectionArgs args, InvokeOptions options)
public static Output<GetConnectionResult> getConnection(GetConnectionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: airbyte:index/getConnection:getConnection
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ConnectionId This property is required. string
ConnectionId This property is required. string
connectionId This property is required. String
connectionId This property is required. string
connection_id This property is required. str
connectionId This property is required. String

getConnection Result

The following output properties are available:

Configurations GetConnectionConfigurations
A list of configured stream options for a connection.
ConnectionId string
CreatedAt double
DataResidency string
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
Tags List<GetConnectionTag>
WorkspaceId string
Configurations GetConnectionConfigurations
A list of configured stream options for a connection.
ConnectionId string
CreatedAt float64
DataResidency string
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
Tags []GetConnectionTag
WorkspaceId string
configurations GetConnectionConfigurations
A list of configured stream options for a connection.
connectionId String
createdAt Double
dataResidency String
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
tags List<GetConnectionTag>
workspaceId String
configurations GetConnectionConfigurations
A list of configured stream options for a connection.
connectionId string
createdAt number
dataResidency string
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
tags GetConnectionTag[]
workspaceId string
configurations GetConnectionConfigurations
A list of configured stream options for a connection.
connection_id str
created_at float
data_residency str
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
tags Sequence[GetConnectionTag]
workspace_id str
configurations Property Map
A list of configured stream options for a connection.
connectionId String
createdAt Number
dataResidency String
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
tags List<Property Map>
workspaceId String

Supporting Types

GetConnectionConfigurations

Streams This property is required. []GetConnectionConfigurationsStream
streams This property is required. GetConnectionConfigurationsStream[]
streams This property is required. List<Property Map>

GetConnectionConfigurationsStream

CursorFields This property is required. 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.
Mappers This property is required. List<GetConnectionConfigurationsStreamMapper>
Mappers that should be applied to the stream before writing to the destination.
Name This property is required. string
PrimaryKeys This property is required. 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 This property is required. List<GetConnectionConfigurationsStreamSelectedField>
Paths to the fields that will be included in the configured catalog.
SyncMode This property is required. string
CursorFields This property is required. []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.
Mappers This property is required. []GetConnectionConfigurationsStreamMapper
Mappers that should be applied to the stream before writing to the destination.
Name This property is required. string
PrimaryKeys This property is required. [][]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 This property is required. []GetConnectionConfigurationsStreamSelectedField
Paths to the fields that will be included in the configured catalog.
SyncMode This property is required. string
cursorFields This property is required. 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.
mappers This property is required. List<GetConnectionConfigurationsStreamMapper>
Mappers that should be applied to the stream before writing to the destination.
name This property is required. String
primaryKeys This property is required. 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 This property is required. List<GetConnectionConfigurationsStreamSelectedField>
Paths to the fields that will be included in the configured catalog.
syncMode This property is required. String
cursorFields This property is required. 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.
mappers This property is required. GetConnectionConfigurationsStreamMapper[]
Mappers that should be applied to the stream before writing to the destination.
name This property is required. string
primaryKeys This property is required. 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 This property is required. GetConnectionConfigurationsStreamSelectedField[]
Paths to the fields that will be included in the configured catalog.
syncMode This property is required. string
cursor_fields This property is required. 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.
mappers This property is required. Sequence[GetConnectionConfigurationsStreamMapper]
Mappers that should be applied to the stream before writing to the destination.
name This property is required. str
primary_keys This property is required. 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 This property is required. Sequence[GetConnectionConfigurationsStreamSelectedField]
Paths to the fields that will be included in the configured catalog.
sync_mode This property is required. str
cursorFields This property is required. 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.
mappers This property is required. List<Property Map>
Mappers that should be applied to the stream before writing to the destination.
name This property is required. String
primaryKeys This property is required. 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 This property is required. List<Property Map>
Paths to the fields that will be included in the configured catalog.
syncMode This property is required. String

GetConnectionConfigurationsStreamMapper

Id This property is required. string
MapperConfiguration This property is required. GetConnectionConfigurationsStreamMapperMapperConfiguration
The values required to configure the mapper.
Type This property is required. string
Id This property is required. string
MapperConfiguration This property is required. GetConnectionConfigurationsStreamMapperMapperConfiguration
The values required to configure the mapper.
Type This property is required. string
id This property is required. String
mapperConfiguration This property is required. GetConnectionConfigurationsStreamMapperMapperConfiguration
The values required to configure the mapper.
type This property is required. String
id This property is required. string
mapperConfiguration This property is required. GetConnectionConfigurationsStreamMapperMapperConfiguration
The values required to configure the mapper.
type This property is required. string
id This property is required. str
mapper_configuration This property is required. GetConnectionConfigurationsStreamMapperMapperConfiguration
The values required to configure the mapper.
type This property is required. str
id This property is required. String
mapperConfiguration This property is required. Property Map
The values required to configure the mapper.
type This property is required. String

GetConnectionConfigurationsStreamMapperMapperConfiguration

encryption This property is required. Property Map
fieldRenaming This property is required. Property Map
hashing This property is required. Property Map
rowFiltering This property is required. Property Map

GetConnectionConfigurationsStreamMapperMapperConfigurationEncryption

aes This property is required. Property Map
rsa This property is required. Property Map

GetConnectionConfigurationsStreamMapperMapperConfigurationEncryptionAes

Algorithm This property is required. string
FieldNameSuffix This property is required. string
Key This property is required. string
Mode This property is required. string
Padding This property is required. string
TargetField This property is required. string
Algorithm This property is required. string
FieldNameSuffix This property is required. string
Key This property is required. string
Mode This property is required. string
Padding This property is required. string
TargetField This property is required. string
algorithm This property is required. String
fieldNameSuffix This property is required. String
key This property is required. String
mode This property is required. String
padding This property is required. String
targetField This property is required. String
algorithm This property is required. string
fieldNameSuffix This property is required. string
key This property is required. string
mode This property is required. string
padding This property is required. string
targetField This property is required. string
algorithm This property is required. str
field_name_suffix This property is required. str
key This property is required. str
mode This property is required. str
padding This property is required. str
target_field This property is required. str
algorithm This property is required. String
fieldNameSuffix This property is required. String
key This property is required. String
mode This property is required. String
padding This property is required. String
targetField This property is required. String

GetConnectionConfigurationsStreamMapperMapperConfigurationEncryptionRsa

Algorithm This property is required. string
FieldNameSuffix This property is required. string
PublicKey This property is required. string
TargetField This property is required. string
Algorithm This property is required. string
FieldNameSuffix This property is required. string
PublicKey This property is required. string
TargetField This property is required. string
algorithm This property is required. String
fieldNameSuffix This property is required. String
publicKey This property is required. String
targetField This property is required. String
algorithm This property is required. string
fieldNameSuffix This property is required. string
publicKey This property is required. string
targetField This property is required. string
algorithm This property is required. str
field_name_suffix This property is required. str
public_key This property is required. str
target_field This property is required. str
algorithm This property is required. String
fieldNameSuffix This property is required. String
publicKey This property is required. String
targetField This property is required. String

GetConnectionConfigurationsStreamMapperMapperConfigurationFieldRenaming

NewFieldName This property is required. string
The new name for the field after renaming.
OriginalFieldName This property is required. string
The current name of the field to rename.
NewFieldName This property is required. string
The new name for the field after renaming.
OriginalFieldName This property is required. string
The current name of the field to rename.
newFieldName This property is required. String
The new name for the field after renaming.
originalFieldName This property is required. String
The current name of the field to rename.
newFieldName This property is required. string
The new name for the field after renaming.
originalFieldName This property is required. string
The current name of the field to rename.
new_field_name This property is required. str
The new name for the field after renaming.
original_field_name This property is required. str
The current name of the field to rename.
newFieldName This property is required. String
The new name for the field after renaming.
originalFieldName This property is required. String
The current name of the field to rename.

GetConnectionConfigurationsStreamMapperMapperConfigurationHashing

FieldNameSuffix This property is required. string
The suffix to append to the field name after hashing.
Method This property is required. string
The hashing algorithm to use.
TargetField This property is required. string
The name of the field to be hashed.
FieldNameSuffix This property is required. string
The suffix to append to the field name after hashing.
Method This property is required. string
The hashing algorithm to use.
TargetField This property is required. string
The name of the field to be hashed.
fieldNameSuffix This property is required. String
The suffix to append to the field name after hashing.
method This property is required. String
The hashing algorithm to use.
targetField This property is required. String
The name of the field to be hashed.
fieldNameSuffix This property is required. string
The suffix to append to the field name after hashing.
method This property is required. string
The hashing algorithm to use.
targetField This property is required. string
The name of the field to be hashed.
field_name_suffix This property is required. str
The suffix to append to the field name after hashing.
method This property is required. str
The hashing algorithm to use.
target_field This property is required. str
The name of the field to be hashed.
fieldNameSuffix This property is required. String
The suffix to append to the field name after hashing.
method This property is required. String
The hashing algorithm to use.
targetField This property is required. String
The name of the field to be hashed.

GetConnectionConfigurationsStreamMapperMapperConfigurationRowFiltering

Conditions This property is required. string
Parsed as JSON.
Conditions This property is required. string
Parsed as JSON.
conditions This property is required. String
Parsed as JSON.
conditions This property is required. string
Parsed as JSON.
conditions This property is required. str
Parsed as JSON.
conditions This property is required. String
Parsed as JSON.

GetConnectionConfigurationsStreamSelectedField

FieldPaths This property is required. List<string>
FieldPaths This property is required. []string
fieldPaths This property is required. List<String>
fieldPaths This property is required. string[]
field_paths This property is required. Sequence[str]
fieldPaths This property is required. List<String>

GetConnectionSchedule

BasicTiming This property is required. string
CronExpression This property is required. string
ScheduleType This property is required. string
BasicTiming This property is required. string
CronExpression This property is required. string
ScheduleType This property is required. string
basicTiming This property is required. String
cronExpression This property is required. String
scheduleType This property is required. String
basicTiming This property is required. string
cronExpression This property is required. string
scheduleType This property is required. string
basic_timing This property is required. str
cron_expression This property is required. str
schedule_type This property is required. str
basicTiming This property is required. String
cronExpression This property is required. String
scheduleType This property is required. String

GetConnectionTag

Color This property is required. string
Name This property is required. string
TagId This property is required. string
WorkspaceId This property is required. string
Color This property is required. string
Name This property is required. string
TagId This property is required. string
WorkspaceId This property is required. string
color This property is required. String
name This property is required. String
tagId This property is required. String
workspaceId This property is required. String
color This property is required. string
name This property is required. string
tagId This property is required. string
workspaceId This property is required. string
color This property is required. str
name This property is required. str
tag_id This property is required. str
workspace_id This property is required. str
color This property is required. String
name This property is required. String
tagId This property is required. String
workspaceId This property is required. String

Package Details

Repository
airbyte airbytehq/terraform-provider-airbyte
License
Notes
This Pulumi package is based on the airbyte Terraform Provider.
airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq