PluginReportJson

class aws_cdk.cloud_assembly_schema.PluginReportJson(*, conclusion, plugin_name, violations, metadata=None, plugin_version=None, suppressed_violations=None)

Bases: object

A report from a single validation plugin.

Parameters:

conclusion (str) – Whether the plugin’s validation passed or failed.
plugin_name (str) – The name of the plugin that produced this report.
violations (Sequence[Union[PolicyViolationJson, Dict[str, Any]]]) – Violations found by this plugin.
metadata (Optional[Mapping[str, str]]) – Additional plugin-specific metadata. Default: - no metadata
plugin_version (Optional[str]) – Version of the plugin that produced this report. Default: - no version
suppressed_violations (Optional[Sequence[Union[SuppressedViolationJson, Dict[str, Any]]]]) – 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. Default: - no suppressed violations

Example:

from aws_cdk.cloud_assembly_schema import PluginReportJson
from aws_cdk.cloud_assembly_schema import PluginReportJson


report = PluginReportJson(
    plugin_name="my-plugin",
    conclusion="success",
    violations=[]
)

Attributes

conclusion: Whether the plugin’s validation passed or failed.

metadata

Additional plugin-specific metadata.

Default:

no metadata

plugin_name: The name of the plugin that produced this report.

plugin_version

Version of the plugin that produced this report.

Default:

no version

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.

Default:

no suppressed violations

violations: Violations found by this plugin.