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

airbyte.SourceHarvest

Explore with Pulumi AI

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

    SourceHarvest 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.SourceHarvest;
import com.pulumi.airbyte.SourceHarvestArgs;
import com.pulumi.airbyte.inputs.SourceHarvestConfigurationArgs;
import com.pulumi.airbyte.inputs.SourceHarvestConfigurationCredentialsArgs;
import com.pulumi.airbyte.inputs.SourceHarvestConfigurationCredentialsAuthenticateViaHarvestOAuthArgs;
import com.pulumi.airbyte.inputs.SourceHarvestConfigurationCredentialsAuthenticateWithPersonalAccessTokenArgs;
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 mySourceHarvest = new SourceHarvest("mySourceHarvest", SourceHarvestArgs.builder()
            .configuration(SourceHarvestConfigurationArgs.builder()
                .account_id("...my_account_id...")
                .credentials(SourceHarvestConfigurationCredentialsArgs.builder()
                    .authenticateViaHarvestOAuth(SourceHarvestConfigurationCredentialsAuthenticateViaHarvestOAuthArgs.builder()
                        .additionalProperties("{ \"see\": \"documentation\" }")
                        .clientId("...my_client_id...")
                        .clientSecret("...my_client_secret...")
                        .refreshToken("...my_refresh_token...")
                        .build())
                    .authenticateWithPersonalAccessToken(SourceHarvestConfigurationCredentialsAuthenticateWithPersonalAccessTokenArgs.builder()
                        .additionalProperties("{ \"see\": \"documentation\" }")
                        .apiToken("...my_api_token...")
                        .build())
                    .build())
                .replication_start_date("2017-01-25T00:00:00Z")
                .build())
            .definitionId("ce100c29-1a0e-4458-807d-89392892e3da")
            .secretId("...my_secret_id...")
            .workspaceId("7a62499e-b740-4a2d-a2c0-621f38c60e24")
            .build());

    }
}

    resources:
  mySourceHarvest:
    type: airbyte:SourceHarvest
    properties:
      configuration:
        account_id: '...my_account_id...'
        credentials:
          authenticateViaHarvestOAuth:
            additionalProperties: '{ "see": "documentation" }'
            clientId: '...my_client_id...'
            clientSecret: '...my_client_secret...'
            refreshToken: '...my_refresh_token...'
          authenticateWithPersonalAccessToken:
            additionalProperties: '{ "see": "documentation" }'
            apiToken: '...my_api_token...'
        replication_start_date: 2017-01-25T00:00:00Z
      definitionId: ce100c29-1a0e-4458-807d-89392892e3da
      secretId: '...my_secret_id...'
      workspaceId: 7a62499e-b740-4a2d-a2c0-621f38c60e24

    Create SourceHarvest Resource

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

    Constructor syntax

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

@overload
def SourceHarvest(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  configuration: Optional[SourceHarvestConfigurationArgs] = None,
                  workspace_id: Optional[str] = None,
                  definition_id: Optional[str] = None,
                  name: Optional[str] = None,
                  secret_id: Optional[str] = None)
    func NewSourceHarvest(ctx *Context, name string, args SourceHarvestArgs, opts ...ResourceOption) (*SourceHarvest, error)
    public SourceHarvest(string name, SourceHarvestArgs args, CustomResourceOptions? opts = null)
    public SourceHarvest(String name, SourceHarvestArgs args)
public SourceHarvest(String name, SourceHarvestArgs args, CustomResourceOptions options)

    type: airbyte:SourceHarvest
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 SourceHarvestArgs
    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 SourceHarvestArgs
    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 SourceHarvestArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SourceHarvestArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SourceHarvestArgs
    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 sourceHarvestResource = new Airbyte.SourceHarvest("sourceHarvestResource", new()
{
    Configuration = new Airbyte.Inputs.SourceHarvestConfigurationArgs
    {
        AccountId = "string",
        ReplicationStartDate = "string",
        Credentials = new Airbyte.Inputs.SourceHarvestConfigurationCredentialsArgs
        {
            AuthenticateViaHarvestOAuth = new Airbyte.Inputs.SourceHarvestConfigurationCredentialsAuthenticateViaHarvestOAuthArgs
            {
                ClientId = "string",
                ClientSecret = "string",
                RefreshToken = "string",
                AdditionalProperties = "string",
            },
            AuthenticateWithPersonalAccessToken = new Airbyte.Inputs.SourceHarvestConfigurationCredentialsAuthenticateWithPersonalAccessTokenArgs
            {
                ApiToken = "string",
                AdditionalProperties = "string",
            },
        },
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

    example, err := airbyte.NewSourceHarvest(ctx, "sourceHarvestResource", &airbyte.SourceHarvestArgs{
Configuration: &.SourceHarvestConfigurationArgs{
AccountId: pulumi.String("string"),
ReplicationStartDate: pulumi.String("string"),
Credentials: &.SourceHarvestConfigurationCredentialsArgs{
AuthenticateViaHarvestOAuth: &.SourceHarvestConfigurationCredentialsAuthenticateViaHarvestOAuthArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
RefreshToken: pulumi.String("string"),
AdditionalProperties: pulumi.String("string"),
},
AuthenticateWithPersonalAccessToken: &.SourceHarvestConfigurationCredentialsAuthenticateWithPersonalAccessTokenArgs{
ApiToken: pulumi.String("string"),
AdditionalProperties: pulumi.String("string"),
},
},
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

    var sourceHarvestResource = new SourceHarvest("sourceHarvestResource", SourceHarvestArgs.builder()
    .configuration(SourceHarvestConfigurationArgs.builder()
        .accountId("string")
        .replicationStartDate("string")
        .credentials(SourceHarvestConfigurationCredentialsArgs.builder()
            .authenticateViaHarvestOAuth(SourceHarvestConfigurationCredentialsAuthenticateViaHarvestOAuthArgs.builder()
                .clientId("string")
                .clientSecret("string")
                .refreshToken("string")
                .additionalProperties("string")
                .build())
            .authenticateWithPersonalAccessToken(SourceHarvestConfigurationCredentialsAuthenticateWithPersonalAccessTokenArgs.builder()
                .apiToken("string")
                .additionalProperties("string")
                .build())
            .build())
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

    source_harvest_resource = airbyte.SourceHarvest("sourceHarvestResource",
    configuration={
        "account_id": "string",
        "replication_start_date": "string",
        "credentials": {
            "authenticate_via_harvest_o_auth": {
                "client_id": "string",
                "client_secret": "string",
                "refresh_token": "string",
                "additional_properties": "string",
            },
            "authenticate_with_personal_access_token": {
                "api_token": "string",
                "additional_properties": "string",
            },
        },
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

    const sourceHarvestResource = new airbyte.SourceHarvest("sourceHarvestResource", {
    configuration: {
        accountId: "string",
        replicationStartDate: "string",
        credentials: {
            authenticateViaHarvestOAuth: {
                clientId: "string",
                clientSecret: "string",
                refreshToken: "string",
                additionalProperties: "string",
            },
            authenticateWithPersonalAccessToken: {
                apiToken: "string",
                additionalProperties: "string",
            },
        },
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

    type: airbyte:SourceHarvest
properties:
    configuration:
        accountId: string
        credentials:
            authenticateViaHarvestOAuth:
                additionalProperties: string
                clientId: string
                clientSecret: string
                refreshToken: string
            authenticateWithPersonalAccessToken:
                additionalProperties: string
                apiToken: string
        replicationStartDate: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

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

    Configuration SourceHarvestConfiguration
    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 SourceHarvestConfigurationArgs
    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 SourceHarvestConfiguration
    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 SourceHarvestConfiguration
    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 SourceHarvestConfigurationArgs
    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 SourceHarvest 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 SourceHarvest Resource

    Get an existing SourceHarvest 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?: SourceHarvestState, opts?: CustomResourceOptions): SourceHarvest
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceHarvestConfigurationArgs] = 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) -> SourceHarvest
    func GetSourceHarvest(ctx *Context, name string, id IDInput, state *SourceHarvestState, opts ...ResourceOption) (*SourceHarvest, error)
    public static SourceHarvest Get(string name, Input<string> id, SourceHarvestState? state, CustomResourceOptions? opts = null)
    public static SourceHarvest get(String name, Output<String> id, SourceHarvestState state, CustomResourceOptions options)
    resources:  _:    type: airbyte:SourceHarvest    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 SourceHarvestConfiguration
    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 SourceHarvestConfigurationArgs
    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 SourceHarvestConfiguration
    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 SourceHarvestConfiguration
    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 SourceHarvestConfigurationArgs
    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

    SourceHarvestConfiguration, SourceHarvestConfigurationArgs

    AccountId string
    Harvest account ID. Required for all Harvest requests in pair with Personal Access Token
    ReplicationStartDate string
    UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated.
    Credentials SourceHarvestConfigurationCredentials
    Choose how to authenticate to Harvest.
    AccountId string
    Harvest account ID. Required for all Harvest requests in pair with Personal Access Token
    ReplicationStartDate string
    UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated.
    Credentials SourceHarvestConfigurationCredentials
    Choose how to authenticate to Harvest.
    accountId String
    Harvest account ID. Required for all Harvest requests in pair with Personal Access Token
    replicationStartDate String
    UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated.
    credentials SourceHarvestConfigurationCredentials
    Choose how to authenticate to Harvest.
    accountId string
    Harvest account ID. Required for all Harvest requests in pair with Personal Access Token
    replicationStartDate string
    UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated.
    credentials SourceHarvestConfigurationCredentials
    Choose how to authenticate to Harvest.
    account_id str
    Harvest account ID. Required for all Harvest requests in pair with Personal Access Token
    replication_start_date str
    UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated.
    credentials SourceHarvestConfigurationCredentials
    Choose how to authenticate to Harvest.
    accountId String
    Harvest account ID. Required for all Harvest requests in pair with Personal Access Token
    replicationStartDate String
    UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated.
    credentials Property Map
    Choose how to authenticate to Harvest.

    SourceHarvestConfigurationCredentials, SourceHarvestConfigurationCredentialsArgs

    SourceHarvestConfigurationCredentialsAuthenticateViaHarvestOAuth, SourceHarvestConfigurationCredentialsAuthenticateViaHarvestOAuthArgs

    ClientId string
    The Client ID of your Harvest developer application.
    ClientSecret string
    The Client Secret of your Harvest developer application.
    RefreshToken string
    Refresh Token to renew the expired Access Token.
    AdditionalProperties string
    Parsed as JSON.
    ClientId string
    The Client ID of your Harvest developer application.
    ClientSecret string
    The Client Secret of your Harvest developer application.
    RefreshToken string
    Refresh Token to renew the expired Access Token.
    AdditionalProperties string
    Parsed as JSON.
    clientId String
    The Client ID of your Harvest developer application.
    clientSecret String
    The Client Secret of your Harvest developer application.
    refreshToken String
    Refresh Token to renew the expired Access Token.
    additionalProperties String
    Parsed as JSON.
    clientId string
    The Client ID of your Harvest developer application.
    clientSecret string
    The Client Secret of your Harvest developer application.
    refreshToken string
    Refresh Token to renew the expired Access Token.
    additionalProperties string
    Parsed as JSON.
    client_id str
    The Client ID of your Harvest developer application.
    client_secret str
    The Client Secret of your Harvest developer application.
    refresh_token str
    Refresh Token to renew the expired Access Token.
    additional_properties str
    Parsed as JSON.
    clientId String
    The Client ID of your Harvest developer application.
    clientSecret String
    The Client Secret of your Harvest developer application.
    refreshToken String
    Refresh Token to renew the expired Access Token.
    additionalProperties String
    Parsed as JSON.

    SourceHarvestConfigurationCredentialsAuthenticateWithPersonalAccessToken, SourceHarvestConfigurationCredentialsAuthenticateWithPersonalAccessTokenArgs

    ApiToken string
    Log into Harvest and then create new \n\n personal access token\n\n.
    AdditionalProperties string
    Parsed as JSON.
    ApiToken string
    Log into Harvest and then create new \n\n personal access token\n\n.
    AdditionalProperties string
    Parsed as JSON.
    apiToken String
    Log into Harvest and then create new \n\n personal access token\n\n.
    additionalProperties String
    Parsed as JSON.
    apiToken string
    Log into Harvest and then create new \n\n personal access token\n\n.
    additionalProperties string
    Parsed as JSON.
    api_token str
    Log into Harvest and then create new \n\n personal access token\n\n.
    additional_properties str
    Parsed as JSON.
    apiToken String
    Log into Harvest and then create new \n\n personal access token\n\n.
    additionalProperties String
    Parsed as JSON.

    Import

    $ pulumi import airbyte:index/sourceHarvest:SourceHarvest my_airbyte_source_harvest ""

    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