Skip to content

Commit fba973d

Browse files
committed
updated main readme
1 parent d808671 commit fba973d

File tree

1 file changed

+50
-6
lines changed

1 file changed

+50
-6
lines changed

javav2/example_code/scheduler/README.md

Lines changed: 50 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# Data Firehose code examples for the SDK for Java 2.x
1+
# EventBridge Scheduler code examples for the SDK for Java 2.x
22

33
## Overview
44

5-
Shows how to use the AWS SDK for Java 2.x to work with Amazon Data Firehose.
5+
Shows how to use the AWS SDK for Java 2.x to work with Amazon EventBridge Scheduler.
66

77
<!--custom.overview.start-->
88
<!--custom.overview.end-->
99

10-
_Data Firehose is a fully managed service for delivering real-time streaming data to AWS destinations and third-party HTTP endpoints._
10+
_EventBridge Scheduler allows you to create, run, and manage tasks on a schedule from one central, managed service._
1111

1212
## ⚠ Important
1313

@@ -29,6 +29,28 @@ For prerequisites, see the [README](../../README.md#Prerequisites) in the `javav
2929
<!--custom.prerequisites.start-->
3030
<!--custom.prerequisites.end-->
3131

32+
### Get started
33+
34+
- [Hello EventBridge Scheduler](src/main/java/com/example/eventbrideschedule/HelloScheduler.java#L6) (`ListSchedules`)
35+
36+
37+
### Single actions
38+
39+
Code excerpts that show you how to call individual service functions.
40+
41+
- [CreateSchedule](src/main/java/com/example/eventbrideschedule/scenario/EventbridgeSchedulerActions.java#L96)
42+
- [CreateScheduleGroup](src/main/java/com/example/eventbrideschedule/scenario/EventbridgeSchedulerActions.java#L68)
43+
- [DeleteSchedule](src/main/java/com/example/eventbrideschedule/scenario/EventbridgeSchedulerActions.java#L191)
44+
- [DeleteScheduleGroup](src/main/java/com/example/eventbrideschedule/scenario/EventbridgeSchedulerActions.java#L166)
45+
46+
### Scenarios
47+
48+
Code examples that show you how to accomplish a specific task by calling multiple
49+
functions within the same service.
50+
51+
- [Scheduled Events workflow](src/main/java/com/example/eventbrideschedule/scenario/EventbridgeSchedulerScenario.java)
52+
53+
3254
<!--custom.examples.start-->
3355
<!--custom.examples.end-->
3456

@@ -40,7 +62,29 @@ For prerequisites, see the [README](../../README.md#Prerequisites) in the `javav
4062
<!--custom.instructions.start-->
4163
<!--custom.instructions.end-->
4264

65+
#### Hello EventBridge Scheduler
66+
67+
This example shows you how to get started using EventBridge Scheduler.
68+
69+
70+
71+
#### Scheduled Events workflow
72+
73+
This example shows you how to do the following:
74+
75+
- Deploy a CloudFormation stack with required resources.
76+
- Create a EventBridge Scheduler schedule group.
77+
- Create a one-time EventBridge Scheduler schedule with a flexible time window.
78+
- Create a recurring EventBridge Scheduler schedule with a specified rate.
79+
- Delete EventBridge Scheduler the schedule and schedule group.
80+
- Clean up resources and delete the stack.
81+
82+
<!--custom.scenario_prereqs.scheduler_ScheduledEventsWorkflow.start-->
83+
<!--custom.scenario_prereqs.scheduler_ScheduledEventsWorkflow.end-->
84+
4385

86+
<!--custom.scenarios.scheduler_ScheduledEventsWorkflow.start-->
87+
<!--custom.scenarios.scheduler_ScheduledEventsWorkflow.end-->
4488

4589
### Tests
4690

@@ -57,9 +101,9 @@ in the `javav2` folder.
57101

58102
## Additional resources
59103

60-
- [Data Firehose User Guide](https://docs.aws.amazon.com/firehose/latest/dev/what-is-this-service.html)
61-
- [Data Firehose API Reference](https://docs.aws.amazon.com/firehose/latest/APIReference/Welcome.html)
62-
- [SDK for Java 2.x Data Firehose reference](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/firehose/package-summary.html)
104+
- [EventBridge Scheduler User Guide](https://docs.aws.amazon.com/scheduler/latest/userguide/intro.html)
105+
- [EventBridge Scheduler API Reference](https://docs.aws.amazon.com/scheduler/latest/apireference/Welcome.html)
106+
- [SDK for Java 2.x EventBridge Scheduler reference](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/firehose/package-summary.html)
63107

64108
<!--custom.resources.start-->
65109
<!--custom.resources.end-->

0 commit comments

Comments
 (0)