Package software.aws.awsprototypingsdk.cdkgraph

Interface ICdkGraphPlugin.Jsii$Default

All Superinterfaces:

ICdkGraphPlugin, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ICdkGraphPlugin.Jsii$Proxy

Enclosing interface:

ICdkGraphPlugin

@Internal
public static interface ICdkGraphPlugin.Jsii$Default
extends ICdkGraphPlugin

Internal default implementation for ICdkGraphPlugin.

Nested Class Summary

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

ICdkGraphPlugin.Jsii$Default, ICdkGraphPlugin.Jsii$Proxy

Method Summary

Modifier and Type	Method	Description
default IGraphPluginBindCallback	getBind()	(experimental) Binds the plugin to the CdkGraph instance.
default List<String>	getDependencies()	(experimental) List of plugins this plugin depends on, including optional semver version (eg: ["foo", "bar@1.2"]).
default String	getId()	(experimental) Unique identifier for this plugin.
default IGraphVisitorCallback	getInspect()	(experimental) Node visitor callback for construct tree traversal.
default IGraphReportCallback	getReport()	(experimental) Generate asynchronous reports based on the graph.
default IGraphSynthesizeCallback	getSynthesize()	(experimental) Called during CDK synthesize to generate synchronous artifacts based on the in-memory graph passed to the plugin.
default String	getVersion()	(experimental) Plugin version.
default void	setBind(IGraphPluginBindCallback value)	(experimental) Binds the plugin to the CdkGraph instance.
default void	setInspect(IGraphVisitorCallback value)	(experimental) Node visitor callback for construct tree traversal.
default void	setReport(IGraphReportCallback value)	(experimental) Generate asynchronous reports based on the graph.
default void	setSynthesize(IGraphSynthesizeCallback value)	(experimental) Called during CDK synthesize to generate synchronous artifacts based on the in-memory graph passed to the plugin.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getId

@Stability(Experimental)
@NotNull
default String getId()

(experimental) Unique identifier for this plugin.

Specified by:

getId in interface ICdkGraphPlugin

getVersion

@Stability(Experimental)
@NotNull
default String getVersion()

(experimental) Plugin version.

Specified by:

getVersion in interface ICdkGraphPlugin

getDependencies

@Stability(Experimental)
@Nullable
default 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 ICdkGraphPlugin

getBind

@Stability(Experimental)
@NotNull
default IGraphPluginBindCallback getBind()

(experimental) Binds the plugin to the CdkGraph instance.

Enables plugins to receive base configs.

Specified by:

getBind in interface ICdkGraphPlugin

setBind

@Stability(Experimental)
default void setBind(@NotNull
                     IGraphPluginBindCallback value)

(experimental) Binds the plugin to the CdkGraph instance.

Enables plugins to receive base configs.

Specified by:

setBind in interface ICdkGraphPlugin

getInspect

@Stability(Experimental)
@Nullable
default IGraphVisitorCallback getInspect()

(experimental) Node visitor callback for construct tree traversal.

This follows IAspect.visit pattern, but the order of visitor traversal in managed by the CdkGraph.

Specified by:

getInspect in interface ICdkGraphPlugin

setInspect

@Stability(Experimental)
default void setInspect(@Nullable
                        IGraphVisitorCallback value)

(experimental) Node visitor callback for construct tree traversal.

This follows IAspect.visit pattern, but the order of visitor traversal in managed by the CdkGraph.

Specified by:

setInspect in interface ICdkGraphPlugin

getReport

@Stability(Experimental)
@Nullable
default 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 ICdkGraphPlugin

setReport

@Stability(Experimental)
default void setReport(@Nullable
                       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 ICdkGraphPlugin

getSynthesize

@Stability(Experimental)
@Nullable
default IGraphSynthesizeCallback getSynthesize()

(experimental) Called during CDK synthesize to generate synchronous artifacts based on the in-memory graph passed to the plugin.

This is called in fifo order of plugins.

Specified by:

getSynthesize in interface ICdkGraphPlugin

setSynthesize

@Stability(Experimental)
default void setSynthesize(@Nullable
                           IGraphSynthesizeCallback value)

(experimental) Called during CDK synthesize to generate synchronous artifacts based on the in-memory graph passed to the plugin.

This is called in fifo order of plugins.

Specified by:

setSynthesize in interface ICdkGraphPlugin