software.amazon.awscdk.core

Class Construct

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

All Implemented Interfaces:

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

Direct Known Subclasses:

AssetStaging, CfnElement, CfnJson, CustomResourceProvider, Resource, Stack, Stage

@Generated(value="jsii-pacmak/1.28.0 (build 1801f4f)",
           date="2021-05-04T12:08:33.589Z")
 @Stability(value=Stable)
public class Construct
extends software.constructs.Construct
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.constructs.Construct

software.constructs.Construct.Builder

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$Default, IConstruct.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	Construct(software.constructs.Construct scope, String id)
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() The construct tree node associated with this construct.
static Boolean	isConstruct(Object x) Return whether the given object is a Construct.
protected void	onPrepare() Perform final modifications before synthesis.
protected void	onSynthesize(software.constructs.ISynthesisSession session) Allows this construct to emit artifacts into the cloud assembly during synthesis.
protected List<String>	onValidate() Validate the current 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.
protected List<String>	validate() Validate the current construct.

Methods inherited from class software.constructs.Construct

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

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(@NotNull
                                          software.constructs.Construct scope,
                                          @NotNull
                                          String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

isConstruct

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

Return whether the given object is a Construct.

Parameters:

x - This parameter is required.

onPrepare

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

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.

Overrides:

onPrepare in class software.constructs.Construct

onSynthesize

@Stability(value=Stable)
protected void onSynthesize(@NotNull
                                                     software.constructs.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.

Overrides:

onSynthesize in class software.constructs.Construct

Parameters:

session - The synthesis session. This parameter is required.

onValidate

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

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.

Overrides:

onValidate in class software.constructs.Construct

Returns:

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

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(@NotNull
                                                   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.

validate

@Stability(value=Stable)
 @NotNull
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 the construct is valid.

getNode

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

The construct tree node associated with this construct.