Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Confluent Provider
  3. API Docs
  4. getBusinessMetadata
Confluent v2.28.0 published on Wednesday, May 14, 2025 by Pulumi
pulumi/pulumi-confluentcloud

confluentcloud.getBusinessMetadata

Explore with Pulumi AI

confluentcloud logo
Confluent v2.28.0 published on Wednesday, May 14, 2025 by Pulumi
pulumi/pulumi-confluentcloud

    General Availability

    confluentcloud.BusinessMetadata describes a Business Metadata data source.

    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 pii = confluentcloud.getBusinessMetadata({
    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>",
    },
    name: "PII",
});

    import pulumi
import pulumi_confluentcloud as confluentcloud

pii = confluentcloud.get_business_metadata(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>",
    },
    name="PII")

    package main

import (
	"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 {
		_, err := confluentcloud.LookupBusinessMetadata(ctx, &confluentcloud.LookupBusinessMetadataArgs{
			SchemaRegistryCluster: confluentcloud.GetBusinessMetadataSchemaRegistryCluster{
				Id: essentials.Id,
			},
			RestEndpoint: pulumi.StringRef(essentials.RestEndpoint),
			Credentials: confluentcloud.GetBusinessMetadataCredentials{
				Key:    "<Schema Registry API Key for data.confluent_schema_registry_cluster.essentials>",
				Secret: "<Schema Registry API Secret for data.confluent_schema_registry_cluster.essentials>",
			},
			Name: "PII",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var pii = ConfluentCloud.GetBusinessMetadata.Invoke(new()
    {
        SchemaRegistryCluster = new ConfluentCloud.Inputs.GetBusinessMetadataSchemaRegistryClusterInputArgs
        {
            Id = essentials.Id,
        },
        RestEndpoint = essentials.RestEndpoint,
        Credentials = new ConfluentCloud.Inputs.GetBusinessMetadataCredentialsInputArgs
        {
            Key = "<Schema Registry API Key for data.confluent_schema_registry_cluster.essentials>",
            Secret = "<Schema Registry API Secret for data.confluent_schema_registry_cluster.essentials>",
        },
        Name = "PII",
    });

});

    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.GetBusinessMetadataArgs;
import com.pulumi.confluentcloud.inputs.GetBusinessMetadataSchemaRegistryClusterArgs;
import com.pulumi.confluentcloud.inputs.GetBusinessMetadataCredentialsArgs;
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 pii = ConfluentcloudFunctions.getBusinessMetadata(GetBusinessMetadataArgs.builder()
            .schemaRegistryCluster(GetBusinessMetadataSchemaRegistryClusterArgs.builder()
                .id(essentials.id())
                .build())
            .restEndpoint(essentials.restEndpoint())
            .credentials(GetBusinessMetadataCredentialsArgs.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())
            .name("PII")
            .build());

    }
}

    variables:
  pii:
    fn::invoke:
      function: confluentcloud:getBusinessMetadata
      arguments:
        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>
        name: PII

    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 pii = confluentcloud.getBusinessMetadata({
    name: "PII",
});

    import pulumi
import pulumi_confluentcloud as confluentcloud

pii = confluentcloud.get_business_metadata(name="PII")

    package main

import (
	"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 {
		_, err := confluentcloud.LookupBusinessMetadata(ctx, &confluentcloud.LookupBusinessMetadataArgs{
			Name: "PII",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var pii = ConfluentCloud.GetBusinessMetadata.Invoke(new()
    {
        Name = "PII",
    });

});

    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.GetBusinessMetadataArgs;
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 pii = ConfluentcloudFunctions.getBusinessMetadata(GetBusinessMetadataArgs.builder()
            .name("PII")
            .build());

    }
}

    variables:
  pii:
    fn::invoke:
      function: confluentcloud:getBusinessMetadata
      arguments:
        name: PII

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

    Using getBusinessMetadata

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getBusinessMetadata(args: GetBusinessMetadataArgs, opts?: InvokeOptions): Promise<GetBusinessMetadataResult>
function getBusinessMetadataOutput(args: GetBusinessMetadataOutputArgs, opts?: InvokeOptions): Output<GetBusinessMetadataResult>
    def get_business_metadata(credentials: Optional[GetBusinessMetadataCredentials] = None,
                          name: Optional[str] = None,
                          rest_endpoint: Optional[str] = None,
                          schema_registry_cluster: Optional[GetBusinessMetadataSchemaRegistryCluster] = None,
                          opts: Optional[InvokeOptions] = None) -> GetBusinessMetadataResult
def get_business_metadata_output(credentials: Optional[pulumi.Input[GetBusinessMetadataCredentialsArgs]] = None,
                          name: Optional[pulumi.Input[str]] = None,
                          rest_endpoint: Optional[pulumi.Input[str]] = None,
                          schema_registry_cluster: Optional[pulumi.Input[GetBusinessMetadataSchemaRegistryClusterArgs]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetBusinessMetadataResult]
    func LookupBusinessMetadata(ctx *Context, args *LookupBusinessMetadataArgs, opts ...InvokeOption) (*LookupBusinessMetadataResult, error)
func LookupBusinessMetadataOutput(ctx *Context, args *LookupBusinessMetadataOutputArgs, opts ...InvokeOption) LookupBusinessMetadataResultOutput

    > Note: This function is named LookupBusinessMetadata in the Go SDK.

    public static class GetBusinessMetadata 
{
    public static Task<GetBusinessMetadataResult> InvokeAsync(GetBusinessMetadataArgs args, InvokeOptions? opts = null)
    public static Output<GetBusinessMetadataResult> Invoke(GetBusinessMetadataInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBusinessMetadataResult> getBusinessMetadata(GetBusinessMetadataArgs args, InvokeOptions options)
public static Output<GetBusinessMetadataResult> getBusinessMetadata(GetBusinessMetadataArgs args, InvokeOptions options)

    fn::invoke:
  function: confluentcloud:index/getBusinessMetadata:getBusinessMetadata
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string

    The name of the Business Metadata, for example, PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.

    Note: A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.

    Credentials Pulumi.ConfluentCloud.Inputs.GetBusinessMetadataCredentials
    RestEndpoint string
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    SchemaRegistryCluster Pulumi.ConfluentCloud.Inputs.GetBusinessMetadataSchemaRegistryCluster
    Name string

    The name of the Business Metadata, for example, PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.

    Note: A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.

    Credentials GetBusinessMetadataCredentials
    RestEndpoint string
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    SchemaRegistryCluster GetBusinessMetadataSchemaRegistryCluster
    name String

    The name of the Business Metadata, for example, PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.

    Note: A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.

    credentials GetBusinessMetadataCredentials
    restEndpoint String
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    schemaRegistryCluster GetBusinessMetadataSchemaRegistryCluster
    name string

    The name of the Business Metadata, for example, PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.

    Note: A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.

    credentials GetBusinessMetadataCredentials
    restEndpoint string
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    schemaRegistryCluster GetBusinessMetadataSchemaRegistryCluster
    name str

    The name of the Business Metadata, for example, PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.

    Note: A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.

    credentials GetBusinessMetadataCredentials
    rest_endpoint str
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    schema_registry_cluster GetBusinessMetadataSchemaRegistryCluster
    name String

    The name of the Business Metadata, for example, PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.

    Note: A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.

    credentials Property Map
    restEndpoint String
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    schemaRegistryCluster Property Map

    getBusinessMetadata Result

    The following output properties are available:

    AttributeDefinitions List<Pulumi.ConfluentCloud.Outputs.GetBusinessMetadataAttributeDefinition>
    (Optional List) The list of attribute definitions (see Business Metadata for more details):
    Description string
    (Optional String) The description of this attribute.
    Id string
    (Required String) The ID of the Business Metadata, in the format <Schema Registry cluster ID>/<Business Metadata name>, for example, lsrc-8wrx70/PII.
    Name string
    (Required String) The name of the attribute.
    Version int
    (Required Integer) The version of the Business Metadata, for example, 1.
    Credentials Pulumi.ConfluentCloud.Outputs.GetBusinessMetadataCredentials
    RestEndpoint string
    SchemaRegistryCluster Pulumi.ConfluentCloud.Outputs.GetBusinessMetadataSchemaRegistryCluster
    AttributeDefinitions []GetBusinessMetadataAttributeDefinition
    (Optional List) The list of attribute definitions (see Business Metadata for more details):
    Description string
    (Optional String) The description of this attribute.
    Id string
    (Required String) The ID of the Business Metadata, in the format <Schema Registry cluster ID>/<Business Metadata name>, for example, lsrc-8wrx70/PII.
    Name string
    (Required String) The name of the attribute.
    Version int
    (Required Integer) The version of the Business Metadata, for example, 1.
    Credentials GetBusinessMetadataCredentials
    RestEndpoint string
    SchemaRegistryCluster GetBusinessMetadataSchemaRegistryCluster
    attributeDefinitions List<GetBusinessMetadataAttributeDefinition>
    (Optional List) The list of attribute definitions (see Business Metadata for more details):
    description String
    (Optional String) The description of this attribute.
    id String
    (Required String) The ID of the Business Metadata, in the format <Schema Registry cluster ID>/<Business Metadata name>, for example, lsrc-8wrx70/PII.
    name String
    (Required String) The name of the attribute.
    version Integer
    (Required Integer) The version of the Business Metadata, for example, 1.
    credentials GetBusinessMetadataCredentials
    restEndpoint String
    schemaRegistryCluster GetBusinessMetadataSchemaRegistryCluster
    attributeDefinitions GetBusinessMetadataAttributeDefinition[]
    (Optional List) The list of attribute definitions (see Business Metadata for more details):
    description string
    (Optional String) The description of this attribute.
    id string
    (Required String) The ID of the Business Metadata, in the format <Schema Registry cluster ID>/<Business Metadata name>, for example, lsrc-8wrx70/PII.
    name string
    (Required String) The name of the attribute.
    version number
    (Required Integer) The version of the Business Metadata, for example, 1.
    credentials GetBusinessMetadataCredentials
    restEndpoint string
    schemaRegistryCluster GetBusinessMetadataSchemaRegistryCluster
    attribute_definitions Sequence[GetBusinessMetadataAttributeDefinition]
    (Optional List) The list of attribute definitions (see Business Metadata for more details):
    description str
    (Optional String) The description of this attribute.
    id str
    (Required String) The ID of the Business Metadata, in the format <Schema Registry cluster ID>/<Business Metadata name>, for example, lsrc-8wrx70/PII.
    name str
    (Required String) The name of the attribute.
    version int
    (Required Integer) The version of the Business Metadata, for example, 1.
    credentials GetBusinessMetadataCredentials
    rest_endpoint str
    schema_registry_cluster GetBusinessMetadataSchemaRegistryCluster
    attributeDefinitions List<Property Map>
    (Optional List) The list of attribute definitions (see Business Metadata for more details):
    description String
    (Optional String) The description of this attribute.
    id String
    (Required String) The ID of the Business Metadata, in the format <Schema Registry cluster ID>/<Business Metadata name>, for example, lsrc-8wrx70/PII.
    name String
    (Required String) The name of the attribute.
    version Number
    (Required Integer) The version of the Business Metadata, for example, 1.
    credentials Property Map
    restEndpoint String
    schemaRegistryCluster Property Map

    Supporting Types

    GetBusinessMetadataAttributeDefinition

    DefaultValue string
    (Optional String) The default value of this attribute.
    Description string
    (Optional String) The description of this attribute.
    IsOptional bool
    (Optional Boolean) An optional flag to control whether the attribute should be optional or required.
    Name string

    The name of the Business Metadata, for example, PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.

    Note: A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.

    Options Dictionary<string, string>
    (Optional Map) Block for the attribute options:

    • applicableEntityTypes - (Optional String) The entity types that the attribute is applicable, it always returns [\"cf_entity\"].
    • maxStrLength - (Optional String) The maximum length of the string value, it always returns 5000.
    Type string
    (Required String) The type of the attribute, it always returns string.
    DefaultValue string
    (Optional String) The default value of this attribute.
    Description string
    (Optional String) The description of this attribute.
    IsOptional bool
    (Optional Boolean) An optional flag to control whether the attribute should be optional or required.
    Name string

    The name of the Business Metadata, for example, PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.

    Note: A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.

    Options map[string]string
    (Optional Map) Block for the attribute options:

    • applicableEntityTypes - (Optional String) The entity types that the attribute is applicable, it always returns [\"cf_entity\"].
    • maxStrLength - (Optional String) The maximum length of the string value, it always returns 5000.
    Type string
    (Required String) The type of the attribute, it always returns string.
    defaultValue String
    (Optional String) The default value of this attribute.
    description String
    (Optional String) The description of this attribute.
    isOptional Boolean
    (Optional Boolean) An optional flag to control whether the attribute should be optional or required.
    name String

    The name of the Business Metadata, for example, PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.

    Note: A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.

    options Map<String,String>
    (Optional Map) Block for the attribute options:

    • applicableEntityTypes - (Optional String) The entity types that the attribute is applicable, it always returns [\"cf_entity\"].
    • maxStrLength - (Optional String) The maximum length of the string value, it always returns 5000.
    type String
    (Required String) The type of the attribute, it always returns string.
    defaultValue string
    (Optional String) The default value of this attribute.
    description string
    (Optional String) The description of this attribute.
    isOptional boolean
    (Optional Boolean) An optional flag to control whether the attribute should be optional or required.
    name string

    The name of the Business Metadata, for example, PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.

    Note: A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.

    options {[key: string]: string}
    (Optional Map) Block for the attribute options:

    • applicableEntityTypes - (Optional String) The entity types that the attribute is applicable, it always returns [\"cf_entity\"].
    • maxStrLength - (Optional String) The maximum length of the string value, it always returns 5000.
    type string
    (Required String) The type of the attribute, it always returns string.
    default_value str
    (Optional String) The default value of this attribute.
    description str
    (Optional String) The description of this attribute.
    is_optional bool
    (Optional Boolean) An optional flag to control whether the attribute should be optional or required.
    name str

    The name of the Business Metadata, for example, PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.

    Note: A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.

    options Mapping[str, str]
    (Optional Map) Block for the attribute options:

    • applicableEntityTypes - (Optional String) The entity types that the attribute is applicable, it always returns [\"cf_entity\"].
    • maxStrLength - (Optional String) The maximum length of the string value, it always returns 5000.
    type str
    (Required String) The type of the attribute, it always returns string.
    defaultValue String
    (Optional String) The default value of this attribute.
    description String
    (Optional String) The description of this attribute.
    isOptional Boolean
    (Optional Boolean) An optional flag to control whether the attribute should be optional or required.
    name String

    The name of the Business Metadata, for example, PII. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.

    Note: A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.

    options Map<String>
    (Optional Map) Block for the attribute options:

    • applicableEntityTypes - (Optional String) The entity types that the attribute is applicable, it always returns [\"cf_entity\"].
    • maxStrLength - (Optional String) The maximum length of the string value, it always returns 5000.
    type String
    (Required String) The type of the attribute, it always returns string.

    GetBusinessMetadataCredentials

    Key string
    The Schema Registry API Key.
    Secret string
    The Schema Registry API Secret.
    Key string
    The Schema Registry API Key.
    Secret string
    The Schema Registry API Secret.
    key String
    The Schema Registry API Key.
    secret String
    The Schema Registry API Secret.
    key string
    The Schema Registry API Key.
    secret string
    The Schema Registry API Secret.
    key str
    The Schema Registry API Key.
    secret str
    The Schema Registry API Secret.
    key String
    The Schema Registry API Key.
    secret String
    The Schema Registry API Secret.

    GetBusinessMetadataSchemaRegistryCluster

    Id string
    The ID of the Schema Registry cluster, for example, lsrc-abc123.
    Id string
    The ID of the Schema Registry cluster, for example, lsrc-abc123.
    id String
    The ID of the Schema Registry cluster, for example, lsrc-abc123.
    id string
    The ID of the Schema Registry cluster, for example, lsrc-abc123.
    id str
    The ID of the Schema Registry cluster, for example, lsrc-abc123.
    id String
    The ID of the Schema Registry cluster, for example, lsrc-abc123.

    Package Details

    Repository
    Confluent Cloud pulumi/pulumi-confluentcloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the confluent Terraform Provider.
    confluentcloud logo
    Confluent v2.28.0 published on Wednesday, May 14, 2025 by Pulumi
    pulumi/pulumi-confluentcloud