@rio-cloud/cdk-v2-constructs 4.31.2 → 4.33.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.
package/.jsii CHANGED
@@ -3668,7 +3668,7 @@
3668
3668
  },
3669
3669
  "name": "@rio-cloud/cdk-v2-constructs",
3670
3670
  "readme": {
3671
- "markdown": "# RIO CDK Constructs\n\nThis package contains CDK2 constructs for RIO teams.\n\n> NPM: `@rio-cloud/cdk-v2-constructs`\n\n## Bootstrapping of CDK project\n\n```\n$ npx cdk init --language typescript\n```\n\n## Installation\n\n```\n$ npm install --save @rio-cloud/cdk-v2-constructs\n```\n\n## See also\n\n * [How to contribut](./CONTRIBUTION.md)\n * [Changelog](./CHANGELOG.md)\n * [brief API desciption](./API.md)\n\n## Internal documentation for library devs\n[Documentation](./developers-readme.md)\n\n## FAQ's\n- How can I udpate the thresholds of monitors created by watchful?\n\n There is an `overrideAlarmThreshold` method which can be used to override the default watchful thresholds. Please make aure to use the method before the `watchscope` function.\n Eg -\n ```\n ...\n const dw = new Watchful(stack, 'Watchful', {});\n dw.overrideAlarmThreshold({\n monitoredResourceScope: lambdaA,\n monitorType: MonitorType.ERRORS,\n threshold: 5,\n });\n dw.watchScope(stack);\n ```"
3671
+ "markdown": "# RIO CDK Constructs\n\nThis package contains CDK2 constructs for RIO teams.\n\n> NPM: `@rio-cloud/cdk-v2-constructs`\n\n## Bootstrapping of CDK project\n\n```\n$ npx cdk init --language typescript\n```\n\n## Installation\n\n```\n$ npm install --save @rio-cloud/cdk-v2-constructs\n```\n\n## See also\n\n * [How to contribute](./CONTRIBUTION.md)\n * [Changelog](./CHANGELOG.md)\n * [brief API description](./API.md)\n\n## Internal documentation for library devs\n[Documentation](./developers-readme.md)\n\n## FAQ's\n- How can I update the thresholds of monitors created by watchful?\n\n There is an `overrideAlarmThreshold` method which can be used to override the default watchful thresholds. Please make aure to use the method before the `watchscope` function.\n Eg -\n ```\n ...\n const dw = new Watchful(stack, 'Watchful', {});\n dw.overrideAlarmThreshold({\n monitoredResourceScope: lambdaA,\n monitorType: MonitorType.ERRORS,\n threshold: 5,\n });\n dw.watchScope(stack);\n ```"
3672
3672
  },
3673
3673
  "repository": {
3674
3674
  "type": "git",
@@ -4318,9 +4318,9 @@
4318
4318
  "assembly": "@rio-cloud/cdk-v2-constructs",
4319
4319
  "base": "constructs.Construct",
4320
4320
  "docs": {
4321
- "remarks": "The construct creates monitoring for detecting ECS containers that were stopped abruptly for reasons such as,\nout of memory, failed health checks.\n\nThe monitor will consume the ECS events and send them to a CloudWatch log group, which are forwarded to Datadog for\nbetter analyses and trigger an alert.\n\nMore details on the AWS ECS events can be found here:\n{@link https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_cwe_events.html}\n\nThis monitor adds transparency to such cases, which otherwise would happen without being noticed and could escalate\nto bigger issues, like a service being that requires more resources.",
4321
+ "remarks": "The construct creates monitoring for detecting ECS containers that were stopped abruptly by AWS for reasons such as,\nout of memory, or failed health checks.\n\nThis monitor adds transparency to such cases, which otherwise would happen without being noticed and could escalate\nto bigger issues, like a service that requires more resources to run properly.\n\nThe construct will consume the ECS events and send them to a CloudWatch log group, which are forwarded to Datadog,\nallowing better analyses since AWS keeps the stopped task details for only one hour and will be used to create a\nmonitor.\n\nContributions are more than welcome, please get in touch with Team Outbound to ensure compatibility.\n\nThis construct was based on an AWS blog post about ECS anomaly detection, see here:\n{@link https://aws.amazon.com/blogs/containers/amazon-elastic-container-service-anomaly-detection-using-amazon-eventbridge/}.\n\nMore details on the AWS ECS events can be found here:\n{@link https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_cwe_events.html}.",
4322
4322
  "stability": "stable",
4323
- "summary": "# WARNING: This construct is still on beta phase."
4323
+ "summary": "# WARNING: This construct is still in the beta phase."
4324
4324
  },
4325
4325
  "fqn": "@rio-cloud/cdk-v2-constructs.AwsEcsAbruptlyStoppedMonitor",
4326
4326
  "initializer": {
@@ -4329,7 +4329,7 @@
4329
4329
  },
4330
4330
  "locationInModule": {
4331
4331
  "filename": "src/contributions/team-oubout-order-book/aws-ecs-abruptly-stopped-monitor/aws-ecs-abruptly-stopped-monitor.ts",
4332
- "line": 31
4332
+ "line": 61
4333
4333
  },
4334
4334
  "parameters": [
4335
4335
  {
@@ -4355,7 +4355,7 @@
4355
4355
  "kind": "class",
4356
4356
  "locationInModule": {
4357
4357
  "filename": "src/contributions/team-oubout-order-book/aws-ecs-abruptly-stopped-monitor/aws-ecs-abruptly-stopped-monitor.ts",
4358
- "line": 30
4358
+ "line": 60
4359
4359
  },
4360
4360
  "name": "AwsEcsAbruptlyStoppedMonitor",
4361
4361
  "symbolId": "src/contributions/team-oubout-order-book/aws-ecs-abruptly-stopped-monitor/aws-ecs-abruptly-stopped-monitor:AwsEcsAbruptlyStoppedMonitor"
@@ -5814,29 +5814,34 @@
5814
5814
  {
5815
5815
  "abstract": true,
5816
5816
  "docs": {
5817
- "stability": "stable"
5817
+ "remarks": "Used to generate the monitor name as well a apply the `service` tag.",
5818
+ "stability": "stable",
5819
+ "summary": "The name of the service to which the monitor belongs."
5818
5820
  },
5819
5821
  "immutable": true,
5820
5822
  "locationInModule": {
5821
5823
  "filename": "src/contributions/team-oubout-order-book/aws-ecs-abruptly-stopped-monitor/aws-ecs-abruptly-stopped-monitor.ts",
5822
- "line": 7
5824
+ "line": 12
5823
5825
  },
5824
- "name": "notification",
5826
+ "name": "serviceName",
5825
5827
  "type": {
5826
- "fqn": "@rio-cloud/cdk-v2-constructs.datadogv2.INotification"
5828
+ "primitive": "string"
5827
5829
  }
5828
5830
  },
5829
5831
  {
5830
5832
  "abstract": true,
5831
5833
  "docs": {
5832
- "stability": "stable"
5834
+ "remarks": "If no cluster is provided, the monitor will consume ECS events for all clusters within the account.",
5835
+ "stability": "stable",
5836
+ "summary": "ARN of the cluster that should be monitored, consuming only ECS events belonging to the cluster."
5833
5837
  },
5834
5838
  "immutable": true,
5835
5839
  "locationInModule": {
5836
5840
  "filename": "src/contributions/team-oubout-order-book/aws-ecs-abruptly-stopped-monitor/aws-ecs-abruptly-stopped-monitor.ts",
5837
- "line": 6
5841
+ "line": 36
5838
5842
  },
5839
- "name": "serviceName",
5843
+ "name": "clusterArn",
5844
+ "optional": true,
5840
5845
  "type": {
5841
5846
  "primitive": "string"
5842
5847
  }
@@ -5844,19 +5849,38 @@
5844
5849
  {
5845
5850
  "abstract": true,
5846
5851
  "docs": {
5847
- "remarks": "If no cluster is provided, all ECS will be part of the monitor.",
5852
+ "default": "{@link DefaultSlackNotification }",
5853
+ "see": "https://docs.datadoghq.com/monitors/notify",
5848
5854
  "stability": "stable",
5849
- "summary": "ARN of the cluster that should be monitored."
5855
+ "summary": "To explicitly disable notifications use {@link NoNotification }."
5850
5856
  },
5851
5857
  "immutable": true,
5852
5858
  "locationInModule": {
5853
5859
  "filename": "src/contributions/team-oubout-order-book/aws-ecs-abruptly-stopped-monitor/aws-ecs-abruptly-stopped-monitor.ts",
5854
- "line": 12
5860
+ "line": 22
5855
5861
  },
5856
- "name": "clusterArn",
5862
+ "name": "notification",
5857
5863
  "optional": true,
5858
5864
  "type": {
5859
- "primitive": "string"
5865
+ "fqn": "@rio-cloud/cdk-v2-constructs.datadogv2.INotification"
5866
+ }
5867
+ },
5868
+ {
5869
+ "abstract": true,
5870
+ "docs": {
5871
+ "default": "{@link DatadogMonitor.DEFAULT_PRIORITY }",
5872
+ "stability": "stable",
5873
+ "summary": "The alert priority of the monitor."
5874
+ },
5875
+ "immutable": true,
5876
+ "locationInModule": {
5877
+ "filename": "src/contributions/team-oubout-order-book/aws-ecs-abruptly-stopped-monitor/aws-ecs-abruptly-stopped-monitor.ts",
5878
+ "line": 30
5879
+ },
5880
+ "name": "priority",
5881
+ "optional": true,
5882
+ "type": {
5883
+ "primitive": "number"
5860
5884
  }
5861
5885
  }
5862
5886
  ],
@@ -6127,7 +6151,7 @@
6127
6151
  "kind": "interface",
6128
6152
  "locationInModule": {
6129
6153
  "filename": "src/kafka/kafka-topic.ts",
6130
- "line": 54
6154
+ "line": 55
6131
6155
  },
6132
6156
  "name": "KafkaAclStatement",
6133
6157
  "properties": [
@@ -6140,7 +6164,7 @@
6140
6164
  "immutable": true,
6141
6165
  "locationInModule": {
6142
6166
  "filename": "src/kafka/kafka-topic.ts",
6143
- "line": 63
6167
+ "line": 64
6144
6168
  },
6145
6169
  "name": "read",
6146
6170
  "type": {
@@ -6161,7 +6185,7 @@
6161
6185
  "immutable": true,
6162
6186
  "locationInModule": {
6163
6187
  "filename": "src/kafka/kafka-topic.ts",
6164
- "line": 58
6188
+ "line": 59
6165
6189
  },
6166
6190
  "name": "write",
6167
6191
  "type": {
@@ -6172,6 +6196,29 @@
6172
6196
  "kind": "array"
6173
6197
  }
6174
6198
  }
6199
+ },
6200
+ {
6201
+ "abstract": true,
6202
+ "docs": {
6203
+ "remarks": "Attention: Only use Deletion policy if you know what you are doing!\nThis is only necessary for KStream and allows the application to delete messages and the topic.<br>\nIf you just want to \"delete\" a message on a log compacted topic, you should not set this permission and send a tombstone message instead.",
6204
+ "stability": "stable",
6205
+ "summary": "List of clients that should get delete permissions."
6206
+ },
6207
+ "immutable": true,
6208
+ "locationInModule": {
6209
+ "filename": "src/kafka/kafka-topic.ts",
6210
+ "line": 73
6211
+ },
6212
+ "name": "delete",
6213
+ "optional": true,
6214
+ "type": {
6215
+ "collection": {
6216
+ "elementtype": {
6217
+ "primitive": "string"
6218
+ },
6219
+ "kind": "array"
6220
+ }
6221
+ }
6175
6222
  }
6176
6223
  ],
6177
6224
  "symbolId": "src/kafka/kafka-topic:KafkaAclStatement"
@@ -6264,7 +6311,7 @@
6264
6311
  "kind": "class",
6265
6312
  "locationInModule": {
6266
6313
  "filename": "src/kafka/kafka-event-spec.ts",
6267
- "line": 52
6314
+ "line": 53
6268
6315
  },
6269
6316
  "methods": [
6270
6317
  {
@@ -6275,7 +6322,7 @@
6275
6322
  },
6276
6323
  "locationInModule": {
6277
6324
  "filename": "src/kafka/kafka-event-spec.ts",
6278
- "line": 59
6325
+ "line": 60
6279
6326
  },
6280
6327
  "name": "fromYamlFile",
6281
6328
  "parameters": [
@@ -6305,7 +6352,7 @@
6305
6352
  },
6306
6353
  "locationInModule": {
6307
6354
  "filename": "src/kafka/kafka-event-spec.ts",
6308
- "line": 69
6355
+ "line": 70
6309
6356
  },
6310
6357
  "name": "fromYamlString",
6311
6358
  "parameters": [
@@ -6333,7 +6380,7 @@
6333
6380
  },
6334
6381
  "locationInModule": {
6335
6382
  "filename": "src/kafka/kafka-event-spec.ts",
6336
- "line": 107
6383
+ "line": 108
6337
6384
  },
6338
6385
  "name": "toSnsMessage",
6339
6386
  "returns": {
@@ -6352,7 +6399,7 @@
6352
6399
  "immutable": true,
6353
6400
  "locationInModule": {
6354
6401
  "filename": "src/kafka/kafka-event-spec.ts",
6355
- "line": 98
6402
+ "line": 99
6356
6403
  },
6357
6404
  "name": "eventName",
6358
6405
  "type": {
@@ -6377,7 +6424,7 @@
6377
6424
  },
6378
6425
  "locationInModule": {
6379
6426
  "filename": "src/kafka/kafka-topic.ts",
6380
- "line": 219
6427
+ "line": 229
6381
6428
  },
6382
6429
  "parameters": [
6383
6430
  {
@@ -6403,7 +6450,7 @@
6403
6450
  "kind": "class",
6404
6451
  "locationInModule": {
6405
6452
  "filename": "src/kafka/kafka-topic.ts",
6406
- "line": 217
6453
+ "line": 227
6407
6454
  },
6408
6455
  "name": "KafkaTopic",
6409
6456
  "symbolId": "src/kafka/kafka-topic:KafkaTopic"
@@ -6419,7 +6466,7 @@
6419
6466
  "kind": "interface",
6420
6467
  "locationInModule": {
6421
6468
  "filename": "src/kafka/kafka-topic.ts",
6422
- "line": 9
6469
+ "line": 10
6423
6470
  },
6424
6471
  "name": "KafkaTopicMetaData",
6425
6472
  "properties": [
@@ -6433,7 +6480,7 @@
6433
6480
  "immutable": true,
6434
6481
  "locationInModule": {
6435
6482
  "filename": "src/kafka/kafka-topic.ts",
6436
- "line": 19
6483
+ "line": 20
6437
6484
  },
6438
6485
  "name": "description",
6439
6486
  "type": {
@@ -6449,7 +6496,7 @@
6449
6496
  "immutable": true,
6450
6497
  "locationInModule": {
6451
6498
  "filename": "src/kafka/kafka-topic.ts",
6452
- "line": 13
6499
+ "line": 14
6453
6500
  },
6454
6501
  "name": "events",
6455
6502
  "type": {
@@ -6475,7 +6522,7 @@
6475
6522
  "kind": "interface",
6476
6523
  "locationInModule": {
6477
6524
  "filename": "src/kafka/kafka-topic.ts",
6478
- "line": 25
6525
+ "line": 26
6479
6526
  },
6480
6527
  "name": "KafkaTopicMetaDataV4",
6481
6528
  "properties": [
@@ -6488,7 +6535,7 @@
6488
6535
  "immutable": true,
6489
6536
  "locationInModule": {
6490
6537
  "filename": "src/kafka/kafka-topic.ts",
6491
- "line": 41
6538
+ "line": 42
6492
6539
  },
6493
6540
  "name": "audience",
6494
6541
  "type": {
@@ -6505,7 +6552,7 @@
6505
6552
  "immutable": true,
6506
6553
  "locationInModule": {
6507
6554
  "filename": "src/kafka/kafka-topic.ts",
6508
- "line": 35
6555
+ "line": 36
6509
6556
  },
6510
6557
  "name": "description",
6511
6558
  "type": {
@@ -6521,7 +6568,7 @@
6521
6568
  "immutable": true,
6522
6569
  "locationInModule": {
6523
6570
  "filename": "src/kafka/kafka-topic.ts",
6524
- "line": 29
6571
+ "line": 30
6525
6572
  },
6526
6573
  "name": "events",
6527
6574
  "type": {
@@ -6542,7 +6589,7 @@
6542
6589
  "immutable": true,
6543
6590
  "locationInModule": {
6544
6591
  "filename": "src/kafka/kafka-topic.ts",
6545
- "line": 46
6592
+ "line": 47
6546
6593
  },
6547
6594
  "name": "recoveryPolicy",
6548
6595
  "type": {
@@ -6564,7 +6611,7 @@
6564
6611
  "kind": "interface",
6565
6612
  "locationInModule": {
6566
6613
  "filename": "src/kafka/kafka-topic.ts",
6567
- "line": 83
6614
+ "line": 93
6568
6615
  },
6569
6616
  "name": "KafkaTopicProps",
6570
6617
  "properties": [
@@ -6577,7 +6624,7 @@
6577
6624
  "immutable": true,
6578
6625
  "locationInModule": {
6579
6626
  "filename": "src/kafka/kafka-topic.ts",
6580
- "line": 126
6627
+ "line": 136
6581
6628
  },
6582
6629
  "name": "acl",
6583
6630
  "type": {
@@ -6593,7 +6640,7 @@
6593
6640
  "immutable": true,
6594
6641
  "locationInModule": {
6595
6642
  "filename": "src/kafka/kafka-topic.ts",
6596
- "line": 131
6643
+ "line": 141
6597
6644
  },
6598
6645
  "name": "isLogCompacted",
6599
6646
  "type": {
@@ -6609,7 +6656,7 @@
6609
6656
  "immutable": true,
6610
6657
  "locationInModule": {
6611
6658
  "filename": "src/kafka/kafka-topic.ts",
6612
- "line": 121
6659
+ "line": 131
6613
6660
  },
6614
6661
  "name": "metadata",
6615
6662
  "type": {
@@ -6626,7 +6673,7 @@
6626
6673
  "immutable": true,
6627
6674
  "locationInModule": {
6628
6675
  "filename": "src/kafka/kafka-topic.ts",
6629
- "line": 87
6676
+ "line": 97
6630
6677
  },
6631
6678
  "name": "name",
6632
6679
  "type": {
@@ -6643,7 +6690,7 @@
6643
6690
  "immutable": true,
6644
6691
  "locationInModule": {
6645
6692
  "filename": "src/kafka/kafka-topic.ts",
6646
- "line": 94
6693
+ "line": 104
6647
6694
  },
6648
6695
  "name": "numberOfPartitions",
6649
6696
  "type": {
@@ -6661,7 +6708,7 @@
6661
6708
  "immutable": true,
6662
6709
  "locationInModule": {
6663
6710
  "filename": "src/kafka/kafka-topic.ts",
6664
- "line": 116
6711
+ "line": 126
6665
6712
  },
6666
6713
  "name": "instantDeletionEnabled",
6667
6714
  "optional": true,
@@ -6679,7 +6726,7 @@
6679
6726
  "immutable": true,
6680
6727
  "locationInModule": {
6681
6728
  "filename": "src/kafka/kafka-topic.ts",
6682
- "line": 137
6729
+ "line": 147
6683
6730
  },
6684
6731
  "name": "logCompactionProperties",
6685
6732
  "optional": true,
@@ -6698,7 +6745,7 @@
6698
6745
  "immutable": true,
6699
6746
  "locationInModule": {
6700
6747
  "filename": "src/kafka/kafka-topic.ts",
6701
- "line": 100
6748
+ "line": 110
6702
6749
  },
6703
6750
  "name": "replicationFactor",
6704
6751
  "optional": true,
@@ -6717,7 +6764,7 @@
6717
6764
  "immutable": true,
6718
6765
  "locationInModule": {
6719
6766
  "filename": "src/kafka/kafka-topic.ts",
6720
- "line": 109
6767
+ "line": 119
6721
6768
  },
6722
6769
  "name": "retention",
6723
6770
  "optional": true,
@@ -6742,7 +6789,7 @@
6742
6789
  },
6743
6790
  "locationInModule": {
6744
6791
  "filename": "src/kafka/kafka-topic.ts",
6745
- "line": 242
6792
+ "line": 252
6746
6793
  },
6747
6794
  "parameters": [
6748
6795
  {
@@ -6768,7 +6815,7 @@
6768
6815
  "kind": "class",
6769
6816
  "locationInModule": {
6770
6817
  "filename": "src/kafka/kafka-topic.ts",
6771
- "line": 240
6818
+ "line": 250
6772
6819
  },
6773
6820
  "name": "KafkaTopicV4",
6774
6821
  "symbolId": "src/kafka/kafka-topic:KafkaTopicV4"
@@ -6785,7 +6832,7 @@
6785
6832
  "kind": "interface",
6786
6833
  "locationInModule": {
6787
6834
  "filename": "src/kafka/kafka-topic.ts",
6788
- "line": 145
6835
+ "line": 155
6789
6836
  },
6790
6837
  "name": "KafkaTopicV4Props",
6791
6838
  "properties": [
@@ -6798,7 +6845,7 @@
6798
6845
  "immutable": true,
6799
6846
  "locationInModule": {
6800
6847
  "filename": "src/kafka/kafka-topic.ts",
6801
- "line": 188
6848
+ "line": 198
6802
6849
  },
6803
6850
  "name": "acl",
6804
6851
  "type": {
@@ -6814,7 +6861,7 @@
6814
6861
  "immutable": true,
6815
6862
  "locationInModule": {
6816
6863
  "filename": "src/kafka/kafka-topic.ts",
6817
- "line": 193
6864
+ "line": 203
6818
6865
  },
6819
6866
  "name": "isLogCompacted",
6820
6867
  "type": {
@@ -6830,7 +6877,7 @@
6830
6877
  "immutable": true,
6831
6878
  "locationInModule": {
6832
6879
  "filename": "src/kafka/kafka-topic.ts",
6833
- "line": 183
6880
+ "line": 193
6834
6881
  },
6835
6882
  "name": "metadata",
6836
6883
  "type": {
@@ -6847,7 +6894,7 @@
6847
6894
  "immutable": true,
6848
6895
  "locationInModule": {
6849
6896
  "filename": "src/kafka/kafka-topic.ts",
6850
- "line": 149
6897
+ "line": 159
6851
6898
  },
6852
6899
  "name": "name",
6853
6900
  "type": {
@@ -6864,7 +6911,7 @@
6864
6911
  "immutable": true,
6865
6912
  "locationInModule": {
6866
6913
  "filename": "src/kafka/kafka-topic.ts",
6867
- "line": 156
6914
+ "line": 166
6868
6915
  },
6869
6916
  "name": "numberOfPartitions",
6870
6917
  "type": {
@@ -6882,7 +6929,7 @@
6882
6929
  "immutable": true,
6883
6930
  "locationInModule": {
6884
6931
  "filename": "src/kafka/kafka-topic.ts",
6885
- "line": 178
6932
+ "line": 188
6886
6933
  },
6887
6934
  "name": "instantDeletionEnabled",
6888
6935
  "optional": true,
@@ -6900,7 +6947,7 @@
6900
6947
  "immutable": true,
6901
6948
  "locationInModule": {
6902
6949
  "filename": "src/kafka/kafka-topic.ts",
6903
- "line": 199
6950
+ "line": 209
6904
6951
  },
6905
6952
  "name": "logCompactionProperties",
6906
6953
  "optional": true,
@@ -6919,7 +6966,7 @@
6919
6966
  "immutable": true,
6920
6967
  "locationInModule": {
6921
6968
  "filename": "src/kafka/kafka-topic.ts",
6922
- "line": 162
6969
+ "line": 172
6923
6970
  },
6924
6971
  "name": "replicationFactor",
6925
6972
  "optional": true,
@@ -6938,7 +6985,7 @@
6938
6985
  "immutable": true,
6939
6986
  "locationInModule": {
6940
6987
  "filename": "src/kafka/kafka-topic.ts",
6941
- "line": 171
6988
+ "line": 181
6942
6989
  },
6943
6990
  "name": "retention",
6944
6991
  "optional": true,
@@ -7321,7 +7368,7 @@
7321
7368
  "kind": "interface",
7322
7369
  "locationInModule": {
7323
7370
  "filename": "src/kafka/kafka-topic.ts",
7324
- "line": 69
7371
+ "line": 79
7325
7372
  },
7326
7373
  "name": "LogCompactionProperties",
7327
7374
  "properties": [
@@ -7336,7 +7383,7 @@
7336
7383
  "immutable": true,
7337
7384
  "locationInModule": {
7338
7385
  "filename": "src/kafka/kafka-topic.ts",
7339
- "line": 75
7386
+ "line": 85
7340
7387
  },
7341
7388
  "name": "deleteRetention",
7342
7389
  "optional": true,
@@ -14376,7 +14423,7 @@
14376
14423
  "kind": "interface",
14377
14424
  "locationInModule": {
14378
14425
  "filename": "src/kafka/kafka-topic.ts",
14379
- "line": 54
14426
+ "line": 55
14380
14427
  },
14381
14428
  "name": "KafkaAclStatement",
14382
14429
  "namespace": "kafka",
@@ -14390,7 +14437,7 @@
14390
14437
  "immutable": true,
14391
14438
  "locationInModule": {
14392
14439
  "filename": "src/kafka/kafka-topic.ts",
14393
- "line": 63
14440
+ "line": 64
14394
14441
  },
14395
14442
  "name": "read",
14396
14443
  "type": {
@@ -14411,7 +14458,7 @@
14411
14458
  "immutable": true,
14412
14459
  "locationInModule": {
14413
14460
  "filename": "src/kafka/kafka-topic.ts",
14414
- "line": 58
14461
+ "line": 59
14415
14462
  },
14416
14463
  "name": "write",
14417
14464
  "type": {
@@ -14422,6 +14469,29 @@
14422
14469
  "kind": "array"
14423
14470
  }
14424
14471
  }
14472
+ },
14473
+ {
14474
+ "abstract": true,
14475
+ "docs": {
14476
+ "remarks": "Attention: Only use Deletion policy if you know what you are doing!\nThis is only necessary for KStream and allows the application to delete messages and the topic.<br>\nIf you just want to \"delete\" a message on a log compacted topic, you should not set this permission and send a tombstone message instead.",
14477
+ "stability": "stable",
14478
+ "summary": "List of clients that should get delete permissions."
14479
+ },
14480
+ "immutable": true,
14481
+ "locationInModule": {
14482
+ "filename": "src/kafka/kafka-topic.ts",
14483
+ "line": 73
14484
+ },
14485
+ "name": "delete",
14486
+ "optional": true,
14487
+ "type": {
14488
+ "collection": {
14489
+ "elementtype": {
14490
+ "primitive": "string"
14491
+ },
14492
+ "kind": "array"
14493
+ }
14494
+ }
14425
14495
  }
14426
14496
  ],
14427
14497
  "symbolId": "src/kafka/kafka-topic:KafkaAclStatement"
@@ -14516,7 +14586,7 @@
14516
14586
  "kind": "class",
14517
14587
  "locationInModule": {
14518
14588
  "filename": "src/kafka/kafka-event-spec.ts",
14519
- "line": 52
14589
+ "line": 53
14520
14590
  },
14521
14591
  "methods": [
14522
14592
  {
@@ -14527,7 +14597,7 @@
14527
14597
  },
14528
14598
  "locationInModule": {
14529
14599
  "filename": "src/kafka/kafka-event-spec.ts",
14530
- "line": 59
14600
+ "line": 60
14531
14601
  },
14532
14602
  "name": "fromYamlFile",
14533
14603
  "parameters": [
@@ -14557,7 +14627,7 @@
14557
14627
  },
14558
14628
  "locationInModule": {
14559
14629
  "filename": "src/kafka/kafka-event-spec.ts",
14560
- "line": 69
14630
+ "line": 70
14561
14631
  },
14562
14632
  "name": "fromYamlString",
14563
14633
  "parameters": [
@@ -14585,7 +14655,7 @@
14585
14655
  },
14586
14656
  "locationInModule": {
14587
14657
  "filename": "src/kafka/kafka-event-spec.ts",
14588
- "line": 107
14658
+ "line": 108
14589
14659
  },
14590
14660
  "name": "toSnsMessage",
14591
14661
  "returns": {
@@ -14605,7 +14675,7 @@
14605
14675
  "immutable": true,
14606
14676
  "locationInModule": {
14607
14677
  "filename": "src/kafka/kafka-event-spec.ts",
14608
- "line": 98
14678
+ "line": 99
14609
14679
  },
14610
14680
  "name": "eventName",
14611
14681
  "type": {
@@ -14630,7 +14700,7 @@
14630
14700
  },
14631
14701
  "locationInModule": {
14632
14702
  "filename": "src/kafka/kafka-topic.ts",
14633
- "line": 219
14703
+ "line": 229
14634
14704
  },
14635
14705
  "parameters": [
14636
14706
  {
@@ -14656,7 +14726,7 @@
14656
14726
  "kind": "class",
14657
14727
  "locationInModule": {
14658
14728
  "filename": "src/kafka/kafka-topic.ts",
14659
- "line": 217
14729
+ "line": 227
14660
14730
  },
14661
14731
  "name": "KafkaTopic",
14662
14732
  "namespace": "kafka",
@@ -14673,7 +14743,7 @@
14673
14743
  "kind": "interface",
14674
14744
  "locationInModule": {
14675
14745
  "filename": "src/kafka/kafka-topic.ts",
14676
- "line": 9
14746
+ "line": 10
14677
14747
  },
14678
14748
  "name": "KafkaTopicMetaData",
14679
14749
  "namespace": "kafka",
@@ -14688,7 +14758,7 @@
14688
14758
  "immutable": true,
14689
14759
  "locationInModule": {
14690
14760
  "filename": "src/kafka/kafka-topic.ts",
14691
- "line": 19
14761
+ "line": 20
14692
14762
  },
14693
14763
  "name": "description",
14694
14764
  "type": {
@@ -14704,7 +14774,7 @@
14704
14774
  "immutable": true,
14705
14775
  "locationInModule": {
14706
14776
  "filename": "src/kafka/kafka-topic.ts",
14707
- "line": 13
14777
+ "line": 14
14708
14778
  },
14709
14779
  "name": "events",
14710
14780
  "type": {
@@ -14730,7 +14800,7 @@
14730
14800
  "kind": "interface",
14731
14801
  "locationInModule": {
14732
14802
  "filename": "src/kafka/kafka-topic.ts",
14733
- "line": 25
14803
+ "line": 26
14734
14804
  },
14735
14805
  "name": "KafkaTopicMetaDataV4",
14736
14806
  "namespace": "kafka",
@@ -14744,7 +14814,7 @@
14744
14814
  "immutable": true,
14745
14815
  "locationInModule": {
14746
14816
  "filename": "src/kafka/kafka-topic.ts",
14747
- "line": 41
14817
+ "line": 42
14748
14818
  },
14749
14819
  "name": "audience",
14750
14820
  "type": {
@@ -14761,7 +14831,7 @@
14761
14831
  "immutable": true,
14762
14832
  "locationInModule": {
14763
14833
  "filename": "src/kafka/kafka-topic.ts",
14764
- "line": 35
14834
+ "line": 36
14765
14835
  },
14766
14836
  "name": "description",
14767
14837
  "type": {
@@ -14777,7 +14847,7 @@
14777
14847
  "immutable": true,
14778
14848
  "locationInModule": {
14779
14849
  "filename": "src/kafka/kafka-topic.ts",
14780
- "line": 29
14850
+ "line": 30
14781
14851
  },
14782
14852
  "name": "events",
14783
14853
  "type": {
@@ -14798,7 +14868,7 @@
14798
14868
  "immutable": true,
14799
14869
  "locationInModule": {
14800
14870
  "filename": "src/kafka/kafka-topic.ts",
14801
- "line": 46
14871
+ "line": 47
14802
14872
  },
14803
14873
  "name": "recoveryPolicy",
14804
14874
  "type": {
@@ -14820,7 +14890,7 @@
14820
14890
  "kind": "interface",
14821
14891
  "locationInModule": {
14822
14892
  "filename": "src/kafka/kafka-topic.ts",
14823
- "line": 83
14893
+ "line": 93
14824
14894
  },
14825
14895
  "name": "KafkaTopicProps",
14826
14896
  "namespace": "kafka",
@@ -14834,7 +14904,7 @@
14834
14904
  "immutable": true,
14835
14905
  "locationInModule": {
14836
14906
  "filename": "src/kafka/kafka-topic.ts",
14837
- "line": 126
14907
+ "line": 136
14838
14908
  },
14839
14909
  "name": "acl",
14840
14910
  "type": {
@@ -14850,7 +14920,7 @@
14850
14920
  "immutable": true,
14851
14921
  "locationInModule": {
14852
14922
  "filename": "src/kafka/kafka-topic.ts",
14853
- "line": 131
14923
+ "line": 141
14854
14924
  },
14855
14925
  "name": "isLogCompacted",
14856
14926
  "type": {
@@ -14866,7 +14936,7 @@
14866
14936
  "immutable": true,
14867
14937
  "locationInModule": {
14868
14938
  "filename": "src/kafka/kafka-topic.ts",
14869
- "line": 121
14939
+ "line": 131
14870
14940
  },
14871
14941
  "name": "metadata",
14872
14942
  "type": {
@@ -14883,7 +14953,7 @@
14883
14953
  "immutable": true,
14884
14954
  "locationInModule": {
14885
14955
  "filename": "src/kafka/kafka-topic.ts",
14886
- "line": 87
14956
+ "line": 97
14887
14957
  },
14888
14958
  "name": "name",
14889
14959
  "type": {
@@ -14900,7 +14970,7 @@
14900
14970
  "immutable": true,
14901
14971
  "locationInModule": {
14902
14972
  "filename": "src/kafka/kafka-topic.ts",
14903
- "line": 94
14973
+ "line": 104
14904
14974
  },
14905
14975
  "name": "numberOfPartitions",
14906
14976
  "type": {
@@ -14918,7 +14988,7 @@
14918
14988
  "immutable": true,
14919
14989
  "locationInModule": {
14920
14990
  "filename": "src/kafka/kafka-topic.ts",
14921
- "line": 116
14991
+ "line": 126
14922
14992
  },
14923
14993
  "name": "instantDeletionEnabled",
14924
14994
  "optional": true,
@@ -14936,7 +15006,7 @@
14936
15006
  "immutable": true,
14937
15007
  "locationInModule": {
14938
15008
  "filename": "src/kafka/kafka-topic.ts",
14939
- "line": 137
15009
+ "line": 147
14940
15010
  },
14941
15011
  "name": "logCompactionProperties",
14942
15012
  "optional": true,
@@ -14955,7 +15025,7 @@
14955
15025
  "immutable": true,
14956
15026
  "locationInModule": {
14957
15027
  "filename": "src/kafka/kafka-topic.ts",
14958
- "line": 100
15028
+ "line": 110
14959
15029
  },
14960
15030
  "name": "replicationFactor",
14961
15031
  "optional": true,
@@ -14974,7 +15044,7 @@
14974
15044
  "immutable": true,
14975
15045
  "locationInModule": {
14976
15046
  "filename": "src/kafka/kafka-topic.ts",
14977
- "line": 109
15047
+ "line": 119
14978
15048
  },
14979
15049
  "name": "retention",
14980
15050
  "optional": true,
@@ -14999,7 +15069,7 @@
14999
15069
  },
15000
15070
  "locationInModule": {
15001
15071
  "filename": "src/kafka/kafka-topic.ts",
15002
- "line": 242
15072
+ "line": 252
15003
15073
  },
15004
15074
  "parameters": [
15005
15075
  {
@@ -15025,7 +15095,7 @@
15025
15095
  "kind": "class",
15026
15096
  "locationInModule": {
15027
15097
  "filename": "src/kafka/kafka-topic.ts",
15028
- "line": 240
15098
+ "line": 250
15029
15099
  },
15030
15100
  "name": "KafkaTopicV4",
15031
15101
  "namespace": "kafka",
@@ -15043,7 +15113,7 @@
15043
15113
  "kind": "interface",
15044
15114
  "locationInModule": {
15045
15115
  "filename": "src/kafka/kafka-topic.ts",
15046
- "line": 145
15116
+ "line": 155
15047
15117
  },
15048
15118
  "name": "KafkaTopicV4Props",
15049
15119
  "namespace": "kafka",
@@ -15057,7 +15127,7 @@
15057
15127
  "immutable": true,
15058
15128
  "locationInModule": {
15059
15129
  "filename": "src/kafka/kafka-topic.ts",
15060
- "line": 188
15130
+ "line": 198
15061
15131
  },
15062
15132
  "name": "acl",
15063
15133
  "type": {
@@ -15073,7 +15143,7 @@
15073
15143
  "immutable": true,
15074
15144
  "locationInModule": {
15075
15145
  "filename": "src/kafka/kafka-topic.ts",
15076
- "line": 193
15146
+ "line": 203
15077
15147
  },
15078
15148
  "name": "isLogCompacted",
15079
15149
  "type": {
@@ -15089,7 +15159,7 @@
15089
15159
  "immutable": true,
15090
15160
  "locationInModule": {
15091
15161
  "filename": "src/kafka/kafka-topic.ts",
15092
- "line": 183
15162
+ "line": 193
15093
15163
  },
15094
15164
  "name": "metadata",
15095
15165
  "type": {
@@ -15106,7 +15176,7 @@
15106
15176
  "immutable": true,
15107
15177
  "locationInModule": {
15108
15178
  "filename": "src/kafka/kafka-topic.ts",
15109
- "line": 149
15179
+ "line": 159
15110
15180
  },
15111
15181
  "name": "name",
15112
15182
  "type": {
@@ -15123,7 +15193,7 @@
15123
15193
  "immutable": true,
15124
15194
  "locationInModule": {
15125
15195
  "filename": "src/kafka/kafka-topic.ts",
15126
- "line": 156
15196
+ "line": 166
15127
15197
  },
15128
15198
  "name": "numberOfPartitions",
15129
15199
  "type": {
@@ -15141,7 +15211,7 @@
15141
15211
  "immutable": true,
15142
15212
  "locationInModule": {
15143
15213
  "filename": "src/kafka/kafka-topic.ts",
15144
- "line": 178
15214
+ "line": 188
15145
15215
  },
15146
15216
  "name": "instantDeletionEnabled",
15147
15217
  "optional": true,
@@ -15159,7 +15229,7 @@
15159
15229
  "immutable": true,
15160
15230
  "locationInModule": {
15161
15231
  "filename": "src/kafka/kafka-topic.ts",
15162
- "line": 199
15232
+ "line": 209
15163
15233
  },
15164
15234
  "name": "logCompactionProperties",
15165
15235
  "optional": true,
@@ -15178,7 +15248,7 @@
15178
15248
  "immutable": true,
15179
15249
  "locationInModule": {
15180
15250
  "filename": "src/kafka/kafka-topic.ts",
15181
- "line": 162
15251
+ "line": 172
15182
15252
  },
15183
15253
  "name": "replicationFactor",
15184
15254
  "optional": true,
@@ -15197,7 +15267,7 @@
15197
15267
  "immutable": true,
15198
15268
  "locationInModule": {
15199
15269
  "filename": "src/kafka/kafka-topic.ts",
15200
- "line": 171
15270
+ "line": 181
15201
15271
  },
15202
15272
  "name": "retention",
15203
15273
  "optional": true,
@@ -15219,7 +15289,7 @@
15219
15289
  "kind": "interface",
15220
15290
  "locationInModule": {
15221
15291
  "filename": "src/kafka/kafka-topic.ts",
15222
- "line": 69
15292
+ "line": 79
15223
15293
  },
15224
15294
  "name": "LogCompactionProperties",
15225
15295
  "namespace": "kafka",
@@ -15235,7 +15305,7 @@
15235
15305
  "immutable": true,
15236
15306
  "locationInModule": {
15237
15307
  "filename": "src/kafka/kafka-topic.ts",
15238
- "line": 75
15308
+ "line": 85
15239
15309
  },
15240
15310
  "name": "deleteRetention",
15241
15311
  "optional": true,
@@ -15591,5 +15661,5 @@
15591
15661
  }
15592
15662
  },
15593
15663
  "version": "0.0.0",
15594
- "fingerprint": "DxDkGwEwMTGJoD8MtFJ4IzjRFrX3dwdLSrNGPWLz/Zw="
15664
+ "fingerprint": "x/mTlwg21suih9TKv6Gaich+3UlQM+14pu4VqnR83KM="
15595
15665
  }