Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Airbyte Provider
  3. API Docs
  4. DestinationTypesense
airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq
airbytehq/terraform-provider-airbyte

airbyte.DestinationTypesense

Explore with Pulumi AI

airbyte logo
airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq
airbytehq/terraform-provider-airbyte

    DestinationTypesense 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.DestinationTypesense;
import com.pulumi.airbyte.DestinationTypesenseArgs;
import com.pulumi.airbyte.inputs.DestinationTypesenseConfigurationArgs;
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 myDestinationTypesense = new DestinationTypesense("myDestinationTypesense", DestinationTypesenseArgs.builder()
            .configuration(DestinationTypesenseConfigurationArgs.builder()
                .api_key("...my_api_key...")
                .batch_size(1)
                .host("...my_host...")
                .path("...my_path...")
                .port("...my_port...")
                .protocol("...my_protocol...")
                .build())
            .definitionId("09194d31-6259-4e62-bc00-bbff9003411f")
            .workspaceId("4d5d1b2b-06f0-4b0b-9f55-26250b3c87d0")
            .build());

    }
}

    resources:
  myDestinationTypesense:
    type: airbyte:DestinationTypesense
    properties:
      configuration:
        api_key: '...my_api_key...'
        batch_size: 1
        host: '...my_host...'
        path: '...my_path...'
        port: '...my_port...'
        protocol: '...my_protocol...'
      definitionId: 09194d31-6259-4e62-bc00-bbff9003411f
      workspaceId: 4d5d1b2b-06f0-4b0b-9f55-26250b3c87d0

    Create DestinationTypesense Resource

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

    Constructor syntax

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

@overload
def DestinationTypesense(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         configuration: Optional[DestinationTypesenseConfigurationArgs] = None,
                         workspace_id: Optional[str] = None,
                         definition_id: Optional[str] = None,
                         name: Optional[str] = None)
    func NewDestinationTypesense(ctx *Context, name string, args DestinationTypesenseArgs, opts ...ResourceOption) (*DestinationTypesense, error)
    public DestinationTypesense(string name, DestinationTypesenseArgs args, CustomResourceOptions? opts = null)
    public DestinationTypesense(String name, DestinationTypesenseArgs args)
public DestinationTypesense(String name, DestinationTypesenseArgs args, CustomResourceOptions options)

    type: airbyte:DestinationTypesense
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 DestinationTypesenseArgs
    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 DestinationTypesenseArgs
    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 DestinationTypesenseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DestinationTypesenseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DestinationTypesenseArgs
    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 destinationTypesenseResource = new Airbyte.DestinationTypesense("destinationTypesenseResource", new()
{
    Configuration = new Airbyte.Inputs.DestinationTypesenseConfigurationArgs
    {
        ApiKey = "string",
        Host = "string",
        BatchSize = 0,
        Path = "string",
        Port = "string",
        Protocol = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
});

    example, err := airbyte.NewDestinationTypesense(ctx, "destinationTypesenseResource", &airbyte.DestinationTypesenseArgs{
Configuration: &.DestinationTypesenseConfigurationArgs{
ApiKey: pulumi.String("string"),
Host: pulumi.String("string"),
BatchSize: pulumi.Float64(0),
Path: pulumi.String("string"),
Port: pulumi.String("string"),
Protocol: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
})

    var destinationTypesenseResource = new DestinationTypesense("destinationTypesenseResource", DestinationTypesenseArgs.builder()
    .configuration(DestinationTypesenseConfigurationArgs.builder()
        .apiKey("string")
        .host("string")
        .batchSize(0)
        .path("string")
        .port("string")
        .protocol("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .build());

    destination_typesense_resource = airbyte.DestinationTypesense("destinationTypesenseResource",
    configuration={
        "api_key": "string",
        "host": "string",
        "batch_size": 0,
        "path": "string",
        "port": "string",
        "protocol": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string")

    const destinationTypesenseResource = new airbyte.DestinationTypesense("destinationTypesenseResource", {
    configuration: {
        apiKey: "string",
        host: "string",
        batchSize: 0,
        path: "string",
        port: "string",
        protocol: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
});

    type: airbyte:DestinationTypesense
properties:
    configuration:
        apiKey: string
        batchSize: 0
        host: string
        path: string
        port: string
        protocol: string
    definitionId: string
    name: string
    workspaceId: string

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

    Configuration DestinationTypesenseConfiguration
    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 DestinationTypesenseConfigurationArgs
    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 DestinationTypesenseConfiguration
    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 DestinationTypesenseConfiguration
    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 DestinationTypesenseConfigurationArgs
    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 DestinationTypesense resource produces the following output properties:

    CreatedAt double
    DestinationId string
    DestinationType string
    Id string
    The provider-assigned unique ID for this managed resource.
    CreatedAt float64
    DestinationId string
    DestinationType string
    Id string
    The provider-assigned unique ID for this managed resource.
    createdAt Double
    destinationId String
    destinationType String
    id String
    The provider-assigned unique ID for this managed resource.
    createdAt number
    destinationId string
    destinationType string
    id string
    The provider-assigned unique ID for this managed resource.
    created_at float
    destination_id str
    destination_type str
    id str
    The provider-assigned unique ID for this managed resource.
    createdAt Number
    destinationId String
    destinationType String
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing DestinationTypesense Resource

    Get an existing DestinationTypesense 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?: DestinationTypesenseState, opts?: CustomResourceOptions): DestinationTypesense
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[DestinationTypesenseConfigurationArgs] = 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,
        workspace_id: Optional[str] = None) -> DestinationTypesense
    func GetDestinationTypesense(ctx *Context, name string, id IDInput, state *DestinationTypesenseState, opts ...ResourceOption) (*DestinationTypesense, error)
    public static DestinationTypesense Get(string name, Input<string> id, DestinationTypesenseState? state, CustomResourceOptions? opts = null)
    public static DestinationTypesense get(String name, Output<String> id, DestinationTypesenseState state, CustomResourceOptions options)
    resources:  _:    type: airbyte:DestinationTypesense    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 DestinationTypesenseConfiguration
    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.
    WorkspaceId string
    Configuration DestinationTypesenseConfigurationArgs
    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.
    WorkspaceId string
    configuration DestinationTypesenseConfiguration
    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.
    workspaceId String
    configuration DestinationTypesenseConfiguration
    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.
    workspaceId string
    configuration DestinationTypesenseConfigurationArgs
    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.
    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.
    workspaceId String

    Supporting Types

    DestinationTypesenseConfiguration, DestinationTypesenseConfigurationArgs

    ApiKey string
    Typesense API Key
    Host string
    Hostname of the Typesense instance without protocol. Accept multiple hosts separated by comma.
    BatchSize double
    How many documents should be imported together. Default 1000
    Path string
    Path of the Typesense instance. Default is none
    Port string
    Port of the Typesense instance. Ex: 8108, 80, 443. Default is 8108
    Protocol string
    Protocol of the Typesense instance. Ex: http or https. Default is https
    ApiKey string
    Typesense API Key
    Host string
    Hostname of the Typesense instance without protocol. Accept multiple hosts separated by comma.
    BatchSize float64
    How many documents should be imported together. Default 1000
    Path string
    Path of the Typesense instance. Default is none
    Port string
    Port of the Typesense instance. Ex: 8108, 80, 443. Default is 8108
    Protocol string
    Protocol of the Typesense instance. Ex: http or https. Default is https
    apiKey String
    Typesense API Key
    host String
    Hostname of the Typesense instance without protocol. Accept multiple hosts separated by comma.
    batchSize Double
    How many documents should be imported together. Default 1000
    path String
    Path of the Typesense instance. Default is none
    port String
    Port of the Typesense instance. Ex: 8108, 80, 443. Default is 8108
    protocol String
    Protocol of the Typesense instance. Ex: http or https. Default is https
    apiKey string
    Typesense API Key
    host string
    Hostname of the Typesense instance without protocol. Accept multiple hosts separated by comma.
    batchSize number
    How many documents should be imported together. Default 1000
    path string
    Path of the Typesense instance. Default is none
    port string
    Port of the Typesense instance. Ex: 8108, 80, 443. Default is 8108
    protocol string
    Protocol of the Typesense instance. Ex: http or https. Default is https
    api_key str
    Typesense API Key
    host str
    Hostname of the Typesense instance without protocol. Accept multiple hosts separated by comma.
    batch_size float
    How many documents should be imported together. Default 1000
    path str
    Path of the Typesense instance. Default is none
    port str
    Port of the Typesense instance. Ex: 8108, 80, 443. Default is 8108
    protocol str
    Protocol of the Typesense instance. Ex: http or https. Default is https
    apiKey String
    Typesense API Key
    host String
    Hostname of the Typesense instance without protocol. Accept multiple hosts separated by comma.
    batchSize Number
    How many documents should be imported together. Default 1000
    path String
    Path of the Typesense instance. Default is none
    port String
    Port of the Typesense instance. Ex: 8108, 80, 443. Default is 8108
    protocol String
    Protocol of the Typesense instance. Ex: http or https. Default is https

    Import

    $ pulumi import airbyte:index/destinationTypesense:DestinationTypesense my_airbyte_destination_typesense ""

    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 logo
    airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq
    airbytehq/terraform-provider-airbyte