software.amazon.awscdk.services.codecommit

Class Repository

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.codecommit.Repository

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:00:56.568Z")
 @Stability(value=Experimental)
public class Repository
extends Resource
implements IRepository

(experimental) Provides a CodeCommit Repository.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Repository.Builder (experimental) A fluent builder for Repository.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.codecommit.IRepository

IRepository.Jsii$Default, IRepository.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	Repository(software.constructs.Construct scope, String id, RepositoryProps props)
protected	Repository(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Repository(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static IRepository	fromRepositoryArn(software.constructs.Construct scope, String id, String repositoryArn) (experimental) Imports a codecommit repository.
static IRepository	fromRepositoryName(software.constructs.Construct scope, String id, String repositoryName)
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.
Repository	notify(String arn) (experimental) Create a trigger to notify another service to run actions on repository events.
Repository	notify(String arn, RepositoryTriggerOptions options) (experimental) Create a trigger to notify another service to run actions on repository events.
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 class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

Constructor Detail

Repository

protected Repository(software.amazon.jsii.JsiiObjectRef objRef)

Repository

protected Repository(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Repository

@Stability(value=Experimental)
public Repository(@NotNull
                                                 software.constructs.Construct scope,
                                                 @NotNull
                                                 String id,
                                                 @NotNull
                                                 RepositoryProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromRepositoryArn

@Stability(value=Experimental)
 @NotNull
public static IRepository fromRepositoryArn(@NotNull
                                                                                     software.constructs.Construct scope,
                                                                                     @NotNull
                                                                                     String id,
                                                                                     @NotNull
                                                                                     String repositoryArn)

(experimental) Imports a codecommit repository.

Parameters:

scope - This parameter is required.

id - This parameter is required.

repositoryArn - (e.g. `arn:aws:codecommit:us-east-1:123456789012:MyDemoRepo`). This parameter is required.

fromRepositoryName

@Stability(value=Experimental)
 @NotNull
public static IRepository fromRepositoryName(@NotNull
                                                                                      software.constructs.Construct scope,
                                                                                      @NotNull
                                                                                      String id,
                                                                                      @NotNull
                                                                                      String repositoryName)

Parameters:

scope - This parameter is required.

id - This parameter is required.

repositoryName - This parameter is required.

grant

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

notify

@Stability(value=Experimental)
 @NotNull
public Repository notify(@NotNull
                                                                  String arn,
                                                                  @Nullable
                                                                  RepositoryTriggerOptions options)

(experimental) Create a trigger to notify another service to run actions on repository events.

Parameters:

arn - Arn of the resource that repository events will notify. This parameter is required.

options - Trigger options to run actions.

notify

@Stability(value=Experimental)
 @NotNull
public Repository notify(@NotNull
                                                                  String arn)

(experimental) Create a trigger to notify another service to run actions on repository events.

Parameters:

arn - Arn of the resource that repository events will notify. This parameter is required.

onCommentOnCommit

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

onCommentOnCommit

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

(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.

onCommentOnPullRequest

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

onCommentOnPullRequest

@Stability(value=Experimental)
 @NotNull
public Rule onCommentOnPullRequest(@NotNull
                                                                            String id)

(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.

onCommit

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

onCommit

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

(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.

onEvent

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

onEvent

@Stability(value=Experimental)
 @NotNull
public Rule onEvent(@NotNull
                                                             String id)

(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.

onPullRequestStateChange

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

onPullRequestStateChange

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

(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.

onReferenceCreated

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

onReferenceCreated

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

Specified by:

onReferenceCreated in interface IRepository

Parameters:

id - This parameter is required.

onReferenceDeleted

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

onReferenceDeleted

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

Specified by:

onReferenceDeleted in interface IRepository

Parameters:

id - This parameter is required.

onReferenceUpdated

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

onReferenceUpdated

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

Specified by:

onReferenceUpdated in interface IRepository

Parameters:

id - This parameter is required.

onStateChange

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

onStateChange

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

(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.

getRepositoryArn

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

(experimental) The ARN of this Repository.

Specified by:

getRepositoryArn in interface IRepository

getRepositoryCloneUrlGrc

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

(experimental) The HTTP clone URL.

Specified by:

getRepositoryCloneUrlHttp in interface IRepository

getRepositoryCloneUrlSsh

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

(experimental) The SSH clone URL.

Specified by:

getRepositoryCloneUrlSsh in interface IRepository

getRepositoryName

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

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

Specified by:

getRepositoryName in interface IRepository