OnEventOptions Struct
Standard set of options for onXxx event handlers on construct.
Example
ts
import * as lambda from 'aws-cdk-lib/aws-lambda';
import { LambdaFunction } from 'aws-cdk-lib/aws-events-targets';
const repo = new ecr.Repository(this, 'Repo');
const lambdaHandler = new lambda.Function(this, 'LambdaFunction', {
runtime: lambda.Runtime.PYTHON_3_12,
code: lambda.Code.fromInline('# dummy func'),
handler: 'index.handler',
});
repo.onEvent('OnEventTargetLambda', {
target: new LambdaFunction(lambdaHandler),
});
Properties
crossStackScopeConstructcross_stack_scopeConstructcrossStackScopeConstructCrossStackScopeConstructCrossStackScopeConstruct= none (the main scope will be use…#The scope to use if the source of the rule and its target are in different Stacks (but in the same account & region).
This helps dealing with cycles that often arise in these situations.
default
Default: none (the main scope will be used, even for cross-stack Events)
descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string= No description#A description of the rule's purpose.
eventPatternEventPatternevent_patternEventPatterneventPatternEventPatternEventPatternEventPatternEventPatternEventPattern= No additional filtering based on…#Additional restrictions for the event to route to the specified target.
The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering.
default
Default: No additional filtering based on an event pattern.
ruleNamestringrule_namestrruleNameStringRuleNamestringRuleName*string= AWS CloudFormation generates a u…#A name for the rule.
default
Default: AWS CloudFormation generates a unique physical ID.
targetIRuleTargettargetIRuleTargettargetIRuleTargetTargetIRuleTargetTargetIRuleTarget= No target is added to the rule. …#The target to register for the event.
default
Default: No target is added to the rule. Use addTarget() to add a target.