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

airbyte.SourceGithub

Explore with Pulumi AI

SourceGithub 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.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()
                .api_url("https://github.com")
                .branches("...")
                .credentials(SourceGithubConfigurationCredentialsArgs.builder()
                    .personalAccessToken(SourceGithubConfigurationCredentialsPersonalAccessTokenArgs.builder()
                        .personalAccessToken("...my_personal_access_token...")
                        .build())
                    .build())
                .max_waiting_time(10)
                .repositories("...")
                .start_date("2021-03-01T00:00:00Z")
                .build())
            .definitionId("eed1fe5e-7311-4b8b-9ce8-186629287c2f")
            .secretId("...my_secret_id...")
            .workspaceId("8cc76dd7-521b-4116-ab6d-3a729514b42f")
            .build());

    }
}
Copy
resources:
  mySourceGithub:
    type: airbyte:SourceGithub
    properties:
      configuration:
        api_url: https://github.com
        branches:
          - '...'
        credentials:
          personalAccessToken:
            personalAccessToken: '...my_personal_access_token...'
        max_waiting_time: 10
        repositories:
          - '...'
        start_date: 2021-03-01T00:00:00Z
      definitionId: eed1fe5e-7311-4b8b-9ce8-186629287c2f
      secretId: '...my_secret_id...'
      workspaceId: 8cc76dd7-521b-4116-ab6d-3a729514b42f
Copy

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 This property is required. string
The unique name of the resource.
args This property is required. SourceGithubArgs
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. 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 This property is required. string
The unique name of the resource.
args This property is required. SourceGithubArgs
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. SourceGithubArgs
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. 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",
        },
        ApiUrl = "string",
        Branches = new[]
        {
            "string",
        },
        MaxWaitingTime = 0,
        StartDate = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});
Copy
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"),
		},
		ApiUrl: pulumi.String("string"),
		Branches: pulumi.StringArray{
			pulumi.String("string"),
		},
		MaxWaitingTime: pulumi.Float64(0),
		StartDate:      pulumi.String("string"),
	},
	WorkspaceId:  pulumi.String("string"),
	DefinitionId: pulumi.String("string"),
	Name:         pulumi.String("string"),
	SecretId:     pulumi.String("string"),
})
Copy
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")
        .apiUrl("string")
        .branches("string")
        .maxWaitingTime(0)
        .startDate("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());
Copy
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"],
        "api_url": "string",
        "branches": ["string"],
        "max_waiting_time": 0,
        "start_date": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")
Copy
const sourceGithubResource = new airbyte.SourceGithub("sourceGithubResource", {
    configuration: {
        credentials: {
            oAuth: {
                accessToken: "string",
                clientId: "string",
                clientSecret: "string",
            },
            personalAccessToken: {
                personalAccessToken: "string",
            },
        },
        repositories: ["string"],
        apiUrl: "string",
        branches: ["string"],
        maxWaitingTime: 0,
        startDate: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});
Copy
type: airbyte:SourceGithub
properties:
    configuration:
        apiUrl: string
        branches:
            - string
        credentials:
            oAuth:
                accessToken: string
                clientId: string
                clientSecret: string
            personalAccessToken:
                personalAccessToken: string
        maxWaitingTime: 0
        repositories:
            - string
        startDate: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string
Copy

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 This property is required. SourceGithubConfiguration
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. SourceGithubConfigurationArgs
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. SourceGithubConfiguration
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. SourceGithubConfiguration
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. SourceGithubConfigurationArgs
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 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 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 SourceGithubConfiguration
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 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
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 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
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 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
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 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
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 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
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

SourceGithubConfiguration
, SourceGithubConfigurationArgs

Credentials This property is required. SourceGithubConfigurationCredentials
Choose how to authenticate to GitHub
Repositories This property is required. 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.
ApiUrl string
Please enter your basic URL from self-hosted GitHub instance or leave it empty to use GitHub. Default: "https://api.github.com/"
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
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 This property is required. SourceGithubConfigurationCredentials
Choose how to authenticate to GitHub
Repositories This property is required. []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.
ApiUrl string
Please enter your basic URL from self-hosted GitHub instance or leave it empty to use GitHub. Default: "https://api.github.com/"
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
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 This property is required. SourceGithubConfigurationCredentials
Choose how to authenticate to GitHub
repositories This property is required. 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.
apiUrl String
Please enter your basic URL from self-hosted GitHub instance or leave it empty to use GitHub. Default: "https://api.github.com/"
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
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 This property is required. SourceGithubConfigurationCredentials
Choose how to authenticate to GitHub
repositories This property is required. 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.
apiUrl string
Please enter your basic URL from self-hosted GitHub instance or leave it empty to use GitHub. Default: "https://api.github.com/"
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
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 This property is required. SourceGithubConfigurationCredentials
Choose how to authenticate to GitHub
repositories This property is required. 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.
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/"
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
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 This property is required. Property Map
Choose how to authenticate to GitHub
repositories This property is required. 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.
apiUrl String
Please enter your basic URL from self-hosted GitHub instance or leave it empty to use GitHub. Default: "https://api.github.com/"
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
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

SourceGithubConfigurationCredentialsOAuth
, SourceGithubConfigurationCredentialsOAuthArgs

AccessToken This property is required. string
OAuth access token
ClientId string
OAuth Client Id
ClientSecret string
OAuth Client secret
AccessToken This property is required. string
OAuth access token
ClientId string
OAuth Client Id
ClientSecret string
OAuth Client secret
accessToken This property is required. String
OAuth access token
clientId String
OAuth Client Id
clientSecret String
OAuth Client secret
accessToken This property is required. string
OAuth access token
clientId string
OAuth Client Id
clientSecret string
OAuth Client secret
access_token This property is required. str
OAuth access token
client_id str
OAuth Client Id
client_secret str
OAuth Client secret
accessToken This property is required. String
OAuth access token
clientId String
OAuth Client Id
clientSecret String
OAuth Client secret

SourceGithubConfigurationCredentialsPersonalAccessToken
, SourceGithubConfigurationCredentialsPersonalAccessTokenArgs

PersonalAccessToken This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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

SourceGithubResourceAllocationJobSpecific
, SourceGithubResourceAllocationJobSpecificArgs

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 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. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
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. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
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. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
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. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
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. 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)

SourceGithubResourceAllocationJobSpecificResourceRequirements
, SourceGithubResourceAllocationJobSpecificResourceRequirementsArgs

Import

$ pulumi import airbyte:index/sourceGithub:SourceGithub my_airbyte_source_github ""
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.