Package software.aws.awsprototypingsdk.cdkgraphplugindiagram

Class CdkGraphDiagramPlugin

  • All Implemented Interfaces:
    software.amazon.jsii.JsiiSerializable, software.aws.awsprototypingsdk.cdkgraph.ICdkGraphPlugin
    @Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-28T05:22:28.479Z")
@Stability(Experimental)
public class CdkGraphDiagramPlugin
extends software.amazon.jsii.JsiiObject
implements software.aws.awsprototypingsdk.cdkgraph.ICdkGraphPlugin
    (experimental) CdkGraphDiagramPlugin is a CdkGraph Plugin implementation for generating diagram artifacts from the CdkGraph framework.

    • Nested Class Summary

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

        software.amazon.jsii.JsiiObject.InitializationMode

      • Nested classes/interfaces inherited from interface software.aws.awsprototypingsdk.cdkgraph.ICdkGraphPlugin

        software.aws.awsprototypingsdk.cdkgraph.ICdkGraphPlugin.Jsii$Default, software.aws.awsprototypingsdk.cdkgraph.ICdkGraphPlugin.Jsii$Proxy

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String ARTIFACT_NS
      (experimental) Namespace for artifacts of the diagram plugin.
      static String ID
      (experimental) Fixed id of the diagram plugin.
      static String VERSION
      (experimental) Current semantic version of the diagram plugin.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static String artifactFilename​(String name, DiagramFormat format)
      (experimental) Get standardized artifact file name for diagram artifacts.
      static String artifactId​(String name, DiagramFormat format)
      (experimental) Get standardized artifact id for diagram artifacts.
      software.aws.awsprototypingsdk.cdkgraph.IGraphPluginBindCallback getBind()
      (experimental) Binds the plugin to the CdkGraph instance.
      IPluginConfig getConfig()
      (experimental) Get diagram plugin config.
      software.aws.awsprototypingsdk.cdkgraph.CdkGraphArtifact getDefaultDotArtifact()
      (experimental) Get default dot artifact.
      software.aws.awsprototypingsdk.cdkgraph.CdkGraphArtifact getDefaultPngArtifact()
      (experimental) Get default PNG artifact.
      List<String> getDependencies()
      (experimental) List of plugins this plugin depends on, including optional semver version (eg: ["foo", "bar@1.2"]).
      software.aws.awsprototypingsdk.cdkgraph.CdkGraphArtifact getDiagramArtifact​(String name, DiagramFormat format)
      (experimental) Get diagram artifact for a given name and format.
      String getId()
      (experimental) Unique identifier for this plugin.
      software.aws.awsprototypingsdk.cdkgraph.IGraphReportCallback getReport()
      (experimental) Generate asynchronous reports based on the graph.
      String getVersion()
      (experimental) Plugin version.
      void setBind​(software.aws.awsprototypingsdk.cdkgraph.IGraphPluginBindCallback value)
      (experimental) Binds the plugin to the CdkGraph instance.
      void setReport​(software.aws.awsprototypingsdk.cdkgraph.IGraphReportCallback value)
      (experimental) Generate asynchronous reports based on the graph.

      • 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.aws.awsprototypingsdk.cdkgraph.ICdkGraphPlugin

        getInspect, getSynthesize, setInspect, setSynthesize

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

        $jsii$toJson

    • Field Detail

      • ARTIFACT_NS

        @Stability(Experimental)
public static final String ARTIFACT_NS
        (experimental) Namespace for artifacts of the diagram plugin.

      • ID

        @Stability(Experimental)
public static final String ID
        (experimental) Fixed id of the diagram plugin.

      • VERSION

        @Stability(Experimental)
public static final String VERSION
        (experimental) Current semantic version of the diagram plugin.

    • Constructor Detail

      • CdkGraphDiagramPlugin

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

      • CdkGraphDiagramPlugin

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

      • CdkGraphDiagramPlugin

        @Stability(Experimental)
public CdkGraphDiagramPlugin​(@Nullable
                             IPluginConfig config)
        Parameters:
        config -

      • CdkGraphDiagramPlugin

        @Stability(Experimental)
public CdkGraphDiagramPlugin()

    • Method Detail

      • artifactFilename

        @Stability(Experimental)
@NotNull
public static String artifactFilename​(@NotNull
                                      String name,
                                      @NotNull
                                      DiagramFormat format)
        (experimental) Get standardized artifact file name for diagram artifacts.

        Parameters:
        name - This parameter is required.
        format - This parameter is required.

      • artifactId

        @Stability(Experimental)
@NotNull
public static String artifactId​(@NotNull
                                String name,
                                @NotNull
                                DiagramFormat format)
        (experimental) Get standardized artifact id for diagram artifacts.

        Parameters:
        name - This parameter is required.
        format - This parameter is required.

      • getDiagramArtifact

        @Stability(Experimental)
@Nullable
public software.aws.awsprototypingsdk.cdkgraph.CdkGraphArtifact getDiagramArtifact​(@NotNull
                                                                                   String name,
                                                                                   @NotNull
                                                                                   DiagramFormat format)
        (experimental) Get diagram artifact for a given name and format.

        Parameters:
        name - This parameter is required.
        format - This parameter is required.

      • getConfig

        @Stability(Experimental)
@NotNull
public IPluginConfig getConfig()
        (experimental) Get diagram plugin config.

      • getId

        @Stability(Experimental)
@NotNull
public String getId()
        (experimental) Unique identifier for this plugin.
        Specified by:
        getId in interface software.aws.awsprototypingsdk.cdkgraph.ICdkGraphPlugin

      • getVersion

        @Stability(Experimental)
@NotNull
public String getVersion()
        (experimental) Plugin version.
        Specified by:
        getVersion in interface software.aws.awsprototypingsdk.cdkgraph.ICdkGraphPlugin

      • getDefaultDotArtifact

        @Stability(Experimental)
@Nullable
public software.aws.awsprototypingsdk.cdkgraph.CdkGraphArtifact getDefaultDotArtifact()
        (experimental) Get default dot artifact.

      • getDefaultPngArtifact

        @Stability(Experimental)
@Nullable
public software.aws.awsprototypingsdk.cdkgraph.CdkGraphArtifact getDefaultPngArtifact()
        (experimental) Get default PNG artifact.

      • getDependencies

        @Stability(Experimental)
@Nullable
public List<String> getDependencies()
        (experimental) List of plugins this plugin depends on, including optional semver version (eg: ["foo", "bar@1.2"]).
        Specified by:
        getDependencies in interface software.aws.awsprototypingsdk.cdkgraph.ICdkGraphPlugin

      • getBind

        @Stability(Experimental)
@NotNull
public software.aws.awsprototypingsdk.cdkgraph.IGraphPluginBindCallback getBind()
        (experimental) Binds the plugin to the CdkGraph instance.

        Enables plugins to receive base configs.

        Specified by:
        getBind in interface software.aws.awsprototypingsdk.cdkgraph.ICdkGraphPlugin

      • setBind

        @Stability(Experimental)
public void setBind​(@NotNull
                    software.aws.awsprototypingsdk.cdkgraph.IGraphPluginBindCallback value)
        (experimental) Binds the plugin to the CdkGraph instance.

        Enables plugins to receive base configs.

        Specified by:
        setBind in interface software.aws.awsprototypingsdk.cdkgraph.ICdkGraphPlugin

      • getReport

        @Stability(Experimental)
@Nullable
public software.aws.awsprototypingsdk.cdkgraph.IGraphReportCallback getReport()
        (experimental) Generate asynchronous reports based on the graph.

        This is not automatically called when synthesizing CDK. Developer must explicitly add await graphInstance.report() to the CDK bin or invoke this outside of the CDK synth. In either case, the plugin receives the in-memory graph interface when invoked, as the CdkGraph will deserialize the graph prior to invoking the plugin report.

        Specified by:
        getReport in interface software.aws.awsprototypingsdk.cdkgraph.ICdkGraphPlugin

      • setReport

        @Stability(Experimental)
public void setReport​(@Nullable
                      software.aws.awsprototypingsdk.cdkgraph.IGraphReportCallback value)
        (experimental) Generate asynchronous reports based on the graph.

        This is not automatically called when synthesizing CDK. Developer must explicitly add await graphInstance.report() to the CDK bin or invoke this outside of the CDK synth. In either case, the plugin receives the in-memory graph interface when invoked, as the CdkGraph will deserialize the graph prior to invoking the plugin report.

        Specified by:
        setReport in interface software.aws.awsprototypingsdk.cdkgraph.ICdkGraphPlugin