Package io.github.cdklabs.cdknag

Class NagPackProps.Builder

java.lang.Object

io.github.cdklabs.cdknag.NagPackProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<NagPackProps>

Enclosing interface:

NagPackProps

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

A builder for NagPackProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
NagPackProps.Builder	additionalLoggers(List<? extends INagLogger> additionalLoggers)	Sets the value of NagPackProps.getAdditionalLoggers()
NagPackProps	build()	Builds the configured instance.
NagPackProps.Builder	logIgnores(Boolean logIgnores)	Sets the value of NagPackProps.getLogIgnores()
NagPackProps.Builder	reportFormats(List<? extends NagReportFormat> reportFormats)	Sets the value of NagPackProps.getReportFormats()
NagPackProps.Builder	reports(Boolean reports)	Sets the value of NagPackProps.getReports()
NagPackProps.Builder	suppressionIgnoreCondition(INagSuppressionIgnore suppressionIgnoreCondition)	Sets the value of NagPackProps.getSuppressionIgnoreCondition()
NagPackProps.Builder	verbose(Boolean verbose)	Sets the value of NagPackProps.getVerbose()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

additionalLoggers

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

Sets the value of NagPackProps.getAdditionalLoggers()

Parameters:

additionalLoggers - Additional NagLoggers for logging rule validation outputs.

Returns:

this

logIgnores

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

Sets the value of NagPackProps.getLogIgnores()

Parameters:

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

Returns:

this

reportFormats

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

Sets the value of NagPackProps.getReportFormats()

Parameters:

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

Returns:

this

reports

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

Sets the value of NagPackProps.getReports()

Parameters:

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

Returns:

this

suppressionIgnoreCondition

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

Sets the value of NagPackProps.getSuppressionIgnoreCondition()

Parameters:

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

Returns:

this

verbose

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

Sets the value of NagPackProps.getVerbose()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public NagPackProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of NagPackProps

Throws:

NullPointerException - if any required attribute was not provided