Package software.amazon.awscdk.services.codecommit

Interface OnCommitOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, OnEventOptions

All Known Implementing Classes:

OnCommitOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:38.259Z")
@Stability(Stable)
public interface OnCommitOptions
extends software.amazon.jsii.JsiiSerializable, OnEventOptions

Options for the onCommit() method.

Example:

 import software.amazon.awscdk.services.codecommit.*;
 import software.amazon.awscdk.services.events.targets.*;
 Repository repo;
 Topic myTopic = new Topic(this, "Topic");
 repo.onCommit("OnCommit", OnCommitOptions.builder()
         .target(new SnsTopic(myTopic))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	OnCommitOptions.Builder	A builder for OnCommitOptions
static final class	OnCommitOptions.Jsii$Proxy	An implementation for OnCommitOptions

Method Summary

Modifier and Type	Method	Description
static OnCommitOptions.Builder	builder()
default List<String>	getBranches()	The branch to monitor.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.events.OnEventOptions

getDescription, getEventPattern, getRuleName, getTarget

Method Details

getBranches

@Stability(Stable)
@Nullable
default List<String> getBranches()

The branch to monitor.

Default: - All branches

builder

@Stability(Stable)
static OnCommitOptions.Builder builder()

Returns:

a OnCommitOptions.Builder of OnCommitOptions