Class EventBridgePutEventsEntry
(experimental) An entry to be sent to EventBridge.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Scheduler.Targets.Alpha
Assembly: Amazon.CDK.AWS.Scheduler.Targets.Alpha.dll
Syntax (csharp)
public class EventBridgePutEventsEntry : Object, IEventBridgePutEventsEntry
Syntax (vb)
Public Class EventBridgePutEventsEntry
Inherits Object
Implements IEventBridgePutEventsEntry
Remarks
Stability: Experimental
See: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEventsRequestEntry.html
ExampleMetadata: infused
Examples
using Amazon.CDK.AWS.Events;
var eventBus = new EventBus(this, "EventBus", new EventBusProps {
EventBusName = "DomainEvents"
});
var eventEntry = new EventBridgePutEventsEntry {
EventBus = eventBus,
Source = "PetService",
Detail = ScheduleTargetInput.FromObject(new Dictionary<string, string> { { "Name", "Fluffy" } }),
DetailType = "🐶"
};
new Schedule(this, "Schedule", new ScheduleProps {
Schedule = ScheduleExpression.Rate(Duration.Hours(1)),
Target = new EventBridgePutEvents(eventEntry, new ScheduleTargetBaseProps { })
});
Synopsis
Constructors
EventBridgePutEventsEntry() |
Properties
Detail | (experimental) The event body. |
DetailType | (experimental) Used along with the source field to help identify the fields and values expected in the detail field. |
EventBus | (experimental) The event bus the entry will be sent to. |
Source | (experimental) The service or application that caused this event to be generated. |
Constructors
EventBridgePutEventsEntry()
public EventBridgePutEventsEntry()
Properties
Detail
(experimental) The event body.
public ScheduleTargetInput Detail { get; set; }
Property Value
Remarks
Can either be provided as an object or as a JSON-serialized string
Stability: Experimental
Examples
ScheduleTargetInput.FromText("{\"instance-id\": \"i-1234567890abcdef0\", \"state\": \"terminated\"}");
ScheduleTargetInput.FromObject(new Dictionary<string, string> { { "Message", "Hello from a friendly event :)" } });
DetailType
(experimental) Used along with the source field to help identify the fields and values expected in the detail field.
public string DetailType { get; set; }
Property Value
System.String
Remarks
For example, events by CloudTrail have detail type "AWS API Call via CloudTrail"
Stability: Experimental
See: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-events.html
EventBus
(experimental) The event bus the entry will be sent to.
public IEventBus EventBus { get; set; }
Property Value
Remarks
Stability: Experimental
Source
(experimental) The service or application that caused this event to be generated.
public string Source { get; set; }
Property Value
System.String
Remarks
Example value: com.example.service
Stability: Experimental
See: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-events.html