Package io.github.cdklabs.cdknag

Class AnnotationLogger.Builder

java.lang.Object

io.github.cdklabs.cdknag.AnnotationLogger.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AnnotationLogger>

Enclosing class:

AnnotationLogger

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

A fluent builder for AnnotationLogger.

Method Summary

Modifier and Type	Method	Description
AnnotationLogger	build()
static AnnotationLogger.Builder	create()
AnnotationLogger.Builder	logIgnores(Boolean logIgnores)	Whether or not to log suppressed rule violations as informational messages (default: false).
AnnotationLogger.Builder	verbose(Boolean verbose)	Whether or not to enable extended explanatory descriptions on warning, error, and logged ignore messages.

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 AnnotationLogger.Builder create()

Returns:

a new instance of AnnotationLogger.Builder.

logIgnores

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

verbose

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

Whether or not to enable extended explanatory descriptions on warning, error, and logged ignore messages.

Parameters:

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

Returns:

this

build

@Stability(Stable)
public AnnotationLogger build()

Specified by:

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

Returns:

a newly built instance of AnnotationLogger.