@pulumi/confluentcloud 2.10.0-alpha.1730384027 → 2.10.0-alpha.1730784202

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (91) hide show
  1. package/businessMetadata.d.ts +59 -0
  2. package/businessMetadata.js +59 -0
  3. package/businessMetadata.js.map +1 -1
  4. package/businessMetadataBinding.d.ts +59 -0
  5. package/businessMetadataBinding.js +59 -0
  6. package/businessMetadataBinding.js.map +1 -1
  7. package/catalogEntityAttributes.d.ts +116 -0
  8. package/catalogEntityAttributes.js +116 -0
  9. package/catalogEntityAttributes.js.map +1 -1
  10. package/flinkStatement.d.ts +57 -2
  11. package/flinkStatement.js +57 -2
  12. package/flinkStatement.js.map +1 -1
  13. package/getBusinessMetadata.d.ts +74 -0
  14. package/getBusinessMetadata.js +74 -0
  15. package/getBusinessMetadata.js.map +1 -1
  16. package/getBusinessMetadataBinding.d.ts +82 -0
  17. package/getBusinessMetadataBinding.js +82 -0
  18. package/getBusinessMetadataBinding.js.map +1 -1
  19. package/getKafkaTopic.d.ts +78 -0
  20. package/getKafkaTopic.js +78 -0
  21. package/getKafkaTopic.js.map +1 -1
  22. package/getSchema.d.ts +82 -0
  23. package/getSchema.js +82 -0
  24. package/getSchema.js.map +1 -1
  25. package/getSchemaRegistryClusterConfig.d.ts +72 -0
  26. package/getSchemaRegistryClusterConfig.js +72 -0
  27. package/getSchemaRegistryClusterConfig.js.map +1 -1
  28. package/getSchemaRegistryClusterMode.d.ts +72 -0
  29. package/getSchemaRegistryClusterMode.js +72 -0
  30. package/getSchemaRegistryClusterMode.js.map +1 -1
  31. package/getSchemaRegistryDek.d.ts +78 -0
  32. package/getSchemaRegistryDek.js +78 -0
  33. package/getSchemaRegistryDek.js.map +1 -1
  34. package/getSchemaRegistryKek.d.ts +74 -0
  35. package/getSchemaRegistryKek.js +74 -0
  36. package/getSchemaRegistryKek.js.map +1 -1
  37. package/getSchemas.d.ts +94 -0
  38. package/getSchemas.js +94 -0
  39. package/getSchemas.js.map +1 -1
  40. package/getSubjectConfig.d.ts +14 -0
  41. package/getSubjectConfig.js +14 -0
  42. package/getSubjectConfig.js.map +1 -1
  43. package/getSubjectMode.d.ts +78 -0
  44. package/getSubjectMode.js +78 -0
  45. package/getSubjectMode.js.map +1 -1
  46. package/getTag.d.ts +74 -0
  47. package/getTag.js +74 -0
  48. package/getTag.js.map +1 -1
  49. package/getTagBinding.d.ts +82 -0
  50. package/getTagBinding.js +82 -0
  51. package/getTagBinding.js.map +1 -1
  52. package/kafkaAcl.d.ts +86 -2
  53. package/kafkaAcl.js +86 -2
  54. package/kafkaAcl.js.map +1 -1
  55. package/kafkaClusterConfig.d.ts +42 -2
  56. package/kafkaClusterConfig.js +42 -2
  57. package/kafkaClusterConfig.js.map +1 -1
  58. package/kafkaTopic.d.ts +57 -2
  59. package/kafkaTopic.js +57 -2
  60. package/kafkaTopic.js.map +1 -1
  61. package/package.json +2 -2
  62. package/schema.d.ts +2 -0
  63. package/schema.js +2 -0
  64. package/schema.js.map +1 -1
  65. package/schemaExporter.d.ts +52 -0
  66. package/schemaExporter.js +52 -0
  67. package/schemaExporter.js.map +1 -1
  68. package/schemaRegistryClusterConfig.d.ts +30 -0
  69. package/schemaRegistryClusterConfig.js +30 -0
  70. package/schemaRegistryClusterConfig.js.map +1 -1
  71. package/schemaRegistryClusterMode.d.ts +30 -0
  72. package/schemaRegistryClusterMode.js +30 -0
  73. package/schemaRegistryClusterMode.js.map +1 -1
  74. package/schemaRegistryDek.d.ts +45 -0
  75. package/schemaRegistryDek.js +45 -0
  76. package/schemaRegistryDek.js.map +1 -1
  77. package/schemaRegistryKek.d.ts +51 -0
  78. package/schemaRegistryKek.js +51 -0
  79. package/schemaRegistryKek.js.map +1 -1
  80. package/subjectConfig.d.ts +34 -0
  81. package/subjectConfig.js +34 -0
  82. package/subjectConfig.js.map +1 -1
  83. package/subjectMode.d.ts +34 -0
  84. package/subjectMode.js +34 -0
  85. package/subjectMode.js.map +1 -1
  86. package/tag.d.ts +43 -0
  87. package/tag.js +43 -0
  88. package/tag.js.map +1 -1
  89. package/tagBinding.d.ts +51 -0
  90. package/tagBinding.js +51 -0
  91. package/tagBinding.js.map +1 -1
@@ -2,6 +2,65 @@ import * as pulumi from "@pulumi/pulumi";
2
2
  import * as inputs from "./types/input";
3
3
  import * as outputs from "./types/output";
4
4
  /**
5
+ * [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy)
6
+ *
7
+ * `confluentcloud.BusinessMetadata` provides a Business Metadata resource that enables creating, editing, and deleting Business Metadata on Confluent Cloud.
8
+ *
9
+ * ## Example Usage
10
+ *
11
+ * ### Option #1: Manage multiple Schema Registry clusters in the same Pulumi Stack
12
+ *
13
+ * ```typescript
14
+ * import * as pulumi from "@pulumi/pulumi";
15
+ * import * as confluentcloud from "@pulumi/confluentcloud";
16
+ *
17
+ * const pii = new confluentcloud.BusinessMetadata("pii", {
18
+ * schemaRegistryCluster: {
19
+ * id: essentials.id,
20
+ * },
21
+ * restEndpoint: essentials.restEndpoint,
22
+ * credentials: {
23
+ * key: "<Schema Registry API Key for data.confluent_schema_registry_cluster.essentials>",
24
+ * secret: "<Schema Registry API Secret for data.confluent_schema_registry_cluster.essentials>",
25
+ * },
26
+ * name: "PII",
27
+ * description: "PII metadata",
28
+ * attributeDefinitions: [
29
+ * {
30
+ * name: "team",
31
+ * },
32
+ * {
33
+ * name: "email",
34
+ * },
35
+ * ],
36
+ * });
37
+ * ```
38
+ *
39
+ * ### Option #2: Manage a single Schema Registry cluster in the same Pulumi Stack
40
+ *
41
+ * ```typescript
42
+ * import * as pulumi from "@pulumi/pulumi";
43
+ * import * as confluentcloud from "@pulumi/confluentcloud";
44
+ *
45
+ * const pii = new confluentcloud.BusinessMetadata("pii", {
46
+ * name: "PII",
47
+ * description: "PII metadata",
48
+ * attributeDefinitions: [
49
+ * {
50
+ * name: "team",
51
+ * },
52
+ * {
53
+ * name: "email",
54
+ * },
55
+ * ],
56
+ * });
57
+ * ```
58
+ *
59
+ * ## Getting Started
60
+ *
61
+ * The following end-to-end example might help to get started with [Stream Catalog](https://docs.confluent.io/cloud/current/stream-governance/stream-catalog.html):
62
+ * * stream-catalog
63
+ *
5
64
  * ## Import
6
65
  *
7
66
  * 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:
@@ -6,6 +6,65 @@ exports.BusinessMetadata = void 0;
6
6
  const pulumi = require("@pulumi/pulumi");
7
7
  const utilities = require("./utilities");
8
8
  /**
9
+ * [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy)
10
+ *
11
+ * `confluentcloud.BusinessMetadata` provides a Business Metadata resource that enables creating, editing, and deleting Business Metadata on Confluent Cloud.
12
+ *
13
+ * ## Example Usage
14
+ *
15
+ * ### Option #1: Manage multiple Schema Registry clusters in the same Pulumi Stack
16
+ *
17
+ * ```typescript
18
+ * import * as pulumi from "@pulumi/pulumi";
19
+ * import * as confluentcloud from "@pulumi/confluentcloud";
20
+ *
21
+ * const pii = new confluentcloud.BusinessMetadata("pii", {
22
+ * schemaRegistryCluster: {
23
+ * id: essentials.id,
24
+ * },
25
+ * restEndpoint: essentials.restEndpoint,
26
+ * credentials: {
27
+ * key: "<Schema Registry API Key for data.confluent_schema_registry_cluster.essentials>",
28
+ * secret: "<Schema Registry API Secret for data.confluent_schema_registry_cluster.essentials>",
29
+ * },
30
+ * name: "PII",
31
+ * description: "PII metadata",
32
+ * attributeDefinitions: [
33
+ * {
34
+ * name: "team",
35
+ * },
36
+ * {
37
+ * name: "email",
38
+ * },
39
+ * ],
40
+ * });
41
+ * ```
42
+ *
43
+ * ### Option #2: Manage a single Schema Registry cluster in the same Pulumi Stack
44
+ *
45
+ * ```typescript
46
+ * import * as pulumi from "@pulumi/pulumi";
47
+ * import * as confluentcloud from "@pulumi/confluentcloud";
48
+ *
49
+ * const pii = new confluentcloud.BusinessMetadata("pii", {
50
+ * name: "PII",
51
+ * description: "PII metadata",
52
+ * attributeDefinitions: [
53
+ * {
54
+ * name: "team",
55
+ * },
56
+ * {
57
+ * name: "email",
58
+ * },
59
+ * ],
60
+ * });
61
+ * ```
62
+ *
63
+ * ## Getting Started
64
+ *
65
+ * The following end-to-end example might help to get started with [Stream Catalog](https://docs.confluent.io/cloud/current/stream-governance/stream-catalog.html):
66
+ * * stream-catalog
67
+ *
9
68
  * ## Import
10
69
  *
11
70
  * 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:
@@ -1 +1 @@
1
- {"version":3,"file":"businessMetadata.js","sourceRoot":"","sources":["../businessMetadata.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;GAgBG;AACH,MAAa,gBAAiB,SAAQ,MAAM,CAAC,cAAc;IACvD;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAA6B,EAAE,IAAmC;QAC3H,OAAO,IAAI,gBAAgB,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IACvE,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,gBAAgB,CAAC,YAAY,CAAC;IACjE,CAAC;IAoCD,YAAY,IAAY,EAAE,WAA0D,EAAE,IAAmC;QACrH,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAgD,CAAC;YAC/D,cAAc,CAAC,sBAAsB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAC,SAAS,CAAC;YACxF,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YACxE,cAAc,CAAC,uBAAuB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1F,cAAc,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;SACjE;aAAM;YACH,MAAM,IAAI,GAAG,WAA+C,CAAC;YAC7D,cAAc,CAAC,sBAAsB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,SAAS,CAAC;YACtF,cAAc,CAAC,aAAa,CAAC,GAAG,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,WAAW,EAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAChG,cAAc,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,uBAAuB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,SAAS,CAAC;YACxF,cAAc,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SACjD;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,MAAM,UAAU,GAAG,EAAE,uBAAuB,EAAE,CAAC,aAAa,CAAC,EAAE,CAAC;QAChE,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAC7C,KAAK,CAAC,gBAAgB,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IACrE,CAAC;;AAxFL,4CAyFC;AA3EG,gBAAgB;AACO,6BAAY,GAAG,wDAAwD,CAAC"}
1
+ {"version":3,"file":"businessMetadata.js","sourceRoot":"","sources":["../businessMetadata.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2EG;AACH,MAAa,gBAAiB,SAAQ,MAAM,CAAC,cAAc;IACvD;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAA6B,EAAE,IAAmC;QAC3H,OAAO,IAAI,gBAAgB,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IACvE,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,gBAAgB,CAAC,YAAY,CAAC;IACjE,CAAC;IAoCD,YAAY,IAAY,EAAE,WAA0D,EAAE,IAAmC;QACrH,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAgD,CAAC;YAC/D,cAAc,CAAC,sBAAsB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAC,SAAS,CAAC;YACxF,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YACxE,cAAc,CAAC,uBAAuB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1F,cAAc,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;SACjE;aAAM;YACH,MAAM,IAAI,GAAG,WAA+C,CAAC;YAC7D,cAAc,CAAC,sBAAsB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,SAAS,CAAC;YACtF,cAAc,CAAC,aAAa,CAAC,GAAG,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,WAAW,EAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAChG,cAAc,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,uBAAuB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,SAAS,CAAC;YACxF,cAAc,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SACjD;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,MAAM,UAAU,GAAG,EAAE,uBAAuB,EAAE,CAAC,aAAa,CAAC,EAAE,CAAC;QAChE,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAC7C,KAAK,CAAC,gBAAgB,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IACrE,CAAC;;AAxFL,4CAyFC;AA3EG,gBAAgB;AACO,6BAAY,GAAG,wDAAwD,CAAC"}
@@ -2,6 +2,65 @@ import * as pulumi from "@pulumi/pulumi";
2
2
  import * as inputs from "./types/input";
3
3
  import * as outputs from "./types/output";
4
4
  /**
5
+ * [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy)
6
+ *
7
+ * `confluentcloud.BusinessMetadataBinding` provides a Business Metadata Binding resource that enables creating, editing, and deleting Business Metadata Bindings on Confluent Cloud.
8
+ *
9
+ * ## Example Usage
10
+ *
11
+ * ### Option #1: Manage multiple Schema Registry clusters in the same Pulumi Stack
12
+ *
13
+ * ```typescript
14
+ * import * as pulumi from "@pulumi/pulumi";
15
+ * import * as confluentcloud from "@pulumi/confluentcloud";
16
+ *
17
+ * const main = confluentcloud.getKafkaTopic({
18
+ * topicName: "orders",
19
+ * });
20
+ * const mainBusinessMetadataBinding = new confluentcloud.BusinessMetadataBinding("main", {
21
+ * schemaRegistryCluster: {
22
+ * id: essentials.id,
23
+ * },
24
+ * restEndpoint: essentials.restEndpoint,
25
+ * credentials: {
26
+ * key: "<Schema Registry API Key for data.confluent_schema_registry_cluster.essentials>",
27
+ * secret: "<Schema Registry API Secret for data.confluent_schema_registry_cluster.essentials>",
28
+ * },
29
+ * businessMetadataName: pii.name,
30
+ * entityName: main.then(main => `${schemaRegistryId}:${kafkaId}:${main.topicName}`),
31
+ * entityType: "kafka_topic",
32
+ * attributes: {
33
+ * team: "teamName",
34
+ * email: "team@company.com",
35
+ * },
36
+ * });
37
+ * ```
38
+ *
39
+ * ### Option #2: Manage a single Schema Registry cluster in the same Pulumi Stack
40
+ *
41
+ * ```typescript
42
+ * import * as pulumi from "@pulumi/pulumi";
43
+ * import * as confluentcloud from "@pulumi/confluentcloud";
44
+ *
45
+ * const main = confluentcloud.getKafkaTopic({
46
+ * topicName: "orders",
47
+ * });
48
+ * const mainBusinessMetadataBinding = new confluentcloud.BusinessMetadataBinding("main", {
49
+ * businessMetadataName: pii.name,
50
+ * entityName: main.then(main => `${schemaRegistryId}:${kafkaId}:${main.topicName}`),
51
+ * entityType: "kafka_topic",
52
+ * attributes: {
53
+ * team: "teamName",
54
+ * email: "team@company.com",
55
+ * },
56
+ * });
57
+ * ```
58
+ *
59
+ * ## Getting Started
60
+ *
61
+ * The following end-to-end example might help to get started with [Stream Catalog](https://docs.confluent.io/cloud/current/stream-governance/stream-catalog.html):
62
+ * * stream-catalog
63
+ *
5
64
  * ## Import
6
65
  *
7
66
  * You can import a Business Metadata Binding by using the Schema Registry cluster ID, Business Metadata name, entity name and entity type in the format `<Schema Registry Cluster Id>/<Business Metadata Name>/<Entity Name>/<Entity Type>`, for example:
@@ -6,6 +6,65 @@ exports.BusinessMetadataBinding = void 0;
6
6
  const pulumi = require("@pulumi/pulumi");
7
7
  const utilities = require("./utilities");
8
8
  /**
9
+ * [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy)
10
+ *
11
+ * `confluentcloud.BusinessMetadataBinding` provides a Business Metadata Binding resource that enables creating, editing, and deleting Business Metadata Bindings on Confluent Cloud.
12
+ *
13
+ * ## Example Usage
14
+ *
15
+ * ### Option #1: Manage multiple Schema Registry clusters in the same Pulumi Stack
16
+ *
17
+ * ```typescript
18
+ * import * as pulumi from "@pulumi/pulumi";
19
+ * import * as confluentcloud from "@pulumi/confluentcloud";
20
+ *
21
+ * const main = confluentcloud.getKafkaTopic({
22
+ * topicName: "orders",
23
+ * });
24
+ * const mainBusinessMetadataBinding = new confluentcloud.BusinessMetadataBinding("main", {
25
+ * schemaRegistryCluster: {
26
+ * id: essentials.id,
27
+ * },
28
+ * restEndpoint: essentials.restEndpoint,
29
+ * credentials: {
30
+ * key: "<Schema Registry API Key for data.confluent_schema_registry_cluster.essentials>",
31
+ * secret: "<Schema Registry API Secret for data.confluent_schema_registry_cluster.essentials>",
32
+ * },
33
+ * businessMetadataName: pii.name,
34
+ * entityName: main.then(main => `${schemaRegistryId}:${kafkaId}:${main.topicName}`),
35
+ * entityType: "kafka_topic",
36
+ * attributes: {
37
+ * team: "teamName",
38
+ * email: "team@company.com",
39
+ * },
40
+ * });
41
+ * ```
42
+ *
43
+ * ### Option #2: Manage a single Schema Registry cluster in the same Pulumi Stack
44
+ *
45
+ * ```typescript
46
+ * import * as pulumi from "@pulumi/pulumi";
47
+ * import * as confluentcloud from "@pulumi/confluentcloud";
48
+ *
49
+ * const main = confluentcloud.getKafkaTopic({
50
+ * topicName: "orders",
51
+ * });
52
+ * const mainBusinessMetadataBinding = new confluentcloud.BusinessMetadataBinding("main", {
53
+ * businessMetadataName: pii.name,
54
+ * entityName: main.then(main => `${schemaRegistryId}:${kafkaId}:${main.topicName}`),
55
+ * entityType: "kafka_topic",
56
+ * attributes: {
57
+ * team: "teamName",
58
+ * email: "team@company.com",
59
+ * },
60
+ * });
61
+ * ```
62
+ *
63
+ * ## Getting Started
64
+ *
65
+ * The following end-to-end example might help to get started with [Stream Catalog](https://docs.confluent.io/cloud/current/stream-governance/stream-catalog.html):
66
+ * * stream-catalog
67
+ *
9
68
  * ## Import
10
69
  *
11
70
  * You can import a Business Metadata Binding by using the Schema Registry cluster ID, Business Metadata name, entity name and entity type in the format `<Schema Registry Cluster Id>/<Business Metadata Name>/<Entity Name>/<Entity Type>`, for example:
@@ -1 +1 @@
1
- {"version":3,"file":"businessMetadataBinding.js","sourceRoot":"","sources":["../businessMetadataBinding.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;GAgBG;AACH,MAAa,uBAAwB,SAAQ,MAAM,CAAC,cAAc;IAC9D;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAoC,EAAE,IAAmC;QAClI,OAAO,IAAI,uBAAuB,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAC9E,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,uBAAuB,CAAC,YAAY,CAAC;IACxE,CAAC;IAoCD,YAAY,IAAY,EAAE,WAAwE,EAAE,IAAmC;QACnI,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAuD,CAAC;YACtE,cAAc,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,sBAAsB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAC,SAAS,CAAC;YACxF,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YACxE,cAAc,CAAC,uBAAuB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC,CAAC,SAAS,CAAC;SAC7F;aAAM;YACH,MAAM,IAAI,GAAG,WAAsD,CAAC;YACpE,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,oBAAoB,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACjE,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;aACvE;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACvD,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;aAC7D;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACvD,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;aAC7D;YACD,cAAc,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,sBAAsB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,SAAS,CAAC;YACtF,cAAc,CAAC,aAAa,CAAC,GAAG,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,WAAW,EAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAChG,cAAc,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,uBAAuB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,SAAS,CAAC;SAC3F;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,MAAM,UAAU,GAAG,EAAE,uBAAuB,EAAE,CAAC,aAAa,CAAC,EAAE,CAAC;QAChE,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAC7C,KAAK,CAAC,uBAAuB,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAC5E,CAAC;;AAjGL,0DAkGC;AApFG,gBAAgB;AACO,oCAAY,GAAG,sEAAsE,CAAC"}
1
+ {"version":3,"file":"businessMetadataBinding.js","sourceRoot":"","sources":["../businessMetadataBinding.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2EG;AACH,MAAa,uBAAwB,SAAQ,MAAM,CAAC,cAAc;IAC9D;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAoC,EAAE,IAAmC;QAClI,OAAO,IAAI,uBAAuB,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAC9E,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,uBAAuB,CAAC,YAAY,CAAC;IACxE,CAAC;IAoCD,YAAY,IAAY,EAAE,WAAwE,EAAE,IAAmC;QACnI,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAuD,CAAC;YACtE,cAAc,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,sBAAsB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAC,SAAS,CAAC;YACxF,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YACxE,cAAc,CAAC,uBAAuB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC,CAAC,SAAS,CAAC;SAC7F;aAAM;YACH,MAAM,IAAI,GAAG,WAAsD,CAAC;YACpE,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,oBAAoB,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACjE,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;aACvE;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACvD,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;aAC7D;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACvD,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;aAC7D;YACD,cAAc,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,sBAAsB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,SAAS,CAAC;YACtF,cAAc,CAAC,aAAa,CAAC,GAAG,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,WAAW,EAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAChG,cAAc,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,uBAAuB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,SAAS,CAAC;SAC3F;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,MAAM,UAAU,GAAG,EAAE,uBAAuB,EAAE,CAAC,aAAa,CAAC,EAAE,CAAC;QAChE,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAC7C,KAAK,CAAC,uBAAuB,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAC5E,CAAC;;AAjGL,0DAkGC;AApFG,gBAAgB;AACO,oCAAY,GAAG,sEAAsE,CAAC"}
@@ -1,6 +1,122 @@
1
1
  import * as pulumi from "@pulumi/pulumi";
2
2
  import * as inputs from "./types/input";
3
3
  import * as outputs from "./types/output";
4
+ /**
5
+ * [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy)
6
+ *
7
+ * > **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.\
8
+ * **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.
9
+ *
10
+ * ## Example Usage
11
+ *
12
+ * ### Option #1: Manage multiple Schema Registry clusters in the same Pulumi Stack
13
+ *
14
+ * ```typescript
15
+ * import * as pulumi from "@pulumi/pulumi";
16
+ * import * as confluentcloud from "@pulumi/confluentcloud";
17
+ *
18
+ * const environment = new confluentcloud.CatalogEntityAttributes("environment", {
19
+ * schemaRegistryCluster: {
20
+ * id: essentials.id,
21
+ * },
22
+ * restEndpoint: essentials.restEndpoint,
23
+ * credentials: {
24
+ * key: "<Schema Registry API Key for data.confluent_schema_registry_cluster.essentials>",
25
+ * secret: "<Schema Registry API Secret for data.confluent_schema_registry_cluster.essentials>",
26
+ * },
27
+ * entityName: main.id,
28
+ * entityType: "cf_environment",
29
+ * attributes: {
30
+ * description: "Environment description",
31
+ * },
32
+ * });
33
+ * const kafka_cluster = new confluentcloud.CatalogEntityAttributes("kafka-cluster", {
34
+ * schemaRegistryCluster: {
35
+ * id: essentials.id,
36
+ * },
37
+ * restEndpoint: essentials.restEndpoint,
38
+ * credentials: {
39
+ * key: "<Schema Registry API Key for data.confluent_schema_registry_cluster.essentials>",
40
+ * secret: "<Schema Registry API Secret for data.confluent_schema_registry_cluster.essentials>",
41
+ * },
42
+ * entityName: basic.id,
43
+ * entityType: "kafka_logical_cluster",
44
+ * attributes: {
45
+ * description: "Kafka Cluster description",
46
+ * },
47
+ * });
48
+ * const topic = new confluentcloud.CatalogEntityAttributes("topic", {
49
+ * schemaRegistryCluster: {
50
+ * id: essentials.id,
51
+ * },
52
+ * restEndpoint: essentials.restEndpoint,
53
+ * credentials: {
54
+ * key: "<Schema Registry API Key for data.confluent_schema_registry_cluster.essentials>",
55
+ * secret: "<Schema Registry API Secret for data.confluent_schema_registry_cluster.essentials>",
56
+ * },
57
+ * entityName: `${basic.id}:${purchase.topicName}`,
58
+ * entityType: "kafka_topic",
59
+ * attributes: {
60
+ * owner: "dev",
61
+ * description: "Kafka topic for orders",
62
+ * ownerEmail: "dev@gmail.com",
63
+ * },
64
+ * });
65
+ * const schema = new confluentcloud.CatalogEntityAttributes("schema", {
66
+ * schemaRegistryCluster: {
67
+ * id: essentials.id,
68
+ * },
69
+ * restEndpoint: essentials.restEndpoint,
70
+ * credentials: {
71
+ * key: "<Schema Registry API Key for data.confluent_schema_registry_cluster.essentials>",
72
+ * secret: "<Schema Registry API Secret for data.confluent_schema_registry_cluster.essentials>",
73
+ * },
74
+ * entityName: `${essentials.id}:.:${purchaseConfluentSchema.schemaIdentifier}`,
75
+ * entityType: "sr_schema",
76
+ * attributes: {
77
+ * description: "Schema description",
78
+ * },
79
+ * });
80
+ * ```
81
+ *
82
+ * ### Option #2: Manage a single Schema Registry cluster in the same Pulumi Stack
83
+ *
84
+ * ```typescript
85
+ * import * as pulumi from "@pulumi/pulumi";
86
+ * import * as confluentcloud from "@pulumi/confluentcloud";
87
+ *
88
+ * const environment = new confluentcloud.CatalogEntityAttributes("environment", {
89
+ * entityName: environmentId,
90
+ * entityType: "cf_environment",
91
+ * attributes: {
92
+ * description: "Environment description",
93
+ * },
94
+ * });
95
+ * const kafka_cluster = new confluentcloud.CatalogEntityAttributes("kafka-cluster", {
96
+ * entityName: kafkaClusterId,
97
+ * entityType: "kafka_logical_cluster",
98
+ * attributes: {
99
+ * description: "Kafka Cluster description",
100
+ * },
101
+ * });
102
+ * const topic = new confluentcloud.CatalogEntityAttributes("topic", {
103
+ * entityName: `${kafkaClusterId}:${kafkaTopicName}`,
104
+ * entityType: "kafka_topic",
105
+ * attributes: {
106
+ * owner: "dev",
107
+ * description: "Kafka topic for orders",
108
+ * ownerEmail: "dev@gmail.com",
109
+ * },
110
+ * });
111
+ * const schema = new confluentcloud.CatalogEntityAttributes("schema", {
112
+ * entityName: `${schemaRegistryClusterId}:.:${purchase.schemaIdentifier}`,
113
+ * entityType: "sr_schema",
114
+ * attributes: {
115
+ * description: "Schema description",
116
+ * },
117
+ * });
118
+ * ```
119
+ */
4
120
  export declare class CatalogEntityAttributes extends pulumi.CustomResource {
5
121
  /**
6
122
  * Get an existing CatalogEntityAttributes resource's state with the given name, ID, and optional extra
@@ -5,6 +5,122 @@ Object.defineProperty(exports, "__esModule", { value: true });
5
5
  exports.CatalogEntityAttributes = void 0;
6
6
  const pulumi = require("@pulumi/pulumi");
7
7
  const utilities = require("./utilities");
8
+ /**
9
+ * [![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy)
10
+ *
11
+ * > **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.\
12
+ * **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.
13
+ *
14
+ * ## Example Usage
15
+ *
16
+ * ### Option #1: Manage multiple Schema Registry clusters in the same Pulumi Stack
17
+ *
18
+ * ```typescript
19
+ * import * as pulumi from "@pulumi/pulumi";
20
+ * import * as confluentcloud from "@pulumi/confluentcloud";
21
+ *
22
+ * const environment = new confluentcloud.CatalogEntityAttributes("environment", {
23
+ * schemaRegistryCluster: {
24
+ * id: essentials.id,
25
+ * },
26
+ * restEndpoint: essentials.restEndpoint,
27
+ * credentials: {
28
+ * key: "<Schema Registry API Key for data.confluent_schema_registry_cluster.essentials>",
29
+ * secret: "<Schema Registry API Secret for data.confluent_schema_registry_cluster.essentials>",
30
+ * },
31
+ * entityName: main.id,
32
+ * entityType: "cf_environment",
33
+ * attributes: {
34
+ * description: "Environment description",
35
+ * },
36
+ * });
37
+ * const kafka_cluster = new confluentcloud.CatalogEntityAttributes("kafka-cluster", {
38
+ * schemaRegistryCluster: {
39
+ * id: essentials.id,
40
+ * },
41
+ * restEndpoint: essentials.restEndpoint,
42
+ * credentials: {
43
+ * key: "<Schema Registry API Key for data.confluent_schema_registry_cluster.essentials>",
44
+ * secret: "<Schema Registry API Secret for data.confluent_schema_registry_cluster.essentials>",
45
+ * },
46
+ * entityName: basic.id,
47
+ * entityType: "kafka_logical_cluster",
48
+ * attributes: {
49
+ * description: "Kafka Cluster description",
50
+ * },
51
+ * });
52
+ * const topic = new confluentcloud.CatalogEntityAttributes("topic", {
53
+ * schemaRegistryCluster: {
54
+ * id: essentials.id,
55
+ * },
56
+ * restEndpoint: essentials.restEndpoint,
57
+ * credentials: {
58
+ * key: "<Schema Registry API Key for data.confluent_schema_registry_cluster.essentials>",
59
+ * secret: "<Schema Registry API Secret for data.confluent_schema_registry_cluster.essentials>",
60
+ * },
61
+ * entityName: `${basic.id}:${purchase.topicName}`,
62
+ * entityType: "kafka_topic",
63
+ * attributes: {
64
+ * owner: "dev",
65
+ * description: "Kafka topic for orders",
66
+ * ownerEmail: "dev@gmail.com",
67
+ * },
68
+ * });
69
+ * const schema = new confluentcloud.CatalogEntityAttributes("schema", {
70
+ * schemaRegistryCluster: {
71
+ * id: essentials.id,
72
+ * },
73
+ * restEndpoint: essentials.restEndpoint,
74
+ * credentials: {
75
+ * key: "<Schema Registry API Key for data.confluent_schema_registry_cluster.essentials>",
76
+ * secret: "<Schema Registry API Secret for data.confluent_schema_registry_cluster.essentials>",
77
+ * },
78
+ * entityName: `${essentials.id}:.:${purchaseConfluentSchema.schemaIdentifier}`,
79
+ * entityType: "sr_schema",
80
+ * attributes: {
81
+ * description: "Schema description",
82
+ * },
83
+ * });
84
+ * ```
85
+ *
86
+ * ### Option #2: Manage a single Schema Registry cluster in the same Pulumi Stack
87
+ *
88
+ * ```typescript
89
+ * import * as pulumi from "@pulumi/pulumi";
90
+ * import * as confluentcloud from "@pulumi/confluentcloud";
91
+ *
92
+ * const environment = new confluentcloud.CatalogEntityAttributes("environment", {
93
+ * entityName: environmentId,
94
+ * entityType: "cf_environment",
95
+ * attributes: {
96
+ * description: "Environment description",
97
+ * },
98
+ * });
99
+ * const kafka_cluster = new confluentcloud.CatalogEntityAttributes("kafka-cluster", {
100
+ * entityName: kafkaClusterId,
101
+ * entityType: "kafka_logical_cluster",
102
+ * attributes: {
103
+ * description: "Kafka Cluster description",
104
+ * },
105
+ * });
106
+ * const topic = new confluentcloud.CatalogEntityAttributes("topic", {
107
+ * entityName: `${kafkaClusterId}:${kafkaTopicName}`,
108
+ * entityType: "kafka_topic",
109
+ * attributes: {
110
+ * owner: "dev",
111
+ * description: "Kafka topic for orders",
112
+ * ownerEmail: "dev@gmail.com",
113
+ * },
114
+ * });
115
+ * const schema = new confluentcloud.CatalogEntityAttributes("schema", {
116
+ * entityName: `${schemaRegistryClusterId}:.:${purchase.schemaIdentifier}`,
117
+ * entityType: "sr_schema",
118
+ * attributes: {
119
+ * description: "Schema description",
120
+ * },
121
+ * });
122
+ * ```
123
+ */
8
124
  class CatalogEntityAttributes extends pulumi.CustomResource {
9
125
  /**
10
126
  * Get an existing CatalogEntityAttributes resource's state with the given name, ID, and optional extra
@@ -1 +1 @@
1
- {"version":3,"file":"catalogEntityAttributes.js","sourceRoot":"","sources":["../catalogEntityAttributes.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC,MAAa,uBAAwB,SAAQ,MAAM,CAAC,cAAc;IAC9D;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAoC,EAAE,IAAmC;QAClI,OAAO,IAAI,uBAAuB,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAC9E,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,uBAAuB,CAAC,YAAY,CAAC;IACxE,CAAC;IAgCD,YAAY,IAAY,EAAE,WAAwE,EAAE,IAAmC;QACnI,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAuD,CAAC;YACtE,cAAc,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YACxE,cAAc,CAAC,uBAAuB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC,CAAC,SAAS,CAAC;SAC7F;aAAM;YACH,MAAM,IAAI,GAAG,WAAsD,CAAC;YACpE,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACvD,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;aAC7D;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACvD,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;aAC7D;YACD,cAAc,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,aAAa,CAAC,GAAG,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,WAAW,EAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAChG,cAAc,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,uBAAuB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,SAAS,CAAC;SAC3F;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,MAAM,UAAU,GAAG,EAAE,uBAAuB,EAAE,CAAC,aAAa,CAAC,EAAE,CAAC;QAChE,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAC7C,KAAK,CAAC,uBAAuB,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAC5E,CAAC;;AAxFL,0DAyFC;AA3EG,gBAAgB;AACO,oCAAY,GAAG,sEAAsE,CAAC"}
1
+ {"version":3,"file":"catalogEntityAttributes.js","sourceRoot":"","sources":["../catalogEntityAttributes.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmHG;AACH,MAAa,uBAAwB,SAAQ,MAAM,CAAC,cAAc;IAC9D;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAoC,EAAE,IAAmC;QAClI,OAAO,IAAI,uBAAuB,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAC9E,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,uBAAuB,CAAC,YAAY,CAAC;IACxE,CAAC;IAgCD,YAAY,IAAY,EAAE,WAAwE,EAAE,IAAmC;QACnI,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAuD,CAAC;YACtE,cAAc,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YACxE,cAAc,CAAC,uBAAuB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC,CAAC,SAAS,CAAC;SAC7F;aAAM;YACH,MAAM,IAAI,GAAG,WAAsD,CAAC;YACpE,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACvD,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;aAC7D;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACvD,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;aAC7D;YACD,cAAc,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,aAAa,CAAC,GAAG,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,WAAW,EAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAChG,cAAc,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,uBAAuB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,SAAS,CAAC;SAC3F;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,MAAM,UAAU,GAAG,EAAE,uBAAuB,EAAE,CAAC,aAAa,CAAC,EAAE,CAAC;QAChE,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAC7C,KAAK,CAAC,uBAAuB,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAC5E,CAAC;;AAxFL,0DAyFC;AA3EG,gBAAgB;AACO,oCAAY,GAAG,sEAAsE,CAAC"}
@@ -2,11 +2,66 @@ import * as pulumi from "@pulumi/pulumi";
2
2
  import * as inputs from "./types/input";
3
3
  import * as outputs from "./types/output";
4
4
  /**
5
+ * ## Example Usage
6
+ *
7
+ * ### Option #1: Manage multiple Flink Compute Pools in the same Pulumi Stack
8
+ *
9
+ * ```typescript
10
+ * import * as pulumi from "@pulumi/pulumi";
11
+ * import * as confluentcloud from "@pulumi/confluentcloud";
12
+ *
13
+ * const randomIntTable = new confluentcloud.FlinkStatement("random_int_table", {
14
+ * organization: {
15
+ * id: main.id,
16
+ * },
17
+ * environment: {
18
+ * id: staging.id,
19
+ * },
20
+ * computePool: {
21
+ * id: example.id,
22
+ * },
23
+ * principal: {
24
+ * id: app_manager_flink.id,
25
+ * },
26
+ * statement: "CREATE TABLE random_int_table(ts TIMESTAMP_LTZ(3), random_value INT);",
27
+ * properties: {
28
+ * "sql.current-catalog": exampleConfluentEnvironment.displayName,
29
+ * "sql.current-database": exampleConfluentKafkaCluster.displayName,
30
+ * },
31
+ * restEndpoint: mainConfluentFlinkRegion.restEndpoint,
32
+ * credentials: {
33
+ * key: env_admin_flink_api_key.id,
34
+ * secret: env_admin_flink_api_key.secret,
35
+ * },
36
+ * });
37
+ * ```
38
+ *
39
+ * ### Option #2: Manage a single Flink Compute Pool in the same Pulumi Stack
40
+ *
41
+ * ```typescript
42
+ * import * as pulumi from "@pulumi/pulumi";
43
+ * import * as confluentcloud from "@pulumi/confluentcloud";
44
+ *
45
+ * const example = new confluentcloud.FlinkStatement("example", {
46
+ * statement: "CREATE TABLE random_int_table(ts TIMESTAMP_LTZ(3), random_value INT);",
47
+ * properties: {
48
+ * "sql.current-catalog": confluentEnvironmentDisplayName,
49
+ * "sql.current-database": confluentKafkaClusterDisplayName,
50
+ * },
51
+ * });
52
+ * ```
53
+ *
54
+ * ## Getting Started
55
+ *
56
+ * The following end-to-end example might help to get started with [Flink Statements](https://docs.confluent.io/cloud/current/flink/get-started/overview.html):
57
+ * * flink-quickstart
58
+ * * flink-carry-over-offset-between-statements
59
+ *
5
60
  * ## Import
6
61
  *
7
62
  * You can import a Flink statement by using the Flink Statement name, for example:
8
63
  *
9
- * Option #1: Manage multiple Flink Compute Pools in the same Terraform workspace
64
+ * Option #1: Manage multiple Flink Compute Pools in the same Pulumi Stack
10
65
  *
11
66
  * $ export IMPORT_CONFLUENT_ORGANIZATION_ID="<organization_id>"
12
67
  *
@@ -26,7 +81,7 @@ import * as outputs from "./types/output";
26
81
  * $ pulumi import confluentcloud:index/flinkStatement:FlinkStatement example cfeab4fe-b62c-49bd-9e99-51cc98c77a67
27
82
  * ```
28
83
  *
29
- * Option #2: Manage a single Flink Compute Pool in the same Terraform workspace
84
+ * Option #2: Manage a single Flink Compute Pool in the same Pulumi Stack
30
85
  *
31
86
  * ```sh
32
87
  * $ pulumi import confluentcloud:index/flinkStatement:FlinkStatement example cfeab4fe-b62c-49bd-9e99-51cc98c77a67