Package io.github.cdklabs.cdknag

Interface NagPackProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

NagPackProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.94.0 (build b380f01)",
           date="2024-02-29T00:11:41.015Z")
@Stability(Stable)
public interface NagPackProps
extends software.amazon.jsii.JsiiSerializable

Interface for creating a NagPack.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	NagPackProps.Builder	A builder for NagPackProps
static class	NagPackProps.Jsii$Proxy	An implementation for NagPackProps

Method Summary

Modifier and Type	Method	Description
static NagPackProps.Builder	builder()
default List<INagLogger>	getAdditionalLoggers()	Additional NagLoggers for logging rule validation outputs.
default Boolean	getLogIgnores()	Whether or not to log suppressed rule violations as informational messages (default: false).
default List<NagReportFormat>	getReportFormats()	If reports are enabled, the output formats of compliance reports in the App's output directory (default: only CSV).
default Boolean	getReports()	Whether or not to generate compliance reports for applied Stacks in the App's output directory (default: true).
default INagSuppressionIgnore	getSuppressionIgnoreCondition()	Conditionally prevent rules from being suppressed (default: no user provided condition).
default Boolean	getVerbose()	Whether or not to enable extended explanatory descriptions on warning, error, and logged ignore messages (default: false).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAdditionalLoggers

@Stability(Stable)
@Nullable
default List<INagLogger> getAdditionalLoggers()

Additional NagLoggers for logging rule validation outputs.

getLogIgnores

@Stability(Stable)
@Nullable
default Boolean getLogIgnores()

Whether or not to log suppressed rule violations as informational messages (default: false).

getReportFormats

@Stability(Stable)
@Nullable
default List<NagReportFormat> getReportFormats()

If reports are enabled, the output formats of compliance reports in the App's output directory (default: only CSV).

getReports

@Stability(Stable)
@Nullable
default Boolean getReports()

Whether or not to generate compliance reports for applied Stacks in the App's output directory (default: true).

getSuppressionIgnoreCondition

@Stability(Stable)
@Nullable
default INagSuppressionIgnore getSuppressionIgnoreCondition()

Conditionally prevent rules from being suppressed (default: no user provided condition).

getVerbose

@Stability(Stable)
@Nullable
default Boolean getVerbose()

Whether or not to enable extended explanatory descriptions on warning, error, and logged ignore messages (default: false).

builder

@Stability(Stable)
static NagPackProps.Builder builder()

Returns:

a NagPackProps.Builder of NagPackProps