airbyte 0.7.0-beta2, Mar 7 25

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

airbyte.Connection

Explore with Pulumi AI

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

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.airbyte.Connection;
import com.pulumi.airbyte.ConnectionArgs;
import com.pulumi.airbyte.inputs.ConnectionConfigurationsArgs;
import com.pulumi.airbyte.inputs.ConnectionScheduleArgs;
import com.pulumi.airbyte.inputs.ConnectionTagArgs;
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 myConnection = new Connection("myConnection", ConnectionArgs.builder()
            .configurations(ConnectionConfigurationsArgs.builder()
                .streams(ConnectionConfigurationsStreamArgs.builder()
                    .cursorField("...")
                    .mappers(ConnectionConfigurationsStreamMapperArgs.builder()
                        .id("6563d1b7-013b-4974-a129-ba463c808f28")
                        .mapperConfiguration(ConnectionConfigurationsStreamMapperMapperConfigurationArgs.builder()
                            .encryption(ConnectionConfigurationsStreamMapperMapperConfigurationEncryptionArgs.builder()
                                .aes(ConnectionConfigurationsStreamMapperMapperConfigurationEncryptionAesArgs.builder()
                                    .algorithm("AES")
                                    .fieldNameSuffix("...my_field_name_suffix...")
                                    .key("...my_key...")
                                    .mode("CBC")
                                    .padding("PKCS5Padding")
                                    .targetField("...my_target_field...")
                                    .build())
                                .rsa(ConnectionConfigurationsStreamMapperMapperConfigurationEncryptionRsaArgs.builder()
                                    .algorithm("RSA")
                                    .fieldNameSuffix("...my_field_name_suffix...")
                                    .publicKey("...my_public_key...")
                                    .targetField("...my_target_field...")
                                    .build())
                                .build())
                            .fieldRenaming(ConnectionConfigurationsStreamMapperMapperConfigurationFieldRenamingArgs.builder()
                                .newFieldName("...my_new_field_name...")
                                .originalFieldName("...my_original_field_name...")
                                .build())
                            .hashing(ConnectionConfigurationsStreamMapperMapperConfigurationHashingArgs.builder()
                                .fieldNameSuffix("...my_field_name_suffix...")
                                .method("SHA-512")
                                .targetField("...my_target_field...")
                                .build())
                            .rowFiltering(ConnectionConfigurationsStreamMapperMapperConfigurationRowFilteringArgs.builder()
                                .conditions("{ \"see\": \"documentation\" }")
                                .build())
                            .build())
                        .type("field-renaming")
                        .build())
                    .name("...my_name...")
                    .primaryKey()
                    .selectedFields(ConnectionConfigurationsStreamSelectedFieldArgs.builder()
                        .fieldPath("...")
                        .build())
                    .syncMode("incremental_append")
                    .build())
                .build())
            .dataResidency("eu")
            .destinationId("5725b342-2d43-4e6c-90a4-e500c954e591")
            .namespaceDefinition("custom_format")
            .namespaceFormat(SOURCE_NAMESPACE)
            .nonBreakingSchemaUpdatesBehavior("ignore")
            .prefix("...my_prefix...")
            .schedule(ConnectionScheduleArgs.builder()
                .cron_expression("...my_cron_expression...")
                .schedule_type("cron")
                .build())
            .sourceId("b5b2b4a5-bba6-4c3f-b0ef-ab87b373f331")
            .status("active")
            .tags(ConnectionTagArgs.builder()
                .color("...my_color...")
                .name("...my_name...")
                .tagId("bf69ef26-2003-4c6e-9dfa-5867d7dba86a")
                .workspaceId("a46bf3e2-e63d-4e32-8959-37721daec43c")
                .build())
            .build());

    }
}

resources:
  myConnection:
    type: airbyte:Connection
    properties:
      configurations:
        streams:
          - cursorField:
              - '...'
            mappers:
              - id: 6563d1b7-013b-4974-a129-ba463c808f28
                mapperConfiguration:
                  encryption:
                    aes:
                      algorithm: AES
                      fieldNameSuffix: '...my_field_name_suffix...'
                      key: '...my_key...'
                      mode: CBC
                      padding: PKCS5Padding
                      targetField: '...my_target_field...'
                    rsa:
                      algorithm: RSA
                      fieldNameSuffix: '...my_field_name_suffix...'
                      publicKey: '...my_public_key...'
                      targetField: '...my_target_field...'
                  fieldRenaming:
                    newFieldName: '...my_new_field_name...'
                    originalFieldName: '...my_original_field_name...'
                  hashing:
                    fieldNameSuffix: '...my_field_name_suffix...'
                    method: SHA-512
                    targetField: '...my_target_field...'
                  rowFiltering:
                    conditions: '{ "see": "documentation" }'
                type: field-renaming
            name: '...my_name...'
            primaryKey:
              - []
            selectedFields:
              - fieldPath:
                  - '...'
            syncMode: incremental_append
      dataResidency: eu
      destinationId: 5725b342-2d43-4e6c-90a4-e500c954e591
      namespaceDefinition: custom_format
      namespaceFormat: ${SOURCE_NAMESPACE}
      nonBreakingSchemaUpdatesBehavior: ignore
      prefix: '...my_prefix...'
      schedule:
        cron_expression: '...my_cron_expression...'
        schedule_type: cron
      sourceId: b5b2b4a5-bba6-4c3f-b0ef-ab87b373f331
      status: active
      tags:
        - color: '...my_color...'
          name: '...my_name...'
          tagId: bf69ef26-2003-4c6e-9dfa-5867d7dba86a
          workspaceId: a46bf3e2-e63d-4e32-8959-37721daec43c

Create Connection Resource

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

Constructor syntax

new Connection(name: string, args: ConnectionArgs, opts?: CustomResourceOptions);

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

@overload
def Connection(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               destination_id: Optional[str] = None,
               source_id: Optional[str] = None,
               configurations: Optional[ConnectionConfigurationsArgs] = None,
               data_residency: Optional[str] = None,
               name: Optional[str] = None,
               namespace_definition: Optional[str] = None,
               namespace_format: Optional[str] = None,
               non_breaking_schema_updates_behavior: Optional[str] = None,
               prefix: Optional[str] = None,
               schedule: Optional[ConnectionScheduleArgs] = None,
               status: Optional[str] = None,
               tags: Optional[Sequence[ConnectionTagArgs]] = None)

func NewConnection(ctx *Context, name string, args ConnectionArgs, opts ...ResourceOption) (*Connection, error)

public Connection(string name, ConnectionArgs args, CustomResourceOptions? opts = null)

public Connection(String name, ConnectionArgs args)
public Connection(String name, ConnectionArgs args, CustomResourceOptions options)

type: airbyte:Connection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

resource_name str: The unique name of the resource.
args ConnectionArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ConnectionArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args ConnectionArgs: 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 connectionResource = new Airbyte.Connection("connectionResource", new()
{
    DestinationId = "string",
    SourceId = "string",
    Configurations = new Airbyte.Inputs.ConnectionConfigurationsArgs
    {
        Streams = new[]
        {
            new Airbyte.Inputs.ConnectionConfigurationsStreamArgs
            {
                CursorFields = new[]
                {
                    "string",
                },
                Mappers = new[]
                {
                    new Airbyte.Inputs.ConnectionConfigurationsStreamMapperArgs
                    {
                        Id = "string",
                        MapperConfiguration = new Airbyte.Inputs.ConnectionConfigurationsStreamMapperMapperConfigurationArgs
                        {
                            Encryption = new Airbyte.Inputs.ConnectionConfigurationsStreamMapperMapperConfigurationEncryptionArgs
                            {
                                Aes = new Airbyte.Inputs.ConnectionConfigurationsStreamMapperMapperConfigurationEncryptionAesArgs
                                {
                                    Algorithm = "string",
                                    FieldNameSuffix = "string",
                                    Key = "string",
                                    Mode = "string",
                                    Padding = "string",
                                    TargetField = "string",
                                },
                                Rsa = new Airbyte.Inputs.ConnectionConfigurationsStreamMapperMapperConfigurationEncryptionRsaArgs
                                {
                                    Algorithm = "string",
                                    FieldNameSuffix = "string",
                                    PublicKey = "string",
                                    TargetField = "string",
                                },
                            },
                            FieldRenaming = new Airbyte.Inputs.ConnectionConfigurationsStreamMapperMapperConfigurationFieldRenamingArgs
                            {
                                NewFieldName = "string",
                                OriginalFieldName = "string",
                            },
                            Hashing = new Airbyte.Inputs.ConnectionConfigurationsStreamMapperMapperConfigurationHashingArgs
                            {
                                FieldNameSuffix = "string",
                                Method = "string",
                                TargetField = "string",
                            },
                            RowFiltering = new Airbyte.Inputs.ConnectionConfigurationsStreamMapperMapperConfigurationRowFilteringArgs
                            {
                                Conditions = "string",
                            },
                        },
                        Type = "string",
                    },
                },
                Name = "string",
                PrimaryKeys = new[]
                {
                    new[]
                    {
                        "string",
                    },
                },
                SelectedFields = new[]
                {
                    new Airbyte.Inputs.ConnectionConfigurationsStreamSelectedFieldArgs
                    {
                        FieldPaths = new[]
                        {
                            "string",
                        },
                    },
                },
                SyncMode = "string",
            },
        },
    },
    DataResidency = "string",
    Name = "string",
    NamespaceDefinition = "string",
    NamespaceFormat = "string",
    NonBreakingSchemaUpdatesBehavior = "string",
    Prefix = "string",
    Schedule = new Airbyte.Inputs.ConnectionScheduleArgs
    {
        BasicTiming = "string",
        CronExpression = "string",
        ScheduleType = "string",
    },
    Status = "string",
    Tags = new[]
    {
        new Airbyte.Inputs.ConnectionTagArgs
        {
            Color = "string",
            Name = "string",
            TagId = "string",
            WorkspaceId = "string",
        },
    },
});

example, err := airbyte.NewConnection(ctx, "connectionResource", &airbyte.ConnectionArgs{
DestinationId: pulumi.String("string"),
SourceId: pulumi.String("string"),
Configurations: &.ConnectionConfigurationsArgs{
Streams: .ConnectionConfigurationsStreamArray{
&.ConnectionConfigurationsStreamArgs{
CursorFields: pulumi.StringArray{
pulumi.String("string"),
},
Mappers: .ConnectionConfigurationsStreamMapperArray{
&.ConnectionConfigurationsStreamMapperArgs{
Id: pulumi.String("string"),
MapperConfiguration: &.ConnectionConfigurationsStreamMapperMapperConfigurationArgs{
Encryption: &.ConnectionConfigurationsStreamMapperMapperConfigurationEncryptionArgs{
Aes: &.ConnectionConfigurationsStreamMapperMapperConfigurationEncryptionAesArgs{
Algorithm: pulumi.String("string"),
FieldNameSuffix: pulumi.String("string"),
Key: pulumi.String("string"),
Mode: pulumi.String("string"),
Padding: pulumi.String("string"),
TargetField: pulumi.String("string"),
},
Rsa: &.ConnectionConfigurationsStreamMapperMapperConfigurationEncryptionRsaArgs{
Algorithm: pulumi.String("string"),
FieldNameSuffix: pulumi.String("string"),
PublicKey: pulumi.String("string"),
TargetField: pulumi.String("string"),
},
},
FieldRenaming: &.ConnectionConfigurationsStreamMapperMapperConfigurationFieldRenamingArgs{
NewFieldName: pulumi.String("string"),
OriginalFieldName: pulumi.String("string"),
},
Hashing: &.ConnectionConfigurationsStreamMapperMapperConfigurationHashingArgs{
FieldNameSuffix: pulumi.String("string"),
Method: pulumi.String("string"),
TargetField: pulumi.String("string"),
},
RowFiltering: &.ConnectionConfigurationsStreamMapperMapperConfigurationRowFilteringArgs{
Conditions: pulumi.String("string"),
},
},
Type: pulumi.String("string"),
},
},
Name: pulumi.String("string"),
PrimaryKeys: pulumi.StringArrayArray{
pulumi.StringArray{
pulumi.String("string"),
},
},
SelectedFields: .ConnectionConfigurationsStreamSelectedFieldArray{
&.ConnectionConfigurationsStreamSelectedFieldArgs{
FieldPaths: pulumi.StringArray{
pulumi.String("string"),
},
},
},
SyncMode: pulumi.String("string"),
},
},
},
DataResidency: pulumi.String("string"),
Name: pulumi.String("string"),
NamespaceDefinition: pulumi.String("string"),
NamespaceFormat: pulumi.String("string"),
NonBreakingSchemaUpdatesBehavior: pulumi.String("string"),
Prefix: pulumi.String("string"),
Schedule: &.ConnectionScheduleArgs{
BasicTiming: pulumi.String("string"),
CronExpression: pulumi.String("string"),
ScheduleType: pulumi.String("string"),
},
Status: pulumi.String("string"),
Tags: .ConnectionTagArray{
&.ConnectionTagArgs{
Color: pulumi.String("string"),
Name: pulumi.String("string"),
TagId: pulumi.String("string"),
WorkspaceId: pulumi.String("string"),
},
},
})

var connectionResource = new Connection("connectionResource", ConnectionArgs.builder()
    .destinationId("string")
    .sourceId("string")
    .configurations(ConnectionConfigurationsArgs.builder()
        .streams(ConnectionConfigurationsStreamArgs.builder()
            .cursorFields("string")
            .mappers(ConnectionConfigurationsStreamMapperArgs.builder()
                .id("string")
                .mapperConfiguration(ConnectionConfigurationsStreamMapperMapperConfigurationArgs.builder()
                    .encryption(ConnectionConfigurationsStreamMapperMapperConfigurationEncryptionArgs.builder()
                        .aes(ConnectionConfigurationsStreamMapperMapperConfigurationEncryptionAesArgs.builder()
                            .algorithm("string")
                            .fieldNameSuffix("string")
                            .key("string")
                            .mode("string")
                            .padding("string")
                            .targetField("string")
                            .build())
                        .rsa(ConnectionConfigurationsStreamMapperMapperConfigurationEncryptionRsaArgs.builder()
                            .algorithm("string")
                            .fieldNameSuffix("string")
                            .publicKey("string")
                            .targetField("string")
                            .build())
                        .build())
                    .fieldRenaming(ConnectionConfigurationsStreamMapperMapperConfigurationFieldRenamingArgs.builder()
                        .newFieldName("string")
                        .originalFieldName("string")
                        .build())
                    .hashing(ConnectionConfigurationsStreamMapperMapperConfigurationHashingArgs.builder()
                        .fieldNameSuffix("string")
                        .method("string")
                        .targetField("string")
                        .build())
                    .rowFiltering(ConnectionConfigurationsStreamMapperMapperConfigurationRowFilteringArgs.builder()
                        .conditions("string")
                        .build())
                    .build())
                .type("string")
                .build())
            .name("string")
            .primaryKeys("string")
            .selectedFields(ConnectionConfigurationsStreamSelectedFieldArgs.builder()
                .fieldPaths("string")
                .build())
            .syncMode("string")
            .build())
        .build())
    .dataResidency("string")
    .name("string")
    .namespaceDefinition("string")
    .namespaceFormat("string")
    .nonBreakingSchemaUpdatesBehavior("string")
    .prefix("string")
    .schedule(ConnectionScheduleArgs.builder()
        .basicTiming("string")
        .cronExpression("string")
        .scheduleType("string")
        .build())
    .status("string")
    .tags(ConnectionTagArgs.builder()
        .color("string")
        .name("string")
        .tagId("string")
        .workspaceId("string")
        .build())
    .build());

connection_resource = airbyte.Connection("connectionResource",
    destination_id="string",
    source_id="string",
    configurations={
        "streams": [{
            "cursor_fields": ["string"],
            "mappers": [{
                "id": "string",
                "mapper_configuration": {
                    "encryption": {
                        "aes": {
                            "algorithm": "string",
                            "field_name_suffix": "string",
                            "key": "string",
                            "mode": "string",
                            "padding": "string",
                            "target_field": "string",
                        },
                        "rsa": {
                            "algorithm": "string",
                            "field_name_suffix": "string",
                            "public_key": "string",
                            "target_field": "string",
                        },
                    },
                    "field_renaming": {
                        "new_field_name": "string",
                        "original_field_name": "string",
                    },
                    "hashing": {
                        "field_name_suffix": "string",
                        "method": "string",
                        "target_field": "string",
                    },
                    "row_filtering": {
                        "conditions": "string",
                    },
                },
                "type": "string",
            }],
            "name": "string",
            "primary_keys": [["string"]],
            "selected_fields": [{
                "field_paths": ["string"],
            }],
            "sync_mode": "string",
        }],
    },
    data_residency="string",
    name="string",
    namespace_definition="string",
    namespace_format="string",
    non_breaking_schema_updates_behavior="string",
    prefix="string",
    schedule={
        "basic_timing": "string",
        "cron_expression": "string",
        "schedule_type": "string",
    },
    status="string",
    tags=[{
        "color": "string",
        "name": "string",
        "tag_id": "string",
        "workspace_id": "string",
    }])

const connectionResource = new airbyte.Connection("connectionResource", {
    destinationId: "string",
    sourceId: "string",
    configurations: {
        streams: [{
            cursorFields: ["string"],
            mappers: [{
                id: "string",
                mapperConfiguration: {
                    encryption: {
                        aes: {
                            algorithm: "string",
                            fieldNameSuffix: "string",
                            key: "string",
                            mode: "string",
                            padding: "string",
                            targetField: "string",
                        },
                        rsa: {
                            algorithm: "string",
                            fieldNameSuffix: "string",
                            publicKey: "string",
                            targetField: "string",
                        },
                    },
                    fieldRenaming: {
                        newFieldName: "string",
                        originalFieldName: "string",
                    },
                    hashing: {
                        fieldNameSuffix: "string",
                        method: "string",
                        targetField: "string",
                    },
                    rowFiltering: {
                        conditions: "string",
                    },
                },
                type: "string",
            }],
            name: "string",
            primaryKeys: [["string"]],
            selectedFields: [{
                fieldPaths: ["string"],
            }],
            syncMode: "string",
        }],
    },
    dataResidency: "string",
    name: "string",
    namespaceDefinition: "string",
    namespaceFormat: "string",
    nonBreakingSchemaUpdatesBehavior: "string",
    prefix: "string",
    schedule: {
        basicTiming: "string",
        cronExpression: "string",
        scheduleType: "string",
    },
    status: "string",
    tags: [{
        color: "string",
        name: "string",
        tagId: "string",
        workspaceId: "string",
    }],
});

type: airbyte:Connection
properties:
    configurations:
        streams:
            - cursorFields:
                - string
              mappers:
                - id: string
                  mapperConfiguration:
                    encryption:
                        aes:
                            algorithm: string
                            fieldNameSuffix: string
                            key: string
                            mode: string
                            padding: string
                            targetField: string
                        rsa:
                            algorithm: string
                            fieldNameSuffix: string
                            publicKey: string
                            targetField: string
                    fieldRenaming:
                        newFieldName: string
                        originalFieldName: string
                    hashing:
                        fieldNameSuffix: string
                        method: string
                        targetField: string
                    rowFiltering:
                        conditions: string
                  type: string
              name: string
              primaryKeys:
                - - string
              selectedFields:
                - fieldPaths:
                    - string
              syncMode: string
    dataResidency: string
    destinationId: string
    name: string
    namespaceDefinition: string
    namespaceFormat: string
    nonBreakingSchemaUpdatesBehavior: string
    prefix: string
    schedule:
        basicTiming: string
        cronExpression: string
        scheduleType: string
    sourceId: string
    status: string
    tags:
        - color: string
          name: string
          tagId: string
          workspaceId: string

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

DestinationId string: Requires replacement if changed.
SourceId string: Requires replacement if changed.
Configurations ConnectionConfigurations: A list of configured stream options for a connection.
DataResidency string: Default: "auto"; must be one of ["auto", "us", "eu"]
Name string: Optional name of the connection
NamespaceDefinition string: Define the location where the data will be stored in the destination. Default: "destination"; must be one of ["source", "destination", "custom_format"]
NamespaceFormat string: Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCENAMESPACE}" then behaves like namespaceDefinition = 'source'.
NonBreakingSchemaUpdatesBehavior string: Set how Airbyte handles syncs when it detects a non-breaking schema change in the source. Default: "ignore"; must be one of ["ignore", "disableconnection", "propagatecolumns", "propagate_fully"]
Prefix string: Prefix that will be prepended to the name of each stream when it is written to the destination (ex. “airbyte*” causes “projects” => “airbyte*projects”). Default: ""
Schedule ConnectionSchedule: schedule for when the the connection should run, per the schedule type
Status string: must be one of ["active", "inactive", "deprecated"]
Tags List<ConnectionTag>

DestinationId string: Requires replacement if changed.
SourceId string: Requires replacement if changed.
Configurations ConnectionConfigurationsArgs: A list of configured stream options for a connection.
DataResidency string: Default: "auto"; must be one of ["auto", "us", "eu"]
Name string: Optional name of the connection
NamespaceDefinition string: Define the location where the data will be stored in the destination. Default: "destination"; must be one of ["source", "destination", "custom_format"]
NamespaceFormat string: Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCENAMESPACE}" then behaves like namespaceDefinition = 'source'.
NonBreakingSchemaUpdatesBehavior string: Set how Airbyte handles syncs when it detects a non-breaking schema change in the source. Default: "ignore"; must be one of ["ignore", "disableconnection", "propagatecolumns", "propagate_fully"]
Prefix string: Prefix that will be prepended to the name of each stream when it is written to the destination (ex. “airbyte*” causes “projects” => “airbyte*projects”). Default: ""
Schedule ConnectionScheduleArgs: schedule for when the the connection should run, per the schedule type
Status string: must be one of ["active", "inactive", "deprecated"]
Tags []ConnectionTagArgs

destinationId String: Requires replacement if changed.
sourceId String: Requires replacement if changed.
configurations ConnectionConfigurations: A list of configured stream options for a connection.
dataResidency String: Default: "auto"; must be one of ["auto", "us", "eu"]
name String: Optional name of the connection
namespaceDefinition String: Define the location where the data will be stored in the destination. Default: "destination"; must be one of ["source", "destination", "custom_format"]
namespaceFormat String: Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCENAMESPACE}" then behaves like namespaceDefinition = 'source'.
nonBreakingSchemaUpdatesBehavior String: Set how Airbyte handles syncs when it detects a non-breaking schema change in the source. Default: "ignore"; must be one of ["ignore", "disableconnection", "propagatecolumns", "propagate_fully"]
prefix String: Prefix that will be prepended to the name of each stream when it is written to the destination (ex. “airbyte*” causes “projects” => “airbyte*projects”). Default: ""
schedule ConnectionSchedule: schedule for when the the connection should run, per the schedule type
status String: must be one of ["active", "inactive", "deprecated"]
tags List<ConnectionTag>

destinationId string: Requires replacement if changed.
sourceId string: Requires replacement if changed.
configurations ConnectionConfigurations: A list of configured stream options for a connection.
dataResidency string: Default: "auto"; must be one of ["auto", "us", "eu"]
name string: Optional name of the connection
namespaceDefinition string: Define the location where the data will be stored in the destination. Default: "destination"; must be one of ["source", "destination", "custom_format"]
namespaceFormat string: Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCENAMESPACE}" then behaves like namespaceDefinition = 'source'.
nonBreakingSchemaUpdatesBehavior string: Set how Airbyte handles syncs when it detects a non-breaking schema change in the source. Default: "ignore"; must be one of ["ignore", "disableconnection", "propagatecolumns", "propagate_fully"]
prefix string: Prefix that will be prepended to the name of each stream when it is written to the destination (ex. “airbyte*” causes “projects” => “airbyte*projects”). Default: ""
schedule ConnectionSchedule: schedule for when the the connection should run, per the schedule type
status string: must be one of ["active", "inactive", "deprecated"]
tags ConnectionTag[]

destination_id str: Requires replacement if changed.
source_id str: Requires replacement if changed.
configurations ConnectionConfigurationsArgs: A list of configured stream options for a connection.
data_residency str: Default: "auto"; must be one of ["auto", "us", "eu"]
name str: Optional name of the connection
namespace_definition str: Define the location where the data will be stored in the destination. Default: "destination"; must be one of ["source", "destination", "custom_format"]
namespace_format str: Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCENAMESPACE}" then behaves like namespaceDefinition = 'source'.
non_breaking_schema_updates_behavior str: Set how Airbyte handles syncs when it detects a non-breaking schema change in the source. Default: "ignore"; must be one of ["ignore", "disableconnection", "propagatecolumns", "propagate_fully"]
prefix str: Prefix that will be prepended to the name of each stream when it is written to the destination (ex. “airbyte*” causes “projects” => “airbyte*projects”). Default: ""
schedule ConnectionScheduleArgs: schedule for when the the connection should run, per the schedule type
status str: must be one of ["active", "inactive", "deprecated"]
tags Sequence[ConnectionTagArgs]

destinationId String: Requires replacement if changed.
sourceId String: Requires replacement if changed.
configurations Property Map: A list of configured stream options for a connection.
dataResidency String: Default: "auto"; must be one of ["auto", "us", "eu"]
name String: Optional name of the connection
namespaceDefinition String: Define the location where the data will be stored in the destination. Default: "destination"; must be one of ["source", "destination", "custom_format"]
namespaceFormat String: Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCENAMESPACE}" then behaves like namespaceDefinition = 'source'.
nonBreakingSchemaUpdatesBehavior String: Set how Airbyte handles syncs when it detects a non-breaking schema change in the source. Default: "ignore"; must be one of ["ignore", "disableconnection", "propagatecolumns", "propagate_fully"]
prefix String: Prefix that will be prepended to the name of each stream when it is written to the destination (ex. “airbyte*” causes “projects” => “airbyte*projects”). Default: ""
schedule Property Map: schedule for when the the connection should run, per the schedule type
status String: must be one of ["active", "inactive", "deprecated"]
tags List<Property Map>

Outputs

All input properties are implicitly available as output properties. Additionally, the Connection resource produces the following output properties:

ConnectionId string
CreatedAt double
Id string: The provider-assigned unique ID for this managed resource.
WorkspaceId string

ConnectionId string
CreatedAt float64
Id string: The provider-assigned unique ID for this managed resource.
WorkspaceId string

connectionId String
createdAt Double
id String: The provider-assigned unique ID for this managed resource.
workspaceId String

connectionId string
createdAt number
id string: The provider-assigned unique ID for this managed resource.
workspaceId string

connection_id str
created_at float
id str: The provider-assigned unique ID for this managed resource.
workspace_id str

connectionId String
createdAt Number
id String: The provider-assigned unique ID for this managed resource.
workspaceId String

Look up Existing Connection Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configurations: Optional[ConnectionConfigurationsArgs] = None,
        connection_id: Optional[str] = None,
        created_at: Optional[float] = None,
        data_residency: Optional[str] = None,
        destination_id: Optional[str] = None,
        name: Optional[str] = None,
        namespace_definition: Optional[str] = None,
        namespace_format: Optional[str] = None,
        non_breaking_schema_updates_behavior: Optional[str] = None,
        prefix: Optional[str] = None,
        schedule: Optional[ConnectionScheduleArgs] = None,
        source_id: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[ConnectionTagArgs]] = None,
        workspace_id: Optional[str] = None) -> Connection

func GetConnection(ctx *Context, name string, id IDInput, state *ConnectionState, opts ...ResourceOption) (*Connection, error)

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

public static Connection get(String name, Output<String> id, ConnectionState state, CustomResourceOptions options)

resources:  _:    type: airbyte:Connection    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Configurations ConnectionConfigurations: A list of configured stream options for a connection.
ConnectionId string
CreatedAt double
DataResidency string: Default: "auto"; must be one of ["auto", "us", "eu"]
DestinationId string: Requires replacement if changed.
Name string: Optional name of the connection
NamespaceDefinition string: Define the location where the data will be stored in the destination. Default: "destination"; must be one of ["source", "destination", "custom_format"]
NamespaceFormat string: Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCENAMESPACE}" then behaves like namespaceDefinition = 'source'.
NonBreakingSchemaUpdatesBehavior string: Set how Airbyte handles syncs when it detects a non-breaking schema change in the source. Default: "ignore"; must be one of ["ignore", "disableconnection", "propagatecolumns", "propagate_fully"]
Prefix string: Prefix that will be prepended to the name of each stream when it is written to the destination (ex. “airbyte*” causes “projects” => “airbyte*projects”). Default: ""
Schedule ConnectionSchedule: schedule for when the the connection should run, per the schedule type
SourceId string: Requires replacement if changed.
Status string: must be one of ["active", "inactive", "deprecated"]
Tags List<ConnectionTag>
WorkspaceId string

Configurations ConnectionConfigurationsArgs: A list of configured stream options for a connection.
ConnectionId string
CreatedAt float64
DataResidency string: Default: "auto"; must be one of ["auto", "us", "eu"]
DestinationId string: Requires replacement if changed.
Name string: Optional name of the connection
NamespaceDefinition string: Define the location where the data will be stored in the destination. Default: "destination"; must be one of ["source", "destination", "custom_format"]
NamespaceFormat string: Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCENAMESPACE}" then behaves like namespaceDefinition = 'source'.
NonBreakingSchemaUpdatesBehavior string: Set how Airbyte handles syncs when it detects a non-breaking schema change in the source. Default: "ignore"; must be one of ["ignore", "disableconnection", "propagatecolumns", "propagate_fully"]
Prefix string: Prefix that will be prepended to the name of each stream when it is written to the destination (ex. “airbyte*” causes “projects” => “airbyte*projects”). Default: ""
Schedule ConnectionScheduleArgs: schedule for when the the connection should run, per the schedule type
SourceId string: Requires replacement if changed.
Status string: must be one of ["active", "inactive", "deprecated"]
Tags []ConnectionTagArgs
WorkspaceId string

configurations ConnectionConfigurations: A list of configured stream options for a connection.
connectionId String
createdAt Double
dataResidency String: Default: "auto"; must be one of ["auto", "us", "eu"]
destinationId String: Requires replacement if changed.
name String: Optional name of the connection
namespaceDefinition String: Define the location where the data will be stored in the destination. Default: "destination"; must be one of ["source", "destination", "custom_format"]
namespaceFormat String: Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCENAMESPACE}" then behaves like namespaceDefinition = 'source'.
nonBreakingSchemaUpdatesBehavior String: Set how Airbyte handles syncs when it detects a non-breaking schema change in the source. Default: "ignore"; must be one of ["ignore", "disableconnection", "propagatecolumns", "propagate_fully"]
prefix String: Prefix that will be prepended to the name of each stream when it is written to the destination (ex. “airbyte*” causes “projects” => “airbyte*projects”). Default: ""
schedule ConnectionSchedule: schedule for when the the connection should run, per the schedule type
sourceId String: Requires replacement if changed.
status String: must be one of ["active", "inactive", "deprecated"]
tags List<ConnectionTag>
workspaceId String

configurations ConnectionConfigurations: A list of configured stream options for a connection.
connectionId string
createdAt number
dataResidency string: Default: "auto"; must be one of ["auto", "us", "eu"]
destinationId string: Requires replacement if changed.
name string: Optional name of the connection
namespaceDefinition string: Define the location where the data will be stored in the destination. Default: "destination"; must be one of ["source", "destination", "custom_format"]
namespaceFormat string: Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCENAMESPACE}" then behaves like namespaceDefinition = 'source'.
nonBreakingSchemaUpdatesBehavior string: Set how Airbyte handles syncs when it detects a non-breaking schema change in the source. Default: "ignore"; must be one of ["ignore", "disableconnection", "propagatecolumns", "propagate_fully"]
prefix string: Prefix that will be prepended to the name of each stream when it is written to the destination (ex. “airbyte*” causes “projects” => “airbyte*projects”). Default: ""
schedule ConnectionSchedule: schedule for when the the connection should run, per the schedule type
sourceId string: Requires replacement if changed.
status string: must be one of ["active", "inactive", "deprecated"]
tags ConnectionTag[]
workspaceId string

configurations ConnectionConfigurationsArgs: A list of configured stream options for a connection.
connection_id str
created_at float
data_residency str: Default: "auto"; must be one of ["auto", "us", "eu"]
destination_id str: Requires replacement if changed.
name str: Optional name of the connection
namespace_definition str: Define the location where the data will be stored in the destination. Default: "destination"; must be one of ["source", "destination", "custom_format"]
namespace_format str: Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCENAMESPACE}" then behaves like namespaceDefinition = 'source'.
non_breaking_schema_updates_behavior str: Set how Airbyte handles syncs when it detects a non-breaking schema change in the source. Default: "ignore"; must be one of ["ignore", "disableconnection", "propagatecolumns", "propagate_fully"]
prefix str: Prefix that will be prepended to the name of each stream when it is written to the destination (ex. “airbyte*” causes “projects” => “airbyte*projects”). Default: ""
schedule ConnectionScheduleArgs: schedule for when the the connection should run, per the schedule type
source_id str: Requires replacement if changed.
status str: must be one of ["active", "inactive", "deprecated"]
tags Sequence[ConnectionTagArgs]
workspace_id str

configurations Property Map: A list of configured stream options for a connection.
connectionId String
createdAt Number
dataResidency String: Default: "auto"; must be one of ["auto", "us", "eu"]
destinationId String: Requires replacement if changed.
name String: Optional name of the connection
namespaceDefinition String: Define the location where the data will be stored in the destination. Default: "destination"; must be one of ["source", "destination", "custom_format"]
namespaceFormat String: Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCENAMESPACE}" then behaves like namespaceDefinition = 'source'.
nonBreakingSchemaUpdatesBehavior String: Set how Airbyte handles syncs when it detects a non-breaking schema change in the source. Default: "ignore"; must be one of ["ignore", "disableconnection", "propagatecolumns", "propagate_fully"]
prefix String: Prefix that will be prepended to the name of each stream when it is written to the destination (ex. “airbyte*” causes “projects” => “airbyte*projects”). Default: ""
schedule Property Map: schedule for when the the connection should run, per the schedule type
sourceId String: Requires replacement if changed.
status String: must be one of ["active", "inactive", "deprecated"]
tags List<Property Map>
workspaceId String

Supporting Types

ConnectionConfigurations, ConnectionConfigurationsArgs

Streams List<ConnectionConfigurationsStream>

Streams []ConnectionConfigurationsStream

streams List<ConnectionConfigurationsStream>

streams ConnectionConfigurationsStream[]

streams Sequence[ConnectionConfigurationsStream]

streams List<Property Map>

ConnectionConfigurationsStream, ConnectionConfigurationsStreamArgs

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.
Mappers List<ConnectionConfigurationsStreamMapper>: Mappers that should be applied to the stream before writing to the destination.
Name string: Not Null
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<ConnectionConfigurationsStreamSelectedField>: Paths to the fields that will be included in the configured catalog.
SyncMode string: must be one of ["fullrefreshoverwrite", "fullrefreshoverwritededuped", "fullrefreshappend", "incrementalappend", "incrementaldedupedhistory"]

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.
Mappers []ConnectionConfigurationsStreamMapper: Mappers that should be applied to the stream before writing to the destination.
Name string: Not Null
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 []ConnectionConfigurationsStreamSelectedField: Paths to the fields that will be included in the configured catalog.
SyncMode string: must be one of ["fullrefreshoverwrite", "fullrefreshoverwritededuped", "fullrefreshappend", "incrementalappend", "incrementaldedupedhistory"]

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.
mappers List<ConnectionConfigurationsStreamMapper>: Mappers that should be applied to the stream before writing to the destination.
name String: Not Null
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<ConnectionConfigurationsStreamSelectedField>: Paths to the fields that will be included in the configured catalog.
syncMode String: must be one of ["fullrefreshoverwrite", "fullrefreshoverwritededuped", "fullrefreshappend", "incrementalappend", "incrementaldedupedhistory"]

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.
mappers ConnectionConfigurationsStreamMapper[]: Mappers that should be applied to the stream before writing to the destination.
name string: Not Null
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 ConnectionConfigurationsStreamSelectedField[]: Paths to the fields that will be included in the configured catalog.
syncMode string: must be one of ["fullrefreshoverwrite", "fullrefreshoverwritededuped", "fullrefreshappend", "incrementalappend", "incrementaldedupedhistory"]

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.
mappers Sequence[ConnectionConfigurationsStreamMapper]: Mappers that should be applied to the stream before writing to the destination.
name str: Not Null
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[ConnectionConfigurationsStreamSelectedField]: Paths to the fields that will be included in the configured catalog.
sync_mode str: must be one of ["fullrefreshoverwrite", "fullrefreshoverwritededuped", "fullrefreshappend", "incrementalappend", "incrementaldedupedhistory"]

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.
mappers List<Property Map>: Mappers that should be applied to the stream before writing to the destination.
name String: Not Null
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: must be one of ["fullrefreshoverwrite", "fullrefreshoverwritededuped", "fullrefreshappend", "incrementalappend", "incrementaldedupedhistory"]

ConnectionConfigurationsStreamMapper, ConnectionConfigurationsStreamMapperArgs

Id string
MapperConfiguration ConnectionConfigurationsStreamMapperMapperConfiguration: The values required to configure the mapper. Not Null
Type string: Not Null; must be one of ["hashing", "field-renaming", "row-filtering", "encryption"]

Id string
MapperConfiguration ConnectionConfigurationsStreamMapperMapperConfiguration: The values required to configure the mapper. Not Null
Type string: Not Null; must be one of ["hashing", "field-renaming", "row-filtering", "encryption"]

id String
mapperConfiguration ConnectionConfigurationsStreamMapperMapperConfiguration: The values required to configure the mapper. Not Null
type String: Not Null; must be one of ["hashing", "field-renaming", "row-filtering", "encryption"]

id string
mapperConfiguration ConnectionConfigurationsStreamMapperMapperConfiguration: The values required to configure the mapper. Not Null
type string: Not Null; must be one of ["hashing", "field-renaming", "row-filtering", "encryption"]

id str
mapper_configuration ConnectionConfigurationsStreamMapperMapperConfiguration: The values required to configure the mapper. Not Null
type str: Not Null; must be one of ["hashing", "field-renaming", "row-filtering", "encryption"]

id String
mapperConfiguration Property Map: The values required to configure the mapper. Not Null
type String: Not Null; must be one of ["hashing", "field-renaming", "row-filtering", "encryption"]

ConnectionConfigurationsStreamMapperMapperConfiguration, ConnectionConfigurationsStreamMapperMapperConfigurationArgs

Encryption ConnectionConfigurationsStreamMapperMapperConfigurationEncryption
FieldRenaming ConnectionConfigurationsStreamMapperMapperConfigurationFieldRenaming
Hashing ConnectionConfigurationsStreamMapperMapperConfigurationHashing
RowFiltering ConnectionConfigurationsStreamMapperMapperConfigurationRowFiltering

Encryption ConnectionConfigurationsStreamMapperMapperConfigurationEncryption
FieldRenaming ConnectionConfigurationsStreamMapperMapperConfigurationFieldRenaming
Hashing ConnectionConfigurationsStreamMapperMapperConfigurationHashing
RowFiltering ConnectionConfigurationsStreamMapperMapperConfigurationRowFiltering

encryption ConnectionConfigurationsStreamMapperMapperConfigurationEncryption
fieldRenaming ConnectionConfigurationsStreamMapperMapperConfigurationFieldRenaming
hashing ConnectionConfigurationsStreamMapperMapperConfigurationHashing
rowFiltering ConnectionConfigurationsStreamMapperMapperConfigurationRowFiltering

encryption ConnectionConfigurationsStreamMapperMapperConfigurationEncryption
fieldRenaming ConnectionConfigurationsStreamMapperMapperConfigurationFieldRenaming
hashing ConnectionConfigurationsStreamMapperMapperConfigurationHashing
rowFiltering ConnectionConfigurationsStreamMapperMapperConfigurationRowFiltering

encryption ConnectionConfigurationsStreamMapperMapperConfigurationEncryption
field_renaming ConnectionConfigurationsStreamMapperMapperConfigurationFieldRenaming
hashing ConnectionConfigurationsStreamMapperMapperConfigurationHashing
row_filtering ConnectionConfigurationsStreamMapperMapperConfigurationRowFiltering

encryption Property Map
fieldRenaming Property Map
hashing Property Map
rowFiltering Property Map

ConnectionConfigurationsStreamMapperMapperConfigurationEncryption, ConnectionConfigurationsStreamMapperMapperConfigurationEncryptionArgs

Aes ConnectionConfigurationsStreamMapperMapperConfigurationEncryptionAes
Rsa ConnectionConfigurationsStreamMapperMapperConfigurationEncryptionRsa

Aes ConnectionConfigurationsStreamMapperMapperConfigurationEncryptionAes
Rsa ConnectionConfigurationsStreamMapperMapperConfigurationEncryptionRsa

aes ConnectionConfigurationsStreamMapperMapperConfigurationEncryptionAes
rsa ConnectionConfigurationsStreamMapperMapperConfigurationEncryptionRsa

aes ConnectionConfigurationsStreamMapperMapperConfigurationEncryptionAes
rsa ConnectionConfigurationsStreamMapperMapperConfigurationEncryptionRsa

aes ConnectionConfigurationsStreamMapperMapperConfigurationEncryptionAes
rsa ConnectionConfigurationsStreamMapperMapperConfigurationEncryptionRsa

aes Property Map
rsa Property Map

ConnectionConfigurationsStreamMapperMapperConfigurationEncryptionAes, ConnectionConfigurationsStreamMapperMapperConfigurationEncryptionAesArgs

Algorithm string: Not Null; must be one of ["RSA", "AES"]
FieldNameSuffix string: Not Null
Key string: Not Null
Mode string: Not Null; must be one of ["CBC", "CFB", "OFB", "CTR", "GCM", "ECB"]
Padding string: Not Null; must be one of ["NoPadding", "PKCS5Padding"]
TargetField string: Not Null

Algorithm string: Not Null; must be one of ["RSA", "AES"]
FieldNameSuffix string: Not Null
Key string: Not Null
Mode string: Not Null; must be one of ["CBC", "CFB", "OFB", "CTR", "GCM", "ECB"]
Padding string: Not Null; must be one of ["NoPadding", "PKCS5Padding"]
TargetField string: Not Null

algorithm String: Not Null; must be one of ["RSA", "AES"]
fieldNameSuffix String: Not Null
key String: Not Null
mode String: Not Null; must be one of ["CBC", "CFB", "OFB", "CTR", "GCM", "ECB"]
padding String: Not Null; must be one of ["NoPadding", "PKCS5Padding"]
targetField String: Not Null

algorithm string: Not Null; must be one of ["RSA", "AES"]
fieldNameSuffix string: Not Null
key string: Not Null
mode string: Not Null; must be one of ["CBC", "CFB", "OFB", "CTR", "GCM", "ECB"]
padding string: Not Null; must be one of ["NoPadding", "PKCS5Padding"]
targetField string: Not Null

algorithm str: Not Null; must be one of ["RSA", "AES"]
field_name_suffix str: Not Null
key str: Not Null
mode str: Not Null; must be one of ["CBC", "CFB", "OFB", "CTR", "GCM", "ECB"]
padding str: Not Null; must be one of ["NoPadding", "PKCS5Padding"]
target_field str: Not Null

algorithm String: Not Null; must be one of ["RSA", "AES"]
fieldNameSuffix String: Not Null
key String: Not Null
mode String: Not Null; must be one of ["CBC", "CFB", "OFB", "CTR", "GCM", "ECB"]
padding String: Not Null; must be one of ["NoPadding", "PKCS5Padding"]
targetField String: Not Null

ConnectionConfigurationsStreamMapperMapperConfigurationEncryptionRsa, ConnectionConfigurationsStreamMapperMapperConfigurationEncryptionRsaArgs

Algorithm string: Not Null; must be one of ["RSA", "AES"]
FieldNameSuffix string: Not Null
PublicKey string: Not Null
TargetField string: Not Null

Algorithm string: Not Null; must be one of ["RSA", "AES"]
FieldNameSuffix string: Not Null
PublicKey string: Not Null
TargetField string: Not Null

algorithm String: Not Null; must be one of ["RSA", "AES"]
fieldNameSuffix String: Not Null
publicKey String: Not Null
targetField String: Not Null

algorithm string: Not Null; must be one of ["RSA", "AES"]
fieldNameSuffix string: Not Null
publicKey string: Not Null
targetField string: Not Null

algorithm str: Not Null; must be one of ["RSA", "AES"]
field_name_suffix str: Not Null
public_key str: Not Null
target_field str: Not Null

algorithm String: Not Null; must be one of ["RSA", "AES"]
fieldNameSuffix String: Not Null
publicKey String: Not Null
targetField String: Not Null

ConnectionConfigurationsStreamMapperMapperConfigurationFieldRenaming, ConnectionConfigurationsStreamMapperMapperConfigurationFieldRenamingArgs

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

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

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

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

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

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

ConnectionConfigurationsStreamMapperMapperConfigurationHashing, ConnectionConfigurationsStreamMapperMapperConfigurationHashingArgs

FieldNameSuffix string: The suffix to append to the field name after hashing. Not Null
Method string: The hashing algorithm to use. Not Null; must be one of ["MD2", "MD5", "SHA-1", "SHA-224", "SHA-256", "SHA-384", "SHA-512"]
TargetField string: The name of the field to be hashed. Not Null

FieldNameSuffix string: The suffix to append to the field name after hashing. Not Null
Method string: The hashing algorithm to use. Not Null; must be one of ["MD2", "MD5", "SHA-1", "SHA-224", "SHA-256", "SHA-384", "SHA-512"]
TargetField string: The name of the field to be hashed. Not Null

fieldNameSuffix String: The suffix to append to the field name after hashing. Not Null
method String: The hashing algorithm to use. Not Null; must be one of ["MD2", "MD5", "SHA-1", "SHA-224", "SHA-256", "SHA-384", "SHA-512"]
targetField String: The name of the field to be hashed. Not Null

fieldNameSuffix string: The suffix to append to the field name after hashing. Not Null
method string: The hashing algorithm to use. Not Null; must be one of ["MD2", "MD5", "SHA-1", "SHA-224", "SHA-256", "SHA-384", "SHA-512"]
targetField string: The name of the field to be hashed. Not Null

field_name_suffix str: The suffix to append to the field name after hashing. Not Null
method str: The hashing algorithm to use. Not Null; must be one of ["MD2", "MD5", "SHA-1", "SHA-224", "SHA-256", "SHA-384", "SHA-512"]
target_field str: The name of the field to be hashed. Not Null

fieldNameSuffix String: The suffix to append to the field name after hashing. Not Null
method String: The hashing algorithm to use. Not Null; must be one of ["MD2", "MD5", "SHA-1", "SHA-224", "SHA-256", "SHA-384", "SHA-512"]
targetField String: The name of the field to be hashed. Not Null

ConnectionConfigurationsStreamMapperMapperConfigurationRowFiltering, ConnectionConfigurationsStreamMapperMapperConfigurationRowFilteringArgs

Conditions string: Not Null; Parsed as JSON.

Conditions string: Not Null; Parsed as JSON.

conditions String: Not Null; Parsed as JSON.

conditions string: Not Null; Parsed as JSON.

conditions str: Not Null; Parsed as JSON.

conditions String: Not Null; Parsed as JSON.

ConnectionConfigurationsStreamSelectedField, ConnectionConfigurationsStreamSelectedFieldArgs

FieldPaths List<string>

FieldPaths []string

fieldPaths List<String>

fieldPaths string[]

field_paths Sequence[str]

fieldPaths List<String>

ConnectionSchedule, ConnectionScheduleArgs

BasicTiming string
CronExpression string
ScheduleType string: Not Null; must be one of ["manual", "cron"]

BasicTiming string
CronExpression string
ScheduleType string: Not Null; must be one of ["manual", "cron"]

basicTiming String
cronExpression String
scheduleType String: Not Null; must be one of ["manual", "cron"]

basicTiming string
cronExpression string
scheduleType string: Not Null; must be one of ["manual", "cron"]

basic_timing str
cron_expression str
schedule_type str: Not Null; must be one of ["manual", "cron"]

basicTiming String
cronExpression String
scheduleType String: Not Null; must be one of ["manual", "cron"]

ConnectionTag, ConnectionTagArgs

Color string: Not Null
Name string: Not Null
TagId string: Not Null
WorkspaceId string: Not Null

Color string: Not Null
Name string: Not Null
TagId string: Not Null
WorkspaceId string: Not Null

color String: Not Null
name String: Not Null
tagId String: Not Null
workspaceId String: Not Null

color string: Not Null
name string: Not Null
tagId string: Not Null
workspaceId string: Not Null

color str: Not Null
name str: Not Null
tag_id str: Not Null
workspace_id str: Not Null

color String: Not Null
name String: Not Null
tagId String: Not Null
workspaceId String: Not Null

Import

$ pulumi import airbyte:index/connection:Connection my_airbyte_connection ""

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: airbyte airbytehq/terraform-provider-airbyte
License
Notes: This Pulumi package is based on the airbyte Terraform Provider.

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

airbytehq/terraform-provider-airbyte

airbyte.Connection

On this page

On this page

Example Usage

Create Connection Resource

Constructor syntax

Parameters

Constructor example

Connection Resource Properties

Inputs

Outputs

Look up Existing Connection Resource

Supporting Types

ConnectionConfigurations, ConnectionConfigurationsArgs

ConnectionConfigurationsStream, ConnectionConfigurationsStreamArgs

ConnectionConfigurationsStreamMapper, ConnectionConfigurationsStreamMapperArgs

ConnectionConfigurationsStreamMapperMapperConfiguration, ConnectionConfigurationsStreamMapperMapperConfigurationArgs

ConnectionConfigurationsStreamMapperMapperConfigurationEncryption, ConnectionConfigurationsStreamMapperMapperConfigurationEncryptionArgs

ConnectionConfigurationsStreamMapperMapperConfigurationEncryptionAes, ConnectionConfigurationsStreamMapperMapperConfigurationEncryptionAesArgs

ConnectionConfigurationsStreamMapperMapperConfigurationEncryptionRsa, ConnectionConfigurationsStreamMapperMapperConfigurationEncryptionRsaArgs

ConnectionConfigurationsStreamMapperMapperConfigurationFieldRenaming, ConnectionConfigurationsStreamMapperMapperConfigurationFieldRenamingArgs

ConnectionConfigurationsStreamMapperMapperConfigurationHashing, ConnectionConfigurationsStreamMapperMapperConfigurationHashingArgs

ConnectionConfigurationsStreamMapperMapperConfigurationRowFiltering, ConnectionConfigurationsStreamMapperMapperConfigurationRowFilteringArgs

ConnectionConfigurationsStreamSelectedField, ConnectionConfigurationsStreamSelectedFieldArgs

ConnectionSchedule, ConnectionScheduleArgs

ConnectionTag, ConnectionTagArgs

Import

Package Details

On this page

On this page