Interface IRepository

Inherited Members

IResource.ApplyRemovalPolicy(RemovalPolicy)

IResource.Stack

INotificationRuleSource.BindAsNotificationRuleSource(Construct)

IRepositoryRef.RepositoryRef

IEnvironmentAware.Env

Namespace: Amazon.CDK.AWS.CodeCommit

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IRepository : IResource, INotificationRuleSource, IRepositoryRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Interface IRepository Inherits IResource, INotificationRuleSource, IRepositoryRef, IConstruct, IDependable, IEnvironmentAware

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, params 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 onEvent API.
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

string

Remarks

Attribute: true

RepositoryCloneUrlGrc

The HTTPS (GRC) clone URL.

string RepositoryCloneUrlGrc { get; }

Property Value

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

string

Remarks

Attribute: true

RepositoryCloneUrlSsh

The SSH clone URL.

string RepositoryCloneUrlSsh { get; }

Property Value

string

Remarks

Attribute: true

RepositoryName

The human-visible name of this Repository.

string RepositoryName { get; }

Property Value

string

Remarks

Attribute: true

Methods

Grant(IGrantable, params 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 string[]

Returns

Grant

GrantPull(IGrantable)

Grant the given identity permissions to pull this repository.

Grant GrantPull(IGrantable grantee)

Parameters

grantee IGrantable

Returns

Grant

GrantPullPush(IGrantable)

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

Grant GrantPullPush(IGrantable grantee)

Parameters

grantee IGrantable

Returns

Grant

GrantRead(IGrantable)

Grant the given identity permissions to read this repository.

Grant GrantRead(IGrantable grantee)

Parameters

grantee IGrantable

Returns

Grant

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 string

target INotificationRuleTarget

options IRepositoryNotifyOnOptions

Returns

INotificationRule

CodeStar Notifications rule associated with this repository.

Remarks

You can also use the methods to define rules for the specific event emitted. e.g. notifyOnPullRequestCreated.

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 string

target INotificationRuleTarget

options INotificationRuleOptions

Returns

INotificationRule

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 string

target INotificationRuleTarget

options INotificationRuleOptions

Returns

INotificationRule

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 string

target INotificationRuleTarget

options INotificationRuleOptions

Returns

INotificationRule

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 string

target INotificationRuleTarget

options INotificationRuleOptions

Returns

INotificationRule

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 string

target INotificationRuleTarget

options INotificationRuleOptions

Returns

INotificationRule

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 string

target INotificationRuleTarget

options INotificationRuleOptions

Returns

INotificationRule

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 string

target INotificationRuleTarget

options INotificationRuleOptions

Returns

INotificationRule

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 string

options IOnEventOptions

Returns

Rule

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 string

options IOnEventOptions

Returns

Rule

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 string

options IOnCommitOptions

Returns

Rule

OnEvent(string, IOnEventOptions?)

Defines a CloudWatch event rule which triggers for repository events.

Rule OnEvent(string id, IOnEventOptions? options = null)

Parameters

id string

options IOnEventOptions

Returns

Rule

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 string

options IOnEventOptions

Returns

Rule

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 string

options IOnEventOptions

Returns

Rule

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 string

options IOnEventOptions

Returns

Rule

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 string

options IOnEventOptions

Returns

Rule

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 string

options IOnEventOptions

Returns

Rule