airbyte 0.8.0-beta2, Mar 27 25

airbyte 0.8.0-beta2 published on Thursday, Mar 27, 2025 by airbytehq

airbyte.SourceMode

Explore with Pulumi AI

airbyte 0.8.0-beta2 published on Thursday, Mar 27, 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.SourceMode;
import com.pulumi.airbyte.SourceModeArgs;
import com.pulumi.airbyte.inputs.SourceModeConfigurationArgs;
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 mySourceMode = new SourceMode("mySourceMode", SourceModeArgs.builder()
            .configuration(SourceModeConfigurationArgs.builder()
                .api_secret("...my_api_secret...")
                .api_token("...my_api_token...")
                .workspace("...my_workspace...")
                .build())
            .definitionId("70ba78b8-dd9b-42e7-825d-4badf3a843d0")
            .secretId("...my_secret_id...")
            .workspaceId("340a8940-479e-4e4b-b8f5-b45758827a0e")
            .build());

    }
}

resources:
  mySourceMode:
    type: airbyte:SourceMode
    properties:
      configuration:
        api_secret: '...my_api_secret...'
        api_token: '...my_api_token...'
        workspace: '...my_workspace...'
      definitionId: 70ba78b8-dd9b-42e7-825d-4badf3a843d0
      secretId: '...my_secret_id...'
      workspaceId: 340a8940-479e-4e4b-b8f5-b45758827a0e

Create SourceMode Resource

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

Constructor syntax

new SourceMode(name: string, args: SourceModeArgs, opts?: CustomResourceOptions);

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

@overload
def SourceMode(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               configuration: Optional[SourceModeConfigurationArgs] = None,
               workspace_id: Optional[str] = None,
               definition_id: Optional[str] = None,
               name: Optional[str] = None,
               secret_id: Optional[str] = None)

func NewSourceMode(ctx *Context, name string, args SourceModeArgs, opts ...ResourceOption) (*SourceMode, error)

public SourceMode(string name, SourceModeArgs args, CustomResourceOptions? opts = null)

public SourceMode(String name, SourceModeArgs args)
public SourceMode(String name, SourceModeArgs args, CustomResourceOptions options)

type: airbyte:SourceMode
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 SourceModeArgs: 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 SourceModeArgs: 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 SourceModeArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args SourceModeArgs: 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 sourceModeResource = new Airbyte.SourceMode("sourceModeResource", new()
{
    Configuration = new Airbyte.Inputs.SourceModeConfigurationArgs
    {
        ApiSecret = "string",
        ApiToken = "string",
        Workspace = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

example, err := airbyte.NewSourceMode(ctx, "sourceModeResource", &airbyte.SourceModeArgs{
Configuration: &.SourceModeConfigurationArgs{
ApiSecret: pulumi.String("string"),
ApiToken: pulumi.String("string"),
Workspace: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

var sourceModeResource = new SourceMode("sourceModeResource", SourceModeArgs.builder()
    .configuration(SourceModeConfigurationArgs.builder()
        .apiSecret("string")
        .apiToken("string")
        .workspace("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

source_mode_resource = airbyte.SourceMode("sourceModeResource",
    configuration={
        "api_secret": "string",
        "api_token": "string",
        "workspace": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

const sourceModeResource = new airbyte.SourceMode("sourceModeResource", {
    configuration: {
        apiSecret: "string",
        apiToken: "string",
        workspace: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

type: airbyte:SourceMode
properties:
    configuration:
        apiSecret: string
        apiToken: string
        workspace: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

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

Configuration SourceModeConfiguration
WorkspaceId string
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Configuration SourceModeConfigurationArgs
WorkspaceId string
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration SourceModeConfiguration
workspaceId String
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration SourceModeConfiguration
workspaceId string
definitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name string: Name of the source e.g. dev-mysql-instance.
secretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration SourceModeConfigurationArgs
workspace_id str
definition_id str: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name str: Name of the source e.g. dev-mysql-instance.
secret_id str: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration Property Map
workspaceId String
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Outputs

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

CreatedAt double
Id string: The provider-assigned unique ID for this managed resource.
ResourceAllocation SourceModeResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SourceId string
SourceType string

CreatedAt float64
Id string: The provider-assigned unique ID for this managed resource.
ResourceAllocation SourceModeResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SourceId string
SourceType string

createdAt Double
id String: The provider-assigned unique ID for this managed resource.
resourceAllocation SourceModeResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
sourceId String
sourceType String

createdAt number
id string: The provider-assigned unique ID for this managed resource.
resourceAllocation SourceModeResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
sourceId string
sourceType string

created_at float
id str: The provider-assigned unique ID for this managed resource.
resource_allocation SourceModeResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
source_id str
source_type str

createdAt Number
id String: The provider-assigned unique ID for this managed resource.
resourceAllocation Property Map: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
sourceId String
sourceType String

Look up Existing SourceMode Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceModeConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        resource_allocation: Optional[SourceModeResourceAllocationArgs] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourceMode

func GetSourceMode(ctx *Context, name string, id IDInput, state *SourceModeState, opts ...ResourceOption) (*SourceMode, error)

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

public static SourceMode get(String name, Output<String> id, SourceModeState state, CustomResourceOptions options)

resources:  _:    type: airbyte:SourceMode    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:

Configuration SourceModeConfiguration
CreatedAt double
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
ResourceAllocation SourceModeResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string

Configuration SourceModeConfigurationArgs
CreatedAt float64
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
ResourceAllocation SourceModeResourceAllocationArgs: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string

configuration SourceModeConfiguration
createdAt Double
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
resourceAllocation SourceModeResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

configuration SourceModeConfiguration
createdAt number
definitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name string: Name of the source e.g. dev-mysql-instance.
resourceAllocation SourceModeResourceAllocation: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId string
sourceType string
workspaceId string

configuration SourceModeConfigurationArgs
created_at float
definition_id str: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name str: Name of the source e.g. dev-mysql-instance.
resource_allocation SourceModeResourceAllocationArgs: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secret_id str: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
source_id str
source_type str
workspace_id str

configuration Property Map
createdAt Number
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
resourceAllocation Property Map: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

Supporting Types

SourceModeConfiguration, SourceModeConfigurationArgs

ApiSecret string: API secret to use as the password for Basic Authentication.
ApiToken string: API token to use as the username for Basic Authentication.
Workspace string

ApiSecret string: API secret to use as the password for Basic Authentication.
ApiToken string: API token to use as the username for Basic Authentication.
Workspace string

apiSecret String: API secret to use as the password for Basic Authentication.
apiToken String: API token to use as the username for Basic Authentication.
workspace String

apiSecret string: API secret to use as the password for Basic Authentication.
apiToken string: API token to use as the username for Basic Authentication.
workspace string

api_secret str: API secret to use as the password for Basic Authentication.
api_token str: API token to use as the username for Basic Authentication.
workspace str

apiSecret String: API secret to use as the password for Basic Authentication.
apiToken String: API token to use as the username for Basic Authentication.
workspace String

SourceModeResourceAllocation, SourceModeResourceAllocationArgs

Default SourceModeResourceAllocationDefault: optional resource requirements to run workers (blank for unbounded allocations)
JobSpecifics List<SourceModeResourceAllocationJobSpecific>

Default SourceModeResourceAllocationDefault: optional resource requirements to run workers (blank for unbounded allocations)
JobSpecifics []SourceModeResourceAllocationJobSpecific

default_ SourceModeResourceAllocationDefault: optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics List<SourceModeResourceAllocationJobSpecific>

default SourceModeResourceAllocationDefault: optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics SourceModeResourceAllocationJobSpecific[]

default SourceModeResourceAllocationDefault: optional resource requirements to run workers (blank for unbounded allocations)
job_specifics Sequence[SourceModeResourceAllocationJobSpecific]

default Property Map: optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics List<Property Map>

SourceModeResourceAllocationDefault, SourceModeResourceAllocationDefaultArgs

CpuLimit string
CpuRequest string
EphemeralStorageLimit string
EphemeralStorageRequest string
MemoryLimit string
MemoryRequest string

CpuLimit string
CpuRequest string
EphemeralStorageLimit string
EphemeralStorageRequest string
MemoryLimit string
MemoryRequest string

cpuLimit String
cpuRequest String
ephemeralStorageLimit String
ephemeralStorageRequest String
memoryLimit String
memoryRequest String

cpuLimit string
cpuRequest string
ephemeralStorageLimit string
ephemeralStorageRequest string
memoryLimit string
memoryRequest string

cpu_limit str
cpu_request str
ephemeral_storage_limit str
ephemeral_storage_request str
memory_limit str
memory_request str

cpuLimit String
cpuRequest String
ephemeralStorageLimit String
ephemeralStorageRequest String
memoryLimit String
memoryRequest String

SourceModeResourceAllocationJobSpecific, SourceModeResourceAllocationJobSpecificArgs

JobType string: enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
ResourceRequirements SourceModeResourceAllocationJobSpecificResourceRequirements: optional resource requirements to run workers (blank for unbounded allocations)

JobType string: enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
ResourceRequirements SourceModeResourceAllocationJobSpecificResourceRequirements: optional resource requirements to run workers (blank for unbounded allocations)

jobType String: enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resourceRequirements SourceModeResourceAllocationJobSpecificResourceRequirements: optional resource requirements to run workers (blank for unbounded allocations)

jobType string: enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resourceRequirements SourceModeResourceAllocationJobSpecificResourceRequirements: optional resource requirements to run workers (blank for unbounded allocations)

job_type str: enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resource_requirements SourceModeResourceAllocationJobSpecificResourceRequirements: optional resource requirements to run workers (blank for unbounded allocations)

jobType String: enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resourceRequirements Property Map: optional resource requirements to run workers (blank for unbounded allocations)

SourceModeResourceAllocationJobSpecificResourceRequirements, SourceModeResourceAllocationJobSpecificResourceRequirementsArgs

CpuLimit string
CpuRequest string
EphemeralStorageLimit string
EphemeralStorageRequest string
MemoryLimit string
MemoryRequest string

CpuLimit string
CpuRequest string
EphemeralStorageLimit string
EphemeralStorageRequest string
MemoryLimit string
MemoryRequest string

cpuLimit String
cpuRequest String
ephemeralStorageLimit String
ephemeralStorageRequest String
memoryLimit String
memoryRequest String

cpuLimit string
cpuRequest string
ephemeralStorageLimit string
ephemeralStorageRequest string
memoryLimit string
memoryRequest string

cpu_limit str
cpu_request str
ephemeral_storage_limit str
ephemeral_storage_request str
memory_limit str
memory_request str

cpuLimit String
cpuRequest String
ephemeralStorageLimit String
ephemeralStorageRequest String
memoryLimit String
memoryRequest String

Import

$ pulumi import airbyte:index/sourceMode:SourceMode my_airbyte_source_mode ""

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.8.0-beta2 published on Thursday, Mar 27, 2025 by airbytehq

airbytehq/terraform-provider-airbyte

airbyte.SourceMode

On this page

On this page

Example Usage

Create SourceMode Resource

Constructor syntax

Parameters

Constructor example

SourceMode Resource Properties

Inputs

Outputs

Look up Existing SourceMode Resource

Supporting Types

SourceModeConfiguration, SourceModeConfigurationArgs

SourceModeResourceAllocation, SourceModeResourceAllocationArgs

SourceModeResourceAllocationDefault, SourceModeResourceAllocationDefaultArgs

SourceModeResourceAllocationJobSpecific, SourceModeResourceAllocationJobSpecificArgs

SourceModeResourceAllocationJobSpecificResourceRequirements, SourceModeResourceAllocationJobSpecificResourceRequirementsArgs

Import

Package Details

On this page

On this page