@pulumi/confluentcloud 1.47.0-alpha.1716264894 → 1.47.0-alpha.1716960167

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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pulumi/confluentcloud",
3
- "version": "1.47.0-alpha.1716264894",
3
+ "version": "1.47.0-alpha.1716960167",
4
4
  "description": "A Pulumi package for creating and managing Confluent cloud resources.",
5
5
  "keywords": [
6
6
  "pulumi",
@@ -24,6 +24,6 @@
24
24
  "pulumi": {
25
25
  "resource": true,
26
26
  "name": "confluentcloud",
27
- "version": "1.47.0-alpha.1716264894"
27
+ "version": "1.47.0-alpha.1716960167"
28
28
  }
29
29
  }
package/types/input.d.ts CHANGED
@@ -62,7 +62,7 @@ export interface ApiKeyManagedResource {
62
62
  */
63
63
  environment: pulumi.Input<inputs.ApiKeyManagedResourceEnvironment>;
64
64
  /**
65
- * The ID of the Environment that the managed resource belongs to, for example, `env-abc123`.
65
+ * The ID of the managed resource that the API Key associated with, for example, `lkc-abc123`.
66
66
  */
67
67
  id: pulumi.Input<string>;
68
68
  /**
@@ -72,7 +72,7 @@ export interface ApiKeyManagedResource {
72
72
  }
73
73
  export interface ApiKeyManagedResourceEnvironment {
74
74
  /**
75
- * (Required String) The ID of the API Key, for example, `EGWX3S4BVNQIRBMJ`.
75
+ * The ID of the Environment that the managed resource belongs to, for example, `env-abc123`.
76
76
  */
77
77
  id: pulumi.Input<string>;
78
78
  }
@@ -109,6 +109,8 @@ export interface BusinessMetadataAttributeDefinition {
109
109
  name: pulumi.Input<string>;
110
110
  /**
111
111
  * (Optional Map) Block for the attribute options:
112
+ * - `applicableEntityTypes` - (Optional String) The entity types that the attribute is applicable, it always returns `[\"cf_entity\"]`.
113
+ * - `maxStrLength` - (Optional String) The maximum length of the string value, it always returns `5000`.
112
114
  */
113
115
  options?: pulumi.Input<{
114
116
  [key: string]: pulumi.Input<string>;
@@ -224,11 +226,11 @@ export interface ClusterLinkDestinationKafkaCluster {
224
226
  }
225
227
  export interface ClusterLinkDestinationKafkaClusterCredentials {
226
228
  /**
227
- * The Kafka API Key for your Confluent Cloud cluster.
229
+ * The Kafka API Key.
228
230
  */
229
231
  key: pulumi.Input<string>;
230
232
  /**
231
- * The Kafka API Secret for your Confluent Cloud cluster.
233
+ * The Kafka API Secret.
232
234
  */
233
235
  secret: pulumi.Input<string>;
234
236
  }
@@ -252,11 +254,11 @@ export interface ClusterLinkLocalKafkaCluster {
252
254
  }
253
255
  export interface ClusterLinkLocalKafkaClusterCredentials {
254
256
  /**
255
- * The Kafka API Key for your Confluent Cloud cluster.
257
+ * The Kafka API Key.
256
258
  */
257
259
  key: pulumi.Input<string>;
258
260
  /**
259
- * The Kafka API Secret for your Confluent Cloud cluster.
261
+ * The Kafka API Secret.
260
262
  */
261
263
  secret: pulumi.Input<string>;
262
264
  }
@@ -280,11 +282,11 @@ export interface ClusterLinkRemoteKafkaCluster {
280
282
  }
281
283
  export interface ClusterLinkRemoteKafkaClusterCredentials {
282
284
  /**
283
- * The Kafka API Key for your Confluent Cloud cluster.
285
+ * The Kafka API Key.
284
286
  */
285
287
  key: pulumi.Input<string>;
286
288
  /**
287
- * The Kafka API Secret for your Confluent Cloud cluster.
289
+ * The Kafka API Secret.
288
290
  */
289
291
  secret: pulumi.Input<string>;
290
292
  }
@@ -308,11 +310,11 @@ export interface ClusterLinkSourceKafkaCluster {
308
310
  }
309
311
  export interface ClusterLinkSourceKafkaClusterCredentials {
310
312
  /**
311
- * The Kafka API Key for your Confluent Cloud cluster.
313
+ * The Kafka API Key.
312
314
  */
313
315
  key: pulumi.Input<string>;
314
316
  /**
315
- * The Kafka API Secret for your Confluent Cloud cluster.
317
+ * The Kafka API Secret.
316
318
  */
317
319
  secret: pulumi.Input<string>;
318
320
  }
@@ -1687,11 +1689,11 @@ export interface KafkaMirrorTopicKafkaCluster {
1687
1689
  }
1688
1690
  export interface KafkaMirrorTopicKafkaClusterCredentials {
1689
1691
  /**
1690
- * The Kafka API Key for your Confluent Cloud cluster.
1692
+ * The Kafka API Key.
1691
1693
  */
1692
1694
  key: pulumi.Input<string>;
1693
1695
  /**
1694
- * The Kafka API Secret for your Confluent Cloud cluster.
1696
+ * The Kafka API Secret.
1695
1697
  */
1696
1698
  secret: pulumi.Input<string>;
1697
1699
  }
@@ -2070,7 +2072,13 @@ export interface SchemaMetadata {
2070
2072
  tags?: pulumi.Input<pulumi.Input<inputs.SchemaMetadataTag>[]>;
2071
2073
  }
2072
2074
  export interface SchemaMetadataTag {
2075
+ /**
2076
+ * The setting name.
2077
+ */
2073
2078
  key?: pulumi.Input<string>;
2079
+ /**
2080
+ * The list of tags.
2081
+ */
2074
2082
  values?: pulumi.Input<pulumi.Input<string>[]>;
2075
2083
  }
2076
2084
  export interface SchemaRegistryClusterConfigCredentials {
@@ -2154,17 +2162,52 @@ export interface SchemaRuleset {
2154
2162
  migrationRules?: pulumi.Input<pulumi.Input<inputs.SchemaRulesetMigrationRule>[]>;
2155
2163
  }
2156
2164
  export interface SchemaRulesetDomainRule {
2165
+ /**
2166
+ * An optional description of the rule.
2167
+ */
2157
2168
  doc?: pulumi.Input<string>;
2169
+ /**
2170
+ * The body of the rule, which is optional.
2171
+ */
2158
2172
  expr?: pulumi.Input<string>;
2173
+ /**
2174
+ * The kind of the rule. Accepted values are `CONDITION` and `TRANSFORM`.
2175
+ */
2159
2176
  kind?: pulumi.Input<string>;
2177
+ /**
2178
+ * The mode of the rule. Accepted values are `UPGRADE`, `DOWNGRADE`, `UPDOWN`, `WRITE`, `READ`, and `WRITEREAD`.
2179
+ */
2160
2180
  mode?: pulumi.Input<string>;
2181
+ /**
2182
+ * A user-defined name that can be used to reference the rule.
2183
+ */
2161
2184
  name?: pulumi.Input<string>;
2185
+ /**
2186
+ * An optional action to execute if the rule fails, otherwise the built-in action type ERROR is used. For `UPDOWN` and `WRITEREAD` rules, one can specify two actions separated by commas, as mentioned above.
2187
+ */
2162
2188
  onFailure?: pulumi.Input<string>;
2189
+ /**
2190
+ * An optional action to execute if the rule succeeds, otherwise the built-in action type NONE is used. For `UPDOWN` and `WRITEREAD` rules, one can specify two actions separated by commas, such as "NONE,ERROR" for a `WRITEREAD` rule. In this case `NONE` applies to `WRITE` and `ERROR` applies to `READ`.
2191
+ */
2163
2192
  onSuccess?: pulumi.Input<string>;
2193
+ /**
2194
+ * A set of static parameters for the rule, which is optional. These are key-value pairs that are passed to the rule.
2195
+ *
2196
+ * > **Note:** Schema rules (`ruleset`) are only available with the [Stream Governance Advanced package](https://docs.confluent.io/cloud/current/stream-governance/packages.html#packages).
2197
+ *
2198
+ * > **Note:** `ruleset` and `metadata` attributes are 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.
2199
+ * **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.
2200
+ */
2164
2201
  params?: pulumi.Input<{
2165
2202
  [key: string]: pulumi.Input<string>;
2166
2203
  }>;
2204
+ /**
2205
+ * The tags to which the rule applies, if any.
2206
+ */
2167
2207
  tags?: pulumi.Input<pulumi.Input<string>[]>;
2208
+ /**
2209
+ * The type of rule, which invokes a specific rule executor, such as Google Common Expression Language (CEL) or JSONata.
2210
+ */
2168
2211
  type?: pulumi.Input<string>;
2169
2212
  }
2170
2213
  export interface SchemaRulesetMigrationRule {
package/types/output.d.ts CHANGED
@@ -61,7 +61,7 @@ export interface ApiKeyManagedResource {
61
61
  */
62
62
  environment: outputs.ApiKeyManagedResourceEnvironment;
63
63
  /**
64
- * The ID of the Environment that the managed resource belongs to, for example, `env-abc123`.
64
+ * The ID of the managed resource that the API Key associated with, for example, `lkc-abc123`.
65
65
  */
66
66
  id: string;
67
67
  /**
@@ -71,7 +71,7 @@ export interface ApiKeyManagedResource {
71
71
  }
72
72
  export interface ApiKeyManagedResourceEnvironment {
73
73
  /**
74
- * (Required String) The ID of the API Key, for example, `EGWX3S4BVNQIRBMJ`.
74
+ * The ID of the Environment that the managed resource belongs to, for example, `env-abc123`.
75
75
  */
76
76
  id: string;
77
77
  }
@@ -108,6 +108,8 @@ export interface BusinessMetadataAttributeDefinition {
108
108
  name: string;
109
109
  /**
110
110
  * (Optional Map) Block for the attribute options:
111
+ * - `applicableEntityTypes` - (Optional String) The entity types that the attribute is applicable, it always returns `[\"cf_entity\"]`.
112
+ * - `maxStrLength` - (Optional String) The maximum length of the string value, it always returns `5000`.
111
113
  */
112
114
  options: {
113
115
  [key: string]: string;
@@ -223,11 +225,11 @@ export interface ClusterLinkDestinationKafkaCluster {
223
225
  }
224
226
  export interface ClusterLinkDestinationKafkaClusterCredentials {
225
227
  /**
226
- * The Kafka API Key for your Confluent Cloud cluster.
228
+ * The Kafka API Key.
227
229
  */
228
230
  key: string;
229
231
  /**
230
- * The Kafka API Secret for your Confluent Cloud cluster.
232
+ * The Kafka API Secret.
231
233
  */
232
234
  secret: string;
233
235
  }
@@ -251,11 +253,11 @@ export interface ClusterLinkLocalKafkaCluster {
251
253
  }
252
254
  export interface ClusterLinkLocalKafkaClusterCredentials {
253
255
  /**
254
- * The Kafka API Key for your Confluent Cloud cluster.
256
+ * The Kafka API Key.
255
257
  */
256
258
  key: string;
257
259
  /**
258
- * The Kafka API Secret for your Confluent Cloud cluster.
260
+ * The Kafka API Secret.
259
261
  */
260
262
  secret: string;
261
263
  }
@@ -279,11 +281,11 @@ export interface ClusterLinkRemoteKafkaCluster {
279
281
  }
280
282
  export interface ClusterLinkRemoteKafkaClusterCredentials {
281
283
  /**
282
- * The Kafka API Key for your Confluent Cloud cluster.
284
+ * The Kafka API Key.
283
285
  */
284
286
  key: string;
285
287
  /**
286
- * The Kafka API Secret for your Confluent Cloud cluster.
288
+ * The Kafka API Secret.
287
289
  */
288
290
  secret: string;
289
291
  }
@@ -307,11 +309,11 @@ export interface ClusterLinkSourceKafkaCluster {
307
309
  }
308
310
  export interface ClusterLinkSourceKafkaClusterCredentials {
309
311
  /**
310
- * The Kafka API Key for your Confluent Cloud cluster.
312
+ * The Kafka API Key.
311
313
  */
312
314
  key: string;
313
315
  /**
314
- * The Kafka API Secret for your Confluent Cloud cluster.
316
+ * The Kafka API Secret.
315
317
  */
316
318
  secret: string;
317
319
  }
@@ -486,6 +488,8 @@ export interface GetBusinessMetadataAttributeDefinition {
486
488
  name: string;
487
489
  /**
488
490
  * (Optional Map) Block for the attribute options:
491
+ * - `applicableEntityTypes` - (Optional String) The entity types that the attribute is applicable, it always returns `[\"cf_entity\"]`.
492
+ * - `maxStrLength` - (Optional String) The maximum length of the string value, it always returns `5000`.
489
493
  */
490
494
  options: {
491
495
  [key: string]: string;
@@ -1664,11 +1668,11 @@ export interface KafkaMirrorTopicKafkaCluster {
1664
1668
  }
1665
1669
  export interface KafkaMirrorTopicKafkaClusterCredentials {
1666
1670
  /**
1667
- * The Kafka API Key for your Confluent Cloud cluster.
1671
+ * The Kafka API Key.
1668
1672
  */
1669
1673
  key: string;
1670
1674
  /**
1671
- * The Kafka API Secret for your Confluent Cloud cluster.
1675
+ * The Kafka API Secret.
1672
1676
  */
1673
1677
  secret: string;
1674
1678
  }
@@ -2047,7 +2051,13 @@ export interface SchemaMetadata {
2047
2051
  tags: outputs.SchemaMetadataTag[];
2048
2052
  }
2049
2053
  export interface SchemaMetadataTag {
2054
+ /**
2055
+ * The setting name.
2056
+ */
2050
2057
  key: string;
2058
+ /**
2059
+ * The list of tags.
2060
+ */
2051
2061
  values: string[];
2052
2062
  }
2053
2063
  export interface SchemaRegistryClusterConfigCredentials {
@@ -2131,17 +2141,52 @@ export interface SchemaRuleset {
2131
2141
  migrationRules: outputs.SchemaRulesetMigrationRule[];
2132
2142
  }
2133
2143
  export interface SchemaRulesetDomainRule {
2144
+ /**
2145
+ * An optional description of the rule.
2146
+ */
2134
2147
  doc: string;
2148
+ /**
2149
+ * The body of the rule, which is optional.
2150
+ */
2135
2151
  expr: string;
2152
+ /**
2153
+ * The kind of the rule. Accepted values are `CONDITION` and `TRANSFORM`.
2154
+ */
2136
2155
  kind: string;
2156
+ /**
2157
+ * The mode of the rule. Accepted values are `UPGRADE`, `DOWNGRADE`, `UPDOWN`, `WRITE`, `READ`, and `WRITEREAD`.
2158
+ */
2137
2159
  mode: string;
2160
+ /**
2161
+ * A user-defined name that can be used to reference the rule.
2162
+ */
2138
2163
  name: string;
2164
+ /**
2165
+ * An optional action to execute if the rule fails, otherwise the built-in action type ERROR is used. For `UPDOWN` and `WRITEREAD` rules, one can specify two actions separated by commas, as mentioned above.
2166
+ */
2139
2167
  onFailure: string;
2168
+ /**
2169
+ * An optional action to execute if the rule succeeds, otherwise the built-in action type NONE is used. For `UPDOWN` and `WRITEREAD` rules, one can specify two actions separated by commas, such as "NONE,ERROR" for a `WRITEREAD` rule. In this case `NONE` applies to `WRITE` and `ERROR` applies to `READ`.
2170
+ */
2140
2171
  onSuccess: string;
2172
+ /**
2173
+ * A set of static parameters for the rule, which is optional. These are key-value pairs that are passed to the rule.
2174
+ *
2175
+ * > **Note:** Schema rules (`ruleset`) are only available with the [Stream Governance Advanced package](https://docs.confluent.io/cloud/current/stream-governance/packages.html#packages).
2176
+ *
2177
+ * > **Note:** `ruleset` and `metadata` attributes are 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.
2178
+ * **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.
2179
+ */
2141
2180
  params: {
2142
2181
  [key: string]: string;
2143
2182
  };
2183
+ /**
2184
+ * The tags to which the rule applies, if any.
2185
+ */
2144
2186
  tags: string[];
2187
+ /**
2188
+ * The type of rule, which invokes a specific rule executor, such as Google Common Expression Language (CEL) or JSONata.
2189
+ */
2145
2190
  type: string;
2146
2191
  }
2147
2192
  export interface SchemaRulesetMigrationRule {