ConstructNode

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.amazon.awscdk.core.ConstructNode

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-29T04:32:13.673Z")
public class ConstructNode
extends software.amazon.jsii.JsiiObject

Represents the construct node in the scope tree.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.core.*;
 Construct construct;
 ConstructNode constructNode = new ConstructNode(construct, construct, "id");

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String PATH_SEP
Separator used to delimit construct path components.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`PATH_SEP` Separator used to delimit construct path components.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`ConstructNode(Construct host, IConstruct scope, java.lang.String id)`
`protected`	`ConstructNode(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`ConstructNode(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addDependency(IDependable... dependencies)` Add an ordering dependency on another Construct.
`void`	`addError(java.lang.String message)` Deprecated. use `Annotations.of(construct).addError()`
`void`	`addInfo(java.lang.String message)` Deprecated. use `Annotations.of(construct).addInfo()`
`void`	`addMetadata(java.lang.String type, java.lang.Object data)` Adds a metadata entry to this construct.
`void`	`addMetadata(java.lang.String type, java.lang.Object data, java.lang.Object fromFunction)` Adds a metadata entry to this construct.
`void`	`addValidation(software.constructs.IValidation validation)` Add a validator to this construct Node.
`void`	`addWarning(java.lang.String message)` Deprecated. use `Annotations.of(construct).addWarning()`
`void`	`applyAspect(IAspect aspect)` Deprecated. This API is going to be removed in the next major version of the AWS CDK. Please use `Aspects.of(scope).add()` instead.
`java.util.List<IConstruct>`	`findAll()` Return this construct and all of its children in the given order.
`java.util.List<IConstruct>`	`findAll(ConstructOrder order)` Return this construct and all of its children in the given order.
`IConstruct`	`findChild(java.lang.String id)` Return a direct child by id.
`java.lang.String`	`getAddr()` Returns an opaque tree-unique address for this construct.
`java.util.List<IConstruct>`	`getChildren()` All direct children of this construct.
`IConstruct`	`getDefaultChild()` Returns the child construct that has the id `Default` or `Resource"`.
`java.util.List<Dependency>`	`getDependencies()` Return all dependencies registered on this node or any of its children.
`java.lang.String`	`getId()` The id of this construct within the current scope.
`java.lang.Boolean`	`getLocked()` Returns true if this construct or the scopes in which it is defined are locked.
`java.util.List<MetadataEntry>`	`getMetadata()` Deprecated. use `metadataEntry`
`java.util.List<software.constructs.MetadataEntry>`	`getMetadataEntry()` An immutable array of metadata objects associated with this construct.
`java.lang.String`	`getPath()` The full, absolute path of this construct in the tree.
`IConstruct`	`getRoot()`
`IConstruct`	`getScope()` Returns the scope in which this construct is defined.
`java.util.List<IConstruct>`	`getScopes()` All parent scopes of this construct.
`java.lang.String`	`getUniqueId()` Deprecated. use `node.addr` to obtain a consistent 42 character address for this node (see https://github.com/aws/constructs/pull/314). Alternatively, to get a CloudFormation-compatible unique identifier, use `Names.uniqueId()`.
`static void`	`prepare(ConstructNode node)` Deprecated. Use `app.synth()` instead
`void`	`setContext(java.lang.String key, java.lang.Object value)` This can be used to set contextual values.
`void`	`setDefaultChild(IConstruct value)` Returns the child construct that has the id `Default` or `Resource"`.
`static CloudAssembly`	`synth(ConstructNode node)` Deprecated. Use `app.synth()` or `stage.synth()` instead
`static CloudAssembly`	`synth(ConstructNode node, SynthesisOptions options)` Deprecated. Use `app.synth()` or `stage.synth()` instead
`IConstruct`	`tryFindChild(java.lang.String id)` Return a direct child by id, or undefined.
`java.lang.Object`	`tryGetContext(java.lang.String key)` Retrieves a value from tree context.
`java.lang.Boolean`	`tryRemoveChild(java.lang.String childName)` Remove the child with the given name, if present.
`static java.util.List<ValidationError>`	`validate(ConstructNode node)` Invokes "validate" on all constructs in the tree (depth-first, pre-order) and returns the list of all errors.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PATH_SEP
```
public static final java.lang.String PATH_SEP
```
    Separator used to delimit construct path components.
- Constructor Detail
  - ConstructNode
```
protected ConstructNode(software.amazon.jsii.JsiiObjectRef objRef)
```
  - ConstructNode
```
protected ConstructNode(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - ConstructNode
```
public ConstructNode(Construct host,
                     IConstruct scope,
                     java.lang.String id)
```
    Parameters:
    
    host - This parameter is required.
    
    scope - This parameter is required.
    
    id - This parameter is required.
- Method Detail
  - prepare
```
@Deprecated
public static void prepare(ConstructNode node)
```
    Deprecated. Use `app.synth()` instead
    
    (deprecated) Invokes "prepare" on all constructs (depth-first, post-order) in the tree under `node`.
    
    Parameters:
    
    node - The root node. This parameter is required.
  - synth
```
@Deprecated
public static CloudAssembly synth(ConstructNode node,
                                              SynthesisOptions options)
```
    Deprecated. Use `app.synth()` or `stage.synth()` instead
    
    (deprecated) Synthesizes a CloudAssembly from a construct tree.
    
    Parameters:
    
    node - The root of the construct tree. This parameter is required.
    
    options - Synthesis options.
  - synth
```
@Deprecated
public static CloudAssembly synth(ConstructNode node)
```
    Deprecated. Use `app.synth()` or `stage.synth()` instead
    
    (deprecated) Synthesizes a CloudAssembly from a construct tree.
    
    Parameters:
    
    node - The root of the construct tree. This parameter is required.
  - validate
```
public static java.util.List<ValidationError> validate(ConstructNode node)
```
    Invokes "validate" on all constructs in the tree (depth-first, pre-order) and returns the list of all errors.
    An empty list indicates that there are no errors.
    
    Parameters:
    
    node - The root node. This parameter is required.
  - addDependency
```
public void addDependency(IDependable... dependencies)
```
    Add an ordering dependency on another Construct.
    All constructs in the dependency's scope will be deployed before any construct in this construct's scope.
    
    Parameters:
    
    dependencies - This parameter is required.
  - addError
```
@Deprecated
public void addError(java.lang.String message)
```
    Deprecated. use `Annotations.of(construct).addError()`
    
    (deprecated) DEPRECATED: Adds an { "error": } metadata entry to this construct.
    The toolkit will fail synthesis when errors are reported.
    
    Parameters:
    
    message - The error message. This parameter is required.
  - addInfo
```
@Deprecated
public void addInfo(java.lang.String message)
```
    Deprecated. use `Annotations.of(construct).addInfo()`
    
    (deprecated) DEPRECATED: Adds a { "info": } metadata entry to this construct.
    The toolkit will display the info message when apps are synthesized.
    
    Parameters:
    
    message - The info message. This parameter is required.
  - addMetadata
```
public void addMetadata(java.lang.String type,
                        java.lang.Object data,
                        java.lang.Object fromFunction)
```
    Adds a metadata entry to this construct.
    Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.
    
    Parameters:
    
    type - a string denoting the type of metadata. This parameter is required.
    
    data - the value of the metadata (can be a Token). This parameter is required.
    
    fromFunction - a function under which to restrict the metadata entry's stack trace (defaults to this.addMetadata).
  - addMetadata
```
public void addMetadata(java.lang.String type,
                        java.lang.Object data)
```
    Adds a metadata entry to this construct.
    Entries are arbitrary values and will also include a stack trace to allow tracing back to the code location for when the entry was added. It can be used, for example, to include source mapping in CloudFormation templates to improve diagnostics.
    
    Parameters:
    
    type - a string denoting the type of metadata. This parameter is required.
    
    data - the value of the metadata (can be a Token). This parameter is required.
  - addValidation
```
public void addValidation(software.constructs.IValidation validation)
```
    Add a validator to this construct Node.
    
    Parameters:
    
    validation - This parameter is required.
  - addWarning
```
@Deprecated
public void addWarning(java.lang.String message)
```
    Deprecated. use `Annotations.of(construct).addWarning()`
    
    (deprecated) DEPRECATED: Adds a { "warning": } metadata entry to this construct.
    The toolkit will display the warning when an app is synthesized, or fail if run in --strict mode.
    
    Parameters:
    
    message - The warning message. This parameter is required.
  - applyAspect
```
@Deprecated
public void applyAspect(IAspect aspect)
```
    Deprecated. This API is going to be removed in the next major version of the AWS CDK. Please use `Aspects.of(scope).add()` instead.
    
    (deprecated) DEPRECATED: Applies the aspect to this Constructs node.
    
    Parameters:
    
    aspect - This parameter is required.
  - findAll
```
public java.util.List<IConstruct> findAll(ConstructOrder order)
```
    Return this construct and all of its children in the given order.
    
    Parameters:
    
    order -
  - findAll
```
public java.util.List<IConstruct> findAll()
```
    Return this construct and all of its children in the given order.
  - findChild
```
public IConstruct findChild(java.lang.String id)
```
    Return a direct child by id.
    Throws an error if the child is not found.
    
    Parameters:
    
    id - Identifier of direct child. This parameter is required.
    
    Returns:
    
    Child with the given id.
  - setContext
```
public void setContext(java.lang.String key,
                       java.lang.Object value)
```
    This can be used to set contextual values.
    Context must be set before any children are added, since children may consult context info during construction. If the key already exists, it will be overridden.
    
    Parameters:
    
    key - The context key. This parameter is required.
    
    value - The context value. This parameter is required.
  - tryFindChild
```
public IConstruct tryFindChild(java.lang.String id)
```
    Return a direct child by id, or undefined.
    
    Parameters:
    
    id - Identifier of direct child. This parameter is required.
    
    Returns:
    
    the child if found, or undefined
  - tryGetContext
```
public java.lang.Object tryGetContext(java.lang.String key)
```
    Retrieves a value from tree context.
    Context is usually initialized at the root, but can be overridden at any point in the tree.
    
    Parameters:
    
    key - The context key. This parameter is required.
    
    Returns:
    
    The context value or `undefined` if there is no context value for the key.
  - tryRemoveChild
```
public java.lang.Boolean tryRemoveChild(java.lang.String childName)
```
    Remove the child with the given name, if present.
    
    Parameters:
    
    childName - This parameter is required.
    
    Returns:
    
    Whether a child with the given name was deleted.
  - getAddr
```
public java.lang.String getAddr()
```
    Returns an opaque tree-unique address for this construct.
    Addresses are 42 characters hexadecimal strings. They begin with "c8" followed by 40 lowercase hexadecimal characters (0-9a-f).
    Addresses are calculated using a SHA-1 of the components of the construct path.
    To enable refactorings of construct trees, constructs with the ID Default will be excluded from the calculation. In those cases constructs in the same tree may have the same addreess.
    Example value: c83a2846e506bcc5f10682b564084bca2d275709ee
  - getChildren
```
public java.util.List<IConstruct> getChildren()
```
    All direct children of this construct.
  - getDependencies
```
public java.util.List<Dependency> getDependencies()
```
    Return all dependencies registered on this node or any of its children.
  - getId
```
public java.lang.String getId()
```
    The id of this construct within the current scope.
    This is a a scope-unique id. To obtain an app-unique id for this construct, use uniqueId.
  - getLocked
```
public java.lang.Boolean getLocked()
```
    Returns true if this construct or the scopes in which it is defined are locked.
  - getMetadata
```
@Deprecated
public java.util.List<MetadataEntry> getMetadata()
```
    Deprecated. use `metadataEntry`
    
    (deprecated) DEPRECATED.
  - getMetadataEntry
```
public java.util.List<software.constructs.MetadataEntry> getMetadataEntry()
```
    An immutable array of metadata objects associated with this construct.
    This can be used, for example, to implement support for deprecation notices, source mapping, etc.
  - getPath
```
public java.lang.String getPath()
```
    The full, absolute path of this construct in the tree.
    Components are separated by '/'.
  - getRoot
```
public IConstruct getRoot()
```
    Returns:
    
    The root of the construct tree.
  - getScopes
```
public java.util.List<IConstruct> getScopes()
```
    All parent scopes of this construct.
    
    Returns:
    
    a list of parent scopes. The last element in the list will always be the current construct and the first element will be the root of the tree.
  - getUniqueId
```
@Deprecated
public java.lang.String getUniqueId()
```
    Deprecated. use `node.addr` to obtain a consistent 42 character address for this node (see https://github.com/aws/constructs/pull/314). Alternatively, to get a CloudFormation-compatible unique identifier, use `Names.uniqueId()`.
    
    (deprecated) A tree-global unique alphanumeric identifier for this construct.
    Includes all components of the tree.
  - getScope
```
public IConstruct getScope()
```
    Returns the scope in which this construct is defined.
    The value is undefined at the root of the construct scope tree.
  - getDefaultChild
```
public IConstruct getDefaultChild()
```
    Returns the child construct that has the id `Default` or `Resource"`.
    This is usually the construct that provides the bulk of the underlying functionality. Useful for modifications of the underlying construct that are not available at the higher levels. Override the defaultChild property.
    This should only be used in the cases where the correct default child is not named 'Resource' or 'Default' as it should be.
    If you set this to undefined, the default behavior of finding the child named 'Resource' or 'Default' will be used.
    
    Returns:
    
    a construct or undefined if there is no default child
  - setDefaultChild
```
public void setDefaultChild(IConstruct value)
```
    Returns the child construct that has the id `Default` or `Resource"`.
    This is usually the construct that provides the bulk of the underlying functionality. Useful for modifications of the underlying construct that are not available at the higher levels. Override the defaultChild property.
    This should only be used in the cases where the correct default child is not named 'Resource' or 'Default' as it should be.
    If you set this to undefined, the default behavior of finding the child named 'Resource' or 'Default' will be used.

Class ConstructNode

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PATH_SEP

Constructor Detail

ConstructNode

ConstructNode

ConstructNode

Method Detail

prepare

synth

synth

validate

addDependency

addError

addInfo

addMetadata

addMetadata

addValidation

addWarning

applyAspect

findAll

findAll

findChild

setContext

tryFindChild

tryGetContext

tryRemoveChild

getAddr

getChildren

getDependencies

getId

getLocked

getMetadata

getMetadataEntry

getPath

getRoot

getScopes

getUniqueId

getScope

getDefaultChild

setDefaultChild