1. Packages
  2. Airbyte Provider
  3. API Docs
  4. getSource
Viewing docs for airbyte 1.0.0
published on Wednesday, Mar 4, 2026 by airbytehq
airbyte logo
Viewing docs for airbyte 1.0.0
published on Wednesday, Mar 4, 2026 by airbytehq

    Source DataSource

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as airbyte from "@pulumi/airbyte";
    
    const mySource = airbyte.getSource({
        includeSecretCoordinates: false,
        sourceId: "...my_source_id...",
    });
    
    import pulumi
    import pulumi_airbyte as airbyte
    
    my_source = airbyte.get_source(include_secret_coordinates=False,
        source_id="...my_source_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.LookupSource(ctx, &airbyte.LookupSourceArgs{
    			IncludeSecretCoordinates: pulumi.BoolRef(false),
    			SourceId:                 "...my_source_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 mySource = Airbyte.GetSource.Invoke(new()
        {
            IncludeSecretCoordinates = false,
            SourceId = "...my_source_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.GetSourceArgs;
    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 mySource = AirbyteFunctions.getSource(GetSourceArgs.builder()
                .includeSecretCoordinates(false)
                .sourceId("...my_source_id...")
                .build());
    
        }
    }
    
    variables:
      mySource:
        fn::invoke:
          function: airbyte:getSource
          arguments:
            includeSecretCoordinates: false
            sourceId: '...my_source_id...'
    

    Using getSource

    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 getSource(args: GetSourceArgs, opts?: InvokeOptions): Promise<GetSourceResult>
    function getSourceOutput(args: GetSourceOutputArgs, opts?: InvokeOptions): Output<GetSourceResult>
    def get_source(include_secret_coordinates: Optional[bool] = None,
                   source_id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetSourceResult
    def get_source_output(include_secret_coordinates: Optional[pulumi.Input[bool]] = None,
                   source_id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetSourceResult]
    func LookupSource(ctx *Context, args *LookupSourceArgs, opts ...InvokeOption) (*LookupSourceResult, error)
    func LookupSourceOutput(ctx *Context, args *LookupSourceOutputArgs, opts ...InvokeOption) LookupSourceResultOutput

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

    public static class GetSource 
    {
        public static Task<GetSourceResult> InvokeAsync(GetSourceArgs args, InvokeOptions? opts = null)
        public static Output<GetSourceResult> Invoke(GetSourceInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSourceResult> getSource(GetSourceArgs args, InvokeOptions options)
    public static Output<GetSourceResult> getSource(GetSourceArgs args, InvokeOptions options)
    
    fn::invoke:
      function: airbyte:index/getSource:getSource
      arguments:
        # arguments dictionary

    The following arguments are supported:

    SourceId string
    IncludeSecretCoordinates bool
    Rather than return *** for secret properties include the secret coordinate information
    SourceId string
    IncludeSecretCoordinates bool
    Rather than return *** for secret properties include the secret coordinate information
    sourceId String
    includeSecretCoordinates Boolean
    Rather than return *** for secret properties include the secret coordinate information
    sourceId string
    includeSecretCoordinates boolean
    Rather than return *** for secret properties include the secret coordinate information
    source_id str
    include_secret_coordinates bool
    Rather than return *** for secret properties include the secret coordinate information
    sourceId String
    includeSecretCoordinates Boolean
    Rather than return *** for secret properties include the secret coordinate information

    getSource Result

    The following output properties are available:

    Configuration string
    The values required to configure the source. The schema for this must match the schema return by sourcedefinitionspecifications/get for the source. Parsed as JSON.
    CreatedAt double
    DefinitionId string
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    ResourceAllocation GetSourceResourceAllocation
    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
    WorkspaceId string
    IncludeSecretCoordinates bool
    Rather than return *** for secret properties include the secret coordinate information
    Configuration string
    The values required to configure the source. The schema for this must match the schema return by sourcedefinitionspecifications/get for the source. Parsed as JSON.
    CreatedAt float64
    DefinitionId string
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    ResourceAllocation GetSourceResourceAllocation
    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
    WorkspaceId string
    IncludeSecretCoordinates bool
    Rather than return *** for secret properties include the secret coordinate information
    configuration String
    The values required to configure the source. The schema for this must match the schema return by sourcedefinitionspecifications/get for the source. Parsed as JSON.
    createdAt Double
    definitionId String
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    resourceAllocation GetSourceResourceAllocation
    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
    workspaceId String
    includeSecretCoordinates Boolean
    Rather than return *** for secret properties include the secret coordinate information
    configuration string
    The values required to configure the source. The schema for this must match the schema return by sourcedefinitionspecifications/get for the source. Parsed as JSON.
    createdAt number
    definitionId string
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    resourceAllocation GetSourceResourceAllocation
    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
    workspaceId string
    includeSecretCoordinates boolean
    Rather than return *** for secret properties include the secret coordinate information
    configuration str
    The values required to configure the source. The schema for this must match the schema return by sourcedefinitionspecifications/get for the source. Parsed as JSON.
    created_at float
    definition_id str
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    resource_allocation GetSourceResourceAllocation
    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
    workspace_id str
    include_secret_coordinates bool
    Rather than return *** for secret properties include the secret coordinate information
    configuration String
    The values required to configure the source. The schema for this must match the schema return by sourcedefinitionspecifications/get for the source. Parsed as JSON.
    createdAt Number
    definitionId String
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    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
    workspaceId String
    includeSecretCoordinates Boolean
    Rather than return *** for secret properties include the secret coordinate information

    Supporting Types

    GetSourceResourceAllocation

    Default GetSourceResourceAllocationDefault
    optional resource requirements to run workers (blank for unbounded allocations)
    JobSpecifics List<GetSourceResourceAllocationJobSpecific>
    Default GetSourceResourceAllocationDefault
    optional resource requirements to run workers (blank for unbounded allocations)
    JobSpecifics []GetSourceResourceAllocationJobSpecific
    default_ GetSourceResourceAllocationDefault
    optional resource requirements to run workers (blank for unbounded allocations)
    jobSpecifics List<GetSourceResourceAllocationJobSpecific>
    default GetSourceResourceAllocationDefault
    optional resource requirements to run workers (blank for unbounded allocations)
    jobSpecifics GetSourceResourceAllocationJobSpecific[]
    default GetSourceResourceAllocationDefault
    optional resource requirements to run workers (blank for unbounded allocations)
    job_specifics Sequence[GetSourceResourceAllocationJobSpecific]
    default Property Map
    optional resource requirements to run workers (blank for unbounded allocations)
    jobSpecifics List<Property Map>

    GetSourceResourceAllocationDefault

    GetSourceResourceAllocationJobSpecific

    JobType string
    enum that describes the different types of jobs that the platform runs.
    ResourceRequirements GetSourceResourceAllocationJobSpecificResourceRequirements
    optional resource requirements to run workers (blank for unbounded allocations)
    JobType string
    enum that describes the different types of jobs that the platform runs.
    ResourceRequirements GetSourceResourceAllocationJobSpecificResourceRequirements
    optional resource requirements to run workers (blank for unbounded allocations)
    jobType String
    enum that describes the different types of jobs that the platform runs.
    resourceRequirements GetSourceResourceAllocationJobSpecificResourceRequirements
    optional resource requirements to run workers (blank for unbounded allocations)
    jobType string
    enum that describes the different types of jobs that the platform runs.
    resourceRequirements GetSourceResourceAllocationJobSpecificResourceRequirements
    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.
    resource_requirements GetSourceResourceAllocationJobSpecificResourceRequirements
    optional resource requirements to run workers (blank for unbounded allocations)
    jobType String
    enum that describes the different types of jobs that the platform runs.
    resourceRequirements Property Map
    optional resource requirements to run workers (blank for unbounded allocations)

    GetSourceResourceAllocationJobSpecificResourceRequirements

    Package Details

    Repository
    airbyte airbytehq/terraform-provider-airbyte
    License
    Notes
    This Pulumi package is based on the airbyte Terraform Provider.
    airbyte logo
    Viewing docs for airbyte 1.0.0
    published on Wednesday, Mar 4, 2026 by airbytehq
      Try Pulumi Cloud free. Your team will thank you.