airbyte 0.7.0-beta2, Mar 7 25

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

airbyte.SourceCircleci

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.SourceCircleci;
import com.pulumi.airbyte.SourceCircleciArgs;
import com.pulumi.airbyte.inputs.SourceCircleciConfigurationArgs;
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 mySourceCircleci = new SourceCircleci("mySourceCircleci", SourceCircleciArgs.builder()
            .configuration(SourceCircleciConfigurationArgs.builder()
                .api_key("...my_api_key...")
                .job_number("...my_job_number...")
                .org_id("...my_org_id...")
                .project_id("...my_project_id...")
                .start_date("2021-12-24T02:44:42.906Z")
                .workflow_id("{ \"see\": \"documentation\" }")
                .build())
            .definitionId("53783c47-5321-4ea7-8d4a-f5c8e6914d08")
            .secretId("...my_secret_id...")
            .workspaceId("bcfd7b44-f6fc-40b7-b657-769d9b08d9e7")
            .build());

    }
}

resources:
  mySourceCircleci:
    type: airbyte:SourceCircleci
    properties:
      configuration:
        api_key: '...my_api_key...'
        job_number: '...my_job_number...'
        org_id: '...my_org_id...'
        project_id: '...my_project_id...'
        start_date: 2021-12-24T02:44:42.906Z
        workflow_id:
          - '{ "see": "documentation" }'
      definitionId: 53783c47-5321-4ea7-8d4a-f5c8e6914d08
      secretId: '...my_secret_id...'
      workspaceId: bcfd7b44-f6fc-40b7-b657-769d9b08d9e7

Create SourceCircleci Resource

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

Constructor syntax

new SourceCircleci(name: string, args: SourceCircleciArgs, opts?: CustomResourceOptions);

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

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

func NewSourceCircleci(ctx *Context, name string, args SourceCircleciArgs, opts ...ResourceOption) (*SourceCircleci, error)

public SourceCircleci(string name, SourceCircleciArgs args, CustomResourceOptions? opts = null)

public SourceCircleci(String name, SourceCircleciArgs args)
public SourceCircleci(String name, SourceCircleciArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args SourceCircleciArgs: 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 sourceCircleciResource = new Airbyte.SourceCircleci("sourceCircleciResource", new()
{
    Configuration = new Airbyte.Inputs.SourceCircleciConfigurationArgs
    {
        ApiKey = "string",
        OrgId = "string",
        ProjectId = "string",
        StartDate = "string",
        JobNumber = "string",
        WorkflowIds = new[]
        {
            "string",
        },
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

example, err := airbyte.NewSourceCircleci(ctx, "sourceCircleciResource", &airbyte.SourceCircleciArgs{
Configuration: &.SourceCircleciConfigurationArgs{
ApiKey: pulumi.String("string"),
OrgId: pulumi.String("string"),
ProjectId: pulumi.String("string"),
StartDate: pulumi.String("string"),
JobNumber: pulumi.String("string"),
WorkflowIds: pulumi.StringArray{
pulumi.String("string"),
},
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

var sourceCircleciResource = new SourceCircleci("sourceCircleciResource", SourceCircleciArgs.builder()
    .configuration(SourceCircleciConfigurationArgs.builder()
        .apiKey("string")
        .orgId("string")
        .projectId("string")
        .startDate("string")
        .jobNumber("string")
        .workflowIds("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

source_circleci_resource = airbyte.SourceCircleci("sourceCircleciResource",
    configuration={
        "api_key": "string",
        "org_id": "string",
        "project_id": "string",
        "start_date": "string",
        "job_number": "string",
        "workflow_ids": ["string"],
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

const sourceCircleciResource = new airbyte.SourceCircleci("sourceCircleciResource", {
    configuration: {
        apiKey: "string",
        orgId: "string",
        projectId: "string",
        startDate: "string",
        jobNumber: "string",
        workflowIds: ["string"],
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

type: airbyte:SourceCircleci
properties:
    configuration:
        apiKey: string
        jobNumber: string
        orgId: string
        projectId: string
        startDate: string
        workflowIds:
            - string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

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

Configuration SourceCircleciConfiguration
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 SourceCircleciConfigurationArgs
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 SourceCircleciConfiguration
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 SourceCircleciConfiguration
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 SourceCircleciConfigurationArgs
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 SourceCircleci 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 SourceCircleci Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceCircleciConfigurationArgs] = 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) -> SourceCircleci

func GetSourceCircleci(ctx *Context, name string, id IDInput, state *SourceCircleciState, opts ...ResourceOption) (*SourceCircleci, error)

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

public static SourceCircleci get(String name, Output<String> id, SourceCircleciState state, CustomResourceOptions options)

resources:  _:    type: airbyte:SourceCircleci    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 SourceCircleciConfiguration
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 SourceCircleciConfigurationArgs
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 SourceCircleciConfiguration
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 SourceCircleciConfiguration
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 SourceCircleciConfigurationArgs
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

SourceCircleciConfiguration, SourceCircleciConfigurationArgs

ApiKey string
OrgId string: The org ID found in https://app.circleci.com/settings/organization/circleci/xxxxx/overview
ProjectId string: Project ID found in the project settings, Visit https://app.circleci.com/settings/project/circleci/ORG_SLUG/YYYYY
StartDate string
JobNumber string: Job Number of the workflow for jobs stream, Auto fetches from workflow_jobs stream, if not configured. Default: "2"
WorkflowIds List<string>: Workflow ID of a project pipeline, Could be seen in the URL of pipeline build, Example https://app.circleci.com/pipelines/circleci/55555xxxxxx/7yyyyyyyyxxxxx/2/workflows/WORKFLOW_ID

ApiKey string
OrgId string: The org ID found in https://app.circleci.com/settings/organization/circleci/xxxxx/overview
ProjectId string: Project ID found in the project settings, Visit https://app.circleci.com/settings/project/circleci/ORG_SLUG/YYYYY
StartDate string
JobNumber string: Job Number of the workflow for jobs stream, Auto fetches from workflow_jobs stream, if not configured. Default: "2"
WorkflowIds []string: Workflow ID of a project pipeline, Could be seen in the URL of pipeline build, Example https://app.circleci.com/pipelines/circleci/55555xxxxxx/7yyyyyyyyxxxxx/2/workflows/WORKFLOW_ID

apiKey String
orgId String: The org ID found in https://app.circleci.com/settings/organization/circleci/xxxxx/overview
projectId String: Project ID found in the project settings, Visit https://app.circleci.com/settings/project/circleci/ORG_SLUG/YYYYY
startDate String
jobNumber String: Job Number of the workflow for jobs stream, Auto fetches from workflow_jobs stream, if not configured. Default: "2"
workflowIds List<String>: Workflow ID of a project pipeline, Could be seen in the URL of pipeline build, Example https://app.circleci.com/pipelines/circleci/55555xxxxxx/7yyyyyyyyxxxxx/2/workflows/WORKFLOW_ID

apiKey string
orgId string: The org ID found in https://app.circleci.com/settings/organization/circleci/xxxxx/overview
projectId string: Project ID found in the project settings, Visit https://app.circleci.com/settings/project/circleci/ORG_SLUG/YYYYY
startDate string
jobNumber string: Job Number of the workflow for jobs stream, Auto fetches from workflow_jobs stream, if not configured. Default: "2"
workflowIds string[]: Workflow ID of a project pipeline, Could be seen in the URL of pipeline build, Example https://app.circleci.com/pipelines/circleci/55555xxxxxx/7yyyyyyyyxxxxx/2/workflows/WORKFLOW_ID

api_key str
org_id str: The org ID found in https://app.circleci.com/settings/organization/circleci/xxxxx/overview
project_id str: Project ID found in the project settings, Visit https://app.circleci.com/settings/project/circleci/ORG_SLUG/YYYYY
start_date str
job_number str: Job Number of the workflow for jobs stream, Auto fetches from workflow_jobs stream, if not configured. Default: "2"
workflow_ids Sequence[str]: Workflow ID of a project pipeline, Could be seen in the URL of pipeline build, Example https://app.circleci.com/pipelines/circleci/55555xxxxxx/7yyyyyyyyxxxxx/2/workflows/WORKFLOW_ID

apiKey String
orgId String: The org ID found in https://app.circleci.com/settings/organization/circleci/xxxxx/overview
projectId String: Project ID found in the project settings, Visit https://app.circleci.com/settings/project/circleci/ORG_SLUG/YYYYY
startDate String
jobNumber String: Job Number of the workflow for jobs stream, Auto fetches from workflow_jobs stream, if not configured. Default: "2"
workflowIds List<String>: Workflow ID of a project pipeline, Could be seen in the URL of pipeline build, Example https://app.circleci.com/pipelines/circleci/55555xxxxxx/7yyyyyyyyxxxxx/2/workflows/WORKFLOW_ID

Import

$ pulumi import airbyte:index/sourceCircleci:SourceCircleci my_airbyte_source_circleci ""

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.SourceCircleci

On this page

On this page

Example Usage

Create SourceCircleci Resource

Constructor syntax

Parameters

Constructor example

SourceCircleci Resource Properties

Inputs

Outputs

Look up Existing SourceCircleci Resource

Supporting Types

SourceCircleciConfiguration, SourceCircleciConfigurationArgs

Import

Package Details

On this page

On this page