Package io.github.cdklabs.cdknag

Class NagReportLogger

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.cdknag.NagReportLogger

All Implemented Interfaces:

INagLogger, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.94.0 (build b380f01)",
           date="2024-02-11T00:12:48.875Z")
@Stability(Stable)
public class NagReportLogger
extends software.amazon.jsii.JsiiObject
implements INagLogger

A NagLogger that creates compliance reports.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NagReportLogger.Builder	A fluent builder for NagReportLogger.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface io.github.cdklabs.cdknag.INagLogger

INagLogger.Jsii$Default, INagLogger.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
	NagReportLogger(NagReportLoggerProps props)
protected	NagReportLogger(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	NagReportLogger(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
List<NagReportFormat>	getFormats()
List<String>	getFormatStacks(NagReportFormat format)
protected void	initializeStackReport(NagLoggerBaseData data)	Initialize the report for the rule pack's compliance report for the resource's Stack if it doesn't exist.
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.
protected void	writeToStackComplianceReport(NagLoggerBaseData data, Object compliance)

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

NagReportLogger

protected NagReportLogger(software.amazon.jsii.JsiiObjectRef objRef)

NagReportLogger

protected NagReportLogger(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

NagReportLogger

@Stability(Stable)
public NagReportLogger(@NotNull
                       NagReportLoggerProps props)

Parameters:

props - This parameter is required.

Method Detail

getFormatStacks

@Stability(Stable)
@NotNull
public List<String> getFormatStacks(@NotNull
                                    NagReportFormat format)

Parameters:

format - This parameter is required.

initializeStackReport

@Stability(Stable)
protected void initializeStackReport(@NotNull
                                     NagLoggerBaseData data)

Initialize the report for the rule pack's compliance report for the resource's Stack if it doesn't exist.

Parameters:

data - This parameter is required.

onCompliance

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

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

Specified by:

onCompliance in interface INagLogger

Parameters:

data - This parameter is required.

onError

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

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

Specified by:

onError in interface INagLogger

Parameters:

data - This parameter is required.

onNonCompliance

@Stability(Stable)
public 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.

Specified by:

onNonCompliance in interface INagLogger

Parameters:

data - This parameter is required.

onNotApplicable

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

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

Specified by:

onNotApplicable in interface INagLogger

Parameters:

data - This parameter is required.

onSuppressed

@Stability(Stable)
public 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.

Specified by:

onSuppressed in interface INagLogger

Parameters:

data - This parameter is required.

onSuppressedError

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

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

Specified by:

onSuppressedError in interface INagLogger

Parameters:

data - This parameter is required.

writeToStackComplianceReport

@Stability(Stable)
protected void writeToStackComplianceReport(@NotNull
                                            NagLoggerBaseData data,
                                            @NotNull
                                            Object compliance)

Parameters:

data - This parameter is required.

compliance - This parameter is required.

getFormats

@Stability(Stable)
@NotNull
public List<NagReportFormat> getFormats()