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

airbyte.DeclarativeSourceDefinition

Explore with Pulumi AI

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

    DeclarativeSourceDefinition Resource

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as airbyte from "@pulumi/airbyte";
    
    const myDeclarativesourcedefinition = new airbyte.DeclarativeSourceDefinition("myDeclarativesourcedefinition", {
        manifest: "{ \"see\": \"documentation\" }",
        workspaceId: "e5279006-d3bf-4277-ada7-423cb18aaece",
    });
    
    import pulumi
    import pulumi_airbyte as airbyte
    
    my_declarativesourcedefinition = airbyte.DeclarativeSourceDefinition("myDeclarativesourcedefinition",
        manifest="{ \"see\": \"documentation\" }",
        workspace_id="e5279006-d3bf-4277-ada7-423cb18aaece")
    
    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.NewDeclarativeSourceDefinition(ctx, "myDeclarativesourcedefinition", &airbyte.DeclarativeSourceDefinitionArgs{
    			Manifest:    pulumi.String("{ \"see\": \"documentation\" }"),
    			WorkspaceId: pulumi.String("e5279006-d3bf-4277-ada7-423cb18aaece"),
    		})
    		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 myDeclarativesourcedefinition = new Airbyte.DeclarativeSourceDefinition("myDeclarativesourcedefinition", new()
        {
            Manifest = "{ \"see\": \"documentation\" }",
            WorkspaceId = "e5279006-d3bf-4277-ada7-423cb18aaece",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.airbyte.DeclarativeSourceDefinition;
    import com.pulumi.airbyte.DeclarativeSourceDefinitionArgs;
    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 myDeclarativesourcedefinition = new DeclarativeSourceDefinition("myDeclarativesourcedefinition", DeclarativeSourceDefinitionArgs.builder()
                .manifest("{ \"see\": \"documentation\" }")
                .workspaceId("e5279006-d3bf-4277-ada7-423cb18aaece")
                .build());
    
        }
    }
    
    resources:
      myDeclarativesourcedefinition:
        type: airbyte:DeclarativeSourceDefinition
        properties:
          manifest: '{ "see": "documentation" }'
          workspaceId: e5279006-d3bf-4277-ada7-423cb18aaece
    

    Create DeclarativeSourceDefinition Resource

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

    Constructor syntax

    new DeclarativeSourceDefinition(name: string, args: DeclarativeSourceDefinitionArgs, opts?: CustomResourceOptions);
    @overload
    def DeclarativeSourceDefinition(resource_name: str,
                                    args: DeclarativeSourceDefinitionArgs,
                                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def DeclarativeSourceDefinition(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    manifest: Optional[str] = None,
                                    workspace_id: Optional[str] = None,
                                    name: Optional[str] = None)
    func NewDeclarativeSourceDefinition(ctx *Context, name string, args DeclarativeSourceDefinitionArgs, opts ...ResourceOption) (*DeclarativeSourceDefinition, error)
    public DeclarativeSourceDefinition(string name, DeclarativeSourceDefinitionArgs args, CustomResourceOptions? opts = null)
    public DeclarativeSourceDefinition(String name, DeclarativeSourceDefinitionArgs args)
    public DeclarativeSourceDefinition(String name, DeclarativeSourceDefinitionArgs args, CustomResourceOptions options)
    
    type: airbyte:DeclarativeSourceDefinition
    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 DeclarativeSourceDefinitionArgs
    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 DeclarativeSourceDefinitionArgs
    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 DeclarativeSourceDefinitionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DeclarativeSourceDefinitionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DeclarativeSourceDefinitionArgs
    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 declarativeSourceDefinitionResource = new Airbyte.DeclarativeSourceDefinition("declarativeSourceDefinitionResource", new()
    {
        Manifest = "string",
        WorkspaceId = "string",
        Name = "string",
    });
    
    example, err := airbyte.NewDeclarativeSourceDefinition(ctx, "declarativeSourceDefinitionResource", &airbyte.DeclarativeSourceDefinitionArgs{
    	Manifest:    pulumi.String("string"),
    	WorkspaceId: pulumi.String("string"),
    	Name:        pulumi.String("string"),
    })
    
    var declarativeSourceDefinitionResource = new DeclarativeSourceDefinition("declarativeSourceDefinitionResource", DeclarativeSourceDefinitionArgs.builder()
        .manifest("string")
        .workspaceId("string")
        .name("string")
        .build());
    
    declarative_source_definition_resource = airbyte.DeclarativeSourceDefinition("declarativeSourceDefinitionResource",
        manifest="string",
        workspace_id="string",
        name="string")
    
    const declarativeSourceDefinitionResource = new airbyte.DeclarativeSourceDefinition("declarativeSourceDefinitionResource", {
        manifest: "string",
        workspaceId: "string",
        name: "string",
    });
    
    type: airbyte:DeclarativeSourceDefinition
    properties:
        manifest: string
        name: string
        workspaceId: string
    

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

    Manifest string
    Low code CDK manifest JSON object. Parsed as JSON.
    WorkspaceId string
    Name string
    Requires replacement if changed.
    Manifest string
    Low code CDK manifest JSON object. Parsed as JSON.
    WorkspaceId string
    Name string
    Requires replacement if changed.
    manifest String
    Low code CDK manifest JSON object. Parsed as JSON.
    workspaceId String
    name String
    Requires replacement if changed.
    manifest string
    Low code CDK manifest JSON object. Parsed as JSON.
    workspaceId string
    name string
    Requires replacement if changed.
    manifest str
    Low code CDK manifest JSON object. Parsed as JSON.
    workspace_id str
    name str
    Requires replacement if changed.
    manifest String
    Low code CDK manifest JSON object. Parsed as JSON.
    workspaceId String
    name String
    Requires replacement if changed.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Version double
    Id string
    The provider-assigned unique ID for this managed resource.
    Version float64
    id String
    The provider-assigned unique ID for this managed resource.
    version Double
    id string
    The provider-assigned unique ID for this managed resource.
    version number
    id str
    The provider-assigned unique ID for this managed resource.
    version float
    id String
    The provider-assigned unique ID for this managed resource.
    version Number

    Look up Existing DeclarativeSourceDefinition Resource

    Get an existing DeclarativeSourceDefinition 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?: DeclarativeSourceDefinitionState, opts?: CustomResourceOptions): DeclarativeSourceDefinition
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            manifest: Optional[str] = None,
            name: Optional[str] = None,
            version: Optional[float] = None,
            workspace_id: Optional[str] = None) -> DeclarativeSourceDefinition
    func GetDeclarativeSourceDefinition(ctx *Context, name string, id IDInput, state *DeclarativeSourceDefinitionState, opts ...ResourceOption) (*DeclarativeSourceDefinition, error)
    public static DeclarativeSourceDefinition Get(string name, Input<string> id, DeclarativeSourceDefinitionState? state, CustomResourceOptions? opts = null)
    public static DeclarativeSourceDefinition get(String name, Output<String> id, DeclarativeSourceDefinitionState state, CustomResourceOptions options)
    resources:  _:    type: airbyte:DeclarativeSourceDefinition    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:
    Manifest string
    Low code CDK manifest JSON object. Parsed as JSON.
    Name string
    Requires replacement if changed.
    Version double
    WorkspaceId string
    Manifest string
    Low code CDK manifest JSON object. Parsed as JSON.
    Name string
    Requires replacement if changed.
    Version float64
    WorkspaceId string
    manifest String
    Low code CDK manifest JSON object. Parsed as JSON.
    name String
    Requires replacement if changed.
    version Double
    workspaceId String
    manifest string
    Low code CDK manifest JSON object. Parsed as JSON.
    name string
    Requires replacement if changed.
    version number
    workspaceId string
    manifest str
    Low code CDK manifest JSON object. Parsed as JSON.
    name str
    Requires replacement if changed.
    version float
    workspace_id str
    manifest String
    Low code CDK manifest JSON object. Parsed as JSON.
    name String
    Requires replacement if changed.
    version Number
    workspaceId String

    Import

    $ pulumi import airbyte:index/declarativeSourceDefinition:DeclarativeSourceDefinition my_airbyte_declarative_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 logo
    airbyte 0.10.0 published on Monday, Apr 14, 2025 by airbytehq