io.github.cdklabs.cdknag.IApplyRule Maven / Gradle / Ivy
Show all versions of cdknag Show documentation
package io.github.cdklabs.cdknag;
/**
* Interface for JSII interoperability for passing parameters and the Rule Callback to @applyRule method.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.102.0 (build e354887)", date = "2024-08-24T00:13:16.207Z")
@software.amazon.jsii.Jsii(module = io.github.cdklabs.cdknag.$Module.class, fqn = "cdk-nag.IApplyRule")
@software.amazon.jsii.Jsii.Proxy(IApplyRule.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public interface IApplyRule extends software.amazon.jsii.JsiiSerializable {
/**
* Why the rule exists.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull java.lang.String getExplanation();
/**
* Why the rule exists.
*/
void setExplanation(final @org.jetbrains.annotations.NotNull java.lang.String value);
/**
* Why the rule was triggered.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull java.lang.String getInfo();
/**
* Why the rule was triggered.
*/
void setInfo(final @org.jetbrains.annotations.NotNull java.lang.String value);
/**
* The annotations message level to apply to the rule if triggered.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull io.github.cdklabs.cdknag.NagMessageLevel getLevel();
/**
* The annotations message level to apply to the rule if triggered.
*/
void setLevel(final @org.jetbrains.annotations.NotNull io.github.cdklabs.cdknag.NagMessageLevel value);
/**
* The CfnResource to check.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull software.amazon.awscdk.CfnResource getNode();
/**
* The CfnResource to check.
*/
void setNode(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.CfnResource value);
/**
* A condition in which a suppression should be ignored.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable io.github.cdklabs.cdknag.INagSuppressionIgnore getIgnoreSuppressionCondition() {
return null;
}
/**
* A condition in which a suppression should be ignored.
*/
@software.amazon.jsii.Optional
default void setIgnoreSuppressionCondition(final @org.jetbrains.annotations.Nullable io.github.cdklabs.cdknag.INagSuppressionIgnore value) {
throw new UnsupportedOperationException("'void " + getClass().getCanonicalName() + "#setIgnoreSuppressionCondition(@org.jetbrains.annotations.Nullable io.github.cdklabs.cdknag.INagSuppressionIgnore)' is not implemented!");
}
/**
* Override for the suffix of the Rule ID for this rule.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.String getRuleSuffixOverride() {
return null;
}
/**
* Override for the suffix of the Rule ID for this rule.
*/
@software.amazon.jsii.Optional
default void setRuleSuffixOverride(final @org.jetbrains.annotations.Nullable java.lang.String value) {
throw new UnsupportedOperationException("'void " + getClass().getCanonicalName() + "#setRuleSuffixOverride(@org.jetbrains.annotations.Nullable java.lang.String)' is not implemented!");
}
/**
* The callback to the rule.
*
* @param node The CfnResource to check. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull java.lang.Object rule(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.CfnResource node);
/**
* A proxy class which represents a concrete javascript instance of this type.
*/
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements io.github.cdklabs.cdknag.IApplyRule.Jsii$Default {
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
/**
* Why the rule exists.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public final @org.jetbrains.annotations.NotNull java.lang.String getExplanation() {
return software.amazon.jsii.Kernel.get(this, "explanation", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Why the rule exists.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public final void setExplanation(final @org.jetbrains.annotations.NotNull java.lang.String value) {
software.amazon.jsii.Kernel.set(this, "explanation", java.util.Objects.requireNonNull(value, "explanation is required"));
}
/**
* Why the rule was triggered.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public final @org.jetbrains.annotations.NotNull java.lang.String getInfo() {
return software.amazon.jsii.Kernel.get(this, "info", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Why the rule was triggered.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public final void setInfo(final @org.jetbrains.annotations.NotNull java.lang.String value) {
software.amazon.jsii.Kernel.set(this, "info", java.util.Objects.requireNonNull(value, "info is required"));
}
/**
* The annotations message level to apply to the rule if triggered.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public final @org.jetbrains.annotations.NotNull io.github.cdklabs.cdknag.NagMessageLevel getLevel() {
return software.amazon.jsii.Kernel.get(this, "level", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.cdknag.NagMessageLevel.class));
}
/**
* The annotations message level to apply to the rule if triggered.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public final void setLevel(final @org.jetbrains.annotations.NotNull io.github.cdklabs.cdknag.NagMessageLevel value) {
software.amazon.jsii.Kernel.set(this, "level", java.util.Objects.requireNonNull(value, "level is required"));
}
/**
* The CfnResource to check.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public final @org.jetbrains.annotations.NotNull software.amazon.awscdk.CfnResource getNode() {
return software.amazon.jsii.Kernel.get(this, "node", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.CfnResource.class));
}
/**
* The CfnResource to check.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public final void setNode(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.CfnResource value) {
software.amazon.jsii.Kernel.set(this, "node", java.util.Objects.requireNonNull(value, "node is required"));
}
/**
* A condition in which a suppression should be ignored.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public final @org.jetbrains.annotations.Nullable io.github.cdklabs.cdknag.INagSuppressionIgnore getIgnoreSuppressionCondition() {
return software.amazon.jsii.Kernel.get(this, "ignoreSuppressionCondition", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.cdknag.INagSuppressionIgnore.class));
}
/**
* A condition in which a suppression should be ignored.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public final void setIgnoreSuppressionCondition(final @org.jetbrains.annotations.Nullable io.github.cdklabs.cdknag.INagSuppressionIgnore value) {
software.amazon.jsii.Kernel.set(this, "ignoreSuppressionCondition", value);
}
/**
* Override for the suffix of the Rule ID for this rule.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public final @org.jetbrains.annotations.Nullable java.lang.String getRuleSuffixOverride() {
return software.amazon.jsii.Kernel.get(this, "ruleSuffixOverride", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Override for the suffix of the Rule ID for this rule.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public final void setRuleSuffixOverride(final @org.jetbrains.annotations.Nullable java.lang.String value) {
software.amazon.jsii.Kernel.set(this, "ruleSuffixOverride", value);
}
/**
* The callback to the rule.
*
* @param node The CfnResource to check. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public final @org.jetbrains.annotations.NotNull java.lang.Object rule(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.CfnResource node) {
return software.amazon.jsii.Kernel.call(this, "rule", software.amazon.jsii.NativeType.forClass(java.lang.Object.class), new Object[] { java.util.Objects.requireNonNull(node, "node is required") });
}
}
/**
* Internal default implementation for {@link IApplyRule}.
*/
@software.amazon.jsii.Internal
interface Jsii$Default extends IApplyRule {
/**
* Why the rule exists.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.NotNull java.lang.String getExplanation() {
return software.amazon.jsii.Kernel.get(this, "explanation", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Why the rule exists.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default void setExplanation(final @org.jetbrains.annotations.NotNull java.lang.String value) {
software.amazon.jsii.Kernel.set(this, "explanation", java.util.Objects.requireNonNull(value, "explanation is required"));
}
/**
* Why the rule was triggered.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.NotNull java.lang.String getInfo() {
return software.amazon.jsii.Kernel.get(this, "info", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Why the rule was triggered.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default void setInfo(final @org.jetbrains.annotations.NotNull java.lang.String value) {
software.amazon.jsii.Kernel.set(this, "info", java.util.Objects.requireNonNull(value, "info is required"));
}
/**
* The annotations message level to apply to the rule if triggered.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.NotNull io.github.cdklabs.cdknag.NagMessageLevel getLevel() {
return software.amazon.jsii.Kernel.get(this, "level", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.cdknag.NagMessageLevel.class));
}
/**
* The annotations message level to apply to the rule if triggered.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default void setLevel(final @org.jetbrains.annotations.NotNull io.github.cdklabs.cdknag.NagMessageLevel value) {
software.amazon.jsii.Kernel.set(this, "level", java.util.Objects.requireNonNull(value, "level is required"));
}
/**
* The CfnResource to check.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.NotNull software.amazon.awscdk.CfnResource getNode() {
return software.amazon.jsii.Kernel.get(this, "node", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.CfnResource.class));
}
/**
* The CfnResource to check.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default void setNode(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.CfnResource value) {
software.amazon.jsii.Kernel.set(this, "node", java.util.Objects.requireNonNull(value, "node is required"));
}
/**
* A condition in which a suppression should be ignored.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable io.github.cdklabs.cdknag.INagSuppressionIgnore getIgnoreSuppressionCondition() {
return software.amazon.jsii.Kernel.get(this, "ignoreSuppressionCondition", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.cdknag.INagSuppressionIgnore.class));
}
/**
* A condition in which a suppression should be ignored.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default void setIgnoreSuppressionCondition(final @org.jetbrains.annotations.Nullable io.github.cdklabs.cdknag.INagSuppressionIgnore value) {
software.amazon.jsii.Kernel.set(this, "ignoreSuppressionCondition", value);
}
/**
* Override for the suffix of the Rule ID for this rule.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.String getRuleSuffixOverride() {
return software.amazon.jsii.Kernel.get(this, "ruleSuffixOverride", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Override for the suffix of the Rule ID for this rule.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default void setRuleSuffixOverride(final @org.jetbrains.annotations.Nullable java.lang.String value) {
software.amazon.jsii.Kernel.set(this, "ruleSuffixOverride", value);
}
/**
* The callback to the rule.
*
* @param node The CfnResource to check. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
default @org.jetbrains.annotations.NotNull java.lang.Object rule(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.CfnResource node) {
return software.amazon.jsii.Kernel.call(this, "rule", software.amazon.jsii.NativeType.forClass(java.lang.Object.class), new Object[] { java.util.Objects.requireNonNull(node, "node is required") });
}
}
}