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
### Issue # (if applicable)
Tracking: #31785
### Reason for this change
Improve README quality.
### Description of changes
Mostly grammar and formatting 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
+14-20Lines changed: 14 additions & 20 deletions
Original file line number
Diff line number
Diff line change
@@ -16,8 +16,7 @@
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
20
-
of millions of tasks across many AWS services without provisioning or managing underlying infrastructure.
19
+
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.
21
20
22
21
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
22
2.**Target**: A target is an API operation that EventBridge Scheduler calls on your behalf every time your schedule runs. EventBridge Scheduler
@@ -28,12 +27,8 @@ more than 6,000 API operations across over 270 AWS services.
28
27
3.**Schedule Group**: A schedule group is an Amazon EventBridge Scheduler resource that you use to organize your schedules. Your AWS account comes
29
28
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
29
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
-
schedules logically, access the schedule metrics and manage permissions at group granularity (see details below). Scheduling groups support tagging:
32
-
with EventBridge Scheduler, you apply tags to schedule groups, not to individual schedules to organize your resources.
33
-
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
-
36
-
> This module is in active development. Some features may not be implemented yet.
30
+
schedules logically, access the schedule metrics and manage permissions at group granularity (see details below). Schedule groups support tagging.
31
+
With EventBridge Scheduler, you apply tags to schedule groups, not to individual schedules to organize your resources.
37
32
38
33
## Defining a schedule
39
34
@@ -49,7 +44,7 @@ const target = new targets.LambdaInvoke(fn, {
description: 'This is a test schedule that invokes lambda function every 10 minutes.',
47
+
description: 'This is a test schedule that invokes a lambda function every 10 minutes.',
53
48
});
54
49
```
55
50
@@ -167,7 +162,7 @@ A list of supported targets can be found at `@aws-cdk/aws-scheduler-targets-alph
167
162
168
163
### Input
169
164
170
-
Targets can be invoked with a custom input. The `ScheduleTargetInput`class supports free-form text input and JSON-formatted object input:
165
+
Targets can be invoked with a custom input. The `ScheduleTargetInput`class supports free-form text input and JSON-formatted object input:
171
166
172
167
```ts
173
168
const input =ScheduleTargetInput.fromObject({
@@ -180,9 +175,9 @@ its respective value and deliver it to the target. See
180
175
[full list of supported context attributes](https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-schedule-context-attributes.html):
181
176
182
177
1.`ContextAttribute.scheduleArn()` – The ARN of the schedule.
183
-
2.`ContextAttribute.scheduledTime()` – The time you specified for the schedule to invoke its target, for example, 2022-03-22T18:59:43Z.
184
-
3.`ContextAttribute.executionId()` – The unique ID that EventBridge Scheduler assigns for each attempted invocation of a target, for example, d32c5kddcf5bb8c3.
185
-
4.`ContextAttribute.attemptNumber()` – A counter that identifies the attempt number for the current invocation, for example, 1.
178
+
2.`ContextAttribute.scheduledTime()` – The time you specified for the schedule to invoke its target, e.g., 2022-03-22T18:59:43Z.
179
+
3.`ContextAttribute.executionId()` – The unique ID that EventBridge Scheduler assigns for each attempted invocation of a target, e.g., d32c5kddcf5bb8c3.
180
+
4.`ContextAttribute.attemptNumber()` – A counter that identifies the attempt number for the current invocation, e.g., 1.
186
181
187
182
```ts
188
183
const text =`Attempt number: ${ContextAttribute.attemptNumber}`;
@@ -195,7 +190,7 @@ An execution role is an IAM role that EventBridge Scheduler assumes in order to
195
190
196
191
The classes for templated schedule targets automatically create an IAM role with all the minimum necessary
197
192
permissions to interact with the templated target. If you wish you may specify your own IAM role, then the templated targets
198
-
will grant minimal required permissions. For example, the target `LambdaInvoke` will grant the
193
+
will grant minimal required permissions. For example, the `LambdaInvoke` target will grant the
199
194
IAM execution role `lambda:InvokeFunction` permission to invoke the Lambda function.
> Visit[Data protection in Amazon EventBridge Scheduler](https://docs.aws.amazon.com/scheduler/latest/UserGuide/data-protection.html) for more details.
237
+
> See[Data protection in Amazon EventBridge Scheduler](https://docs.aws.amazon.com/scheduler/latest/UserGuide/data-protection.html) for more details.
243
238
244
239
## Configuring flexible time windows
245
240
246
241
You can configure flexible time windows by specifying the `timeWindow` property.
> Visit[Configuring flexible time windows](https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-schedule-flexible-time-windows.html) for more details.
254
+
> See[Configuring flexible time windows](https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-schedule-flexible-time-windows.html) for more details.
260
255
261
256
## Error-handling
262
257
@@ -295,8 +290,7 @@ EventBridge Scheduler publishes additional metrics when your schedule exhausts i
295
290
296
291
### Metrics for all schedules
297
292
298
-
Class `Schedule` provides static methods for accessing all schedules metrics with default configuration,
299
-
such as `metricAllErrors` for viewing errors when executing targets.
293
+
The `Schedule` class provides static methods for accessing all schedules metrics with default configuration, such as `metricAllErrors` for viewing errors when executing targets.
Copy file name to clipboardExpand all lines: packages/@aws-cdk/aws-scheduler-targets-alpha/README.md
+25-26Lines changed: 25 additions & 26 deletions
Original file line number
Diff line number
Diff line change
@@ -16,22 +16,21 @@
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
20
-
of millions of tasks across many AWS services without provisioning or managing underlying infrastructure.
19
+
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.
21
20
22
21
This library contains integration classes for Amazon EventBridge Scheduler to call any
23
-
number of supported AWS Services.
22
+
number of supported AWS Services.
24
23
25
24
The following targets are supported:
26
25
27
-
1.`targets.LambdaInvoke`: [Invoke an AWS Lambda function](#invoke-a-lambda-function))
26
+
1.`targets.LambdaInvoke`: [Invoke an AWS Lambda function](#invoke-a-lambda-function)
28
27
2.`targets.StepFunctionsStartExecution`: [Start an AWS Step Function](#start-an-aws-step-function)
29
28
3.`targets.CodeBuildStartBuild`: [Start a CodeBuild job](#start-a-codebuild-job)
30
-
4.`targets.SqsSendMessage`: [Send a Message to an Amazon SQS Queue](#send-a-message-to-sqs-queue)
29
+
4.`targets.SqsSendMessage`: [Send a Message to an Amazon SQS Queue](#send-a-message-to-an-sqs-queue)
31
30
5.`targets.SnsPublish`: [Publish messages to an Amazon SNS topic](#publish-messages-to-an-amazon-sns-topic)
32
31
6.`targets.EventBridgePutEvents`: [Put Events on EventBridge](#send-events-to-an-eventbridge-event-bus)
33
32
7.`targets.InspectorStartAssessmentRun`: [Start an Amazon Inspector assessment run](#start-an-amazon-inspector-assessment-run)
34
-
8.`targets.KinesisStreamPutRecord`: [Put a record to an Amazon Kinesis Data Streams](#put-a-record-to-an-amazon-kinesis-data-streams)
33
+
8.`targets.KinesisStreamPutRecord`: [Put a record to an Amazon Kinesis Data Stream](#put-a-record-to-an-amazon-kinesis-data-stream)
35
34
9.`targets.KinesisDataFirehosePutRecord`: [Put a record to a Kinesis Data Firehose](#put-a-record-to-a-kinesis-data-firehose)
36
35
10.`targets.CodePipelineStartPipelineExecution`: [Start a CodePipeline execution](#start-a-codepipeline-execution)
37
36
11.`targets.SageMakerStartPipelineExecution`: [Start a SageMaker pipeline execution](#start-a-sagemaker-pipeline-execution)
@@ -41,7 +40,7 @@ The following targets are supported:
41
40
Use the `LambdaInvoke` target to invoke a lambda function.
42
41
43
42
The code snippet below creates an event rule with a Lambda function as a target
44
-
called every hour by Event Bridge Scheduler with custom payload. You can optionally attach a
43
+
called every hour by EventBridge Scheduler with a custom payload. You can optionally attach a
45
44
[dead letter queue](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html).
0 commit comments