Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Hsdp Provider
  3. API Docs
  4. DbsTopicSubscription
hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software
philips-software/terraform-provider-hsdp

hsdp.DbsTopicSubscription

Explore with Pulumi AI

hsdp logo
hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software
philips-software/terraform-provider-hsdp

    Manages Connect DBS Topic Subscriptions

    Example Usage

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

    import pulumi

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() => 
{
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
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) {
    }
}

    {}

    Attributes reference

    In addition to all arguments above, the following attributes are exported:

    • id - The ID reference of the subscription (format: ${GUID})
    • name - The name of the subscription
    • status - The status of the subscription
    • rule_name - The rule name of the subscription

    Create DbsTopicSubscription Resource

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

    Constructor syntax

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

@overload
def DbsTopicSubscription(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         data_type: Optional[str] = None,
                         description: Optional[str] = None,
                         name_infix: Optional[str] = None,
                         subscriber_id: Optional[str] = None,
                         dbs_topic_subscription_id: Optional[str] = None,
                         deliver_data_only: Optional[bool] = None,
                         kinesis_stream_partition_key: Optional[str] = None)
    func NewDbsTopicSubscription(ctx *Context, name string, args DbsTopicSubscriptionArgs, opts ...ResourceOption) (*DbsTopicSubscription, error)
    public DbsTopicSubscription(string name, DbsTopicSubscriptionArgs args, CustomResourceOptions? opts = null)
    public DbsTopicSubscription(String name, DbsTopicSubscriptionArgs args)
public DbsTopicSubscription(String name, DbsTopicSubscriptionArgs args, CustomResourceOptions options)

    type: hsdp:DbsTopicSubscription
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 DbsTopicSubscriptionArgs
    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 DbsTopicSubscriptionArgs
    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 DbsTopicSubscriptionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DbsTopicSubscriptionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DbsTopicSubscriptionArgs
    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 dbsTopicSubscriptionResource = new Hsdp.DbsTopicSubscription("dbsTopicSubscriptionResource", new()
{
    DataType = "string",
    Description = "string",
    NameInfix = "string",
    SubscriberId = "string",
    DbsTopicSubscriptionId = "string",
    DeliverDataOnly = false,
    KinesisStreamPartitionKey = "string",
});

    example, err := hsdp.NewDbsTopicSubscription(ctx, "dbsTopicSubscriptionResource", &hsdp.DbsTopicSubscriptionArgs{
	DataType:                  pulumi.String("string"),
	Description:               pulumi.String("string"),
	NameInfix:                 pulumi.String("string"),
	SubscriberId:              pulumi.String("string"),
	DbsTopicSubscriptionId:    pulumi.String("string"),
	DeliverDataOnly:           pulumi.Bool(false),
	KinesisStreamPartitionKey: pulumi.String("string"),
})

    var dbsTopicSubscriptionResource = new DbsTopicSubscription("dbsTopicSubscriptionResource", DbsTopicSubscriptionArgs.builder()
    .dataType("string")
    .description("string")
    .nameInfix("string")
    .subscriberId("string")
    .dbsTopicSubscriptionId("string")
    .deliverDataOnly(false)
    .kinesisStreamPartitionKey("string")
    .build());

    dbs_topic_subscription_resource = hsdp.DbsTopicSubscription("dbsTopicSubscriptionResource",
    data_type="string",
    description="string",
    name_infix="string",
    subscriber_id="string",
    dbs_topic_subscription_id="string",
    deliver_data_only=False,
    kinesis_stream_partition_key="string")

    const dbsTopicSubscriptionResource = new hsdp.DbsTopicSubscription("dbsTopicSubscriptionResource", {
    dataType: "string",
    description: "string",
    nameInfix: "string",
    subscriberId: "string",
    dbsTopicSubscriptionId: "string",
    deliverDataOnly: false,
    kinesisStreamPartitionKey: "string",
});

    type: hsdp:DbsTopicSubscription
properties:
    dataType: string
    dbsTopicSubscriptionId: string
    deliverDataOnly: false
    description: string
    kinesisStreamPartitionKey: string
    nameInfix: string
    subscriberId: string

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

    DataType string
    The data type of the topic
    Description string
    A short description of the subscription
    NameInfix string
    The name infix of the subscription
    SubscriberId string
    The ID of the subscriber to associate with this topic subscription
    DbsTopicSubscriptionId string
    DeliverDataOnly bool
    Boolean designating whether to deliver only data (true) or data and metadata (false). Default is false
    KinesisStreamPartitionKey string
    When used in combination with a Kinesis Subscriber, the Stream Partition Key for inserting the data into the Kinesis Stream needs to be provided. Example:= ${newuuid()}
    DataType string
    The data type of the topic
    Description string
    A short description of the subscription
    NameInfix string
    The name infix of the subscription
    SubscriberId string
    The ID of the subscriber to associate with this topic subscription
    DbsTopicSubscriptionId string
    DeliverDataOnly bool
    Boolean designating whether to deliver only data (true) or data and metadata (false). Default is false
    KinesisStreamPartitionKey string
    When used in combination with a Kinesis Subscriber, the Stream Partition Key for inserting the data into the Kinesis Stream needs to be provided. Example:= ${newuuid()}
    dataType String
    The data type of the topic
    description String
    A short description of the subscription
    nameInfix String
    The name infix of the subscription
    subscriberId String
    The ID of the subscriber to associate with this topic subscription
    dbsTopicSubscriptionId String
    deliverDataOnly Boolean
    Boolean designating whether to deliver only data (true) or data and metadata (false). Default is false
    kinesisStreamPartitionKey String
    When used in combination with a Kinesis Subscriber, the Stream Partition Key for inserting the data into the Kinesis Stream needs to be provided. Example:= ${newuuid()}
    dataType string
    The data type of the topic
    description string
    A short description of the subscription
    nameInfix string
    The name infix of the subscription
    subscriberId string
    The ID of the subscriber to associate with this topic subscription
    dbsTopicSubscriptionId string
    deliverDataOnly boolean
    Boolean designating whether to deliver only data (true) or data and metadata (false). Default is false
    kinesisStreamPartitionKey string
    When used in combination with a Kinesis Subscriber, the Stream Partition Key for inserting the data into the Kinesis Stream needs to be provided. Example:= ${newuuid()}
    data_type str
    The data type of the topic
    description str
    A short description of the subscription
    name_infix str
    The name infix of the subscription
    subscriber_id str
    The ID of the subscriber to associate with this topic subscription
    dbs_topic_subscription_id str
    deliver_data_only bool
    Boolean designating whether to deliver only data (true) or data and metadata (false). Default is false
    kinesis_stream_partition_key str
    When used in combination with a Kinesis Subscriber, the Stream Partition Key for inserting the data into the Kinesis Stream needs to be provided. Example:= ${newuuid()}
    dataType String
    The data type of the topic
    description String
    A short description of the subscription
    nameInfix String
    The name infix of the subscription
    subscriberId String
    The ID of the subscriber to associate with this topic subscription
    dbsTopicSubscriptionId String
    deliverDataOnly Boolean
    Boolean designating whether to deliver only data (true) or data and metadata (false). Default is false
    kinesisStreamPartitionKey String
    When used in combination with a Kinesis Subscriber, the Stream Partition Key for inserting the data into the Kinesis Stream needs to be provided. Example:= ${newuuid()}

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    RuleName string
    Status string
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    RuleName string
    Status string
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    ruleName String
    status String
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    ruleName string
    status string
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    rule_name str
    status str
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    ruleName String
    status String

    Look up Existing DbsTopicSubscription Resource

    Get an existing DbsTopicSubscription 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?: DbsTopicSubscriptionState, opts?: CustomResourceOptions): DbsTopicSubscription
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        data_type: Optional[str] = None,
        dbs_topic_subscription_id: Optional[str] = None,
        deliver_data_only: Optional[bool] = None,
        description: Optional[str] = None,
        kinesis_stream_partition_key: Optional[str] = None,
        name: Optional[str] = None,
        name_infix: Optional[str] = None,
        rule_name: Optional[str] = None,
        status: Optional[str] = None,
        subscriber_id: Optional[str] = None) -> DbsTopicSubscription
    func GetDbsTopicSubscription(ctx *Context, name string, id IDInput, state *DbsTopicSubscriptionState, opts ...ResourceOption) (*DbsTopicSubscription, error)
    public static DbsTopicSubscription Get(string name, Input<string> id, DbsTopicSubscriptionState? state, CustomResourceOptions? opts = null)
    public static DbsTopicSubscription get(String name, Output<String> id, DbsTopicSubscriptionState state, CustomResourceOptions options)
    resources:  _:    type: hsdp:DbsTopicSubscription    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:
    DataType string
    The data type of the topic
    DbsTopicSubscriptionId string
    DeliverDataOnly bool
    Boolean designating whether to deliver only data (true) or data and metadata (false). Default is false
    Description string
    A short description of the subscription
    KinesisStreamPartitionKey string
    When used in combination with a Kinesis Subscriber, the Stream Partition Key for inserting the data into the Kinesis Stream needs to be provided. Example:= ${newuuid()}
    Name string
    NameInfix string
    The name infix of the subscription
    RuleName string
    Status string
    SubscriberId string
    The ID of the subscriber to associate with this topic subscription
    DataType string
    The data type of the topic
    DbsTopicSubscriptionId string
    DeliverDataOnly bool
    Boolean designating whether to deliver only data (true) or data and metadata (false). Default is false
    Description string
    A short description of the subscription
    KinesisStreamPartitionKey string
    When used in combination with a Kinesis Subscriber, the Stream Partition Key for inserting the data into the Kinesis Stream needs to be provided. Example:= ${newuuid()}
    Name string
    NameInfix string
    The name infix of the subscription
    RuleName string
    Status string
    SubscriberId string
    The ID of the subscriber to associate with this topic subscription
    dataType String
    The data type of the topic
    dbsTopicSubscriptionId String
    deliverDataOnly Boolean
    Boolean designating whether to deliver only data (true) or data and metadata (false). Default is false
    description String
    A short description of the subscription
    kinesisStreamPartitionKey String
    When used in combination with a Kinesis Subscriber, the Stream Partition Key for inserting the data into the Kinesis Stream needs to be provided. Example:= ${newuuid()}
    name String
    nameInfix String
    The name infix of the subscription
    ruleName String
    status String
    subscriberId String
    The ID of the subscriber to associate with this topic subscription
    dataType string
    The data type of the topic
    dbsTopicSubscriptionId string
    deliverDataOnly boolean
    Boolean designating whether to deliver only data (true) or data and metadata (false). Default is false
    description string
    A short description of the subscription
    kinesisStreamPartitionKey string
    When used in combination with a Kinesis Subscriber, the Stream Partition Key for inserting the data into the Kinesis Stream needs to be provided. Example:= ${newuuid()}
    name string
    nameInfix string
    The name infix of the subscription
    ruleName string
    status string
    subscriberId string
    The ID of the subscriber to associate with this topic subscription
    data_type str
    The data type of the topic
    dbs_topic_subscription_id str
    deliver_data_only bool
    Boolean designating whether to deliver only data (true) or data and metadata (false). Default is false
    description str
    A short description of the subscription
    kinesis_stream_partition_key str
    When used in combination with a Kinesis Subscriber, the Stream Partition Key for inserting the data into the Kinesis Stream needs to be provided. Example:= ${newuuid()}
    name str
    name_infix str
    The name infix of the subscription
    rule_name str
    status str
    subscriber_id str
    The ID of the subscriber to associate with this topic subscription
    dataType String
    The data type of the topic
    dbsTopicSubscriptionId String
    deliverDataOnly Boolean
    Boolean designating whether to deliver only data (true) or data and metadata (false). Default is false
    description String
    A short description of the subscription
    kinesisStreamPartitionKey String
    When used in combination with a Kinesis Subscriber, the Stream Partition Key for inserting the data into the Kinesis Stream needs to be provided. Example:= ${newuuid()}
    name String
    nameInfix String
    The name infix of the subscription
    ruleName String
    status String
    subscriberId String
    The ID of the subscriber to associate with this topic subscription

    Import

    $ pulumi import hsdp:index/dbsTopicSubscription:DbsTopicSubscription An existing Topic subscription using `hsdp_dbs_topic_subscription`, e.g.

    bash

    $ pulumi import hsdp:index/dbsTopicSubscription:DbsTopicSubscription target guid-of-the-subscription-to-import

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

    Package Details

    Repository
    hsdp philips-software/terraform-provider-hsdp
    License
    Notes
    This Pulumi package is based on the hsdp Terraform Provider.
    hsdp logo
    hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software
    philips-software/terraform-provider-hsdp