airbyte 0.10.0, Apr 14 25

airbyte 0.10.0 published on Monday, Apr 14, 2025 by airbytehq

airbyte.SourceDatascope

Explore with Pulumi AI

airbyte 0.10.0 published on Monday, Apr 14, 2025 by airbytehq

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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.SourceDatascope;
import com.pulumi.airbyte.SourceDatascopeArgs;
import com.pulumi.airbyte.inputs.SourceDatascopeConfigurationArgs;
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 mySourceDatascope = new SourceDatascope("mySourceDatascope", SourceDatascopeArgs.builder()
            .configuration(SourceDatascopeConfigurationArgs.builder()
                .api_key("...my_api_key...")
                .start_date("dd/mm/YYYY HH:MM")
                .build())
            .definitionId("200f9c0e-d455-4199-96c3-9b473f66c92f")
            .secretId("...my_secret_id...")
            .workspaceId("2292273e-92fb-4a2a-9d00-148222335f72")
            .build());

    }
}

resources:
  mySourceDatascope:
    type: airbyte:SourceDatascope
    properties:
      configuration:
        api_key: '...my_api_key...'
        start_date: dd/mm/YYYY HH:MM
      definitionId: 200f9c0e-d455-4199-96c3-9b473f66c92f
      secretId: '...my_secret_id...'
      workspaceId: 2292273e-92fb-4a2a-9d00-148222335f72

Create SourceDatascope Resource

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

new SourceDatascope(name: string, args: SourceDatascopeArgs, opts?: CustomResourceOptions);

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

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

func NewSourceDatascope(ctx *Context, name string, args SourceDatascopeArgs, opts ...ResourceOption) (*SourceDatascope, error)

public SourceDatascope(string name, SourceDatascopeArgs args, CustomResourceOptions? opts = null)

public SourceDatascope(String name, SourceDatascopeArgs args)
public SourceDatascope(String name, SourceDatascopeArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args SourceDatascopeArgs: 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.

TypeScript
Python
Go
C#
Java
YAML

var sourceDatascopeResource = new Airbyte.SourceDatascope("sourceDatascopeResource", new()
{
    Configuration = new Airbyte.Inputs.SourceDatascopeConfigurationArgs
    {
        ApiKey = "string",
        StartDate = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

example, err := airbyte.NewSourceDatascope(ctx, "sourceDatascopeResource", &airbyte.SourceDatascopeArgs{
Configuration: &.SourceDatascopeConfigurationArgs{
ApiKey: pulumi.String("string"),
StartDate: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

var sourceDatascopeResource = new SourceDatascope("sourceDatascopeResource", SourceDatascopeArgs.builder()
    .configuration(SourceDatascopeConfigurationArgs.builder()
        .apiKey("string")
        .startDate("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

source_datascope_resource = airbyte.SourceDatascope("sourceDatascopeResource",
    configuration={
        "api_key": "string",
        "start_date": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

const sourceDatascopeResource = new airbyte.SourceDatascope("sourceDatascopeResource", {
    configuration: {
        apiKey: "string",
        startDate: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

type: airbyte:SourceDatascope
properties:
    configuration:
        apiKey: string
        startDate: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

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

Configuration SourceDatascopeConfiguration
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 SourceDatascopeConfigurationArgs
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 SourceDatascopeConfiguration
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 SourceDatascopeConfiguration
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 SourceDatascopeConfigurationArgs
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 SourceDatascope resource produces the following output properties:

CreatedAt double
Id string: The provider-assigned unique ID for this managed resource.
ResourceAllocation SourceDatascopeResourceAllocation: 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.
SourceId string
SourceType string

CreatedAt float64
Id string: The provider-assigned unique ID for this managed resource.
ResourceAllocation SourceDatascopeResourceAllocation: 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.
SourceId string
SourceType string

createdAt Double
id String: The provider-assigned unique ID for this managed resource.
resourceAllocation SourceDatascopeResourceAllocation: 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.
sourceId String
sourceType String

createdAt number
id string: The provider-assigned unique ID for this managed resource.
resourceAllocation SourceDatascopeResourceAllocation: 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.
sourceId string
sourceType string

created_at float
id str: The provider-assigned unique ID for this managed resource.
resource_allocation SourceDatascopeResourceAllocation: 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.
source_id str
source_type str

createdAt Number
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.
sourceId String
sourceType String

Look up Existing SourceDatascope Resource

Get an existing SourceDatascope resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

TypeScript
Python
Go
C#
Java
YAML

public static get(name: string, id: Input<ID>, state?: SourceDatascopeState, opts?: CustomResourceOptions): SourceDatascope

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

func GetSourceDatascope(ctx *Context, name string, id IDInput, state *SourceDatascopeState, opts ...ResourceOption) (*SourceDatascope, error)

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

public static SourceDatascope get(String name, Output<String> id, SourceDatascopeState state, CustomResourceOptions options)

resources:  _:    type: airbyte:SourceDatascope    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 SourceDatascopeConfiguration
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.
ResourceAllocation SourceDatascopeResourceAllocation: 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.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string

Configuration SourceDatascopeConfigurationArgs
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.
ResourceAllocation SourceDatascopeResourceAllocationArgs: 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.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string

configuration SourceDatascopeConfiguration
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.
resourceAllocation SourceDatascopeResourceAllocation: 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.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

configuration SourceDatascopeConfiguration
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.
resourceAllocation SourceDatascopeResourceAllocation: 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.
secretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId string
sourceType string
workspaceId string

configuration SourceDatascopeConfigurationArgs
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.
resource_allocation SourceDatascopeResourceAllocationArgs: 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.
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.
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.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

Supporting Types

SourceDatascopeConfiguration
, SourceDatascopeConfigurationArgs

ApiKey string: API Key
StartDate string: Start date for the data to be replicated

ApiKey string: API Key
StartDate string: Start date for the data to be replicated

apiKey String: API Key
startDate String: Start date for the data to be replicated

apiKey string: API Key
startDate string: Start date for the data to be replicated

api_key str: API Key
start_date str: Start date for the data to be replicated

apiKey String: API Key
startDate String: Start date for the data to be replicated

SourceDatascopeResourceAllocation
, SourceDatascopeResourceAllocationArgs

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

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

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

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

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

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

SourceDatascopeResourceAllocationDefault
, SourceDatascopeResourceAllocationDefaultArgs

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

SourceDatascopeResourceAllocationJobSpecific
, SourceDatascopeResourceAllocationJobSpecificArgs

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

SourceDatascopeResourceAllocationJobSpecificResourceRequirements
, SourceDatascopeResourceAllocationJobSpecificResourceRequirementsArgs

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/sourceDatascope:SourceDatascope my_airbyte_source_datascope ""

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.10.0 published on Monday, Apr 14, 2025 by airbytehq

airbytehq/terraform-provider-airbyte

airbyte.SourceDatascope

On this page

On this page

Example Usage

Create SourceDatascope Resource

Constructor syntax

Parameters

Constructor example

SourceDatascope Resource Properties

Inputs

Outputs

Look up Existing SourceDatascope Resource

Supporting Types

SourceDatascopeConfiguration
, SourceDatascopeConfigurationArgs

SourceDatascopeResourceAllocation
, SourceDatascopeResourceAllocationArgs

SourceDatascopeResourceAllocationDefault
, SourceDatascopeResourceAllocationDefaultArgs

SourceDatascopeResourceAllocationJobSpecific
, SourceDatascopeResourceAllocationJobSpecificArgs

SourceDatascopeResourceAllocationJobSpecificResourceRequirements
, SourceDatascopeResourceAllocationJobSpecificResourceRequirementsArgs

Import

Package Details

On this page

On this page

airbyte.SourceDatascope

On this page

On this page

Example Usage

Create SourceDatascope Resource

Constructor syntax

Parameters

Constructor example

SourceDatascope Resource Properties

Inputs

Outputs

Look up Existing SourceDatascope Resource

Supporting Types

SourceDatascopeConfiguration, SourceDatascopeConfigurationArgs

SourceDatascopeResourceAllocation, SourceDatascopeResourceAllocationArgs

SourceDatascopeResourceAllocationDefault, SourceDatascopeResourceAllocationDefaultArgs

SourceDatascopeResourceAllocationJobSpecific, SourceDatascopeResourceAllocationJobSpecificArgs

SourceDatascopeResourceAllocationJobSpecificResourceRequirements, SourceDatascopeResourceAllocationJobSpecificResourceRequirementsArgs

Import

Package Details

On this page

On this page

SourceDatascopeConfiguration
, SourceDatascopeConfigurationArgs

SourceDatascopeResourceAllocation
, SourceDatascopeResourceAllocationArgs

SourceDatascopeResourceAllocationDefault
, SourceDatascopeResourceAllocationDefaultArgs

SourceDatascopeResourceAllocationJobSpecific
, SourceDatascopeResourceAllocationJobSpecificArgs

SourceDatascopeResourceAllocationJobSpecificResourceRequirements
, SourceDatascopeResourceAllocationJobSpecificResourceRequirementsArgs