airbyte 0.10.0, Apr 14 25

airbyte 0.10.0 published on Monday, Apr 14, 2025 by airbytehq

airbyte.SourceDefinition

Explore with Pulumi AI

airbyte 0.10.0 published on Monday, Apr 14, 2025 by airbytehq

Example Usage

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

const mySourcedefinition = new airbyte.SourceDefinition("mySourcedefinition", {
    dockerImageTag: "...my_docker_image_tag...",
    dockerRepository: "...my_docker_repository...",
    documentationUrl: "https://fuzzy-alert.name/",
    workspaceId: "2f247b56-4c74-41ae-8045-9f64dd27512e",
});

import pulumi
import pulumi_airbyte as airbyte

my_sourcedefinition = airbyte.SourceDefinition("mySourcedefinition",
    docker_image_tag="...my_docker_image_tag...",
    docker_repository="...my_docker_repository...",
    documentation_url="https://fuzzy-alert.name/",
    workspace_id="2f247b56-4c74-41ae-8045-9f64dd27512e")

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.NewSourceDefinition(ctx, "mySourcedefinition", &airbyte.SourceDefinitionArgs{
			DockerImageTag:   pulumi.String("...my_docker_image_tag..."),
			DockerRepository: pulumi.String("...my_docker_repository..."),
			DocumentationUrl: pulumi.String("https://fuzzy-alert.name/"),
			WorkspaceId:      pulumi.String("2f247b56-4c74-41ae-8045-9f64dd27512e"),
		})
		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 mySourcedefinition = new Airbyte.SourceDefinition("mySourcedefinition", new()
    {
        DockerImageTag = "...my_docker_image_tag...",
        DockerRepository = "...my_docker_repository...",
        DocumentationUrl = "https://fuzzy-alert.name/",
        WorkspaceId = "2f247b56-4c74-41ae-8045-9f64dd27512e",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.airbyte.SourceDefinition;
import com.pulumi.airbyte.SourceDefinitionArgs;
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 mySourcedefinition = new SourceDefinition("mySourcedefinition", SourceDefinitionArgs.builder()
            .dockerImageTag("...my_docker_image_tag...")
            .dockerRepository("...my_docker_repository...")
            .documentationUrl("https://fuzzy-alert.name/")
            .workspaceId("2f247b56-4c74-41ae-8045-9f64dd27512e")
            .build());

    }
}

resources:
  mySourcedefinition:
    type: airbyte:SourceDefinition
    properties:
      dockerImageTag: '...my_docker_image_tag...'
      dockerRepository: '...my_docker_repository...'
      documentationUrl: https://fuzzy-alert.name/
      workspaceId: 2f247b56-4c74-41ae-8045-9f64dd27512e

Create SourceDefinition Resource

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

Constructor syntax

new SourceDefinition(name: string, args: SourceDefinitionArgs, opts?: CustomResourceOptions);

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

@overload
def SourceDefinition(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     docker_image_tag: Optional[str] = None,
                     docker_repository: Optional[str] = None,
                     workspace_id: Optional[str] = None,
                     documentation_url: Optional[str] = None,
                     name: Optional[str] = None)

func NewSourceDefinition(ctx *Context, name string, args SourceDefinitionArgs, opts ...ResourceOption) (*SourceDefinition, error)

public SourceDefinition(string name, SourceDefinitionArgs args, CustomResourceOptions? opts = null)

public SourceDefinition(String name, SourceDefinitionArgs args)
public SourceDefinition(String name, SourceDefinitionArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args SourceDefinitionArgs: 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 sourceDefinitionResource = new Airbyte.SourceDefinition("sourceDefinitionResource", new()
{
    DockerImageTag = "string",
    DockerRepository = "string",
    WorkspaceId = "string",
    DocumentationUrl = "string",
    Name = "string",
});

example, err := airbyte.NewSourceDefinition(ctx, "sourceDefinitionResource", &airbyte.SourceDefinitionArgs{
	DockerImageTag:   pulumi.String("string"),
	DockerRepository: pulumi.String("string"),
	WorkspaceId:      pulumi.String("string"),
	DocumentationUrl: pulumi.String("string"),
	Name:             pulumi.String("string"),
})

var sourceDefinitionResource = new SourceDefinition("sourceDefinitionResource", SourceDefinitionArgs.builder()
    .dockerImageTag("string")
    .dockerRepository("string")
    .workspaceId("string")
    .documentationUrl("string")
    .name("string")
    .build());

source_definition_resource = airbyte.SourceDefinition("sourceDefinitionResource",
    docker_image_tag="string",
    docker_repository="string",
    workspace_id="string",
    documentation_url="string",
    name="string")

const sourceDefinitionResource = new airbyte.SourceDefinition("sourceDefinitionResource", {
    dockerImageTag: "string",
    dockerRepository: "string",
    workspaceId: "string",
    documentationUrl: "string",
    name: "string",
});

type: airbyte:SourceDefinition
properties:
    dockerImageTag: string
    dockerRepository: string
    documentationUrl: string
    name: string
    workspaceId: string

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

DockerImageTag string
DockerRepository string: Requires replacement if changed.
WorkspaceId string
DocumentationUrl string: Requires replacement if changed.
Name string

DockerImageTag string
DockerRepository string: Requires replacement if changed.
WorkspaceId string
DocumentationUrl string: Requires replacement if changed.
Name string

dockerImageTag String
dockerRepository String: Requires replacement if changed.
workspaceId String
documentationUrl String: Requires replacement if changed.
name String

dockerImageTag string
dockerRepository string: Requires replacement if changed.
workspaceId string
documentationUrl string: Requires replacement if changed.
name string

docker_image_tag str
docker_repository str: Requires replacement if changed.
workspace_id str
documentation_url str: Requires replacement if changed.
name str

dockerImageTag String
dockerRepository String: Requires replacement if changed.
workspaceId String
documentationUrl String: Requires replacement if changed.
name String

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing SourceDefinition Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        docker_image_tag: Optional[str] = None,
        docker_repository: Optional[str] = None,
        documentation_url: Optional[str] = None,
        name: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourceDefinition

func GetSourceDefinition(ctx *Context, name string, id IDInput, state *SourceDefinitionState, opts ...ResourceOption) (*SourceDefinition, error)

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

public static SourceDefinition get(String name, Output<String> id, SourceDefinitionState state, CustomResourceOptions options)

resources:  _:    type: airbyte:SourceDefinition    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:

DockerImageTag string
DockerRepository string: Requires replacement if changed.
DocumentationUrl string: Requires replacement if changed.
Name string
WorkspaceId string

DockerImageTag string
DockerRepository string: Requires replacement if changed.
DocumentationUrl string: Requires replacement if changed.
Name string
WorkspaceId string

dockerImageTag String
dockerRepository String: Requires replacement if changed.
documentationUrl String: Requires replacement if changed.
name String
workspaceId String

dockerImageTag string
dockerRepository string: Requires replacement if changed.
documentationUrl string: Requires replacement if changed.
name string
workspaceId string

docker_image_tag str
docker_repository str: Requires replacement if changed.
documentation_url str: Requires replacement if changed.
name str
workspace_id str

dockerImageTag String
dockerRepository String: Requires replacement if changed.
documentationUrl String: Requires replacement if changed.
name String
workspaceId String

Import

$ pulumi import airbyte:index/sourceDefinition:SourceDefinition my_airbyte_source_definition "{ \"definition_id\": \"\", \"workspace_id\": \"\"}"

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.10.0 published on Monday, Apr 14, 2025 by airbytehq

airbytehq/terraform-provider-airbyte

airbyte.SourceDefinition

On this page

On this page

Example Usage

Create SourceDefinition Resource

Constructor syntax

Parameters

Constructor example

SourceDefinition Resource Properties

Inputs

Outputs

Look up Existing SourceDefinition Resource

Import

Package Details

On this page

On this page