AWS CodeCommit Construct Library
---
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:
repo = codecommit.Repository(self, "Repository",
repository_name="MyRepositoryName",
description="Some description."
)
Use the repositoryCloneUrlHttp, repositoryCloneUrlSsh or repositoryCloneUrlGrc
property to clone your repository.
To add an Amazon SNS trigger to your repository:
# repo: codecommit.Repository
# 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:
repo = codecommit.Repository(self, "Repository",
repository_name="MyRepositoryName",
code=codecommit.Code.from_directory(path.join(__dirname, "directory/"), "develop")
)
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 aws_cdk.aws_sns as sns
import aws_cdk.aws_events_targets as targets
# repo: codecommit.Repository
# project: codebuild.PipelineProject
# my_topic: sns.Topic
# starts a CodeBuild project when a commit is pushed to the "master" branch of the repo
repo.on_commit("CommitToMaster",
target=targets.CodeBuildProject(project),
branches=["master"]
)
# publishes a message to an Amazon SNS topic when a comment is made on a pull request
rule = repo.on_comment_on_pull_request("CommentOnPullRequest",
target=targets.SnsTopic(my_topic)
)
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 aws_cdk.aws_chatbot as chatbot
# repository: codecommit.Repository
target = chatbot.SlackChannelConfiguration(self, "MySlackChannel",
slack_channel_configuration_name="YOUR_CHANNEL_NAME",
slack_workspace_id="YOUR_SLACK_WORKSPACE_ID",
slack_channel_id="YOUR_SLACK_CHANNEL_ID"
)
rule = repository.notify_on_pull_request_created("NotifyOnPullRequestCreated", target)
2 maintainers
Metadata
2 maintainers
Release files for aws-cdk.aws-codecommit 1.204.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| aws-cdk.aws-codecommit-1.204.0.tar.gz | 106.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| aws_cdk.aws_codecommit-1.204.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 210.7 kB
Release files / aws-cdk.aws-codecommit-1.204.0.tar.gz
| Download URL | aws-cdk.aws-codecommit-1.204.0.tar.gz |
|---|---|
| Size | 106.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
301fcd774b09f3b4ed720afbc00f0888e3e8d22f8fc355a9a859cf1ba95ea118
|
|
BLAKE2b-256 checksum How to use checksums |
3f87d35d976c451d36c17b7dcbcb6663f62b5d5867e72a3d9b92f4e9231f3f3b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.2
|
Release files / aws_cdk.aws_codecommit-1.204.0-py3-none-any.whl
| Download URL | aws_cdk.aws_codecommit-1.204.0-py3-none-any.whl |
|---|---|
| Size | 104.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7a091a7c8c740a72a6ed3d619f98147e2ea12cfade7077e24c70a4f0721fd951
|
|
BLAKE2b-256 checksum How to use checksums |
a808a416daa0e5ee5662b0fee0b0893012a8ef1a3292e1bf435cc13a7c007980
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.2
|
