Skip to main content

The CDK Construct Library for AWS::CodeCommit

Project description

AWS CodeCommit Construct Library

---

cfn-resources: Stable

cdk-constructs: Stable


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)

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aws-cdk.aws-codecommit-1.190.0.tar.gz (106.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aws_cdk.aws_codecommit-1.190.0-py3-none-any.whl (105.1 kB view details)

Uploaded Python 3

File details

Details for the file aws-cdk.aws-codecommit-1.190.0.tar.gz.

File metadata

  • Download URL: aws-cdk.aws-codecommit-1.190.0.tar.gz
  • Upload date:
  • Size: 106.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.12

File hashes

Hashes for aws-cdk.aws-codecommit-1.190.0.tar.gz
Algorithm Hash digest
SHA256 d740ce3ab40ccfb24507b847eaf79d69caca730ea5b298a72bb759066934d6cc
MD5 8997fa3d07b80461c655184b25c050fc
BLAKE2b-256 b98b1379025e9d5052e4ad84bc4328e55b8fbcfcc34129d7e484ca2599c0df92

See more details on using hashes here.

File details

Details for the file aws_cdk.aws_codecommit-1.190.0-py3-none-any.whl.

File metadata

File hashes

Hashes for aws_cdk.aws_codecommit-1.190.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b3f8e35ac79d1b319488b8dcf3ebf8b781ae64cb2b559cdeec83180c4940e453
MD5 1c48fda937c0628f3d11e5c0016570ec
BLAKE2b-256 27d4e8f0006736db1a91eead769c5b48e8f3082d48537e380f2095f617180ae0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page