Skip to content

Latest commit

 

History

History
133 lines (86 loc) · 7.57 KB

API.md

File metadata and controls

133 lines (86 loc) · 7.57 KB

API Reference

Classes

Name Description
CodeCommitDependencyCheck No description

Structs

Name Description
CodeCommitDependencyCheckProps No description

class CodeCommitDependencyCheck

Implements: IConstruct, IConstruct, IConstruct, IDependable Extends: Construct

Initializer

new CodeCommitDependencyCheck(scope: Construct, id: string, props: CodeCommitDependencyCheckProps)
  • scope (Construct) No description
  • id (string) No description
  • props (CodeCommitDependencyCheckProps) No description
    • repository (IRepository) The repository to be checked.
    • schedule (Schedule) Schedule for dependency check.
    • computeType (ComputeType) The type of compute to use for check the repositories. Default: taken from {@link #buildImage#defaultComputeType}
    • enableExperimental (boolean) Enable the experimental analyzers. Default: false
    • excludes (Array) The path patterns to exclude from the scan. Optional
    • failOnCVSS (number) If the score set between 0 and 10 the exit code from dependency-check will indicate if a vulnerability with a CVSS score equal to or higher was identified. Default: 0
    • paths (Array) The paths to scan. Default: the repositoryDir
    • preCheckCommand (string) Custom command to be executed before the dependency check. Default: echo "No preCheckCommand!"
    • projectName (string) The name of the project being scanned. Optional
    • reportsBucket (Bucket) Bucket for uploading html reports. Optional
    • suppressions (Array) The file paths to the suppression XML files; Optional
    • version (string) Version of the dependency check. Default: 5.3.2

Methods

onCheckFailed(id, options?)

Defines an event rule which triggers when a check fails.

onCheckFailed(id: string, options?: OnEventOptions): Rule
  • id (string) No description
  • options (OnEventOptions) No description
    • description (string) A description of the rule's purpose. Default: No description
    • eventPattern (EventPattern) Additional restrictions for the event to route to the specified target. Default: No additional filtering based on an event pattern.
    • ruleName (string) A name for the rule. Default: AWS CloudFormation generates a unique physical ID.
    • target (IRuleTarget) The target to register for the event. Default: No target is added to the rule. Use addTarget() to add a target.

Returns:

onCheckStarted(id, options?)

Defines an event rule which triggers when a check starts.

onCheckStarted(id: string, options?: OnEventOptions): Rule
  • id (string) No description
  • options (OnEventOptions) No description
    • description (string) A description of the rule's purpose. Default: No description
    • eventPattern (EventPattern) Additional restrictions for the event to route to the specified target. Default: No additional filtering based on an event pattern.
    • ruleName (string) A name for the rule. Default: AWS CloudFormation generates a unique physical ID.
    • target (IRuleTarget) The target to register for the event. Default: No target is added to the rule. Use addTarget() to add a target.

Returns:

onCheckSucceeded(id, options?)

Defines an event rule which triggers when a check complets successfully.

onCheckSucceeded(id: string, options?: OnEventOptions): Rule
  • id (string) No description
  • options (OnEventOptions) No description
    • description (string) A description of the rule's purpose. Default: No description
    • eventPattern (EventPattern) Additional restrictions for the event to route to the specified target. Default: No additional filtering based on an event pattern.
    • ruleName (string) A name for the rule. Default: AWS CloudFormation generates a unique physical ID.
    • target (IRuleTarget) The target to register for the event. Default: No target is added to the rule. Use addTarget() to add a target.

Returns:

struct CodeCommitDependencyCheckProps

Name Type Description
repository IRepository The repository to be checked.
schedule Schedule Schedule for dependency check.
computeType? ComputeType The type of compute to use for check the repositories.
Default: taken from {@link #buildImage#defaultComputeType}
enableExperimental? boolean Enable the experimental analyzers.
Default: false
excludes? Array The path patterns to exclude from the scan.
Optional
failOnCVSS? number If the score set between 0 and 10 the exit code from dependency-check will indicate if a vulnerability with a CVSS score equal to or higher was identified.
Default: 0
paths? Array The paths to scan.
Default: the repositoryDir
preCheckCommand? string Custom command to be executed before the dependency check.
Default: echo "No preCheckCommand!"
projectName? string The name of the project being scanned.
Optional
reportsBucket? Bucket Bucket for uploading html reports.
Optional
suppressions? Array The file paths to the suppression XML files;
Optional
version? string Version of the dependency check.
Default: 5.3.2