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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.310Z")
 @Stability(value=Stable)
public interface OnEventOptions
extends software.amazon.jsii.JsiiSerializable, EventCommonOptions

Standard set of options for `onXxx` event handlers on construct.

Example:

 // Lambda function containing logic that evaluates compliance with the rule.
 Function evalComplianceFn = Function.Builder.create(this, "CustomFunction")
         .code(AssetCode.fromInline("exports.handler = (event) => console.log(event);"))
         .handler("index.handler")
         .runtime(Runtime.NODEJS_14_X)
         .build();
 // A custom rule that runs on configuration changes of EC2 instances
 CustomRule customRule = CustomRule.Builder.create(this, "Custom")
         .configurationChanges(true)
         .lambdaFunction(evalComplianceFn)
         .ruleScope(RuleScope.fromResource(ResourceType.EC2_INSTANCE))
         .build();
 // A rule to detect stack drifts
 CloudFormationStackDriftDetectionCheck driftRule = new CloudFormationStackDriftDetectionCheck(this, "Drift");
 // Topic to which compliance notification events will be published
 Topic complianceTopic = new Topic(this, "ComplianceTopic");
 // Send notification on compliance change events
 driftRule.onComplianceChange("ComplianceChange", OnEventOptions.builder()
         .target(new SnsTopic(complianceTopic))
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and 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 Detail

getTarget

@Stability(value=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(value=Stable)
static OnEventOptions.Builder builder()

Specified by:

builder in interface EventCommonOptions

Returns:

a OnEventOptions.Builder of OnEventOptions