1. Packages
  2. Airbyte Provider
  3. API Docs
  4. DestinationCustom
airbyte 0.10.0 published on Monday, Apr 14, 2025 by airbytehq

airbyte.DestinationCustom

Explore with Pulumi AI

DestinationCustom Resource

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.DestinationCustom;
import com.pulumi.airbyte.DestinationCustomArgs;
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 myDestinationCustom = new DestinationCustom("myDestinationCustom", DestinationCustomArgs.builder()
            .configuration(Map.of("user", "charles"))
            .definitionId("07bacc7a-a59a-4a47-b4ae-31030ef9e941")
            .workspaceId("38d0a8b3-769a-4f52-be2d-38d6aaf96641")
            .build());

    }
}
Copy
resources:
  myDestinationCustom:
    type: airbyte:DestinationCustom
    properties:
      configuration:
        user: charles
      definitionId: 07bacc7a-a59a-4a47-b4ae-31030ef9e941
      workspaceId: 38d0a8b3-769a-4f52-be2d-38d6aaf96641
Copy

Create DestinationCustom Resource

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

Constructor syntax

new DestinationCustom(name: string, args: DestinationCustomArgs, opts?: CustomResourceOptions);
@overload
def DestinationCustom(resource_name: str,
                      args: DestinationCustomArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def DestinationCustom(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      configuration: Optional[str] = None,
                      workspace_id: Optional[str] = None,
                      definition_id: Optional[str] = None,
                      name: Optional[str] = None)
func NewDestinationCustom(ctx *Context, name string, args DestinationCustomArgs, opts ...ResourceOption) (*DestinationCustom, error)
public DestinationCustom(string name, DestinationCustomArgs args, CustomResourceOptions? opts = null)
public DestinationCustom(String name, DestinationCustomArgs args)
public DestinationCustom(String name, DestinationCustomArgs args, CustomResourceOptions options)
type: airbyte:DestinationCustom
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DestinationCustomArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DestinationCustomArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DestinationCustomArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DestinationCustomArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DestinationCustomArgs
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 destinationCustomResource = new Airbyte.DestinationCustom("destinationCustomResource", new()
{
    Configuration = "string",
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
});
Copy
example, err := airbyte.NewDestinationCustom(ctx, "destinationCustomResource", &airbyte.DestinationCustomArgs{
Configuration: pulumi.String("string"),
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
})
Copy
var destinationCustomResource = new DestinationCustom("destinationCustomResource", DestinationCustomArgs.builder()
    .configuration("string")
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .build());
Copy
destination_custom_resource = airbyte.DestinationCustom("destinationCustomResource",
    configuration="string",
    workspace_id="string",
    definition_id="string",
    name="string")
Copy
const destinationCustomResource = new airbyte.DestinationCustom("destinationCustomResource", {
    configuration: "string",
    workspaceId: "string",
    definitionId: "string",
    name: "string",
});
Copy
type: airbyte:DestinationCustom
properties:
    configuration: string
    definitionId: string
    name: string
    workspaceId: string
Copy

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

Configuration This property is required. string
The values required to configure the destination. Parsed as JSON.
WorkspaceId This property is required. string
DefinitionId string
The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
Name string
Name of the destination e.g. dev-mysql-instance.
Configuration This property is required. string
The values required to configure the destination. Parsed as JSON.
WorkspaceId This property is required. string
DefinitionId string
The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
Name string
Name of the destination e.g. dev-mysql-instance.
configuration This property is required. String
The values required to configure the destination. Parsed as JSON.
workspaceId This property is required. String
definitionId String
The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
name String
Name of the destination e.g. dev-mysql-instance.
configuration This property is required. string
The values required to configure the destination. Parsed as JSON.
workspaceId This property is required. string
definitionId string
The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
name string
Name of the destination e.g. dev-mysql-instance.
configuration This property is required. str
The values required to configure the destination. Parsed as JSON.
workspace_id This property is required. str
definition_id str
The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
name str
Name of the destination e.g. dev-mysql-instance.
configuration This property is required. String
The values required to configure the destination. Parsed as JSON.
workspaceId This property is required. String
definitionId String
The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
name String
Name of the destination e.g. dev-mysql-instance.

Outputs

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

CreatedAt double
DestinationId string
DestinationType string
Id string
The provider-assigned unique ID for this managed resource.
ResourceAllocation DestinationCustomResourceAllocation
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.
CreatedAt float64
DestinationId string
DestinationType string
Id string
The provider-assigned unique ID for this managed resource.
ResourceAllocation DestinationCustomResourceAllocation
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.
createdAt Double
destinationId String
destinationType String
id String
The provider-assigned unique ID for this managed resource.
resourceAllocation DestinationCustomResourceAllocation
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.
createdAt number
destinationId string
destinationType string
id string
The provider-assigned unique ID for this managed resource.
resourceAllocation DestinationCustomResourceAllocation
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.
created_at float
destination_id str
destination_type str
id str
The provider-assigned unique ID for this managed resource.
resource_allocation DestinationCustomResourceAllocation
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.
createdAt Number
destinationId String
destinationType String
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.

Look up Existing DestinationCustom Resource

Get an existing DestinationCustom 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?: DestinationCustomState, opts?: CustomResourceOptions): DestinationCustom
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[str] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        destination_id: Optional[str] = None,
        destination_type: Optional[str] = None,
        name: Optional[str] = None,
        resource_allocation: Optional[DestinationCustomResourceAllocationArgs] = None,
        workspace_id: Optional[str] = None) -> DestinationCustom
func GetDestinationCustom(ctx *Context, name string, id IDInput, state *DestinationCustomState, opts ...ResourceOption) (*DestinationCustom, error)
public static DestinationCustom Get(string name, Input<string> id, DestinationCustomState? state, CustomResourceOptions? opts = null)
public static DestinationCustom get(String name, Output<String> id, DestinationCustomState state, CustomResourceOptions options)
resources:  _:    type: airbyte:DestinationCustom    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 string
The values required to configure the destination. Parsed as JSON.
CreatedAt double
DefinitionId string
The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
DestinationId string
DestinationType string
Name string
Name of the destination e.g. dev-mysql-instance.
ResourceAllocation DestinationCustomResourceAllocation
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
Configuration string
The values required to configure the destination. Parsed as JSON.
CreatedAt float64
DefinitionId string
The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
DestinationId string
DestinationType string
Name string
Name of the destination e.g. dev-mysql-instance.
ResourceAllocation DestinationCustomResourceAllocationArgs
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
configuration String
The values required to configure the destination. Parsed as JSON.
createdAt Double
definitionId String
The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
destinationId String
destinationType String
name String
Name of the destination e.g. dev-mysql-instance.
resourceAllocation DestinationCustomResourceAllocation
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
configuration string
The values required to configure the destination. Parsed as JSON.
createdAt number
definitionId string
The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
destinationId string
destinationType string
name string
Name of the destination e.g. dev-mysql-instance.
resourceAllocation DestinationCustomResourceAllocation
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
configuration str
The values required to configure the destination. Parsed as JSON.
created_at float
definition_id str
The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
destination_id str
destination_type str
name str
Name of the destination e.g. dev-mysql-instance.
resource_allocation DestinationCustomResourceAllocationArgs
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
configuration String
The values required to configure the destination. Parsed as JSON.
createdAt Number
definitionId String
The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
destinationId String
destinationType String
name String
Name of the destination 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.
workspaceId String

Supporting Types

DestinationCustomResourceAllocation
, DestinationCustomResourceAllocationArgs

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

DestinationCustomResourceAllocationDefault
, DestinationCustomResourceAllocationDefaultArgs

DestinationCustomResourceAllocationJobSpecific
, DestinationCustomResourceAllocationJobSpecificArgs

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 DestinationCustomResourceAllocationJobSpecificResourceRequirements
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 DestinationCustomResourceAllocationJobSpecificResourceRequirements
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 DestinationCustomResourceAllocationJobSpecificResourceRequirements
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 DestinationCustomResourceAllocationJobSpecificResourceRequirements
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 DestinationCustomResourceAllocationJobSpecificResourceRequirements
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)

DestinationCustomResourceAllocationJobSpecificResourceRequirements
, DestinationCustomResourceAllocationJobSpecificResourceRequirementsArgs

Import

$ pulumi import airbyte:index/destinationCustom:DestinationCustom my_airbyte_destination_custom ""
Copy

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.