Class EventBridgePutEventsEntry

An entry to be sent to EventBridge.

Inheritance
object
EventBridgePutEventsEntry
Inherited Members
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class EventBridgePutEventsEntry : IEventBridgePutEventsEntry
Syntax (vb)
Public Class EventBridgePutEventsEntry Implements 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.StepFunctions;
             using Amazon.CDK.AWS.StepFunctions.Tasks;
             using Amazon.CDK.Interfaces.Events;

             IEventBusRef eventBusRef;
             TaskInput taskInput;

             var eventBridgePutEventsEntry = new EventBridgePutEventsEntry {
                 Detail = taskInput,
                 DetailType = "detailType",
                 Source = "source",

                 // the properties below are optional
                 EventBus = eventBusRef
             };

Synopsis

Constructors

EventBridgePutEventsEntry()

An entry to be sent to EventBridge.

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.

Constructors

EventBridgePutEventsEntry()

An entry to be sent to EventBridge.

public EventBridgePutEventsEntry()
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.StepFunctions;
             using Amazon.CDK.AWS.StepFunctions.Tasks;
             using Amazon.CDK.Interfaces.Events;

             IEventBusRef eventBusRef;
             TaskInput taskInput;

             var eventBridgePutEventsEntry = new EventBridgePutEventsEntry {
                 Detail = taskInput,
                 DetailType = "detailType",
                 Source = "source",

                 // the properties below are optional
                 EventBus = eventBusRef
             };

Properties

Detail

The event body.

public TaskInput Detail { get; set; }
Property Value

TaskInput

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.

public string DetailType { get; set; }
Property Value

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.

public IEventBusRef? EventBus { get; set; }
Property Value

IEventBusRef

Remarks

Default: - event is sent to account's default event bus

Source

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

public string Source { get; set; }
Property Value

string

Remarks

Example value: com.example.service

See: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-events.html

Implements