Merge branch 'main' of https://github.com/go-to-k/aws-cdk into schedu…

…ler-targets-kinesis-stream
aws · mergify · Dec 4, 2023 · Nov 5, 2023 · Nov 5, 2023 · Nov 5, 2023
commit ed8b2ddcace3c47eb744d682036f6c153c685b73
diff --git a/packages/@aws-cdk/aws-scheduler-targets-alpha/README.md b/packages/@aws-cdk/aws-scheduler-targets-alpha/README.md
@@ -28,7 +28,9 @@ The following targets are supported:
 2. `targets.StepFunctionsStartExecution`: [Start an AWS Step Function](#start-an-aws-step-function)
 3. `targets.CodeBuildStartBuild`: [Start a CodeBuild job](#start-a-codebuild-job)
 4. `targets.SqsSendMessage`: [Send a Message to an Amazon SQS Queue](#send-a-message-to-sqs-queue)
-5. `targets.KinesisStreamPutRecord`: [Put a record to an Amazon Kinesis Data Streams](#put-a-record-to-an-amazon-kinesis-data-streams)
+5. `targets.SnsPublish`: [Publish messages to an Amazon SNS topic](#publish-messages-to-an-amazon-sns-topic)
+6. `targets.EventBridgePutEvents`: [Put Events on EventBridge](#send-events-to-an-eventbridge-event-bus)
+7. `targets.KinesisStreamPutRecord`: [Put a record to an Amazon Kinesis Data Streams](#put-a-record-to-an-amazon-kinesis-data-streams)
 
 ## Invoke a Lambda function
 
@@ -153,6 +155,59 @@ new Schedule(this, 'Schedule', {
 });
 ```
 
+## Publish messages to an Amazon SNS topic
+
+Use the `SnsPublish` target to publish messages to an Amazon SNS topic.
+
+The code snippets below create an event rule with a Amazon SNS topic as a target.
+It's called every hour by Amazon Event Bridge Scheduler with custom payload.
+
+```ts
+import * as sns from 'aws-cdk-lib/aws-sns';
+
+const topic = new sns.Topic(this, 'Topic');
+
+const payload = {
+  message: 'Hello scheduler!',
+};
+
+const target = new targets.SnsPublish(topic, {
+  input: ScheduleTargetInput.fromObject(payload),
+});
+
+new Schedule(this, 'Schedule', {
+  schedule: ScheduleExpression.rate(Duration.hours(1)),
+  target,
+});
+```
+
+## Send events to an EventBridge event bus
+
+Use the `EventBridgePutEvents` target to send events to an EventBridge event bus.
+
+The code snippet below creates an event rule with an EventBridge event bus as a target
+called every hour by Event Bridge Scheduler with a custom event payload.
+
+```ts
+import * as events from 'aws-cdk-lib/aws-events';
+
+const eventBus = new events.EventBus(this, 'EventBus', {
+  eventBusName: 'DomainEvents',
+});
+
+const eventEntry: targets.EventBridgePutEventsEntry = {
+  eventBus,
+  source: 'PetService',
+  detail: ScheduleTargetInput.fromObject({ Name: 'Fluffy' }),
+  detailType: '🐶',
+};
+
+new Schedule(this, 'Schedule', {
+  schedule: ScheduleExpression.rate(Duration.hours(1)),
+  target: new targets.EventBridgePutEvents(eventEntry, {}),
+});
+```
+
 ## Put a record to an Amazon Kinesis Data Streams
 
 Use the `KinesisStreamPutRecord` target to put a record to an Amazon Kinesis Data Streams.

diff --git a/packages/@aws-cdk/aws-scheduler-targets-alpha/lib/index.ts b/packages/@aws-cdk/aws-scheduler-targets-alpha/lib/index.ts
@@ -1,6 +1,8 @@
 export * from './codebuild-start-build';
+export * from './event-bridge-put-events';
 export * from './kinesis-stream-put-record';
 export * from './lambda-invoke';
+export * from './sns-publish';
 export * from './sqs-send-message';
 export * from './stepfunctions-start-execution';
 export * from './target';