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

airbyte.SourceApifyDataset

Explore with Pulumi AI

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

    SourceApifyDataset 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.SourceApifyDataset;
import com.pulumi.airbyte.SourceApifyDatasetArgs;
import com.pulumi.airbyte.inputs.SourceApifyDatasetConfigurationArgs;
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 mySourceApifydataset = new SourceApifyDataset("mySourceApifydataset", SourceApifyDatasetArgs.builder()
            .configuration(SourceApifyDatasetConfigurationArgs.builder()
                .dataset_id("rHuMdwm6xCFt6WiGU")
                .token("apify_api_PbVwb1cBbuvbfg2jRmAIHZKgx3NQyfEMG7uk")
                .build())
            .definitionId("49497209-8cea-4532-b165-394417019982")
            .secretId("...my_secret_id...")
            .workspaceId("d350e995-36c3-4597-9bda-37f40d6e49ad")
            .build());

    }
}

    resources:
  mySourceApifydataset:
    type: airbyte:SourceApifyDataset
    properties:
      configuration:
        dataset_id: rHuMdwm6xCFt6WiGU
        token: apify_api_PbVwb1cBbuvbfg2jRmAIHZKgx3NQyfEMG7uk
      definitionId: 49497209-8cea-4532-b165-394417019982
      secretId: '...my_secret_id...'
      workspaceId: d350e995-36c3-4597-9bda-37f40d6e49ad

    Create SourceApifyDataset Resource

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

    Constructor syntax

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

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

    type: airbyte:SourceApifyDataset
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 SourceApifyDatasetArgs
    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 SourceApifyDatasetArgs
    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 SourceApifyDatasetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SourceApifyDatasetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SourceApifyDatasetArgs
    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 sourceApifyDatasetResource = new Airbyte.SourceApifyDataset("sourceApifyDatasetResource", new()
{
    Configuration = new Airbyte.Inputs.SourceApifyDatasetConfigurationArgs
    {
        DatasetId = "string",
        Token = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

    example, err := airbyte.NewSourceApifyDataset(ctx, "sourceApifyDatasetResource", &airbyte.SourceApifyDatasetArgs{
Configuration: &.SourceApifyDatasetConfigurationArgs{
DatasetId: pulumi.String("string"),
Token: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

    var sourceApifyDatasetResource = new SourceApifyDataset("sourceApifyDatasetResource", SourceApifyDatasetArgs.builder()
    .configuration(SourceApifyDatasetConfigurationArgs.builder()
        .datasetId("string")
        .token("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

    source_apify_dataset_resource = airbyte.SourceApifyDataset("sourceApifyDatasetResource",
    configuration={
        "dataset_id": "string",
        "token": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

    const sourceApifyDatasetResource = new airbyte.SourceApifyDataset("sourceApifyDatasetResource", {
    configuration: {
        datasetId: "string",
        token: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

    type: airbyte:SourceApifyDataset
properties:
    configuration:
        datasetId: string
        token: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

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

    Configuration SourceApifyDatasetConfiguration
    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 SourceApifyDatasetConfigurationArgs
    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 SourceApifyDatasetConfiguration
    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 SourceApifyDatasetConfiguration
    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 SourceApifyDatasetConfigurationArgs
    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 SourceApifyDataset 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 SourceApifyDataset Resource

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

    SourceApifyDatasetConfiguration, SourceApifyDatasetConfigurationArgs

    DatasetId string
    ID of the dataset you would like to load to Airbyte. In Apify Console, you can view your datasets in the \n\nStorage section under the Datasets tab\n\n after you login. See the \n\nApify Docs\n\n for more information.
    Token string
    Personal API token of your Apify account. In Apify Console, you can find your API token in the \n\nSettings section under the Integrations tab\n\n after you login. See the \n\nApify Docs\n\n for more information.
    DatasetId string
    ID of the dataset you would like to load to Airbyte. In Apify Console, you can view your datasets in the \n\nStorage section under the Datasets tab\n\n after you login. See the \n\nApify Docs\n\n for more information.
    Token string
    Personal API token of your Apify account. In Apify Console, you can find your API token in the \n\nSettings section under the Integrations tab\n\n after you login. See the \n\nApify Docs\n\n for more information.
    datasetId String
    ID of the dataset you would like to load to Airbyte. In Apify Console, you can view your datasets in the \n\nStorage section under the Datasets tab\n\n after you login. See the \n\nApify Docs\n\n for more information.
    token String
    Personal API token of your Apify account. In Apify Console, you can find your API token in the \n\nSettings section under the Integrations tab\n\n after you login. See the \n\nApify Docs\n\n for more information.
    datasetId string
    ID of the dataset you would like to load to Airbyte. In Apify Console, you can view your datasets in the \n\nStorage section under the Datasets tab\n\n after you login. See the \n\nApify Docs\n\n for more information.
    token string
    Personal API token of your Apify account. In Apify Console, you can find your API token in the \n\nSettings section under the Integrations tab\n\n after you login. See the \n\nApify Docs\n\n for more information.
    dataset_id str
    ID of the dataset you would like to load to Airbyte. In Apify Console, you can view your datasets in the \n\nStorage section under the Datasets tab\n\n after you login. See the \n\nApify Docs\n\n for more information.
    token str
    Personal API token of your Apify account. In Apify Console, you can find your API token in the \n\nSettings section under the Integrations tab\n\n after you login. See the \n\nApify Docs\n\n for more information.
    datasetId String
    ID of the dataset you would like to load to Airbyte. In Apify Console, you can view your datasets in the \n\nStorage section under the Datasets tab\n\n after you login. See the \n\nApify Docs\n\n for more information.
    token String
    Personal API token of your Apify account. In Apify Console, you can find your API token in the \n\nSettings section under the Integrations tab\n\n after you login. See the \n\nApify Docs\n\n for more information.

    Import

    $ pulumi import airbyte:index/sourceApifyDataset:SourceApifyDataset my_airbyte_source_apify_dataset ""

    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