software.amazon.awscdk.core

Class Construct

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.core.Construct

All Implemented Interfaces:

IConstruct, IDependable, software.amazon.jsii.JsiiSerializable

Direct Known Subclasses:

App, CfnElement, Resource, Stack

@Generated(value="jsii-pacmak/0.20.6 (build 17f281e)",
           date="2019-11-19T17:18:01.079Z")
 @Stability(value=Stable)
public class Construct
extends software.amazon.jsii.JsiiObject
implements IConstruct

Represents the building block of the construct graph. All constructs besides the root construct must be created within the scope of another construct.

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.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	Construct(Construct scope, String id) Creates a new construct node.
protected	Construct(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Construct(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
ConstructNode	getNode() Construct tree node which offers APIs for interacting with the construct tree.
static Boolean	isConstruct(Object x) Return whether the given object is a Construct.
protected void	prepare() Perform final modifications before synthesis.
protected void	synthesize(ISynthesisSession session) Allows this construct to emit artifacts into the cloud assembly during synthesis.
String	toString() Returns a string representation of this construct.
protected List<String>	validate() Validate the current construct.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiCall, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticGet, 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

Constructor Detail

Construct

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

Construct

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

Construct

@Stability(value=Stable)
public Construct(Construct scope,
                                          String id)

Creates a new construct node.

Parameters:

scope - The scope in which to define this construct. This parameter is required.

id - The scoped construct ID. This parameter is required.

Method Detail

isConstruct

@Stability(value=Stable)
public static Boolean isConstruct(Object x)

Return whether the given object is a Construct.

Parameters:

x - This parameter is required.

prepare

@Stability(value=Stable)
protected void prepare()

Perform final modifications before synthesis. This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared. This is an advanced framework feature. Only use this if you understand the implications.

synthesize

@Stability(value=Stable)
protected void synthesize(ISynthesisSession session)

Allows this construct to emit artifacts into the cloud assembly during synthesis. This method is usually implemented by framework-level constructs such as `Stack` and `Asset` as they participate in synthesizing the cloud assembly.

Parameters:

session - The synthesis session. This parameter is required.

toString

@Stability(value=Stable)
public String toString()

Returns a string representation of this construct.

Overrides:

toString in class Object

validate

@Stability(value=Stable)
protected List<String> validate()

Validate the current construct. This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Returns:

An array of validation error messages, or an empty array if there the construct is valid.

getNode

@Stability(value=Stable)
public ConstructNode getNode()

Construct tree node which offers APIs for interacting with the construct tree.

Specified by:

getNode in interface IConstruct