Package io.github.cdklabs.cdknag

Class AwsSolutionsChecks.Builder

java.lang.Object

io.github.cdklabs.cdknag.AwsSolutionsChecks.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AwsSolutionsChecks>

Enclosing class:

AwsSolutionsChecks

@Stability(Stable)
public static final class AwsSolutionsChecks.Builder
extends Object
implements software.amazon.jsii.Builder<AwsSolutionsChecks>

A fluent builder for AwsSolutionsChecks.

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(Stable)
public static AwsSolutionsChecks.Builder create()

Returns:

a new instance of AwsSolutionsChecks.Builder.

additionalLoggers

@Stability(Stable)
public AwsSolutionsChecks.Builder additionalLoggers(List<? extends INagLogger> additionalLoggers)

Additional NagLoggers for logging rule validation outputs.

Parameters:

additionalLoggers - Additional NagLoggers for logging rule validation outputs. This parameter is required.

Returns:

this

logIgnores

@Stability(Stable)
public AwsSolutionsChecks.Builder logIgnores(Boolean logIgnores)

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

Parameters:

logIgnores - Whether or not to log suppressed rule violations as informational messages (default: false). This parameter is required.

Returns:

this

reportFormats

@Stability(Stable)
public AwsSolutionsChecks.Builder reportFormats(List<? extends NagReportFormat> reportFormats)

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

Parameters:

reportFormats - If reports are enabled, the output formats of compliance reports in the App's output directory (default: only CSV). This parameter is required.

Returns:

this

reports

@Stability(Stable)
public AwsSolutionsChecks.Builder reports(Boolean reports)

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

Parameters:

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

Returns:

this

suppressionIgnoreCondition

@Stability(Stable)
public AwsSolutionsChecks.Builder suppressionIgnoreCondition(INagSuppressionIgnore suppressionIgnoreCondition)

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

Parameters:

suppressionIgnoreCondition - Conditionally prevent rules from being suppressed (default: no user provided condition). This parameter is required.

Returns:

this

verbose

@Stability(Stable)
public AwsSolutionsChecks.Builder verbose(Boolean verbose)

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

Parameters:

verbose - Whether or not to enable extended explanatory descriptions on warning, error, and logged ignore messages (default: false). This parameter is required.

Returns:

this

build

@Stability(Stable)
public AwsSolutionsChecks build()

Specified by:

build in interface software.amazon.jsii.Builder<AwsSolutionsChecks>

Returns:

a newly built instance of AwsSolutionsChecks.