interface OnCommitOptions
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.CodeCommit.OnCommitOptions |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awscodecommit#OnCommitOptions |
![]() | software.amazon.awscdk.services.codecommit.OnCommitOptions |
![]() | aws_cdk.aws_codecommit.OnCommitOptions |
![]() | aws-cdk-lib » aws_codecommit » OnCommitOptions |
Options for the onCommit() method.
Example
import * as codecommit from 'aws-cdk-lib/aws-codecommit';
import * as targets from 'aws-cdk-lib/aws-events-targets';
declare const repo: codecommit.Repository;
const myTopic = new sns.Topic(this, 'Topic');
repo.onCommit('OnCommit', {
target: new targets.SnsTopic(myTopic),
});
Properties
Name | Type | Description |
---|---|---|
branches? | string[] | The branch to monitor. |
cross | Construct | The scope to use if the source of the rule and its target are in different Stacks (but in the same account & region). |
description? | string | A description of the rule's purpose. |
event | Event | Additional restrictions for the event to route to the specified target. |
rule | string | A name for the rule. |
target? | IRule | The target to register for the event. |
branches?
Type:
string[]
(optional, default: All branches)
The branch to monitor.
crossStackScope?
Type:
Construct
(optional, default: none (the main scope will be used, even for cross-stack Events))
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.
description?
Type:
string
(optional, default: No description)
A description of the rule's purpose.
eventPattern?
Type:
Event
(optional, default: No additional filtering based on an event pattern.)
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.
ruleName?
Type:
string
(optional, default: AWS CloudFormation generates a unique physical ID.)
A name for the rule.
target?
Type:
IRule
(optional, default: No target is added to the rule. Use addTarget()
to add a target.)
The target to register for the event.