Package software.amazon.awscdk.services.scheduler.targets.alpha

Class EventBridgePutEvents.Builder

java.lang.Object

software.amazon.awscdk.services.scheduler.targets.alpha.EventBridgePutEvents.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<EventBridgePutEvents>

Enclosing class:

EventBridgePutEvents

@Stability(Experimental)
public static final class EventBridgePutEvents.Builder
extends Object
implements software.amazon.jsii.Builder<EventBridgePutEvents>

(experimental) A fluent builder for EventBridgePutEvents.

Method Summary

Modifier and Type	Method	Description
EventBridgePutEvents	build()
static EventBridgePutEvents.Builder	create(ScheduleTargetBaseProps props)
EventBridgePutEvents.Builder	detail(ScheduleTargetInput detail)	(experimental) The event body.
EventBridgePutEvents.Builder	detailType(String detailType)	(experimental) Used along with the source field to help identify the fields and values expected in the detail field.
EventBridgePutEvents.Builder	eventBus(IEventBus eventBus)	(experimental) The event bus the entry will be sent to.
EventBridgePutEvents.Builder	source(String source)	(experimental) The service or application that caused this event to be generated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Experimental)
public static EventBridgePutEvents.Builder create(ScheduleTargetBaseProps props)

Parameters:

props - This parameter is required.

Returns:

a new instance of EventBridgePutEvents.Builder.

detail

@Stability(Experimental)
public EventBridgePutEvents.Builder detail(ScheduleTargetInput detail)

(experimental) 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(Map.of("Message", "Hello from a friendly event :)"));
 

Parameters:

detail - The event body. This parameter is required.

Returns:

this

detailType

@Stability(Experimental)
public EventBridgePutEvents.Builder detailType(String detailType)

(experimental) 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"

Parameters:

detailType - Used along with the source field to help identify the fields and values expected in the detail field. This parameter is required.

Returns:

this

See Also:

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

eventBus

@Stability(Experimental)
public EventBridgePutEvents.Builder eventBus(IEventBus eventBus)

(experimental) The event bus the entry will be sent to.

Parameters:

eventBus - The event bus the entry will be sent to. This parameter is required.

Returns:

this

source

@Stability(Experimental)
public EventBridgePutEvents.Builder source(String source)

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

Example value: com.example.service

Parameters:

source - The service or application that caused this event to be generated. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Experimental)
public EventBridgePutEvents build()

Specified by:

build in interface software.amazon.jsii.Builder<EventBridgePutEvents>

Returns:

a newly built instance of EventBridgePutEvents.