interface PluginReportJson

Language	Type name
.NET	Amazon.CDK.CloudAssembly.Schema.PluginReportJson
Java	software.amazon.awscdk.cloudassembly.schema.PluginReportJson
Python	aws_cdk.cloud_assembly_schema.PluginReportJson
TypeScript	@aws-cdk/cloud-assembly-schema » PluginReportJson

A report from a single validation plugin.

Example

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

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

Properties

Name	Type	Description
conclusion	string	Whether the plugin's validation passed or failed.
pluginName	string	The name of the plugin that produced this report.
violations	PolicyViolationJson[]	Violations found by this plugin.
metadata?	{ [string]: string }	Additional plugin-specific metadata.
pluginVersion?	string	Version of the plugin that produced this report.
suppressedViolations?	SuppressedViolationJson[]	Violations that were suppressed via acknowledgement.

---

conclusion

Type: string

Whether the plugin's validation passed or failed.

---

pluginName

Type: string

The name of the plugin that produced this report.

---

violations

Type: PolicyViolationJson[]

Violations found by this plugin.

---

metadata?

Type: { [string]: string } (optional, default: no metadata)

Additional plugin-specific metadata.

---

pluginVersion?

Type: string (optional, default: no version)

Version of the plugin that produced this report.

---

suppressedViolations?

Type: SuppressedViolationJson[] (optional, default: no suppressed violations)

Violations that were suppressed via acknowledgement.

These violations matched an acknowledged rule ID and were excluded from the active violations list. They are retained for audit trail and reporting purposes.