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...",
});
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:
- Connection
Id This property is required. string
- Connection
Id This property is required. string
- connection
Id This property is required. String
- connection
Id This property is required. string
- connection_
id This property is required. str
- connection
Id This property is required. String
getConnection Result
The following output properties are available:
- Configurations
Get
Connection Configurations - A list of configured stream options for a connection.
- Connection
Id string - Created
At double - Data
Residency string - Destination
Id string - Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Namespace
Definition string - Define the location where the data will be stored in the destination
- Namespace
Format string - Non
Breaking stringSchema Updates Behavior - Set how Airbyte handles syncs when it detects a non-breaking schema change in the source
- Prefix string
- Schedule
Get
Connection Schedule - schedule for when the the connection should run, per the schedule type
- Source
Id string - Status string
- List<Get
Connection Tag> - Workspace
Id string
- Configurations
Get
Connection Configurations - A list of configured stream options for a connection.
- Connection
Id string - Created
At float64 - Data
Residency string - Destination
Id string - Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Namespace
Definition string - Define the location where the data will be stored in the destination
- Namespace
Format string - Non
Breaking stringSchema Updates Behavior - Set how Airbyte handles syncs when it detects a non-breaking schema change in the source
- Prefix string
- Schedule
Get
Connection Schedule - schedule for when the the connection should run, per the schedule type
- Source
Id string - Status string
- []Get
Connection Tag - Workspace
Id string
- configurations
Get
Connection Configurations - A list of configured stream options for a connection.
- connection
Id String - created
At Double - data
Residency String - destination
Id String - id String
- The provider-assigned unique ID for this managed resource.
- name String
- namespace
Definition String - Define the location where the data will be stored in the destination
- namespace
Format String - non
Breaking StringSchema Updates Behavior - Set how Airbyte handles syncs when it detects a non-breaking schema change in the source
- prefix String
- schedule
Get
Connection Schedule - schedule for when the the connection should run, per the schedule type
- source
Id String - status String
- List<Get
Connection Tag> - workspace
Id String
- configurations
Get
Connection Configurations - A list of configured stream options for a connection.
- connection
Id string - created
At number - data
Residency string - destination
Id string - id string
- The provider-assigned unique ID for this managed resource.
- name string
- namespace
Definition string - Define the location where the data will be stored in the destination
- namespace
Format string - non
Breaking stringSchema Updates Behavior - Set how Airbyte handles syncs when it detects a non-breaking schema change in the source
- prefix string
- schedule
Get
Connection Schedule - schedule for when the the connection should run, per the schedule type
- source
Id string - status string
- Get
Connection Tag[] - workspace
Id string
- configurations
Get
Connection Configurations - 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_ strschema_ updates_ behavior - Set how Airbyte handles syncs when it detects a non-breaking schema change in the source
- prefix str
- schedule
Get
Connection Schedule - schedule for when the the connection should run, per the schedule type
- source_
id str - status str
- Sequence[Get
Connection Tag] - workspace_
id str
- configurations Property Map
- A list of configured stream options for a connection.
- connection
Id String - created
At Number - data
Residency String - destination
Id String - id String
- The provider-assigned unique ID for this managed resource.
- name String
- namespace
Definition String - Define the location where the data will be stored in the destination
- namespace
Format String - non
Breaking StringSchema Updates Behavior - 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
- source
Id String - status String
- List<Property Map>
- workspace
Id String
Supporting Types
GetConnectionConfigurations
- Streams
This property is required. List<GetConnection Configurations Stream>
- Streams
This property is required. []GetConnection Configurations Stream
- streams
This property is required. List<GetConnection Configurations Stream>
- streams
This property is required. GetConnection Configurations Stream[]
- streams
This property is required. Sequence[GetConnection Configurations Stream]
- streams
This property is required. List<Property Map>
GetConnectionConfigurationsStream
- Cursor
Fields 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
isincremental
unless there is a default. - Mappers
This property is required. List<GetConnection Configurations Stream Mapper> - Mappers that should be applied to the stream before writing to the destination.
- Name
This property is required. string - Primary
Keys 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. - Selected
Fields This property is required. List<GetConnection Configurations Stream Selected Field> - Paths to the fields that will be included in the configured catalog.
- Sync
Mode This property is required. string
- Cursor
Fields 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
isincremental
unless there is a default. - Mappers
This property is required. []GetConnection Configurations Stream Mapper - Mappers that should be applied to the stream before writing to the destination.
- Name
This property is required. string - Primary
Keys 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. - Selected
Fields This property is required. []GetConnection Configurations Stream Selected Field - Paths to the fields that will be included in the configured catalog.
- Sync
Mode This property is required. string
- cursor
Fields 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
isincremental
unless there is a default. - mappers
This property is required. List<GetConnection Configurations Stream Mapper> - Mappers that should be applied to the stream before writing to the destination.
- name
This property is required. String - primary
Keys 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. - selected
Fields This property is required. List<GetConnection Configurations Stream Selected Field> - Paths to the fields that will be included in the configured catalog.
- sync
Mode This property is required. String
- cursor
Fields 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
isincremental
unless there is a default. - mappers
This property is required. GetConnection Configurations Stream Mapper[] - Mappers that should be applied to the stream before writing to the destination.
- name
This property is required. string - primary
Keys 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. - selected
Fields This property is required. GetConnection Configurations Stream Selected Field[] - Paths to the fields that will be included in the configured catalog.
- sync
Mode 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
isincremental
unless there is a default. - mappers
This property is required. Sequence[GetConnection Configurations Stream Mapper] - 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[GetConnection Configurations Stream Selected Field] - Paths to the fields that will be included in the configured catalog.
- sync_
mode This property is required. str
- cursor
Fields 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
isincremental
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 - primary
Keys 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. - selected
Fields This property is required. List<Property Map> - Paths to the fields that will be included in the configured catalog.
- sync
Mode This property is required. String
GetConnectionConfigurationsStreamMapper
- Id
This property is required. string - Mapper
Configuration This property is required. GetConnection Configurations Stream Mapper Mapper Configuration - The values required to configure the mapper.
- Type
This property is required. string
- Id
This property is required. string - Mapper
Configuration This property is required. GetConnection Configurations Stream Mapper Mapper Configuration - The values required to configure the mapper.
- Type
This property is required. string
- id
This property is required. String - mapper
Configuration This property is required. GetConnection Configurations Stream Mapper Mapper Configuration - The values required to configure the mapper.
- type
This property is required. String
- id
This property is required. string - mapper
Configuration This property is required. GetConnection Configurations Stream Mapper Mapper Configuration - 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. GetConnection Configurations Stream Mapper Mapper Configuration - The values required to configure the mapper.
- type
This property is required. str
- id
This property is required. String - mapper
Configuration 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. GetConnection Configurations Stream Mapper Mapper Configuration Encryption - Field
Renaming This property is required. GetConnection Configurations Stream Mapper Mapper Configuration Field Renaming - Hashing
This property is required. GetConnection Configurations Stream Mapper Mapper Configuration Hashing - Row
Filtering This property is required. GetConnection Configurations Stream Mapper Mapper Configuration Row Filtering
- Encryption
This property is required. GetConnection Configurations Stream Mapper Mapper Configuration Encryption - Field
Renaming This property is required. GetConnection Configurations Stream Mapper Mapper Configuration Field Renaming - Hashing
This property is required. GetConnection Configurations Stream Mapper Mapper Configuration Hashing - Row
Filtering This property is required. GetConnection Configurations Stream Mapper Mapper Configuration Row Filtering
- encryption
This property is required. GetConnection Configurations Stream Mapper Mapper Configuration Encryption - field
Renaming This property is required. GetConnection Configurations Stream Mapper Mapper Configuration Field Renaming - hashing
This property is required. GetConnection Configurations Stream Mapper Mapper Configuration Hashing - row
Filtering This property is required. GetConnection Configurations Stream Mapper Mapper Configuration Row Filtering
- encryption
This property is required. GetConnection Configurations Stream Mapper Mapper Configuration Encryption - field
Renaming This property is required. GetConnection Configurations Stream Mapper Mapper Configuration Field Renaming - hashing
This property is required. GetConnection Configurations Stream Mapper Mapper Configuration Hashing - row
Filtering This property is required. GetConnection Configurations Stream Mapper Mapper Configuration Row Filtering
- encryption
This property is required. GetConnection Configurations Stream Mapper Mapper Configuration Encryption - field_
renaming This property is required. GetConnection Configurations Stream Mapper Mapper Configuration Field Renaming - hashing
This property is required. GetConnection Configurations Stream Mapper Mapper Configuration Hashing - row_
filtering This property is required. GetConnection Configurations Stream Mapper Mapper Configuration Row Filtering
- encryption
This property is required. Property Map - field
Renaming This property is required. Property Map - hashing
This property is required. Property Map - row
Filtering This property is required. Property Map
GetConnectionConfigurationsStreamMapperMapperConfigurationEncryption
- Aes
This property is required. GetConnection Configurations Stream Mapper Mapper Configuration Encryption Aes - Rsa
This property is required. GetConnection Configurations Stream Mapper Mapper Configuration Encryption Rsa
- Aes
This property is required. GetConnection Configurations Stream Mapper Mapper Configuration Encryption Aes - Rsa
This property is required. GetConnection Configurations Stream Mapper Mapper Configuration Encryption Rsa
- aes
This property is required. GetConnection Configurations Stream Mapper Mapper Configuration Encryption Aes - rsa
This property is required. GetConnection Configurations Stream Mapper Mapper Configuration Encryption Rsa
- aes
This property is required. GetConnection Configurations Stream Mapper Mapper Configuration Encryption Aes - rsa
This property is required. GetConnection Configurations Stream Mapper Mapper Configuration Encryption Rsa
- aes
This property is required. GetConnection Configurations Stream Mapper Mapper Configuration Encryption Aes - rsa
This property is required. GetConnection Configurations Stream Mapper Mapper Configuration Encryption Rsa
- aes
This property is required. Property Map - rsa
This property is required. Property Map
GetConnectionConfigurationsStreamMapperMapperConfigurationEncryptionAes
- Algorithm
This property is required. string - Field
Name Suffix This property is required. string - Key
This property is required. string - Mode
This property is required. string - Padding
This property is required. string - Target
Field This property is required. string
- Algorithm
This property is required. string - Field
Name Suffix This property is required. string - Key
This property is required. string - Mode
This property is required. string - Padding
This property is required. string - Target
Field This property is required. string
- algorithm
This property is required. String - field
Name Suffix This property is required. String - key
This property is required. String - mode
This property is required. String - padding
This property is required. String - target
Field This property is required. String
- algorithm
This property is required. string - field
Name Suffix This property is required. string - key
This property is required. string - mode
This property is required. string - padding
This property is required. string - target
Field 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 - field
Name Suffix This property is required. String - key
This property is required. String - mode
This property is required. String - padding
This property is required. String - target
Field This property is required. String
GetConnectionConfigurationsStreamMapperMapperConfigurationEncryptionRsa
- Algorithm
This property is required. string - Field
Name Suffix This property is required. string - Public
Key This property is required. string - Target
Field This property is required. string
- Algorithm
This property is required. string - Field
Name Suffix This property is required. string - Public
Key This property is required. string - Target
Field This property is required. string
- algorithm
This property is required. String - field
Name Suffix This property is required. String - public
Key This property is required. String - target
Field This property is required. String
- algorithm
This property is required. string - field
Name Suffix This property is required. string - public
Key This property is required. string - target
Field 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 - field
Name Suffix This property is required. String - public
Key This property is required. String - target
Field This property is required. String
GetConnectionConfigurationsStreamMapperMapperConfigurationFieldRenaming
- New
Field Name This property is required. string - The new name for the field after renaming.
- Original
Field Name This property is required. string - The current name of the field to rename.
- New
Field Name This property is required. string - The new name for the field after renaming.
- Original
Field Name This property is required. string - The current name of the field to rename.
- new
Field Name This property is required. String - The new name for the field after renaming.
- original
Field Name This property is required. String - The current name of the field to rename.
- new
Field Name This property is required. string - The new name for the field after renaming.
- original
Field Name 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.
- new
Field Name This property is required. String - The new name for the field after renaming.
- original
Field Name This property is required. String - The current name of the field to rename.
GetConnectionConfigurationsStreamMapperMapperConfigurationHashing
- Field
Name Suffix 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.
- Target
Field This property is required. string - The name of the field to be hashed.
- Field
Name Suffix 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.
- Target
Field This property is required. string - The name of the field to be hashed.
- field
Name Suffix 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.
- target
Field This property is required. String - The name of the field to be hashed.
- field
Name Suffix 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.
- target
Field 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.
- field
Name Suffix 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.
- target
Field 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
- Field
Paths This property is required. List<string>
- Field
Paths This property is required. []string
- field
Paths This property is required. List<String>
- field
Paths This property is required. string[]
- field_
paths This property is required. Sequence[str]
- field
Paths This property is required. List<String>
GetConnectionSchedule
- Basic
Timing This property is required. string - Cron
Expression This property is required. string - Schedule
Type This property is required. string
- Basic
Timing This property is required. string - Cron
Expression This property is required. string - Schedule
Type This property is required. string
- basic
Timing This property is required. String - cron
Expression This property is required. String - schedule
Type This property is required. String
- basic
Timing This property is required. string - cron
Expression This property is required. string - schedule
Type 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
- basic
Timing This property is required. String - cron
Expression This property is required. String - schedule
Type This property is required. String
GetConnectionTag
- Color
This property is required. string - Name
This property is required. string - Tag
Id This property is required. string - Workspace
Id This property is required. string
- Color
This property is required. string - Name
This property is required. string - Tag
Id This property is required. string - Workspace
Id This property is required. string
- color
This property is required. String - name
This property is required. String - tag
Id This property is required. String - workspace
Id This property is required. String
- color
This property is required. string - name
This property is required. string - tag
Id This property is required. string - workspace
Id 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 - tag
Id This property is required. String - workspace
Id 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