aws-cdk-lib.PolicyValidationPluginReport

PolicyValidationPluginReport Struct

The report emitted by the plugin after evaluation.

Source

core/lib/validation/report.ts

Type last changed

v2.251.0 · 24 Apr 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
const policyValidationPluginReport: cdk.PolicyValidationPluginReport = {
  success: false,
  violations: [{
    description: 'description',
    ruleName: 'ruleName',
    violatingResources: [{
      locations: ['locations'],

      // the properties below are optional
      constructPath: 'constructPath',
      resourceLogicalId: 'resourceLogicalId',
      templatePath: 'templatePath',
    }],

    // the properties below are optional
    fix: 'fix',
    ruleMetadata: {
      ruleMetadataKey: 'ruleMetadata',
    },
    severity: 'severity',
  }],

  // the properties below are optional
  metadata: {
    metadataKey: 'metadata',
  },
  pluginVersion: 'pluginVersion',
};

Properties

metadata?optional{ [key: string]: string }metadata?optionaltyping.Mapping[str, str]metadata?optionalMap<String, String>Metadata?optionalIDictionary<string, string>Metadata?optional*map[string]*string#

Arbitrary information about the report.

Default: no metadata

pluginVersion?optionalstringplugin_version?optionalstrpluginVersion?optionalStringPluginVersion?optionalstringPluginVersion?optional*string#

The version of the plugin that created the report.

Default: no version

successbooleansuccessboolsuccessBooleanSuccessboolSuccess*boolrequired#

Whether or not the report was successful.

violationsPolicyViolation[]violationstyping.List[PolicyViolation]violationsList<PolicyViolation>ViolationsPolicyViolation[]Violations*[]PolicyViolationrequired#

List of violations in the report.