PolicyValidationPluginReportBeta1

class aws_cdk.PolicyValidationPluginReportBeta1(*, success, violations, metadata=None, plugin_version=None)

Bases: object

The report emitted by the plugin after evaluation.

Parameters:

success (bool) – Whether or not the report was successful.
violations (Sequence[Union[PolicyViolationBeta1, Dict[str, Any]]]) – List of violations in the report.
metadata (Optional[Mapping[str, str]]) – Arbitrary information about the report. Default: - no metadata
plugin_version (Optional[str]) – The version of the plugin that created the report. Default: - no version

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk

policy_validation_plugin_report_beta1 = cdk.PolicyValidationPluginReportBeta1(
    success=False,
    violations=[cdk.PolicyViolationBeta1(
        description="description",
        rule_name="ruleName",
        violating_resources=[cdk.PolicyViolatingResourceBeta1(
            locations=["locations"],
            resource_logical_id="resourceLogicalId",
            template_path="templatePath"
        )],

        # the properties below are optional
        fix="fix",
        rule_metadata={
            "rule_metadata_key": "ruleMetadata"
        },
        severity="severity"
    )],

    # the properties below are optional
    metadata={
        "metadata_key": "metadata"
    },
    plugin_version="pluginVersion"
)

Attributes

metadata

Arbitrary information about the report.

Default:

no metadata

plugin_version

The version of the plugin that created the report.

Default:

no version

success: Whether or not the report was successful.

violations: List of violations in the report.