Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Confluent Provider
  3. API Docs
  4. BusinessMetadata
Confluent v2.24.0 published on Saturday, Apr 19, 2025 by Pulumi
pulumi/pulumi-confluentcloud

confluentcloud.BusinessMetadata

Explore with Pulumi AI

Confluent v2.24.0 published on Saturday, Apr 19, 2025 by Pulumi
pulumi/pulumi-confluentcloud

General Availability

confluentcloud.BusinessMetadata provides a Business Metadata resource that enables creating, editing, and deleting Business Metadata 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 pii = new confluentcloud.BusinessMetadata("pii", {
    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",
    description: "PII metadata",
    attributeDefinitions: [
        {
            name: "team",
        },
        {
            name: "email",
        },
    ],
});
Copy
import pulumi
import pulumi_confluentcloud as confluentcloud

pii = confluentcloud.BusinessMetadata("pii",
    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",
    description="PII metadata",
    attribute_definitions=[
        {
            "name": "team",
        },
        {
            "name": "email",
        },
    ])
Copy
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.NewBusinessMetadata(ctx, "pii", &confluentcloud.BusinessMetadataArgs{
			SchemaRegistryCluster: &confluentcloud.BusinessMetadataSchemaRegistryClusterArgs{
				Id: pulumi.Any(essentials.Id),
			},
			RestEndpoint: pulumi.Any(essentials.RestEndpoint),
			Credentials: &confluentcloud.BusinessMetadataCredentialsArgs{
				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>"),
			},
			Name:        pulumi.String("PII"),
			Description: pulumi.String("PII metadata"),
			AttributeDefinitions: confluentcloud.BusinessMetadataAttributeDefinitionArray{
				&confluentcloud.BusinessMetadataAttributeDefinitionArgs{
					Name: pulumi.String("team"),
				},
				&confluentcloud.BusinessMetadataAttributeDefinitionArgs{
					Name: pulumi.String("email"),
				},
			},
		})
		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 pii = new ConfluentCloud.BusinessMetadata("pii", new()
    {
        SchemaRegistryCluster = new ConfluentCloud.Inputs.BusinessMetadataSchemaRegistryClusterArgs
        {
            Id = essentials.Id,
        },
        RestEndpoint = essentials.RestEndpoint,
        Credentials = new ConfluentCloud.Inputs.BusinessMetadataCredentialsArgs
        {
            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",
        Description = "PII metadata",
        AttributeDefinitions = new[]
        {
            new ConfluentCloud.Inputs.BusinessMetadataAttributeDefinitionArgs
            {
                Name = "team",
            },
            new ConfluentCloud.Inputs.BusinessMetadataAttributeDefinitionArgs
            {
                Name = "email",
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.BusinessMetadata;
import com.pulumi.confluentcloud.BusinessMetadataArgs;
import com.pulumi.confluentcloud.inputs.BusinessMetadataSchemaRegistryClusterArgs;
import com.pulumi.confluentcloud.inputs.BusinessMetadataCredentialsArgs;
import com.pulumi.confluentcloud.inputs.BusinessMetadataAttributeDefinitionArgs;
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 pii = new BusinessMetadata("pii", BusinessMetadataArgs.builder()
            .schemaRegistryCluster(BusinessMetadataSchemaRegistryClusterArgs.builder()
                .id(essentials.id())
                .build())
            .restEndpoint(essentials.restEndpoint())
            .credentials(BusinessMetadataCredentialsArgs.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")
            .description("PII metadata")
            .attributeDefinitions(            
                BusinessMetadataAttributeDefinitionArgs.builder()
                    .name("team")
                    .build(),
                BusinessMetadataAttributeDefinitionArgs.builder()
                    .name("email")
                    .build())
            .build());

    }
}
Copy
resources:
  pii:
    type: confluentcloud:BusinessMetadata
    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>
      name: PII
      description: PII metadata
      attributeDefinitions:
        - name: team
        - name: email
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 pii = new confluentcloud.BusinessMetadata("pii", {
    name: "PII",
    description: "PII metadata",
    attributeDefinitions: [
        {
            name: "team",
        },
        {
            name: "email",
        },
    ],
});
Copy
import pulumi
import pulumi_confluentcloud as confluentcloud

pii = confluentcloud.BusinessMetadata("pii",
    name="PII",
    description="PII metadata",
    attribute_definitions=[
        {
            "name": "team",
        },
        {
            "name": "email",
        },
    ])
Copy
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.NewBusinessMetadata(ctx, "pii", &confluentcloud.BusinessMetadataArgs{
			Name:        pulumi.String("PII"),
			Description: pulumi.String("PII metadata"),
			AttributeDefinitions: confluentcloud.BusinessMetadataAttributeDefinitionArray{
				&confluentcloud.BusinessMetadataAttributeDefinitionArgs{
					Name: pulumi.String("team"),
				},
				&confluentcloud.BusinessMetadataAttributeDefinitionArgs{
					Name: pulumi.String("email"),
				},
			},
		})
		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 pii = new ConfluentCloud.BusinessMetadata("pii", new()
    {
        Name = "PII",
        Description = "PII metadata",
        AttributeDefinitions = new[]
        {
            new ConfluentCloud.Inputs.BusinessMetadataAttributeDefinitionArgs
            {
                Name = "team",
            },
            new ConfluentCloud.Inputs.BusinessMetadataAttributeDefinitionArgs
            {
                Name = "email",
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.BusinessMetadata;
import com.pulumi.confluentcloud.BusinessMetadataArgs;
import com.pulumi.confluentcloud.inputs.BusinessMetadataAttributeDefinitionArgs;
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 pii = new BusinessMetadata("pii", BusinessMetadataArgs.builder()
            .name("PII")
            .description("PII metadata")
            .attributeDefinitions(            
                BusinessMetadataAttributeDefinitionArgs.builder()
                    .name("team")
                    .build(),
                BusinessMetadataAttributeDefinitionArgs.builder()
                    .name("email")
                    .build())
            .build());

    }
}
Copy
resources:
  pii:
    type: confluentcloud:BusinessMetadata
    properties:
      name: PII
      description: PII metadata
      attributeDefinitions:
        - name: team
        - name: email
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 BusinessMetadata Resource

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

Constructor syntax

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

@overload
def BusinessMetadata(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     attribute_definitions: Optional[Sequence[BusinessMetadataAttributeDefinitionArgs]] = None,
                     credentials: Optional[BusinessMetadataCredentialsArgs] = None,
                     description: Optional[str] = None,
                     name: Optional[str] = None,
                     rest_endpoint: Optional[str] = None,
                     schema_registry_cluster: Optional[BusinessMetadataSchemaRegistryClusterArgs] = None)
func NewBusinessMetadata(ctx *Context, name string, args *BusinessMetadataArgs, opts ...ResourceOption) (*BusinessMetadata, error)
public BusinessMetadata(string name, BusinessMetadataArgs? args = null, CustomResourceOptions? opts = null)
public BusinessMetadata(String name, BusinessMetadataArgs args)
public BusinessMetadata(String name, BusinessMetadataArgs args, CustomResourceOptions options)

type: confluentcloud:BusinessMetadata
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 BusinessMetadataArgs
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 BusinessMetadataArgs
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 BusinessMetadataArgs
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 BusinessMetadataArgs
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. BusinessMetadataArgs
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 businessMetadataResource = new ConfluentCloud.BusinessMetadata("businessMetadataResource", new()
{
    AttributeDefinitions = new[]
    {
        new ConfluentCloud.Inputs.BusinessMetadataAttributeDefinitionArgs
        {
            Name = "string",
            DefaultValue = "string",
            Description = "string",
            IsOptional = false,
            Options = 
            {
                { "string", "string" },
            },
            Type = "string",
        },
    },
    Credentials = new ConfluentCloud.Inputs.BusinessMetadataCredentialsArgs
    {
        Key = "string",
        Secret = "string",
    },
    Description = "string",
    Name = "string",
    RestEndpoint = "string",
    SchemaRegistryCluster = new ConfluentCloud.Inputs.BusinessMetadataSchemaRegistryClusterArgs
    {
        Id = "string",
    },
});
Copy
example, err := confluentcloud.NewBusinessMetadata(ctx, "businessMetadataResource", &confluentcloud.BusinessMetadataArgs{
	AttributeDefinitions: confluentcloud.BusinessMetadataAttributeDefinitionArray{
		&confluentcloud.BusinessMetadataAttributeDefinitionArgs{
			Name:         pulumi.String("string"),
			DefaultValue: pulumi.String("string"),
			Description:  pulumi.String("string"),
			IsOptional:   pulumi.Bool(false),
			Options: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			Type: pulumi.String("string"),
		},
	},
	Credentials: &confluentcloud.BusinessMetadataCredentialsArgs{
		Key:    pulumi.String("string"),
		Secret: pulumi.String("string"),
	},
	Description:  pulumi.String("string"),
	Name:         pulumi.String("string"),
	RestEndpoint: pulumi.String("string"),
	SchemaRegistryCluster: &confluentcloud.BusinessMetadataSchemaRegistryClusterArgs{
		Id: pulumi.String("string"),
	},
})
Copy
var businessMetadataResource = new BusinessMetadata("businessMetadataResource", BusinessMetadataArgs.builder()
    .attributeDefinitions(BusinessMetadataAttributeDefinitionArgs.builder()
        .name("string")
        .defaultValue("string")
        .description("string")
        .isOptional(false)
        .options(Map.of("string", "string"))
        .type("string")
        .build())
    .credentials(BusinessMetadataCredentialsArgs.builder()
        .key("string")
        .secret("string")
        .build())
    .description("string")
    .name("string")
    .restEndpoint("string")
    .schemaRegistryCluster(BusinessMetadataSchemaRegistryClusterArgs.builder()
        .id("string")
        .build())
    .build());
Copy
business_metadata_resource = confluentcloud.BusinessMetadata("businessMetadataResource",
    attribute_definitions=[{
        "name": "string",
        "default_value": "string",
        "description": "string",
        "is_optional": False,
        "options": {
            "string": "string",
        },
        "type": "string",
    }],
    credentials={
        "key": "string",
        "secret": "string",
    },
    description="string",
    name="string",
    rest_endpoint="string",
    schema_registry_cluster={
        "id": "string",
    })
Copy
const businessMetadataResource = new confluentcloud.BusinessMetadata("businessMetadataResource", {
    attributeDefinitions: [{
        name: "string",
        defaultValue: "string",
        description: "string",
        isOptional: false,
        options: {
            string: "string",
        },
        type: "string",
    }],
    credentials: {
        key: "string",
        secret: "string",
    },
    description: "string",
    name: "string",
    restEndpoint: "string",
    schemaRegistryCluster: {
        id: "string",
    },
});
Copy
type: confluentcloud:BusinessMetadata
properties:
    attributeDefinitions:
        - defaultValue: string
          description: string
          isOptional: false
          name: string
          options:
            string: string
          type: string
    credentials:
        key: string
        secret: string
    description: string
    name: string
    restEndpoint: string
    schemaRegistryCluster:
        id: string
Copy

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

AttributeDefinitions List<Pulumi.ConfluentCloud.Inputs.BusinessMetadataAttributeDefinition>
The list of attribute definitions (see Business Metadata for more details):
Credentials Pulumi.ConfluentCloud.Inputs.BusinessMetadataCredentials
The Cluster API Credentials.
Description string
The description of the Business Metadata.
Name Changes to this property will trigger replacement. 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.
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.BusinessMetadataSchemaRegistryCluster
AttributeDefinitions []BusinessMetadataAttributeDefinitionArgs
The list of attribute definitions (see Business Metadata for more details):
Credentials BusinessMetadataCredentialsArgs
The Cluster API Credentials.
Description string
The description of the Business Metadata.
Name Changes to this property will trigger replacement. 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.
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. BusinessMetadataSchemaRegistryClusterArgs
attributeDefinitions List<BusinessMetadataAttributeDefinition>
The list of attribute definitions (see Business Metadata for more details):
credentials BusinessMetadataCredentials
The Cluster API Credentials.
description String
The description of the Business Metadata.
name Changes to this property will trigger replacement. 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.
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. BusinessMetadataSchemaRegistryCluster
attributeDefinitions BusinessMetadataAttributeDefinition[]
The list of attribute definitions (see Business Metadata for more details):
credentials BusinessMetadataCredentials
The Cluster API Credentials.
description string
The description of the Business Metadata.
name Changes to this property will trigger replacement. 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.
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. BusinessMetadataSchemaRegistryCluster
attribute_definitions Sequence[BusinessMetadataAttributeDefinitionArgs]
The list of attribute definitions (see Business Metadata for more details):
credentials BusinessMetadataCredentialsArgs
The Cluster API Credentials.
description str
The description of the Business Metadata.
name Changes to this property will trigger replacement. 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.
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. BusinessMetadataSchemaRegistryClusterArgs
attributeDefinitions List<Property Map>
The list of attribute definitions (see Business Metadata for more details):
credentials Property Map
The Cluster API Credentials.
description String
The description of the Business Metadata.
name Changes to this property will trigger replacement. 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.
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 BusinessMetadata resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Version int
(Required Integer) The version of the Business Metadata, for example, 1.
Id string
The provider-assigned unique ID for this managed resource.
Version int
(Required Integer) The version of the Business Metadata, for example, 1.
id String
The provider-assigned unique ID for this managed resource.
version Integer
(Required Integer) The version of the Business Metadata, for example, 1.
id string
The provider-assigned unique ID for this managed resource.
version number
(Required Integer) The version of the Business Metadata, for example, 1.
id str
The provider-assigned unique ID for this managed resource.
version int
(Required Integer) The version of the Business Metadata, for example, 1.
id String
The provider-assigned unique ID for this managed resource.
version Number
(Required Integer) The version of the Business Metadata, for example, 1.

Look up Existing BusinessMetadata Resource

Get an existing BusinessMetadata 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?: BusinessMetadataState, opts?: CustomResourceOptions): BusinessMetadata
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        attribute_definitions: Optional[Sequence[BusinessMetadataAttributeDefinitionArgs]] = None,
        credentials: Optional[BusinessMetadataCredentialsArgs] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        rest_endpoint: Optional[str] = None,
        schema_registry_cluster: Optional[BusinessMetadataSchemaRegistryClusterArgs] = None,
        version: Optional[int] = None) -> BusinessMetadata
func GetBusinessMetadata(ctx *Context, name string, id IDInput, state *BusinessMetadataState, opts ...ResourceOption) (*BusinessMetadata, error)
public static BusinessMetadata Get(string name, Input<string> id, BusinessMetadataState? state, CustomResourceOptions? opts = null)
public static BusinessMetadata get(String name, Output<String> id, BusinessMetadataState state, CustomResourceOptions options)
resources:  _:    type: confluentcloud:BusinessMetadata    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:
AttributeDefinitions List<Pulumi.ConfluentCloud.Inputs.BusinessMetadataAttributeDefinition>
The list of attribute definitions (see Business Metadata for more details):
Credentials Pulumi.ConfluentCloud.Inputs.BusinessMetadataCredentials
The Cluster API Credentials.
Description string
The description of the Business Metadata.
Name Changes to this property will trigger replacement. 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.
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.BusinessMetadataSchemaRegistryCluster
Version int
(Required Integer) The version of the Business Metadata, for example, 1.
AttributeDefinitions []BusinessMetadataAttributeDefinitionArgs
The list of attribute definitions (see Business Metadata for more details):
Credentials BusinessMetadataCredentialsArgs
The Cluster API Credentials.
Description string
The description of the Business Metadata.
Name Changes to this property will trigger replacement. 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.
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. BusinessMetadataSchemaRegistryClusterArgs
Version int
(Required Integer) The version of the Business Metadata, for example, 1.
attributeDefinitions List<BusinessMetadataAttributeDefinition>
The list of attribute definitions (see Business Metadata for more details):
credentials BusinessMetadataCredentials
The Cluster API Credentials.
description String
The description of the Business Metadata.
name Changes to this property will trigger replacement. 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.
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. BusinessMetadataSchemaRegistryCluster
version Integer
(Required Integer) The version of the Business Metadata, for example, 1.
attributeDefinitions BusinessMetadataAttributeDefinition[]
The list of attribute definitions (see Business Metadata for more details):
credentials BusinessMetadataCredentials
The Cluster API Credentials.
description string
The description of the Business Metadata.
name Changes to this property will trigger replacement. 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.
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. BusinessMetadataSchemaRegistryCluster
version number
(Required Integer) The version of the Business Metadata, for example, 1.
attribute_definitions Sequence[BusinessMetadataAttributeDefinitionArgs]
The list of attribute definitions (see Business Metadata for more details):
credentials BusinessMetadataCredentialsArgs
The Cluster API Credentials.
description str
The description of the Business Metadata.
name Changes to this property will trigger replacement. 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.
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. BusinessMetadataSchemaRegistryClusterArgs
version int
(Required Integer) The version of the Business Metadata, for example, 1.
attributeDefinitions List<Property Map>
The list of attribute definitions (see Business Metadata for more details):
credentials Property Map
The Cluster API Credentials.
description String
The description of the Business Metadata.
name Changes to this property will trigger replacement. 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.
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
version Number
(Required Integer) The version of the Business Metadata, for example, 1.

Supporting Types

BusinessMetadataAttributeDefinition
, BusinessMetadataAttributeDefinitionArgs

Name This property is required. string
The name of the attribute.
DefaultValue string
The default value of this attribute.
Description string
The description of this attribute.
IsOptional bool
An optional flag to control whether the attribute should be optional or required. The default value is false.
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.
Name This property is required. string
The name of the attribute.
DefaultValue string
The default value of this attribute.
Description string
The description of this attribute.
IsOptional bool
An optional flag to control whether the attribute should be optional or required. The default value is false.
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.
name This property is required. String
The name of the attribute.
defaultValue String
The default value of this attribute.
description String
The description of this attribute.
isOptional Boolean
An optional flag to control whether the attribute should be optional or required. The default value is false.
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.
name This property is required. string
The name of the attribute.
defaultValue string
The default value of this attribute.
description string
The description of this attribute.
isOptional boolean
An optional flag to control whether the attribute should be optional or required. The default value is false.
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.
name This property is required. str
The name of the attribute.
default_value str
The default value of this attribute.
description str
The description of this attribute.
is_optional bool
An optional flag to control whether the attribute should be optional or required. The default value is false.
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.
name This property is required. String
The name of the attribute.
defaultValue String
The default value of this attribute.
description String
The description of this attribute.
isOptional Boolean
An optional flag to control whether the attribute should be optional or required. The default value is false.
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.

BusinessMetadataCredentials
, BusinessMetadataCredentialsArgs

Key This property is required. string
The Schema Registry API Key.
Secret This property is required. string
The Cluster API Secret for your Confluent Cloud cluster.
Key This property is required. string
The Schema Registry API Key.
Secret This property is required. string
The Cluster API Secret for your Confluent Cloud cluster.
key This property is required. String
The Schema Registry API Key.
secret This property is required. String
The Cluster API Secret for your Confluent Cloud cluster.
key This property is required. string
The Schema Registry API Key.
secret This property is required. string
The Cluster API Secret for your Confluent Cloud cluster.
key This property is required. str
The Schema Registry API Key.
secret This property is required. str
The Cluster API Secret for your Confluent Cloud cluster.
key This property is required. String
The Schema Registry API Key.
secret This property is required. String
The Cluster API Secret for your Confluent Cloud cluster.

BusinessMetadataSchemaRegistryCluster
, BusinessMetadataSchemaRegistryClusterArgs

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 by using the Schema Registry cluster ID, Business Metadata name in the format <Schema Registry cluster ID>/<Business Metadata name>, 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/businessMetadata:BusinessMetadata pii lsrc-8wrx70/PII
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.24.0 published on Saturday, Apr 19, 2025 by Pulumi
pulumi/pulumi-confluentcloud