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.97.0 (build 729de35)",
date="2024-04-18T17:54:17.363Z")
@Stability(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_18_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
Modifier and TypeInterfaceDescriptionstatic final class
A builder forOnEventOptions
static final class
An implementation forOnEventOptions
-
Method Summary
Modifier and TypeMethodDescriptionstatic OnEventOptions.Builder
builder()
default IRuleTarget
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
The target to register for the event.Default: - No target is added to the rule. Use `addTarget()` to add a target.
-
builder
- Returns:
- a
OnEventOptions.Builder
ofOnEventOptions
-