Package software.amazon.awscdk

Interface IPolicyValidationPlugin.Jsii$Default

All Superinterfaces:
IPolicyValidationPlugin, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
IPolicyValidationPlugin.Jsii$Proxy
Enclosing interface:
IPolicyValidationPlugin
@Internal public static interface IPolicyValidationPlugin.Jsii$Default extends IPolicyValidationPlugin
Internal default implementation for IPolicyValidationPlugin.

  • Method Details

    • getName

      @Stability(Stable) @NotNull default String getName()
      The name of the plugin that will be displayed in the validation report.
      Specified by:
      getName in interface IPolicyValidationPlugin

    • getRuleIds

      @Stability(Stable) @Nullable default List<String> getRuleIds()
      The list of rule IDs that the plugin will evaluate.

      Used for analytics purposes.

      Default: - No rule is reported

      Specified by:
      getRuleIds in interface IPolicyValidationPlugin

    • getVersion

      @Stability(Stable) @Nullable default String getVersion()
      The version of the plugin, following the Semantic Versioning specification (see https://semver.org/). This version is used for analytics purposes, to measure the usage of different plugins and different versions. The value of this property should be kept in sync with the actual version of the software package. If the version is not provided or is not a valid semantic version, it will be reported as 0.0.0.
      Specified by:
      getVersion in interface IPolicyValidationPlugin

    • validate

      @Stability(Stable) @NotNull default PolicyValidationPluginReport validate(@NotNull IPolicyValidationContext context)
      The method that will be called by the CDK framework to perform validations.

      This is where the plugin will evaluate the CloudFormation templates for compliance and report and violations

      Specified by:
      validate in interface IPolicyValidationPlugin
      Parameters:
      context - This parameter is required.