confluentcloud.CatalogEntityAttributes
Explore with Pulumi AI
Note:
confluentcloud.CatalogEntityAttributes
resource is available in Preview for early adopters. Preview features are introduced to gather customer feedback. This feature should be used only for evaluation and non-production testing purposes or to provide feedback to Confluent, particularly as it becomes more widely available in follow-on editions.
Preview features are intended for evaluation use in development and testing environments only, and not for production use. The warranty, SLA, and Support Services provisions of your agreement with Confluent do not apply to Preview features. Preview features are considered to be a Proof of Concept as defined in the Confluent Cloud Terms of Service. Confluent may discontinue providing preview releases of the Preview features at any time in Confluent’s sole discretion.
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 environment = new confluentcloud.CatalogEntityAttributes("environment", {
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>",
},
entityName: main.id,
entityType: "cf_environment",
attributes: {
description: "Environment description",
},
});
const kafka_cluster = new confluentcloud.CatalogEntityAttributes("kafka-cluster", {
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>",
},
entityName: basic.id,
entityType: "kafka_logical_cluster",
attributes: {
description: "Kafka Cluster description",
},
});
const topic = new confluentcloud.CatalogEntityAttributes("topic", {
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>",
},
entityName: `${basic.id}:${purchase.topicName}`,
entityType: "kafka_topic",
attributes: {
owner: "dev",
description: "Kafka topic for orders",
ownerEmail: "dev@gmail.com",
},
});
const schema = new confluentcloud.CatalogEntityAttributes("schema", {
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>",
},
entityName: `${essentials.id}:.:${purchaseConfluentSchema.schemaIdentifier}`,
entityType: "sr_schema",
attributes: {
description: "Schema description",
},
});
import pulumi
import pulumi_confluentcloud as confluentcloud
environment = confluentcloud.CatalogEntityAttributes("environment",
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>",
},
entity_name=main["id"],
entity_type="cf_environment",
attributes={
"description": "Environment description",
})
kafka_cluster = confluentcloud.CatalogEntityAttributes("kafka-cluster",
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>",
},
entity_name=basic["id"],
entity_type="kafka_logical_cluster",
attributes={
"description": "Kafka Cluster description",
})
topic = confluentcloud.CatalogEntityAttributes("topic",
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>",
},
entity_name=f"{basic['id']}:{purchase['topicName']}",
entity_type="kafka_topic",
attributes={
"owner": "dev",
"description": "Kafka topic for orders",
"ownerEmail": "dev@gmail.com",
})
schema = confluentcloud.CatalogEntityAttributes("schema",
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>",
},
entity_name=f"{essentials['id']}:.:{purchase_confluent_schema['schemaIdentifier']}",
entity_type="sr_schema",
attributes={
"description": "Schema description",
})
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 {
_, err := confluentcloud.NewCatalogEntityAttributes(ctx, "environment", &confluentcloud.CatalogEntityAttributesArgs{
SchemaRegistryCluster: &confluentcloud.CatalogEntityAttributesSchemaRegistryClusterArgs{
Id: pulumi.Any(essentials.Id),
},
RestEndpoint: pulumi.Any(essentials.RestEndpoint),
Credentials: &confluentcloud.CatalogEntityAttributesCredentialsArgs{
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>"),
},
EntityName: pulumi.Any(main.Id),
EntityType: pulumi.String("cf_environment"),
Attributes: pulumi.StringMap{
"description": pulumi.String("Environment description"),
},
})
if err != nil {
return err
}
_, err = confluentcloud.NewCatalogEntityAttributes(ctx, "kafka-cluster", &confluentcloud.CatalogEntityAttributesArgs{
SchemaRegistryCluster: &confluentcloud.CatalogEntityAttributesSchemaRegistryClusterArgs{
Id: pulumi.Any(essentials.Id),
},
RestEndpoint: pulumi.Any(essentials.RestEndpoint),
Credentials: &confluentcloud.CatalogEntityAttributesCredentialsArgs{
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>"),
},
EntityName: pulumi.Any(basic.Id),
EntityType: pulumi.String("kafka_logical_cluster"),
Attributes: pulumi.StringMap{
"description": pulumi.String("Kafka Cluster description"),
},
})
if err != nil {
return err
}
_, err = confluentcloud.NewCatalogEntityAttributes(ctx, "topic", &confluentcloud.CatalogEntityAttributesArgs{
SchemaRegistryCluster: &confluentcloud.CatalogEntityAttributesSchemaRegistryClusterArgs{
Id: pulumi.Any(essentials.Id),
},
RestEndpoint: pulumi.Any(essentials.RestEndpoint),
Credentials: &confluentcloud.CatalogEntityAttributesCredentialsArgs{
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>"),
},
EntityName: pulumi.Sprintf("%v:%v", basic.Id, purchase.TopicName),
EntityType: pulumi.String("kafka_topic"),
Attributes: pulumi.StringMap{
"owner": pulumi.String("dev"),
"description": pulumi.String("Kafka topic for orders"),
"ownerEmail": pulumi.String("dev@gmail.com"),
},
})
if err != nil {
return err
}
_, err = confluentcloud.NewCatalogEntityAttributes(ctx, "schema", &confluentcloud.CatalogEntityAttributesArgs{
SchemaRegistryCluster: &confluentcloud.CatalogEntityAttributesSchemaRegistryClusterArgs{
Id: pulumi.Any(essentials.Id),
},
RestEndpoint: pulumi.Any(essentials.RestEndpoint),
Credentials: &confluentcloud.CatalogEntityAttributesCredentialsArgs{
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>"),
},
EntityName: pulumi.Sprintf("%v:.:%v", essentials.Id, purchaseConfluentSchema.SchemaIdentifier),
EntityType: pulumi.String("sr_schema"),
Attributes: pulumi.StringMap{
"description": pulumi.String("Schema description"),
},
})
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 environment = new ConfluentCloud.CatalogEntityAttributes("environment", new()
{
SchemaRegistryCluster = new ConfluentCloud.Inputs.CatalogEntityAttributesSchemaRegistryClusterArgs
{
Id = essentials.Id,
},
RestEndpoint = essentials.RestEndpoint,
Credentials = new ConfluentCloud.Inputs.CatalogEntityAttributesCredentialsArgs
{
Key = "<Schema Registry API Key for data.confluent_schema_registry_cluster.essentials>",
Secret = "<Schema Registry API Secret for data.confluent_schema_registry_cluster.essentials>",
},
EntityName = main.Id,
EntityType = "cf_environment",
Attributes =
{
{ "description", "Environment description" },
},
});
var kafka_cluster = new ConfluentCloud.CatalogEntityAttributes("kafka-cluster", new()
{
SchemaRegistryCluster = new ConfluentCloud.Inputs.CatalogEntityAttributesSchemaRegistryClusterArgs
{
Id = essentials.Id,
},
RestEndpoint = essentials.RestEndpoint,
Credentials = new ConfluentCloud.Inputs.CatalogEntityAttributesCredentialsArgs
{
Key = "<Schema Registry API Key for data.confluent_schema_registry_cluster.essentials>",
Secret = "<Schema Registry API Secret for data.confluent_schema_registry_cluster.essentials>",
},
EntityName = basic.Id,
EntityType = "kafka_logical_cluster",
Attributes =
{
{ "description", "Kafka Cluster description" },
},
});
var topic = new ConfluentCloud.CatalogEntityAttributes("topic", new()
{
SchemaRegistryCluster = new ConfluentCloud.Inputs.CatalogEntityAttributesSchemaRegistryClusterArgs
{
Id = essentials.Id,
},
RestEndpoint = essentials.RestEndpoint,
Credentials = new ConfluentCloud.Inputs.CatalogEntityAttributesCredentialsArgs
{
Key = "<Schema Registry API Key for data.confluent_schema_registry_cluster.essentials>",
Secret = "<Schema Registry API Secret for data.confluent_schema_registry_cluster.essentials>",
},
EntityName = $"{basic.Id}:{purchase.TopicName}",
EntityType = "kafka_topic",
Attributes =
{
{ "owner", "dev" },
{ "description", "Kafka topic for orders" },
{ "ownerEmail", "dev@gmail.com" },
},
});
var schema = new ConfluentCloud.CatalogEntityAttributes("schema", new()
{
SchemaRegistryCluster = new ConfluentCloud.Inputs.CatalogEntityAttributesSchemaRegistryClusterArgs
{
Id = essentials.Id,
},
RestEndpoint = essentials.RestEndpoint,
Credentials = new ConfluentCloud.Inputs.CatalogEntityAttributesCredentialsArgs
{
Key = "<Schema Registry API Key for data.confluent_schema_registry_cluster.essentials>",
Secret = "<Schema Registry API Secret for data.confluent_schema_registry_cluster.essentials>",
},
EntityName = $"{essentials.Id}:.:{purchaseConfluentSchema.SchemaIdentifier}",
EntityType = "sr_schema",
Attributes =
{
{ "description", "Schema description" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.CatalogEntityAttributes;
import com.pulumi.confluentcloud.CatalogEntityAttributesArgs;
import com.pulumi.confluentcloud.inputs.CatalogEntityAttributesSchemaRegistryClusterArgs;
import com.pulumi.confluentcloud.inputs.CatalogEntityAttributesCredentialsArgs;
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 environment = new CatalogEntityAttributes("environment", CatalogEntityAttributesArgs.builder()
.schemaRegistryCluster(CatalogEntityAttributesSchemaRegistryClusterArgs.builder()
.id(essentials.id())
.build())
.restEndpoint(essentials.restEndpoint())
.credentials(CatalogEntityAttributesCredentialsArgs.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())
.entityName(main.id())
.entityType("cf_environment")
.attributes(Map.of("description", "Environment description"))
.build());
var kafka_cluster = new CatalogEntityAttributes("kafka-cluster", CatalogEntityAttributesArgs.builder()
.schemaRegistryCluster(CatalogEntityAttributesSchemaRegistryClusterArgs.builder()
.id(essentials.id())
.build())
.restEndpoint(essentials.restEndpoint())
.credentials(CatalogEntityAttributesCredentialsArgs.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())
.entityName(basic.id())
.entityType("kafka_logical_cluster")
.attributes(Map.of("description", "Kafka Cluster description"))
.build());
var topic = new CatalogEntityAttributes("topic", CatalogEntityAttributesArgs.builder()
.schemaRegistryCluster(CatalogEntityAttributesSchemaRegistryClusterArgs.builder()
.id(essentials.id())
.build())
.restEndpoint(essentials.restEndpoint())
.credentials(CatalogEntityAttributesCredentialsArgs.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())
.entityName(String.format("%s:%s", basic.id(),purchase.topicName()))
.entityType("kafka_topic")
.attributes(Map.ofEntries(
Map.entry("owner", "dev"),
Map.entry("description", "Kafka topic for orders"),
Map.entry("ownerEmail", "dev@gmail.com")
))
.build());
var schema = new CatalogEntityAttributes("schema", CatalogEntityAttributesArgs.builder()
.schemaRegistryCluster(CatalogEntityAttributesSchemaRegistryClusterArgs.builder()
.id(essentials.id())
.build())
.restEndpoint(essentials.restEndpoint())
.credentials(CatalogEntityAttributesCredentialsArgs.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())
.entityName(String.format("%s:.:%s", essentials.id(),purchaseConfluentSchema.schemaIdentifier()))
.entityType("sr_schema")
.attributes(Map.of("description", "Schema description"))
.build());
}
}
resources:
environment:
type: confluentcloud:CatalogEntityAttributes
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>
entityName: ${main.id}
entityType: cf_environment
attributes:
description: Environment description
kafka-cluster:
type: confluentcloud:CatalogEntityAttributes
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>
entityName: ${basic.id}
entityType: kafka_logical_cluster
attributes:
description: Kafka Cluster description
topic:
type: confluentcloud:CatalogEntityAttributes
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>
entityName: ${basic.id}:${purchase.topicName}
entityType: kafka_topic
attributes:
owner: dev
description: Kafka topic for orders
ownerEmail: dev@gmail.com
schema:
type: confluentcloud:CatalogEntityAttributes
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>
entityName: ${essentials.id}:.:${purchaseConfluentSchema.schemaIdentifier}
entityType: sr_schema
attributes:
description: Schema description
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 environment = new confluentcloud.CatalogEntityAttributes("environment", {
entityName: environmentId,
entityType: "cf_environment",
attributes: {
description: "Environment description",
},
});
const kafka_cluster = new confluentcloud.CatalogEntityAttributes("kafka-cluster", {
entityName: kafkaClusterId,
entityType: "kafka_logical_cluster",
attributes: {
description: "Kafka Cluster description",
},
});
const topic = new confluentcloud.CatalogEntityAttributes("topic", {
entityName: `${kafkaClusterId}:${kafkaTopicName}`,
entityType: "kafka_topic",
attributes: {
owner: "dev",
description: "Kafka topic for orders",
ownerEmail: "dev@gmail.com",
},
});
const schema = new confluentcloud.CatalogEntityAttributes("schema", {
entityName: `${schemaRegistryClusterId}:.:${purchase.schemaIdentifier}`,
entityType: "sr_schema",
attributes: {
description: "Schema description",
},
});
import pulumi
import pulumi_confluentcloud as confluentcloud
environment = confluentcloud.CatalogEntityAttributes("environment",
entity_name=environment_id,
entity_type="cf_environment",
attributes={
"description": "Environment description",
})
kafka_cluster = confluentcloud.CatalogEntityAttributes("kafka-cluster",
entity_name=kafka_cluster_id,
entity_type="kafka_logical_cluster",
attributes={
"description": "Kafka Cluster description",
})
topic = confluentcloud.CatalogEntityAttributes("topic",
entity_name=f"{kafka_cluster_id}:{kafka_topic_name}",
entity_type="kafka_topic",
attributes={
"owner": "dev",
"description": "Kafka topic for orders",
"ownerEmail": "dev@gmail.com",
})
schema = confluentcloud.CatalogEntityAttributes("schema",
entity_name=f"{schema_registry_cluster_id}:.:{purchase['schemaIdentifier']}",
entity_type="sr_schema",
attributes={
"description": "Schema description",
})
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 {
_, err := confluentcloud.NewCatalogEntityAttributes(ctx, "environment", &confluentcloud.CatalogEntityAttributesArgs{
EntityName: pulumi.Any(environmentId),
EntityType: pulumi.String("cf_environment"),
Attributes: pulumi.StringMap{
"description": pulumi.String("Environment description"),
},
})
if err != nil {
return err
}
_, err = confluentcloud.NewCatalogEntityAttributes(ctx, "kafka-cluster", &confluentcloud.CatalogEntityAttributesArgs{
EntityName: pulumi.Any(kafkaClusterId),
EntityType: pulumi.String("kafka_logical_cluster"),
Attributes: pulumi.StringMap{
"description": pulumi.String("Kafka Cluster description"),
},
})
if err != nil {
return err
}
_, err = confluentcloud.NewCatalogEntityAttributes(ctx, "topic", &confluentcloud.CatalogEntityAttributesArgs{
EntityName: pulumi.Sprintf("%v:%v", kafkaClusterId, kafkaTopicName),
EntityType: pulumi.String("kafka_topic"),
Attributes: pulumi.StringMap{
"owner": pulumi.String("dev"),
"description": pulumi.String("Kafka topic for orders"),
"ownerEmail": pulumi.String("dev@gmail.com"),
},
})
if err != nil {
return err
}
_, err = confluentcloud.NewCatalogEntityAttributes(ctx, "schema", &confluentcloud.CatalogEntityAttributesArgs{
EntityName: pulumi.Sprintf("%v:.:%v", schemaRegistryClusterId, purchase.SchemaIdentifier),
EntityType: pulumi.String("sr_schema"),
Attributes: pulumi.StringMap{
"description": pulumi.String("Schema description"),
},
})
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 environment = new ConfluentCloud.CatalogEntityAttributes("environment", new()
{
EntityName = environmentId,
EntityType = "cf_environment",
Attributes =
{
{ "description", "Environment description" },
},
});
var kafka_cluster = new ConfluentCloud.CatalogEntityAttributes("kafka-cluster", new()
{
EntityName = kafkaClusterId,
EntityType = "kafka_logical_cluster",
Attributes =
{
{ "description", "Kafka Cluster description" },
},
});
var topic = new ConfluentCloud.CatalogEntityAttributes("topic", new()
{
EntityName = $"{kafkaClusterId}:{kafkaTopicName}",
EntityType = "kafka_topic",
Attributes =
{
{ "owner", "dev" },
{ "description", "Kafka topic for orders" },
{ "ownerEmail", "dev@gmail.com" },
},
});
var schema = new ConfluentCloud.CatalogEntityAttributes("schema", new()
{
EntityName = $"{schemaRegistryClusterId}:.:{purchase.SchemaIdentifier}",
EntityType = "sr_schema",
Attributes =
{
{ "description", "Schema description" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.CatalogEntityAttributes;
import com.pulumi.confluentcloud.CatalogEntityAttributesArgs;
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 environment = new CatalogEntityAttributes("environment", CatalogEntityAttributesArgs.builder()
.entityName(environmentId)
.entityType("cf_environment")
.attributes(Map.of("description", "Environment description"))
.build());
var kafka_cluster = new CatalogEntityAttributes("kafka-cluster", CatalogEntityAttributesArgs.builder()
.entityName(kafkaClusterId)
.entityType("kafka_logical_cluster")
.attributes(Map.of("description", "Kafka Cluster description"))
.build());
var topic = new CatalogEntityAttributes("topic", CatalogEntityAttributesArgs.builder()
.entityName(String.format("%s:%s", kafkaClusterId,kafkaTopicName))
.entityType("kafka_topic")
.attributes(Map.ofEntries(
Map.entry("owner", "dev"),
Map.entry("description", "Kafka topic for orders"),
Map.entry("ownerEmail", "dev@gmail.com")
))
.build());
var schema = new CatalogEntityAttributes("schema", CatalogEntityAttributesArgs.builder()
.entityName(String.format("%s:.:%s", schemaRegistryClusterId,purchase.schemaIdentifier()))
.entityType("sr_schema")
.attributes(Map.of("description", "Schema description"))
.build());
}
}
resources:
environment:
type: confluentcloud:CatalogEntityAttributes
properties:
entityName: ${environmentId}
entityType: cf_environment
attributes:
description: Environment description
kafka-cluster:
type: confluentcloud:CatalogEntityAttributes
properties:
entityName: ${kafkaClusterId}
entityType: kafka_logical_cluster
attributes:
description: Kafka Cluster description
topic:
type: confluentcloud:CatalogEntityAttributes
properties:
entityName: ${kafkaClusterId}:${kafkaTopicName}
entityType: kafka_topic
attributes:
owner: dev
description: Kafka topic for orders
ownerEmail: dev@gmail.com
schema:
type: confluentcloud:CatalogEntityAttributes
properties:
entityName: ${schemaRegistryClusterId}:.:${purchase.schemaIdentifier}
entityType: sr_schema
attributes:
description: Schema description
Create CatalogEntityAttributes Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CatalogEntityAttributes(name: string, args: CatalogEntityAttributesArgs, opts?: CustomResourceOptions);
@overload
def CatalogEntityAttributes(resource_name: str,
args: CatalogEntityAttributesArgs,
opts: Optional[ResourceOptions] = None)
@overload
def CatalogEntityAttributes(resource_name: str,
opts: Optional[ResourceOptions] = None,
entity_name: Optional[str] = None,
entity_type: Optional[str] = None,
attributes: Optional[Mapping[str, str]] = None,
credentials: Optional[CatalogEntityAttributesCredentialsArgs] = None,
rest_endpoint: Optional[str] = None,
schema_registry_cluster: Optional[CatalogEntityAttributesSchemaRegistryClusterArgs] = None)
func NewCatalogEntityAttributes(ctx *Context, name string, args CatalogEntityAttributesArgs, opts ...ResourceOption) (*CatalogEntityAttributes, error)
public CatalogEntityAttributes(string name, CatalogEntityAttributesArgs args, CustomResourceOptions? opts = null)
public CatalogEntityAttributes(String name, CatalogEntityAttributesArgs args)
public CatalogEntityAttributes(String name, CatalogEntityAttributesArgs args, CustomResourceOptions options)
type: confluentcloud:CatalogEntityAttributes
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args CatalogEntityAttributesArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args CatalogEntityAttributesArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args CatalogEntityAttributesArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CatalogEntityAttributesArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CatalogEntityAttributesArgs
- 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 catalogEntityAttributesResource = new ConfluentCloud.CatalogEntityAttributes("catalogEntityAttributesResource", new()
{
EntityName = "string",
EntityType = "string",
Attributes =
{
{ "string", "string" },
},
Credentials = new ConfluentCloud.Inputs.CatalogEntityAttributesCredentialsArgs
{
Key = "string",
Secret = "string",
},
RestEndpoint = "string",
SchemaRegistryCluster = new ConfluentCloud.Inputs.CatalogEntityAttributesSchemaRegistryClusterArgs
{
Id = "string",
},
});
example, err := confluentcloud.NewCatalogEntityAttributes(ctx, "catalogEntityAttributesResource", &confluentcloud.CatalogEntityAttributesArgs{
EntityName: pulumi.String("string"),
EntityType: pulumi.String("string"),
Attributes: pulumi.StringMap{
"string": pulumi.String("string"),
},
Credentials: &confluentcloud.CatalogEntityAttributesCredentialsArgs{
Key: pulumi.String("string"),
Secret: pulumi.String("string"),
},
RestEndpoint: pulumi.String("string"),
SchemaRegistryCluster: &confluentcloud.CatalogEntityAttributesSchemaRegistryClusterArgs{
Id: pulumi.String("string"),
},
})
var catalogEntityAttributesResource = new CatalogEntityAttributes("catalogEntityAttributesResource", CatalogEntityAttributesArgs.builder()
.entityName("string")
.entityType("string")
.attributes(Map.of("string", "string"))
.credentials(CatalogEntityAttributesCredentialsArgs.builder()
.key("string")
.secret("string")
.build())
.restEndpoint("string")
.schemaRegistryCluster(CatalogEntityAttributesSchemaRegistryClusterArgs.builder()
.id("string")
.build())
.build());
catalog_entity_attributes_resource = confluentcloud.CatalogEntityAttributes("catalogEntityAttributesResource",
entity_name="string",
entity_type="string",
attributes={
"string": "string",
},
credentials={
"key": "string",
"secret": "string",
},
rest_endpoint="string",
schema_registry_cluster={
"id": "string",
})
const catalogEntityAttributesResource = new confluentcloud.CatalogEntityAttributes("catalogEntityAttributesResource", {
entityName: "string",
entityType: "string",
attributes: {
string: "string",
},
credentials: {
key: "string",
secret: "string",
},
restEndpoint: "string",
schemaRegistryCluster: {
id: "string",
},
});
type: confluentcloud:CatalogEntityAttributes
properties:
attributes:
string: string
credentials:
key: string
secret: string
entityName: string
entityType: string
restEndpoint: string
schemaRegistryCluster:
id: string
CatalogEntityAttributes 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 CatalogEntityAttributes resource accepts the following input properties:
- Entity
Name 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}
. - Entity
Type string - The entity type, for example,
cf_environment
,kafka_logical_cluster
,kafka_topic
,sr_schema
, etc. Refer to the Entity types to learn more about entity types. - Attributes Dictionary<string, string>
- The attributes.
- Credentials
Pulumi.
Confluent Cloud. Inputs. Catalog Entity Attributes Credentials - The Cluster API Credentials.
- Rest
Endpoint string - The REST endpoint of the Schema Registry cluster, for example,
https://psrc-00000.us-central1.gcp.confluent.cloud:443
). - Schema
Registry Pulumi.Cluster Confluent Cloud. Inputs. Catalog Entity Attributes Schema Registry Cluster
- Entity
Name 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}
. - Entity
Type string - The entity type, for example,
cf_environment
,kafka_logical_cluster
,kafka_topic
,sr_schema
, etc. Refer to the Entity types to learn more about entity types. - Attributes map[string]string
- The attributes.
- Credentials
Catalog
Entity Attributes Credentials Args - The Cluster API Credentials.
- Rest
Endpoint string - The REST endpoint of the Schema Registry cluster, for example,
https://psrc-00000.us-central1.gcp.confluent.cloud:443
). - Schema
Registry CatalogCluster Entity Attributes Schema Registry Cluster Args
- entity
Name 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}
. - entity
Type String - The entity type, for example,
cf_environment
,kafka_logical_cluster
,kafka_topic
,sr_schema
, etc. Refer to the Entity types to learn more about entity types. - attributes Map<String,String>
- The attributes.
- credentials
Catalog
Entity Attributes Credentials - The Cluster API Credentials.
- rest
Endpoint String - The REST endpoint of the Schema Registry cluster, for example,
https://psrc-00000.us-central1.gcp.confluent.cloud:443
). - schema
Registry CatalogCluster Entity Attributes Schema Registry Cluster
- entity
Name 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}
. - entity
Type string - The entity type, for example,
cf_environment
,kafka_logical_cluster
,kafka_topic
,sr_schema
, etc. Refer to the Entity types to learn more about entity types. - attributes {[key: string]: string}
- The attributes.
- credentials
Catalog
Entity Attributes Credentials - The Cluster API Credentials.
- rest
Endpoint string - The REST endpoint of the Schema Registry cluster, for example,
https://psrc-00000.us-central1.gcp.confluent.cloud:443
). - schema
Registry CatalogCluster Entity Attributes Schema Registry Cluster
- 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}
. - entity_
type str - The entity type, for example,
cf_environment
,kafka_logical_cluster
,kafka_topic
,sr_schema
, etc. Refer to the Entity types to learn more about entity types. - attributes Mapping[str, str]
- The attributes.
- credentials
Catalog
Entity Attributes Credentials Args - The Cluster API Credentials.
- rest_
endpoint str - The REST endpoint of the Schema Registry cluster, for example,
https://psrc-00000.us-central1.gcp.confluent.cloud:443
). - schema_
registry_ Catalogcluster Entity Attributes Schema Registry Cluster Args
- entity
Name 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}
. - entity
Type String - The entity type, for example,
cf_environment
,kafka_logical_cluster
,kafka_topic
,sr_schema
, etc. Refer to the Entity types to learn more about entity types. - attributes Map<String>
- The attributes.
- credentials Property Map
- The Cluster API Credentials.
- rest
Endpoint String - The REST endpoint of the Schema Registry cluster, for example,
https://psrc-00000.us-central1.gcp.confluent.cloud:443
). - schema
Registry Property MapCluster
Outputs
All input properties are implicitly available as output properties. Additionally, the CatalogEntityAttributes 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 CatalogEntityAttributes Resource
Get an existing CatalogEntityAttributes 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?: CatalogEntityAttributesState, opts?: CustomResourceOptions): CatalogEntityAttributes
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
attributes: Optional[Mapping[str, str]] = None,
credentials: Optional[CatalogEntityAttributesCredentialsArgs] = None,
entity_name: Optional[str] = None,
entity_type: Optional[str] = None,
rest_endpoint: Optional[str] = None,
schema_registry_cluster: Optional[CatalogEntityAttributesSchemaRegistryClusterArgs] = None) -> CatalogEntityAttributes
func GetCatalogEntityAttributes(ctx *Context, name string, id IDInput, state *CatalogEntityAttributesState, opts ...ResourceOption) (*CatalogEntityAttributes, error)
public static CatalogEntityAttributes Get(string name, Input<string> id, CatalogEntityAttributesState? state, CustomResourceOptions? opts = null)
public static CatalogEntityAttributes get(String name, Output<String> id, CatalogEntityAttributesState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Attributes Dictionary<string, string>
- The attributes.
- Credentials
Pulumi.
Confluent Cloud. Inputs. Catalog Entity Attributes Credentials - The Cluster API Credentials.
- Entity
Name 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}
. - Entity
Type string - The entity type, for example,
cf_environment
,kafka_logical_cluster
,kafka_topic
,sr_schema
, etc. Refer to the Entity types to learn more about entity types. - Rest
Endpoint string - The REST endpoint of the Schema Registry cluster, for example,
https://psrc-00000.us-central1.gcp.confluent.cloud:443
). - Schema
Registry Pulumi.Cluster Confluent Cloud. Inputs. Catalog Entity Attributes Schema Registry Cluster
- Attributes map[string]string
- The attributes.
- Credentials
Catalog
Entity Attributes Credentials Args - The Cluster API Credentials.
- Entity
Name 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}
. - Entity
Type string - The entity type, for example,
cf_environment
,kafka_logical_cluster
,kafka_topic
,sr_schema
, etc. Refer to the Entity types to learn more about entity types. - Rest
Endpoint string - The REST endpoint of the Schema Registry cluster, for example,
https://psrc-00000.us-central1.gcp.confluent.cloud:443
). - Schema
Registry CatalogCluster Entity Attributes Schema Registry Cluster Args
- attributes Map<String,String>
- The attributes.
- credentials
Catalog
Entity Attributes Credentials - The Cluster API Credentials.
- entity
Name 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}
. - entity
Type String - The entity type, for example,
cf_environment
,kafka_logical_cluster
,kafka_topic
,sr_schema
, etc. Refer to the Entity types to learn more about entity types. - rest
Endpoint String - The REST endpoint of the Schema Registry cluster, for example,
https://psrc-00000.us-central1.gcp.confluent.cloud:443
). - schema
Registry CatalogCluster Entity Attributes Schema Registry Cluster
- attributes {[key: string]: string}
- The attributes.
- credentials
Catalog
Entity Attributes Credentials - The Cluster API Credentials.
- entity
Name 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}
. - entity
Type string - The entity type, for example,
cf_environment
,kafka_logical_cluster
,kafka_topic
,sr_schema
, etc. Refer to the Entity types to learn more about entity types. - rest
Endpoint string - The REST endpoint of the Schema Registry cluster, for example,
https://psrc-00000.us-central1.gcp.confluent.cloud:443
). - schema
Registry CatalogCluster Entity Attributes Schema Registry Cluster
- attributes Mapping[str, str]
- The attributes.
- credentials
Catalog
Entity Attributes Credentials Args - 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}
. - entity_
type str - The entity type, for example,
cf_environment
,kafka_logical_cluster
,kafka_topic
,sr_schema
, etc. Refer to the Entity types to learn more about entity types. - rest_
endpoint str - The REST endpoint of the Schema Registry cluster, for example,
https://psrc-00000.us-central1.gcp.confluent.cloud:443
). - schema_
registry_ Catalogcluster Entity Attributes Schema Registry Cluster Args
- attributes Map<String>
- The attributes.
- credentials Property Map
- The Cluster API Credentials.
- entity
Name 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}
. - entity
Type String - The entity type, for example,
cf_environment
,kafka_logical_cluster
,kafka_topic
,sr_schema
, etc. Refer to the Entity types to learn more about entity types. - rest
Endpoint String - The REST endpoint of the Schema Registry cluster, for example,
https://psrc-00000.us-central1.gcp.confluent.cloud:443
). - schema
Registry Property MapCluster
Supporting Types
CatalogEntityAttributesCredentials, CatalogEntityAttributesCredentialsArgs
CatalogEntityAttributesSchemaRegistryCluster, CatalogEntityAttributesSchemaRegistryClusterArgs
- 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.