Class to initialize repository

Hierarchy

  • Repository
    • Repository

Constructors

Properties

env: ResourceEnvironment
node: Node

The tree node.

Stability

stable

physicalName: string

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.
repositoryArn: string
repositoryCloneUrlGrc: string
repositoryCloneUrlHttp: string
repositoryCloneUrlSsh: string
repositoryName: string
stack: Stack

Methods

  • Internal

    Called when this resource is referenced across environments (account/region) to order to request that a physical name will be generated for this resource during synthesis, so the resource can be referenced through its absolute name/arn.

    Returns void

  • 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).

    Parameters

    • policy: RemovalPolicy

    Returns void

  • Parameters

    • _scope: Construct

    Returns NotificationRuleSourceConfig

  • Returns string

  • Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

    Normally, this token will resolve to arnAttr, but if the resource is referenced across environments, arnComponents will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arnComponents.

    Parameters

    • arnAttr: string

      The CFN attribute which resolves to the ARN of the resource. Commonly it will be called "Arn" (e.g. resource.attrArn), but sometimes it's the CFN resource's ref.

    • arnComponents: ArnComponents

      The format of the ARN of this resource. You must reference this.physicalName somewhere within the ARN in order for cross-environment references to work.

    Returns string

  • Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

    Normally, this token will resolve to nameAttr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

    Parameters

    • nameAttr: string

      The CFN attribute which resolves to the resource's name. Commonly this is the resource's ref.

    Returns string

  • Parameters

    • grantee: IGrantable
    • Rest ...actions: string[]

    Returns Grant

  • Parameters

    • grantee: IGrantable

    Returns Grant

  • Parameters

    • grantee: IGrantable

    Returns Grant

  • Parameters

    • grantee: IGrantable

    Returns Grant

  • Parameters

    • id: string
    • target: INotificationRuleTarget
    • Optional options: NotificationRuleOptions

    Returns INotificationRule

  • Create a trigger to notify another service to run actions on repository events.

    Parameters

    • arn: string

      Arn of the resource that repository events will notify

    • Optional options: RepositoryTriggerOptions

      Trigger options to run actions

    Returns Repository

  • Parameters

    • id: string
    • target: INotificationRuleTarget
    • options: RepositoryNotifyOnOptions

    Returns INotificationRule

  • Parameters

    • id: string
    • target: INotificationRuleTarget
    • Optional options: NotificationRuleOptions

    Returns INotificationRule

  • Parameters

    • id: string
    • target: INotificationRuleTarget
    • Optional options: NotificationRuleOptions

    Returns INotificationRule

  • Parameters

    • id: string
    • target: INotificationRuleTarget
    • Optional options: NotificationRuleOptions

    Returns INotificationRule

  • Parameters

    • id: string
    • target: INotificationRuleTarget
    • Optional options: NotificationRuleOptions

    Returns INotificationRule

  • Parameters

    • id: string
    • target: INotificationRuleTarget
    • Optional options: NotificationRuleOptions

    Returns INotificationRule

  • Parameters

    • id: string
    • target: INotificationRuleTarget
    • Optional options: NotificationRuleOptions

    Returns INotificationRule

  • Parameters

    • id: string
    • target: INotificationRuleTarget
    • Optional options: NotificationRuleOptions

    Returns INotificationRule

  • Defines a CloudWatch event rule which triggers when a comment is made on a commit.

    Parameters

    • id: string
    • Optional options: OnEventOptions

    Returns Rule

  • Defines a CloudWatch event rule which triggers when a comment is made on a pull request.

    Parameters

    • id: string
    • Optional options: OnEventOptions

    Returns Rule

  • Defines a CloudWatch event rule which triggers when a commit is pushed to a branch.

    Parameters

    • id: string
    • Optional options: OnCommitOptions

    Returns Rule

  • Defines a CloudWatch event rule which triggers for repository events. Use rule.addEventPattern(pattern) to specify a filter.

    Parameters

    • id: string
    • Optional options: OnEventOptions

    Returns Rule

  • Defines a CloudWatch event rule which triggers when a pull request state is changed.

    Parameters

    • id: string
    • Optional options: OnEventOptions

    Returns Rule

  • 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: string
    • Optional options: OnEventOptions

    Returns Rule

  • Defines a CloudWatch event rule which triggers when a reference is delete (i.e. a branch/tag is deleted) from the repository.

    Parameters

    • id: string
    • Optional options: OnEventOptions

    Returns Rule

  • 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: string
    • Optional options: OnEventOptions

    Returns Rule

  • Defines a CloudWatch event rule which triggers when a "CodeCommit Repository State Change" event occurs.

    Parameters

    • id: string
    • Optional options: OnEventOptions

    Returns Rule

  • Returns a string representation of this construct.

    Stability

    stable

    Returns string

  • Imports a codecommit repository.

    Parameters

    • scope: Construct
    • id: string
    • repositoryArn: string

      (e.g. arn:aws:codecommit:us-east-1:123456789012:MyDemoRepo)

    Returns IRepository

  • Parameters

    • scope: Construct
    • id: string
    • repositoryName: string

    Returns IRepository

  • (deprecated) Checks if x is a construct.

    Returns

    true if x is an object created from a class which extends Construct.

    Deprecated

    use x instanceof Construct instead

    Parameters

    • x: any

      Any object.

    Returns x is Construct

  • Returns true if the construct was created by CDK, and false otherwise

    Parameters

    • construct: IConstruct

    Returns boolean

  • Check whether the given construct is a Resource

    Parameters

    • construct: IConstruct

    Returns construct is Resource

Generated using TypeDoc