You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
small changes to README before developer preview, mostly formatting and some grammar fixes
----
*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Copy file name to clipboardExpand all lines: packages/@aws-cdk/aws-scheduler-alpha/README.md
+38-31
Original file line number
Diff line number
Diff line change
@@ -16,26 +16,26 @@
16
16
<!--END STABILITY BANNER-->
17
17
18
18
[Amazon EventBridge Scheduler](https://aws.amazon.com/blogs/compute/introducing-amazon-eventbridge-scheduler/) is a feature from Amazon EventBridge
19
-
that allows you to create, run, and manage scheduled tasks at scale. With EventBridge Scheduler, you can schedule one-time or recurrently tens
19
+
that allows you to create, run, and manage scheduled tasks at scale. With EventBridge Scheduler, you can schedule one-time or recurrently tens
20
20
of millions of tasks across many AWS services without provisioning or managing underlying infrastructure.
21
21
22
-
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.
23
-
2.**Targets**: A target is an API operation that EventBridge Scheduler calls on your behalf every time your schedule runs. EventBridge Scheduler
24
-
supports two types of targets: templated targets and universal targets. Templated targets invoke common API operations across a core groups of
25
-
services. For example, EventBridge Scheduler supports templated targets for invoking AWS Lambda Function or starting execution of Step Function state
22
+
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.
23
+
2.**Target**: A target is an API operation that EventBridge Scheduler calls on your behalf every time your schedule runs. EventBridge Scheduler
24
+
supports two types of targets: templated targets and universal targets. Templated targets invoke common API operations across a core groups of
25
+
services. For example, EventBridge Scheduler supports templated targets for invoking AWS Lambda Function or starting execution of Step Functions state
26
26
machine. For API operations that are not supported by templated targets you can use customizable universal targets. Universal targets support calling
27
27
more than 6,000 API operations across over 270 AWS services.
28
28
3.**Schedule Group**: A schedule group is an Amazon EventBridge Scheduler resource that you use to organize your schedules. Your AWS account comes
29
-
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
30
-
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
29
+
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
30
+
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
31
31
schedules logically, access the schedule metrics and manage permissions at group granularity (see details below). Scheduling groups support tagging:
32
32
with EventBridge Scheduler, you apply tags to schedule groups, not to individual schedules to organize your resources.
33
33
34
34
This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project. It allows you to define Event Bridge Schedules.
35
35
36
36
> This module is in active development. Some features may not be implemented yet.
If not specified a schedule is added to the default group. However, you can also add the schedule to a custom scheduling group managed by you:
111
+
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.
110
112
111
113
```ts
112
114
declareconst target:targets.LambdaInvoke;
@@ -154,13 +156,18 @@ new Schedule(this, 'Schedule', {
154
156
## Scheduler Targets
155
157
156
158
The `@aws-cdk/aws-scheduler-targets-alpha` module includes classes that implement the `IScheduleTarget` interface for
157
-
various AWS services. EventBridge Scheduler supports two types of targets: templated targets invoke common API
158
-
operations across a core groups of services, and customizable universal targets that you can use to call more
159
-
than 6,000 operations across over 270 services. A list of supported targets can be found at `@aws-cdk/aws-scheduler-targets-alpha`.
159
+
various AWS services. EventBridge Scheduler supports two types of targets:
160
+
161
+
1.**Templated targets** which invoke common API
162
+
operations across a core groups of services, and
163
+
2.**Universal targets** that you can customize to call more
164
+
than 6,000 operations across over 270 services.
165
+
166
+
A list of supported targets can be found at `@aws-cdk/aws-scheduler-targets-alpha`.
160
167
161
-
### Input
168
+
### Input
162
169
163
-
Target can be invoked with a custom input. Class`ScheduleTargetInput` supports freeform text input and JSON-formatted object input:
170
+
Targets can be invoked with a custom input. The`ScheduleTargetInput`class supports free-form text input and JSON-formatted object input:
164
171
165
172
```ts
166
173
const input =ScheduleTargetInput.fromObject({
@@ -182,14 +189,14 @@ const text = `Attempt number: ${ContextAttribute.attemptNumber}`;
182
189
const input =ScheduleTargetInput.fromText(text);
183
190
```
184
191
185
-
### Specifying Execution Role
192
+
### Specifying an execution role
186
193
187
194
An execution role is an IAM role that EventBridge Scheduler assumes in order to interact with other AWS services on your behalf.
188
195
189
196
The classes for templated schedule targets automatically create an IAM role with all the minimum necessary
190
197
permissions to interact with the templated target. If you wish you may specify your own IAM role, then the templated targets
191
-
will grant minimal required permissions. For example: for invoking Lambda function target `LambdaInvoke` will grant
192
-
execution IAM role permission to `lambda:InvokeFunction`.
198
+
will grant minimal required permissions. For example, the target `LambdaInvoke` will grant the
199
+
IAM execution role `lambda:InvokeFunction` permission to invoke the Lambda function.
193
200
194
201
```ts
195
202
declareconst fn:lambda.Function;
@@ -206,14 +213,14 @@ const target = new targets.LambdaInvoke(fn, {
206
213
});
207
214
```
208
215
209
-
### Specifying Encryption key
216
+
### Specifying an encryption key
210
217
211
-
EventBridge Scheduler integrates with AWS Key Management Service (AWS KMS) to encrypt and decrypt your data using an AWS KMS key.
218
+
EventBridge Scheduler integrates with AWS Key Management Service (AWS KMS) to encrypt and decrypt your data using an AWS KMS key.
212
219
EventBridge Scheduler supports two types of KMS keys: AWS owned keys, and customer managed keys.
213
220
214
-
By default, all events in Scheduler are encrypted with a key that AWS owns and manages.
215
-
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.
216
-
Target classes will automatically add AWS KMS Decrypt permission to your schedule's execution role permissions policy.
221
+
By default, all events in Scheduler are encrypted with a key that AWS owns and manages.
222
+
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.
223
+
Target classes will automatically add AWS `kms:Decrypt` permission to your schedule's execution role permissions policy.
> Visit [Configuring flexible time windows](https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-schedule-flexible-time-windows.html) for more details.
253
260
254
-
## Error-handling
261
+
## Error-handling
255
262
256
263
You can configure how your schedule handles failures, when EventBridge Scheduler is unable to deliver an event
257
264
successfully to a target, by using two primary mechanisms: a retry policy, and a dead-letter queue (DLQ).
@@ -280,10 +287,10 @@ const target = new targets.LambdaInvoke(fn, {
280
287
281
288
## Monitoring
282
289
283
-
You can monitor Amazon EventBridge Scheduler using CloudWatch, which collects raw data
284
-
and processes it into readable, near real-time metrics. EventBridge Scheduler emits
290
+
You can monitor Amazon EventBridge Scheduler using CloudWatch, which collects raw data
291
+
and processes it into readable, near real-time metrics. EventBridge Scheduler emits
285
292
a set of metrics for all schedules, and an additional set of metrics for schedules that
286
-
have an associated dead-letter queue (DLQ). If you configure a DLQ for your schedule,
293
+
have an associated dead-letter queue (DLQ). If you configure a DLQ for your schedule,
287
294
EventBridge Scheduler publishes additional metrics when your schedule exhausts its retry policy.
0 commit comments