1. Packages
  2. Astra DB
  3. API Docs
  4. StreamingSink
Astra DB v1.0.42 published on Tuesday, Jun 6, 2023 by pulumiverse

astra.StreamingSink

Explore with Pulumi AI

astra.StreamingSink creates a streaming sink which sends data from a topic to a target system.

Example Usage

using System.Collections.Generic;
using System.Text.Json;
using Pulumi;
using Astra = Pulumiverse.Astra;

return await Deployment.RunAsync(() => 
{
    var streamingTenant_1 = new Astra.StreamingTenant("streamingTenant-1", new()
    {
        TenantName = "terraformtest2",
        Topic = "terraformtest",
        Region = "useast-4",
        CloudProvider = "gcp",
        UserEmail = "seb@datastax.com",
    });

    var cdc_1 = new Astra.Cdc("cdc-1", new()
    {
        DatabaseId = "5b70892f-e01a-4595-98e6-19ecc9985d50",
        DatabaseName = "sai_test",
        Table = "test",
        Keyspace = "sai_test",
        TopicPartitions = 3,
        TenantName = streamingTenant_1.TenantName,
    }, new CustomResourceOptions
    {
        DependsOn = new[]
        {
            streamingTenant_1,
        },
    });

    var streamingSink_1 = new Astra.StreamingSink("streamingSink-1", new()
    {
        TenantName = streamingTenant_1.TenantName,
        Topic = cdc_1.DataTopic,
        Region = "useast-4",
        CloudProvider = "gcp",
        SinkName = "jdbc-clickhouse",
        RetainOrdering = true,
        ProcessingGuarantees = "ATLEAST_ONCE",
        Parallelism = 3,
        Namespace = "default",
        SinkConfigs = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["userName"] = "clickhouse",
            ["password"] = "password",
            ["jdbcUrl"] = "jdbc:clickhouse://fake.clickhouse.url:8123/pulsar_clickhouse_jdbc_sink",
            ["tableName"] = "pulsar_clickhouse_jdbc_sink",
        }),
        AutoAck = true,
    }, new CustomResourceOptions
    {
        DependsOn = new[]
        {
            streamingTenant_1,
            cdc_1,
        },
    });

});
Copy
package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-astra/sdk/go/astra"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := astra.NewStreamingTenant(ctx, "streamingTenant-1", &astra.StreamingTenantArgs{
			TenantName:    pulumi.String("terraformtest2"),
			Topic:         pulumi.String("terraformtest"),
			Region:        pulumi.String("useast-4"),
			CloudProvider: pulumi.String("gcp"),
			UserEmail:     pulumi.String("seb@datastax.com"),
		})
		if err != nil {
			return err
		}
		_, err = astra.NewCdc(ctx, "cdc-1", &astra.CdcArgs{
			DatabaseId:      pulumi.String("5b70892f-e01a-4595-98e6-19ecc9985d50"),
			DatabaseName:    pulumi.String("sai_test"),
			Table:           pulumi.String("test"),
			Keyspace:        pulumi.String("sai_test"),
			TopicPartitions: pulumi.Int(3),
			TenantName:      streamingTenant_1.TenantName,
		}, pulumi.DependsOn([]pulumi.Resource{
			streamingTenant_1,
		}))
		if err != nil {
			return err
		}
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"userName":  "clickhouse",
			"password":  "password",
			"jdbcUrl":   "jdbc:clickhouse://fake.clickhouse.url:8123/pulsar_clickhouse_jdbc_sink",
			"tableName": "pulsar_clickhouse_jdbc_sink",
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = astra.NewStreamingSink(ctx, "streamingSink-1", &astra.StreamingSinkArgs{
			TenantName:           streamingTenant_1.TenantName,
			Topic:                cdc_1.DataTopic,
			Region:               pulumi.String("useast-4"),
			CloudProvider:        pulumi.String("gcp"),
			SinkName:             pulumi.String("jdbc-clickhouse"),
			RetainOrdering:       pulumi.Bool(true),
			ProcessingGuarantees: pulumi.String("ATLEAST_ONCE"),
			Parallelism:          pulumi.Int(3),
			Namespace:            pulumi.String("default"),
			SinkConfigs:          pulumi.String(json0),
			AutoAck:              pulumi.Bool(true),
		}, pulumi.DependsOn([]pulumi.Resource{
			streamingTenant_1,
			cdc_1,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.astra.StreamingTenant;
import com.pulumi.astra.StreamingTenantArgs;
import com.pulumi.astra.Cdc;
import com.pulumi.astra.CdcArgs;
import com.pulumi.astra.StreamingSink;
import com.pulumi.astra.StreamingSinkArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import com.pulumi.resources.CustomResourceOptions;
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 streamingTenant_1 = new StreamingTenant("streamingTenant-1", StreamingTenantArgs.builder()        
            .tenantName("terraformtest2")
            .topic("terraformtest")
            .region("useast-4")
            .cloudProvider("gcp")
            .userEmail("seb@datastax.com")
            .build());

        var cdc_1 = new Cdc("cdc-1", CdcArgs.builder()        
            .databaseId("5b70892f-e01a-4595-98e6-19ecc9985d50")
            .databaseName("sai_test")
            .table("test")
            .keyspace("sai_test")
            .topicPartitions(3)
            .tenantName(streamingTenant_1.tenantName())
            .build(), CustomResourceOptions.builder()
                .dependsOn(streamingTenant_1)
                .build());

        var streamingSink_1 = new StreamingSink("streamingSink-1", StreamingSinkArgs.builder()        
            .tenantName(streamingTenant_1.tenantName())
            .topic(cdc_1.dataTopic())
            .region("useast-4")
            .cloudProvider("gcp")
            .sinkName("jdbc-clickhouse")
            .retainOrdering(true)
            .processingGuarantees("ATLEAST_ONCE")
            .parallelism(3)
            .namespace("default")
            .sinkConfigs(serializeJson(
                jsonObject(
                    jsonProperty("userName", "clickhouse"),
                    jsonProperty("password", "password"),
                    jsonProperty("jdbcUrl", "jdbc:clickhouse://fake.clickhouse.url:8123/pulsar_clickhouse_jdbc_sink"),
                    jsonProperty("tableName", "pulsar_clickhouse_jdbc_sink")
                )))
            .autoAck(true)
            .build(), CustomResourceOptions.builder()
                .dependsOn(                
                    streamingTenant_1,
                    cdc_1)
                .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as astra from "@pulumiverse/astra";

const streamingTenant_1 = new astra.StreamingTenant("streamingTenant-1", {
    tenantName: "terraformtest2",
    topic: "terraformtest",
    region: "useast-4",
    cloudProvider: "gcp",
    userEmail: "seb@datastax.com",
});
const cdc_1 = new astra.Cdc("cdc-1", {
    databaseId: "5b70892f-e01a-4595-98e6-19ecc9985d50",
    databaseName: "sai_test",
    table: "test",
    keyspace: "sai_test",
    topicPartitions: 3,
    tenantName: streamingTenant_1.tenantName,
}, {
    dependsOn: [streamingTenant_1],
});
const streamingSink_1 = new astra.StreamingSink("streamingSink-1", {
    tenantName: streamingTenant_1.tenantName,
    topic: cdc_1.dataTopic,
    region: "useast-4",
    cloudProvider: "gcp",
    sinkName: "jdbc-clickhouse",
    retainOrdering: true,
    processingGuarantees: "ATLEAST_ONCE",
    parallelism: 3,
    namespace: "default",
    sinkConfigs: JSON.stringify({
        userName: "clickhouse",
        password: "password",
        jdbcUrl: "jdbc:clickhouse://fake.clickhouse.url:8123/pulsar_clickhouse_jdbc_sink",
        tableName: "pulsar_clickhouse_jdbc_sink",
    }),
    autoAck: true,
}, {
    dependsOn: [
        streamingTenant_1,
        cdc_1,
    ],
});
Copy
import pulumi
import json
import pulumiverse_astra as astra

streaming_tenant_1 = astra.StreamingTenant("streamingTenant-1",
    tenant_name="terraformtest2",
    topic="terraformtest",
    region="useast-4",
    cloud_provider="gcp",
    user_email="seb@datastax.com")
cdc_1 = astra.Cdc("cdc-1",
    database_id="5b70892f-e01a-4595-98e6-19ecc9985d50",
    database_name="sai_test",
    table="test",
    keyspace="sai_test",
    topic_partitions=3,
    tenant_name=streaming_tenant_1.tenant_name,
    opts=pulumi.ResourceOptions(depends_on=[streaming_tenant_1]))
streaming_sink_1 = astra.StreamingSink("streamingSink-1",
    tenant_name=streaming_tenant_1.tenant_name,
    topic=cdc_1.data_topic,
    region="useast-4",
    cloud_provider="gcp",
    sink_name="jdbc-clickhouse",
    retain_ordering=True,
    processing_guarantees="ATLEAST_ONCE",
    parallelism=3,
    namespace="default",
    sink_configs=json.dumps({
        "userName": "clickhouse",
        "password": "password",
        "jdbcUrl": "jdbc:clickhouse://fake.clickhouse.url:8123/pulsar_clickhouse_jdbc_sink",
        "tableName": "pulsar_clickhouse_jdbc_sink",
    }),
    auto_ack=True,
    opts=pulumi.ResourceOptions(depends_on=[
            streaming_tenant_1,
            cdc_1,
        ]))
Copy
resources:
  streamingTenant-1:
    type: astra:StreamingTenant
    properties:
      tenantName: terraformtest2
      topic: terraformtest
      region: useast-4
      cloudProvider: gcp
      userEmail: seb@datastax.com
  cdc-1:
    type: astra:Cdc
    properties:
      databaseId: 5b70892f-e01a-4595-98e6-19ecc9985d50
      databaseName: sai_test
      table: test
      keyspace: sai_test
      topicPartitions: 3
      tenantName: ${["streamingTenant-1"].tenantName}
    options:
      dependson:
        - ${["streamingTenant-1"]}
  streamingSink-1:
    type: astra:StreamingSink
    properties:
      tenantName: ${["streamingTenant-1"].tenantName}
      topic: ${["cdc-1"].dataTopic}
      region: useast-4
      cloudProvider: gcp
      sinkName: jdbc-clickhouse
      retainOrdering: true
      processingGuarantees: ATLEAST_ONCE
      parallelism: 3
      namespace: default
      sinkConfigs:
        Fn::ToJSON:
          userName: clickhouse
          password: password
          jdbcUrl: jdbc:clickhouse://fake.clickhouse.url:8123/pulsar_clickhouse_jdbc_sink
          tableName: pulsar_clickhouse_jdbc_sink
      autoAck: true
    options:
      dependson:
        - ${["streamingTenant-1"]}
        - ${["cdc-1"]}
Copy

Create StreamingSink Resource

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

Constructor syntax

new StreamingSink(name: string, args: StreamingSinkArgs, opts?: CustomResourceOptions);
@overload
def StreamingSink(resource_name: str,
                  args: StreamingSinkArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def StreamingSink(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  auto_ack: Optional[bool] = None,
                  cloud_provider: Optional[str] = None,
                  namespace: Optional[str] = None,
                  parallelism: Optional[int] = None,
                  processing_guarantees: Optional[str] = None,
                  region: Optional[str] = None,
                  retain_ordering: Optional[bool] = None,
                  sink_configs: Optional[str] = None,
                  sink_name: Optional[str] = None,
                  tenant_name: Optional[str] = None,
                  topic: Optional[str] = None,
                  deletion_protection: Optional[bool] = None)
func NewStreamingSink(ctx *Context, name string, args StreamingSinkArgs, opts ...ResourceOption) (*StreamingSink, error)
public StreamingSink(string name, StreamingSinkArgs args, CustomResourceOptions? opts = null)
public StreamingSink(String name, StreamingSinkArgs args)
public StreamingSink(String name, StreamingSinkArgs args, CustomResourceOptions options)
type: astra:StreamingSink
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. StreamingSinkArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. StreamingSinkArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. StreamingSinkArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. StreamingSinkArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. StreamingSinkArgs
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 streamingSinkResource = new Astra.StreamingSink("streamingSinkResource", new()
{
    AutoAck = false,
    CloudProvider = "string",
    Namespace = "string",
    Parallelism = 0,
    ProcessingGuarantees = "string",
    Region = "string",
    RetainOrdering = false,
    SinkConfigs = "string",
    SinkName = "string",
    TenantName = "string",
    Topic = "string",
    DeletionProtection = false,
});
Copy
example, err := astra.NewStreamingSink(ctx, "streamingSinkResource", &astra.StreamingSinkArgs{
	AutoAck:              pulumi.Bool(false),
	CloudProvider:        pulumi.String("string"),
	Namespace:            pulumi.String("string"),
	Parallelism:          pulumi.Int(0),
	ProcessingGuarantees: pulumi.String("string"),
	Region:               pulumi.String("string"),
	RetainOrdering:       pulumi.Bool(false),
	SinkConfigs:          pulumi.String("string"),
	SinkName:             pulumi.String("string"),
	TenantName:           pulumi.String("string"),
	Topic:                pulumi.String("string"),
	DeletionProtection:   pulumi.Bool(false),
})
Copy
var streamingSinkResource = new StreamingSink("streamingSinkResource", StreamingSinkArgs.builder()
    .autoAck(false)
    .cloudProvider("string")
    .namespace("string")
    .parallelism(0)
    .processingGuarantees("string")
    .region("string")
    .retainOrdering(false)
    .sinkConfigs("string")
    .sinkName("string")
    .tenantName("string")
    .topic("string")
    .deletionProtection(false)
    .build());
Copy
streaming_sink_resource = astra.StreamingSink("streamingSinkResource",
    auto_ack=False,
    cloud_provider="string",
    namespace="string",
    parallelism=0,
    processing_guarantees="string",
    region="string",
    retain_ordering=False,
    sink_configs="string",
    sink_name="string",
    tenant_name="string",
    topic="string",
    deletion_protection=False)
Copy
const streamingSinkResource = new astra.StreamingSink("streamingSinkResource", {
    autoAck: false,
    cloudProvider: "string",
    namespace: "string",
    parallelism: 0,
    processingGuarantees: "string",
    region: "string",
    retainOrdering: false,
    sinkConfigs: "string",
    sinkName: "string",
    tenantName: "string",
    topic: "string",
    deletionProtection: false,
});
Copy
type: astra:StreamingSink
properties:
    autoAck: false
    cloudProvider: string
    deletionProtection: false
    namespace: string
    parallelism: 0
    processingGuarantees: string
    region: string
    retainOrdering: false
    sinkConfigs: string
    sinkName: string
    tenantName: string
    topic: string
Copy

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

AutoAck
This property is required.
Changes to this property will trigger replacement.
bool
auto ack
CloudProvider
This property is required.
Changes to this property will trigger replacement.
string
Cloud provider
Namespace
This property is required.
Changes to this property will trigger replacement.
string
Pulsar Namespace
Parallelism
This property is required.
Changes to this property will trigger replacement.
int
Parallelism for Pulsar sink
ProcessingGuarantees
This property is required.
Changes to this property will trigger replacement.
string
"ATLEASTONCE""ATMOSTONCE""EFFECTIVELY_ONCE".
Region
This property is required.
Changes to this property will trigger replacement.
string
cloud region
RetainOrdering
This property is required.
Changes to this property will trigger replacement.
bool
Retain ordering.
SinkConfigs
This property is required.
Changes to this property will trigger replacement.
string
Sink Configs
SinkName
This property is required.
Changes to this property will trigger replacement.
string
Name of the sink.
TenantName
This property is required.
Changes to this property will trigger replacement.
string
Streaming tenant name.
Topic
This property is required.
Changes to this property will trigger replacement.
string
Streaming tenant topic.
DeletionProtection bool
Whether or not to allow Terraform to destroy this streaming sink. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply command that deletes the instance will fail. Defaults to true.
AutoAck
This property is required.
Changes to this property will trigger replacement.
bool
auto ack
CloudProvider
This property is required.
Changes to this property will trigger replacement.
string
Cloud provider
Namespace
This property is required.
Changes to this property will trigger replacement.
string
Pulsar Namespace
Parallelism
This property is required.
Changes to this property will trigger replacement.
int
Parallelism for Pulsar sink
ProcessingGuarantees
This property is required.
Changes to this property will trigger replacement.
string
"ATLEASTONCE""ATMOSTONCE""EFFECTIVELY_ONCE".
Region
This property is required.
Changes to this property will trigger replacement.
string
cloud region
RetainOrdering
This property is required.
Changes to this property will trigger replacement.
bool
Retain ordering.
SinkConfigs
This property is required.
Changes to this property will trigger replacement.
string
Sink Configs
SinkName
This property is required.
Changes to this property will trigger replacement.
string
Name of the sink.
TenantName
This property is required.
Changes to this property will trigger replacement.
string
Streaming tenant name.
Topic
This property is required.
Changes to this property will trigger replacement.
string
Streaming tenant topic.
DeletionProtection bool
Whether or not to allow Terraform to destroy this streaming sink. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply command that deletes the instance will fail. Defaults to true.
autoAck
This property is required.
Changes to this property will trigger replacement.
Boolean
auto ack
cloudProvider
This property is required.
Changes to this property will trigger replacement.
String
Cloud provider
namespace
This property is required.
Changes to this property will trigger replacement.
String
Pulsar Namespace
parallelism
This property is required.
Changes to this property will trigger replacement.
Integer
Parallelism for Pulsar sink
processingGuarantees
This property is required.
Changes to this property will trigger replacement.
String
"ATLEASTONCE""ATMOSTONCE""EFFECTIVELY_ONCE".
region
This property is required.
Changes to this property will trigger replacement.
String
cloud region
retainOrdering
This property is required.
Changes to this property will trigger replacement.
Boolean
Retain ordering.
sinkConfigs
This property is required.
Changes to this property will trigger replacement.
String
Sink Configs
sinkName
This property is required.
Changes to this property will trigger replacement.
String
Name of the sink.
tenantName
This property is required.
Changes to this property will trigger replacement.
String
Streaming tenant name.
topic
This property is required.
Changes to this property will trigger replacement.
String
Streaming tenant topic.
deletionProtection Boolean
Whether or not to allow Terraform to destroy this streaming sink. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply command that deletes the instance will fail. Defaults to true.
autoAck
This property is required.
Changes to this property will trigger replacement.
boolean
auto ack
cloudProvider
This property is required.
Changes to this property will trigger replacement.
string
Cloud provider
namespace
This property is required.
Changes to this property will trigger replacement.
string
Pulsar Namespace
parallelism
This property is required.
Changes to this property will trigger replacement.
number
Parallelism for Pulsar sink
processingGuarantees
This property is required.
Changes to this property will trigger replacement.
string
"ATLEASTONCE""ATMOSTONCE""EFFECTIVELY_ONCE".
region
This property is required.
Changes to this property will trigger replacement.
string
cloud region
retainOrdering
This property is required.
Changes to this property will trigger replacement.
boolean
Retain ordering.
sinkConfigs
This property is required.
Changes to this property will trigger replacement.
string
Sink Configs
sinkName
This property is required.
Changes to this property will trigger replacement.
string
Name of the sink.
tenantName
This property is required.
Changes to this property will trigger replacement.
string
Streaming tenant name.
topic
This property is required.
Changes to this property will trigger replacement.
string
Streaming tenant topic.
deletionProtection boolean
Whether or not to allow Terraform to destroy this streaming sink. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply command that deletes the instance will fail. Defaults to true.
auto_ack
This property is required.
Changes to this property will trigger replacement.
bool
auto ack
cloud_provider
This property is required.
Changes to this property will trigger replacement.
str
Cloud provider
namespace
This property is required.
Changes to this property will trigger replacement.
str
Pulsar Namespace
parallelism
This property is required.
Changes to this property will trigger replacement.
int
Parallelism for Pulsar sink
processing_guarantees
This property is required.
Changes to this property will trigger replacement.
str
"ATLEASTONCE""ATMOSTONCE""EFFECTIVELY_ONCE".
region
This property is required.
Changes to this property will trigger replacement.
str
cloud region
retain_ordering
This property is required.
Changes to this property will trigger replacement.
bool
Retain ordering.
sink_configs
This property is required.
Changes to this property will trigger replacement.
str
Sink Configs
sink_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the sink.
tenant_name
This property is required.
Changes to this property will trigger replacement.
str
Streaming tenant name.
topic
This property is required.
Changes to this property will trigger replacement.
str
Streaming tenant topic.
deletion_protection bool
Whether or not to allow Terraform to destroy this streaming sink. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply command that deletes the instance will fail. Defaults to true.
autoAck
This property is required.
Changes to this property will trigger replacement.
Boolean
auto ack
cloudProvider
This property is required.
Changes to this property will trigger replacement.
String
Cloud provider
namespace
This property is required.
Changes to this property will trigger replacement.
String
Pulsar Namespace
parallelism
This property is required.
Changes to this property will trigger replacement.
Number
Parallelism for Pulsar sink
processingGuarantees
This property is required.
Changes to this property will trigger replacement.
String
"ATLEASTONCE""ATMOSTONCE""EFFECTIVELY_ONCE".
region
This property is required.
Changes to this property will trigger replacement.
String
cloud region
retainOrdering
This property is required.
Changes to this property will trigger replacement.
Boolean
Retain ordering.
sinkConfigs
This property is required.
Changes to this property will trigger replacement.
String
Sink Configs
sinkName
This property is required.
Changes to this property will trigger replacement.
String
Name of the sink.
tenantName
This property is required.
Changes to this property will trigger replacement.
String
Streaming tenant name.
topic
This property is required.
Changes to this property will trigger replacement.
String
Streaming tenant topic.
deletionProtection Boolean
Whether or not to allow Terraform to destroy this streaming sink. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply command that deletes the instance will fail. Defaults to true.

Outputs

All input properties are implicitly available as output properties. Additionally, the StreamingSink 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 StreamingSink Resource

Get an existing StreamingSink 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?: StreamingSinkState, opts?: CustomResourceOptions): StreamingSink
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_ack: Optional[bool] = None,
        cloud_provider: Optional[str] = None,
        deletion_protection: Optional[bool] = None,
        namespace: Optional[str] = None,
        parallelism: Optional[int] = None,
        processing_guarantees: Optional[str] = None,
        region: Optional[str] = None,
        retain_ordering: Optional[bool] = None,
        sink_configs: Optional[str] = None,
        sink_name: Optional[str] = None,
        tenant_name: Optional[str] = None,
        topic: Optional[str] = None) -> StreamingSink
func GetStreamingSink(ctx *Context, name string, id IDInput, state *StreamingSinkState, opts ...ResourceOption) (*StreamingSink, error)
public static StreamingSink Get(string name, Input<string> id, StreamingSinkState? state, CustomResourceOptions? opts = null)
public static StreamingSink get(String name, Output<String> id, StreamingSinkState state, CustomResourceOptions options)
resources:  _:    type: astra:StreamingSink    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AutoAck Changes to this property will trigger replacement. bool
auto ack
CloudProvider Changes to this property will trigger replacement. string
Cloud provider
DeletionProtection bool
Whether or not to allow Terraform to destroy this streaming sink. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply command that deletes the instance will fail. Defaults to true.
Namespace Changes to this property will trigger replacement. string
Pulsar Namespace
Parallelism Changes to this property will trigger replacement. int
Parallelism for Pulsar sink
ProcessingGuarantees Changes to this property will trigger replacement. string
"ATLEASTONCE""ATMOSTONCE""EFFECTIVELY_ONCE".
Region Changes to this property will trigger replacement. string
cloud region
RetainOrdering Changes to this property will trigger replacement. bool
Retain ordering.
SinkConfigs Changes to this property will trigger replacement. string
Sink Configs
SinkName Changes to this property will trigger replacement. string
Name of the sink.
TenantName Changes to this property will trigger replacement. string
Streaming tenant name.
Topic Changes to this property will trigger replacement. string
Streaming tenant topic.
AutoAck Changes to this property will trigger replacement. bool
auto ack
CloudProvider Changes to this property will trigger replacement. string
Cloud provider
DeletionProtection bool
Whether or not to allow Terraform to destroy this streaming sink. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply command that deletes the instance will fail. Defaults to true.
Namespace Changes to this property will trigger replacement. string
Pulsar Namespace
Parallelism Changes to this property will trigger replacement. int
Parallelism for Pulsar sink
ProcessingGuarantees Changes to this property will trigger replacement. string
"ATLEASTONCE""ATMOSTONCE""EFFECTIVELY_ONCE".
Region Changes to this property will trigger replacement. string
cloud region
RetainOrdering Changes to this property will trigger replacement. bool
Retain ordering.
SinkConfigs Changes to this property will trigger replacement. string
Sink Configs
SinkName Changes to this property will trigger replacement. string
Name of the sink.
TenantName Changes to this property will trigger replacement. string
Streaming tenant name.
Topic Changes to this property will trigger replacement. string
Streaming tenant topic.
autoAck Changes to this property will trigger replacement. Boolean
auto ack
cloudProvider Changes to this property will trigger replacement. String
Cloud provider
deletionProtection Boolean
Whether or not to allow Terraform to destroy this streaming sink. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply command that deletes the instance will fail. Defaults to true.
namespace Changes to this property will trigger replacement. String
Pulsar Namespace
parallelism Changes to this property will trigger replacement. Integer
Parallelism for Pulsar sink
processingGuarantees Changes to this property will trigger replacement. String
"ATLEASTONCE""ATMOSTONCE""EFFECTIVELY_ONCE".
region Changes to this property will trigger replacement. String
cloud region
retainOrdering Changes to this property will trigger replacement. Boolean
Retain ordering.
sinkConfigs Changes to this property will trigger replacement. String
Sink Configs
sinkName Changes to this property will trigger replacement. String
Name of the sink.
tenantName Changes to this property will trigger replacement. String
Streaming tenant name.
topic Changes to this property will trigger replacement. String
Streaming tenant topic.
autoAck Changes to this property will trigger replacement. boolean
auto ack
cloudProvider Changes to this property will trigger replacement. string
Cloud provider
deletionProtection boolean
Whether or not to allow Terraform to destroy this streaming sink. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply command that deletes the instance will fail. Defaults to true.
namespace Changes to this property will trigger replacement. string
Pulsar Namespace
parallelism Changes to this property will trigger replacement. number
Parallelism for Pulsar sink
processingGuarantees Changes to this property will trigger replacement. string
"ATLEASTONCE""ATMOSTONCE""EFFECTIVELY_ONCE".
region Changes to this property will trigger replacement. string
cloud region
retainOrdering Changes to this property will trigger replacement. boolean
Retain ordering.
sinkConfigs Changes to this property will trigger replacement. string
Sink Configs
sinkName Changes to this property will trigger replacement. string
Name of the sink.
tenantName Changes to this property will trigger replacement. string
Streaming tenant name.
topic Changes to this property will trigger replacement. string
Streaming tenant topic.
auto_ack Changes to this property will trigger replacement. bool
auto ack
cloud_provider Changes to this property will trigger replacement. str
Cloud provider
deletion_protection bool
Whether or not to allow Terraform to destroy this streaming sink. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply command that deletes the instance will fail. Defaults to true.
namespace Changes to this property will trigger replacement. str
Pulsar Namespace
parallelism Changes to this property will trigger replacement. int
Parallelism for Pulsar sink
processing_guarantees Changes to this property will trigger replacement. str
"ATLEASTONCE""ATMOSTONCE""EFFECTIVELY_ONCE".
region Changes to this property will trigger replacement. str
cloud region
retain_ordering Changes to this property will trigger replacement. bool
Retain ordering.
sink_configs Changes to this property will trigger replacement. str
Sink Configs
sink_name Changes to this property will trigger replacement. str
Name of the sink.
tenant_name Changes to this property will trigger replacement. str
Streaming tenant name.
topic Changes to this property will trigger replacement. str
Streaming tenant topic.
autoAck Changes to this property will trigger replacement. Boolean
auto ack
cloudProvider Changes to this property will trigger replacement. String
Cloud provider
deletionProtection Boolean
Whether or not to allow Terraform to destroy this streaming sink. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply command that deletes the instance will fail. Defaults to true.
namespace Changes to this property will trigger replacement. String
Pulsar Namespace
parallelism Changes to this property will trigger replacement. Number
Parallelism for Pulsar sink
processingGuarantees Changes to this property will trigger replacement. String
"ATLEASTONCE""ATMOSTONCE""EFFECTIVELY_ONCE".
region Changes to this property will trigger replacement. String
cloud region
retainOrdering Changes to this property will trigger replacement. Boolean
Retain ordering.
sinkConfigs Changes to this property will trigger replacement. String
Sink Configs
sinkName Changes to this property will trigger replacement. String
Name of the sink.
tenantName Changes to this property will trigger replacement. String
Streaming tenant name.
topic Changes to this property will trigger replacement. String
Streaming tenant topic.

Import

 $ pulumi import astra:index/streamingSink:StreamingSink example tenant_name/topic
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
astra pulumiverse/pulumi-astra
License
Apache-2.0
Notes
This Pulumi package is based on the astra Terraform Provider.