aws-cdk-lib 2.185.0__py3-none-any.whl → 2.186.0__py3-none-any.whl
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.
Potentially problematic release.
This version of aws-cdk-lib might be problematic. Click here for more details.
- aws_cdk/__init__.py +102 -29
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.185.0.jsii.tgz → aws-cdk-lib@2.186.0.jsii.tgz} +0 -0
- aws_cdk/aws_amazonmq/__init__.py +3 -2
- aws_cdk/aws_apigatewayv2/__init__.py +9 -0
- aws_cdk/aws_appconfig/__init__.py +3 -3
- aws_cdk/aws_applicationsignals/__init__.py +363 -3
- aws_cdk/aws_appsync/__init__.py +65 -3
- aws_cdk/aws_bedrock/__init__.py +385 -14
- aws_cdk/aws_cleanrooms/__init__.py +21 -9
- aws_cdk/aws_cloudformation/__init__.py +1 -5
- aws_cdk/aws_cloudfront/__init__.py +4 -1
- aws_cdk/aws_cloudfront_origins/__init__.py +4 -2
- aws_cdk/aws_codeartifact/__init__.py +20 -33
- aws_cdk/aws_codepipeline/__init__.py +1328 -120
- aws_cdk/aws_cognito/__init__.py +1 -1
- aws_cdk/aws_cognito_identitypool/__init__.py +2303 -0
- aws_cdk/aws_connect/__init__.py +3 -7
- aws_cdk/aws_controltower/__init__.py +18 -26
- aws_cdk/aws_datazone/__init__.py +3471 -2
- aws_cdk/aws_ec2/__init__.py +560 -25
- aws_cdk/aws_ecs/__init__.py +15 -20
- aws_cdk/aws_events/__init__.py +37 -14
- aws_cdk/aws_gamelift/__init__.py +5 -5
- aws_cdk/aws_iam/__init__.py +264 -0
- aws_cdk/aws_imagebuilder/__init__.py +3 -27
- aws_cdk/aws_kinesisfirehose/__init__.py +2 -3
- aws_cdk/aws_lambda/__init__.py +7 -1
- aws_cdk/aws_location/__init__.py +24 -7
- aws_cdk/aws_msk/__init__.py +8 -2
- aws_cdk/aws_networkfirewall/__init__.py +16 -12
- aws_cdk/aws_oam/__init__.py +8 -37
- aws_cdk/aws_quicksight/__init__.py +6 -69
- aws_cdk/aws_redshiftserverless/__init__.py +192 -15
- aws_cdk/aws_rum/__init__.py +315 -52
- aws_cdk/aws_scheduler/__init__.py +3944 -121
- aws_cdk/aws_scheduler_targets/__init__.py +4472 -0
- aws_cdk/aws_ssmquicksetup/__init__.py +5 -3
- aws_cdk/aws_stepfunctions/__init__.py +17 -15
- aws_cdk/aws_timestream/__init__.py +4 -4
- aws_cdk/aws_wafv2/__init__.py +345 -0
- aws_cdk/aws_workspacesthinclient/__init__.py +4 -4
- aws_cdk/cx_api/__init__.py +23 -0
- {aws_cdk_lib-2.185.0.dist-info → aws_cdk_lib-2.186.0.dist-info}/METADATA +1 -1
- {aws_cdk_lib-2.185.0.dist-info → aws_cdk_lib-2.186.0.dist-info}/RECORD +49 -47
- {aws_cdk_lib-2.185.0.dist-info → aws_cdk_lib-2.186.0.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.185.0.dist-info → aws_cdk_lib-2.186.0.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.185.0.dist-info → aws_cdk_lib-2.186.0.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.185.0.dist-info → aws_cdk_lib-2.186.0.dist-info}/top_level.txt +0 -0
|
@@ -1,29 +1,326 @@
|
|
|
1
1
|
r'''
|
|
2
|
-
#
|
|
2
|
+
# Amazon EventBridge Scheduler Construct Library
|
|
3
3
|
|
|
4
|
-
|
|
4
|
+
[Amazon EventBridge Scheduler](https://aws.amazon.com/blogs/compute/introducing-amazon-eventbridge-scheduler/) is a feature from Amazon EventBridge
|
|
5
|
+
that allows you to create, run, and manage scheduled tasks at scale. With EventBridge Scheduler, you can schedule millions of one-time or recurring tasks across various AWS services without provisioning or managing underlying infrastructure.
|
|
6
|
+
|
|
7
|
+
1. **Schedule**: A schedule is the main resource you create, configure, and manage using Amazon EventBridge Scheduler. Every schedule has a schedule expression that determines when, and with what frequency, the schedule runs. EventBridge Scheduler supports three types of schedules: rate, cron, and one-time schedules. When you create a schedule, you configure a target for the schedule to invoke.
|
|
8
|
+
2. **Target**: A target is an API operation that EventBridge Scheduler calls on your behalf every time your schedule runs. EventBridge Scheduler
|
|
9
|
+
supports two types of targets: templated targets and universal targets. Templated targets invoke common API operations across a core groups of
|
|
10
|
+
services. For example, EventBridge Scheduler supports templated targets for invoking AWS Lambda Function or starting execution of Step Functions state
|
|
11
|
+
machine. For API operations that are not supported by templated targets you can use customizable universal targets. Universal targets support calling
|
|
12
|
+
more than 6,000 API operations across over 270 AWS services.
|
|
13
|
+
3. **Schedule Group**: A schedule group is an Amazon EventBridge Scheduler resource that you use to organize your schedules. Your AWS account comes
|
|
14
|
+
with a default scheduler group. A new schedule will always be added to a scheduling group. If you do not provide a scheduling group to add to, it
|
|
15
|
+
will be added to the default scheduling group. You can create up to 500 schedule groups in your AWS account. Groups can be used to organize the
|
|
16
|
+
schedules logically, access the schedule metrics and manage permissions at group granularity (see details below). Schedule groups support tagging.
|
|
17
|
+
With EventBridge Scheduler, you apply tags to schedule groups, not to individual schedules to organize your resources.
|
|
18
|
+
|
|
19
|
+
## Defining a schedule
|
|
20
|
+
|
|
21
|
+
```python
|
|
22
|
+
# fn: lambda.Function
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
target = targets.LambdaInvoke(fn,
|
|
26
|
+
input=ScheduleTargetInput.from_object({
|
|
27
|
+
"payload": "useful"
|
|
28
|
+
})
|
|
29
|
+
)
|
|
30
|
+
|
|
31
|
+
schedule = Schedule(self, "Schedule",
|
|
32
|
+
schedule=ScheduleExpression.rate(Duration.minutes(10)),
|
|
33
|
+
target=target,
|
|
34
|
+
description="This is a test schedule that invokes a lambda function every 10 minutes."
|
|
35
|
+
)
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### Schedule Expressions
|
|
39
|
+
|
|
40
|
+
You can choose from three schedule types when configuring your schedule: rate-based, cron-based, and one-time schedules.
|
|
41
|
+
|
|
42
|
+
Both rate-based and cron-based schedules are recurring schedules. You can configure each recurring schedule type using a schedule expression.
|
|
43
|
+
|
|
44
|
+
For
|
|
45
|
+
cron-based schedules you can specify a time zone in which EventBridge Scheduler evaluates the expression.
|
|
46
|
+
|
|
47
|
+
```python
|
|
48
|
+
# target: targets.LambdaInvoke
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
rate_based_schedule = Schedule(self, "Schedule",
|
|
52
|
+
schedule=ScheduleExpression.rate(Duration.minutes(10)),
|
|
53
|
+
target=target,
|
|
54
|
+
description="This is a test rate-based schedule"
|
|
55
|
+
)
|
|
56
|
+
|
|
57
|
+
cron_based_schedule = Schedule(self, "Schedule",
|
|
58
|
+
schedule=ScheduleExpression.cron(
|
|
59
|
+
minute="0",
|
|
60
|
+
hour="23",
|
|
61
|
+
day="20",
|
|
62
|
+
month="11",
|
|
63
|
+
time_zone=TimeZone.AMERICA_NEW_YORK
|
|
64
|
+
),
|
|
65
|
+
target=target,
|
|
66
|
+
description="This is a test cron-based schedule that will run at 11:00 PM, on day 20 of the month, only in November in New York timezone"
|
|
67
|
+
)
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
A one-time schedule is a schedule that invokes a target only once. You configure a one-time schedule by specifying the time of day, date,
|
|
71
|
+
and time zone in which EventBridge Scheduler evaluates the schedule.
|
|
72
|
+
|
|
73
|
+
```python
|
|
74
|
+
# target: targets.LambdaInvoke
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
one_time_schedule = Schedule(self, "Schedule",
|
|
78
|
+
schedule=ScheduleExpression.at(
|
|
79
|
+
Date(2022, 10, 20, 19, 20, 23), TimeZone.AMERICA_NEW_YORK),
|
|
80
|
+
target=target,
|
|
81
|
+
description="This is a one-time schedule in New York timezone"
|
|
82
|
+
)
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
### Grouping Schedules
|
|
86
|
+
|
|
87
|
+
Your AWS account comes with a default scheduler group. You can access the default group in CDK with:
|
|
88
|
+
|
|
89
|
+
```python
|
|
90
|
+
default_schedule_group = ScheduleGroup.from_default_schedule_group(self, "DefaultGroup")
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
You can add a schedule to a custom scheduling group managed by you. If a custom group is not specified, the schedule is added to the default group.
|
|
94
|
+
|
|
95
|
+
```python
|
|
96
|
+
# target: targets.LambdaInvoke
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
schedule_group = ScheduleGroup(self, "ScheduleGroup",
|
|
100
|
+
schedule_group_name="MyScheduleGroup"
|
|
101
|
+
)
|
|
102
|
+
|
|
103
|
+
Schedule(self, "Schedule",
|
|
104
|
+
schedule=ScheduleExpression.rate(Duration.minutes(10)),
|
|
105
|
+
target=target,
|
|
106
|
+
schedule_group=schedule_group
|
|
107
|
+
)
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
### Disabling Schedules
|
|
111
|
+
|
|
112
|
+
By default, a schedule will be enabled. You can disable a schedule by setting the `enabled` property to false:
|
|
113
|
+
|
|
114
|
+
```python
|
|
115
|
+
# target: targets.LambdaInvoke
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
Schedule(self, "Schedule",
|
|
119
|
+
schedule=ScheduleExpression.rate(Duration.minutes(10)),
|
|
120
|
+
target=target,
|
|
121
|
+
enabled=False
|
|
122
|
+
)
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
### Configuring a start and end time of the Schedule
|
|
126
|
+
|
|
127
|
+
If you choose a recurring schedule, you can set the start and end time of the Schedule by specifying the `start` and `end`.
|
|
128
|
+
|
|
129
|
+
```python
|
|
130
|
+
# target: targets.LambdaInvoke
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
Schedule(self, "Schedule",
|
|
134
|
+
schedule=ScheduleExpression.rate(cdk.Duration.hours(12)),
|
|
135
|
+
target=target,
|
|
136
|
+
start=Date("2023-01-01T00:00:00.000Z"),
|
|
137
|
+
end=Date("2023-02-01T00:00:00.000Z")
|
|
138
|
+
)
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
## Scheduler Targets
|
|
142
|
+
|
|
143
|
+
The `aws-cdk-lib/aws-scheduler-targets` module includes classes that implement the `IScheduleTarget` interface for
|
|
144
|
+
various AWS services. EventBridge Scheduler supports two types of targets:
|
|
145
|
+
|
|
146
|
+
1. **Templated targets** which invoke common API
|
|
147
|
+
operations across a core groups of services, and
|
|
148
|
+
2. **Universal targets** that you can customize to call more
|
|
149
|
+
than 6,000 operations across over 270 services.
|
|
150
|
+
|
|
151
|
+
A list of supported targets can be found at `aws-cdk-lib/aws-scheduler-targets`.
|
|
152
|
+
|
|
153
|
+
### Input
|
|
154
|
+
|
|
155
|
+
Targets can be invoked with a custom input. The `ScheduleTargetInput` class supports free-form text input and JSON-formatted object input:
|
|
156
|
+
|
|
157
|
+
```python
|
|
158
|
+
input = ScheduleTargetInput.from_object({
|
|
159
|
+
"QueueName": "MyQueue"
|
|
160
|
+
})
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
You can include context attributes in your target payload. EventBridge Scheduler will replace each keyword with
|
|
164
|
+
its respective value and deliver it to the target. See
|
|
165
|
+
[full list of supported context attributes](https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-schedule-context-attributes.html):
|
|
166
|
+
|
|
167
|
+
1. `ContextAttribute.scheduleArn()` – The ARN of the schedule.
|
|
168
|
+
2. `ContextAttribute.scheduledTime()` – The time you specified for the schedule to invoke its target, e.g., 2022-03-22T18:59:43Z.
|
|
169
|
+
3. `ContextAttribute.executionId()` – The unique ID that EventBridge Scheduler assigns for each attempted invocation of a target, e.g., d32c5kddcf5bb8c3.
|
|
170
|
+
4. `ContextAttribute.attemptNumber()` – A counter that identifies the attempt number for the current invocation, e.g., 1.
|
|
171
|
+
|
|
172
|
+
```python
|
|
173
|
+
text = f"Attempt number: {ContextAttribute.attemptNumber}"
|
|
174
|
+
input = ScheduleTargetInput.from_text(text)
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
### Specifying an execution role
|
|
178
|
+
|
|
179
|
+
An execution role is an IAM role that EventBridge Scheduler assumes in order to interact with other AWS services on your behalf.
|
|
180
|
+
|
|
181
|
+
The classes for templated schedule targets automatically create an IAM role with all the minimum necessary
|
|
182
|
+
permissions to interact with the templated target. If you wish you may specify your own IAM role, then the templated targets
|
|
183
|
+
will grant minimal required permissions. For example, the `LambdaInvoke` target will grant the
|
|
184
|
+
IAM execution role `lambda:InvokeFunction` permission to invoke the Lambda function.
|
|
185
|
+
|
|
186
|
+
```python
|
|
187
|
+
# fn: lambda.Function
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
role = iam.Role(self, "Role",
|
|
191
|
+
assumed_by=iam.ServicePrincipal("scheduler.amazonaws.com")
|
|
192
|
+
)
|
|
193
|
+
|
|
194
|
+
target = targets.LambdaInvoke(fn,
|
|
195
|
+
input=ScheduleTargetInput.from_object({
|
|
196
|
+
"payload": "useful"
|
|
197
|
+
}),
|
|
198
|
+
role=role
|
|
199
|
+
)
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
### Specifying an encryption key
|
|
203
|
+
|
|
204
|
+
EventBridge Scheduler integrates with AWS Key Management Service (AWS KMS) to encrypt and decrypt your data using an AWS KMS key.
|
|
205
|
+
EventBridge Scheduler supports two types of KMS keys: AWS owned keys, and customer managed keys.
|
|
206
|
+
|
|
207
|
+
By default, all events in Scheduler are encrypted with a key that AWS owns and manages.
|
|
208
|
+
If you wish you can also provide a customer managed key to encrypt and decrypt the payload that your schedule delivers to its target using the `key` property.
|
|
209
|
+
Target classes will automatically add AWS `kms:Decrypt` permission to your schedule's execution role permissions policy.
|
|
210
|
+
|
|
211
|
+
```python
|
|
212
|
+
# key: kms.Key
|
|
213
|
+
# fn: lambda.Function
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
target = targets.LambdaInvoke(fn,
|
|
217
|
+
input=ScheduleTargetInput.from_object({
|
|
218
|
+
"payload": "useful"
|
|
219
|
+
})
|
|
220
|
+
)
|
|
221
|
+
|
|
222
|
+
schedule = Schedule(self, "Schedule",
|
|
223
|
+
schedule=ScheduleExpression.rate(Duration.minutes(10)),
|
|
224
|
+
target=target,
|
|
225
|
+
key=key
|
|
226
|
+
)
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
> See [Data protection in Amazon EventBridge Scheduler](https://docs.aws.amazon.com/scheduler/latest/UserGuide/data-protection.html) for more details.
|
|
230
|
+
|
|
231
|
+
## Configuring flexible time windows
|
|
232
|
+
|
|
233
|
+
You can configure flexible time windows by specifying the `timeWindow` property.
|
|
234
|
+
Flexible time windows are disabled by default.
|
|
235
|
+
|
|
236
|
+
```python
|
|
237
|
+
# target: targets.LambdaInvoke
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
schedule = Schedule(self, "Schedule",
|
|
241
|
+
schedule=ScheduleExpression.rate(Duration.hours(12)),
|
|
242
|
+
target=target,
|
|
243
|
+
time_window=TimeWindow.flexible(Duration.hours(10))
|
|
244
|
+
)
|
|
245
|
+
```
|
|
246
|
+
|
|
247
|
+
> See [Configuring flexible time windows](https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-schedule-flexible-time-windows.html) for more details.
|
|
248
|
+
|
|
249
|
+
## Error-handling
|
|
250
|
+
|
|
251
|
+
You can configure how your schedule handles failures, when EventBridge Scheduler is unable to deliver an event
|
|
252
|
+
successfully to a target, by using two primary mechanisms: a retry policy, and a dead-letter queue (DLQ).
|
|
253
|
+
|
|
254
|
+
A retry policy determines the number of times EventBridge Scheduler must retry a failed event, and how long
|
|
255
|
+
to keep an unprocessed event.
|
|
256
|
+
|
|
257
|
+
A DLQ is a standard Amazon SQS queue EventBridge Scheduler uses to deliver failed events to, after the retry
|
|
258
|
+
policy has been exhausted. You can use a DLQ to troubleshoot issues with your schedule or its downstream target.
|
|
259
|
+
If you've configured a retry policy for your schedule, EventBridge Scheduler delivers the dead-letter event after
|
|
260
|
+
exhausting the maximum number of retries you set in the retry policy.
|
|
5
261
|
|
|
6
262
|
```python
|
|
7
|
-
|
|
263
|
+
# fn: lambda.Function
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
dlq = sqs.Queue(self, "DLQ",
|
|
267
|
+
queue_name="MyDLQ"
|
|
268
|
+
)
|
|
269
|
+
|
|
270
|
+
target = targets.LambdaInvoke(fn,
|
|
271
|
+
dead_letter_queue=dlq,
|
|
272
|
+
max_event_age=Duration.minutes(1),
|
|
273
|
+
retry_attempts=3
|
|
274
|
+
)
|
|
8
275
|
```
|
|
9
276
|
|
|
10
|
-
|
|
277
|
+
## Monitoring
|
|
278
|
+
|
|
279
|
+
You can monitor Amazon EventBridge Scheduler using CloudWatch, which collects raw data
|
|
280
|
+
and processes it into readable, near real-time metrics. EventBridge Scheduler emits
|
|
281
|
+
a set of metrics for all schedules, and an additional set of metrics for schedules that
|
|
282
|
+
have an associated dead-letter queue (DLQ). If you configure a DLQ for your schedule,
|
|
283
|
+
EventBridge Scheduler publishes additional metrics when your schedule exhausts its retry policy.
|
|
284
|
+
|
|
285
|
+
### Metrics for all schedules
|
|
11
286
|
|
|
12
|
-
|
|
287
|
+
The `Schedule` class provides static methods for accessing all schedules metrics with default configuration, such as `metricAllErrors` for viewing errors when executing targets.
|
|
288
|
+
|
|
289
|
+
```python
|
|
290
|
+
cloudwatch.Alarm(self, "SchedulesErrorAlarm",
|
|
291
|
+
metric=Schedule.metric_all_errors(),
|
|
292
|
+
threshold=0,
|
|
293
|
+
evaluation_periods=1
|
|
294
|
+
)
|
|
295
|
+
```
|
|
13
296
|
|
|
14
|
-
|
|
15
|
-
* Use the automatically generated [L1](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_l1_using) constructs, in the same way you would use [the CloudFormation AWS::Scheduler resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_Scheduler.html) directly.
|
|
297
|
+
### Metrics for a Schedule Group
|
|
16
298
|
|
|
17
|
-
|
|
299
|
+
To view metrics for a specific group you can use methods on class `ScheduleGroup`:
|
|
18
300
|
|
|
19
|
-
|
|
20
|
-
|
|
301
|
+
```python
|
|
302
|
+
schedule_group = ScheduleGroup(self, "ScheduleGroup",
|
|
303
|
+
schedule_group_name="MyScheduleGroup"
|
|
304
|
+
)
|
|
21
305
|
|
|
22
|
-
|
|
306
|
+
cloudwatch.Alarm(self, "MyGroupErrorAlarm",
|
|
307
|
+
metric=schedule_group.metric_target_errors(),
|
|
308
|
+
evaluation_periods=1,
|
|
309
|
+
threshold=0
|
|
310
|
+
)
|
|
23
311
|
|
|
24
|
-
|
|
312
|
+
# Or use default group
|
|
313
|
+
default_schedule_group = ScheduleGroup.from_default_schedule_group(self, "DefaultScheduleGroup")
|
|
314
|
+
cloudwatch.Alarm(self, "DefaultScheduleGroupErrorAlarm",
|
|
315
|
+
metric=default_schedule_group.metric_target_errors(),
|
|
316
|
+
evaluation_periods=1,
|
|
317
|
+
threshold=0
|
|
318
|
+
)
|
|
319
|
+
```
|
|
25
320
|
|
|
26
|
-
|
|
321
|
+
See full list of metrics and their description at
|
|
322
|
+
[Monitoring Using CloudWatch Metrics](https://docs.aws.amazon.com/scheduler/latest/UserGuide/monitoring-cloudwatch.html)
|
|
323
|
+
in the *AWS EventBridge Scheduler User Guide*.
|
|
27
324
|
'''
|
|
28
325
|
from pkgutil import extend_path
|
|
29
326
|
__path__ = extend_path(__path__, __name__)
|
|
@@ -61,12 +358,29 @@ import constructs as _constructs_77d1e7e8
|
|
|
61
358
|
from .. import (
|
|
62
359
|
CfnResource as _CfnResource_9df397a6,
|
|
63
360
|
CfnTag as _CfnTag_f6864754,
|
|
361
|
+
Duration as _Duration_4839e8c3,
|
|
64
362
|
IInspectable as _IInspectable_c2943556,
|
|
65
363
|
IResolvable as _IResolvable_da3f097b,
|
|
364
|
+
IResource as _IResource_c80c4260,
|
|
66
365
|
ITaggable as _ITaggable_36806126,
|
|
366
|
+
RemovalPolicy as _RemovalPolicy_9f93c814,
|
|
367
|
+
Resource as _Resource_45bc6135,
|
|
67
368
|
TagManager as _TagManager_0a598cb3,
|
|
369
|
+
TimeZone as _TimeZone_cdd72ac9,
|
|
68
370
|
TreeInspector as _TreeInspector_488e0dd5,
|
|
69
371
|
)
|
|
372
|
+
from ..aws_cloudwatch import (
|
|
373
|
+
Metric as _Metric_e396a4dc,
|
|
374
|
+
MetricOptions as _MetricOptions_1788b62f,
|
|
375
|
+
Unit as _Unit_61bc6f70,
|
|
376
|
+
)
|
|
377
|
+
from ..aws_events import CronOptions as _CronOptions_6401a7a0
|
|
378
|
+
from ..aws_iam import (
|
|
379
|
+
Grant as _Grant_a7ae64f8,
|
|
380
|
+
IGrantable as _IGrantable_71c4f5de,
|
|
381
|
+
IRole as _IRole_235f5d8e,
|
|
382
|
+
)
|
|
383
|
+
from ..aws_kms import IKey as _IKey_5f11635f
|
|
70
384
|
|
|
71
385
|
|
|
72
386
|
@jsii.implements(_IInspectable_c2943556)
|
|
@@ -2518,131 +2832,3320 @@ class CfnScheduleProps:
|
|
|
2518
2832
|
)
|
|
2519
2833
|
|
|
2520
2834
|
|
|
2521
|
-
|
|
2522
|
-
|
|
2523
|
-
"
|
|
2524
|
-
|
|
2525
|
-
|
|
2526
|
-
]
|
|
2527
|
-
|
|
2528
|
-
publication.publish()
|
|
2835
|
+
class ContextAttribute(
|
|
2836
|
+
metaclass=jsii.JSIIMeta,
|
|
2837
|
+
jsii_type="aws-cdk-lib.aws_scheduler.ContextAttribute",
|
|
2838
|
+
):
|
|
2839
|
+
'''A set of convenient static methods representing the Scheduler Context Attributes.
|
|
2529
2840
|
|
|
2530
|
-
|
|
2531
|
-
scope: _constructs_77d1e7e8.Construct,
|
|
2532
|
-
id: builtins.str,
|
|
2533
|
-
*,
|
|
2534
|
-
flexible_time_window: typing.Union[_IResolvable_da3f097b, typing.Union[CfnSchedule.FlexibleTimeWindowProperty, typing.Dict[builtins.str, typing.Any]]],
|
|
2535
|
-
schedule_expression: builtins.str,
|
|
2536
|
-
target: typing.Union[_IResolvable_da3f097b, typing.Union[CfnSchedule.TargetProperty, typing.Dict[builtins.str, typing.Any]]],
|
|
2537
|
-
description: typing.Optional[builtins.str] = None,
|
|
2538
|
-
end_date: typing.Optional[builtins.str] = None,
|
|
2539
|
-
group_name: typing.Optional[builtins.str] = None,
|
|
2540
|
-
kms_key_arn: typing.Optional[builtins.str] = None,
|
|
2541
|
-
name: typing.Optional[builtins.str] = None,
|
|
2542
|
-
schedule_expression_timezone: typing.Optional[builtins.str] = None,
|
|
2543
|
-
start_date: typing.Optional[builtins.str] = None,
|
|
2544
|
-
state: typing.Optional[builtins.str] = None,
|
|
2545
|
-
) -> None:
|
|
2546
|
-
"""Type checking stubs"""
|
|
2547
|
-
pass
|
|
2841
|
+
These Context Attributes keywords can be used inside a ScheduleTargetInput.
|
|
2548
2842
|
|
|
2549
|
-
|
|
2550
|
-
|
|
2551
|
-
) -> None:
|
|
2552
|
-
"""Type checking stubs"""
|
|
2553
|
-
pass
|
|
2843
|
+
:see: https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-schedule-context-attributes.html
|
|
2844
|
+
'''
|
|
2554
2845
|
|
|
2555
|
-
|
|
2556
|
-
|
|
2557
|
-
) ->
|
|
2558
|
-
|
|
2559
|
-
pass
|
|
2846
|
+
@jsii.member(jsii_name="fromName")
|
|
2847
|
+
@builtins.classmethod
|
|
2848
|
+
def from_name(cls, name: builtins.str) -> builtins.str:
|
|
2849
|
+
'''Escape hatch for other Context Attributes that may be added in the future.
|
|
2560
2850
|
|
|
2561
|
-
|
|
2562
|
-
|
|
2563
|
-
|
|
2564
|
-
|
|
2565
|
-
|
|
2851
|
+
:param name: - name will replace xxx in <aws.scheduler.xxx>.
|
|
2852
|
+
'''
|
|
2853
|
+
if __debug__:
|
|
2854
|
+
type_hints = typing.get_type_hints(_typecheckingstub__c3ffc32f8d37e5b3c60f6299c8f15649e00e5778ef81be54ecc2ffbb99ac1bbc)
|
|
2855
|
+
check_type(argname="argument name", value=name, expected_type=type_hints["name"])
|
|
2856
|
+
return typing.cast(builtins.str, jsii.sinvoke(cls, "fromName", [name]))
|
|
2566
2857
|
|
|
2567
|
-
|
|
2568
|
-
|
|
2569
|
-
|
|
2570
|
-
|
|
2571
|
-
pass
|
|
2858
|
+
@jsii.member(jsii_name="toString")
|
|
2859
|
+
def to_string(self) -> builtins.str:
|
|
2860
|
+
'''Convert the path to the field in the event pattern to JSON.'''
|
|
2861
|
+
return typing.cast(builtins.str, jsii.invoke(self, "toString", []))
|
|
2572
2862
|
|
|
2573
|
-
|
|
2574
|
-
|
|
2575
|
-
) ->
|
|
2576
|
-
|
|
2577
|
-
|
|
2863
|
+
@jsii.python.classproperty
|
|
2864
|
+
@jsii.member(jsii_name="attemptNumber")
|
|
2865
|
+
def attempt_number(cls) -> builtins.str:
|
|
2866
|
+
'''A counter that identifies the attempt number for the current invocation, for example, 1.'''
|
|
2867
|
+
return typing.cast(builtins.str, jsii.sget(cls, "attemptNumber"))
|
|
2578
2868
|
|
|
2579
|
-
|
|
2580
|
-
|
|
2581
|
-
) ->
|
|
2582
|
-
|
|
2583
|
-
|
|
2869
|
+
@jsii.python.classproperty
|
|
2870
|
+
@jsii.member(jsii_name="executionId")
|
|
2871
|
+
def execution_id(cls) -> builtins.str:
|
|
2872
|
+
'''The unique ID that EventBridge Scheduler assigns for each attempted invocation of a target, for example, d32c5kddcf5bb8c3.'''
|
|
2873
|
+
return typing.cast(builtins.str, jsii.sget(cls, "executionId"))
|
|
2584
2874
|
|
|
2585
|
-
|
|
2586
|
-
|
|
2587
|
-
) ->
|
|
2588
|
-
|
|
2589
|
-
|
|
2875
|
+
@jsii.python.classproperty
|
|
2876
|
+
@jsii.member(jsii_name="scheduleArn")
|
|
2877
|
+
def schedule_arn(cls) -> builtins.str:
|
|
2878
|
+
'''The ARN of the schedule.'''
|
|
2879
|
+
return typing.cast(builtins.str, jsii.sget(cls, "scheduleArn"))
|
|
2590
2880
|
|
|
2591
|
-
|
|
2592
|
-
|
|
2593
|
-
) ->
|
|
2594
|
-
|
|
2595
|
-
|
|
2881
|
+
@jsii.python.classproperty
|
|
2882
|
+
@jsii.member(jsii_name="scheduledTime")
|
|
2883
|
+
def scheduled_time(cls) -> builtins.str:
|
|
2884
|
+
'''The time you specified for the schedule to invoke its target, for example, 2022-03-22T18:59:43Z.'''
|
|
2885
|
+
return typing.cast(builtins.str, jsii.sget(cls, "scheduledTime"))
|
|
2596
2886
|
|
|
2597
|
-
|
|
2598
|
-
|
|
2599
|
-
) ->
|
|
2600
|
-
|
|
2601
|
-
pass
|
|
2887
|
+
@builtins.property
|
|
2888
|
+
@jsii.member(jsii_name="name")
|
|
2889
|
+
def name(self) -> builtins.str:
|
|
2890
|
+
return typing.cast(builtins.str, jsii.get(self, "name"))
|
|
2602
2891
|
|
|
2603
|
-
def _typecheckingstub__eb6bd8d80ac829e96128e011c87e852bfea080bdcd859bfdf98c7874542dc1b5(
|
|
2604
|
-
value: typing.Optional[builtins.str],
|
|
2605
|
-
) -> None:
|
|
2606
|
-
"""Type checking stubs"""
|
|
2607
|
-
pass
|
|
2608
2892
|
|
|
2609
|
-
|
|
2610
|
-
|
|
2611
|
-
|
|
2612
|
-
|
|
2613
|
-
|
|
2893
|
+
@jsii.data_type(
|
|
2894
|
+
jsii_type="aws-cdk-lib.aws_scheduler.CronOptionsWithTimezone",
|
|
2895
|
+
jsii_struct_bases=[_CronOptions_6401a7a0],
|
|
2896
|
+
name_mapping={
|
|
2897
|
+
"day": "day",
|
|
2898
|
+
"hour": "hour",
|
|
2899
|
+
"minute": "minute",
|
|
2900
|
+
"month": "month",
|
|
2901
|
+
"week_day": "weekDay",
|
|
2902
|
+
"year": "year",
|
|
2903
|
+
"time_zone": "timeZone",
|
|
2904
|
+
},
|
|
2905
|
+
)
|
|
2906
|
+
class CronOptionsWithTimezone(_CronOptions_6401a7a0):
|
|
2907
|
+
def __init__(
|
|
2908
|
+
self,
|
|
2909
|
+
*,
|
|
2910
|
+
day: typing.Optional[builtins.str] = None,
|
|
2911
|
+
hour: typing.Optional[builtins.str] = None,
|
|
2912
|
+
minute: typing.Optional[builtins.str] = None,
|
|
2913
|
+
month: typing.Optional[builtins.str] = None,
|
|
2914
|
+
week_day: typing.Optional[builtins.str] = None,
|
|
2915
|
+
year: typing.Optional[builtins.str] = None,
|
|
2916
|
+
time_zone: typing.Optional[_TimeZone_cdd72ac9] = None,
|
|
2917
|
+
) -> None:
|
|
2918
|
+
'''Options to configure a cron expression.
|
|
2614
2919
|
|
|
2615
|
-
|
|
2616
|
-
|
|
2617
|
-
) -> None:
|
|
2618
|
-
"""Type checking stubs"""
|
|
2619
|
-
pass
|
|
2920
|
+
All fields are strings so you can use complex expressions. Absence of
|
|
2921
|
+
a field implies '*' or '?', whichever one is appropriate.
|
|
2620
2922
|
|
|
2621
|
-
|
|
2622
|
-
|
|
2623
|
-
|
|
2624
|
-
|
|
2625
|
-
|
|
2923
|
+
:param day: The day of the month to run this rule at. Default: - Every day of the month
|
|
2924
|
+
:param hour: The hour to run this rule at. Default: - Every hour
|
|
2925
|
+
:param minute: The minute to run this rule at. Default: - Every minute
|
|
2926
|
+
:param month: The month to run this rule at. Default: - Every month
|
|
2927
|
+
:param week_day: The day of the week to run this rule at. Default: - Any day of the week
|
|
2928
|
+
:param year: The year to run this rule at. Default: - Every year
|
|
2929
|
+
:param time_zone: The timezone to run the schedule in. Default: - TimeZone.ETC_UTC
|
|
2626
2930
|
|
|
2627
|
-
|
|
2628
|
-
|
|
2629
|
-
subnets: typing.Sequence[builtins.str],
|
|
2630
|
-
assign_public_ip: typing.Optional[builtins.str] = None,
|
|
2631
|
-
security_groups: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
2632
|
-
) -> None:
|
|
2633
|
-
"""Type checking stubs"""
|
|
2634
|
-
pass
|
|
2931
|
+
:see: https://docs.aws.amazon.com/eventbridge/latest/userguide/scheduled-events.html#cron-expressions
|
|
2932
|
+
:exampleMetadata: infused
|
|
2635
2933
|
|
|
2636
|
-
|
|
2637
|
-
*,
|
|
2638
|
-
capacity_provider: builtins.str,
|
|
2639
|
-
base: typing.Optional[jsii.Number] = None,
|
|
2640
|
-
weight: typing.Optional[jsii.Number] = None,
|
|
2641
|
-
) -> None:
|
|
2642
|
-
"""Type checking stubs"""
|
|
2643
|
-
pass
|
|
2934
|
+
Example::
|
|
2644
2935
|
|
|
2645
|
-
|
|
2936
|
+
# target: targets.LambdaInvoke
|
|
2937
|
+
|
|
2938
|
+
|
|
2939
|
+
rate_based_schedule = Schedule(self, "Schedule",
|
|
2940
|
+
schedule=ScheduleExpression.rate(Duration.minutes(10)),
|
|
2941
|
+
target=target,
|
|
2942
|
+
description="This is a test rate-based schedule"
|
|
2943
|
+
)
|
|
2944
|
+
|
|
2945
|
+
cron_based_schedule = Schedule(self, "Schedule",
|
|
2946
|
+
schedule=ScheduleExpression.cron(
|
|
2947
|
+
minute="0",
|
|
2948
|
+
hour="23",
|
|
2949
|
+
day="20",
|
|
2950
|
+
month="11",
|
|
2951
|
+
time_zone=TimeZone.AMERICA_NEW_YORK
|
|
2952
|
+
),
|
|
2953
|
+
target=target,
|
|
2954
|
+
description="This is a test cron-based schedule that will run at 11:00 PM, on day 20 of the month, only in November in New York timezone"
|
|
2955
|
+
)
|
|
2956
|
+
'''
|
|
2957
|
+
if __debug__:
|
|
2958
|
+
type_hints = typing.get_type_hints(_typecheckingstub__c87f71f166be27f7417012dedd810bd7b3cedb2ec7d0a0493ca36f93993f6c5b)
|
|
2959
|
+
check_type(argname="argument day", value=day, expected_type=type_hints["day"])
|
|
2960
|
+
check_type(argname="argument hour", value=hour, expected_type=type_hints["hour"])
|
|
2961
|
+
check_type(argname="argument minute", value=minute, expected_type=type_hints["minute"])
|
|
2962
|
+
check_type(argname="argument month", value=month, expected_type=type_hints["month"])
|
|
2963
|
+
check_type(argname="argument week_day", value=week_day, expected_type=type_hints["week_day"])
|
|
2964
|
+
check_type(argname="argument year", value=year, expected_type=type_hints["year"])
|
|
2965
|
+
check_type(argname="argument time_zone", value=time_zone, expected_type=type_hints["time_zone"])
|
|
2966
|
+
self._values: typing.Dict[builtins.str, typing.Any] = {}
|
|
2967
|
+
if day is not None:
|
|
2968
|
+
self._values["day"] = day
|
|
2969
|
+
if hour is not None:
|
|
2970
|
+
self._values["hour"] = hour
|
|
2971
|
+
if minute is not None:
|
|
2972
|
+
self._values["minute"] = minute
|
|
2973
|
+
if month is not None:
|
|
2974
|
+
self._values["month"] = month
|
|
2975
|
+
if week_day is not None:
|
|
2976
|
+
self._values["week_day"] = week_day
|
|
2977
|
+
if year is not None:
|
|
2978
|
+
self._values["year"] = year
|
|
2979
|
+
if time_zone is not None:
|
|
2980
|
+
self._values["time_zone"] = time_zone
|
|
2981
|
+
|
|
2982
|
+
@builtins.property
|
|
2983
|
+
def day(self) -> typing.Optional[builtins.str]:
|
|
2984
|
+
'''The day of the month to run this rule at.
|
|
2985
|
+
|
|
2986
|
+
:default: - Every day of the month
|
|
2987
|
+
'''
|
|
2988
|
+
result = self._values.get("day")
|
|
2989
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
|
2990
|
+
|
|
2991
|
+
@builtins.property
|
|
2992
|
+
def hour(self) -> typing.Optional[builtins.str]:
|
|
2993
|
+
'''The hour to run this rule at.
|
|
2994
|
+
|
|
2995
|
+
:default: - Every hour
|
|
2996
|
+
'''
|
|
2997
|
+
result = self._values.get("hour")
|
|
2998
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
|
2999
|
+
|
|
3000
|
+
@builtins.property
|
|
3001
|
+
def minute(self) -> typing.Optional[builtins.str]:
|
|
3002
|
+
'''The minute to run this rule at.
|
|
3003
|
+
|
|
3004
|
+
:default: - Every minute
|
|
3005
|
+
'''
|
|
3006
|
+
result = self._values.get("minute")
|
|
3007
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
|
3008
|
+
|
|
3009
|
+
@builtins.property
|
|
3010
|
+
def month(self) -> typing.Optional[builtins.str]:
|
|
3011
|
+
'''The month to run this rule at.
|
|
3012
|
+
|
|
3013
|
+
:default: - Every month
|
|
3014
|
+
'''
|
|
3015
|
+
result = self._values.get("month")
|
|
3016
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
|
3017
|
+
|
|
3018
|
+
@builtins.property
|
|
3019
|
+
def week_day(self) -> typing.Optional[builtins.str]:
|
|
3020
|
+
'''The day of the week to run this rule at.
|
|
3021
|
+
|
|
3022
|
+
:default: - Any day of the week
|
|
3023
|
+
'''
|
|
3024
|
+
result = self._values.get("week_day")
|
|
3025
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
|
3026
|
+
|
|
3027
|
+
@builtins.property
|
|
3028
|
+
def year(self) -> typing.Optional[builtins.str]:
|
|
3029
|
+
'''The year to run this rule at.
|
|
3030
|
+
|
|
3031
|
+
:default: - Every year
|
|
3032
|
+
'''
|
|
3033
|
+
result = self._values.get("year")
|
|
3034
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
|
3035
|
+
|
|
3036
|
+
@builtins.property
|
|
3037
|
+
def time_zone(self) -> typing.Optional[_TimeZone_cdd72ac9]:
|
|
3038
|
+
'''The timezone to run the schedule in.
|
|
3039
|
+
|
|
3040
|
+
:default: - TimeZone.ETC_UTC
|
|
3041
|
+
'''
|
|
3042
|
+
result = self._values.get("time_zone")
|
|
3043
|
+
return typing.cast(typing.Optional[_TimeZone_cdd72ac9], result)
|
|
3044
|
+
|
|
3045
|
+
def __eq__(self, rhs: typing.Any) -> builtins.bool:
|
|
3046
|
+
return isinstance(rhs, self.__class__) and rhs._values == self._values
|
|
3047
|
+
|
|
3048
|
+
def __ne__(self, rhs: typing.Any) -> builtins.bool:
|
|
3049
|
+
return not (rhs == self)
|
|
3050
|
+
|
|
3051
|
+
def __repr__(self) -> str:
|
|
3052
|
+
return "CronOptionsWithTimezone(%s)" % ", ".join(
|
|
3053
|
+
k + "=" + repr(v) for k, v in self._values.items()
|
|
3054
|
+
)
|
|
3055
|
+
|
|
3056
|
+
|
|
3057
|
+
@jsii.interface(jsii_type="aws-cdk-lib.aws_scheduler.ISchedule")
|
|
3058
|
+
class ISchedule(_IResource_c80c4260, typing_extensions.Protocol):
|
|
3059
|
+
'''Interface representing a created or an imported ``Schedule``.'''
|
|
3060
|
+
|
|
3061
|
+
@builtins.property
|
|
3062
|
+
@jsii.member(jsii_name="scheduleArn")
|
|
3063
|
+
def schedule_arn(self) -> builtins.str:
|
|
3064
|
+
'''The arn of the schedule.
|
|
3065
|
+
|
|
3066
|
+
:attribute: true
|
|
3067
|
+
'''
|
|
3068
|
+
...
|
|
3069
|
+
|
|
3070
|
+
@builtins.property
|
|
3071
|
+
@jsii.member(jsii_name="scheduleName")
|
|
3072
|
+
def schedule_name(self) -> builtins.str:
|
|
3073
|
+
'''The name of the schedule.
|
|
3074
|
+
|
|
3075
|
+
:attribute: true
|
|
3076
|
+
'''
|
|
3077
|
+
...
|
|
3078
|
+
|
|
3079
|
+
@builtins.property
|
|
3080
|
+
@jsii.member(jsii_name="scheduleGroup")
|
|
3081
|
+
def schedule_group(self) -> typing.Optional["IScheduleGroup"]:
|
|
3082
|
+
'''The schedule group associated with this schedule.'''
|
|
3083
|
+
...
|
|
3084
|
+
|
|
3085
|
+
|
|
3086
|
+
class _IScheduleProxy(
|
|
3087
|
+
jsii.proxy_for(_IResource_c80c4260), # type: ignore[misc]
|
|
3088
|
+
):
|
|
3089
|
+
'''Interface representing a created or an imported ``Schedule``.'''
|
|
3090
|
+
|
|
3091
|
+
__jsii_type__: typing.ClassVar[str] = "aws-cdk-lib.aws_scheduler.ISchedule"
|
|
3092
|
+
|
|
3093
|
+
@builtins.property
|
|
3094
|
+
@jsii.member(jsii_name="scheduleArn")
|
|
3095
|
+
def schedule_arn(self) -> builtins.str:
|
|
3096
|
+
'''The arn of the schedule.
|
|
3097
|
+
|
|
3098
|
+
:attribute: true
|
|
3099
|
+
'''
|
|
3100
|
+
return typing.cast(builtins.str, jsii.get(self, "scheduleArn"))
|
|
3101
|
+
|
|
3102
|
+
@builtins.property
|
|
3103
|
+
@jsii.member(jsii_name="scheduleName")
|
|
3104
|
+
def schedule_name(self) -> builtins.str:
|
|
3105
|
+
'''The name of the schedule.
|
|
3106
|
+
|
|
3107
|
+
:attribute: true
|
|
3108
|
+
'''
|
|
3109
|
+
return typing.cast(builtins.str, jsii.get(self, "scheduleName"))
|
|
3110
|
+
|
|
3111
|
+
@builtins.property
|
|
3112
|
+
@jsii.member(jsii_name="scheduleGroup")
|
|
3113
|
+
def schedule_group(self) -> typing.Optional["IScheduleGroup"]:
|
|
3114
|
+
'''The schedule group associated with this schedule.'''
|
|
3115
|
+
return typing.cast(typing.Optional["IScheduleGroup"], jsii.get(self, "scheduleGroup"))
|
|
3116
|
+
|
|
3117
|
+
# Adding a "__jsii_proxy_class__(): typing.Type" function to the interface
|
|
3118
|
+
typing.cast(typing.Any, ISchedule).__jsii_proxy_class__ = lambda : _IScheduleProxy
|
|
3119
|
+
|
|
3120
|
+
|
|
3121
|
+
@jsii.interface(jsii_type="aws-cdk-lib.aws_scheduler.IScheduleGroup")
|
|
3122
|
+
class IScheduleGroup(_IResource_c80c4260, typing_extensions.Protocol):
|
|
3123
|
+
'''Interface representing a created or an imported ``ScheduleGroup``.'''
|
|
3124
|
+
|
|
3125
|
+
@builtins.property
|
|
3126
|
+
@jsii.member(jsii_name="scheduleGroupArn")
|
|
3127
|
+
def schedule_group_arn(self) -> builtins.str:
|
|
3128
|
+
'''The arn of the schedule group.
|
|
3129
|
+
|
|
3130
|
+
:attribute: true
|
|
3131
|
+
'''
|
|
3132
|
+
...
|
|
3133
|
+
|
|
3134
|
+
@builtins.property
|
|
3135
|
+
@jsii.member(jsii_name="scheduleGroupName")
|
|
3136
|
+
def schedule_group_name(self) -> builtins.str:
|
|
3137
|
+
'''The name of the schedule group.
|
|
3138
|
+
|
|
3139
|
+
:attribute: true
|
|
3140
|
+
'''
|
|
3141
|
+
...
|
|
3142
|
+
|
|
3143
|
+
@jsii.member(jsii_name="grant")
|
|
3144
|
+
def grant(
|
|
3145
|
+
self,
|
|
3146
|
+
grantee: _IGrantable_71c4f5de,
|
|
3147
|
+
*actions: builtins.str,
|
|
3148
|
+
) -> _Grant_a7ae64f8:
|
|
3149
|
+
'''Grant the indicated permissions on this group to the given principal.
|
|
3150
|
+
|
|
3151
|
+
:param grantee: -
|
|
3152
|
+
:param actions: -
|
|
3153
|
+
'''
|
|
3154
|
+
...
|
|
3155
|
+
|
|
3156
|
+
@jsii.member(jsii_name="grantDeleteSchedules")
|
|
3157
|
+
def grant_delete_schedules(self, identity: _IGrantable_71c4f5de) -> _Grant_a7ae64f8:
|
|
3158
|
+
'''Grant delete schedule permission for schedules in this group to the given principal.
|
|
3159
|
+
|
|
3160
|
+
:param identity: -
|
|
3161
|
+
'''
|
|
3162
|
+
...
|
|
3163
|
+
|
|
3164
|
+
@jsii.member(jsii_name="grantReadSchedules")
|
|
3165
|
+
def grant_read_schedules(self, identity: _IGrantable_71c4f5de) -> _Grant_a7ae64f8:
|
|
3166
|
+
'''Grant list and get schedule permissions for schedules in this group to the given principal.
|
|
3167
|
+
|
|
3168
|
+
:param identity: -
|
|
3169
|
+
'''
|
|
3170
|
+
...
|
|
3171
|
+
|
|
3172
|
+
@jsii.member(jsii_name="grantWriteSchedules")
|
|
3173
|
+
def grant_write_schedules(self, identity: _IGrantable_71c4f5de) -> _Grant_a7ae64f8:
|
|
3174
|
+
'''Grant create and update schedule permissions for schedules in this group to the given principal.
|
|
3175
|
+
|
|
3176
|
+
:param identity: -
|
|
3177
|
+
'''
|
|
3178
|
+
...
|
|
3179
|
+
|
|
3180
|
+
@jsii.member(jsii_name="metric")
|
|
3181
|
+
def metric(
|
|
3182
|
+
self,
|
|
3183
|
+
metric_name: builtins.str,
|
|
3184
|
+
*,
|
|
3185
|
+
account: typing.Optional[builtins.str] = None,
|
|
3186
|
+
color: typing.Optional[builtins.str] = None,
|
|
3187
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
3188
|
+
label: typing.Optional[builtins.str] = None,
|
|
3189
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
3190
|
+
region: typing.Optional[builtins.str] = None,
|
|
3191
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
3192
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
3193
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
3194
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
3195
|
+
) -> _Metric_e396a4dc:
|
|
3196
|
+
'''Return the given named metric for this group schedules.
|
|
3197
|
+
|
|
3198
|
+
:param metric_name: -
|
|
3199
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
3200
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
3201
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
3202
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
3203
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
3204
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
3205
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
3206
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
3207
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
3208
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
3209
|
+
|
|
3210
|
+
:default: - sum over 5 minutes
|
|
3211
|
+
'''
|
|
3212
|
+
...
|
|
3213
|
+
|
|
3214
|
+
@jsii.member(jsii_name="metricAttempts")
|
|
3215
|
+
def metric_attempts(
|
|
3216
|
+
self,
|
|
3217
|
+
*,
|
|
3218
|
+
account: typing.Optional[builtins.str] = None,
|
|
3219
|
+
color: typing.Optional[builtins.str] = None,
|
|
3220
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
3221
|
+
label: typing.Optional[builtins.str] = None,
|
|
3222
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
3223
|
+
region: typing.Optional[builtins.str] = None,
|
|
3224
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
3225
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
3226
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
3227
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
3228
|
+
) -> _Metric_e396a4dc:
|
|
3229
|
+
'''Metric for all invocation attempts.
|
|
3230
|
+
|
|
3231
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
3232
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
3233
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
3234
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
3235
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
3236
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
3237
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
3238
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
3239
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
3240
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
3241
|
+
|
|
3242
|
+
:default: - sum over 5 minutes
|
|
3243
|
+
'''
|
|
3244
|
+
...
|
|
3245
|
+
|
|
3246
|
+
@jsii.member(jsii_name="metricDropped")
|
|
3247
|
+
def metric_dropped(
|
|
3248
|
+
self,
|
|
3249
|
+
*,
|
|
3250
|
+
account: typing.Optional[builtins.str] = None,
|
|
3251
|
+
color: typing.Optional[builtins.str] = None,
|
|
3252
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
3253
|
+
label: typing.Optional[builtins.str] = None,
|
|
3254
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
3255
|
+
region: typing.Optional[builtins.str] = None,
|
|
3256
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
3257
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
3258
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
3259
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
3260
|
+
) -> _Metric_e396a4dc:
|
|
3261
|
+
'''Metric for dropped invocations when EventBridge Scheduler stops attempting to invoke the target after a schedule's retry policy has been exhausted.
|
|
3262
|
+
|
|
3263
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
3264
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
3265
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
3266
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
3267
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
3268
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
3269
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
3270
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
3271
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
3272
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
3273
|
+
|
|
3274
|
+
:default: - sum over 5 minutes
|
|
3275
|
+
'''
|
|
3276
|
+
...
|
|
3277
|
+
|
|
3278
|
+
@jsii.member(jsii_name="metricFailedToBeSentToDLQ")
|
|
3279
|
+
def metric_failed_to_be_sent_to_dlq(
|
|
3280
|
+
self,
|
|
3281
|
+
error_code: typing.Optional[builtins.str] = None,
|
|
3282
|
+
*,
|
|
3283
|
+
account: typing.Optional[builtins.str] = None,
|
|
3284
|
+
color: typing.Optional[builtins.str] = None,
|
|
3285
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
3286
|
+
label: typing.Optional[builtins.str] = None,
|
|
3287
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
3288
|
+
region: typing.Optional[builtins.str] = None,
|
|
3289
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
3290
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
3291
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
3292
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
3293
|
+
) -> _Metric_e396a4dc:
|
|
3294
|
+
'''Metric for failed invocations that also failed to deliver to DLQ.
|
|
3295
|
+
|
|
3296
|
+
:param error_code: -
|
|
3297
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
3298
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
3299
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
3300
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
3301
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
3302
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
3303
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
3304
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
3305
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
3306
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
3307
|
+
|
|
3308
|
+
:default: - sum over 5 minutes
|
|
3309
|
+
'''
|
|
3310
|
+
...
|
|
3311
|
+
|
|
3312
|
+
@jsii.member(jsii_name="metricSentToDLQ")
|
|
3313
|
+
def metric_sent_to_dlq(
|
|
3314
|
+
self,
|
|
3315
|
+
*,
|
|
3316
|
+
account: typing.Optional[builtins.str] = None,
|
|
3317
|
+
color: typing.Optional[builtins.str] = None,
|
|
3318
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
3319
|
+
label: typing.Optional[builtins.str] = None,
|
|
3320
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
3321
|
+
region: typing.Optional[builtins.str] = None,
|
|
3322
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
3323
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
3324
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
3325
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
3326
|
+
) -> _Metric_e396a4dc:
|
|
3327
|
+
'''Metric for invocations delivered to the DLQ.
|
|
3328
|
+
|
|
3329
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
3330
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
3331
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
3332
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
3333
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
3334
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
3335
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
3336
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
3337
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
3338
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
3339
|
+
|
|
3340
|
+
:default: - sum over 5 minutes
|
|
3341
|
+
'''
|
|
3342
|
+
...
|
|
3343
|
+
|
|
3344
|
+
@jsii.member(jsii_name="metricSentToDLQTruncated")
|
|
3345
|
+
def metric_sent_to_dlq_truncated(
|
|
3346
|
+
self,
|
|
3347
|
+
*,
|
|
3348
|
+
account: typing.Optional[builtins.str] = None,
|
|
3349
|
+
color: typing.Optional[builtins.str] = None,
|
|
3350
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
3351
|
+
label: typing.Optional[builtins.str] = None,
|
|
3352
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
3353
|
+
region: typing.Optional[builtins.str] = None,
|
|
3354
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
3355
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
3356
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
3357
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
3358
|
+
) -> _Metric_e396a4dc:
|
|
3359
|
+
'''Metric for delivery of failed invocations to DLQ when the payload of the event sent to the DLQ exceeds the maximum size allowed by Amazon SQS.
|
|
3360
|
+
|
|
3361
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
3362
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
3363
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
3364
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
3365
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
3366
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
3367
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
3368
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
3369
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
3370
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
3371
|
+
|
|
3372
|
+
:default: - sum over 5 minutes
|
|
3373
|
+
'''
|
|
3374
|
+
...
|
|
3375
|
+
|
|
3376
|
+
@jsii.member(jsii_name="metricTargetErrors")
|
|
3377
|
+
def metric_target_errors(
|
|
3378
|
+
self,
|
|
3379
|
+
*,
|
|
3380
|
+
account: typing.Optional[builtins.str] = None,
|
|
3381
|
+
color: typing.Optional[builtins.str] = None,
|
|
3382
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
3383
|
+
label: typing.Optional[builtins.str] = None,
|
|
3384
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
3385
|
+
region: typing.Optional[builtins.str] = None,
|
|
3386
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
3387
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
3388
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
3389
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
3390
|
+
) -> _Metric_e396a4dc:
|
|
3391
|
+
'''Emitted when the target returns an exception after EventBridge Scheduler calls the target API.
|
|
3392
|
+
|
|
3393
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
3394
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
3395
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
3396
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
3397
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
3398
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
3399
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
3400
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
3401
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
3402
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
3403
|
+
|
|
3404
|
+
:default: - sum over 5 minutes
|
|
3405
|
+
'''
|
|
3406
|
+
...
|
|
3407
|
+
|
|
3408
|
+
@jsii.member(jsii_name="metricTargetThrottled")
|
|
3409
|
+
def metric_target_throttled(
|
|
3410
|
+
self,
|
|
3411
|
+
*,
|
|
3412
|
+
account: typing.Optional[builtins.str] = None,
|
|
3413
|
+
color: typing.Optional[builtins.str] = None,
|
|
3414
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
3415
|
+
label: typing.Optional[builtins.str] = None,
|
|
3416
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
3417
|
+
region: typing.Optional[builtins.str] = None,
|
|
3418
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
3419
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
3420
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
3421
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
3422
|
+
) -> _Metric_e396a4dc:
|
|
3423
|
+
'''Metric for invocation failures due to API throttling by the target.
|
|
3424
|
+
|
|
3425
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
3426
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
3427
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
3428
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
3429
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
3430
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
3431
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
3432
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
3433
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
3434
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
3435
|
+
|
|
3436
|
+
:default: - sum over 5 minutes
|
|
3437
|
+
'''
|
|
3438
|
+
...
|
|
3439
|
+
|
|
3440
|
+
@jsii.member(jsii_name="metricThrottled")
|
|
3441
|
+
def metric_throttled(
|
|
3442
|
+
self,
|
|
3443
|
+
*,
|
|
3444
|
+
account: typing.Optional[builtins.str] = None,
|
|
3445
|
+
color: typing.Optional[builtins.str] = None,
|
|
3446
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
3447
|
+
label: typing.Optional[builtins.str] = None,
|
|
3448
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
3449
|
+
region: typing.Optional[builtins.str] = None,
|
|
3450
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
3451
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
3452
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
3453
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
3454
|
+
) -> _Metric_e396a4dc:
|
|
3455
|
+
'''Metric for the number of invocations that were throttled because it exceeds your service quotas.
|
|
3456
|
+
|
|
3457
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
3458
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
3459
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
3460
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
3461
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
3462
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
3463
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
3464
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
3465
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
3466
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
3467
|
+
|
|
3468
|
+
:default: - sum over 5 minutes
|
|
3469
|
+
|
|
3470
|
+
:see: https://docs.aws.amazon.com/scheduler/latest/UserGuide/scheduler-quotas.html
|
|
3471
|
+
'''
|
|
3472
|
+
...
|
|
3473
|
+
|
|
3474
|
+
|
|
3475
|
+
class _IScheduleGroupProxy(
|
|
3476
|
+
jsii.proxy_for(_IResource_c80c4260), # type: ignore[misc]
|
|
3477
|
+
):
|
|
3478
|
+
'''Interface representing a created or an imported ``ScheduleGroup``.'''
|
|
3479
|
+
|
|
3480
|
+
__jsii_type__: typing.ClassVar[str] = "aws-cdk-lib.aws_scheduler.IScheduleGroup"
|
|
3481
|
+
|
|
3482
|
+
@builtins.property
|
|
3483
|
+
@jsii.member(jsii_name="scheduleGroupArn")
|
|
3484
|
+
def schedule_group_arn(self) -> builtins.str:
|
|
3485
|
+
'''The arn of the schedule group.
|
|
3486
|
+
|
|
3487
|
+
:attribute: true
|
|
3488
|
+
'''
|
|
3489
|
+
return typing.cast(builtins.str, jsii.get(self, "scheduleGroupArn"))
|
|
3490
|
+
|
|
3491
|
+
@builtins.property
|
|
3492
|
+
@jsii.member(jsii_name="scheduleGroupName")
|
|
3493
|
+
def schedule_group_name(self) -> builtins.str:
|
|
3494
|
+
'''The name of the schedule group.
|
|
3495
|
+
|
|
3496
|
+
:attribute: true
|
|
3497
|
+
'''
|
|
3498
|
+
return typing.cast(builtins.str, jsii.get(self, "scheduleGroupName"))
|
|
3499
|
+
|
|
3500
|
+
@jsii.member(jsii_name="grant")
|
|
3501
|
+
def grant(
|
|
3502
|
+
self,
|
|
3503
|
+
grantee: _IGrantable_71c4f5de,
|
|
3504
|
+
*actions: builtins.str,
|
|
3505
|
+
) -> _Grant_a7ae64f8:
|
|
3506
|
+
'''Grant the indicated permissions on this group to the given principal.
|
|
3507
|
+
|
|
3508
|
+
:param grantee: -
|
|
3509
|
+
:param actions: -
|
|
3510
|
+
'''
|
|
3511
|
+
if __debug__:
|
|
3512
|
+
type_hints = typing.get_type_hints(_typecheckingstub__190f03a36ab90eca0db1bdfd7c06d5891c61b69defb1c7be61f45d771a66e130)
|
|
3513
|
+
check_type(argname="argument grantee", value=grantee, expected_type=type_hints["grantee"])
|
|
3514
|
+
check_type(argname="argument actions", value=actions, expected_type=typing.Tuple[type_hints["actions"], ...]) # pyright: ignore [reportGeneralTypeIssues]
|
|
3515
|
+
return typing.cast(_Grant_a7ae64f8, jsii.invoke(self, "grant", [grantee, *actions]))
|
|
3516
|
+
|
|
3517
|
+
@jsii.member(jsii_name="grantDeleteSchedules")
|
|
3518
|
+
def grant_delete_schedules(self, identity: _IGrantable_71c4f5de) -> _Grant_a7ae64f8:
|
|
3519
|
+
'''Grant delete schedule permission for schedules in this group to the given principal.
|
|
3520
|
+
|
|
3521
|
+
:param identity: -
|
|
3522
|
+
'''
|
|
3523
|
+
if __debug__:
|
|
3524
|
+
type_hints = typing.get_type_hints(_typecheckingstub__579ff4205e0ccb1830f899a44fc742e9853277ba0f82091be749e20b4fdbf1c2)
|
|
3525
|
+
check_type(argname="argument identity", value=identity, expected_type=type_hints["identity"])
|
|
3526
|
+
return typing.cast(_Grant_a7ae64f8, jsii.invoke(self, "grantDeleteSchedules", [identity]))
|
|
3527
|
+
|
|
3528
|
+
@jsii.member(jsii_name="grantReadSchedules")
|
|
3529
|
+
def grant_read_schedules(self, identity: _IGrantable_71c4f5de) -> _Grant_a7ae64f8:
|
|
3530
|
+
'''Grant list and get schedule permissions for schedules in this group to the given principal.
|
|
3531
|
+
|
|
3532
|
+
:param identity: -
|
|
3533
|
+
'''
|
|
3534
|
+
if __debug__:
|
|
3535
|
+
type_hints = typing.get_type_hints(_typecheckingstub__66f280f7a41957c98ada2240887b088985bbe273d1067b2c4f83f8ca69d09aae)
|
|
3536
|
+
check_type(argname="argument identity", value=identity, expected_type=type_hints["identity"])
|
|
3537
|
+
return typing.cast(_Grant_a7ae64f8, jsii.invoke(self, "grantReadSchedules", [identity]))
|
|
3538
|
+
|
|
3539
|
+
@jsii.member(jsii_name="grantWriteSchedules")
|
|
3540
|
+
def grant_write_schedules(self, identity: _IGrantable_71c4f5de) -> _Grant_a7ae64f8:
|
|
3541
|
+
'''Grant create and update schedule permissions for schedules in this group to the given principal.
|
|
3542
|
+
|
|
3543
|
+
:param identity: -
|
|
3544
|
+
'''
|
|
3545
|
+
if __debug__:
|
|
3546
|
+
type_hints = typing.get_type_hints(_typecheckingstub__f189e0a2b180ceb7d47a54524a64df15a2d1c7a5efe1e25873a64a68692c1d18)
|
|
3547
|
+
check_type(argname="argument identity", value=identity, expected_type=type_hints["identity"])
|
|
3548
|
+
return typing.cast(_Grant_a7ae64f8, jsii.invoke(self, "grantWriteSchedules", [identity]))
|
|
3549
|
+
|
|
3550
|
+
@jsii.member(jsii_name="metric")
|
|
3551
|
+
def metric(
|
|
3552
|
+
self,
|
|
3553
|
+
metric_name: builtins.str,
|
|
3554
|
+
*,
|
|
3555
|
+
account: typing.Optional[builtins.str] = None,
|
|
3556
|
+
color: typing.Optional[builtins.str] = None,
|
|
3557
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
3558
|
+
label: typing.Optional[builtins.str] = None,
|
|
3559
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
3560
|
+
region: typing.Optional[builtins.str] = None,
|
|
3561
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
3562
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
3563
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
3564
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
3565
|
+
) -> _Metric_e396a4dc:
|
|
3566
|
+
'''Return the given named metric for this group schedules.
|
|
3567
|
+
|
|
3568
|
+
:param metric_name: -
|
|
3569
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
3570
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
3571
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
3572
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
3573
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
3574
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
3575
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
3576
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
3577
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
3578
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
3579
|
+
|
|
3580
|
+
:default: - sum over 5 minutes
|
|
3581
|
+
'''
|
|
3582
|
+
if __debug__:
|
|
3583
|
+
type_hints = typing.get_type_hints(_typecheckingstub__b1a1c48be5584426072c1f842a1e31e59436e2cefe7df9e84b5a3115ad743d3e)
|
|
3584
|
+
check_type(argname="argument metric_name", value=metric_name, expected_type=type_hints["metric_name"])
|
|
3585
|
+
props = _MetricOptions_1788b62f(
|
|
3586
|
+
account=account,
|
|
3587
|
+
color=color,
|
|
3588
|
+
dimensions_map=dimensions_map,
|
|
3589
|
+
label=label,
|
|
3590
|
+
period=period,
|
|
3591
|
+
region=region,
|
|
3592
|
+
stack_account=stack_account,
|
|
3593
|
+
stack_region=stack_region,
|
|
3594
|
+
statistic=statistic,
|
|
3595
|
+
unit=unit,
|
|
3596
|
+
)
|
|
3597
|
+
|
|
3598
|
+
return typing.cast(_Metric_e396a4dc, jsii.invoke(self, "metric", [metric_name, props]))
|
|
3599
|
+
|
|
3600
|
+
@jsii.member(jsii_name="metricAttempts")
|
|
3601
|
+
def metric_attempts(
|
|
3602
|
+
self,
|
|
3603
|
+
*,
|
|
3604
|
+
account: typing.Optional[builtins.str] = None,
|
|
3605
|
+
color: typing.Optional[builtins.str] = None,
|
|
3606
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
3607
|
+
label: typing.Optional[builtins.str] = None,
|
|
3608
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
3609
|
+
region: typing.Optional[builtins.str] = None,
|
|
3610
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
3611
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
3612
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
3613
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
3614
|
+
) -> _Metric_e396a4dc:
|
|
3615
|
+
'''Metric for all invocation attempts.
|
|
3616
|
+
|
|
3617
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
3618
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
3619
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
3620
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
3621
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
3622
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
3623
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
3624
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
3625
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
3626
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
3627
|
+
|
|
3628
|
+
:default: - sum over 5 minutes
|
|
3629
|
+
'''
|
|
3630
|
+
props = _MetricOptions_1788b62f(
|
|
3631
|
+
account=account,
|
|
3632
|
+
color=color,
|
|
3633
|
+
dimensions_map=dimensions_map,
|
|
3634
|
+
label=label,
|
|
3635
|
+
period=period,
|
|
3636
|
+
region=region,
|
|
3637
|
+
stack_account=stack_account,
|
|
3638
|
+
stack_region=stack_region,
|
|
3639
|
+
statistic=statistic,
|
|
3640
|
+
unit=unit,
|
|
3641
|
+
)
|
|
3642
|
+
|
|
3643
|
+
return typing.cast(_Metric_e396a4dc, jsii.invoke(self, "metricAttempts", [props]))
|
|
3644
|
+
|
|
3645
|
+
@jsii.member(jsii_name="metricDropped")
|
|
3646
|
+
def metric_dropped(
|
|
3647
|
+
self,
|
|
3648
|
+
*,
|
|
3649
|
+
account: typing.Optional[builtins.str] = None,
|
|
3650
|
+
color: typing.Optional[builtins.str] = None,
|
|
3651
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
3652
|
+
label: typing.Optional[builtins.str] = None,
|
|
3653
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
3654
|
+
region: typing.Optional[builtins.str] = None,
|
|
3655
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
3656
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
3657
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
3658
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
3659
|
+
) -> _Metric_e396a4dc:
|
|
3660
|
+
'''Metric for dropped invocations when EventBridge Scheduler stops attempting to invoke the target after a schedule's retry policy has been exhausted.
|
|
3661
|
+
|
|
3662
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
3663
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
3664
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
3665
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
3666
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
3667
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
3668
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
3669
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
3670
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
3671
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
3672
|
+
|
|
3673
|
+
:default: - sum over 5 minutes
|
|
3674
|
+
'''
|
|
3675
|
+
props = _MetricOptions_1788b62f(
|
|
3676
|
+
account=account,
|
|
3677
|
+
color=color,
|
|
3678
|
+
dimensions_map=dimensions_map,
|
|
3679
|
+
label=label,
|
|
3680
|
+
period=period,
|
|
3681
|
+
region=region,
|
|
3682
|
+
stack_account=stack_account,
|
|
3683
|
+
stack_region=stack_region,
|
|
3684
|
+
statistic=statistic,
|
|
3685
|
+
unit=unit,
|
|
3686
|
+
)
|
|
3687
|
+
|
|
3688
|
+
return typing.cast(_Metric_e396a4dc, jsii.invoke(self, "metricDropped", [props]))
|
|
3689
|
+
|
|
3690
|
+
@jsii.member(jsii_name="metricFailedToBeSentToDLQ")
|
|
3691
|
+
def metric_failed_to_be_sent_to_dlq(
|
|
3692
|
+
self,
|
|
3693
|
+
error_code: typing.Optional[builtins.str] = None,
|
|
3694
|
+
*,
|
|
3695
|
+
account: typing.Optional[builtins.str] = None,
|
|
3696
|
+
color: typing.Optional[builtins.str] = None,
|
|
3697
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
3698
|
+
label: typing.Optional[builtins.str] = None,
|
|
3699
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
3700
|
+
region: typing.Optional[builtins.str] = None,
|
|
3701
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
3702
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
3703
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
3704
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
3705
|
+
) -> _Metric_e396a4dc:
|
|
3706
|
+
'''Metric for failed invocations that also failed to deliver to DLQ.
|
|
3707
|
+
|
|
3708
|
+
:param error_code: -
|
|
3709
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
3710
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
3711
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
3712
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
3713
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
3714
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
3715
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
3716
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
3717
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
3718
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
3719
|
+
|
|
3720
|
+
:default: - sum over 5 minutes
|
|
3721
|
+
'''
|
|
3722
|
+
if __debug__:
|
|
3723
|
+
type_hints = typing.get_type_hints(_typecheckingstub__43e3d3a73dae7296d8e1b29562f7a8fbdf941fb9885fa0ddcc13164e2352e68d)
|
|
3724
|
+
check_type(argname="argument error_code", value=error_code, expected_type=type_hints["error_code"])
|
|
3725
|
+
props = _MetricOptions_1788b62f(
|
|
3726
|
+
account=account,
|
|
3727
|
+
color=color,
|
|
3728
|
+
dimensions_map=dimensions_map,
|
|
3729
|
+
label=label,
|
|
3730
|
+
period=period,
|
|
3731
|
+
region=region,
|
|
3732
|
+
stack_account=stack_account,
|
|
3733
|
+
stack_region=stack_region,
|
|
3734
|
+
statistic=statistic,
|
|
3735
|
+
unit=unit,
|
|
3736
|
+
)
|
|
3737
|
+
|
|
3738
|
+
return typing.cast(_Metric_e396a4dc, jsii.invoke(self, "metricFailedToBeSentToDLQ", [error_code, props]))
|
|
3739
|
+
|
|
3740
|
+
@jsii.member(jsii_name="metricSentToDLQ")
|
|
3741
|
+
def metric_sent_to_dlq(
|
|
3742
|
+
self,
|
|
3743
|
+
*,
|
|
3744
|
+
account: typing.Optional[builtins.str] = None,
|
|
3745
|
+
color: typing.Optional[builtins.str] = None,
|
|
3746
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
3747
|
+
label: typing.Optional[builtins.str] = None,
|
|
3748
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
3749
|
+
region: typing.Optional[builtins.str] = None,
|
|
3750
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
3751
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
3752
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
3753
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
3754
|
+
) -> _Metric_e396a4dc:
|
|
3755
|
+
'''Metric for invocations delivered to the DLQ.
|
|
3756
|
+
|
|
3757
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
3758
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
3759
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
3760
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
3761
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
3762
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
3763
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
3764
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
3765
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
3766
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
3767
|
+
|
|
3768
|
+
:default: - sum over 5 minutes
|
|
3769
|
+
'''
|
|
3770
|
+
props = _MetricOptions_1788b62f(
|
|
3771
|
+
account=account,
|
|
3772
|
+
color=color,
|
|
3773
|
+
dimensions_map=dimensions_map,
|
|
3774
|
+
label=label,
|
|
3775
|
+
period=period,
|
|
3776
|
+
region=region,
|
|
3777
|
+
stack_account=stack_account,
|
|
3778
|
+
stack_region=stack_region,
|
|
3779
|
+
statistic=statistic,
|
|
3780
|
+
unit=unit,
|
|
3781
|
+
)
|
|
3782
|
+
|
|
3783
|
+
return typing.cast(_Metric_e396a4dc, jsii.invoke(self, "metricSentToDLQ", [props]))
|
|
3784
|
+
|
|
3785
|
+
@jsii.member(jsii_name="metricSentToDLQTruncated")
|
|
3786
|
+
def metric_sent_to_dlq_truncated(
|
|
3787
|
+
self,
|
|
3788
|
+
*,
|
|
3789
|
+
account: typing.Optional[builtins.str] = None,
|
|
3790
|
+
color: typing.Optional[builtins.str] = None,
|
|
3791
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
3792
|
+
label: typing.Optional[builtins.str] = None,
|
|
3793
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
3794
|
+
region: typing.Optional[builtins.str] = None,
|
|
3795
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
3796
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
3797
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
3798
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
3799
|
+
) -> _Metric_e396a4dc:
|
|
3800
|
+
'''Metric for delivery of failed invocations to DLQ when the payload of the event sent to the DLQ exceeds the maximum size allowed by Amazon SQS.
|
|
3801
|
+
|
|
3802
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
3803
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
3804
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
3805
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
3806
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
3807
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
3808
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
3809
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
3810
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
3811
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
3812
|
+
|
|
3813
|
+
:default: - sum over 5 minutes
|
|
3814
|
+
'''
|
|
3815
|
+
props = _MetricOptions_1788b62f(
|
|
3816
|
+
account=account,
|
|
3817
|
+
color=color,
|
|
3818
|
+
dimensions_map=dimensions_map,
|
|
3819
|
+
label=label,
|
|
3820
|
+
period=period,
|
|
3821
|
+
region=region,
|
|
3822
|
+
stack_account=stack_account,
|
|
3823
|
+
stack_region=stack_region,
|
|
3824
|
+
statistic=statistic,
|
|
3825
|
+
unit=unit,
|
|
3826
|
+
)
|
|
3827
|
+
|
|
3828
|
+
return typing.cast(_Metric_e396a4dc, jsii.invoke(self, "metricSentToDLQTruncated", [props]))
|
|
3829
|
+
|
|
3830
|
+
@jsii.member(jsii_name="metricTargetErrors")
|
|
3831
|
+
def metric_target_errors(
|
|
3832
|
+
self,
|
|
3833
|
+
*,
|
|
3834
|
+
account: typing.Optional[builtins.str] = None,
|
|
3835
|
+
color: typing.Optional[builtins.str] = None,
|
|
3836
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
3837
|
+
label: typing.Optional[builtins.str] = None,
|
|
3838
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
3839
|
+
region: typing.Optional[builtins.str] = None,
|
|
3840
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
3841
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
3842
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
3843
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
3844
|
+
) -> _Metric_e396a4dc:
|
|
3845
|
+
'''Emitted when the target returns an exception after EventBridge Scheduler calls the target API.
|
|
3846
|
+
|
|
3847
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
3848
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
3849
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
3850
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
3851
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
3852
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
3853
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
3854
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
3855
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
3856
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
3857
|
+
|
|
3858
|
+
:default: - sum over 5 minutes
|
|
3859
|
+
'''
|
|
3860
|
+
props = _MetricOptions_1788b62f(
|
|
3861
|
+
account=account,
|
|
3862
|
+
color=color,
|
|
3863
|
+
dimensions_map=dimensions_map,
|
|
3864
|
+
label=label,
|
|
3865
|
+
period=period,
|
|
3866
|
+
region=region,
|
|
3867
|
+
stack_account=stack_account,
|
|
3868
|
+
stack_region=stack_region,
|
|
3869
|
+
statistic=statistic,
|
|
3870
|
+
unit=unit,
|
|
3871
|
+
)
|
|
3872
|
+
|
|
3873
|
+
return typing.cast(_Metric_e396a4dc, jsii.invoke(self, "metricTargetErrors", [props]))
|
|
3874
|
+
|
|
3875
|
+
@jsii.member(jsii_name="metricTargetThrottled")
|
|
3876
|
+
def metric_target_throttled(
|
|
3877
|
+
self,
|
|
3878
|
+
*,
|
|
3879
|
+
account: typing.Optional[builtins.str] = None,
|
|
3880
|
+
color: typing.Optional[builtins.str] = None,
|
|
3881
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
3882
|
+
label: typing.Optional[builtins.str] = None,
|
|
3883
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
3884
|
+
region: typing.Optional[builtins.str] = None,
|
|
3885
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
3886
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
3887
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
3888
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
3889
|
+
) -> _Metric_e396a4dc:
|
|
3890
|
+
'''Metric for invocation failures due to API throttling by the target.
|
|
3891
|
+
|
|
3892
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
3893
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
3894
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
3895
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
3896
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
3897
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
3898
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
3899
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
3900
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
3901
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
3902
|
+
|
|
3903
|
+
:default: - sum over 5 minutes
|
|
3904
|
+
'''
|
|
3905
|
+
props = _MetricOptions_1788b62f(
|
|
3906
|
+
account=account,
|
|
3907
|
+
color=color,
|
|
3908
|
+
dimensions_map=dimensions_map,
|
|
3909
|
+
label=label,
|
|
3910
|
+
period=period,
|
|
3911
|
+
region=region,
|
|
3912
|
+
stack_account=stack_account,
|
|
3913
|
+
stack_region=stack_region,
|
|
3914
|
+
statistic=statistic,
|
|
3915
|
+
unit=unit,
|
|
3916
|
+
)
|
|
3917
|
+
|
|
3918
|
+
return typing.cast(_Metric_e396a4dc, jsii.invoke(self, "metricTargetThrottled", [props]))
|
|
3919
|
+
|
|
3920
|
+
@jsii.member(jsii_name="metricThrottled")
|
|
3921
|
+
def metric_throttled(
|
|
3922
|
+
self,
|
|
3923
|
+
*,
|
|
3924
|
+
account: typing.Optional[builtins.str] = None,
|
|
3925
|
+
color: typing.Optional[builtins.str] = None,
|
|
3926
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
3927
|
+
label: typing.Optional[builtins.str] = None,
|
|
3928
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
3929
|
+
region: typing.Optional[builtins.str] = None,
|
|
3930
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
3931
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
3932
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
3933
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
3934
|
+
) -> _Metric_e396a4dc:
|
|
3935
|
+
'''Metric for the number of invocations that were throttled because it exceeds your service quotas.
|
|
3936
|
+
|
|
3937
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
3938
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
3939
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
3940
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
3941
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
3942
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
3943
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
3944
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
3945
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
3946
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
3947
|
+
|
|
3948
|
+
:default: - sum over 5 minutes
|
|
3949
|
+
|
|
3950
|
+
:see: https://docs.aws.amazon.com/scheduler/latest/UserGuide/scheduler-quotas.html
|
|
3951
|
+
'''
|
|
3952
|
+
props = _MetricOptions_1788b62f(
|
|
3953
|
+
account=account,
|
|
3954
|
+
color=color,
|
|
3955
|
+
dimensions_map=dimensions_map,
|
|
3956
|
+
label=label,
|
|
3957
|
+
period=period,
|
|
3958
|
+
region=region,
|
|
3959
|
+
stack_account=stack_account,
|
|
3960
|
+
stack_region=stack_region,
|
|
3961
|
+
statistic=statistic,
|
|
3962
|
+
unit=unit,
|
|
3963
|
+
)
|
|
3964
|
+
|
|
3965
|
+
return typing.cast(_Metric_e396a4dc, jsii.invoke(self, "metricThrottled", [props]))
|
|
3966
|
+
|
|
3967
|
+
# Adding a "__jsii_proxy_class__(): typing.Type" function to the interface
|
|
3968
|
+
typing.cast(typing.Any, IScheduleGroup).__jsii_proxy_class__ = lambda : _IScheduleGroupProxy
|
|
3969
|
+
|
|
3970
|
+
|
|
3971
|
+
@jsii.interface(jsii_type="aws-cdk-lib.aws_scheduler.IScheduleTarget")
|
|
3972
|
+
class IScheduleTarget(typing_extensions.Protocol):
|
|
3973
|
+
'''Interface representing a Event Bridge Schedule Target.'''
|
|
3974
|
+
|
|
3975
|
+
@jsii.member(jsii_name="bind")
|
|
3976
|
+
def bind(self, _schedule: ISchedule) -> "ScheduleTargetConfig":
|
|
3977
|
+
'''Returns the schedule target specification.
|
|
3978
|
+
|
|
3979
|
+
:param _schedule: a schedule the target should be added to.
|
|
3980
|
+
'''
|
|
3981
|
+
...
|
|
3982
|
+
|
|
3983
|
+
|
|
3984
|
+
class _IScheduleTargetProxy:
|
|
3985
|
+
'''Interface representing a Event Bridge Schedule Target.'''
|
|
3986
|
+
|
|
3987
|
+
__jsii_type__: typing.ClassVar[str] = "aws-cdk-lib.aws_scheduler.IScheduleTarget"
|
|
3988
|
+
|
|
3989
|
+
@jsii.member(jsii_name="bind")
|
|
3990
|
+
def bind(self, _schedule: ISchedule) -> "ScheduleTargetConfig":
|
|
3991
|
+
'''Returns the schedule target specification.
|
|
3992
|
+
|
|
3993
|
+
:param _schedule: a schedule the target should be added to.
|
|
3994
|
+
'''
|
|
3995
|
+
if __debug__:
|
|
3996
|
+
type_hints = typing.get_type_hints(_typecheckingstub__1db14aa1db4d786b1846e49587706992ee79b66245d52b5efebd763ccbd24c94)
|
|
3997
|
+
check_type(argname="argument _schedule", value=_schedule, expected_type=type_hints["_schedule"])
|
|
3998
|
+
return typing.cast("ScheduleTargetConfig", jsii.invoke(self, "bind", [_schedule]))
|
|
3999
|
+
|
|
4000
|
+
# Adding a "__jsii_proxy_class__(): typing.Type" function to the interface
|
|
4001
|
+
typing.cast(typing.Any, IScheduleTarget).__jsii_proxy_class__ = lambda : _IScheduleTargetProxy
|
|
4002
|
+
|
|
4003
|
+
|
|
4004
|
+
@jsii.implements(ISchedule)
|
|
4005
|
+
class Schedule(
|
|
4006
|
+
_Resource_45bc6135,
|
|
4007
|
+
metaclass=jsii.JSIIMeta,
|
|
4008
|
+
jsii_type="aws-cdk-lib.aws_scheduler.Schedule",
|
|
4009
|
+
):
|
|
4010
|
+
'''An EventBridge Schedule.
|
|
4011
|
+
|
|
4012
|
+
:exampleMetadata: infused
|
|
4013
|
+
|
|
4014
|
+
Example::
|
|
4015
|
+
|
|
4016
|
+
import aws_cdk.aws_kinesisfirehose as firehose
|
|
4017
|
+
# delivery_stream: firehose.IDeliveryStream
|
|
4018
|
+
|
|
4019
|
+
|
|
4020
|
+
payload = {
|
|
4021
|
+
"Data": "record"
|
|
4022
|
+
}
|
|
4023
|
+
|
|
4024
|
+
Schedule(self, "Schedule",
|
|
4025
|
+
schedule=ScheduleExpression.rate(Duration.minutes(60)),
|
|
4026
|
+
target=targets.FirehosePutRecord(delivery_stream,
|
|
4027
|
+
input=ScheduleTargetInput.from_object(payload)
|
|
4028
|
+
)
|
|
4029
|
+
)
|
|
4030
|
+
'''
|
|
4031
|
+
|
|
4032
|
+
def __init__(
|
|
4033
|
+
self,
|
|
4034
|
+
scope: _constructs_77d1e7e8.Construct,
|
|
4035
|
+
id: builtins.str,
|
|
4036
|
+
*,
|
|
4037
|
+
schedule: "ScheduleExpression",
|
|
4038
|
+
target: IScheduleTarget,
|
|
4039
|
+
description: typing.Optional[builtins.str] = None,
|
|
4040
|
+
enabled: typing.Optional[builtins.bool] = None,
|
|
4041
|
+
end: typing.Optional[datetime.datetime] = None,
|
|
4042
|
+
key: typing.Optional[_IKey_5f11635f] = None,
|
|
4043
|
+
schedule_group: typing.Optional[IScheduleGroup] = None,
|
|
4044
|
+
schedule_name: typing.Optional[builtins.str] = None,
|
|
4045
|
+
start: typing.Optional[datetime.datetime] = None,
|
|
4046
|
+
time_window: typing.Optional["TimeWindow"] = None,
|
|
4047
|
+
) -> None:
|
|
4048
|
+
'''
|
|
4049
|
+
:param scope: -
|
|
4050
|
+
:param id: -
|
|
4051
|
+
:param schedule: The expression that defines when the schedule runs. Can be either a ``at``, ``rate`` or ``cron`` expression.
|
|
4052
|
+
:param target: The schedule's target details.
|
|
4053
|
+
:param description: The description you specify for the schedule. Default: - no value
|
|
4054
|
+
:param enabled: Indicates whether the schedule is enabled. Default: true
|
|
4055
|
+
:param end: The date, in UTC, before which the schedule can invoke its target. EventBridge Scheduler ignores end for one-time schedules. Default: - no value
|
|
4056
|
+
:param key: The customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data. Default: - All events in Scheduler are encrypted with a key that AWS owns and manages.
|
|
4057
|
+
:param schedule_group: The schedule's group. Default: - By default a schedule will be associated with the ``default`` group.
|
|
4058
|
+
:param schedule_name: The name of the schedule. Up to 64 letters (uppercase and lowercase), numbers, hyphens, underscores and dots are allowed. Default: - A unique name will be generated
|
|
4059
|
+
:param start: The date, in UTC, after which the schedule can begin invoking its target. EventBridge Scheduler ignores start for one-time schedules. Default: - no value
|
|
4060
|
+
:param time_window: A time window during which EventBridge Scheduler invokes the schedule. Default: TimeWindow.off()
|
|
4061
|
+
'''
|
|
4062
|
+
if __debug__:
|
|
4063
|
+
type_hints = typing.get_type_hints(_typecheckingstub__e5e74b4c774095daccbb01abe34df777261be2bfce9f7ec773cd8688b17dbb98)
|
|
4064
|
+
check_type(argname="argument scope", value=scope, expected_type=type_hints["scope"])
|
|
4065
|
+
check_type(argname="argument id", value=id, expected_type=type_hints["id"])
|
|
4066
|
+
props = ScheduleProps(
|
|
4067
|
+
schedule=schedule,
|
|
4068
|
+
target=target,
|
|
4069
|
+
description=description,
|
|
4070
|
+
enabled=enabled,
|
|
4071
|
+
end=end,
|
|
4072
|
+
key=key,
|
|
4073
|
+
schedule_group=schedule_group,
|
|
4074
|
+
schedule_name=schedule_name,
|
|
4075
|
+
start=start,
|
|
4076
|
+
time_window=time_window,
|
|
4077
|
+
)
|
|
4078
|
+
|
|
4079
|
+
jsii.create(self.__class__, self, [scope, id, props])
|
|
4080
|
+
|
|
4081
|
+
@jsii.member(jsii_name="fromScheduleArn")
|
|
4082
|
+
@builtins.classmethod
|
|
4083
|
+
def from_schedule_arn(
|
|
4084
|
+
cls,
|
|
4085
|
+
scope: _constructs_77d1e7e8.Construct,
|
|
4086
|
+
id: builtins.str,
|
|
4087
|
+
schedule_arn: builtins.str,
|
|
4088
|
+
) -> ISchedule:
|
|
4089
|
+
'''Import an existing schedule using the ARN.
|
|
4090
|
+
|
|
4091
|
+
:param scope: -
|
|
4092
|
+
:param id: -
|
|
4093
|
+
:param schedule_arn: -
|
|
4094
|
+
'''
|
|
4095
|
+
if __debug__:
|
|
4096
|
+
type_hints = typing.get_type_hints(_typecheckingstub__1372455178922293375a1300f4c6e69cee5bc442b16f4036c84aafb7d9332f93)
|
|
4097
|
+
check_type(argname="argument scope", value=scope, expected_type=type_hints["scope"])
|
|
4098
|
+
check_type(argname="argument id", value=id, expected_type=type_hints["id"])
|
|
4099
|
+
check_type(argname="argument schedule_arn", value=schedule_arn, expected_type=type_hints["schedule_arn"])
|
|
4100
|
+
return typing.cast(ISchedule, jsii.sinvoke(cls, "fromScheduleArn", [scope, id, schedule_arn]))
|
|
4101
|
+
|
|
4102
|
+
@jsii.member(jsii_name="metricAll")
|
|
4103
|
+
@builtins.classmethod
|
|
4104
|
+
def metric_all(
|
|
4105
|
+
cls,
|
|
4106
|
+
metric_name: builtins.str,
|
|
4107
|
+
*,
|
|
4108
|
+
account: typing.Optional[builtins.str] = None,
|
|
4109
|
+
color: typing.Optional[builtins.str] = None,
|
|
4110
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
4111
|
+
label: typing.Optional[builtins.str] = None,
|
|
4112
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
4113
|
+
region: typing.Optional[builtins.str] = None,
|
|
4114
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
4115
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
4116
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
4117
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
4118
|
+
) -> _Metric_e396a4dc:
|
|
4119
|
+
'''Return the given named metric for all schedules.
|
|
4120
|
+
|
|
4121
|
+
:param metric_name: -
|
|
4122
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
4123
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
4124
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
4125
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
4126
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
4127
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
4128
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
4129
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
4130
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
4131
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
4132
|
+
|
|
4133
|
+
:default: - sum over 5 minutes
|
|
4134
|
+
'''
|
|
4135
|
+
if __debug__:
|
|
4136
|
+
type_hints = typing.get_type_hints(_typecheckingstub__3e9697edf3bddfcbab866b7220407b409d24e19d71a4831cc2eae389b626c1d7)
|
|
4137
|
+
check_type(argname="argument metric_name", value=metric_name, expected_type=type_hints["metric_name"])
|
|
4138
|
+
props = _MetricOptions_1788b62f(
|
|
4139
|
+
account=account,
|
|
4140
|
+
color=color,
|
|
4141
|
+
dimensions_map=dimensions_map,
|
|
4142
|
+
label=label,
|
|
4143
|
+
period=period,
|
|
4144
|
+
region=region,
|
|
4145
|
+
stack_account=stack_account,
|
|
4146
|
+
stack_region=stack_region,
|
|
4147
|
+
statistic=statistic,
|
|
4148
|
+
unit=unit,
|
|
4149
|
+
)
|
|
4150
|
+
|
|
4151
|
+
return typing.cast(_Metric_e396a4dc, jsii.sinvoke(cls, "metricAll", [metric_name, props]))
|
|
4152
|
+
|
|
4153
|
+
@jsii.member(jsii_name="metricAllAttempts")
|
|
4154
|
+
@builtins.classmethod
|
|
4155
|
+
def metric_all_attempts(
|
|
4156
|
+
cls,
|
|
4157
|
+
*,
|
|
4158
|
+
account: typing.Optional[builtins.str] = None,
|
|
4159
|
+
color: typing.Optional[builtins.str] = None,
|
|
4160
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
4161
|
+
label: typing.Optional[builtins.str] = None,
|
|
4162
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
4163
|
+
region: typing.Optional[builtins.str] = None,
|
|
4164
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
4165
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
4166
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
4167
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
4168
|
+
) -> _Metric_e396a4dc:
|
|
4169
|
+
'''Metric for all invocation attempts across all schedules.
|
|
4170
|
+
|
|
4171
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
4172
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
4173
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
4174
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
4175
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
4176
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
4177
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
4178
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
4179
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
4180
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
4181
|
+
|
|
4182
|
+
:default: - sum over 5 minutes
|
|
4183
|
+
'''
|
|
4184
|
+
props = _MetricOptions_1788b62f(
|
|
4185
|
+
account=account,
|
|
4186
|
+
color=color,
|
|
4187
|
+
dimensions_map=dimensions_map,
|
|
4188
|
+
label=label,
|
|
4189
|
+
period=period,
|
|
4190
|
+
region=region,
|
|
4191
|
+
stack_account=stack_account,
|
|
4192
|
+
stack_region=stack_region,
|
|
4193
|
+
statistic=statistic,
|
|
4194
|
+
unit=unit,
|
|
4195
|
+
)
|
|
4196
|
+
|
|
4197
|
+
return typing.cast(_Metric_e396a4dc, jsii.sinvoke(cls, "metricAllAttempts", [props]))
|
|
4198
|
+
|
|
4199
|
+
@jsii.member(jsii_name="metricAllDropped")
|
|
4200
|
+
@builtins.classmethod
|
|
4201
|
+
def metric_all_dropped(
|
|
4202
|
+
cls,
|
|
4203
|
+
*,
|
|
4204
|
+
account: typing.Optional[builtins.str] = None,
|
|
4205
|
+
color: typing.Optional[builtins.str] = None,
|
|
4206
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
4207
|
+
label: typing.Optional[builtins.str] = None,
|
|
4208
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
4209
|
+
region: typing.Optional[builtins.str] = None,
|
|
4210
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
4211
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
4212
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
4213
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
4214
|
+
) -> _Metric_e396a4dc:
|
|
4215
|
+
'''Metric for dropped invocations when EventBridge Scheduler stops attempting to invoke the target after a schedule's retry policy has been exhausted.
|
|
4216
|
+
|
|
4217
|
+
Metric is calculated for all schedules.
|
|
4218
|
+
|
|
4219
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
4220
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
4221
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
4222
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
4223
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
4224
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
4225
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
4226
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
4227
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
4228
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
4229
|
+
|
|
4230
|
+
:default: - sum over 5 minutes
|
|
4231
|
+
'''
|
|
4232
|
+
props = _MetricOptions_1788b62f(
|
|
4233
|
+
account=account,
|
|
4234
|
+
color=color,
|
|
4235
|
+
dimensions_map=dimensions_map,
|
|
4236
|
+
label=label,
|
|
4237
|
+
period=period,
|
|
4238
|
+
region=region,
|
|
4239
|
+
stack_account=stack_account,
|
|
4240
|
+
stack_region=stack_region,
|
|
4241
|
+
statistic=statistic,
|
|
4242
|
+
unit=unit,
|
|
4243
|
+
)
|
|
4244
|
+
|
|
4245
|
+
return typing.cast(_Metric_e396a4dc, jsii.sinvoke(cls, "metricAllDropped", [props]))
|
|
4246
|
+
|
|
4247
|
+
@jsii.member(jsii_name="metricAllErrors")
|
|
4248
|
+
@builtins.classmethod
|
|
4249
|
+
def metric_all_errors(
|
|
4250
|
+
cls,
|
|
4251
|
+
*,
|
|
4252
|
+
account: typing.Optional[builtins.str] = None,
|
|
4253
|
+
color: typing.Optional[builtins.str] = None,
|
|
4254
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
4255
|
+
label: typing.Optional[builtins.str] = None,
|
|
4256
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
4257
|
+
region: typing.Optional[builtins.str] = None,
|
|
4258
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
4259
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
4260
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
4261
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
4262
|
+
) -> _Metric_e396a4dc:
|
|
4263
|
+
'''Emitted when the target returns an exception after EventBridge Scheduler calls the target API across all schedules.
|
|
4264
|
+
|
|
4265
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
4266
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
4267
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
4268
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
4269
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
4270
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
4271
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
4272
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
4273
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
4274
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
4275
|
+
|
|
4276
|
+
:default: - sum over 5 minutes
|
|
4277
|
+
'''
|
|
4278
|
+
props = _MetricOptions_1788b62f(
|
|
4279
|
+
account=account,
|
|
4280
|
+
color=color,
|
|
4281
|
+
dimensions_map=dimensions_map,
|
|
4282
|
+
label=label,
|
|
4283
|
+
period=period,
|
|
4284
|
+
region=region,
|
|
4285
|
+
stack_account=stack_account,
|
|
4286
|
+
stack_region=stack_region,
|
|
4287
|
+
statistic=statistic,
|
|
4288
|
+
unit=unit,
|
|
4289
|
+
)
|
|
4290
|
+
|
|
4291
|
+
return typing.cast(_Metric_e396a4dc, jsii.sinvoke(cls, "metricAllErrors", [props]))
|
|
4292
|
+
|
|
4293
|
+
@jsii.member(jsii_name="metricAllFailedToBeSentToDLQ")
|
|
4294
|
+
@builtins.classmethod
|
|
4295
|
+
def metric_all_failed_to_be_sent_to_dlq(
|
|
4296
|
+
cls,
|
|
4297
|
+
error_code: typing.Optional[builtins.str] = None,
|
|
4298
|
+
*,
|
|
4299
|
+
account: typing.Optional[builtins.str] = None,
|
|
4300
|
+
color: typing.Optional[builtins.str] = None,
|
|
4301
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
4302
|
+
label: typing.Optional[builtins.str] = None,
|
|
4303
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
4304
|
+
region: typing.Optional[builtins.str] = None,
|
|
4305
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
4306
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
4307
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
4308
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
4309
|
+
) -> _Metric_e396a4dc:
|
|
4310
|
+
'''Metric for failed invocations that also failed to deliver to DLQ across all schedules.
|
|
4311
|
+
|
|
4312
|
+
:param error_code: -
|
|
4313
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
4314
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
4315
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
4316
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
4317
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
4318
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
4319
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
4320
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
4321
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
4322
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
4323
|
+
|
|
4324
|
+
:default: - sum over 5 minutes
|
|
4325
|
+
'''
|
|
4326
|
+
if __debug__:
|
|
4327
|
+
type_hints = typing.get_type_hints(_typecheckingstub__897a723a752bdf5a7cbd4dc9c673edd8862b55def0dfc20984054c323d651b0d)
|
|
4328
|
+
check_type(argname="argument error_code", value=error_code, expected_type=type_hints["error_code"])
|
|
4329
|
+
props = _MetricOptions_1788b62f(
|
|
4330
|
+
account=account,
|
|
4331
|
+
color=color,
|
|
4332
|
+
dimensions_map=dimensions_map,
|
|
4333
|
+
label=label,
|
|
4334
|
+
period=period,
|
|
4335
|
+
region=region,
|
|
4336
|
+
stack_account=stack_account,
|
|
4337
|
+
stack_region=stack_region,
|
|
4338
|
+
statistic=statistic,
|
|
4339
|
+
unit=unit,
|
|
4340
|
+
)
|
|
4341
|
+
|
|
4342
|
+
return typing.cast(_Metric_e396a4dc, jsii.sinvoke(cls, "metricAllFailedToBeSentToDLQ", [error_code, props]))
|
|
4343
|
+
|
|
4344
|
+
@jsii.member(jsii_name="metricAllSentToDLQ")
|
|
4345
|
+
@builtins.classmethod
|
|
4346
|
+
def metric_all_sent_to_dlq(
|
|
4347
|
+
cls,
|
|
4348
|
+
*,
|
|
4349
|
+
account: typing.Optional[builtins.str] = None,
|
|
4350
|
+
color: typing.Optional[builtins.str] = None,
|
|
4351
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
4352
|
+
label: typing.Optional[builtins.str] = None,
|
|
4353
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
4354
|
+
region: typing.Optional[builtins.str] = None,
|
|
4355
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
4356
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
4357
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
4358
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
4359
|
+
) -> _Metric_e396a4dc:
|
|
4360
|
+
'''Metric for invocations delivered to the DLQ across all schedules.
|
|
4361
|
+
|
|
4362
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
4363
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
4364
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
4365
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
4366
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
4367
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
4368
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
4369
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
4370
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
4371
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
4372
|
+
|
|
4373
|
+
:default: - sum over 5 minutes
|
|
4374
|
+
'''
|
|
4375
|
+
props = _MetricOptions_1788b62f(
|
|
4376
|
+
account=account,
|
|
4377
|
+
color=color,
|
|
4378
|
+
dimensions_map=dimensions_map,
|
|
4379
|
+
label=label,
|
|
4380
|
+
period=period,
|
|
4381
|
+
region=region,
|
|
4382
|
+
stack_account=stack_account,
|
|
4383
|
+
stack_region=stack_region,
|
|
4384
|
+
statistic=statistic,
|
|
4385
|
+
unit=unit,
|
|
4386
|
+
)
|
|
4387
|
+
|
|
4388
|
+
return typing.cast(_Metric_e396a4dc, jsii.sinvoke(cls, "metricAllSentToDLQ", [props]))
|
|
4389
|
+
|
|
4390
|
+
@jsii.member(jsii_name="metricAllSentToDLQTruncated")
|
|
4391
|
+
@builtins.classmethod
|
|
4392
|
+
def metric_all_sent_to_dlq_truncated(
|
|
4393
|
+
cls,
|
|
4394
|
+
*,
|
|
4395
|
+
account: typing.Optional[builtins.str] = None,
|
|
4396
|
+
color: typing.Optional[builtins.str] = None,
|
|
4397
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
4398
|
+
label: typing.Optional[builtins.str] = None,
|
|
4399
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
4400
|
+
region: typing.Optional[builtins.str] = None,
|
|
4401
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
4402
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
4403
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
4404
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
4405
|
+
) -> _Metric_e396a4dc:
|
|
4406
|
+
'''Metric for delivery of failed invocations to DLQ when the payload of the event sent to the DLQ exceeds the maximum size allowed by Amazon SQS.
|
|
4407
|
+
|
|
4408
|
+
Metric is calculated for all schedules.
|
|
4409
|
+
|
|
4410
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
4411
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
4412
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
4413
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
4414
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
4415
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
4416
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
4417
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
4418
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
4419
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
4420
|
+
|
|
4421
|
+
:default: - sum over 5 minutes
|
|
4422
|
+
'''
|
|
4423
|
+
props = _MetricOptions_1788b62f(
|
|
4424
|
+
account=account,
|
|
4425
|
+
color=color,
|
|
4426
|
+
dimensions_map=dimensions_map,
|
|
4427
|
+
label=label,
|
|
4428
|
+
period=period,
|
|
4429
|
+
region=region,
|
|
4430
|
+
stack_account=stack_account,
|
|
4431
|
+
stack_region=stack_region,
|
|
4432
|
+
statistic=statistic,
|
|
4433
|
+
unit=unit,
|
|
4434
|
+
)
|
|
4435
|
+
|
|
4436
|
+
return typing.cast(_Metric_e396a4dc, jsii.sinvoke(cls, "metricAllSentToDLQTruncated", [props]))
|
|
4437
|
+
|
|
4438
|
+
@jsii.member(jsii_name="metricAllTargetThrottled")
|
|
4439
|
+
@builtins.classmethod
|
|
4440
|
+
def metric_all_target_throttled(
|
|
4441
|
+
cls,
|
|
4442
|
+
*,
|
|
4443
|
+
account: typing.Optional[builtins.str] = None,
|
|
4444
|
+
color: typing.Optional[builtins.str] = None,
|
|
4445
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
4446
|
+
label: typing.Optional[builtins.str] = None,
|
|
4447
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
4448
|
+
region: typing.Optional[builtins.str] = None,
|
|
4449
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
4450
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
4451
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
4452
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
4453
|
+
) -> _Metric_e396a4dc:
|
|
4454
|
+
'''Metric for invocation failures due to API throttling by the target across all schedules.
|
|
4455
|
+
|
|
4456
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
4457
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
4458
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
4459
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
4460
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
4461
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
4462
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
4463
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
4464
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
4465
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
4466
|
+
|
|
4467
|
+
:default: - sum over 5 minutes
|
|
4468
|
+
'''
|
|
4469
|
+
props = _MetricOptions_1788b62f(
|
|
4470
|
+
account=account,
|
|
4471
|
+
color=color,
|
|
4472
|
+
dimensions_map=dimensions_map,
|
|
4473
|
+
label=label,
|
|
4474
|
+
period=period,
|
|
4475
|
+
region=region,
|
|
4476
|
+
stack_account=stack_account,
|
|
4477
|
+
stack_region=stack_region,
|
|
4478
|
+
statistic=statistic,
|
|
4479
|
+
unit=unit,
|
|
4480
|
+
)
|
|
4481
|
+
|
|
4482
|
+
return typing.cast(_Metric_e396a4dc, jsii.sinvoke(cls, "metricAllTargetThrottled", [props]))
|
|
4483
|
+
|
|
4484
|
+
@jsii.member(jsii_name="metricAllThrottled")
|
|
4485
|
+
@builtins.classmethod
|
|
4486
|
+
def metric_all_throttled(
|
|
4487
|
+
cls,
|
|
4488
|
+
*,
|
|
4489
|
+
account: typing.Optional[builtins.str] = None,
|
|
4490
|
+
color: typing.Optional[builtins.str] = None,
|
|
4491
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
4492
|
+
label: typing.Optional[builtins.str] = None,
|
|
4493
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
4494
|
+
region: typing.Optional[builtins.str] = None,
|
|
4495
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
4496
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
4497
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
4498
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
4499
|
+
) -> _Metric_e396a4dc:
|
|
4500
|
+
'''Metric for the number of invocations that were throttled across all schedules.
|
|
4501
|
+
|
|
4502
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
4503
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
4504
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
4505
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
4506
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
4507
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
4508
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
4509
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
4510
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
4511
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
4512
|
+
|
|
4513
|
+
:default: - sum over 5 minutes
|
|
4514
|
+
|
|
4515
|
+
:see: https://docs.aws.amazon.com/scheduler/latest/UserGuide/scheduler-quotas.html
|
|
4516
|
+
'''
|
|
4517
|
+
props = _MetricOptions_1788b62f(
|
|
4518
|
+
account=account,
|
|
4519
|
+
color=color,
|
|
4520
|
+
dimensions_map=dimensions_map,
|
|
4521
|
+
label=label,
|
|
4522
|
+
period=period,
|
|
4523
|
+
region=region,
|
|
4524
|
+
stack_account=stack_account,
|
|
4525
|
+
stack_region=stack_region,
|
|
4526
|
+
statistic=statistic,
|
|
4527
|
+
unit=unit,
|
|
4528
|
+
)
|
|
4529
|
+
|
|
4530
|
+
return typing.cast(_Metric_e396a4dc, jsii.sinvoke(cls, "metricAllThrottled", [props]))
|
|
4531
|
+
|
|
4532
|
+
@builtins.property
|
|
4533
|
+
@jsii.member(jsii_name="scheduleArn")
|
|
4534
|
+
def schedule_arn(self) -> builtins.str:
|
|
4535
|
+
'''The arn of the schedule.'''
|
|
4536
|
+
return typing.cast(builtins.str, jsii.get(self, "scheduleArn"))
|
|
4537
|
+
|
|
4538
|
+
@builtins.property
|
|
4539
|
+
@jsii.member(jsii_name="scheduleName")
|
|
4540
|
+
def schedule_name(self) -> builtins.str:
|
|
4541
|
+
'''The name of the schedule.'''
|
|
4542
|
+
return typing.cast(builtins.str, jsii.get(self, "scheduleName"))
|
|
4543
|
+
|
|
4544
|
+
@builtins.property
|
|
4545
|
+
@jsii.member(jsii_name="key")
|
|
4546
|
+
def key(self) -> typing.Optional[_IKey_5f11635f]:
|
|
4547
|
+
'''The customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.'''
|
|
4548
|
+
return typing.cast(typing.Optional[_IKey_5f11635f], jsii.get(self, "key"))
|
|
4549
|
+
|
|
4550
|
+
@builtins.property
|
|
4551
|
+
@jsii.member(jsii_name="scheduleGroup")
|
|
4552
|
+
def schedule_group(self) -> typing.Optional[IScheduleGroup]:
|
|
4553
|
+
'''The schedule group associated with this schedule.'''
|
|
4554
|
+
return typing.cast(typing.Optional[IScheduleGroup], jsii.get(self, "scheduleGroup"))
|
|
4555
|
+
|
|
4556
|
+
|
|
4557
|
+
class ScheduleExpression(
|
|
4558
|
+
metaclass=jsii.JSIIAbstractClass,
|
|
4559
|
+
jsii_type="aws-cdk-lib.aws_scheduler.ScheduleExpression",
|
|
4560
|
+
):
|
|
4561
|
+
'''ScheduleExpression for EventBridge Schedule.
|
|
4562
|
+
|
|
4563
|
+
You can choose from three schedule types when configuring your schedule: rate-based, cron-based, and one-time schedules.
|
|
4564
|
+
Both rate-based and cron-based schedules are recurring schedules.
|
|
4565
|
+
|
|
4566
|
+
:see: https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html
|
|
4567
|
+
:exampleMetadata: infused
|
|
4568
|
+
|
|
4569
|
+
Example::
|
|
4570
|
+
|
|
4571
|
+
import aws_cdk.aws_kinesisfirehose as firehose
|
|
4572
|
+
# delivery_stream: firehose.IDeliveryStream
|
|
4573
|
+
|
|
4574
|
+
|
|
4575
|
+
payload = {
|
|
4576
|
+
"Data": "record"
|
|
4577
|
+
}
|
|
4578
|
+
|
|
4579
|
+
Schedule(self, "Schedule",
|
|
4580
|
+
schedule=ScheduleExpression.rate(Duration.minutes(60)),
|
|
4581
|
+
target=targets.FirehosePutRecord(delivery_stream,
|
|
4582
|
+
input=ScheduleTargetInput.from_object(payload)
|
|
4583
|
+
)
|
|
4584
|
+
)
|
|
4585
|
+
'''
|
|
4586
|
+
|
|
4587
|
+
def __init__(self) -> None:
|
|
4588
|
+
jsii.create(self.__class__, self, [])
|
|
4589
|
+
|
|
4590
|
+
@jsii.member(jsii_name="at")
|
|
4591
|
+
@builtins.classmethod
|
|
4592
|
+
def at(
|
|
4593
|
+
cls,
|
|
4594
|
+
date: datetime.datetime,
|
|
4595
|
+
time_zone: typing.Optional[_TimeZone_cdd72ac9] = None,
|
|
4596
|
+
) -> "ScheduleExpression":
|
|
4597
|
+
'''Construct a one-time schedule from a date.
|
|
4598
|
+
|
|
4599
|
+
:param date: The date and time to use. The millisecond part will be ignored.
|
|
4600
|
+
:param time_zone: The time zone to use for interpreting the date. Default: - UTC
|
|
4601
|
+
'''
|
|
4602
|
+
if __debug__:
|
|
4603
|
+
type_hints = typing.get_type_hints(_typecheckingstub__175909e9c50b88b6e35fc2db4998caa986e6da11a9a20dbde9c02ee1ca0b00b8)
|
|
4604
|
+
check_type(argname="argument date", value=date, expected_type=type_hints["date"])
|
|
4605
|
+
check_type(argname="argument time_zone", value=time_zone, expected_type=type_hints["time_zone"])
|
|
4606
|
+
return typing.cast("ScheduleExpression", jsii.sinvoke(cls, "at", [date, time_zone]))
|
|
4607
|
+
|
|
4608
|
+
@jsii.member(jsii_name="cron")
|
|
4609
|
+
@builtins.classmethod
|
|
4610
|
+
def cron(
|
|
4611
|
+
cls,
|
|
4612
|
+
*,
|
|
4613
|
+
time_zone: typing.Optional[_TimeZone_cdd72ac9] = None,
|
|
4614
|
+
day: typing.Optional[builtins.str] = None,
|
|
4615
|
+
hour: typing.Optional[builtins.str] = None,
|
|
4616
|
+
minute: typing.Optional[builtins.str] = None,
|
|
4617
|
+
month: typing.Optional[builtins.str] = None,
|
|
4618
|
+
week_day: typing.Optional[builtins.str] = None,
|
|
4619
|
+
year: typing.Optional[builtins.str] = None,
|
|
4620
|
+
) -> "ScheduleExpression":
|
|
4621
|
+
'''Create a recurring schedule from a set of cron fields and time zone.
|
|
4622
|
+
|
|
4623
|
+
:param time_zone: The timezone to run the schedule in. Default: - TimeZone.ETC_UTC
|
|
4624
|
+
:param day: The day of the month to run this rule at. Default: - Every day of the month
|
|
4625
|
+
:param hour: The hour to run this rule at. Default: - Every hour
|
|
4626
|
+
:param minute: The minute to run this rule at. Default: - Every minute
|
|
4627
|
+
:param month: The month to run this rule at. Default: - Every month
|
|
4628
|
+
:param week_day: The day of the week to run this rule at. Default: - Any day of the week
|
|
4629
|
+
:param year: The year to run this rule at. Default: - Every year
|
|
4630
|
+
'''
|
|
4631
|
+
options = CronOptionsWithTimezone(
|
|
4632
|
+
time_zone=time_zone,
|
|
4633
|
+
day=day,
|
|
4634
|
+
hour=hour,
|
|
4635
|
+
minute=minute,
|
|
4636
|
+
month=month,
|
|
4637
|
+
week_day=week_day,
|
|
4638
|
+
year=year,
|
|
4639
|
+
)
|
|
4640
|
+
|
|
4641
|
+
return typing.cast("ScheduleExpression", jsii.sinvoke(cls, "cron", [options]))
|
|
4642
|
+
|
|
4643
|
+
@jsii.member(jsii_name="expression")
|
|
4644
|
+
@builtins.classmethod
|
|
4645
|
+
def expression(
|
|
4646
|
+
cls,
|
|
4647
|
+
expression: builtins.str,
|
|
4648
|
+
time_zone: typing.Optional[_TimeZone_cdd72ac9] = None,
|
|
4649
|
+
) -> "ScheduleExpression":
|
|
4650
|
+
'''Construct a schedule from a literal schedule expression.
|
|
4651
|
+
|
|
4652
|
+
:param expression: The expression to use. Must be in a format that EventBridge will recognize
|
|
4653
|
+
:param time_zone: The time zone to use for interpreting the expression. Default: - UTC
|
|
4654
|
+
'''
|
|
4655
|
+
if __debug__:
|
|
4656
|
+
type_hints = typing.get_type_hints(_typecheckingstub__21e89766a8d616bfc00e75a22774b5d41c55681b6f5f623f08f201c835dd2902)
|
|
4657
|
+
check_type(argname="argument expression", value=expression, expected_type=type_hints["expression"])
|
|
4658
|
+
check_type(argname="argument time_zone", value=time_zone, expected_type=type_hints["time_zone"])
|
|
4659
|
+
return typing.cast("ScheduleExpression", jsii.sinvoke(cls, "expression", [expression, time_zone]))
|
|
4660
|
+
|
|
4661
|
+
@jsii.member(jsii_name="rate")
|
|
4662
|
+
@builtins.classmethod
|
|
4663
|
+
def rate(cls, duration: _Duration_4839e8c3) -> "ScheduleExpression":
|
|
4664
|
+
'''Construct a recurring schedule from an interval and a time unit.
|
|
4665
|
+
|
|
4666
|
+
Rates may be defined with any unit of time, but when converted into minutes, the duration must be a positive whole number of minutes.
|
|
4667
|
+
|
|
4668
|
+
:param duration: -
|
|
4669
|
+
'''
|
|
4670
|
+
if __debug__:
|
|
4671
|
+
type_hints = typing.get_type_hints(_typecheckingstub__97a45c9b75fc81cb3d47817d0893dffb28ebc87496c4a4eedb9cf73b57a68cc5)
|
|
4672
|
+
check_type(argname="argument duration", value=duration, expected_type=type_hints["duration"])
|
|
4673
|
+
return typing.cast("ScheduleExpression", jsii.sinvoke(cls, "rate", [duration]))
|
|
4674
|
+
|
|
4675
|
+
@builtins.property
|
|
4676
|
+
@jsii.member(jsii_name="expressionString")
|
|
4677
|
+
@abc.abstractmethod
|
|
4678
|
+
def expression_string(self) -> builtins.str:
|
|
4679
|
+
'''Retrieve the expression for this schedule.'''
|
|
4680
|
+
...
|
|
4681
|
+
|
|
4682
|
+
@builtins.property
|
|
4683
|
+
@jsii.member(jsii_name="timeZone")
|
|
4684
|
+
@abc.abstractmethod
|
|
4685
|
+
def time_zone(self) -> typing.Optional[_TimeZone_cdd72ac9]:
|
|
4686
|
+
'''Retrieve the expression for this schedule.'''
|
|
4687
|
+
...
|
|
4688
|
+
|
|
4689
|
+
|
|
4690
|
+
class _ScheduleExpressionProxy(ScheduleExpression):
|
|
4691
|
+
@builtins.property
|
|
4692
|
+
@jsii.member(jsii_name="expressionString")
|
|
4693
|
+
def expression_string(self) -> builtins.str:
|
|
4694
|
+
'''Retrieve the expression for this schedule.'''
|
|
4695
|
+
return typing.cast(builtins.str, jsii.get(self, "expressionString"))
|
|
4696
|
+
|
|
4697
|
+
@builtins.property
|
|
4698
|
+
@jsii.member(jsii_name="timeZone")
|
|
4699
|
+
def time_zone(self) -> typing.Optional[_TimeZone_cdd72ac9]:
|
|
4700
|
+
'''Retrieve the expression for this schedule.'''
|
|
4701
|
+
return typing.cast(typing.Optional[_TimeZone_cdd72ac9], jsii.get(self, "timeZone"))
|
|
4702
|
+
|
|
4703
|
+
# Adding a "__jsii_proxy_class__(): typing.Type" function to the abstract class
|
|
4704
|
+
typing.cast(typing.Any, ScheduleExpression).__jsii_proxy_class__ = lambda : _ScheduleExpressionProxy
|
|
4705
|
+
|
|
4706
|
+
|
|
4707
|
+
@jsii.implements(IScheduleGroup)
|
|
4708
|
+
class ScheduleGroup(
|
|
4709
|
+
_Resource_45bc6135,
|
|
4710
|
+
metaclass=jsii.JSIIMeta,
|
|
4711
|
+
jsii_type="aws-cdk-lib.aws_scheduler.ScheduleGroup",
|
|
4712
|
+
):
|
|
4713
|
+
'''A Schedule Group.
|
|
4714
|
+
|
|
4715
|
+
:resource: AWS::Scheduler::ScheduleGroup
|
|
4716
|
+
:exampleMetadata: infused
|
|
4717
|
+
|
|
4718
|
+
Example::
|
|
4719
|
+
|
|
4720
|
+
# target: targets.LambdaInvoke
|
|
4721
|
+
|
|
4722
|
+
|
|
4723
|
+
schedule_group = ScheduleGroup(self, "ScheduleGroup",
|
|
4724
|
+
schedule_group_name="MyScheduleGroup"
|
|
4725
|
+
)
|
|
4726
|
+
|
|
4727
|
+
Schedule(self, "Schedule",
|
|
4728
|
+
schedule=ScheduleExpression.rate(Duration.minutes(10)),
|
|
4729
|
+
target=target,
|
|
4730
|
+
schedule_group=schedule_group
|
|
4731
|
+
)
|
|
4732
|
+
'''
|
|
4733
|
+
|
|
4734
|
+
def __init__(
|
|
4735
|
+
self,
|
|
4736
|
+
scope: _constructs_77d1e7e8.Construct,
|
|
4737
|
+
id: builtins.str,
|
|
4738
|
+
*,
|
|
4739
|
+
removal_policy: typing.Optional[_RemovalPolicy_9f93c814] = None,
|
|
4740
|
+
schedule_group_name: typing.Optional[builtins.str] = None,
|
|
4741
|
+
) -> None:
|
|
4742
|
+
'''
|
|
4743
|
+
:param scope: -
|
|
4744
|
+
:param id: -
|
|
4745
|
+
:param removal_policy: The removal policy for the group. If the group is removed also all schedules are removed. Default: RemovalPolicy.RETAIN
|
|
4746
|
+
:param schedule_group_name: The name of the schedule group. Up to 64 letters (uppercase and lowercase), numbers, hyphens, underscores and dots are allowed. Default: - A unique name will be generated
|
|
4747
|
+
'''
|
|
4748
|
+
if __debug__:
|
|
4749
|
+
type_hints = typing.get_type_hints(_typecheckingstub__736972893d2822201f3b54995126456a9f4766921d769ea7836c13c49c015d53)
|
|
4750
|
+
check_type(argname="argument scope", value=scope, expected_type=type_hints["scope"])
|
|
4751
|
+
check_type(argname="argument id", value=id, expected_type=type_hints["id"])
|
|
4752
|
+
props = ScheduleGroupProps(
|
|
4753
|
+
removal_policy=removal_policy, schedule_group_name=schedule_group_name
|
|
4754
|
+
)
|
|
4755
|
+
|
|
4756
|
+
jsii.create(self.__class__, self, [scope, id, props])
|
|
4757
|
+
|
|
4758
|
+
@jsii.member(jsii_name="fromDefaultScheduleGroup")
|
|
4759
|
+
@builtins.classmethod
|
|
4760
|
+
def from_default_schedule_group(
|
|
4761
|
+
cls,
|
|
4762
|
+
scope: _constructs_77d1e7e8.Construct,
|
|
4763
|
+
id: builtins.str,
|
|
4764
|
+
) -> IScheduleGroup:
|
|
4765
|
+
'''Import a default schedule group.
|
|
4766
|
+
|
|
4767
|
+
:param scope: construct scope.
|
|
4768
|
+
:param id: construct id.
|
|
4769
|
+
'''
|
|
4770
|
+
if __debug__:
|
|
4771
|
+
type_hints = typing.get_type_hints(_typecheckingstub__b7b5a1fbdcbfd0ad106f45caf1d995619df8d064b8587659c5461157f6e48926)
|
|
4772
|
+
check_type(argname="argument scope", value=scope, expected_type=type_hints["scope"])
|
|
4773
|
+
check_type(argname="argument id", value=id, expected_type=type_hints["id"])
|
|
4774
|
+
return typing.cast(IScheduleGroup, jsii.sinvoke(cls, "fromDefaultScheduleGroup", [scope, id]))
|
|
4775
|
+
|
|
4776
|
+
@jsii.member(jsii_name="fromScheduleGroupArn")
|
|
4777
|
+
@builtins.classmethod
|
|
4778
|
+
def from_schedule_group_arn(
|
|
4779
|
+
cls,
|
|
4780
|
+
scope: _constructs_77d1e7e8.Construct,
|
|
4781
|
+
id: builtins.str,
|
|
4782
|
+
schedule_group_arn: builtins.str,
|
|
4783
|
+
) -> IScheduleGroup:
|
|
4784
|
+
'''Import an external schedule group by ARN.
|
|
4785
|
+
|
|
4786
|
+
:param scope: construct scope.
|
|
4787
|
+
:param id: construct id.
|
|
4788
|
+
:param schedule_group_arn: the ARN of the schedule group to import (e.g. ``arn:aws:scheduler:region:account-id:schedule-group/group-name``).
|
|
4789
|
+
'''
|
|
4790
|
+
if __debug__:
|
|
4791
|
+
type_hints = typing.get_type_hints(_typecheckingstub__9c77731a2b0fb48c74a722651a8f036cef9066af4a6dd7b73c0b9b2d119bc36d)
|
|
4792
|
+
check_type(argname="argument scope", value=scope, expected_type=type_hints["scope"])
|
|
4793
|
+
check_type(argname="argument id", value=id, expected_type=type_hints["id"])
|
|
4794
|
+
check_type(argname="argument schedule_group_arn", value=schedule_group_arn, expected_type=type_hints["schedule_group_arn"])
|
|
4795
|
+
return typing.cast(IScheduleGroup, jsii.sinvoke(cls, "fromScheduleGroupArn", [scope, id, schedule_group_arn]))
|
|
4796
|
+
|
|
4797
|
+
@jsii.member(jsii_name="fromScheduleGroupName")
|
|
4798
|
+
@builtins.classmethod
|
|
4799
|
+
def from_schedule_group_name(
|
|
4800
|
+
cls,
|
|
4801
|
+
scope: _constructs_77d1e7e8.Construct,
|
|
4802
|
+
id: builtins.str,
|
|
4803
|
+
schedule_group_name: builtins.str,
|
|
4804
|
+
) -> IScheduleGroup:
|
|
4805
|
+
'''Import an existing schedule group with a given name.
|
|
4806
|
+
|
|
4807
|
+
:param scope: construct scope.
|
|
4808
|
+
:param id: construct id.
|
|
4809
|
+
:param schedule_group_name: the name of the existing schedule group to import.
|
|
4810
|
+
'''
|
|
4811
|
+
if __debug__:
|
|
4812
|
+
type_hints = typing.get_type_hints(_typecheckingstub__e0eef3cd9167e1bcf64df7282dec1f362eaac5659d22625afac3c28dcc0b7edb)
|
|
4813
|
+
check_type(argname="argument scope", value=scope, expected_type=type_hints["scope"])
|
|
4814
|
+
check_type(argname="argument id", value=id, expected_type=type_hints["id"])
|
|
4815
|
+
check_type(argname="argument schedule_group_name", value=schedule_group_name, expected_type=type_hints["schedule_group_name"])
|
|
4816
|
+
return typing.cast(IScheduleGroup, jsii.sinvoke(cls, "fromScheduleGroupName", [scope, id, schedule_group_name]))
|
|
4817
|
+
|
|
4818
|
+
@jsii.member(jsii_name="grant")
|
|
4819
|
+
def grant(
|
|
4820
|
+
self,
|
|
4821
|
+
grantee: _IGrantable_71c4f5de,
|
|
4822
|
+
*actions: builtins.str,
|
|
4823
|
+
) -> _Grant_a7ae64f8:
|
|
4824
|
+
'''Grant the indicated permissions on this schedule group to the given principal.
|
|
4825
|
+
|
|
4826
|
+
:param grantee: -
|
|
4827
|
+
:param actions: -
|
|
4828
|
+
'''
|
|
4829
|
+
if __debug__:
|
|
4830
|
+
type_hints = typing.get_type_hints(_typecheckingstub__1603de1685aaaf14ff1514df8394bc631af9b5e6f8b79a44c31ff5e24157a7e0)
|
|
4831
|
+
check_type(argname="argument grantee", value=grantee, expected_type=type_hints["grantee"])
|
|
4832
|
+
check_type(argname="argument actions", value=actions, expected_type=typing.Tuple[type_hints["actions"], ...]) # pyright: ignore [reportGeneralTypeIssues]
|
|
4833
|
+
return typing.cast(_Grant_a7ae64f8, jsii.invoke(self, "grant", [grantee, *actions]))
|
|
4834
|
+
|
|
4835
|
+
@jsii.member(jsii_name="grantDeleteSchedules")
|
|
4836
|
+
def grant_delete_schedules(self, identity: _IGrantable_71c4f5de) -> _Grant_a7ae64f8:
|
|
4837
|
+
'''Grant delete schedule permission for schedules in this group to the given principal.
|
|
4838
|
+
|
|
4839
|
+
:param identity: -
|
|
4840
|
+
'''
|
|
4841
|
+
if __debug__:
|
|
4842
|
+
type_hints = typing.get_type_hints(_typecheckingstub__15bda48b16b2099393ebcd41e9be05dd66aaf7faaeae1ba65b42220d7667bce5)
|
|
4843
|
+
check_type(argname="argument identity", value=identity, expected_type=type_hints["identity"])
|
|
4844
|
+
return typing.cast(_Grant_a7ae64f8, jsii.invoke(self, "grantDeleteSchedules", [identity]))
|
|
4845
|
+
|
|
4846
|
+
@jsii.member(jsii_name="grantReadSchedules")
|
|
4847
|
+
def grant_read_schedules(self, identity: _IGrantable_71c4f5de) -> _Grant_a7ae64f8:
|
|
4848
|
+
'''Grant list and get schedule permissions for schedules in this group to the given principal.
|
|
4849
|
+
|
|
4850
|
+
:param identity: -
|
|
4851
|
+
'''
|
|
4852
|
+
if __debug__:
|
|
4853
|
+
type_hints = typing.get_type_hints(_typecheckingstub__55a9d37bafcef8d26af6e888f5ab8b2aef1359b02c7a510049f6e900c986b797)
|
|
4854
|
+
check_type(argname="argument identity", value=identity, expected_type=type_hints["identity"])
|
|
4855
|
+
return typing.cast(_Grant_a7ae64f8, jsii.invoke(self, "grantReadSchedules", [identity]))
|
|
4856
|
+
|
|
4857
|
+
@jsii.member(jsii_name="grantWriteSchedules")
|
|
4858
|
+
def grant_write_schedules(self, identity: _IGrantable_71c4f5de) -> _Grant_a7ae64f8:
|
|
4859
|
+
'''Grant create and update schedule permissions for schedules in this group to the given principal.
|
|
4860
|
+
|
|
4861
|
+
:param identity: -
|
|
4862
|
+
'''
|
|
4863
|
+
if __debug__:
|
|
4864
|
+
type_hints = typing.get_type_hints(_typecheckingstub__f2cc2856526773b02c8dfcbfcca6cf534cc4a4b00a0b0de1e8fe166c071534ab)
|
|
4865
|
+
check_type(argname="argument identity", value=identity, expected_type=type_hints["identity"])
|
|
4866
|
+
return typing.cast(_Grant_a7ae64f8, jsii.invoke(self, "grantWriteSchedules", [identity]))
|
|
4867
|
+
|
|
4868
|
+
@jsii.member(jsii_name="metric")
|
|
4869
|
+
def metric(
|
|
4870
|
+
self,
|
|
4871
|
+
metric_name: builtins.str,
|
|
4872
|
+
*,
|
|
4873
|
+
account: typing.Optional[builtins.str] = None,
|
|
4874
|
+
color: typing.Optional[builtins.str] = None,
|
|
4875
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
4876
|
+
label: typing.Optional[builtins.str] = None,
|
|
4877
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
4878
|
+
region: typing.Optional[builtins.str] = None,
|
|
4879
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
4880
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
4881
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
4882
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
4883
|
+
) -> _Metric_e396a4dc:
|
|
4884
|
+
'''Return the given named metric for this schedule group.
|
|
4885
|
+
|
|
4886
|
+
:param metric_name: -
|
|
4887
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
4888
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
4889
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
4890
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
4891
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
4892
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
4893
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
4894
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
4895
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
4896
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
4897
|
+
|
|
4898
|
+
:default: - sum over 5 minutes
|
|
4899
|
+
'''
|
|
4900
|
+
if __debug__:
|
|
4901
|
+
type_hints = typing.get_type_hints(_typecheckingstub__634bd225463be60303d9d1588926bbaa9fbd72c940ca54fecf9724d90fdefe64)
|
|
4902
|
+
check_type(argname="argument metric_name", value=metric_name, expected_type=type_hints["metric_name"])
|
|
4903
|
+
props = _MetricOptions_1788b62f(
|
|
4904
|
+
account=account,
|
|
4905
|
+
color=color,
|
|
4906
|
+
dimensions_map=dimensions_map,
|
|
4907
|
+
label=label,
|
|
4908
|
+
period=period,
|
|
4909
|
+
region=region,
|
|
4910
|
+
stack_account=stack_account,
|
|
4911
|
+
stack_region=stack_region,
|
|
4912
|
+
statistic=statistic,
|
|
4913
|
+
unit=unit,
|
|
4914
|
+
)
|
|
4915
|
+
|
|
4916
|
+
return typing.cast(_Metric_e396a4dc, jsii.invoke(self, "metric", [metric_name, props]))
|
|
4917
|
+
|
|
4918
|
+
@jsii.member(jsii_name="metricAttempts")
|
|
4919
|
+
def metric_attempts(
|
|
4920
|
+
self,
|
|
4921
|
+
*,
|
|
4922
|
+
account: typing.Optional[builtins.str] = None,
|
|
4923
|
+
color: typing.Optional[builtins.str] = None,
|
|
4924
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
4925
|
+
label: typing.Optional[builtins.str] = None,
|
|
4926
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
4927
|
+
region: typing.Optional[builtins.str] = None,
|
|
4928
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
4929
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
4930
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
4931
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
4932
|
+
) -> _Metric_e396a4dc:
|
|
4933
|
+
'''Metric for all invocation attempts.
|
|
4934
|
+
|
|
4935
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
4936
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
4937
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
4938
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
4939
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
4940
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
4941
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
4942
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
4943
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
4944
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
4945
|
+
|
|
4946
|
+
:default: - sum over 5 minutes
|
|
4947
|
+
'''
|
|
4948
|
+
props = _MetricOptions_1788b62f(
|
|
4949
|
+
account=account,
|
|
4950
|
+
color=color,
|
|
4951
|
+
dimensions_map=dimensions_map,
|
|
4952
|
+
label=label,
|
|
4953
|
+
period=period,
|
|
4954
|
+
region=region,
|
|
4955
|
+
stack_account=stack_account,
|
|
4956
|
+
stack_region=stack_region,
|
|
4957
|
+
statistic=statistic,
|
|
4958
|
+
unit=unit,
|
|
4959
|
+
)
|
|
4960
|
+
|
|
4961
|
+
return typing.cast(_Metric_e396a4dc, jsii.invoke(self, "metricAttempts", [props]))
|
|
4962
|
+
|
|
4963
|
+
@jsii.member(jsii_name="metricDropped")
|
|
4964
|
+
def metric_dropped(
|
|
4965
|
+
self,
|
|
4966
|
+
*,
|
|
4967
|
+
account: typing.Optional[builtins.str] = None,
|
|
4968
|
+
color: typing.Optional[builtins.str] = None,
|
|
4969
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
4970
|
+
label: typing.Optional[builtins.str] = None,
|
|
4971
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
4972
|
+
region: typing.Optional[builtins.str] = None,
|
|
4973
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
4974
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
4975
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
4976
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
4977
|
+
) -> _Metric_e396a4dc:
|
|
4978
|
+
'''Metric for dropped invocations when EventBridge Scheduler stops attempting to invoke the target after a schedule's retry policy has been exhausted.
|
|
4979
|
+
|
|
4980
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
4981
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
4982
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
4983
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
4984
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
4985
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
4986
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
4987
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
4988
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
4989
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
4990
|
+
|
|
4991
|
+
:default: - sum over 5 minutes
|
|
4992
|
+
'''
|
|
4993
|
+
props = _MetricOptions_1788b62f(
|
|
4994
|
+
account=account,
|
|
4995
|
+
color=color,
|
|
4996
|
+
dimensions_map=dimensions_map,
|
|
4997
|
+
label=label,
|
|
4998
|
+
period=period,
|
|
4999
|
+
region=region,
|
|
5000
|
+
stack_account=stack_account,
|
|
5001
|
+
stack_region=stack_region,
|
|
5002
|
+
statistic=statistic,
|
|
5003
|
+
unit=unit,
|
|
5004
|
+
)
|
|
5005
|
+
|
|
5006
|
+
return typing.cast(_Metric_e396a4dc, jsii.invoke(self, "metricDropped", [props]))
|
|
5007
|
+
|
|
5008
|
+
@jsii.member(jsii_name="metricFailedToBeSentToDLQ")
|
|
5009
|
+
def metric_failed_to_be_sent_to_dlq(
|
|
5010
|
+
self,
|
|
5011
|
+
error_code: typing.Optional[builtins.str] = None,
|
|
5012
|
+
*,
|
|
5013
|
+
account: typing.Optional[builtins.str] = None,
|
|
5014
|
+
color: typing.Optional[builtins.str] = None,
|
|
5015
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
5016
|
+
label: typing.Optional[builtins.str] = None,
|
|
5017
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
5018
|
+
region: typing.Optional[builtins.str] = None,
|
|
5019
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
5020
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
5021
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
5022
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
5023
|
+
) -> _Metric_e396a4dc:
|
|
5024
|
+
'''Metric for failed invocations that also failed to deliver to DLQ.
|
|
5025
|
+
|
|
5026
|
+
:param error_code: -
|
|
5027
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
5028
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
5029
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
5030
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
5031
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
5032
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
5033
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
5034
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
5035
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
5036
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
5037
|
+
|
|
5038
|
+
:default: - sum over 5 minutes
|
|
5039
|
+
'''
|
|
5040
|
+
if __debug__:
|
|
5041
|
+
type_hints = typing.get_type_hints(_typecheckingstub__ca970bf647095b0a6fd282ecce93e19b12761be780f7fac1db8cc3b6f97c0cbf)
|
|
5042
|
+
check_type(argname="argument error_code", value=error_code, expected_type=type_hints["error_code"])
|
|
5043
|
+
props = _MetricOptions_1788b62f(
|
|
5044
|
+
account=account,
|
|
5045
|
+
color=color,
|
|
5046
|
+
dimensions_map=dimensions_map,
|
|
5047
|
+
label=label,
|
|
5048
|
+
period=period,
|
|
5049
|
+
region=region,
|
|
5050
|
+
stack_account=stack_account,
|
|
5051
|
+
stack_region=stack_region,
|
|
5052
|
+
statistic=statistic,
|
|
5053
|
+
unit=unit,
|
|
5054
|
+
)
|
|
5055
|
+
|
|
5056
|
+
return typing.cast(_Metric_e396a4dc, jsii.invoke(self, "metricFailedToBeSentToDLQ", [error_code, props]))
|
|
5057
|
+
|
|
5058
|
+
@jsii.member(jsii_name="metricSentToDLQ")
|
|
5059
|
+
def metric_sent_to_dlq(
|
|
5060
|
+
self,
|
|
5061
|
+
*,
|
|
5062
|
+
account: typing.Optional[builtins.str] = None,
|
|
5063
|
+
color: typing.Optional[builtins.str] = None,
|
|
5064
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
5065
|
+
label: typing.Optional[builtins.str] = None,
|
|
5066
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
5067
|
+
region: typing.Optional[builtins.str] = None,
|
|
5068
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
5069
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
5070
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
5071
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
5072
|
+
) -> _Metric_e396a4dc:
|
|
5073
|
+
'''Metric for invocations delivered to the DLQ.
|
|
5074
|
+
|
|
5075
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
5076
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
5077
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
5078
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
5079
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
5080
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
5081
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
5082
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
5083
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
5084
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
5085
|
+
|
|
5086
|
+
:default: - sum over 5 minutes
|
|
5087
|
+
'''
|
|
5088
|
+
props = _MetricOptions_1788b62f(
|
|
5089
|
+
account=account,
|
|
5090
|
+
color=color,
|
|
5091
|
+
dimensions_map=dimensions_map,
|
|
5092
|
+
label=label,
|
|
5093
|
+
period=period,
|
|
5094
|
+
region=region,
|
|
5095
|
+
stack_account=stack_account,
|
|
5096
|
+
stack_region=stack_region,
|
|
5097
|
+
statistic=statistic,
|
|
5098
|
+
unit=unit,
|
|
5099
|
+
)
|
|
5100
|
+
|
|
5101
|
+
return typing.cast(_Metric_e396a4dc, jsii.invoke(self, "metricSentToDLQ", [props]))
|
|
5102
|
+
|
|
5103
|
+
@jsii.member(jsii_name="metricSentToDLQTruncated")
|
|
5104
|
+
def metric_sent_to_dlq_truncated(
|
|
5105
|
+
self,
|
|
5106
|
+
*,
|
|
5107
|
+
account: typing.Optional[builtins.str] = None,
|
|
5108
|
+
color: typing.Optional[builtins.str] = None,
|
|
5109
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
5110
|
+
label: typing.Optional[builtins.str] = None,
|
|
5111
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
5112
|
+
region: typing.Optional[builtins.str] = None,
|
|
5113
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
5114
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
5115
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
5116
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
5117
|
+
) -> _Metric_e396a4dc:
|
|
5118
|
+
'''Metric for delivery of failed invocations to DLQ when the payload of the event sent to the DLQ exceeds the maximum size allowed by Amazon SQS.
|
|
5119
|
+
|
|
5120
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
5121
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
5122
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
5123
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
5124
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
5125
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
5126
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
5127
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
5128
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
5129
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
5130
|
+
|
|
5131
|
+
:default: - sum over 5 minutes
|
|
5132
|
+
'''
|
|
5133
|
+
props = _MetricOptions_1788b62f(
|
|
5134
|
+
account=account,
|
|
5135
|
+
color=color,
|
|
5136
|
+
dimensions_map=dimensions_map,
|
|
5137
|
+
label=label,
|
|
5138
|
+
period=period,
|
|
5139
|
+
region=region,
|
|
5140
|
+
stack_account=stack_account,
|
|
5141
|
+
stack_region=stack_region,
|
|
5142
|
+
statistic=statistic,
|
|
5143
|
+
unit=unit,
|
|
5144
|
+
)
|
|
5145
|
+
|
|
5146
|
+
return typing.cast(_Metric_e396a4dc, jsii.invoke(self, "metricSentToDLQTruncated", [props]))
|
|
5147
|
+
|
|
5148
|
+
@jsii.member(jsii_name="metricTargetErrors")
|
|
5149
|
+
def metric_target_errors(
|
|
5150
|
+
self,
|
|
5151
|
+
*,
|
|
5152
|
+
account: typing.Optional[builtins.str] = None,
|
|
5153
|
+
color: typing.Optional[builtins.str] = None,
|
|
5154
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
5155
|
+
label: typing.Optional[builtins.str] = None,
|
|
5156
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
5157
|
+
region: typing.Optional[builtins.str] = None,
|
|
5158
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
5159
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
5160
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
5161
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
5162
|
+
) -> _Metric_e396a4dc:
|
|
5163
|
+
'''Emitted when the target returns an exception after EventBridge Scheduler calls the target API.
|
|
5164
|
+
|
|
5165
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
5166
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
5167
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
5168
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
5169
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
5170
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
5171
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
5172
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
5173
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
5174
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
5175
|
+
|
|
5176
|
+
:default: - sum over 5 minutes
|
|
5177
|
+
'''
|
|
5178
|
+
props = _MetricOptions_1788b62f(
|
|
5179
|
+
account=account,
|
|
5180
|
+
color=color,
|
|
5181
|
+
dimensions_map=dimensions_map,
|
|
5182
|
+
label=label,
|
|
5183
|
+
period=period,
|
|
5184
|
+
region=region,
|
|
5185
|
+
stack_account=stack_account,
|
|
5186
|
+
stack_region=stack_region,
|
|
5187
|
+
statistic=statistic,
|
|
5188
|
+
unit=unit,
|
|
5189
|
+
)
|
|
5190
|
+
|
|
5191
|
+
return typing.cast(_Metric_e396a4dc, jsii.invoke(self, "metricTargetErrors", [props]))
|
|
5192
|
+
|
|
5193
|
+
@jsii.member(jsii_name="metricTargetThrottled")
|
|
5194
|
+
def metric_target_throttled(
|
|
5195
|
+
self,
|
|
5196
|
+
*,
|
|
5197
|
+
account: typing.Optional[builtins.str] = None,
|
|
5198
|
+
color: typing.Optional[builtins.str] = None,
|
|
5199
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
5200
|
+
label: typing.Optional[builtins.str] = None,
|
|
5201
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
5202
|
+
region: typing.Optional[builtins.str] = None,
|
|
5203
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
5204
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
5205
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
5206
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
5207
|
+
) -> _Metric_e396a4dc:
|
|
5208
|
+
'''Metric for invocation failures due to API throttling by the target.
|
|
5209
|
+
|
|
5210
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
5211
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
5212
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
5213
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
5214
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
5215
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
5216
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
5217
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
5218
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
5219
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
5220
|
+
|
|
5221
|
+
:default: - sum over 5 minutes
|
|
5222
|
+
'''
|
|
5223
|
+
props = _MetricOptions_1788b62f(
|
|
5224
|
+
account=account,
|
|
5225
|
+
color=color,
|
|
5226
|
+
dimensions_map=dimensions_map,
|
|
5227
|
+
label=label,
|
|
5228
|
+
period=period,
|
|
5229
|
+
region=region,
|
|
5230
|
+
stack_account=stack_account,
|
|
5231
|
+
stack_region=stack_region,
|
|
5232
|
+
statistic=statistic,
|
|
5233
|
+
unit=unit,
|
|
5234
|
+
)
|
|
5235
|
+
|
|
5236
|
+
return typing.cast(_Metric_e396a4dc, jsii.invoke(self, "metricTargetThrottled", [props]))
|
|
5237
|
+
|
|
5238
|
+
@jsii.member(jsii_name="metricThrottled")
|
|
5239
|
+
def metric_throttled(
|
|
5240
|
+
self,
|
|
5241
|
+
*,
|
|
5242
|
+
account: typing.Optional[builtins.str] = None,
|
|
5243
|
+
color: typing.Optional[builtins.str] = None,
|
|
5244
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
5245
|
+
label: typing.Optional[builtins.str] = None,
|
|
5246
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
5247
|
+
region: typing.Optional[builtins.str] = None,
|
|
5248
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
5249
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
5250
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
5251
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
5252
|
+
) -> _Metric_e396a4dc:
|
|
5253
|
+
'''Metric for the number of invocations that were throttled because it exceeds your service quotas.
|
|
5254
|
+
|
|
5255
|
+
:param account: Account which this metric comes from. Default: - Deployment account.
|
|
5256
|
+
:param color: The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The ``Color`` class has a set of standard colors that can be used here. Default: - Automatic color
|
|
5257
|
+
:param dimensions_map: Dimensions of the metric. Default: - No dimensions.
|
|
5258
|
+
:param label: Label for this metric when added to a Graph in a Dashboard. You can use `dynamic labels <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html>`_ to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend. Default: - No label
|
|
5259
|
+
:param period: The period over which the specified statistic is applied. Default: Duration.minutes(5)
|
|
5260
|
+
:param region: Region which this metric comes from. Default: - Deployment region.
|
|
5261
|
+
:param stack_account: Account of the stack this metric is attached to. Default: - Deployment account.
|
|
5262
|
+
:param stack_region: Region of the stack this metric is attached to. Default: - Deployment region.
|
|
5263
|
+
:param statistic: What function to use for aggregating. Use the ``aws_cloudwatch.Stats`` helper class to construct valid input strings. Can be one of the following: - "Minimum" | "min" - "Maximum" | "max" - "Average" | "avg" - "Sum" | "sum" - "SampleCount | "n" - "pNN.NN" - "tmNN.NN" | "tm(NN.NN%:NN.NN%)" - "iqm" - "wmNN.NN" | "wm(NN.NN%:NN.NN%)" - "tcNN.NN" | "tc(NN.NN%:NN.NN%)" - "tsNN.NN" | "ts(NN.NN%:NN.NN%)" Default: Average
|
|
5264
|
+
:param unit: Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream
|
|
5265
|
+
|
|
5266
|
+
:default: - sum over 5 minutes
|
|
5267
|
+
|
|
5268
|
+
:see: https://docs.aws.amazon.com/scheduler/latest/UserGuide/scheduler-quotas.html
|
|
5269
|
+
'''
|
|
5270
|
+
props = _MetricOptions_1788b62f(
|
|
5271
|
+
account=account,
|
|
5272
|
+
color=color,
|
|
5273
|
+
dimensions_map=dimensions_map,
|
|
5274
|
+
label=label,
|
|
5275
|
+
period=period,
|
|
5276
|
+
region=region,
|
|
5277
|
+
stack_account=stack_account,
|
|
5278
|
+
stack_region=stack_region,
|
|
5279
|
+
statistic=statistic,
|
|
5280
|
+
unit=unit,
|
|
5281
|
+
)
|
|
5282
|
+
|
|
5283
|
+
return typing.cast(_Metric_e396a4dc, jsii.invoke(self, "metricThrottled", [props]))
|
|
5284
|
+
|
|
5285
|
+
@builtins.property
|
|
5286
|
+
@jsii.member(jsii_name="scheduleGroupArn")
|
|
5287
|
+
def schedule_group_arn(self) -> builtins.str:
|
|
5288
|
+
'''The arn of the schedule group.'''
|
|
5289
|
+
return typing.cast(builtins.str, jsii.get(self, "scheduleGroupArn"))
|
|
5290
|
+
|
|
5291
|
+
@builtins.property
|
|
5292
|
+
@jsii.member(jsii_name="scheduleGroupName")
|
|
5293
|
+
def schedule_group_name(self) -> builtins.str:
|
|
5294
|
+
'''The name of the schedule group.'''
|
|
5295
|
+
return typing.cast(builtins.str, jsii.get(self, "scheduleGroupName"))
|
|
5296
|
+
|
|
5297
|
+
|
|
5298
|
+
@jsii.data_type(
|
|
5299
|
+
jsii_type="aws-cdk-lib.aws_scheduler.ScheduleGroupProps",
|
|
5300
|
+
jsii_struct_bases=[],
|
|
5301
|
+
name_mapping={
|
|
5302
|
+
"removal_policy": "removalPolicy",
|
|
5303
|
+
"schedule_group_name": "scheduleGroupName",
|
|
5304
|
+
},
|
|
5305
|
+
)
|
|
5306
|
+
class ScheduleGroupProps:
|
|
5307
|
+
def __init__(
|
|
5308
|
+
self,
|
|
5309
|
+
*,
|
|
5310
|
+
removal_policy: typing.Optional[_RemovalPolicy_9f93c814] = None,
|
|
5311
|
+
schedule_group_name: typing.Optional[builtins.str] = None,
|
|
5312
|
+
) -> None:
|
|
5313
|
+
'''Properties for a Schedule Group.
|
|
5314
|
+
|
|
5315
|
+
:param removal_policy: The removal policy for the group. If the group is removed also all schedules are removed. Default: RemovalPolicy.RETAIN
|
|
5316
|
+
:param schedule_group_name: The name of the schedule group. Up to 64 letters (uppercase and lowercase), numbers, hyphens, underscores and dots are allowed. Default: - A unique name will be generated
|
|
5317
|
+
|
|
5318
|
+
:exampleMetadata: infused
|
|
5319
|
+
|
|
5320
|
+
Example::
|
|
5321
|
+
|
|
5322
|
+
# target: targets.LambdaInvoke
|
|
5323
|
+
|
|
5324
|
+
|
|
5325
|
+
schedule_group = ScheduleGroup(self, "ScheduleGroup",
|
|
5326
|
+
schedule_group_name="MyScheduleGroup"
|
|
5327
|
+
)
|
|
5328
|
+
|
|
5329
|
+
Schedule(self, "Schedule",
|
|
5330
|
+
schedule=ScheduleExpression.rate(Duration.minutes(10)),
|
|
5331
|
+
target=target,
|
|
5332
|
+
schedule_group=schedule_group
|
|
5333
|
+
)
|
|
5334
|
+
'''
|
|
5335
|
+
if __debug__:
|
|
5336
|
+
type_hints = typing.get_type_hints(_typecheckingstub__00f616ddd843f7dab1625531f0a0666a403b81004bd707155fc676f64bb15c34)
|
|
5337
|
+
check_type(argname="argument removal_policy", value=removal_policy, expected_type=type_hints["removal_policy"])
|
|
5338
|
+
check_type(argname="argument schedule_group_name", value=schedule_group_name, expected_type=type_hints["schedule_group_name"])
|
|
5339
|
+
self._values: typing.Dict[builtins.str, typing.Any] = {}
|
|
5340
|
+
if removal_policy is not None:
|
|
5341
|
+
self._values["removal_policy"] = removal_policy
|
|
5342
|
+
if schedule_group_name is not None:
|
|
5343
|
+
self._values["schedule_group_name"] = schedule_group_name
|
|
5344
|
+
|
|
5345
|
+
@builtins.property
|
|
5346
|
+
def removal_policy(self) -> typing.Optional[_RemovalPolicy_9f93c814]:
|
|
5347
|
+
'''The removal policy for the group.
|
|
5348
|
+
|
|
5349
|
+
If the group is removed also all schedules are removed.
|
|
5350
|
+
|
|
5351
|
+
:default: RemovalPolicy.RETAIN
|
|
5352
|
+
'''
|
|
5353
|
+
result = self._values.get("removal_policy")
|
|
5354
|
+
return typing.cast(typing.Optional[_RemovalPolicy_9f93c814], result)
|
|
5355
|
+
|
|
5356
|
+
@builtins.property
|
|
5357
|
+
def schedule_group_name(self) -> typing.Optional[builtins.str]:
|
|
5358
|
+
'''The name of the schedule group.
|
|
5359
|
+
|
|
5360
|
+
Up to 64 letters (uppercase and lowercase), numbers, hyphens, underscores and dots are allowed.
|
|
5361
|
+
|
|
5362
|
+
:default: - A unique name will be generated
|
|
5363
|
+
'''
|
|
5364
|
+
result = self._values.get("schedule_group_name")
|
|
5365
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
|
5366
|
+
|
|
5367
|
+
def __eq__(self, rhs: typing.Any) -> builtins.bool:
|
|
5368
|
+
return isinstance(rhs, self.__class__) and rhs._values == self._values
|
|
5369
|
+
|
|
5370
|
+
def __ne__(self, rhs: typing.Any) -> builtins.bool:
|
|
5371
|
+
return not (rhs == self)
|
|
5372
|
+
|
|
5373
|
+
def __repr__(self) -> str:
|
|
5374
|
+
return "ScheduleGroupProps(%s)" % ", ".join(
|
|
5375
|
+
k + "=" + repr(v) for k, v in self._values.items()
|
|
5376
|
+
)
|
|
5377
|
+
|
|
5378
|
+
|
|
5379
|
+
@jsii.data_type(
|
|
5380
|
+
jsii_type="aws-cdk-lib.aws_scheduler.ScheduleProps",
|
|
5381
|
+
jsii_struct_bases=[],
|
|
5382
|
+
name_mapping={
|
|
5383
|
+
"schedule": "schedule",
|
|
5384
|
+
"target": "target",
|
|
5385
|
+
"description": "description",
|
|
5386
|
+
"enabled": "enabled",
|
|
5387
|
+
"end": "end",
|
|
5388
|
+
"key": "key",
|
|
5389
|
+
"schedule_group": "scheduleGroup",
|
|
5390
|
+
"schedule_name": "scheduleName",
|
|
5391
|
+
"start": "start",
|
|
5392
|
+
"time_window": "timeWindow",
|
|
5393
|
+
},
|
|
5394
|
+
)
|
|
5395
|
+
class ScheduleProps:
|
|
5396
|
+
def __init__(
|
|
5397
|
+
self,
|
|
5398
|
+
*,
|
|
5399
|
+
schedule: ScheduleExpression,
|
|
5400
|
+
target: IScheduleTarget,
|
|
5401
|
+
description: typing.Optional[builtins.str] = None,
|
|
5402
|
+
enabled: typing.Optional[builtins.bool] = None,
|
|
5403
|
+
end: typing.Optional[datetime.datetime] = None,
|
|
5404
|
+
key: typing.Optional[_IKey_5f11635f] = None,
|
|
5405
|
+
schedule_group: typing.Optional[IScheduleGroup] = None,
|
|
5406
|
+
schedule_name: typing.Optional[builtins.str] = None,
|
|
5407
|
+
start: typing.Optional[datetime.datetime] = None,
|
|
5408
|
+
time_window: typing.Optional["TimeWindow"] = None,
|
|
5409
|
+
) -> None:
|
|
5410
|
+
'''Construction properties for ``Schedule``.
|
|
5411
|
+
|
|
5412
|
+
:param schedule: The expression that defines when the schedule runs. Can be either a ``at``, ``rate`` or ``cron`` expression.
|
|
5413
|
+
:param target: The schedule's target details.
|
|
5414
|
+
:param description: The description you specify for the schedule. Default: - no value
|
|
5415
|
+
:param enabled: Indicates whether the schedule is enabled. Default: true
|
|
5416
|
+
:param end: The date, in UTC, before which the schedule can invoke its target. EventBridge Scheduler ignores end for one-time schedules. Default: - no value
|
|
5417
|
+
:param key: The customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data. Default: - All events in Scheduler are encrypted with a key that AWS owns and manages.
|
|
5418
|
+
:param schedule_group: The schedule's group. Default: - By default a schedule will be associated with the ``default`` group.
|
|
5419
|
+
:param schedule_name: The name of the schedule. Up to 64 letters (uppercase and lowercase), numbers, hyphens, underscores and dots are allowed. Default: - A unique name will be generated
|
|
5420
|
+
:param start: The date, in UTC, after which the schedule can begin invoking its target. EventBridge Scheduler ignores start for one-time schedules. Default: - no value
|
|
5421
|
+
:param time_window: A time window during which EventBridge Scheduler invokes the schedule. Default: TimeWindow.off()
|
|
5422
|
+
|
|
5423
|
+
:exampleMetadata: infused
|
|
5424
|
+
|
|
5425
|
+
Example::
|
|
5426
|
+
|
|
5427
|
+
import aws_cdk.aws_kinesisfirehose as firehose
|
|
5428
|
+
# delivery_stream: firehose.IDeliveryStream
|
|
5429
|
+
|
|
5430
|
+
|
|
5431
|
+
payload = {
|
|
5432
|
+
"Data": "record"
|
|
5433
|
+
}
|
|
5434
|
+
|
|
5435
|
+
Schedule(self, "Schedule",
|
|
5436
|
+
schedule=ScheduleExpression.rate(Duration.minutes(60)),
|
|
5437
|
+
target=targets.FirehosePutRecord(delivery_stream,
|
|
5438
|
+
input=ScheduleTargetInput.from_object(payload)
|
|
5439
|
+
)
|
|
5440
|
+
)
|
|
5441
|
+
'''
|
|
5442
|
+
if __debug__:
|
|
5443
|
+
type_hints = typing.get_type_hints(_typecheckingstub__f1a1cbc6cf4c30e6930150f969adcdfef2b116842e4bcb34a1adcf13677e296f)
|
|
5444
|
+
check_type(argname="argument schedule", value=schedule, expected_type=type_hints["schedule"])
|
|
5445
|
+
check_type(argname="argument target", value=target, expected_type=type_hints["target"])
|
|
5446
|
+
check_type(argname="argument description", value=description, expected_type=type_hints["description"])
|
|
5447
|
+
check_type(argname="argument enabled", value=enabled, expected_type=type_hints["enabled"])
|
|
5448
|
+
check_type(argname="argument end", value=end, expected_type=type_hints["end"])
|
|
5449
|
+
check_type(argname="argument key", value=key, expected_type=type_hints["key"])
|
|
5450
|
+
check_type(argname="argument schedule_group", value=schedule_group, expected_type=type_hints["schedule_group"])
|
|
5451
|
+
check_type(argname="argument schedule_name", value=schedule_name, expected_type=type_hints["schedule_name"])
|
|
5452
|
+
check_type(argname="argument start", value=start, expected_type=type_hints["start"])
|
|
5453
|
+
check_type(argname="argument time_window", value=time_window, expected_type=type_hints["time_window"])
|
|
5454
|
+
self._values: typing.Dict[builtins.str, typing.Any] = {
|
|
5455
|
+
"schedule": schedule,
|
|
5456
|
+
"target": target,
|
|
5457
|
+
}
|
|
5458
|
+
if description is not None:
|
|
5459
|
+
self._values["description"] = description
|
|
5460
|
+
if enabled is not None:
|
|
5461
|
+
self._values["enabled"] = enabled
|
|
5462
|
+
if end is not None:
|
|
5463
|
+
self._values["end"] = end
|
|
5464
|
+
if key is not None:
|
|
5465
|
+
self._values["key"] = key
|
|
5466
|
+
if schedule_group is not None:
|
|
5467
|
+
self._values["schedule_group"] = schedule_group
|
|
5468
|
+
if schedule_name is not None:
|
|
5469
|
+
self._values["schedule_name"] = schedule_name
|
|
5470
|
+
if start is not None:
|
|
5471
|
+
self._values["start"] = start
|
|
5472
|
+
if time_window is not None:
|
|
5473
|
+
self._values["time_window"] = time_window
|
|
5474
|
+
|
|
5475
|
+
@builtins.property
|
|
5476
|
+
def schedule(self) -> ScheduleExpression:
|
|
5477
|
+
'''The expression that defines when the schedule runs.
|
|
5478
|
+
|
|
5479
|
+
Can be either a ``at``, ``rate``
|
|
5480
|
+
or ``cron`` expression.
|
|
5481
|
+
'''
|
|
5482
|
+
result = self._values.get("schedule")
|
|
5483
|
+
assert result is not None, "Required property 'schedule' is missing"
|
|
5484
|
+
return typing.cast(ScheduleExpression, result)
|
|
5485
|
+
|
|
5486
|
+
@builtins.property
|
|
5487
|
+
def target(self) -> IScheduleTarget:
|
|
5488
|
+
'''The schedule's target details.'''
|
|
5489
|
+
result = self._values.get("target")
|
|
5490
|
+
assert result is not None, "Required property 'target' is missing"
|
|
5491
|
+
return typing.cast(IScheduleTarget, result)
|
|
5492
|
+
|
|
5493
|
+
@builtins.property
|
|
5494
|
+
def description(self) -> typing.Optional[builtins.str]:
|
|
5495
|
+
'''The description you specify for the schedule.
|
|
5496
|
+
|
|
5497
|
+
:default: - no value
|
|
5498
|
+
'''
|
|
5499
|
+
result = self._values.get("description")
|
|
5500
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
|
5501
|
+
|
|
5502
|
+
@builtins.property
|
|
5503
|
+
def enabled(self) -> typing.Optional[builtins.bool]:
|
|
5504
|
+
'''Indicates whether the schedule is enabled.
|
|
5505
|
+
|
|
5506
|
+
:default: true
|
|
5507
|
+
'''
|
|
5508
|
+
result = self._values.get("enabled")
|
|
5509
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
|
5510
|
+
|
|
5511
|
+
@builtins.property
|
|
5512
|
+
def end(self) -> typing.Optional[datetime.datetime]:
|
|
5513
|
+
'''The date, in UTC, before which the schedule can invoke its target.
|
|
5514
|
+
|
|
5515
|
+
EventBridge Scheduler ignores end for one-time schedules.
|
|
5516
|
+
|
|
5517
|
+
:default: - no value
|
|
5518
|
+
'''
|
|
5519
|
+
result = self._values.get("end")
|
|
5520
|
+
return typing.cast(typing.Optional[datetime.datetime], result)
|
|
5521
|
+
|
|
5522
|
+
@builtins.property
|
|
5523
|
+
def key(self) -> typing.Optional[_IKey_5f11635f]:
|
|
5524
|
+
'''The customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.
|
|
5525
|
+
|
|
5526
|
+
:default: - All events in Scheduler are encrypted with a key that AWS owns and manages.
|
|
5527
|
+
'''
|
|
5528
|
+
result = self._values.get("key")
|
|
5529
|
+
return typing.cast(typing.Optional[_IKey_5f11635f], result)
|
|
5530
|
+
|
|
5531
|
+
@builtins.property
|
|
5532
|
+
def schedule_group(self) -> typing.Optional[IScheduleGroup]:
|
|
5533
|
+
'''The schedule's group.
|
|
5534
|
+
|
|
5535
|
+
:default: - By default a schedule will be associated with the ``default`` group.
|
|
5536
|
+
'''
|
|
5537
|
+
result = self._values.get("schedule_group")
|
|
5538
|
+
return typing.cast(typing.Optional[IScheduleGroup], result)
|
|
5539
|
+
|
|
5540
|
+
@builtins.property
|
|
5541
|
+
def schedule_name(self) -> typing.Optional[builtins.str]:
|
|
5542
|
+
'''The name of the schedule.
|
|
5543
|
+
|
|
5544
|
+
Up to 64 letters (uppercase and lowercase), numbers, hyphens, underscores and dots are allowed.
|
|
5545
|
+
|
|
5546
|
+
:default: - A unique name will be generated
|
|
5547
|
+
'''
|
|
5548
|
+
result = self._values.get("schedule_name")
|
|
5549
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
|
5550
|
+
|
|
5551
|
+
@builtins.property
|
|
5552
|
+
def start(self) -> typing.Optional[datetime.datetime]:
|
|
5553
|
+
'''The date, in UTC, after which the schedule can begin invoking its target.
|
|
5554
|
+
|
|
5555
|
+
EventBridge Scheduler ignores start for one-time schedules.
|
|
5556
|
+
|
|
5557
|
+
:default: - no value
|
|
5558
|
+
'''
|
|
5559
|
+
result = self._values.get("start")
|
|
5560
|
+
return typing.cast(typing.Optional[datetime.datetime], result)
|
|
5561
|
+
|
|
5562
|
+
@builtins.property
|
|
5563
|
+
def time_window(self) -> typing.Optional["TimeWindow"]:
|
|
5564
|
+
'''A time window during which EventBridge Scheduler invokes the schedule.
|
|
5565
|
+
|
|
5566
|
+
:default: TimeWindow.off()
|
|
5567
|
+
|
|
5568
|
+
:see: https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-schedule-flexible-time-windows.html
|
|
5569
|
+
'''
|
|
5570
|
+
result = self._values.get("time_window")
|
|
5571
|
+
return typing.cast(typing.Optional["TimeWindow"], result)
|
|
5572
|
+
|
|
5573
|
+
def __eq__(self, rhs: typing.Any) -> builtins.bool:
|
|
5574
|
+
return isinstance(rhs, self.__class__) and rhs._values == self._values
|
|
5575
|
+
|
|
5576
|
+
def __ne__(self, rhs: typing.Any) -> builtins.bool:
|
|
5577
|
+
return not (rhs == self)
|
|
5578
|
+
|
|
5579
|
+
def __repr__(self) -> str:
|
|
5580
|
+
return "ScheduleProps(%s)" % ", ".join(
|
|
5581
|
+
k + "=" + repr(v) for k, v in self._values.items()
|
|
5582
|
+
)
|
|
5583
|
+
|
|
5584
|
+
|
|
5585
|
+
@jsii.data_type(
|
|
5586
|
+
jsii_type="aws-cdk-lib.aws_scheduler.ScheduleTargetConfig",
|
|
5587
|
+
jsii_struct_bases=[],
|
|
5588
|
+
name_mapping={
|
|
5589
|
+
"arn": "arn",
|
|
5590
|
+
"role": "role",
|
|
5591
|
+
"dead_letter_config": "deadLetterConfig",
|
|
5592
|
+
"ecs_parameters": "ecsParameters",
|
|
5593
|
+
"event_bridge_parameters": "eventBridgeParameters",
|
|
5594
|
+
"input": "input",
|
|
5595
|
+
"kinesis_parameters": "kinesisParameters",
|
|
5596
|
+
"retry_policy": "retryPolicy",
|
|
5597
|
+
"sage_maker_pipeline_parameters": "sageMakerPipelineParameters",
|
|
5598
|
+
"sqs_parameters": "sqsParameters",
|
|
5599
|
+
},
|
|
5600
|
+
)
|
|
5601
|
+
class ScheduleTargetConfig:
|
|
5602
|
+
def __init__(
|
|
5603
|
+
self,
|
|
5604
|
+
*,
|
|
5605
|
+
arn: builtins.str,
|
|
5606
|
+
role: _IRole_235f5d8e,
|
|
5607
|
+
dead_letter_config: typing.Optional[typing.Union[CfnSchedule.DeadLetterConfigProperty, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
5608
|
+
ecs_parameters: typing.Optional[typing.Union[CfnSchedule.EcsParametersProperty, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
5609
|
+
event_bridge_parameters: typing.Optional[typing.Union[CfnSchedule.EventBridgeParametersProperty, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
5610
|
+
input: typing.Optional["ScheduleTargetInput"] = None,
|
|
5611
|
+
kinesis_parameters: typing.Optional[typing.Union[CfnSchedule.KinesisParametersProperty, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
5612
|
+
retry_policy: typing.Optional[typing.Union[CfnSchedule.RetryPolicyProperty, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
5613
|
+
sage_maker_pipeline_parameters: typing.Optional[typing.Union[CfnSchedule.SageMakerPipelineParametersProperty, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
5614
|
+
sqs_parameters: typing.Optional[typing.Union[CfnSchedule.SqsParametersProperty, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
5615
|
+
) -> None:
|
|
5616
|
+
'''Config of a Schedule Target used during initialization of Schedule.
|
|
5617
|
+
|
|
5618
|
+
:param arn: The Amazon Resource Name (ARN) of the target.
|
|
5619
|
+
:param role: Role to use to invoke this event target.
|
|
5620
|
+
:param dead_letter_config: An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule. If specified, EventBridge Scheduler delivers failed events that could not be successfully delivered to a target to the queue. Default: - No dead-letter queue
|
|
5621
|
+
:param ecs_parameters: The templated target type for the Amazon ECS RunTask API Operation. Default: - No parameters
|
|
5622
|
+
:param event_bridge_parameters: The templated target type for the EventBridge PutEvents API operation. Default: - No parameters
|
|
5623
|
+
:param input: What input to pass to the target. Default: - No input
|
|
5624
|
+
:param kinesis_parameters: The templated target type for the Amazon Kinesis PutRecord API operation. Default: - No parameters
|
|
5625
|
+
:param retry_policy: A ``RetryPolicy`` object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target. Default: - Maximum retry attempts of 185 and maximum age of 86400 seconds (1 day)
|
|
5626
|
+
:param sage_maker_pipeline_parameters: The templated target type for the Amazon SageMaker StartPipelineExecution API operation. Default: - No parameters
|
|
5627
|
+
:param sqs_parameters: The templated target type for the Amazon SQS SendMessage API Operation. Default: - No parameters
|
|
5628
|
+
|
|
5629
|
+
:exampleMetadata: fixture=_generated
|
|
5630
|
+
|
|
5631
|
+
Example::
|
|
5632
|
+
|
|
5633
|
+
# The code below shows an example of how to instantiate this type.
|
|
5634
|
+
# The values are placeholders you should change.
|
|
5635
|
+
from aws_cdk import aws_iam as iam
|
|
5636
|
+
from aws_cdk import aws_scheduler as scheduler
|
|
5637
|
+
|
|
5638
|
+
# role: iam.Role
|
|
5639
|
+
# schedule_target_input: scheduler.ScheduleTargetInput
|
|
5640
|
+
# tags: Any
|
|
5641
|
+
|
|
5642
|
+
schedule_target_config = scheduler.ScheduleTargetConfig(
|
|
5643
|
+
arn="arn",
|
|
5644
|
+
role=role,
|
|
5645
|
+
|
|
5646
|
+
# the properties below are optional
|
|
5647
|
+
dead_letter_config=scheduler.CfnSchedule.DeadLetterConfigProperty(
|
|
5648
|
+
arn="arn"
|
|
5649
|
+
),
|
|
5650
|
+
ecs_parameters=scheduler.CfnSchedule.EcsParametersProperty(
|
|
5651
|
+
task_definition_arn="taskDefinitionArn",
|
|
5652
|
+
|
|
5653
|
+
# the properties below are optional
|
|
5654
|
+
capacity_provider_strategy=[scheduler.CfnSchedule.CapacityProviderStrategyItemProperty(
|
|
5655
|
+
capacity_provider="capacityProvider",
|
|
5656
|
+
|
|
5657
|
+
# the properties below are optional
|
|
5658
|
+
base=123,
|
|
5659
|
+
weight=123
|
|
5660
|
+
)],
|
|
5661
|
+
enable_ecs_managed_tags=False,
|
|
5662
|
+
enable_execute_command=False,
|
|
5663
|
+
group="group",
|
|
5664
|
+
launch_type="launchType",
|
|
5665
|
+
network_configuration=scheduler.CfnSchedule.NetworkConfigurationProperty(
|
|
5666
|
+
awsvpc_configuration=scheduler.CfnSchedule.AwsVpcConfigurationProperty(
|
|
5667
|
+
subnets=["subnets"],
|
|
5668
|
+
|
|
5669
|
+
# the properties below are optional
|
|
5670
|
+
assign_public_ip="assignPublicIp",
|
|
5671
|
+
security_groups=["securityGroups"]
|
|
5672
|
+
)
|
|
5673
|
+
),
|
|
5674
|
+
placement_constraints=[scheduler.CfnSchedule.PlacementConstraintProperty(
|
|
5675
|
+
expression="expression",
|
|
5676
|
+
type="type"
|
|
5677
|
+
)],
|
|
5678
|
+
placement_strategy=[scheduler.CfnSchedule.PlacementStrategyProperty(
|
|
5679
|
+
field="field",
|
|
5680
|
+
type="type"
|
|
5681
|
+
)],
|
|
5682
|
+
platform_version="platformVersion",
|
|
5683
|
+
propagate_tags="propagateTags",
|
|
5684
|
+
reference_id="referenceId",
|
|
5685
|
+
tags=tags,
|
|
5686
|
+
task_count=123
|
|
5687
|
+
),
|
|
5688
|
+
event_bridge_parameters=scheduler.CfnSchedule.EventBridgeParametersProperty(
|
|
5689
|
+
detail_type="detailType",
|
|
5690
|
+
source="source"
|
|
5691
|
+
),
|
|
5692
|
+
input=schedule_target_input,
|
|
5693
|
+
kinesis_parameters=scheduler.CfnSchedule.KinesisParametersProperty(
|
|
5694
|
+
partition_key="partitionKey"
|
|
5695
|
+
),
|
|
5696
|
+
retry_policy=scheduler.CfnSchedule.RetryPolicyProperty(
|
|
5697
|
+
maximum_event_age_in_seconds=123,
|
|
5698
|
+
maximum_retry_attempts=123
|
|
5699
|
+
),
|
|
5700
|
+
sage_maker_pipeline_parameters=scheduler.CfnSchedule.SageMakerPipelineParametersProperty(
|
|
5701
|
+
pipeline_parameter_list=[scheduler.CfnSchedule.SageMakerPipelineParameterProperty(
|
|
5702
|
+
name="name",
|
|
5703
|
+
value="value"
|
|
5704
|
+
)]
|
|
5705
|
+
),
|
|
5706
|
+
sqs_parameters=scheduler.CfnSchedule.SqsParametersProperty(
|
|
5707
|
+
message_group_id="messageGroupId"
|
|
5708
|
+
)
|
|
5709
|
+
)
|
|
5710
|
+
'''
|
|
5711
|
+
if isinstance(dead_letter_config, dict):
|
|
5712
|
+
dead_letter_config = CfnSchedule.DeadLetterConfigProperty(**dead_letter_config)
|
|
5713
|
+
if isinstance(ecs_parameters, dict):
|
|
5714
|
+
ecs_parameters = CfnSchedule.EcsParametersProperty(**ecs_parameters)
|
|
5715
|
+
if isinstance(event_bridge_parameters, dict):
|
|
5716
|
+
event_bridge_parameters = CfnSchedule.EventBridgeParametersProperty(**event_bridge_parameters)
|
|
5717
|
+
if isinstance(kinesis_parameters, dict):
|
|
5718
|
+
kinesis_parameters = CfnSchedule.KinesisParametersProperty(**kinesis_parameters)
|
|
5719
|
+
if isinstance(retry_policy, dict):
|
|
5720
|
+
retry_policy = CfnSchedule.RetryPolicyProperty(**retry_policy)
|
|
5721
|
+
if isinstance(sage_maker_pipeline_parameters, dict):
|
|
5722
|
+
sage_maker_pipeline_parameters = CfnSchedule.SageMakerPipelineParametersProperty(**sage_maker_pipeline_parameters)
|
|
5723
|
+
if isinstance(sqs_parameters, dict):
|
|
5724
|
+
sqs_parameters = CfnSchedule.SqsParametersProperty(**sqs_parameters)
|
|
5725
|
+
if __debug__:
|
|
5726
|
+
type_hints = typing.get_type_hints(_typecheckingstub__39b25a1f04a872a013c3ee593bb9140da10796639b130bc7f2461018358c6292)
|
|
5727
|
+
check_type(argname="argument arn", value=arn, expected_type=type_hints["arn"])
|
|
5728
|
+
check_type(argname="argument role", value=role, expected_type=type_hints["role"])
|
|
5729
|
+
check_type(argname="argument dead_letter_config", value=dead_letter_config, expected_type=type_hints["dead_letter_config"])
|
|
5730
|
+
check_type(argname="argument ecs_parameters", value=ecs_parameters, expected_type=type_hints["ecs_parameters"])
|
|
5731
|
+
check_type(argname="argument event_bridge_parameters", value=event_bridge_parameters, expected_type=type_hints["event_bridge_parameters"])
|
|
5732
|
+
check_type(argname="argument input", value=input, expected_type=type_hints["input"])
|
|
5733
|
+
check_type(argname="argument kinesis_parameters", value=kinesis_parameters, expected_type=type_hints["kinesis_parameters"])
|
|
5734
|
+
check_type(argname="argument retry_policy", value=retry_policy, expected_type=type_hints["retry_policy"])
|
|
5735
|
+
check_type(argname="argument sage_maker_pipeline_parameters", value=sage_maker_pipeline_parameters, expected_type=type_hints["sage_maker_pipeline_parameters"])
|
|
5736
|
+
check_type(argname="argument sqs_parameters", value=sqs_parameters, expected_type=type_hints["sqs_parameters"])
|
|
5737
|
+
self._values: typing.Dict[builtins.str, typing.Any] = {
|
|
5738
|
+
"arn": arn,
|
|
5739
|
+
"role": role,
|
|
5740
|
+
}
|
|
5741
|
+
if dead_letter_config is not None:
|
|
5742
|
+
self._values["dead_letter_config"] = dead_letter_config
|
|
5743
|
+
if ecs_parameters is not None:
|
|
5744
|
+
self._values["ecs_parameters"] = ecs_parameters
|
|
5745
|
+
if event_bridge_parameters is not None:
|
|
5746
|
+
self._values["event_bridge_parameters"] = event_bridge_parameters
|
|
5747
|
+
if input is not None:
|
|
5748
|
+
self._values["input"] = input
|
|
5749
|
+
if kinesis_parameters is not None:
|
|
5750
|
+
self._values["kinesis_parameters"] = kinesis_parameters
|
|
5751
|
+
if retry_policy is not None:
|
|
5752
|
+
self._values["retry_policy"] = retry_policy
|
|
5753
|
+
if sage_maker_pipeline_parameters is not None:
|
|
5754
|
+
self._values["sage_maker_pipeline_parameters"] = sage_maker_pipeline_parameters
|
|
5755
|
+
if sqs_parameters is not None:
|
|
5756
|
+
self._values["sqs_parameters"] = sqs_parameters
|
|
5757
|
+
|
|
5758
|
+
@builtins.property
|
|
5759
|
+
def arn(self) -> builtins.str:
|
|
5760
|
+
'''The Amazon Resource Name (ARN) of the target.'''
|
|
5761
|
+
result = self._values.get("arn")
|
|
5762
|
+
assert result is not None, "Required property 'arn' is missing"
|
|
5763
|
+
return typing.cast(builtins.str, result)
|
|
5764
|
+
|
|
5765
|
+
@builtins.property
|
|
5766
|
+
def role(self) -> _IRole_235f5d8e:
|
|
5767
|
+
'''Role to use to invoke this event target.'''
|
|
5768
|
+
result = self._values.get("role")
|
|
5769
|
+
assert result is not None, "Required property 'role' is missing"
|
|
5770
|
+
return typing.cast(_IRole_235f5d8e, result)
|
|
5771
|
+
|
|
5772
|
+
@builtins.property
|
|
5773
|
+
def dead_letter_config(
|
|
5774
|
+
self,
|
|
5775
|
+
) -> typing.Optional[CfnSchedule.DeadLetterConfigProperty]:
|
|
5776
|
+
'''An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule.
|
|
5777
|
+
|
|
5778
|
+
If specified, EventBridge Scheduler delivers failed events that could not be successfully delivered to a target to the queue.
|
|
5779
|
+
|
|
5780
|
+
:default: - No dead-letter queue
|
|
5781
|
+
'''
|
|
5782
|
+
result = self._values.get("dead_letter_config")
|
|
5783
|
+
return typing.cast(typing.Optional[CfnSchedule.DeadLetterConfigProperty], result)
|
|
5784
|
+
|
|
5785
|
+
@builtins.property
|
|
5786
|
+
def ecs_parameters(self) -> typing.Optional[CfnSchedule.EcsParametersProperty]:
|
|
5787
|
+
'''The templated target type for the Amazon ECS RunTask API Operation.
|
|
5788
|
+
|
|
5789
|
+
:default: - No parameters
|
|
5790
|
+
'''
|
|
5791
|
+
result = self._values.get("ecs_parameters")
|
|
5792
|
+
return typing.cast(typing.Optional[CfnSchedule.EcsParametersProperty], result)
|
|
5793
|
+
|
|
5794
|
+
@builtins.property
|
|
5795
|
+
def event_bridge_parameters(
|
|
5796
|
+
self,
|
|
5797
|
+
) -> typing.Optional[CfnSchedule.EventBridgeParametersProperty]:
|
|
5798
|
+
'''The templated target type for the EventBridge PutEvents API operation.
|
|
5799
|
+
|
|
5800
|
+
:default: - No parameters
|
|
5801
|
+
'''
|
|
5802
|
+
result = self._values.get("event_bridge_parameters")
|
|
5803
|
+
return typing.cast(typing.Optional[CfnSchedule.EventBridgeParametersProperty], result)
|
|
5804
|
+
|
|
5805
|
+
@builtins.property
|
|
5806
|
+
def input(self) -> typing.Optional["ScheduleTargetInput"]:
|
|
5807
|
+
'''What input to pass to the target.
|
|
5808
|
+
|
|
5809
|
+
:default: - No input
|
|
5810
|
+
'''
|
|
5811
|
+
result = self._values.get("input")
|
|
5812
|
+
return typing.cast(typing.Optional["ScheduleTargetInput"], result)
|
|
5813
|
+
|
|
5814
|
+
@builtins.property
|
|
5815
|
+
def kinesis_parameters(
|
|
5816
|
+
self,
|
|
5817
|
+
) -> typing.Optional[CfnSchedule.KinesisParametersProperty]:
|
|
5818
|
+
'''The templated target type for the Amazon Kinesis PutRecord API operation.
|
|
5819
|
+
|
|
5820
|
+
:default: - No parameters
|
|
5821
|
+
'''
|
|
5822
|
+
result = self._values.get("kinesis_parameters")
|
|
5823
|
+
return typing.cast(typing.Optional[CfnSchedule.KinesisParametersProperty], result)
|
|
5824
|
+
|
|
5825
|
+
@builtins.property
|
|
5826
|
+
def retry_policy(self) -> typing.Optional[CfnSchedule.RetryPolicyProperty]:
|
|
5827
|
+
'''A ``RetryPolicy`` object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.
|
|
5828
|
+
|
|
5829
|
+
:default: - Maximum retry attempts of 185 and maximum age of 86400 seconds (1 day)
|
|
5830
|
+
'''
|
|
5831
|
+
result = self._values.get("retry_policy")
|
|
5832
|
+
return typing.cast(typing.Optional[CfnSchedule.RetryPolicyProperty], result)
|
|
5833
|
+
|
|
5834
|
+
@builtins.property
|
|
5835
|
+
def sage_maker_pipeline_parameters(
|
|
5836
|
+
self,
|
|
5837
|
+
) -> typing.Optional[CfnSchedule.SageMakerPipelineParametersProperty]:
|
|
5838
|
+
'''The templated target type for the Amazon SageMaker StartPipelineExecution API operation.
|
|
5839
|
+
|
|
5840
|
+
:default: - No parameters
|
|
5841
|
+
'''
|
|
5842
|
+
result = self._values.get("sage_maker_pipeline_parameters")
|
|
5843
|
+
return typing.cast(typing.Optional[CfnSchedule.SageMakerPipelineParametersProperty], result)
|
|
5844
|
+
|
|
5845
|
+
@builtins.property
|
|
5846
|
+
def sqs_parameters(self) -> typing.Optional[CfnSchedule.SqsParametersProperty]:
|
|
5847
|
+
'''The templated target type for the Amazon SQS SendMessage API Operation.
|
|
5848
|
+
|
|
5849
|
+
:default: - No parameters
|
|
5850
|
+
'''
|
|
5851
|
+
result = self._values.get("sqs_parameters")
|
|
5852
|
+
return typing.cast(typing.Optional[CfnSchedule.SqsParametersProperty], result)
|
|
5853
|
+
|
|
5854
|
+
def __eq__(self, rhs: typing.Any) -> builtins.bool:
|
|
5855
|
+
return isinstance(rhs, self.__class__) and rhs._values == self._values
|
|
5856
|
+
|
|
5857
|
+
def __ne__(self, rhs: typing.Any) -> builtins.bool:
|
|
5858
|
+
return not (rhs == self)
|
|
5859
|
+
|
|
5860
|
+
def __repr__(self) -> str:
|
|
5861
|
+
return "ScheduleTargetConfig(%s)" % ", ".join(
|
|
5862
|
+
k + "=" + repr(v) for k, v in self._values.items()
|
|
5863
|
+
)
|
|
5864
|
+
|
|
5865
|
+
|
|
5866
|
+
class ScheduleTargetInput(
|
|
5867
|
+
metaclass=jsii.JSIIAbstractClass,
|
|
5868
|
+
jsii_type="aws-cdk-lib.aws_scheduler.ScheduleTargetInput",
|
|
5869
|
+
):
|
|
5870
|
+
'''The text or well-formed JSON input passed to the target of the schedule.
|
|
5871
|
+
|
|
5872
|
+
Tokens and ContextAttribute may be used in the input.
|
|
5873
|
+
|
|
5874
|
+
:exampleMetadata: infused
|
|
5875
|
+
|
|
5876
|
+
Example::
|
|
5877
|
+
|
|
5878
|
+
import aws_cdk.aws_sns as sns
|
|
5879
|
+
|
|
5880
|
+
|
|
5881
|
+
topic = sns.Topic(self, "Topic")
|
|
5882
|
+
|
|
5883
|
+
payload = {
|
|
5884
|
+
"message": "Hello scheduler!"
|
|
5885
|
+
}
|
|
5886
|
+
|
|
5887
|
+
target = targets.SnsPublish(topic,
|
|
5888
|
+
input=ScheduleTargetInput.from_object(payload)
|
|
5889
|
+
)
|
|
5890
|
+
|
|
5891
|
+
Schedule(self, "Schedule",
|
|
5892
|
+
schedule=ScheduleExpression.rate(Duration.hours(1)),
|
|
5893
|
+
target=target
|
|
5894
|
+
)
|
|
5895
|
+
'''
|
|
5896
|
+
|
|
5897
|
+
def __init__(self) -> None:
|
|
5898
|
+
jsii.create(self.__class__, self, [])
|
|
5899
|
+
|
|
5900
|
+
@jsii.member(jsii_name="fromObject")
|
|
5901
|
+
@builtins.classmethod
|
|
5902
|
+
def from_object(cls, obj: typing.Any) -> "ScheduleTargetInput":
|
|
5903
|
+
'''Pass a JSON object to the target.
|
|
5904
|
+
|
|
5905
|
+
The object will be transformed into a well-formed JSON string in the final template.
|
|
5906
|
+
|
|
5907
|
+
:param obj: object to use to convert to JSON to use as input for the target.
|
|
5908
|
+
'''
|
|
5909
|
+
if __debug__:
|
|
5910
|
+
type_hints = typing.get_type_hints(_typecheckingstub__6fdac9a672a0bc2eb981e9971ac41140aa1074946d827f45e5c9d4d78673f0cd)
|
|
5911
|
+
check_type(argname="argument obj", value=obj, expected_type=type_hints["obj"])
|
|
5912
|
+
return typing.cast("ScheduleTargetInput", jsii.sinvoke(cls, "fromObject", [obj]))
|
|
5913
|
+
|
|
5914
|
+
@jsii.member(jsii_name="fromText")
|
|
5915
|
+
@builtins.classmethod
|
|
5916
|
+
def from_text(cls, text: builtins.str) -> "ScheduleTargetInput":
|
|
5917
|
+
'''Pass simple text to the target.
|
|
5918
|
+
|
|
5919
|
+
For passing complex values like JSON object to a target use method
|
|
5920
|
+
``ScheduleTargetInput.fromObject()`` instead.
|
|
5921
|
+
|
|
5922
|
+
:param text: Text to use as the input for the target.
|
|
5923
|
+
'''
|
|
5924
|
+
if __debug__:
|
|
5925
|
+
type_hints = typing.get_type_hints(_typecheckingstub__0925fac0caa3d8fe93a0fe4320d4f08133f45e33174afd1af78bf68282a68524)
|
|
5926
|
+
check_type(argname="argument text", value=text, expected_type=type_hints["text"])
|
|
5927
|
+
return typing.cast("ScheduleTargetInput", jsii.sinvoke(cls, "fromText", [text]))
|
|
5928
|
+
|
|
5929
|
+
@jsii.member(jsii_name="bind")
|
|
5930
|
+
@abc.abstractmethod
|
|
5931
|
+
def bind(self, schedule: ISchedule) -> builtins.str:
|
|
5932
|
+
'''Return the input properties for this input object.
|
|
5933
|
+
|
|
5934
|
+
:param schedule: -
|
|
5935
|
+
'''
|
|
5936
|
+
...
|
|
5937
|
+
|
|
5938
|
+
|
|
5939
|
+
class _ScheduleTargetInputProxy(ScheduleTargetInput):
|
|
5940
|
+
@jsii.member(jsii_name="bind")
|
|
5941
|
+
def bind(self, schedule: ISchedule) -> builtins.str:
|
|
5942
|
+
'''Return the input properties for this input object.
|
|
5943
|
+
|
|
5944
|
+
:param schedule: -
|
|
5945
|
+
'''
|
|
5946
|
+
if __debug__:
|
|
5947
|
+
type_hints = typing.get_type_hints(_typecheckingstub__a35be52ccc2276f18b489131a0846e36e39c8e364f156c20793828399d6d4527)
|
|
5948
|
+
check_type(argname="argument schedule", value=schedule, expected_type=type_hints["schedule"])
|
|
5949
|
+
return typing.cast(builtins.str, jsii.invoke(self, "bind", [schedule]))
|
|
5950
|
+
|
|
5951
|
+
# Adding a "__jsii_proxy_class__(): typing.Type" function to the abstract class
|
|
5952
|
+
typing.cast(typing.Any, ScheduleTargetInput).__jsii_proxy_class__ = lambda : _ScheduleTargetInputProxy
|
|
5953
|
+
|
|
5954
|
+
|
|
5955
|
+
class TimeWindow(
|
|
5956
|
+
metaclass=jsii.JSIIMeta,
|
|
5957
|
+
jsii_type="aws-cdk-lib.aws_scheduler.TimeWindow",
|
|
5958
|
+
):
|
|
5959
|
+
'''A time window during which EventBridge Scheduler invokes the schedule.
|
|
5960
|
+
|
|
5961
|
+
:exampleMetadata: infused
|
|
5962
|
+
|
|
5963
|
+
Example::
|
|
5964
|
+
|
|
5965
|
+
# target: targets.LambdaInvoke
|
|
5966
|
+
|
|
5967
|
+
|
|
5968
|
+
schedule = Schedule(self, "Schedule",
|
|
5969
|
+
schedule=ScheduleExpression.rate(Duration.hours(12)),
|
|
5970
|
+
target=target,
|
|
5971
|
+
time_window=TimeWindow.flexible(Duration.hours(10))
|
|
5972
|
+
)
|
|
5973
|
+
'''
|
|
5974
|
+
|
|
5975
|
+
@jsii.member(jsii_name="flexible")
|
|
5976
|
+
@builtins.classmethod
|
|
5977
|
+
def flexible(cls, max_window: _Duration_4839e8c3) -> "TimeWindow":
|
|
5978
|
+
'''TimeWindow is enabled.
|
|
5979
|
+
|
|
5980
|
+
:param max_window: -
|
|
5981
|
+
'''
|
|
5982
|
+
if __debug__:
|
|
5983
|
+
type_hints = typing.get_type_hints(_typecheckingstub__6dd8fc85f0f89b4cd8d1345003a4cdf1c778546716260aab856c858e92935511)
|
|
5984
|
+
check_type(argname="argument max_window", value=max_window, expected_type=type_hints["max_window"])
|
|
5985
|
+
return typing.cast("TimeWindow", jsii.sinvoke(cls, "flexible", [max_window]))
|
|
5986
|
+
|
|
5987
|
+
@jsii.member(jsii_name="off")
|
|
5988
|
+
@builtins.classmethod
|
|
5989
|
+
def off(cls) -> "TimeWindow":
|
|
5990
|
+
'''TimeWindow is disabled.'''
|
|
5991
|
+
return typing.cast("TimeWindow", jsii.sinvoke(cls, "off", []))
|
|
5992
|
+
|
|
5993
|
+
@builtins.property
|
|
5994
|
+
@jsii.member(jsii_name="mode")
|
|
5995
|
+
def mode(self) -> builtins.str:
|
|
5996
|
+
'''Determines whether the schedule is invoked within a flexible time window.'''
|
|
5997
|
+
return typing.cast(builtins.str, jsii.get(self, "mode"))
|
|
5998
|
+
|
|
5999
|
+
@builtins.property
|
|
6000
|
+
@jsii.member(jsii_name="maxWindow")
|
|
6001
|
+
def max_window(self) -> typing.Optional[_Duration_4839e8c3]:
|
|
6002
|
+
'''The maximum time window during which the schedule can be invoked.
|
|
6003
|
+
|
|
6004
|
+
Must be between 1 to 1440 minutes.
|
|
6005
|
+
|
|
6006
|
+
:default: - no value
|
|
6007
|
+
'''
|
|
6008
|
+
return typing.cast(typing.Optional[_Duration_4839e8c3], jsii.get(self, "maxWindow"))
|
|
6009
|
+
|
|
6010
|
+
|
|
6011
|
+
__all__ = [
|
|
6012
|
+
"CfnSchedule",
|
|
6013
|
+
"CfnScheduleGroup",
|
|
6014
|
+
"CfnScheduleGroupProps",
|
|
6015
|
+
"CfnScheduleProps",
|
|
6016
|
+
"ContextAttribute",
|
|
6017
|
+
"CronOptionsWithTimezone",
|
|
6018
|
+
"ISchedule",
|
|
6019
|
+
"IScheduleGroup",
|
|
6020
|
+
"IScheduleTarget",
|
|
6021
|
+
"Schedule",
|
|
6022
|
+
"ScheduleExpression",
|
|
6023
|
+
"ScheduleGroup",
|
|
6024
|
+
"ScheduleGroupProps",
|
|
6025
|
+
"ScheduleProps",
|
|
6026
|
+
"ScheduleTargetConfig",
|
|
6027
|
+
"ScheduleTargetInput",
|
|
6028
|
+
"TimeWindow",
|
|
6029
|
+
]
|
|
6030
|
+
|
|
6031
|
+
publication.publish()
|
|
6032
|
+
|
|
6033
|
+
def _typecheckingstub__503b74ac170f15626de2456b6f8c40d2cdc1ab21574c821e051517099f516ea4(
|
|
6034
|
+
scope: _constructs_77d1e7e8.Construct,
|
|
6035
|
+
id: builtins.str,
|
|
6036
|
+
*,
|
|
6037
|
+
flexible_time_window: typing.Union[_IResolvable_da3f097b, typing.Union[CfnSchedule.FlexibleTimeWindowProperty, typing.Dict[builtins.str, typing.Any]]],
|
|
6038
|
+
schedule_expression: builtins.str,
|
|
6039
|
+
target: typing.Union[_IResolvable_da3f097b, typing.Union[CfnSchedule.TargetProperty, typing.Dict[builtins.str, typing.Any]]],
|
|
6040
|
+
description: typing.Optional[builtins.str] = None,
|
|
6041
|
+
end_date: typing.Optional[builtins.str] = None,
|
|
6042
|
+
group_name: typing.Optional[builtins.str] = None,
|
|
6043
|
+
kms_key_arn: typing.Optional[builtins.str] = None,
|
|
6044
|
+
name: typing.Optional[builtins.str] = None,
|
|
6045
|
+
schedule_expression_timezone: typing.Optional[builtins.str] = None,
|
|
6046
|
+
start_date: typing.Optional[builtins.str] = None,
|
|
6047
|
+
state: typing.Optional[builtins.str] = None,
|
|
6048
|
+
) -> None:
|
|
6049
|
+
"""Type checking stubs"""
|
|
6050
|
+
pass
|
|
6051
|
+
|
|
6052
|
+
def _typecheckingstub__859c33780944a757aa0069dfe861a7f9ee3aaa6d51b1881276590d23b3cbc11d(
|
|
6053
|
+
inspector: _TreeInspector_488e0dd5,
|
|
6054
|
+
) -> None:
|
|
6055
|
+
"""Type checking stubs"""
|
|
6056
|
+
pass
|
|
6057
|
+
|
|
6058
|
+
def _typecheckingstub__1c9dd58f37a9f244d09bdbca3ac4ea0869a0855a2cb760325d51c0d8beed730d(
|
|
6059
|
+
props: typing.Mapping[builtins.str, typing.Any],
|
|
6060
|
+
) -> None:
|
|
6061
|
+
"""Type checking stubs"""
|
|
6062
|
+
pass
|
|
6063
|
+
|
|
6064
|
+
def _typecheckingstub__596e14fe3c5d30f5608996086027eaf3ff49cf0205d5a551a9e0895e2be75f2a(
|
|
6065
|
+
value: typing.Union[_IResolvable_da3f097b, CfnSchedule.FlexibleTimeWindowProperty],
|
|
6066
|
+
) -> None:
|
|
6067
|
+
"""Type checking stubs"""
|
|
6068
|
+
pass
|
|
6069
|
+
|
|
6070
|
+
def _typecheckingstub__86a3656a00e3dadf75b2e58b2162ed9850cd46df81630349120c362c216f94db(
|
|
6071
|
+
value: builtins.str,
|
|
6072
|
+
) -> None:
|
|
6073
|
+
"""Type checking stubs"""
|
|
6074
|
+
pass
|
|
6075
|
+
|
|
6076
|
+
def _typecheckingstub__9658077cef2602ca00d25f391105ce442d6a0a3efef1ca5be55db053ede80a78(
|
|
6077
|
+
value: typing.Union[_IResolvable_da3f097b, CfnSchedule.TargetProperty],
|
|
6078
|
+
) -> None:
|
|
6079
|
+
"""Type checking stubs"""
|
|
6080
|
+
pass
|
|
6081
|
+
|
|
6082
|
+
def _typecheckingstub__5864139b51db95ec1c3e6c947b577675bb4f83133b1f5476864d71c4009c2386(
|
|
6083
|
+
value: typing.Optional[builtins.str],
|
|
6084
|
+
) -> None:
|
|
6085
|
+
"""Type checking stubs"""
|
|
6086
|
+
pass
|
|
6087
|
+
|
|
6088
|
+
def _typecheckingstub__c3d0ae7ef525e3a588544a09eb7ec3271c357974ae47f41180a7aeb9086e2594(
|
|
6089
|
+
value: typing.Optional[builtins.str],
|
|
6090
|
+
) -> None:
|
|
6091
|
+
"""Type checking stubs"""
|
|
6092
|
+
pass
|
|
6093
|
+
|
|
6094
|
+
def _typecheckingstub__f1860ec4ad4204d90b7f2756ff633582f92f7f97d174b16a7da8e36811ebdc98(
|
|
6095
|
+
value: typing.Optional[builtins.str],
|
|
6096
|
+
) -> None:
|
|
6097
|
+
"""Type checking stubs"""
|
|
6098
|
+
pass
|
|
6099
|
+
|
|
6100
|
+
def _typecheckingstub__c65947df9a6be40d839d971ea07ff6a85493b9cfbab03c61fc17e54bdd0e9276(
|
|
6101
|
+
value: typing.Optional[builtins.str],
|
|
6102
|
+
) -> None:
|
|
6103
|
+
"""Type checking stubs"""
|
|
6104
|
+
pass
|
|
6105
|
+
|
|
6106
|
+
def _typecheckingstub__eb6bd8d80ac829e96128e011c87e852bfea080bdcd859bfdf98c7874542dc1b5(
|
|
6107
|
+
value: typing.Optional[builtins.str],
|
|
6108
|
+
) -> None:
|
|
6109
|
+
"""Type checking stubs"""
|
|
6110
|
+
pass
|
|
6111
|
+
|
|
6112
|
+
def _typecheckingstub__eb337d25b9d34da19dbe88b72514ea1e1e7a235cd91b7597abecd038498e11a9(
|
|
6113
|
+
value: typing.Optional[builtins.str],
|
|
6114
|
+
) -> None:
|
|
6115
|
+
"""Type checking stubs"""
|
|
6116
|
+
pass
|
|
6117
|
+
|
|
6118
|
+
def _typecheckingstub__38fc94567c401ce05bf3ed2461327df25f05b71764228be5a3f95fec0573d007(
|
|
6119
|
+
value: typing.Optional[builtins.str],
|
|
6120
|
+
) -> None:
|
|
6121
|
+
"""Type checking stubs"""
|
|
6122
|
+
pass
|
|
6123
|
+
|
|
6124
|
+
def _typecheckingstub__986ef975482735e4fbf46592da626ebfd4ca9636ad053fe886d40f9856d1483e(
|
|
6125
|
+
value: typing.Optional[builtins.str],
|
|
6126
|
+
) -> None:
|
|
6127
|
+
"""Type checking stubs"""
|
|
6128
|
+
pass
|
|
6129
|
+
|
|
6130
|
+
def _typecheckingstub__4be9629f7b1d55fb08861d6713480d5fa198e6e40012bcf701a627e532032afb(
|
|
6131
|
+
*,
|
|
6132
|
+
subnets: typing.Sequence[builtins.str],
|
|
6133
|
+
assign_public_ip: typing.Optional[builtins.str] = None,
|
|
6134
|
+
security_groups: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
6135
|
+
) -> None:
|
|
6136
|
+
"""Type checking stubs"""
|
|
6137
|
+
pass
|
|
6138
|
+
|
|
6139
|
+
def _typecheckingstub__1d8897162eaa13dfb81dc83e782d5936ed604f09ed623574ad9d0fabc4a1ab7e(
|
|
6140
|
+
*,
|
|
6141
|
+
capacity_provider: builtins.str,
|
|
6142
|
+
base: typing.Optional[jsii.Number] = None,
|
|
6143
|
+
weight: typing.Optional[jsii.Number] = None,
|
|
6144
|
+
) -> None:
|
|
6145
|
+
"""Type checking stubs"""
|
|
6146
|
+
pass
|
|
6147
|
+
|
|
6148
|
+
def _typecheckingstub__147909ee33401019ceeec9c9c260dd3ac0812db04c597e1b63c26f0608f61069(
|
|
2646
6149
|
*,
|
|
2647
6150
|
arn: typing.Optional[builtins.str] = None,
|
|
2648
6151
|
) -> None:
|
|
@@ -2819,3 +6322,323 @@ def _typecheckingstub__7259f3f17d67e55e8ad4459f637d0d8aa80d57d58cb928f6b0403a609
|
|
|
2819
6322
|
) -> None:
|
|
2820
6323
|
"""Type checking stubs"""
|
|
2821
6324
|
pass
|
|
6325
|
+
|
|
6326
|
+
def _typecheckingstub__c3ffc32f8d37e5b3c60f6299c8f15649e00e5778ef81be54ecc2ffbb99ac1bbc(
|
|
6327
|
+
name: builtins.str,
|
|
6328
|
+
) -> None:
|
|
6329
|
+
"""Type checking stubs"""
|
|
6330
|
+
pass
|
|
6331
|
+
|
|
6332
|
+
def _typecheckingstub__c87f71f166be27f7417012dedd810bd7b3cedb2ec7d0a0493ca36f93993f6c5b(
|
|
6333
|
+
*,
|
|
6334
|
+
day: typing.Optional[builtins.str] = None,
|
|
6335
|
+
hour: typing.Optional[builtins.str] = None,
|
|
6336
|
+
minute: typing.Optional[builtins.str] = None,
|
|
6337
|
+
month: typing.Optional[builtins.str] = None,
|
|
6338
|
+
week_day: typing.Optional[builtins.str] = None,
|
|
6339
|
+
year: typing.Optional[builtins.str] = None,
|
|
6340
|
+
time_zone: typing.Optional[_TimeZone_cdd72ac9] = None,
|
|
6341
|
+
) -> None:
|
|
6342
|
+
"""Type checking stubs"""
|
|
6343
|
+
pass
|
|
6344
|
+
|
|
6345
|
+
def _typecheckingstub__190f03a36ab90eca0db1bdfd7c06d5891c61b69defb1c7be61f45d771a66e130(
|
|
6346
|
+
grantee: _IGrantable_71c4f5de,
|
|
6347
|
+
*actions: builtins.str,
|
|
6348
|
+
) -> None:
|
|
6349
|
+
"""Type checking stubs"""
|
|
6350
|
+
pass
|
|
6351
|
+
|
|
6352
|
+
def _typecheckingstub__579ff4205e0ccb1830f899a44fc742e9853277ba0f82091be749e20b4fdbf1c2(
|
|
6353
|
+
identity: _IGrantable_71c4f5de,
|
|
6354
|
+
) -> None:
|
|
6355
|
+
"""Type checking stubs"""
|
|
6356
|
+
pass
|
|
6357
|
+
|
|
6358
|
+
def _typecheckingstub__66f280f7a41957c98ada2240887b088985bbe273d1067b2c4f83f8ca69d09aae(
|
|
6359
|
+
identity: _IGrantable_71c4f5de,
|
|
6360
|
+
) -> None:
|
|
6361
|
+
"""Type checking stubs"""
|
|
6362
|
+
pass
|
|
6363
|
+
|
|
6364
|
+
def _typecheckingstub__f189e0a2b180ceb7d47a54524a64df15a2d1c7a5efe1e25873a64a68692c1d18(
|
|
6365
|
+
identity: _IGrantable_71c4f5de,
|
|
6366
|
+
) -> None:
|
|
6367
|
+
"""Type checking stubs"""
|
|
6368
|
+
pass
|
|
6369
|
+
|
|
6370
|
+
def _typecheckingstub__b1a1c48be5584426072c1f842a1e31e59436e2cefe7df9e84b5a3115ad743d3e(
|
|
6371
|
+
metric_name: builtins.str,
|
|
6372
|
+
*,
|
|
6373
|
+
account: typing.Optional[builtins.str] = None,
|
|
6374
|
+
color: typing.Optional[builtins.str] = None,
|
|
6375
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
6376
|
+
label: typing.Optional[builtins.str] = None,
|
|
6377
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
6378
|
+
region: typing.Optional[builtins.str] = None,
|
|
6379
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
6380
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
6381
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
6382
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
6383
|
+
) -> None:
|
|
6384
|
+
"""Type checking stubs"""
|
|
6385
|
+
pass
|
|
6386
|
+
|
|
6387
|
+
def _typecheckingstub__43e3d3a73dae7296d8e1b29562f7a8fbdf941fb9885fa0ddcc13164e2352e68d(
|
|
6388
|
+
error_code: typing.Optional[builtins.str] = None,
|
|
6389
|
+
*,
|
|
6390
|
+
account: typing.Optional[builtins.str] = None,
|
|
6391
|
+
color: typing.Optional[builtins.str] = None,
|
|
6392
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
6393
|
+
label: typing.Optional[builtins.str] = None,
|
|
6394
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
6395
|
+
region: typing.Optional[builtins.str] = None,
|
|
6396
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
6397
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
6398
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
6399
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
6400
|
+
) -> None:
|
|
6401
|
+
"""Type checking stubs"""
|
|
6402
|
+
pass
|
|
6403
|
+
|
|
6404
|
+
def _typecheckingstub__1db14aa1db4d786b1846e49587706992ee79b66245d52b5efebd763ccbd24c94(
|
|
6405
|
+
_schedule: ISchedule,
|
|
6406
|
+
) -> None:
|
|
6407
|
+
"""Type checking stubs"""
|
|
6408
|
+
pass
|
|
6409
|
+
|
|
6410
|
+
def _typecheckingstub__e5e74b4c774095daccbb01abe34df777261be2bfce9f7ec773cd8688b17dbb98(
|
|
6411
|
+
scope: _constructs_77d1e7e8.Construct,
|
|
6412
|
+
id: builtins.str,
|
|
6413
|
+
*,
|
|
6414
|
+
schedule: ScheduleExpression,
|
|
6415
|
+
target: IScheduleTarget,
|
|
6416
|
+
description: typing.Optional[builtins.str] = None,
|
|
6417
|
+
enabled: typing.Optional[builtins.bool] = None,
|
|
6418
|
+
end: typing.Optional[datetime.datetime] = None,
|
|
6419
|
+
key: typing.Optional[_IKey_5f11635f] = None,
|
|
6420
|
+
schedule_group: typing.Optional[IScheduleGroup] = None,
|
|
6421
|
+
schedule_name: typing.Optional[builtins.str] = None,
|
|
6422
|
+
start: typing.Optional[datetime.datetime] = None,
|
|
6423
|
+
time_window: typing.Optional[TimeWindow] = None,
|
|
6424
|
+
) -> None:
|
|
6425
|
+
"""Type checking stubs"""
|
|
6426
|
+
pass
|
|
6427
|
+
|
|
6428
|
+
def _typecheckingstub__1372455178922293375a1300f4c6e69cee5bc442b16f4036c84aafb7d9332f93(
|
|
6429
|
+
scope: _constructs_77d1e7e8.Construct,
|
|
6430
|
+
id: builtins.str,
|
|
6431
|
+
schedule_arn: builtins.str,
|
|
6432
|
+
) -> None:
|
|
6433
|
+
"""Type checking stubs"""
|
|
6434
|
+
pass
|
|
6435
|
+
|
|
6436
|
+
def _typecheckingstub__3e9697edf3bddfcbab866b7220407b409d24e19d71a4831cc2eae389b626c1d7(
|
|
6437
|
+
metric_name: builtins.str,
|
|
6438
|
+
*,
|
|
6439
|
+
account: typing.Optional[builtins.str] = None,
|
|
6440
|
+
color: typing.Optional[builtins.str] = None,
|
|
6441
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
6442
|
+
label: typing.Optional[builtins.str] = None,
|
|
6443
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
6444
|
+
region: typing.Optional[builtins.str] = None,
|
|
6445
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
6446
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
6447
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
6448
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
6449
|
+
) -> None:
|
|
6450
|
+
"""Type checking stubs"""
|
|
6451
|
+
pass
|
|
6452
|
+
|
|
6453
|
+
def _typecheckingstub__897a723a752bdf5a7cbd4dc9c673edd8862b55def0dfc20984054c323d651b0d(
|
|
6454
|
+
error_code: typing.Optional[builtins.str] = None,
|
|
6455
|
+
*,
|
|
6456
|
+
account: typing.Optional[builtins.str] = None,
|
|
6457
|
+
color: typing.Optional[builtins.str] = None,
|
|
6458
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
6459
|
+
label: typing.Optional[builtins.str] = None,
|
|
6460
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
6461
|
+
region: typing.Optional[builtins.str] = None,
|
|
6462
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
6463
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
6464
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
6465
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
6466
|
+
) -> None:
|
|
6467
|
+
"""Type checking stubs"""
|
|
6468
|
+
pass
|
|
6469
|
+
|
|
6470
|
+
def _typecheckingstub__175909e9c50b88b6e35fc2db4998caa986e6da11a9a20dbde9c02ee1ca0b00b8(
|
|
6471
|
+
date: datetime.datetime,
|
|
6472
|
+
time_zone: typing.Optional[_TimeZone_cdd72ac9] = None,
|
|
6473
|
+
) -> None:
|
|
6474
|
+
"""Type checking stubs"""
|
|
6475
|
+
pass
|
|
6476
|
+
|
|
6477
|
+
def _typecheckingstub__21e89766a8d616bfc00e75a22774b5d41c55681b6f5f623f08f201c835dd2902(
|
|
6478
|
+
expression: builtins.str,
|
|
6479
|
+
time_zone: typing.Optional[_TimeZone_cdd72ac9] = None,
|
|
6480
|
+
) -> None:
|
|
6481
|
+
"""Type checking stubs"""
|
|
6482
|
+
pass
|
|
6483
|
+
|
|
6484
|
+
def _typecheckingstub__97a45c9b75fc81cb3d47817d0893dffb28ebc87496c4a4eedb9cf73b57a68cc5(
|
|
6485
|
+
duration: _Duration_4839e8c3,
|
|
6486
|
+
) -> None:
|
|
6487
|
+
"""Type checking stubs"""
|
|
6488
|
+
pass
|
|
6489
|
+
|
|
6490
|
+
def _typecheckingstub__736972893d2822201f3b54995126456a9f4766921d769ea7836c13c49c015d53(
|
|
6491
|
+
scope: _constructs_77d1e7e8.Construct,
|
|
6492
|
+
id: builtins.str,
|
|
6493
|
+
*,
|
|
6494
|
+
removal_policy: typing.Optional[_RemovalPolicy_9f93c814] = None,
|
|
6495
|
+
schedule_group_name: typing.Optional[builtins.str] = None,
|
|
6496
|
+
) -> None:
|
|
6497
|
+
"""Type checking stubs"""
|
|
6498
|
+
pass
|
|
6499
|
+
|
|
6500
|
+
def _typecheckingstub__b7b5a1fbdcbfd0ad106f45caf1d995619df8d064b8587659c5461157f6e48926(
|
|
6501
|
+
scope: _constructs_77d1e7e8.Construct,
|
|
6502
|
+
id: builtins.str,
|
|
6503
|
+
) -> None:
|
|
6504
|
+
"""Type checking stubs"""
|
|
6505
|
+
pass
|
|
6506
|
+
|
|
6507
|
+
def _typecheckingstub__9c77731a2b0fb48c74a722651a8f036cef9066af4a6dd7b73c0b9b2d119bc36d(
|
|
6508
|
+
scope: _constructs_77d1e7e8.Construct,
|
|
6509
|
+
id: builtins.str,
|
|
6510
|
+
schedule_group_arn: builtins.str,
|
|
6511
|
+
) -> None:
|
|
6512
|
+
"""Type checking stubs"""
|
|
6513
|
+
pass
|
|
6514
|
+
|
|
6515
|
+
def _typecheckingstub__e0eef3cd9167e1bcf64df7282dec1f362eaac5659d22625afac3c28dcc0b7edb(
|
|
6516
|
+
scope: _constructs_77d1e7e8.Construct,
|
|
6517
|
+
id: builtins.str,
|
|
6518
|
+
schedule_group_name: builtins.str,
|
|
6519
|
+
) -> None:
|
|
6520
|
+
"""Type checking stubs"""
|
|
6521
|
+
pass
|
|
6522
|
+
|
|
6523
|
+
def _typecheckingstub__1603de1685aaaf14ff1514df8394bc631af9b5e6f8b79a44c31ff5e24157a7e0(
|
|
6524
|
+
grantee: _IGrantable_71c4f5de,
|
|
6525
|
+
*actions: builtins.str,
|
|
6526
|
+
) -> None:
|
|
6527
|
+
"""Type checking stubs"""
|
|
6528
|
+
pass
|
|
6529
|
+
|
|
6530
|
+
def _typecheckingstub__15bda48b16b2099393ebcd41e9be05dd66aaf7faaeae1ba65b42220d7667bce5(
|
|
6531
|
+
identity: _IGrantable_71c4f5de,
|
|
6532
|
+
) -> None:
|
|
6533
|
+
"""Type checking stubs"""
|
|
6534
|
+
pass
|
|
6535
|
+
|
|
6536
|
+
def _typecheckingstub__55a9d37bafcef8d26af6e888f5ab8b2aef1359b02c7a510049f6e900c986b797(
|
|
6537
|
+
identity: _IGrantable_71c4f5de,
|
|
6538
|
+
) -> None:
|
|
6539
|
+
"""Type checking stubs"""
|
|
6540
|
+
pass
|
|
6541
|
+
|
|
6542
|
+
def _typecheckingstub__f2cc2856526773b02c8dfcbfcca6cf534cc4a4b00a0b0de1e8fe166c071534ab(
|
|
6543
|
+
identity: _IGrantable_71c4f5de,
|
|
6544
|
+
) -> None:
|
|
6545
|
+
"""Type checking stubs"""
|
|
6546
|
+
pass
|
|
6547
|
+
|
|
6548
|
+
def _typecheckingstub__634bd225463be60303d9d1588926bbaa9fbd72c940ca54fecf9724d90fdefe64(
|
|
6549
|
+
metric_name: builtins.str,
|
|
6550
|
+
*,
|
|
6551
|
+
account: typing.Optional[builtins.str] = None,
|
|
6552
|
+
color: typing.Optional[builtins.str] = None,
|
|
6553
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
6554
|
+
label: typing.Optional[builtins.str] = None,
|
|
6555
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
6556
|
+
region: typing.Optional[builtins.str] = None,
|
|
6557
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
6558
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
6559
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
6560
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
6561
|
+
) -> None:
|
|
6562
|
+
"""Type checking stubs"""
|
|
6563
|
+
pass
|
|
6564
|
+
|
|
6565
|
+
def _typecheckingstub__ca970bf647095b0a6fd282ecce93e19b12761be780f7fac1db8cc3b6f97c0cbf(
|
|
6566
|
+
error_code: typing.Optional[builtins.str] = None,
|
|
6567
|
+
*,
|
|
6568
|
+
account: typing.Optional[builtins.str] = None,
|
|
6569
|
+
color: typing.Optional[builtins.str] = None,
|
|
6570
|
+
dimensions_map: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
|
|
6571
|
+
label: typing.Optional[builtins.str] = None,
|
|
6572
|
+
period: typing.Optional[_Duration_4839e8c3] = None,
|
|
6573
|
+
region: typing.Optional[builtins.str] = None,
|
|
6574
|
+
stack_account: typing.Optional[builtins.str] = None,
|
|
6575
|
+
stack_region: typing.Optional[builtins.str] = None,
|
|
6576
|
+
statistic: typing.Optional[builtins.str] = None,
|
|
6577
|
+
unit: typing.Optional[_Unit_61bc6f70] = None,
|
|
6578
|
+
) -> None:
|
|
6579
|
+
"""Type checking stubs"""
|
|
6580
|
+
pass
|
|
6581
|
+
|
|
6582
|
+
def _typecheckingstub__00f616ddd843f7dab1625531f0a0666a403b81004bd707155fc676f64bb15c34(
|
|
6583
|
+
*,
|
|
6584
|
+
removal_policy: typing.Optional[_RemovalPolicy_9f93c814] = None,
|
|
6585
|
+
schedule_group_name: typing.Optional[builtins.str] = None,
|
|
6586
|
+
) -> None:
|
|
6587
|
+
"""Type checking stubs"""
|
|
6588
|
+
pass
|
|
6589
|
+
|
|
6590
|
+
def _typecheckingstub__f1a1cbc6cf4c30e6930150f969adcdfef2b116842e4bcb34a1adcf13677e296f(
|
|
6591
|
+
*,
|
|
6592
|
+
schedule: ScheduleExpression,
|
|
6593
|
+
target: IScheduleTarget,
|
|
6594
|
+
description: typing.Optional[builtins.str] = None,
|
|
6595
|
+
enabled: typing.Optional[builtins.bool] = None,
|
|
6596
|
+
end: typing.Optional[datetime.datetime] = None,
|
|
6597
|
+
key: typing.Optional[_IKey_5f11635f] = None,
|
|
6598
|
+
schedule_group: typing.Optional[IScheduleGroup] = None,
|
|
6599
|
+
schedule_name: typing.Optional[builtins.str] = None,
|
|
6600
|
+
start: typing.Optional[datetime.datetime] = None,
|
|
6601
|
+
time_window: typing.Optional[TimeWindow] = None,
|
|
6602
|
+
) -> None:
|
|
6603
|
+
"""Type checking stubs"""
|
|
6604
|
+
pass
|
|
6605
|
+
|
|
6606
|
+
def _typecheckingstub__39b25a1f04a872a013c3ee593bb9140da10796639b130bc7f2461018358c6292(
|
|
6607
|
+
*,
|
|
6608
|
+
arn: builtins.str,
|
|
6609
|
+
role: _IRole_235f5d8e,
|
|
6610
|
+
dead_letter_config: typing.Optional[typing.Union[CfnSchedule.DeadLetterConfigProperty, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
6611
|
+
ecs_parameters: typing.Optional[typing.Union[CfnSchedule.EcsParametersProperty, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
6612
|
+
event_bridge_parameters: typing.Optional[typing.Union[CfnSchedule.EventBridgeParametersProperty, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
6613
|
+
input: typing.Optional[ScheduleTargetInput] = None,
|
|
6614
|
+
kinesis_parameters: typing.Optional[typing.Union[CfnSchedule.KinesisParametersProperty, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
6615
|
+
retry_policy: typing.Optional[typing.Union[CfnSchedule.RetryPolicyProperty, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
6616
|
+
sage_maker_pipeline_parameters: typing.Optional[typing.Union[CfnSchedule.SageMakerPipelineParametersProperty, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
6617
|
+
sqs_parameters: typing.Optional[typing.Union[CfnSchedule.SqsParametersProperty, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
6618
|
+
) -> None:
|
|
6619
|
+
"""Type checking stubs"""
|
|
6620
|
+
pass
|
|
6621
|
+
|
|
6622
|
+
def _typecheckingstub__6fdac9a672a0bc2eb981e9971ac41140aa1074946d827f45e5c9d4d78673f0cd(
|
|
6623
|
+
obj: typing.Any,
|
|
6624
|
+
) -> None:
|
|
6625
|
+
"""Type checking stubs"""
|
|
6626
|
+
pass
|
|
6627
|
+
|
|
6628
|
+
def _typecheckingstub__0925fac0caa3d8fe93a0fe4320d4f08133f45e33174afd1af78bf68282a68524(
|
|
6629
|
+
text: builtins.str,
|
|
6630
|
+
) -> None:
|
|
6631
|
+
"""Type checking stubs"""
|
|
6632
|
+
pass
|
|
6633
|
+
|
|
6634
|
+
def _typecheckingstub__a35be52ccc2276f18b489131a0846e36e39c8e364f156c20793828399d6d4527(
|
|
6635
|
+
schedule: ISchedule,
|
|
6636
|
+
) -> None:
|
|
6637
|
+
"""Type checking stubs"""
|
|
6638
|
+
pass
|
|
6639
|
+
|
|
6640
|
+
def _typecheckingstub__6dd8fc85f0f89b4cd8d1345003a4cdf1c778546716260aab856c858e92935511(
|
|
6641
|
+
max_window: _Duration_4839e8c3,
|
|
6642
|
+
) -> None:
|
|
6643
|
+
"""Type checking stubs"""
|
|
6644
|
+
pass
|