airbyte 0.7.0-beta2, Mar 7 25

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

airbyte.DestinationPubsub

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.DestinationPubsub;
import com.pulumi.airbyte.DestinationPubsubArgs;
import com.pulumi.airbyte.inputs.DestinationPubsubConfigurationArgs;
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 myDestinationPubsub = new DestinationPubsub("myDestinationPubsub", DestinationPubsubArgs.builder()
            .configuration(DestinationPubsubConfigurationArgs.builder()
                .batching_delay_threshold(10)
                .batching_element_count_threshold(10)
                .batching_enabled(true)
                .batching_request_bytes_threshold(5)
                .credentials_json("...my_credentials_json...")
                .ordering_enabled(false)
                .project_id("...my_project_id...")
                .topic_id("...my_topic_id...")
                .build())
            .definitionId("df92d7e3-59fc-4984-811b-a60c95e88972")
            .workspaceId("d57f528a-f49b-4b8c-91c8-620eafc0353a")
            .build());

    }
}

resources:
  myDestinationPubsub:
    type: airbyte:DestinationPubsub
    properties:
      configuration:
        batching_delay_threshold: 10
        batching_element_count_threshold: 10
        batching_enabled: true
        batching_request_bytes_threshold: 5
        credentials_json: '...my_credentials_json...'
        ordering_enabled: false
        project_id: '...my_project_id...'
        topic_id: '...my_topic_id...'
      definitionId: df92d7e3-59fc-4984-811b-a60c95e88972
      workspaceId: d57f528a-f49b-4b8c-91c8-620eafc0353a

Create DestinationPubsub Resource

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

Constructor syntax

new DestinationPubsub(name: string, args: DestinationPubsubArgs, opts?: CustomResourceOptions);

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

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

func NewDestinationPubsub(ctx *Context, name string, args DestinationPubsubArgs, opts ...ResourceOption) (*DestinationPubsub, error)

public DestinationPubsub(string name, DestinationPubsubArgs args, CustomResourceOptions? opts = null)

public DestinationPubsub(String name, DestinationPubsubArgs args)
public DestinationPubsub(String name, DestinationPubsubArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args DestinationPubsubArgs: 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 destinationPubsubResource = new Airbyte.DestinationPubsub("destinationPubsubResource", new()
{
    Configuration = new Airbyte.Inputs.DestinationPubsubConfigurationArgs
    {
        CredentialsJson = "string",
        ProjectId = "string",
        TopicId = "string",
        BatchingDelayThreshold = 0,
        BatchingElementCountThreshold = 0,
        BatchingEnabled = false,
        BatchingRequestBytesThreshold = 0,
        OrderingEnabled = false,
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
});

example, err := airbyte.NewDestinationPubsub(ctx, "destinationPubsubResource", &airbyte.DestinationPubsubArgs{
Configuration: &.DestinationPubsubConfigurationArgs{
CredentialsJson: pulumi.String("string"),
ProjectId: pulumi.String("string"),
TopicId: pulumi.String("string"),
BatchingDelayThreshold: pulumi.Float64(0),
BatchingElementCountThreshold: pulumi.Float64(0),
BatchingEnabled: pulumi.Bool(false),
BatchingRequestBytesThreshold: pulumi.Float64(0),
OrderingEnabled: pulumi.Bool(false),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
})

var destinationPubsubResource = new DestinationPubsub("destinationPubsubResource", DestinationPubsubArgs.builder()
    .configuration(DestinationPubsubConfigurationArgs.builder()
        .credentialsJson("string")
        .projectId("string")
        .topicId("string")
        .batchingDelayThreshold(0)
        .batchingElementCountThreshold(0)
        .batchingEnabled(false)
        .batchingRequestBytesThreshold(0)
        .orderingEnabled(false)
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .build());

destination_pubsub_resource = airbyte.DestinationPubsub("destinationPubsubResource",
    configuration={
        "credentials_json": "string",
        "project_id": "string",
        "topic_id": "string",
        "batching_delay_threshold": 0,
        "batching_element_count_threshold": 0,
        "batching_enabled": False,
        "batching_request_bytes_threshold": 0,
        "ordering_enabled": False,
    },
    workspace_id="string",
    definition_id="string",
    name="string")

const destinationPubsubResource = new airbyte.DestinationPubsub("destinationPubsubResource", {
    configuration: {
        credentialsJson: "string",
        projectId: "string",
        topicId: "string",
        batchingDelayThreshold: 0,
        batchingElementCountThreshold: 0,
        batchingEnabled: false,
        batchingRequestBytesThreshold: 0,
        orderingEnabled: false,
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
});

type: airbyte:DestinationPubsub
properties:
    configuration:
        batchingDelayThreshold: 0
        batchingElementCountThreshold: 0
        batchingEnabled: false
        batchingRequestBytesThreshold: 0
        credentialsJson: string
        orderingEnabled: false
        projectId: string
        topicId: string
    definitionId: string
    name: string
    workspaceId: string

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

Configuration DestinationPubsubConfiguration
WorkspaceId string
DefinitionId string: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the destination e.g. dev-mysql-instance.

Configuration DestinationPubsubConfigurationArgs
WorkspaceId string
DefinitionId string: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the destination e.g. dev-mysql-instance.

configuration DestinationPubsubConfiguration
workspaceId String
definitionId String: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
name String: Name of the destination e.g. dev-mysql-instance.

configuration DestinationPubsubConfiguration
workspaceId string
definitionId string: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
name string: Name of the destination e.g. dev-mysql-instance.

configuration DestinationPubsubConfigurationArgs
workspace_id str
definition_id str: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
name str: Name of the destination e.g. dev-mysql-instance.

configuration Property Map
workspaceId String
definitionId String: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
name String: Name of the destination e.g. dev-mysql-instance.

Outputs

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

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

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

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

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

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

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

Look up Existing DestinationPubsub Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[DestinationPubsubConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        destination_id: Optional[str] = None,
        destination_type: Optional[str] = None,
        name: Optional[str] = None,
        workspace_id: Optional[str] = None) -> DestinationPubsub

func GetDestinationPubsub(ctx *Context, name string, id IDInput, state *DestinationPubsubState, opts ...ResourceOption) (*DestinationPubsub, error)

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

public static DestinationPubsub get(String name, Output<String> id, DestinationPubsubState state, CustomResourceOptions options)

resources:  _:    type: airbyte:DestinationPubsub    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 DestinationPubsubConfiguration
CreatedAt double
DefinitionId string: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
DestinationId string
DestinationType string
Name string: Name of the destination e.g. dev-mysql-instance.
WorkspaceId string

Configuration DestinationPubsubConfigurationArgs
CreatedAt float64
DefinitionId string: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
DestinationId string
DestinationType string
Name string: Name of the destination e.g. dev-mysql-instance.
WorkspaceId string

configuration DestinationPubsubConfiguration
createdAt Double
definitionId String: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
destinationId String
destinationType String
name String: Name of the destination e.g. dev-mysql-instance.
workspaceId String

configuration DestinationPubsubConfiguration
createdAt number
definitionId string: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
destinationId string
destinationType string
name string: Name of the destination e.g. dev-mysql-instance.
workspaceId string

configuration DestinationPubsubConfigurationArgs
created_at float
definition_id str: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
destination_id str
destination_type str
name str: Name of the destination e.g. dev-mysql-instance.
workspace_id str

configuration Property Map
createdAt Number
definitionId String: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
destinationId String
destinationType String
name String: Name of the destination e.g. dev-mysql-instance.
workspaceId String

Supporting Types

DestinationPubsubConfiguration, DestinationPubsubConfigurationArgs

CredentialsJson string: The contents of the JSON service account key. Check out the \n\ndocs\n\n if you need help generating this key.
ProjectId string: The GCP project ID for the project containing the target PubSub.
TopicId string: The PubSub topic ID in the given GCP project ID.
BatchingDelayThreshold double: Number of ms before the buffer is flushed. Default: 1
BatchingElementCountThreshold double: Number of messages before the buffer is flushed. Default: 1
BatchingEnabled bool: If TRUE messages will be buffered instead of sending them one by one. Default: false
BatchingRequestBytesThreshold double: Number of bytes before the buffer is flushed. Default: 1
OrderingEnabled bool: If TRUE PubSub publisher will have \n\nmessage ordering\n\n enabled. Every message will have an ordering key of stream. Default: false

CredentialsJson string: The contents of the JSON service account key. Check out the \n\ndocs\n\n if you need help generating this key.
ProjectId string: The GCP project ID for the project containing the target PubSub.
TopicId string: The PubSub topic ID in the given GCP project ID.
BatchingDelayThreshold float64: Number of ms before the buffer is flushed. Default: 1
BatchingElementCountThreshold float64: Number of messages before the buffer is flushed. Default: 1
BatchingEnabled bool: If TRUE messages will be buffered instead of sending them one by one. Default: false
BatchingRequestBytesThreshold float64: Number of bytes before the buffer is flushed. Default: 1
OrderingEnabled bool: If TRUE PubSub publisher will have \n\nmessage ordering\n\n enabled. Every message will have an ordering key of stream. Default: false

credentialsJson String: The contents of the JSON service account key. Check out the \n\ndocs\n\n if you need help generating this key.
projectId String: The GCP project ID for the project containing the target PubSub.
topicId String: The PubSub topic ID in the given GCP project ID.
batchingDelayThreshold Double: Number of ms before the buffer is flushed. Default: 1
batchingElementCountThreshold Double: Number of messages before the buffer is flushed. Default: 1
batchingEnabled Boolean: If TRUE messages will be buffered instead of sending them one by one. Default: false
batchingRequestBytesThreshold Double: Number of bytes before the buffer is flushed. Default: 1
orderingEnabled Boolean: If TRUE PubSub publisher will have \n\nmessage ordering\n\n enabled. Every message will have an ordering key of stream. Default: false

credentialsJson string: The contents of the JSON service account key. Check out the \n\ndocs\n\n if you need help generating this key.
projectId string: The GCP project ID for the project containing the target PubSub.
topicId string: The PubSub topic ID in the given GCP project ID.
batchingDelayThreshold number: Number of ms before the buffer is flushed. Default: 1
batchingElementCountThreshold number: Number of messages before the buffer is flushed. Default: 1
batchingEnabled boolean: If TRUE messages will be buffered instead of sending them one by one. Default: false
batchingRequestBytesThreshold number: Number of bytes before the buffer is flushed. Default: 1
orderingEnabled boolean: If TRUE PubSub publisher will have \n\nmessage ordering\n\n enabled. Every message will have an ordering key of stream. Default: false

credentials_json str: The contents of the JSON service account key. Check out the \n\ndocs\n\n if you need help generating this key.
project_id str: The GCP project ID for the project containing the target PubSub.
topic_id str: The PubSub topic ID in the given GCP project ID.
batching_delay_threshold float: Number of ms before the buffer is flushed. Default: 1
batching_element_count_threshold float: Number of messages before the buffer is flushed. Default: 1
batching_enabled bool: If TRUE messages will be buffered instead of sending them one by one. Default: false
batching_request_bytes_threshold float: Number of bytes before the buffer is flushed. Default: 1
ordering_enabled bool: If TRUE PubSub publisher will have \n\nmessage ordering\n\n enabled. Every message will have an ordering key of stream. Default: false

credentialsJson String: The contents of the JSON service account key. Check out the \n\ndocs\n\n if you need help generating this key.
projectId String: The GCP project ID for the project containing the target PubSub.
topicId String: The PubSub topic ID in the given GCP project ID.
batchingDelayThreshold Number: Number of ms before the buffer is flushed. Default: 1
batchingElementCountThreshold Number: Number of messages before the buffer is flushed. Default: 1
batchingEnabled Boolean: If TRUE messages will be buffered instead of sending them one by one. Default: false
batchingRequestBytesThreshold Number: Number of bytes before the buffer is flushed. Default: 1
orderingEnabled Boolean: If TRUE PubSub publisher will have \n\nmessage ordering\n\n enabled. Every message will have an ordering key of stream. Default: false

Import

$ pulumi import airbyte:index/destinationPubsub:DestinationPubsub my_airbyte_destination_pubsub ""

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

On this page

On this page

Example Usage

Create DestinationPubsub Resource

Constructor syntax

Parameters

Constructor example

DestinationPubsub Resource Properties

Inputs

Outputs

Look up Existing DestinationPubsub Resource

Supporting Types

DestinationPubsubConfiguration, DestinationPubsubConfigurationArgs

Import

Package Details

On this page

On this page