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

airbyte.DestinationDefinition

Explore with Pulumi AI

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

    DestinationDefinition Resource

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as airbyte from "@pulumi/airbyte";
    
    const myDestinationdefinition = new airbyte.DestinationDefinition("myDestinationdefinition", {
        dockerImageTag: "...my_docker_image_tag...",
        dockerRepository: "...my_docker_repository...",
        documentationUrl: "https://tidy-newsprint.name",
        workspaceId: "b2d427cd-1e14-44a7-9eca-d09b2237ee28",
    });
    
    import pulumi
    import pulumi_airbyte as airbyte
    
    my_destinationdefinition = airbyte.DestinationDefinition("myDestinationdefinition",
        docker_image_tag="...my_docker_image_tag...",
        docker_repository="...my_docker_repository...",
        documentation_url="https://tidy-newsprint.name",
        workspace_id="b2d427cd-1e14-44a7-9eca-d09b2237ee28")
    
    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.NewDestinationDefinition(ctx, "myDestinationdefinition", &airbyte.DestinationDefinitionArgs{
    			DockerImageTag:   pulumi.String("...my_docker_image_tag..."),
    			DockerRepository: pulumi.String("...my_docker_repository..."),
    			DocumentationUrl: pulumi.String("https://tidy-newsprint.name"),
    			WorkspaceId:      pulumi.String("b2d427cd-1e14-44a7-9eca-d09b2237ee28"),
    		})
    		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 myDestinationdefinition = new Airbyte.DestinationDefinition("myDestinationdefinition", new()
        {
            DockerImageTag = "...my_docker_image_tag...",
            DockerRepository = "...my_docker_repository...",
            DocumentationUrl = "https://tidy-newsprint.name",
            WorkspaceId = "b2d427cd-1e14-44a7-9eca-d09b2237ee28",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.airbyte.DestinationDefinition;
    import com.pulumi.airbyte.DestinationDefinitionArgs;
    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 myDestinationdefinition = new DestinationDefinition("myDestinationdefinition", DestinationDefinitionArgs.builder()
                .dockerImageTag("...my_docker_image_tag...")
                .dockerRepository("...my_docker_repository...")
                .documentationUrl("https://tidy-newsprint.name")
                .workspaceId("b2d427cd-1e14-44a7-9eca-d09b2237ee28")
                .build());
    
        }
    }
    
    resources:
      myDestinationdefinition:
        type: airbyte:DestinationDefinition
        properties:
          dockerImageTag: '...my_docker_image_tag...'
          dockerRepository: '...my_docker_repository...'
          documentationUrl: https://tidy-newsprint.name
          workspaceId: b2d427cd-1e14-44a7-9eca-d09b2237ee28
    

    Create DestinationDefinition Resource

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

    Constructor syntax

    new DestinationDefinition(name: string, args: DestinationDefinitionArgs, opts?: CustomResourceOptions);
    @overload
    def DestinationDefinition(resource_name: str,
                              args: DestinationDefinitionArgs,
                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def DestinationDefinition(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 NewDestinationDefinition(ctx *Context, name string, args DestinationDefinitionArgs, opts ...ResourceOption) (*DestinationDefinition, error)
    public DestinationDefinition(string name, DestinationDefinitionArgs args, CustomResourceOptions? opts = null)
    public DestinationDefinition(String name, DestinationDefinitionArgs args)
    public DestinationDefinition(String name, DestinationDefinitionArgs args, CustomResourceOptions options)
    
    type: airbyte:DestinationDefinition
    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 DestinationDefinitionArgs
    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 DestinationDefinitionArgs
    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 DestinationDefinitionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DestinationDefinitionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DestinationDefinitionArgs
    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 destinationDefinitionResource = new Airbyte.DestinationDefinition("destinationDefinitionResource", new()
    {
        DockerImageTag = "string",
        DockerRepository = "string",
        WorkspaceId = "string",
        DocumentationUrl = "string",
        Name = "string",
    });
    
    example, err := airbyte.NewDestinationDefinition(ctx, "destinationDefinitionResource", &airbyte.DestinationDefinitionArgs{
    	DockerImageTag:   pulumi.String("string"),
    	DockerRepository: pulumi.String("string"),
    	WorkspaceId:      pulumi.String("string"),
    	DocumentationUrl: pulumi.String("string"),
    	Name:             pulumi.String("string"),
    })
    
    var destinationDefinitionResource = new DestinationDefinition("destinationDefinitionResource", DestinationDefinitionArgs.builder()
        .dockerImageTag("string")
        .dockerRepository("string")
        .workspaceId("string")
        .documentationUrl("string")
        .name("string")
        .build());
    
    destination_definition_resource = airbyte.DestinationDefinition("destinationDefinitionResource",
        docker_image_tag="string",
        docker_repository="string",
        workspace_id="string",
        documentation_url="string",
        name="string")
    
    const destinationDefinitionResource = new airbyte.DestinationDefinition("destinationDefinitionResource", {
        dockerImageTag: "string",
        dockerRepository: "string",
        workspaceId: "string",
        documentationUrl: "string",
        name: "string",
    });
    
    type: airbyte:DestinationDefinition
    properties:
        dockerImageTag: string
        dockerRepository: string
        documentationUrl: string
        name: string
        workspaceId: string
    

    DestinationDefinition 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 DestinationDefinition 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 DestinationDefinition 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 DestinationDefinition Resource

    Get an existing DestinationDefinition 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?: DestinationDefinitionState, opts?: CustomResourceOptions): DestinationDefinition
    @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) -> DestinationDefinition
    func GetDestinationDefinition(ctx *Context, name string, id IDInput, state *DestinationDefinitionState, opts ...ResourceOption) (*DestinationDefinition, error)
    public static DestinationDefinition Get(string name, Input<string> id, DestinationDefinitionState? state, CustomResourceOptions? opts = null)
    public static DestinationDefinition get(String name, Output<String> id, DestinationDefinitionState state, CustomResourceOptions options)
    resources:  _:    type: airbyte:DestinationDefinition    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/destinationDefinition:DestinationDefinition my_airbyte_destination_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