software.amazon.awscdk.services.codecommit

Interface IRepository

All Superinterfaces:

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

All Known Subinterfaces:

IRepository.Jsii$Default

All Known Implementing Classes:

IRepository.Jsii$Proxy, Repository

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:07.342Z")
 @Stability(value=Experimental)
public interface IRepository
extends software.amazon.jsii.JsiiSerializable, IResource

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
String	getRepositoryArn() (experimental) The ARN of this Repository.
String	getRepositoryCloneUrlGrc() (experimental) The HTTPS (GRC) clone URL.
String	getRepositoryCloneUrlHttp() (experimental) The HTTP clone URL.
String	getRepositoryCloneUrlSsh() (experimental) The SSH clone URL.
String	getRepositoryName() (experimental) The human-visible name of this Repository.
Grant	grant(IGrantable grantee, String... actions) (experimental) Grant the given principal identity permissions to perform the actions on this repository.
Grant	grantPull(IGrantable grantee) (experimental) Grant the given identity permissions to pull this repository.
Grant	grantPullPush(IGrantable grantee) (experimental) Grant the given identity permissions to pull and push this repository.
Grant	grantRead(IGrantable grantee) (experimental) Grant the given identity permissions to read this repository.
Rule	onCommentOnCommit(String id) (experimental) Defines a CloudWatch event rule which triggers when a comment is made on a commit.
Rule	onCommentOnCommit(String id, OnEventOptions options) (experimental) Defines a CloudWatch event rule which triggers when a comment is made on a commit.
Rule	onCommentOnPullRequest(String id) (experimental) Defines a CloudWatch event rule which triggers when a comment is made on a pull request.
Rule	onCommentOnPullRequest(String id, OnEventOptions options) (experimental) Defines a CloudWatch event rule which triggers when a comment is made on a pull request.
Rule	onCommit(String id) (experimental) Defines a CloudWatch event rule which triggers when a commit is pushed to a branch.
Rule	onCommit(String id, OnCommitOptions options) (experimental) Defines a CloudWatch event rule which triggers when a commit is pushed to a branch.
Rule	onEvent(String id) (experimental) Defines a CloudWatch event rule which triggers for repository events.
Rule	onEvent(String id, OnEventOptions options) (experimental) Defines a CloudWatch event rule which triggers for repository events.
Rule	onPullRequestStateChange(String id) (experimental) Defines a CloudWatch event rule which triggers when a pull request state is changed.
Rule	onPullRequestStateChange(String id, OnEventOptions options) (experimental) Defines a CloudWatch event rule which triggers when a pull request state is changed.
Rule	onReferenceCreated(String id) (experimental) Defines a CloudWatch event rule which triggers when a reference is created (i.e.
Rule	onReferenceCreated(String id, OnEventOptions options) (experimental) Defines a CloudWatch event rule which triggers when a reference is created (i.e.
Rule	onReferenceDeleted(String id) (experimental) Defines a CloudWatch event rule which triggers when a reference is delete (i.e.
Rule	onReferenceDeleted(String id, OnEventOptions options) (experimental) Defines a CloudWatch event rule which triggers when a reference is delete (i.e.
Rule	onReferenceUpdated(String id) (experimental) Defines a CloudWatch event rule which triggers when a reference is updated (i.e.
Rule	onReferenceUpdated(String id, OnEventOptions options) (experimental) Defines a CloudWatch event rule which triggers when a reference is updated (i.e.
Rule	onStateChange(String id) (experimental) Defines a CloudWatch event rule which triggers when a "CodeCommit Repository State Change" event occurs.
Rule	onStateChange(String id, OnEventOptions options) (experimental) Defines a CloudWatch event rule which triggers when a "CodeCommit Repository State Change" event occurs.

Methods inherited from interface software.amazon.awscdk.IResource

getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getRepositoryArn

@Stability(value=Experimental)
 @NotNull
String getRepositoryArn()

(experimental) The ARN of this Repository.

getRepositoryCloneUrlGrc

@Stability(value=Experimental)
 @NotNull
String getRepositoryCloneUrlGrc()

(experimental) 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(value=Experimental)
 @NotNull
String getRepositoryCloneUrlHttp()

(experimental) The HTTP clone URL.

getRepositoryCloneUrlSsh

@Stability(value=Experimental)
 @NotNull
String getRepositoryCloneUrlSsh()

(experimental) The SSH clone URL.

getRepositoryName

@Stability(value=Experimental)
 @NotNull
String getRepositoryName()

(experimental) The human-visible name of this Repository.

grant

@Stability(value=Experimental)
 @NotNull
Grant grant(@NotNull
                                                     IGrantable grantee,
                                                     @NotNull
                                                     String... actions)

(experimental) 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(value=Experimental)
 @NotNull
Grant grantPull(@NotNull
                                                         IGrantable grantee)

(experimental) Grant the given identity permissions to pull this repository.

Parameters:

grantee - This parameter is required.

grantPullPush

@Stability(value=Experimental)
 @NotNull
Grant grantPullPush(@NotNull
                                                             IGrantable grantee)

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

Parameters:

grantee - This parameter is required.

grantRead

@Stability(value=Experimental)
 @NotNull
Grant grantRead(@NotNull
                                                         IGrantable grantee)

(experimental) Grant the given identity permissions to read this repository.

Parameters:

grantee - This parameter is required.

onCommentOnCommit

@Stability(value=Experimental)
 @NotNull
Rule onCommentOnCommit(@NotNull
                                                                String id,
                                                                @Nullable
                                                                OnEventOptions options)

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

Parameters:

id - This parameter is required.

options -

onCommentOnCommit

@Stability(value=Experimental)
 @NotNull
Rule onCommentOnCommit(@NotNull
                                                                String id)

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

Parameters:

id - This parameter is required.

onCommentOnPullRequest

@Stability(value=Experimental)
 @NotNull
Rule onCommentOnPullRequest(@NotNull
                                                                     String id,
                                                                     @Nullable
                                                                     OnEventOptions options)

(experimental) 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(value=Experimental)
 @NotNull
Rule onCommentOnPullRequest(@NotNull
                                                                     String id)

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

Parameters:

id - This parameter is required.

onCommit

@Stability(value=Experimental)
 @NotNull
Rule onCommit(@NotNull
                                                       String id,
                                                       @Nullable
                                                       OnCommitOptions options)

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

Parameters:

id - This parameter is required.

options -

onCommit

@Stability(value=Experimental)
 @NotNull
Rule onCommit(@NotNull
                                                       String id)

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

Parameters:

id - This parameter is required.

onEvent

@Stability(value=Experimental)
 @NotNull
Rule onEvent(@NotNull
                                                      String id,
                                                      @Nullable
                                                      OnEventOptions options)

(experimental) 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(value=Experimental)
 @NotNull
Rule onEvent(@NotNull
                                                      String id)

(experimental) 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(value=Experimental)
 @NotNull
Rule onPullRequestStateChange(@NotNull
                                                                       String id,
                                                                       @Nullable
                                                                       OnEventOptions options)

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

Parameters:

id - This parameter is required.

options -

onPullRequestStateChange

@Stability(value=Experimental)
 @NotNull
Rule onPullRequestStateChange(@NotNull
                                                                       String id)

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

Parameters:

id - This parameter is required.

onReferenceCreated

@Stability(value=Experimental)
 @NotNull
Rule onReferenceCreated(@NotNull
                                                                 String id,
                                                                 @Nullable
                                                                 OnEventOptions options)

(experimental) 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(value=Experimental)
 @NotNull
Rule onReferenceCreated(@NotNull
                                                                 String id)

(experimental) 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(value=Experimental)
 @NotNull
Rule onReferenceDeleted(@NotNull
                                                                 String id,
                                                                 @Nullable
                                                                 OnEventOptions options)

(experimental) 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(value=Experimental)
 @NotNull
Rule onReferenceDeleted(@NotNull
                                                                 String id)

(experimental) 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(value=Experimental)
 @NotNull
Rule onReferenceUpdated(@NotNull
                                                                 String id,
                                                                 @Nullable
                                                                 OnEventOptions options)

(experimental) 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(value=Experimental)
 @NotNull
Rule onReferenceUpdated(@NotNull
                                                                 String id)

(experimental) 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(value=Experimental)
 @NotNull
Rule onStateChange(@NotNull
                                                            String id,
                                                            @Nullable
                                                            OnEventOptions options)

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

Parameters:

id - This parameter is required.

options -

onStateChange

@Stability(value=Experimental)
 @NotNull
Rule onStateChange(@NotNull
                                                            String id)

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

Parameters:

id - This parameter is required.