aws-cdk-lib.aws_codecommit.OnCommitOptions

interface OnCommitOptions

LanguageType name
.NETAmazon.CDK.AWS.CodeCommit.OnCommitOptions
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscodecommit#OnCommitOptions
Javasoftware.amazon.awscdk.services.codecommit.OnCommitOptions
Pythonaws_cdk.aws_codecommit.OnCommitOptions
TypeScript (source)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

NameTypeDescription
branches?string[]The branch to monitor.
crossStackScope?ConstructThe scope to use if the source of the rule and its target are in different Stacks (but in the same account & region).
description?stringA description of the rule's purpose.
eventPattern?EventPatternAdditional restrictions for the event to route to the specified target.
ruleName?stringA name for the rule.
target?IRuleTargetThe 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: EventPattern (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.

See also: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html


ruleName?

Type: string (optional, default: AWS CloudFormation generates a unique physical ID.)

A name for the rule.


target?

Type: IRuleTarget (optional, default: No target is added to the rule. Use addTarget() to add a target.)

The target to register for the event.