@rio-cloud/cdk-v2-constructs 6.7.2 → 6.9.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 +204 -81
- package/docs/API.md +827 -43
- package/docs/changelog.md +37 -616
- package/lib/contributions/team-transport-two/pipeline/pipeline-stack.d.ts +12 -12
- package/lib/contributions/team-transport-two/pipeline/pipeline-stack.js +1 -1
- package/lib/datadog/datadog-monitor.d.ts +2 -2
- package/lib/datadog/datadog-monitor.js +1 -1
- package/lib/datadogv2/datadog-dashboard.d.ts +1 -1
- package/lib/datadogv2/datadog-dashboard.js +1 -1
- package/lib/datadogv2/datadog-monitor.js +1 -2
- package/lib/datadogv2/datadog-notification.d.ts +4 -4
- package/lib/datadogv2/datadog-notification.js +3 -3
- package/lib/fargate/rio-fargate-service.d.ts +6 -6
- package/lib/fargate/rio-fargate-service.js +1 -1
- package/lib/iam/ecr-pull-through-cache-policy-statement.d.ts +4 -0
- package/lib/iam/ecr-pull-through-cache-policy-statement.js +25 -0
- package/lib/iam/index.d.ts +1 -0
- package/lib/iam/index.js +18 -0
- package/lib/index.d.ts +1 -0
- package/lib/index.js +3 -2
- package/lib/kafka/kafka-event-spec.d.ts +2 -2
- package/lib/kafka/kafka-event-spec.js +3 -3
- package/lib/kafka/kafka-topic.js +1 -1
- package/lib/kafka/rio-kafka-event-source.d.ts +4 -1
- package/lib/kafka/rio-kafka-event-source.js +1 -1
- package/lib/toggle.d.ts +7 -7
- package/lib/toggle.js +9 -12
- package/lib/watchful/ecs.d.ts +7 -0
- package/lib/watchful/ecs.js +21 -1
- package/lib/watchful/monitor-type.d.ts +5 -1
- package/lib/watchful/monitor-type.js +5 -1
- package/lib/watchful/watchful.d.ts +19 -3
- package/lib/watchful/watchful.js +15 -3
- package/lib/watchfulv2/watchful.d.ts +7 -3
- package/lib/watchfulv2/watchful.js +7 -3
- package/package.json +3 -3
- package/version.json +1 -1
- package/CHANGELOG.md +0 -99
package/docs/API.md
CHANGED
|
@@ -154,6 +154,8 @@ An application load balancer that should be watched [disable-awslint:ref-via-int
|
|
|
154
154
|
|
|
155
155
|
- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.WatchApplicationLoadBalancerOptions">WatchApplicationLoadBalancerOptions</a>
|
|
156
156
|
|
|
157
|
+
Additional options for the watch see {@link WatchApplicationLoadBalancerOptions}.
|
|
158
|
+
|
|
157
159
|
---
|
|
158
160
|
|
|
159
161
|
##### `watchApplicationTargetGroup` <a name="watchApplicationTargetGroup" id="@rio-cloud/cdk-v2-constructs.AbstractWatchful.watchApplicationTargetGroup"></a>
|
|
@@ -176,6 +178,8 @@ An application target group that should be watched [disable-awslint:ref-via-inte
|
|
|
176
178
|
|
|
177
179
|
- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.WatchApplicationTargetGroupOptions">WatchApplicationTargetGroupOptions</a>
|
|
178
180
|
|
|
181
|
+
Additional options for the watch see {@link WatchApplicationTargetGroupOptions}.
|
|
182
|
+
|
|
179
183
|
---
|
|
180
184
|
|
|
181
185
|
##### `watchCloudfrontDistribution` <a name="watchCloudfrontDistribution" id="@rio-cloud/cdk-v2-constructs.AbstractWatchful.watchCloudfrontDistribution"></a>
|
|
@@ -198,6 +202,8 @@ A Cloudfront Distribution that should be watched [disable-awslint:ref-via-interf
|
|
|
198
202
|
|
|
199
203
|
- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.WatchCloudfrontDistributionOptions">WatchCloudfrontDistributionOptions</a>
|
|
200
204
|
|
|
205
|
+
Additional options for the watch see {@link WatchCloudfrontDistributionOptions}.
|
|
206
|
+
|
|
201
207
|
---
|
|
202
208
|
|
|
203
209
|
##### `watchDatabaseCluster` <a name="watchDatabaseCluster" id="@rio-cloud/cdk-v2-constructs.AbstractWatchful.watchDatabaseCluster"></a>
|
|
@@ -220,6 +226,8 @@ An database cluster that should be watched [disable-awslint:ref-via-interface].
|
|
|
220
226
|
|
|
221
227
|
- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.WatchDatabaseClusterOptions">WatchDatabaseClusterOptions</a>
|
|
222
228
|
|
|
229
|
+
Additional options for the watch see {@link WatchDatabaseClusterOptions}.
|
|
230
|
+
|
|
223
231
|
---
|
|
224
232
|
|
|
225
233
|
##### `watchDocDb` <a name="watchDocDb" id="@rio-cloud/cdk-v2-constructs.AbstractWatchful.watchDocDb"></a>
|
|
@@ -242,6 +250,8 @@ An DocDb cluster that should be watched [disable-awslint:ref-via-interface].
|
|
|
242
250
|
|
|
243
251
|
- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.WatchDocDbClusterOptions">WatchDocDbClusterOptions</a>
|
|
244
252
|
|
|
253
|
+
Additional options for the watch see {@link WatchDocDbClusterOptions}.
|
|
254
|
+
|
|
245
255
|
---
|
|
246
256
|
|
|
247
257
|
##### `watchDynamoDbTable` <a name="watchDynamoDbTable" id="@rio-cloud/cdk-v2-constructs.AbstractWatchful.watchDynamoDbTable"></a>
|
|
@@ -264,6 +274,8 @@ An database cluster that should be watched [disable-awslint:ref-via-interface].
|
|
|
264
274
|
|
|
265
275
|
- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.WatchDynamoDbTableOptions">WatchDynamoDbTableOptions</a>
|
|
266
276
|
|
|
277
|
+
Additional options for the watch see {@link WatchDynamoDbTableOptions}.
|
|
278
|
+
|
|
267
279
|
---
|
|
268
280
|
|
|
269
281
|
##### `watchEcsService` <a name="watchEcsService" id="@rio-cloud/cdk-v2-constructs.AbstractWatchful.watchEcsService"></a>
|
|
@@ -286,6 +298,8 @@ An ECS service that should be watched [disable-awslint:ref-via-interface].
|
|
|
286
298
|
|
|
287
299
|
- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.WatchEcsServiceOptions">WatchEcsServiceOptions</a>
|
|
288
300
|
|
|
301
|
+
Additional options for the watch see {@link WatchEcsServiceOptions}.
|
|
302
|
+
|
|
289
303
|
---
|
|
290
304
|
|
|
291
305
|
##### `watchLambdaFunction` <a name="watchLambdaFunction" id="@rio-cloud/cdk-v2-constructs.AbstractWatchful.watchLambdaFunction"></a>
|
|
@@ -308,6 +322,8 @@ A lambda function that should be watched [disable-awslint:ref-via-interface].
|
|
|
308
322
|
|
|
309
323
|
- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.WatchLambdaFunctionOptions">WatchLambdaFunctionOptions</a>
|
|
310
324
|
|
|
325
|
+
Additional options for the watch see {@link WatchLambdaFunctionOptions}.
|
|
326
|
+
|
|
311
327
|
---
|
|
312
328
|
|
|
313
329
|
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
@@ -6398,19 +6414,23 @@ Adds the alarmTopic as alarm action to the given alarm.
|
|
|
6398
6414
|
|
|
6399
6415
|
- *Type:* constructs.Construct
|
|
6400
6416
|
|
|
6417
|
+
The construct to add the alarm to.
|
|
6418
|
+
|
|
6401
6419
|
---
|
|
6402
6420
|
|
|
6403
6421
|
###### `id`<sup>Required</sup> <a name="id" id="@rio-cloud/cdk-v2-constructs.Watchful.createAlarm.parameter.id"></a>
|
|
6404
6422
|
|
|
6405
6423
|
- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.MonitorType">MonitorType</a>
|
|
6406
6424
|
|
|
6425
|
+
The id of the alarm.
|
|
6426
|
+
|
|
6407
6427
|
---
|
|
6408
6428
|
|
|
6409
6429
|
###### `alarm`<sup>Required</sup> <a name="alarm" id="@rio-cloud/cdk-v2-constructs.Watchful.createAlarm.parameter.alarm"></a>
|
|
6410
6430
|
|
|
6411
6431
|
- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.MetricAlarmProps">MetricAlarmProps</a>
|
|
6412
6432
|
|
|
6413
|
-
|
|
6433
|
+
Additional options for the watch see {@link MetricAlarmProps}.
|
|
6414
6434
|
|
|
6415
6435
|
---
|
|
6416
6436
|
|
|
@@ -6426,18 +6446,24 @@ Adds an alert for error logs.
|
|
|
6426
6446
|
|
|
6427
6447
|
- *Type:* constructs.Construct
|
|
6428
6448
|
|
|
6449
|
+
The construct to add the alarm to.
|
|
6450
|
+
|
|
6429
6451
|
---
|
|
6430
6452
|
|
|
6431
6453
|
###### `id`<sup>Required</sup> <a name="id" id="@rio-cloud/cdk-v2-constructs.Watchful.createLogAlarm.parameter.id"></a>
|
|
6432
6454
|
|
|
6433
6455
|
- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.MonitorType">MonitorType</a>
|
|
6434
6456
|
|
|
6457
|
+
The id of the alarm.
|
|
6458
|
+
|
|
6435
6459
|
---
|
|
6436
6460
|
|
|
6437
6461
|
###### `alarm`<sup>Required</sup> <a name="alarm" id="@rio-cloud/cdk-v2-constructs.Watchful.createLogAlarm.parameter.alarm"></a>
|
|
6438
6462
|
|
|
6439
6463
|
- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.LogAlarmProps">LogAlarmProps</a>
|
|
6440
6464
|
|
|
6465
|
+
The alarm properties see {@link LogAlarmProps}.
|
|
6466
|
+
|
|
6441
6467
|
---
|
|
6442
6468
|
|
|
6443
6469
|
##### ~~`overrideAlarmThreshold`~~ <a name="overrideAlarmThreshold" id="@rio-cloud/cdk-v2-constructs.Watchful.overrideAlarmThreshold"></a>
|
|
@@ -6474,6 +6500,8 @@ An application load balancer that should be watched [disable-awslint:ref-via-int
|
|
|
6474
6500
|
|
|
6475
6501
|
- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.WatchApplicationLoadBalancerOptions">WatchApplicationLoadBalancerOptions</a>
|
|
6476
6502
|
|
|
6503
|
+
Additional options for the watch see {@link WatchApplicationLoadBalancerOptions}.
|
|
6504
|
+
|
|
6477
6505
|
---
|
|
6478
6506
|
|
|
6479
6507
|
##### ~~`watchApplicationTargetGroup`~~ <a name="watchApplicationTargetGroup" id="@rio-cloud/cdk-v2-constructs.Watchful.watchApplicationTargetGroup"></a>
|
|
@@ -6496,6 +6524,8 @@ An application target group that should be watched [disable-awslint:ref-via-inte
|
|
|
6496
6524
|
|
|
6497
6525
|
- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.WatchApplicationTargetGroupOptions">WatchApplicationTargetGroupOptions</a>
|
|
6498
6526
|
|
|
6527
|
+
Additional options for the watch see {@link WatchApplicationTargetGroupOptions}.
|
|
6528
|
+
|
|
6499
6529
|
---
|
|
6500
6530
|
|
|
6501
6531
|
##### ~~`watchCloudfrontDistribution`~~ <a name="watchCloudfrontDistribution" id="@rio-cloud/cdk-v2-constructs.Watchful.watchCloudfrontDistribution"></a>
|
|
@@ -6518,6 +6548,8 @@ A Cloudfront Distribution that should be watched [disable-awslint:ref-via-interf
|
|
|
6518
6548
|
|
|
6519
6549
|
- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.WatchCloudfrontDistributionOptions">WatchCloudfrontDistributionOptions</a>
|
|
6520
6550
|
|
|
6551
|
+
Additional options for the watch see {@link WatchCloudfrontDistributionOptions}.
|
|
6552
|
+
|
|
6521
6553
|
---
|
|
6522
6554
|
|
|
6523
6555
|
##### ~~`watchDatabaseCluster`~~ <a name="watchDatabaseCluster" id="@rio-cloud/cdk-v2-constructs.Watchful.watchDatabaseCluster"></a>
|
|
@@ -6540,6 +6572,8 @@ An database cluster that should be watched [disable-awslint:ref-via-interface].
|
|
|
6540
6572
|
|
|
6541
6573
|
- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.WatchDatabaseClusterOptions">WatchDatabaseClusterOptions</a>
|
|
6542
6574
|
|
|
6575
|
+
Additional options for the watch see {@link WatchDatabaseClusterOptions}.
|
|
6576
|
+
|
|
6543
6577
|
---
|
|
6544
6578
|
|
|
6545
6579
|
##### ~~`watchDocDb`~~ <a name="watchDocDb" id="@rio-cloud/cdk-v2-constructs.Watchful.watchDocDb"></a>
|
|
@@ -6562,6 +6596,8 @@ An DocDb cluster that should be watched [disable-awslint:ref-via-interface].
|
|
|
6562
6596
|
|
|
6563
6597
|
- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.WatchDocDbClusterOptions">WatchDocDbClusterOptions</a>
|
|
6564
6598
|
|
|
6599
|
+
Additional options for the watch see {@link WatchDocDbClusterOptions}.
|
|
6600
|
+
|
|
6565
6601
|
---
|
|
6566
6602
|
|
|
6567
6603
|
##### ~~`watchDynamoDbTable`~~ <a name="watchDynamoDbTable" id="@rio-cloud/cdk-v2-constructs.Watchful.watchDynamoDbTable"></a>
|
|
@@ -6584,6 +6620,8 @@ An database cluster that should be watched [disable-awslint:ref-via-interface].
|
|
|
6584
6620
|
|
|
6585
6621
|
- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.WatchDynamoDbTableOptions">WatchDynamoDbTableOptions</a>
|
|
6586
6622
|
|
|
6623
|
+
Additional options for the watch see {@link WatchDynamoDbTableOptions}.
|
|
6624
|
+
|
|
6587
6625
|
---
|
|
6588
6626
|
|
|
6589
6627
|
##### ~~`watchEcsService`~~ <a name="watchEcsService" id="@rio-cloud/cdk-v2-constructs.Watchful.watchEcsService"></a>
|
|
@@ -6606,6 +6644,8 @@ An ECS service that should be watched [disable-awslint:ref-via-interface].
|
|
|
6606
6644
|
|
|
6607
6645
|
- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.WatchEcsServiceOptions">WatchEcsServiceOptions</a>
|
|
6608
6646
|
|
|
6647
|
+
Additional options for the watch see {@link WatchEcsServiceOptions}.
|
|
6648
|
+
|
|
6609
6649
|
---
|
|
6610
6650
|
|
|
6611
6651
|
##### ~~`watchLambdaFunction`~~ <a name="watchLambdaFunction" id="@rio-cloud/cdk-v2-constructs.Watchful.watchLambdaFunction"></a>
|
|
@@ -6628,6 +6668,8 @@ A lambda function that should be watched [disable-awslint:ref-via-interface].
|
|
|
6628
6668
|
|
|
6629
6669
|
- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.WatchLambdaFunctionOptions">WatchLambdaFunctionOptions</a>
|
|
6630
6670
|
|
|
6671
|
+
Additional options for the watch see {@link WatchLambdaFunctionOptions}.
|
|
6672
|
+
|
|
6631
6673
|
---
|
|
6632
6674
|
|
|
6633
6675
|
##### ~~`watchScope`~~ <a name="watchScope" id="@rio-cloud/cdk-v2-constructs.Watchful.watchScope"></a>
|
|
@@ -6794,12 +6836,16 @@ Adds the alarmTopic as alarm action to the given alarm.
|
|
|
6794
6836
|
|
|
6795
6837
|
- *Type:* constructs.Construct
|
|
6796
6838
|
|
|
6839
|
+
The construct to add the alarm to.
|
|
6840
|
+
|
|
6797
6841
|
---
|
|
6798
6842
|
|
|
6799
6843
|
###### `id`<sup>Required</sup> <a name="id" id="@rio-cloud/cdk-v2-constructs.watchfulv2.Watchful.createAlarm.parameter.id"></a>
|
|
6800
6844
|
|
|
6801
6845
|
- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.MonitorType">MonitorType</a>
|
|
6802
6846
|
|
|
6847
|
+
The id of the alarm.
|
|
6848
|
+
|
|
6803
6849
|
---
|
|
6804
6850
|
|
|
6805
6851
|
###### `alarm`<sup>Required</sup> <a name="alarm" id="@rio-cloud/cdk-v2-constructs.watchfulv2.Watchful.createAlarm.parameter.alarm"></a>
|
|
@@ -6822,18 +6868,24 @@ Adds an alert for error logs.
|
|
|
6822
6868
|
|
|
6823
6869
|
- *Type:* constructs.Construct
|
|
6824
6870
|
|
|
6871
|
+
The construct to add the alarm to.
|
|
6872
|
+
|
|
6825
6873
|
---
|
|
6826
6874
|
|
|
6827
6875
|
###### `id`<sup>Required</sup> <a name="id" id="@rio-cloud/cdk-v2-constructs.watchfulv2.Watchful.createLogAlarm.parameter.id"></a>
|
|
6828
6876
|
|
|
6829
6877
|
- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.MonitorType">MonitorType</a>
|
|
6830
6878
|
|
|
6879
|
+
The id of the alarm.
|
|
6880
|
+
|
|
6831
6881
|
---
|
|
6832
6882
|
|
|
6833
6883
|
###### `alarm`<sup>Required</sup> <a name="alarm" id="@rio-cloud/cdk-v2-constructs.watchfulv2.Watchful.createLogAlarm.parameter.alarm"></a>
|
|
6834
6884
|
|
|
6835
6885
|
- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.LogAlarmProps">LogAlarmProps</a>
|
|
6836
6886
|
|
|
6887
|
+
The alarm properties see {@link LogAlarmProps}.
|
|
6888
|
+
|
|
6837
6889
|
---
|
|
6838
6890
|
|
|
6839
6891
|
##### `overrideAlarmThreshold` <a name="overrideAlarmThreshold" id="@rio-cloud/cdk-v2-constructs.watchfulv2.Watchful.overrideAlarmThreshold"></a>
|
|
@@ -6870,6 +6922,8 @@ An application load balancer that should be watched [disable-awslint:ref-via-int
|
|
|
6870
6922
|
|
|
6871
6923
|
- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.WatchApplicationLoadBalancerOptions">WatchApplicationLoadBalancerOptions</a>
|
|
6872
6924
|
|
|
6925
|
+
Additional options for the watch see {@link WatchApplicationLoadBalancerOptions}.
|
|
6926
|
+
|
|
6873
6927
|
---
|
|
6874
6928
|
|
|
6875
6929
|
##### `watchApplicationTargetGroup` <a name="watchApplicationTargetGroup" id="@rio-cloud/cdk-v2-constructs.watchfulv2.Watchful.watchApplicationTargetGroup"></a>
|
|
@@ -6892,6 +6946,8 @@ An application target group that should be watched [disable-awslint:ref-via-inte
|
|
|
6892
6946
|
|
|
6893
6947
|
- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.WatchApplicationTargetGroupOptions">WatchApplicationTargetGroupOptions</a>
|
|
6894
6948
|
|
|
6949
|
+
Additional options for the watch see {@link WatchApplicationTargetGroupOptions}.
|
|
6950
|
+
|
|
6895
6951
|
---
|
|
6896
6952
|
|
|
6897
6953
|
##### `watchCloudfrontDistribution` <a name="watchCloudfrontDistribution" id="@rio-cloud/cdk-v2-constructs.watchfulv2.Watchful.watchCloudfrontDistribution"></a>
|
|
@@ -6914,6 +6970,8 @@ A Cloudfront Distribution that should be watched [disable-awslint:ref-via-interf
|
|
|
6914
6970
|
|
|
6915
6971
|
- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.WatchCloudfrontDistributionOptions">WatchCloudfrontDistributionOptions</a>
|
|
6916
6972
|
|
|
6973
|
+
Additional options for the watch see {@link WatchCloudfrontDistributionOptions}.
|
|
6974
|
+
|
|
6917
6975
|
---
|
|
6918
6976
|
|
|
6919
6977
|
##### `watchDatabaseCluster` <a name="watchDatabaseCluster" id="@rio-cloud/cdk-v2-constructs.watchfulv2.Watchful.watchDatabaseCluster"></a>
|
|
@@ -6936,6 +6994,8 @@ An database cluster that should be watched [disable-awslint:ref-via-interface].
|
|
|
6936
6994
|
|
|
6937
6995
|
- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.WatchDatabaseClusterOptions">WatchDatabaseClusterOptions</a>
|
|
6938
6996
|
|
|
6997
|
+
Additional options for the watch see {@link WatchDatabaseClusterOptions}.
|
|
6998
|
+
|
|
6939
6999
|
---
|
|
6940
7000
|
|
|
6941
7001
|
##### `watchDocDb` <a name="watchDocDb" id="@rio-cloud/cdk-v2-constructs.watchfulv2.Watchful.watchDocDb"></a>
|
|
@@ -6958,6 +7018,8 @@ An DocDb cluster that should be watched [disable-awslint:ref-via-interface].
|
|
|
6958
7018
|
|
|
6959
7019
|
- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.WatchDocDbClusterOptions">WatchDocDbClusterOptions</a>
|
|
6960
7020
|
|
|
7021
|
+
Additional options for the watch see {@link WatchDocDbClusterOptions}.
|
|
7022
|
+
|
|
6961
7023
|
---
|
|
6962
7024
|
|
|
6963
7025
|
##### `watchDynamoDbTable` <a name="watchDynamoDbTable" id="@rio-cloud/cdk-v2-constructs.watchfulv2.Watchful.watchDynamoDbTable"></a>
|
|
@@ -6980,6 +7042,8 @@ An database cluster that should be watched [disable-awslint:ref-via-interface].
|
|
|
6980
7042
|
|
|
6981
7043
|
- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.WatchDynamoDbTableOptions">WatchDynamoDbTableOptions</a>
|
|
6982
7044
|
|
|
7045
|
+
Additional options for the watch see {@link WatchDynamoDbTableOptions}.
|
|
7046
|
+
|
|
6983
7047
|
---
|
|
6984
7048
|
|
|
6985
7049
|
##### `watchEcsService` <a name="watchEcsService" id="@rio-cloud/cdk-v2-constructs.watchfulv2.Watchful.watchEcsService"></a>
|
|
@@ -7002,6 +7066,8 @@ An ECS service that should be watched [disable-awslint:ref-via-interface].
|
|
|
7002
7066
|
|
|
7003
7067
|
- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.WatchEcsServiceOptions">WatchEcsServiceOptions</a>
|
|
7004
7068
|
|
|
7069
|
+
Additional options for the watch see {@link WatchEcsServiceOptions}.
|
|
7070
|
+
|
|
7005
7071
|
---
|
|
7006
7072
|
|
|
7007
7073
|
##### `watchLambdaFunction` <a name="watchLambdaFunction" id="@rio-cloud/cdk-v2-constructs.watchfulv2.Watchful.watchLambdaFunction"></a>
|
|
@@ -7024,6 +7090,8 @@ A lambda function that should be watched [disable-awslint:ref-via-interface].
|
|
|
7024
7090
|
|
|
7025
7091
|
- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.WatchLambdaFunctionOptions">WatchLambdaFunctionOptions</a>
|
|
7026
7092
|
|
|
7093
|
+
Additional options for the watch see {@link WatchLambdaFunctionOptions}.
|
|
7094
|
+
|
|
7027
7095
|
---
|
|
7028
7096
|
|
|
7029
7097
|
##### `watchScope` <a name="watchScope" id="@rio-cloud/cdk-v2-constructs.watchfulv2.Watchful.watchScope"></a>
|
|
@@ -8158,7 +8226,7 @@ The image used to start a container.
|
|
|
8158
8226
|
|
|
8159
8227
|
This string is passed directly to the Docker daemon.
|
|
8160
8228
|
Images in the Docker Hub registry are available by default.
|
|
8161
|
-
Other repositories are specified with either repository-url/image:tag or repository-url/image
|
|
8229
|
+
Other repositories are specified with either repository-url/image:tag or repository-url/image\@digest.
|
|
8162
8230
|
|
|
8163
8231
|
---
|
|
8164
8232
|
|
|
@@ -8249,7 +8317,7 @@ The image used to start a container.
|
|
|
8249
8317
|
|
|
8250
8318
|
This string is passed directly to the Docker daemon.
|
|
8251
8319
|
Images in the Docker Hub registry are available by default.
|
|
8252
|
-
Other repositories are specified with either repository-url/image:tag or repository-url/image
|
|
8320
|
+
Other repositories are specified with either repository-url/image:tag or repository-url/image\@digest.
|
|
8253
8321
|
|
|
8254
8322
|
---
|
|
8255
8323
|
|
|
@@ -8338,7 +8406,7 @@ The Dashboard definition as exported from Datadog: ```ts import dashboardDefinit
|
|
|
8338
8406
|
new DatadogDashboard(this, 'SampleDashboard', { dashboardDefinition })
|
|
8339
8407
|
```
|
|
8340
8408
|
|
|
8341
|
-
References to {@link
|
|
8409
|
+
References to {@link ./datadog-monitor.ts.#DatadogMonitor}. will not be resolved at the moment.
|
|
8342
8410
|
|
|
8343
8411
|
---
|
|
8344
8412
|
|
|
@@ -8385,11 +8453,11 @@ Defaults are:
|
|
|
8385
8453
|
* env: Set to RioFargateServiceProps#stage prop
|
|
8386
8454
|
* service: Set to RioFargateServiceProps#serviceName prop
|
|
8387
8455
|
* version: Set to RioFargateServiceProps#version prop
|
|
8388
|
-
* account_id
|
|
8389
|
-
* account_name
|
|
8390
|
-
* region
|
|
8391
|
-
* team
|
|
8392
|
-
* team_identifier
|
|
8456
|
+
* account_id:$\{accountID\}
|
|
8457
|
+
* account_name:$\{accountName\}
|
|
8458
|
+
* region:$\{AWSRegion\}
|
|
8459
|
+
* team:$\{teamName from ssm param /config/team/name\}
|
|
8460
|
+
* team_identifier:$\{teamIdentifier from ssm param /config/team/identifier\}
|
|
8393
8461
|
|
|
8394
8462
|
---
|
|
8395
8463
|
|
|
@@ -8534,11 +8602,11 @@ Defaults are:
|
|
|
8534
8602
|
* env: Set to RioFargateServiceProps#stage prop
|
|
8535
8603
|
* service: Set to RioFargateServiceProps#serviceName prop
|
|
8536
8604
|
* version: Set to RioFargateServiceProps#version prop
|
|
8537
|
-
* account_id
|
|
8538
|
-
* account_name
|
|
8539
|
-
* region
|
|
8540
|
-
* team
|
|
8541
|
-
* team_identifier
|
|
8605
|
+
* account_id:$\{accountID\}
|
|
8606
|
+
* account_name:$\{accountName\}
|
|
8607
|
+
* region:$\{AWSRegion\}
|
|
8608
|
+
* team:$\{teamName from ssm param /config/team/name\}
|
|
8609
|
+
* team_identifier:$\{teamIdentifier from ssm param /config/team/identifier\}
|
|
8542
8610
|
|
|
8543
8611
|
---
|
|
8544
8612
|
|
|
@@ -9865,7 +9933,7 @@ const datadogMonitorProps: DatadogMonitorProps = { ... }
|
|
|
9865
9933
|
| <code><a href="#@rio-cloud/cdk-v2-constructs.DatadogMonitorProps.property.monitor">monitor</a></code> | <code>{[ key: string ]: any}</code> | Monitor definition. |
|
|
9866
9934
|
| <code><a href="#@rio-cloud/cdk-v2-constructs.DatadogMonitorProps.property.serviceName">serviceName</a></code> | <code>string</code> | The name of the service to which the monitor belongs. |
|
|
9867
9935
|
| <code><a href="#@rio-cloud/cdk-v2-constructs.DatadogMonitorProps.property.alertTypes">alertTypes</a></code> | <code>string[]</code> | Type of alert. |
|
|
9868
|
-
| <code><a href="#@rio-cloud/cdk-v2-constructs.DatadogMonitorProps.property.autoCloseOpsGenieAlerts">autoCloseOpsGenieAlerts</a></code> | <code>boolean</code> | 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. |
|
|
9936
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.DatadogMonitorProps.property.autoCloseOpsGenieAlerts">autoCloseOpsGenieAlerts</a></code> | <code>boolean</code> | 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. |
|
|
9869
9937
|
|
|
9870
9938
|
---
|
|
9871
9939
|
|
|
@@ -9919,7 +9987,7 @@ public readonly autoCloseOpsGenieAlerts: boolean;
|
|
|
9919
9987
|
|
|
9920
9988
|
- *Type:* boolean
|
|
9921
9989
|
|
|
9922
|
-
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.
|
|
9990
|
+
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.
|
|
9923
9991
|
|
|
9924
9992
|
---
|
|
9925
9993
|
|
|
@@ -9940,7 +10008,7 @@ const datadogMonitorProps: datadog.DatadogMonitorProps = { ... }
|
|
|
9940
10008
|
| <code><a href="#@rio-cloud/cdk-v2-constructs.datadog.DatadogMonitorProps.property.monitor">monitor</a></code> | <code>{[ key: string ]: any}</code> | Monitor definition. |
|
|
9941
10009
|
| <code><a href="#@rio-cloud/cdk-v2-constructs.datadog.DatadogMonitorProps.property.serviceName">serviceName</a></code> | <code>string</code> | The name of the service to which the monitor belongs. |
|
|
9942
10010
|
| <code><a href="#@rio-cloud/cdk-v2-constructs.datadog.DatadogMonitorProps.property.alertTypes">alertTypes</a></code> | <code>string[]</code> | Type of alert. |
|
|
9943
|
-
| <code><a href="#@rio-cloud/cdk-v2-constructs.datadog.DatadogMonitorProps.property.autoCloseOpsGenieAlerts">autoCloseOpsGenieAlerts</a></code> | <code>boolean</code> | 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. |
|
|
10011
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.datadog.DatadogMonitorProps.property.autoCloseOpsGenieAlerts">autoCloseOpsGenieAlerts</a></code> | <code>boolean</code> | 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. |
|
|
9944
10012
|
|
|
9945
10013
|
---
|
|
9946
10014
|
|
|
@@ -9994,7 +10062,7 @@ public readonly autoCloseOpsGenieAlerts: boolean;
|
|
|
9994
10062
|
|
|
9995
10063
|
- *Type:* boolean
|
|
9996
10064
|
|
|
9997
|
-
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.
|
|
10065
|
+
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.
|
|
9998
10066
|
|
|
9999
10067
|
---
|
|
10000
10068
|
|
|
@@ -12361,7 +12429,7 @@ public readonly createCasesFromErrorLogMonitors: boolean;
|
|
|
12361
12429
|
```
|
|
12362
12430
|
|
|
12363
12431
|
- *Type:* boolean
|
|
12364
|
-
- *Default:*
|
|
12432
|
+
- *Default:* false
|
|
12365
12433
|
|
|
12366
12434
|
Enable error log monitors creating cases in Datadog.
|
|
12367
12435
|
|
|
@@ -13112,7 +13180,7 @@ const pipelineStackRioMonitoringDeployStepProps: PipelineStackRioMonitoringDeplo
|
|
|
13112
13180
|
|
|
13113
13181
|
| **Name** | **Type** | **Description** |
|
|
13114
13182
|
| --- | --- | --- |
|
|
13115
|
-
| <code><a href="#@rio-cloud/cdk-v2-constructs.PipelineStackRioMonitoringDeployStepProps.property.monitoringArtifacts">monitoringArtifacts</a></code> | <code>{[ key: string ]: string[]}</code> | 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'], } ```. |
|
|
13183
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.PipelineStackRioMonitoringDeployStepProps.property.monitoringArtifacts">monitoringArtifacts</a></code> | <code>{[ key: string ]: string[]}</code> | 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'], } ```. |
|
|
13116
13184
|
|
|
13117
13185
|
---
|
|
13118
13186
|
|
|
@@ -13124,7 +13192,7 @@ public readonly monitoringArtifacts: {[ key: string ]: string[]};
|
|
|
13124
13192
|
|
|
13125
13193
|
- *Type:* {[ key: string ]: string[]}
|
|
13126
13194
|
|
|
13127
|
-
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'], } ```.
|
|
13195
|
+
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'], } ```.
|
|
13128
13196
|
|
|
13129
13197
|
---
|
|
13130
13198
|
|
|
@@ -13780,7 +13848,9 @@ public readonly consumerGroupId: string;
|
|
|
13780
13848
|
|
|
13781
13849
|
The identifier for the Kafka consumer group to join.
|
|
13782
13850
|
|
|
13783
|
-
The consumer group ID must be unique among all your Kafka event sources.
|
|
13851
|
+
The consumer group ID must be unique among all your Kafka event sources.
|
|
13852
|
+
After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value.
|
|
13853
|
+
The value must have a lenght between 1 and 200 and full the pattern '[a-zA-Z0-9-\/*:_+=.\@-]*'.
|
|
13784
13854
|
|
|
13785
13855
|
> [https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id)
|
|
13786
13856
|
|
|
@@ -13918,7 +13988,9 @@ public readonly consumerGroupId: string;
|
|
|
13918
13988
|
|
|
13919
13989
|
The identifier for the Kafka consumer group to join.
|
|
13920
13990
|
|
|
13921
|
-
The consumer group ID must be unique among all your Kafka event sources.
|
|
13991
|
+
The consumer group ID must be unique among all your Kafka event sources.
|
|
13992
|
+
After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value.
|
|
13993
|
+
The value must have a lenght between 1 and 200 and full the pattern '[a-zA-Z0-9-\/*:_+=.\@-]*'.
|
|
13922
13994
|
|
|
13923
13995
|
> [https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id)
|
|
13924
13996
|
|
|
@@ -14146,7 +14218,7 @@ const slackNotificationProps: datadogv2.SlackNotificationProps = { ... }
|
|
|
14146
14218
|
|
|
14147
14219
|
| **Name** | **Type** | **Description** |
|
|
14148
14220
|
| --- | --- | --- |
|
|
14149
|
-
| <code><a href="#@rio-cloud/cdk-v2-constructs.datadogv2.SlackNotificationProps.property.channel">channel</a></code> | <code>string</code> | the
|
|
14221
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.datadogv2.SlackNotificationProps.property.channel">channel</a></code> | <code>string</code> | the Slack channel to route the alert to. |
|
|
14150
14222
|
|
|
14151
14223
|
---
|
|
14152
14224
|
|
|
@@ -14158,7 +14230,7 @@ public readonly channel: string;
|
|
|
14158
14230
|
|
|
14159
14231
|
- *Type:* string
|
|
14160
14232
|
|
|
14161
|
-
the
|
|
14233
|
+
the Slack channel to route the alert to.
|
|
14162
14234
|
|
|
14163
14235
|
---
|
|
14164
14236
|
|
|
@@ -15074,6 +15146,7 @@ const watchEcsServiceOptions: WatchEcsServiceOptions = { ... }
|
|
|
15074
15146
|
| --- | --- | --- |
|
|
15075
15147
|
| <code><a href="#@rio-cloud/cdk-v2-constructs.WatchEcsServiceOptions.property.cpuUtilizationThresholdPercent">cpuUtilizationThresholdPercent</a></code> | <code>number</code> | Threshold for the cpu utilization alarm as percentage. |
|
|
15076
15148
|
| <code><a href="#@rio-cloud/cdk-v2-constructs.WatchEcsServiceOptions.property.memoryUtilizationThresholdPercent">memoryUtilizationThresholdPercent</a></code> | <code>number</code> | Threshold for the memory utilization alarm as percentage. |
|
|
15149
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.WatchEcsServiceOptions.property.minimumNumberOfTasks">minimumNumberOfTasks</a></code> | <code>number</code> | Minimum number of tasks that should be running. |
|
|
15077
15150
|
|
|
15078
15151
|
---
|
|
15079
15152
|
|
|
@@ -15103,6 +15176,19 @@ Threshold for the memory utilization alarm as percentage.
|
|
|
15103
15176
|
|
|
15104
15177
|
---
|
|
15105
15178
|
|
|
15179
|
+
##### `minimumNumberOfTasks`<sup>Optional</sup> <a name="minimumNumberOfTasks" id="@rio-cloud/cdk-v2-constructs.WatchEcsServiceOptions.property.minimumNumberOfTasks"></a>
|
|
15180
|
+
|
|
15181
|
+
```typescript
|
|
15182
|
+
public readonly minimumNumberOfTasks: number;
|
|
15183
|
+
```
|
|
15184
|
+
|
|
15185
|
+
- *Type:* number
|
|
15186
|
+
- *Default:* 1
|
|
15187
|
+
|
|
15188
|
+
Minimum number of tasks that should be running.
|
|
15189
|
+
|
|
15190
|
+
---
|
|
15191
|
+
|
|
15106
15192
|
### WatchEcsServiceProps <a name="WatchEcsServiceProps" id="@rio-cloud/cdk-v2-constructs.WatchEcsServiceProps"></a>
|
|
15107
15193
|
|
|
15108
15194
|
Properties for defining a WatchEcsService.
|
|
@@ -15121,6 +15207,7 @@ const watchEcsServiceProps: WatchEcsServiceProps = { ... }
|
|
|
15121
15207
|
| --- | --- | --- |
|
|
15122
15208
|
| <code><a href="#@rio-cloud/cdk-v2-constructs.WatchEcsServiceProps.property.cpuUtilizationThresholdPercent">cpuUtilizationThresholdPercent</a></code> | <code>number</code> | Threshold for the cpu utilization alarm as percentage. |
|
|
15123
15209
|
| <code><a href="#@rio-cloud/cdk-v2-constructs.WatchEcsServiceProps.property.memoryUtilizationThresholdPercent">memoryUtilizationThresholdPercent</a></code> | <code>number</code> | Threshold for the memory utilization alarm as percentage. |
|
|
15210
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.WatchEcsServiceProps.property.minimumNumberOfTasks">minimumNumberOfTasks</a></code> | <code>number</code> | Minimum number of tasks that should be running. |
|
|
15124
15211
|
| <code><a href="#@rio-cloud/cdk-v2-constructs.WatchEcsServiceProps.property.service">service</a></code> | <code>aws-cdk-lib.aws_ecs.BaseService</code> | The ECS service that should be watched. |
|
|
15125
15212
|
| <code><a href="#@rio-cloud/cdk-v2-constructs.WatchEcsServiceProps.property.watchful">watchful</a></code> | <code><a href="#@rio-cloud/cdk-v2-constructs.IWatchful">IWatchful</a></code> | The reference to IWatchful class. |
|
|
15126
15213
|
|
|
@@ -15152,6 +15239,19 @@ Threshold for the memory utilization alarm as percentage.
|
|
|
15152
15239
|
|
|
15153
15240
|
---
|
|
15154
15241
|
|
|
15242
|
+
##### `minimumNumberOfTasks`<sup>Optional</sup> <a name="minimumNumberOfTasks" id="@rio-cloud/cdk-v2-constructs.WatchEcsServiceProps.property.minimumNumberOfTasks"></a>
|
|
15243
|
+
|
|
15244
|
+
```typescript
|
|
15245
|
+
public readonly minimumNumberOfTasks: number;
|
|
15246
|
+
```
|
|
15247
|
+
|
|
15248
|
+
- *Type:* number
|
|
15249
|
+
- *Default:* 1
|
|
15250
|
+
|
|
15251
|
+
Minimum number of tasks that should be running.
|
|
15252
|
+
|
|
15253
|
+
---
|
|
15254
|
+
|
|
15155
15255
|
##### `service`<sup>Required</sup> <a name="service" id="@rio-cloud/cdk-v2-constructs.WatchEcsServiceProps.property.service"></a>
|
|
15156
15256
|
|
|
15157
15257
|
```typescript
|
|
@@ -15288,7 +15388,7 @@ public readonly createCasesFromErrorLogMonitors: boolean;
|
|
|
15288
15388
|
```
|
|
15289
15389
|
|
|
15290
15390
|
- *Type:* boolean
|
|
15291
|
-
- *Default:*
|
|
15391
|
+
- *Default:* false
|
|
15292
15392
|
|
|
15293
15393
|
Enable error log monitors creating cases in Datadog.
|
|
15294
15394
|
|
|
@@ -15862,6 +15962,674 @@ Example - route issues based on their priority:
|
|
|
15862
15962
|
|
|
15863
15963
|
|
|
15864
15964
|
|
|
15965
|
+
### EcrPullThroughCachePolicyStatement <a name="EcrPullThroughCachePolicyStatement" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement"></a>
|
|
15966
|
+
|
|
15967
|
+
#### Initializers <a name="Initializers" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.Initializer"></a>
|
|
15968
|
+
|
|
15969
|
+
```typescript
|
|
15970
|
+
import { iam } from '@rio-cloud/cdk-v2-constructs'
|
|
15971
|
+
|
|
15972
|
+
new iam.EcrPullThroughCachePolicyStatement()
|
|
15973
|
+
```
|
|
15974
|
+
|
|
15975
|
+
| **Name** | **Type** | **Description** |
|
|
15976
|
+
| --- | --- | --- |
|
|
15977
|
+
|
|
15978
|
+
---
|
|
15979
|
+
|
|
15980
|
+
#### Methods <a name="Methods" id="Methods"></a>
|
|
15981
|
+
|
|
15982
|
+
| **Name** | **Description** |
|
|
15983
|
+
| --- | --- |
|
|
15984
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addAccountCondition">addAccountCondition</a></code> | Add a `StringEquals` condition that limits to a given account from `sts:ExternalId`. |
|
|
15985
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addAccountRootPrincipal">addAccountRootPrincipal</a></code> | Adds an AWS account root user principal to this policy statement. |
|
|
15986
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addActions">addActions</a></code> | Specify allowed actions into the "Action" section of the policy statement. |
|
|
15987
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addAllResources">addAllResources</a></code> | Adds a ``"*"`` resource to this statement. |
|
|
15988
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addAnyPrincipal">addAnyPrincipal</a></code> | Adds all identities in all accounts ("*") to this policy statement. |
|
|
15989
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addArnPrincipal">addArnPrincipal</a></code> | Specify a principal using the ARN identifier of the principal. |
|
|
15990
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addAwsAccountPrincipal">addAwsAccountPrincipal</a></code> | Specify AWS account ID as the principal entity to the "Principal" section of a policy statement. |
|
|
15991
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addCanonicalUserPrincipal">addCanonicalUserPrincipal</a></code> | Adds a canonical user ID principal to this policy document. |
|
|
15992
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addCondition">addCondition</a></code> | Add a condition to the Policy. |
|
|
15993
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addConditions">addConditions</a></code> | Add multiple conditions to the Policy. |
|
|
15994
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addFederatedPrincipal">addFederatedPrincipal</a></code> | Adds a federated identity provider such as Amazon Cognito to this policy statement. |
|
|
15995
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addNotActions">addNotActions</a></code> | Explicitly allow all actions except the specified list of actions into the "NotAction" section of the policy document. |
|
|
15996
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addNotPrincipals">addNotPrincipals</a></code> | Specify principals that is not allowed or denied access to the "NotPrincipal" section of a policy statement. |
|
|
15997
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addNotResources">addNotResources</a></code> | Specify resources that this policy statement will not apply to in the "NotResource" section of this policy statement. |
|
|
15998
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addPrincipals">addPrincipals</a></code> | Adds principals to the "Principal" section of a policy statement. |
|
|
15999
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addResources">addResources</a></code> | Specify resources that this policy statement applies into the "Resource" section of this policy statement. |
|
|
16000
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addServicePrincipal">addServicePrincipal</a></code> | Adds a service principal to this policy statement. |
|
|
16001
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addSourceAccountCondition">addSourceAccountCondition</a></code> | Add an `StringEquals` condition that limits to a given account from `aws:SourceAccount`. |
|
|
16002
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addSourceArnCondition">addSourceArnCondition</a></code> | Add an `ArnEquals` condition that limits to a given resource arn from `aws:SourceArn`. |
|
|
16003
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.copy">copy</a></code> | Create a new `PolicyStatement` with the same exact properties as this one, except for the overrides. |
|
|
16004
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.freeze">freeze</a></code> | Make the PolicyStatement immutable. |
|
|
16005
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.toJSON">toJSON</a></code> | JSON-ify the statement. |
|
|
16006
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.toStatementJson">toStatementJson</a></code> | JSON-ify the policy statement. |
|
|
16007
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.toString">toString</a></code> | String representation of this policy statement. |
|
|
16008
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.validateForAnyPolicy">validateForAnyPolicy</a></code> | Validate that the policy statement satisfies base requirements for a policy. |
|
|
16009
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.validateForIdentityPolicy">validateForIdentityPolicy</a></code> | Validate that the policy statement satisfies all requirements for an identity-based policy. |
|
|
16010
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.validateForResourcePolicy">validateForResourcePolicy</a></code> | Validate that the policy statement satisfies all requirements for a resource-based policy. |
|
|
16011
|
+
|
|
16012
|
+
---
|
|
16013
|
+
|
|
16014
|
+
##### `addAccountCondition` <a name="addAccountCondition" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addAccountCondition"></a>
|
|
16015
|
+
|
|
16016
|
+
```typescript
|
|
16017
|
+
public addAccountCondition(accountId: string): void
|
|
16018
|
+
```
|
|
16019
|
+
|
|
16020
|
+
Add a `StringEquals` condition that limits to a given account from `sts:ExternalId`.
|
|
16021
|
+
|
|
16022
|
+
This method can only be called once: subsequent calls will overwrite earlier calls.
|
|
16023
|
+
|
|
16024
|
+
> [https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html)
|
|
16025
|
+
|
|
16026
|
+
###### `accountId`<sup>Required</sup> <a name="accountId" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addAccountCondition.parameter.accountId"></a>
|
|
16027
|
+
|
|
16028
|
+
- *Type:* string
|
|
16029
|
+
|
|
16030
|
+
---
|
|
16031
|
+
|
|
16032
|
+
##### `addAccountRootPrincipal` <a name="addAccountRootPrincipal" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addAccountRootPrincipal"></a>
|
|
16033
|
+
|
|
16034
|
+
```typescript
|
|
16035
|
+
public addAccountRootPrincipal(): void
|
|
16036
|
+
```
|
|
16037
|
+
|
|
16038
|
+
Adds an AWS account root user principal to this policy statement.
|
|
16039
|
+
|
|
16040
|
+
##### `addActions` <a name="addActions" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addActions"></a>
|
|
16041
|
+
|
|
16042
|
+
```typescript
|
|
16043
|
+
public addActions(actions: string): void
|
|
16044
|
+
```
|
|
16045
|
+
|
|
16046
|
+
Specify allowed actions into the "Action" section of the policy statement.
|
|
16047
|
+
|
|
16048
|
+
> [https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_action.html](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_action.html)
|
|
16049
|
+
|
|
16050
|
+
###### `actions`<sup>Required</sup> <a name="actions" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addActions.parameter.actions"></a>
|
|
16051
|
+
|
|
16052
|
+
- *Type:* string
|
|
16053
|
+
|
|
16054
|
+
actions that will be allowed.
|
|
16055
|
+
|
|
16056
|
+
---
|
|
16057
|
+
|
|
16058
|
+
##### `addAllResources` <a name="addAllResources" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addAllResources"></a>
|
|
16059
|
+
|
|
16060
|
+
```typescript
|
|
16061
|
+
public addAllResources(): void
|
|
16062
|
+
```
|
|
16063
|
+
|
|
16064
|
+
Adds a ``"*"`` resource to this statement.
|
|
16065
|
+
|
|
16066
|
+
##### `addAnyPrincipal` <a name="addAnyPrincipal" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addAnyPrincipal"></a>
|
|
16067
|
+
|
|
16068
|
+
```typescript
|
|
16069
|
+
public addAnyPrincipal(): void
|
|
16070
|
+
```
|
|
16071
|
+
|
|
16072
|
+
Adds all identities in all accounts ("*") to this policy statement.
|
|
16073
|
+
|
|
16074
|
+
##### `addArnPrincipal` <a name="addArnPrincipal" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addArnPrincipal"></a>
|
|
16075
|
+
|
|
16076
|
+
```typescript
|
|
16077
|
+
public addArnPrincipal(arn: string): void
|
|
16078
|
+
```
|
|
16079
|
+
|
|
16080
|
+
Specify a principal using the ARN identifier of the principal.
|
|
16081
|
+
|
|
16082
|
+
You cannot specify IAM groups and instance profiles as principals.
|
|
16083
|
+
|
|
16084
|
+
###### `arn`<sup>Required</sup> <a name="arn" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addArnPrincipal.parameter.arn"></a>
|
|
16085
|
+
|
|
16086
|
+
- *Type:* string
|
|
16087
|
+
|
|
16088
|
+
ARN identifier of AWS account, IAM user, or IAM role (i.e. arn:aws:iam::123456789012:user/user-name).
|
|
16089
|
+
|
|
16090
|
+
---
|
|
16091
|
+
|
|
16092
|
+
##### `addAwsAccountPrincipal` <a name="addAwsAccountPrincipal" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addAwsAccountPrincipal"></a>
|
|
16093
|
+
|
|
16094
|
+
```typescript
|
|
16095
|
+
public addAwsAccountPrincipal(accountId: string): void
|
|
16096
|
+
```
|
|
16097
|
+
|
|
16098
|
+
Specify AWS account ID as the principal entity to the "Principal" section of a policy statement.
|
|
16099
|
+
|
|
16100
|
+
###### `accountId`<sup>Required</sup> <a name="accountId" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addAwsAccountPrincipal.parameter.accountId"></a>
|
|
16101
|
+
|
|
16102
|
+
- *Type:* string
|
|
16103
|
+
|
|
16104
|
+
---
|
|
16105
|
+
|
|
16106
|
+
##### `addCanonicalUserPrincipal` <a name="addCanonicalUserPrincipal" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addCanonicalUserPrincipal"></a>
|
|
16107
|
+
|
|
16108
|
+
```typescript
|
|
16109
|
+
public addCanonicalUserPrincipal(canonicalUserId: string): void
|
|
16110
|
+
```
|
|
16111
|
+
|
|
16112
|
+
Adds a canonical user ID principal to this policy document.
|
|
16113
|
+
|
|
16114
|
+
###### `canonicalUserId`<sup>Required</sup> <a name="canonicalUserId" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addCanonicalUserPrincipal.parameter.canonicalUserId"></a>
|
|
16115
|
+
|
|
16116
|
+
- *Type:* string
|
|
16117
|
+
|
|
16118
|
+
unique identifier assigned by AWS for every account.
|
|
16119
|
+
|
|
16120
|
+
---
|
|
16121
|
+
|
|
16122
|
+
##### `addCondition` <a name="addCondition" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addCondition"></a>
|
|
16123
|
+
|
|
16124
|
+
```typescript
|
|
16125
|
+
public addCondition(key: string, value: any): void
|
|
16126
|
+
```
|
|
16127
|
+
|
|
16128
|
+
Add a condition to the Policy.
|
|
16129
|
+
|
|
16130
|
+
If multiple calls are made to add a condition with the same operator and field, only
|
|
16131
|
+
the last one wins. For example:
|
|
16132
|
+
|
|
16133
|
+
```ts
|
|
16134
|
+
declare const stmt: iam.PolicyStatement;
|
|
16135
|
+
|
|
16136
|
+
stmt.addCondition('StringEquals', { 'aws:SomeField': '1' });
|
|
16137
|
+
stmt.addCondition('StringEquals', { 'aws:SomeField': '2' });
|
|
16138
|
+
```
|
|
16139
|
+
|
|
16140
|
+
Will end up with the single condition `StringEquals: { 'aws:SomeField': '2' }`.
|
|
16141
|
+
|
|
16142
|
+
If you meant to add a condition to say that the field can be *either* `1` or `2`, write
|
|
16143
|
+
this:
|
|
16144
|
+
|
|
16145
|
+
```ts
|
|
16146
|
+
declare const stmt: iam.PolicyStatement;
|
|
16147
|
+
|
|
16148
|
+
stmt.addCondition('StringEquals', { 'aws:SomeField': ['1', '2'] });
|
|
16149
|
+
```
|
|
16150
|
+
|
|
16151
|
+
###### `key`<sup>Required</sup> <a name="key" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addCondition.parameter.key"></a>
|
|
16152
|
+
|
|
16153
|
+
- *Type:* string
|
|
16154
|
+
|
|
16155
|
+
---
|
|
16156
|
+
|
|
16157
|
+
###### `value`<sup>Required</sup> <a name="value" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addCondition.parameter.value"></a>
|
|
16158
|
+
|
|
16159
|
+
- *Type:* any
|
|
16160
|
+
|
|
16161
|
+
---
|
|
16162
|
+
|
|
16163
|
+
##### `addConditions` <a name="addConditions" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addConditions"></a>
|
|
16164
|
+
|
|
16165
|
+
```typescript
|
|
16166
|
+
public addConditions(conditions: {[ key: string ]: any}): void
|
|
16167
|
+
```
|
|
16168
|
+
|
|
16169
|
+
Add multiple conditions to the Policy.
|
|
16170
|
+
|
|
16171
|
+
See the `addCondition` function for a caveat on calling this method multiple times.
|
|
16172
|
+
|
|
16173
|
+
###### `conditions`<sup>Required</sup> <a name="conditions" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addConditions.parameter.conditions"></a>
|
|
16174
|
+
|
|
16175
|
+
- *Type:* {[ key: string ]: any}
|
|
16176
|
+
|
|
16177
|
+
---
|
|
16178
|
+
|
|
16179
|
+
##### `addFederatedPrincipal` <a name="addFederatedPrincipal" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addFederatedPrincipal"></a>
|
|
16180
|
+
|
|
16181
|
+
```typescript
|
|
16182
|
+
public addFederatedPrincipal(federated: any, conditions: {[ key: string ]: any}): void
|
|
16183
|
+
```
|
|
16184
|
+
|
|
16185
|
+
Adds a federated identity provider such as Amazon Cognito to this policy statement.
|
|
16186
|
+
|
|
16187
|
+
###### `federated`<sup>Required</sup> <a name="federated" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addFederatedPrincipal.parameter.federated"></a>
|
|
16188
|
+
|
|
16189
|
+
- *Type:* any
|
|
16190
|
+
|
|
16191
|
+
federated identity provider (i.e. 'cognito-identity.amazonaws.com').
|
|
16192
|
+
|
|
16193
|
+
---
|
|
16194
|
+
|
|
16195
|
+
###### `conditions`<sup>Required</sup> <a name="conditions" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addFederatedPrincipal.parameter.conditions"></a>
|
|
16196
|
+
|
|
16197
|
+
- *Type:* {[ key: string ]: any}
|
|
16198
|
+
|
|
16199
|
+
The conditions under which the policy is in effect.
|
|
16200
|
+
|
|
16201
|
+
See [the IAM documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition.html).
|
|
16202
|
+
|
|
16203
|
+
---
|
|
16204
|
+
|
|
16205
|
+
##### `addNotActions` <a name="addNotActions" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addNotActions"></a>
|
|
16206
|
+
|
|
16207
|
+
```typescript
|
|
16208
|
+
public addNotActions(notActions: string): void
|
|
16209
|
+
```
|
|
16210
|
+
|
|
16211
|
+
Explicitly allow all actions except the specified list of actions into the "NotAction" section of the policy document.
|
|
16212
|
+
|
|
16213
|
+
> [https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_notaction.html](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_notaction.html)
|
|
16214
|
+
|
|
16215
|
+
###### `notActions`<sup>Required</sup> <a name="notActions" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addNotActions.parameter.notActions"></a>
|
|
16216
|
+
|
|
16217
|
+
- *Type:* string
|
|
16218
|
+
|
|
16219
|
+
actions that will be denied.
|
|
16220
|
+
|
|
16221
|
+
All other actions will be permitted.
|
|
16222
|
+
|
|
16223
|
+
---
|
|
16224
|
+
|
|
16225
|
+
##### `addNotPrincipals` <a name="addNotPrincipals" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addNotPrincipals"></a>
|
|
16226
|
+
|
|
16227
|
+
```typescript
|
|
16228
|
+
public addNotPrincipals(notPrincipals: IPrincipal): void
|
|
16229
|
+
```
|
|
16230
|
+
|
|
16231
|
+
Specify principals that is not allowed or denied access to the "NotPrincipal" section of a policy statement.
|
|
16232
|
+
|
|
16233
|
+
> [https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_notprincipal.html](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_notprincipal.html)
|
|
16234
|
+
|
|
16235
|
+
###### `notPrincipals`<sup>Required</sup> <a name="notPrincipals" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addNotPrincipals.parameter.notPrincipals"></a>
|
|
16236
|
+
|
|
16237
|
+
- *Type:* aws-cdk-lib.aws_iam.IPrincipal
|
|
16238
|
+
|
|
16239
|
+
IAM principals that will be denied access.
|
|
16240
|
+
|
|
16241
|
+
---
|
|
16242
|
+
|
|
16243
|
+
##### `addNotResources` <a name="addNotResources" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addNotResources"></a>
|
|
16244
|
+
|
|
16245
|
+
```typescript
|
|
16246
|
+
public addNotResources(arns: string): void
|
|
16247
|
+
```
|
|
16248
|
+
|
|
16249
|
+
Specify resources that this policy statement will not apply to in the "NotResource" section of this policy statement.
|
|
16250
|
+
|
|
16251
|
+
All resources except the specified list will be matched.
|
|
16252
|
+
|
|
16253
|
+
> [https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_notresource.html](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_notresource.html)
|
|
16254
|
+
|
|
16255
|
+
###### `arns`<sup>Required</sup> <a name="arns" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addNotResources.parameter.arns"></a>
|
|
16256
|
+
|
|
16257
|
+
- *Type:* string
|
|
16258
|
+
|
|
16259
|
+
Amazon Resource Names (ARNs) of the resources that this policy statement does not apply to.
|
|
16260
|
+
|
|
16261
|
+
---
|
|
16262
|
+
|
|
16263
|
+
##### `addPrincipals` <a name="addPrincipals" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addPrincipals"></a>
|
|
16264
|
+
|
|
16265
|
+
```typescript
|
|
16266
|
+
public addPrincipals(principals: IPrincipal): void
|
|
16267
|
+
```
|
|
16268
|
+
|
|
16269
|
+
Adds principals to the "Principal" section of a policy statement.
|
|
16270
|
+
|
|
16271
|
+
> [https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html)
|
|
16272
|
+
|
|
16273
|
+
###### `principals`<sup>Required</sup> <a name="principals" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addPrincipals.parameter.principals"></a>
|
|
16274
|
+
|
|
16275
|
+
- *Type:* aws-cdk-lib.aws_iam.IPrincipal
|
|
16276
|
+
|
|
16277
|
+
IAM principals that will be added.
|
|
16278
|
+
|
|
16279
|
+
---
|
|
16280
|
+
|
|
16281
|
+
##### `addResources` <a name="addResources" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addResources"></a>
|
|
16282
|
+
|
|
16283
|
+
```typescript
|
|
16284
|
+
public addResources(arns: string): void
|
|
16285
|
+
```
|
|
16286
|
+
|
|
16287
|
+
Specify resources that this policy statement applies into the "Resource" section of this policy statement.
|
|
16288
|
+
|
|
16289
|
+
> [https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_resource.html](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_resource.html)
|
|
16290
|
+
|
|
16291
|
+
###### `arns`<sup>Required</sup> <a name="arns" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addResources.parameter.arns"></a>
|
|
16292
|
+
|
|
16293
|
+
- *Type:* string
|
|
16294
|
+
|
|
16295
|
+
Amazon Resource Names (ARNs) of the resources that this policy statement applies to.
|
|
16296
|
+
|
|
16297
|
+
---
|
|
16298
|
+
|
|
16299
|
+
##### `addServicePrincipal` <a name="addServicePrincipal" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addServicePrincipal"></a>
|
|
16300
|
+
|
|
16301
|
+
```typescript
|
|
16302
|
+
public addServicePrincipal(service: string, opts?: ServicePrincipalOpts): void
|
|
16303
|
+
```
|
|
16304
|
+
|
|
16305
|
+
Adds a service principal to this policy statement.
|
|
16306
|
+
|
|
16307
|
+
###### `service`<sup>Required</sup> <a name="service" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addServicePrincipal.parameter.service"></a>
|
|
16308
|
+
|
|
16309
|
+
- *Type:* string
|
|
16310
|
+
|
|
16311
|
+
the service name for which a service principal is requested (e.g: `s3.amazonaws.com`).
|
|
16312
|
+
|
|
16313
|
+
---
|
|
16314
|
+
|
|
16315
|
+
###### `opts`<sup>Optional</sup> <a name="opts" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addServicePrincipal.parameter.opts"></a>
|
|
16316
|
+
|
|
16317
|
+
- *Type:* aws-cdk-lib.aws_iam.ServicePrincipalOpts
|
|
16318
|
+
|
|
16319
|
+
options for adding the service principal (such as specifying a principal in a different region).
|
|
16320
|
+
|
|
16321
|
+
---
|
|
16322
|
+
|
|
16323
|
+
##### `addSourceAccountCondition` <a name="addSourceAccountCondition" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addSourceAccountCondition"></a>
|
|
16324
|
+
|
|
16325
|
+
```typescript
|
|
16326
|
+
public addSourceAccountCondition(accountId: string): void
|
|
16327
|
+
```
|
|
16328
|
+
|
|
16329
|
+
Add an `StringEquals` condition that limits to a given account from `aws:SourceAccount`.
|
|
16330
|
+
|
|
16331
|
+
This method can only be called once: subsequent calls will overwrite earlier calls.
|
|
16332
|
+
|
|
16333
|
+
> [https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourceaccount](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourceaccount)
|
|
16334
|
+
|
|
16335
|
+
###### `accountId`<sup>Required</sup> <a name="accountId" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addSourceAccountCondition.parameter.accountId"></a>
|
|
16336
|
+
|
|
16337
|
+
- *Type:* string
|
|
16338
|
+
|
|
16339
|
+
---
|
|
16340
|
+
|
|
16341
|
+
##### `addSourceArnCondition` <a name="addSourceArnCondition" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addSourceArnCondition"></a>
|
|
16342
|
+
|
|
16343
|
+
```typescript
|
|
16344
|
+
public addSourceArnCondition(arn: string): void
|
|
16345
|
+
```
|
|
16346
|
+
|
|
16347
|
+
Add an `ArnEquals` condition that limits to a given resource arn from `aws:SourceArn`.
|
|
16348
|
+
|
|
16349
|
+
This method can only be called once: subsequent calls will overwrite earlier calls.
|
|
16350
|
+
|
|
16351
|
+
> [https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcearn](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcearn)
|
|
16352
|
+
|
|
16353
|
+
###### `arn`<sup>Required</sup> <a name="arn" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.addSourceArnCondition.parameter.arn"></a>
|
|
16354
|
+
|
|
16355
|
+
- *Type:* string
|
|
16356
|
+
|
|
16357
|
+
---
|
|
16358
|
+
|
|
16359
|
+
##### `copy` <a name="copy" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.copy"></a>
|
|
16360
|
+
|
|
16361
|
+
```typescript
|
|
16362
|
+
public copy(overrides?: PolicyStatementProps): PolicyStatement
|
|
16363
|
+
```
|
|
16364
|
+
|
|
16365
|
+
Create a new `PolicyStatement` with the same exact properties as this one, except for the overrides.
|
|
16366
|
+
|
|
16367
|
+
###### `overrides`<sup>Optional</sup> <a name="overrides" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.copy.parameter.overrides"></a>
|
|
16368
|
+
|
|
16369
|
+
- *Type:* aws-cdk-lib.aws_iam.PolicyStatementProps
|
|
16370
|
+
|
|
16371
|
+
---
|
|
16372
|
+
|
|
16373
|
+
##### `freeze` <a name="freeze" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.freeze"></a>
|
|
16374
|
+
|
|
16375
|
+
```typescript
|
|
16376
|
+
public freeze(): PolicyStatement
|
|
16377
|
+
```
|
|
16378
|
+
|
|
16379
|
+
Make the PolicyStatement immutable.
|
|
16380
|
+
|
|
16381
|
+
After calling this, any of the `addXxx()` methods will throw an exception.
|
|
16382
|
+
|
|
16383
|
+
Libraries that lazily generate statement bodies can override this method to
|
|
16384
|
+
fill the actual PolicyStatement fields. Be aware that this method may be called
|
|
16385
|
+
multiple times.
|
|
16386
|
+
|
|
16387
|
+
##### `toJSON` <a name="toJSON" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.toJSON"></a>
|
|
16388
|
+
|
|
16389
|
+
```typescript
|
|
16390
|
+
public toJSON(): any
|
|
16391
|
+
```
|
|
16392
|
+
|
|
16393
|
+
JSON-ify the statement.
|
|
16394
|
+
|
|
16395
|
+
Used when JSON.stringify() is called
|
|
16396
|
+
|
|
16397
|
+
##### `toStatementJson` <a name="toStatementJson" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.toStatementJson"></a>
|
|
16398
|
+
|
|
16399
|
+
```typescript
|
|
16400
|
+
public toStatementJson(): any
|
|
16401
|
+
```
|
|
16402
|
+
|
|
16403
|
+
JSON-ify the policy statement.
|
|
16404
|
+
|
|
16405
|
+
Used when JSON.stringify() is called
|
|
16406
|
+
|
|
16407
|
+
##### `toString` <a name="toString" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.toString"></a>
|
|
16408
|
+
|
|
16409
|
+
```typescript
|
|
16410
|
+
public toString(): string
|
|
16411
|
+
```
|
|
16412
|
+
|
|
16413
|
+
String representation of this policy statement.
|
|
16414
|
+
|
|
16415
|
+
##### `validateForAnyPolicy` <a name="validateForAnyPolicy" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.validateForAnyPolicy"></a>
|
|
16416
|
+
|
|
16417
|
+
```typescript
|
|
16418
|
+
public validateForAnyPolicy(): string[]
|
|
16419
|
+
```
|
|
16420
|
+
|
|
16421
|
+
Validate that the policy statement satisfies base requirements for a policy.
|
|
16422
|
+
|
|
16423
|
+
##### `validateForIdentityPolicy` <a name="validateForIdentityPolicy" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.validateForIdentityPolicy"></a>
|
|
16424
|
+
|
|
16425
|
+
```typescript
|
|
16426
|
+
public validateForIdentityPolicy(): string[]
|
|
16427
|
+
```
|
|
16428
|
+
|
|
16429
|
+
Validate that the policy statement satisfies all requirements for an identity-based policy.
|
|
16430
|
+
|
|
16431
|
+
##### `validateForResourcePolicy` <a name="validateForResourcePolicy" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.validateForResourcePolicy"></a>
|
|
16432
|
+
|
|
16433
|
+
```typescript
|
|
16434
|
+
public validateForResourcePolicy(): string[]
|
|
16435
|
+
```
|
|
16436
|
+
|
|
16437
|
+
Validate that the policy statement satisfies all requirements for a resource-based policy.
|
|
16438
|
+
|
|
16439
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
16440
|
+
|
|
16441
|
+
| **Name** | **Description** |
|
|
16442
|
+
| --- | --- |
|
|
16443
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.fromJson">fromJson</a></code> | Creates a new PolicyStatement based on the object provided. |
|
|
16444
|
+
|
|
16445
|
+
---
|
|
16446
|
+
|
|
16447
|
+
##### `fromJson` <a name="fromJson" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.fromJson"></a>
|
|
16448
|
+
|
|
16449
|
+
```typescript
|
|
16450
|
+
import { iam } from '@rio-cloud/cdk-v2-constructs'
|
|
16451
|
+
|
|
16452
|
+
iam.EcrPullThroughCachePolicyStatement.fromJson(obj: any)
|
|
16453
|
+
```
|
|
16454
|
+
|
|
16455
|
+
Creates a new PolicyStatement based on the object provided.
|
|
16456
|
+
|
|
16457
|
+
This will accept an object created from the `.toJSON()` call
|
|
16458
|
+
|
|
16459
|
+
###### `obj`<sup>Required</sup> <a name="obj" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.fromJson.parameter.obj"></a>
|
|
16460
|
+
|
|
16461
|
+
- *Type:* any
|
|
16462
|
+
|
|
16463
|
+
the PolicyStatement in object form.
|
|
16464
|
+
|
|
16465
|
+
---
|
|
16466
|
+
|
|
16467
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
16468
|
+
|
|
16469
|
+
| **Name** | **Type** | **Description** |
|
|
16470
|
+
| --- | --- | --- |
|
|
16471
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.property.actions">actions</a></code> | <code>string[]</code> | The Actions added to this statement. |
|
|
16472
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.property.conditions">conditions</a></code> | <code>any</code> | The conditions added to this statement. |
|
|
16473
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.property.frozen">frozen</a></code> | <code>boolean</code> | Whether the PolicyStatement has been frozen. |
|
|
16474
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.property.hasPrincipal">hasPrincipal</a></code> | <code>boolean</code> | Indicates if this permission has a "Principal" section. |
|
|
16475
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.property.hasResource">hasResource</a></code> | <code>boolean</code> | Indicates if this permission has at least one resource associated with it. |
|
|
16476
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.property.notActions">notActions</a></code> | <code>string[]</code> | The NotActions added to this statement. |
|
|
16477
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.property.notPrincipals">notPrincipals</a></code> | <code>aws-cdk-lib.aws_iam.IPrincipal[]</code> | The NotPrincipals added to this statement. |
|
|
16478
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.property.notResources">notResources</a></code> | <code>string[]</code> | The NotResources added to this statement. |
|
|
16479
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.property.principals">principals</a></code> | <code>aws-cdk-lib.aws_iam.IPrincipal[]</code> | The Principals added to this statement. |
|
|
16480
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.property.resources">resources</a></code> | <code>string[]</code> | The Resources added to this statement. |
|
|
16481
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.property.effect">effect</a></code> | <code>aws-cdk-lib.aws_iam.Effect</code> | Whether to allow or deny the actions in this statement Set effect for this statement. |
|
|
16482
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.property.sid">sid</a></code> | <code>string</code> | Statement ID for this statement Set Statement ID for this statement. |
|
|
16483
|
+
|
|
16484
|
+
---
|
|
16485
|
+
|
|
16486
|
+
##### `actions`<sup>Required</sup> <a name="actions" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.property.actions"></a>
|
|
16487
|
+
|
|
16488
|
+
```typescript
|
|
16489
|
+
public readonly actions: string[];
|
|
16490
|
+
```
|
|
16491
|
+
|
|
16492
|
+
- *Type:* string[]
|
|
16493
|
+
|
|
16494
|
+
The Actions added to this statement.
|
|
16495
|
+
|
|
16496
|
+
---
|
|
16497
|
+
|
|
16498
|
+
##### `conditions`<sup>Required</sup> <a name="conditions" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.property.conditions"></a>
|
|
16499
|
+
|
|
16500
|
+
```typescript
|
|
16501
|
+
public readonly conditions: any;
|
|
16502
|
+
```
|
|
16503
|
+
|
|
16504
|
+
- *Type:* any
|
|
16505
|
+
|
|
16506
|
+
The conditions added to this statement.
|
|
16507
|
+
|
|
16508
|
+
---
|
|
16509
|
+
|
|
16510
|
+
##### `frozen`<sup>Required</sup> <a name="frozen" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.property.frozen"></a>
|
|
16511
|
+
|
|
16512
|
+
```typescript
|
|
16513
|
+
public readonly frozen: boolean;
|
|
16514
|
+
```
|
|
16515
|
+
|
|
16516
|
+
- *Type:* boolean
|
|
16517
|
+
|
|
16518
|
+
Whether the PolicyStatement has been frozen.
|
|
16519
|
+
|
|
16520
|
+
The statement object is frozen when `freeze()` is called.
|
|
16521
|
+
|
|
16522
|
+
---
|
|
16523
|
+
|
|
16524
|
+
##### `hasPrincipal`<sup>Required</sup> <a name="hasPrincipal" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.property.hasPrincipal"></a>
|
|
16525
|
+
|
|
16526
|
+
```typescript
|
|
16527
|
+
public readonly hasPrincipal: boolean;
|
|
16528
|
+
```
|
|
16529
|
+
|
|
16530
|
+
- *Type:* boolean
|
|
16531
|
+
|
|
16532
|
+
Indicates if this permission has a "Principal" section.
|
|
16533
|
+
|
|
16534
|
+
---
|
|
16535
|
+
|
|
16536
|
+
##### `hasResource`<sup>Required</sup> <a name="hasResource" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.property.hasResource"></a>
|
|
16537
|
+
|
|
16538
|
+
```typescript
|
|
16539
|
+
public readonly hasResource: boolean;
|
|
16540
|
+
```
|
|
16541
|
+
|
|
16542
|
+
- *Type:* boolean
|
|
16543
|
+
|
|
16544
|
+
Indicates if this permission has at least one resource associated with it.
|
|
16545
|
+
|
|
16546
|
+
---
|
|
16547
|
+
|
|
16548
|
+
##### `notActions`<sup>Required</sup> <a name="notActions" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.property.notActions"></a>
|
|
16549
|
+
|
|
16550
|
+
```typescript
|
|
16551
|
+
public readonly notActions: string[];
|
|
16552
|
+
```
|
|
16553
|
+
|
|
16554
|
+
- *Type:* string[]
|
|
16555
|
+
|
|
16556
|
+
The NotActions added to this statement.
|
|
16557
|
+
|
|
16558
|
+
---
|
|
16559
|
+
|
|
16560
|
+
##### `notPrincipals`<sup>Required</sup> <a name="notPrincipals" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.property.notPrincipals"></a>
|
|
16561
|
+
|
|
16562
|
+
```typescript
|
|
16563
|
+
public readonly notPrincipals: IPrincipal[];
|
|
16564
|
+
```
|
|
16565
|
+
|
|
16566
|
+
- *Type:* aws-cdk-lib.aws_iam.IPrincipal[]
|
|
16567
|
+
|
|
16568
|
+
The NotPrincipals added to this statement.
|
|
16569
|
+
|
|
16570
|
+
---
|
|
16571
|
+
|
|
16572
|
+
##### `notResources`<sup>Required</sup> <a name="notResources" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.property.notResources"></a>
|
|
16573
|
+
|
|
16574
|
+
```typescript
|
|
16575
|
+
public readonly notResources: string[];
|
|
16576
|
+
```
|
|
16577
|
+
|
|
16578
|
+
- *Type:* string[]
|
|
16579
|
+
|
|
16580
|
+
The NotResources added to this statement.
|
|
16581
|
+
|
|
16582
|
+
---
|
|
16583
|
+
|
|
16584
|
+
##### `principals`<sup>Required</sup> <a name="principals" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.property.principals"></a>
|
|
16585
|
+
|
|
16586
|
+
```typescript
|
|
16587
|
+
public readonly principals: IPrincipal[];
|
|
16588
|
+
```
|
|
16589
|
+
|
|
16590
|
+
- *Type:* aws-cdk-lib.aws_iam.IPrincipal[]
|
|
16591
|
+
|
|
16592
|
+
The Principals added to this statement.
|
|
16593
|
+
|
|
16594
|
+
---
|
|
16595
|
+
|
|
16596
|
+
##### `resources`<sup>Required</sup> <a name="resources" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.property.resources"></a>
|
|
16597
|
+
|
|
16598
|
+
```typescript
|
|
16599
|
+
public readonly resources: string[];
|
|
16600
|
+
```
|
|
16601
|
+
|
|
16602
|
+
- *Type:* string[]
|
|
16603
|
+
|
|
16604
|
+
The Resources added to this statement.
|
|
16605
|
+
|
|
16606
|
+
---
|
|
16607
|
+
|
|
16608
|
+
##### `effect`<sup>Required</sup> <a name="effect" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.property.effect"></a>
|
|
16609
|
+
|
|
16610
|
+
```typescript
|
|
16611
|
+
public readonly effect: Effect;
|
|
16612
|
+
```
|
|
16613
|
+
|
|
16614
|
+
- *Type:* aws-cdk-lib.aws_iam.Effect
|
|
16615
|
+
|
|
16616
|
+
Whether to allow or deny the actions in this statement Set effect for this statement.
|
|
16617
|
+
|
|
16618
|
+
---
|
|
16619
|
+
|
|
16620
|
+
##### `sid`<sup>Optional</sup> <a name="sid" id="@rio-cloud/cdk-v2-constructs.iam.EcrPullThroughCachePolicyStatement.property.sid"></a>
|
|
16621
|
+
|
|
16622
|
+
```typescript
|
|
16623
|
+
public readonly sid: string;
|
|
16624
|
+
```
|
|
16625
|
+
|
|
16626
|
+
- *Type:* string
|
|
16627
|
+
|
|
16628
|
+
Statement ID for this statement Set Statement ID for this statement.
|
|
16629
|
+
|
|
16630
|
+
---
|
|
16631
|
+
|
|
16632
|
+
|
|
15865
16633
|
### KafkaEventSpecSource <a name="KafkaEventSpecSource" id="@rio-cloud/cdk-v2-constructs.KafkaEventSpecSource"></a>
|
|
15866
16634
|
|
|
15867
16635
|
Wrapper class for the event spec itself to support providing it via file or inline string.
|
|
@@ -15907,7 +16675,7 @@ Helper method to create a KafkaEventSpecSource by loading spec from a (UTF-8 enc
|
|
|
15907
16675
|
|
|
15908
16676
|
- *Type:* string
|
|
15909
16677
|
|
|
15910
|
-
|
|
16678
|
+
The filename of the event specification file.
|
|
15911
16679
|
|
|
15912
16680
|
Must either be an absolute path or a path relative to CDK's working directory.
|
|
15913
16681
|
|
|
@@ -15927,7 +16695,7 @@ Helper method to create a KafkaEventSpecSource from an inline yaml string.
|
|
|
15927
16695
|
|
|
15928
16696
|
- *Type:* string
|
|
15929
16697
|
|
|
15930
|
-
as yaml formatted string.
|
|
16698
|
+
EventSpec as yaml formatted string.
|
|
15931
16699
|
|
|
15932
16700
|
---
|
|
15933
16701
|
|
|
@@ -15995,7 +16763,7 @@ Helper method to create a KafkaEventSpecSource by loading spec from a (UTF-8 enc
|
|
|
15995
16763
|
|
|
15996
16764
|
- *Type:* string
|
|
15997
16765
|
|
|
15998
|
-
|
|
16766
|
+
The filename of the event specification file.
|
|
15999
16767
|
|
|
16000
16768
|
Must either be an absolute path or a path relative to CDK's working directory.
|
|
16001
16769
|
|
|
@@ -16015,7 +16783,7 @@ Helper method to create a KafkaEventSpecSource from an inline yaml string.
|
|
|
16015
16783
|
|
|
16016
16784
|
- *Type:* string
|
|
16017
16785
|
|
|
16018
|
-
as yaml formatted string.
|
|
16786
|
+
EventSpec as yaml formatted string.
|
|
16019
16787
|
|
|
16020
16788
|
---
|
|
16021
16789
|
|
|
@@ -16045,7 +16813,7 @@ public readonly eventName: string;
|
|
|
16045
16813
|
{@link INotification} implementation, that explicitly suppresses notifications.
|
|
16046
16814
|
|
|
16047
16815
|
Per default every monitor
|
|
16048
|
-
has a
|
|
16816
|
+
has a Slack notification. In order to create a {@link DatadogMonitor} just for a {@link ./datadog-monitor.ts.#DatadogMonitor}
|
|
16049
16817
|
without further notification.
|
|
16050
16818
|
|
|
16051
16819
|
#### Initializers <a name="Initializers" id="@rio-cloud/cdk-v2-constructs.datadogv2.NoNotification.Initializer"></a>
|
|
@@ -16583,7 +17351,7 @@ RioLandingZone.getTeamNameParameter(scope: Construct)
|
|
|
16583
17351
|
|
|
16584
17352
|
An {@link INotification}, that forwards alerts to the RIO paging router to engage the corresponding team.
|
|
16585
17353
|
|
|
16586
|
-
Alerts with Priority
|
|
17354
|
+
Alerts with Priority \> {@link RioPagingNotification.MINIMUM_PRIORITY} will not be taken into account.
|
|
16587
17355
|
|
|
16588
17356
|
#### Initializers <a name="Initializers" id="@rio-cloud/cdk-v2-constructs.datadogv2.RioPagingNotification.Initializer"></a>
|
|
16589
17357
|
|
|
@@ -17363,19 +18131,19 @@ Simply place the AppStack creation into the create-method:
|
|
|
17363
18131
|
|
|
17364
18132
|
```typescript
|
|
17365
18133
|
// Use e.g. within ApplicationProps as JSONObject:
|
|
17366
|
-
{ create: (construct, props)
|
|
18134
|
+
\{ create: (construct, props) =\> new Stack(construct, 'AppStack', props) \}
|
|
17367
18135
|
|
|
17368
18136
|
// or simply as class interface within your stack implementation:
|
|
17369
|
-
class PipelineStage extends Stage implements IAppStackFactory {
|
|
17370
|
-
constructor(scope: Construct, id: string, props: StageProps) {
|
|
18137
|
+
class PipelineStage extends Stage implements IAppStackFactory \{
|
|
18138
|
+
constructor(scope: Construct, id: string, props: StageProps) \{
|
|
17371
18139
|
super(scope, id, props);
|
|
17372
18140
|
// your stage definition
|
|
17373
|
-
}
|
|
18141
|
+
\}
|
|
17374
18142
|
|
|
17375
|
-
create(scope: Construct, props: AppStackProps): void {
|
|
18143
|
+
create(scope: Construct, props: AppStackProps): void \{
|
|
17376
18144
|
// app stack initiation goes in here
|
|
17377
|
-
}
|
|
17378
|
-
}
|
|
18145
|
+
\}
|
|
18146
|
+
\}
|
|
17379
18147
|
```
|
|
17380
18148
|
|
|
17381
18149
|
|
|
@@ -17399,7 +18167,7 @@ Factory method, being invoked with the specific scope during pipeline instantiat
|
|
|
17399
18167
|
|
|
17400
18168
|
- *Type:* constructs.Construct
|
|
17401
18169
|
|
|
17402
|
-
|
|
18170
|
+
The parent construct for the app stack.
|
|
17403
18171
|
|
|
17404
18172
|
---
|
|
17405
18173
|
|
|
@@ -17407,7 +18175,7 @@ the parent construct for the app stack.
|
|
|
17407
18175
|
|
|
17408
18176
|
- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.AppStackProps">AppStackProps</a>
|
|
17409
18177
|
|
|
17410
|
-
|
|
18178
|
+
The app stacks properties.
|
|
17411
18179
|
|
|
17412
18180
|
---
|
|
17413
18181
|
|
|
@@ -17418,7 +18186,7 @@ the app stacks properties.
|
|
|
17418
18186
|
|
|
17419
18187
|
Interface to plug in specific notification types for monitors in Datadog.
|
|
17420
18188
|
|
|
17421
|
-
One instance could be reused over multiple monitors, e.g. when using the {@link
|
|
18189
|
+
One instance could be reused over multiple monitors, e.g. when using the {@link ./../watchfulv2#watchful.ts} construct.
|
|
17422
18190
|
|
|
17423
18191
|
#### Methods <a name="Methods" id="Methods"></a>
|
|
17424
18192
|
|
|
@@ -17487,19 +18255,23 @@ Adds the alarmTopic as alarm action to the given alarm.
|
|
|
17487
18255
|
|
|
17488
18256
|
- *Type:* constructs.Construct
|
|
17489
18257
|
|
|
18258
|
+
The construct to add the alarm to.
|
|
18259
|
+
|
|
17490
18260
|
---
|
|
17491
18261
|
|
|
17492
18262
|
###### `id`<sup>Required</sup> <a name="id" id="@rio-cloud/cdk-v2-constructs.IWatchful.createAlarm.parameter.id"></a>
|
|
17493
18263
|
|
|
17494
18264
|
- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.MonitorType">MonitorType</a>
|
|
17495
18265
|
|
|
18266
|
+
The id of the alarm.
|
|
18267
|
+
|
|
17496
18268
|
---
|
|
17497
18269
|
|
|
17498
18270
|
###### `alarm`<sup>Required</sup> <a name="alarm" id="@rio-cloud/cdk-v2-constructs.IWatchful.createAlarm.parameter.alarm"></a>
|
|
17499
18271
|
|
|
17500
18272
|
- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.MetricAlarmProps">MetricAlarmProps</a>
|
|
17501
18273
|
|
|
17502
|
-
|
|
18274
|
+
Additional options for the watch see {@link MetricAlarmProps}.
|
|
17503
18275
|
|
|
17504
18276
|
---
|
|
17505
18277
|
|
|
@@ -17515,6 +18287,8 @@ Adds and alert for error logs.
|
|
|
17515
18287
|
|
|
17516
18288
|
- *Type:* constructs.Construct
|
|
17517
18289
|
|
|
18290
|
+
The construct to add the alarm to.
|
|
18291
|
+
|
|
17518
18292
|
---
|
|
17519
18293
|
|
|
17520
18294
|
###### `id`<sup>Required</sup> <a name="id" id="@rio-cloud/cdk-v2-constructs.IWatchful.createLogAlarm.parameter.id"></a>
|
|
@@ -17529,6 +18303,8 @@ The name of the service.
|
|
|
17529
18303
|
|
|
17530
18304
|
- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.LogAlarmProps">LogAlarmProps</a>
|
|
17531
18305
|
|
|
18306
|
+
The alarm properties see {@link LogAlarmProps}.
|
|
18307
|
+
|
|
17532
18308
|
---
|
|
17533
18309
|
|
|
17534
18310
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
@@ -18033,6 +18809,7 @@ Options for onMissingData supported by Datadog.
|
|
|
18033
18809
|
| <code><a href="#@rio-cloud/cdk-v2-constructs.MonitorType.DURATION">DURATION</a></code> | Runtime duration metrics for lambda. |
|
|
18034
18810
|
| <code><a href="#@rio-cloud/cdk-v2-constructs.MonitorType.FREEABLE_MEMORY">FREEABLE_MEMORY</a></code> | Free memory for Document DB and RDS. |
|
|
18035
18811
|
| <code><a href="#@rio-cloud/cdk-v2-constructs.MonitorType.CONNECTION_ERROR">CONNECTION_ERROR</a></code> | Connection error metrics for Application load balancer target group. |
|
|
18812
|
+
| <code><a href="#@rio-cloud/cdk-v2-constructs.MonitorType.RUNNING_TASKS">RUNNING_TASKS</a></code> | Running fargate tasks monitor. |
|
|
18036
18813
|
|
|
18037
18814
|
---
|
|
18038
18815
|
|
|
@@ -18148,6 +18925,13 @@ Connection error metrics for Application load balancer target group.
|
|
|
18148
18925
|
---
|
|
18149
18926
|
|
|
18150
18927
|
|
|
18928
|
+
##### `RUNNING_TASKS` <a name="RUNNING_TASKS" id="@rio-cloud/cdk-v2-constructs.MonitorType.RUNNING_TASKS"></a>
|
|
18929
|
+
|
|
18930
|
+
Running fargate tasks monitor.
|
|
18931
|
+
|
|
18932
|
+
---
|
|
18933
|
+
|
|
18934
|
+
|
|
18151
18935
|
### PipelineType <a name="PipelineType" id="@rio-cloud/cdk-v2-constructs.PipelineType"></a>
|
|
18152
18936
|
|
|
18153
18937
|
#### Members <a name="Members" id="Members"></a>
|