Package software.constructs

Class Construct

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, IConstruct, IDependable

@Generated(value="jsii-pacmak/1.75.0 (build 63bb957)",
           date="2023-02-21T00:09:41.616Z")
@Stability(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.constructs.IConstruct

IConstruct.Jsii$Default, IConstruct.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Node	getNode()	The tree node.
static Boolean	isConstruct(Object x)	Checks if `x` is a construct.
String	toString()	Returns a string representation of this construct.

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

Constructor Detail

Construct

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

Construct

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

Construct

@Stability(Stable)
public Construct(@NotNull
                 Construct scope,
                 @NotNull
                 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(Stable)
@NotNull
public static Boolean isConstruct(@NotNull
                                  Object x)

Checks if `x` is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x - Any object. This parameter is required.

Returns:

true if `x` is an object created from a class which extends `Construct`.

toString

@Stability(Stable)
@NotNull
public String toString()

Returns a string representation of this construct.

Overrides:

toString in class Object

getNode

@Stability(Stable)
@NotNull
public Node getNode()

The tree node.

Specified by:

getNode in interface IConstruct