Package 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, INotificationRuleSource, INotificationRuleSource.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, INotificationRuleSource.Jsii$Default
Internal default implementation for IRepository.

  • Method Details

    • getNode

      @Stability(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(Stable) @NotNull default ResourceEnvironment getEnv()
      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(Stable) @NotNull default Stack getStack()
      The stack in which this resource is defined.
      Specified by:
      getStack in interface IResource
      Specified by:
      getStack in interface IResource.Jsii$Default

    • getRepositoryArn

      @Stability(Stable) @NotNull default String getRepositoryArn()
      The ARN of this Repository.
      Specified by:
      getRepositoryArn in interface IRepository

    • getRepositoryCloneUrlGrc

      @Stability(Stable) @NotNull default String getRepositoryCloneUrlGrc()
      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:

    • getRepositoryCloneUrlHttp

      @Stability(Stable) @NotNull default String getRepositoryCloneUrlHttp()
      The HTTP clone URL.
      Specified by:
      getRepositoryCloneUrlHttp in interface IRepository

    • getRepositoryCloneUrlSsh

      @Stability(Stable) @NotNull default String getRepositoryCloneUrlSsh()
      The SSH clone URL.
      Specified by:
      getRepositoryCloneUrlSsh in interface IRepository

    • getRepositoryName

      @Stability(Stable) @NotNull default String getRepositoryName()
      The human-visible name of this Repository.
      Specified by:
      getRepositoryName in interface IRepository

    • applyRemovalPolicy

      @Stability(Stable) default void applyRemovalPolicy(@NotNull RemovalPolicy policy)
      Apply the given removal policy to this resource.

      The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

      The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

      Specified by:
      applyRemovalPolicy in interface IResource
      Specified by:
      applyRemovalPolicy in interface IResource.Jsii$Default
      Parameters:
      policy - This parameter is required.

    • bindAsNotificationRuleSource

      @Stability(Stable) @NotNull default NotificationRuleSourceConfig bindAsNotificationRuleSource(@NotNull software.constructs.Construct scope)
      Returns a source configuration for notification rule.

      Specified by:
      bindAsNotificationRuleSource in interface INotificationRuleSource
      Specified by:
      bindAsNotificationRuleSource in interface INotificationRuleSource.Jsii$Default
      Parameters:
      scope - This parameter is required.

    • grant

      @Stability(Stable) @NotNull default Grant grant(@NotNull IGrantable grantee, @NotNull @NotNull String... actions)
      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(Stable) @NotNull default Grant grantPull(@NotNull IGrantable grantee)
      Grant the given identity permissions to pull this repository.

      Specified by:
      grantPull in interface IRepository
      Parameters:
      grantee - This parameter is required.

    • grantPullPush

      @Stability(Stable) @NotNull default Grant grantPullPush(@NotNull IGrantable grantee)
      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(Stable) @NotNull default Grant grantRead(@NotNull IGrantable grantee)
      Grant the given identity permissions to read this repository.

      Specified by:
      grantRead in interface IRepository
      Parameters:
      grantee - This parameter is required.

    • notifyOn

      @Stability(Stable) @NotNull default INotificationRule notifyOn(@NotNull String id, @NotNull INotificationRuleTarget target, @NotNull RepositoryNotifyOnOptions options)
      Defines a CodeStar Notification rule triggered when the project events specified by you are emitted. Similar to onEvent API.

      You can also use the methods to define rules for the specific event emitted. eg: notifyOnPullRequstCreated.

      Specified by:
      notifyOn in interface IRepository
      Parameters:
      id - This parameter is required.
      target - This parameter is required.
      options - This parameter is required.
      Returns:
      CodeStar Notifications rule associated with this repository.

    • notifyOnApprovalRuleOverridden

      @Stability(Stable) @NotNull default INotificationRule notifyOnApprovalRuleOverridden(@NotNull String id, @NotNull INotificationRuleTarget target, @Nullable NotificationRuleOptions options)
      Defines a CodeStar Notification rule which triggers when an approval rule is overridden.

      Specified by:
      notifyOnApprovalRuleOverridden in interface IRepository
      Parameters:
      id - This parameter is required.
      target - This parameter is required.
      options -

    • notifyOnApprovalStatusChanged

      @Stability(Stable) @NotNull default INotificationRule notifyOnApprovalStatusChanged(@NotNull String id, @NotNull INotificationRuleTarget target, @Nullable NotificationRuleOptions options)
      Defines a CodeStar Notification rule which triggers when an approval status is changed.

      Specified by:
      notifyOnApprovalStatusChanged in interface IRepository
      Parameters:
      id - This parameter is required.
      target - This parameter is required.
      options -

    • notifyOnBranchOrTagCreated

      @Stability(Stable) @NotNull default INotificationRule notifyOnBranchOrTagCreated(@NotNull String id, @NotNull INotificationRuleTarget target, @Nullable NotificationRuleOptions options)
      Defines a CodeStar Notification rule which triggers when a new branch or tag is created.

      Specified by:
      notifyOnBranchOrTagCreated in interface IRepository
      Parameters:
      id - This parameter is required.
      target - This parameter is required.
      options -

    • notifyOnBranchOrTagDeleted

      @Stability(Stable) @NotNull default INotificationRule notifyOnBranchOrTagDeleted(@NotNull String id, @NotNull INotificationRuleTarget target, @Nullable NotificationRuleOptions options)
      Defines a CodeStar Notification rule which triggers when a branch or tag is deleted.

      Specified by:
      notifyOnBranchOrTagDeleted in interface IRepository
      Parameters:
      id - This parameter is required.
      target - This parameter is required.
      options -

    • notifyOnPullRequestComment

      @Stability(Stable) @NotNull default INotificationRule notifyOnPullRequestComment(@NotNull String id, @NotNull INotificationRuleTarget target, @Nullable NotificationRuleOptions options)
      Defines a CodeStar Notification rule which triggers when a comment is made on a pull request.

      Specified by:
      notifyOnPullRequestComment in interface IRepository
      Parameters:
      id - This parameter is required.
      target - This parameter is required.
      options -

    • notifyOnPullRequestCreated

      @Stability(Stable) @NotNull default INotificationRule notifyOnPullRequestCreated(@NotNull String id, @NotNull INotificationRuleTarget target, @Nullable NotificationRuleOptions options)
      Defines a CodeStar Notification rule which triggers when a pull request is created.

      Specified by:
      notifyOnPullRequestCreated in interface IRepository
      Parameters:
      id - This parameter is required.
      target - This parameter is required.
      options -

    • notifyOnPullRequestMerged

      @Stability(Stable) @NotNull default INotificationRule notifyOnPullRequestMerged(@NotNull String id, @NotNull INotificationRuleTarget target, @Nullable NotificationRuleOptions options)
      Defines a CodeStar Notification rule which triggers when a pull request is merged.

      Specified by:
      notifyOnPullRequestMerged in interface IRepository
      Parameters:
      id - This parameter is required.
      target - This parameter is required.
      options -

    • onCommentOnCommit

      @Stability(Stable) @NotNull default Rule onCommentOnCommit(@NotNull String id, @Nullable OnEventOptions options)
      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(Stable) @NotNull default Rule onCommentOnPullRequest(@NotNull String id, @Nullable OnEventOptions options)
      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(Stable) @NotNull default Rule onCommit(@NotNull String id, @Nullable OnCommitOptions options)
      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(Stable) @NotNull default Rule onEvent(@NotNull String id, @Nullable OnEventOptions options)
      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(Stable) @NotNull default Rule onPullRequestStateChange(@NotNull String id, @Nullable OnEventOptions options)
      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(Stable) @NotNull default Rule onReferenceCreated(@NotNull String id, @Nullable OnEventOptions options)
      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(Stable) @NotNull default Rule onReferenceDeleted(@NotNull String id, @Nullable OnEventOptions options)
      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(Stable) @NotNull default Rule onReferenceUpdated(@NotNull String id, @Nullable OnEventOptions options)
      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(Stable) @NotNull default Rule onStateChange(@NotNull String id, @Nullable OnEventOptions options)
      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 -