SourceGithub

airbyte 1.0.0-rc6, Feb 16 26

airbyte 1.0.0-rc6 published on Monday, Feb 16, 2026 by airbytehq

Schema (JSON)

airbytehq/terraform-provider-airbyte

airbyte 1.0.0-rc6 published on Monday, Feb 16, 2026 by airbytehq

Schema (JSON)

airbytehq/terraform-provider-airbyte

Example Usage

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

const mySourceGithub = new airbyte.SourceGithub("my_source_github", {
    configuration: {
        additionalProperties: "{ \"see\": \"documentation\" }",
        apiUrl: "https://github.com",
        branch: "airbytehq/airbyte/master airbytehq/airbyte/my-branch",
        branches: ["..."],
        credentials: {
            personalAccessToken: {
                personalAccessToken: "...my_personal_access_token...",
            },
        },
        maxWaitingTime: 10,
        repositories: ["..."],
        repository: "airbytehq/airbyte airbytehq/another-repo",
        startDate: "2021-03-01T00:00:00Z",
    },
    definitionId: "eed1fe5e-7311-4b8b-9ce8-186629287c2f",
    name: "...my_name...",
    secretId: "...my_secret_id...",
    workspaceId: "8cc76dd7-521b-4116-ab6d-3a729514b42f",
});

import pulumi
import pulumi_airbyte as airbyte

my_source_github = airbyte.SourceGithub("my_source_github",
    configuration={
        "additional_properties": "{ \"see\": \"documentation\" }",
        "api_url": "https://github.com",
        "branch": "airbytehq/airbyte/master airbytehq/airbyte/my-branch",
        "branches": ["..."],
        "credentials": {
            "personal_access_token": {
                "personal_access_token": "...my_personal_access_token...",
            },
        },
        "max_waiting_time": 10,
        "repositories": ["..."],
        "repository": "airbytehq/airbyte airbytehq/another-repo",
        "start_date": "2021-03-01T00:00:00Z",
    },
    definition_id="eed1fe5e-7311-4b8b-9ce8-186629287c2f",
    name="...my_name...",
    secret_id="...my_secret_id...",
    workspace_id="8cc76dd7-521b-4116-ab6d-3a729514b42f")

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.NewSourceGithub(ctx, "my_source_github", &airbyte.SourceGithubArgs{
			Configuration: &airbyte.SourceGithubConfigurationArgs{
				AdditionalProperties: pulumi.String("{ \"see\": \"documentation\" }"),
				ApiUrl:               pulumi.String("https://github.com"),
				Branch:               pulumi.String("airbytehq/airbyte/master airbytehq/airbyte/my-branch"),
				Branches: pulumi.StringArray{
					pulumi.String("..."),
				},
				Credentials: &airbyte.SourceGithubConfigurationCredentialsArgs{
					PersonalAccessToken: &airbyte.SourceGithubConfigurationCredentialsPersonalAccessTokenArgs{
						PersonalAccessToken: pulumi.String("...my_personal_access_token..."),
					},
				},
				MaxWaitingTime: pulumi.Float64(10),
				Repositories: pulumi.StringArray{
					pulumi.String("..."),
				},
				Repository: pulumi.String("airbytehq/airbyte airbytehq/another-repo"),
				StartDate:  pulumi.String("2021-03-01T00:00:00Z"),
			},
			DefinitionId: pulumi.String("eed1fe5e-7311-4b8b-9ce8-186629287c2f"),
			Name:         pulumi.String("...my_name..."),
			SecretId:     pulumi.String("...my_secret_id..."),
			WorkspaceId:  pulumi.String("8cc76dd7-521b-4116-ab6d-3a729514b42f"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Airbyte = Pulumi.Airbyte;

return await Deployment.RunAsync(() => 
{
    var mySourceGithub = new Airbyte.SourceGithub("my_source_github", new()
    {
        Configuration = new Airbyte.Inputs.SourceGithubConfigurationArgs
        {
            AdditionalProperties = "{ \"see\": \"documentation\" }",
            ApiUrl = "https://github.com",
            Branch = "airbytehq/airbyte/master airbytehq/airbyte/my-branch",
            Branches = new[]
            {
                "...",
            },
            Credentials = new Airbyte.Inputs.SourceGithubConfigurationCredentialsArgs
            {
                PersonalAccessToken = new Airbyte.Inputs.SourceGithubConfigurationCredentialsPersonalAccessTokenArgs
                {
                    PersonalAccessToken = "...my_personal_access_token...",
                },
            },
            MaxWaitingTime = 10,
            Repositories = new[]
            {
                "...",
            },
            Repository = "airbytehq/airbyte airbytehq/another-repo",
            StartDate = "2021-03-01T00:00:00Z",
        },
        DefinitionId = "eed1fe5e-7311-4b8b-9ce8-186629287c2f",
        Name = "...my_name...",
        SecretId = "...my_secret_id...",
        WorkspaceId = "8cc76dd7-521b-4116-ab6d-3a729514b42f",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.airbyte.SourceGithub;
import com.pulumi.airbyte.SourceGithubArgs;
import com.pulumi.airbyte.inputs.SourceGithubConfigurationArgs;
import com.pulumi.airbyte.inputs.SourceGithubConfigurationCredentialsArgs;
import com.pulumi.airbyte.inputs.SourceGithubConfigurationCredentialsPersonalAccessTokenArgs;
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 mySourceGithub = new SourceGithub("mySourceGithub", SourceGithubArgs.builder()
            .configuration(SourceGithubConfigurationArgs.builder()
                .additionalProperties("{ \"see\": \"documentation\" }")
                .apiUrl("https://github.com")
                .branch("airbytehq/airbyte/master airbytehq/airbyte/my-branch")
                .branches("...")
                .credentials(SourceGithubConfigurationCredentialsArgs.builder()
                    .personalAccessToken(SourceGithubConfigurationCredentialsPersonalAccessTokenArgs.builder()
                        .personalAccessToken("...my_personal_access_token...")
                        .build())
                    .build())
                .maxWaitingTime(10.0)
                .repositories("...")
                .repository("airbytehq/airbyte airbytehq/another-repo")
                .startDate("2021-03-01T00:00:00Z")
                .build())
            .definitionId("eed1fe5e-7311-4b8b-9ce8-186629287c2f")
            .name("...my_name...")
            .secretId("...my_secret_id...")
            .workspaceId("8cc76dd7-521b-4116-ab6d-3a729514b42f")
            .build());

    }
}

resources:
  mySourceGithub:
    type: airbyte:SourceGithub
    name: my_source_github
    properties:
      configuration:
        additionalProperties: '{ "see": "documentation" }'
        apiUrl: https://github.com
        branch: airbytehq/airbyte/master airbytehq/airbyte/my-branch
        branches:
          - '...'
        credentials:
          personalAccessToken:
            personalAccessToken: '...my_personal_access_token...'
        maxWaitingTime: 10
        repositories:
          - '...'
        repository: airbytehq/airbyte airbytehq/another-repo
        startDate: 2021-03-01T00:00:00Z
      definitionId: eed1fe5e-7311-4b8b-9ce8-186629287c2f
      name: '...my_name...'
      secretId: '...my_secret_id...'
      workspaceId: 8cc76dd7-521b-4116-ab6d-3a729514b42f

Create SourceGithub Resource

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

Constructor syntax

new SourceGithub(name: string, args: SourceGithubArgs, opts?: CustomResourceOptions);

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

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

func NewSourceGithub(ctx *Context, name string, args SourceGithubArgs, opts ...ResourceOption) (*SourceGithub, error)

public SourceGithub(string name, SourceGithubArgs args, CustomResourceOptions? opts = null)

public SourceGithub(String name, SourceGithubArgs args)
public SourceGithub(String name, SourceGithubArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args SourceGithubArgs: 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 sourceGithubResource = new Airbyte.SourceGithub("sourceGithubResource", new()
{
    Configuration = new Airbyte.Inputs.SourceGithubConfigurationArgs
    {
        Credentials = new Airbyte.Inputs.SourceGithubConfigurationCredentialsArgs
        {
            OAuth = new Airbyte.Inputs.SourceGithubConfigurationCredentialsOAuthArgs
            {
                AccessToken = "string",
                ClientId = "string",
                ClientSecret = "string",
            },
            PersonalAccessToken = new Airbyte.Inputs.SourceGithubConfigurationCredentialsPersonalAccessTokenArgs
            {
                PersonalAccessToken = "string",
            },
        },
        Repositories = new[]
        {
            "string",
        },
        AdditionalProperties = "string",
        ApiUrl = "string",
        Branch = "string",
        Branches = new[]
        {
            "string",
        },
        MaxWaitingTime = 0,
        Repository = "string",
        StartDate = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

example, err := airbyte.NewSourceGithub(ctx, "sourceGithubResource", &airbyte.SourceGithubArgs{
	Configuration: &airbyte.SourceGithubConfigurationArgs{
		Credentials: &airbyte.SourceGithubConfigurationCredentialsArgs{
			OAuth: &airbyte.SourceGithubConfigurationCredentialsOAuthArgs{
				AccessToken:  pulumi.String("string"),
				ClientId:     pulumi.String("string"),
				ClientSecret: pulumi.String("string"),
			},
			PersonalAccessToken: &airbyte.SourceGithubConfigurationCredentialsPersonalAccessTokenArgs{
				PersonalAccessToken: pulumi.String("string"),
			},
		},
		Repositories: pulumi.StringArray{
			pulumi.String("string"),
		},
		AdditionalProperties: pulumi.String("string"),
		ApiUrl:               pulumi.String("string"),
		Branch:               pulumi.String("string"),
		Branches: pulumi.StringArray{
			pulumi.String("string"),
		},
		MaxWaitingTime: pulumi.Float64(0),
		Repository:     pulumi.String("string"),
		StartDate:      pulumi.String("string"),
	},
	WorkspaceId:  pulumi.String("string"),
	DefinitionId: pulumi.String("string"),
	Name:         pulumi.String("string"),
	SecretId:     pulumi.String("string"),
})

var sourceGithubResource = new SourceGithub("sourceGithubResource", SourceGithubArgs.builder()
    .configuration(SourceGithubConfigurationArgs.builder()
        .credentials(SourceGithubConfigurationCredentialsArgs.builder()
            .oAuth(SourceGithubConfigurationCredentialsOAuthArgs.builder()
                .accessToken("string")
                .clientId("string")
                .clientSecret("string")
                .build())
            .personalAccessToken(SourceGithubConfigurationCredentialsPersonalAccessTokenArgs.builder()
                .personalAccessToken("string")
                .build())
            .build())
        .repositories("string")
        .additionalProperties("string")
        .apiUrl("string")
        .branch("string")
        .branches("string")
        .maxWaitingTime(0.0)
        .repository("string")
        .startDate("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

source_github_resource = airbyte.SourceGithub("sourceGithubResource",
    configuration={
        "credentials": {
            "o_auth": {
                "access_token": "string",
                "client_id": "string",
                "client_secret": "string",
            },
            "personal_access_token": {
                "personal_access_token": "string",
            },
        },
        "repositories": ["string"],
        "additional_properties": "string",
        "api_url": "string",
        "branch": "string",
        "branches": ["string"],
        "max_waiting_time": 0,
        "repository": "string",
        "start_date": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

const sourceGithubResource = new airbyte.SourceGithub("sourceGithubResource", {
    configuration: {
        credentials: {
            oAuth: {
                accessToken: "string",
                clientId: "string",
                clientSecret: "string",
            },
            personalAccessToken: {
                personalAccessToken: "string",
            },
        },
        repositories: ["string"],
        additionalProperties: "string",
        apiUrl: "string",
        branch: "string",
        branches: ["string"],
        maxWaitingTime: 0,
        repository: "string",
        startDate: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

type: airbyte:SourceGithub
properties:
    configuration:
        additionalProperties: string
        apiUrl: string
        branch: string
        branches:
            - string
        credentials:
            oAuth:
                accessToken: string
                clientId: string
                clientSecret: string
            personalAccessToken:
                personalAccessToken: string
        maxWaitingTime: 0
        repositories:
            - string
        repository: string
        startDate: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

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

Configuration SourceGithubConfiguration: The values required to configure the source. The schema for this must match the schema return by sourcedefinitionspecifications/get for the source.
WorkspaceId string
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Default: "ef69ef6e-aa7f-4af1-a01d-ef775033524e"; 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 SourceGithubConfigurationArgs: The values required to configure the source. The schema for this must match the schema return by sourcedefinitionspecifications/get for the source.
WorkspaceId string
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Default: "ef69ef6e-aa7f-4af1-a01d-ef775033524e"; 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 SourceGithubConfiguration: The values required to configure the source. The schema for this must match the schema return by sourcedefinitionspecifications/get for the source.
workspaceId String
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Default: "ef69ef6e-aa7f-4af1-a01d-ef775033524e"; 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 SourceGithubConfiguration: The values required to configure the source. The schema for this must match the schema return by sourcedefinitionspecifications/get for the source.
workspaceId string
definitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Default: "ef69ef6e-aa7f-4af1-a01d-ef775033524e"; 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 SourceGithubConfigurationArgs: The values required to configure the source. The schema for this must match the schema return by sourcedefinitionspecifications/get for the source.
workspace_id str
definition_id str: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Default: "ef69ef6e-aa7f-4af1-a01d-ef775033524e"; 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: The values required to configure the source. The schema for this must match the schema return by sourcedefinitionspecifications/get for the source.
workspaceId String
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Default: "ef69ef6e-aa7f-4af1-a01d-ef775033524e"; 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 SourceGithub resource produces the following output properties:

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

Get an existing SourceGithub 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?: SourceGithubState, opts?: CustomResourceOptions): SourceGithub

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

func GetSourceGithub(ctx *Context, name string, id IDInput, state *SourceGithubState, opts ...ResourceOption) (*SourceGithub, error)

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

public static SourceGithub get(String name, Output<String> id, SourceGithubState state, CustomResourceOptions options)

resources:  _:    type: airbyte:SourceGithub    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 SourceGithubConfiguration: The values required to configure the source. The schema for this must match the schema return by sourcedefinitionspecifications/get for the source.
CreatedAt double
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Default: "ef69ef6e-aa7f-4af1-a01d-ef775033524e"; Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
ResourceAllocation SourceGithubResourceAllocation: 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 SourceGithubConfigurationArgs: The values required to configure the source. The schema for this must match the schema return by sourcedefinitionspecifications/get for the source.
CreatedAt float64
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Default: "ef69ef6e-aa7f-4af1-a01d-ef775033524e"; Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
ResourceAllocation SourceGithubResourceAllocationArgs: 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 SourceGithubConfiguration: The values required to configure the source. The schema for this must match the schema return by sourcedefinitionspecifications/get for the source.
createdAt Double
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Default: "ef69ef6e-aa7f-4af1-a01d-ef775033524e"; Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
resourceAllocation SourceGithubResourceAllocation: 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 SourceGithubConfiguration: The values required to configure the source. The schema for this must match the schema return by sourcedefinitionspecifications/get for the source.
createdAt number
definitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Default: "ef69ef6e-aa7f-4af1-a01d-ef775033524e"; Requires replacement if changed.
name string: Name of the source e.g. dev-mysql-instance.
resourceAllocation SourceGithubResourceAllocation: 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 SourceGithubConfigurationArgs: The values required to configure the source. The schema for this must match the schema return by sourcedefinitionspecifications/get for the source.
created_at float
definition_id str: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Default: "ef69ef6e-aa7f-4af1-a01d-ef775033524e"; Requires replacement if changed.
name str: Name of the source e.g. dev-mysql-instance.
resource_allocation SourceGithubResourceAllocationArgs: 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: The values required to configure the source. The schema for this must match the schema return by sourcedefinitionspecifications/get for the source.
createdAt Number
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Default: "ef69ef6e-aa7f-4af1-a01d-ef775033524e"; 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

SourceGithubConfiguration, SourceGithubConfigurationArgs

Credentials SourceGithubConfigurationCredentials: Choose how to authenticate to GitHub
Repositories List<string>: List of GitHub organizations/repositories, e.g. airbytehq/airbyte for single repository, airbytehq/* for get all repositories from organization and `airbytehq/a* for matching multiple repositories by pattern.
AdditionalProperties string: Parsed as JSON.
ApiUrl string: Please enter your basic URL from self-hosted GitHub instance or leave it empty to use GitHub. Default: "https://api.github.com/"
Branch string: (DEPRCATED) Space-delimited list of GitHub repository branches to pull commits for, e.g. airbytehq/airbyte/master. If no branches are specified for a repository, the default branch will be pulled.
Branches List<string>: List of GitHub repository branches to pull commits for, e.g. airbytehq/airbyte/master. If no branches are specified for a repository, the default branch will be pulled.
MaxWaitingTime double: Max Waiting Time for rate limit. Set higher value to wait till rate limits will be resetted to continue sync. Default: 10
Repository string: (DEPRCATED) Space-delimited list of GitHub organizations/repositories, e.g. airbytehq/airbyte for single repository, airbytehq/* for get all repositories from organization and airbytehq/airbyte airbytehq/another-repo for multiple repositories.
StartDate string: The date from which you'd like to replicate data from GitHub in the format YYYY-MM-DDT00:00:00Z. If the date is not set, all data will be replicated. For the streams which support this configuration, only data generated on or after the start date will be replicated. This field doesn't apply to all streams, see the \n\ndocs\n\n for more info

Credentials SourceGithubConfigurationCredentials: Choose how to authenticate to GitHub
Repositories []string: List of GitHub organizations/repositories, e.g. airbytehq/airbyte for single repository, airbytehq/* for get all repositories from organization and `airbytehq/a* for matching multiple repositories by pattern.
AdditionalProperties string: Parsed as JSON.
ApiUrl string: Please enter your basic URL from self-hosted GitHub instance or leave it empty to use GitHub. Default: "https://api.github.com/"
Branch string: (DEPRCATED) Space-delimited list of GitHub repository branches to pull commits for, e.g. airbytehq/airbyte/master. If no branches are specified for a repository, the default branch will be pulled.
Branches []string: List of GitHub repository branches to pull commits for, e.g. airbytehq/airbyte/master. If no branches are specified for a repository, the default branch will be pulled.
MaxWaitingTime float64: Max Waiting Time for rate limit. Set higher value to wait till rate limits will be resetted to continue sync. Default: 10
Repository string: (DEPRCATED) Space-delimited list of GitHub organizations/repositories, e.g. airbytehq/airbyte for single repository, airbytehq/* for get all repositories from organization and airbytehq/airbyte airbytehq/another-repo for multiple repositories.
StartDate string: The date from which you'd like to replicate data from GitHub in the format YYYY-MM-DDT00:00:00Z. If the date is not set, all data will be replicated. For the streams which support this configuration, only data generated on or after the start date will be replicated. This field doesn't apply to all streams, see the \n\ndocs\n\n for more info

credentials SourceGithubConfigurationCredentials: Choose how to authenticate to GitHub
repositories List<String>: List of GitHub organizations/repositories, e.g. airbytehq/airbyte for single repository, airbytehq/* for get all repositories from organization and `airbytehq/a* for matching multiple repositories by pattern.
additionalProperties String: Parsed as JSON.
apiUrl String: Please enter your basic URL from self-hosted GitHub instance or leave it empty to use GitHub. Default: "https://api.github.com/"
branch String: (DEPRCATED) Space-delimited list of GitHub repository branches to pull commits for, e.g. airbytehq/airbyte/master. If no branches are specified for a repository, the default branch will be pulled.
branches List<String>: List of GitHub repository branches to pull commits for, e.g. airbytehq/airbyte/master. If no branches are specified for a repository, the default branch will be pulled.
maxWaitingTime Double: Max Waiting Time for rate limit. Set higher value to wait till rate limits will be resetted to continue sync. Default: 10
repository String: (DEPRCATED) Space-delimited list of GitHub organizations/repositories, e.g. airbytehq/airbyte for single repository, airbytehq/* for get all repositories from organization and airbytehq/airbyte airbytehq/another-repo for multiple repositories.
startDate String: The date from which you'd like to replicate data from GitHub in the format YYYY-MM-DDT00:00:00Z. If the date is not set, all data will be replicated. For the streams which support this configuration, only data generated on or after the start date will be replicated. This field doesn't apply to all streams, see the \n\ndocs\n\n for more info

credentials SourceGithubConfigurationCredentials: Choose how to authenticate to GitHub
repositories string[]: List of GitHub organizations/repositories, e.g. airbytehq/airbyte for single repository, airbytehq/* for get all repositories from organization and `airbytehq/a* for matching multiple repositories by pattern.
additionalProperties string: Parsed as JSON.
apiUrl string: Please enter your basic URL from self-hosted GitHub instance or leave it empty to use GitHub. Default: "https://api.github.com/"
branch string: (DEPRCATED) Space-delimited list of GitHub repository branches to pull commits for, e.g. airbytehq/airbyte/master. If no branches are specified for a repository, the default branch will be pulled.
branches string[]: List of GitHub repository branches to pull commits for, e.g. airbytehq/airbyte/master. If no branches are specified for a repository, the default branch will be pulled.
maxWaitingTime number: Max Waiting Time for rate limit. Set higher value to wait till rate limits will be resetted to continue sync. Default: 10
repository string: (DEPRCATED) Space-delimited list of GitHub organizations/repositories, e.g. airbytehq/airbyte for single repository, airbytehq/* for get all repositories from organization and airbytehq/airbyte airbytehq/another-repo for multiple repositories.
startDate string: The date from which you'd like to replicate data from GitHub in the format YYYY-MM-DDT00:00:00Z. If the date is not set, all data will be replicated. For the streams which support this configuration, only data generated on or after the start date will be replicated. This field doesn't apply to all streams, see the \n\ndocs\n\n for more info

credentials SourceGithubConfigurationCredentials: Choose how to authenticate to GitHub
repositories Sequence[str]: List of GitHub organizations/repositories, e.g. airbytehq/airbyte for single repository, airbytehq/* for get all repositories from organization and `airbytehq/a* for matching multiple repositories by pattern.
additional_properties str: Parsed as JSON.
api_url str: Please enter your basic URL from self-hosted GitHub instance or leave it empty to use GitHub. Default: "https://api.github.com/"
branch str: (DEPRCATED) Space-delimited list of GitHub repository branches to pull commits for, e.g. airbytehq/airbyte/master. If no branches are specified for a repository, the default branch will be pulled.
branches Sequence[str]: List of GitHub repository branches to pull commits for, e.g. airbytehq/airbyte/master. If no branches are specified for a repository, the default branch will be pulled.
max_waiting_time float: Max Waiting Time for rate limit. Set higher value to wait till rate limits will be resetted to continue sync. Default: 10
repository str: (DEPRCATED) Space-delimited list of GitHub organizations/repositories, e.g. airbytehq/airbyte for single repository, airbytehq/* for get all repositories from organization and airbytehq/airbyte airbytehq/another-repo for multiple repositories.
start_date str: The date from which you'd like to replicate data from GitHub in the format YYYY-MM-DDT00:00:00Z. If the date is not set, all data will be replicated. For the streams which support this configuration, only data generated on or after the start date will be replicated. This field doesn't apply to all streams, see the \n\ndocs\n\n for more info

credentials Property Map: Choose how to authenticate to GitHub
repositories List<String>: List of GitHub organizations/repositories, e.g. airbytehq/airbyte for single repository, airbytehq/* for get all repositories from organization and `airbytehq/a* for matching multiple repositories by pattern.
additionalProperties String: Parsed as JSON.
apiUrl String: Please enter your basic URL from self-hosted GitHub instance or leave it empty to use GitHub. Default: "https://api.github.com/"
branch String: (DEPRCATED) Space-delimited list of GitHub repository branches to pull commits for, e.g. airbytehq/airbyte/master. If no branches are specified for a repository, the default branch will be pulled.
branches List<String>: List of GitHub repository branches to pull commits for, e.g. airbytehq/airbyte/master. If no branches are specified for a repository, the default branch will be pulled.
maxWaitingTime Number: Max Waiting Time for rate limit. Set higher value to wait till rate limits will be resetted to continue sync. Default: 10
repository String: (DEPRCATED) Space-delimited list of GitHub organizations/repositories, e.g. airbytehq/airbyte for single repository, airbytehq/* for get all repositories from organization and airbytehq/airbyte airbytehq/another-repo for multiple repositories.
startDate String: The date from which you'd like to replicate data from GitHub in the format YYYY-MM-DDT00:00:00Z. If the date is not set, all data will be replicated. For the streams which support this configuration, only data generated on or after the start date will be replicated. This field doesn't apply to all streams, see the \n\ndocs\n\n for more info

SourceGithubConfigurationCredentials, SourceGithubConfigurationCredentialsArgs

OAuth SourceGithubConfigurationCredentialsOAuth
PersonalAccessToken SourceGithubConfigurationCredentialsPersonalAccessToken

OAuth SourceGithubConfigurationCredentialsOAuth
PersonalAccessToken SourceGithubConfigurationCredentialsPersonalAccessToken

oAuth SourceGithubConfigurationCredentialsOAuth
personalAccessToken SourceGithubConfigurationCredentialsPersonalAccessToken

oAuth SourceGithubConfigurationCredentialsOAuth
personalAccessToken SourceGithubConfigurationCredentialsPersonalAccessToken

o_auth SourceGithubConfigurationCredentialsOAuth
personal_access_token SourceGithubConfigurationCredentialsPersonalAccessToken

oAuth Property Map
personalAccessToken Property Map

SourceGithubConfigurationCredentialsOAuth, SourceGithubConfigurationCredentialsOAuthArgs

AccessToken string: OAuth access token
ClientId string: OAuth Client Id
ClientSecret string: OAuth Client secret

AccessToken string: OAuth access token
ClientId string: OAuth Client Id
ClientSecret string: OAuth Client secret

accessToken String: OAuth access token
clientId String: OAuth Client Id
clientSecret String: OAuth Client secret

accessToken string: OAuth access token
clientId string: OAuth Client Id
clientSecret string: OAuth Client secret

access_token str: OAuth access token
client_id str: OAuth Client Id
client_secret str: OAuth Client secret

accessToken String: OAuth access token
clientId String: OAuth Client Id
clientSecret String: OAuth Client secret

SourceGithubConfigurationCredentialsPersonalAccessToken, SourceGithubConfigurationCredentialsPersonalAccessTokenArgs

PersonalAccessToken string: Log into GitHub and then generate a \n\npersonal access token\n\n. To load balance your API quota consumption across multiple API tokens, input multiple tokens separated with ","

PersonalAccessToken string: Log into GitHub and then generate a \n\npersonal access token\n\n. To load balance your API quota consumption across multiple API tokens, input multiple tokens separated with ","

personalAccessToken String: Log into GitHub and then generate a \n\npersonal access token\n\n. To load balance your API quota consumption across multiple API tokens, input multiple tokens separated with ","

personalAccessToken string: Log into GitHub and then generate a \n\npersonal access token\n\n. To load balance your API quota consumption across multiple API tokens, input multiple tokens separated with ","

personal_access_token str: Log into GitHub and then generate a \n\npersonal access token\n\n. To load balance your API quota consumption across multiple API tokens, input multiple tokens separated with ","

personalAccessToken String: Log into GitHub and then generate a \n\npersonal access token\n\n. To load balance your API quota consumption across multiple API tokens, input multiple tokens separated with ","

SourceGithubResourceAllocation, SourceGithubResourceAllocationArgs

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

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

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

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

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

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

SourceGithubResourceAllocationDefault, SourceGithubResourceAllocationDefaultArgs

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

SourceGithubResourceAllocationJobSpecific, SourceGithubResourceAllocationJobSpecificArgs

JobType string: enum that describes the different types of jobs that the platform runs.
ResourceRequirements SourceGithubResourceAllocationJobSpecificResourceRequirements: optional resource requirements to run workers (blank for unbounded allocations)

JobType string: enum that describes the different types of jobs that the platform runs.
ResourceRequirements SourceGithubResourceAllocationJobSpecificResourceRequirements: optional resource requirements to run workers (blank for unbounded allocations)

jobType String: enum that describes the different types of jobs that the platform runs.
resourceRequirements SourceGithubResourceAllocationJobSpecificResourceRequirements: optional resource requirements to run workers (blank for unbounded allocations)

jobType string: enum that describes the different types of jobs that the platform runs.
resourceRequirements SourceGithubResourceAllocationJobSpecificResourceRequirements: 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.
resource_requirements SourceGithubResourceAllocationJobSpecificResourceRequirements: optional resource requirements to run workers (blank for unbounded allocations)

jobType String: enum that describes the different types of jobs that the platform runs.
resourceRequirements Property Map: optional resource requirements to run workers (blank for unbounded allocations)

SourceGithubResourceAllocationJobSpecificResourceRequirements, SourceGithubResourceAllocationJobSpecificResourceRequirementsArgs

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

In Terraform v1.5.0 and later, the import block can be used with the id attribute, for example:

terraform

import {

to = airbyte_source_github.my_airbyte_source_github

id = “…”

}

The pulumi import command can be used, for example:

$ pulumi import airbyte:index/sourceGithub:SourceGithub my_airbyte_source_github "..."

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 1.0.0-rc6 published on Monday, Feb 16, 2026 by airbytehq

Schema (JSON)

airbytehq/terraform-provider-airbyte

airbyte.SourceGithub

On this page

On this page

Example Usage

Create SourceGithub Resource

Constructor syntax

Parameters

Constructor example

SourceGithub Resource Properties

Inputs

Outputs

Look up Existing SourceGithub Resource

Supporting Types

SourceGithubConfiguration, SourceGithubConfigurationArgs

SourceGithubConfigurationCredentials, SourceGithubConfigurationCredentialsArgs

SourceGithubConfigurationCredentialsOAuth, SourceGithubConfigurationCredentialsOAuthArgs

SourceGithubConfigurationCredentialsPersonalAccessToken, SourceGithubConfigurationCredentialsPersonalAccessTokenArgs

SourceGithubResourceAllocation, SourceGithubResourceAllocationArgs

SourceGithubResourceAllocationDefault, SourceGithubResourceAllocationDefaultArgs

SourceGithubResourceAllocationJobSpecific, SourceGithubResourceAllocationJobSpecificArgs

SourceGithubResourceAllocationJobSpecificResourceRequirements, SourceGithubResourceAllocationJobSpecificResourceRequirementsArgs

Import

Package Details

On this page

On this page