@pulumi/aiven 6.7.0 → 6.7.2

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/types/output.d.ts CHANGED
@@ -88,18 +88,39 @@ export interface CassandraCassandraUserConfig {
88
88
  staticIps?: boolean;
89
89
  }
90
90
  export interface CassandraCassandraUserConfigCassandra {
91
+ /**
92
+ * Fail any multiple-partition batch exceeding this value. 50kb (10x warn threshold) by default.
93
+ */
91
94
  batchSizeFailThresholdInKb?: number;
95
+ /**
96
+ * Log a warning message on any multiple-partition batch size exceeding this value.5kb per batch by default.Caution should be taken on increasing the size of this thresholdas it can lead to node instability.
97
+ */
92
98
  batchSizeWarnThresholdInKb?: number;
99
+ /**
100
+ * Name of the datacenter to which nodes of this service belong. Can be set only when creating the service.
101
+ */
93
102
  datacenter?: string;
94
103
  }
95
104
  export interface CassandraCassandraUserConfigIpFilterObject {
105
+ /**
106
+ * Description for IP filter list entry.
107
+ */
96
108
  description?: string;
109
+ /**
110
+ * CIDR address block.
111
+ */
97
112
  network: string;
98
113
  }
99
114
  export interface CassandraCassandraUserConfigPrivateAccess {
115
+ /**
116
+ * Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
117
+ */
100
118
  prometheus?: boolean;
101
119
  }
102
120
  export interface CassandraCassandraUserConfigPublicAccess {
121
+ /**
122
+ * Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
123
+ */
103
124
  prometheus?: boolean;
104
125
  }
105
126
  export interface CassandraComponent {
@@ -178,31 +199,55 @@ export interface ClickhouseClickhouseUserConfig {
178
199
  staticIps?: boolean;
179
200
  }
180
201
  export interface ClickhouseClickhouseUserConfigIpFilterObject {
202
+ /**
203
+ * Description for IP filter list entry.
204
+ */
181
205
  description?: string;
206
+ /**
207
+ * CIDR address block.
208
+ */
182
209
  network: string;
183
210
  }
184
211
  export interface ClickhouseClickhouseUserConfigPrivateAccess {
185
212
  /**
186
- * Clickhouse server provided values
213
+ * Allow clients to connect to clickhouse with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
187
214
  */
188
215
  clickhouse?: boolean;
216
+ /**
217
+ * Allow clients to connect to clickhouseHttps with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
218
+ */
189
219
  clickhouseHttps?: boolean;
220
+ /**
221
+ * Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
222
+ */
190
223
  prometheus?: boolean;
191
224
  }
192
225
  export interface ClickhouseClickhouseUserConfigPrivatelinkAccess {
193
226
  /**
194
- * Clickhouse server provided values
227
+ * Allow clients to connect to clickhouse with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
195
228
  */
196
229
  clickhouse?: boolean;
230
+ /**
231
+ * Allow clients to connect to clickhouseHttps with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
232
+ */
197
233
  clickhouseHttps?: boolean;
234
+ /**
235
+ * Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
236
+ */
198
237
  prometheus?: boolean;
199
238
  }
200
239
  export interface ClickhouseClickhouseUserConfigPublicAccess {
201
240
  /**
202
- * Clickhouse server provided values
241
+ * Allow clients to connect to clickhouse with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
203
242
  */
204
243
  clickhouse?: boolean;
244
+ /**
245
+ * Allow clients to connect to clickhouseHttps with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
246
+ */
205
247
  clickhouseHttps?: boolean;
248
+ /**
249
+ * Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
250
+ */
206
251
  prometheus?: boolean;
207
252
  }
208
253
  export interface ClickhouseComponent {
@@ -326,14 +371,23 @@ export interface FlinkFlinkUserConfig {
326
371
  privatelinkAccess?: outputs.FlinkFlinkUserConfigPrivatelinkAccess;
327
372
  }
328
373
  export interface FlinkFlinkUserConfigIpFilterObject {
374
+ /**
375
+ * Description for IP filter list entry.
376
+ */
329
377
  description?: string;
378
+ /**
379
+ * CIDR address block.
380
+ */
330
381
  network: string;
331
382
  }
332
383
  export interface FlinkFlinkUserConfigPrivatelinkAccess {
333
384
  /**
334
- * Flink server provided values
385
+ * Enable flink.
335
386
  */
336
387
  flink?: boolean;
388
+ /**
389
+ * Enable prometheus.
390
+ */
337
391
  prometheus?: boolean;
338
392
  }
339
393
  export interface FlinkServiceIntegration {
@@ -369,9 +423,6 @@ export interface GetCassandaCassandraUserConfig {
369
423
  additionalBackupRegions?: string;
370
424
  backupHour?: number;
371
425
  backupMinute?: number;
372
- /**
373
- * Cassandra server provided values
374
- */
375
426
  cassandra?: outputs.GetCassandaCassandraUserConfigCassandra;
376
427
  cassandraVersion?: string;
377
428
  ipFilterObjects?: outputs.GetCassandaCassandraUserConfigIpFilterObject[];
@@ -386,9 +437,6 @@ export interface GetCassandaCassandraUserConfig {
386
437
  publicAccess?: outputs.GetCassandaCassandraUserConfigPublicAccess;
387
438
  serviceToForkFrom?: string;
388
439
  serviceToJoinWith?: string;
389
- /**
390
- * Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
391
- */
392
440
  staticIps?: boolean;
393
441
  }
394
442
  export interface GetCassandaCassandraUserConfigCassandra {
@@ -429,9 +477,6 @@ export interface GetCassandraCassandraUserConfig {
429
477
  additionalBackupRegions?: string;
430
478
  backupHour?: number;
431
479
  backupMinute?: number;
432
- /**
433
- * Cassandra server provided values
434
- */
435
480
  cassandra?: outputs.GetCassandraCassandraUserConfigCassandra;
436
481
  cassandraVersion?: string;
437
482
  ipFilterObjects?: outputs.GetCassandraCassandraUserConfigIpFilterObject[];
@@ -446,9 +491,6 @@ export interface GetCassandraCassandraUserConfig {
446
491
  publicAccess?: outputs.GetCassandraCassandraUserConfigPublicAccess;
447
492
  serviceToForkFrom?: string;
448
493
  serviceToJoinWith?: string;
449
- /**
450
- * Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
451
- */
452
494
  staticIps?: boolean;
453
495
  }
454
496
  export interface GetCassandraCassandraUserConfigCassandra {
@@ -498,9 +540,6 @@ export interface GetClickhouseClickhouseUserConfig {
498
540
  projectToForkFrom?: string;
499
541
  publicAccess?: outputs.GetClickhouseClickhouseUserConfigPublicAccess;
500
542
  serviceToForkFrom?: string;
501
- /**
502
- * Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
503
- */
504
543
  staticIps?: boolean;
505
544
  }
506
545
  export interface GetClickhouseClickhouseUserConfigIpFilterObject {
@@ -508,25 +547,16 @@ export interface GetClickhouseClickhouseUserConfigIpFilterObject {
508
547
  network: string;
509
548
  }
510
549
  export interface GetClickhouseClickhouseUserConfigPrivateAccess {
511
- /**
512
- * Clickhouse server provided values
513
- */
514
550
  clickhouse?: boolean;
515
551
  clickhouseHttps?: boolean;
516
552
  prometheus?: boolean;
517
553
  }
518
554
  export interface GetClickhouseClickhouseUserConfigPrivatelinkAccess {
519
- /**
520
- * Clickhouse server provided values
521
- */
522
555
  clickhouse?: boolean;
523
556
  clickhouseHttps?: boolean;
524
557
  prometheus?: boolean;
525
558
  }
526
559
  export interface GetClickhouseClickhouseUserConfigPublicAccess {
527
- /**
528
- * Clickhouse server provided values
529
- */
530
560
  clickhouse?: boolean;
531
561
  clickhouseHttps?: boolean;
532
562
  prometheus?: boolean;
@@ -584,9 +614,6 @@ export interface GetFlinkFlinkUserConfigIpFilterObject {
584
614
  network: string;
585
615
  }
586
616
  export interface GetFlinkFlinkUserConfigPrivatelinkAccess {
587
- /**
588
- * Flink server provided values
589
- */
590
617
  flink?: boolean;
591
618
  prometheus?: boolean;
592
619
  }
@@ -649,9 +676,6 @@ export interface GetGrafanaGrafanaUserConfig {
649
676
  recoveryBasebackupName?: string;
650
677
  serviceToForkFrom?: string;
651
678
  smtpServer?: outputs.GetGrafanaGrafanaUserConfigSmtpServer;
652
- /**
653
- * Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
654
- */
655
679
  staticIps?: boolean;
656
680
  userAutoAssignOrg?: boolean;
657
681
  userAutoAssignOrgRole?: string;
@@ -722,21 +746,12 @@ export interface GetGrafanaGrafanaUserConfigIpFilterObject {
722
746
  network: string;
723
747
  }
724
748
  export interface GetGrafanaGrafanaUserConfigPrivateAccess {
725
- /**
726
- * Grafana server provided values
727
- */
728
749
  grafana?: boolean;
729
750
  }
730
751
  export interface GetGrafanaGrafanaUserConfigPrivatelinkAccess {
731
- /**
732
- * Grafana server provided values
733
- */
734
752
  grafana?: boolean;
735
753
  }
736
754
  export interface GetGrafanaGrafanaUserConfigPublicAccess {
737
- /**
738
- * Grafana server provided values
739
- */
740
755
  grafana?: boolean;
741
756
  }
742
757
  export interface GetGrafanaGrafanaUserConfigSmtpServer {
@@ -772,9 +787,6 @@ export interface GetInfluxDbInfluxdb {
772
787
  export interface GetInfluxDbInfluxdbUserConfig {
773
788
  additionalBackupRegions?: string;
774
789
  customDomain?: string;
775
- /**
776
- * InfluxDB server provided values
777
- */
778
790
  influxdb?: outputs.GetInfluxDbInfluxdbUserConfigInfluxdb;
779
791
  ipFilterObjects?: outputs.GetInfluxDbInfluxdbUserConfigIpFilterObject[];
780
792
  ipFilterStrings?: string[];
@@ -788,9 +800,6 @@ export interface GetInfluxDbInfluxdbUserConfig {
788
800
  publicAccess?: outputs.GetInfluxDbInfluxdbUserConfigPublicAccess;
789
801
  recoveryBasebackupName?: string;
790
802
  serviceToForkFrom?: string;
791
- /**
792
- * Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
793
- */
794
803
  staticIps?: boolean;
795
804
  }
796
805
  export interface GetInfluxDbInfluxdbUserConfigInfluxdb {
@@ -807,21 +816,12 @@ export interface GetInfluxDbInfluxdbUserConfigIpFilterObject {
807
816
  network: string;
808
817
  }
809
818
  export interface GetInfluxDbInfluxdbUserConfigPrivateAccess {
810
- /**
811
- * InfluxDB server provided values
812
- */
813
819
  influxdb?: boolean;
814
820
  }
815
821
  export interface GetInfluxDbInfluxdbUserConfigPrivatelinkAccess {
816
- /**
817
- * InfluxDB server provided values
818
- */
819
822
  influxdb?: boolean;
820
823
  }
821
824
  export interface GetInfluxDbInfluxdbUserConfigPublicAccess {
822
- /**
823
- * InfluxDB server provided values
824
- */
825
825
  influxdb?: boolean;
826
826
  }
827
827
  export interface GetInfluxDbServiceIntegration {
@@ -860,16 +860,10 @@ export interface GetKafkaConnectKafkaConnectUserConfig {
860
860
  * @deprecated This will be removed in v5.0.0 and replaced with ip_filter_string instead.
861
861
  */
862
862
  ipFilters?: string[];
863
- /**
864
- * Kafka Connect server provided values
865
- */
866
863
  kafkaConnect?: outputs.GetKafkaConnectKafkaConnectUserConfigKafkaConnect;
867
864
  privateAccess?: outputs.GetKafkaConnectKafkaConnectUserConfigPrivateAccess;
868
865
  privatelinkAccess?: outputs.GetKafkaConnectKafkaConnectUserConfigPrivatelinkAccess;
869
866
  publicAccess?: outputs.GetKafkaConnectKafkaConnectUserConfigPublicAccess;
870
- /**
871
- * Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
872
- */
873
867
  staticIps?: boolean;
874
868
  }
875
869
  export interface GetKafkaConnectKafkaConnectUserConfigIpFilterObject {
@@ -895,24 +889,15 @@ export interface GetKafkaConnectKafkaConnectUserConfigKafkaConnect {
895
889
  sessionTimeoutMs?: number;
896
890
  }
897
891
  export interface GetKafkaConnectKafkaConnectUserConfigPrivateAccess {
898
- /**
899
- * Kafka Connect server provided values
900
- */
901
892
  kafkaConnect?: boolean;
902
893
  prometheus?: boolean;
903
894
  }
904
895
  export interface GetKafkaConnectKafkaConnectUserConfigPrivatelinkAccess {
905
896
  jolokia?: boolean;
906
- /**
907
- * Kafka Connect server provided values
908
- */
909
897
  kafkaConnect?: boolean;
910
898
  prometheus?: boolean;
911
899
  }
912
900
  export interface GetKafkaConnectKafkaConnectUserConfigPublicAccess {
913
- /**
914
- * Kafka Connect server provided values
915
- */
916
901
  kafkaConnect?: boolean;
917
902
  prometheus?: boolean;
918
903
  }
@@ -926,9 +911,6 @@ export interface GetKafkaConnectTag {
926
911
  }
927
912
  export interface GetKafkaConnectorTask {
928
913
  connector: string;
929
- /**
930
- * List of tasks of a connector.
931
- */
932
914
  task: number;
933
915
  }
934
916
  export interface GetKafkaKafka {
@@ -947,9 +929,6 @@ export interface GetKafkaKafkaUserConfig {
947
929
  * @deprecated This will be removed in v5.0.0 and replaced with ip_filter_string instead.
948
930
  */
949
931
  ipFilters?: string[];
950
- /**
951
- * Kafka server provided values
952
- */
953
932
  kafka?: outputs.GetKafkaKafkaUserConfigKafka;
954
933
  kafkaAuthenticationMethods?: outputs.GetKafkaKafkaUserConfigKafkaAuthenticationMethods;
955
934
  kafkaConnect?: boolean;
@@ -963,9 +942,6 @@ export interface GetKafkaKafkaUserConfig {
963
942
  publicAccess?: outputs.GetKafkaKafkaUserConfigPublicAccess;
964
943
  schemaRegistry?: boolean;
965
944
  schemaRegistryConfig?: outputs.GetKafkaKafkaUserConfigSchemaRegistryConfig;
966
- /**
967
- * Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
968
- */
969
945
  staticIps?: boolean;
970
946
  }
971
947
  export interface GetKafkaKafkaUserConfigIpFilterObject {
@@ -1046,9 +1022,6 @@ export interface GetKafkaKafkaUserConfigKafkaRestConfig {
1046
1022
  simpleconsumerPoolSizeMax?: number;
1047
1023
  }
1048
1024
  export interface GetKafkaKafkaUserConfigPrivateAccess {
1049
- /**
1050
- * Kafka server provided values
1051
- */
1052
1025
  kafka?: boolean;
1053
1026
  kafkaConnect?: boolean;
1054
1027
  kafkaRest?: boolean;
@@ -1057,9 +1030,6 @@ export interface GetKafkaKafkaUserConfigPrivateAccess {
1057
1030
  }
1058
1031
  export interface GetKafkaKafkaUserConfigPrivatelinkAccess {
1059
1032
  jolokia?: boolean;
1060
- /**
1061
- * Kafka server provided values
1062
- */
1063
1033
  kafka?: boolean;
1064
1034
  kafkaConnect?: boolean;
1065
1035
  kafkaRest?: boolean;
@@ -1067,9 +1037,6 @@ export interface GetKafkaKafkaUserConfigPrivatelinkAccess {
1067
1037
  schemaRegistry?: boolean;
1068
1038
  }
1069
1039
  export interface GetKafkaKafkaUserConfigPublicAccess {
1070
- /**
1071
- * Kafka server provided values
1072
- */
1073
1040
  kafka?: boolean;
1074
1041
  kafkaConnect?: boolean;
1075
1042
  kafkaRest?: boolean;
@@ -1099,13 +1066,7 @@ export interface GetKafkaMirrorMakerKafkaMirrormakerUserConfig {
1099
1066
  * @deprecated This will be removed in v5.0.0 and replaced with ip_filter_string instead.
1100
1067
  */
1101
1068
  ipFilters?: string[];
1102
- /**
1103
- * Kafka MirrorMaker 2 server provided values
1104
- */
1105
1069
  kafkaMirrormaker?: outputs.GetKafkaMirrorMakerKafkaMirrormakerUserConfigKafkaMirrormaker;
1106
- /**
1107
- * Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
1108
- */
1109
1070
  staticIps?: boolean;
1110
1071
  }
1111
1072
  export interface GetKafkaMirrorMakerKafkaMirrormakerUserConfigIpFilterObject {
@@ -1197,9 +1158,6 @@ export interface GetM3AggregatorM3aggregatorUserConfig {
1197
1158
  */
1198
1159
  m3Version?: string;
1199
1160
  m3aggregatorVersion?: string;
1200
- /**
1201
- * Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
1202
- */
1203
1161
  staticIps?: boolean;
1204
1162
  }
1205
1163
  export interface GetM3AggregatorM3aggregatorUserConfigIpFilterObject {
@@ -1248,9 +1206,6 @@ export interface GetM3DbM3dbUserConfig {
1248
1206
  publicAccess?: outputs.GetM3DbM3dbUserConfigPublicAccess;
1249
1207
  rules?: outputs.GetM3DbM3dbUserConfigRules;
1250
1208
  serviceToForkFrom?: string;
1251
- /**
1252
- * Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
1253
- */
1254
1209
  staticIps?: boolean;
1255
1210
  }
1256
1211
  export interface GetM3DbM3dbUserConfigIpFilterObject {
@@ -1353,9 +1308,6 @@ export interface GetMySqlMysqlUserConfig {
1353
1308
  */
1354
1309
  ipFilters?: string[];
1355
1310
  migration?: outputs.GetMySqlMysqlUserConfigMigration;
1356
- /**
1357
- * MySQL specific server provided values
1358
- */
1359
1311
  mysql?: outputs.GetMySqlMysqlUserConfigMysql;
1360
1312
  mysqlVersion?: string;
1361
1313
  privateAccess?: outputs.GetMySqlMysqlUserConfigPrivateAccess;
@@ -1364,9 +1316,6 @@ export interface GetMySqlMysqlUserConfig {
1364
1316
  publicAccess?: outputs.GetMySqlMysqlUserConfigPublicAccess;
1365
1317
  recoveryTargetTime?: string;
1366
1318
  serviceToForkFrom?: string;
1367
- /**
1368
- * Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
1369
- */
1370
1319
  staticIps?: boolean;
1371
1320
  }
1372
1321
  export interface GetMySqlMysqlUserConfigIpFilterObject {
@@ -1416,25 +1365,16 @@ export interface GetMySqlMysqlUserConfigMysql {
1416
1365
  waitTimeout?: number;
1417
1366
  }
1418
1367
  export interface GetMySqlMysqlUserConfigPrivateAccess {
1419
- /**
1420
- * MySQL specific server provided values
1421
- */
1422
1368
  mysql?: boolean;
1423
1369
  mysqlx?: boolean;
1424
1370
  prometheus?: boolean;
1425
1371
  }
1426
1372
  export interface GetMySqlMysqlUserConfigPrivatelinkAccess {
1427
- /**
1428
- * MySQL specific server provided values
1429
- */
1430
1373
  mysql?: boolean;
1431
1374
  mysqlx?: boolean;
1432
1375
  prometheus?: boolean;
1433
1376
  }
1434
1377
  export interface GetMySqlMysqlUserConfigPublicAccess {
1435
- /**
1436
- * MySQL specific server provided values
1437
- */
1438
1378
  mysql?: boolean;
1439
1379
  mysqlx?: boolean;
1440
1380
  prometheus?: boolean;
@@ -1480,9 +1420,6 @@ export interface GetOpenSearchOpensearchUserConfig {
1480
1420
  */
1481
1421
  maxIndexCount?: number;
1482
1422
  openid?: outputs.GetOpenSearchOpensearchUserConfigOpenid;
1483
- /**
1484
- * OpenSearch server provided values
1485
- */
1486
1423
  opensearch?: outputs.GetOpenSearchOpensearchUserConfigOpensearch;
1487
1424
  opensearchDashboards?: outputs.GetOpenSearchOpensearchUserConfigOpensearchDashboards;
1488
1425
  opensearchVersion?: string;
@@ -1493,9 +1430,6 @@ export interface GetOpenSearchOpensearchUserConfig {
1493
1430
  recoveryBasebackupName?: string;
1494
1431
  saml?: outputs.GetOpenSearchOpensearchUserConfigSaml;
1495
1432
  serviceToForkFrom?: string;
1496
- /**
1497
- * Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
1498
- */
1499
1433
  staticIps?: boolean;
1500
1434
  }
1501
1435
  export interface GetOpenSearchOpensearchUserConfigIndexPattern {
@@ -1565,25 +1499,16 @@ export interface GetOpenSearchOpensearchUserConfigOpensearchDashboards {
1565
1499
  opensearchRequestTimeout?: number;
1566
1500
  }
1567
1501
  export interface GetOpenSearchOpensearchUserConfigPrivateAccess {
1568
- /**
1569
- * OpenSearch server provided values
1570
- */
1571
1502
  opensearch?: boolean;
1572
1503
  opensearchDashboards?: boolean;
1573
1504
  prometheus?: boolean;
1574
1505
  }
1575
1506
  export interface GetOpenSearchOpensearchUserConfigPrivatelinkAccess {
1576
- /**
1577
- * OpenSearch server provided values
1578
- */
1579
1507
  opensearch?: boolean;
1580
1508
  opensearchDashboards?: boolean;
1581
1509
  prometheus?: boolean;
1582
1510
  }
1583
1511
  export interface GetOpenSearchOpensearchUserConfigPublicAccess {
1584
- /**
1585
- * OpenSearch server provided values
1586
- */
1587
1512
  opensearch?: boolean;
1588
1513
  opensearchDashboards?: boolean;
1589
1514
  prometheus?: boolean;
@@ -1639,9 +1564,6 @@ export interface GetPgPgUserConfig {
1639
1564
  */
1640
1565
  ipFilters?: string[];
1641
1566
  migration?: outputs.GetPgPgUserConfigMigration;
1642
- /**
1643
- * PostgreSQL specific server provided values
1644
- */
1645
1567
  pg?: outputs.GetPgPgUserConfigPg;
1646
1568
  /**
1647
1569
  * @deprecated Usage of this field is discouraged.
@@ -1662,9 +1584,6 @@ export interface GetPgPgUserConfig {
1662
1584
  recoveryTargetTime?: string;
1663
1585
  serviceToForkFrom?: string;
1664
1586
  sharedBuffersPercentage?: number;
1665
- /**
1666
- * Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
1667
- */
1668
1587
  staticIps?: boolean;
1669
1588
  synchronousReplication?: string;
1670
1589
  timescaledb?: outputs.GetPgPgUserConfigTimescaledb;
@@ -1751,25 +1670,16 @@ export interface GetPgPgUserConfigPglookout {
1751
1670
  maxFailoverReplicationTimeLag?: number;
1752
1671
  }
1753
1672
  export interface GetPgPgUserConfigPrivateAccess {
1754
- /**
1755
- * PostgreSQL specific server provided values
1756
- */
1757
1673
  pg?: boolean;
1758
1674
  pgbouncer?: boolean;
1759
1675
  prometheus?: boolean;
1760
1676
  }
1761
1677
  export interface GetPgPgUserConfigPrivatelinkAccess {
1762
- /**
1763
- * PostgreSQL specific server provided values
1764
- */
1765
1678
  pg?: boolean;
1766
1679
  pgbouncer?: boolean;
1767
1680
  prometheus?: boolean;
1768
1681
  }
1769
1682
  export interface GetPgPgUserConfigPublicAccess {
1770
- /**
1771
- * PostgreSQL specific server provided values
1772
- */
1773
1683
  pg?: boolean;
1774
1684
  pgbouncer?: boolean;
1775
1685
  prometheus?: boolean;
@@ -1826,9 +1736,6 @@ export interface GetRedisRedisUserConfig {
1826
1736
  redisSsl?: boolean;
1827
1737
  redisTimeout?: number;
1828
1738
  serviceToForkFrom?: string;
1829
- /**
1830
- * Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
1831
- */
1832
1739
  staticIps?: boolean;
1833
1740
  }
1834
1741
  export interface GetRedisRedisUserConfigIpFilterObject {
@@ -1847,23 +1754,14 @@ export interface GetRedisRedisUserConfigMigration {
1847
1754
  }
1848
1755
  export interface GetRedisRedisUserConfigPrivateAccess {
1849
1756
  prometheus?: boolean;
1850
- /**
1851
- * Redis server provided values
1852
- */
1853
1757
  redis?: boolean;
1854
1758
  }
1855
1759
  export interface GetRedisRedisUserConfigPrivatelinkAccess {
1856
1760
  prometheus?: boolean;
1857
- /**
1858
- * Redis server provided values
1859
- */
1860
1761
  redis?: boolean;
1861
1762
  }
1862
1763
  export interface GetRedisRedisUserConfigPublicAccess {
1863
1764
  prometheus?: boolean;
1864
- /**
1865
- * Redis server provided values
1866
- */
1867
1765
  redis?: boolean;
1868
1766
  }
1869
1767
  export interface GetRedisServiceIntegration {
@@ -2294,33 +2192,60 @@ export interface InfluxDbInfluxdbUserConfig {
2294
2192
  staticIps?: boolean;
2295
2193
  }
2296
2194
  export interface InfluxDbInfluxdbUserConfigInfluxdb {
2195
+ /**
2196
+ * The maximum duration in seconds before a query is logged as a slow query. Setting this to 0 (the default) will never log slow queries.
2197
+ */
2297
2198
  logQueriesAfter?: number;
2199
+ /**
2200
+ * Maximum number of connections to InfluxDB. Setting this to 0 (default) means no limit. If using max*connection*limit, it is recommended to set the value to be large enough in order to not block clients unnecessarily.
2201
+ */
2298
2202
  maxConnectionLimit?: number;
2203
+ /**
2204
+ * The maximum number of rows returned in a non-chunked query. Setting this to 0 (the default) allows an unlimited number to be returned.
2205
+ */
2299
2206
  maxRowLimit?: number;
2207
+ /**
2208
+ * The maximum number of `GROUP BY time()` buckets that can be processed in a query. Setting this to 0 (the default) allows an unlimited number to be processed.
2209
+ */
2300
2210
  maxSelectBuckets?: number;
2211
+ /**
2212
+ * The maximum number of points that can be processed in a SELECT statement. Setting this to 0 (the default) allows an unlimited number to be processed.
2213
+ */
2301
2214
  maxSelectPoint?: number;
2215
+ /**
2216
+ * Whether queries should be logged before execution. May log sensitive data contained within a query.
2217
+ */
2302
2218
  queryLogEnabled?: boolean;
2219
+ /**
2220
+ * The maximum duration in seconds before a query is killed. Setting this to 0 (the default) will never kill slow queries.
2221
+ */
2303
2222
  queryTimeout?: number;
2304
2223
  }
2305
2224
  export interface InfluxDbInfluxdbUserConfigIpFilterObject {
2225
+ /**
2226
+ * Description for IP filter list entry.
2227
+ */
2306
2228
  description?: string;
2229
+ /**
2230
+ * CIDR address block.
2231
+ */
2307
2232
  network: string;
2308
2233
  }
2309
2234
  export interface InfluxDbInfluxdbUserConfigPrivateAccess {
2310
2235
  /**
2311
- * InfluxDB server provided values
2236
+ * influxdb.conf configuration values.
2312
2237
  */
2313
2238
  influxdb?: boolean;
2314
2239
  }
2315
2240
  export interface InfluxDbInfluxdbUserConfigPrivatelinkAccess {
2316
2241
  /**
2317
- * InfluxDB server provided values
2242
+ * influxdb.conf configuration values.
2318
2243
  */
2319
2244
  influxdb?: boolean;
2320
2245
  }
2321
2246
  export interface InfluxDbInfluxdbUserConfigPublicAccess {
2322
2247
  /**
2323
- * InfluxDB server provided values
2248
+ * influxdb.conf configuration values.
2324
2249
  */
2325
2250
  influxdb?: boolean;
2326
2251
  }
@@ -2423,9 +2348,6 @@ export interface KafkaConnectTag {
2423
2348
  }
2424
2349
  export interface KafkaConnectorTask {
2425
2350
  connector: string;
2426
- /**
2427
- * List of tasks of a connector.
2428
- */
2429
2351
  task: number;
2430
2352
  }
2431
2353
  export interface KafkaKafka {
@@ -2516,115 +2438,361 @@ export interface KafkaKafkaUserConfig {
2516
2438
  staticIps?: boolean;
2517
2439
  }
2518
2440
  export interface KafkaKafkaUserConfigIpFilterObject {
2441
+ /**
2442
+ * Description for IP filter list entry.
2443
+ */
2519
2444
  description?: string;
2445
+ /**
2446
+ * CIDR address block.
2447
+ */
2520
2448
  network: string;
2521
2449
  }
2522
2450
  export interface KafkaKafkaUserConfigKafka {
2451
+ /**
2452
+ * Enable auto creation of topics.
2453
+ */
2523
2454
  autoCreateTopicsEnable?: boolean;
2455
+ /**
2456
+ * Specify the final compression type for a given topic. This configuration accepts the standard compression codecs ('gzip', 'snappy', 'lz4', 'zstd'). It additionally accepts 'uncompressed' which is equivalent to no compression; and 'producer' which means retain the original compression codec set by the producer.
2457
+ */
2524
2458
  compressionType?: string;
2459
+ /**
2460
+ * Idle connections timeout: the server socket processor threads close the connections that idle for longer than this.
2461
+ */
2525
2462
  connectionsMaxIdleMs?: number;
2463
+ /**
2464
+ * Replication factor for autocreated topics.
2465
+ */
2526
2466
  defaultReplicationFactor?: number;
2467
+ /**
2468
+ * The amount of time, in milliseconds, the group coordinator will wait for more consumers to join a new group before performing the first rebalance. A longer delay means potentially fewer rebalances, but increases the time until processing begins. The default value for this is 3 seconds. During development and testing it might be desirable to set this to 0 in order to not delay test execution time.
2469
+ */
2527
2470
  groupInitialRebalanceDelayMs?: number;
2471
+ /**
2472
+ * The maximum allowed session timeout for registered consumers. Longer timeouts give consumers more time to process messages in between heartbeats at the cost of a longer time to detect failures.
2473
+ */
2528
2474
  groupMaxSessionTimeoutMs?: number;
2475
+ /**
2476
+ * The minimum allowed session timeout for registered consumers. Longer timeouts give consumers more time to process messages in between heartbeats at the cost of a longer time to detect failures.
2477
+ */
2529
2478
  groupMinSessionTimeoutMs?: number;
2479
+ /**
2480
+ * How long are delete records retained?.
2481
+ */
2530
2482
  logCleanerDeleteRetentionMs?: number;
2483
+ /**
2484
+ * The maximum amount of time message will remain uncompacted. Only applicable for logs that are being compacted.
2485
+ */
2531
2486
  logCleanerMaxCompactionLagMs?: number;
2487
+ /**
2488
+ * Controls log compactor frequency. Larger value means more frequent compactions but also more space wasted for logs. Consider setting log.cleaner.max.compaction.lag.ms to enforce compactions sooner, instead of setting a very high value for this option.
2489
+ */
2532
2490
  logCleanerMinCleanableRatio?: number;
2491
+ /**
2492
+ * The minimum time a message will remain uncompacted in the log. Only applicable for logs that are being compacted.
2493
+ */
2533
2494
  logCleanerMinCompactionLagMs?: number;
2495
+ /**
2496
+ * The default cleanup policy for segments beyond the retention window.
2497
+ */
2534
2498
  logCleanupPolicy?: string;
2499
+ /**
2500
+ * The number of messages accumulated on a log partition before messages are flushed to disk.
2501
+ */
2535
2502
  logFlushIntervalMessages?: number;
2503
+ /**
2504
+ * The maximum time in ms that a message in any topic is kept in memory before flushed to disk. If not set, the value in log.flush.scheduler.interval.ms is used.
2505
+ */
2536
2506
  logFlushIntervalMs?: number;
2507
+ /**
2508
+ * The interval with which Kafka adds an entry to the offset index.
2509
+ */
2537
2510
  logIndexIntervalBytes?: number;
2511
+ /**
2512
+ * The maximum size in bytes of the offset index.
2513
+ */
2538
2514
  logIndexSizeMaxBytes?: number;
2515
+ /**
2516
+ * This configuration controls whether down-conversion of message formats is enabled to satisfy consume requests. .
2517
+ */
2539
2518
  logMessageDownconversionEnable?: boolean;
2519
+ /**
2520
+ * The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message.
2521
+ */
2540
2522
  logMessageTimestampDifferenceMaxMs?: number;
2523
+ /**
2524
+ * Define whether the timestamp in the message is message create time or log append time.
2525
+ */
2541
2526
  logMessageTimestampType?: string;
2527
+ /**
2528
+ * Should pre allocate file when create new segment?.
2529
+ */
2542
2530
  logPreallocate?: boolean;
2531
+ /**
2532
+ * The maximum size of the log before deleting messages.
2533
+ */
2543
2534
  logRetentionBytes?: number;
2535
+ /**
2536
+ * The number of hours to keep a log file before deleting it.
2537
+ */
2544
2538
  logRetentionHours?: number;
2539
+ /**
2540
+ * The number of milliseconds to keep a log file before deleting it (in milliseconds), If not set, the value in log.retention.minutes is used. If set to -1, no time limit is applied.
2541
+ */
2545
2542
  logRetentionMs?: number;
2543
+ /**
2544
+ * The maximum jitter to subtract from logRollTimeMillis (in milliseconds). If not set, the value in log.roll.jitter.hours is used.
2545
+ */
2546
2546
  logRollJitterMs?: number;
2547
+ /**
2548
+ * The maximum time before a new log segment is rolled out (in milliseconds).
2549
+ */
2547
2550
  logRollMs?: number;
2551
+ /**
2552
+ * The maximum size of a single log file.
2553
+ */
2548
2554
  logSegmentBytes?: number;
2555
+ /**
2556
+ * The amount of time to wait before deleting a file from the filesystem.
2557
+ */
2549
2558
  logSegmentDeleteDelayMs?: number;
2559
+ /**
2560
+ * The maximum number of connections allowed from each ip address (defaults to 2147483647).
2561
+ */
2550
2562
  maxConnectionsPerIp?: number;
2563
+ /**
2564
+ * The maximum number of incremental fetch sessions that the broker will maintain.
2565
+ */
2551
2566
  maxIncrementalFetchSessionCacheSlots?: number;
2567
+ /**
2568
+ * The maximum size of message that the server can receive.
2569
+ */
2552
2570
  messageMaxBytes?: number;
2571
+ /**
2572
+ * When a producer sets acks to 'all' (or '-1'), min.insync.replicas specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful.
2573
+ */
2553
2574
  minInsyncReplicas?: number;
2575
+ /**
2576
+ * Number of partitions for autocreated topics.
2577
+ */
2554
2578
  numPartitions?: number;
2579
+ /**
2580
+ * Log retention window in minutes for offsets topic.
2581
+ */
2555
2582
  offsetsRetentionMinutes?: number;
2583
+ /**
2584
+ * The purge interval (in number of requests) of the producer request purgatory(defaults to 1000).
2585
+ */
2556
2586
  producerPurgatoryPurgeIntervalRequests?: number;
2587
+ /**
2588
+ * The number of bytes of messages to attempt to fetch for each partition (defaults to 1048576). This is not an absolute maximum, if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that progress can be made.
2589
+ */
2557
2590
  replicaFetchMaxBytes?: number;
2591
+ /**
2592
+ * Maximum bytes expected for the entire fetch response (defaults to 10485760). Records are fetched in batches, and if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that progress can be made. As such, this is not an absolute maximum.
2593
+ */
2558
2594
  replicaFetchResponseMaxBytes?: number;
2595
+ /**
2596
+ * The maximum number of bytes in a socket request (defaults to 104857600).
2597
+ */
2559
2598
  socketRequestMaxBytes?: number;
2599
+ /**
2600
+ * The interval at which to remove transactions that have expired due to transactional.id.expiration.ms passing (defaults to 3600000 (1 hour)).
2601
+ */
2560
2602
  transactionRemoveExpiredTransactionCleanupIntervalMs?: number;
2603
+ /**
2604
+ * The transaction topic segment bytes should be kept relatively small in order to facilitate faster log compaction and cache loads (defaults to 104857600 (100 mebibytes)).
2605
+ */
2561
2606
  transactionStateLogSegmentBytes?: number;
2562
2607
  }
2563
2608
  export interface KafkaKafkaUserConfigKafkaAuthenticationMethods {
2609
+ /**
2610
+ * Enable certificate/SSL authentication. The default value is `true`.
2611
+ */
2564
2612
  certificate?: boolean;
2613
+ /**
2614
+ * Enable SASL authentication. The default value is `false`.
2615
+ */
2565
2616
  sasl?: boolean;
2566
2617
  }
2567
2618
  export interface KafkaKafkaUserConfigKafkaConnectConfig {
2619
+ /**
2620
+ * Defines what client configurations can be overridden by the connector. Default is None.
2621
+ */
2568
2622
  connectorClientConfigOverridePolicy?: string;
2623
+ /**
2624
+ * What to do when there is no initial offset in Kafka or if the current offset does not exist any more on the server. Default is earliest.
2625
+ */
2569
2626
  consumerAutoOffsetReset?: string;
2627
+ /**
2628
+ * Records are fetched in batches by the consumer, and if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that the consumer can make progress. As such, this is not a absolute maximum.
2629
+ */
2570
2630
  consumerFetchMaxBytes?: number;
2571
- consumerIsolationLevel?: string;
2631
+ /**
2632
+ * Transaction read isolation level. read*uncommitted is the default, but read*committed can be used if consume-exactly-once behavior is desired.
2633
+ */
2634
+ consumerIsolationLevel?: string;
2635
+ /**
2636
+ * Records are fetched in batches by the consumer.If the first record batch in the first non-empty partition of the fetch is larger than this limit, the batch will still be returned to ensure that the consumer can make progress. .
2637
+ */
2572
2638
  consumerMaxPartitionFetchBytes?: number;
2639
+ /**
2640
+ * The maximum delay in milliseconds between invocations of poll() when using consumer group management (defaults to 300000).
2641
+ */
2573
2642
  consumerMaxPollIntervalMs?: number;
2643
+ /**
2644
+ * The maximum number of records returned in a single call to poll() (defaults to 500).
2645
+ */
2574
2646
  consumerMaxPollRecords?: number;
2647
+ /**
2648
+ * The interval at which to try committing offsets for tasks (defaults to 60000).
2649
+ */
2575
2650
  offsetFlushIntervalMs?: number;
2651
+ /**
2652
+ * Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt (defaults to 5000).
2653
+ */
2576
2654
  offsetFlushTimeoutMs?: number;
2655
+ /**
2656
+ * This setting gives the upper bound of the batch size to be sent. If there are fewer than this many bytes accumulated for this partition, the producer will 'linger' for the linger.ms time waiting for more records to show up. A batch size of zero will disable batching entirely (defaults to 16384).
2657
+ */
2577
2658
  producerBatchSize?: number;
2659
+ /**
2660
+ * The total bytes of memory the producer can use to buffer records waiting to be sent to the broker (defaults to 33554432).
2661
+ */
2578
2662
  producerBufferMemory?: number;
2663
+ /**
2664
+ * Specify the default compression type for producers. This configuration accepts the standard compression codecs ('gzip', 'snappy', 'lz4', 'zstd'). It additionally accepts 'none' which is the default and equivalent to no compression.
2665
+ */
2579
2666
  producerCompressionType?: string;
2667
+ /**
2668
+ * This setting gives the upper bound on the delay for batching: once there is batch.size worth of records for a partition it will be sent immediately regardless of this setting, however if there are fewer than this many bytes accumulated for this partition the producer will 'linger' for the specified time waiting for more records to show up. Defaults to 0.
2669
+ */
2580
2670
  producerLingerMs?: number;
2671
+ /**
2672
+ * This setting will limit the number of record batches the producer will send in a single request to avoid sending huge requests.
2673
+ */
2581
2674
  producerMaxRequestSize?: number;
2675
+ /**
2676
+ * The maximum delay that is scheduled in order to wait for the return of one or more departed workers before rebalancing and reassigning their connectors and tasks to the group. During this period the connectors and tasks of the departed workers remain unassigned. Defaults to 5 minutes.
2677
+ */
2582
2678
  scheduledRebalanceMaxDelayMs?: number;
2679
+ /**
2680
+ * The timeout in milliseconds used to detect failures when using Kafka’s group management facilities (defaults to 10000).
2681
+ */
2583
2682
  sessionTimeoutMs?: number;
2584
2683
  }
2585
2684
  export interface KafkaKafkaUserConfigKafkaRestConfig {
2685
+ /**
2686
+ * If true the consumer's offset will be periodically committed to Kafka in the background. The default value is `true`.
2687
+ */
2586
2688
  consumerEnableAutoCommit?: boolean;
2689
+ /**
2690
+ * Maximum number of bytes in unencoded message keys and values by a single request. The default value is `67108864`.
2691
+ */
2587
2692
  consumerRequestMaxBytes?: number;
2693
+ /**
2694
+ * The maximum total time to wait for messages for a request if the maximum number of messages has not yet been reached. The default value is `1000`.
2695
+ */
2588
2696
  consumerRequestTimeoutMs?: number;
2697
+ /**
2698
+ * The number of acknowledgments the producer requires the leader to have received before considering a request complete. If set to 'all' or '-1', the leader will wait for the full set of in-sync replicas to acknowledge the record. The default value is `1`.
2699
+ */
2589
2700
  producerAcks?: string;
2701
+ /**
2702
+ * Specify the default compression type for producers. This configuration accepts the standard compression codecs ('gzip', 'snappy', 'lz4', 'zstd'). It additionally accepts 'none' which is the default and equivalent to no compression.
2703
+ */
2590
2704
  producerCompressionType?: string;
2705
+ /**
2706
+ * This setting gives the upper bound on the delay for batching: once there is batch.size worth of records for a partition it will be sent immediately regardless of this setting, however if there are fewer than this many bytes accumulated for this partition the producer will 'linger' for the specified time waiting for more records to show up. Defaults to 0.
2707
+ */
2591
2708
  producerLingerMs?: number;
2709
+ /**
2710
+ * This setting will limit the number of record batches the producer will send in a single request to avoid sending huge requests.
2711
+ */
2592
2712
  producerMaxRequestSize?: number;
2713
+ /**
2714
+ * Maximum number of SimpleConsumers that can be instantiated per broker. The default value is `25`.
2715
+ */
2593
2716
  simpleconsumerPoolSizeMax?: number;
2594
2717
  }
2595
2718
  export interface KafkaKafkaUserConfigPrivateAccess {
2596
2719
  /**
2597
- * Kafka server provided values
2720
+ * Kafka broker configuration values.
2598
2721
  */
2599
2722
  kafka?: boolean;
2723
+ /**
2724
+ * Enable Kafka Connect service. The default value is `false`.
2725
+ */
2600
2726
  kafkaConnect?: boolean;
2727
+ /**
2728
+ * Enable Kafka-REST service. The default value is `false`.
2729
+ */
2601
2730
  kafkaRest?: boolean;
2731
+ /**
2732
+ * Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
2733
+ */
2602
2734
  prometheus?: boolean;
2735
+ /**
2736
+ * Allow clients to connect to schemaRegistry with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
2737
+ */
2603
2738
  schemaRegistry?: boolean;
2604
2739
  }
2605
2740
  export interface KafkaKafkaUserConfigPrivatelinkAccess {
2741
+ /**
2742
+ * Enable jolokia.
2743
+ */
2606
2744
  jolokia?: boolean;
2607
2745
  /**
2608
- * Kafka server provided values
2746
+ * Kafka broker configuration values.
2609
2747
  */
2610
2748
  kafka?: boolean;
2749
+ /**
2750
+ * Enable Kafka Connect service. The default value is `false`.
2751
+ */
2611
2752
  kafkaConnect?: boolean;
2753
+ /**
2754
+ * Enable Kafka-REST service. The default value is `false`.
2755
+ */
2612
2756
  kafkaRest?: boolean;
2757
+ /**
2758
+ * Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
2759
+ */
2613
2760
  prometheus?: boolean;
2761
+ /**
2762
+ * Allow clients to connect to schemaRegistry with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
2763
+ */
2614
2764
  schemaRegistry?: boolean;
2615
2765
  }
2616
2766
  export interface KafkaKafkaUserConfigPublicAccess {
2617
2767
  /**
2618
- * Kafka server provided values
2768
+ * Kafka broker configuration values.
2619
2769
  */
2620
2770
  kafka?: boolean;
2771
+ /**
2772
+ * Enable Kafka Connect service. The default value is `false`.
2773
+ */
2621
2774
  kafkaConnect?: boolean;
2775
+ /**
2776
+ * Enable Kafka-REST service. The default value is `false`.
2777
+ */
2622
2778
  kafkaRest?: boolean;
2779
+ /**
2780
+ * Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
2781
+ */
2623
2782
  prometheus?: boolean;
2783
+ /**
2784
+ * Allow clients to connect to schemaRegistry with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
2785
+ */
2624
2786
  schemaRegistry?: boolean;
2625
2787
  }
2626
2788
  export interface KafkaKafkaUserConfigSchemaRegistryConfig {
2789
+ /**
2790
+ * If true, Karapace / Schema Registry on the service nodes can participate in leader election. It might be needed to disable this when the schemas topic is replicated to a secondary cluster and Karapace / Schema Registry there must not participate in leader election. Defaults to `true`.
2791
+ */
2627
2792
  leaderEligibility?: boolean;
2793
+ /**
2794
+ * The durable single partition topic that acts as the durable log for the data. This topic must be compacted to avoid losing data due to retention policy. Please note that changing this configuration in an existing Schema Registry / Karapace setup leads to previous schemas being inaccessible, data encoded with them potentially unreadable and schema ID sequence put out of order. It's only possible to do the switch while Schema Registry / Karapace is disabled. Defaults to `_schemas`.
2795
+ */
2628
2796
  topicName?: string;
2629
2797
  }
2630
2798
  export interface KafkaMirrorMakerComponent {
@@ -3165,102 +3333,303 @@ export interface OpenSearchOpensearchUserConfig {
3165
3333
  staticIps?: boolean;
3166
3334
  }
3167
3335
  export interface OpenSearchOpensearchUserConfigIndexPattern {
3336
+ /**
3337
+ * Maximum number of indexes to keep.
3338
+ */
3168
3339
  maxIndexCount: number;
3340
+ /**
3341
+ * fnmatch pattern.
3342
+ */
3169
3343
  pattern: string;
3344
+ /**
3345
+ * Deletion sorting algorithm. The default value is `creationDate`.
3346
+ */
3170
3347
  sortingAlgorithm?: string;
3171
3348
  }
3172
3349
  export interface OpenSearchOpensearchUserConfigIndexTemplate {
3350
+ /**
3351
+ * The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects. Default is 10000.
3352
+ */
3173
3353
  mappingNestedObjectsLimit?: number;
3354
+ /**
3355
+ * The number of replicas each primary shard has.
3356
+ */
3174
3357
  numberOfReplicas?: number;
3358
+ /**
3359
+ * The number of primary shards that an index should have.
3360
+ */
3175
3361
  numberOfShards?: number;
3176
3362
  }
3177
3363
  export interface OpenSearchOpensearchUserConfigIpFilterObject {
3364
+ /**
3365
+ * Description for IP filter list entry.
3366
+ */
3178
3367
  description?: string;
3368
+ /**
3369
+ * CIDR address block.
3370
+ */
3179
3371
  network: string;
3180
3372
  }
3181
3373
  export interface OpenSearchOpensearchUserConfigOpenid {
3374
+ /**
3375
+ * The ID of the OpenID Connect client configured in your IdP. Required.
3376
+ */
3182
3377
  clientId: string;
3378
+ /**
3379
+ * The client secret of the OpenID Connect client configured in your IdP. Required.
3380
+ */
3183
3381
  clientSecret: string;
3382
+ /**
3383
+ * The URL of your IdP where the Security plugin can find the OpenID Connect metadata/configuration settings.
3384
+ */
3184
3385
  connectUrl: string;
3386
+ /**
3387
+ * Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider. The default value is `true`.
3388
+ */
3185
3389
  enabled?: boolean;
3390
+ /**
3391
+ * HTTP header name of the JWT token. Optional. Default is Authorization. The default value is `Authorization`.
3392
+ */
3186
3393
  header?: string;
3394
+ /**
3395
+ * The HTTP header that stores the token. Typically the Authorization header with the Bearer schema: Authorization: Bearer \n\n. Optional. Default is Authorization.
3396
+ */
3187
3397
  jwtHeader?: string;
3398
+ /**
3399
+ * If the token is not transmitted in the HTTP header, but as an URL parameter, define the name of the parameter here. Optional.
3400
+ */
3188
3401
  jwtUrlParameter?: string;
3402
+ /**
3403
+ * The maximum number of unknown key IDs in the time frame. Default is 10. Optional. The default value is `10`.
3404
+ */
3189
3405
  refreshRateLimitCount?: number;
3406
+ /**
3407
+ * The time frame to use when checking the maximum number of unknown key IDs, in milliseconds. Optional.Default is 10000 (10 seconds). The default value is `10000`.
3408
+ */
3190
3409
  refreshRateLimitTimeWindowMs?: number;
3410
+ /**
3411
+ * The key in the JSON payload that stores the user’s roles. The value of this key must be a comma-separated list of roles. Required only if you want to use roles in the JWT.
3412
+ */
3191
3413
  rolesKey?: string;
3414
+ /**
3415
+ * The scope of the identity token issued by the IdP. Optional. Default is openid profile email address phone.
3416
+ */
3192
3417
  scope?: string;
3418
+ /**
3419
+ * The key in the JSON payload that stores the user’s name. If not defined, the subject registered claim is used. Most IdP providers use the preferredUsername claim. Optional.
3420
+ */
3193
3421
  subjectKey?: string;
3194
3422
  }
3195
3423
  export interface OpenSearchOpensearchUserConfigOpensearch {
3424
+ /**
3425
+ * Explicitly allow or block automatic creation of indices. Defaults to true.
3426
+ */
3196
3427
  actionAutoCreateIndexEnabled?: boolean;
3428
+ /**
3429
+ * Require explicit index names when deleting.
3430
+ */
3197
3431
  actionDestructiveRequiresName?: boolean;
3432
+ /**
3433
+ * Controls the number of shards allowed in the cluster per data node.
3434
+ */
3198
3435
  clusterMaxShardsPerNode?: number;
3436
+ /**
3437
+ * How many concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to 2.
3438
+ */
3199
3439
  clusterRoutingAllocationNodeConcurrentRecoveries?: number;
3440
+ /**
3441
+ * This should be identical to the Sender name defined in Opensearch dashboards.
3442
+ */
3200
3443
  emailSenderName?: string;
3444
+ /**
3445
+ * Sender password for Opensearch alerts to authenticate with SMTP server.
3446
+ */
3201
3447
  emailSenderPassword?: string;
3448
+ /**
3449
+ * Sender username for Opensearch alerts.
3450
+ */
3202
3451
  emailSenderUsername?: string;
3452
+ /**
3453
+ * Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes.
3454
+ */
3203
3455
  httpMaxContentLength?: number;
3456
+ /**
3457
+ * The max size of allowed headers, in bytes.
3458
+ */
3204
3459
  httpMaxHeaderSize?: number;
3460
+ /**
3461
+ * The max length of an HTTP URL, in bytes.
3462
+ */
3205
3463
  httpMaxInitialLineLength?: number;
3464
+ /**
3465
+ * Relative amount. Maximum amount of heap memory used for field data cache. This is an expert setting; decreasing the value too much will increase overhead of loading field data; too much memory used for field data cache will decrease amount of heap available for other operations.
3466
+ */
3206
3467
  indicesFielddataCacheSize?: number;
3468
+ /**
3469
+ * Percentage value. Default is 10%. Total amount of heap used for indexing buffer, before writing segments to disk. This is an expert setting. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance.
3470
+ */
3207
3471
  indicesMemoryIndexBufferSize?: number;
3472
+ /**
3473
+ * Percentage value. Default is 10%. Maximum amount of heap used for query cache. This is an expert setting. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other OpenSearch functionality.
3474
+ */
3208
3475
  indicesQueriesCacheSize?: number;
3476
+ /**
3477
+ * Maximum number of clauses Lucene BooleanQuery can have. The default value (1024) is relatively high, and increasing it may cause performance issues. Investigate other approaches first before increasing this value.
3478
+ */
3209
3479
  indicesQueryBoolMaxClauseCount?: number;
3480
+ /**
3481
+ * Limits total inbound and outbound recovery traffic for each node. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Defaults to 40mb.
3482
+ */
3210
3483
  indicesRecoveryMaxBytesPerSec?: number;
3484
+ /**
3485
+ * Number of file chunks sent in parallel for each recovery. Defaults to 2.
3486
+ */
3211
3487
  indicesRecoveryMaxConcurrentFileChunks?: number;
3488
+ /**
3489
+ * Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default is false.
3490
+ */
3212
3491
  overrideMainResponseVersion?: boolean;
3492
+ /**
3493
+ * Whitelisted addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.
3494
+ */
3213
3495
  reindexRemoteWhitelists?: string[];
3496
+ /**
3497
+ * Script compilation circuit breaker limits the number of inline script compilations within a period of time. Default is use-context.
3498
+ */
3214
3499
  scriptMaxCompilationsRate?: string;
3500
+ /**
3501
+ * Maximum number of aggregation buckets allowed in a single response. OpenSearch default value is used when this is not defined.
3502
+ */
3215
3503
  searchMaxBuckets?: number;
3504
+ /**
3505
+ * Size for the thread pool queue. See documentation for exact details.
3506
+ */
3216
3507
  threadPoolAnalyzeQueueSize?: number;
3508
+ /**
3509
+ * Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
3510
+ */
3217
3511
  threadPoolAnalyzeSize?: number;
3512
+ /**
3513
+ * Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
3514
+ */
3218
3515
  threadPoolForceMergeSize?: number;
3516
+ /**
3517
+ * Size for the thread pool queue. See documentation for exact details.
3518
+ */
3219
3519
  threadPoolGetQueueSize?: number;
3520
+ /**
3521
+ * Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
3522
+ */
3220
3523
  threadPoolGetSize?: number;
3524
+ /**
3525
+ * Size for the thread pool queue. See documentation for exact details.
3526
+ */
3221
3527
  threadPoolSearchQueueSize?: number;
3528
+ /**
3529
+ * Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
3530
+ */
3222
3531
  threadPoolSearchSize?: number;
3532
+ /**
3533
+ * Size for the thread pool queue. See documentation for exact details.
3534
+ */
3223
3535
  threadPoolSearchThrottledQueueSize?: number;
3536
+ /**
3537
+ * Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
3538
+ */
3224
3539
  threadPoolSearchThrottledSize?: number;
3540
+ /**
3541
+ * Size for the thread pool queue. See documentation for exact details.
3542
+ */
3225
3543
  threadPoolWriteQueueSize?: number;
3544
+ /**
3545
+ * Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
3546
+ */
3226
3547
  threadPoolWriteSize?: number;
3227
3548
  }
3228
3549
  export interface OpenSearchOpensearchUserConfigOpensearchDashboards {
3550
+ /**
3551
+ * Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider. The default value is `true`.
3552
+ */
3229
3553
  enabled?: boolean;
3554
+ /**
3555
+ * Limits the maximum amount of memory (in MiB) the OpenSearch Dashboards process can use. This sets the max*old*space_size option of the nodejs running the OpenSearch Dashboards. Note: the memory reserved by OpenSearch Dashboards is not available for OpenSearch. The default value is `128`.
3556
+ */
3230
3557
  maxOldSpaceSize?: number;
3558
+ /**
3559
+ * Timeout in milliseconds for requests made by OpenSearch Dashboards towards OpenSearch. The default value is `30000`.
3560
+ */
3231
3561
  opensearchRequestTimeout?: number;
3232
3562
  }
3233
3563
  export interface OpenSearchOpensearchUserConfigPrivateAccess {
3234
3564
  /**
3235
- * OpenSearch server provided values
3565
+ * OpenSearch settings.
3236
3566
  */
3237
3567
  opensearch?: boolean;
3568
+ /**
3569
+ * OpenSearch Dashboards settings.
3570
+ */
3238
3571
  opensearchDashboards?: boolean;
3572
+ /**
3573
+ * Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
3574
+ */
3239
3575
  prometheus?: boolean;
3240
3576
  }
3241
3577
  export interface OpenSearchOpensearchUserConfigPrivatelinkAccess {
3242
3578
  /**
3243
- * OpenSearch server provided values
3579
+ * OpenSearch settings.
3244
3580
  */
3245
3581
  opensearch?: boolean;
3582
+ /**
3583
+ * OpenSearch Dashboards settings.
3584
+ */
3246
3585
  opensearchDashboards?: boolean;
3586
+ /**
3587
+ * Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
3588
+ */
3247
3589
  prometheus?: boolean;
3248
3590
  }
3249
3591
  export interface OpenSearchOpensearchUserConfigPublicAccess {
3250
3592
  /**
3251
- * OpenSearch server provided values
3593
+ * OpenSearch settings.
3252
3594
  */
3253
3595
  opensearch?: boolean;
3596
+ /**
3597
+ * OpenSearch Dashboards settings.
3598
+ */
3254
3599
  opensearchDashboards?: boolean;
3600
+ /**
3601
+ * Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
3602
+ */
3255
3603
  prometheus?: boolean;
3256
3604
  }
3257
3605
  export interface OpenSearchOpensearchUserConfigSaml {
3606
+ /**
3607
+ * Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider. The default value is `true`.
3608
+ */
3258
3609
  enabled: boolean;
3610
+ /**
3611
+ * The unique identifier for the Identity Provider (IdP) entity that is used for SAML authentication. This value is typically provided by the IdP.
3612
+ */
3259
3613
  idpEntityId: string;
3614
+ /**
3615
+ * The URL of the SAML metadata for the Identity Provider (IdP). This is used to configure SAML-based authentication with the IdP.
3616
+ */
3260
3617
  idpMetadataUrl: string;
3618
+ /**
3619
+ * This parameter specifies the PEM-encoded root certificate authority (CA) content for the SAML identity provider (IdP) server verification. The root CA content is used to verify the SSL/TLS certificate presented by the server.
3620
+ */
3261
3621
  idpPemtrustedcasContent?: string;
3622
+ /**
3623
+ * The key in the JSON payload that stores the user’s roles. The value of this key must be a comma-separated list of roles. Required only if you want to use roles in the JWT.
3624
+ */
3262
3625
  rolesKey?: string;
3626
+ /**
3627
+ * The unique identifier for the Service Provider (SP) entity that is used for SAML authentication. This value is typically provided by the SP.
3628
+ */
3263
3629
  spEntityId: string;
3630
+ /**
3631
+ * The key in the JSON payload that stores the user’s name. If not defined, the subject registered claim is used. Most IdP providers use the preferredUsername claim. Optional.
3632
+ */
3264
3633
  subjectKey?: string;
3265
3634
  }
3266
3635
  export interface OpenSearchServiceIntegration {
@@ -3473,109 +3842,328 @@ export interface PgPgUserConfig {
3473
3842
  workMem?: number;
3474
3843
  }
3475
3844
  export interface PgPgUserConfigIpFilterObject {
3845
+ /**
3846
+ * Description for IP filter list entry.
3847
+ */
3476
3848
  description?: string;
3849
+ /**
3850
+ * CIDR address block.
3851
+ */
3477
3852
  network: string;
3478
3853
  }
3479
3854
  export interface PgPgUserConfigMigration {
3855
+ /**
3856
+ * Primary PostgreSQL database name
3857
+ */
3480
3858
  dbname?: string;
3481
3859
  host: string;
3860
+ /**
3861
+ * Comma-separated list of databases, which should be ignored during migration (supported by MySQL and PostgreSQL only at the moment).
3862
+ */
3482
3863
  ignoreDbs?: string;
3864
+ /**
3865
+ * The migration method to be used (currently supported only by Redis, MySQL and PostgreSQL service types).
3866
+ */
3483
3867
  method?: string;
3868
+ /**
3869
+ * PostgreSQL admin user password
3870
+ */
3484
3871
  password?: string;
3485
3872
  port: number;
3486
3873
  ssl?: boolean;
3874
+ /**
3875
+ * User name for authentication with the server where to migrate data from.
3876
+ */
3487
3877
  username?: string;
3488
3878
  }
3489
3879
  export interface PgPgUserConfigPg {
3880
+ /**
3881
+ * Specifies a fraction of the table size to add to autovacuum*analyze*threshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size).
3882
+ */
3490
3883
  autovacuumAnalyzeScaleFactor?: number;
3884
+ /**
3885
+ * Specifies the minimum number of inserted, updated or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples.
3886
+ */
3491
3887
  autovacuumAnalyzeThreshold?: number;
3888
+ /**
3889
+ * Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. Note that the system will launch autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. This parameter will cause the server to be restarted.
3890
+ */
3492
3891
  autovacuumFreezeMaxAge?: number;
3892
+ /**
3893
+ * Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is three. This parameter can only be set at server start.
3894
+ */
3493
3895
  autovacuumMaxWorkers?: number;
3896
+ /**
3897
+ * Specifies the minimum delay between autovacuum runs on any given database. The delay is measured in seconds, and the default is one minute.
3898
+ */
3494
3899
  autovacuumNaptime?: number;
3900
+ /**
3901
+ * Specifies the cost delay value that will be used in automatic VACUUM operations. If -1 is specified, the regular vacuum*cost*delay value will be used. The default value is 20 milliseconds.
3902
+ */
3495
3903
  autovacuumVacuumCostDelay?: number;
3904
+ /**
3905
+ * Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuum*cost*limit value will be used.
3906
+ */
3496
3907
  autovacuumVacuumCostLimit?: number;
3908
+ /**
3909
+ * Specifies a fraction of the table size to add to autovacuum*vacuum*threshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size).
3910
+ */
3497
3911
  autovacuumVacuumScaleFactor?: number;
3912
+ /**
3913
+ * Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples.
3914
+ */
3498
3915
  autovacuumVacuumThreshold?: number;
3916
+ /**
3917
+ * Specifies the delay between activity rounds for the background writer in milliseconds. Default is 200.
3918
+ */
3499
3919
  bgwriterDelay?: number;
3920
+ /**
3921
+ * Whenever more than bgwriter*flush*after bytes have been written by the background writer, attempt to force the OS to issue these writes to the underlying storage. Specified in kilobytes, default is 512. Setting of 0 disables forced writeback.
3922
+ */
3500
3923
  bgwriterFlushAfter?: number;
3924
+ /**
3925
+ * In each round, no more than this many buffers will be written by the background writer. Setting this to zero disables background writing. Default is 100.
3926
+ */
3501
3927
  bgwriterLruMaxpages?: number;
3928
+ /**
3929
+ * The average recent need for new buffers is multiplied by bgwriter*lru*multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter*lru*maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0.
3930
+ */
3502
3931
  bgwriterLruMultiplier?: number;
3932
+ /**
3933
+ * This is the amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition.
3934
+ */
3503
3935
  deadlockTimeout?: number;
3936
+ /**
3937
+ * Specifies the default TOAST compression method for values of compressible columns (the default is lz4).
3938
+ */
3504
3939
  defaultToastCompression?: string;
3940
+ /**
3941
+ * Time out sessions with open transactions after this number of milliseconds.
3942
+ */
3505
3943
  idleInTransactionSessionTimeout?: number;
3944
+ /**
3945
+ * Controls system-wide use of Just-in-Time Compilation (JIT).
3946
+ */
3506
3947
  jit?: boolean;
3948
+ /**
3949
+ * Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one (the default) disables logging autovacuum actions.
3950
+ */
3507
3951
  logAutovacuumMinDuration?: number;
3952
+ /**
3953
+ * Controls the amount of detail written in the server log for each message that is logged.
3954
+ */
3508
3955
  logErrorVerbosity?: string;
3956
+ /**
3957
+ * Choose from one of the available log-formats. These can support popular log analyzers like pgbadger, pganalyze etc.
3958
+ */
3509
3959
  logLinePrefix?: string;
3960
+ /**
3961
+ * Log statements that take more than this number of milliseconds to run, -1 disables.
3962
+ */
3510
3963
  logMinDurationStatement?: number;
3964
+ /**
3965
+ * Log statements for each temporary file created larger than this number of kilobytes, -1 disables.
3966
+ */
3511
3967
  logTempFiles?: number;
3968
+ /**
3969
+ * PostgreSQL maximum number of files that can be open per process.
3970
+ */
3512
3971
  maxFilesPerProcess?: number;
3972
+ /**
3973
+ * PostgreSQL maximum locks per transaction.
3974
+ */
3513
3975
  maxLocksPerTransaction?: number;
3976
+ /**
3977
+ * PostgreSQL maximum logical replication workers (taken from the pool of max*parallel*workers).
3978
+ */
3514
3979
  maxLogicalReplicationWorkers?: number;
3980
+ /**
3981
+ * Sets the maximum number of workers that the system can support for parallel queries.
3982
+ */
3515
3983
  maxParallelWorkers?: number;
3984
+ /**
3985
+ * Sets the maximum number of workers that can be started by a single Gather or Gather Merge node.
3986
+ */
3516
3987
  maxParallelWorkersPerGather?: number;
3988
+ /**
3989
+ * PostgreSQL maximum predicate locks per transaction.
3990
+ */
3517
3991
  maxPredLocksPerTransaction?: number;
3992
+ /**
3993
+ * PostgreSQL maximum prepared transactions.
3994
+ */
3518
3995
  maxPreparedTransactions?: number;
3996
+ /**
3997
+ * PostgreSQL maximum replication slots.
3998
+ */
3519
3999
  maxReplicationSlots?: number;
4000
+ /**
4001
+ * PostgreSQL maximum WAL size (MB) reserved for replication slots. Default is -1 (unlimited). wal*keep*size minimum WAL size setting takes precedence over this.
4002
+ */
3520
4003
  maxSlotWalKeepSize?: number;
4004
+ /**
4005
+ * Maximum depth of the stack in bytes.
4006
+ */
3521
4007
  maxStackDepth?: number;
4008
+ /**
4009
+ * Max standby archive delay in milliseconds.
4010
+ */
3522
4011
  maxStandbyArchiveDelay?: number;
4012
+ /**
4013
+ * Max standby streaming delay in milliseconds.
4014
+ */
3523
4015
  maxStandbyStreamingDelay?: number;
4016
+ /**
4017
+ * PostgreSQL maximum WAL senders.
4018
+ */
3524
4019
  maxWalSenders?: number;
4020
+ /**
4021
+ * Sets the maximum number of background processes that the system can support.
4022
+ */
3525
4023
  maxWorkerProcesses?: number;
4024
+ /**
4025
+ * Sets the time interval to run pg_partman's scheduled tasks.
4026
+ */
3526
4027
  pgPartmanBgwDotInterval?: number;
4028
+ /**
4029
+ * Controls which role to use for pg_partman's scheduled background tasks.
4030
+ */
3527
4031
  pgPartmanBgwDotRole?: string;
4032
+ /**
4033
+ * Enables or disables query plan monitoring.
4034
+ */
3528
4035
  pgStatMonitorDotPgsmEnableQueryPlan?: boolean;
4036
+ /**
4037
+ * Sets the maximum number of buckets .
4038
+ */
3529
4039
  pgStatMonitorDotPgsmMaxBuckets?: number;
4040
+ /**
4041
+ * Controls which statements are counted. Specify top to track top-level statements (those issued directly by clients), all to also track nested statements (such as statements invoked within functions), or none to disable statement statistics collection. The default value is top.
4042
+ */
3530
4043
  pgStatStatementsDotTrack?: string;
4044
+ /**
4045
+ * PostgreSQL temporary file limit in KiB, -1 for unlimited.
4046
+ */
3531
4047
  tempFileLimit?: number;
4048
+ /**
4049
+ * PostgreSQL service timezone.
4050
+ */
3532
4051
  timezone?: string;
4052
+ /**
4053
+ * Specifies the number of bytes reserved to track the currently executing command for each active session.
4054
+ */
3533
4055
  trackActivityQuerySize?: number;
4056
+ /**
4057
+ * Record commit time of transactions.
4058
+ */
3534
4059
  trackCommitTimestamp?: string;
4060
+ /**
4061
+ * Enables tracking of function call counts and time used.
4062
+ */
3535
4063
  trackFunctions?: string;
4064
+ /**
4065
+ * Enables timing of database I/O calls. This parameter is off by default, because it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms.
4066
+ */
3536
4067
  trackIoTiming?: string;
4068
+ /**
4069
+ * Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout.
4070
+ */
3537
4071
  walSenderTimeout?: number;
4072
+ /**
4073
+ * WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance.
4074
+ */
3538
4075
  walWriterDelay?: number;
3539
4076
  }
3540
4077
  export interface PgPgUserConfigPgbouncer {
4078
+ /**
4079
+ * If the automatically created database pools have been unused this many seconds, they are freed. If 0 then timeout is disabled. (seconds).
4080
+ */
3541
4081
  autodbIdleTimeout?: number;
4082
+ /**
4083
+ * Do not allow more than this many server connections per database (regardless of user). Setting it to 0 means unlimited.
4084
+ */
3542
4085
  autodbMaxDbConnections?: number;
4086
+ /**
4087
+ * PGBouncer pool mode.
4088
+ */
3543
4089
  autodbPoolMode?: string;
4090
+ /**
4091
+ * If non-zero then create automatically a pool of that size per user when a pool doesn't exist.
4092
+ */
3544
4093
  autodbPoolSize?: number;
4094
+ /**
4095
+ * List of parameters to ignore when given in startup packet.
4096
+ */
3545
4097
  ignoreStartupParameters?: string[];
4098
+ /**
4099
+ * Add more server connections to pool if below this number. Improves behavior when usual load comes suddenly back after period of total inactivity. The value is effectively capped at the pool size.
4100
+ */
3546
4101
  minPoolSize?: number;
4102
+ /**
4103
+ * If a server connection has been idle more than this many seconds it will be dropped. If 0 then timeout is disabled. (seconds).
4104
+ */
3547
4105
  serverIdleTimeout?: number;
4106
+ /**
4107
+ * The pooler will close an unused server connection that has been connected longer than this. (seconds).
4108
+ */
3548
4109
  serverLifetime?: number;
4110
+ /**
4111
+ * Run server*reset*query (DISCARD ALL) in all pooling modes.
4112
+ */
3549
4113
  serverResetQueryAlways?: boolean;
3550
4114
  }
3551
4115
  export interface PgPgUserConfigPglookout {
4116
+ /**
4117
+ * Number of seconds of master unavailability before triggering database failover to standby. The default value is `60`.
4118
+ */
3552
4119
  maxFailoverReplicationTimeLag?: number;
3553
4120
  }
3554
4121
  export interface PgPgUserConfigPrivateAccess {
3555
4122
  /**
3556
- * PostgreSQL specific server provided values
4123
+ * postgresql.conf configuration values.
3557
4124
  */
3558
4125
  pg?: boolean;
4126
+ /**
4127
+ * PGBouncer connection pooling settings.
4128
+ */
3559
4129
  pgbouncer?: boolean;
4130
+ /**
4131
+ * Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
4132
+ */
3560
4133
  prometheus?: boolean;
3561
4134
  }
3562
4135
  export interface PgPgUserConfigPrivatelinkAccess {
3563
4136
  /**
3564
- * PostgreSQL specific server provided values
4137
+ * postgresql.conf configuration values.
3565
4138
  */
3566
4139
  pg?: boolean;
4140
+ /**
4141
+ * PGBouncer connection pooling settings.
4142
+ */
3567
4143
  pgbouncer?: boolean;
4144
+ /**
4145
+ * Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
4146
+ */
3568
4147
  prometheus?: boolean;
3569
4148
  }
3570
4149
  export interface PgPgUserConfigPublicAccess {
3571
4150
  /**
3572
- * PostgreSQL specific server provided values
4151
+ * postgresql.conf configuration values.
3573
4152
  */
3574
4153
  pg?: boolean;
4154
+ /**
4155
+ * PGBouncer connection pooling settings.
4156
+ */
3575
4157
  pgbouncer?: boolean;
4158
+ /**
4159
+ * Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
4160
+ */
3576
4161
  prometheus?: boolean;
3577
4162
  }
3578
4163
  export interface PgPgUserConfigTimescaledb {
4164
+ /**
4165
+ * The number of background workers for timescaledb operations. You should configure this setting to the sum of your number of databases and the total number of concurrent background workers you want running at any given point in time.
4166
+ */
3579
4167
  maxBackgroundWorkers?: number;
3580
4168
  }
3581
4169
  export interface PgServiceIntegration {
@@ -3688,25 +4276,73 @@ export interface ServiceIntegrationClickhouseKafkaUserConfig {
3688
4276
  tables?: outputs.ServiceIntegrationClickhouseKafkaUserConfigTable[];
3689
4277
  }
3690
4278
  export interface ServiceIntegrationClickhouseKafkaUserConfigTable {
4279
+ /**
4280
+ * Action to take when there is no initial offset in offset store or the desired offset is out of range. The default value is `earliest`.
4281
+ */
3691
4282
  autoOffsetReset?: string;
4283
+ /**
4284
+ * Table columns.
4285
+ */
3692
4286
  columns?: outputs.ServiceIntegrationClickhouseKafkaUserConfigTableColumn[];
4287
+ /**
4288
+ * Message data format. The default value is `JSONEachRow`.
4289
+ */
3693
4290
  dataFormat: string;
4291
+ /**
4292
+ * Method to read DateTime from text input formats. The default value is `basic`.
4293
+ */
3694
4294
  dateTimeInputFormat?: string;
4295
+ /**
4296
+ * Kafka consumers group. The default value is `clickhouse`.
4297
+ */
3695
4298
  groupName: string;
4299
+ /**
4300
+ * How to handle errors for Kafka engine. The default value is `default`.
4301
+ */
3696
4302
  handleErrorMode?: string;
4303
+ /**
4304
+ * Number of row collected by poll(s) for flushing data from Kafka. The default value is `0`.
4305
+ */
3697
4306
  maxBlockSize?: number;
4307
+ /**
4308
+ * The maximum number of rows produced in one kafka message for row-based formats. The default value is `1`.
4309
+ */
3698
4310
  maxRowsPerMessage?: number;
4311
+ /**
4312
+ * Column name.
4313
+ */
3699
4314
  name: string;
4315
+ /**
4316
+ * The number of consumers per table per replica. The default value is `1`.
4317
+ */
3700
4318
  numConsumers?: number;
4319
+ /**
4320
+ * Maximum amount of messages to be polled in a single Kafka poll. The default value is `0`.
4321
+ */
3701
4322
  pollMaxBatchSize?: number;
4323
+ /**
4324
+ * Skip at least this number of broken messages from Kafka topic per block. The default value is `0`.
4325
+ */
3702
4326
  skipBrokenMessages?: number;
4327
+ /**
4328
+ * Kafka topics.
4329
+ */
3703
4330
  topics?: outputs.ServiceIntegrationClickhouseKafkaUserConfigTableTopic[];
3704
4331
  }
3705
4332
  export interface ServiceIntegrationClickhouseKafkaUserConfigTableColumn {
4333
+ /**
4334
+ * Column name.
4335
+ */
3706
4336
  name: string;
4337
+ /**
4338
+ * Column type.
4339
+ */
3707
4340
  type: string;
3708
4341
  }
3709
4342
  export interface ServiceIntegrationClickhouseKafkaUserConfigTableTopic {
4343
+ /**
4344
+ * Column name.
4345
+ */
3710
4346
  name: string;
3711
4347
  }
3712
4348
  export interface ServiceIntegrationClickhousePostgresqlUserConfig {
@@ -3716,7 +4352,13 @@ export interface ServiceIntegrationClickhousePostgresqlUserConfig {
3716
4352
  databases?: outputs.ServiceIntegrationClickhousePostgresqlUserConfigDatabase[];
3717
4353
  }
3718
4354
  export interface ServiceIntegrationClickhousePostgresqlUserConfigDatabase {
4355
+ /**
4356
+ * PostgreSQL database to expose. The default value is `defaultdb`.
4357
+ */
3719
4358
  database?: string;
4359
+ /**
4360
+ * PostgreSQL schema to expose. The default value is `public`.
4361
+ */
3720
4362
  schema?: string;
3721
4363
  }
3722
4364
  export interface ServiceIntegrationDatadogUserConfig {
@@ -3762,15 +4404,33 @@ export interface ServiceIntegrationDatadogUserConfig {
3762
4404
  redis?: outputs.ServiceIntegrationDatadogUserConfigRedis;
3763
4405
  }
3764
4406
  export interface ServiceIntegrationDatadogUserConfigDatadogTag {
4407
+ /**
4408
+ * Optional tag explanation.
4409
+ */
3765
4410
  comment?: string;
4411
+ /**
4412
+ * Tag format and usage are described here: https://docs.datadoghq.com/getting_started/tagging. Tags with prefix 'aiven-' are reserved for Aiven.
4413
+ */
3766
4414
  tag: string;
3767
4415
  }
3768
4416
  export interface ServiceIntegrationDatadogUserConfigOpensearch {
4417
+ /**
4418
+ * Enable Datadog Opensearch Index Monitoring.
4419
+ */
3769
4420
  indexStatsEnabled?: boolean;
4421
+ /**
4422
+ * Enable Datadog Opensearch Pending Task Monitoring.
4423
+ */
3770
4424
  pendingTaskStatsEnabled?: boolean;
4425
+ /**
4426
+ * Enable Datadog Opensearch Primary Shard Monitoring.
4427
+ */
3771
4428
  pshardStatsEnabled?: boolean;
3772
4429
  }
3773
4430
  export interface ServiceIntegrationDatadogUserConfigRedis {
4431
+ /**
4432
+ * Enable commandStats option in the agent's configuration. The default value is `false`.
4433
+ */
3774
4434
  commandStatsEnabled?: boolean;
3775
4435
  }
3776
4436
  export interface ServiceIntegrationEndpointDatadogUserConfig {
@@ -3804,7 +4464,13 @@ export interface ServiceIntegrationEndpointDatadogUserConfig {
3804
4464
  site?: string;
3805
4465
  }
3806
4466
  export interface ServiceIntegrationEndpointDatadogUserConfigDatadogTag {
4467
+ /**
4468
+ * Optional tag explanation.
4469
+ */
3807
4470
  comment?: string;
4471
+ /**
4472
+ * Tag format and usage are described here: https://docs.datadoghq.com/getting_started/tagging. Tags with prefix 'aiven-' are reserved for Aiven.
4473
+ */
3808
4474
  tag: string;
3809
4475
  }
3810
4476
  export interface ServiceIntegrationEndpointExternalAwsCloudwatchLogsUserConfig {
@@ -4026,11 +4692,23 @@ export interface ServiceIntegrationExternalAwsCloudwatchMetricsUserConfig {
4026
4692
  extraMetrics?: outputs.ServiceIntegrationExternalAwsCloudwatchMetricsUserConfigExtraMetric[];
4027
4693
  }
4028
4694
  export interface ServiceIntegrationExternalAwsCloudwatchMetricsUserConfigDroppedMetric {
4695
+ /**
4696
+ * Identifier of a value in the metric.
4697
+ */
4029
4698
  field: string;
4699
+ /**
4700
+ * Identifier of the metric.
4701
+ */
4030
4702
  metric: string;
4031
4703
  }
4032
4704
  export interface ServiceIntegrationExternalAwsCloudwatchMetricsUserConfigExtraMetric {
4705
+ /**
4706
+ * Identifier of a value in the metric.
4707
+ */
4033
4708
  field: string;
4709
+ /**
4710
+ * Identifier of the metric.
4711
+ */
4034
4712
  metric: string;
4035
4713
  }
4036
4714
  export interface ServiceIntegrationKafkaConnectUserConfig {
@@ -4040,9 +4718,21 @@ export interface ServiceIntegrationKafkaConnectUserConfig {
4040
4718
  kafkaConnect?: outputs.ServiceIntegrationKafkaConnectUserConfigKafkaConnect;
4041
4719
  }
4042
4720
  export interface ServiceIntegrationKafkaConnectUserConfigKafkaConnect {
4721
+ /**
4722
+ * The name of the topic where connector and task configuration data are stored.This must be the same for all workers with the same group_id.
4723
+ */
4043
4724
  configStorageTopic?: string;
4725
+ /**
4726
+ * A unique string that identifies the Connect cluster group this worker belongs to.
4727
+ */
4044
4728
  groupId?: string;
4729
+ /**
4730
+ * The name of the topic where connector and task configuration offsets are stored.This must be the same for all workers with the same group_id.
4731
+ */
4045
4732
  offsetStorageTopic?: string;
4733
+ /**
4734
+ * The name of the topic where connector and task configuration status updates are stored.This must be the same for all workers with the same group_id.
4735
+ */
4046
4736
  statusStorageTopic?: string;
4047
4737
  }
4048
4738
  export interface ServiceIntegrationKafkaLogsUserConfig {
@@ -4066,11 +4756,29 @@ export interface ServiceIntegrationKafkaMirrormakerUserConfig {
4066
4756
  kafkaMirrormaker?: outputs.ServiceIntegrationKafkaMirrormakerUserConfigKafkaMirrormaker;
4067
4757
  }
4068
4758
  export interface ServiceIntegrationKafkaMirrormakerUserConfigKafkaMirrormaker {
4759
+ /**
4760
+ * The minimum amount of data the server should return for a fetch request.
4761
+ */
4069
4762
  consumerFetchMinBytes?: number;
4763
+ /**
4764
+ * The batch size in bytes producer will attempt to collect before publishing to broker.
4765
+ */
4070
4766
  producerBatchSize?: number;
4767
+ /**
4768
+ * The amount of bytes producer can use for buffering data before publishing to broker.
4769
+ */
4071
4770
  producerBufferMemory?: number;
4771
+ /**
4772
+ * Specify the default compression type for producers. This configuration accepts the standard compression codecs ('gzip', 'snappy', 'lz4', 'zstd'). It additionally accepts 'none' which is the default and equivalent to no compression.
4773
+ */
4072
4774
  producerCompressionType?: string;
4775
+ /**
4776
+ * The linger time (ms) for waiting new data to arrive for publishing.
4777
+ */
4073
4778
  producerLingerMs?: number;
4779
+ /**
4780
+ * The maximum request size in bytes.
4781
+ */
4074
4782
  producerMaxRequestSize?: number;
4075
4783
  }
4076
4784
  export interface ServiceIntegrationLogsUserConfig {
@@ -4110,21 +4818,66 @@ export interface ServiceIntegrationMetricsUserConfig {
4110
4818
  username?: string;
4111
4819
  }
4112
4820
  export interface ServiceIntegrationMetricsUserConfigSourceMysql {
4821
+ /**
4822
+ * Configuration options for Telegraf MySQL input plugin.
4823
+ */
4113
4824
  telegraf?: outputs.ServiceIntegrationMetricsUserConfigSourceMysqlTelegraf;
4114
4825
  }
4115
4826
  export interface ServiceIntegrationMetricsUserConfigSourceMysqlTelegraf {
4827
+ /**
4828
+ * Gather metrics from PERFORMANCE*SCHEMA.EVENT*WAITS.
4829
+ */
4116
4830
  gatherEventWaits?: boolean;
4831
+ /**
4832
+ * gather metrics from PERFORMANCE*SCHEMA.FILE*SUMMARY*BY*EVENT_NAME.
4833
+ */
4117
4834
  gatherFileEventsStats?: boolean;
4835
+ /**
4836
+ * Gather metrics from PERFORMANCE*SCHEMA.TABLE*IO*WAITS*SUMMARY*BY*INDEX_USAGE.
4837
+ */
4118
4838
  gatherIndexIoWaits?: boolean;
4839
+ /**
4840
+ * Gather autoIncrement columns and max values from information schema.
4841
+ */
4119
4842
  gatherInfoSchemaAutoInc?: boolean;
4843
+ /**
4844
+ * Gather metrics from INFORMATION*SCHEMA.INNODB*METRICS.
4845
+ */
4120
4846
  gatherInnodbMetrics?: boolean;
4847
+ /**
4848
+ * Gather metrics from PERFORMANCE*SCHEMA.EVENTS*STATEMENTS*SUMMARY*BY_DIGEST.
4849
+ */
4121
4850
  gatherPerfEventsStatements?: boolean;
4851
+ /**
4852
+ * Gather thread state counts from INFORMATION_SCHEMA.PROCESSLIST.
4853
+ */
4122
4854
  gatherProcessList?: boolean;
4855
+ /**
4856
+ * Gather metrics from SHOW SLAVE STATUS command output.
4857
+ */
4123
4858
  gatherSlaveStatus?: boolean;
4859
+ /**
4860
+ * Gather metrics from PERFORMANCE*SCHEMA.TABLE*IO*WAITS*SUMMARY*BY*TABLE.
4861
+ */
4124
4862
  gatherTableIoWaits?: boolean;
4863
+ /**
4864
+ * Gather metrics from PERFORMANCE*SCHEMA.TABLE*LOCK_WAITS.
4865
+ */
4125
4866
  gatherTableLockWaits?: boolean;
4867
+ /**
4868
+ * Gather metrics from INFORMATION_SCHEMA.TABLES.
4869
+ */
4126
4870
  gatherTableSchema?: boolean;
4871
+ /**
4872
+ * Truncates digest text from perf*events*statements into this many characters.
4873
+ */
4127
4874
  perfEventsStatementsDigestTextLimit?: number;
4875
+ /**
4876
+ * Limits metrics from perf*events*statements.
4877
+ */
4128
4878
  perfEventsStatementsLimit?: number;
4879
+ /**
4880
+ * Only include perf*events*statements whose last seen is less than this many seconds.
4881
+ */
4129
4882
  perfEventsStatementsTimeLimit?: number;
4130
4883
  }