Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Confluent Provider
  3. API Docs
  4. BusinessMetadataBinding
Confluent v2.22.0 published on Friday, Mar 28, 2025 by Pulumi
pulumi/pulumi-confluentcloud

confluentcloud.BusinessMetadataBinding

Explore with Pulumi AI

Confluent v2.22.0 published on Friday, Mar 28, 2025 by Pulumi
pulumi/pulumi-confluentcloud

General Availability

confluentcloud.BusinessMetadataBinding provides a Business Metadata Binding resource that enables creating, editing, and deleting Business Metadata Bindings on Confluent Cloud.

Example Usage

Option #1: Manage multiple Schema Registry clusters in the same Pulumi Stack

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

const main = confluentcloud.getKafkaTopic({
    topicName: "orders",
});
const mainBusinessMetadataBinding = new confluentcloud.BusinessMetadataBinding("main", {
    schemaRegistryCluster: {
        id: essentials.id,
    },
    restEndpoint: essentials.restEndpoint,
    credentials: {
        key: "<Schema Registry API Key for data.confluent_schema_registry_cluster.essentials>",
        secret: "<Schema Registry API Secret for data.confluent_schema_registry_cluster.essentials>",
    },
    businessMetadataName: pii.name,
    entityName: main.then(main => `${schemaRegistryId}:${kafkaId}:${main.topicName}`),
    entityType: "kafka_topic",
    attributes: {
        team: "teamName",
        email: "team@company.com",
    },
});
Copy
import pulumi
import pulumi_confluentcloud as confluentcloud

main = confluentcloud.get_kafka_topic(topic_name="orders")
main_business_metadata_binding = confluentcloud.BusinessMetadataBinding("main",
    schema_registry_cluster={
        "id": essentials["id"],
    },
    rest_endpoint=essentials["restEndpoint"],
    credentials={
        "key": "<Schema Registry API Key for data.confluent_schema_registry_cluster.essentials>",
        "secret": "<Schema Registry API Secret for data.confluent_schema_registry_cluster.essentials>",
    },
    business_metadata_name=pii["name"],
    entity_name=f"{schema_registry_id}:{kafka_id}:{main.topic_name}",
    entity_type="kafka_topic",
    attributes={
        "team": "teamName",
        "email": "team@company.com",
    })
Copy
package main

import (
	"fmt"

	"github.com/pulumi/pulumi-confluentcloud/sdk/v2/go/confluentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		main, err := confluentcloud.LookupKafkaTopic(ctx, &confluentcloud.LookupKafkaTopicArgs{
			TopicName: "orders",
		}, nil)
		if err != nil {
			return err
		}
		_, err = confluentcloud.NewBusinessMetadataBinding(ctx, "main", &confluentcloud.BusinessMetadataBindingArgs{
			SchemaRegistryCluster: &confluentcloud.BusinessMetadataBindingSchemaRegistryClusterArgs{
				Id: pulumi.Any(essentials.Id),
			},
			RestEndpoint: pulumi.Any(essentials.RestEndpoint),
			Credentials: &confluentcloud.BusinessMetadataBindingCredentialsArgs{
				Key:    pulumi.String("<Schema Registry API Key for data.confluent_schema_registry_cluster.essentials>"),
				Secret: pulumi.String("<Schema Registry API Secret for data.confluent_schema_registry_cluster.essentials>"),
			},
			BusinessMetadataName: pulumi.Any(pii.Name),
			EntityName:           pulumi.Sprintf("%v:%v:%v", schemaRegistryId, kafkaId, main.TopicName),
			EntityType:           pulumi.String("kafka_topic"),
			Attributes: pulumi.StringMap{
				"team":  pulumi.String("teamName"),
				"email": pulumi.String("team@company.com"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ConfluentCloud = Pulumi.ConfluentCloud;

return await Deployment.RunAsync(() => 
{
    var main = ConfluentCloud.GetKafkaTopic.Invoke(new()
    {
        TopicName = "orders",
    });

    var mainBusinessMetadataBinding = new ConfluentCloud.BusinessMetadataBinding("main", new()
    {
        SchemaRegistryCluster = new ConfluentCloud.Inputs.BusinessMetadataBindingSchemaRegistryClusterArgs
        {
            Id = essentials.Id,
        },
        RestEndpoint = essentials.RestEndpoint,
        Credentials = new ConfluentCloud.Inputs.BusinessMetadataBindingCredentialsArgs
        {
            Key = "<Schema Registry API Key for data.confluent_schema_registry_cluster.essentials>",
            Secret = "<Schema Registry API Secret for data.confluent_schema_registry_cluster.essentials>",
        },
        BusinessMetadataName = pii.Name,
        EntityName = $"{schemaRegistryId}:{kafkaId}:{main.Apply(getKafkaTopicResult => getKafkaTopicResult.TopicName)}",
        EntityType = "kafka_topic",
        Attributes = 
        {
            { "team", "teamName" },
            { "email", "team@company.com" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.ConfluentcloudFunctions;
import com.pulumi.confluentcloud.inputs.GetKafkaTopicArgs;
import com.pulumi.confluentcloud.BusinessMetadataBinding;
import com.pulumi.confluentcloud.BusinessMetadataBindingArgs;
import com.pulumi.confluentcloud.inputs.BusinessMetadataBindingSchemaRegistryClusterArgs;
import com.pulumi.confluentcloud.inputs.BusinessMetadataBindingCredentialsArgs;
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) {
        final var main = ConfluentcloudFunctions.getKafkaTopic(GetKafkaTopicArgs.builder()
            .topicName("orders")
            .build());

        var mainBusinessMetadataBinding = new BusinessMetadataBinding("mainBusinessMetadataBinding", BusinessMetadataBindingArgs.builder()
            .schemaRegistryCluster(BusinessMetadataBindingSchemaRegistryClusterArgs.builder()
                .id(essentials.id())
                .build())
            .restEndpoint(essentials.restEndpoint())
            .credentials(BusinessMetadataBindingCredentialsArgs.builder()
                .key("<Schema Registry API Key for data.confluent_schema_registry_cluster.essentials>")
                .secret("<Schema Registry API Secret for data.confluent_schema_registry_cluster.essentials>")
                .build())
            .businessMetadataName(pii.name())
            .entityName(String.format("%s:%s:%s", schemaRegistryId,kafkaId,main.applyValue(getKafkaTopicResult -> getKafkaTopicResult.topicName())))
            .entityType("kafka_topic")
            .attributes(Map.ofEntries(
                Map.entry("team", "teamName"),
                Map.entry("email", "team@company.com")
            ))
            .build());

    }
}
Copy
resources:
  mainBusinessMetadataBinding:
    type: confluentcloud:BusinessMetadataBinding
    name: main
    properties:
      schemaRegistryCluster:
        id: ${essentials.id}
      restEndpoint: ${essentials.restEndpoint}
      credentials:
        key: <Schema Registry API Key for data.confluent_schema_registry_cluster.essentials>
        secret: <Schema Registry API Secret for data.confluent_schema_registry_cluster.essentials>
      businessMetadataName: ${pii.name}
      entityName: ${schemaRegistryId}:${kafkaId}:${main.topicName}
      entityType: kafka_topic
      attributes:
        team: teamName
        email: team@company.com
variables:
  main:
    fn::invoke:
      function: confluentcloud:getKafkaTopic
      arguments:
        topicName: orders
Copy

Option #2: Manage a single Schema Registry cluster in the same Pulumi Stack

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

const main = confluentcloud.getKafkaTopic({
    topicName: "orders",
});
const mainBusinessMetadataBinding = new confluentcloud.BusinessMetadataBinding("main", {
    businessMetadataName: pii.name,
    entityName: main.then(main => `${schemaRegistryId}:${kafkaId}:${main.topicName}`),
    entityType: "kafka_topic",
    attributes: {
        team: "teamName",
        email: "team@company.com",
    },
});
Copy
import pulumi
import pulumi_confluentcloud as confluentcloud

main = confluentcloud.get_kafka_topic(topic_name="orders")
main_business_metadata_binding = confluentcloud.BusinessMetadataBinding("main",
    business_metadata_name=pii["name"],
    entity_name=f"{schema_registry_id}:{kafka_id}:{main.topic_name}",
    entity_type="kafka_topic",
    attributes={
        "team": "teamName",
        "email": "team@company.com",
    })
Copy
package main

import (
	"fmt"

	"github.com/pulumi/pulumi-confluentcloud/sdk/v2/go/confluentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		main, err := confluentcloud.LookupKafkaTopic(ctx, &confluentcloud.LookupKafkaTopicArgs{
			TopicName: "orders",
		}, nil)
		if err != nil {
			return err
		}
		_, err = confluentcloud.NewBusinessMetadataBinding(ctx, "main", &confluentcloud.BusinessMetadataBindingArgs{
			BusinessMetadataName: pulumi.Any(pii.Name),
			EntityName:           pulumi.Sprintf("%v:%v:%v", schemaRegistryId, kafkaId, main.TopicName),
			EntityType:           pulumi.String("kafka_topic"),
			Attributes: pulumi.StringMap{
				"team":  pulumi.String("teamName"),
				"email": pulumi.String("team@company.com"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ConfluentCloud = Pulumi.ConfluentCloud;

return await Deployment.RunAsync(() => 
{
    var main = ConfluentCloud.GetKafkaTopic.Invoke(new()
    {
        TopicName = "orders",
    });

    var mainBusinessMetadataBinding = new ConfluentCloud.BusinessMetadataBinding("main", new()
    {
        BusinessMetadataName = pii.Name,
        EntityName = $"{schemaRegistryId}:{kafkaId}:{main.Apply(getKafkaTopicResult => getKafkaTopicResult.TopicName)}",
        EntityType = "kafka_topic",
        Attributes = 
        {
            { "team", "teamName" },
            { "email", "team@company.com" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.ConfluentcloudFunctions;
import com.pulumi.confluentcloud.inputs.GetKafkaTopicArgs;
import com.pulumi.confluentcloud.BusinessMetadataBinding;
import com.pulumi.confluentcloud.BusinessMetadataBindingArgs;
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) {
        final var main = ConfluentcloudFunctions.getKafkaTopic(GetKafkaTopicArgs.builder()
            .topicName("orders")
            .build());

        var mainBusinessMetadataBinding = new BusinessMetadataBinding("mainBusinessMetadataBinding", BusinessMetadataBindingArgs.builder()
            .businessMetadataName(pii.name())
            .entityName(String.format("%s:%s:%s", schemaRegistryId,kafkaId,main.applyValue(getKafkaTopicResult -> getKafkaTopicResult.topicName())))
            .entityType("kafka_topic")
            .attributes(Map.ofEntries(
                Map.entry("team", "teamName"),
                Map.entry("email", "team@company.com")
            ))
            .build());

    }
}
Copy
resources:
  mainBusinessMetadataBinding:
    type: confluentcloud:BusinessMetadataBinding
    name: main
    properties:
      businessMetadataName: ${pii.name}
      entityName: ${schemaRegistryId}:${kafkaId}:${main.topicName}
      entityType: kafka_topic
      attributes:
        team: teamName
        email: team@company.com
variables:
  main:
    fn::invoke:
      function: confluentcloud:getKafkaTopic
      arguments:
        topicName: orders
Copy

Note: We also support schema_registry_rest_endpoint instead of catalog_rest_endpoint for the time being.

Getting Started

The following end-to-end example might help to get started with Stream Catalog:

  • stream-catalog

Create BusinessMetadataBinding Resource

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

Constructor syntax

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

@overload
def BusinessMetadataBinding(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            business_metadata_name: Optional[str] = None,
                            entity_name: Optional[str] = None,
                            entity_type: Optional[str] = None,
                            attributes: Optional[Mapping[str, str]] = None,
                            credentials: Optional[BusinessMetadataBindingCredentialsArgs] = None,
                            rest_endpoint: Optional[str] = None,
                            schema_registry_cluster: Optional[BusinessMetadataBindingSchemaRegistryClusterArgs] = None)
func NewBusinessMetadataBinding(ctx *Context, name string, args BusinessMetadataBindingArgs, opts ...ResourceOption) (*BusinessMetadataBinding, error)
public BusinessMetadataBinding(string name, BusinessMetadataBindingArgs args, CustomResourceOptions? opts = null)
public BusinessMetadataBinding(String name, BusinessMetadataBindingArgs args)
public BusinessMetadataBinding(String name, BusinessMetadataBindingArgs args, CustomResourceOptions options)

type: confluentcloud:BusinessMetadataBinding
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. BusinessMetadataBindingArgs
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. BusinessMetadataBindingArgs
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. BusinessMetadataBindingArgs
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. BusinessMetadataBindingArgs
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. BusinessMetadataBindingArgs
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 businessMetadataBindingResource = new ConfluentCloud.BusinessMetadataBinding("businessMetadataBindingResource", new()
{
    BusinessMetadataName = "string",
    EntityName = "string",
    EntityType = "string",
    Attributes = 
    {
        { "string", "string" },
    },
    Credentials = new ConfluentCloud.Inputs.BusinessMetadataBindingCredentialsArgs
    {
        Key = "string",
        Secret = "string",
    },
    RestEndpoint = "string",
    SchemaRegistryCluster = new ConfluentCloud.Inputs.BusinessMetadataBindingSchemaRegistryClusterArgs
    {
        Id = "string",
    },
});
Copy
example, err := confluentcloud.NewBusinessMetadataBinding(ctx, "businessMetadataBindingResource", &confluentcloud.BusinessMetadataBindingArgs{
	BusinessMetadataName: pulumi.String("string"),
	EntityName:           pulumi.String("string"),
	EntityType:           pulumi.String("string"),
	Attributes: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Credentials: &confluentcloud.BusinessMetadataBindingCredentialsArgs{
		Key:    pulumi.String("string"),
		Secret: pulumi.String("string"),
	},
	RestEndpoint: pulumi.String("string"),
	SchemaRegistryCluster: &confluentcloud.BusinessMetadataBindingSchemaRegistryClusterArgs{
		Id: pulumi.String("string"),
	},
})
Copy
var businessMetadataBindingResource = new BusinessMetadataBinding("businessMetadataBindingResource", BusinessMetadataBindingArgs.builder()
    .businessMetadataName("string")
    .entityName("string")
    .entityType("string")
    .attributes(Map.of("string", "string"))
    .credentials(BusinessMetadataBindingCredentialsArgs.builder()
        .key("string")
        .secret("string")
        .build())
    .restEndpoint("string")
    .schemaRegistryCluster(BusinessMetadataBindingSchemaRegistryClusterArgs.builder()
        .id("string")
        .build())
    .build());
Copy
business_metadata_binding_resource = confluentcloud.BusinessMetadataBinding("businessMetadataBindingResource",
    business_metadata_name="string",
    entity_name="string",
    entity_type="string",
    attributes={
        "string": "string",
    },
    credentials={
        "key": "string",
        "secret": "string",
    },
    rest_endpoint="string",
    schema_registry_cluster={
        "id": "string",
    })
Copy
const businessMetadataBindingResource = new confluentcloud.BusinessMetadataBinding("businessMetadataBindingResource", {
    businessMetadataName: "string",
    entityName: "string",
    entityType: "string",
    attributes: {
        string: "string",
    },
    credentials: {
        key: "string",
        secret: "string",
    },
    restEndpoint: "string",
    schemaRegistryCluster: {
        id: "string",
    },
});
Copy
type: confluentcloud:BusinessMetadataBinding
properties:
    attributes:
        string: string
    businessMetadataName: string
    credentials:
        key: string
        secret: string
    entityName: string
    entityType: string
    restEndpoint: string
    schemaRegistryCluster:
        id: string
Copy

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

BusinessMetadataName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Business Metadata to be applied, for example, PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.
EntityName This property is required. string
The qualified name of the entity, for example, ${data.confluent_schema_registry_cluster.essentials.id}:.:${confluent_schema.purchase.schema_identifier}, ${data.confluent_schema_registry_cluster.essentials.id}:${confluent_kafka_cluster.basic.id}:${confluent_kafka_topic.purchase.topic_name}. Refer to the Examples of qualified names to see the full list of supported values for the entity_name attribute.
EntityType
This property is required.
Changes to this property will trigger replacement.
string
The entity type, for example, sr_schema. Refer to the Entity types to learn more about entity types.
Attributes Dictionary<string, string>
The attributes.
Credentials Pulumi.ConfluentCloud.Inputs.BusinessMetadataBindingCredentials
The Cluster API Credentials.
RestEndpoint Changes to this property will trigger replacement. string
The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
SchemaRegistryCluster Changes to this property will trigger replacement. Pulumi.ConfluentCloud.Inputs.BusinessMetadataBindingSchemaRegistryCluster
BusinessMetadataName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Business Metadata to be applied, for example, PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.
EntityName This property is required. string
The qualified name of the entity, for example, ${data.confluent_schema_registry_cluster.essentials.id}:.:${confluent_schema.purchase.schema_identifier}, ${data.confluent_schema_registry_cluster.essentials.id}:${confluent_kafka_cluster.basic.id}:${confluent_kafka_topic.purchase.topic_name}. Refer to the Examples of qualified names to see the full list of supported values for the entity_name attribute.
EntityType
This property is required.
Changes to this property will trigger replacement.
string
The entity type, for example, sr_schema. Refer to the Entity types to learn more about entity types.
Attributes map[string]string
The attributes.
Credentials BusinessMetadataBindingCredentialsArgs
The Cluster API Credentials.
RestEndpoint Changes to this property will trigger replacement. string
The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
SchemaRegistryCluster Changes to this property will trigger replacement. BusinessMetadataBindingSchemaRegistryClusterArgs
businessMetadataName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Business Metadata to be applied, for example, PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.
entityName This property is required. String
The qualified name of the entity, for example, ${data.confluent_schema_registry_cluster.essentials.id}:.:${confluent_schema.purchase.schema_identifier}, ${data.confluent_schema_registry_cluster.essentials.id}:${confluent_kafka_cluster.basic.id}:${confluent_kafka_topic.purchase.topic_name}. Refer to the Examples of qualified names to see the full list of supported values for the entity_name attribute.
entityType
This property is required.
Changes to this property will trigger replacement.
String
The entity type, for example, sr_schema. Refer to the Entity types to learn more about entity types.
attributes Map<String,String>
The attributes.
credentials BusinessMetadataBindingCredentials
The Cluster API Credentials.
restEndpoint Changes to this property will trigger replacement. String
The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
schemaRegistryCluster Changes to this property will trigger replacement. BusinessMetadataBindingSchemaRegistryCluster
businessMetadataName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Business Metadata to be applied, for example, PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.
entityName This property is required. string
The qualified name of the entity, for example, ${data.confluent_schema_registry_cluster.essentials.id}:.:${confluent_schema.purchase.schema_identifier}, ${data.confluent_schema_registry_cluster.essentials.id}:${confluent_kafka_cluster.basic.id}:${confluent_kafka_topic.purchase.topic_name}. Refer to the Examples of qualified names to see the full list of supported values for the entity_name attribute.
entityType
This property is required.
Changes to this property will trigger replacement.
string
The entity type, for example, sr_schema. Refer to the Entity types to learn more about entity types.
attributes {[key: string]: string}
The attributes.
credentials BusinessMetadataBindingCredentials
The Cluster API Credentials.
restEndpoint Changes to this property will trigger replacement. string
The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
schemaRegistryCluster Changes to this property will trigger replacement. BusinessMetadataBindingSchemaRegistryCluster
business_metadata_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Business Metadata to be applied, for example, PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.
entity_name This property is required. str
The qualified name of the entity, for example, ${data.confluent_schema_registry_cluster.essentials.id}:.:${confluent_schema.purchase.schema_identifier}, ${data.confluent_schema_registry_cluster.essentials.id}:${confluent_kafka_cluster.basic.id}:${confluent_kafka_topic.purchase.topic_name}. Refer to the Examples of qualified names to see the full list of supported values for the entity_name attribute.
entity_type
This property is required.
Changes to this property will trigger replacement.
str
The entity type, for example, sr_schema. Refer to the Entity types to learn more about entity types.
attributes Mapping[str, str]
The attributes.
credentials BusinessMetadataBindingCredentialsArgs
The Cluster API Credentials.
rest_endpoint Changes to this property will trigger replacement. str
The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
schema_registry_cluster Changes to this property will trigger replacement. BusinessMetadataBindingSchemaRegistryClusterArgs
businessMetadataName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Business Metadata to be applied, for example, PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.
entityName This property is required. String
The qualified name of the entity, for example, ${data.confluent_schema_registry_cluster.essentials.id}:.:${confluent_schema.purchase.schema_identifier}, ${data.confluent_schema_registry_cluster.essentials.id}:${confluent_kafka_cluster.basic.id}:${confluent_kafka_topic.purchase.topic_name}. Refer to the Examples of qualified names to see the full list of supported values for the entity_name attribute.
entityType
This property is required.
Changes to this property will trigger replacement.
String
The entity type, for example, sr_schema. Refer to the Entity types to learn more about entity types.
attributes Map<String>
The attributes.
credentials Property Map
The Cluster API Credentials.
restEndpoint Changes to this property will trigger replacement. String
The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
schemaRegistryCluster Changes to this property will trigger replacement. Property Map

Outputs

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

Get an existing BusinessMetadataBinding 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?: BusinessMetadataBindingState, opts?: CustomResourceOptions): BusinessMetadataBinding
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        attributes: Optional[Mapping[str, str]] = None,
        business_metadata_name: Optional[str] = None,
        credentials: Optional[BusinessMetadataBindingCredentialsArgs] = None,
        entity_name: Optional[str] = None,
        entity_type: Optional[str] = None,
        rest_endpoint: Optional[str] = None,
        schema_registry_cluster: Optional[BusinessMetadataBindingSchemaRegistryClusterArgs] = None) -> BusinessMetadataBinding
func GetBusinessMetadataBinding(ctx *Context, name string, id IDInput, state *BusinessMetadataBindingState, opts ...ResourceOption) (*BusinessMetadataBinding, error)
public static BusinessMetadataBinding Get(string name, Input<string> id, BusinessMetadataBindingState? state, CustomResourceOptions? opts = null)
public static BusinessMetadataBinding get(String name, Output<String> id, BusinessMetadataBindingState state, CustomResourceOptions options)
resources:  _:    type: confluentcloud:BusinessMetadataBinding    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:
Attributes Dictionary<string, string>
The attributes.
BusinessMetadataName Changes to this property will trigger replacement. string
The name of the Business Metadata to be applied, for example, PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.
Credentials Pulumi.ConfluentCloud.Inputs.BusinessMetadataBindingCredentials
The Cluster API Credentials.
EntityName string
The qualified name of the entity, for example, ${data.confluent_schema_registry_cluster.essentials.id}:.:${confluent_schema.purchase.schema_identifier}, ${data.confluent_schema_registry_cluster.essentials.id}:${confluent_kafka_cluster.basic.id}:${confluent_kafka_topic.purchase.topic_name}. Refer to the Examples of qualified names to see the full list of supported values for the entity_name attribute.
EntityType Changes to this property will trigger replacement. string
The entity type, for example, sr_schema. Refer to the Entity types to learn more about entity types.
RestEndpoint Changes to this property will trigger replacement. string
The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
SchemaRegistryCluster Changes to this property will trigger replacement. Pulumi.ConfluentCloud.Inputs.BusinessMetadataBindingSchemaRegistryCluster
Attributes map[string]string
The attributes.
BusinessMetadataName Changes to this property will trigger replacement. string
The name of the Business Metadata to be applied, for example, PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.
Credentials BusinessMetadataBindingCredentialsArgs
The Cluster API Credentials.
EntityName string
The qualified name of the entity, for example, ${data.confluent_schema_registry_cluster.essentials.id}:.:${confluent_schema.purchase.schema_identifier}, ${data.confluent_schema_registry_cluster.essentials.id}:${confluent_kafka_cluster.basic.id}:${confluent_kafka_topic.purchase.topic_name}. Refer to the Examples of qualified names to see the full list of supported values for the entity_name attribute.
EntityType Changes to this property will trigger replacement. string
The entity type, for example, sr_schema. Refer to the Entity types to learn more about entity types.
RestEndpoint Changes to this property will trigger replacement. string
The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
SchemaRegistryCluster Changes to this property will trigger replacement. BusinessMetadataBindingSchemaRegistryClusterArgs
attributes Map<String,String>
The attributes.
businessMetadataName Changes to this property will trigger replacement. String
The name of the Business Metadata to be applied, for example, PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.
credentials BusinessMetadataBindingCredentials
The Cluster API Credentials.
entityName String
The qualified name of the entity, for example, ${data.confluent_schema_registry_cluster.essentials.id}:.:${confluent_schema.purchase.schema_identifier}, ${data.confluent_schema_registry_cluster.essentials.id}:${confluent_kafka_cluster.basic.id}:${confluent_kafka_topic.purchase.topic_name}. Refer to the Examples of qualified names to see the full list of supported values for the entity_name attribute.
entityType Changes to this property will trigger replacement. String
The entity type, for example, sr_schema. Refer to the Entity types to learn more about entity types.
restEndpoint Changes to this property will trigger replacement. String
The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
schemaRegistryCluster Changes to this property will trigger replacement. BusinessMetadataBindingSchemaRegistryCluster
attributes {[key: string]: string}
The attributes.
businessMetadataName Changes to this property will trigger replacement. string
The name of the Business Metadata to be applied, for example, PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.
credentials BusinessMetadataBindingCredentials
The Cluster API Credentials.
entityName string
The qualified name of the entity, for example, ${data.confluent_schema_registry_cluster.essentials.id}:.:${confluent_schema.purchase.schema_identifier}, ${data.confluent_schema_registry_cluster.essentials.id}:${confluent_kafka_cluster.basic.id}:${confluent_kafka_topic.purchase.topic_name}. Refer to the Examples of qualified names to see the full list of supported values for the entity_name attribute.
entityType Changes to this property will trigger replacement. string
The entity type, for example, sr_schema. Refer to the Entity types to learn more about entity types.
restEndpoint Changes to this property will trigger replacement. string
The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
schemaRegistryCluster Changes to this property will trigger replacement. BusinessMetadataBindingSchemaRegistryCluster
attributes Mapping[str, str]
The attributes.
business_metadata_name Changes to this property will trigger replacement. str
The name of the Business Metadata to be applied, for example, PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.
credentials BusinessMetadataBindingCredentialsArgs
The Cluster API Credentials.
entity_name str
The qualified name of the entity, for example, ${data.confluent_schema_registry_cluster.essentials.id}:.:${confluent_schema.purchase.schema_identifier}, ${data.confluent_schema_registry_cluster.essentials.id}:${confluent_kafka_cluster.basic.id}:${confluent_kafka_topic.purchase.topic_name}. Refer to the Examples of qualified names to see the full list of supported values for the entity_name attribute.
entity_type Changes to this property will trigger replacement. str
The entity type, for example, sr_schema. Refer to the Entity types to learn more about entity types.
rest_endpoint Changes to this property will trigger replacement. str
The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
schema_registry_cluster Changes to this property will trigger replacement. BusinessMetadataBindingSchemaRegistryClusterArgs
attributes Map<String>
The attributes.
businessMetadataName Changes to this property will trigger replacement. String
The name of the Business Metadata to be applied, for example, PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.
credentials Property Map
The Cluster API Credentials.
entityName String
The qualified name of the entity, for example, ${data.confluent_schema_registry_cluster.essentials.id}:.:${confluent_schema.purchase.schema_identifier}, ${data.confluent_schema_registry_cluster.essentials.id}:${confluent_kafka_cluster.basic.id}:${confluent_kafka_topic.purchase.topic_name}. Refer to the Examples of qualified names to see the full list of supported values for the entity_name attribute.
entityType Changes to this property will trigger replacement. String
The entity type, for example, sr_schema. Refer to the Entity types to learn more about entity types.
restEndpoint Changes to this property will trigger replacement. String
The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
schemaRegistryCluster Changes to this property will trigger replacement. Property Map

Supporting Types

BusinessMetadataBindingCredentials
, BusinessMetadataBindingCredentialsArgs

Key This property is required. string
The Schema Registry API Key.
Secret This property is required. string
The Schema Registry API Secret.
Key This property is required. string
The Schema Registry API Key.
Secret This property is required. string
The Schema Registry API Secret.
key This property is required. String
The Schema Registry API Key.
secret This property is required. String
The Schema Registry API Secret.
key This property is required. string
The Schema Registry API Key.
secret This property is required. string
The Schema Registry API Secret.
key This property is required. str
The Schema Registry API Key.
secret This property is required. str
The Schema Registry API Secret.
key This property is required. String
The Schema Registry API Key.
secret This property is required. String
The Schema Registry API Secret.

BusinessMetadataBindingSchemaRegistryCluster
, BusinessMetadataBindingSchemaRegistryClusterArgs

Id
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Schema Registry cluster, for example, lsrc-abc123.
Id
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Schema Registry cluster, for example, lsrc-abc123.
id
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Schema Registry cluster, for example, lsrc-abc123.
id
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Schema Registry cluster, for example, lsrc-abc123.
id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the Schema Registry cluster, for example, lsrc-abc123.
id
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Schema Registry cluster, for example, lsrc-abc123.

Import

You can import a Business Metadata Binding by using the Schema Registry cluster ID, Business Metadata name, entity name and entity type in the format <Schema Registry Cluster Id>/<Business Metadata Name>/<Entity Name>/<Entity Type>, for example:

$ export IMPORT_SCHEMA_REGISTRY_API_KEY="<schema_registry_api_key>"

$ export IMPORT_SCHEMA_REGISTRY_API_SECRET="<schema_registry_api_secret>"

$ export IMPORT_CATALOG_REST_ENDPOINT="<catalog_rest_endpoint>"

$ pulumi import confluentcloud:index/businessMetadataBinding:BusinessMetadataBinding main lsrc-8wrx70/PII/lsrc-8wrx70:.:100001/sr_schema
Copy

!> Warning: Do not forget to delete terminal command history afterwards for security purposes.

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

Package Details

Repository
Confluent Cloud pulumi/pulumi-confluentcloud
License
Apache-2.0
Notes
This Pulumi package is based on the confluent Terraform Provider.
Confluent v2.22.0 published on Friday, Mar 28, 2025 by Pulumi
pulumi/pulumi-confluentcloud