@rio-cloud/cdk-v2-constructs 6.7.2 → 6.8.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
@@ -3773,7 +3773,7 @@
3773
3773
  "kind": "class",
3774
3774
  "locationInModule": {
3775
3775
  "filename": "src/watchful/watchful.ts",
3776
- "line": 83
3776
+ "line": 87
3777
3777
  },
3778
3778
  "methods": [
3779
3779
  {
@@ -3784,7 +3784,7 @@
3784
3784
  },
3785
3785
  "locationInModule": {
3786
3786
  "filename": "src/watchful/watchful.ts",
3787
- "line": 86
3787
+ "line": 90
3788
3788
  },
3789
3789
  "name": "createAlarm",
3790
3790
  "overrides": "@rio-cloud/cdk-v2-constructs.IWatchful",
@@ -3817,7 +3817,7 @@
3817
3817
  },
3818
3818
  "locationInModule": {
3819
3819
  "filename": "src/watchful/watchful.ts",
3820
- "line": 85
3820
+ "line": 89
3821
3821
  },
3822
3822
  "name": "createLogAlarm",
3823
3823
  "overrides": "@rio-cloud/cdk-v2-constructs.IWatchful",
@@ -3849,7 +3849,7 @@
3849
3849
  },
3850
3850
  "locationInModule": {
3851
3851
  "filename": "src/watchful/watchful.ts",
3852
- "line": 91
3852
+ "line": 95
3853
3853
  },
3854
3854
  "name": "overrideAlarmThreshold",
3855
3855
  "parameters": [
@@ -3867,7 +3867,7 @@
3867
3867
  },
3868
3868
  "locationInModule": {
3869
3869
  "filename": "src/watchful/watchful.ts",
3870
- "line": 99
3870
+ "line": 103
3871
3871
  },
3872
3872
  "name": "shouldOverrideThreshold",
3873
3873
  "parameters": [
@@ -3892,7 +3892,7 @@
3892
3892
  },
3893
3893
  "locationInModule": {
3894
3894
  "filename": "src/watchful/watchful.ts",
3895
- "line": 154
3895
+ "line": 162
3896
3896
  },
3897
3897
  "name": "watchAlb",
3898
3898
  "parameters": [
@@ -3906,6 +3906,9 @@
3906
3906
  }
3907
3907
  },
3908
3908
  {
3909
+ "docs": {
3910
+ "summary": "- Additional options for the watch see {@link WatchApplicationLoadBalancerOptions}."
3911
+ },
3909
3912
  "name": "options",
3910
3913
  "optional": true,
3911
3914
  "type": {
@@ -3921,7 +3924,7 @@
3921
3924
  },
3922
3925
  "locationInModule": {
3923
3926
  "filename": "src/watchful/watchful.ts",
3924
- "line": 166
3927
+ "line": 175
3925
3928
  },
3926
3929
  "name": "watchApplicationTargetGroup",
3927
3930
  "parameters": [
@@ -3935,6 +3938,9 @@
3935
3938
  }
3936
3939
  },
3937
3940
  {
3941
+ "docs": {
3942
+ "summary": "- Additional options for the watch see {@link WatchApplicationTargetGroupOptions}."
3943
+ },
3938
3944
  "name": "options",
3939
3945
  "optional": true,
3940
3946
  "type": {
@@ -3950,7 +3956,7 @@
3950
3956
  },
3951
3957
  "locationInModule": {
3952
3958
  "filename": "src/watchful/watchful.ts",
3953
- "line": 127
3959
+ "line": 133
3954
3960
  },
3955
3961
  "name": "watchCloudfrontDistribution",
3956
3962
  "parameters": [
@@ -3964,6 +3970,9 @@
3964
3970
  }
3965
3971
  },
3966
3972
  {
3973
+ "docs": {
3974
+ "summary": "- Additional options for the watch see {@link WatchCloudfrontDistributionOptions}."
3975
+ },
3967
3976
  "name": "options",
3968
3977
  "optional": true,
3969
3978
  "type": {
@@ -3979,7 +3988,7 @@
3979
3988
  },
3980
3989
  "locationInModule": {
3981
3990
  "filename": "src/watchful/watchful.ts",
3982
- "line": 193
3991
+ "line": 204
3983
3992
  },
3984
3993
  "name": "watchDatabaseCluster",
3985
3994
  "parameters": [
@@ -3993,6 +4002,9 @@
3993
4002
  }
3994
4003
  },
3995
4004
  {
4005
+ "docs": {
4006
+ "summary": "- Additional options for the watch see {@link WatchDatabaseClusterOptions}."
4007
+ },
3996
4008
  "name": "options",
3997
4009
  "optional": true,
3998
4010
  "type": {
@@ -4008,7 +4020,7 @@
4008
4020
  },
4009
4021
  "locationInModule": {
4010
4022
  "filename": "src/watchful/watchful.ts",
4011
- "line": 181
4023
+ "line": 191
4012
4024
  },
4013
4025
  "name": "watchDocDb",
4014
4026
  "parameters": [
@@ -4022,6 +4034,9 @@
4022
4034
  }
4023
4035
  },
4024
4036
  {
4037
+ "docs": {
4038
+ "summary": "- Additional options for the watch see {@link WatchDocDbClusterOptions}."
4039
+ },
4025
4040
  "name": "options",
4026
4041
  "optional": true,
4027
4042
  "type": {
@@ -4037,7 +4052,7 @@
4037
4052
  },
4038
4053
  "locationInModule": {
4039
4054
  "filename": "src/watchful/watchful.ts",
4040
- "line": 205
4055
+ "line": 217
4041
4056
  },
4042
4057
  "name": "watchDynamoDbTable",
4043
4058
  "parameters": [
@@ -4051,6 +4066,9 @@
4051
4066
  }
4052
4067
  },
4053
4068
  {
4069
+ "docs": {
4070
+ "summary": "- Additional options for the watch see {@link WatchDynamoDbTableOptions}."
4071
+ },
4054
4072
  "name": "options",
4055
4073
  "optional": true,
4056
4074
  "type": {
@@ -4066,7 +4084,7 @@
4066
4084
  },
4067
4085
  "locationInModule": {
4068
4086
  "filename": "src/watchful/watchful.ts",
4069
- "line": 142
4087
+ "line": 149
4070
4088
  },
4071
4089
  "name": "watchEcsService",
4072
4090
  "parameters": [
@@ -4080,6 +4098,9 @@
4080
4098
  }
4081
4099
  },
4082
4100
  {
4101
+ "docs": {
4102
+ "summary": "- Additional options for the watch see {@link WatchEcsServiceOptions}."
4103
+ },
4083
4104
  "name": "options",
4084
4105
  "optional": true,
4085
4106
  "type": {
@@ -4095,7 +4116,7 @@
4095
4116
  },
4096
4117
  "locationInModule": {
4097
4118
  "filename": "src/watchful/watchful.ts",
4098
- "line": 114
4119
+ "line": 119
4099
4120
  },
4100
4121
  "name": "watchLambdaFunction",
4101
4122
  "parameters": [
@@ -4109,6 +4130,9 @@
4109
4130
  }
4110
4131
  },
4111
4132
  {
4133
+ "docs": {
4134
+ "summary": "- Additional options for the watch see {@link WatchLambdaFunctionOptions}."
4135
+ },
4112
4136
  "name": "options",
4113
4137
  "optional": true,
4114
4138
  "type": {
@@ -4127,7 +4151,7 @@
4127
4151
  "immutable": true,
4128
4152
  "locationInModule": {
4129
4153
  "filename": "src/watchful/watchful.ts",
4130
- "line": 84
4154
+ "line": 88
4131
4155
  },
4132
4156
  "name": "metricsAlarmOverrides",
4133
4157
  "protected": true,
@@ -4779,7 +4803,7 @@
4779
4803
  {
4780
4804
  "abstract": true,
4781
4805
  "docs": {
4782
- "remarks": "This string is passed directly to the Docker daemon.\nImages in the Docker Hub registry are available by default.\nOther repositories are specified with either repository-url/image:tag or repository-url/image@digest.",
4806
+ "remarks": "This string is passed directly to the Docker daemon.\nImages in the Docker Hub registry are available by default.\nOther repositories are specified with either repository-url/image:tag or repository-url/image\\@digest.",
4783
4807
  "stability": "stable",
4784
4808
  "summary": "The image used to start a container."
4785
4809
  },
@@ -5211,7 +5235,7 @@
5211
5235
  {
5212
5236
  "abstract": true,
5213
5237
  "docs": {
5214
- "remarks": "We would like to learn about your use cases.\n\nDefault tags are not allowed to be overridden!\n\nDefaults are:\n* env: Set to RioFargateServiceProps#stage prop\n* service: Set to RioFargateServiceProps#serviceName prop\n* version: Set to RioFargateServiceProps#version prop\n* account_id:${accountID}\n* account_name:${accountName}\n* region:${AWSRegion}\n* team:${teamName from ssm param /config/team/name}\n* team_identifier:${teamIdentifier from ssm param /config/team/identifier}",
5238
+ "remarks": "We would like to learn about your use cases.\n\nDefault tags are not allowed to be overridden!\n\nDefaults are:\n* env: Set to RioFargateServiceProps#stage prop\n* service: Set to RioFargateServiceProps#serviceName prop\n* version: Set to RioFargateServiceProps#version prop\n* account_id:$\\{accountID\\}\n* account_name:$\\{accountName\\}\n* region:$\\{AWSRegion\\}\n* team:$\\{teamName from ssm param /config/team/name\\}\n* team_identifier:$\\{teamIdentifier from ssm param /config/team/identifier\\}",
5215
5239
  "stability": "stable",
5216
5240
  "summary": "Configure additional tags, which are appended to the defaults, When you define custom tags we would be glad if you contact us."
5217
5241
  },
@@ -5724,7 +5748,7 @@
5724
5748
  "abstract": true,
5725
5749
  "docs": {
5726
5750
  "stability": "stable",
5727
- "summary": "If AutoCloseOpsGenieAlerts is set to False, the monitor message will be wrapped in {{#is_alert}} ... {{/is_alert}} so that the corresponding OpsGenie alert will not resolve automatically. If set to True, it will leave the monitor message as it is. Note also that it is not possible to provide any of the wrappings {{#is_alert}}, {{#is_warning}}, {{#is_alert_recovery}}, '{{#is_warning_recovery}}' in the message yourself and use the property AutoCloseOpsGenieAlerts at the same time."
5751
+ "summary": "If AutoCloseOpsGenieAlerts is set to False, the monitor message will be wrapped in \\{\\{#is_alert\\}\\} ... \\{\\{/is_alert\\}\\} so that the corresponding OpsGenie alert will not resolve automatically. If set to True, it will leave the monitor message as it is. Note also that it is not possible to provide any of the wrappings \\{\\{#is_alert\\}\\}, \\{\\{#is_warning\\}\\}, \\{\\{#is_alert_recovery\\}\\}, '\\{\\{#is_warning_recovery\\}\\}' in the message yourself and use the property AutoCloseOpsGenieAlerts at the same time."
5728
5752
  },
5729
5753
  "immutable": true,
5730
5754
  "locationInModule": {
@@ -6464,7 +6488,7 @@
6464
6488
  "@rio-cloud/cdk-v2-constructs.IAppStackFactory": {
6465
6489
  "assembly": "@rio-cloud/cdk-v2-constructs",
6466
6490
  "docs": {
6467
- "example": "// Use e.g. within ApplicationProps as JSONObject:\n{ create: (construct, props) => new Stack(construct, 'AppStack', props) }\n\n// or simply as class interface within your stack implementation:\nclass PipelineStage extends Stage implements IAppStackFactory {\n constructor(scope: Construct, id: string, props: StageProps) {\n super(scope, id, props);\n // your stage definition\n }\n\n create(scope: Construct, props: AppStackProps): void {\n // app stack initiation goes in here\n }\n}",
6491
+ "example": "// Use e.g. within ApplicationProps as JSONObject:\n\\{ create: (construct, props) =\\> new Stack(construct, 'AppStack', props) \\}\n\n// or simply as class interface within your stack implementation:\nclass PipelineStage extends Stage implements IAppStackFactory \\{\n constructor(scope: Construct, id: string, props: StageProps) \\{\n super(scope, id, props);\n // your stage definition\n \\}\n\n create(scope: Construct, props: AppStackProps): void \\{\n // app stack initiation goes in here\n \\}\n\\}",
6468
6492
  "remarks": "Simply place the AppStack creation into the create-method:",
6469
6493
  "stability": "stable",
6470
6494
  "summary": "Provider interface to create the AppStack within the specific scope."
@@ -6490,7 +6514,7 @@
6490
6514
  "parameters": [
6491
6515
  {
6492
6516
  "docs": {
6493
- "summary": "the parent construct for the app stack."
6517
+ "summary": "- The parent construct for the app stack."
6494
6518
  },
6495
6519
  "name": "scope",
6496
6520
  "type": {
@@ -6499,7 +6523,7 @@
6499
6523
  },
6500
6524
  {
6501
6525
  "docs": {
6502
- "summary": "the app stacks properties."
6526
+ "summary": "- The app stacks properties."
6503
6527
  },
6504
6528
  "name": "props",
6505
6529
  "type": {
@@ -6536,17 +6560,23 @@
6536
6560
  },
6537
6561
  "locationInModule": {
6538
6562
  "filename": "src/watchful/watchful.ts",
6539
- "line": 52
6563
+ "line": 56
6540
6564
  },
6541
6565
  "name": "createAlarm",
6542
6566
  "parameters": [
6543
6567
  {
6568
+ "docs": {
6569
+ "summary": "- The construct to add the alarm to."
6570
+ },
6544
6571
  "name": "scope",
6545
6572
  "type": {
6546
6573
  "fqn": "constructs.Construct"
6547
6574
  }
6548
6575
  },
6549
6576
  {
6577
+ "docs": {
6578
+ "summary": "- The id of the alarm."
6579
+ },
6550
6580
  "name": "id",
6551
6581
  "type": {
6552
6582
  "fqn": "@rio-cloud/cdk-v2-constructs.MonitorType"
@@ -6554,7 +6584,7 @@
6554
6584
  },
6555
6585
  {
6556
6586
  "docs": {
6557
- "summary": "- The watchful to add those resources to."
6587
+ "summary": "- Additional options for the watch see {@link MetricAlarmProps}."
6558
6588
  },
6559
6589
  "name": "alarm",
6560
6590
  "type": {
@@ -6571,11 +6601,14 @@
6571
6601
  },
6572
6602
  "locationInModule": {
6573
6603
  "filename": "src/watchful/watchful.ts",
6574
- "line": 46
6604
+ "line": 48
6575
6605
  },
6576
6606
  "name": "createLogAlarm",
6577
6607
  "parameters": [
6578
6608
  {
6609
+ "docs": {
6610
+ "summary": "- The construct to add the alarm to."
6611
+ },
6579
6612
  "name": "scope",
6580
6613
  "type": {
6581
6614
  "fqn": "constructs.Construct"
@@ -6591,6 +6624,9 @@
6591
6624
  }
6592
6625
  },
6593
6626
  {
6627
+ "docs": {
6628
+ "summary": "- The alarm properties see {@link LogAlarmProps}."
6629
+ },
6594
6630
  "name": "alarm",
6595
6631
  "type": {
6596
6632
  "fqn": "@rio-cloud/cdk-v2-constructs.LogAlarmProps"
@@ -6769,7 +6805,7 @@
6769
6805
  {
6770
6806
  "docs": {
6771
6807
  "remarks": "Must either be an absolute path or a path relative to CDK's working directory.",
6772
- "summary": "the filename of the event specification file."
6808
+ "summary": "- The filename of the event specification file."
6773
6809
  },
6774
6810
  "name": "filename",
6775
6811
  "type": {
@@ -6798,7 +6834,7 @@
6798
6834
  "parameters": [
6799
6835
  {
6800
6836
  "docs": {
6801
- "summary": "as yaml formatted string."
6837
+ "summary": "- EventSpec as yaml formatted string."
6802
6838
  },
6803
6839
  "name": "spec",
6804
6840
  "type": {
@@ -8126,6 +8162,13 @@
8126
8162
  "summary": "Connection error metrics for Application load balancer target group."
8127
8163
  },
8128
8164
  "name": "CONNECTION_ERROR"
8165
+ },
8166
+ {
8167
+ "docs": {
8168
+ "stability": "stable",
8169
+ "summary": "Running fargate tasks monitor."
8170
+ },
8171
+ "name": "RUNNING_TASKS"
8129
8172
  }
8130
8173
  ],
8131
8174
  "name": "MonitorType",
@@ -8141,7 +8184,7 @@
8141
8184
  "kind": "interface",
8142
8185
  "locationInModule": {
8143
8186
  "filename": "src/watchful/watchful.ts",
8144
- "line": 55
8187
+ "line": 59
8145
8188
  },
8146
8189
  "name": "OverrideAlarmThresholdProps",
8147
8190
  "properties": [
@@ -8154,7 +8197,7 @@
8154
8197
  "immutable": true,
8155
8198
  "locationInModule": {
8156
8199
  "filename": "src/watchful/watchful.ts",
8157
- "line": 59
8200
+ "line": 63
8158
8201
  },
8159
8202
  "name": "monitoredResourceScope",
8160
8203
  "type": {
@@ -8171,7 +8214,7 @@
8171
8214
  "immutable": true,
8172
8215
  "locationInModule": {
8173
8216
  "filename": "src/watchful/watchful.ts",
8174
- "line": 65
8217
+ "line": 69
8175
8218
  },
8176
8219
  "name": "monitorType",
8177
8220
  "type": {
@@ -8187,7 +8230,7 @@
8187
8230
  "immutable": true,
8188
8231
  "locationInModule": {
8189
8232
  "filename": "src/watchful/watchful.ts",
8190
- "line": 70
8233
+ "line": 74
8191
8234
  },
8192
8235
  "name": "threshold",
8193
8236
  "type": {
@@ -8513,7 +8556,7 @@
8513
8556
  "abstract": true,
8514
8557
  "docs": {
8515
8558
  "stability": "stable",
8516
- "summary": "Map {directory: filenames} containing .jar or .zip files created in main build step to be uploaded to the monitoring-testsuite-runner bucket, e.g. ``` { 'availability-monitoring/build/libs': ['foo-availability.jar'], 'performance-monitoring/build/libs': ['api-check.zip', 'foo-performance.jar'], } ```."
8559
+ "summary": "Map \\{directory: filenames\\} containing .jar or .zip files created in main build step to be uploaded to the monitoring-testsuite-runner bucket, e.g. ``` { 'availability-monitoring/build/libs': ['foo-availability.jar'], 'performance-monitoring/build/libs': ['api-check.zip', 'foo-performance.jar'], } ```."
8517
8560
  },
8518
8561
  "immutable": true,
8519
8562
  "locationInModule": {
@@ -9243,7 +9286,7 @@
9243
9286
  },
9244
9287
  "locationInModule": {
9245
9288
  "filename": "src/kafka/rio-kafka-event-source.ts",
9246
- "line": 59
9289
+ "line": 62
9247
9290
  },
9248
9291
  "parameters": [
9249
9292
  {
@@ -9260,7 +9303,7 @@
9260
9303
  "kind": "class",
9261
9304
  "locationInModule": {
9262
9305
  "filename": "src/kafka/rio-kafka-event-source.ts",
9263
- "line": 57
9306
+ "line": 60
9264
9307
  },
9265
9308
  "methods": [
9266
9309
  {
@@ -9270,7 +9313,7 @@
9270
9313
  },
9271
9314
  "locationInModule": {
9272
9315
  "filename": "src/kafka/rio-kafka-event-source.ts",
9273
- "line": 62
9316
+ "line": 65
9274
9317
  },
9275
9318
  "name": "bind",
9276
9319
  "overrides": "aws-cdk-lib.aws_lambda.IEventSource",
@@ -9342,7 +9385,7 @@
9342
9385
  "abstract": true,
9343
9386
  "docs": {
9344
9387
  "default": "- none",
9345
- "remarks": "The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. The value must have a lenght between 1 and 200 and full the pattern '[a-zA-Z0-9-\\/*:_+=.@-]*'.",
9388
+ "remarks": "The consumer group ID must be unique among all your Kafka event sources.\nAfter creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value.\nThe value must have a lenght between 1 and 200 and full the pattern '[a-zA-Z0-9-\\/*:_+=.\\@-]*'.",
9346
9389
  "see": "https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id",
9347
9390
  "stability": "stable",
9348
9391
  "summary": "The identifier for the Kafka consumer group to join."
@@ -9350,7 +9393,7 @@
9350
9393
  "immutable": true,
9351
9394
  "locationInModule": {
9352
9395
  "filename": "src/kafka/rio-kafka-event-source.ts",
9353
- "line": 36
9396
+ "line": 39
9354
9397
  },
9355
9398
  "name": "consumerGroupId",
9356
9399
  "optional": true,
@@ -9935,7 +9978,7 @@
9935
9978
  "kind": "interface",
9936
9979
  "locationInModule": {
9937
9980
  "filename": "src/watchful/watchful.ts",
9938
- "line": 73
9981
+ "line": 77
9939
9982
  },
9940
9983
  "name": "ShouldOverrideThresholdProps",
9941
9984
  "properties": [
@@ -9947,7 +9990,7 @@
9947
9990
  "immutable": true,
9948
9991
  "locationInModule": {
9949
9992
  "filename": "src/watchful/watchful.ts",
9950
- "line": 74
9993
+ "line": 78
9951
9994
  },
9952
9995
  "name": "watchfulMonitorScope",
9953
9996
  "type": {
@@ -9962,7 +10005,7 @@
9962
10005
  "immutable": true,
9963
10006
  "locationInModule": {
9964
10007
  "filename": "src/watchful/watchful.ts",
9965
- "line": 75
10008
+ "line": 79
9966
10009
  },
9967
10010
  "name": "watchfulNodeId",
9968
10011
  "type": {
@@ -9982,7 +10025,7 @@
9982
10025
  "kind": "interface",
9983
10026
  "locationInModule": {
9984
10027
  "filename": "src/watchful/watchful.ts",
9985
- "line": 78
10028
+ "line": 82
9986
10029
  },
9987
10030
  "name": "ShouldOverrideThresholdReturnProps",
9988
10031
  "properties": [
@@ -9994,7 +10037,7 @@
9994
10037
  "immutable": true,
9995
10038
  "locationInModule": {
9996
10039
  "filename": "src/watchful/watchful.ts",
9997
- "line": 79
10040
+ "line": 83
9998
10041
  },
9999
10042
  "name": "shouldOverrideThreshold",
10000
10043
  "type": {
@@ -10009,7 +10052,7 @@
10009
10052
  "immutable": true,
10010
10053
  "locationInModule": {
10011
10054
  "filename": "src/watchful/watchful.ts",
10012
- "line": 80
10055
+ "line": 84
10013
10056
  },
10014
10057
  "name": "threshold",
10015
10058
  "optional": true,
@@ -11246,7 +11289,7 @@
11246
11289
  },
11247
11290
  "locationInModule": {
11248
11291
  "filename": "src/watchful/ecs.ts",
11249
- "line": 59
11292
+ "line": 67
11250
11293
  },
11251
11294
  "parameters": [
11252
11295
  {
@@ -11272,7 +11315,7 @@
11272
11315
  "kind": "class",
11273
11316
  "locationInModule": {
11274
11317
  "filename": "src/watchful/ecs.ts",
11275
- "line": 55
11318
+ "line": 63
11276
11319
  },
11277
11320
  "name": "WatchEcsService",
11278
11321
  "symbolId": "src/watchful/ecs:WatchEcsService"
@@ -11288,7 +11331,7 @@
11288
11331
  "kind": "interface",
11289
11332
  "locationInModule": {
11290
11333
  "filename": "src/watchful/ecs.ts",
11291
- "line": 15
11334
+ "line": 16
11292
11335
  },
11293
11336
  "name": "WatchEcsServiceOptions",
11294
11337
  "properties": [
@@ -11302,7 +11345,7 @@
11302
11345
  "immutable": true,
11303
11346
  "locationInModule": {
11304
11347
  "filename": "src/watchful/ecs.ts",
11305
- "line": 21
11348
+ "line": 22
11306
11349
  },
11307
11350
  "name": "cpuUtilizationThresholdPercent",
11308
11351
  "optional": true,
@@ -11320,13 +11363,31 @@
11320
11363
  "immutable": true,
11321
11364
  "locationInModule": {
11322
11365
  "filename": "src/watchful/ecs.ts",
11323
- "line": 28
11366
+ "line": 29
11324
11367
  },
11325
11368
  "name": "memoryUtilizationThresholdPercent",
11326
11369
  "optional": true,
11327
11370
  "type": {
11328
11371
  "primitive": "number"
11329
11372
  }
11373
+ },
11374
+ {
11375
+ "abstract": true,
11376
+ "docs": {
11377
+ "default": "1",
11378
+ "stability": "stable",
11379
+ "summary": "Minimum number of tasks that should be running."
11380
+ },
11381
+ "immutable": true,
11382
+ "locationInModule": {
11383
+ "filename": "src/watchful/ecs.ts",
11384
+ "line": 36
11385
+ },
11386
+ "name": "minimumNumberOfTasks",
11387
+ "optional": true,
11388
+ "type": {
11389
+ "primitive": "number"
11390
+ }
11330
11391
  }
11331
11392
  ],
11332
11393
  "symbolId": "src/watchful/ecs:WatchEcsServiceOptions"
@@ -11345,7 +11406,7 @@
11345
11406
  "kind": "interface",
11346
11407
  "locationInModule": {
11347
11408
  "filename": "src/watchful/ecs.ts",
11348
- "line": 34
11409
+ "line": 42
11349
11410
  },
11350
11411
  "name": "WatchEcsServiceProps",
11351
11412
  "properties": [
@@ -11359,7 +11420,7 @@
11359
11420
  "immutable": true,
11360
11421
  "locationInModule": {
11361
11422
  "filename": "src/watchful/ecs.ts",
11362
- "line": 44
11423
+ "line": 52
11363
11424
  },
11364
11425
  "name": "service",
11365
11426
  "type": {
@@ -11376,7 +11437,7 @@
11376
11437
  "immutable": true,
11377
11438
  "locationInModule": {
11378
11439
  "filename": "src/watchful/ecs.ts",
11379
- "line": 38
11440
+ "line": 46
11380
11441
  },
11381
11442
  "name": "watchful",
11382
11443
  "type": {
@@ -11577,7 +11638,7 @@
11577
11638
  },
11578
11639
  "locationInModule": {
11579
11640
  "filename": "src/watchful/watchful.ts",
11580
- "line": 257
11641
+ "line": 269
11581
11642
  },
11582
11643
  "parameters": [
11583
11644
  {
@@ -11604,7 +11665,7 @@
11604
11665
  "kind": "class",
11605
11666
  "locationInModule": {
11606
11667
  "filename": "src/watchful/watchful.ts",
11607
- "line": 251
11668
+ "line": 263
11608
11669
  },
11609
11670
  "methods": [
11610
11671
  {
@@ -11614,18 +11675,24 @@
11614
11675
  },
11615
11676
  "locationInModule": {
11616
11677
  "filename": "src/watchful/watchful.ts",
11617
- "line": 283
11678
+ "line": 297
11618
11679
  },
11619
11680
  "name": "createAlarm",
11620
11681
  "overrides": "@rio-cloud/cdk-v2-constructs.AbstractWatchful",
11621
11682
  "parameters": [
11622
11683
  {
11684
+ "docs": {
11685
+ "summary": "- The construct to add the alarm to."
11686
+ },
11623
11687
  "name": "scope",
11624
11688
  "type": {
11625
11689
  "fqn": "constructs.Construct"
11626
11690
  }
11627
11691
  },
11628
11692
  {
11693
+ "docs": {
11694
+ "summary": "- The id of the alarm."
11695
+ },
11629
11696
  "name": "id",
11630
11697
  "type": {
11631
11698
  "fqn": "@rio-cloud/cdk-v2-constructs.MonitorType"
@@ -11633,7 +11700,7 @@
11633
11700
  },
11634
11701
  {
11635
11702
  "docs": {
11636
- "summary": "The watchful to add those resources to."
11703
+ "summary": "- Additional options for the watch see {@link MetricAlarmProps}."
11637
11704
  },
11638
11705
  "name": "alarm",
11639
11706
  "type": {
@@ -11649,24 +11716,33 @@
11649
11716
  },
11650
11717
  "locationInModule": {
11651
11718
  "filename": "src/watchful/watchful.ts",
11652
- "line": 318
11719
+ "line": 334
11653
11720
  },
11654
11721
  "name": "createLogAlarm",
11655
11722
  "overrides": "@rio-cloud/cdk-v2-constructs.AbstractWatchful",
11656
11723
  "parameters": [
11657
11724
  {
11725
+ "docs": {
11726
+ "summary": "- The construct to add the alarm to."
11727
+ },
11658
11728
  "name": "scope",
11659
11729
  "type": {
11660
11730
  "fqn": "constructs.Construct"
11661
11731
  }
11662
11732
  },
11663
11733
  {
11734
+ "docs": {
11735
+ "summary": "- The id of the alarm."
11736
+ },
11664
11737
  "name": "id",
11665
11738
  "type": {
11666
11739
  "fqn": "@rio-cloud/cdk-v2-constructs.MonitorType"
11667
11740
  }
11668
11741
  },
11669
11742
  {
11743
+ "docs": {
11744
+ "summary": "- The alarm properties see {@link LogAlarmProps}."
11745
+ },
11670
11746
  "name": "alarm",
11671
11747
  "type": {
11672
11748
  "fqn": "@rio-cloud/cdk-v2-constructs.LogAlarmProps"
@@ -11681,7 +11757,7 @@
11681
11757
  },
11682
11758
  "locationInModule": {
11683
11759
  "filename": "src/watchful/watchful.ts",
11684
- "line": 342
11760
+ "line": 358
11685
11761
  },
11686
11762
  "name": "watchScope",
11687
11763
  "parameters": [
@@ -11769,7 +11845,7 @@
11769
11845
  "kind": "interface",
11770
11846
  "locationInModule": {
11771
11847
  "filename": "src/watchful/watchful.ts",
11772
- "line": 217
11848
+ "line": 229
11773
11849
  },
11774
11850
  "name": "WatchfulProps",
11775
11851
  "properties": [
@@ -11783,7 +11859,7 @@
11783
11859
  "immutable": true,
11784
11860
  "locationInModule": {
11785
11861
  "filename": "src/watchful/watchful.ts",
11786
- "line": 223
11862
+ "line": 235
11787
11863
  },
11788
11864
  "name": "alarmSns",
11789
11865
  "optional": true,
@@ -11801,7 +11877,7 @@
11801
11877
  "immutable": true,
11802
11878
  "locationInModule": {
11803
11879
  "filename": "src/watchful/watchful.ts",
11804
- "line": 237
11880
+ "line": 249
11805
11881
  },
11806
11882
  "name": "dataDogMonitorServiceName",
11807
11883
  "optional": true,
@@ -11819,7 +11895,7 @@
11819
11895
  "immutable": true,
11820
11896
  "locationInModule": {
11821
11897
  "filename": "src/watchful/watchful.ts",
11822
- "line": 230
11898
+ "line": 242
11823
11899
  },
11824
11900
  "name": "dataDogMonitorServiceToken",
11825
11901
  "optional": true,
@@ -11837,7 +11913,7 @@
11837
11913
  "immutable": true,
11838
11914
  "locationInModule": {
11839
11915
  "filename": "src/watchful/watchful.ts",
11840
- "line": 244
11916
+ "line": 256
11841
11917
  },
11842
11918
  "name": "dataDogOpsGenieIntegrationName",
11843
11919
  "optional": true,
@@ -12294,7 +12370,7 @@
12294
12370
  "abstract": true,
12295
12371
  "docs": {
12296
12372
  "stability": "stable",
12297
- "summary": "If AutoCloseOpsGenieAlerts is set to False, the monitor message will be wrapped in {{#is_alert}} ... {{/is_alert}} so that the corresponding OpsGenie alert will not resolve automatically. If set to True, it will leave the monitor message as it is. Note also that it is not possible to provide any of the wrappings {{#is_alert}}, {{#is_warning}}, {{#is_alert_recovery}}, '{{#is_warning_recovery}}' in the message yourself and use the property AutoCloseOpsGenieAlerts at the same time."
12373
+ "summary": "If AutoCloseOpsGenieAlerts is set to False, the monitor message will be wrapped in \\{\\{#is_alert\\}\\} ... \\{\\{/is_alert\\}\\} so that the corresponding OpsGenie alert will not resolve automatically. If set to True, it will leave the monitor message as it is. Note also that it is not possible to provide any of the wrappings \\{\\{#is_alert\\}\\}, \\{\\{#is_warning\\}\\}, \\{\\{#is_alert_recovery\\}\\}, '\\{\\{#is_warning_recovery\\}\\}' in the message yourself and use the property AutoCloseOpsGenieAlerts at the same time."
12298
12374
  },
12299
12375
  "immutable": true,
12300
12376
  "locationInModule": {
@@ -13084,7 +13160,7 @@
13084
13160
  {
13085
13161
  "abstract": true,
13086
13162
  "docs": {
13087
- "remarks": "new DatadogDashboard(this, 'SampleDashboard', { dashboardDefinition })\n```\n\nReferences to {@link [DatadogMonitor](./datadog-monitor.ts)} will not be resolved at the moment.",
13163
+ "remarks": "new DatadogDashboard(this, 'SampleDashboard', { dashboardDefinition })\n```\n\nReferences to {@link ./datadog-monitor.ts.#DatadogMonitor}. will not be resolved at the moment.",
13088
13164
  "stability": "stable",
13089
13165
  "summary": "The Dashboard definition as exported from Datadog: ```ts import dashboardDefinition from './dashboard.json';"
13090
13166
  },
@@ -14529,7 +14605,7 @@
14529
14605
  "@rio-cloud/cdk-v2-constructs.datadogv2.INotification": {
14530
14606
  "assembly": "@rio-cloud/cdk-v2-constructs",
14531
14607
  "docs": {
14532
- "remarks": "One instance could be reused over multiple monitors, e.g. when using the {@link [Watchful v2](../watchfulv2/watchful.ts)} construct.",
14608
+ "remarks": "One instance could be reused over multiple monitors, e.g. when using the {@link ./../watchfulv2#watchful.ts} construct.",
14533
14609
  "stability": "stable",
14534
14610
  "summary": "Interface to plug in specific notification types for monitors in Datadog."
14535
14611
  },
@@ -14771,7 +14847,7 @@
14771
14847
  "@rio-cloud/cdk-v2-constructs.datadogv2.NoNotification": {
14772
14848
  "assembly": "@rio-cloud/cdk-v2-constructs",
14773
14849
  "docs": {
14774
- "remarks": "Per default every monitor\nhas a slack notification. In order to create a {@link DatadogMonitor} just for a {@link [DatadogDashboard](./datadog-dashboard.ts)}\nwithout further notification.",
14850
+ "remarks": "Per default every monitor\nhas a Slack notification. In order to create a {@link DatadogMonitor} just for a {@link ./datadog-monitor.ts.#DatadogMonitor}\nwithout further notification.",
14775
14851
  "stability": "stable",
14776
14852
  "summary": "{@link INotification} implementation, that explicitly suppresses notifications."
14777
14853
  },
@@ -14949,7 +15025,7 @@
14949
15025
  "@rio-cloud/cdk-v2-constructs.datadogv2.RioPagingNotification": {
14950
15026
  "assembly": "@rio-cloud/cdk-v2-constructs",
14951
15027
  "docs": {
14952
- "remarks": "Alerts with Priority > {@link RioPagingNotification.MINIMUM_PRIORITY} will not be taken into account.",
15028
+ "remarks": "Alerts with Priority \\> {@link RioPagingNotification.MINIMUM_PRIORITY} will not be taken into account.",
14953
15029
  "stability": "stable",
14954
15030
  "summary": "An {@link INotification}, that forwards alerts to the RIO paging router to engage the corresponding team."
14955
15031
  },
@@ -15101,7 +15177,7 @@
15101
15177
  "abstract": true,
15102
15178
  "docs": {
15103
15179
  "stability": "stable",
15104
- "summary": "the slack channel to route the alert to."
15180
+ "summary": "the Slack channel to route the alert to."
15105
15181
  },
15106
15182
  "immutable": true,
15107
15183
  "locationInModule": {
@@ -15134,7 +15210,7 @@
15134
15210
  {
15135
15211
  "abstract": true,
15136
15212
  "docs": {
15137
- "remarks": "This string is passed directly to the Docker daemon.\nImages in the Docker Hub registry are available by default.\nOther repositories are specified with either repository-url/image:tag or repository-url/image@digest.",
15213
+ "remarks": "This string is passed directly to the Docker daemon.\nImages in the Docker Hub registry are available by default.\nOther repositories are specified with either repository-url/image:tag or repository-url/image\\@digest.",
15138
15214
  "stability": "stable",
15139
15215
  "summary": "The image used to start a container."
15140
15216
  },
@@ -15281,7 +15357,7 @@
15281
15357
  {
15282
15358
  "abstract": true,
15283
15359
  "docs": {
15284
- "remarks": "We would like to learn about your use cases.\n\nDefault tags are not allowed to be overridden!\n\nDefaults are:\n* env: Set to RioFargateServiceProps#stage prop\n* service: Set to RioFargateServiceProps#serviceName prop\n* version: Set to RioFargateServiceProps#version prop\n* account_id:${accountID}\n* account_name:${accountName}\n* region:${AWSRegion}\n* team:${teamName from ssm param /config/team/name}\n* team_identifier:${teamIdentifier from ssm param /config/team/identifier}",
15360
+ "remarks": "We would like to learn about your use cases.\n\nDefault tags are not allowed to be overridden!\n\nDefaults are:\n* env: Set to RioFargateServiceProps#stage prop\n* service: Set to RioFargateServiceProps#serviceName prop\n* version: Set to RioFargateServiceProps#version prop\n* account_id:$\\{accountID\\}\n* account_name:$\\{accountName\\}\n* region:$\\{AWSRegion\\}\n* team:$\\{teamName from ssm param /config/team/name\\}\n* team_identifier:$\\{teamIdentifier from ssm param /config/team/identifier\\}",
15285
15361
  "stability": "stable",
15286
15362
  "summary": "Configure additional tags, which are appended to the defaults, When you define custom tags we would be glad if you contact us."
15287
15363
  },
@@ -16243,7 +16319,7 @@
16243
16319
  {
16244
16320
  "docs": {
16245
16321
  "remarks": "Must either be an absolute path or a path relative to CDK's working directory.",
16246
- "summary": "the filename of the event specification file."
16322
+ "summary": "- The filename of the event specification file."
16247
16323
  },
16248
16324
  "name": "filename",
16249
16325
  "type": {
@@ -16272,7 +16348,7 @@
16272
16348
  "parameters": [
16273
16349
  {
16274
16350
  "docs": {
16275
- "summary": "as yaml formatted string."
16351
+ "summary": "- EventSpec as yaml formatted string."
16276
16352
  },
16277
16353
  "name": "spec",
16278
16354
  "type": {
@@ -16988,7 +17064,7 @@
16988
17064
  },
16989
17065
  "locationInModule": {
16990
17066
  "filename": "src/kafka/rio-kafka-event-source.ts",
16991
- "line": 59
17067
+ "line": 62
16992
17068
  },
16993
17069
  "parameters": [
16994
17070
  {
@@ -17005,7 +17081,7 @@
17005
17081
  "kind": "class",
17006
17082
  "locationInModule": {
17007
17083
  "filename": "src/kafka/rio-kafka-event-source.ts",
17008
- "line": 57
17084
+ "line": 60
17009
17085
  },
17010
17086
  "methods": [
17011
17087
  {
@@ -17015,7 +17091,7 @@
17015
17091
  },
17016
17092
  "locationInModule": {
17017
17093
  "filename": "src/kafka/rio-kafka-event-source.ts",
17018
- "line": 62
17094
+ "line": 65
17019
17095
  },
17020
17096
  "name": "bind",
17021
17097
  "overrides": "aws-cdk-lib.aws_lambda.IEventSource",
@@ -17089,7 +17165,7 @@
17089
17165
  "abstract": true,
17090
17166
  "docs": {
17091
17167
  "default": "- none",
17092
- "remarks": "The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. The value must have a lenght between 1 and 200 and full the pattern '[a-zA-Z0-9-\\/*:_+=.@-]*'.",
17168
+ "remarks": "The consumer group ID must be unique among all your Kafka event sources.\nAfter creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value.\nThe value must have a lenght between 1 and 200 and full the pattern '[a-zA-Z0-9-\\/*:_+=.\\@-]*'.",
17093
17169
  "see": "https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id",
17094
17170
  "stability": "stable",
17095
17171
  "summary": "The identifier for the Kafka consumer group to join."
@@ -17097,7 +17173,7 @@
17097
17173
  "immutable": true,
17098
17174
  "locationInModule": {
17099
17175
  "filename": "src/kafka/rio-kafka-event-source.ts",
17100
- "line": 36
17176
+ "line": 39
17101
17177
  },
17102
17178
  "name": "consumerGroupId",
17103
17179
  "optional": true,
@@ -17127,7 +17203,7 @@
17127
17203
  {
17128
17204
  "abstract": true,
17129
17205
  "docs": {
17130
- "default": "{@link false }",
17206
+ "default": "false",
17131
17207
  "remarks": "This property has been deprecated. The propery has been instead nested into logErrorMonitorConfig.\nThe functionality remains unchanged",
17132
17208
  "stability": "stable",
17133
17209
  "summary": "Enable error log monitors creating cases in Datadog."
@@ -17289,18 +17365,24 @@
17289
17365
  },
17290
17366
  "locationInModule": {
17291
17367
  "filename": "src/watchfulv2/watchful.ts",
17292
- "line": 142
17368
+ "line": 144
17293
17369
  },
17294
17370
  "name": "createAlarm",
17295
17371
  "overrides": "@rio-cloud/cdk-v2-constructs.AbstractWatchful",
17296
17372
  "parameters": [
17297
17373
  {
17374
+ "docs": {
17375
+ "summary": "- The construct to add the alarm to."
17376
+ },
17298
17377
  "name": "scope",
17299
17378
  "type": {
17300
17379
  "fqn": "constructs.Construct"
17301
17380
  }
17302
17381
  },
17303
17382
  {
17383
+ "docs": {
17384
+ "summary": "- The id of the alarm."
17385
+ },
17304
17386
  "name": "id",
17305
17387
  "type": {
17306
17388
  "fqn": "@rio-cloud/cdk-v2-constructs.MonitorType"
@@ -17324,24 +17406,33 @@
17324
17406
  },
17325
17407
  "locationInModule": {
17326
17408
  "filename": "src/watchfulv2/watchful.ts",
17327
- "line": 170
17409
+ "line": 174
17328
17410
  },
17329
17411
  "name": "createLogAlarm",
17330
17412
  "overrides": "@rio-cloud/cdk-v2-constructs.AbstractWatchful",
17331
17413
  "parameters": [
17332
17414
  {
17415
+ "docs": {
17416
+ "summary": "- The construct to add the alarm to."
17417
+ },
17333
17418
  "name": "scope",
17334
17419
  "type": {
17335
17420
  "fqn": "constructs.Construct"
17336
17421
  }
17337
17422
  },
17338
17423
  {
17424
+ "docs": {
17425
+ "summary": "- The id of the alarm."
17426
+ },
17339
17427
  "name": "id",
17340
17428
  "type": {
17341
17429
  "fqn": "@rio-cloud/cdk-v2-constructs.MonitorType"
17342
17430
  }
17343
17431
  },
17344
17432
  {
17433
+ "docs": {
17434
+ "summary": "- The alarm properties see {@link LogAlarmProps}."
17435
+ },
17345
17436
  "name": "alarm",
17346
17437
  "type": {
17347
17438
  "fqn": "@rio-cloud/cdk-v2-constructs.LogAlarmProps"
@@ -17356,7 +17447,7 @@
17356
17447
  },
17357
17448
  "locationInModule": {
17358
17449
  "filename": "src/watchfulv2/watchful.ts",
17359
- "line": 208
17450
+ "line": 212
17360
17451
  },
17361
17452
  "name": "watchScope",
17362
17453
  "parameters": [
@@ -17392,7 +17483,7 @@
17392
17483
  {
17393
17484
  "abstract": true,
17394
17485
  "docs": {
17395
- "default": "{@link false }",
17486
+ "default": "false",
17396
17487
  "deprecated": "This property has been deprecated. The propery has been instead nested into logErrorMonitorConfig. The functionality remains unchanged.",
17397
17488
  "stability": "deprecated",
17398
17489
  "summary": "Enable error log monitors creating cases in Datadog."
@@ -17484,5 +17575,5 @@
17484
17575
  }
17485
17576
  },
17486
17577
  "version": "0.0.0",
17487
- "fingerprint": "36V3BIrn5+gY9l0rmrPKouwvWkHujrovZ1A32S6kN6E="
17578
+ "fingerprint": "2MeGJif6LRKbwaxSpHmnCXoJh8y+w/nf3bjRrk+2KqE="
17488
17579
  }