Package io.github.cdklabs.cdknag

Class NagRules

  • All Implemented Interfaces:
    software.amazon.jsii.JsiiSerializable
    @Generated(value="jsii-pacmak/1.94.0 (build b380f01)",
           date="2024-02-11T00:12:48.886Z")
@Stability(Stable)
public class NagRules
extends software.amazon.jsii.JsiiObject
    Helper class with methods for rule creation.

    • Nested Class Summary

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

        software.amazon.jsii.JsiiObject.InitializationMode

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
        NagRules()  
      protected NagRules​(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)  
      protected NagRules​(software.amazon.jsii.JsiiObjectRef objRef)  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static Object resolveIfPrimitive​(software.amazon.awscdk.CfnResource node, Object parameter)
      Use in cases where a primitive value must be known to pass a rule.
      static Object resolveResourceFromInstrinsic​(software.amazon.awscdk.CfnResource node, Object parameter)
      Use in cases where a token resolves to an intrinsic function and the referenced resource must be known to pass a rule.

      • Methods inherited from class software.amazon.jsii.JsiiObject

        jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

      • Methods inherited from interface software.amazon.jsii.JsiiSerializable

        $jsii$toJson

    • Constructor Detail

      • NagRules

        protected NagRules​(software.amazon.jsii.JsiiObjectRef objRef)

      • NagRules

        protected NagRules​(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

      • NagRules

        @Stability(Stable)
public NagRules()

    • Method Detail

      • resolveIfPrimitive

        @Stability(Stable)
@NotNull
public static Object resolveIfPrimitive​(@NotNull
                                        software.amazon.awscdk.CfnResource node,
                                        @NotNull
                                        Object parameter)
        Use in cases where a primitive value must be known to pass a rule.

        https://developer.mozilla.org/en-US/docs/Glossary/Primitive

        Parameters:
        node - The CfnResource to check. This parameter is required.
        parameter - The value to attempt to resolve. This parameter is required.
        Returns:
        Return a value if resolves to a primitive data type, otherwise throw an error.

      • resolveResourceFromInstrinsic

        @Stability(Stable)
@NotNull
public static Object resolveResourceFromInstrinsic​(@NotNull
                                                   software.amazon.awscdk.CfnResource node,
                                                   @NotNull
                                                   Object parameter)
        Use in cases where a token resolves to an intrinsic function and the referenced resource must be known to pass a rule.

        Parameters:
        node - The CfnResource to check. This parameter is required.
        parameter - The value to attempt to resolve. This parameter is required.
        Returns:
        Return the Logical resource Id if resolves to a intrinsic function, otherwise the resolved provided value.