Interface IRepository
Inherited Members
Namespace: Amazon.CDK.AWS.CodeCommit
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IRepository : IResource, INotificationRuleSource
Syntax (vb)
Public Interface IRepository
Inherits IResource, IConstruct, IDependable, INotificationRuleSource
Synopsis
Properties
RepositoryArn | The ARN of this Repository. |
RepositoryCloneUrlGrc | The HTTPS (GRC) clone URL. |
RepositoryCloneUrlHttp | The HTTP clone URL. |
RepositoryCloneUrlSsh | The SSH clone URL. |
RepositoryName | The human-visible name of this Repository. |
Methods
Grant(IGrantable, String[]) | Grant the given principal identity permissions to perform the actions on this repository. |
GrantPull(IGrantable) | Grant the given identity permissions to pull this repository. |
GrantPullPush(IGrantable) | Grant the given identity permissions to pull and push this repository. |
GrantRead(IGrantable) | Grant the given identity permissions to read this repository. |
NotifyOn(String, INotificationRuleTarget, IRepositoryNotifyOnOptions) | Defines a CodeStar Notification rule triggered when the project events specified by you are emitted. Similar to |
NotifyOnApprovalRuleOverridden(String, INotificationRuleTarget, INotificationRuleOptions) | Defines a CodeStar Notification rule which triggers when an approval rule is overridden. |
NotifyOnApprovalStatusChanged(String, INotificationRuleTarget, INotificationRuleOptions) | Defines a CodeStar Notification rule which triggers when an approval status is changed. |
NotifyOnBranchOrTagCreated(String, INotificationRuleTarget, INotificationRuleOptions) | Defines a CodeStar Notification rule which triggers when a new branch or tag is created. |
NotifyOnBranchOrTagDeleted(String, INotificationRuleTarget, INotificationRuleOptions) | Defines a CodeStar Notification rule which triggers when a branch or tag is deleted. |
NotifyOnPullRequestComment(String, INotificationRuleTarget, INotificationRuleOptions) | Defines a CodeStar Notification rule which triggers when a comment is made on a pull request. |
NotifyOnPullRequestCreated(String, INotificationRuleTarget, INotificationRuleOptions) | Defines a CodeStar Notification rule which triggers when a pull request is created. |
NotifyOnPullRequestMerged(String, INotificationRuleTarget, INotificationRuleOptions) | Defines a CodeStar Notification rule which triggers when a pull request is merged. |
OnCommentOnCommit(String, IOnEventOptions) | Defines a CloudWatch event rule which triggers when a comment is made on a commit. |
OnCommentOnPullRequest(String, IOnEventOptions) | Defines a CloudWatch event rule which triggers when a comment is made on a pull request. |
OnCommit(String, IOnCommitOptions) | Defines a CloudWatch event rule which triggers when a commit is pushed to a branch. |
OnEvent(String, IOnEventOptions) | Defines a CloudWatch event rule which triggers for repository events. |
OnPullRequestStateChange(String, IOnEventOptions) | Defines a CloudWatch event rule which triggers when a pull request state is changed. |
OnReferenceCreated(String, IOnEventOptions) | Defines a CloudWatch event rule which triggers when a reference is created (i.e. a new branch/tag is created) to the repository. |
OnReferenceDeleted(String, IOnEventOptions) | Defines a CloudWatch event rule which triggers when a reference is delete (i.e. a branch/tag is deleted) from the repository. |
OnReferenceUpdated(String, IOnEventOptions) | 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. |
OnStateChange(String, IOnEventOptions) | Defines a CloudWatch event rule which triggers when a "CodeCommit Repository State Change" event occurs. |
Properties
RepositoryArn
The ARN of this Repository.
string RepositoryArn { get; }
Property Value
System.String
Remarks
Attribute: true
RepositoryCloneUrlGrc
The HTTPS (GRC) clone URL.
string RepositoryCloneUrlGrc { get; }
Property Value
System.String
Remarks
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: https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-git-remote-codecommit.html
RepositoryCloneUrlHttp
The HTTP clone URL.
string RepositoryCloneUrlHttp { get; }
Property Value
System.String
Remarks
Attribute: true
RepositoryCloneUrlSsh
The SSH clone URL.
string RepositoryCloneUrlSsh { get; }
Property Value
System.String
Remarks
Attribute: true
RepositoryName
The human-visible name of this Repository.
string RepositoryName { get; }
Property Value
System.String
Remarks
Attribute: true
Methods
Grant(IGrantable, String[])
Grant the given principal identity permissions to perform the actions on this repository.
Grant Grant(IGrantable grantee, params string[] actions)
Parameters
- grantee IGrantable
- actions System.String[]
Returns
GrantPull(IGrantable)
Grant the given identity permissions to pull this repository.
Grant GrantPull(IGrantable grantee)
Parameters
- grantee IGrantable
Returns
GrantPullPush(IGrantable)
Grant the given identity permissions to pull and push this repository.
Grant GrantPullPush(IGrantable grantee)
Parameters
- grantee IGrantable
Returns
GrantRead(IGrantable)
Grant the given identity permissions to read this repository.
Grant GrantRead(IGrantable grantee)
Parameters
- grantee IGrantable
Returns
NotifyOn(String, INotificationRuleTarget, IRepositoryNotifyOnOptions)
Defines a CodeStar Notification rule triggered when the project events specified by you are emitted. Similar to onEvent
API.
INotificationRule NotifyOn(string id, INotificationRuleTarget target, IRepositoryNotifyOnOptions options)
Parameters
- id System.String
- target INotificationRuleTarget
- options IRepositoryNotifyOnOptions
Returns
CodeStar Notifications rule associated with this repository.
Remarks
You can also use the methods to define rules for the specific event emitted.
eg: notifyOnPullRequstCreated
.
NotifyOnApprovalRuleOverridden(String, INotificationRuleTarget, INotificationRuleOptions)
Defines a CodeStar Notification rule which triggers when an approval rule is overridden.
INotificationRule NotifyOnApprovalRuleOverridden(string id, INotificationRuleTarget target, INotificationRuleOptions options = null)
Parameters
- id System.String
- target INotificationRuleTarget
- options INotificationRuleOptions
Returns
NotifyOnApprovalStatusChanged(String, INotificationRuleTarget, INotificationRuleOptions)
Defines a CodeStar Notification rule which triggers when an approval status is changed.
INotificationRule NotifyOnApprovalStatusChanged(string id, INotificationRuleTarget target, INotificationRuleOptions options = null)
Parameters
- id System.String
- target INotificationRuleTarget
- options INotificationRuleOptions
Returns
NotifyOnBranchOrTagCreated(String, INotificationRuleTarget, INotificationRuleOptions)
Defines a CodeStar Notification rule which triggers when a new branch or tag is created.
INotificationRule NotifyOnBranchOrTagCreated(string id, INotificationRuleTarget target, INotificationRuleOptions options = null)
Parameters
- id System.String
- target INotificationRuleTarget
- options INotificationRuleOptions
Returns
NotifyOnBranchOrTagDeleted(String, INotificationRuleTarget, INotificationRuleOptions)
Defines a CodeStar Notification rule which triggers when a branch or tag is deleted.
INotificationRule NotifyOnBranchOrTagDeleted(string id, INotificationRuleTarget target, INotificationRuleOptions options = null)
Parameters
- id System.String
- target INotificationRuleTarget
- options INotificationRuleOptions
Returns
NotifyOnPullRequestComment(String, INotificationRuleTarget, INotificationRuleOptions)
Defines a CodeStar Notification rule which triggers when a comment is made on a pull request.
INotificationRule NotifyOnPullRequestComment(string id, INotificationRuleTarget target, INotificationRuleOptions options = null)
Parameters
- id System.String
- target INotificationRuleTarget
- options INotificationRuleOptions
Returns
NotifyOnPullRequestCreated(String, INotificationRuleTarget, INotificationRuleOptions)
Defines a CodeStar Notification rule which triggers when a pull request is created.
INotificationRule NotifyOnPullRequestCreated(string id, INotificationRuleTarget target, INotificationRuleOptions options = null)
Parameters
- id System.String
- target INotificationRuleTarget
- options INotificationRuleOptions
Returns
NotifyOnPullRequestMerged(String, INotificationRuleTarget, INotificationRuleOptions)
Defines a CodeStar Notification rule which triggers when a pull request is merged.
INotificationRule NotifyOnPullRequestMerged(string id, INotificationRuleTarget target, INotificationRuleOptions options = null)
Parameters
- id System.String
- target INotificationRuleTarget
- options INotificationRuleOptions
Returns
OnCommentOnCommit(String, IOnEventOptions)
Defines a CloudWatch event rule which triggers when a comment is made on a commit.
Rule OnCommentOnCommit(string id, IOnEventOptions options = null)
Parameters
- id System.String
- options IOnEventOptions
Returns
OnCommentOnPullRequest(String, IOnEventOptions)
Defines a CloudWatch event rule which triggers when a comment is made on a pull request.
Rule OnCommentOnPullRequest(string id, IOnEventOptions options = null)
Parameters
- id System.String
- options IOnEventOptions
Returns
OnCommit(String, IOnCommitOptions)
Defines a CloudWatch event rule which triggers when a commit is pushed to a branch.
Rule OnCommit(string id, IOnCommitOptions options = null)
Parameters
- id System.String
- options IOnCommitOptions
Returns
OnEvent(String, IOnEventOptions)
Defines a CloudWatch event rule which triggers for repository events.
Rule OnEvent(string id, IOnEventOptions options = null)
Parameters
- id System.String
- options IOnEventOptions
Returns
Remarks
Use
rule.addEventPattern(pattern)
to specify a filter.
OnPullRequestStateChange(String, IOnEventOptions)
Defines a CloudWatch event rule which triggers when a pull request state is changed.
Rule OnPullRequestStateChange(string id, IOnEventOptions options = null)
Parameters
- id System.String
- options IOnEventOptions
Returns
OnReferenceCreated(String, IOnEventOptions)
Defines a CloudWatch event rule which triggers when a reference is created (i.e. a new branch/tag is created) to the repository.
Rule OnReferenceCreated(string id, IOnEventOptions options = null)
Parameters
- id System.String
- options IOnEventOptions
Returns
OnReferenceDeleted(String, IOnEventOptions)
Defines a CloudWatch event rule which triggers when a reference is delete (i.e. a branch/tag is deleted) from the repository.
Rule OnReferenceDeleted(string id, IOnEventOptions options = null)
Parameters
- id System.String
- options IOnEventOptions
Returns
OnReferenceUpdated(String, IOnEventOptions)
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.
Rule OnReferenceUpdated(string id, IOnEventOptions options = null)
Parameters
- id System.String
- options IOnEventOptions
Returns
OnStateChange(String, IOnEventOptions)
Defines a CloudWatch event rule which triggers when a "CodeCommit Repository State Change" event occurs.
Rule OnStateChange(string id, IOnEventOptions options = null)
Parameters
- id System.String
- options IOnEventOptions
Returns