Package io.github.cdklabs.cdknag

Interface INagLogger

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

INagLogger.Jsii$Default

All Known Implementing Classes:

AnnotationLogger, INagLogger.Jsii$Proxy, NagReportLogger

@Generated(value="jsii-pacmak/1.93.0 (build 1706ca5)",
           date="2023-12-13T00:20:27.639Z")
@Stability(Stable)
public interface INagLogger
extends software.amazon.jsii.JsiiSerializable

Interface for creating NagSuppression Ignores.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	INagLogger.Jsii$Default	Internal default implementation for INagLogger.
static class	INagLogger.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
void	onCompliance(NagLoggerComplianceData data)	Called when a CfnResource passes the compliance check for a given rule.
void	onError(NagLoggerErrorData data)	Called when a rule throws an error during while validating a CfnResource for compliance.
void	onNonCompliance(NagLoggerNonComplianceData data)	Called when a CfnResource does not pass the compliance check for a given rule and the the rule violation is not suppressed by the user.
void	onNotApplicable(NagLoggerNotApplicableData data)	Called when a rule does not apply to the given CfnResource.
void	onSuppressed(NagLoggerSuppressedData data)	Called when a CfnResource does not pass the compliance check for a given rule and the rule violation is suppressed by the user.
void	onSuppressedError(NagLoggerSuppressedErrorData data)	Called when a rule throws an error during while validating a CfnResource for compliance and the error is suppressed.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

onCompliance

@Stability(Stable)
void onCompliance(@NotNull
                  NagLoggerComplianceData data)

Called when a CfnResource passes the compliance check for a given rule.

Parameters:

data - This parameter is required.

onError

@Stability(Stable)
void onError(@NotNull
             NagLoggerErrorData data)

Called when a rule throws an error during while validating a CfnResource for compliance.

Parameters:

data - This parameter is required.

onNonCompliance

@Stability(Stable)
void onNonCompliance(@NotNull
                     NagLoggerNonComplianceData data)

Called when a CfnResource does not pass the compliance check for a given rule and the the rule violation is not suppressed by the user.

Parameters:

data - This parameter is required.

onNotApplicable

@Stability(Stable)
void onNotApplicable(@NotNull
                     NagLoggerNotApplicableData data)

Called when a rule does not apply to the given CfnResource.

Parameters:

data - This parameter is required.

onSuppressed

@Stability(Stable)
void onSuppressed(@NotNull
                  NagLoggerSuppressedData data)

Called when a CfnResource does not pass the compliance check for a given rule and the rule violation is suppressed by the user.

Parameters:

data - This parameter is required.

onSuppressedError

@Stability(Stable)
void onSuppressedError(@NotNull
                       NagLoggerSuppressedErrorData data)

Called when a rule throws an error during while validating a CfnResource for compliance and the error is suppressed.

Parameters:

data - This parameter is required.