airbyte 0.7.0-beta2, Mar 7 25

airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

airbyte.SourceAlgolia

Explore with Pulumi AI

airbyte 0.7.0-beta2 published on Friday, Mar 7, 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.SourceAlgolia;
import com.pulumi.airbyte.SourceAlgoliaArgs;
import com.pulumi.airbyte.inputs.SourceAlgoliaConfigurationArgs;
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 mySourceAlgolia = new SourceAlgolia("mySourceAlgolia", SourceAlgoliaArgs.builder()
            .configuration(SourceAlgoliaConfigurationArgs.builder()
                .api_key("...my_api_key...")
                .application_id("...my_application_id...")
                .object_id("...my_object_id...")
                .search_query("...my_search_query...")
                .start_date("2022-01-27T04:29:58.326Z")
                .build())
            .definitionId("00a54114-c5be-4aed-90d6-a8221ddabb9f")
            .secretId("...my_secret_id...")
            .workspaceId("af54511a-0ce6-446e-a98c-15d2a04095d8")
            .build());

    }
}

resources:
  mySourceAlgolia:
    type: airbyte:SourceAlgolia
    properties:
      configuration:
        api_key: '...my_api_key...'
        application_id: '...my_application_id...'
        object_id: '...my_object_id...'
        search_query: '...my_search_query...'
        start_date: 2022-01-27T04:29:58.326Z
      definitionId: 00a54114-c5be-4aed-90d6-a8221ddabb9f
      secretId: '...my_secret_id...'
      workspaceId: af54511a-0ce6-446e-a98c-15d2a04095d8

Create SourceAlgolia Resource

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

Constructor syntax

new SourceAlgolia(name: string, args: SourceAlgoliaArgs, opts?: CustomResourceOptions);

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

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

func NewSourceAlgolia(ctx *Context, name string, args SourceAlgoliaArgs, opts ...ResourceOption) (*SourceAlgolia, error)

public SourceAlgolia(string name, SourceAlgoliaArgs args, CustomResourceOptions? opts = null)

public SourceAlgolia(String name, SourceAlgoliaArgs args)
public SourceAlgolia(String name, SourceAlgoliaArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args SourceAlgoliaArgs: 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 sourceAlgoliaResource = new Airbyte.SourceAlgolia("sourceAlgoliaResource", new()
{
    Configuration = new Airbyte.Inputs.SourceAlgoliaConfigurationArgs
    {
        ApiKey = "string",
        ApplicationId = "string",
        StartDate = "string",
        ObjectId = "string",
        SearchQuery = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

example, err := airbyte.NewSourceAlgolia(ctx, "sourceAlgoliaResource", &airbyte.SourceAlgoliaArgs{
Configuration: &.SourceAlgoliaConfigurationArgs{
ApiKey: pulumi.String("string"),
ApplicationId: pulumi.String("string"),
StartDate: pulumi.String("string"),
ObjectId: pulumi.String("string"),
SearchQuery: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

var sourceAlgoliaResource = new SourceAlgolia("sourceAlgoliaResource", SourceAlgoliaArgs.builder()
    .configuration(SourceAlgoliaConfigurationArgs.builder()
        .apiKey("string")
        .applicationId("string")
        .startDate("string")
        .objectId("string")
        .searchQuery("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

source_algolia_resource = airbyte.SourceAlgolia("sourceAlgoliaResource",
    configuration={
        "api_key": "string",
        "application_id": "string",
        "start_date": "string",
        "object_id": "string",
        "search_query": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

const sourceAlgoliaResource = new airbyte.SourceAlgolia("sourceAlgoliaResource", {
    configuration: {
        apiKey: "string",
        applicationId: "string",
        startDate: "string",
        objectId: "string",
        searchQuery: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

type: airbyte:SourceAlgolia
properties:
    configuration:
        apiKey: string
        applicationId: string
        objectId: string
        searchQuery: string
        startDate: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

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

Configuration SourceAlgoliaConfiguration
WorkspaceId string
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Configuration SourceAlgoliaConfigurationArgs
WorkspaceId string
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration SourceAlgoliaConfiguration
workspaceId String
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration SourceAlgoliaConfiguration
workspaceId string
definitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name string: Name of the source e.g. dev-mysql-instance.
secretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration SourceAlgoliaConfigurationArgs
workspace_id str
definition_id str: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name str: Name of the source e.g. dev-mysql-instance.
secret_id str: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration Property Map
workspaceId String
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Outputs

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

CreatedAt double
Id string: The provider-assigned unique ID for this managed resource.
SourceId string
SourceType string

CreatedAt float64
Id string: The provider-assigned unique ID for this managed resource.
SourceId string
SourceType string

createdAt Double
id String: The provider-assigned unique ID for this managed resource.
sourceId String
sourceType String

createdAt number
id string: The provider-assigned unique ID for this managed resource.
sourceId string
sourceType string

created_at float
id str: The provider-assigned unique ID for this managed resource.
source_id str
source_type str

createdAt Number
id String: The provider-assigned unique ID for this managed resource.
sourceId String
sourceType String

Look up Existing SourceAlgolia Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceAlgoliaConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourceAlgolia

func GetSourceAlgolia(ctx *Context, name string, id IDInput, state *SourceAlgoliaState, opts ...ResourceOption) (*SourceAlgolia, error)

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

public static SourceAlgolia get(String name, Output<String> id, SourceAlgoliaState state, CustomResourceOptions options)

resources:  _:    type: airbyte:SourceAlgolia    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 SourceAlgoliaConfiguration
CreatedAt double
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string

Configuration SourceAlgoliaConfigurationArgs
CreatedAt float64
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string

configuration SourceAlgoliaConfiguration
createdAt Double
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

configuration SourceAlgoliaConfiguration
createdAt number
definitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name string: Name of the source e.g. dev-mysql-instance.
secretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId string
sourceType string
workspaceId string

configuration SourceAlgoliaConfigurationArgs
created_at float
definition_id str: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name str: Name of the source e.g. dev-mysql-instance.
secret_id str: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
source_id str
source_type str
workspace_id str

configuration Property Map
createdAt Number
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

Supporting Types

SourceAlgoliaConfiguration, SourceAlgoliaConfigurationArgs

ApiKey string
ApplicationId string: The application ID for your application found in settings
StartDate string
ObjectId string: Object ID within index for search queries. Default: "ecommerce-sample-data-9999996"
SearchQuery string: Search query to be used with indexes_query stream with format defined in https://www.algolia.com/doc/rest-api/search/#tag/Search/operation/searchSingleIndex. Default: "hitsPerPage=2&getRankingInfo=1"

ApiKey string
ApplicationId string: The application ID for your application found in settings
StartDate string
ObjectId string: Object ID within index for search queries. Default: "ecommerce-sample-data-9999996"
SearchQuery string: Search query to be used with indexes_query stream with format defined in https://www.algolia.com/doc/rest-api/search/#tag/Search/operation/searchSingleIndex. Default: "hitsPerPage=2&getRankingInfo=1"

apiKey String
applicationId String: The application ID for your application found in settings
startDate String
objectId String: Object ID within index for search queries. Default: "ecommerce-sample-data-9999996"
searchQuery String: Search query to be used with indexes_query stream with format defined in https://www.algolia.com/doc/rest-api/search/#tag/Search/operation/searchSingleIndex. Default: "hitsPerPage=2&getRankingInfo=1"

apiKey string
applicationId string: The application ID for your application found in settings
startDate string
objectId string: Object ID within index for search queries. Default: "ecommerce-sample-data-9999996"
searchQuery string: Search query to be used with indexes_query stream with format defined in https://www.algolia.com/doc/rest-api/search/#tag/Search/operation/searchSingleIndex. Default: "hitsPerPage=2&getRankingInfo=1"

api_key str
application_id str: The application ID for your application found in settings
start_date str
object_id str: Object ID within index for search queries. Default: "ecommerce-sample-data-9999996"
search_query str: Search query to be used with indexes_query stream with format defined in https://www.algolia.com/doc/rest-api/search/#tag/Search/operation/searchSingleIndex. Default: "hitsPerPage=2&getRankingInfo=1"

apiKey String
applicationId String: The application ID for your application found in settings
startDate String
objectId String: Object ID within index for search queries. Default: "ecommerce-sample-data-9999996"
searchQuery String: Search query to be used with indexes_query stream with format defined in https://www.algolia.com/doc/rest-api/search/#tag/Search/operation/searchSingleIndex. Default: "hitsPerPage=2&getRankingInfo=1"

Import

$ pulumi import airbyte:index/sourceAlgolia:SourceAlgolia my_airbyte_source_algolia ""

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.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

airbytehq/terraform-provider-airbyte

airbyte.SourceAlgolia

On this page

On this page

Example Usage

Create SourceAlgolia Resource

Constructor syntax

Parameters

Constructor example

SourceAlgolia Resource Properties

Inputs

Outputs

Look up Existing SourceAlgolia Resource

Supporting Types

SourceAlgoliaConfiguration, SourceAlgoliaConfigurationArgs

Import

Package Details

On this page

On this page