Interface IPolicyValidationPluginReportBeta1

The report emitted by the plugin after evaluation.

Namespace: Amazon.CDK

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IPolicyValidationPluginReportBeta1

Syntax (vb)

Public Interface IPolicyValidationPluginReportBeta1

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;

var policyValidationPluginReportBeta1 = new PolicyValidationPluginReportBeta1 {
    Success = false,
    Violations = new [] { new PolicyViolationBeta1 {
        Description = "description",
        RuleName = "ruleName",
        ViolatingResources = new [] { new PolicyViolatingResourceBeta1 {
            Locations = new [] { "locations" },
            ResourceLogicalId = "resourceLogicalId",
            TemplatePath = "templatePath"
        } },

        // the properties below are optional
        Fix = "fix",
        RuleMetadata = new Dictionary<string, string> {
            { "ruleMetadataKey", "ruleMetadata" }
        },
        Severity = "severity"
    } },

    // the properties below are optional
    Metadata = new Dictionary<string, string> {
        { "metadataKey", "metadata" }
    },
    PluginVersion = "pluginVersion"
};

Synopsis

Properties

Metadata	Arbitrary information about the report.
PluginVersion	The version of the plugin that created the report.
Success	Whether or not the report was successful.
Violations	List of violations in the report.

Properties

Metadata

Arbitrary information about the report.

virtual IDictionary<string, string> Metadata { get; }

Property Value

System.Collections.Generic.IDictionary<System.String, System.String>

Remarks

Default: - no metadata

PluginVersion

The version of the plugin that created the report.

virtual string PluginVersion { get; }

Property Value

System.String

Remarks

Default: - no version

Success

Whether or not the report was successful.

bool Success { get; }

Property Value

System.Boolean

Violations

List of violations in the report.

IPolicyViolationBeta1[] Violations { get; }

Property Value

IPolicyViolationBeta1[]