airbyte 0.8.0-beta2, Mar 27 25

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

airbyte.DestinationDeepset

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.DestinationDeepset;
import com.pulumi.airbyte.DestinationDeepsetArgs;
import com.pulumi.airbyte.inputs.DestinationDeepsetConfigurationArgs;
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 myDestinationDeepset = new DestinationDeepset("myDestinationDeepset", DestinationDeepsetArgs.builder()
            .configuration(DestinationDeepsetConfigurationArgs.builder()
                .api_key("...my_api_key...")
                .base_url("...my_base_url...")
                .retries(5.99)
                .workspace("...my_workspace...")
                .build())
            .definitionId("c11a7a64-baea-4147-88f7-cef552af7b76")
            .workspaceId("8b8fb71d-00cc-452f-b5fb-61a41744e4b5")
            .build());

    }
}

resources:
  myDestinationDeepset:
    type: airbyte:DestinationDeepset
    properties:
      configuration:
        api_key: '...my_api_key...'
        base_url: '...my_base_url...'
        retries: 5.99
        workspace: '...my_workspace...'
      definitionId: c11a7a64-baea-4147-88f7-cef552af7b76
      workspaceId: 8b8fb71d-00cc-452f-b5fb-61a41744e4b5

Create DestinationDeepset Resource

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

Constructor syntax

new DestinationDeepset(name: string, args: DestinationDeepsetArgs, opts?: CustomResourceOptions);

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

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

func NewDestinationDeepset(ctx *Context, name string, args DestinationDeepsetArgs, opts ...ResourceOption) (*DestinationDeepset, error)

public DestinationDeepset(string name, DestinationDeepsetArgs args, CustomResourceOptions? opts = null)

public DestinationDeepset(String name, DestinationDeepsetArgs args)
public DestinationDeepset(String name, DestinationDeepsetArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args DestinationDeepsetArgs: 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 destinationDeepsetResource = new Airbyte.DestinationDeepset("destinationDeepsetResource", new()
{
    Configuration = new Airbyte.Inputs.DestinationDeepsetConfigurationArgs
    {
        ApiKey = "string",
        Workspace = "string",
        BaseUrl = "string",
        Retries = 0,
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
});

example, err := airbyte.NewDestinationDeepset(ctx, "destinationDeepsetResource", &airbyte.DestinationDeepsetArgs{
Configuration: &.DestinationDeepsetConfigurationArgs{
ApiKey: pulumi.String("string"),
Workspace: pulumi.String("string"),
BaseUrl: pulumi.String("string"),
Retries: pulumi.Float64(0),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
})

var destinationDeepsetResource = new DestinationDeepset("destinationDeepsetResource", DestinationDeepsetArgs.builder()
    .configuration(DestinationDeepsetConfigurationArgs.builder()
        .apiKey("string")
        .workspace("string")
        .baseUrl("string")
        .retries(0)
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .build());

destination_deepset_resource = airbyte.DestinationDeepset("destinationDeepsetResource",
    configuration={
        "api_key": "string",
        "workspace": "string",
        "base_url": "string",
        "retries": 0,
    },
    workspace_id="string",
    definition_id="string",
    name="string")

const destinationDeepsetResource = new airbyte.DestinationDeepset("destinationDeepsetResource", {
    configuration: {
        apiKey: "string",
        workspace: "string",
        baseUrl: "string",
        retries: 0,
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
});

type: airbyte:DestinationDeepset
properties:
    configuration:
        apiKey: string
        baseUrl: string
        retries: 0
        workspace: string
    definitionId: string
    name: string
    workspaceId: string

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

Configuration DestinationDeepsetConfiguration
WorkspaceId 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 DestinationDeepsetConfigurationArgs
WorkspaceId 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 DestinationDeepsetConfiguration
workspaceId 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 DestinationDeepsetConfiguration
workspaceId 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 DestinationDeepsetConfigurationArgs
workspace_id 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 Property Map
workspaceId 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 DestinationDeepset resource produces the following output properties:

CreatedAt double
DestinationId string
DestinationType string
Id string: The provider-assigned unique ID for this managed resource.
ResourceAllocation DestinationDeepsetResourceAllocation: 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 DestinationDeepsetResourceAllocation: 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 DestinationDeepsetResourceAllocation: 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 DestinationDeepsetResourceAllocation: 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 DestinationDeepsetResourceAllocation: 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 DestinationDeepset Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[DestinationDeepsetConfigurationArgs] = 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[DestinationDeepsetResourceAllocationArgs] = None,
        workspace_id: Optional[str] = None) -> DestinationDeepset

func GetDestinationDeepset(ctx *Context, name string, id IDInput, state *DestinationDeepsetState, opts ...ResourceOption) (*DestinationDeepset, error)

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

public static DestinationDeepset get(String name, Output<String> id, DestinationDeepsetState state, CustomResourceOptions options)

resources:  _:    type: airbyte:DestinationDeepset    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 DestinationDeepsetConfiguration
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 DestinationDeepsetResourceAllocation: 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 DestinationDeepsetConfigurationArgs
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 DestinationDeepsetResourceAllocationArgs: 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 DestinationDeepsetConfiguration
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 DestinationDeepsetResourceAllocation: 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 DestinationDeepsetConfiguration
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 DestinationDeepsetResourceAllocation: 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 DestinationDeepsetConfigurationArgs
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 DestinationDeepsetResourceAllocationArgs: 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 Property Map
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

DestinationDeepsetConfiguration, DestinationDeepsetConfigurationArgs

ApiKey string: Your deepset cloud API key
Workspace string: Name of workspace to which to sync the data.
BaseUrl string: URL of deepset Cloud API (e.g. https://api.cloud.deepset.ai, https://api.us.deepset.ai, etc). Defaults to https://api.cloud.deepset.ai. Default: "https://api.cloud.deepset.ai"
Retries double: Number of times to retry an action before giving up. Default: 5

ApiKey string: Your deepset cloud API key
Workspace string: Name of workspace to which to sync the data.
BaseUrl string: URL of deepset Cloud API (e.g. https://api.cloud.deepset.ai, https://api.us.deepset.ai, etc). Defaults to https://api.cloud.deepset.ai. Default: "https://api.cloud.deepset.ai"
Retries float64: Number of times to retry an action before giving up. Default: 5

apiKey String: Your deepset cloud API key
workspace String: Name of workspace to which to sync the data.
baseUrl String: URL of deepset Cloud API (e.g. https://api.cloud.deepset.ai, https://api.us.deepset.ai, etc). Defaults to https://api.cloud.deepset.ai. Default: "https://api.cloud.deepset.ai"
retries Double: Number of times to retry an action before giving up. Default: 5

apiKey string: Your deepset cloud API key
workspace string: Name of workspace to which to sync the data.
baseUrl string: URL of deepset Cloud API (e.g. https://api.cloud.deepset.ai, https://api.us.deepset.ai, etc). Defaults to https://api.cloud.deepset.ai. Default: "https://api.cloud.deepset.ai"
retries number: Number of times to retry an action before giving up. Default: 5

api_key str: Your deepset cloud API key
workspace str: Name of workspace to which to sync the data.
base_url str: URL of deepset Cloud API (e.g. https://api.cloud.deepset.ai, https://api.us.deepset.ai, etc). Defaults to https://api.cloud.deepset.ai. Default: "https://api.cloud.deepset.ai"
retries float: Number of times to retry an action before giving up. Default: 5

apiKey String: Your deepset cloud API key
workspace String: Name of workspace to which to sync the data.
baseUrl String: URL of deepset Cloud API (e.g. https://api.cloud.deepset.ai, https://api.us.deepset.ai, etc). Defaults to https://api.cloud.deepset.ai. Default: "https://api.cloud.deepset.ai"
retries Number: Number of times to retry an action before giving up. Default: 5

DestinationDeepsetResourceAllocation, DestinationDeepsetResourceAllocationArgs

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

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

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

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

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

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

DestinationDeepsetResourceAllocationDefault, DestinationDeepsetResourceAllocationDefaultArgs

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

DestinationDeepsetResourceAllocationJobSpecific, DestinationDeepsetResourceAllocationJobSpecificArgs

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 DestinationDeepsetResourceAllocationJobSpecificResourceRequirements: 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 DestinationDeepsetResourceAllocationJobSpecificResourceRequirements: 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 DestinationDeepsetResourceAllocationJobSpecificResourceRequirements: 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 DestinationDeepsetResourceAllocationJobSpecificResourceRequirements: 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 DestinationDeepsetResourceAllocationJobSpecificResourceRequirements: 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)

DestinationDeepsetResourceAllocationJobSpecificResourceRequirements, DestinationDeepsetResourceAllocationJobSpecificResourceRequirementsArgs

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/destinationDeepset:DestinationDeepset my_airbyte_destination_deepset ""

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.DestinationDeepset

On this page

On this page

Example Usage

Create DestinationDeepset Resource

Constructor syntax

Parameters

Constructor example

DestinationDeepset Resource Properties

Inputs

Outputs

Look up Existing DestinationDeepset Resource

Supporting Types

DestinationDeepsetConfiguration, DestinationDeepsetConfigurationArgs

DestinationDeepsetResourceAllocation, DestinationDeepsetResourceAllocationArgs

DestinationDeepsetResourceAllocationDefault, DestinationDeepsetResourceAllocationDefaultArgs

DestinationDeepsetResourceAllocationJobSpecific, DestinationDeepsetResourceAllocationJobSpecificArgs

DestinationDeepsetResourceAllocationJobSpecificResourceRequirements, DestinationDeepsetResourceAllocationJobSpecificResourceRequirementsArgs

Import

Package Details

On this page

On this page