IPolicyValidationPlugin Interface
Represents a validation plugin that will be executed during synthesis.
Example
ts
/// fixture=validation-plugin
class MyPlugin implements IPolicyValidationPlugin {
public readonly name = 'MyPlugin';
public validate(context: IPolicyValidationContext): PolicyValidationPluginReport {
// First read the templates using context.templatePaths...
// ...then perform the validation, and then compose and return the report.
// Using hard-coded values here for better clarity:
return {
success: false,
violations: [{
ruleName: 'CKV_AWS_117',
description: 'Ensure that AWS Lambda function is configured inside a VPC',
fix: 'https://docs.bridgecrew.io/docs/ensure-that-aws-lambda-function-is-configured-inside-a-vpc-1',
violatingResources: [{
resourceLogicalId: 'MyFunction3BAA72D1',
templatePath: '/home/johndoe/myapp/cdk.out/MyService.template.json',
locations: ['Properties/VpcConfig'],
}],
}],
};
}
}
Properties
The name of the plugin that will be displayed in the validation report.
ruleIdsstring[]rule_idstyping.List[str]ruleIdsList<String>RuleIdsstring[]RuleIds*[]*string= No rule is reported#The list of rule IDs that the plugin will evaluate.
Used for analytics purposes.
The version of the plugin, following the Semantic Versioning specification (see https://semver.org/). This version is used for analytics purposes, to measure the usage of different plugins and different versions. The value of this property should be kept in sync with the actual version of the software package. If the version is not provided or is not a valid semantic version, it will be reported as `0.0.0`.
Methods
validate(context: IPolicyValidationContext): PolicyValidationPluginReportdef validate(self, context: IPolicyValidationContext) -> PolicyValidationPluginReportpublic PolicyValidationPluginReport validate(IPolicyValidationContext context)public PolicyValidationPluginReport Validate(IPolicyValidationContext context)func Validate(Context IPolicyValidationContext) PolicyValidationPluginReport#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