airbyte 0.7.0-beta2, Mar 7 25

airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

airbyte.SourceJira

Explore with Pulumi AI

airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

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.SourceJira;
import com.pulumi.airbyte.SourceJiraArgs;
import com.pulumi.airbyte.inputs.SourceJiraConfigurationArgs;
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 mySourceJira = new SourceJira("mySourceJira", SourceJiraArgs.builder()
            .configuration(SourceJiraConfigurationArgs.builder()
                .api_token("...my_api_token...")
                .domain("<your-domain>.atlassian.net")
                .email("...my_email...")
                .enable_experimental_streams(false)
                .lookback_window_minutes(60)
                .num_workers(1)
                .projects("...")
                .start_date("2021-03-01T00:00:00Z")
                .build())
            .definitionId("949473c3-da2c-444e-bfcd-8f8d84c88b15")
            .secretId("...my_secret_id...")
            .workspaceId("126f780d-bef6-41d4-af4f-97391ac97b8d")
            .build());

    }
}

resources:
  mySourceJira:
    type: airbyte:SourceJira
    properties:
      configuration:
        api_token: '...my_api_token...'
        domain: <your-domain>.atlassian.net
        email: '...my_email...'
        enable_experimental_streams: false
        lookback_window_minutes: 60
        num_workers: 1
        projects:
          - '...'
        start_date: 2021-03-01T00:00:00Z
      definitionId: 949473c3-da2c-444e-bfcd-8f8d84c88b15
      secretId: '...my_secret_id...'
      workspaceId: 126f780d-bef6-41d4-af4f-97391ac97b8d

Create SourceJira Resource

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

Constructor syntax

new SourceJira(name: string, args: SourceJiraArgs, opts?: CustomResourceOptions);

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

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

func NewSourceJira(ctx *Context, name string, args SourceJiraArgs, opts ...ResourceOption) (*SourceJira, error)

public SourceJira(string name, SourceJiraArgs args, CustomResourceOptions? opts = null)

public SourceJira(String name, SourceJiraArgs args)
public SourceJira(String name, SourceJiraArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args SourceJiraArgs: 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 sourceJiraResource = new Airbyte.SourceJira("sourceJiraResource", new()
{
    Configuration = new Airbyte.Inputs.SourceJiraConfigurationArgs
    {
        ApiToken = "string",
        Domain = "string",
        Email = "string",
        EnableExperimentalStreams = false,
        LookbackWindowMinutes = 0,
        NumWorkers = 0,
        Projects = new[]
        {
            "string",
        },
        StartDate = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

example, err := airbyte.NewSourceJira(ctx, "sourceJiraResource", &airbyte.SourceJiraArgs{
Configuration: &.SourceJiraConfigurationArgs{
ApiToken: pulumi.String("string"),
Domain: pulumi.String("string"),
Email: pulumi.String("string"),
EnableExperimentalStreams: pulumi.Bool(false),
LookbackWindowMinutes: pulumi.Float64(0),
NumWorkers: pulumi.Float64(0),
Projects: pulumi.StringArray{
pulumi.String("string"),
},
StartDate: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

var sourceJiraResource = new SourceJira("sourceJiraResource", SourceJiraArgs.builder()
    .configuration(SourceJiraConfigurationArgs.builder()
        .apiToken("string")
        .domain("string")
        .email("string")
        .enableExperimentalStreams(false)
        .lookbackWindowMinutes(0)
        .numWorkers(0)
        .projects("string")
        .startDate("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

source_jira_resource = airbyte.SourceJira("sourceJiraResource",
    configuration={
        "api_token": "string",
        "domain": "string",
        "email": "string",
        "enable_experimental_streams": False,
        "lookback_window_minutes": 0,
        "num_workers": 0,
        "projects": ["string"],
        "start_date": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

const sourceJiraResource = new airbyte.SourceJira("sourceJiraResource", {
    configuration: {
        apiToken: "string",
        domain: "string",
        email: "string",
        enableExperimentalStreams: false,
        lookbackWindowMinutes: 0,
        numWorkers: 0,
        projects: ["string"],
        startDate: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

type: airbyte:SourceJira
properties:
    configuration:
        apiToken: string
        domain: string
        email: string
        enableExperimentalStreams: false
        lookbackWindowMinutes: 0
        numWorkers: 0
        projects:
            - string
        startDate: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

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

Configuration SourceJiraConfiguration
WorkspaceId string
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Configuration SourceJiraConfigurationArgs
WorkspaceId string
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration SourceJiraConfiguration
workspaceId String
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration SourceJiraConfiguration
workspaceId string
definitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name string: Name of the source e.g. dev-mysql-instance.
secretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration SourceJiraConfigurationArgs
workspace_id str
definition_id str: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name str: Name of the source e.g. dev-mysql-instance.
secret_id str: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration Property Map
workspaceId String
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Outputs

All input properties are implicitly available as output properties. Additionally, the SourceJira resource produces the following output properties:

CreatedAt double
Id string: The provider-assigned unique ID for this managed resource.
SourceId string
SourceType string

CreatedAt float64
Id string: The provider-assigned unique ID for this managed resource.
SourceId string
SourceType string

createdAt Double
id String: The provider-assigned unique ID for this managed resource.
sourceId String
sourceType String

createdAt number
id string: The provider-assigned unique ID for this managed resource.
sourceId string
sourceType string

created_at float
id str: The provider-assigned unique ID for this managed resource.
source_id str
source_type str

createdAt Number
id String: The provider-assigned unique ID for this managed resource.
sourceId String
sourceType String

Look up Existing SourceJira Resource

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

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

func GetSourceJira(ctx *Context, name string, id IDInput, state *SourceJiraState, opts ...ResourceOption) (*SourceJira, error)

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

public static SourceJira get(String name, Output<String> id, SourceJiraState state, CustomResourceOptions options)

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

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

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

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

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

Supporting Types

SourceJiraConfiguration, SourceJiraConfigurationArgs

ApiToken string: Jira API Token. See the \n\ndocs\n\n for more information on how to generate this key. API Token is used for Authorization to your account by BasicAuth.
Domain string: The Domain for your Jira account, e.g. airbyteio.atlassian.net, airbyteio.jira.com, jira.your-domain.com
Email string: The user email for your Jira account which you used to generate the API token. This field is used for Authorization to your account by BasicAuth.
EnableExperimentalStreams bool: Allow the use of experimental streams which rely on undocumented Jira API endpoints. See https://docs.airbyte.com/integrations/sources/jira#experimental-tables for more info. Default: false
LookbackWindowMinutes double: When set to N, the connector will always refresh resources created within the past N minutes. By default, updated objects that are not newly created are not incrementally synced. Default: 0
NumWorkers double: The number of worker threads to use for the sync. Default: 3
Projects List<string>: List of Jira project keys to replicate data for, or leave it empty if you want to replicate data for all projects.
StartDate string: The date from which you want to replicate data from Jira, use the format YYYY-MM-DDT00:00:00Z. Note that this field only applies to certain streams, and only data generated on or after the start date will be replicated. Or leave it empty if you want to replicate all data. For more information, refer to the \n\ndocumentation\n\n.

ApiToken string: Jira API Token. See the \n\ndocs\n\n for more information on how to generate this key. API Token is used for Authorization to your account by BasicAuth.
Domain string: The Domain for your Jira account, e.g. airbyteio.atlassian.net, airbyteio.jira.com, jira.your-domain.com
Email string: The user email for your Jira account which you used to generate the API token. This field is used for Authorization to your account by BasicAuth.
EnableExperimentalStreams bool: Allow the use of experimental streams which rely on undocumented Jira API endpoints. See https://docs.airbyte.com/integrations/sources/jira#experimental-tables for more info. Default: false
LookbackWindowMinutes float64: When set to N, the connector will always refresh resources created within the past N minutes. By default, updated objects that are not newly created are not incrementally synced. Default: 0
NumWorkers float64: The number of worker threads to use for the sync. Default: 3
Projects []string: List of Jira project keys to replicate data for, or leave it empty if you want to replicate data for all projects.
StartDate string: The date from which you want to replicate data from Jira, use the format YYYY-MM-DDT00:00:00Z. Note that this field only applies to certain streams, and only data generated on or after the start date will be replicated. Or leave it empty if you want to replicate all data. For more information, refer to the \n\ndocumentation\n\n.

apiToken String: Jira API Token. See the \n\ndocs\n\n for more information on how to generate this key. API Token is used for Authorization to your account by BasicAuth.
domain String: The Domain for your Jira account, e.g. airbyteio.atlassian.net, airbyteio.jira.com, jira.your-domain.com
email String: The user email for your Jira account which you used to generate the API token. This field is used for Authorization to your account by BasicAuth.
enableExperimentalStreams Boolean: Allow the use of experimental streams which rely on undocumented Jira API endpoints. See https://docs.airbyte.com/integrations/sources/jira#experimental-tables for more info. Default: false
lookbackWindowMinutes Double: When set to N, the connector will always refresh resources created within the past N minutes. By default, updated objects that are not newly created are not incrementally synced. Default: 0
numWorkers Double: The number of worker threads to use for the sync. Default: 3
projects List<String>: List of Jira project keys to replicate data for, or leave it empty if you want to replicate data for all projects.
startDate String: The date from which you want to replicate data from Jira, use the format YYYY-MM-DDT00:00:00Z. Note that this field only applies to certain streams, and only data generated on or after the start date will be replicated. Or leave it empty if you want to replicate all data. For more information, refer to the \n\ndocumentation\n\n.

apiToken string: Jira API Token. See the \n\ndocs\n\n for more information on how to generate this key. API Token is used for Authorization to your account by BasicAuth.
domain string: The Domain for your Jira account, e.g. airbyteio.atlassian.net, airbyteio.jira.com, jira.your-domain.com
email string: The user email for your Jira account which you used to generate the API token. This field is used for Authorization to your account by BasicAuth.
enableExperimentalStreams boolean: Allow the use of experimental streams which rely on undocumented Jira API endpoints. See https://docs.airbyte.com/integrations/sources/jira#experimental-tables for more info. Default: false
lookbackWindowMinutes number: When set to N, the connector will always refresh resources created within the past N minutes. By default, updated objects that are not newly created are not incrementally synced. Default: 0
numWorkers number: The number of worker threads to use for the sync. Default: 3
projects string[]: List of Jira project keys to replicate data for, or leave it empty if you want to replicate data for all projects.
startDate string: The date from which you want to replicate data from Jira, use the format YYYY-MM-DDT00:00:00Z. Note that this field only applies to certain streams, and only data generated on or after the start date will be replicated. Or leave it empty if you want to replicate all data. For more information, refer to the \n\ndocumentation\n\n.

api_token str: Jira API Token. See the \n\ndocs\n\n for more information on how to generate this key. API Token is used for Authorization to your account by BasicAuth.
domain str: The Domain for your Jira account, e.g. airbyteio.atlassian.net, airbyteio.jira.com, jira.your-domain.com
email str: The user email for your Jira account which you used to generate the API token. This field is used for Authorization to your account by BasicAuth.
enable_experimental_streams bool: Allow the use of experimental streams which rely on undocumented Jira API endpoints. See https://docs.airbyte.com/integrations/sources/jira#experimental-tables for more info. Default: false
lookback_window_minutes float: When set to N, the connector will always refresh resources created within the past N minutes. By default, updated objects that are not newly created are not incrementally synced. Default: 0
num_workers float: The number of worker threads to use for the sync. Default: 3
projects Sequence[str]: List of Jira project keys to replicate data for, or leave it empty if you want to replicate data for all projects.
start_date str: The date from which you want to replicate data from Jira, use the format YYYY-MM-DDT00:00:00Z. Note that this field only applies to certain streams, and only data generated on or after the start date will be replicated. Or leave it empty if you want to replicate all data. For more information, refer to the \n\ndocumentation\n\n.

apiToken String: Jira API Token. See the \n\ndocs\n\n for more information on how to generate this key. API Token is used for Authorization to your account by BasicAuth.
domain String: The Domain for your Jira account, e.g. airbyteio.atlassian.net, airbyteio.jira.com, jira.your-domain.com
email String: The user email for your Jira account which you used to generate the API token. This field is used for Authorization to your account by BasicAuth.
enableExperimentalStreams Boolean: Allow the use of experimental streams which rely on undocumented Jira API endpoints. See https://docs.airbyte.com/integrations/sources/jira#experimental-tables for more info. Default: false
lookbackWindowMinutes Number: When set to N, the connector will always refresh resources created within the past N minutes. By default, updated objects that are not newly created are not incrementally synced. Default: 0
numWorkers Number: The number of worker threads to use for the sync. Default: 3
projects List<String>: List of Jira project keys to replicate data for, or leave it empty if you want to replicate data for all projects.
startDate String: The date from which you want to replicate data from Jira, use the format YYYY-MM-DDT00:00:00Z. Note that this field only applies to certain streams, and only data generated on or after the start date will be replicated. Or leave it empty if you want to replicate all data. For more information, refer to the \n\ndocumentation\n\n.

Import

$ pulumi import airbyte:index/sourceJira:SourceJira my_airbyte_source_jira ""

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.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

airbytehq/terraform-provider-airbyte

airbyte.SourceJira

On this page

On this page

Example Usage

Create SourceJira Resource

Constructor syntax

Parameters

Constructor example

SourceJira Resource Properties

Inputs

Outputs

Look up Existing SourceJira Resource

Supporting Types

SourceJiraConfiguration, SourceJiraConfigurationArgs

Import

Package Details

On this page

On this page