aws-cdk-lib.cloud_assembly_schema.PluginReportJson

PluginReportJson Struct

A report from a single validation plugin.

Source

node_modules/@aws-cdk/cloud-assembly-schema/lib/cloud-assembly/validation-report-schema.d.ts

Type last changed

v2.271.0 · 25 Sep 2026

Example

import { PluginReportJson } from '@aws-cdk/cloud-assembly-schema';

const report: PluginReportJson = {
  pluginName: 'my-plugin',
  conclusion: 'success',
  violations: [],
};

Properties

conclusionstringconclusionstrconclusionStringConclusionstringConclusion*stringrequired#

Whether the plugin's validation passed or failed.

metadata{ [key: string]: string }metadatatyping.Mapping[str, str]metadataMap<String, String>MetadataIDictionary<string, string>Metadata*map[string]*string#

Additional plugin-specific metadata.

Default: no metadata

pluginNamestringplugin_namestrpluginNameStringPluginNamestringPluginName*stringrequired#

The name of the plugin that produced this report.

pluginVersionstringplugin_versionstrpluginVersionStringPluginVersionstringPluginVersion*string#

Version of the plugin that produced this report.

Default: no version

preamblestringpreamblestrpreambleStringPreamblestringPreamble*string#

Any preamble text that the plugin wants to include in the report that is not a violation itself.

Default: no preamble

suppressedViolationsSuppressedViolationJson[]suppressed_violationstyping.List[SuppressedViolationJson]suppressedViolationsList<SuppressedViolationJson>SuppressedViolationsSuppressedViolationJson[]SuppressedViolations*[]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.