Package software.aws.awsprototypingsdk.cdkgraph

Class CdkGraph

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.aws.awsprototypingsdk.cdkgraph.CdkGraph

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.82.0 (build 2d2ddd7)",
           date="2023-08-24T23:07:44.295Z")
@Stability(Experimental)
public class CdkGraph
extends software.constructs.Construct

(experimental) CdkGraph construct is the cdk-graph framework controller that is responsible for computing the graph, storing serialized graph, and instrumenting plugins per the plugin contract.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CdkGraph.Builder	(experimental) A fluent builder for CdkGraph.

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

Field Summary

Fields

Modifier and Type	Field	Description
static String	ID	(experimental) Fixed CdkGraph construct id.
static String	VERSION	(experimental) Current CdkGraph semantic version.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CdkGraph(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CdkGraph(software.amazon.jsii.JsiiObjectRef objRef)
	CdkGraph(software.constructs.Construct root)
	CdkGraph(software.constructs.Construct root, ICdkGraphProps props)

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getConfig()	(experimental) Config.
CdkGraphContext	getGraphContext()	(experimental) Get the context for the graph instance.
List<ICdkGraphPlugin>	getPlugins()	(experimental) List of plugins registered with this instance.
software.constructs.Construct	getRoot()
void	report()	(experimental) Asynchronous report generation.

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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

ID

@Stability(Experimental)
public static final String ID

(experimental) Fixed CdkGraph construct id.

VERSION

@Stability(Experimental)
public static final String VERSION

(experimental) Current CdkGraph semantic version.

Constructor Detail

CdkGraph

protected CdkGraph(software.amazon.jsii.JsiiObjectRef objRef)

CdkGraph

protected CdkGraph(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CdkGraph

@Stability(Experimental)
public CdkGraph(@NotNull
                software.constructs.Construct root,
                @Nullable
                ICdkGraphProps props)

Parameters:

root - This parameter is required.

props -

CdkGraph

@Stability(Experimental)
public CdkGraph(@NotNull
                software.constructs.Construct root)

Parameters:

root - This parameter is required.

Method Detail

report

@Stability(Experimental)
public void report()

(experimental) Asynchronous report generation. This operation enables running expensive and non-synchronous report generation by plugins post synthesis.

If a given plugin requires performing asynchronous operations or is general expensive, it should utilize report rather than synthesize.

getConfig

@Stability(Experimental)
@NotNull
public Map<String,Object> getConfig()

(experimental) Config.

getPlugins

@Stability(Experimental)
@NotNull
public List<ICdkGraphPlugin> getPlugins()

(experimental) List of plugins registered with this instance.

getRoot

@Stability(Experimental)
@NotNull
public software.constructs.Construct getRoot()

getGraphContext

@Stability(Experimental)
@Nullable
public CdkGraphContext getGraphContext()

(experimental) Get the context for the graph instance.

This will be undefined before construct synthesis has initiated.