Package io.github.cdklabs.cdknag
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.94.0 (build b380f01)", date="2024-02-29T00:11:40.942Z") @Stability(Stable) public interface IApplyRule extends software.amazon.jsii.JsiiSerializable
Interface for JSII interoperability for passing parameters and the Rule Callback to @applyRule method.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interfaceIApplyRule.Jsii$DefaultInternal default implementation forIApplyRule.static classIApplyRule.Jsii$ProxyA proxy class which represents a concrete javascript instance of this type.
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description StringgetExplanation()Why the rule exists.default INagSuppressionIgnoregetIgnoreSuppressionCondition()A condition in which a suppression should be ignored.StringgetInfo()Why the rule was triggered.NagMessageLevelgetLevel()The annotations message level to apply to the rule if triggered.software.amazon.awscdk.CfnResourcegetNode()The CfnResource to check.default StringgetRuleSuffixOverride()Override for the suffix of the Rule ID for this rule.Objectrule(software.amazon.awscdk.CfnResource node)The callback to the rule.voidsetExplanation(String value)Why the rule exists.default voidsetIgnoreSuppressionCondition(INagSuppressionIgnore value)A condition in which a suppression should be ignored.voidsetInfo(String value)Why the rule was triggered.voidsetLevel(NagMessageLevel value)The annotations message level to apply to the rule if triggered.voidsetNode(software.amazon.awscdk.CfnResource value)The CfnResource to check.default voidsetRuleSuffixOverride(String value)Override for the suffix of the Rule ID for this rule.
-
-
-
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.
-
-