software.amazon.awscdk.services.codecommit

Interface IRepository.Jsii$Default

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IRepository, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IRepository.Jsii$Proxy

Enclosing interface:

IRepository

@Internal
public static interface IRepository.Jsii$Default
extends IRepository, IResource.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 ResourceEnvironment	getEnv() (experimental) The environment this resource belongs to.
default software.constructs.Node	getNode() The tree node.
default String	getRepositoryArn() (experimental) The ARN of this Repository.
default String	getRepositoryCloneUrlGrc() (experimental) The HTTPS (GRC) clone URL.
default String	getRepositoryCloneUrlHttp() (experimental) The HTTP clone URL.
default String	getRepositoryCloneUrlSsh() (experimental) The SSH clone URL.
default String	getRepositoryName() (experimental) The human-visible name of this Repository.
default Stack	getStack() (experimental) The stack in which this resource is defined.
default Grant	grant(IGrantable grantee, String... actions) (experimental) Grant the given principal identity permissions to perform the actions on this repository.
default Grant	grantPull(IGrantable grantee) (experimental) Grant the given identity permissions to pull this repository.
default Grant	grantPullPush(IGrantable grantee) (experimental) Grant the given identity permissions to pull and push this repository.
default Grant	grantRead(IGrantable grantee) (experimental) Grant the given identity permissions to read this repository.
default Rule	onCommentOnCommit(String id, OnEventOptions options) (experimental) Defines a CloudWatch event rule which triggers when a comment is made on a commit.
default Rule	onCommentOnPullRequest(String id, OnEventOptions options) (experimental) Defines a CloudWatch event rule which triggers when a comment is made on a pull request.
default Rule	onCommit(String id, OnCommitOptions options) (experimental) Defines a CloudWatch event rule which triggers when a commit is pushed to a branch.
default Rule	onEvent(String id, OnEventOptions options) (experimental) Defines a CloudWatch event rule which triggers for repository events.
default Rule	onPullRequestStateChange(String id, OnEventOptions options) (experimental) Defines a CloudWatch event rule which triggers when a pull request state is changed.
default Rule	onReferenceCreated(String id, OnEventOptions options) (experimental) Defines a CloudWatch event rule which triggers when a reference is created (i.e.
default Rule	onReferenceDeleted(String id, OnEventOptions options) (experimental) Defines a CloudWatch event rule which triggers when a reference is delete (i.e.
default Rule	onReferenceUpdated(String id, OnEventOptions options) (experimental) Defines a CloudWatch event rule which triggers when a reference is updated (i.e.
default 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.services.codecommit.IRepository

onCommentOnCommit, onCommentOnPullRequest, onCommit, onEvent, onPullRequestStateChange, onReferenceCreated, onReferenceDeleted, onReferenceUpdated, onStateChange

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getNode

@Stability(value=Stable)
 @NotNull
default software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(value=Experimental)
 @NotNull
default ResourceEnvironment getEnv()

(experimental) 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

@Stability(value=Experimental)
 @NotNull
default Stack getStack()

(experimental) The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getRepositoryArn

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

(experimental) The ARN of this Repository.

Specified by:

getRepositoryArn in interface IRepository

getRepositoryCloneUrlGrc

@Stability(value=Experimental)
 @NotNull
default 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.

Specified by:

getRepositoryCloneUrlGrc in interface IRepository

See Also:

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

getRepositoryCloneUrlHttp

@Stability(value=Experimental)
 @NotNull
default String getRepositoryCloneUrlHttp()

(experimental) The HTTP clone URL.

Specified by:

getRepositoryCloneUrlHttp in interface IRepository

getRepositoryCloneUrlSsh

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

(experimental) The SSH clone URL.

Specified by:

getRepositoryCloneUrlSsh in interface IRepository

getRepositoryName

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

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

Specified by:

getRepositoryName in interface IRepository

grant

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

(experimental) 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

@Stability(value=Experimental)
 @NotNull
default Grant grantPull(@NotNull
                                                                 IGrantable grantee)

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

Specified by:

grantPull in interface IRepository

Parameters:

grantee - This parameter is required.

grantPullPush

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

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

Specified by:

grantPullPush in interface IRepository

Parameters:

grantee - This parameter is required.

grantRead

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

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

Specified by:

grantRead in interface IRepository

Parameters:

grantee - This parameter is required.

onCommentOnCommit

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

(experimental) 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

@Stability(value=Experimental)
 @NotNull
default 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.

Specified by:

onCommentOnPullRequest in interface IRepository

Parameters:

id - This parameter is required.

options -

onCommit

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

(experimental) 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

@Stability(value=Experimental)
 @NotNull
default 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.

Specified by:

onEvent in interface IRepository

Parameters:

id - This parameter is required.

options -

onPullRequestStateChange

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

(experimental) 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

@Stability(value=Experimental)
 @NotNull
default 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.

Specified by:

onReferenceCreated in interface IRepository

Parameters:

id - This parameter is required.

options -

onReferenceDeleted

@Stability(value=Experimental)
 @NotNull
default 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.

Specified by:

onReferenceDeleted in interface IRepository

Parameters:

id - This parameter is required.

options -

onReferenceUpdated

@Stability(value=Experimental)
 @NotNull
default 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.

Specified by:

onReferenceUpdated in interface IRepository

Parameters:

id - This parameter is required.

options -

onStateChange

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

(experimental) 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 -