OnCommitOptions

class aws_cdk.aws_codecommit.OnCommitOptions(*, description=None, event_pattern=None, rule_name=None, target=None, branches=None)

Bases: aws_cdk.aws_events.OnEventOptions

Options for the onCommit() method.

Parameters
  • description (Optional[str]) – A description of the rule’s purpose. Default: - No description

  • event_pattern (Optional[EventPattern]) – 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: - No additional filtering based on an event pattern.

  • rule_name (Optional[str]) – A name for the rule. Default: AWS CloudFormation generates a unique physical ID.

  • target (Optional[IRuleTarget]) – The target to register for the event. Default: - No target is added to the rule. Use addTarget() to add a target.

  • branches (Optional[List[str]]) – The branch to monitor. Default: - All branches

Attributes

branches

The branch to monitor.

Default
  • All branches

Return type

Optional[List[str]]

description

A description of the rule’s purpose.

Default
  • No description

Return type

Optional[str]

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.

Default
  • No additional filtering based on an event pattern.

See

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

Return type

Optional[EventPattern]

rule_name

A name for the rule.

Default

AWS CloudFormation generates a unique physical ID.

Return type

Optional[str]

target

The target to register for the event.

Default
  • No target is added to the rule. Use addTarget() to add a target.

Return type

Optional[IRuleTarget]