@pulumi/confluentcloud 1.16.0-alpha.1683783653 → 1.16.0

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 (57) hide show
  1. package/businessMetadataBinding.d.ts +6 -6
  2. package/connector.d.ts +0 -9
  3. package/connector.js.map +1 -1
  4. package/getBusinessMetadata.d.ts +6 -2
  5. package/getBusinessMetadata.js.map +1 -1
  6. package/getBusinessMetadataBinding.d.ts +2 -2
  7. package/getByokKey.d.ts +2 -8
  8. package/getByokKey.js +2 -8
  9. package/getByokKey.js.map +1 -1
  10. package/getEnvironment.d.ts +4 -0
  11. package/getEnvironment.js.map +1 -1
  12. package/getIdentityPool.d.ts +4 -0
  13. package/getIdentityPool.js.map +1 -1
  14. package/getIdentityProvider.d.ts +4 -0
  15. package/getIdentityProvider.js.map +1 -1
  16. package/getKafkaCluster.d.ts +4 -0
  17. package/getKafkaCluster.js.map +1 -1
  18. package/getKsqlCluster.d.ts +4 -0
  19. package/getKsqlCluster.js.map +1 -1
  20. package/getNetwork.d.ts +4 -0
  21. package/getNetwork.js.map +1 -1
  22. package/getPeering.d.ts +4 -0
  23. package/getPeering.js.map +1 -1
  24. package/getPrivateLinkAccess.d.ts +4 -0
  25. package/getPrivateLinkAccess.js.map +1 -1
  26. package/getSchema.d.ts +4 -0
  27. package/getSchema.js.map +1 -1
  28. package/getSchemaRegistryCluster.d.ts +7 -0
  29. package/getSchemaRegistryCluster.js.map +1 -1
  30. package/getSchemaRegistryRegion.d.ts +4 -0
  31. package/getSchemaRegistryRegion.js.map +1 -1
  32. package/getServiceAccount.d.ts +4 -0
  33. package/getServiceAccount.js.map +1 -1
  34. package/getSubjectMode.d.ts +4 -0
  35. package/getSubjectMode.js.map +1 -1
  36. package/getTag.d.ts +6 -2
  37. package/getTag.js.map +1 -1
  38. package/getTagBinding.d.ts +6 -2
  39. package/getTagBinding.js.map +1 -1
  40. package/getTransitGatewayAttachment.d.ts +4 -0
  41. package/getTransitGatewayAttachment.js.map +1 -1
  42. package/getUser.d.ts +4 -0
  43. package/getUser.js.map +1 -1
  44. package/identityProvider.d.ts +6 -0
  45. package/identityProvider.js.map +1 -1
  46. package/kafkaAcl.d.ts +3 -3
  47. package/kafkaMirrorTopic.d.ts +0 -9
  48. package/kafkaMirrorTopic.js.map +1 -1
  49. package/network.d.ts +6 -0
  50. package/network.js.map +1 -1
  51. package/package.json +2 -2
  52. package/package.json.dev +2 -2
  53. package/tag.d.ts +6 -6
  54. package/tagBinding.d.ts +6 -6
  55. package/tfImporter.d.ts +3 -3
  56. package/types/input.d.ts +74 -27
  57. package/types/output.d.ts +73 -25
package/types/input.d.ts CHANGED
@@ -84,9 +84,6 @@ export interface BusinessMetadataCredentials {
84
84
  * The Schema Registry API Key.
85
85
  */
86
86
  key: pulumi.Input<string>;
87
- /**
88
- * The Schema Registry API Secret.
89
- */
90
87
  secret: pulumi.Input<string>;
91
88
  }
92
89
  export interface BusinessMetadataSchemaRegistryCluster {
@@ -192,6 +189,8 @@ export interface GetBusinessMetadataBindingCredentials {
192
189
  key: string;
193
190
  /**
194
191
  * The Schema Registry API Secret.
192
+ *
193
+ * > **Note:** A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.
195
194
  */
196
195
  secret: string;
197
196
  }
@@ -202,6 +201,8 @@ export interface GetBusinessMetadataBindingCredentialsArgs {
202
201
  key: pulumi.Input<string>;
203
202
  /**
204
203
  * The Schema Registry API Secret.
204
+ *
205
+ * > **Note:** A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.
205
206
  */
206
207
  secret: pulumi.Input<string>;
207
208
  }
@@ -252,12 +253,16 @@ export interface GetBusinessMetadataSchemaRegistryClusterArgs {
252
253
  export interface GetIdentityPoolIdentityProvider {
253
254
  /**
254
255
  * The ID of the Identity Provider associated with the Identity Pool, for example, `op-abc123`.
256
+ *
257
+ * > **Note:** Exactly one from the `id` and `displayName` attributes must be specified.
255
258
  */
256
259
  id: string;
257
260
  }
258
261
  export interface GetIdentityPoolIdentityProviderArgs {
259
262
  /**
260
263
  * The ID of the Identity Provider associated with the Identity Pool, for example, `op-abc123`.
264
+ *
265
+ * > **Note:** Exactly one from the `id` and `displayName` attributes must be specified.
261
266
  */
262
267
  id: pulumi.Input<string>;
263
268
  }
@@ -296,12 +301,16 @@ export interface GetKafkaClusterDedicatedArgs {
296
301
  export interface GetKafkaClusterEnvironment {
297
302
  /**
298
303
  * The ID of the Environment that the Kafka cluster belongs to, for example, `env-xyz456`.
304
+ *
305
+ * > **Note:** Exactly one from the `id` and `displayName` attributes must be specified.
299
306
  */
300
307
  id: string;
301
308
  }
302
309
  export interface GetKafkaClusterEnvironmentArgs {
303
310
  /**
304
311
  * The ID of the Environment that the Kafka cluster belongs to, for example, `env-xyz456`.
312
+ *
313
+ * > **Note:** Exactly one from the `id` and `displayName` attributes must be specified.
305
314
  */
306
315
  id: pulumi.Input<string>;
307
316
  }
@@ -314,9 +323,6 @@ export interface GetKafkaTopicCredentials {
314
323
  * The Kafka API Key.
315
324
  */
316
325
  key: string;
317
- /**
318
- * The Kafka API Secret.
319
- */
320
326
  secret: string;
321
327
  }
322
328
  export interface GetKafkaTopicCredentialsArgs {
@@ -324,9 +330,6 @@ export interface GetKafkaTopicCredentialsArgs {
324
330
  * The Kafka API Key.
325
331
  */
326
332
  key: pulumi.Input<string>;
327
- /**
328
- * The Kafka API Secret.
329
- */
330
333
  secret: pulumi.Input<string>;
331
334
  }
332
335
  export interface GetKafkaTopicKafkaCluster {
@@ -344,12 +347,16 @@ export interface GetKafkaTopicKafkaClusterArgs {
344
347
  export interface GetKsqlClusterEnvironment {
345
348
  /**
346
349
  * The ID of the Environment that the ksqlDB cluster belongs to, for example, `env-xyz456`.
350
+ *
351
+ * > **Note:** Exactly one from the `id` and `displayName` attributes must be specified.
347
352
  */
348
353
  id: string;
349
354
  }
350
355
  export interface GetKsqlClusterEnvironmentArgs {
351
356
  /**
352
357
  * The ID of the Environment that the ksqlDB cluster belongs to, for example, `env-xyz456`.
358
+ *
359
+ * > **Note:** Exactly one from the `id` and `displayName` attributes must be specified.
353
360
  */
354
361
  id: pulumi.Input<string>;
355
362
  }
@@ -416,12 +423,16 @@ export interface GetNetworkDnsConfigArgs {
416
423
  export interface GetNetworkEnvironment {
417
424
  /**
418
425
  * The ID of the Environment that the Network belongs to, for example, `env-xyz456`.
426
+ *
427
+ * > **Note:** Exactly one from the `id` and `displayName` attributes must be specified.
419
428
  */
420
429
  id: string;
421
430
  }
422
431
  export interface GetNetworkEnvironmentArgs {
423
432
  /**
424
433
  * The ID of the Environment that the Network belongs to, for example, `env-xyz456`.
434
+ *
435
+ * > **Note:** Exactly one from the `id` and `displayName` attributes must be specified.
425
436
  */
426
437
  id: pulumi.Input<string>;
427
438
  }
@@ -504,24 +515,32 @@ export interface GetNetworkLinkServiceEnvironmentArgs {
504
515
  export interface GetPeeringEnvironment {
505
516
  /**
506
517
  * The ID of the Environment that the Peering belongs to, for example, `env-xyz456`.
518
+ *
519
+ * > **Note:** Exactly one from the `id` and `displayName` attributes must be specified.
507
520
  */
508
521
  id: string;
509
522
  }
510
523
  export interface GetPeeringEnvironmentArgs {
511
524
  /**
512
525
  * The ID of the Environment that the Peering belongs to, for example, `env-xyz456`.
526
+ *
527
+ * > **Note:** Exactly one from the `id` and `displayName` attributes must be specified.
513
528
  */
514
529
  id: pulumi.Input<string>;
515
530
  }
516
531
  export interface GetPrivateLinkAccessEnvironment {
517
532
  /**
518
533
  * The ID of the Environment that the Private Link Access belongs to, for example, `env-xyz456`.
534
+ *
535
+ * > **Note:** Exactly one from the `id` and `displayName` attributes must be specified.
519
536
  */
520
537
  id: string;
521
538
  }
522
539
  export interface GetPrivateLinkAccessEnvironmentArgs {
523
540
  /**
524
541
  * The ID of the Environment that the Private Link Access belongs to, for example, `env-xyz456`.
542
+ *
543
+ * > **Note:** Exactly one from the `id` and `displayName` attributes must be specified.
525
544
  */
526
545
  id: pulumi.Input<string>;
527
546
  }
@@ -580,12 +599,16 @@ export interface GetSchemaRegistryClusterConfigSchemaRegistryClusterArgs {
580
599
  export interface GetSchemaRegistryClusterEnvironment {
581
600
  /**
582
601
  * The ID of the Environment that the Schema Registry cluster belongs to, for example, `env-xyz456`.
602
+ *
603
+ * > **Note:** Exactly one from the `id` and `displayName` attributes must be specified.
583
604
  */
584
605
  id: string;
585
606
  }
586
607
  export interface GetSchemaRegistryClusterEnvironmentArgs {
587
608
  /**
588
609
  * The ID of the Environment that the Schema Registry cluster belongs to, for example, `env-xyz456`.
610
+ *
611
+ * > **Note:** Exactly one from the `id` and `displayName` attributes must be specified.
589
612
  */
590
613
  id: pulumi.Input<string>;
591
614
  }
@@ -596,6 +619,8 @@ export interface GetSchemaRegistryClusterModeCredentials {
596
619
  key: string;
597
620
  /**
598
621
  * The Schema Registry API Secret.
622
+ *
623
+ * > **Note:** A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.
599
624
  */
600
625
  secret: string;
601
626
  }
@@ -606,6 +631,8 @@ export interface GetSchemaRegistryClusterModeCredentialsArgs {
606
631
  key: pulumi.Input<string>;
607
632
  /**
608
633
  * The Schema Registry API Secret.
634
+ *
635
+ * > **Note:** A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.
609
636
  */
610
637
  secret: pulumi.Input<string>;
611
638
  }
@@ -824,12 +851,16 @@ export interface GetTagSchemaRegistryClusterArgs {
824
851
  export interface GetTransitGatewayAttachmentEnvironment {
825
852
  /**
826
853
  * The ID of the Environment that the Transit Gateway Attachment belongs to, for example, `env-xyz456`.
854
+ *
855
+ * > **Note:** Exactly one from the `id` and `displayName` attributes must be specified.
827
856
  */
828
857
  id: string;
829
858
  }
830
859
  export interface GetTransitGatewayAttachmentEnvironmentArgs {
831
860
  /**
832
861
  * The ID of the Environment that the Transit Gateway Attachment belongs to, for example, `env-xyz456`.
862
+ *
863
+ * > **Note:** Exactly one from the `id` and `displayName` attributes must be specified.
833
864
  */
834
865
  id: pulumi.Input<string>;
835
866
  }
@@ -870,12 +901,20 @@ export interface KafkaAclKafkaCluster {
870
901
  export interface KafkaClientQuotaEnvironment {
871
902
  /**
872
903
  * The ID of the Environment that the corresponding Kafka Cluster belongs to, for example, `env-abc123`.
904
+ *
905
+ * > **Note:** Each principal assigned to a quota receives the full amount of the quota, meaning the quota is not shared by the principals it is assigned. For example, if a 10 MBps ingress quota is applied to Principals 1 and 2, Principal 1 can produce at most 10 MBps, independently of Principal 2.
906
+ *
907
+ * > **Note:** Define a throughput maximum, but do not guarantee a throughput floor. Applications are rate-limited through the use of the Kafka throttling mechanism. Kafka asks the client to wait before sending more data and mutes the channel, which appears as latency to the client application.
873
908
  */
874
909
  id: pulumi.Input<string>;
875
910
  }
876
911
  export interface KafkaClientQuotaKafkaCluster {
877
912
  /**
878
913
  * The ID of the Environment that the corresponding Kafka Cluster belongs to, for example, `env-abc123`.
914
+ *
915
+ * > **Note:** Each principal assigned to a quota receives the full amount of the quota, meaning the quota is not shared by the principals it is assigned. For example, if a 10 MBps ingress quota is applied to Principals 1 and 2, Principal 1 can produce at most 10 MBps, independently of Principal 2.
916
+ *
917
+ * > **Note:** Define a throughput maximum, but do not guarantee a throughput floor. Applications are rate-limited through the use of the Kafka throttling mechanism. Kafka asks the client to wait before sending more data and mutes the channel, which appears as latency to the client application.
879
918
  */
880
919
  id: pulumi.Input<string>;
881
920
  }
@@ -904,6 +943,10 @@ export interface KafkaClusterConfigCredentials {
904
943
  key: pulumi.Input<string>;
905
944
  /**
906
945
  * The Kafka API Secret.
946
+ *
947
+ * > **Note:** A Kafka API key consists of a key and a secret. Kafka API keys are required to interact with Kafka clusters in Confluent Cloud. Each Kafka API key is valid for one specific Kafka cluster.
948
+ *
949
+ * > **Note:** Use Option #2 to simplify the key rotation process. When using Option #1, to rotate a Kafka API key, create a new Kafka API key, update the `credentials` block in all configuration files to use the new Kafka API key, run `pulumi up -target="confluent_kafka_cluster_config.orders"`, and remove the old Kafka API key. Alternatively, in case the old Kafka API Key was deleted already, you might need to run `pulumi preview -refresh=false -target="confluent_kafka_cluster_config.orders" -out=rotate-kafka-api-key` and `pulumi up rotate-kafka-api-key` instead.
907
950
  */
908
951
  secret: pulumi.Input<string>;
909
952
  }
@@ -914,9 +957,6 @@ export interface KafkaClusterConfigKafkaCluster {
914
957
  id: pulumi.Input<string>;
915
958
  }
916
959
  export interface KafkaClusterDedicated {
917
- /**
918
- * The number of Confluent Kafka Units (CKUs) for Dedicated cluster types. The minimum number of CKUs for `SINGLE_ZONE` dedicated clusters is `1` whereas `MULTI_ZONE` dedicated clusters must have more than `2` CKUs.
919
- */
920
960
  cku: pulumi.Input<number>;
921
961
  encryptionKey?: pulumi.Input<string>;
922
962
  /**
@@ -981,6 +1021,10 @@ export interface KafkaTopicCredentials {
981
1021
  key: pulumi.Input<string>;
982
1022
  /**
983
1023
  * The Kafka API Secret.
1024
+ *
1025
+ * > **Note:** A Kafka API key consists of a key and a secret. Kafka API keys are required to interact with Kafka clusters in Confluent Cloud. Each Kafka API key is valid for one specific Kafka cluster.
1026
+ *
1027
+ * > **Note:** Use Option #2 to simplify the key rotation process. When using Option #1, to rotate a Kafka API key, create a new Kafka API key, update the `credentials` block in all configuration files to use the new Kafka API key, run `pulumi up -target="confluent_kafka_topic.orders"`, and remove the old Kafka API key. Alternatively, in case the old Kafka API Key was deleted already, you might need to run `pulumi preview -refresh=false -target="confluent_kafka_topic.orders" -out=rotate-kafka-api-key` and `pulumi up rotate-kafka-api-key` instead.
984
1028
  */
985
1029
  secret: pulumi.Input<string>;
986
1030
  }
@@ -1103,6 +1147,8 @@ export interface NetworkLinkServiceNetwork {
1103
1147
  export interface NetworkZoneInfo {
1104
1148
  /**
1105
1149
  * The IPv4 CIDR block to be used for the network. Must be `/27`. Required for VPC peering and AWS TransitGateway.
1150
+ *
1151
+ * > **Note:** The `zoneInfo` configuration block and `reservedCidr` are in a [Limited Availability lifecycle stage](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy), and it's available only for AWS networks with PRIVATELINK connection type.
1106
1152
  */
1107
1153
  cidr?: pulumi.Input<string>;
1108
1154
  /**
@@ -1151,6 +1197,14 @@ export interface PeeringEnvironment {
1151
1197
  export interface PeeringGcp {
1152
1198
  /**
1153
1199
  * The Import Custom Routes option enables connectivity to a Confluent Cloud cluster in Google Cloud from customer premise or other clouds, such as AWS and Azure, through a customer VPC that is peered with Confluent Cloud in the same region. Defaults to `false`. Learn more about considerations / limitations of the Import Custom Routes option [here](https://docs.confluent.io/cloud/current/networking/peering/gcp-peering.html#import-custom-routes).
1200
+ *
1201
+ * > **Note:** Exactly one from the `aws`, `azure`, and `gcp` configuration blocks must be specified.
1202
+ *
1203
+ * > **Note:** Learn more about VPC Peering requirements on AWS [here](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html#vpc-peering-on-aws).
1204
+ *
1205
+ * > **Note:** Learn more about VNet Peering requirements on Azure [here](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html#vnet-peering-on-az).
1206
+ *
1207
+ * > **Note:** Learn more about VPC Peering requirements on Google Cloud Platform [here](https://docs.confluent.io/cloud/current/networking/peering/gcp-peering.html#vpc-peering-on-gcp).
1154
1208
  */
1155
1209
  importCustomRoutes?: pulumi.Input<boolean>;
1156
1210
  /**
@@ -1189,6 +1243,12 @@ export interface PrivateLinkAccessEnvironment {
1189
1243
  export interface PrivateLinkAccessGcp {
1190
1244
  /**
1191
1245
  * The GCP project ID to allow for Private Service Connect access. You can find your Google Cloud Project ID under **Project ID** section of your [Google Cloud Console dashboard](https://console.cloud.google.com/home/dashboard).
1246
+ *
1247
+ * > **Note:** Exactly one from the `aws`, `azure`, `gcp` configuration blocks must be specified.
1248
+ *
1249
+ * > **Note:** Learn more about Private Link Access limitations on AWS [here](https://docs.confluent.io/cloud/current/networking/private-links/aws-privatelink.html#limitations).
1250
+ *
1251
+ * > **Note:** Learn more about Private Link Access limitations on Azure [here](https://docs.confluent.io/cloud/current/networking/private-links/azure-privatelink.html#limitations).
1192
1252
  */
1193
1253
  project: pulumi.Input<string>;
1194
1254
  }
@@ -1203,9 +1263,6 @@ export interface SchemaCredentials {
1203
1263
  * The Schema Registry API Key.
1204
1264
  */
1205
1265
  key: pulumi.Input<string>;
1206
- /**
1207
- * The Schema Registry API Secret.
1208
- */
1209
1266
  secret: pulumi.Input<string>;
1210
1267
  }
1211
1268
  export interface SchemaRegistryClusterConfigCredentials {
@@ -1213,9 +1270,6 @@ export interface SchemaRegistryClusterConfigCredentials {
1213
1270
  * The Schema Registry API Key.
1214
1271
  */
1215
1272
  key: pulumi.Input<string>;
1216
- /**
1217
- * The Schema Registry API Secret.
1218
- */
1219
1273
  secret: pulumi.Input<string>;
1220
1274
  }
1221
1275
  export interface SchemaRegistryClusterConfigSchemaRegistryCluster {
@@ -1235,9 +1289,6 @@ export interface SchemaRegistryClusterModeCredentials {
1235
1289
  * The Schema Registry API Key.
1236
1290
  */
1237
1291
  key: pulumi.Input<string>;
1238
- /**
1239
- * The Schema Registry API Secret.
1240
- */
1241
1292
  secret: pulumi.Input<string>;
1242
1293
  }
1243
1294
  export interface SchemaRegistryClusterModeSchemaRegistryCluster {
@@ -1277,9 +1328,6 @@ export interface SubjectConfigCredentials {
1277
1328
  * The Schema Registry API Key.
1278
1329
  */
1279
1330
  key: pulumi.Input<string>;
1280
- /**
1281
- * The Schema Registry API Secret.
1282
- */
1283
1331
  secret: pulumi.Input<string>;
1284
1332
  }
1285
1333
  export interface SubjectConfigSchemaRegistryCluster {
@@ -1293,9 +1341,6 @@ export interface SubjectModeCredentials {
1293
1341
  * The Schema Registry API Key.
1294
1342
  */
1295
1343
  key: pulumi.Input<string>;
1296
- /**
1297
- * The Schema Registry API Secret.
1298
- */
1299
1344
  secret: pulumi.Input<string>;
1300
1345
  }
1301
1346
  export interface SubjectModeSchemaRegistryCluster {
@@ -1343,6 +1388,8 @@ export interface TransitGatewayAttachmentAws {
1343
1388
  ramResourceShareArn: pulumi.Input<string>;
1344
1389
  /**
1345
1390
  * List of destination routes for traffic from Confluent VPC to customer VPC via Transit Gateway.
1391
+ *
1392
+ * > **Note:** Learn more about Transit Gateway Attachment limitations on AWS [here](https://docs.confluent.io/cloud/current/networking/aws-transit-gateway.html#limitations).
1346
1393
  */
1347
1394
  routes: pulumi.Input<pulumi.Input<string>[]>;
1348
1395
  /**
package/types/output.d.ts CHANGED
@@ -83,9 +83,6 @@ export interface BusinessMetadataCredentials {
83
83
  * The Schema Registry API Key.
84
84
  */
85
85
  key: string;
86
- /**
87
- * The Schema Registry API Secret.
88
- */
89
86
  secret: string;
90
87
  }
91
88
  export interface BusinessMetadataSchemaRegistryCluster {
@@ -198,7 +195,9 @@ export interface GetBusinessMetadataAttributeDefinition {
198
195
  */
199
196
  isOptional: boolean;
200
197
  /**
201
- * The name of the Business Metadata, for example, `PII`.
198
+ * The name of the Business Metadata, for example, `PII`. The name must not be empty and consist of a letter followed by a sequence of letter, number, space, or _ characters.
199
+ *
200
+ * > **Note:** A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.
202
201
  */
203
202
  name: string;
204
203
  /**
@@ -219,6 +218,8 @@ export interface GetBusinessMetadataBindingCredentials {
219
218
  key: string;
220
219
  /**
221
220
  * The Schema Registry API Secret.
221
+ *
222
+ * > **Note:** A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.
222
223
  */
223
224
  secret: string;
224
225
  }
@@ -275,6 +276,8 @@ export interface GetByokKeyAzure {
275
276
  export interface GetIdentityPoolIdentityProvider {
276
277
  /**
277
278
  * The ID of the Identity Provider associated with the Identity Pool, for example, `op-abc123`.
279
+ *
280
+ * > **Note:** Exactly one from the `id` and `displayName` attributes must be specified.
278
281
  */
279
282
  id: string;
280
283
  }
@@ -317,6 +320,8 @@ export interface GetKafkaClusterBasic {
317
320
  export interface GetKafkaClusterByokKey {
318
321
  /**
319
322
  * The ID of the Environment that the Kafka cluster belongs to, for example, `env-xyz456`.
323
+ *
324
+ * > **Note:** Exactly one from the `id` and `displayName` attributes must be specified.
320
325
  */
321
326
  id: string;
322
327
  }
@@ -337,12 +342,16 @@ export interface GetKafkaClusterDedicated {
337
342
  export interface GetKafkaClusterEnvironment {
338
343
  /**
339
344
  * The ID of the Environment that the Kafka cluster belongs to, for example, `env-xyz456`.
345
+ *
346
+ * > **Note:** Exactly one from the `id` and `displayName` attributes must be specified.
340
347
  */
341
348
  id: string;
342
349
  }
343
350
  export interface GetKafkaClusterNetwork {
344
351
  /**
345
352
  * The ID of the Environment that the Kafka cluster belongs to, for example, `env-xyz456`.
353
+ *
354
+ * > **Note:** Exactly one from the `id` and `displayName` attributes must be specified.
346
355
  */
347
356
  id: string;
348
357
  }
@@ -353,9 +362,6 @@ export interface GetKafkaTopicCredentials {
353
362
  * The Kafka API Key.
354
363
  */
355
364
  key: string;
356
- /**
357
- * The Kafka API Secret.
358
- */
359
365
  secret: string;
360
366
  }
361
367
  export interface GetKafkaTopicKafkaCluster {
@@ -367,18 +373,24 @@ export interface GetKafkaTopicKafkaCluster {
367
373
  export interface GetKsqlClusterCredentialIdentity {
368
374
  /**
369
375
  * The ID of the Environment that the ksqlDB cluster belongs to, for example, `env-xyz456`.
376
+ *
377
+ * > **Note:** Exactly one from the `id` and `displayName` attributes must be specified.
370
378
  */
371
379
  id: string;
372
380
  }
373
381
  export interface GetKsqlClusterEnvironment {
374
382
  /**
375
383
  * The ID of the Environment that the ksqlDB cluster belongs to, for example, `env-xyz456`.
384
+ *
385
+ * > **Note:** Exactly one from the `id` and `displayName` attributes must be specified.
376
386
  */
377
387
  id: string;
378
388
  }
379
389
  export interface GetKsqlClusterKafkaCluster {
380
390
  /**
381
391
  * The ID of the Environment that the ksqlDB cluster belongs to, for example, `env-xyz456`.
392
+ *
393
+ * > **Note:** Exactly one from the `id` and `displayName` attributes must be specified.
382
394
  */
383
395
  id: string;
384
396
  }
@@ -415,6 +427,8 @@ export interface GetNetworkDnsConfig {
415
427
  export interface GetNetworkEnvironment {
416
428
  /**
417
429
  * The ID of the Environment that the Network belongs to, for example, `env-xyz456`.
430
+ *
431
+ * > **Note:** Exactly one from the `id` and `displayName` attributes must be specified.
418
432
  */
419
433
  id: string;
420
434
  }
@@ -519,6 +533,8 @@ export interface GetPeeringAzure {
519
533
  export interface GetPeeringEnvironment {
520
534
  /**
521
535
  * The ID of the Environment that the Peering belongs to, for example, `env-xyz456`.
536
+ *
537
+ * > **Note:** Exactly one from the `id` and `displayName` attributes must be specified.
522
538
  */
523
539
  id: string;
524
540
  }
@@ -539,6 +555,8 @@ export interface GetPeeringGcp {
539
555
  export interface GetPeeringNetwork {
540
556
  /**
541
557
  * The ID of the Environment that the Peering belongs to, for example, `env-xyz456`.
558
+ *
559
+ * > **Note:** Exactly one from the `id` and `displayName` attributes must be specified.
542
560
  */
543
561
  id: string;
544
562
  }
@@ -557,6 +575,8 @@ export interface GetPrivateLinkAccessAzure {
557
575
  export interface GetPrivateLinkAccessEnvironment {
558
576
  /**
559
577
  * The ID of the Environment that the Private Link Access belongs to, for example, `env-xyz456`.
578
+ *
579
+ * > **Note:** Exactly one from the `id` and `displayName` attributes must be specified.
560
580
  */
561
581
  id: string;
562
582
  }
@@ -569,6 +589,8 @@ export interface GetPrivateLinkAccessGcp {
569
589
  export interface GetPrivateLinkAccessNetwork {
570
590
  /**
571
591
  * The ID of the Environment that the Private Link Access belongs to, for example, `env-xyz456`.
592
+ *
593
+ * > **Note:** Exactly one from the `id` and `displayName` attributes must be specified.
572
594
  */
573
595
  id: string;
574
596
  }
@@ -601,6 +623,8 @@ export interface GetSchemaRegistryClusterConfigSchemaRegistryCluster {
601
623
  export interface GetSchemaRegistryClusterEnvironment {
602
624
  /**
603
625
  * The ID of the Environment that the Schema Registry cluster belongs to, for example, `env-xyz456`.
626
+ *
627
+ * > **Note:** Exactly one from the `id` and `displayName` attributes must be specified.
604
628
  */
605
629
  id: string;
606
630
  }
@@ -611,6 +635,8 @@ export interface GetSchemaRegistryClusterModeCredentials {
611
635
  key: string;
612
636
  /**
613
637
  * The Schema Registry API Secret.
638
+ *
639
+ * > **Note:** A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.
614
640
  */
615
641
  secret: string;
616
642
  }
@@ -623,6 +649,8 @@ export interface GetSchemaRegistryClusterModeSchemaRegistryCluster {
623
649
  export interface GetSchemaRegistryClusterRegion {
624
650
  /**
625
651
  * The ID of the Environment that the Schema Registry cluster belongs to, for example, `env-xyz456`.
652
+ *
653
+ * > **Note:** Exactly one from the `id` and `displayName` attributes must be specified.
626
654
  */
627
655
  id: string;
628
656
  }
@@ -801,12 +829,16 @@ export interface GetTransitGatewayAttachmentAw {
801
829
  export interface GetTransitGatewayAttachmentEnvironment {
802
830
  /**
803
831
  * The ID of the Environment that the Transit Gateway Attachment belongs to, for example, `env-xyz456`.
832
+ *
833
+ * > **Note:** Exactly one from the `id` and `displayName` attributes must be specified.
804
834
  */
805
835
  id: string;
806
836
  }
807
837
  export interface GetTransitGatewayAttachmentNetwork {
808
838
  /**
809
839
  * The ID of the Environment that the Transit Gateway Attachment belongs to, for example, `env-xyz456`.
840
+ *
841
+ * > **Note:** Exactly one from the `id` and `displayName` attributes must be specified.
810
842
  */
811
843
  id: string;
812
844
  }
@@ -847,12 +879,20 @@ export interface KafkaAclKafkaCluster {
847
879
  export interface KafkaClientQuotaEnvironment {
848
880
  /**
849
881
  * The ID of the Environment that the corresponding Kafka Cluster belongs to, for example, `env-abc123`.
882
+ *
883
+ * > **Note:** Each principal assigned to a quota receives the full amount of the quota, meaning the quota is not shared by the principals it is assigned. For example, if a 10 MBps ingress quota is applied to Principals 1 and 2, Principal 1 can produce at most 10 MBps, independently of Principal 2.
884
+ *
885
+ * > **Note:** Define a throughput maximum, but do not guarantee a throughput floor. Applications are rate-limited through the use of the Kafka throttling mechanism. Kafka asks the client to wait before sending more data and mutes the channel, which appears as latency to the client application.
850
886
  */
851
887
  id: string;
852
888
  }
853
889
  export interface KafkaClientQuotaKafkaCluster {
854
890
  /**
855
891
  * The ID of the Environment that the corresponding Kafka Cluster belongs to, for example, `env-abc123`.
892
+ *
893
+ * > **Note:** Each principal assigned to a quota receives the full amount of the quota, meaning the quota is not shared by the principals it is assigned. For example, if a 10 MBps ingress quota is applied to Principals 1 and 2, Principal 1 can produce at most 10 MBps, independently of Principal 2.
894
+ *
895
+ * > **Note:** Define a throughput maximum, but do not guarantee a throughput floor. Applications are rate-limited through the use of the Kafka throttling mechanism. Kafka asks the client to wait before sending more data and mutes the channel, which appears as latency to the client application.
856
896
  */
857
897
  id: string;
858
898
  }
@@ -881,6 +921,10 @@ export interface KafkaClusterConfigCredentials {
881
921
  key: string;
882
922
  /**
883
923
  * The Kafka API Secret.
924
+ *
925
+ * > **Note:** A Kafka API key consists of a key and a secret. Kafka API keys are required to interact with Kafka clusters in Confluent Cloud. Each Kafka API key is valid for one specific Kafka cluster.
926
+ *
927
+ * > **Note:** Use Option #2 to simplify the key rotation process. When using Option #1, to rotate a Kafka API key, create a new Kafka API key, update the `credentials` block in all configuration files to use the new Kafka API key, run `pulumi up -target="confluent_kafka_cluster_config.orders"`, and remove the old Kafka API key. Alternatively, in case the old Kafka API Key was deleted already, you might need to run `pulumi preview -refresh=false -target="confluent_kafka_cluster_config.orders" -out=rotate-kafka-api-key` and `pulumi up rotate-kafka-api-key` instead.
884
928
  */
885
929
  secret: string;
886
930
  }
@@ -891,9 +935,6 @@ export interface KafkaClusterConfigKafkaCluster {
891
935
  id: string;
892
936
  }
893
937
  export interface KafkaClusterDedicated {
894
- /**
895
- * The number of Confluent Kafka Units (CKUs) for Dedicated cluster types. The minimum number of CKUs for `SINGLE_ZONE` dedicated clusters is `1` whereas `MULTI_ZONE` dedicated clusters must have more than `2` CKUs.
896
- */
897
938
  cku: number;
898
939
  encryptionKey?: string;
899
940
  /**
@@ -958,6 +999,10 @@ export interface KafkaTopicCredentials {
958
999
  key: string;
959
1000
  /**
960
1001
  * The Kafka API Secret.
1002
+ *
1003
+ * > **Note:** A Kafka API key consists of a key and a secret. Kafka API keys are required to interact with Kafka clusters in Confluent Cloud. Each Kafka API key is valid for one specific Kafka cluster.
1004
+ *
1005
+ * > **Note:** Use Option #2 to simplify the key rotation process. When using Option #1, to rotate a Kafka API key, create a new Kafka API key, update the `credentials` block in all configuration files to use the new Kafka API key, run `pulumi up -target="confluent_kafka_topic.orders"`, and remove the old Kafka API key. Alternatively, in case the old Kafka API Key was deleted already, you might need to run `pulumi preview -refresh=false -target="confluent_kafka_topic.orders" -out=rotate-kafka-api-key` and `pulumi up rotate-kafka-api-key` instead.
961
1006
  */
962
1007
  secret: string;
963
1008
  }
@@ -1080,6 +1125,8 @@ export interface NetworkLinkServiceNetwork {
1080
1125
  export interface NetworkZoneInfo {
1081
1126
  /**
1082
1127
  * The IPv4 CIDR block to be used for the network. Must be `/27`. Required for VPC peering and AWS TransitGateway.
1128
+ *
1129
+ * > **Note:** The `zoneInfo` configuration block and `reservedCidr` are in a [Limited Availability lifecycle stage](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy), and it's available only for AWS networks with PRIVATELINK connection type.
1083
1130
  */
1084
1131
  cidr: string;
1085
1132
  /**
@@ -1128,6 +1175,14 @@ export interface PeeringEnvironment {
1128
1175
  export interface PeeringGcp {
1129
1176
  /**
1130
1177
  * The Import Custom Routes option enables connectivity to a Confluent Cloud cluster in Google Cloud from customer premise or other clouds, such as AWS and Azure, through a customer VPC that is peered with Confluent Cloud in the same region. Defaults to `false`. Learn more about considerations / limitations of the Import Custom Routes option [here](https://docs.confluent.io/cloud/current/networking/peering/gcp-peering.html#import-custom-routes).
1178
+ *
1179
+ * > **Note:** Exactly one from the `aws`, `azure`, and `gcp` configuration blocks must be specified.
1180
+ *
1181
+ * > **Note:** Learn more about VPC Peering requirements on AWS [here](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html#vpc-peering-on-aws).
1182
+ *
1183
+ * > **Note:** Learn more about VNet Peering requirements on Azure [here](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html#vnet-peering-on-az).
1184
+ *
1185
+ * > **Note:** Learn more about VPC Peering requirements on Google Cloud Platform [here](https://docs.confluent.io/cloud/current/networking/peering/gcp-peering.html#vpc-peering-on-gcp).
1131
1186
  */
1132
1187
  importCustomRoutes?: boolean;
1133
1188
  /**
@@ -1166,6 +1221,12 @@ export interface PrivateLinkAccessEnvironment {
1166
1221
  export interface PrivateLinkAccessGcp {
1167
1222
  /**
1168
1223
  * The GCP project ID to allow for Private Service Connect access. You can find your Google Cloud Project ID under **Project ID** section of your [Google Cloud Console dashboard](https://console.cloud.google.com/home/dashboard).
1224
+ *
1225
+ * > **Note:** Exactly one from the `aws`, `azure`, `gcp` configuration blocks must be specified.
1226
+ *
1227
+ * > **Note:** Learn more about Private Link Access limitations on AWS [here](https://docs.confluent.io/cloud/current/networking/private-links/aws-privatelink.html#limitations).
1228
+ *
1229
+ * > **Note:** Learn more about Private Link Access limitations on Azure [here](https://docs.confluent.io/cloud/current/networking/private-links/azure-privatelink.html#limitations).
1169
1230
  */
1170
1231
  project: string;
1171
1232
  }
@@ -1180,9 +1241,6 @@ export interface SchemaCredentials {
1180
1241
  * The Schema Registry API Key.
1181
1242
  */
1182
1243
  key: string;
1183
- /**
1184
- * The Schema Registry API Secret.
1185
- */
1186
1244
  secret: string;
1187
1245
  }
1188
1246
  export interface SchemaRegistryClusterConfigCredentials {
@@ -1190,9 +1248,6 @@ export interface SchemaRegistryClusterConfigCredentials {
1190
1248
  * The Schema Registry API Key.
1191
1249
  */
1192
1250
  key: string;
1193
- /**
1194
- * The Schema Registry API Secret.
1195
- */
1196
1251
  secret: string;
1197
1252
  }
1198
1253
  export interface SchemaRegistryClusterConfigSchemaRegistryCluster {
@@ -1212,9 +1267,6 @@ export interface SchemaRegistryClusterModeCredentials {
1212
1267
  * The Schema Registry API Key.
1213
1268
  */
1214
1269
  key: string;
1215
- /**
1216
- * The Schema Registry API Secret.
1217
- */
1218
1270
  secret: string;
1219
1271
  }
1220
1272
  export interface SchemaRegistryClusterModeSchemaRegistryCluster {
@@ -1254,9 +1306,6 @@ export interface SubjectConfigCredentials {
1254
1306
  * The Schema Registry API Key.
1255
1307
  */
1256
1308
  key: string;
1257
- /**
1258
- * The Schema Registry API Secret.
1259
- */
1260
1309
  secret: string;
1261
1310
  }
1262
1311
  export interface SubjectConfigSchemaRegistryCluster {
@@ -1270,9 +1319,6 @@ export interface SubjectModeCredentials {
1270
1319
  * The Schema Registry API Key.
1271
1320
  */
1272
1321
  key: string;
1273
- /**
1274
- * The Schema Registry API Secret.
1275
- */
1276
1322
  secret: string;
1277
1323
  }
1278
1324
  export interface SubjectModeSchemaRegistryCluster {
@@ -1320,6 +1366,8 @@ export interface TransitGatewayAttachmentAws {
1320
1366
  ramResourceShareArn: string;
1321
1367
  /**
1322
1368
  * List of destination routes for traffic from Confluent VPC to customer VPC via Transit Gateway.
1369
+ *
1370
+ * > **Note:** Learn more about Transit Gateway Attachment limitations on AWS [here](https://docs.confluent.io/cloud/current/networking/aws-transit-gateway.html#limitations).
1323
1371
  */
1324
1372
  routes: string[];
1325
1373
  /**