API.md

API Reference

Structs

CheckovValidatorProps

Initializer

import { CheckovValidatorProps } from '@bridgecrew/cdk-validator-checkov'

const checkovValidatorProps: CheckovValidatorProps = { ... }

Properties

Name	Type	Description
check	string[]	List of checks to run.
skipCheck	string[]	List of checks to skip.

---

check^Optional

public readonly check: string[];

• Type: string[]
• Default: all checks are run

List of checks to run.

---

skipCheck^Optional

public readonly skipCheck: string[];

• Type: string[]
• Default: no checks are skipped

List of checks to skip.

---

Classes

CheckovValidator

• Implements: aws-cdk-lib.IPolicyValidationPluginBeta1

A validation plugin using checkov.

Initializers

import { CheckovValidator } from '@bridgecrew/cdk-validator-checkov'

new CheckovValidator(props?: CheckovValidatorProps)

Name	Type	Description
props	CheckovValidatorProps	No description.

---

props^Optional

• Type: CheckovValidatorProps

---

Methods

Name	Description
validate	The method that will be called by the CDK framework to perform validations.

---

validate

public validate(context: IPolicyValidationContextBeta1): PolicyValidationPluginReportBeta1

The method that will be called by the CDK framework to perform validations.

This is where the plugin will evaluate the CloudFormation templates for compliance and report and violations

context^Required

• Type: aws-cdk-lib.IPolicyValidationContextBeta1

---

Properties

Name	Type	Description
name	string	The name of the plugin that will be displayed in the validation report.

---

name^Required

public readonly name: string;

• Type: string

The name of the plugin that will be displayed in the validation report.

---