Skip to content

Commit ab72182

Browse files
scmacdonscmacdon
authored
Add EventBridge Scheduler Java examples (#6973)
1 parent 6dc1b78 commit ab72182

File tree

12 files changed

+1586
-0
lines changed

12 files changed

+1586
-0
lines changed

‎.doc_gen/metadata/scheduler_metadata.yaml‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@ scheduler_hello:
44
synopsis: get started using &EVS;.
55
category: Hello
66
languages:
7+
Java:
8+
versions:
9+
- sdk_version: 2
10+
github: javav2/example_code/scheduler
11+
excerpts:
12+
- description:
13+
snippet_tags:
14+
- scheduler.javav2.hello.main
715
.NET:
816
versions:
917
- sdk_version: 3
@@ -17,6 +25,14 @@ scheduler_hello:
1725
scheduler: {ListSchedules}
1826
scheduler_CreateSchedule:
1927
languages:
28+
Java:
29+
versions:
30+
- sdk_version: 2
31+
github: javav2/example_code/scheduler
32+
excerpts:
33+
- description:
34+
snippet_tags:
35+
- scheduler.javav2.create.schedule.main
2036
.NET:
2137
versions:
2238
- sdk_version: 3
@@ -30,6 +46,14 @@ scheduler_CreateSchedule:
3046
scheduler: {CreateSchedule}
3147
scheduler_CreateScheduleGroup:
3248
languages:
49+
Java:
50+
versions:
51+
- sdk_version: 2
52+
github: javav2/example_code/scheduler
53+
excerpts:
54+
- description:
55+
snippet_tags:
56+
- scheduler.javav2.create.schedule.group.main
3357
.NET:
3458
versions:
3559
- sdk_version: 3
@@ -52,10 +76,26 @@ scheduler_DeleteSchedule:
5276
genai: most
5377
snippet_tags:
5478
- Scheduler.dotnetv3.DeleteSchedule
79+
Java:
80+
versions:
81+
- sdk_version: 2
82+
github: javav2/example_code/scheduler
83+
excerpts:
84+
- description:
85+
snippet_tags:
86+
- scheduler.javav2.delete.schedule.main
5587
services:
5688
scheduler: {DeleteSchedule}
5789
scheduler_DeleteScheduleGroup:
5890
languages:
91+
Java:
92+
versions:
93+
- sdk_version: 2
94+
github: javav2/example_code/scheduler
95+
excerpts:
96+
- description:
97+
snippet_tags:
98+
- scheduler.javav2.delete.schedule.group.main
5999
.NET:
60100
versions:
61101
- sdk_version: 3
@@ -79,6 +119,19 @@ scheduler_ScheduledEventsWorkflow:
79119
- Clean up resources and delete the stack.
80120
category: Scenarios
81121
languages:
122+
Java:
123+
versions:
124+
- sdk_version: 2
125+
github: javav2/example_code/scheduler
126+
excerpts:
127+
- description: Run the workflow.
128+
genai: most
129+
snippet_tags:
130+
- scheduler.javav2.scenario.main
131+
- description: Wrapper for service operations.
132+
genai: most
133+
snippet_tags:
134+
- scheduler.javav2.actions.main
82135
.NET:
83136
versions:
84137
- sdk_version: 3

‎javav2/example_code/scheduler/.gitignore‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
target/
2+
!.mvn/wrapper/maven-wrapper.jar
3+
!**/src/main/**/target/
4+
!**/src/test/**/target/
5+
6+
### IntelliJ IDEA ###
7+
.idea/modules.xml
8+
.idea/jarRepositories.xml
9+
.idea/compiler.xml
10+
.idea/libraries/
11+
*.iws
12+
*.iml
13+
*.ipr
14+
15+
### Eclipse ###
16+
.apt_generated
17+
.classpath
18+
.factorypath
19+
.project
20+
.settings
21+
.springBeans
22+
.sts4-cache
23+
24+
### NetBeans ###
25+
/nbproject/private/
26+
/nbbuild/
27+
/dist/
28+
/nbdist/
29+
/.nb-gradle/
30+
build/
31+
!**/src/main/**/build/
32+
!**/src/test/**/build/
33+
34+
### VS Code ###
35+
.vscode/
36+
37+
### Mac OS ###
38+
.DS_Store

‎javav2/example_code/scheduler/README.md‎

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
# EventBridge Scheduler code examples for the SDK for Java 2.x
2+
3+
## Overview
4+
5+
Shows how to use the AWS SDK for Java 2.x to work with Amazon EventBridge Scheduler.
6+
7+
<!--custom.overview.start-->
8+
<!--custom.overview.end-->
9+
10+
_EventBridge Scheduler allows you to create, run, and manage tasks on a schedule from one central, managed service._
11+
12+
## ⚠ Important
13+
14+
* Running this code might result in charges to your AWS account. For more details, see [AWS Pricing](https://aws.amazon.com/pricing/) and [Free Tier](https://aws.amazon.com/free/).
15+
* Running the tests might result in charges to your AWS account.
16+
* We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see [Grant least privilege](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege).
17+
* This code is not tested in every AWS Region. For more information, see [AWS Regional Services](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services).
18+
19+
<!--custom.important.start-->
20+
<!--custom.important.end-->
21+
22+
## Code examples
23+
24+
### Prerequisites
25+
26+
For prerequisites, see the [README](../../README.md#Prerequisites) in the `javav2` folder.
27+
28+
29+
<!--custom.prerequisites.start-->
30+
<!--custom.prerequisites.end-->
31+
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#L104)
42+
- [CreateScheduleGroup](src/main/java/com/example/eventbrideschedule/scenario/EventbridgeSchedulerActions.java#L70)
43+
- [DeleteSchedule](src/main/java/com/example/eventbrideschedule/scenario/EventbridgeSchedulerActions.java#L212)
44+
- [DeleteScheduleGroup](src/main/java/com/example/eventbrideschedule/scenario/EventbridgeSchedulerActions.java#L182)
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+
54+
<!--custom.examples.start-->
55+
<!--custom.examples.end-->
56+
57+
## Run the examples
58+
59+
### Instructions
60+
61+
62+
<!--custom.instructions.start-->
63+
<!--custom.instructions.end-->
64+
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+
85+
86+
<!--custom.scenarios.scheduler_ScheduledEventsWorkflow.start-->
87+
<!--custom.scenarios.scheduler_ScheduledEventsWorkflow.end-->
88+
89+
### Tests
90+
91+
⚠ Running tests might result in charges to your AWS account.
92+
93+
94+
To find instructions for running these tests, see the [README](../../README.md#Tests)
95+
in the `javav2` folder.
96+
97+
98+
99+
<!--custom.tests.start-->
100+
<!--custom.tests.end-->
101+
102+
## Additional resources
103+
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)
107+
108+
<!--custom.resources.start-->
109+
<!--custom.resources.end-->
110+
111+
---
112+
113+
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
114+
115+
SPDX-License-Identifier: Apache-2.0

0 commit comments

Comments
 (0)