Skip to content

Commit b1e59dd

Browse files
authored
chore(scheduler-alpha): clean up readme (#32034)
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*
1 parent 1c6f23f commit b1e59dd

File tree

1 file changed

+38
-31
lines changed
  • packages/@aws-cdk/aws-scheduler-alpha

1 file changed

+38
-31
lines changed

packages/@aws-cdk/aws-scheduler-alpha/README.md

+38-31
Original file line numberDiff line numberDiff line change
@@ -16,26 +16,26 @@
1616
<!--END STABILITY BANNER-->
1717

1818
[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
2020
of millions of tasks across many AWS services without provisioning or managing underlying infrastructure.
2121

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
2626
machine. For API operations that are not supported by templated targets you can use customizable universal targets. Universal targets support calling
2727
more than 6,000 API operations across over 270 AWS services.
2828
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
3131
schedules logically, access the schedule metrics and manage permissions at group granularity (see details below). Scheduling groups support tagging:
3232
with EventBridge Scheduler, you apply tags to schedule groups, not to individual schedules to organize your resources.
3333

3434
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.
3535

3636
> This module is in active development. Some features may not be implemented yet.
3737
38-
## Defining a schedule
38+
## Defining a schedule
3939

4040
```ts
4141
declare const fn: lambda.Function;
@@ -55,10 +55,12 @@ const schedule = new Schedule(this, 'Schedule', {
5555

5656
### Schedule Expressions
5757

58-
You can choose from three schedule types when configuring your schedule: rate-based, cron-based, and one-time schedules.
58+
You can choose from three schedule types when configuring your schedule: rate-based, cron-based, and one-time schedules.
5959

60-
Both rate-based and cron-based schedules are recurring schedules. You can configure each recurring schedule type using a schedule expression. For
61-
cron-based schedule you can specify a time zone in which EventBridge Scheduler evaluates the expression.
60+
Both rate-based and cron-based schedules are recurring schedules. You can configure each recurring schedule type using a schedule expression.
61+
62+
For
63+
cron-based schedules you can specify a time zone in which EventBridge Scheduler evaluates the expression.
6264

6365
```ts
6466
declare const target: targets.LambdaInvoke;
@@ -82,7 +84,7 @@ const cronBasedSchedule = new Schedule(this, 'Schedule', {
8284
});
8385
```
8486

85-
A one-time schedule is a schedule that invokes a target only once. You configure a one-time schedule when by specifying the time of the day, date,
87+
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,
8688
and time zone in which EventBridge Scheduler evaluates the schedule.
8789

8890
```ts
@@ -100,13 +102,13 @@ const oneTimeSchedule = new Schedule(this, 'Schedule', {
100102

101103
### Grouping Schedules
102104

103-
Your AWS account comes with a default scheduler group. You can access default group in CDK with:
105+
Your AWS account comes with a default scheduler group. You can access the default group in CDK with:
104106

105107
```ts
106108
const defaultGroup = Group.fromDefaultGroup(this, "DefaultGroup");
107109
```
108110

109-
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.
110112

111113
```ts
112114
declare const target: targets.LambdaInvoke;
@@ -154,13 +156,18 @@ new Schedule(this, 'Schedule', {
154156
## Scheduler Targets
155157

156158
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`.
160167

161-
### Input
168+
### Input
162169

163-
Target can be invoked with a custom input. Class `ScheduleTargetInput` supports free form 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:
164171

165172
```ts
166173
const input = ScheduleTargetInput.fromObject({
@@ -182,14 +189,14 @@ const text = `Attempt number: ${ContextAttribute.attemptNumber}`;
182189
const input = ScheduleTargetInput.fromText(text);
183190
```
184191

185-
### Specifying Execution Role
192+
### Specifying an execution role
186193

187194
An execution role is an IAM role that EventBridge Scheduler assumes in order to interact with other AWS services on your behalf.
188195

189196
The classes for templated schedule targets automatically create an IAM role with all the minimum necessary
190197
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.
193200

194201
```ts
195202
declare const fn: lambda.Function;
@@ -206,14 +213,14 @@ const target = new targets.LambdaInvoke(fn, {
206213
});
207214
```
208215

209-
### Specifying Encryption key
216+
### Specifying an encryption key
210217

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.
212219
EventBridge Scheduler supports two types of KMS keys: AWS owned keys, and customer managed keys.
213220

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.
217224

218225
```ts
219226
declare const key: kms.Key;
@@ -251,7 +258,7 @@ const schedule = new Schedule(this, 'Schedule', {
251258

252259
> Visit [Configuring flexible time windows](https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-schedule-flexible-time-windows.html) for more details.
253260
254-
## Error-handling
261+
## Error-handling
255262

256263
You can configure how your schedule handles failures, when EventBridge Scheduler is unable to deliver an event
257264
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, {
280287

281288
## Monitoring
282289

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
285292
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,
287294
EventBridge Scheduler publishes additional metrics when your schedule exhausts its retry policy.
288295

289296
### Metrics for all schedules

0 commit comments

Comments
 (0)