Interface IApplyRule

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable
    All Known Subinterfaces:
    IApplyRule.Jsii$Default
    All Known Implementing Classes:
    IApplyRule.Jsii$Proxy

    @Generated(value="jsii-pacmak/1.93.0 (build 1706ca5)",
               date="2023-12-13T00:20:27.636Z")
    @Stability(Stable)
    public interface IApplyRule
    extends software.amazon.jsii.JsiiSerializable
    Interface for JSII interoperability for passing parameters and the Rule Callback to @applyRule method.
    • Method Detail

      • getExplanation

        @Stability(Stable)
        @NotNull
        String getExplanation()
        Why the rule exists.
      • setExplanation

        void setExplanation​(@NotNull
                            String value)
        Why the rule exists.
      • getInfo

        @Stability(Stable)
        @NotNull
        String getInfo()
        Why the rule was triggered.
      • setInfo

        void setInfo​(@NotNull
                     String value)
        Why the rule was triggered.
      • getLevel

        @Stability(Stable)
        @NotNull
        NagMessageLevel getLevel()
        The annotations message level to apply to the rule if triggered.
      • setLevel

        void setLevel​(@NotNull
                      NagMessageLevel value)
        The annotations message level to apply to the rule if triggered.
      • getNode

        @Stability(Stable)
        @NotNull
        software.amazon.awscdk.CfnResource getNode()
        The CfnResource to check.
      • setNode

        void setNode​(@NotNull
                     software.amazon.awscdk.CfnResource value)
        The CfnResource to check.
      • getIgnoreSuppressionCondition

        @Stability(Stable)
        @Nullable
        default INagSuppressionIgnore getIgnoreSuppressionCondition()
        A condition in which a suppression should be ignored.
      • setIgnoreSuppressionCondition

        @Optional
        default void setIgnoreSuppressionCondition​(@Nullable
                                                   INagSuppressionIgnore value)
        A condition in which a suppression should be ignored.
      • getRuleSuffixOverride

        @Stability(Stable)
        @Nullable
        default String getRuleSuffixOverride()
        Override for the suffix of the Rule ID for this rule.
      • setRuleSuffixOverride

        @Optional
        default void setRuleSuffixOverride​(@Nullable
                                           String value)
        Override for the suffix of the Rule ID for this rule.
      • rule

        @Stability(Stable)
        @NotNull
        Object rule​(@NotNull
                    software.amazon.awscdk.CfnResource node)
        The callback to the rule.

        Parameters:
        node - The CfnResource to check. This parameter is required.