Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Airbyte Provider
  3. API Docs
  4. SourceWhenIWork
airbyte 0.8.1-beta published on Saturday, Mar 29, 2025 by airbytehq
airbytehq/terraform-provider-airbyte

airbyte.SourceWhenIWork

Explore with Pulumi AI

airbyte 0.8.1-beta published on Saturday, Mar 29, 2025 by airbytehq
airbytehq/terraform-provider-airbyte

SourceWhenIWork Resource

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as airbyte from "@pulumi/airbyte";

const mySourceWheniwork = new airbyte.SourceWhenIWork("mySourceWheniwork", {
    configuration: {
        email: "...my_email...",
        password: "...my_password...",
    },
    definitionId: "f634cd12-ec11-48cf-8c00-8e13a5f17023",
    secretId: "...my_secret_id...",
    workspaceId: "eab3f325-09ae-44d1-9400-c10cb8f97607",
});
Copy
import pulumi
import pulumi_airbyte as airbyte

my_source_wheniwork = airbyte.SourceWhenIWork("mySourceWheniwork",
    configuration={
        "email": "...my_email...",
        "password": "...my_password...",
    },
    definition_id="f634cd12-ec11-48cf-8c00-8e13a5f17023",
    secret_id="...my_secret_id...",
    workspace_id="eab3f325-09ae-44d1-9400-c10cb8f97607")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/airbyte/airbyte"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := airbyte.NewSourceWhenIWork(ctx, "mySourceWheniwork", &airbyte.SourceWhenIWorkArgs{
			Configuration: &airbyte.SourceWhenIWorkConfigurationArgs{
				Email:    pulumi.String("...my_email..."),
				Password: pulumi.String("...my_password..."),
			},
			DefinitionId: pulumi.String("f634cd12-ec11-48cf-8c00-8e13a5f17023"),
			SecretId:     pulumi.String("...my_secret_id..."),
			WorkspaceId:  pulumi.String("eab3f325-09ae-44d1-9400-c10cb8f97607"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Airbyte = Pulumi.Airbyte;

return await Deployment.RunAsync(() => 
{
    var mySourceWheniwork = new Airbyte.SourceWhenIWork("mySourceWheniwork", new()
    {
        Configuration = new Airbyte.Inputs.SourceWhenIWorkConfigurationArgs
        {
            Email = "...my_email...",
            Password = "...my_password...",
        },
        DefinitionId = "f634cd12-ec11-48cf-8c00-8e13a5f17023",
        SecretId = "...my_secret_id...",
        WorkspaceId = "eab3f325-09ae-44d1-9400-c10cb8f97607",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.airbyte.SourceWhenIWork;
import com.pulumi.airbyte.SourceWhenIWorkArgs;
import com.pulumi.airbyte.inputs.SourceWhenIWorkConfigurationArgs;
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 mySourceWheniwork = new SourceWhenIWork("mySourceWheniwork", SourceWhenIWorkArgs.builder()
            .configuration(SourceWhenIWorkConfigurationArgs.builder()
                .email("...my_email...")
                .password("...my_password...")
                .build())
            .definitionId("f634cd12-ec11-48cf-8c00-8e13a5f17023")
            .secretId("...my_secret_id...")
            .workspaceId("eab3f325-09ae-44d1-9400-c10cb8f97607")
            .build());

    }
}
Copy
resources:
  mySourceWheniwork:
    type: airbyte:SourceWhenIWork
    properties:
      configuration:
        email: '...my_email...'
        password: '...my_password...'
      definitionId: f634cd12-ec11-48cf-8c00-8e13a5f17023
      secretId: '...my_secret_id...'
      workspaceId: eab3f325-09ae-44d1-9400-c10cb8f97607
Copy

Create SourceWhenIWork Resource

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

Constructor syntax

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

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

type: airbyte:SourceWhenIWork
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. SourceWhenIWorkArgs
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. SourceWhenIWorkArgs
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. SourceWhenIWorkArgs
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. SourceWhenIWorkArgs
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. SourceWhenIWorkArgs
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 sourceWhenIWorkResource = new Airbyte.SourceWhenIWork("sourceWhenIWorkResource", new()
{
    Configuration = new Airbyte.Inputs.SourceWhenIWorkConfigurationArgs
    {
        Email = "string",
        Password = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});
Copy
example, err := airbyte.NewSourceWhenIWork(ctx, "sourceWhenIWorkResource", &airbyte.SourceWhenIWorkArgs{
Configuration: &.SourceWhenIWorkConfigurationArgs{
Email: pulumi.String("string"),
Password: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})
Copy
var sourceWhenIWorkResource = new SourceWhenIWork("sourceWhenIWorkResource", SourceWhenIWorkArgs.builder()
    .configuration(SourceWhenIWorkConfigurationArgs.builder()
        .email("string")
        .password("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());
Copy
source_when_i_work_resource = airbyte.SourceWhenIWork("sourceWhenIWorkResource",
    configuration={
        "email": "string",
        "password": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")
Copy
const sourceWhenIWorkResource = new airbyte.SourceWhenIWork("sourceWhenIWorkResource", {
    configuration: {
        email: "string",
        password: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});
Copy
type: airbyte:SourceWhenIWork
properties:
    configuration:
        email: string
        password: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string
Copy

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

Configuration This property is required. SourceWhenIWorkConfiguration
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. SourceWhenIWorkConfigurationArgs
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. SourceWhenIWorkConfiguration
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. SourceWhenIWorkConfiguration
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. SourceWhenIWorkConfigurationArgs
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 SourceWhenIWork resource produces the following output properties:

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

Get an existing SourceWhenIWork 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?: SourceWhenIWorkState, opts?: CustomResourceOptions): SourceWhenIWork
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceWhenIWorkConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        resource_allocation: Optional[SourceWhenIWorkResourceAllocationArgs] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourceWhenIWork
func GetSourceWhenIWork(ctx *Context, name string, id IDInput, state *SourceWhenIWorkState, opts ...ResourceOption) (*SourceWhenIWork, error)
public static SourceWhenIWork Get(string name, Input<string> id, SourceWhenIWorkState? state, CustomResourceOptions? opts = null)
public static SourceWhenIWork get(String name, Output<String> id, SourceWhenIWorkState state, CustomResourceOptions options)
resources:  _:    type: airbyte:SourceWhenIWork    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 SourceWhenIWorkConfiguration
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 SourceWhenIWorkResourceAllocation
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 SourceWhenIWorkConfigurationArgs
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 SourceWhenIWorkResourceAllocationArgs
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 SourceWhenIWorkConfiguration
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 SourceWhenIWorkResourceAllocation
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 SourceWhenIWorkConfiguration
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 SourceWhenIWorkResourceAllocation
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 SourceWhenIWorkConfigurationArgs
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 SourceWhenIWorkResourceAllocationArgs
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

SourceWhenIWorkConfiguration
, SourceWhenIWorkConfigurationArgs

Email This property is required. string
Email of your when-i-work account
Password This property is required. string
Password for your when-i-work account
Email This property is required. string
Email of your when-i-work account
Password This property is required. string
Password for your when-i-work account
email This property is required. String
Email of your when-i-work account
password This property is required. String
Password for your when-i-work account
email This property is required. string
Email of your when-i-work account
password This property is required. string
Password for your when-i-work account
email This property is required. str
Email of your when-i-work account
password This property is required. str
Password for your when-i-work account
email This property is required. String
Email of your when-i-work account
password This property is required. String
Password for your when-i-work account

SourceWhenIWorkResourceAllocation
, SourceWhenIWorkResourceAllocationArgs

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

SourceWhenIWorkResourceAllocationDefault
, SourceWhenIWorkResourceAllocationDefaultArgs

SourceWhenIWorkResourceAllocationJobSpecific
, SourceWhenIWorkResourceAllocationJobSpecificArgs

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

SourceWhenIWorkResourceAllocationJobSpecificResourceRequirements
, SourceWhenIWorkResourceAllocationJobSpecificResourceRequirementsArgs

Import

$ pulumi import airbyte:index/sourceWhenIWork:SourceWhenIWork my_airbyte_source_when_i_work ""
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.
airbyte 0.8.1-beta published on Saturday, Mar 29, 2025 by airbytehq
airbytehq/terraform-provider-airbyte