Node (software.constructs:constructs 3.0.1 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.constructs.Node

All Implemented Interfaces:: software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.1.0 (build df55f5e)",
           date="2020-04-14T13:11:34.048Z")
 @Stability(value=Stable)
public class Node
extends software.amazon.jsii.JsiiObject

Represents the construct node in the scope tree.

Nested Class Summary
- Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
  software.amazon.jsii.JsiiObject.InitializationMode

Field Summary

Fields
Modifier and Type Field and Description

static String PATH_SEP
Separator used to delimit construct path components.

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

Constructor Summary

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDependency(IConstruct... dependencies)` Add an ordering dependency on another Construct.
`void`	`addError(String message)` Adds an { "error": } metadata entry to this construct.
`void`	`addInfo(String message)` Adds a { "info": } metadata entry to this construct.
`void`	`addMetadata(String type, Object data)` Adds a metadata entry to this construct.
`void`	`addMetadata(String type, Object data, Object fromFunction)` Adds a metadata entry to this construct.
`void`	`addWarning(String message)` Adds a { "warning": } metadata entry to this construct.
`void`	`applyAspect(IAspect aspect)` Applies the aspect to this Constructs node.
`List<IConstruct>`	`findAll()` Return this construct and all of its children in the given order.
`List<IConstruct>`	`findAll(ConstructOrder order)` Return this construct and all of its children in the given order.
`IConstruct`	`findChild(String id)` Return a direct child by id.
`List<IConstruct>`	`getChildren()` All direct children of this construct.
`IConstruct`	`getDefaultChild()` Returns the child construct that has the id `Default` or `Resource"`.
`List<Dependency>`	`getDependencies()` Return all dependencies registered on this node or any of its children.
`String`	`getId()` The id of this construct within the current scope.
`Boolean`	`getLocked()` Returns true if this construct or the scopes in which it is defined are locked.
`List<MetadataEntry>`	`getMetadata()` An immutable array of metadata objects associated with this construct.
`String`	`getPath()` The full, absolute path of this construct in the tree.
`IConstruct`	`getRoot()` Returns the root of the construct tree.
`IConstruct`	`getScope()` Returns the scope in which this construct is defined.
`List<IConstruct>`	`getScopes()` All parent scopes of this construct.
`String`	`getUniqueId()` A tree-global unique alphanumeric identifier for this construct.
`static Node`	`of(IConstruct construct)` Returns the node associated with a construct.
`void`	`prepare()` Invokes "prepare" on all constructs (depth-first, post-order) in the tree under `node`.
`void`	`setContext(String key, 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"`.
`void`	`synthesize(SynthesisOptions options)` Synthesizes a CloudAssembly from a construct tree.
`IConstruct`	`tryFindChild(String id)` Return a direct child by id, or undefined.
`Object`	`tryGetContext(String key)` Retrieves a value from tree context.
`Boolean`	`tryRemoveChild(String childName)` Remove the child with the given name, if present.
`List<ValidationError>`	`validate()` Invokes "validate" on all constructs in the tree (depth-first, pre-order) and returns the list of all errors.

Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Field Detail
  - PATH_SEP
```
@Stability(value=Stable)
public static final String PATH_SEP
```
    Separator used to delimit construct path components.
- Constructor Detail
  - Node
```
protected Node(software.amazon.jsii.JsiiObjectRef objRef)
```
  - Node
```
protected Node(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - Node
```
@Stability(value=Stable)
public Node(@NotNull
                                     Construct host,
                                     @NotNull
                                     IConstruct scope,
                                     @NotNull
                                     String id)
```
    Parameters:
    
    host - This parameter is required.
    
    scope - This parameter is required.
    
    id - This parameter is required.
- Method Detail
  - of
```
@Stability(value=Stable)
 @NotNull
public static Node of(@NotNull
                                                         IConstruct construct)
```
    Returns the node associated with a construct.
    
    Parameters:
    
    construct - the construct. This parameter is required.
  - addDependency
```
@Stability(value=Stable)
public void addDependency(@NotNull
                                                   IConstruct... 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
```
@Stability(value=Stable)
public void addError(@NotNull
                                              String message)
```
    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
```
@Stability(value=Stable)
public void addInfo(@NotNull
                                             String message)
```
    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
```
@Stability(value=Stable)
public void addMetadata(@NotNull
                                                 String type,
                                                 @NotNull
                                                 Object data,
                                                 @Nullable
                                                 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
```
@Stability(value=Stable)
public void addMetadata(@NotNull
                                                 String type,
                                                 @NotNull
                                                 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.
  - addWarning
```
@Stability(value=Stable)
public void addWarning(@NotNull
                                                String message)
```
    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
```
@Stability(value=Stable)
public void applyAspect(@NotNull
                                                 IAspect aspect)
```
    Applies the aspect to this Constructs node.
    
    Parameters:
    
    aspect - This parameter is required.
  - findAll
```
@Stability(value=Stable)
 @NotNull
public List<IConstruct> findAll(@Nullable
                                                                   ConstructOrder order)
```
    Return this construct and all of its children in the given order.
    
    Parameters:
    
    order -
  - findAll
```
@Stability(value=Stable)
 @NotNull
public List<IConstruct> findAll()
```
    Return this construct and all of its children in the given order.
  - findChild
```
@Stability(value=Stable)
 @NotNull
public IConstruct findChild(@NotNull
                                                               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.
  - prepare
```
@Stability(value=Stable)
public void prepare()
```
    Invokes "prepare" on all constructs (depth-first, post-order) in the tree under `node`.
  - setContext
```
@Stability(value=Stable)
public void setContext(@NotNull
                                                String key,
                                                @NotNull
                                                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.
  - synthesize
```
@Stability(value=Stable)
public void synthesize(@NotNull
                                                SynthesisOptions options)
```
    Synthesizes a CloudAssembly from a construct tree.
    
    Parameters:
    
    options - Synthesis options. This parameter is required.
  - tryFindChild
```
@Stability(value=Stable)
 @Nullable
public IConstruct tryFindChild(@NotNull
                                                                   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
```
@Stability(value=Stable)
 @NotNull
public Object tryGetContext(@NotNull
                                                               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 thie key.
  - tryRemoveChild
```
@Stability(value=Experimental)
 @NotNull
public Boolean tryRemoveChild(@NotNull
                                                                       String childName)
```
    Remove the child with the given name, if present.
    EXPERIMENTAL
    
    Parameters:
    
    childName - This parameter is required.
    
    Returns:
    
    Whether a child with the given name was deleted.
  - validate
```
@Stability(value=Stable)
 @NotNull
public List<ValidationError> validate()
```
    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.
  - getChildren
```
@Stability(value=Stable)
 @NotNull
public List<IConstruct> getChildren()
```
    All direct children of this construct.
  - getDependencies
```
@Stability(value=Stable)
 @NotNull
public List<Dependency> getDependencies()
```
    Return all dependencies registered on this node or any of its children.
  - getId
```
@Stability(value=Stable)
 @NotNull
public 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
```
@Stability(value=Stable)
 @NotNull
public Boolean getLocked()
```
    Returns true if this construct or the scopes in which it is defined are locked.
  - getMetadata
```
@Stability(value=Stable)
 @NotNull
public List<MetadataEntry> getMetadata()
```
    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
```
@Stability(value=Stable)
 @NotNull
public String getPath()
```
    The full, absolute path of this construct in the tree.
    Components are separated by '/'.
  - getRoot
```
@Stability(value=Stable)
 @NotNull
public IConstruct getRoot()
```
    Returns the root of the construct tree.
    
    Returns:
    
    The root of the construct tree.
  - getScopes
```
@Stability(value=Stable)
 @NotNull
public 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
```
@Stability(value=Stable)
 @NotNull
public String getUniqueId()
```
    A tree-global unique alphanumeric identifier for this construct.
    Includes all components of the tree.
  - getScope
```
@Stability(value=Stable)
 @Nullable
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
```
@Stability(value=Stable)
 @Nullable
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
```
@Stability(value=Stable)
public void setDefaultChild(@Nullable
                                                     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 Node

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Field Detail

PATH_SEP

Constructor Detail

Node

Node

Node

Method Detail

of

addDependency

addError

addInfo

addMetadata

addMetadata

addWarning

applyAspect

findAll

findAll

findChild

prepare

setContext

synthesize

tryFindChild

tryGetContext

tryRemoveChild

validate

getChildren

getDependencies

getId

getLocked

getMetadata

getPath

getRoot

getScopes

getUniqueId

getScope

getDefaultChild

setDefaultChild