Package software.aws.awsprototypingsdk.pdknag

Class PDKNagApp

  • All Implemented Interfaces:
    software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
    @Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-02-01T23:43:16.033Z")
@Stability(Stable)
public class PDKNagApp
extends software.amazon.awscdk.App

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  PDKNagApp.Builder
      A fluent builder for PDKNagApp.

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

        software.amazon.jsii.JsiiObject.InitializationMode

      • Nested classes/interfaces inherited from interface software.constructs.IConstruct

        software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

    • Constructor Summary

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addNagResult​(NagResult result)  
      List<io.github.cdklabs.cdknag.NagPack> getNagPacks()  
      List<NagResult> nagResults()
      Returns a list of NagResult.
      software.amazon.awscdk.cxapi.CloudAssembly synth()
      Synthesize this stage into a cloud assembly.
      software.amazon.awscdk.cxapi.CloudAssembly synth​(software.amazon.awscdk.StageSynthesisOptions options)
      Synthesize this stage into a cloud assembly.

      • Methods inherited from class software.amazon.awscdk.App

        isApp

      • Methods inherited from class software.amazon.awscdk.Stage

        getAccount, getArtifactId, getAssetOutdir, getOutdir, getParentStage, getRegion, getStageName, isStage, of

      • Methods inherited from class software.constructs.Construct

        getNode, isConstruct, toString

      • 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

      • PDKNagApp

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

      • PDKNagApp

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

      • PDKNagApp

        @Stability(Stable)
public PDKNagApp​(@Nullable
                 PDKNagAppProps props)
        Parameters:
        props -

      • PDKNagApp

        @Stability(Stable)
public PDKNagApp()

    • Method Detail

      • addNagResult

        @Stability(Stable)
public void addNagResult​(@NotNull
                         NagResult result)
        Parameters:
        result - This parameter is required.

      • nagResults

        @Stability(Stable)
@NotNull
public List<NagResult> nagResults()
        Returns a list of NagResult.

        Note: app.synth() must be called before this to retrieve results.

      • synth

        @Stability(Stable)
@NotNull
public software.amazon.awscdk.cxapi.CloudAssembly synth​(@Nullable
                                                        software.amazon.awscdk.StageSynthesisOptions options)
        Synthesize this stage into a cloud assembly.

        Once an assembly has been synthesized, it cannot be modified. Subsequent calls will return the same assembly.

        Overrides:
        synth in class software.amazon.awscdk.Stage
        Parameters:
        options -

      • synth

        @Stability(Stable)
@NotNull
public software.amazon.awscdk.cxapi.CloudAssembly synth()
        Synthesize this stage into a cloud assembly.

        Once an assembly has been synthesized, it cannot be modified. Subsequent calls will return the same assembly.

        Overrides:
        synth in class software.amazon.awscdk.Stage

      • getNagPacks

        @Stability(Stable)
@NotNull
public List<io.github.cdklabs.cdknag.NagPack> getNagPacks()