Interface IEventBridgePutEventsEntry
An entry to be sent to EventBridge.
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.AWS.StepFunctions.Tasks.dll
Syntax (csharp)
public interface IEventBridgePutEventsEntry
Syntax (vb)
Public Interface IEventBridgePutEventsEntry
Remarks
See: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEventsRequestEntry.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Events;
using Amazon.CDK.AWS.StepFunctions;
using Amazon.CDK.AWS.StepFunctions.Tasks;
EventBus eventBus;
TaskInput taskInput;
var eventBridgePutEventsEntry = new EventBridgePutEventsEntry {
Detail = taskInput,
DetailType = "detailType",
Source = "source",
// the properties below are optional
EventBus = eventBus
};
Synopsis
Properties
Detail | The event body. |
DetailType | Used along with the source field to help identify the fields and values expected in the detail field. |
EventBus | The event bus the entry will be sent to. |
Source | The service or application that caused this event to be generated. |
Properties
Detail
The event body.
TaskInput Detail { get; }
Property Value
Remarks
Can either be provided as an object or as a JSON-serialized string
Examples
TaskInput.FromText("{\"instance-id\": \"i-1234567890abcdef0\", \"state\": \"terminated\"}");
TaskInput.FromObject(new Dictionary<string, object> { { "Message", "Hello from Step Functions" } });
TaskInput.FromJsonPathAt("$.EventDetail");
DetailType
Used along with the source field to help identify the fields and values expected in the detail field.
string DetailType { get; }
Property Value
System.String
Remarks
For example, events by CloudTrail have detail type "AWS API Call via CloudTrail"
See: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-events.html
EventBus
The event bus the entry will be sent to.
virtual IEventBus EventBus { get; }
Property Value
Remarks
Default: - event is sent to account's default event bus
Source
The service or application that caused this event to be generated.
string Source { get; }
Property Value
System.String
Remarks
Example value: com.example.service
See: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-events.html