PluginReportJson Struct
A report from a single validation plugin.
Example
ts
import { PluginReportJson } from '@aws-cdk/cloud-assembly-schema';
const report: PluginReportJson = {
pluginName: 'my-plugin',
conclusion: 'success',
violations: [],
};
Properties
Whether the plugin's validation passed or failed.
metadataoptional{ [key: string]: string }metadataoptionaltyping.Mapping[str, str]metadataoptionalMap<String, String>MetadataoptionalIDictionary<string, string>Metadataoptional*map[string]*string#Additional plugin-specific metadata.
Default: no metadata
The name of the plugin that produced this report.
pluginVersionoptionalstringplugin_versionoptionalstrpluginVersionoptionalStringPluginVersionoptionalstringPluginVersionoptional*string#Version of the plugin that produced this report.
Default: no version
preambleoptionalstringpreambleoptionalstrpreambleoptionalStringPreambleoptionalstringPreambleoptional*string#Any preamble text that the plugin wants to include in the report that is not a violation itself.
Default: no preamble
suppressedViolationsoptionalSuppressedViolationJson[]suppressed_violationsoptionaltyping.List[SuppressedViolationJson]suppressedViolationsoptionalList<SuppressedViolationJson>SuppressedViolationsoptionalSuppressedViolationJson[]SuppressedViolationsoptional*[]SuppressedViolationJson#Violations that were suppressed via acknowledgement.
Default: no suppressed violations
These violations matched an acknowledged rule ID and were excluded from the active violations list. They are retained for audit trail and reporting purposes.
violationsPolicyViolationJson[]violationstyping.List[PolicyViolationJson]violationsList<PolicyViolationJson>ViolationsPolicyViolationJson[]Violations*[]PolicyViolationJsonrequired#Violations found by this plugin.