AWS CDK Reference

Appearance

v2.274.0

RootConstruct ​

Creates a new root construct node.

The root construct represents the top of the construct tree and is not contained within a parent scope itself. For root constructs, the id is optional.

Source
src/construct.ts

Example ​

ts
import { RootConstruct } from 'constructs';

const rootConstruct = new RootConstruct();
python
from constructs import RootConstruct

root_construct = RootConstruct()
java
import software.constructs.RootConstruct;

RootConstruct rootConstruct = new RootConstruct();
csharp
// Install: dotnet add package Constructs
using Constructs;

var rootConstruct = new RootConstruct();
go
// Install: go get github.com/aws/constructs-go/constructs/v10
import (
	"github.com/aws/jsii-runtime-go"
	"github.com/aws/constructs-go/constructs/v10"
)

rootConstruct := constructs.NewRootConstruct(nil)

Initializer ​

ts
new RootConstruct(id?: string)
python
RootConstruct(id: typing.Optional[str] = None)
java
new RootConstruct(String id)
csharp
new RootConstruct(string? id = null)
go
NewRootConstruct(Id *string)

Properties ​

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#
The tree node.

Methods ​

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#
Checks if `x` is a construct.
notes · 1 parameter · returns

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

  • xxxxX — Any object.

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

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#
Returns a string representation of this construct.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#
Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

1 parameter · returns

Parameters

  • mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining