Package software.amazon.awscdk.services.codecommit

Interface IRepository

All Superinterfaces:

IConstruct, software.constructs.IConstruct, IDependable, INotificationRuleSource, IResource, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IRepository.Jsii$Default

All Known Implementing Classes:

IRepository.Jsii$Proxy, Repository

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IRepository.Jsii$Default	Internal default implementation for IRepository.
static final class	IRepository.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
String	getRepositoryArn()	The ARN of this Repository.
String	getRepositoryCloneUrlGrc()	The HTTPS (GRC) clone URL.
String	getRepositoryCloneUrlHttp()	The HTTP clone URL.
String	getRepositoryCloneUrlSsh()	The SSH clone URL.
String	getRepositoryName()	The human-visible name of this Repository.
Grant	grant(IGrantable grantee, @NotNull String... actions)	Grant the given principal identity permissions to perform the actions on this repository.
Grant	grantPull(IGrantable grantee)	Grant the given identity permissions to pull this repository.
Grant	grantPullPush(IGrantable grantee)	Grant the given identity permissions to pull and push this repository.
Grant	grantRead(IGrantable grantee)	Grant the given identity permissions to read this repository.
INotificationRule	notifiyOnPullRequestMerged(String id, INotificationRuleTarget target)	Deprecated. this method has a typo in its name, use notifyOnPullRequestMerged instead
INotificationRule	notifiyOnPullRequestMerged(String id, INotificationRuleTarget target, NotificationRuleOptions options)	Deprecated. this method has a typo in its name, use notifyOnPullRequestMerged instead
INotificationRule	notifyOn(String id, INotificationRuleTarget target, RepositoryNotifyOnOptions options)	Defines a CodeStar Notification rule triggered when the project events specified by you are emitted.
INotificationRule	notifyOnApprovalRuleOverridden(String id, INotificationRuleTarget target)	Defines a CodeStar Notification rule which triggers when an approval rule is overridden.
INotificationRule	notifyOnApprovalRuleOverridden(String id, INotificationRuleTarget target, NotificationRuleOptions options)	Defines a CodeStar Notification rule which triggers when an approval rule is overridden.
INotificationRule	notifyOnApprovalStatusChanged(String id, INotificationRuleTarget target)	Defines a CodeStar Notification rule which triggers when an approval status is changed.
INotificationRule	notifyOnApprovalStatusChanged(String id, INotificationRuleTarget target, NotificationRuleOptions options)	Defines a CodeStar Notification rule which triggers when an approval status is changed.
INotificationRule	notifyOnBranchOrTagCreated(String id, INotificationRuleTarget target)	Defines a CodeStar Notification rule which triggers when a new branch or tag is created.
INotificationRule	notifyOnBranchOrTagCreated(String id, INotificationRuleTarget target, NotificationRuleOptions options)	Defines a CodeStar Notification rule which triggers when a new branch or tag is created.
INotificationRule	notifyOnBranchOrTagDeleted(String id, INotificationRuleTarget target)	Defines a CodeStar Notification rule which triggers when a branch or tag is deleted.
INotificationRule	notifyOnBranchOrTagDeleted(String id, INotificationRuleTarget target, NotificationRuleOptions options)	Defines a CodeStar Notification rule which triggers when a branch or tag is deleted.
INotificationRule	notifyOnPullRequestComment(String id, INotificationRuleTarget target)	Defines a CodeStar Notification rule which triggers when a comment is made on a pull request.
INotificationRule	notifyOnPullRequestComment(String id, INotificationRuleTarget target, NotificationRuleOptions options)	Defines a CodeStar Notification rule which triggers when a comment is made on a pull request.
INotificationRule	notifyOnPullRequestCreated(String id, INotificationRuleTarget target)	Defines a CodeStar Notification rule which triggers when a pull request is created.
INotificationRule	notifyOnPullRequestCreated(String id, INotificationRuleTarget target, NotificationRuleOptions options)	Defines a CodeStar Notification rule which triggers when a pull request is created.
INotificationRule	notifyOnPullRequestMerged(String id, INotificationRuleTarget target)	Defines a CodeStar Notification rule which triggers when a pull request is merged.
INotificationRule	notifyOnPullRequestMerged(String id, INotificationRuleTarget target, NotificationRuleOptions options)	Defines a CodeStar Notification rule which triggers when a pull request is merged.
Rule	onCommentOnCommit(String id)	Defines a CloudWatch event rule which triggers when a comment is made on a commit.
Rule	onCommentOnCommit(String id, OnEventOptions options)	Defines a CloudWatch event rule which triggers when a comment is made on a commit.
Rule	onCommentOnPullRequest(String id)	Defines a CloudWatch event rule which triggers when a comment is made on a pull request.
Rule	onCommentOnPullRequest(String id, OnEventOptions options)	Defines a CloudWatch event rule which triggers when a comment is made on a pull request.
Rule	onCommit(String id)	Defines a CloudWatch event rule which triggers when a commit is pushed to a branch.
Rule	onCommit(String id, OnCommitOptions options)	Defines a CloudWatch event rule which triggers when a commit is pushed to a branch.
Rule	onEvent(String id)	Defines a CloudWatch event rule which triggers for repository events.
Rule	onEvent(String id, OnEventOptions options)	Defines a CloudWatch event rule which triggers for repository events.
Rule	onPullRequestStateChange(String id)	Defines a CloudWatch event rule which triggers when a pull request state is changed.
Rule	onPullRequestStateChange(String id, OnEventOptions options)	Defines a CloudWatch event rule which triggers when a pull request state is changed.
Rule	onReferenceCreated(String id)	Defines a CloudWatch event rule which triggers when a reference is created (i.e.
Rule	onReferenceCreated(String id, OnEventOptions options)	Defines a CloudWatch event rule which triggers when a reference is created (i.e.
Rule	onReferenceDeleted(String id)	Defines a CloudWatch event rule which triggers when a reference is delete (i.e.
Rule	onReferenceDeleted(String id, OnEventOptions options)	Defines a CloudWatch event rule which triggers when a reference is delete (i.e.
Rule	onReferenceUpdated(String id)	Defines a CloudWatch event rule which triggers when a reference is updated (i.e.
Rule	onReferenceUpdated(String id, OnEventOptions options)	Defines a CloudWatch event rule which triggers when a reference is updated (i.e.
Rule	onStateChange(String id)	Defines a CloudWatch event rule which triggers when a "CodeCommit Repository State Change" event occurs.
Rule	onStateChange(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.core.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.services.codestarnotifications.INotificationRuleSource

bindAsNotificationRuleSource

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRepositoryArn

@Stability(Stable)
@NotNull
String getRepositoryArn()

The ARN of this Repository.

getRepositoryCloneUrlGrc

@Stability(Stable)
@NotNull
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.

See Also:

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

getRepositoryCloneUrlHttp

@Stability(Stable)
@NotNull
String getRepositoryCloneUrlHttp()

The HTTP clone URL.

getRepositoryCloneUrlSsh

@Stability(Stable)
@NotNull
String getRepositoryCloneUrlSsh()

The SSH clone URL.

getRepositoryName

@Stability(Stable)
@NotNull
String getRepositoryName()

The human-visible name of this Repository.

grant

@Stability(Stable)
@NotNull
Grant grant(@NotNull
 IGrantable grantee,
 @NotNull
 @NotNull String... actions)

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

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

grantPull

@Stability(Stable)
@NotNull
Grant grantPull(@NotNull
 IGrantable grantee)

Grant the given identity permissions to pull this repository.

Parameters:

grantee - This parameter is required.

grantPullPush

@Stability(Stable)
@NotNull
Grant grantPullPush(@NotNull
 IGrantable grantee)

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

Parameters:

grantee - This parameter is required.

grantRead

@Stability(Stable)
@NotNull
Grant grantRead(@NotNull
 IGrantable grantee)

Grant the given identity permissions to read this repository.

Parameters:

grantee - This parameter is required.

notifiyOnPullRequestMerged

@Stability(Deprecated)
@Deprecated
@NotNull
INotificationRule notifiyOnPullRequestMerged(@NotNull
 String id,
 @NotNull
 INotificationRuleTarget target,
 @Nullable
 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.

Parameters:

id - This parameter is required.

target - This parameter is required.

options -

notifiyOnPullRequestMerged

@Stability(Deprecated)
@Deprecated
@NotNull
INotificationRule notifiyOnPullRequestMerged(@NotNull
 String id,
 @NotNull
 INotificationRuleTarget target)

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.

Parameters:

id - This parameter is required.

target - This parameter is required.

notifyOn

@Stability(Stable)
@NotNull
INotificationRule notifyOn(@NotNull
 String id,
 @NotNull
 INotificationRuleTarget target,
 @NotNull
 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.

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

@Stability(Stable)
@NotNull
INotificationRule notifyOnApprovalRuleOverridden(@NotNull
 String id,
 @NotNull
 INotificationRuleTarget target,
 @Nullable
 NotificationRuleOptions options)

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

Parameters:

id - This parameter is required.

target - This parameter is required.

options -

notifyOnApprovalRuleOverridden

@Stability(Stable)
@NotNull
INotificationRule notifyOnApprovalRuleOverridden(@NotNull
 String id,
 @NotNull
 INotificationRuleTarget target)

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

Parameters:

id - This parameter is required.

target - This parameter is required.

notifyOnApprovalStatusChanged

@Stability(Stable)
@NotNull
INotificationRule notifyOnApprovalStatusChanged(@NotNull
 String id,
 @NotNull
 INotificationRuleTarget target,
 @Nullable
 NotificationRuleOptions options)

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

Parameters:

id - This parameter is required.

target - This parameter is required.

options -

notifyOnApprovalStatusChanged

@Stability(Stable)
@NotNull
INotificationRule notifyOnApprovalStatusChanged(@NotNull
 String id,
 @NotNull
 INotificationRuleTarget target)

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

Parameters:

id - This parameter is required.

target - This parameter is required.

notifyOnBranchOrTagCreated

@Stability(Stable)
@NotNull
INotificationRule notifyOnBranchOrTagCreated(@NotNull
 String id,
 @NotNull
 INotificationRuleTarget target,
 @Nullable
 NotificationRuleOptions options)

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

Parameters:

id - This parameter is required.

target - This parameter is required.

options -

notifyOnBranchOrTagCreated

@Stability(Stable)
@NotNull
INotificationRule notifyOnBranchOrTagCreated(@NotNull
 String id,
 @NotNull
 INotificationRuleTarget target)

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

Parameters:

id - This parameter is required.

target - This parameter is required.

notifyOnBranchOrTagDeleted

@Stability(Stable)
@NotNull
INotificationRule notifyOnBranchOrTagDeleted(@NotNull
 String id,
 @NotNull
 INotificationRuleTarget target,
 @Nullable
 NotificationRuleOptions options)

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

Parameters:

id - This parameter is required.

target - This parameter is required.

options -

notifyOnBranchOrTagDeleted

@Stability(Stable)
@NotNull
INotificationRule notifyOnBranchOrTagDeleted(@NotNull
 String id,
 @NotNull
 INotificationRuleTarget target)

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

Parameters:

id - This parameter is required.

target - This parameter is required.

notifyOnPullRequestComment

@Stability(Stable)
@NotNull
INotificationRule notifyOnPullRequestComment(@NotNull
 String id,
 @NotNull
 INotificationRuleTarget target,
 @Nullable
 NotificationRuleOptions options)

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

Parameters:

id - This parameter is required.

target - This parameter is required.

options -

notifyOnPullRequestComment

@Stability(Stable)
@NotNull
INotificationRule notifyOnPullRequestComment(@NotNull
 String id,
 @NotNull
 INotificationRuleTarget target)

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

Parameters:

id - This parameter is required.

target - This parameter is required.

notifyOnPullRequestCreated

@Stability(Stable)
@NotNull
INotificationRule notifyOnPullRequestCreated(@NotNull
 String id,
 @NotNull
 INotificationRuleTarget target,
 @Nullable
 NotificationRuleOptions options)

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

Parameters:

id - This parameter is required.

target - This parameter is required.

options -

notifyOnPullRequestCreated

@Stability(Stable)
@NotNull
INotificationRule notifyOnPullRequestCreated(@NotNull
 String id,
 @NotNull
 INotificationRuleTarget target)

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

Parameters:

id - This parameter is required.

target - This parameter is required.

notifyOnPullRequestMerged

@Stability(Stable)
@NotNull
INotificationRule notifyOnPullRequestMerged(@NotNull
 String id,
 @NotNull
 INotificationRuleTarget target,
 @Nullable
 NotificationRuleOptions options)

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

Parameters:

id - This parameter is required.

target - This parameter is required.

options -

notifyOnPullRequestMerged

@Stability(Stable)
@NotNull
INotificationRule notifyOnPullRequestMerged(@NotNull
 String id,
 @NotNull
 INotificationRuleTarget target)

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

Parameters:

id - This parameter is required.

target - This parameter is required.

onCommentOnCommit

@Stability(Stable)
@NotNull
Rule onCommentOnCommit(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

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

Parameters:

id - This parameter is required.

options -

onCommentOnCommit

@Stability(Stable)
@NotNull
Rule onCommentOnCommit(@NotNull
 String id)

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

Parameters:

id - This parameter is required.

onCommentOnPullRequest

@Stability(Stable)
@NotNull
Rule onCommentOnPullRequest(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

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

Parameters:

id - This parameter is required.

options -

onCommentOnPullRequest

@Stability(Stable)
@NotNull
Rule onCommentOnPullRequest(@NotNull
 String id)

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

Parameters:

id - This parameter is required.

onCommit

@Stability(Stable)
@NotNull
Rule onCommit(@NotNull
 String id,
 @Nullable
 OnCommitOptions options)

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

Parameters:

id - This parameter is required.

options -

onCommit

@Stability(Stable)
@NotNull
Rule onCommit(@NotNull
 String id)

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

Parameters:

id - This parameter is required.

onEvent

@Stability(Stable)
@NotNull
Rule onEvent(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

Defines a CloudWatch event rule which triggers for repository events.

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

Parameters:

id - This parameter is required.

options -

onEvent

@Stability(Stable)
@NotNull
Rule onEvent(@NotNull
 String id)

Defines a CloudWatch event rule which triggers for repository events.

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

Parameters:

id - This parameter is required.

onPullRequestStateChange

@Stability(Stable)
@NotNull
Rule onPullRequestStateChange(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

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

Parameters:

id - This parameter is required.

options -

onPullRequestStateChange

@Stability(Stable)
@NotNull
Rule onPullRequestStateChange(@NotNull
 String id)

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

Parameters:

id - This parameter is required.

onReferenceCreated

@Stability(Stable)
@NotNull
Rule onReferenceCreated(@NotNull
 String id,
 @Nullable
 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.

Parameters:

id - This parameter is required.

options -

onReferenceCreated

@Stability(Stable)
@NotNull
Rule onReferenceCreated(@NotNull
 String id)

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

Parameters:

id - This parameter is required.

onReferenceDeleted

@Stability(Stable)
@NotNull
Rule onReferenceDeleted(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

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

Parameters:

id - This parameter is required.

options -

onReferenceDeleted

@Stability(Stable)
@NotNull
Rule onReferenceDeleted(@NotNull
 String id)

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

Parameters:

id - This parameter is required.

onReferenceUpdated

@Stability(Stable)
@NotNull
Rule onReferenceUpdated(@NotNull
 String id,
 @Nullable
 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.

Parameters:

id - This parameter is required.

options -

onReferenceUpdated

@Stability(Stable)
@NotNull
Rule onReferenceUpdated(@NotNull
 String id)

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.

Parameters:

id - This parameter is required.

onStateChange

@Stability(Stable)
@NotNull
Rule onStateChange(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

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

Parameters:

id - This parameter is required.

options -

onStateChange

@Stability(Stable)
@NotNull
Rule onStateChange(@NotNull
 String id)

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

Parameters:

id - This parameter is required.