Package software.amazon.awscdk.services.codecommit


@Stability(Stable) @Deprecated package software.amazon.awscdk.services.codecommit
Deprecated.

AWS CodeCommit Construct Library

---

End-of-Support

AWS CDK v1 has reached End-of-Support on 2023-06-01. This package is no longer being updated, and users should migrate to AWS CDK v2.

For more information on how to migrate, see the Migrating to AWS CDK v2 guide.


AWS CodeCommit is a version control service that enables you to privately store and manage Git repositories in the AWS cloud.

For further information on CodeCommit, see the AWS CodeCommit documentation.

To add a CodeCommit Repository to your stack:

 Repository repo = Repository.Builder.create(this, "Repository")
         .repositoryName("MyRepositoryName")
         .description("Some description.")
         .build();
 

Use the repositoryCloneUrlHttp, repositoryCloneUrlSsh or repositoryCloneUrlGrc property to clone your repository.

To add an Amazon SNS trigger to your repository:

 Repository repo;
 
 
 // trigger is established for all repository actions on all branches by default.
 repo.notify("arn:aws:sns:*:123456789012:my_topic");
 

Add initial commit

It is possible to initialize the Repository via the Code class. It provides methods for loading code from a directory, .zip file and from a pre-created CDK Asset.

Example:

 Repository repo = Repository.Builder.create(this, "Repository")
         .repositoryName("MyRepositoryName")
         .code(Code.fromDirectory(join(__dirname, "directory/"), "develop"))
         .build();
 

Events

CodeCommit repositories emit Amazon CloudWatch events for certain activities. Use the repo.onXxx methods to define rules that trigger on these events and invoke targets as a result:

 import software.amazon.awscdk.services.sns.*;
 import software.amazon.awscdk.services.events.targets.*;
 
 Repository repo;
 PipelineProject project;
 Topic myTopic;
 
 
 // starts a CodeBuild project when a commit is pushed to the "master" branch of the repo
 repo.onCommit("CommitToMaster", OnCommitOptions.builder()
         .target(new CodeBuildProject(project))
         .branches(List.of("master"))
         .build());
 
 // publishes a message to an Amazon SNS topic when a comment is made on a pull request
 Rule rule = repo.onCommentOnPullRequest("CommentOnPullRequest", OnEventOptions.builder()
         .target(new SnsTopic(myTopic))
         .build());
 

CodeStar Notifications

To define CodeStar Notification rules for Repositories, use one of the notifyOnXxx() methods. They are very similar to onXxx() methods for CloudWatch events:

 import software.amazon.awscdk.services.chatbot.*;
 
 Repository repository;
 
 SlackChannelConfiguration target = SlackChannelConfiguration.Builder.create(this, "MySlackChannel")
         .slackChannelConfigurationName("YOUR_CHANNEL_NAME")
         .slackWorkspaceId("YOUR_SLACK_WORKSPACE_ID")
         .slackChannelId("YOUR_SLACK_CHANNEL_ID")
         .build();
 INotificationRule rule = repository.notifyOnPullRequestCreated("NotifyOnPullRequestCreated", target);
 
Deprecated: AWS CDK v1 has reached End-of-Support on 2023-06-01. This package is no longer being updated, and users should migrate to AWS CDK v2. For more information on how to migrate, see https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html