1. Packages
  2. Airbyte Provider
  3. API Docs
  4. getDestination
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

    Destination DataSource

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as airbyte from "@pulumi/airbyte";
    
    const myDestination = airbyte.getDestination({
        destinationId: "...my_destination_id...",
        includeSecretCoordinates: false,
    });
    
    import pulumi
    import pulumi_airbyte as airbyte
    
    my_destination = airbyte.get_destination(destination_id="...my_destination_id...",
        include_secret_coordinates=False)
    
    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.LookupDestination(ctx, &airbyte.LookupDestinationArgs{
    			DestinationId:            "...my_destination_id...",
    			IncludeSecretCoordinates: pulumi.BoolRef(false),
    		}, 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 myDestination = Airbyte.GetDestination.Invoke(new()
        {
            DestinationId = "...my_destination_id...",
            IncludeSecretCoordinates = false,
        });
    
    });
    
    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.GetDestinationArgs;
    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 myDestination = AirbyteFunctions.getDestination(GetDestinationArgs.builder()
                .destinationId("...my_destination_id...")
                .includeSecretCoordinates(false)
                .build());
    
        }
    }
    
    variables:
      myDestination:
        fn::invoke:
          function: airbyte:getDestination
          arguments:
            destinationId: '...my_destination_id...'
            includeSecretCoordinates: false
    

    Using getDestination

    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 getDestination(args: GetDestinationArgs, opts?: InvokeOptions): Promise<GetDestinationResult>
    function getDestinationOutput(args: GetDestinationOutputArgs, opts?: InvokeOptions): Output<GetDestinationResult>
    def get_destination(destination_id: Optional[str] = None,
                        include_secret_coordinates: Optional[bool] = None,
                        opts: Optional[InvokeOptions] = None) -> GetDestinationResult
    def get_destination_output(destination_id: Optional[pulumi.Input[str]] = None,
                        include_secret_coordinates: Optional[pulumi.Input[bool]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetDestinationResult]
    func LookupDestination(ctx *Context, args *LookupDestinationArgs, opts ...InvokeOption) (*LookupDestinationResult, error)
    func LookupDestinationOutput(ctx *Context, args *LookupDestinationOutputArgs, opts ...InvokeOption) LookupDestinationResultOutput

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

    public static class GetDestination 
    {
        public static Task<GetDestinationResult> InvokeAsync(GetDestinationArgs args, InvokeOptions? opts = null)
        public static Output<GetDestinationResult> Invoke(GetDestinationInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDestinationResult> getDestination(GetDestinationArgs args, InvokeOptions options)
    public static Output<GetDestinationResult> getDestination(GetDestinationArgs args, InvokeOptions options)
    
    fn::invoke:
      function: airbyte:index/getDestination:getDestination
      arguments:
        # arguments dictionary

    The following arguments are supported:

    DestinationId string
    IncludeSecretCoordinates bool
    Rather than return *** for secret properties include the secret coordinate information
    DestinationId string
    IncludeSecretCoordinates bool
    Rather than return *** for secret properties include the secret coordinate information
    destinationId String
    includeSecretCoordinates Boolean
    Rather than return *** for secret properties include the secret coordinate information
    destinationId string
    includeSecretCoordinates boolean
    Rather than return *** for secret properties include the secret coordinate information
    destination_id str
    include_secret_coordinates bool
    Rather than return *** for secret properties include the secret coordinate information
    destinationId String
    includeSecretCoordinates Boolean
    Rather than return *** for secret properties include the secret coordinate information

    getDestination Result

    The following output properties are available:

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

    Supporting Types

    GetDestinationResourceAllocation

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

    GetDestinationResourceAllocationDefault

    GetDestinationResourceAllocationJobSpecific

    JobType string
    enum that describes the different types of jobs that the platform runs.
    ResourceRequirements GetDestinationResourceAllocationJobSpecificResourceRequirements
    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 GetDestinationResourceAllocationJobSpecificResourceRequirements
    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 GetDestinationResourceAllocationJobSpecificResourceRequirements
    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 GetDestinationResourceAllocationJobSpecificResourceRequirements
    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 GetDestinationResourceAllocationJobSpecificResourceRequirements
    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)

    GetDestinationResourceAllocationJobSpecificResourceRequirements

    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.