interface PolicyValidationPluginReportBeta1
Language | Type name |
---|---|
![]() | Amazon.CDK.PolicyValidationPluginReportBeta1 |
![]() | github.com/aws/aws-cdk-go/awscdk/v2#PolicyValidationPluginReportBeta1 |
![]() | software.amazon.awscdk.PolicyValidationPluginReportBeta1 |
![]() | aws_cdk.PolicyValidationPluginReportBeta1 |
![]() | aws-cdk-lib » PolicyValidationPluginReportBeta1 |
The report emitted by the plugin after evaluation.
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 policyValidationPluginReportBeta1: cdk.PolicyValidationPluginReportBeta1 = {
success: false,
violations: [{
description: 'description',
ruleName: 'ruleName',
violatingResources: [{
locations: ['locations'],
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
Name | Type | Description |
---|---|---|
success | boolean | Whether or not the report was successful. |
violations | Policy [] | List of violations in the report. |
metadata? | { [string]: string } | Arbitrary information about the report. |
plugin | string | The version of the plugin that created the report. |
success
Type:
boolean
Whether or not the report was successful.
violations
Type:
Policy
[]
List of violations in the report.
metadata?
Type:
{ [string]: string }
(optional, default: no metadata)
Arbitrary information about the report.
pluginVersion?
Type:
string
(optional, default: no version)
The version of the plugin that created the report.