Back to Aws Doc Sdk Examples

EventBridge Scheduler code examples for the SDK for .NET

dotnetv3/EventBridge Scheduler/README.md

latest4.2 KB
Original Source

EventBridge Scheduler code examples for the SDK for .NET

Overview

Shows how to use the AWS SDK for .NET to work with Amazon EventBridge Scheduler.

<!--custom.overview.start--> <!--custom.overview.end-->

EventBridge Scheduler allows you to create, run, and manage tasks on a schedule from one central, managed service.

⚠ Important

  • Running this code might result in charges to your AWS account. For more details, see AWS Pricing and Free Tier.
  • Running the tests might result in charges to your AWS account.
  • 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.
  • This code is not tested in every AWS Region. For more information, see AWS Regional Services.
<!--custom.important.start--> <!--custom.important.end-->

Code examples

Prerequisites

For prerequisites, see the README in the dotnetv3 folder.

<!--custom.prerequisites.start--> <!--custom.prerequisites.end-->

Get started

Single actions

Code excerpts that show you how to call individual service functions.

Scenarios

Code examples that show you how to accomplish a specific task by calling multiple functions within the same service.

<!--custom.examples.start--> <!--custom.examples.end-->

Run the examples

Instructions

For general instructions to run the examples, see the README in the dotnetv3 folder.

Some projects might include a settings.json file. Before compiling the project, you can change these values to match your own account and resources. Alternatively, add a settings.local.json file with your local settings, which will be loaded automatically when the application runs.

After the example compiles, you can run it from the command line. To do so, navigate to the folder that contains the .csproj file and run the following command:

dotnet run

Alternatively, you can run the example from within your IDE.

<!--custom.instructions.start--> <!--custom.instructions.end-->

Hello EventBridge Scheduler

This example shows you how to get started using EventBridge Scheduler.

Scheduled Events

This example shows you how to do the following:

  • Deploy a CloudFormation stack with required resources.
  • Create a EventBridge Scheduler schedule group.
  • Create a one-time EventBridge Scheduler schedule with a flexible time window.
  • Create a recurring EventBridge Scheduler schedule with a specified rate.
  • Delete EventBridge Scheduler the schedule and schedule group.
  • Clean up resources and delete the stack.
<!--custom.scenario_prereqs.scheduler_ScheduledEventsScenario.start--> <!--custom.scenario_prereqs.scheduler_ScheduledEventsScenario.end--> <!--custom.scenarios.scheduler_ScheduledEventsScenario.start--> <!--custom.scenarios.scheduler_ScheduledEventsScenario.end-->

Tests

⚠ Running tests might result in charges to your AWS account.

To find instructions for running these tests, see the README in the dotnetv3 folder.

<!--custom.tests.start--> <!--custom.tests.end-->

Additional resources

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

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

SPDX-License-Identifier: Apache-2.0