software.amazon.awscdk.services.codecommit

Interface IRepository.Jsii$Default

All Superinterfaces:

IConstruct, IConstruct.Jsii$Default, IDependable, IDependable.Jsii$Default, INotificationRuleSource, INotificationRuleSource.Jsii$Default, IRepository, IResource, IResource.Jsii$Default

All Known Implementing Classes:

IRepository.Jsii$Proxy

Enclosing interface:

IRepository

public static interface IRepository.Jsii$Default
extends IRepository, IResource.Jsii$Default, INotificationRuleSource.Jsii$Default

Internal default implementation for IRepository.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.codecommit.IRepository

IRepository.Jsii$Default, IRepository.Jsii$Proxy

Method Summary

Modifier and Type	Method and Description
default void	applyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.
default NotificationRuleSourceConfig	bindAsNotificationRuleSource(software.constructs.Construct scope) Returns a source configuration for notification rule.
default ResourceEnvironment	getEnv() The environment this resource belongs to.
default ConstructNode	getNode() The construct tree node for this construct.
default java.lang.String	getRepositoryArn() The ARN of this Repository.
default java.lang.String	getRepositoryCloneUrlGrc() The HTTPS (GRC) clone URL.
default java.lang.String	getRepositoryCloneUrlHttp() The HTTP clone URL.
default java.lang.String	getRepositoryCloneUrlSsh() The SSH clone URL.
default java.lang.String	getRepositoryName() The human-visible name of this Repository.
default Stack	getStack() The stack in which this resource is defined.
default Grant	grant(IGrantable grantee, java.lang.String... actions) Grant the given principal identity permissions to perform the actions on this repository.
default Grant	grantPull(IGrantable grantee) Grant the given identity permissions to pull this repository.
default Grant	grantPullPush(IGrantable grantee) Grant the given identity permissions to pull and push this repository.
default Grant	grantRead(IGrantable grantee) Grant the given identity permissions to read this repository.
default INotificationRule	notifiyOnPullRequestMerged(java.lang.String id, INotificationRuleTarget target, NotificationRuleOptions options) Deprecated. this method has a typo in its name, use notifyOnPullRequestMerged instead
default INotificationRule	notifyOn(java.lang.String id, INotificationRuleTarget target, RepositoryNotifyOnOptions options) Defines a CodeStar Notification rule triggered when the project events specified by you are emitted.
default INotificationRule	notifyOnApprovalRuleOverridden(java.lang.String id, INotificationRuleTarget target, NotificationRuleOptions options) Defines a CodeStar Notification rule which triggers when an approval rule is overridden.
default INotificationRule	notifyOnApprovalStatusChanged(java.lang.String id, INotificationRuleTarget target, NotificationRuleOptions options) Defines a CodeStar Notification rule which triggers when an approval status is changed.
default INotificationRule	notifyOnBranchOrTagCreated(java.lang.String id, INotificationRuleTarget target, NotificationRuleOptions options) Defines a CodeStar Notification rule which triggers when a new branch or tag is created.
default INotificationRule	notifyOnBranchOrTagDeleted(java.lang.String id, INotificationRuleTarget target, NotificationRuleOptions options) Defines a CodeStar Notification rule which triggers when a branch or tag is deleted.
default INotificationRule	notifyOnPullRequestComment(java.lang.String id, INotificationRuleTarget target, NotificationRuleOptions options) Defines a CodeStar Notification rule which triggers when a comment is made on a pull request.
default INotificationRule	notifyOnPullRequestCreated(java.lang.String id, INotificationRuleTarget target, NotificationRuleOptions options) Defines a CodeStar Notification rule which triggers when a pull request is created.
default INotificationRule	notifyOnPullRequestMerged(java.lang.String id, INotificationRuleTarget target, NotificationRuleOptions options) Defines a CodeStar Notification rule which triggers when a pull request is merged.
default Rule	onCommentOnCommit(java.lang.String id, OnEventOptions options) Defines a CloudWatch event rule which triggers when a comment is made on a commit.
default Rule	onCommentOnPullRequest(java.lang.String id, OnEventOptions options) Defines a CloudWatch event rule which triggers when a comment is made on a pull request.
default Rule	onCommit(java.lang.String id, OnCommitOptions options) Defines a CloudWatch event rule which triggers when a commit is pushed to a branch.
default Rule	onEvent(java.lang.String id, OnEventOptions options) Defines a CloudWatch event rule which triggers for repository events.
default Rule	onPullRequestStateChange(java.lang.String id, OnEventOptions options) Defines a CloudWatch event rule which triggers when a pull request state is changed.
default Rule	onReferenceCreated(java.lang.String id, OnEventOptions options) Defines a CloudWatch event rule which triggers when a reference is created (i.e.
default Rule	onReferenceDeleted(java.lang.String id, OnEventOptions options) Defines a CloudWatch event rule which triggers when a reference is delete (i.e.
default Rule	onReferenceUpdated(java.lang.String id, OnEventOptions options) Defines a CloudWatch event rule which triggers when a reference is updated (i.e.
default Rule	onStateChange(java.lang.String id, OnEventOptions options) Defines a CloudWatch event rule which triggers when a "CodeCommit Repository State Change" event occurs.

Methods inherited from interface software.amazon.awscdk.services.codecommit.IRepository

notifiyOnPullRequestMerged, notifyOnApprovalRuleOverridden, notifyOnApprovalStatusChanged, notifyOnBranchOrTagCreated, notifyOnBranchOrTagDeleted, notifyOnPullRequestComment, notifyOnPullRequestCreated, notifyOnPullRequestMerged, onCommentOnCommit, onCommentOnPullRequest, onCommit, onEvent, onPullRequestStateChange, onReferenceCreated, onReferenceDeleted, onReferenceUpdated, onStateChange

Method Detail

getNode

default ConstructNode getNode()

The construct tree node for this construct.

Specified by:

getNode in interface IConstruct

Specified by:

getNode in interface IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

default ResourceEnvironment getEnv()

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

default Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getRepositoryArn

default java.lang.String getRepositoryArn()

The ARN of this Repository.

Specified by:

getRepositoryArn in interface IRepository

getRepositoryCloneUrlGrc

default java.lang.String getRepositoryCloneUrlGrc()

The HTTPS (GRC) clone URL.

HTTPS (GRC) is the protocol to use with git-remote-codecommit (GRC).

It is the recommended method for supporting connections made with federated access, identity providers, and temporary credentials.

Specified by:

getRepositoryCloneUrlGrc in interface IRepository

See Also:

https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-git-remote-codecommit.html

getRepositoryCloneUrlHttp

default java.lang.String getRepositoryCloneUrlHttp()

The HTTP clone URL.

Specified by:

getRepositoryCloneUrlHttp in interface IRepository

getRepositoryCloneUrlSsh

default java.lang.String getRepositoryCloneUrlSsh()

The SSH clone URL.

Specified by:

getRepositoryCloneUrlSsh in interface IRepository

getRepositoryName

default java.lang.String getRepositoryName()

The human-visible name of this Repository.

Specified by:

getRepositoryName in interface IRepository

applyRemovalPolicy

default void applyRemovalPolicy(RemovalPolicy policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Parameters:

policy - This parameter is required.

bindAsNotificationRuleSource

default NotificationRuleSourceConfig bindAsNotificationRuleSource(software.constructs.Construct scope)

Returns a source configuration for notification rule.

Specified by:

bindAsNotificationRuleSource in interface INotificationRuleSource

Specified by:

bindAsNotificationRuleSource in interface INotificationRuleSource.Jsii$Default

Parameters:

scope - This parameter is required.

grant

default Grant grant(IGrantable grantee,
                    java.lang.String... actions)

Grant the given principal identity permissions to perform the actions on this repository.

Specified by:

grant in interface IRepository

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

grantPull

default Grant grantPull(IGrantable grantee)

Grant the given identity permissions to pull this repository.

Specified by:

grantPull in interface IRepository

Parameters:

grantee - This parameter is required.

grantPullPush

default Grant grantPullPush(IGrantable grantee)

Grant the given identity permissions to pull and push this repository.

Specified by:

grantPullPush in interface IRepository

Parameters:

grantee - This parameter is required.

grantRead

default Grant grantRead(IGrantable grantee)

Grant the given identity permissions to read this repository.

Specified by:

grantRead in interface IRepository

Parameters:

grantee - This parameter is required.

notifiyOnPullRequestMerged

@Deprecated
default INotificationRule notifiyOnPullRequestMerged(java.lang.String id,
                                                                 INotificationRuleTarget target,
                                                                 NotificationRuleOptions options)

Deprecated. this method has a typo in its name, use notifyOnPullRequestMerged instead

(deprecated) Defines a CodeStar Notification rule which triggers when a pull request is merged.

Specified by:

notifiyOnPullRequestMerged in interface IRepository

Parameters:

id - This parameter is required.

target - This parameter is required.

options -

notifyOn

default INotificationRule notifyOn(java.lang.String id,
                                   INotificationRuleTarget target,
                                   RepositoryNotifyOnOptions options)

Defines a CodeStar Notification rule triggered when the project events specified by you are emitted. Similar to `onEvent` API.

You can also use the methods to define rules for the specific event emitted. eg: notifyOnPullRequstCreated.

Specified by:

notifyOn in interface IRepository

Parameters:

id - This parameter is required.

target - This parameter is required.

options - This parameter is required.

Returns:

CodeStar Notifications rule associated with this repository.

notifyOnApprovalRuleOverridden

default INotificationRule notifyOnApprovalRuleOverridden(java.lang.String id,
                                                         INotificationRuleTarget target,
                                                         NotificationRuleOptions options)

Defines a CodeStar Notification rule which triggers when an approval rule is overridden.

Specified by:

notifyOnApprovalRuleOverridden in interface IRepository

Parameters:

id - This parameter is required.

target - This parameter is required.

options -

notifyOnApprovalStatusChanged

default INotificationRule notifyOnApprovalStatusChanged(java.lang.String id,
                                                        INotificationRuleTarget target,
                                                        NotificationRuleOptions options)

Defines a CodeStar Notification rule which triggers when an approval status is changed.

Specified by:

notifyOnApprovalStatusChanged in interface IRepository

Parameters:

id - This parameter is required.

target - This parameter is required.

options -

notifyOnBranchOrTagCreated

default INotificationRule notifyOnBranchOrTagCreated(java.lang.String id,
                                                     INotificationRuleTarget target,
                                                     NotificationRuleOptions options)

Defines a CodeStar Notification rule which triggers when a new branch or tag is created.

Specified by:

notifyOnBranchOrTagCreated in interface IRepository

Parameters:

id - This parameter is required.

target - This parameter is required.

options -

notifyOnBranchOrTagDeleted

default INotificationRule notifyOnBranchOrTagDeleted(java.lang.String id,
                                                     INotificationRuleTarget target,
                                                     NotificationRuleOptions options)

Defines a CodeStar Notification rule which triggers when a branch or tag is deleted.

Specified by:

notifyOnBranchOrTagDeleted in interface IRepository

Parameters:

id - This parameter is required.

target - This parameter is required.

options -

notifyOnPullRequestComment

default INotificationRule notifyOnPullRequestComment(java.lang.String id,
                                                     INotificationRuleTarget target,
                                                     NotificationRuleOptions options)

Defines a CodeStar Notification rule which triggers when a comment is made on a pull request.

Specified by:

notifyOnPullRequestComment in interface IRepository

Parameters:

id - This parameter is required.

target - This parameter is required.

options -

notifyOnPullRequestCreated

default INotificationRule notifyOnPullRequestCreated(java.lang.String id,
                                                     INotificationRuleTarget target,
                                                     NotificationRuleOptions options)

Defines a CodeStar Notification rule which triggers when a pull request is created.

Specified by:

notifyOnPullRequestCreated in interface IRepository

Parameters:

id - This parameter is required.

target - This parameter is required.

options -

notifyOnPullRequestMerged

default INotificationRule notifyOnPullRequestMerged(java.lang.String id,
                                                    INotificationRuleTarget target,
                                                    NotificationRuleOptions options)

Defines a CodeStar Notification rule which triggers when a pull request is merged.

Specified by:

notifyOnPullRequestMerged in interface IRepository

Parameters:

id - This parameter is required.

target - This parameter is required.

options -

onCommentOnCommit

default Rule onCommentOnCommit(java.lang.String id,
                               OnEventOptions options)

Defines a CloudWatch event rule which triggers when a comment is made on a commit.

Specified by:

onCommentOnCommit in interface IRepository

Parameters:

id - This parameter is required.

options -

onCommentOnPullRequest

default Rule onCommentOnPullRequest(java.lang.String id,
                                    OnEventOptions options)

Defines a CloudWatch event rule which triggers when a comment is made on a pull request.

Specified by:

onCommentOnPullRequest in interface IRepository

Parameters:

id - This parameter is required.

options -

onCommit

default Rule onCommit(java.lang.String id,
                      OnCommitOptions options)

Defines a CloudWatch event rule which triggers when a commit is pushed to a branch.

Specified by:

onCommit in interface IRepository

Parameters:

id - This parameter is required.

options -

onEvent

default Rule onEvent(java.lang.String id,
                     OnEventOptions options)

Defines a CloudWatch event rule which triggers for repository events.

Use rule.addEventPattern(pattern) to specify a filter.

Specified by:

onEvent in interface IRepository

Parameters:

id - This parameter is required.

options -

onPullRequestStateChange

default Rule onPullRequestStateChange(java.lang.String id,
                                      OnEventOptions options)

Defines a CloudWatch event rule which triggers when a pull request state is changed.

Specified by:

onPullRequestStateChange in interface IRepository

Parameters:

id - This parameter is required.

options -

onReferenceCreated

default Rule onReferenceCreated(java.lang.String id,
                                OnEventOptions options)

Defines a CloudWatch event rule which triggers when a reference is created (i.e. a new branch/tag is created) to the repository.

Specified by:

onReferenceCreated in interface IRepository

Parameters:

id - This parameter is required.

options -

onReferenceDeleted

default Rule onReferenceDeleted(java.lang.String id,
                                OnEventOptions options)

Defines a CloudWatch event rule which triggers when a reference is delete (i.e. a branch/tag is deleted) from the repository.

Specified by:

onReferenceDeleted in interface IRepository

Parameters:

id - This parameter is required.

options -

onReferenceUpdated

default Rule onReferenceUpdated(java.lang.String id,
                                OnEventOptions options)

Defines a CloudWatch event rule which triggers when a reference is updated (i.e. a commit is pushed to an existing or new branch) from the repository.

Specified by:

onReferenceUpdated in interface IRepository

Parameters:

id - This parameter is required.

options -

onStateChange

default Rule onStateChange(java.lang.String id,
                           OnEventOptions options)

Defines a CloudWatch event rule which triggers when a "CodeCommit Repository State Change" event occurs.

Specified by:

onStateChange in interface IRepository

Parameters:

id - This parameter is required.

options -