interface EventBridgePutEventsEntry

Language	Type name
.NET	`Amazon.CDK.AWS.Scheduler.Targets.EventBridgePutEventsEntry`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsschedulertargets#EventBridgePutEventsEntry`
Java	`software.amazon.awscdk.services.scheduler.targets.EventBridgePutEventsEntry`
Python	`aws_cdk.aws_scheduler_targets.EventBridgePutEventsEntry`
TypeScript (source)	`aws-cdk-lib` » `aws_scheduler_targets` » `EventBridgePutEventsEntry`

An entry to be sent to EventBridge.

Example

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),
});

Properties

Name	Type	Description
detail	`ScheduleTargetInput`	The event body.
detailType	`string`	Used along with the source field to help identify the fields and values expected in the detail field.
eventBus	`IEventBus`	The event bus the entry will be sent to.
source	`string`	The service or application that caused this event to be generated.

detail

Type: ScheduleTargetInput

The event body.

Can either be provided as an object or as a JSON-serialized string Example

ScheduleTargetInput.fromText('{"instance-id": "i-1234567890abcdef0", "state": "terminated"}');
ScheduleTargetInput.fromObject({ Message: 'Hello from a friendly event :)' });

detailType

Type: string

Used along with the source field to help identify the fields and values expected in the detail field.

For example, events by CloudTrail have detail type "AWS API Call via CloudTrail"

eventBus

Type: IEventBus

The event bus the entry will be sent to.

source

Type: string

The service or application that caused this event to be generated.

Example value: com.example.service

Select your cookie preferences