Package io.github.cdklabs.cdknag

Class NagSuppressions

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.cdknag.NagSuppressions

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-22T00:11:30.593Z")
@Stability(Stable)
public class NagSuppressions
extends software.amazon.jsii.JsiiObject

Helper class with methods to add cdk-nag suppressions to cdk resources.

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor	Description
	NagSuppressions()
protected	NagSuppressions(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	NagSuppressions(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
static void	addResourceSuppressions(Object construct, List<? extends NagPackSuppression> suppressions)	Add cdk-nag suppressions to a CfnResource and optionally its children.
static void	addResourceSuppressions(Object construct, List<? extends NagPackSuppression> suppressions, Boolean applyToChildren)	Add cdk-nag suppressions to a CfnResource and optionally its children.
static void	addResourceSuppressionsByPath(software.amazon.awscdk.Stack stack, Object path, List<? extends NagPackSuppression> suppressions)	Add cdk-nag suppressions to a CfnResource and optionally its children via its path.
static void	addResourceSuppressionsByPath(software.amazon.awscdk.Stack stack, Object path, List<? extends NagPackSuppression> suppressions, Boolean applyToChildren)	Add cdk-nag suppressions to a CfnResource and optionally its children via its path.
static void	addStackSuppressions(software.amazon.awscdk.Stack stack, List<? extends NagPackSuppression> suppressions)	Apply cdk-nag suppressions to a Stack and optionally nested stacks.
static void	addStackSuppressions(software.amazon.awscdk.Stack stack, List<? extends NagPackSuppression> suppressions, Boolean applyToNestedStacks)	Apply cdk-nag suppressions to a Stack and optionally nested stacks.

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

NagSuppressions

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

NagSuppressions

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

NagSuppressions

@Stability(Stable)
public NagSuppressions()

Method Detail

addResourceSuppressions

@Stability(Stable)
public static void addResourceSuppressions(@NotNull
                                           Object construct,
                                           @NotNull
                                           List<? extends NagPackSuppression> suppressions,
                                           @Nullable
                                           Boolean applyToChildren)

Add cdk-nag suppressions to a CfnResource and optionally its children.

Parameters:

construct - The IConstruct(s) to apply the suppression to. This parameter is required.

suppressions - A list of suppressions to apply to the resource. This parameter is required.

applyToChildren - Apply the suppressions to children CfnResources (default:false).

addResourceSuppressions

@Stability(Stable)
public static void addResourceSuppressions(@NotNull
                                           Object construct,
                                           @NotNull
                                           List<? extends NagPackSuppression> suppressions)

Add cdk-nag suppressions to a CfnResource and optionally its children.

Parameters:

construct - The IConstruct(s) to apply the suppression to. This parameter is required.

suppressions - A list of suppressions to apply to the resource. This parameter is required.

addResourceSuppressionsByPath

@Stability(Stable)
public static void addResourceSuppressionsByPath(@NotNull
                                                 software.amazon.awscdk.Stack stack,
                                                 @NotNull
                                                 Object path,
                                                 @NotNull
                                                 List<? extends NagPackSuppression> suppressions,
                                                 @Nullable
                                                 Boolean applyToChildren)

Add cdk-nag suppressions to a CfnResource and optionally its children via its path.

Parameters:

stack - The Stack the construct belongs to. This parameter is required.

path - The path(s) to the construct in the provided stack. This parameter is required.

suppressions - A list of suppressions to apply to the resource. This parameter is required.

applyToChildren - Apply the suppressions to children CfnResources (default:false).

addResourceSuppressionsByPath

@Stability(Stable)
public static void addResourceSuppressionsByPath(@NotNull
                                                 software.amazon.awscdk.Stack stack,
                                                 @NotNull
                                                 Object path,
                                                 @NotNull
                                                 List<? extends NagPackSuppression> suppressions)

Add cdk-nag suppressions to a CfnResource and optionally its children via its path.

Parameters:

stack - The Stack the construct belongs to. This parameter is required.

path - The path(s) to the construct in the provided stack. This parameter is required.

suppressions - A list of suppressions to apply to the resource. This parameter is required.

addStackSuppressions

@Stability(Stable)
public static void addStackSuppressions(@NotNull
                                        software.amazon.awscdk.Stack stack,
                                        @NotNull
                                        List<? extends NagPackSuppression> suppressions,
                                        @Nullable
                                        Boolean applyToNestedStacks)

Apply cdk-nag suppressions to a Stack and optionally nested stacks.

Parameters:

stack - The Stack to apply the suppression to. This parameter is required.

suppressions - A list of suppressions to apply to the stack. This parameter is required.

applyToNestedStacks - Apply the suppressions to children stacks (default:false).

addStackSuppressions

@Stability(Stable)
public static void addStackSuppressions(@NotNull
                                        software.amazon.awscdk.Stack stack,
                                        @NotNull
                                        List<? extends NagPackSuppression> suppressions)

Apply cdk-nag suppressions to a Stack and optionally nested stacks.

Parameters:

stack - The Stack to apply the suppression to. This parameter is required.

suppressions - A list of suppressions to apply to the stack. This parameter is required.