1. Packages
  2. Airbyte Provider
  3. API Docs
  4. SourceToggl
airbyte 0.10.0 published on Monday, Apr 14, 2025 by airbytehq

airbyte.SourceToggl

Explore with Pulumi AI

SourceToggl 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.SourceToggl;
import com.pulumi.airbyte.SourceTogglArgs;
import com.pulumi.airbyte.inputs.SourceTogglConfigurationArgs;
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 mySourceToggl = new SourceToggl("mySourceToggl", SourceTogglArgs.builder()
            .configuration(SourceTogglConfigurationArgs.builder()
                .api_token("...my_api_token...")
                .end_date("YYYY-MM-DD")
                .organization_id(7)
                .start_date("YYYY-MM-DD")
                .workspace_id(3)
                .build())
            .definitionId("5a734240-3b38-447c-94cf-7f78c764bdbe")
            .secretId("...my_secret_id...")
            .workspaceId("6a95d581-a8d4-4c54-8218-1af6e73e44ad")
            .build());

    }
}
Copy
resources:
  mySourceToggl:
    type: airbyte:SourceToggl
    properties:
      configuration:
        api_token: '...my_api_token...'
        end_date: YYYY-MM-DD
        organization_id: 7
        start_date: YYYY-MM-DD
        workspace_id: 3
      definitionId: 5a734240-3b38-447c-94cf-7f78c764bdbe
      secretId: '...my_secret_id...'
      workspaceId: 6a95d581-a8d4-4c54-8218-1af6e73e44ad
Copy

Create SourceToggl Resource

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

Constructor syntax

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

@overload
def SourceToggl(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                configuration: Optional[SourceTogglConfigurationArgs] = None,
                workspace_id: Optional[str] = None,
                definition_id: Optional[str] = None,
                name: Optional[str] = None,
                secret_id: Optional[str] = None)
func NewSourceToggl(ctx *Context, name string, args SourceTogglArgs, opts ...ResourceOption) (*SourceToggl, error)
public SourceToggl(string name, SourceTogglArgs args, CustomResourceOptions? opts = null)
public SourceToggl(String name, SourceTogglArgs args)
public SourceToggl(String name, SourceTogglArgs args, CustomResourceOptions options)
type: airbyte:SourceToggl
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SourceTogglArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SourceTogglArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SourceTogglArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SourceTogglArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SourceTogglArgs
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 sourceTogglResource = new Airbyte.SourceToggl("sourceTogglResource", new()
{
    Configuration = new Airbyte.Inputs.SourceTogglConfigurationArgs
    {
        ApiToken = "string",
        EndDate = "string",
        OrganizationId = 0,
        StartDate = "string",
        WorkspaceId = 0,
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});
Copy
example, err := airbyte.NewSourceToggl(ctx, "sourceTogglResource", &airbyte.SourceTogglArgs{
Configuration: &.SourceTogglConfigurationArgs{
ApiToken: pulumi.String("string"),
EndDate: pulumi.String("string"),
OrganizationId: pulumi.Float64(0),
StartDate: pulumi.String("string"),
WorkspaceId: pulumi.Float64(0),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})
Copy
var sourceTogglResource = new SourceToggl("sourceTogglResource", SourceTogglArgs.builder()
    .configuration(SourceTogglConfigurationArgs.builder()
        .apiToken("string")
        .endDate("string")
        .organizationId(0)
        .startDate("string")
        .workspaceId(0)
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());
Copy
source_toggl_resource = airbyte.SourceToggl("sourceTogglResource",
    configuration={
        "api_token": "string",
        "end_date": "string",
        "organization_id": 0,
        "start_date": "string",
        "workspace_id": 0,
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")
Copy
const sourceTogglResource = new airbyte.SourceToggl("sourceTogglResource", {
    configuration: {
        apiToken: "string",
        endDate: "string",
        organizationId: 0,
        startDate: "string",
        workspaceId: 0,
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});
Copy
type: airbyte:SourceToggl
properties:
    configuration:
        apiToken: string
        endDate: string
        organizationId: 0
        startDate: string
        workspaceId: 0
    definitionId: string
    name: string
    secretId: string
    workspaceId: string
Copy

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

Configuration This property is required. SourceTogglConfiguration
WorkspaceId This property is required. 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 This property is required. SourceTogglConfigurationArgs
WorkspaceId This property is required. 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 This property is required. SourceTogglConfiguration
workspaceId This property is required. 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 This property is required. SourceTogglConfiguration
workspaceId This property is required. 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 This property is required. SourceTogglConfigurationArgs
workspace_id This property is required. 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 This property is required. Property Map
workspaceId This property is required. 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 SourceToggl resource produces the following output properties:

CreatedAt double
Id string
The provider-assigned unique ID for this managed resource.
ResourceAllocation SourceTogglResourceAllocation
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 SourceTogglResourceAllocation
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 SourceTogglResourceAllocation
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 SourceTogglResourceAllocation
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 SourceTogglResourceAllocation
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 SourceToggl Resource

Get an existing SourceToggl 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?: SourceTogglState, opts?: CustomResourceOptions): SourceToggl
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceTogglConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        resource_allocation: Optional[SourceTogglResourceAllocationArgs] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourceToggl
func GetSourceToggl(ctx *Context, name string, id IDInput, state *SourceTogglState, opts ...ResourceOption) (*SourceToggl, error)
public static SourceToggl Get(string name, Input<string> id, SourceTogglState? state, CustomResourceOptions? opts = null)
public static SourceToggl get(String name, Output<String> id, SourceTogglState state, CustomResourceOptions options)
resources:  _:    type: airbyte:SourceToggl    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 SourceTogglConfiguration
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 SourceTogglResourceAllocation
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 SourceTogglConfigurationArgs
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 SourceTogglResourceAllocationArgs
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 SourceTogglConfiguration
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 SourceTogglResourceAllocation
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 SourceTogglConfiguration
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 SourceTogglResourceAllocation
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 SourceTogglConfigurationArgs
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 SourceTogglResourceAllocationArgs
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

SourceTogglConfiguration
, SourceTogglConfigurationArgs

ApiToken This property is required. string
Your API Token. See \n\nhere\n\n. The token is case sensitive.
EndDate This property is required. string
To retrieve time entries created before the given date (inclusive).
OrganizationId This property is required. double
Your organization id. See \n\nhere\n\n.
StartDate This property is required. string
To retrieve time entries created after the given date (inclusive).
WorkspaceId This property is required. double
Your workspace id. See \n\nhere\n\n.
ApiToken This property is required. string
Your API Token. See \n\nhere\n\n. The token is case sensitive.
EndDate This property is required. string
To retrieve time entries created before the given date (inclusive).
OrganizationId This property is required. float64
Your organization id. See \n\nhere\n\n.
StartDate This property is required. string
To retrieve time entries created after the given date (inclusive).
WorkspaceId This property is required. float64
Your workspace id. See \n\nhere\n\n.
apiToken This property is required. String
Your API Token. See \n\nhere\n\n. The token is case sensitive.
endDate This property is required. String
To retrieve time entries created before the given date (inclusive).
organizationId This property is required. Double
Your organization id. See \n\nhere\n\n.
startDate This property is required. String
To retrieve time entries created after the given date (inclusive).
workspaceId This property is required. Double
Your workspace id. See \n\nhere\n\n.
apiToken This property is required. string
Your API Token. See \n\nhere\n\n. The token is case sensitive.
endDate This property is required. string
To retrieve time entries created before the given date (inclusive).
organizationId This property is required. number
Your organization id. See \n\nhere\n\n.
startDate This property is required. string
To retrieve time entries created after the given date (inclusive).
workspaceId This property is required. number
Your workspace id. See \n\nhere\n\n.
api_token This property is required. str
Your API Token. See \n\nhere\n\n. The token is case sensitive.
end_date This property is required. str
To retrieve time entries created before the given date (inclusive).
organization_id This property is required. float
Your organization id. See \n\nhere\n\n.
start_date This property is required. str
To retrieve time entries created after the given date (inclusive).
workspace_id This property is required. float
Your workspace id. See \n\nhere\n\n.
apiToken This property is required. String
Your API Token. See \n\nhere\n\n. The token is case sensitive.
endDate This property is required. String
To retrieve time entries created before the given date (inclusive).
organizationId This property is required. Number
Your organization id. See \n\nhere\n\n.
startDate This property is required. String
To retrieve time entries created after the given date (inclusive).
workspaceId This property is required. Number
Your workspace id. See \n\nhere\n\n.

SourceTogglResourceAllocation
, SourceTogglResourceAllocationArgs

Default SourceTogglResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
JobSpecifics List<SourceTogglResourceAllocationJobSpecific>
Default SourceTogglResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
JobSpecifics []SourceTogglResourceAllocationJobSpecific
default_ SourceTogglResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics List<SourceTogglResourceAllocationJobSpecific>
default SourceTogglResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics SourceTogglResourceAllocationJobSpecific[]
default SourceTogglResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
job_specifics Sequence[SourceTogglResourceAllocationJobSpecific]
default Property Map
optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics List<Property Map>

SourceTogglResourceAllocationDefault
, SourceTogglResourceAllocationDefaultArgs

SourceTogglResourceAllocationJobSpecific
, SourceTogglResourceAllocationJobSpecificArgs

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 SourceTogglResourceAllocationJobSpecificResourceRequirements
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 SourceTogglResourceAllocationJobSpecificResourceRequirements
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 SourceTogglResourceAllocationJobSpecificResourceRequirements
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 SourceTogglResourceAllocationJobSpecificResourceRequirements
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 SourceTogglResourceAllocationJobSpecificResourceRequirements
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)

SourceTogglResourceAllocationJobSpecificResourceRequirements
, SourceTogglResourceAllocationJobSpecificResourceRequirementsArgs

Import

$ pulumi import airbyte:index/sourceToggl:SourceToggl my_airbyte_source_toggl ""
Copy

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.