airbyte 0.8.0-beta2, Mar 27 25

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

airbyte.DestinationConvex

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.DestinationConvex;
import com.pulumi.airbyte.DestinationConvexArgs;
import com.pulumi.airbyte.inputs.DestinationConvexConfigurationArgs;
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 myDestinationConvex = new DestinationConvex("myDestinationConvex", DestinationConvexArgs.builder()
            .configuration(DestinationConvexConfigurationArgs.builder()
                .access_key("...my_access_key...")
                .deployment_url("https://murky-swan-635.convex.cloud")
                .build())
            .definitionId("ecdd0a64-9bfa-4ec1-81e5-5ae9a4e94cf7")
            .workspaceId("c753766d-fb7a-4ec8-a514-3a8d07d6f56b")
            .build());

    }
}

resources:
  myDestinationConvex:
    type: airbyte:DestinationConvex
    properties:
      configuration:
        access_key: '...my_access_key...'
        deployment_url: https://murky-swan-635.convex.cloud
      definitionId: ecdd0a64-9bfa-4ec1-81e5-5ae9a4e94cf7
      workspaceId: c753766d-fb7a-4ec8-a514-3a8d07d6f56b

Create DestinationConvex Resource

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

Constructor syntax

new DestinationConvex(name: string, args: DestinationConvexArgs, opts?: CustomResourceOptions);

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

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

func NewDestinationConvex(ctx *Context, name string, args DestinationConvexArgs, opts ...ResourceOption) (*DestinationConvex, error)

public DestinationConvex(string name, DestinationConvexArgs args, CustomResourceOptions? opts = null)

public DestinationConvex(String name, DestinationConvexArgs args)
public DestinationConvex(String name, DestinationConvexArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args DestinationConvexArgs: 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 destinationConvexResource = new Airbyte.DestinationConvex("destinationConvexResource", new()
{
    Configuration = new Airbyte.Inputs.DestinationConvexConfigurationArgs
    {
        AccessKey = "string",
        DeploymentUrl = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
});

example, err := airbyte.NewDestinationConvex(ctx, "destinationConvexResource", &airbyte.DestinationConvexArgs{
Configuration: &.DestinationConvexConfigurationArgs{
AccessKey: pulumi.String("string"),
DeploymentUrl: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
})

var destinationConvexResource = new DestinationConvex("destinationConvexResource", DestinationConvexArgs.builder()
    .configuration(DestinationConvexConfigurationArgs.builder()
        .accessKey("string")
        .deploymentUrl("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .build());

destination_convex_resource = airbyte.DestinationConvex("destinationConvexResource",
    configuration={
        "access_key": "string",
        "deployment_url": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string")

const destinationConvexResource = new airbyte.DestinationConvex("destinationConvexResource", {
    configuration: {
        accessKey: "string",
        deploymentUrl: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
});

type: airbyte:DestinationConvex
properties:
    configuration:
        accessKey: string
        deploymentUrl: string
    definitionId: string
    name: string
    workspaceId: string

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

Configuration DestinationConvexConfiguration
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 DestinationConvexConfigurationArgs
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 DestinationConvexConfiguration
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 DestinationConvexConfiguration
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 DestinationConvexConfigurationArgs
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 DestinationConvex resource produces the following output properties:

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

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

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

func GetDestinationConvex(ctx *Context, name string, id IDInput, state *DestinationConvexState, opts ...ResourceOption) (*DestinationConvex, error)

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

public static DestinationConvex get(String name, Output<String> id, DestinationConvexState state, CustomResourceOptions options)

resources:  _:    type: airbyte:DestinationConvex    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 DestinationConvexConfiguration
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 DestinationConvexResourceAllocation: 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 DestinationConvexConfigurationArgs
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 DestinationConvexResourceAllocationArgs: 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 DestinationConvexConfiguration
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 DestinationConvexResourceAllocation: 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 DestinationConvexConfiguration
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 DestinationConvexResourceAllocation: 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 DestinationConvexConfigurationArgs
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 DestinationConvexResourceAllocationArgs: 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

DestinationConvexConfiguration, DestinationConvexConfigurationArgs

AccessKey string: API access key used to send data to a Convex deployment.
DeploymentUrl string: URL of the Convex deployment that is the destination

AccessKey string: API access key used to send data to a Convex deployment.
DeploymentUrl string: URL of the Convex deployment that is the destination

accessKey String: API access key used to send data to a Convex deployment.
deploymentUrl String: URL of the Convex deployment that is the destination

accessKey string: API access key used to send data to a Convex deployment.
deploymentUrl string: URL of the Convex deployment that is the destination

access_key str: API access key used to send data to a Convex deployment.
deployment_url str: URL of the Convex deployment that is the destination

accessKey String: API access key used to send data to a Convex deployment.
deploymentUrl String: URL of the Convex deployment that is the destination

DestinationConvexResourceAllocation, DestinationConvexResourceAllocationArgs

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

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

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

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

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

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

DestinationConvexResourceAllocationDefault, DestinationConvexResourceAllocationDefaultArgs

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

DestinationConvexResourceAllocationJobSpecific, DestinationConvexResourceAllocationJobSpecificArgs

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

DestinationConvexResourceAllocationJobSpecificResourceRequirements, DestinationConvexResourceAllocationJobSpecificResourceRequirementsArgs

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/destinationConvex:DestinationConvex my_airbyte_destination_convex ""

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

On this page

On this page

Example Usage

Create DestinationConvex Resource

Constructor syntax

Parameters

Constructor example

DestinationConvex Resource Properties

Inputs

Outputs

Look up Existing DestinationConvex Resource

Supporting Types

DestinationConvexConfiguration, DestinationConvexConfigurationArgs

DestinationConvexResourceAllocation, DestinationConvexResourceAllocationArgs

DestinationConvexResourceAllocationDefault, DestinationConvexResourceAllocationDefaultArgs

DestinationConvexResourceAllocationJobSpecific, DestinationConvexResourceAllocationJobSpecificArgs

DestinationConvexResourceAllocationJobSpecificResourceRequirements, DestinationConvexResourceAllocationJobSpecificResourceRequirementsArgs

Import

Package Details

On this page

On this page