Package software.aws.awsprototypingsdk.cdkgraph

Interface ICdkGraphPlugin

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

ICdkGraphPlugin.Jsii$Default

All Known Implementing Classes:

ICdkGraphPlugin.Jsii$Proxy

@Generated(value="jsii-pacmak/1.82.0 (build 2d2ddd7)",
           date="2023-08-24T23:07:44.344Z")
@Stability(Experimental)
public interface ICdkGraphPlugin
extends software.amazon.jsii.JsiiSerializable

(experimental) CdkGraph Plugin interface.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ICdkGraphPlugin.Jsii$Default	Internal default implementation for ICdkGraphPlugin.
static class	ICdkGraphPlugin.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
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"]).
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.
String	getVersion()	(experimental) Plugin version.
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
String getId()

(experimental) Unique identifier for this plugin.

getVersion

@Stability(Experimental)
@NotNull
String getVersion()

(experimental) Plugin version.

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"]).

getBind

@Stability(Experimental)
@NotNull
IGraphPluginBindCallback getBind()

(experimental) Binds the plugin to the CdkGraph instance.

Enables plugins to receive base configs.

setBind

void setBind(@NotNull
             IGraphPluginBindCallback value)

(experimental) Binds the plugin to the CdkGraph instance.

Enables plugins to receive base configs.

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.

setInspect

@Optional
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.

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.

setReport

@Optional
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.

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.

setSynthesize

@Optional
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.