@cloudcomponents/cdk-dependency-check
@cloudcomponents/cdk-dependency-check / CodeCommitDependencyCheck
-
Construct↳
CodeCommitDependencyCheck
- onCheckFailed
- onCheckStarted
- onCheckSucceeded
- onPrepare
- onSynthesize
- onValidate
- prepare
- synthesize
- toString
- validate
- isConstruct
• new CodeCommitDependencyCheck(scope, id, props)
| Name | Type |
|---|---|
scope |
Construct |
id |
string |
props |
CodeCommitDependencyCheckProps |
Construct.constructor
• Private Readonly checkProject: Project
• Readonly node: ConstructNode
The construct tree node associated with this construct.
stability stable
Construct.node
▸ onCheckFailed(id, options?): Rule
Defines an event rule which triggers when a check fails.
| Name | Type |
|---|---|
id |
string |
options? |
OnEventOptions |
Rule
▸ onCheckStarted(id, options?): Rule
Defines an event rule which triggers when a check starts.
| Name | Type |
|---|---|
id |
string |
options? |
OnEventOptions |
Rule
▸ onCheckSucceeded(id, options?): Rule
Defines an event rule which triggers when a check complets successfully.
| Name | Type |
|---|---|
id |
string |
options? |
OnEventOptions |
Rule
▸ Protected onPrepare(): void
Perform final modifications before synthesis.
This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.
This is an advanced framework feature. Only use this if you understand the implications.
stability stable
void
Construct.onPrepare
▸ Protected onSynthesize(session): void
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack and Asset
as they participate in synthesizing the cloud assembly.
stability stable
| Name | Type | Description |
|---|---|---|
session |
ISynthesisSession |
The synthesis session. |
void
Construct.onSynthesize
▸ Protected onValidate(): string[]
Validate the current construct.
This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.
stability stable
string[]
An array of validation error messages, or an empty array if the construct is valid.
Construct.onValidate
▸ Protected prepare(): void
Perform final modifications before synthesis.
This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.
This is an advanced framework feature. Only use this if you understand the implications.
stability stable
void
Construct.prepare
▸ Protected synthesize(session): void
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack and Asset
as they participate in synthesizing the cloud assembly.
stability stable
| Name | Type | Description |
|---|---|---|
session |
ISynthesisSession |
The synthesis session. |
void
Construct.synthesize
▸ toString(): string
Returns a string representation of this construct.
stability stable
string
Construct.toString
▸ Protected validate(): string[]
Validate the current construct.
This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.
stability stable
string[]
An array of validation error messages, or an empty array if the construct is valid.
Construct.validate
▸ Static isConstruct(x): x is Construct
Return whether the given object is a Construct.
stability stable
| Name | Type |
|---|---|
x |
any |
x is Construct
Construct.isConstruct
@cloudcomponents/cdk-dependency-check / CodeCommitDependencyCheckProps
- computeType
- enableExperimental
- excludes
- failOnCVSS
- paths
- preCheckCommand
- projectName
- reportsBucket
- repository
- schedule
- suppressions
- version
• Optional Readonly computeType: ComputeType
The type of compute to use for check the repositories. See the {@link ComputeType} enum for the possible values.
default taken from {@link #buildImage#defaultComputeType}
• Optional Readonly enableExperimental: boolean
Enable the experimental analyzers. If not set the analyzers marked as experimental will not be loaded or used.
default false
• Optional Readonly excludes: string[]
The path patterns to exclude from the scan
• Optional Readonly 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
• Optional Readonly paths: string[]
The paths to scan. Basedir repositoryDir
default the repositoryDir
• Optional Readonly preCheckCommand: string
Custom command to be executed before the dependency check
default echo "No preCheckCommand!"
• Optional Readonly projectName: string
The name of the project being scanned.
- @default taken from {@link #repository#repositoryName}
• Optional Readonly reportsBucket: Bucket
Bucket for uploading html reports
• Readonly repository: IRepository
The repository to be checked
• Readonly schedule: Schedule
Schedule for dependency check.
• Optional Readonly suppressions: string[]
The file paths to the suppression XML files; used to suppress false positives.
• Optional Readonly version: string
Version of the dependency check
default 5.3.2