software.amazon.awscdk.services.stepfunctions.tasks

Interface EventBridgePutEventsEntry

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

EventBridgePutEventsEntry.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.508Z")
 @Stability(value=Stable)
public interface EventBridgePutEventsEntry
extends software.amazon.jsii.JsiiSerializable

An entry to be sent to EventBridge.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.events.*;
 import software.amazon.awscdk.services.stepfunctions.*;
 import software.amazon.awscdk.services.stepfunctions.tasks.*;
 EventBus eventBus;
 TaskInput taskInput;
 EventBridgePutEventsEntry eventBridgePutEventsEntry = EventBridgePutEventsEntry.builder()
         .detail(taskInput)
         .detailType("detailType")
         .source("source")
         // the properties below are optional
         .eventBus(eventBus)
         .build();
 

See Also:

https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEventsRequestEntry.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	EventBridgePutEventsEntry.Builder A builder for EventBridgePutEventsEntry
static class	EventBridgePutEventsEntry.Jsii$Proxy An implementation for EventBridgePutEventsEntry

Method Summary

Modifier and Type	Method and Description
static EventBridgePutEventsEntry.Builder	builder()
TaskInput	getDetail() The event body.
String	getDetailType() Used along with the source field to help identify the fields and values expected in the detail field.
default IEventBus	getEventBus() The event bus the entry will be sent to.
String	getSource() The service or application that caused this event to be generated.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDetail

@Stability(value=Stable)
 @NotNull
TaskInput getDetail()

The event body.

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

Example:

 TaskInput.fromText("{\"instance-id\": \"i-1234567890abcdef0\", \"state\": \"terminated\"}");
 TaskInput.fromObject(Map.of("Message", "Hello from Step Functions"));
 TaskInput.fromJsonPathAt("$.EventDetail");
 

getDetailType

@Stability(value=Stable)
 @NotNull
String getDetailType()

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"

See Also:

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

getSource

@Stability(value=Stable)
 @NotNull
String getSource()

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

Example value: com.example.service

See Also:

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

getEventBus

@Stability(value=Stable)
 @Nullable
default IEventBus getEventBus()

The event bus the entry will be sent to.

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

builder

@Stability(value=Stable)
static EventBridgePutEventsEntry.Builder builder()

Returns:

a EventBridgePutEventsEntry.Builder of EventBridgePutEventsEntry