Package software.amazon.awscdk.services.events

Interface OnEventOptions

All Superinterfaces:

EventCommonOptions, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

OnCloudTrailBucketEventOptions, OnCloudTrailImagePushedOptions, OnCommitOptions, OnImageScanCompletedOptions

All Known Implementing Classes:

OnCloudTrailBucketEventOptions.Jsii$Proxy, OnCloudTrailImagePushedOptions.Jsii$Proxy, OnCommitOptions.Jsii$Proxy, OnEventOptions.Jsii$Proxy, OnImageScanCompletedOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-31T09:54:31.315Z")
@Stability(Stable)
public interface OnEventOptions
extends software.amazon.jsii.JsiiSerializable, EventCommonOptions

Standard set of options for onXxx event handlers on construct.

Example:

 import software.amazon.awscdk.services.lambda.*;
 import software.amazon.awscdk.services.events.targets.LambdaFunction;
 Repository repo = new Repository(this, "Repo");
 Function lambdaHandler = Function.Builder.create(this, "LambdaFunction")
         .runtime(Runtime.PYTHON_3_12)
         .code(Code.fromInline("# dummy func"))
         .handler("index.handler")
         .build();
 repo.onEvent("OnEventTargetLambda", OnEventOptions.builder()
         .target(new LambdaFunction(lambdaHandler))
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static OnEventOptions.Builder	builder()
default IRuleTarget	getTarget()	The target to register for the event.

Methods inherited from interface software.amazon.awscdk.services.events.EventCommonOptions

getCrossStackScope, getDescription, getEventPattern, getRuleName

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getTarget

@Stability(Stable)
@Nullable
default IRuleTarget getTarget()

The target to register for the event.

Default: - No target is added to the rule. Use `addTarget()` to add a target.

builder

@Stability(Stable)
static OnEventOptions.Builder builder()

Returns:

a OnEventOptions.Builder of OnEventOptions