Package software.amazon.awscdk.cloud_assembly_schema

Interface PluginReportJson

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

PluginReportJson.Jsii$Proxy

@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)",
           date="2026-09-30T11:05:03.582Z")
@Stability(Stable)
public interface PluginReportJson
extends software.amazon.jsii.JsiiSerializable

A report from a single validation plugin.

Example:

 import software.amazon.awscdk.cloudassembly.schema.PluginReportJson;
 PluginReportJson report = PluginReportJson.builder()
         .pluginName("my-plugin")
         .conclusion("success")
         .violations(List.of())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	PluginReportJson.Builder	A builder for PluginReportJson
static final class	PluginReportJson.Jsii$Proxy	An implementation for PluginReportJson

Method Summary

Modifier and Type	Method	Description
static PluginReportJson.Builder	builder()
String	getConclusion()	Whether the plugin's validation passed or failed.
default Map<String,String>	getMetadata()	Additional plugin-specific metadata.
String	getPluginName()	The name of the plugin that produced this report.
default String	getPluginVersion()	Version of the plugin that produced this report.
default String	getPreamble()	Any preamble text that the plugin wants to include in the report that is not a violation itself.
default List<SuppressedViolationJson>	getSuppressedViolations()	Violations that were suppressed via acknowledgement.
List<PolicyViolationJson>	getViolations()	Violations found by this plugin.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConclusion

@Stability(Stable)
@NotNull
String getConclusion()

Whether the plugin's validation passed or failed.

getPluginName

@Stability(Stable)
@NotNull
String getPluginName()

The name of the plugin that produced this report.

getViolations

@Stability(Stable)
@NotNull
List<PolicyViolationJson> getViolations()

Violations found by this plugin.

getMetadata

@Stability(Stable)
@Nullable
default Map<String,String> getMetadata()

Additional plugin-specific metadata.

Default: - no metadata

getPluginVersion

@Stability(Stable)
@Nullable
default String getPluginVersion()

Version of the plugin that produced this report.

Default: - no version

getPreamble

@Stability(Stable)
@Nullable
default String getPreamble()

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

Default: - no preamble

getSuppressedViolations

@Stability(Stable)
@Nullable
default List<SuppressedViolationJson> getSuppressedViolations()

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

builder

@Stability(Stable)
static PluginReportJson.Builder builder()

Returns:

a PluginReportJson.Builder of PluginReportJson