# API Reference ## Constructs ### CdkGraph CdkGraph construct is the cdk-graph framework controller that is responsible for computing the graph, storing serialized graph, and instrumenting plugins per the plugin contract. #### Initializers ```java import software.aws.awsprototypingsdk.cdkgraph.CdkGraph; CdkGraph.Builder.create(Construct root) // .plugins(java.util.List) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | root | software.constructs.Construct | *No description.* | | plugins | java.util.List<ICdkGraphPlugin> | List of plugins to extends the graph. | --- ##### `root`^Required - *Type:* software.constructs.Construct --- ##### `plugins`^Optional - *Type:* java.util.List<ICdkGraphPlugin> List of plugins to extends the graph. Plugins are invoked at each phases in fifo order. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | report | Asynchronous report generation. This operation enables running expensive and non-synchronous report generation by plugins post synthesis. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. ##### `report` ```java public void report() ``` Asynchronous report generation. This operation enables running expensive and non-synchronous report generation by plugins post synthesis. If a given plugin requires performing asynchronous operations or is general expensive, it should utilize `report` rather than `synthesize`. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```java import software.aws.awsprototypingsdk.cdkgraph.CdkGraph; CdkGraph.isConstruct(java.lang.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. ###### `x`^Required - *Type:* java.lang.Object Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | config | java.util.Map | Config. | | plugins | java.util.List<ICdkGraphPlugin> | List of plugins registered with this instance. | | root | software.constructs.Construct | *No description.* | | graphContext | CdkGraphContext | Get the context for the graph instance. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `config`^Required ```java public java.util.Map getConfig(); ``` - *Type:* java.util.Map Config. --- ##### `plugins`^Required ```java public java.util.List getPlugins(); ``` - *Type:* java.util.List<ICdkGraphPlugin> List of plugins registered with this instance. --- ##### `root`^Required ```java public Construct getRoot(); ``` - *Type:* software.constructs.Construct --- ##### `graphContext`^Optional ```java public CdkGraphContext getGraphContext(); ``` - *Type:* CdkGraphContext Get the context for the graph instance. This will be `undefined` before construct synthesis has initiated. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ID | java.lang.String | Fixed CdkGraph construct id. | | VERSION | java.lang.String | Current CdkGraph semantic version. | --- ##### `ID`^Required ```java public java.lang.String getId(); ``` - *Type:* java.lang.String Fixed CdkGraph construct id. --- ##### `VERSION`^Required ```java public java.lang.String getVersion(); ``` - *Type:* java.lang.String Current CdkGraph semantic version. --- ## Structs ### CdkGraphArtifact CdkGraph artifact definition. #### Initializer ```java import software.aws.awsprototypingsdk.cdkgraph.CdkGraphArtifact; CdkGraphArtifact.builder() .filename(java.lang.String) .filepath(java.lang.String) .id(java.lang.String) .source(java.lang.String) // .description(java.lang.String) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | filename | java.lang.String | Filename of the artifact. | | filepath | java.lang.String | Full path where artifact is stored. | | id | java.lang.String | The unique type of the artifact. | | source | java.lang.String | The source of the artifact (such as plugin, or core system, etc). | | description | java.lang.String | Description of artifact. | --- ##### `filename`^Required ```java public java.lang.String getFilename(); ``` - *Type:* java.lang.String Filename of the artifact. --- ##### `filepath`^Required ```java public java.lang.String getFilepath(); ``` - *Type:* java.lang.String Full path where artifact is stored. --- ##### `id`^Required ```java public java.lang.String getId(); ``` - *Type:* java.lang.String The unique type of the artifact. --- ##### `source`^Required ```java public java.lang.String getSource(); ``` - *Type:* java.lang.String The source of the artifact (such as plugin, or core system, etc). --- ##### `description`^Optional ```java public java.lang.String getDescription(); ``` - *Type:* java.lang.String Description of artifact. --- ### ConstructInfo Source information on a construct (class fqn and version). > [https://github.com/aws/aws-cdk/blob/cea1039e3664fdfa89c6f00cdaeb1a0185a12678/packages/%40aws-cdk/core/lib/private/runtime-info.ts#L22](https://github.com/aws/aws-cdk/blob/cea1039e3664fdfa89c6f00cdaeb1a0185a12678/packages/%40aws-cdk/core/lib/private/runtime-info.ts#L22) #### Initializer ```java import software.aws.awsprototypingsdk.cdkgraph.ConstructInfo; ConstructInfo.builder() .fqn(java.lang.String) .version(java.lang.String) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | fqn | java.lang.String | *No description.* | | version | java.lang.String | *No description.* | --- ##### `fqn`^Required ```java public java.lang.String getFqn(); ``` - *Type:* java.lang.String --- ##### `version`^Required ```java public java.lang.String getVersion(); ``` - *Type:* java.lang.String --- ### ICdkGraphProps {@link CdkGraph} props. #### Initializer ```java import software.aws.awsprototypingsdk.cdkgraph.ICdkGraphProps; ICdkGraphProps.builder() // .plugins(java.util.List) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | plugins | java.util.List<ICdkGraphPlugin> | List of plugins to extends the graph. | --- ##### `plugins`^Optional ```java public java.util.List getPlugins(); ``` - *Type:* java.util.List<ICdkGraphPlugin> List of plugins to extends the graph. Plugins are invoked at each phases in fifo order. --- ### IGraphFilterPlanFocusConfig #### Initializer ```java import software.aws.awsprototypingsdk.cdkgraph.IGraphFilterPlanFocusConfig; IGraphFilterPlanFocusConfig.builder() .node(Node) .node(IFilterFocusCallback) // .noHoist(java.lang.Boolean) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | Node OR IFilterFocusCallback | The node or resolver to determine the node to focus on. | | noHoist | java.lang.Boolean | Indicates if ancestral containers are preserved (eg: Stages, Stack). | --- ##### `node`^Required ```java public java.lang.Object getNode(); ``` - *Type:* Node OR IFilterFocusCallback The node or resolver to determine the node to focus on. --- ##### `noHoist`^Optional ```java public java.lang.Boolean getNoHoist(); ``` - *Type:* java.lang.Boolean - *Default:* true Indicates if ancestral containers are preserved (eg: Stages, Stack). If `false`, the "focused node" will be hoisted to the graph root and all ancestors will be pruned. If `true`, the "focused" will be left in-place, while all siblings and non-scope ancestors will be pruned. --- ### InferredNodeProps Inferred node props. #### Initializer ```java import software.aws.awsprototypingsdk.cdkgraph.InferredNodeProps; InferredNodeProps.builder() .uuid(java.lang.String) // .attributes(java.util.Map>) // .flags(java.util.List) // .metadata(java.util.List) // .tags(java.util.Map) .dependencies(java.util.List) .unresolvedReferences(java.util.List) // .cfnType(java.lang.String) // .constructInfo(ConstructInfo) // .logicalId(java.lang.String) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | uuid | java.lang.String | Universally unique identity. | | attributes | java.util.MapPlainObject OR java.util.ListPlainObject>> | Serializable entity attributes. | | flags | java.util.List<FlagEnum> | Serializable entity flags. | | metadata | java.util.List | Serializable entity metadata. | | tags | java.util.Map | Serializable entity tags. | | dependencies | java.util.List | *No description.* | | unresolvedReferences | java.util.List<SGUnresolvedReference> | *No description.* | | cfnType | java.lang.String | *No description.* | | constructInfo | ConstructInfo | *No description.* | | logicalId | java.lang.String | *No description.* | --- ##### `uuid`^Required ```java public java.lang.String getUuid(); ``` - *Type:* java.lang.String Universally unique identity. --- ##### `attributes`^Optional ```java public java.lang.Object getAttributes(); ``` - *Type:* java.util.MapPlainObject OR java.util.ListPlainObject>> Serializable entity attributes. > [{@link Attributes }]({@link Attributes }) --- ##### `flags`^Optional ```java public java.util.List getFlags(); ``` - *Type:* java.util.List<FlagEnum> Serializable entity flags. > [{@link FlagEnum }]({@link FlagEnum }) --- ##### `metadata`^Optional ```java public java.util.List getMetadata(); ``` - *Type:* java.util.List Serializable entity metadata. > [{@link Metadata }]({@link Metadata }) --- ##### `tags`^Optional ```java public java.util.Map getTags(); ``` - *Type:* java.util.Map Serializable entity tags. > [{@link Tags }]({@link Tags }) --- ##### `dependencies`^Required ```java public java.util.List getDependencies(); ``` - *Type:* java.util.List --- ##### `unresolvedReferences`^Required ```java public java.util.List getUnresolvedReferences(); ``` - *Type:* java.util.List<SGUnresolvedReference> --- ##### `cfnType`^Optional ```java public java.lang.String getCfnType(); ``` - *Type:* java.lang.String --- ##### `constructInfo`^Optional ```java public ConstructInfo getConstructInfo(); ``` - *Type:* ConstructInfo --- ##### `logicalId`^Optional ```java public java.lang.String getLogicalId(); ``` - *Type:* java.lang.String --- ### PlainObject Serializable plain object value (JSII supported). #### Initializer ```java import software.aws.awsprototypingsdk.cdkgraph.PlainObject; PlainObject.builder() .build(); ``` ### SGEdge Serializable graph edge entity. #### Initializer ```java import software.aws.awsprototypingsdk.cdkgraph.SGEdge; SGEdge.builder() .uuid(java.lang.String) // .attributes(java.util.Map>) // .flags(java.util.List) // .metadata(java.util.List) // .tags(java.util.Map) .direction(EdgeDirectionEnum) .edgeType(EdgeTypeEnum) .source(java.lang.String) .target(java.lang.String) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | uuid | java.lang.String | Universally unique identity. | | attributes | java.util.MapPlainObject OR java.util.ListPlainObject>> | Serializable entity attributes. | | flags | java.util.List<FlagEnum> | Serializable entity flags. | | metadata | java.util.List | Serializable entity metadata. | | tags | java.util.Map | Serializable entity tags. | | direction | EdgeDirectionEnum | Indicates the direction in which the edge is directed. | | edgeType | EdgeTypeEnum | Type of edge. | | source | java.lang.String | UUID of edge **source** node (tail). | | target | java.lang.String | UUID of edge **target** node (head). | --- ##### `uuid`^Required ```java public java.lang.String getUuid(); ``` - *Type:* java.lang.String Universally unique identity. --- ##### `attributes`^Optional ```java public java.lang.Object getAttributes(); ``` - *Type:* java.util.MapPlainObject OR java.util.ListPlainObject>> Serializable entity attributes. > [{@link Attributes }]({@link Attributes }) --- ##### `flags`^Optional ```java public java.util.List getFlags(); ``` - *Type:* java.util.List<FlagEnum> Serializable entity flags. > [{@link FlagEnum }]({@link FlagEnum }) --- ##### `metadata`^Optional ```java public java.util.List getMetadata(); ``` - *Type:* java.util.List Serializable entity metadata. > [{@link Metadata }]({@link Metadata }) --- ##### `tags`^Optional ```java public java.util.Map getTags(); ``` - *Type:* java.util.Map Serializable entity tags. > [{@link Tags }]({@link Tags }) --- ##### `direction`^Required ```java public EdgeDirectionEnum getDirection(); ``` - *Type:* EdgeDirectionEnum Indicates the direction in which the edge is directed. --- ##### `edgeType`^Required ```java public EdgeTypeEnum getEdgeType(); ``` - *Type:* EdgeTypeEnum Type of edge. --- ##### `source`^Required ```java public java.lang.String getSource(); ``` - *Type:* java.lang.String UUID of edge **source** node (tail). --- ##### `target`^Required ```java public java.lang.String getTarget(); ``` - *Type:* java.lang.String UUID of edge **target** node (head). --- ### SGEntity Serializable graph entity. #### Initializer ```java import software.aws.awsprototypingsdk.cdkgraph.SGEntity; SGEntity.builder() .uuid(java.lang.String) // .attributes(java.util.Map>) // .flags(java.util.List) // .metadata(java.util.List) // .tags(java.util.Map) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | uuid | java.lang.String | Universally unique identity. | | attributes | java.util.MapPlainObject OR java.util.ListPlainObject>> | Serializable entity attributes. | | flags | java.util.List<FlagEnum> | Serializable entity flags. | | metadata | java.util.List | Serializable entity metadata. | | tags | java.util.Map | Serializable entity tags. | --- ##### `uuid`^Required ```java public java.lang.String getUuid(); ``` - *Type:* java.lang.String Universally unique identity. --- ##### `attributes`^Optional ```java public java.lang.Object getAttributes(); ``` - *Type:* java.util.MapPlainObject OR java.util.ListPlainObject>> Serializable entity attributes. > [{@link Attributes }]({@link Attributes }) --- ##### `flags`^Optional ```java public java.util.List getFlags(); ``` - *Type:* java.util.List<FlagEnum> Serializable entity flags. > [{@link FlagEnum }]({@link FlagEnum }) --- ##### `metadata`^Optional ```java public java.util.List getMetadata(); ``` - *Type:* java.util.List Serializable entity metadata. > [{@link Metadata }]({@link Metadata }) --- ##### `tags`^Optional ```java public java.util.Map getTags(); ``` - *Type:* java.util.Map Serializable entity tags. > [{@link Tags }]({@link Tags }) --- ### SGGraphStore Serializable graph store. #### Initializer ```java import software.aws.awsprototypingsdk.cdkgraph.SGGraphStore; SGGraphStore.builder() .edges(java.util.List) .tree(SGNode) .version(java.lang.String) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | edges | java.util.List<SGEdge> | List of edges. | | tree | SGNode | Node tree. | | version | java.lang.String | Store version. | --- ##### `edges`^Required ```java public java.util.List getEdges(); ``` - *Type:* java.util.List<SGEdge> List of edges. --- ##### `tree`^Required ```java public SGNode getTree(); ``` - *Type:* SGNode Node tree. --- ##### `version`^Required ```java public java.lang.String getVersion(); ``` - *Type:* java.lang.String Store version. --- ### SGNode Serializable graph node entity. #### Initializer ```java import software.aws.awsprototypingsdk.cdkgraph.SGNode; SGNode.builder() .uuid(java.lang.String) // .attributes(java.util.Map>) // .flags(java.util.List) // .metadata(java.util.List) // .tags(java.util.Map) .id(java.lang.String) .nodeType(NodeTypeEnum) .path(java.lang.String) // .cfnType(java.lang.String) // .children(java.util.Map) // .constructInfo(ConstructInfo) // .edges(java.util.List) // .logicalId(java.lang.String) // .parent(java.lang.String) // .stack(java.lang.String) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | uuid | java.lang.String | Universally unique identity. | | attributes | java.util.MapPlainObject OR java.util.ListPlainObject>> | Serializable entity attributes. | | flags | java.util.List<FlagEnum> | Serializable entity flags. | | metadata | java.util.List | Serializable entity metadata. | | tags | java.util.Map | Serializable entity tags. | | id | java.lang.String | Node id within parent (unique only between parent child nodes). | | nodeType | NodeTypeEnum | Node type. | | path | java.lang.String | Node path. | | cfnType | java.lang.String | CloudFormation resource type for this node. | | children | java.util.MapSGNode> | Child node record. | | constructInfo | ConstructInfo | Synthesized construct information defining jii resolution data. | | edges | java.util.List | List of edge UUIDs where this node is the **source**. | | logicalId | java.lang.String | Logical id of the node, which is only unique within containing stack. | | parent | java.lang.String | UUID of node parent. | | stack | java.lang.String | UUID of node stack. | --- ##### `uuid`^Required ```java public java.lang.String getUuid(); ``` - *Type:* java.lang.String Universally unique identity. --- ##### `attributes`^Optional ```java public java.lang.Object getAttributes(); ``` - *Type:* java.util.MapPlainObject OR java.util.ListPlainObject>> Serializable entity attributes. > [{@link Attributes }]({@link Attributes }) --- ##### `flags`^Optional ```java public java.util.List getFlags(); ``` - *Type:* java.util.List<FlagEnum> Serializable entity flags. > [{@link FlagEnum }]({@link FlagEnum }) --- ##### `metadata`^Optional ```java public java.util.List getMetadata(); ``` - *Type:* java.util.List Serializable entity metadata. > [{@link Metadata }]({@link Metadata }) --- ##### `tags`^Optional ```java public java.util.Map getTags(); ``` - *Type:* java.util.Map Serializable entity tags. > [{@link Tags }]({@link Tags }) --- ##### `id`^Required ```java public java.lang.String getId(); ``` - *Type:* java.lang.String Node id within parent (unique only between parent child nodes). --- ##### `nodeType`^Required ```java public NodeTypeEnum getNodeType(); ``` - *Type:* NodeTypeEnum Node type. --- ##### `path`^Required ```java public java.lang.String getPath(); ``` - *Type:* java.lang.String Node path. --- ##### `cfnType`^Optional ```java public java.lang.String getCfnType(); ``` - *Type:* java.lang.String CloudFormation resource type for this node. --- ##### `children`^Optional ```java public java.util.Map getChildren(); ``` - *Type:* java.util.MapSGNode> Child node record. --- ##### `constructInfo`^Optional ```java public ConstructInfo getConstructInfo(); ``` - *Type:* ConstructInfo Synthesized construct information defining jii resolution data. --- ##### `edges`^Optional ```java public java.util.List getEdges(); ``` - *Type:* java.util.List List of edge UUIDs where this node is the **source**. --- ##### `logicalId`^Optional ```java public java.lang.String getLogicalId(); ``` - *Type:* java.lang.String Logical id of the node, which is only unique within containing stack. --- ##### `parent`^Optional ```java public java.lang.String getParent(); ``` - *Type:* java.lang.String UUID of node parent. --- ##### `stack`^Optional ```java public java.lang.String getStack(); ``` - *Type:* java.lang.String UUID of node stack. --- ### SGUnresolvedReference Unresolved reference struct. During graph computation references are unresolved and stored in this struct. #### Initializer ```java import software.aws.awsprototypingsdk.cdkgraph.SGUnresolvedReference; SGUnresolvedReference.builder() .referenceType(ReferenceTypeEnum) .source(java.lang.String) .target(java.lang.String) // .value(java.lang.String) // .value(java.lang.Number) // .value(java.lang.Boolean) // .value(PlainObject) // .value(java.util.List) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | referenceType | ReferenceTypeEnum | *No description.* | | source | java.lang.String | *No description.* | | target | java.lang.String | *No description.* | | value | java.lang.String OR java.lang.Number OR java.lang.Boolean OR PlainObject OR java.util.ListPlainObject> | *No description.* | --- ##### `referenceType`^Required ```java public ReferenceTypeEnum getReferenceType(); ``` - *Type:* ReferenceTypeEnum --- ##### `source`^Required ```java public java.lang.String getSource(); ``` - *Type:* java.lang.String --- ##### `target`^Required ```java public java.lang.String getTarget(); ``` - *Type:* java.lang.String --- ##### `value`^Optional ```java public java.lang.Object getValue(); ``` - *Type:* java.lang.String OR java.lang.Number OR java.lang.Boolean OR PlainObject OR java.util.ListPlainObject> --- ## Classes ### AppNode AppNode defines a cdk App. #### Initializers ```java import software.aws.awsprototypingsdk.cdkgraph.AppNode; new AppNode(IAppNodeProps props); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | IAppNodeProps | *No description.* | --- ##### `props`^Required - *Type:* IAppNodeProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAttribute | Add attribute. | | addFlag | Add flag. | | addMetadata | Add metadata entry. | | addTag | Add tag. | | applyData | Applies data (attributes, metadata, tags, flag) to entity. | | findMetadata | Retrieves all metadata entries of a given type. | | getAttribute | Get attribute by key. | | getTag | Get tag by key. | | hasAttribute | Indicates if entity has a given attribute defined, and optionally with a specific value. | | hasFlag | Indicates if entity has a given flag. | | hasMetadata | Indicates if entity has matching metadata entry. | | hasTag | Indicates if entity has tag, optionally verifying tag value. | | mutateDestroy | Destroys this node by removing all references and removing this node from the store. | | setAttribute | Set attribute. | | setTag | Set tag. | | addChild | Add *child* node. | | addLink | Add *link* to another node. | | addReverseLink | Add *link* from another node. | | doesDependOn | Indicates if *this node* depends on *another node*. | | doesReference | Indicates if *this node* references *another node*. | | find | Recursively find the nearest sub-node matching predicate. | | findAll | Return this construct and all of its sub-nodes in the given order. | | findAllLinks | Return all direct links of this node and that of all sub-nodes. | | findAncestor | Find nearest *ancestor* of *this node* matching given predicate. | | findChild | Find child with given *id*. | | findLink | Find link of this node based on predicate. | | findLinks | Find all links of this node based on predicate. | | getCfnProp | Get specific CloudFormation property. | | getChild | Get *child* node with given *id*. | | getLinkChains | Resolve all link chains. | | getNearestAncestor | Gets the nearest **common** *ancestor* shared between *this node* and another *node*. | | isAncestor | Indicates if a specific *node* is an *ancestor* of *this node*. | | isChild | Indicates if specific *node* is a *child* of *this node*. | | mutateCollapse | Collapses all sub-nodes of *this node* into *this node*. | | mutateCollapseTo | Collapses *this node* into *an ancestor*. | | mutateCollapseToParent | Collapses *this node* into *it's parent node*. | | mutateHoist | Hoist *this node* to an *ancestor* by removing it from its current parent node and in turn moving it to the ancestor. | | mutateMove | Move this node into a new parent node. | | mutateRemoveChild | Remove a *child* node from *this node*. | | mutateRemoveLink | Remove a *link* from *this node*. | | mutateRemoveReverseLink | Remove a *link* to *this node*. | | mutateUncluster | Hoist all children to parent and collapse node to parent. | | toString | Get string representation of this node. | --- ##### `addAttribute` ```java public void addAttribute(java.lang.String key, java.lang.Object value) ``` Add attribute. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.Object --- ##### `addFlag` ```java public void addFlag(FlagEnum flag) ``` Add flag. ###### `flag`^Required - *Type:* FlagEnum --- ##### `addMetadata` ```java public void addMetadata(java.lang.String metadataType, java.lang.Object data) ``` Add metadata entry. ###### `metadataType`^Required - *Type:* java.lang.String --- ###### `data`^Required - *Type:* java.lang.Object --- ##### `addTag` ```java public void addTag(java.lang.String key, java.lang.String value) ``` Add tag. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.String --- ##### `applyData` ```java public void applyData(IBaseEntityDataProps data) public void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite) public void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite, java.lang.Boolean applyFlags) ``` Applies data (attributes, metadata, tags, flag) to entity. Generally used only for mutations such as collapse and consume to retain data. ###### `data`^Required - *Type:* IBaseEntityDataProps The data to apply. --- ###### `overwrite`^Optional - *Type:* java.lang.Boolean --- ###### `applyFlags`^Optional - *Type:* java.lang.Boolean Indicates if data is overwritten - Indicates if flags should be applied. --- ##### `findMetadata` ```java public java.util.List findMetadata(java.lang.String metadataType) ``` Retrieves all metadata entries of a given type. ###### `metadataType`^Required - *Type:* java.lang.String --- ##### `getAttribute` ```java public java.lang.Object getAttribute(java.lang.String key) ``` Get attribute by key. ###### `key`^Required - *Type:* java.lang.String --- ##### `getTag` ```java public java.lang.String getTag(java.lang.String key) ``` Get tag by key. ###### `key`^Required - *Type:* java.lang.String --- ##### `hasAttribute` ```java public java.lang.Boolean hasAttribute(java.lang.String key) public java.lang.Boolean hasAttribute(java.lang.String key, java.lang.Object value) ``` Indicates if entity has a given attribute defined, and optionally with a specific value. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Optional - *Type:* java.lang.Object --- ##### `hasFlag` ```java public java.lang.Boolean hasFlag(FlagEnum flag) ``` Indicates if entity has a given flag. ###### `flag`^Required - *Type:* FlagEnum --- ##### `hasMetadata` ```java public java.lang.Boolean hasMetadata(java.lang.String metadataType, java.lang.Object data) ``` Indicates if entity has matching metadata entry. ###### `metadataType`^Required - *Type:* java.lang.String --- ###### `data`^Required - *Type:* java.lang.Object --- ##### `hasTag` ```java public java.lang.Boolean hasTag(java.lang.String key) public java.lang.Boolean hasTag(java.lang.String key, java.lang.String value) ``` Indicates if entity has tag, optionally verifying tag value. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Optional - *Type:* java.lang.String --- ##### `mutateDestroy` ```java public void mutateDestroy() public void mutateDestroy(java.lang.Boolean strict) ``` Destroys this node by removing all references and removing this node from the store. ###### `strict`^Optional - *Type:* java.lang.Boolean Indicates that this node must not have references. --- ##### `setAttribute` ```java public void setAttribute(java.lang.String key, java.lang.Object value) ``` Set attribute. This will overwrite existing attribute. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.Object --- ##### `setTag` ```java public void setTag(java.lang.String key, java.lang.String value) ``` Set tag. Will overwrite existing tag. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.String --- ##### `addChild` ```java public void addChild(Node node) ``` Add *child* node. ###### `node`^Required - *Type:* Node --- ##### `addLink` ```java public void addLink(Edge edge) ``` Add *link* to another node. ###### `edge`^Required - *Type:* Edge --- ##### `addReverseLink` ```java public void addReverseLink(Edge edge) ``` Add *link* from another node. ###### `edge`^Required - *Type:* Edge --- ##### `doesDependOn` ```java public java.lang.Boolean doesDependOn(Node node) ``` Indicates if *this node* depends on *another node*. ###### `node`^Required - *Type:* Node --- ##### `doesReference` ```java public java.lang.Boolean doesReference(Node node) ``` Indicates if *this node* references *another node*. ###### `node`^Required - *Type:* Node --- ##### `find` ```java public Node find(INodePredicate predicate) ``` Recursively find the nearest sub-node matching predicate. ###### `predicate`^Required - *Type:* INodePredicate --- ##### `findAll` ```java public java.util.List findAll() public java.util.List findAll(IFindNodeOptions options) ``` Return this construct and all of its sub-nodes in the given order. Optionally filter nodes based on predicate. ###### `options`^Optional - *Type:* IFindNodeOptions --- ##### `findAllLinks` ```java public java.util.List findAllLinks() public java.util.List findAllLinks(IFindEdgeOptions options) ``` Return all direct links of this node and that of all sub-nodes. Optionally filter links based on predicate. ###### `options`^Optional - *Type:* IFindEdgeOptions --- ##### `findAncestor` ```java public Node findAncestor(INodePredicate predicate) public Node findAncestor(INodePredicate predicate, java.lang.Number max) ``` Find nearest *ancestor* of *this node* matching given predicate. ###### `predicate`^Required - *Type:* INodePredicate Predicate to match ancestor. --- ###### `max`^Optional - *Type:* java.lang.Number --- ##### `findChild` ```java public Node findChild(java.lang.String id) ``` Find child with given *id*. Similar to `find` but does not throw error if no child found. ###### `id`^Required - *Type:* java.lang.String --- ##### `findLink` ```java public Edge findLink(IEdgePredicate predicate) public Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse) public Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow) public Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow, java.lang.Boolean direct) ``` Find link of this node based on predicate. By default this will follow link chains to evaluate the predicate against and return the matching direct link of this node. ###### `predicate`^Required - *Type:* IEdgePredicate Edge predicate function to match edge. --- ###### `reverse`^Optional - *Type:* java.lang.Boolean Indicates if links are search in reverse order. --- ###### `follow`^Optional - *Type:* java.lang.Boolean Indicates if link chain is followed. --- ###### `direct`^Optional - *Type:* java.lang.Boolean Indicates that only *direct* links should be searched. --- ##### `findLinks` ```java public java.util.List findLinks(IEdgePredicate predicate) public java.util.List findLinks(IEdgePredicate predicate, java.lang.Boolean reverse) public java.util.List findLinks(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow) public java.util.List findLinks(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow, java.lang.Boolean direct) ``` Find all links of this node based on predicate. By default this will follow link chains to evaluate the predicate against and return the matching direct links of this node. ###### `predicate`^Required - *Type:* IEdgePredicate Edge predicate function to match edge. --- ###### `reverse`^Optional - *Type:* java.lang.Boolean Indicates if links are search in reverse order. --- ###### `follow`^Optional - *Type:* java.lang.Boolean Indicates if link chain is followed. --- ###### `direct`^Optional - *Type:* java.lang.Boolean Indicates that only *direct* links should be searched. --- ##### `getCfnProp` ```java public java.lang.String OR java.lang.Number OR java.lang.Boolean OR PlainObject OR java.util.List getCfnProp(java.lang.String key) ``` Get specific CloudFormation property. ###### `key`^Required - *Type:* java.lang.String --- ##### `getChild` ```java public Node getChild(java.lang.String id) ``` Get *child* node with given *id*. ###### `id`^Required - *Type:* java.lang.String --- ##### `getLinkChains` ```java public java.util.List> getLinkChains() public java.util.List> getLinkChains(java.lang.Boolean reverse) ``` Resolve all link chains. > [{@link EdgeChain }]({@link EdgeChain }) ###### `reverse`^Optional - *Type:* java.lang.Boolean --- ##### `getNearestAncestor` ```java public Node getNearestAncestor(Node node) ``` Gets the nearest **common** *ancestor* shared between *this node* and another *node*. ###### `node`^Required - *Type:* Node --- ##### `isAncestor` ```java public java.lang.Boolean isAncestor(Node ancestor) ``` Indicates if a specific *node* is an *ancestor* of *this node*. ###### `ancestor`^Required - *Type:* Node --- ##### `isChild` ```java public java.lang.Boolean isChild(Node node) ``` Indicates if specific *node* is a *child* of *this node*. ###### `node`^Required - *Type:* Node --- ##### `mutateCollapse` ```java public void mutateCollapse() ``` Collapses all sub-nodes of *this node* into *this node*. ##### `mutateCollapseTo` ```java public Node mutateCollapseTo(Node ancestor) ``` Collapses *this node* into *an ancestor*. ###### `ancestor`^Required - *Type:* Node --- ##### `mutateCollapseToParent` ```java public Node mutateCollapseToParent() ``` Collapses *this node* into *it's parent node*. ##### `mutateHoist` ```java public void mutateHoist(Node newParent) ``` Hoist *this node* to an *ancestor* by removing it from its current parent node and in turn moving it to the ancestor. ###### `newParent`^Required - *Type:* Node --- ##### `mutateMove` ```java public void mutateMove(Node newParent) ``` Move this node into a new parent node. ###### `newParent`^Required - *Type:* Node The parent to move this node to. --- ##### `mutateRemoveChild` ```java public java.lang.Boolean mutateRemoveChild(Node node) ``` Remove a *child* node from *this node*. ###### `node`^Required - *Type:* Node --- ##### `mutateRemoveLink` ```java public java.lang.Boolean mutateRemoveLink(Edge link) ``` Remove a *link* from *this node*. ###### `link`^Required - *Type:* Edge --- ##### `mutateRemoveReverseLink` ```java public java.lang.Boolean mutateRemoveReverseLink(Edge link) ``` Remove a *link* to *this node*. ###### `link`^Required - *Type:* Edge --- ##### `mutateUncluster` ```java public void mutateUncluster() ``` Hoist all children to parent and collapse node to parent. ##### `toString` ```java public java.lang.String toString() ``` Get string representation of this node. #### Static Functions | **Name** | **Description** | | --- | --- | | isAppNode | Indicates if node is a {@link AppNode}. | --- ##### `isAppNode` ```java import software.aws.awsprototypingsdk.cdkgraph.AppNode; AppNode.isAppNode(Node node) ``` Indicates if node is a {@link AppNode}. ###### `node`^Required - *Type:* Node --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | attributes | java.util.MapPlainObject OR java.util.ListPlainObject>> | Get *readonly* record of all attributes. | | flags | java.util.List<FlagEnum> | Get *readonly* list of all flags. | | isDestroyed | java.lang.Boolean | Indicates if the entity has been destroyed (eg: removed from store). | | isMutated | java.lang.Boolean | Indicates if the entity has had destructive mutations applied. | | metadata | java.util.List | Get *readonly* list of all metadata entries. | | store | Store | Reference to the store. | | tags | java.util.Map | Get *readonly* record of all tags. | | uuid | java.lang.String | Universally unique identifier. | | allowDestructiveMutations | java.lang.Boolean | Indicates if this node allows destructive mutations. | | children | java.util.List<Node> | Get all direct child nodes. | | dependedOnBy | java.util.List<Node> | Get list of **Nodes** that *depend on this node*. | | dependencies | java.util.List<Node> | Get list of **Nodes** that *this node depends on*. | | dependencyLinks | java.util.List<Dependency> | Gets list of {@link Dependency} links (edges) where this node is the **source**. | | depth | java.lang.Number | Indicates the depth of the node relative to root (0). | | id | java.lang.String | Node id, which is only unique within parent scope. | | isAsset | java.lang.Boolean | Indicates if this node is considered a {@link FlagEnum.ASSET}. | | isCfnFqn | java.lang.Boolean | Indicates if node ConstructInfoFqn denotes a `aws-cdk-lib.*.Cfn*` construct. | | isCluster | java.lang.Boolean | Indicates if this node is considered a {@link FlagEnum.CLUSTER}. | | isCustomResource | java.lang.Boolean | Indicates if node is a *Custom Resource*. | | isExtraneous | java.lang.Boolean | Indicates if this node is considered a {@link FlagEnum.EXTRANEOUS} node or determined to be extraneous: - Clusters that contain no children. | | isGraphContainer | java.lang.Boolean | Indicates if this node is considered a {@link FlagEnum.GRAPH_CONTAINER}. | | isLeaf | java.lang.Boolean | Indicates if this node is a *leaf* node, which means it does not have children. | | isTopLevel | java.lang.Boolean | Indicates if node is direct child of the graph root node. | | links | java.util.List<Edge> | Gets all links (edges) in which this node is the **source**. | | nodeType | NodeTypeEnum | Type of node. | | path | java.lang.String | Path of the node. | | referencedBy | java.util.List<Node> | Get list of **Nodes** that *reference this node*. | | referenceLinks | java.util.List<Reference> | Gets list of {@link Reference} links (edges) where this node is the **source**. | | references | java.util.List<Node> | Get list of **Nodes** that *this node references*. | | reverseDependencyLinks | java.util.List<Dependency> | Gets list of {@link Dependency} links (edges) where this node is the **target**. | | reverseLinks | java.util.List<Edge> | Gets all links (edges) in which this node is the **target**. | | reverseReferenceLinks | java.util.List<Reference> | Gets list of {@link Reference} links (edges) where this node is the **target**. | | scopes | java.util.List<Node> | Gets descending ordered list of ancestors from the root. | | siblings | java.util.List<Node> | Get list of *siblings* of this node. | | cfnProps | PlainObject | Gets CloudFormation properties for this node. | | cfnType | java.lang.String | Get the CloudFormation resource type for this node. | | constructInfo | ConstructInfo | Synthesized construct information defining jii resolution data. | | constructInfoFqn | java.lang.String | Synthesized construct information defining jii resolution data. | | logicalId | java.lang.String | Logical id of the node, which is only unique within containing stack. | | parent | Node | Parent node. | | rootStack | StackNode | Get **root** stack. | | stack | StackNode | Stack the node is contained in. | --- ##### `attributes`^Required ```java public java.lang.Object getAttributes(); ``` - *Type:* java.util.MapPlainObject OR java.util.ListPlainObject>> Get *readonly* record of all attributes. --- ##### `flags`^Required ```java public java.util.List getFlags(); ``` - *Type:* java.util.List<FlagEnum> Get *readonly* list of all flags. --- ##### `isDestroyed`^Required ```java public java.lang.Boolean getIsDestroyed(); ``` - *Type:* java.lang.Boolean Indicates if the entity has been destroyed (eg: removed from store). --- ##### `isMutated`^Required ```java public java.lang.Boolean getIsMutated(); ``` - *Type:* java.lang.Boolean Indicates if the entity has had destructive mutations applied. --- ##### `metadata`^Required ```java public java.util.List getMetadata(); ``` - *Type:* java.util.List Get *readonly* list of all metadata entries. --- ##### `store`^Required ```java public Store getStore(); ``` - *Type:* Store Reference to the store. --- ##### `tags`^Required ```java public java.util.Map getTags(); ``` - *Type:* java.util.Map Get *readonly* record of all tags. --- ##### `uuid`^Required ```java public java.lang.String getUuid(); ``` - *Type:* java.lang.String Universally unique identifier. --- ##### `allowDestructiveMutations`^Required ```java public java.lang.Boolean getAllowDestructiveMutations(); ``` - *Type:* java.lang.Boolean Indicates if this node allows destructive mutations. > [{@link Store.allowDestructiveMutations }]({@link Store.allowDestructiveMutations }) --- ##### `children`^Required ```java public java.util.List getChildren(); ``` - *Type:* java.util.List<Node> Get all direct child nodes. --- ##### `dependedOnBy`^Required ```java public java.util.List getDependedOnBy(); ``` - *Type:* java.util.List<Node> Get list of **Nodes** that *depend on this node*. > [{@link Node.reverseDependencyLinks }]({@link Node.reverseDependencyLinks }) --- ##### `dependencies`^Required ```java public java.util.List getDependencies(); ``` - *Type:* java.util.List<Node> Get list of **Nodes** that *this node depends on*. > [{@link Node.dependencyLinks }]({@link Node.dependencyLinks }) --- ##### `dependencyLinks`^Required ```java public java.util.List getDependencyLinks(); ``` - *Type:* java.util.List<Dependency> Gets list of {@link Dependency} links (edges) where this node is the **source**. --- ##### `depth`^Required ```java public java.lang.Number getDepth(); ``` - *Type:* java.lang.Number Indicates the depth of the node relative to root (0). --- ##### `id`^Required ```java public java.lang.String getId(); ``` - *Type:* java.lang.String Node id, which is only unique within parent scope. --- ##### `isAsset`^Required ```java public java.lang.Boolean getIsAsset(); ``` - *Type:* java.lang.Boolean Indicates if this node is considered a {@link FlagEnum.ASSET}. --- ##### `isCfnFqn`^Required ```java public java.lang.Boolean getIsCfnFqn(); ``` - *Type:* java.lang.Boolean Indicates if node ConstructInfoFqn denotes a `aws-cdk-lib.*.Cfn*` construct. > [{@link FlagEnum.CFN_FQN }]({@link FlagEnum.CFN_FQN }) --- ##### `isCluster`^Required ```java public java.lang.Boolean getIsCluster(); ``` - *Type:* java.lang.Boolean Indicates if this node is considered a {@link FlagEnum.CLUSTER}. --- ##### `isCustomResource`^Required ```java public java.lang.Boolean getIsCustomResource(); ``` - *Type:* java.lang.Boolean Indicates if node is a *Custom Resource*. --- ##### `isExtraneous`^Required ```java public java.lang.Boolean getIsExtraneous(); ``` - *Type:* java.lang.Boolean Indicates if this node is considered a {@link FlagEnum.EXTRANEOUS} node or determined to be extraneous: - Clusters that contain no children. --- ##### `isGraphContainer`^Required ```java public java.lang.Boolean getIsGraphContainer(); ``` - *Type:* java.lang.Boolean Indicates if this node is considered a {@link FlagEnum.GRAPH_CONTAINER}. --- ##### `isLeaf`^Required ```java public java.lang.Boolean getIsLeaf(); ``` - *Type:* java.lang.Boolean Indicates if this node is a *leaf* node, which means it does not have children. --- ##### `isTopLevel`^Required ```java public java.lang.Boolean getIsTopLevel(); ``` - *Type:* java.lang.Boolean Indicates if node is direct child of the graph root node. --- ##### `links`^Required ```java public java.util.List getLinks(); ``` - *Type:* java.util.List<Edge> Gets all links (edges) in which this node is the **source**. --- ##### `nodeType`^Required ```java public NodeTypeEnum getNodeType(); ``` - *Type:* NodeTypeEnum Type of node. --- ##### `path`^Required ```java public java.lang.String getPath(); ``` - *Type:* java.lang.String Path of the node. --- ##### `referencedBy`^Required ```java public java.util.List getReferencedBy(); ``` - *Type:* java.util.List<Node> Get list of **Nodes** that *reference this node*. > [{@link Node.reverseReferenceLinks }]({@link Node.reverseReferenceLinks }) --- ##### `referenceLinks`^Required ```java public java.util.List getReferenceLinks(); ``` - *Type:* java.util.List<Reference> Gets list of {@link Reference} links (edges) where this node is the **source**. --- ##### `references`^Required ```java public java.util.List getReferences(); ``` - *Type:* java.util.List<Node> Get list of **Nodes** that *this node references*. > [{@link Node.referenceLinks }]({@link Node.referenceLinks }) --- ##### `reverseDependencyLinks`^Required ```java public java.util.List getReverseDependencyLinks(); ``` - *Type:* java.util.List<Dependency> Gets list of {@link Dependency} links (edges) where this node is the **target**. --- ##### `reverseLinks`^Required ```java public java.util.List getReverseLinks(); ``` - *Type:* java.util.List<Edge> Gets all links (edges) in which this node is the **target**. --- ##### `reverseReferenceLinks`^Required ```java public java.util.List getReverseReferenceLinks(); ``` - *Type:* java.util.List<Reference> Gets list of {@link Reference} links (edges) where this node is the **target**. --- ##### `scopes`^Required ```java public java.util.List getScopes(); ``` - *Type:* java.util.List<Node> Gets descending ordered list of ancestors from the root. --- ##### `siblings`^Required ```java public java.util.List getSiblings(); ``` - *Type:* java.util.List<Node> Get list of *siblings* of this node. --- ##### `cfnProps`^Optional ```java public PlainObject getCfnProps(); ``` - *Type:* PlainObject Gets CloudFormation properties for this node. --- ##### `cfnType`^Optional ```java public java.lang.String getCfnType(); ``` - *Type:* java.lang.String Get the CloudFormation resource type for this node. --- ##### `constructInfo`^Optional ```java public ConstructInfo getConstructInfo(); ``` - *Type:* ConstructInfo Synthesized construct information defining jii resolution data. --- ##### `constructInfoFqn`^Optional ```java public java.lang.String getConstructInfoFqn(); ``` - *Type:* java.lang.String Synthesized construct information defining jii resolution data. --- ##### `logicalId`^Optional ```java public java.lang.String getLogicalId(); ``` - *Type:* java.lang.String Logical id of the node, which is only unique within containing stack. --- ##### `parent`^Optional ```java public Node getParent(); ``` - *Type:* Node Parent node. Only the root node should not have parent. --- ##### `rootStack`^Optional ```java public StackNode getRootStack(); ``` - *Type:* StackNode Get **root** stack. --- ##### `stack`^Optional ```java public StackNode getStack(); ``` - *Type:* StackNode Stack the node is contained in. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | PATH | java.lang.String | Fixed path of the App. | | UUID | java.lang.String | Fixed UUID for App node. | --- ##### `PATH`^Required ```java public java.lang.String getPath(); ``` - *Type:* java.lang.String Fixed path of the App. --- ##### `UUID`^Required ```java public java.lang.String getUuid(); ``` - *Type:* java.lang.String Fixed UUID for App node. --- ### AttributeReference Attribute type reference edge. #### Initializers ```java import software.aws.awsprototypingsdk.cdkgraph.AttributeReference; new AttributeReference(IAttributeReferenceProps props); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | IAttributeReferenceProps | *No description.* | --- ##### `props`^Required - *Type:* IAttributeReferenceProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAttribute | Add attribute. | | addFlag | Add flag. | | addMetadata | Add metadata entry. | | addTag | Add tag. | | applyData | Applies data (attributes, metadata, tags, flag) to entity. | | findMetadata | Retrieves all metadata entries of a given type. | | getAttribute | Get attribute by key. | | getTag | Get tag by key. | | hasAttribute | Indicates if entity has a given attribute defined, and optionally with a specific value. | | hasFlag | Indicates if entity has a given flag. | | hasMetadata | Indicates if entity has matching metadata entry. | | hasTag | Indicates if entity has tag, optionally verifying tag value. | | mutateDestroy | Destroy the edge. | | setAttribute | Set attribute. | | setTag | Set tag. | | isEquivalent | Indicates if this edge is equivalent to another edge. | | mutateConsume | Merge an equivalent edge's data into this edge and destroy the other edge. | | mutateDirection | Change the edge **direction**. | | mutateSource | Change the edge **source**. | | mutateTarget | Change the edge **target**. | | toString | Get string representation of this edge. | | resolveChain | Resolve reference chain. | | resolveTargets | Resolve targets by following potential edge chain. | --- ##### `addAttribute` ```java public void addAttribute(java.lang.String key, java.lang.Object value) ``` Add attribute. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.Object --- ##### `addFlag` ```java public void addFlag(FlagEnum flag) ``` Add flag. ###### `flag`^Required - *Type:* FlagEnum --- ##### `addMetadata` ```java public void addMetadata(java.lang.String metadataType, java.lang.Object data) ``` Add metadata entry. ###### `metadataType`^Required - *Type:* java.lang.String --- ###### `data`^Required - *Type:* java.lang.Object --- ##### `addTag` ```java public void addTag(java.lang.String key, java.lang.String value) ``` Add tag. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.String --- ##### `applyData` ```java public void applyData(IBaseEntityDataProps data) public void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite) public void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite, java.lang.Boolean applyFlags) ``` Applies data (attributes, metadata, tags, flag) to entity. Generally used only for mutations such as collapse and consume to retain data. ###### `data`^Required - *Type:* IBaseEntityDataProps The data to apply. --- ###### `overwrite`^Optional - *Type:* java.lang.Boolean --- ###### `applyFlags`^Optional - *Type:* java.lang.Boolean Indicates if data is overwritten - Indicates if flags should be applied. --- ##### `findMetadata` ```java public java.util.List findMetadata(java.lang.String metadataType) ``` Retrieves all metadata entries of a given type. ###### `metadataType`^Required - *Type:* java.lang.String --- ##### `getAttribute` ```java public java.lang.Object getAttribute(java.lang.String key) ``` Get attribute by key. ###### `key`^Required - *Type:* java.lang.String --- ##### `getTag` ```java public java.lang.String getTag(java.lang.String key) ``` Get tag by key. ###### `key`^Required - *Type:* java.lang.String --- ##### `hasAttribute` ```java public java.lang.Boolean hasAttribute(java.lang.String key) public java.lang.Boolean hasAttribute(java.lang.String key, java.lang.Object value) ``` Indicates if entity has a given attribute defined, and optionally with a specific value. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Optional - *Type:* java.lang.Object --- ##### `hasFlag` ```java public java.lang.Boolean hasFlag(FlagEnum flag) ``` Indicates if entity has a given flag. ###### `flag`^Required - *Type:* FlagEnum --- ##### `hasMetadata` ```java public java.lang.Boolean hasMetadata(java.lang.String metadataType, java.lang.Object data) ``` Indicates if entity has matching metadata entry. ###### `metadataType`^Required - *Type:* java.lang.String --- ###### `data`^Required - *Type:* java.lang.Object --- ##### `hasTag` ```java public java.lang.Boolean hasTag(java.lang.String key) public java.lang.Boolean hasTag(java.lang.String key, java.lang.String value) ``` Indicates if entity has tag, optionally verifying tag value. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Optional - *Type:* java.lang.String --- ##### `mutateDestroy` ```java public void mutateDestroy() public void mutateDestroy(java.lang.Boolean _strict) ``` Destroy the edge. Remove all references and remove from store. ###### `_strict`^Optional - *Type:* java.lang.Boolean --- ##### `setAttribute` ```java public void setAttribute(java.lang.String key, java.lang.Object value) ``` Set attribute. This will overwrite existing attribute. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.Object --- ##### `setTag` ```java public void setTag(java.lang.String key, java.lang.String value) ``` Set tag. Will overwrite existing tag. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.String --- ##### `isEquivalent` ```java public java.lang.Boolean isEquivalent(Edge edge) ``` Indicates if this edge is equivalent to another edge. Edges are considered equivalent if they share same type, source, and target. ###### `edge`^Required - *Type:* Edge --- ##### `mutateConsume` ```java public void mutateConsume(Edge edge) ``` Merge an equivalent edge's data into this edge and destroy the other edge. Used during filtering operations to consolidate equivalent edges. ###### `edge`^Required - *Type:* Edge The edge to consume. --- ##### `mutateDirection` ```java public void mutateDirection(EdgeDirectionEnum direction) ``` Change the edge **direction**. ###### `direction`^Required - *Type:* EdgeDirectionEnum --- ##### `mutateSource` ```java public void mutateSource(Node node) ``` Change the edge **source**. ###### `node`^Required - *Type:* Node --- ##### `mutateTarget` ```java public void mutateTarget(Node node) ``` Change the edge **target**. ###### `node`^Required - *Type:* Node --- ##### `toString` ```java public java.lang.String toString() ``` Get string representation of this edge. ##### `resolveChain` ```java public java.util.List resolveChain() ``` Resolve reference chain. ##### `resolveTargets` ```java public java.util.List resolveTargets() ``` Resolve targets by following potential edge chain. > [{@link EdgeChain }]({@link EdgeChain }) #### Static Functions | **Name** | **Description** | | --- | --- | | findAllInChain | Find all matching edges based on predicate within an EdgeChain. | | findInChain | Find first edge matching predicate within an EdgeChain. | | isRef | Indicates if edge is a **Ref** based {@link Reference} edge. | | isReference | Indicates if edge is a {@link Reference}. | | isAtt | Indicates if edge in an **Fn::GetAtt** {@link Reference}. | --- ##### `findAllInChain` ```java import software.aws.awsprototypingsdk.cdkgraph.AttributeReference; AttributeReference.findAllInChain(java.util.List chain, IEdgePredicate predicate) ``` Find all matching edges based on predicate within an EdgeChain. ###### `chain`^Required - *Type:* java.util.List --- ###### `predicate`^Required - *Type:* IEdgePredicate --- ##### `findInChain` ```java import software.aws.awsprototypingsdk.cdkgraph.AttributeReference; AttributeReference.findInChain(java.util.List chain, IEdgePredicate predicate) ``` Find first edge matching predicate within an EdgeChain. ###### `chain`^Required - *Type:* java.util.List --- ###### `predicate`^Required - *Type:* IEdgePredicate --- ##### `isRef` ```java import software.aws.awsprototypingsdk.cdkgraph.AttributeReference; AttributeReference.isRef(Edge edge) ``` Indicates if edge is a **Ref** based {@link Reference} edge. ###### `edge`^Required - *Type:* Edge --- ##### `isReference` ```java import software.aws.awsprototypingsdk.cdkgraph.AttributeReference; AttributeReference.isReference(Edge edge) ``` Indicates if edge is a {@link Reference}. ###### `edge`^Required - *Type:* Edge --- ##### `isAtt` ```java import software.aws.awsprototypingsdk.cdkgraph.AttributeReference; AttributeReference.isAtt(Edge edge) ``` Indicates if edge in an **Fn::GetAtt** {@link Reference}. ###### `edge`^Required - *Type:* Edge --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | attributes | java.util.MapPlainObject OR java.util.ListPlainObject>> | Get *readonly* record of all attributes. | | flags | java.util.List<FlagEnum> | Get *readonly* list of all flags. | | isDestroyed | java.lang.Boolean | Indicates if the entity has been destroyed (eg: removed from store). | | isMutated | java.lang.Boolean | Indicates if the entity has had destructive mutations applied. | | metadata | java.util.List | Get *readonly* list of all metadata entries. | | store | Store | Reference to the store. | | tags | java.util.Map | Get *readonly* record of all tags. | | uuid | java.lang.String | Universally unique identifier. | | allowDestructiveMutations | java.lang.Boolean | Indicates if edge allows destructive mutations. | | direction | EdgeDirectionEnum | Indicates the direction in which the edge is directed. | | edgeType | EdgeTypeEnum | Type of edge. | | isClosed | java.lang.Boolean | Indicates if the Edge's **source** and **target** are the same, or were the same when it was created (prior to mutations). | | isCrossStack | java.lang.Boolean | Indicates if **source** and **target** nodes reside in different *root* stacks. | | isExtraneous | java.lang.Boolean | Indicates if edge is extraneous which is determined by explicitly having *EXTRANEOUS* flag added and/or being a closed loop (source===target). | | source | Node | Edge **source** is the node that defines the edge (tail). | | target | Node | Edge **target** is the node being referenced by the **source** (head). | | referenceType | ReferenceTypeEnum | Get type of reference. | | value | java.lang.String | Get the resolved attribute value. | --- ##### `attributes`^Required ```java public java.lang.Object getAttributes(); ``` - *Type:* java.util.MapPlainObject OR java.util.ListPlainObject>> Get *readonly* record of all attributes. --- ##### `flags`^Required ```java public java.util.List getFlags(); ``` - *Type:* java.util.List<FlagEnum> Get *readonly* list of all flags. --- ##### `isDestroyed`^Required ```java public java.lang.Boolean getIsDestroyed(); ``` - *Type:* java.lang.Boolean Indicates if the entity has been destroyed (eg: removed from store). --- ##### `isMutated`^Required ```java public java.lang.Boolean getIsMutated(); ``` - *Type:* java.lang.Boolean Indicates if the entity has had destructive mutations applied. --- ##### `metadata`^Required ```java public java.util.List getMetadata(); ``` - *Type:* java.util.List Get *readonly* list of all metadata entries. --- ##### `store`^Required ```java public Store getStore(); ``` - *Type:* Store Reference to the store. --- ##### `tags`^Required ```java public java.util.Map getTags(); ``` - *Type:* java.util.Map Get *readonly* record of all tags. --- ##### `uuid`^Required ```java public java.lang.String getUuid(); ``` - *Type:* java.lang.String Universally unique identifier. --- ##### `allowDestructiveMutations`^Required ```java public java.lang.Boolean getAllowDestructiveMutations(); ``` - *Type:* java.lang.Boolean Indicates if edge allows destructive mutations. --- ##### `direction`^Required ```java public EdgeDirectionEnum getDirection(); ``` - *Type:* EdgeDirectionEnum Indicates the direction in which the edge is directed. --- ##### `edgeType`^Required ```java public EdgeTypeEnum getEdgeType(); ``` - *Type:* EdgeTypeEnum Type of edge. --- ##### `isClosed`^Required ```java public java.lang.Boolean getIsClosed(); ``` - *Type:* java.lang.Boolean Indicates if the Edge's **source** and **target** are the same, or were the same when it was created (prior to mutations). To check whether it was originally closed, use `hasFlag(FlagEnum.CLOSED_EDGE)` instead. --- ##### `isCrossStack`^Required ```java public java.lang.Boolean getIsCrossStack(); ``` - *Type:* java.lang.Boolean Indicates if **source** and **target** nodes reside in different *root* stacks. --- ##### `isExtraneous`^Required ```java public java.lang.Boolean getIsExtraneous(); ``` - *Type:* java.lang.Boolean Indicates if edge is extraneous which is determined by explicitly having *EXTRANEOUS* flag added and/or being a closed loop (source===target). --- ##### `source`^Required ```java public Node getSource(); ``` - *Type:* Node Edge **source** is the node that defines the edge (tail). --- ##### `target`^Required ```java public Node getTarget(); ``` - *Type:* Node Edge **target** is the node being referenced by the **source** (head). --- ##### `referenceType`^Required ```java public ReferenceTypeEnum getReferenceType(); ``` - *Type:* ReferenceTypeEnum Get type of reference. --- ##### `value`^Required ```java public java.lang.String getValue(); ``` - *Type:* java.lang.String Get the resolved attribute value. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ATT_TYPE | java.lang.String | Attribute defining the type of reference. | | PREFIX | java.lang.String | Edge prefix to denote **Fn::GetAtt** type reference edge. | | ATT_VALUE | java.lang.String | Attribute key for resolved value of attribute reference. | --- ##### `ATT_TYPE`^Required ```java public java.lang.String getAttType(); ``` - *Type:* java.lang.String Attribute defining the type of reference. --- ##### `PREFIX`^Required ```java public java.lang.String getPrefix(); ``` - *Type:* java.lang.String Edge prefix to denote **Fn::GetAtt** type reference edge. --- ##### `ATT_VALUE`^Required ```java public java.lang.String getAttValue(); ``` - *Type:* java.lang.String Attribute key for resolved value of attribute reference. --- ### BaseEntity - *Implements:* ISerializableEntity Base class for all store entities (Node and Edges). #### Initializers ```java import software.aws.awsprototypingsdk.cdkgraph.BaseEntity; new BaseEntity(IBaseEntityProps props); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | IBaseEntityProps | *No description.* | --- ##### `props`^Required - *Type:* IBaseEntityProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAttribute | Add attribute. | | addFlag | Add flag. | | addMetadata | Add metadata entry. | | addTag | Add tag. | | applyData | Applies data (attributes, metadata, tags, flag) to entity. | | findMetadata | Retrieves all metadata entries of a given type. | | getAttribute | Get attribute by key. | | getTag | Get tag by key. | | hasAttribute | Indicates if entity has a given attribute defined, and optionally with a specific value. | | hasFlag | Indicates if entity has a given flag. | | hasMetadata | Indicates if entity has matching metadata entry. | | hasTag | Indicates if entity has tag, optionally verifying tag value. | | mutateDestroy | Destroy the entity be removing all references and removing from store. | | setAttribute | Set attribute. | | setTag | Set tag. | --- ##### `addAttribute` ```java public void addAttribute(java.lang.String key, java.lang.Object value) ``` Add attribute. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.Object --- ##### `addFlag` ```java public void addFlag(FlagEnum flag) ``` Add flag. ###### `flag`^Required - *Type:* FlagEnum --- ##### `addMetadata` ```java public void addMetadata(java.lang.String metadataType, java.lang.Object data) ``` Add metadata entry. ###### `metadataType`^Required - *Type:* java.lang.String --- ###### `data`^Required - *Type:* java.lang.Object --- ##### `addTag` ```java public void addTag(java.lang.String key, java.lang.String value) ``` Add tag. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.String --- ##### `applyData` ```java public void applyData(IBaseEntityDataProps data) public void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite) public void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite, java.lang.Boolean applyFlags) ``` Applies data (attributes, metadata, tags, flag) to entity. Generally used only for mutations such as collapse and consume to retain data. ###### `data`^Required - *Type:* IBaseEntityDataProps The data to apply. --- ###### `overwrite`^Optional - *Type:* java.lang.Boolean --- ###### `applyFlags`^Optional - *Type:* java.lang.Boolean Indicates if data is overwritten - Indicates if flags should be applied. --- ##### `findMetadata` ```java public java.util.List findMetadata(java.lang.String metadataType) ``` Retrieves all metadata entries of a given type. ###### `metadataType`^Required - *Type:* java.lang.String --- ##### `getAttribute` ```java public java.lang.Object getAttribute(java.lang.String key) ``` Get attribute by key. ###### `key`^Required - *Type:* java.lang.String --- ##### `getTag` ```java public java.lang.String getTag(java.lang.String key) ``` Get tag by key. ###### `key`^Required - *Type:* java.lang.String --- ##### `hasAttribute` ```java public java.lang.Boolean hasAttribute(java.lang.String key) public java.lang.Boolean hasAttribute(java.lang.String key, java.lang.Object value) ``` Indicates if entity has a given attribute defined, and optionally with a specific value. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Optional - *Type:* java.lang.Object --- ##### `hasFlag` ```java public java.lang.Boolean hasFlag(FlagEnum flag) ``` Indicates if entity has a given flag. ###### `flag`^Required - *Type:* FlagEnum --- ##### `hasMetadata` ```java public java.lang.Boolean hasMetadata(java.lang.String metadataType, java.lang.Object data) ``` Indicates if entity has matching metadata entry. ###### `metadataType`^Required - *Type:* java.lang.String --- ###### `data`^Required - *Type:* java.lang.Object --- ##### `hasTag` ```java public java.lang.Boolean hasTag(java.lang.String key) public java.lang.Boolean hasTag(java.lang.String key, java.lang.String value) ``` Indicates if entity has tag, optionally verifying tag value. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Optional - *Type:* java.lang.String --- ##### `mutateDestroy` ```java public void mutateDestroy() public void mutateDestroy(java.lang.Boolean strict) ``` Destroy the entity be removing all references and removing from store. ###### `strict`^Optional - *Type:* java.lang.Boolean If `strict`, then entity must not have any references remaining when attempting to destroy. --- ##### `setAttribute` ```java public void setAttribute(java.lang.String key, java.lang.Object value) ``` Set attribute. This will overwrite existing attribute. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.Object --- ##### `setTag` ```java public void setTag(java.lang.String key, java.lang.String value) ``` Set tag. Will overwrite existing tag. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.String --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | attributes | java.util.MapPlainObject OR java.util.ListPlainObject>> | Get *readonly* record of all attributes. | | flags | java.util.List<FlagEnum> | Get *readonly* list of all flags. | | isDestroyed | java.lang.Boolean | Indicates if the entity has been destroyed (eg: removed from store). | | isMutated | java.lang.Boolean | Indicates if the entity has had destructive mutations applied. | | metadata | java.util.List | Get *readonly* list of all metadata entries. | | store | Store | Reference to the store. | | tags | java.util.Map | Get *readonly* record of all tags. | | uuid | java.lang.String | Universally unique identifier. | --- ##### `attributes`^Required ```java public java.lang.Object getAttributes(); ``` - *Type:* java.util.MapPlainObject OR java.util.ListPlainObject>> Get *readonly* record of all attributes. --- ##### `flags`^Required ```java public java.util.List getFlags(); ``` - *Type:* java.util.List<FlagEnum> Get *readonly* list of all flags. --- ##### `isDestroyed`^Required ```java public java.lang.Boolean getIsDestroyed(); ``` - *Type:* java.lang.Boolean Indicates if the entity has been destroyed (eg: removed from store). --- ##### `isMutated`^Required ```java public java.lang.Boolean getIsMutated(); ``` - *Type:* java.lang.Boolean Indicates if the entity has had destructive mutations applied. --- ##### `metadata`^Required ```java public java.util.List getMetadata(); ``` - *Type:* java.util.List Get *readonly* list of all metadata entries. --- ##### `store`^Required ```java public Store getStore(); ``` - *Type:* Store Reference to the store. --- ##### `tags`^Required ```java public java.util.Map getTags(); ``` - *Type:* java.util.Map Get *readonly* record of all tags. --- ##### `uuid`^Required ```java public java.lang.String getUuid(); ``` - *Type:* java.lang.String Universally unique identifier. --- ### CdkGraphContext CdkGraph context. #### Initializers ```java import software.aws.awsprototypingsdk.cdkgraph.CdkGraphContext; new CdkGraphContext(Store store, java.lang.String outdir); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | store | Store | *No description.* | | outdir | java.lang.String | *No description.* | --- ##### `store`^Required - *Type:* Store --- ##### `outdir`^Required - *Type:* java.lang.String --- #### Methods | **Name** | **Description** | | --- | --- | | getArtifact | Get CdkGraph artifact by id. | | hasArtifactFile | Indicates if context has an artifact with *filename* defined. | | logArtifact | Logs an artifact entry. | | writeArtifact | Writes artifact data to outdir and logs the entry. | --- ##### `getArtifact` ```java public CdkGraphArtifact getArtifact(java.lang.String id) ``` Get CdkGraph artifact by id. ###### `id`^Required - *Type:* java.lang.String --- ##### `hasArtifactFile` ```java public java.lang.Boolean hasArtifactFile(java.lang.String filename) ``` Indicates if context has an artifact with *filename* defined. ###### `filename`^Required - *Type:* java.lang.String --- ##### `logArtifact` ```java public CdkGraphArtifact logArtifact(CdkGraph OR ICdkGraphPlugin source, java.lang.String id, java.lang.String filepath) public CdkGraphArtifact logArtifact(CdkGraph OR ICdkGraphPlugin source, java.lang.String id, java.lang.String filepath, java.lang.String description) ``` Logs an artifact entry. In general this should not be called directly, as `writeArtifact` should be utilized to perform writing and logging artifacts. However some plugins utilize other tools that generate the artifacts, in which case the plugin would call this method to log the entry. ###### `source`^Required - *Type:* CdkGraph OR ICdkGraphPlugin The source of the artifact, such as the name of plugin. --- ###### `id`^Required - *Type:* java.lang.String Unique id of the artifact. --- ###### `filepath`^Required - *Type:* java.lang.String Full path where the artifact is stored. --- ###### `description`^Optional - *Type:* java.lang.String Description of the artifact. --- ##### `writeArtifact` ```java public CdkGraphArtifact writeArtifact(CdkGraph OR ICdkGraphPlugin source, java.lang.String id, java.lang.String filename, java.lang.String data) public CdkGraphArtifact writeArtifact(CdkGraph OR ICdkGraphPlugin source, java.lang.String id, java.lang.String filename, java.lang.String data, java.lang.String description) ``` Writes artifact data to outdir and logs the entry. ###### `source`^Required - *Type:* CdkGraph OR ICdkGraphPlugin The source of the artifact, such as the name of plugin. --- ###### `id`^Required - *Type:* java.lang.String Unique id of the artifact. --- ###### `filename`^Required - *Type:* java.lang.String Relative name of the file. --- ###### `data`^Required - *Type:* java.lang.String --- ###### `description`^Optional - *Type:* java.lang.String Description of the artifact. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | artifacts | java.util.MapCdkGraphArtifact> | Get record of all graph artifacts keyed by artifact id. | | graphJson | CdkGraphArtifact | Get CdkGraph core `graph.json` artifact. | | outdir | java.lang.String | *No description.* | | store | Store | *No description.* | --- ##### `artifacts`^Required ```java public java.util.Map getArtifacts(); ``` - *Type:* java.util.MapCdkGraphArtifact> Get record of all graph artifacts keyed by artifact id. --- ##### `graphJson`^Required ```java public CdkGraphArtifact getGraphJson(); ``` - *Type:* CdkGraphArtifact Get CdkGraph core `graph.json` artifact. --- ##### `outdir`^Required ```java public java.lang.String getOutdir(); ``` - *Type:* java.lang.String --- ##### `store`^Required ```java public Store getStore(); ``` - *Type:* Store --- ### CfnResourceNode CfnResourceNode defines an L1 cdk resource. #### Initializers ```java import software.aws.awsprototypingsdk.cdkgraph.CfnResourceNode; new CfnResourceNode(ICfnResourceNodeProps props); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | ICfnResourceNodeProps | *No description.* | --- ##### `props`^Required - *Type:* ICfnResourceNodeProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAttribute | Add attribute. | | addFlag | Add flag. | | addMetadata | Add metadata entry. | | addTag | Add tag. | | applyData | Applies data (attributes, metadata, tags, flag) to entity. | | findMetadata | Retrieves all metadata entries of a given type. | | getAttribute | Get attribute by key. | | getTag | Get tag by key. | | hasAttribute | Indicates if entity has a given attribute defined, and optionally with a specific value. | | hasFlag | Indicates if entity has a given flag. | | hasMetadata | Indicates if entity has matching metadata entry. | | hasTag | Indicates if entity has tag, optionally verifying tag value. | | mutateDestroy | Destroys this node by removing all references and removing this node from the store. | | setAttribute | Set attribute. | | setTag | Set tag. | | addChild | Add *child* node. | | addLink | Add *link* to another node. | | addReverseLink | Add *link* from another node. | | doesDependOn | Indicates if *this node* depends on *another node*. | | doesReference | Indicates if *this node* references *another node*. | | find | Recursively find the nearest sub-node matching predicate. | | findAll | Return this construct and all of its sub-nodes in the given order. | | findAllLinks | Return all direct links of this node and that of all sub-nodes. | | findAncestor | Find nearest *ancestor* of *this node* matching given predicate. | | findChild | Find child with given *id*. | | findLink | Find link of this node based on predicate. | | findLinks | Find all links of this node based on predicate. | | getCfnProp | Get specific CloudFormation property. | | getChild | Get *child* node with given *id*. | | getLinkChains | Resolve all link chains. | | getNearestAncestor | Gets the nearest **common** *ancestor* shared between *this node* and another *node*. | | isAncestor | Indicates if a specific *node* is an *ancestor* of *this node*. | | isChild | Indicates if specific *node* is a *child* of *this node*. | | mutateCollapse | Collapses all sub-nodes of *this node* into *this node*. | | mutateCollapseTo | Collapses *this node* into *an ancestor*. | | mutateCollapseToParent | Collapses *this node* into *it's parent node*. | | mutateHoist | Hoist *this node* to an *ancestor* by removing it from its current parent node and in turn moving it to the ancestor. | | mutateMove | Move this node into a new parent node. | | mutateRemoveChild | Remove a *child* node from *this node*. | | mutateRemoveLink | Remove a *link* from *this node*. | | mutateRemoveReverseLink | Remove a *link* to *this node*. | | mutateUncluster | Hoist all children to parent and collapse node to parent. | | toString | Get string representation of this node. | | isEquivalentFqn | Evaluates if CfnResourceNode fqn is equivalent to ResourceNode fqn. | --- ##### `addAttribute` ```java public void addAttribute(java.lang.String key, java.lang.Object value) ``` Add attribute. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.Object --- ##### `addFlag` ```java public void addFlag(FlagEnum flag) ``` Add flag. ###### `flag`^Required - *Type:* FlagEnum --- ##### `addMetadata` ```java public void addMetadata(java.lang.String metadataType, java.lang.Object data) ``` Add metadata entry. ###### `metadataType`^Required - *Type:* java.lang.String --- ###### `data`^Required - *Type:* java.lang.Object --- ##### `addTag` ```java public void addTag(java.lang.String key, java.lang.String value) ``` Add tag. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.String --- ##### `applyData` ```java public void applyData(IBaseEntityDataProps data) public void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite) public void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite, java.lang.Boolean applyFlags) ``` Applies data (attributes, metadata, tags, flag) to entity. Generally used only for mutations such as collapse and consume to retain data. ###### `data`^Required - *Type:* IBaseEntityDataProps The data to apply. --- ###### `overwrite`^Optional - *Type:* java.lang.Boolean --- ###### `applyFlags`^Optional - *Type:* java.lang.Boolean Indicates if data is overwritten - Indicates if flags should be applied. --- ##### `findMetadata` ```java public java.util.List findMetadata(java.lang.String metadataType) ``` Retrieves all metadata entries of a given type. ###### `metadataType`^Required - *Type:* java.lang.String --- ##### `getAttribute` ```java public java.lang.Object getAttribute(java.lang.String key) ``` Get attribute by key. ###### `key`^Required - *Type:* java.lang.String --- ##### `getTag` ```java public java.lang.String getTag(java.lang.String key) ``` Get tag by key. ###### `key`^Required - *Type:* java.lang.String --- ##### `hasAttribute` ```java public java.lang.Boolean hasAttribute(java.lang.String key) public java.lang.Boolean hasAttribute(java.lang.String key, java.lang.Object value) ``` Indicates if entity has a given attribute defined, and optionally with a specific value. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Optional - *Type:* java.lang.Object --- ##### `hasFlag` ```java public java.lang.Boolean hasFlag(FlagEnum flag) ``` Indicates if entity has a given flag. ###### `flag`^Required - *Type:* FlagEnum --- ##### `hasMetadata` ```java public java.lang.Boolean hasMetadata(java.lang.String metadataType, java.lang.Object data) ``` Indicates if entity has matching metadata entry. ###### `metadataType`^Required - *Type:* java.lang.String --- ###### `data`^Required - *Type:* java.lang.Object --- ##### `hasTag` ```java public java.lang.Boolean hasTag(java.lang.String key) public java.lang.Boolean hasTag(java.lang.String key, java.lang.String value) ``` Indicates if entity has tag, optionally verifying tag value. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Optional - *Type:* java.lang.String --- ##### `mutateDestroy` ```java public void mutateDestroy() public void mutateDestroy(java.lang.Boolean strict) ``` Destroys this node by removing all references and removing this node from the store. ###### `strict`^Optional - *Type:* java.lang.Boolean --- ##### `setAttribute` ```java public void setAttribute(java.lang.String key, java.lang.Object value) ``` Set attribute. This will overwrite existing attribute. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.Object --- ##### `setTag` ```java public void setTag(java.lang.String key, java.lang.String value) ``` Set tag. Will overwrite existing tag. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.String --- ##### `addChild` ```java public void addChild(Node node) ``` Add *child* node. ###### `node`^Required - *Type:* Node --- ##### `addLink` ```java public void addLink(Edge edge) ``` Add *link* to another node. ###### `edge`^Required - *Type:* Edge --- ##### `addReverseLink` ```java public void addReverseLink(Edge edge) ``` Add *link* from another node. ###### `edge`^Required - *Type:* Edge --- ##### `doesDependOn` ```java public java.lang.Boolean doesDependOn(Node node) ``` Indicates if *this node* depends on *another node*. ###### `node`^Required - *Type:* Node --- ##### `doesReference` ```java public java.lang.Boolean doesReference(Node node) ``` Indicates if *this node* references *another node*. ###### `node`^Required - *Type:* Node --- ##### `find` ```java public Node find(INodePredicate predicate) ``` Recursively find the nearest sub-node matching predicate. ###### `predicate`^Required - *Type:* INodePredicate --- ##### `findAll` ```java public java.util.List findAll() public java.util.List findAll(IFindNodeOptions options) ``` Return this construct and all of its sub-nodes in the given order. Optionally filter nodes based on predicate. ###### `options`^Optional - *Type:* IFindNodeOptions --- ##### `findAllLinks` ```java public java.util.List findAllLinks() public java.util.List findAllLinks(IFindEdgeOptions options) ``` Return all direct links of this node and that of all sub-nodes. Optionally filter links based on predicate. ###### `options`^Optional - *Type:* IFindEdgeOptions --- ##### `findAncestor` ```java public Node findAncestor(INodePredicate predicate) public Node findAncestor(INodePredicate predicate, java.lang.Number max) ``` Find nearest *ancestor* of *this node* matching given predicate. ###### `predicate`^Required - *Type:* INodePredicate Predicate to match ancestor. --- ###### `max`^Optional - *Type:* java.lang.Number --- ##### `findChild` ```java public Node findChild(java.lang.String id) ``` Find child with given *id*. Similar to `find` but does not throw error if no child found. ###### `id`^Required - *Type:* java.lang.String --- ##### `findLink` ```java public Edge findLink(IEdgePredicate predicate) public Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse) public Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow) public Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow, java.lang.Boolean direct) ``` Find link of this node based on predicate. By default this will follow link chains to evaluate the predicate against and return the matching direct link of this node. ###### `predicate`^Required - *Type:* IEdgePredicate Edge predicate function to match edge. --- ###### `reverse`^Optional - *Type:* java.lang.Boolean Indicates if links are search in reverse order. --- ###### `follow`^Optional - *Type:* java.lang.Boolean Indicates if link chain is followed. --- ###### `direct`^Optional - *Type:* java.lang.Boolean Indicates that only *direct* links should be searched. --- ##### `findLinks` ```java public java.util.List findLinks(IEdgePredicate predicate) public java.util.List findLinks(IEdgePredicate predicate, java.lang.Boolean reverse) public java.util.List findLinks(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow) public java.util.List findLinks(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow, java.lang.Boolean direct) ``` Find all links of this node based on predicate. By default this will follow link chains to evaluate the predicate against and return the matching direct links of this node. ###### `predicate`^Required - *Type:* IEdgePredicate Edge predicate function to match edge. --- ###### `reverse`^Optional - *Type:* java.lang.Boolean Indicates if links are search in reverse order. --- ###### `follow`^Optional - *Type:* java.lang.Boolean Indicates if link chain is followed. --- ###### `direct`^Optional - *Type:* java.lang.Boolean Indicates that only *direct* links should be searched. --- ##### `getCfnProp` ```java public java.lang.String OR java.lang.Number OR java.lang.Boolean OR PlainObject OR java.util.List getCfnProp(java.lang.String key) ``` Get specific CloudFormation property. ###### `key`^Required - *Type:* java.lang.String --- ##### `getChild` ```java public Node getChild(java.lang.String id) ``` Get *child* node with given *id*. ###### `id`^Required - *Type:* java.lang.String --- ##### `getLinkChains` ```java public java.util.List> getLinkChains() public java.util.List> getLinkChains(java.lang.Boolean reverse) ``` Resolve all link chains. > [{@link EdgeChain }]({@link EdgeChain }) ###### `reverse`^Optional - *Type:* java.lang.Boolean --- ##### `getNearestAncestor` ```java public Node getNearestAncestor(Node node) ``` Gets the nearest **common** *ancestor* shared between *this node* and another *node*. ###### `node`^Required - *Type:* Node --- ##### `isAncestor` ```java public java.lang.Boolean isAncestor(Node ancestor) ``` Indicates if a specific *node* is an *ancestor* of *this node*. ###### `ancestor`^Required - *Type:* Node --- ##### `isChild` ```java public java.lang.Boolean isChild(Node node) ``` Indicates if specific *node* is a *child* of *this node*. ###### `node`^Required - *Type:* Node --- ##### `mutateCollapse` ```java public void mutateCollapse() ``` Collapses all sub-nodes of *this node* into *this node*. ##### `mutateCollapseTo` ```java public Node mutateCollapseTo(Node ancestor) ``` Collapses *this node* into *an ancestor*. ###### `ancestor`^Required - *Type:* Node --- ##### `mutateCollapseToParent` ```java public Node mutateCollapseToParent() ``` Collapses *this node* into *it's parent node*. ##### `mutateHoist` ```java public void mutateHoist(Node newParent) ``` Hoist *this node* to an *ancestor* by removing it from its current parent node and in turn moving it to the ancestor. ###### `newParent`^Required - *Type:* Node --- ##### `mutateMove` ```java public void mutateMove(Node newParent) ``` Move this node into a new parent node. ###### `newParent`^Required - *Type:* Node The parent to move this node to. --- ##### `mutateRemoveChild` ```java public java.lang.Boolean mutateRemoveChild(Node node) ``` Remove a *child* node from *this node*. ###### `node`^Required - *Type:* Node --- ##### `mutateRemoveLink` ```java public java.lang.Boolean mutateRemoveLink(Edge link) ``` Remove a *link* from *this node*. ###### `link`^Required - *Type:* Edge --- ##### `mutateRemoveReverseLink` ```java public java.lang.Boolean mutateRemoveReverseLink(Edge link) ``` Remove a *link* to *this node*. ###### `link`^Required - *Type:* Edge --- ##### `mutateUncluster` ```java public void mutateUncluster() ``` Hoist all children to parent and collapse node to parent. ##### `toString` ```java public java.lang.String toString() ``` Get string representation of this node. ##### `isEquivalentFqn` ```java public java.lang.Boolean isEquivalentFqn(ResourceNode resource) ``` Evaluates if CfnResourceNode fqn is equivalent to ResourceNode fqn. *Example* ```java // Example automatically generated from non-compiling source. May contain errors. "aws-cdk-lib.aws_lambda.Function";"aws-cdk-lib.aws_lambda.CfnFunction"; ``` ###### `resource`^Required - *Type:* ResourceNode {@link Graph.ResourceNode } to compare. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isCfnResourceNode | Indicates if a node is a {@link CfnResourceNode}. | --- ##### `isCfnResourceNode` ```java import software.aws.awsprototypingsdk.cdkgraph.CfnResourceNode; CfnResourceNode.isCfnResourceNode(Node node) ``` Indicates if a node is a {@link CfnResourceNode}. ###### `node`^Required - *Type:* Node --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | attributes | java.util.MapPlainObject OR java.util.ListPlainObject>> | Get *readonly* record of all attributes. | | flags | java.util.List<FlagEnum> | Get *readonly* list of all flags. | | isDestroyed | java.lang.Boolean | Indicates if the entity has been destroyed (eg: removed from store). | | isMutated | java.lang.Boolean | Indicates if the entity has had destructive mutations applied. | | metadata | java.util.List | Get *readonly* list of all metadata entries. | | store | Store | Reference to the store. | | tags | java.util.Map | Get *readonly* record of all tags. | | uuid | java.lang.String | Universally unique identifier. | | allowDestructiveMutations | java.lang.Boolean | Indicates if this node allows destructive mutations. | | children | java.util.List<Node> | Get all direct child nodes. | | dependedOnBy | java.util.List<Node> | Get list of **Nodes** that *depend on this node*. | | dependencies | java.util.List<Node> | Get list of **Nodes** that *this node depends on*. | | dependencyLinks | java.util.List<Dependency> | Gets list of {@link Dependency} links (edges) where this node is the **source**. | | depth | java.lang.Number | Indicates the depth of the node relative to root (0). | | id | java.lang.String | Node id, which is only unique within parent scope. | | isAsset | java.lang.Boolean | Indicates if this node is considered a {@link FlagEnum.ASSET}. | | isCfnFqn | java.lang.Boolean | Indicates if node ConstructInfoFqn denotes a `aws-cdk-lib.*.Cfn*` construct. | | isCluster | java.lang.Boolean | Indicates if this node is considered a {@link FlagEnum.CLUSTER}. | | isCustomResource | java.lang.Boolean | Indicates if node is a *Custom Resource*. | | isExtraneous | java.lang.Boolean | Indicates if this node is considered a {@link FlagEnum.EXTRANEOUS} node or determined to be extraneous: - Clusters that contain no children. | | isGraphContainer | java.lang.Boolean | Indicates if this node is considered a {@link FlagEnum.GRAPH_CONTAINER}. | | isLeaf | java.lang.Boolean | Indicates if this node is a *leaf* node, which means it does not have children. | | isTopLevel | java.lang.Boolean | Indicates if node is direct child of the graph root node. | | links | java.util.List<Edge> | Gets all links (edges) in which this node is the **source**. | | nodeType | NodeTypeEnum | Type of node. | | path | java.lang.String | Path of the node. | | referencedBy | java.util.List<Node> | Get list of **Nodes** that *reference this node*. | | referenceLinks | java.util.List<Reference> | Gets list of {@link Reference} links (edges) where this node is the **source**. | | references | java.util.List<Node> | Get list of **Nodes** that *this node references*. | | reverseDependencyLinks | java.util.List<Dependency> | Gets list of {@link Dependency} links (edges) where this node is the **target**. | | reverseLinks | java.util.List<Edge> | Gets all links (edges) in which this node is the **target**. | | reverseReferenceLinks | java.util.List<Reference> | Gets list of {@link Reference} links (edges) where this node is the **target**. | | scopes | java.util.List<Node> | Gets descending ordered list of ancestors from the root. | | siblings | java.util.List<Node> | Get list of *siblings* of this node. | | cfnProps | PlainObject | Gets CloudFormation properties for this node. | | cfnType | java.lang.String | Get the CloudFormation resource type for this node. | | constructInfo | ConstructInfo | Synthesized construct information defining jii resolution data. | | constructInfoFqn | java.lang.String | Synthesized construct information defining jii resolution data. | | logicalId | java.lang.String | Logical id of the node, which is only unique within containing stack. | | parent | Node | Parent node. | | rootStack | StackNode | Get **root** stack. | | stack | StackNode | Stack the node is contained in. | | isImport | java.lang.Boolean | Indicates if this CfnResource is imported (eg: `s3.Bucket.fromBucketArn`). | | resource | ResourceNode | Reference to the L2 Resource that wraps this L1 CfnResource if it is wrapped. | --- ##### `attributes`^Required ```java public java.lang.Object getAttributes(); ``` - *Type:* java.util.MapPlainObject OR java.util.ListPlainObject>> Get *readonly* record of all attributes. --- ##### `flags`^Required ```java public java.util.List getFlags(); ``` - *Type:* java.util.List<FlagEnum> Get *readonly* list of all flags. --- ##### `isDestroyed`^Required ```java public java.lang.Boolean getIsDestroyed(); ``` - *Type:* java.lang.Boolean Indicates if the entity has been destroyed (eg: removed from store). --- ##### `isMutated`^Required ```java public java.lang.Boolean getIsMutated(); ``` - *Type:* java.lang.Boolean Indicates if the entity has had destructive mutations applied. --- ##### `metadata`^Required ```java public java.util.List getMetadata(); ``` - *Type:* java.util.List Get *readonly* list of all metadata entries. --- ##### `store`^Required ```java public Store getStore(); ``` - *Type:* Store Reference to the store. --- ##### `tags`^Required ```java public java.util.Map getTags(); ``` - *Type:* java.util.Map Get *readonly* record of all tags. --- ##### `uuid`^Required ```java public java.lang.String getUuid(); ``` - *Type:* java.lang.String Universally unique identifier. --- ##### `allowDestructiveMutations`^Required ```java public java.lang.Boolean getAllowDestructiveMutations(); ``` - *Type:* java.lang.Boolean Indicates if this node allows destructive mutations. > [{@link Store.allowDestructiveMutations }]({@link Store.allowDestructiveMutations }) --- ##### `children`^Required ```java public java.util.List getChildren(); ``` - *Type:* java.util.List<Node> Get all direct child nodes. --- ##### `dependedOnBy`^Required ```java public java.util.List getDependedOnBy(); ``` - *Type:* java.util.List<Node> Get list of **Nodes** that *depend on this node*. > [{@link Node.reverseDependencyLinks }]({@link Node.reverseDependencyLinks }) --- ##### `dependencies`^Required ```java public java.util.List getDependencies(); ``` - *Type:* java.util.List<Node> Get list of **Nodes** that *this node depends on*. > [{@link Node.dependencyLinks }]({@link Node.dependencyLinks }) --- ##### `dependencyLinks`^Required ```java public java.util.List getDependencyLinks(); ``` - *Type:* java.util.List<Dependency> Gets list of {@link Dependency} links (edges) where this node is the **source**. --- ##### `depth`^Required ```java public java.lang.Number getDepth(); ``` - *Type:* java.lang.Number Indicates the depth of the node relative to root (0). --- ##### `id`^Required ```java public java.lang.String getId(); ``` - *Type:* java.lang.String Node id, which is only unique within parent scope. --- ##### `isAsset`^Required ```java public java.lang.Boolean getIsAsset(); ``` - *Type:* java.lang.Boolean Indicates if this node is considered a {@link FlagEnum.ASSET}. --- ##### `isCfnFqn`^Required ```java public java.lang.Boolean getIsCfnFqn(); ``` - *Type:* java.lang.Boolean Indicates if node ConstructInfoFqn denotes a `aws-cdk-lib.*.Cfn*` construct. > [{@link FlagEnum.CFN_FQN }]({@link FlagEnum.CFN_FQN }) --- ##### `isCluster`^Required ```java public java.lang.Boolean getIsCluster(); ``` - *Type:* java.lang.Boolean Indicates if this node is considered a {@link FlagEnum.CLUSTER}. --- ##### `isCustomResource`^Required ```java public java.lang.Boolean getIsCustomResource(); ``` - *Type:* java.lang.Boolean Indicates if node is a *Custom Resource*. --- ##### `isExtraneous`^Required ```java public java.lang.Boolean getIsExtraneous(); ``` - *Type:* java.lang.Boolean Indicates if this node is considered a {@link FlagEnum.EXTRANEOUS} node or determined to be extraneous: - Clusters that contain no children. --- ##### `isGraphContainer`^Required ```java public java.lang.Boolean getIsGraphContainer(); ``` - *Type:* java.lang.Boolean Indicates if this node is considered a {@link FlagEnum.GRAPH_CONTAINER}. --- ##### `isLeaf`^Required ```java public java.lang.Boolean getIsLeaf(); ``` - *Type:* java.lang.Boolean Indicates if this node is a *leaf* node, which means it does not have children. --- ##### `isTopLevel`^Required ```java public java.lang.Boolean getIsTopLevel(); ``` - *Type:* java.lang.Boolean Indicates if node is direct child of the graph root node. --- ##### `links`^Required ```java public java.util.List getLinks(); ``` - *Type:* java.util.List<Edge> Gets all links (edges) in which this node is the **source**. --- ##### `nodeType`^Required ```java public NodeTypeEnum getNodeType(); ``` - *Type:* NodeTypeEnum Type of node. --- ##### `path`^Required ```java public java.lang.String getPath(); ``` - *Type:* java.lang.String Path of the node. --- ##### `referencedBy`^Required ```java public java.util.List getReferencedBy(); ``` - *Type:* java.util.List<Node> Get list of **Nodes** that *reference this node*. > [{@link Node.reverseReferenceLinks }]({@link Node.reverseReferenceLinks }) --- ##### `referenceLinks`^Required ```java public java.util.List getReferenceLinks(); ``` - *Type:* java.util.List<Reference> Gets list of {@link Reference} links (edges) where this node is the **source**. --- ##### `references`^Required ```java public java.util.List getReferences(); ``` - *Type:* java.util.List<Node> Get list of **Nodes** that *this node references*. > [{@link Node.referenceLinks }]({@link Node.referenceLinks }) --- ##### `reverseDependencyLinks`^Required ```java public java.util.List getReverseDependencyLinks(); ``` - *Type:* java.util.List<Dependency> Gets list of {@link Dependency} links (edges) where this node is the **target**. --- ##### `reverseLinks`^Required ```java public java.util.List getReverseLinks(); ``` - *Type:* java.util.List<Edge> Gets all links (edges) in which this node is the **target**. --- ##### `reverseReferenceLinks`^Required ```java public java.util.List getReverseReferenceLinks(); ``` - *Type:* java.util.List<Reference> Gets list of {@link Reference} links (edges) where this node is the **target**. --- ##### `scopes`^Required ```java public java.util.List getScopes(); ``` - *Type:* java.util.List<Node> Gets descending ordered list of ancestors from the root. --- ##### `siblings`^Required ```java public java.util.List getSiblings(); ``` - *Type:* java.util.List<Node> Get list of *siblings* of this node. --- ##### `cfnProps`^Optional ```java public PlainObject getCfnProps(); ``` - *Type:* PlainObject Gets CloudFormation properties for this node. --- ##### `cfnType`^Optional ```java public java.lang.String getCfnType(); ``` - *Type:* java.lang.String Get the CloudFormation resource type for this node. --- ##### `constructInfo`^Optional ```java public ConstructInfo getConstructInfo(); ``` - *Type:* ConstructInfo Synthesized construct information defining jii resolution data. --- ##### `constructInfoFqn`^Optional ```java public java.lang.String getConstructInfoFqn(); ``` - *Type:* java.lang.String Synthesized construct information defining jii resolution data. --- ##### `logicalId`^Optional ```java public java.lang.String getLogicalId(); ``` - *Type:* java.lang.String Logical id of the node, which is only unique within containing stack. --- ##### `parent`^Optional ```java public Node getParent(); ``` - *Type:* Node Parent node. Only the root node should not have parent. --- ##### `rootStack`^Optional ```java public StackNode getRootStack(); ``` - *Type:* StackNode Get **root** stack. --- ##### `stack`^Optional ```java public StackNode getStack(); ``` - *Type:* StackNode Stack the node is contained in. --- ##### `isImport`^Required ```java public java.lang.Boolean getIsImport(); ``` - *Type:* java.lang.Boolean Indicates if this CfnResource is imported (eg: `s3.Bucket.fromBucketArn`). --- ##### `resource`^Optional ```java public ResourceNode getResource(); ``` - *Type:* ResourceNode Reference to the L2 Resource that wraps this L1 CfnResource if it is wrapped. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ATT_IMPORT_ARN_TOKEN | java.lang.String | Normalized CfnReference attribute. | --- ##### `ATT_IMPORT_ARN_TOKEN`^Required ```java public java.lang.String getAttImportArnToken(); ``` - *Type:* java.lang.String Normalized CfnReference attribute. --- ### Dependency Dependency edge class defines CloudFormation dependency between resources. #### Initializers ```java import software.aws.awsprototypingsdk.cdkgraph.Dependency; new Dependency(ITypedEdgeProps props); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | ITypedEdgeProps | *No description.* | --- ##### `props`^Required - *Type:* ITypedEdgeProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAttribute | Add attribute. | | addFlag | Add flag. | | addMetadata | Add metadata entry. | | addTag | Add tag. | | applyData | Applies data (attributes, metadata, tags, flag) to entity. | | findMetadata | Retrieves all metadata entries of a given type. | | getAttribute | Get attribute by key. | | getTag | Get tag by key. | | hasAttribute | Indicates if entity has a given attribute defined, and optionally with a specific value. | | hasFlag | Indicates if entity has a given flag. | | hasMetadata | Indicates if entity has matching metadata entry. | | hasTag | Indicates if entity has tag, optionally verifying tag value. | | mutateDestroy | Destroy the edge. | | setAttribute | Set attribute. | | setTag | Set tag. | | isEquivalent | Indicates if this edge is equivalent to another edge. | | mutateConsume | Merge an equivalent edge's data into this edge and destroy the other edge. | | mutateDirection | Change the edge **direction**. | | mutateSource | Change the edge **source**. | | mutateTarget | Change the edge **target**. | | toString | Get string representation of this edge. | --- ##### `addAttribute` ```java public void addAttribute(java.lang.String key, java.lang.Object value) ``` Add attribute. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.Object --- ##### `addFlag` ```java public void addFlag(FlagEnum flag) ``` Add flag. ###### `flag`^Required - *Type:* FlagEnum --- ##### `addMetadata` ```java public void addMetadata(java.lang.String metadataType, java.lang.Object data) ``` Add metadata entry. ###### `metadataType`^Required - *Type:* java.lang.String --- ###### `data`^Required - *Type:* java.lang.Object --- ##### `addTag` ```java public void addTag(java.lang.String key, java.lang.String value) ``` Add tag. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.String --- ##### `applyData` ```java public void applyData(IBaseEntityDataProps data) public void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite) public void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite, java.lang.Boolean applyFlags) ``` Applies data (attributes, metadata, tags, flag) to entity. Generally used only for mutations such as collapse and consume to retain data. ###### `data`^Required - *Type:* IBaseEntityDataProps The data to apply. --- ###### `overwrite`^Optional - *Type:* java.lang.Boolean --- ###### `applyFlags`^Optional - *Type:* java.lang.Boolean Indicates if data is overwritten - Indicates if flags should be applied. --- ##### `findMetadata` ```java public java.util.List findMetadata(java.lang.String metadataType) ``` Retrieves all metadata entries of a given type. ###### `metadataType`^Required - *Type:* java.lang.String --- ##### `getAttribute` ```java public java.lang.Object getAttribute(java.lang.String key) ``` Get attribute by key. ###### `key`^Required - *Type:* java.lang.String --- ##### `getTag` ```java public java.lang.String getTag(java.lang.String key) ``` Get tag by key. ###### `key`^Required - *Type:* java.lang.String --- ##### `hasAttribute` ```java public java.lang.Boolean hasAttribute(java.lang.String key) public java.lang.Boolean hasAttribute(java.lang.String key, java.lang.Object value) ``` Indicates if entity has a given attribute defined, and optionally with a specific value. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Optional - *Type:* java.lang.Object --- ##### `hasFlag` ```java public java.lang.Boolean hasFlag(FlagEnum flag) ``` Indicates if entity has a given flag. ###### `flag`^Required - *Type:* FlagEnum --- ##### `hasMetadata` ```java public java.lang.Boolean hasMetadata(java.lang.String metadataType, java.lang.Object data) ``` Indicates if entity has matching metadata entry. ###### `metadataType`^Required - *Type:* java.lang.String --- ###### `data`^Required - *Type:* java.lang.Object --- ##### `hasTag` ```java public java.lang.Boolean hasTag(java.lang.String key) public java.lang.Boolean hasTag(java.lang.String key, java.lang.String value) ``` Indicates if entity has tag, optionally verifying tag value. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Optional - *Type:* java.lang.String --- ##### `mutateDestroy` ```java public void mutateDestroy() public void mutateDestroy(java.lang.Boolean _strict) ``` Destroy the edge. Remove all references and remove from store. ###### `_strict`^Optional - *Type:* java.lang.Boolean --- ##### `setAttribute` ```java public void setAttribute(java.lang.String key, java.lang.Object value) ``` Set attribute. This will overwrite existing attribute. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.Object --- ##### `setTag` ```java public void setTag(java.lang.String key, java.lang.String value) ``` Set tag. Will overwrite existing tag. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.String --- ##### `isEquivalent` ```java public java.lang.Boolean isEquivalent(Edge edge) ``` Indicates if this edge is equivalent to another edge. Edges are considered equivalent if they share same type, source, and target. ###### `edge`^Required - *Type:* Edge --- ##### `mutateConsume` ```java public void mutateConsume(Edge edge) ``` Merge an equivalent edge's data into this edge and destroy the other edge. Used during filtering operations to consolidate equivalent edges. ###### `edge`^Required - *Type:* Edge The edge to consume. --- ##### `mutateDirection` ```java public void mutateDirection(EdgeDirectionEnum direction) ``` Change the edge **direction**. ###### `direction`^Required - *Type:* EdgeDirectionEnum --- ##### `mutateSource` ```java public void mutateSource(Node node) ``` Change the edge **source**. ###### `node`^Required - *Type:* Node --- ##### `mutateTarget` ```java public void mutateTarget(Node node) ``` Change the edge **target**. ###### `node`^Required - *Type:* Node --- ##### `toString` ```java public java.lang.String toString() ``` Get string representation of this edge. #### Static Functions | **Name** | **Description** | | --- | --- | | findAllInChain | Find all matching edges based on predicate within an EdgeChain. | | findInChain | Find first edge matching predicate within an EdgeChain. | | isDependency | Indicates if given edge is a {@link Dependency} edge. | --- ##### `findAllInChain` ```java import software.aws.awsprototypingsdk.cdkgraph.Dependency; Dependency.findAllInChain(java.util.List chain, IEdgePredicate predicate) ``` Find all matching edges based on predicate within an EdgeChain. ###### `chain`^Required - *Type:* java.util.List --- ###### `predicate`^Required - *Type:* IEdgePredicate --- ##### `findInChain` ```java import software.aws.awsprototypingsdk.cdkgraph.Dependency; Dependency.findInChain(java.util.List chain, IEdgePredicate predicate) ``` Find first edge matching predicate within an EdgeChain. ###### `chain`^Required - *Type:* java.util.List --- ###### `predicate`^Required - *Type:* IEdgePredicate --- ##### `isDependency` ```java import software.aws.awsprototypingsdk.cdkgraph.Dependency; Dependency.isDependency(Edge edge) ``` Indicates if given edge is a {@link Dependency} edge. ###### `edge`^Required - *Type:* Edge --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | attributes | java.util.MapPlainObject OR java.util.ListPlainObject>> | Get *readonly* record of all attributes. | | flags | java.util.List<FlagEnum> | Get *readonly* list of all flags. | | isDestroyed | java.lang.Boolean | Indicates if the entity has been destroyed (eg: removed from store). | | isMutated | java.lang.Boolean | Indicates if the entity has had destructive mutations applied. | | metadata | java.util.List | Get *readonly* list of all metadata entries. | | store | Store | Reference to the store. | | tags | java.util.Map | Get *readonly* record of all tags. | | uuid | java.lang.String | Universally unique identifier. | | allowDestructiveMutations | java.lang.Boolean | Indicates if edge allows destructive mutations. | | direction | EdgeDirectionEnum | Indicates the direction in which the edge is directed. | | edgeType | EdgeTypeEnum | Type of edge. | | isClosed | java.lang.Boolean | Indicates if the Edge's **source** and **target** are the same, or were the same when it was created (prior to mutations). | | isCrossStack | java.lang.Boolean | Indicates if **source** and **target** nodes reside in different *root* stacks. | | isExtraneous | java.lang.Boolean | Indicates if edge is extraneous which is determined by explicitly having *EXTRANEOUS* flag added and/or being a closed loop (source===target). | | source | Node | Edge **source** is the node that defines the edge (tail). | | target | Node | Edge **target** is the node being referenced by the **source** (head). | --- ##### `attributes`^Required ```java public java.lang.Object getAttributes(); ``` - *Type:* java.util.MapPlainObject OR java.util.ListPlainObject>> Get *readonly* record of all attributes. --- ##### `flags`^Required ```java public java.util.List getFlags(); ``` - *Type:* java.util.List<FlagEnum> Get *readonly* list of all flags. --- ##### `isDestroyed`^Required ```java public java.lang.Boolean getIsDestroyed(); ``` - *Type:* java.lang.Boolean Indicates if the entity has been destroyed (eg: removed from store). --- ##### `isMutated`^Required ```java public java.lang.Boolean getIsMutated(); ``` - *Type:* java.lang.Boolean Indicates if the entity has had destructive mutations applied. --- ##### `metadata`^Required ```java public java.util.List getMetadata(); ``` - *Type:* java.util.List Get *readonly* list of all metadata entries. --- ##### `store`^Required ```java public Store getStore(); ``` - *Type:* Store Reference to the store. --- ##### `tags`^Required ```java public java.util.Map getTags(); ``` - *Type:* java.util.Map Get *readonly* record of all tags. --- ##### `uuid`^Required ```java public java.lang.String getUuid(); ``` - *Type:* java.lang.String Universally unique identifier. --- ##### `allowDestructiveMutations`^Required ```java public java.lang.Boolean getAllowDestructiveMutations(); ``` - *Type:* java.lang.Boolean Indicates if edge allows destructive mutations. --- ##### `direction`^Required ```java public EdgeDirectionEnum getDirection(); ``` - *Type:* EdgeDirectionEnum Indicates the direction in which the edge is directed. --- ##### `edgeType`^Required ```java public EdgeTypeEnum getEdgeType(); ``` - *Type:* EdgeTypeEnum Type of edge. --- ##### `isClosed`^Required ```java public java.lang.Boolean getIsClosed(); ``` - *Type:* java.lang.Boolean Indicates if the Edge's **source** and **target** are the same, or were the same when it was created (prior to mutations). To check whether it was originally closed, use `hasFlag(FlagEnum.CLOSED_EDGE)` instead. --- ##### `isCrossStack`^Required ```java public java.lang.Boolean getIsCrossStack(); ``` - *Type:* java.lang.Boolean Indicates if **source** and **target** nodes reside in different *root* stacks. --- ##### `isExtraneous`^Required ```java public java.lang.Boolean getIsExtraneous(); ``` - *Type:* java.lang.Boolean Indicates if edge is extraneous which is determined by explicitly having *EXTRANEOUS* flag added and/or being a closed loop (source===target). --- ##### `source`^Required ```java public Node getSource(); ``` - *Type:* Node Edge **source** is the node that defines the edge (tail). --- ##### `target`^Required ```java public Node getTarget(); ``` - *Type:* Node Edge **target** is the node being referenced by the **source** (head). --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | PREFIX | java.lang.String | Edge prefix to denote dependency edge. | --- ##### `PREFIX`^Required ```java public java.lang.String getPrefix(); ``` - *Type:* java.lang.String Edge prefix to denote dependency edge. --- ### Edge - *Implements:* ISerializableEdge Edge class defines a link (relationship) between nodes, as in standard [graph theory](https://en.wikipedia.org/wiki/Graph_theory). #### Initializers ```java import software.aws.awsprototypingsdk.cdkgraph.Edge; new Edge(IEdgeProps props); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | IEdgeProps | *No description.* | --- ##### `props`^Required - *Type:* IEdgeProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAttribute | Add attribute. | | addFlag | Add flag. | | addMetadata | Add metadata entry. | | addTag | Add tag. | | applyData | Applies data (attributes, metadata, tags, flag) to entity. | | findMetadata | Retrieves all metadata entries of a given type. | | getAttribute | Get attribute by key. | | getTag | Get tag by key. | | hasAttribute | Indicates if entity has a given attribute defined, and optionally with a specific value. | | hasFlag | Indicates if entity has a given flag. | | hasMetadata | Indicates if entity has matching metadata entry. | | hasTag | Indicates if entity has tag, optionally verifying tag value. | | mutateDestroy | Destroy the edge. | | setAttribute | Set attribute. | | setTag | Set tag. | | isEquivalent | Indicates if this edge is equivalent to another edge. | | mutateConsume | Merge an equivalent edge's data into this edge and destroy the other edge. | | mutateDirection | Change the edge **direction**. | | mutateSource | Change the edge **source**. | | mutateTarget | Change the edge **target**. | | toString | Get string representation of this edge. | --- ##### `addAttribute` ```java public void addAttribute(java.lang.String key, java.lang.Object value) ``` Add attribute. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.Object --- ##### `addFlag` ```java public void addFlag(FlagEnum flag) ``` Add flag. ###### `flag`^Required - *Type:* FlagEnum --- ##### `addMetadata` ```java public void addMetadata(java.lang.String metadataType, java.lang.Object data) ``` Add metadata entry. ###### `metadataType`^Required - *Type:* java.lang.String --- ###### `data`^Required - *Type:* java.lang.Object --- ##### `addTag` ```java public void addTag(java.lang.String key, java.lang.String value) ``` Add tag. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.String --- ##### `applyData` ```java public void applyData(IBaseEntityDataProps data) public void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite) public void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite, java.lang.Boolean applyFlags) ``` Applies data (attributes, metadata, tags, flag) to entity. Generally used only for mutations such as collapse and consume to retain data. ###### `data`^Required - *Type:* IBaseEntityDataProps The data to apply. --- ###### `overwrite`^Optional - *Type:* java.lang.Boolean --- ###### `applyFlags`^Optional - *Type:* java.lang.Boolean Indicates if data is overwritten - Indicates if flags should be applied. --- ##### `findMetadata` ```java public java.util.List findMetadata(java.lang.String metadataType) ``` Retrieves all metadata entries of a given type. ###### `metadataType`^Required - *Type:* java.lang.String --- ##### `getAttribute` ```java public java.lang.Object getAttribute(java.lang.String key) ``` Get attribute by key. ###### `key`^Required - *Type:* java.lang.String --- ##### `getTag` ```java public java.lang.String getTag(java.lang.String key) ``` Get tag by key. ###### `key`^Required - *Type:* java.lang.String --- ##### `hasAttribute` ```java public java.lang.Boolean hasAttribute(java.lang.String key) public java.lang.Boolean hasAttribute(java.lang.String key, java.lang.Object value) ``` Indicates if entity has a given attribute defined, and optionally with a specific value. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Optional - *Type:* java.lang.Object --- ##### `hasFlag` ```java public java.lang.Boolean hasFlag(FlagEnum flag) ``` Indicates if entity has a given flag. ###### `flag`^Required - *Type:* FlagEnum --- ##### `hasMetadata` ```java public java.lang.Boolean hasMetadata(java.lang.String metadataType, java.lang.Object data) ``` Indicates if entity has matching metadata entry. ###### `metadataType`^Required - *Type:* java.lang.String --- ###### `data`^Required - *Type:* java.lang.Object --- ##### `hasTag` ```java public java.lang.Boolean hasTag(java.lang.String key) public java.lang.Boolean hasTag(java.lang.String key, java.lang.String value) ``` Indicates if entity has tag, optionally verifying tag value. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Optional - *Type:* java.lang.String --- ##### `mutateDestroy` ```java public void mutateDestroy() public void mutateDestroy(java.lang.Boolean _strict) ``` Destroy the edge. Remove all references and remove from store. ###### `_strict`^Optional - *Type:* java.lang.Boolean --- ##### `setAttribute` ```java public void setAttribute(java.lang.String key, java.lang.Object value) ``` Set attribute. This will overwrite existing attribute. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.Object --- ##### `setTag` ```java public void setTag(java.lang.String key, java.lang.String value) ``` Set tag. Will overwrite existing tag. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.String --- ##### `isEquivalent` ```java public java.lang.Boolean isEquivalent(Edge edge) ``` Indicates if this edge is equivalent to another edge. Edges are considered equivalent if they share same type, source, and target. ###### `edge`^Required - *Type:* Edge --- ##### `mutateConsume` ```java public void mutateConsume(Edge edge) ``` Merge an equivalent edge's data into this edge and destroy the other edge. Used during filtering operations to consolidate equivalent edges. ###### `edge`^Required - *Type:* Edge The edge to consume. --- ##### `mutateDirection` ```java public void mutateDirection(EdgeDirectionEnum direction) ``` Change the edge **direction**. ###### `direction`^Required - *Type:* EdgeDirectionEnum --- ##### `mutateSource` ```java public void mutateSource(Node node) ``` Change the edge **source**. ###### `node`^Required - *Type:* Node --- ##### `mutateTarget` ```java public void mutateTarget(Node node) ``` Change the edge **target**. ###### `node`^Required - *Type:* Node --- ##### `toString` ```java public java.lang.String toString() ``` Get string representation of this edge. #### Static Functions | **Name** | **Description** | | --- | --- | | findAllInChain | Find all matching edges based on predicate within an EdgeChain. | | findInChain | Find first edge matching predicate within an EdgeChain. | --- ##### `findAllInChain` ```java import software.aws.awsprototypingsdk.cdkgraph.Edge; Edge.findAllInChain(java.util.List chain, IEdgePredicate predicate) ``` Find all matching edges based on predicate within an EdgeChain. ###### `chain`^Required - *Type:* java.util.List --- ###### `predicate`^Required - *Type:* IEdgePredicate --- ##### `findInChain` ```java import software.aws.awsprototypingsdk.cdkgraph.Edge; Edge.findInChain(java.util.List chain, IEdgePredicate predicate) ``` Find first edge matching predicate within an EdgeChain. ###### `chain`^Required - *Type:* java.util.List --- ###### `predicate`^Required - *Type:* IEdgePredicate --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | attributes | java.util.MapPlainObject OR java.util.ListPlainObject>> | Get *readonly* record of all attributes. | | flags | java.util.List<FlagEnum> | Get *readonly* list of all flags. | | isDestroyed | java.lang.Boolean | Indicates if the entity has been destroyed (eg: removed from store). | | isMutated | java.lang.Boolean | Indicates if the entity has had destructive mutations applied. | | metadata | java.util.List | Get *readonly* list of all metadata entries. | | store | Store | Reference to the store. | | tags | java.util.Map | Get *readonly* record of all tags. | | uuid | java.lang.String | Universally unique identifier. | | allowDestructiveMutations | java.lang.Boolean | Indicates if edge allows destructive mutations. | | direction | EdgeDirectionEnum | Indicates the direction in which the edge is directed. | | edgeType | EdgeTypeEnum | Type of edge. | | isClosed | java.lang.Boolean | Indicates if the Edge's **source** and **target** are the same, or were the same when it was created (prior to mutations). | | isCrossStack | java.lang.Boolean | Indicates if **source** and **target** nodes reside in different *root* stacks. | | isExtraneous | java.lang.Boolean | Indicates if edge is extraneous which is determined by explicitly having *EXTRANEOUS* flag added and/or being a closed loop (source===target). | | source | Node | Edge **source** is the node that defines the edge (tail). | | target | Node | Edge **target** is the node being referenced by the **source** (head). | --- ##### `attributes`^Required ```java public java.lang.Object getAttributes(); ``` - *Type:* java.util.MapPlainObject OR java.util.ListPlainObject>> Get *readonly* record of all attributes. --- ##### `flags`^Required ```java public java.util.List getFlags(); ``` - *Type:* java.util.List<FlagEnum> Get *readonly* list of all flags. --- ##### `isDestroyed`^Required ```java public java.lang.Boolean getIsDestroyed(); ``` - *Type:* java.lang.Boolean Indicates if the entity has been destroyed (eg: removed from store). --- ##### `isMutated`^Required ```java public java.lang.Boolean getIsMutated(); ``` - *Type:* java.lang.Boolean Indicates if the entity has had destructive mutations applied. --- ##### `metadata`^Required ```java public java.util.List getMetadata(); ``` - *Type:* java.util.List Get *readonly* list of all metadata entries. --- ##### `store`^Required ```java public Store getStore(); ``` - *Type:* Store Reference to the store. --- ##### `tags`^Required ```java public java.util.Map getTags(); ``` - *Type:* java.util.Map Get *readonly* record of all tags. --- ##### `uuid`^Required ```java public java.lang.String getUuid(); ``` - *Type:* java.lang.String Universally unique identifier. --- ##### `allowDestructiveMutations`^Required ```java public java.lang.Boolean getAllowDestructiveMutations(); ``` - *Type:* java.lang.Boolean Indicates if edge allows destructive mutations. --- ##### `direction`^Required ```java public EdgeDirectionEnum getDirection(); ``` - *Type:* EdgeDirectionEnum Indicates the direction in which the edge is directed. --- ##### `edgeType`^Required ```java public EdgeTypeEnum getEdgeType(); ``` - *Type:* EdgeTypeEnum Type of edge. --- ##### `isClosed`^Required ```java public java.lang.Boolean getIsClosed(); ``` - *Type:* java.lang.Boolean Indicates if the Edge's **source** and **target** are the same, or were the same when it was created (prior to mutations). To check whether it was originally closed, use `hasFlag(FlagEnum.CLOSED_EDGE)` instead. --- ##### `isCrossStack`^Required ```java public java.lang.Boolean getIsCrossStack(); ``` - *Type:* java.lang.Boolean Indicates if **source** and **target** nodes reside in different *root* stacks. --- ##### `isExtraneous`^Required ```java public java.lang.Boolean getIsExtraneous(); ``` - *Type:* java.lang.Boolean Indicates if edge is extraneous which is determined by explicitly having *EXTRANEOUS* flag added and/or being a closed loop (source===target). --- ##### `source`^Required ```java public Node getSource(); ``` - *Type:* Node Edge **source** is the node that defines the edge (tail). --- ##### `target`^Required ```java public Node getTarget(); ``` - *Type:* Node Edge **target** is the node being referenced by the **source** (head). --- ### ImportReference Import reference defines **Fn::ImportValue** type reference edge. #### Initializers ```java import software.aws.awsprototypingsdk.cdkgraph.ImportReference; new ImportReference(ITypedEdgeProps props); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | ITypedEdgeProps | *No description.* | --- ##### `props`^Required - *Type:* ITypedEdgeProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAttribute | Add attribute. | | addFlag | Add flag. | | addMetadata | Add metadata entry. | | addTag | Add tag. | | applyData | Applies data (attributes, metadata, tags, flag) to entity. | | findMetadata | Retrieves all metadata entries of a given type. | | getAttribute | Get attribute by key. | | getTag | Get tag by key. | | hasAttribute | Indicates if entity has a given attribute defined, and optionally with a specific value. | | hasFlag | Indicates if entity has a given flag. | | hasMetadata | Indicates if entity has matching metadata entry. | | hasTag | Indicates if entity has tag, optionally verifying tag value. | | mutateDestroy | Destroy the edge. | | setAttribute | Set attribute. | | setTag | Set tag. | | isEquivalent | Indicates if this edge is equivalent to another edge. | | mutateConsume | Merge an equivalent edge's data into this edge and destroy the other edge. | | mutateDirection | Change the edge **direction**. | | mutateSource | Change the edge **source**. | | mutateTarget | Change the edge **target**. | | toString | Get string representation of this edge. | | resolveChain | Resolve reference chain. | | resolveTargets | Resolve targets by following potential edge chain. | --- ##### `addAttribute` ```java public void addAttribute(java.lang.String key, java.lang.Object value) ``` Add attribute. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.Object --- ##### `addFlag` ```java public void addFlag(FlagEnum flag) ``` Add flag. ###### `flag`^Required - *Type:* FlagEnum --- ##### `addMetadata` ```java public void addMetadata(java.lang.String metadataType, java.lang.Object data) ``` Add metadata entry. ###### `metadataType`^Required - *Type:* java.lang.String --- ###### `data`^Required - *Type:* java.lang.Object --- ##### `addTag` ```java public void addTag(java.lang.String key, java.lang.String value) ``` Add tag. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.String --- ##### `applyData` ```java public void applyData(IBaseEntityDataProps data) public void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite) public void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite, java.lang.Boolean applyFlags) ``` Applies data (attributes, metadata, tags, flag) to entity. Generally used only for mutations such as collapse and consume to retain data. ###### `data`^Required - *Type:* IBaseEntityDataProps The data to apply. --- ###### `overwrite`^Optional - *Type:* java.lang.Boolean --- ###### `applyFlags`^Optional - *Type:* java.lang.Boolean Indicates if data is overwritten - Indicates if flags should be applied. --- ##### `findMetadata` ```java public java.util.List findMetadata(java.lang.String metadataType) ``` Retrieves all metadata entries of a given type. ###### `metadataType`^Required - *Type:* java.lang.String --- ##### `getAttribute` ```java public java.lang.Object getAttribute(java.lang.String key) ``` Get attribute by key. ###### `key`^Required - *Type:* java.lang.String --- ##### `getTag` ```java public java.lang.String getTag(java.lang.String key) ``` Get tag by key. ###### `key`^Required - *Type:* java.lang.String --- ##### `hasAttribute` ```java public java.lang.Boolean hasAttribute(java.lang.String key) public java.lang.Boolean hasAttribute(java.lang.String key, java.lang.Object value) ``` Indicates if entity has a given attribute defined, and optionally with a specific value. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Optional - *Type:* java.lang.Object --- ##### `hasFlag` ```java public java.lang.Boolean hasFlag(FlagEnum flag) ``` Indicates if entity has a given flag. ###### `flag`^Required - *Type:* FlagEnum --- ##### `hasMetadata` ```java public java.lang.Boolean hasMetadata(java.lang.String metadataType, java.lang.Object data) ``` Indicates if entity has matching metadata entry. ###### `metadataType`^Required - *Type:* java.lang.String --- ###### `data`^Required - *Type:* java.lang.Object --- ##### `hasTag` ```java public java.lang.Boolean hasTag(java.lang.String key) public java.lang.Boolean hasTag(java.lang.String key, java.lang.String value) ``` Indicates if entity has tag, optionally verifying tag value. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Optional - *Type:* java.lang.String --- ##### `mutateDestroy` ```java public void mutateDestroy() public void mutateDestroy(java.lang.Boolean _strict) ``` Destroy the edge. Remove all references and remove from store. ###### `_strict`^Optional - *Type:* java.lang.Boolean --- ##### `setAttribute` ```java public void setAttribute(java.lang.String key, java.lang.Object value) ``` Set attribute. This will overwrite existing attribute. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.Object --- ##### `setTag` ```java public void setTag(java.lang.String key, java.lang.String value) ``` Set tag. Will overwrite existing tag. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.String --- ##### `isEquivalent` ```java public java.lang.Boolean isEquivalent(Edge edge) ``` Indicates if this edge is equivalent to another edge. Edges are considered equivalent if they share same type, source, and target. ###### `edge`^Required - *Type:* Edge --- ##### `mutateConsume` ```java public void mutateConsume(Edge edge) ``` Merge an equivalent edge's data into this edge and destroy the other edge. Used during filtering operations to consolidate equivalent edges. ###### `edge`^Required - *Type:* Edge The edge to consume. --- ##### `mutateDirection` ```java public void mutateDirection(EdgeDirectionEnum direction) ``` Change the edge **direction**. ###### `direction`^Required - *Type:* EdgeDirectionEnum --- ##### `mutateSource` ```java public void mutateSource(Node node) ``` Change the edge **source**. ###### `node`^Required - *Type:* Node --- ##### `mutateTarget` ```java public void mutateTarget(Node node) ``` Change the edge **target**. ###### `node`^Required - *Type:* Node --- ##### `toString` ```java public java.lang.String toString() ``` Get string representation of this edge. ##### `resolveChain` ```java public java.util.List resolveChain() ``` Resolve reference chain. ##### `resolveTargets` ```java public java.util.List resolveTargets() ``` Resolve targets by following potential edge chain. > [{@link EdgeChain }]({@link EdgeChain }) #### Static Functions | **Name** | **Description** | | --- | --- | | findAllInChain | Find all matching edges based on predicate within an EdgeChain. | | findInChain | Find first edge matching predicate within an EdgeChain. | | isRef | Indicates if edge is a **Ref** based {@link Reference} edge. | | isReference | Indicates if edge is a {@link Reference}. | | isImport | Indicates if edge is **Fn::ImportValue** based {@link Reference}. | --- ##### `findAllInChain` ```java import software.aws.awsprototypingsdk.cdkgraph.ImportReference; ImportReference.findAllInChain(java.util.List chain, IEdgePredicate predicate) ``` Find all matching edges based on predicate within an EdgeChain. ###### `chain`^Required - *Type:* java.util.List --- ###### `predicate`^Required - *Type:* IEdgePredicate --- ##### `findInChain` ```java import software.aws.awsprototypingsdk.cdkgraph.ImportReference; ImportReference.findInChain(java.util.List chain, IEdgePredicate predicate) ``` Find first edge matching predicate within an EdgeChain. ###### `chain`^Required - *Type:* java.util.List --- ###### `predicate`^Required - *Type:* IEdgePredicate --- ##### `isRef` ```java import software.aws.awsprototypingsdk.cdkgraph.ImportReference; ImportReference.isRef(Edge edge) ``` Indicates if edge is a **Ref** based {@link Reference} edge. ###### `edge`^Required - *Type:* Edge --- ##### `isReference` ```java import software.aws.awsprototypingsdk.cdkgraph.ImportReference; ImportReference.isReference(Edge edge) ``` Indicates if edge is a {@link Reference}. ###### `edge`^Required - *Type:* Edge --- ##### `isImport` ```java import software.aws.awsprototypingsdk.cdkgraph.ImportReference; ImportReference.isImport(Edge edge) ``` Indicates if edge is **Fn::ImportValue** based {@link Reference}. ###### `edge`^Required - *Type:* Edge --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | attributes | java.util.MapPlainObject OR java.util.ListPlainObject>> | Get *readonly* record of all attributes. | | flags | java.util.List<FlagEnum> | Get *readonly* list of all flags. | | isDestroyed | java.lang.Boolean | Indicates if the entity has been destroyed (eg: removed from store). | | isMutated | java.lang.Boolean | Indicates if the entity has had destructive mutations applied. | | metadata | java.util.List | Get *readonly* list of all metadata entries. | | store | Store | Reference to the store. | | tags | java.util.Map | Get *readonly* record of all tags. | | uuid | java.lang.String | Universally unique identifier. | | allowDestructiveMutations | java.lang.Boolean | Indicates if edge allows destructive mutations. | | direction | EdgeDirectionEnum | Indicates the direction in which the edge is directed. | | edgeType | EdgeTypeEnum | Type of edge. | | isClosed | java.lang.Boolean | Indicates if the Edge's **source** and **target** are the same, or were the same when it was created (prior to mutations). | | isCrossStack | java.lang.Boolean | Indicates if **source** and **target** nodes reside in different *root* stacks. | | isExtraneous | java.lang.Boolean | Indicates if edge is extraneous which is determined by explicitly having *EXTRANEOUS* flag added and/or being a closed loop (source===target). | | source | Node | Edge **source** is the node that defines the edge (tail). | | target | Node | Edge **target** is the node being referenced by the **source** (head). | | referenceType | ReferenceTypeEnum | Get type of reference. | --- ##### `attributes`^Required ```java public java.lang.Object getAttributes(); ``` - *Type:* java.util.MapPlainObject OR java.util.ListPlainObject>> Get *readonly* record of all attributes. --- ##### `flags`^Required ```java public java.util.List getFlags(); ``` - *Type:* java.util.List<FlagEnum> Get *readonly* list of all flags. --- ##### `isDestroyed`^Required ```java public java.lang.Boolean getIsDestroyed(); ``` - *Type:* java.lang.Boolean Indicates if the entity has been destroyed (eg: removed from store). --- ##### `isMutated`^Required ```java public java.lang.Boolean getIsMutated(); ``` - *Type:* java.lang.Boolean Indicates if the entity has had destructive mutations applied. --- ##### `metadata`^Required ```java public java.util.List getMetadata(); ``` - *Type:* java.util.List Get *readonly* list of all metadata entries. --- ##### `store`^Required ```java public Store getStore(); ``` - *Type:* Store Reference to the store. --- ##### `tags`^Required ```java public java.util.Map getTags(); ``` - *Type:* java.util.Map Get *readonly* record of all tags. --- ##### `uuid`^Required ```java public java.lang.String getUuid(); ``` - *Type:* java.lang.String Universally unique identifier. --- ##### `allowDestructiveMutations`^Required ```java public java.lang.Boolean getAllowDestructiveMutations(); ``` - *Type:* java.lang.Boolean Indicates if edge allows destructive mutations. --- ##### `direction`^Required ```java public EdgeDirectionEnum getDirection(); ``` - *Type:* EdgeDirectionEnum Indicates the direction in which the edge is directed. --- ##### `edgeType`^Required ```java public EdgeTypeEnum getEdgeType(); ``` - *Type:* EdgeTypeEnum Type of edge. --- ##### `isClosed`^Required ```java public java.lang.Boolean getIsClosed(); ``` - *Type:* java.lang.Boolean Indicates if the Edge's **source** and **target** are the same, or were the same when it was created (prior to mutations). To check whether it was originally closed, use `hasFlag(FlagEnum.CLOSED_EDGE)` instead. --- ##### `isCrossStack`^Required ```java public java.lang.Boolean getIsCrossStack(); ``` - *Type:* java.lang.Boolean Indicates if **source** and **target** nodes reside in different *root* stacks. --- ##### `isExtraneous`^Required ```java public java.lang.Boolean getIsExtraneous(); ``` - *Type:* java.lang.Boolean Indicates if edge is extraneous which is determined by explicitly having *EXTRANEOUS* flag added and/or being a closed loop (source===target). --- ##### `source`^Required ```java public Node getSource(); ``` - *Type:* Node Edge **source** is the node that defines the edge (tail). --- ##### `target`^Required ```java public Node getTarget(); ``` - *Type:* Node Edge **target** is the node being referenced by the **source** (head). --- ##### `referenceType`^Required ```java public ReferenceTypeEnum getReferenceType(); ``` - *Type:* ReferenceTypeEnum Get type of reference. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ATT_TYPE | java.lang.String | Attribute defining the type of reference. | | PREFIX | java.lang.String | Edge prefix to denote **Fn::ImportValue** type reference edge. | --- ##### `ATT_TYPE`^Required ```java public java.lang.String getAttType(); ``` - *Type:* java.lang.String Attribute defining the type of reference. --- ##### `PREFIX`^Required ```java public java.lang.String getPrefix(); ``` - *Type:* java.lang.String Edge prefix to denote **Fn::ImportValue** type reference edge. --- ### NestedStackNode NestedStackNode defines a cdk NestedStack. #### Initializers ```java import software.aws.awsprototypingsdk.cdkgraph.NestedStackNode; new NestedStackNode(INestedStackNodeProps props); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | INestedStackNodeProps | *No description.* | --- ##### `props`^Required - *Type:* INestedStackNodeProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAttribute | Add attribute. | | addFlag | Add flag. | | addMetadata | Add metadata entry. | | addTag | Add tag. | | applyData | Applies data (attributes, metadata, tags, flag) to entity. | | findMetadata | Retrieves all metadata entries of a given type. | | getAttribute | Get attribute by key. | | getTag | Get tag by key. | | hasAttribute | Indicates if entity has a given attribute defined, and optionally with a specific value. | | hasFlag | Indicates if entity has a given flag. | | hasMetadata | Indicates if entity has matching metadata entry. | | hasTag | Indicates if entity has tag, optionally verifying tag value. | | mutateDestroy | Destroys this node by removing all references and removing this node from the store. | | setAttribute | Set attribute. | | setTag | Set tag. | | addChild | Add *child* node. | | addLink | Add *link* to another node. | | addReverseLink | Add *link* from another node. | | doesDependOn | Indicates if *this node* depends on *another node*. | | doesReference | Indicates if *this node* references *another node*. | | find | Recursively find the nearest sub-node matching predicate. | | findAll | Return this construct and all of its sub-nodes in the given order. | | findAllLinks | Return all direct links of this node and that of all sub-nodes. | | findAncestor | Find nearest *ancestor* of *this node* matching given predicate. | | findChild | Find child with given *id*. | | findLink | Find link of this node based on predicate. | | findLinks | Find all links of this node based on predicate. | | getCfnProp | Get specific CloudFormation property. | | getChild | Get *child* node with given *id*. | | getLinkChains | Resolve all link chains. | | getNearestAncestor | Gets the nearest **common** *ancestor* shared between *this node* and another *node*. | | isAncestor | Indicates if a specific *node* is an *ancestor* of *this node*. | | isChild | Indicates if specific *node* is a *child* of *this node*. | | mutateCollapse | Collapses all sub-nodes of *this node* into *this node*. | | mutateCollapseTo | Collapses *this node* into *an ancestor*. | | mutateCollapseToParent | Collapses *this node* into *it's parent node*. | | mutateHoist | Hoist *this node* to an *ancestor* by removing it from its current parent node and in turn moving it to the ancestor. | | mutateMove | Move this node into a new parent node. | | mutateRemoveChild | Remove a *child* node from *this node*. | | mutateRemoveLink | Remove a *link* from *this node*. | | mutateRemoveReverseLink | Remove a *link* to *this node*. | | mutateUncluster | Hoist all children to parent and collapse node to parent. | | toString | Get string representation of this node. | | addOutput | Associate {@link OutputNode} with this stack. | | addParameter | Associate {@link ParameterNode} with this stack. | | findOutput | Find {@link OutputNode} with *logicalId* defined by this stack. | | findParameter | Find {@link ParameterNode} with *parameterId* defined by this stack. | | mutateRemoveOutput | Disassociate {@link OutputNode} from this stack. | | mutateRemoveParameter | Disassociate {@link ParameterNode} from this stack. | --- ##### `addAttribute` ```java public void addAttribute(java.lang.String key, java.lang.Object value) ``` Add attribute. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.Object --- ##### `addFlag` ```java public void addFlag(FlagEnum flag) ``` Add flag. ###### `flag`^Required - *Type:* FlagEnum --- ##### `addMetadata` ```java public void addMetadata(java.lang.String metadataType, java.lang.Object data) ``` Add metadata entry. ###### `metadataType`^Required - *Type:* java.lang.String --- ###### `data`^Required - *Type:* java.lang.Object --- ##### `addTag` ```java public void addTag(java.lang.String key, java.lang.String value) ``` Add tag. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.String --- ##### `applyData` ```java public void applyData(IBaseEntityDataProps data) public void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite) public void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite, java.lang.Boolean applyFlags) ``` Applies data (attributes, metadata, tags, flag) to entity. Generally used only for mutations such as collapse and consume to retain data. ###### `data`^Required - *Type:* IBaseEntityDataProps The data to apply. --- ###### `overwrite`^Optional - *Type:* java.lang.Boolean --- ###### `applyFlags`^Optional - *Type:* java.lang.Boolean Indicates if data is overwritten - Indicates if flags should be applied. --- ##### `findMetadata` ```java public java.util.List findMetadata(java.lang.String metadataType) ``` Retrieves all metadata entries of a given type. ###### `metadataType`^Required - *Type:* java.lang.String --- ##### `getAttribute` ```java public java.lang.Object getAttribute(java.lang.String key) ``` Get attribute by key. ###### `key`^Required - *Type:* java.lang.String --- ##### `getTag` ```java public java.lang.String getTag(java.lang.String key) ``` Get tag by key. ###### `key`^Required - *Type:* java.lang.String --- ##### `hasAttribute` ```java public java.lang.Boolean hasAttribute(java.lang.String key) public java.lang.Boolean hasAttribute(java.lang.String key, java.lang.Object value) ``` Indicates if entity has a given attribute defined, and optionally with a specific value. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Optional - *Type:* java.lang.Object --- ##### `hasFlag` ```java public java.lang.Boolean hasFlag(FlagEnum flag) ``` Indicates if entity has a given flag. ###### `flag`^Required - *Type:* FlagEnum --- ##### `hasMetadata` ```java public java.lang.Boolean hasMetadata(java.lang.String metadataType, java.lang.Object data) ``` Indicates if entity has matching metadata entry. ###### `metadataType`^Required - *Type:* java.lang.String --- ###### `data`^Required - *Type:* java.lang.Object --- ##### `hasTag` ```java public java.lang.Boolean hasTag(java.lang.String key) public java.lang.Boolean hasTag(java.lang.String key, java.lang.String value) ``` Indicates if entity has tag, optionally verifying tag value. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Optional - *Type:* java.lang.String --- ##### `mutateDestroy` ```java public void mutateDestroy() public void mutateDestroy(java.lang.Boolean strict) ``` Destroys this node by removing all references and removing this node from the store. ###### `strict`^Optional - *Type:* java.lang.Boolean --- ##### `setAttribute` ```java public void setAttribute(java.lang.String key, java.lang.Object value) ``` Set attribute. This will overwrite existing attribute. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.Object --- ##### `setTag` ```java public void setTag(java.lang.String key, java.lang.String value) ``` Set tag. Will overwrite existing tag. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.String --- ##### `addChild` ```java public void addChild(Node node) ``` Add *child* node. ###### `node`^Required - *Type:* Node --- ##### `addLink` ```java public void addLink(Edge edge) ``` Add *link* to another node. ###### `edge`^Required - *Type:* Edge --- ##### `addReverseLink` ```java public void addReverseLink(Edge edge) ``` Add *link* from another node. ###### `edge`^Required - *Type:* Edge --- ##### `doesDependOn` ```java public java.lang.Boolean doesDependOn(Node node) ``` Indicates if *this node* depends on *another node*. ###### `node`^Required - *Type:* Node --- ##### `doesReference` ```java public java.lang.Boolean doesReference(Node node) ``` Indicates if *this node* references *another node*. ###### `node`^Required - *Type:* Node --- ##### `find` ```java public Node find(INodePredicate predicate) ``` Recursively find the nearest sub-node matching predicate. ###### `predicate`^Required - *Type:* INodePredicate --- ##### `findAll` ```java public java.util.List findAll() public java.util.List findAll(IFindNodeOptions options) ``` Return this construct and all of its sub-nodes in the given order. Optionally filter nodes based on predicate. ###### `options`^Optional - *Type:* IFindNodeOptions --- ##### `findAllLinks` ```java public java.util.List findAllLinks() public java.util.List findAllLinks(IFindEdgeOptions options) ``` Return all direct links of this node and that of all sub-nodes. Optionally filter links based on predicate. ###### `options`^Optional - *Type:* IFindEdgeOptions --- ##### `findAncestor` ```java public Node findAncestor(INodePredicate predicate) public Node findAncestor(INodePredicate predicate, java.lang.Number max) ``` Find nearest *ancestor* of *this node* matching given predicate. ###### `predicate`^Required - *Type:* INodePredicate Predicate to match ancestor. --- ###### `max`^Optional - *Type:* java.lang.Number --- ##### `findChild` ```java public Node findChild(java.lang.String id) ``` Find child with given *id*. Similar to `find` but does not throw error if no child found. ###### `id`^Required - *Type:* java.lang.String --- ##### `findLink` ```java public Edge findLink(IEdgePredicate predicate) public Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse) public Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow) public Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow, java.lang.Boolean direct) ``` Find link of this node based on predicate. By default this will follow link chains to evaluate the predicate against and return the matching direct link of this node. ###### `predicate`^Required - *Type:* IEdgePredicate Edge predicate function to match edge. --- ###### `reverse`^Optional - *Type:* java.lang.Boolean Indicates if links are search in reverse order. --- ###### `follow`^Optional - *Type:* java.lang.Boolean Indicates if link chain is followed. --- ###### `direct`^Optional - *Type:* java.lang.Boolean Indicates that only *direct* links should be searched. --- ##### `findLinks` ```java public java.util.List findLinks(IEdgePredicate predicate) public java.util.List findLinks(IEdgePredicate predicate, java.lang.Boolean reverse) public java.util.List findLinks(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow) public java.util.List findLinks(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow, java.lang.Boolean direct) ``` Find all links of this node based on predicate. By default this will follow link chains to evaluate the predicate against and return the matching direct links of this node. ###### `predicate`^Required - *Type:* IEdgePredicate Edge predicate function to match edge. --- ###### `reverse`^Optional - *Type:* java.lang.Boolean Indicates if links are search in reverse order. --- ###### `follow`^Optional - *Type:* java.lang.Boolean Indicates if link chain is followed. --- ###### `direct`^Optional - *Type:* java.lang.Boolean Indicates that only *direct* links should be searched. --- ##### `getCfnProp` ```java public java.lang.String OR java.lang.Number OR java.lang.Boolean OR PlainObject OR java.util.List getCfnProp(java.lang.String key) ``` Get specific CloudFormation property. ###### `key`^Required - *Type:* java.lang.String --- ##### `getChild` ```java public Node getChild(java.lang.String id) ``` Get *child* node with given *id*. ###### `id`^Required - *Type:* java.lang.String --- ##### `getLinkChains` ```java public java.util.List> getLinkChains() public java.util.List> getLinkChains(java.lang.Boolean reverse) ``` Resolve all link chains. > [{@link EdgeChain }]({@link EdgeChain }) ###### `reverse`^Optional - *Type:* java.lang.Boolean --- ##### `getNearestAncestor` ```java public Node getNearestAncestor(Node node) ``` Gets the nearest **common** *ancestor* shared between *this node* and another *node*. ###### `node`^Required - *Type:* Node --- ##### `isAncestor` ```java public java.lang.Boolean isAncestor(Node ancestor) ``` Indicates if a specific *node* is an *ancestor* of *this node*. ###### `ancestor`^Required - *Type:* Node --- ##### `isChild` ```java public java.lang.Boolean isChild(Node node) ``` Indicates if specific *node* is a *child* of *this node*. ###### `node`^Required - *Type:* Node --- ##### `mutateCollapse` ```java public void mutateCollapse() ``` Collapses all sub-nodes of *this node* into *this node*. ##### `mutateCollapseTo` ```java public Node mutateCollapseTo(Node ancestor) ``` Collapses *this node* into *an ancestor*. ###### `ancestor`^Required - *Type:* Node --- ##### `mutateCollapseToParent` ```java public Node mutateCollapseToParent() ``` Collapses *this node* into *it's parent node*. ##### `mutateHoist` ```java public void mutateHoist(Node newParent) ``` Hoist *this node* to an *ancestor* by removing it from its current parent node and in turn moving it to the ancestor. ###### `newParent`^Required - *Type:* Node --- ##### `mutateMove` ```java public void mutateMove(Node newParent) ``` Move this node into a new parent node. ###### `newParent`^Required - *Type:* Node The parent to move this node to. --- ##### `mutateRemoveChild` ```java public java.lang.Boolean mutateRemoveChild(Node node) ``` Remove a *child* node from *this node*. ###### `node`^Required - *Type:* Node --- ##### `mutateRemoveLink` ```java public java.lang.Boolean mutateRemoveLink(Edge link) ``` Remove a *link* from *this node*. ###### `link`^Required - *Type:* Edge --- ##### `mutateRemoveReverseLink` ```java public java.lang.Boolean mutateRemoveReverseLink(Edge link) ``` Remove a *link* to *this node*. ###### `link`^Required - *Type:* Edge --- ##### `mutateUncluster` ```java public void mutateUncluster() ``` Hoist all children to parent and collapse node to parent. ##### `toString` ```java public java.lang.String toString() ``` Get string representation of this node. ##### `addOutput` ```java public void addOutput(OutputNode node) ``` Associate {@link OutputNode} with this stack. ###### `node`^Required - *Type:* OutputNode --- ##### `addParameter` ```java public void addParameter(ParameterNode node) ``` Associate {@link ParameterNode} with this stack. ###### `node`^Required - *Type:* ParameterNode --- ##### `findOutput` ```java public OutputNode findOutput(java.lang.String logicalId) ``` Find {@link OutputNode} with *logicalId* defined by this stack. ###### `logicalId`^Required - *Type:* java.lang.String --- ##### `findParameter` ```java public ParameterNode findParameter(java.lang.String parameterId) ``` Find {@link ParameterNode} with *parameterId* defined by this stack. ###### `parameterId`^Required - *Type:* java.lang.String --- ##### `mutateRemoveOutput` ```java public java.lang.Boolean mutateRemoveOutput(OutputNode node) ``` Disassociate {@link OutputNode} from this stack. ###### `node`^Required - *Type:* OutputNode --- ##### `mutateRemoveParameter` ```java public java.lang.Boolean mutateRemoveParameter(ParameterNode node) ``` Disassociate {@link ParameterNode} from this stack. ###### `node`^Required - *Type:* ParameterNode --- #### Static Functions | **Name** | **Description** | | --- | --- | | isStackNode | Indicates if node is a {@link StackNode}. | | of | Gets the {@link StackNode} containing a given resource. | | isNestedStackNode | Indicates if node is a {@link NestedStackNode}. | --- ##### `isStackNode` ```java import software.aws.awsprototypingsdk.cdkgraph.NestedStackNode; NestedStackNode.isStackNode(Node node) ``` Indicates if node is a {@link StackNode}. ###### `node`^Required - *Type:* Node --- ##### `of` ```java import software.aws.awsprototypingsdk.cdkgraph.NestedStackNode; NestedStackNode.of(Node node) ``` Gets the {@link StackNode} containing a given resource. ###### `node`^Required - *Type:* Node --- ##### `isNestedStackNode` ```java import software.aws.awsprototypingsdk.cdkgraph.NestedStackNode; NestedStackNode.isNestedStackNode(Node node) ``` Indicates if node is a {@link NestedStackNode}. ###### `node`^Required - *Type:* Node --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | attributes | java.util.MapPlainObject OR java.util.ListPlainObject>> | Get *readonly* record of all attributes. | | flags | java.util.List<FlagEnum> | Get *readonly* list of all flags. | | isDestroyed | java.lang.Boolean | Indicates if the entity has been destroyed (eg: removed from store). | | isMutated | java.lang.Boolean | Indicates if the entity has had destructive mutations applied. | | metadata | java.util.List | Get *readonly* list of all metadata entries. | | store | Store | Reference to the store. | | tags | java.util.Map | Get *readonly* record of all tags. | | uuid | java.lang.String | Universally unique identifier. | | allowDestructiveMutations | java.lang.Boolean | Indicates if this node allows destructive mutations. | | children | java.util.List<Node> | Get all direct child nodes. | | dependedOnBy | java.util.List<Node> | Get list of **Nodes** that *depend on this node*. | | dependencies | java.util.List<Node> | Get list of **Nodes** that *this node depends on*. | | dependencyLinks | java.util.List<Dependency> | Gets list of {@link Dependency} links (edges) where this node is the **source**. | | depth | java.lang.Number | Indicates the depth of the node relative to root (0). | | id | java.lang.String | Node id, which is only unique within parent scope. | | isAsset | java.lang.Boolean | Indicates if this node is considered a {@link FlagEnum.ASSET}. | | isCfnFqn | java.lang.Boolean | Indicates if node ConstructInfoFqn denotes a `aws-cdk-lib.*.Cfn*` construct. | | isCluster | java.lang.Boolean | Indicates if this node is considered a {@link FlagEnum.CLUSTER}. | | isCustomResource | java.lang.Boolean | Indicates if node is a *Custom Resource*. | | isExtraneous | java.lang.Boolean | Indicates if this node is considered a {@link FlagEnum.EXTRANEOUS} node or determined to be extraneous: - Clusters that contain no children. | | isGraphContainer | java.lang.Boolean | Indicates if this node is considered a {@link FlagEnum.GRAPH_CONTAINER}. | | isLeaf | java.lang.Boolean | Indicates if this node is a *leaf* node, which means it does not have children. | | isTopLevel | java.lang.Boolean | Indicates if node is direct child of the graph root node. | | links | java.util.List<Edge> | Gets all links (edges) in which this node is the **source**. | | nodeType | NodeTypeEnum | Type of node. | | path | java.lang.String | Path of the node. | | referencedBy | java.util.List<Node> | Get list of **Nodes** that *reference this node*. | | referenceLinks | java.util.List<Reference> | Gets list of {@link Reference} links (edges) where this node is the **source**. | | references | java.util.List<Node> | Get list of **Nodes** that *this node references*. | | reverseDependencyLinks | java.util.List<Dependency> | Gets list of {@link Dependency} links (edges) where this node is the **target**. | | reverseLinks | java.util.List<Edge> | Gets all links (edges) in which this node is the **target**. | | reverseReferenceLinks | java.util.List<Reference> | Gets list of {@link Reference} links (edges) where this node is the **target**. | | scopes | java.util.List<Node> | Gets descending ordered list of ancestors from the root. | | siblings | java.util.List<Node> | Get list of *siblings* of this node. | | cfnProps | PlainObject | Gets CloudFormation properties for this node. | | cfnType | java.lang.String | Get the CloudFormation resource type for this node. | | constructInfo | ConstructInfo | Synthesized construct information defining jii resolution data. | | constructInfoFqn | java.lang.String | Synthesized construct information defining jii resolution data. | | logicalId | java.lang.String | Logical id of the node, which is only unique within containing stack. | | parent | Node | Parent node. | | rootStack | StackNode | Get **root** stack. | | stack | StackNode | Stack the node is contained in. | | exports | java.util.List<OutputNode> | Get all **exported** {@link OutputNode}s defined by this stack. | | outputs | java.util.List<OutputNode> | Get all {@link OutputNode}s defined by this stack. | | parameters | java.util.List<ParameterNode> | Get all {@link ParameterNode}s defined by this stack. | | stage | StageNode | Get {@link StageNode} containing this stack. | | parentStack | StackNode | Get parent stack of this nested stack. | --- ##### `attributes`^Required ```java public java.lang.Object getAttributes(); ``` - *Type:* java.util.MapPlainObject OR java.util.ListPlainObject>> Get *readonly* record of all attributes. --- ##### `flags`^Required ```java public java.util.List getFlags(); ``` - *Type:* java.util.List<FlagEnum> Get *readonly* list of all flags. --- ##### `isDestroyed`^Required ```java public java.lang.Boolean getIsDestroyed(); ``` - *Type:* java.lang.Boolean Indicates if the entity has been destroyed (eg: removed from store). --- ##### `isMutated`^Required ```java public java.lang.Boolean getIsMutated(); ``` - *Type:* java.lang.Boolean Indicates if the entity has had destructive mutations applied. --- ##### `metadata`^Required ```java public java.util.List getMetadata(); ``` - *Type:* java.util.List Get *readonly* list of all metadata entries. --- ##### `store`^Required ```java public Store getStore(); ``` - *Type:* Store Reference to the store. --- ##### `tags`^Required ```java public java.util.Map getTags(); ``` - *Type:* java.util.Map Get *readonly* record of all tags. --- ##### `uuid`^Required ```java public java.lang.String getUuid(); ``` - *Type:* java.lang.String Universally unique identifier. --- ##### `allowDestructiveMutations`^Required ```java public java.lang.Boolean getAllowDestructiveMutations(); ``` - *Type:* java.lang.Boolean Indicates if this node allows destructive mutations. > [{@link Store.allowDestructiveMutations }]({@link Store.allowDestructiveMutations }) --- ##### `children`^Required ```java public java.util.List getChildren(); ``` - *Type:* java.util.List<Node> Get all direct child nodes. --- ##### `dependedOnBy`^Required ```java public java.util.List getDependedOnBy(); ``` - *Type:* java.util.List<Node> Get list of **Nodes** that *depend on this node*. > [{@link Node.reverseDependencyLinks }]({@link Node.reverseDependencyLinks }) --- ##### `dependencies`^Required ```java public java.util.List getDependencies(); ``` - *Type:* java.util.List<Node> Get list of **Nodes** that *this node depends on*. > [{@link Node.dependencyLinks }]({@link Node.dependencyLinks }) --- ##### `dependencyLinks`^Required ```java public java.util.List getDependencyLinks(); ``` - *Type:* java.util.List<Dependency> Gets list of {@link Dependency} links (edges) where this node is the **source**. --- ##### `depth`^Required ```java public java.lang.Number getDepth(); ``` - *Type:* java.lang.Number Indicates the depth of the node relative to root (0). --- ##### `id`^Required ```java public java.lang.String getId(); ``` - *Type:* java.lang.String Node id, which is only unique within parent scope. --- ##### `isAsset`^Required ```java public java.lang.Boolean getIsAsset(); ``` - *Type:* java.lang.Boolean Indicates if this node is considered a {@link FlagEnum.ASSET}. --- ##### `isCfnFqn`^Required ```java public java.lang.Boolean getIsCfnFqn(); ``` - *Type:* java.lang.Boolean Indicates if node ConstructInfoFqn denotes a `aws-cdk-lib.*.Cfn*` construct. > [{@link FlagEnum.CFN_FQN }]({@link FlagEnum.CFN_FQN }) --- ##### `isCluster`^Required ```java public java.lang.Boolean getIsCluster(); ``` - *Type:* java.lang.Boolean Indicates if this node is considered a {@link FlagEnum.CLUSTER}. --- ##### `isCustomResource`^Required ```java public java.lang.Boolean getIsCustomResource(); ``` - *Type:* java.lang.Boolean Indicates if node is a *Custom Resource*. --- ##### `isExtraneous`^Required ```java public java.lang.Boolean getIsExtraneous(); ``` - *Type:* java.lang.Boolean Indicates if this node is considered a {@link FlagEnum.EXTRANEOUS} node or determined to be extraneous: - Clusters that contain no children. --- ##### `isGraphContainer`^Required ```java public java.lang.Boolean getIsGraphContainer(); ``` - *Type:* java.lang.Boolean Indicates if this node is considered a {@link FlagEnum.GRAPH_CONTAINER}. --- ##### `isLeaf`^Required ```java public java.lang.Boolean getIsLeaf(); ``` - *Type:* java.lang.Boolean Indicates if this node is a *leaf* node, which means it does not have children. --- ##### `isTopLevel`^Required ```java public java.lang.Boolean getIsTopLevel(); ``` - *Type:* java.lang.Boolean Indicates if node is direct child of the graph root node. --- ##### `links`^Required ```java public java.util.List getLinks(); ``` - *Type:* java.util.List<Edge> Gets all links (edges) in which this node is the **source**. --- ##### `nodeType`^Required ```java public NodeTypeEnum getNodeType(); ``` - *Type:* NodeTypeEnum Type of node. --- ##### `path`^Required ```java public java.lang.String getPath(); ``` - *Type:* java.lang.String Path of the node. --- ##### `referencedBy`^Required ```java public java.util.List getReferencedBy(); ``` - *Type:* java.util.List<Node> Get list of **Nodes** that *reference this node*. > [{@link Node.reverseReferenceLinks }]({@link Node.reverseReferenceLinks }) --- ##### `referenceLinks`^Required ```java public java.util.List getReferenceLinks(); ``` - *Type:* java.util.List<Reference> Gets list of {@link Reference} links (edges) where this node is the **source**. --- ##### `references`^Required ```java public java.util.List getReferences(); ``` - *Type:* java.util.List<Node> Get list of **Nodes** that *this node references*. > [{@link Node.referenceLinks }]({@link Node.referenceLinks }) --- ##### `reverseDependencyLinks`^Required ```java public java.util.List getReverseDependencyLinks(); ``` - *Type:* java.util.List<Dependency> Gets list of {@link Dependency} links (edges) where this node is the **target**. --- ##### `reverseLinks`^Required ```java public java.util.List getReverseLinks(); ``` - *Type:* java.util.List<Edge> Gets all links (edges) in which this node is the **target**. --- ##### `reverseReferenceLinks`^Required ```java public java.util.List getReverseReferenceLinks(); ``` - *Type:* java.util.List<Reference> Gets list of {@link Reference} links (edges) where this node is the **target**. --- ##### `scopes`^Required ```java public java.util.List getScopes(); ``` - *Type:* java.util.List<Node> Gets descending ordered list of ancestors from the root. --- ##### `siblings`^Required ```java public java.util.List getSiblings(); ``` - *Type:* java.util.List<Node> Get list of *siblings* of this node. --- ##### `cfnProps`^Optional ```java public PlainObject getCfnProps(); ``` - *Type:* PlainObject Gets CloudFormation properties for this node. --- ##### `cfnType`^Optional ```java public java.lang.String getCfnType(); ``` - *Type:* java.lang.String Get the CloudFormation resource type for this node. --- ##### `constructInfo`^Optional ```java public ConstructInfo getConstructInfo(); ``` - *Type:* ConstructInfo Synthesized construct information defining jii resolution data. --- ##### `constructInfoFqn`^Optional ```java public java.lang.String getConstructInfoFqn(); ``` - *Type:* java.lang.String Synthesized construct information defining jii resolution data. --- ##### `logicalId`^Optional ```java public java.lang.String getLogicalId(); ``` - *Type:* java.lang.String Logical id of the node, which is only unique within containing stack. --- ##### `parent`^Optional ```java public Node getParent(); ``` - *Type:* Node Parent node. Only the root node should not have parent. --- ##### `rootStack`^Optional ```java public StackNode getRootStack(); ``` - *Type:* StackNode Get **root** stack. --- ##### `stack`^Optional ```java public StackNode getStack(); ``` - *Type:* StackNode Stack the node is contained in. --- ##### `exports`^Required ```java public java.util.List getExports(); ``` - *Type:* java.util.List<OutputNode> Get all **exported** {@link OutputNode}s defined by this stack. --- ##### `outputs`^Required ```java public java.util.List getOutputs(); ``` - *Type:* java.util.List<OutputNode> Get all {@link OutputNode}s defined by this stack. --- ##### `parameters`^Required ```java public java.util.List getParameters(); ``` - *Type:* java.util.List<ParameterNode> Get all {@link ParameterNode}s defined by this stack. --- ##### `stage`^Optional ```java public StageNode getStage(); ``` - *Type:* StageNode Get {@link StageNode} containing this stack. --- ##### `parentStack`^Optional ```java public StackNode getParentStack(); ``` - *Type:* StackNode Get parent stack of this nested stack. --- ### Node - *Implements:* ISerializableNode Node class is the base definition of **node** entities in the graph, as in standard [graph theory](https://en.wikipedia.org/wiki/Graph_theory). #### Initializers ```java import software.aws.awsprototypingsdk.cdkgraph.Node; new Node(INodeProps props); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | INodeProps | *No description.* | --- ##### `props`^Required - *Type:* INodeProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAttribute | Add attribute. | | addFlag | Add flag. | | addMetadata | Add metadata entry. | | addTag | Add tag. | | applyData | Applies data (attributes, metadata, tags, flag) to entity. | | findMetadata | Retrieves all metadata entries of a given type. | | getAttribute | Get attribute by key. | | getTag | Get tag by key. | | hasAttribute | Indicates if entity has a given attribute defined, and optionally with a specific value. | | hasFlag | Indicates if entity has a given flag. | | hasMetadata | Indicates if entity has matching metadata entry. | | hasTag | Indicates if entity has tag, optionally verifying tag value. | | mutateDestroy | Destroys this node by removing all references and removing this node from the store. | | setAttribute | Set attribute. | | setTag | Set tag. | | addChild | Add *child* node. | | addLink | Add *link* to another node. | | addReverseLink | Add *link* from another node. | | doesDependOn | Indicates if *this node* depends on *another node*. | | doesReference | Indicates if *this node* references *another node*. | | find | Recursively find the nearest sub-node matching predicate. | | findAll | Return this construct and all of its sub-nodes in the given order. | | findAllLinks | Return all direct links of this node and that of all sub-nodes. | | findAncestor | Find nearest *ancestor* of *this node* matching given predicate. | | findChild | Find child with given *id*. | | findLink | Find link of this node based on predicate. | | findLinks | Find all links of this node based on predicate. | | getCfnProp | Get specific CloudFormation property. | | getChild | Get *child* node with given *id*. | | getLinkChains | Resolve all link chains. | | getNearestAncestor | Gets the nearest **common** *ancestor* shared between *this node* and another *node*. | | isAncestor | Indicates if a specific *node* is an *ancestor* of *this node*. | | isChild | Indicates if specific *node* is a *child* of *this node*. | | mutateCollapse | Collapses all sub-nodes of *this node* into *this node*. | | mutateCollapseTo | Collapses *this node* into *an ancestor*. | | mutateCollapseToParent | Collapses *this node* into *it's parent node*. | | mutateHoist | Hoist *this node* to an *ancestor* by removing it from its current parent node and in turn moving it to the ancestor. | | mutateMove | Move this node into a new parent node. | | mutateRemoveChild | Remove a *child* node from *this node*. | | mutateRemoveLink | Remove a *link* from *this node*. | | mutateRemoveReverseLink | Remove a *link* to *this node*. | | mutateUncluster | Hoist all children to parent and collapse node to parent. | | toString | Get string representation of this node. | --- ##### `addAttribute` ```java public void addAttribute(java.lang.String key, java.lang.Object value) ``` Add attribute. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.Object --- ##### `addFlag` ```java public void addFlag(FlagEnum flag) ``` Add flag. ###### `flag`^Required - *Type:* FlagEnum --- ##### `addMetadata` ```java public void addMetadata(java.lang.String metadataType, java.lang.Object data) ``` Add metadata entry. ###### `metadataType`^Required - *Type:* java.lang.String --- ###### `data`^Required - *Type:* java.lang.Object --- ##### `addTag` ```java public void addTag(java.lang.String key, java.lang.String value) ``` Add tag. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.String --- ##### `applyData` ```java public void applyData(IBaseEntityDataProps data) public void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite) public void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite, java.lang.Boolean applyFlags) ``` Applies data (attributes, metadata, tags, flag) to entity. Generally used only for mutations such as collapse and consume to retain data. ###### `data`^Required - *Type:* IBaseEntityDataProps The data to apply. --- ###### `overwrite`^Optional - *Type:* java.lang.Boolean --- ###### `applyFlags`^Optional - *Type:* java.lang.Boolean Indicates if data is overwritten - Indicates if flags should be applied. --- ##### `findMetadata` ```java public java.util.List findMetadata(java.lang.String metadataType) ``` Retrieves all metadata entries of a given type. ###### `metadataType`^Required - *Type:* java.lang.String --- ##### `getAttribute` ```java public java.lang.Object getAttribute(java.lang.String key) ``` Get attribute by key. ###### `key`^Required - *Type:* java.lang.String --- ##### `getTag` ```java public java.lang.String getTag(java.lang.String key) ``` Get tag by key. ###### `key`^Required - *Type:* java.lang.String --- ##### `hasAttribute` ```java public java.lang.Boolean hasAttribute(java.lang.String key) public java.lang.Boolean hasAttribute(java.lang.String key, java.lang.Object value) ``` Indicates if entity has a given attribute defined, and optionally with a specific value. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Optional - *Type:* java.lang.Object --- ##### `hasFlag` ```java public java.lang.Boolean hasFlag(FlagEnum flag) ``` Indicates if entity has a given flag. ###### `flag`^Required - *Type:* FlagEnum --- ##### `hasMetadata` ```java public java.lang.Boolean hasMetadata(java.lang.String metadataType, java.lang.Object data) ``` Indicates if entity has matching metadata entry. ###### `metadataType`^Required - *Type:* java.lang.String --- ###### `data`^Required - *Type:* java.lang.Object --- ##### `hasTag` ```java public java.lang.Boolean hasTag(java.lang.String key) public java.lang.Boolean hasTag(java.lang.String key, java.lang.String value) ``` Indicates if entity has tag, optionally verifying tag value. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Optional - *Type:* java.lang.String --- ##### `mutateDestroy` ```java public void mutateDestroy() public void mutateDestroy(java.lang.Boolean strict) ``` Destroys this node by removing all references and removing this node from the store. ###### `strict`^Optional - *Type:* java.lang.Boolean Indicates that this node must not have references. --- ##### `setAttribute` ```java public void setAttribute(java.lang.String key, java.lang.Object value) ``` Set attribute. This will overwrite existing attribute. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.Object --- ##### `setTag` ```java public void setTag(java.lang.String key, java.lang.String value) ``` Set tag. Will overwrite existing tag. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.String --- ##### `addChild` ```java public void addChild(Node node) ``` Add *child* node. ###### `node`^Required - *Type:* Node --- ##### `addLink` ```java public void addLink(Edge edge) ``` Add *link* to another node. ###### `edge`^Required - *Type:* Edge --- ##### `addReverseLink` ```java public void addReverseLink(Edge edge) ``` Add *link* from another node. ###### `edge`^Required - *Type:* Edge --- ##### `doesDependOn` ```java public java.lang.Boolean doesDependOn(Node node) ``` Indicates if *this node* depends on *another node*. ###### `node`^Required - *Type:* Node --- ##### `doesReference` ```java public java.lang.Boolean doesReference(Node node) ``` Indicates if *this node* references *another node*. ###### `node`^Required - *Type:* Node --- ##### `find` ```java public Node find(INodePredicate predicate) ``` Recursively find the nearest sub-node matching predicate. ###### `predicate`^Required - *Type:* INodePredicate --- ##### `findAll` ```java public java.util.List findAll() public java.util.List findAll(IFindNodeOptions options) ``` Return this construct and all of its sub-nodes in the given order. Optionally filter nodes based on predicate. ###### `options`^Optional - *Type:* IFindNodeOptions --- ##### `findAllLinks` ```java public java.util.List findAllLinks() public java.util.List findAllLinks(IFindEdgeOptions options) ``` Return all direct links of this node and that of all sub-nodes. Optionally filter links based on predicate. ###### `options`^Optional - *Type:* IFindEdgeOptions --- ##### `findAncestor` ```java public Node findAncestor(INodePredicate predicate) public Node findAncestor(INodePredicate predicate, java.lang.Number max) ``` Find nearest *ancestor* of *this node* matching given predicate. ###### `predicate`^Required - *Type:* INodePredicate Predicate to match ancestor. --- ###### `max`^Optional - *Type:* java.lang.Number --- ##### `findChild` ```java public Node findChild(java.lang.String id) ``` Find child with given *id*. Similar to `find` but does not throw error if no child found. ###### `id`^Required - *Type:* java.lang.String --- ##### `findLink` ```java public Edge findLink(IEdgePredicate predicate) public Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse) public Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow) public Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow, java.lang.Boolean direct) ``` Find link of this node based on predicate. By default this will follow link chains to evaluate the predicate against and return the matching direct link of this node. ###### `predicate`^Required - *Type:* IEdgePredicate Edge predicate function to match edge. --- ###### `reverse`^Optional - *Type:* java.lang.Boolean Indicates if links are search in reverse order. --- ###### `follow`^Optional - *Type:* java.lang.Boolean Indicates if link chain is followed. --- ###### `direct`^Optional - *Type:* java.lang.Boolean Indicates that only *direct* links should be searched. --- ##### `findLinks` ```java public java.util.List findLinks(IEdgePredicate predicate) public java.util.List findLinks(IEdgePredicate predicate, java.lang.Boolean reverse) public java.util.List findLinks(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow) public java.util.List findLinks(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow, java.lang.Boolean direct) ``` Find all links of this node based on predicate. By default this will follow link chains to evaluate the predicate against and return the matching direct links of this node. ###### `predicate`^Required - *Type:* IEdgePredicate Edge predicate function to match edge. --- ###### `reverse`^Optional - *Type:* java.lang.Boolean Indicates if links are search in reverse order. --- ###### `follow`^Optional - *Type:* java.lang.Boolean Indicates if link chain is followed. --- ###### `direct`^Optional - *Type:* java.lang.Boolean Indicates that only *direct* links should be searched. --- ##### `getCfnProp` ```java public java.lang.String OR java.lang.Number OR java.lang.Boolean OR PlainObject OR java.util.List getCfnProp(java.lang.String key) ``` Get specific CloudFormation property. ###### `key`^Required - *Type:* java.lang.String --- ##### `getChild` ```java public Node getChild(java.lang.String id) ``` Get *child* node with given *id*. ###### `id`^Required - *Type:* java.lang.String --- ##### `getLinkChains` ```java public java.util.List> getLinkChains() public java.util.List> getLinkChains(java.lang.Boolean reverse) ``` Resolve all link chains. > [{@link EdgeChain }]({@link EdgeChain }) ###### `reverse`^Optional - *Type:* java.lang.Boolean --- ##### `getNearestAncestor` ```java public Node getNearestAncestor(Node node) ``` Gets the nearest **common** *ancestor* shared between *this node* and another *node*. ###### `node`^Required - *Type:* Node --- ##### `isAncestor` ```java public java.lang.Boolean isAncestor(Node ancestor) ``` Indicates if a specific *node* is an *ancestor* of *this node*. ###### `ancestor`^Required - *Type:* Node --- ##### `isChild` ```java public java.lang.Boolean isChild(Node node) ``` Indicates if specific *node* is a *child* of *this node*. ###### `node`^Required - *Type:* Node --- ##### `mutateCollapse` ```java public void mutateCollapse() ``` Collapses all sub-nodes of *this node* into *this node*. ##### `mutateCollapseTo` ```java public Node mutateCollapseTo(Node ancestor) ``` Collapses *this node* into *an ancestor*. ###### `ancestor`^Required - *Type:* Node --- ##### `mutateCollapseToParent` ```java public Node mutateCollapseToParent() ``` Collapses *this node* into *it's parent node*. ##### `mutateHoist` ```java public void mutateHoist(Node newParent) ``` Hoist *this node* to an *ancestor* by removing it from its current parent node and in turn moving it to the ancestor. ###### `newParent`^Required - *Type:* Node --- ##### `mutateMove` ```java public void mutateMove(Node newParent) ``` Move this node into a new parent node. ###### `newParent`^Required - *Type:* Node The parent to move this node to. --- ##### `mutateRemoveChild` ```java public java.lang.Boolean mutateRemoveChild(Node node) ``` Remove a *child* node from *this node*. ###### `node`^Required - *Type:* Node --- ##### `mutateRemoveLink` ```java public java.lang.Boolean mutateRemoveLink(Edge link) ``` Remove a *link* from *this node*. ###### `link`^Required - *Type:* Edge --- ##### `mutateRemoveReverseLink` ```java public java.lang.Boolean mutateRemoveReverseLink(Edge link) ``` Remove a *link* to *this node*. ###### `link`^Required - *Type:* Edge --- ##### `mutateUncluster` ```java public void mutateUncluster() ``` Hoist all children to parent and collapse node to parent. ##### `toString` ```java public java.lang.String toString() ``` Get string representation of this node. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | attributes | java.util.MapPlainObject OR java.util.ListPlainObject>> | Get *readonly* record of all attributes. | | flags | java.util.List<FlagEnum> | Get *readonly* list of all flags. | | isDestroyed | java.lang.Boolean | Indicates if the entity has been destroyed (eg: removed from store). | | isMutated | java.lang.Boolean | Indicates if the entity has had destructive mutations applied. | | metadata | java.util.List | Get *readonly* list of all metadata entries. | | store | Store | Reference to the store. | | tags | java.util.Map | Get *readonly* record of all tags. | | uuid | java.lang.String | Universally unique identifier. | | allowDestructiveMutations | java.lang.Boolean | Indicates if this node allows destructive mutations. | | children | java.util.List<Node> | Get all direct child nodes. | | dependedOnBy | java.util.List<Node> | Get list of **Nodes** that *depend on this node*. | | dependencies | java.util.List<Node> | Get list of **Nodes** that *this node depends on*. | | dependencyLinks | java.util.List<Dependency> | Gets list of {@link Dependency} links (edges) where this node is the **source**. | | depth | java.lang.Number | Indicates the depth of the node relative to root (0). | | id | java.lang.String | Node id, which is only unique within parent scope. | | isAsset | java.lang.Boolean | Indicates if this node is considered a {@link FlagEnum.ASSET}. | | isCfnFqn | java.lang.Boolean | Indicates if node ConstructInfoFqn denotes a `aws-cdk-lib.*.Cfn*` construct. | | isCluster | java.lang.Boolean | Indicates if this node is considered a {@link FlagEnum.CLUSTER}. | | isCustomResource | java.lang.Boolean | Indicates if node is a *Custom Resource*. | | isExtraneous | java.lang.Boolean | Indicates if this node is considered a {@link FlagEnum.EXTRANEOUS} node or determined to be extraneous: - Clusters that contain no children. | | isGraphContainer | java.lang.Boolean | Indicates if this node is considered a {@link FlagEnum.GRAPH_CONTAINER}. | | isLeaf | java.lang.Boolean | Indicates if this node is a *leaf* node, which means it does not have children. | | isTopLevel | java.lang.Boolean | Indicates if node is direct child of the graph root node. | | links | java.util.List<Edge> | Gets all links (edges) in which this node is the **source**. | | nodeType | NodeTypeEnum | Type of node. | | path | java.lang.String | Path of the node. | | referencedBy | java.util.List<Node> | Get list of **Nodes** that *reference this node*. | | referenceLinks | java.util.List<Reference> | Gets list of {@link Reference} links (edges) where this node is the **source**. | | references | java.util.List<Node> | Get list of **Nodes** that *this node references*. | | reverseDependencyLinks | java.util.List<Dependency> | Gets list of {@link Dependency} links (edges) where this node is the **target**. | | reverseLinks | java.util.List<Edge> | Gets all links (edges) in which this node is the **target**. | | reverseReferenceLinks | java.util.List<Reference> | Gets list of {@link Reference} links (edges) where this node is the **target**. | | scopes | java.util.List<Node> | Gets descending ordered list of ancestors from the root. | | siblings | java.util.List<Node> | Get list of *siblings* of this node. | | cfnProps | PlainObject | Gets CloudFormation properties for this node. | | cfnType | java.lang.String | Get the CloudFormation resource type for this node. | | constructInfo | ConstructInfo | Synthesized construct information defining jii resolution data. | | constructInfoFqn | java.lang.String | Synthesized construct information defining jii resolution data. | | logicalId | java.lang.String | Logical id of the node, which is only unique within containing stack. | | parent | Node | Parent node. | | rootStack | StackNode | Get **root** stack. | | stack | StackNode | Stack the node is contained in. | --- ##### `attributes`^Required ```java public java.lang.Object getAttributes(); ``` - *Type:* java.util.MapPlainObject OR java.util.ListPlainObject>> Get *readonly* record of all attributes. --- ##### `flags`^Required ```java public java.util.List getFlags(); ``` - *Type:* java.util.List<FlagEnum> Get *readonly* list of all flags. --- ##### `isDestroyed`^Required ```java public java.lang.Boolean getIsDestroyed(); ``` - *Type:* java.lang.Boolean Indicates if the entity has been destroyed (eg: removed from store). --- ##### `isMutated`^Required ```java public java.lang.Boolean getIsMutated(); ``` - *Type:* java.lang.Boolean Indicates if the entity has had destructive mutations applied. --- ##### `metadata`^Required ```java public java.util.List getMetadata(); ``` - *Type:* java.util.List Get *readonly* list of all metadata entries. --- ##### `store`^Required ```java public Store getStore(); ``` - *Type:* Store Reference to the store. --- ##### `tags`^Required ```java public java.util.Map getTags(); ``` - *Type:* java.util.Map Get *readonly* record of all tags. --- ##### `uuid`^Required ```java public java.lang.String getUuid(); ``` - *Type:* java.lang.String Universally unique identifier. --- ##### `allowDestructiveMutations`^Required ```java public java.lang.Boolean getAllowDestructiveMutations(); ``` - *Type:* java.lang.Boolean Indicates if this node allows destructive mutations. > [{@link Store.allowDestructiveMutations }]({@link Store.allowDestructiveMutations }) --- ##### `children`^Required ```java public java.util.List getChildren(); ``` - *Type:* java.util.List<Node> Get all direct child nodes. --- ##### `dependedOnBy`^Required ```java public java.util.List getDependedOnBy(); ``` - *Type:* java.util.List<Node> Get list of **Nodes** that *depend on this node*. > [{@link Node.reverseDependencyLinks }]({@link Node.reverseDependencyLinks }) --- ##### `dependencies`^Required ```java public java.util.List getDependencies(); ``` - *Type:* java.util.List<Node> Get list of **Nodes** that *this node depends on*. > [{@link Node.dependencyLinks }]({@link Node.dependencyLinks }) --- ##### `dependencyLinks`^Required ```java public java.util.List getDependencyLinks(); ``` - *Type:* java.util.List<Dependency> Gets list of {@link Dependency} links (edges) where this node is the **source**. --- ##### `depth`^Required ```java public java.lang.Number getDepth(); ``` - *Type:* java.lang.Number Indicates the depth of the node relative to root (0). --- ##### `id`^Required ```java public java.lang.String getId(); ``` - *Type:* java.lang.String Node id, which is only unique within parent scope. --- ##### `isAsset`^Required ```java public java.lang.Boolean getIsAsset(); ``` - *Type:* java.lang.Boolean Indicates if this node is considered a {@link FlagEnum.ASSET}. --- ##### `isCfnFqn`^Required ```java public java.lang.Boolean getIsCfnFqn(); ``` - *Type:* java.lang.Boolean Indicates if node ConstructInfoFqn denotes a `aws-cdk-lib.*.Cfn*` construct. > [{@link FlagEnum.CFN_FQN }]({@link FlagEnum.CFN_FQN }) --- ##### `isCluster`^Required ```java public java.lang.Boolean getIsCluster(); ``` - *Type:* java.lang.Boolean Indicates if this node is considered a {@link FlagEnum.CLUSTER}. --- ##### `isCustomResource`^Required ```java public java.lang.Boolean getIsCustomResource(); ``` - *Type:* java.lang.Boolean Indicates if node is a *Custom Resource*. --- ##### `isExtraneous`^Required ```java public java.lang.Boolean getIsExtraneous(); ``` - *Type:* java.lang.Boolean Indicates if this node is considered a {@link FlagEnum.EXTRANEOUS} node or determined to be extraneous: - Clusters that contain no children. --- ##### `isGraphContainer`^Required ```java public java.lang.Boolean getIsGraphContainer(); ``` - *Type:* java.lang.Boolean Indicates if this node is considered a {@link FlagEnum.GRAPH_CONTAINER}. --- ##### `isLeaf`^Required ```java public java.lang.Boolean getIsLeaf(); ``` - *Type:* java.lang.Boolean Indicates if this node is a *leaf* node, which means it does not have children. --- ##### `isTopLevel`^Required ```java public java.lang.Boolean getIsTopLevel(); ``` - *Type:* java.lang.Boolean Indicates if node is direct child of the graph root node. --- ##### `links`^Required ```java public java.util.List getLinks(); ``` - *Type:* java.util.List<Edge> Gets all links (edges) in which this node is the **source**. --- ##### `nodeType`^Required ```java public NodeTypeEnum getNodeType(); ``` - *Type:* NodeTypeEnum Type of node. --- ##### `path`^Required ```java public java.lang.String getPath(); ``` - *Type:* java.lang.String Path of the node. --- ##### `referencedBy`^Required ```java public java.util.List getReferencedBy(); ``` - *Type:* java.util.List<Node> Get list of **Nodes** that *reference this node*. > [{@link Node.reverseReferenceLinks }]({@link Node.reverseReferenceLinks }) --- ##### `referenceLinks`^Required ```java public java.util.List getReferenceLinks(); ``` - *Type:* java.util.List<Reference> Gets list of {@link Reference} links (edges) where this node is the **source**. --- ##### `references`^Required ```java public java.util.List getReferences(); ``` - *Type:* java.util.List<Node> Get list of **Nodes** that *this node references*. > [{@link Node.referenceLinks }]({@link Node.referenceLinks }) --- ##### `reverseDependencyLinks`^Required ```java public java.util.List getReverseDependencyLinks(); ``` - *Type:* java.util.List<Dependency> Gets list of {@link Dependency} links (edges) where this node is the **target**. --- ##### `reverseLinks`^Required ```java public java.util.List getReverseLinks(); ``` - *Type:* java.util.List<Edge> Gets all links (edges) in which this node is the **target**. --- ##### `reverseReferenceLinks`^Required ```java public java.util.List getReverseReferenceLinks(); ``` - *Type:* java.util.List<Reference> Gets list of {@link Reference} links (edges) where this node is the **target**. --- ##### `scopes`^Required ```java public java.util.List getScopes(); ``` - *Type:* java.util.List<Node> Gets descending ordered list of ancestors from the root. --- ##### `siblings`^Required ```java public java.util.List getSiblings(); ``` - *Type:* java.util.List<Node> Get list of *siblings* of this node. --- ##### `cfnProps`^Optional ```java public PlainObject getCfnProps(); ``` - *Type:* PlainObject Gets CloudFormation properties for this node. --- ##### `cfnType`^Optional ```java public java.lang.String getCfnType(); ``` - *Type:* java.lang.String Get the CloudFormation resource type for this node. --- ##### `constructInfo`^Optional ```java public ConstructInfo getConstructInfo(); ``` - *Type:* ConstructInfo Synthesized construct information defining jii resolution data. --- ##### `constructInfoFqn`^Optional ```java public java.lang.String getConstructInfoFqn(); ``` - *Type:* java.lang.String Synthesized construct information defining jii resolution data. --- ##### `logicalId`^Optional ```java public java.lang.String getLogicalId(); ``` - *Type:* java.lang.String Logical id of the node, which is only unique within containing stack. --- ##### `parent`^Optional ```java public Node getParent(); ``` - *Type:* Node Parent node. Only the root node should not have parent. --- ##### `rootStack`^Optional ```java public StackNode getRootStack(); ``` - *Type:* StackNode Get **root** stack. --- ##### `stack`^Optional ```java public StackNode getStack(); ``` - *Type:* StackNode Stack the node is contained in. --- ### OutputNode OutputNode defines a cdk CfnOutput resources. #### Initializers ```java import software.aws.awsprototypingsdk.cdkgraph.OutputNode; new OutputNode(IOutputNodeProps props); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | IOutputNodeProps | *No description.* | --- ##### `props`^Required - *Type:* IOutputNodeProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAttribute | Add attribute. | | addFlag | Add flag. | | addMetadata | Add metadata entry. | | addTag | Add tag. | | applyData | Applies data (attributes, metadata, tags, flag) to entity. | | findMetadata | Retrieves all metadata entries of a given type. | | getAttribute | Get attribute by key. | | getTag | Get tag by key. | | hasAttribute | Indicates if entity has a given attribute defined, and optionally with a specific value. | | hasFlag | Indicates if entity has a given flag. | | hasMetadata | Indicates if entity has matching metadata entry. | | hasTag | Indicates if entity has tag, optionally verifying tag value. | | mutateDestroy | Destroys this node by removing all references and removing this node from the store. | | setAttribute | Set attribute. | | setTag | Set tag. | | addChild | Add *child* node. | | addLink | Add *link* to another node. | | addReverseLink | Add *link* from another node. | | doesDependOn | Indicates if *this node* depends on *another node*. | | doesReference | Indicates if *this node* references *another node*. | | find | Recursively find the nearest sub-node matching predicate. | | findAll | Return this construct and all of its sub-nodes in the given order. | | findAllLinks | Return all direct links of this node and that of all sub-nodes. | | findAncestor | Find nearest *ancestor* of *this node* matching given predicate. | | findChild | Find child with given *id*. | | findLink | Find link of this node based on predicate. | | findLinks | Find all links of this node based on predicate. | | getCfnProp | Get specific CloudFormation property. | | getChild | Get *child* node with given *id*. | | getLinkChains | Resolve all link chains. | | getNearestAncestor | Gets the nearest **common** *ancestor* shared between *this node* and another *node*. | | isAncestor | Indicates if a specific *node* is an *ancestor* of *this node*. | | isChild | Indicates if specific *node* is a *child* of *this node*. | | mutateCollapse | Collapses all sub-nodes of *this node* into *this node*. | | mutateCollapseTo | Collapses *this node* into *an ancestor*. | | mutateCollapseToParent | Collapses *this node* into *it's parent node*. | | mutateHoist | Hoist *this node* to an *ancestor* by removing it from its current parent node and in turn moving it to the ancestor. | | mutateMove | Move this node into a new parent node. | | mutateRemoveChild | Remove a *child* node from *this node*. | | mutateRemoveLink | Remove a *link* from *this node*. | | mutateRemoveReverseLink | Remove a *link* to *this node*. | | mutateUncluster | Hoist all children to parent and collapse node to parent. | | toString | Get string representation of this node. | --- ##### `addAttribute` ```java public void addAttribute(java.lang.String key, java.lang.Object value) ``` Add attribute. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.Object --- ##### `addFlag` ```java public void addFlag(FlagEnum flag) ``` Add flag. ###### `flag`^Required - *Type:* FlagEnum --- ##### `addMetadata` ```java public void addMetadata(java.lang.String metadataType, java.lang.Object data) ``` Add metadata entry. ###### `metadataType`^Required - *Type:* java.lang.String --- ###### `data`^Required - *Type:* java.lang.Object --- ##### `addTag` ```java public void addTag(java.lang.String key, java.lang.String value) ``` Add tag. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.String --- ##### `applyData` ```java public void applyData(IBaseEntityDataProps data) public void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite) public void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite, java.lang.Boolean applyFlags) ``` Applies data (attributes, metadata, tags, flag) to entity. Generally used only for mutations such as collapse and consume to retain data. ###### `data`^Required - *Type:* IBaseEntityDataProps The data to apply. --- ###### `overwrite`^Optional - *Type:* java.lang.Boolean --- ###### `applyFlags`^Optional - *Type:* java.lang.Boolean Indicates if data is overwritten - Indicates if flags should be applied. --- ##### `findMetadata` ```java public java.util.List findMetadata(java.lang.String metadataType) ``` Retrieves all metadata entries of a given type. ###### `metadataType`^Required - *Type:* java.lang.String --- ##### `getAttribute` ```java public java.lang.Object getAttribute(java.lang.String key) ``` Get attribute by key. ###### `key`^Required - *Type:* java.lang.String --- ##### `getTag` ```java public java.lang.String getTag(java.lang.String key) ``` Get tag by key. ###### `key`^Required - *Type:* java.lang.String --- ##### `hasAttribute` ```java public java.lang.Boolean hasAttribute(java.lang.String key) public java.lang.Boolean hasAttribute(java.lang.String key, java.lang.Object value) ``` Indicates if entity has a given attribute defined, and optionally with a specific value. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Optional - *Type:* java.lang.Object --- ##### `hasFlag` ```java public java.lang.Boolean hasFlag(FlagEnum flag) ``` Indicates if entity has a given flag. ###### `flag`^Required - *Type:* FlagEnum --- ##### `hasMetadata` ```java public java.lang.Boolean hasMetadata(java.lang.String metadataType, java.lang.Object data) ``` Indicates if entity has matching metadata entry. ###### `metadataType`^Required - *Type:* java.lang.String --- ###### `data`^Required - *Type:* java.lang.Object --- ##### `hasTag` ```java public java.lang.Boolean hasTag(java.lang.String key) public java.lang.Boolean hasTag(java.lang.String key, java.lang.String value) ``` Indicates if entity has tag, optionally verifying tag value. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Optional - *Type:* java.lang.String --- ##### `mutateDestroy` ```java public void mutateDestroy() public void mutateDestroy(java.lang.Boolean strict) ``` Destroys this node by removing all references and removing this node from the store. ###### `strict`^Optional - *Type:* java.lang.Boolean --- ##### `setAttribute` ```java public void setAttribute(java.lang.String key, java.lang.Object value) ``` Set attribute. This will overwrite existing attribute. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.Object --- ##### `setTag` ```java public void setTag(java.lang.String key, java.lang.String value) ``` Set tag. Will overwrite existing tag. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.String --- ##### `addChild` ```java public void addChild(Node node) ``` Add *child* node. ###### `node`^Required - *Type:* Node --- ##### `addLink` ```java public void addLink(Edge edge) ``` Add *link* to another node. ###### `edge`^Required - *Type:* Edge --- ##### `addReverseLink` ```java public void addReverseLink(Edge edge) ``` Add *link* from another node. ###### `edge`^Required - *Type:* Edge --- ##### `doesDependOn` ```java public java.lang.Boolean doesDependOn(Node node) ``` Indicates if *this node* depends on *another node*. ###### `node`^Required - *Type:* Node --- ##### `doesReference` ```java public java.lang.Boolean doesReference(Node node) ``` Indicates if *this node* references *another node*. ###### `node`^Required - *Type:* Node --- ##### `find` ```java public Node find(INodePredicate predicate) ``` Recursively find the nearest sub-node matching predicate. ###### `predicate`^Required - *Type:* INodePredicate --- ##### `findAll` ```java public java.util.List findAll() public java.util.List findAll(IFindNodeOptions options) ``` Return this construct and all of its sub-nodes in the given order. Optionally filter nodes based on predicate. ###### `options`^Optional - *Type:* IFindNodeOptions --- ##### `findAllLinks` ```java public java.util.List findAllLinks() public java.util.List findAllLinks(IFindEdgeOptions options) ``` Return all direct links of this node and that of all sub-nodes. Optionally filter links based on predicate. ###### `options`^Optional - *Type:* IFindEdgeOptions --- ##### `findAncestor` ```java public Node findAncestor(INodePredicate predicate) public Node findAncestor(INodePredicate predicate, java.lang.Number max) ``` Find nearest *ancestor* of *this node* matching given predicate. ###### `predicate`^Required - *Type:* INodePredicate Predicate to match ancestor. --- ###### `max`^Optional - *Type:* java.lang.Number --- ##### `findChild` ```java public Node findChild(java.lang.String id) ``` Find child with given *id*. Similar to `find` but does not throw error if no child found. ###### `id`^Required - *Type:* java.lang.String --- ##### `findLink` ```java public Edge findLink(IEdgePredicate predicate) public Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse) public Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow) public Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow, java.lang.Boolean direct) ``` Find link of this node based on predicate. By default this will follow link chains to evaluate the predicate against and return the matching direct link of this node. ###### `predicate`^Required - *Type:* IEdgePredicate Edge predicate function to match edge. --- ###### `reverse`^Optional - *Type:* java.lang.Boolean Indicates if links are search in reverse order. --- ###### `follow`^Optional - *Type:* java.lang.Boolean Indicates if link chain is followed. --- ###### `direct`^Optional - *Type:* java.lang.Boolean Indicates that only *direct* links should be searched. --- ##### `findLinks` ```java public java.util.List findLinks(IEdgePredicate predicate) public java.util.List findLinks(IEdgePredicate predicate, java.lang.Boolean reverse) public java.util.List findLinks(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow) public java.util.List findLinks(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow, java.lang.Boolean direct) ``` Find all links of this node based on predicate. By default this will follow link chains to evaluate the predicate against and return the matching direct links of this node. ###### `predicate`^Required - *Type:* IEdgePredicate Edge predicate function to match edge. --- ###### `reverse`^Optional - *Type:* java.lang.Boolean Indicates if links are search in reverse order. --- ###### `follow`^Optional - *Type:* java.lang.Boolean Indicates if link chain is followed. --- ###### `direct`^Optional - *Type:* java.lang.Boolean Indicates that only *direct* links should be searched. --- ##### `getCfnProp` ```java public java.lang.String OR java.lang.Number OR java.lang.Boolean OR PlainObject OR java.util.List getCfnProp(java.lang.String key) ``` Get specific CloudFormation property. ###### `key`^Required - *Type:* java.lang.String --- ##### `getChild` ```java public Node getChild(java.lang.String id) ``` Get *child* node with given *id*. ###### `id`^Required - *Type:* java.lang.String --- ##### `getLinkChains` ```java public java.util.List> getLinkChains() public java.util.List> getLinkChains(java.lang.Boolean reverse) ``` Resolve all link chains. > [{@link EdgeChain }]({@link EdgeChain }) ###### `reverse`^Optional - *Type:* java.lang.Boolean --- ##### `getNearestAncestor` ```java public Node getNearestAncestor(Node node) ``` Gets the nearest **common** *ancestor* shared between *this node* and another *node*. ###### `node`^Required - *Type:* Node --- ##### `isAncestor` ```java public java.lang.Boolean isAncestor(Node ancestor) ``` Indicates if a specific *node* is an *ancestor* of *this node*. ###### `ancestor`^Required - *Type:* Node --- ##### `isChild` ```java public java.lang.Boolean isChild(Node node) ``` Indicates if specific *node* is a *child* of *this node*. ###### `node`^Required - *Type:* Node --- ##### `mutateCollapse` ```java public void mutateCollapse() ``` Collapses all sub-nodes of *this node* into *this node*. ##### `mutateCollapseTo` ```java public Node mutateCollapseTo(Node ancestor) ``` Collapses *this node* into *an ancestor*. ###### `ancestor`^Required - *Type:* Node --- ##### `mutateCollapseToParent` ```java public Node mutateCollapseToParent() ``` Collapses *this node* into *it's parent node*. ##### `mutateHoist` ```java public void mutateHoist(Node newParent) ``` Hoist *this node* to an *ancestor* by removing it from its current parent node and in turn moving it to the ancestor. ###### `newParent`^Required - *Type:* Node --- ##### `mutateMove` ```java public void mutateMove(Node newParent) ``` Move this node into a new parent node. ###### `newParent`^Required - *Type:* Node The parent to move this node to. --- ##### `mutateRemoveChild` ```java public java.lang.Boolean mutateRemoveChild(Node node) ``` Remove a *child* node from *this node*. ###### `node`^Required - *Type:* Node --- ##### `mutateRemoveLink` ```java public java.lang.Boolean mutateRemoveLink(Edge link) ``` Remove a *link* from *this node*. ###### `link`^Required - *Type:* Edge --- ##### `mutateRemoveReverseLink` ```java public java.lang.Boolean mutateRemoveReverseLink(Edge link) ``` Remove a *link* to *this node*. ###### `link`^Required - *Type:* Edge --- ##### `mutateUncluster` ```java public void mutateUncluster() ``` Hoist all children to parent and collapse node to parent. ##### `toString` ```java public java.lang.String toString() ``` Get string representation of this node. #### Static Functions | **Name** | **Description** | | --- | --- | | isOutputNode | Indicates if node is an {@link OutputNode}. | --- ##### `isOutputNode` ```java import software.aws.awsprototypingsdk.cdkgraph.OutputNode; OutputNode.isOutputNode(Node node) ``` Indicates if node is an {@link OutputNode}. ###### `node`^Required - *Type:* Node --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | attributes | java.util.MapPlainObject OR java.util.ListPlainObject>> | Get *readonly* record of all attributes. | | flags | java.util.List<FlagEnum> | Get *readonly* list of all flags. | | isDestroyed | java.lang.Boolean | Indicates if the entity has been destroyed (eg: removed from store). | | isMutated | java.lang.Boolean | Indicates if the entity has had destructive mutations applied. | | metadata | java.util.List | Get *readonly* list of all metadata entries. | | store | Store | Reference to the store. | | tags | java.util.Map | Get *readonly* record of all tags. | | uuid | java.lang.String | Universally unique identifier. | | allowDestructiveMutations | java.lang.Boolean | Indicates if this node allows destructive mutations. | | children | java.util.List<Node> | Get all direct child nodes. | | dependedOnBy | java.util.List<Node> | Get list of **Nodes** that *depend on this node*. | | dependencies | java.util.List<Node> | Get list of **Nodes** that *this node depends on*. | | dependencyLinks | java.util.List<Dependency> | Gets list of {@link Dependency} links (edges) where this node is the **source**. | | depth | java.lang.Number | Indicates the depth of the node relative to root (0). | | id | java.lang.String | Node id, which is only unique within parent scope. | | isAsset | java.lang.Boolean | Indicates if this node is considered a {@link FlagEnum.ASSET}. | | isCfnFqn | java.lang.Boolean | Indicates if node ConstructInfoFqn denotes a `aws-cdk-lib.*.Cfn*` construct. | | isCluster | java.lang.Boolean | Indicates if this node is considered a {@link FlagEnum.CLUSTER}. | | isCustomResource | java.lang.Boolean | Indicates if node is a *Custom Resource*. | | isExtraneous | java.lang.Boolean | Indicates if this node is considered a {@link FlagEnum.EXTRANEOUS} node or determined to be extraneous: - Clusters that contain no children. | | isGraphContainer | java.lang.Boolean | Indicates if this node is considered a {@link FlagEnum.GRAPH_CONTAINER}. | | isLeaf | java.lang.Boolean | Indicates if this node is a *leaf* node, which means it does not have children. | | isTopLevel | java.lang.Boolean | Indicates if node is direct child of the graph root node. | | links | java.util.List<Edge> | Gets all links (edges) in which this node is the **source**. | | nodeType | NodeTypeEnum | Type of node. | | path | java.lang.String | Path of the node. | | referencedBy | java.util.List<Node> | Get list of **Nodes** that *reference this node*. | | referenceLinks | java.util.List<Reference> | Gets list of {@link Reference} links (edges) where this node is the **source**. | | references | java.util.List<Node> | Get list of **Nodes** that *this node references*. | | reverseDependencyLinks | java.util.List<Dependency> | Gets list of {@link Dependency} links (edges) where this node is the **target**. | | reverseLinks | java.util.List<Edge> | Gets all links (edges) in which this node is the **target**. | | reverseReferenceLinks | java.util.List<Reference> | Gets list of {@link Reference} links (edges) where this node is the **target**. | | scopes | java.util.List<Node> | Gets descending ordered list of ancestors from the root. | | siblings | java.util.List<Node> | Get list of *siblings* of this node. | | cfnProps | PlainObject | Gets CloudFormation properties for this node. | | cfnType | java.lang.String | Get the CloudFormation resource type for this node. | | constructInfo | ConstructInfo | Synthesized construct information defining jii resolution data. | | constructInfoFqn | java.lang.String | Synthesized construct information defining jii resolution data. | | logicalId | java.lang.String | Logical id of the node, which is only unique within containing stack. | | parent | Node | Parent node. | | rootStack | StackNode | Get **root** stack. | | stack | StackNode | Stack the node is contained in. | | isExport | java.lang.Boolean | Indicates if {@link OutputNode} is **exported**. | | value | java.lang.Object | Get the *value** attribute. | | exportName | java.lang.String | Get the export name attribute. | --- ##### `attributes`^Required ```java public java.lang.Object getAttributes(); ``` - *Type:* java.util.MapPlainObject OR java.util.ListPlainObject>> Get *readonly* record of all attributes. --- ##### `flags`^Required ```java public java.util.List getFlags(); ``` - *Type:* java.util.List<FlagEnum> Get *readonly* list of all flags. --- ##### `isDestroyed`^Required ```java public java.lang.Boolean getIsDestroyed(); ``` - *Type:* java.lang.Boolean Indicates if the entity has been destroyed (eg: removed from store). --- ##### `isMutated`^Required ```java public java.lang.Boolean getIsMutated(); ``` - *Type:* java.lang.Boolean Indicates if the entity has had destructive mutations applied. --- ##### `metadata`^Required ```java public java.util.List getMetadata(); ``` - *Type:* java.util.List Get *readonly* list of all metadata entries. --- ##### `store`^Required ```java public Store getStore(); ``` - *Type:* Store Reference to the store. --- ##### `tags`^Required ```java public java.util.Map getTags(); ``` - *Type:* java.util.Map Get *readonly* record of all tags. --- ##### `uuid`^Required ```java public java.lang.String getUuid(); ``` - *Type:* java.lang.String Universally unique identifier. --- ##### `allowDestructiveMutations`^Required ```java public java.lang.Boolean getAllowDestructiveMutations(); ``` - *Type:* java.lang.Boolean Indicates if this node allows destructive mutations. > [{@link Store.allowDestructiveMutations }]({@link Store.allowDestructiveMutations }) --- ##### `children`^Required ```java public java.util.List getChildren(); ``` - *Type:* java.util.List<Node> Get all direct child nodes. --- ##### `dependedOnBy`^Required ```java public java.util.List getDependedOnBy(); ``` - *Type:* java.util.List<Node> Get list of **Nodes** that *depend on this node*. > [{@link Node.reverseDependencyLinks }]({@link Node.reverseDependencyLinks }) --- ##### `dependencies`^Required ```java public java.util.List getDependencies(); ``` - *Type:* java.util.List<Node> Get list of **Nodes** that *this node depends on*. > [{@link Node.dependencyLinks }]({@link Node.dependencyLinks }) --- ##### `dependencyLinks`^Required ```java public java.util.List getDependencyLinks(); ``` - *Type:* java.util.List<Dependency> Gets list of {@link Dependency} links (edges) where this node is the **source**. --- ##### `depth`^Required ```java public java.lang.Number getDepth(); ``` - *Type:* java.lang.Number Indicates the depth of the node relative to root (0). --- ##### `id`^Required ```java public java.lang.String getId(); ``` - *Type:* java.lang.String Node id, which is only unique within parent scope. --- ##### `isAsset`^Required ```java public java.lang.Boolean getIsAsset(); ``` - *Type:* java.lang.Boolean Indicates if this node is considered a {@link FlagEnum.ASSET}. --- ##### `isCfnFqn`^Required ```java public java.lang.Boolean getIsCfnFqn(); ``` - *Type:* java.lang.Boolean Indicates if node ConstructInfoFqn denotes a `aws-cdk-lib.*.Cfn*` construct. > [{@link FlagEnum.CFN_FQN }]({@link FlagEnum.CFN_FQN }) --- ##### `isCluster`^Required ```java public java.lang.Boolean getIsCluster(); ``` - *Type:* java.lang.Boolean Indicates if this node is considered a {@link FlagEnum.CLUSTER}. --- ##### `isCustomResource`^Required ```java public java.lang.Boolean getIsCustomResource(); ``` - *Type:* java.lang.Boolean Indicates if node is a *Custom Resource*. --- ##### `isExtraneous`^Required ```java public java.lang.Boolean getIsExtraneous(); ``` - *Type:* java.lang.Boolean Indicates if this node is considered a {@link FlagEnum.EXTRANEOUS} node or determined to be extraneous: - Clusters that contain no children. --- ##### `isGraphContainer`^Required ```java public java.lang.Boolean getIsGraphContainer(); ``` - *Type:* java.lang.Boolean Indicates if this node is considered a {@link FlagEnum.GRAPH_CONTAINER}. --- ##### `isLeaf`^Required ```java public java.lang.Boolean getIsLeaf(); ``` - *Type:* java.lang.Boolean Indicates if this node is a *leaf* node, which means it does not have children. --- ##### `isTopLevel`^Required ```java public java.lang.Boolean getIsTopLevel(); ``` - *Type:* java.lang.Boolean Indicates if node is direct child of the graph root node. --- ##### `links`^Required ```java public java.util.List getLinks(); ``` - *Type:* java.util.List<Edge> Gets all links (edges) in which this node is the **source**. --- ##### `nodeType`^Required ```java public NodeTypeEnum getNodeType(); ``` - *Type:* NodeTypeEnum Type of node. --- ##### `path`^Required ```java public java.lang.String getPath(); ``` - *Type:* java.lang.String Path of the node. --- ##### `referencedBy`^Required ```java public java.util.List getReferencedBy(); ``` - *Type:* java.util.List<Node> Get list of **Nodes** that *reference this node*. > [{@link Node.reverseReferenceLinks }]({@link Node.reverseReferenceLinks }) --- ##### `referenceLinks`^Required ```java public java.util.List getReferenceLinks(); ``` - *Type:* java.util.List<Reference> Gets list of {@link Reference} links (edges) where this node is the **source**. --- ##### `references`^Required ```java public java.util.List getReferences(); ``` - *Type:* java.util.List<Node> Get list of **Nodes** that *this node references*. > [{@link Node.referenceLinks }]({@link Node.referenceLinks }) --- ##### `reverseDependencyLinks`^Required ```java public java.util.List getReverseDependencyLinks(); ``` - *Type:* java.util.List<Dependency> Gets list of {@link Dependency} links (edges) where this node is the **target**. --- ##### `reverseLinks`^Required ```java public java.util.List getReverseLinks(); ``` - *Type:* java.util.List<Edge> Gets all links (edges) in which this node is the **target**. --- ##### `reverseReferenceLinks`^Required ```java public java.util.List getReverseReferenceLinks(); ``` - *Type:* java.util.List<Reference> Gets list of {@link Reference} links (edges) where this node is the **target**. --- ##### `scopes`^Required ```java public java.util.List getScopes(); ``` - *Type:* java.util.List<Node> Gets descending ordered list of ancestors from the root. --- ##### `siblings`^Required ```java public java.util.List getSiblings(); ``` - *Type:* java.util.List<Node> Get list of *siblings* of this node. --- ##### `cfnProps`^Optional ```java public PlainObject getCfnProps(); ``` - *Type:* PlainObject Gets CloudFormation properties for this node. --- ##### `cfnType`^Optional ```java public java.lang.String getCfnType(); ``` - *Type:* java.lang.String Get the CloudFormation resource type for this node. --- ##### `constructInfo`^Optional ```java public ConstructInfo getConstructInfo(); ``` - *Type:* ConstructInfo Synthesized construct information defining jii resolution data. --- ##### `constructInfoFqn`^Optional ```java public java.lang.String getConstructInfoFqn(); ``` - *Type:* java.lang.String Synthesized construct information defining jii resolution data. --- ##### `logicalId`^Optional ```java public java.lang.String getLogicalId(); ``` - *Type:* java.lang.String Logical id of the node, which is only unique within containing stack. --- ##### `parent`^Optional ```java public Node getParent(); ``` - *Type:* Node Parent node. Only the root node should not have parent. --- ##### `rootStack`^Optional ```java public StackNode getRootStack(); ``` - *Type:* StackNode Get **root** stack. --- ##### `stack`^Optional ```java public StackNode getStack(); ``` - *Type:* StackNode Stack the node is contained in. --- ##### `isExport`^Required ```java public java.lang.Boolean getIsExport(); ``` - *Type:* java.lang.Boolean Indicates if {@link OutputNode} is **exported**. --- ##### `value`^Required ```java public java.lang.Object getValue(); ``` - *Type:* java.lang.Object Get the *value** attribute. --- ##### `exportName`^Optional ```java public java.lang.String getExportName(); ``` - *Type:* java.lang.String Get the export name attribute. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ATTR_EXPORT_NAME | java.lang.String | Attribute key where output export name is stored. | | ATTR_VALUE | java.lang.String | Attribute key where output value is stored. | --- ##### `ATTR_EXPORT_NAME`^Required ```java public java.lang.String getAttrExportName(); ``` - *Type:* java.lang.String Attribute key where output export name is stored. --- ##### `ATTR_VALUE`^Required ```java public java.lang.String getAttrValue(); ``` - *Type:* java.lang.String Attribute key where output value is stored. --- ### ParameterNode ParameterNode defines a CfnParameter node. #### Initializers ```java import software.aws.awsprototypingsdk.cdkgraph.ParameterNode; new ParameterNode(IParameterNodeProps props); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | IParameterNodeProps | *No description.* | --- ##### `props`^Required - *Type:* IParameterNodeProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAttribute | Add attribute. | | addFlag | Add flag. | | addMetadata | Add metadata entry. | | addTag | Add tag. | | applyData | Applies data (attributes, metadata, tags, flag) to entity. | | findMetadata | Retrieves all metadata entries of a given type. | | getAttribute | Get attribute by key. | | getTag | Get tag by key. | | hasAttribute | Indicates if entity has a given attribute defined, and optionally with a specific value. | | hasFlag | Indicates if entity has a given flag. | | hasMetadata | Indicates if entity has matching metadata entry. | | hasTag | Indicates if entity has tag, optionally verifying tag value. | | mutateDestroy | Destroys this node by removing all references and removing this node from the store. | | setAttribute | Set attribute. | | setTag | Set tag. | | addChild | Add *child* node. | | addLink | Add *link* to another node. | | addReverseLink | Add *link* from another node. | | doesDependOn | Indicates if *this node* depends on *another node*. | | doesReference | Indicates if *this node* references *another node*. | | find | Recursively find the nearest sub-node matching predicate. | | findAll | Return this construct and all of its sub-nodes in the given order. | | findAllLinks | Return all direct links of this node and that of all sub-nodes. | | findAncestor | Find nearest *ancestor* of *this node* matching given predicate. | | findChild | Find child with given *id*. | | findLink | Find link of this node based on predicate. | | findLinks | Find all links of this node based on predicate. | | getCfnProp | Get specific CloudFormation property. | | getChild | Get *child* node with given *id*. | | getLinkChains | Resolve all link chains. | | getNearestAncestor | Gets the nearest **common** *ancestor* shared between *this node* and another *node*. | | isAncestor | Indicates if a specific *node* is an *ancestor* of *this node*. | | isChild | Indicates if specific *node* is a *child* of *this node*. | | mutateCollapse | Collapses all sub-nodes of *this node* into *this node*. | | mutateCollapseTo | Collapses *this node* into *an ancestor*. | | mutateCollapseToParent | Collapses *this node* into *it's parent node*. | | mutateHoist | Hoist *this node* to an *ancestor* by removing it from its current parent node and in turn moving it to the ancestor. | | mutateMove | Move this node into a new parent node. | | mutateRemoveChild | Remove a *child* node from *this node*. | | mutateRemoveLink | Remove a *link* from *this node*. | | mutateRemoveReverseLink | Remove a *link* to *this node*. | | mutateUncluster | Hoist all children to parent and collapse node to parent. | | toString | Get string representation of this node. | --- ##### `addAttribute` ```java public void addAttribute(java.lang.String key, java.lang.Object value) ``` Add attribute. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.Object --- ##### `addFlag` ```java public void addFlag(FlagEnum flag) ``` Add flag. ###### `flag`^Required - *Type:* FlagEnum --- ##### `addMetadata` ```java public void addMetadata(java.lang.String metadataType, java.lang.Object data) ``` Add metadata entry. ###### `metadataType`^Required - *Type:* java.lang.String --- ###### `data`^Required - *Type:* java.lang.Object --- ##### `addTag` ```java public void addTag(java.lang.String key, java.lang.String value) ``` Add tag. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.String --- ##### `applyData` ```java public void applyData(IBaseEntityDataProps data) public void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite) public void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite, java.lang.Boolean applyFlags) ``` Applies data (attributes, metadata, tags, flag) to entity. Generally used only for mutations such as collapse and consume to retain data. ###### `data`^Required - *Type:* IBaseEntityDataProps The data to apply. --- ###### `overwrite`^Optional - *Type:* java.lang.Boolean --- ###### `applyFlags`^Optional - *Type:* java.lang.Boolean Indicates if data is overwritten - Indicates if flags should be applied. --- ##### `findMetadata` ```java public java.util.List findMetadata(java.lang.String metadataType) ``` Retrieves all metadata entries of a given type. ###### `metadataType`^Required - *Type:* java.lang.String --- ##### `getAttribute` ```java public java.lang.Object getAttribute(java.lang.String key) ``` Get attribute by key. ###### `key`^Required - *Type:* java.lang.String --- ##### `getTag` ```java public java.lang.String getTag(java.lang.String key) ``` Get tag by key. ###### `key`^Required - *Type:* java.lang.String --- ##### `hasAttribute` ```java public java.lang.Boolean hasAttribute(java.lang.String key) public java.lang.Boolean hasAttribute(java.lang.String key, java.lang.Object value) ``` Indicates if entity has a given attribute defined, and optionally with a specific value. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Optional - *Type:* java.lang.Object --- ##### `hasFlag` ```java public java.lang.Boolean hasFlag(FlagEnum flag) ``` Indicates if entity has a given flag. ###### `flag`^Required - *Type:* FlagEnum --- ##### `hasMetadata` ```java public java.lang.Boolean hasMetadata(java.lang.String metadataType, java.lang.Object data) ``` Indicates if entity has matching metadata entry. ###### `metadataType`^Required - *Type:* java.lang.String --- ###### `data`^Required - *Type:* java.lang.Object --- ##### `hasTag` ```java public java.lang.Boolean hasTag(java.lang.String key) public java.lang.Boolean hasTag(java.lang.String key, java.lang.String value) ``` Indicates if entity has tag, optionally verifying tag value. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Optional - *Type:* java.lang.String --- ##### `mutateDestroy` ```java public void mutateDestroy() public void mutateDestroy(java.lang.Boolean strict) ``` Destroys this node by removing all references and removing this node from the store. ###### `strict`^Optional - *Type:* java.lang.Boolean --- ##### `setAttribute` ```java public void setAttribute(java.lang.String key, java.lang.Object value) ``` Set attribute. This will overwrite existing attribute. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.Object --- ##### `setTag` ```java public void setTag(java.lang.String key, java.lang.String value) ``` Set tag. Will overwrite existing tag. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.String --- ##### `addChild` ```java public void addChild(Node node) ``` Add *child* node. ###### `node`^Required - *Type:* Node --- ##### `addLink` ```java public void addLink(Edge edge) ``` Add *link* to another node. ###### `edge`^Required - *Type:* Edge --- ##### `addReverseLink` ```java public void addReverseLink(Edge edge) ``` Add *link* from another node. ###### `edge`^Required - *Type:* Edge --- ##### `doesDependOn` ```java public java.lang.Boolean doesDependOn(Node node) ``` Indicates if *this node* depends on *another node*. ###### `node`^Required - *Type:* Node --- ##### `doesReference` ```java public java.lang.Boolean doesReference(Node node) ``` Indicates if *this node* references *another node*. ###### `node`^Required - *Type:* Node --- ##### `find` ```java public Node find(INodePredicate predicate) ``` Recursively find the nearest sub-node matching predicate. ###### `predicate`^Required - *Type:* INodePredicate --- ##### `findAll` ```java public java.util.List findAll() public java.util.List findAll(IFindNodeOptions options) ``` Return this construct and all of its sub-nodes in the given order. Optionally filter nodes based on predicate. ###### `options`^Optional - *Type:* IFindNodeOptions --- ##### `findAllLinks` ```java public java.util.List findAllLinks() public java.util.List findAllLinks(IFindEdgeOptions options) ``` Return all direct links of this node and that of all sub-nodes. Optionally filter links based on predicate. ###### `options`^Optional - *Type:* IFindEdgeOptions --- ##### `findAncestor` ```java public Node findAncestor(INodePredicate predicate) public Node findAncestor(INodePredicate predicate, java.lang.Number max) ``` Find nearest *ancestor* of *this node* matching given predicate. ###### `predicate`^Required - *Type:* INodePredicate Predicate to match ancestor. --- ###### `max`^Optional - *Type:* java.lang.Number --- ##### `findChild` ```java public Node findChild(java.lang.String id) ``` Find child with given *id*. Similar to `find` but does not throw error if no child found. ###### `id`^Required - *Type:* java.lang.String --- ##### `findLink` ```java public Edge findLink(IEdgePredicate predicate) public Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse) public Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow) public Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow, java.lang.Boolean direct) ``` Find link of this node based on predicate. By default this will follow link chains to evaluate the predicate against and return the matching direct link of this node. ###### `predicate`^Required - *Type:* IEdgePredicate Edge predicate function to match edge. --- ###### `reverse`^Optional - *Type:* java.lang.Boolean Indicates if links are search in reverse order. --- ###### `follow`^Optional - *Type:* java.lang.Boolean Indicates if link chain is followed. --- ###### `direct`^Optional - *Type:* java.lang.Boolean Indicates that only *direct* links should be searched. --- ##### `findLinks` ```java public java.util.List findLinks(IEdgePredicate predicate) public java.util.List findLinks(IEdgePredicate predicate, java.lang.Boolean reverse) public java.util.List findLinks(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow) public java.util.List findLinks(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow, java.lang.Boolean direct) ``` Find all links of this node based on predicate. By default this will follow link chains to evaluate the predicate against and return the matching direct links of this node. ###### `predicate`^Required - *Type:* IEdgePredicate Edge predicate function to match edge. --- ###### `reverse`^Optional - *Type:* java.lang.Boolean Indicates if links are search in reverse order. --- ###### `follow`^Optional - *Type:* java.lang.Boolean Indicates if link chain is followed. --- ###### `direct`^Optional - *Type:* java.lang.Boolean Indicates that only *direct* links should be searched. --- ##### `getCfnProp` ```java public java.lang.String OR java.lang.Number OR java.lang.Boolean OR PlainObject OR java.util.List getCfnProp(java.lang.String key) ``` Get specific CloudFormation property. ###### `key`^Required - *Type:* java.lang.String --- ##### `getChild` ```java public Node getChild(java.lang.String id) ``` Get *child* node with given *id*. ###### `id`^Required - *Type:* java.lang.String --- ##### `getLinkChains` ```java public java.util.List> getLinkChains() public java.util.List> getLinkChains(java.lang.Boolean reverse) ``` Resolve all link chains. > [{@link EdgeChain }]({@link EdgeChain }) ###### `reverse`^Optional - *Type:* java.lang.Boolean --- ##### `getNearestAncestor` ```java public Node getNearestAncestor(Node node) ``` Gets the nearest **common** *ancestor* shared between *this node* and another *node*. ###### `node`^Required - *Type:* Node --- ##### `isAncestor` ```java public java.lang.Boolean isAncestor(Node ancestor) ``` Indicates if a specific *node* is an *ancestor* of *this node*. ###### `ancestor`^Required - *Type:* Node --- ##### `isChild` ```java public java.lang.Boolean isChild(Node node) ``` Indicates if specific *node* is a *child* of *this node*. ###### `node`^Required - *Type:* Node --- ##### `mutateCollapse` ```java public void mutateCollapse() ``` Collapses all sub-nodes of *this node* into *this node*. ##### `mutateCollapseTo` ```java public Node mutateCollapseTo(Node ancestor) ``` Collapses *this node* into *an ancestor*. ###### `ancestor`^Required - *Type:* Node --- ##### `mutateCollapseToParent` ```java public Node mutateCollapseToParent() ``` Collapses *this node* into *it's parent node*. ##### `mutateHoist` ```java public void mutateHoist(Node newParent) ``` Hoist *this node* to an *ancestor* by removing it from its current parent node and in turn moving it to the ancestor. ###### `newParent`^Required - *Type:* Node --- ##### `mutateMove` ```java public void mutateMove(Node newParent) ``` Move this node into a new parent node. ###### `newParent`^Required - *Type:* Node The parent to move this node to. --- ##### `mutateRemoveChild` ```java public java.lang.Boolean mutateRemoveChild(Node node) ``` Remove a *child* node from *this node*. ###### `node`^Required - *Type:* Node --- ##### `mutateRemoveLink` ```java public java.lang.Boolean mutateRemoveLink(Edge link) ``` Remove a *link* from *this node*. ###### `link`^Required - *Type:* Edge --- ##### `mutateRemoveReverseLink` ```java public java.lang.Boolean mutateRemoveReverseLink(Edge link) ``` Remove a *link* to *this node*. ###### `link`^Required - *Type:* Edge --- ##### `mutateUncluster` ```java public void mutateUncluster() ``` Hoist all children to parent and collapse node to parent. ##### `toString` ```java public java.lang.String toString() ``` Get string representation of this node. #### Static Functions | **Name** | **Description** | | --- | --- | | isParameterNode | Indicates if node is a {@link ParameterNode}. | --- ##### `isParameterNode` ```java import software.aws.awsprototypingsdk.cdkgraph.ParameterNode; ParameterNode.isParameterNode(Node node) ``` Indicates if node is a {@link ParameterNode}. ###### `node`^Required - *Type:* Node --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | attributes | java.util.MapPlainObject OR java.util.ListPlainObject>> | Get *readonly* record of all attributes. | | flags | java.util.List<FlagEnum> | Get *readonly* list of all flags. | | isDestroyed | java.lang.Boolean | Indicates if the entity has been destroyed (eg: removed from store). | | isMutated | java.lang.Boolean | Indicates if the entity has had destructive mutations applied. | | metadata | java.util.List | Get *readonly* list of all metadata entries. | | store | Store | Reference to the store. | | tags | java.util.Map | Get *readonly* record of all tags. | | uuid | java.lang.String | Universally unique identifier. | | allowDestructiveMutations | java.lang.Boolean | Indicates if this node allows destructive mutations. | | children | java.util.List<Node> | Get all direct child nodes. | | dependedOnBy | java.util.List<Node> | Get list of **Nodes** that *depend on this node*. | | dependencies | java.util.List<Node> | Get list of **Nodes** that *this node depends on*. | | dependencyLinks | java.util.List<Dependency> | Gets list of {@link Dependency} links (edges) where this node is the **source**. | | depth | java.lang.Number | Indicates the depth of the node relative to root (0). | | id | java.lang.String | Node id, which is only unique within parent scope. | | isAsset | java.lang.Boolean | Indicates if this node is considered a {@link FlagEnum.ASSET}. | | isCfnFqn | java.lang.Boolean | Indicates if node ConstructInfoFqn denotes a `aws-cdk-lib.*.Cfn*` construct. | | isCluster | java.lang.Boolean | Indicates if this node is considered a {@link FlagEnum.CLUSTER}. | | isCustomResource | java.lang.Boolean | Indicates if node is a *Custom Resource*. | | isExtraneous | java.lang.Boolean | Indicates if this node is considered a {@link FlagEnum.EXTRANEOUS} node or determined to be extraneous: - Clusters that contain no children. | | isGraphContainer | java.lang.Boolean | Indicates if this node is considered a {@link FlagEnum.GRAPH_CONTAINER}. | | isLeaf | java.lang.Boolean | Indicates if this node is a *leaf* node, which means it does not have children. | | isTopLevel | java.lang.Boolean | Indicates if node is direct child of the graph root node. | | links | java.util.List<Edge> | Gets all links (edges) in which this node is the **source**. | | nodeType | NodeTypeEnum | Type of node. | | path | java.lang.String | Path of the node. | | referencedBy | java.util.List<Node> | Get list of **Nodes** that *reference this node*. | | referenceLinks | java.util.List<Reference> | Gets list of {@link Reference} links (edges) where this node is the **source**. | | references | java.util.List<Node> | Get list of **Nodes** that *this node references*. | | reverseDependencyLinks | java.util.List<Dependency> | Gets list of {@link Dependency} links (edges) where this node is the **target**. | | reverseLinks | java.util.List<Edge> | Gets all links (edges) in which this node is the **target**. | | reverseReferenceLinks | java.util.List<Reference> | Gets list of {@link Reference} links (edges) where this node is the **target**. | | scopes | java.util.List<Node> | Gets descending ordered list of ancestors from the root. | | siblings | java.util.List<Node> | Get list of *siblings* of this node. | | cfnProps | PlainObject | Gets CloudFormation properties for this node. | | cfnType | java.lang.String | Get the CloudFormation resource type for this node. | | constructInfo | ConstructInfo | Synthesized construct information defining jii resolution data. | | constructInfoFqn | java.lang.String | Synthesized construct information defining jii resolution data. | | logicalId | java.lang.String | Logical id of the node, which is only unique within containing stack. | | parent | Node | Parent node. | | rootStack | StackNode | Get **root** stack. | | stack | StackNode | Stack the node is contained in. | | isStackReference | java.lang.Boolean | Indicates if parameter is a reference to a stack. | | parameterType | java.lang.Object | Get the parameter type attribute. | | value | java.lang.Object | Get the value attribute. | --- ##### `attributes`^Required ```java public java.lang.Object getAttributes(); ``` - *Type:* java.util.MapPlainObject OR java.util.ListPlainObject>> Get *readonly* record of all attributes. --- ##### `flags`^Required ```java public java.util.List getFlags(); ``` - *Type:* java.util.List<FlagEnum> Get *readonly* list of all flags. --- ##### `isDestroyed`^Required ```java public java.lang.Boolean getIsDestroyed(); ``` - *Type:* java.lang.Boolean Indicates if the entity has been destroyed (eg: removed from store). --- ##### `isMutated`^Required ```java public java.lang.Boolean getIsMutated(); ``` - *Type:* java.lang.Boolean Indicates if the entity has had destructive mutations applied. --- ##### `metadata`^Required ```java public java.util.List getMetadata(); ``` - *Type:* java.util.List Get *readonly* list of all metadata entries. --- ##### `store`^Required ```java public Store getStore(); ``` - *Type:* Store Reference to the store. --- ##### `tags`^Required ```java public java.util.Map getTags(); ``` - *Type:* java.util.Map Get *readonly* record of all tags. --- ##### `uuid`^Required ```java public java.lang.String getUuid(); ``` - *Type:* java.lang.String Universally unique identifier. --- ##### `allowDestructiveMutations`^Required ```java public java.lang.Boolean getAllowDestructiveMutations(); ``` - *Type:* java.lang.Boolean Indicates if this node allows destructive mutations. > [{@link Store.allowDestructiveMutations }]({@link Store.allowDestructiveMutations }) --- ##### `children`^Required ```java public java.util.List getChildren(); ``` - *Type:* java.util.List<Node> Get all direct child nodes. --- ##### `dependedOnBy`^Required ```java public java.util.List getDependedOnBy(); ``` - *Type:* java.util.List<Node> Get list of **Nodes** that *depend on this node*. > [{@link Node.reverseDependencyLinks }]({@link Node.reverseDependencyLinks }) --- ##### `dependencies`^Required ```java public java.util.List getDependencies(); ``` - *Type:* java.util.List<Node> Get list of **Nodes** that *this node depends on*. > [{@link Node.dependencyLinks }]({@link Node.dependencyLinks }) --- ##### `dependencyLinks`^Required ```java public java.util.List getDependencyLinks(); ``` - *Type:* java.util.List<Dependency> Gets list of {@link Dependency} links (edges) where this node is the **source**. --- ##### `depth`^Required ```java public java.lang.Number getDepth(); ``` - *Type:* java.lang.Number Indicates the depth of the node relative to root (0). --- ##### `id`^Required ```java public java.lang.String getId(); ``` - *Type:* java.lang.String Node id, which is only unique within parent scope. --- ##### `isAsset`^Required ```java public java.lang.Boolean getIsAsset(); ``` - *Type:* java.lang.Boolean Indicates if this node is considered a {@link FlagEnum.ASSET}. --- ##### `isCfnFqn`^Required ```java public java.lang.Boolean getIsCfnFqn(); ``` - *Type:* java.lang.Boolean Indicates if node ConstructInfoFqn denotes a `aws-cdk-lib.*.Cfn*` construct. > [{@link FlagEnum.CFN_FQN }]({@link FlagEnum.CFN_FQN }) --- ##### `isCluster`^Required ```java public java.lang.Boolean getIsCluster(); ``` - *Type:* java.lang.Boolean Indicates if this node is considered a {@link FlagEnum.CLUSTER}. --- ##### `isCustomResource`^Required ```java public java.lang.Boolean getIsCustomResource(); ``` - *Type:* java.lang.Boolean Indicates if node is a *Custom Resource*. --- ##### `isExtraneous`^Required ```java public java.lang.Boolean getIsExtraneous(); ``` - *Type:* java.lang.Boolean Indicates if this node is considered a {@link FlagEnum.EXTRANEOUS} node or determined to be extraneous: - Clusters that contain no children. --- ##### `isGraphContainer`^Required ```java public java.lang.Boolean getIsGraphContainer(); ``` - *Type:* java.lang.Boolean Indicates if this node is considered a {@link FlagEnum.GRAPH_CONTAINER}. --- ##### `isLeaf`^Required ```java public java.lang.Boolean getIsLeaf(); ``` - *Type:* java.lang.Boolean Indicates if this node is a *leaf* node, which means it does not have children. --- ##### `isTopLevel`^Required ```java public java.lang.Boolean getIsTopLevel(); ``` - *Type:* java.lang.Boolean Indicates if node is direct child of the graph root node. --- ##### `links`^Required ```java public java.util.List getLinks(); ``` - *Type:* java.util.List<Edge> Gets all links (edges) in which this node is the **source**. --- ##### `nodeType`^Required ```java public NodeTypeEnum getNodeType(); ``` - *Type:* NodeTypeEnum Type of node. --- ##### `path`^Required ```java public java.lang.String getPath(); ``` - *Type:* java.lang.String Path of the node. --- ##### `referencedBy`^Required ```java public java.util.List getReferencedBy(); ``` - *Type:* java.util.List<Node> Get list of **Nodes** that *reference this node*. > [{@link Node.reverseReferenceLinks }]({@link Node.reverseReferenceLinks }) --- ##### `referenceLinks`^Required ```java public java.util.List getReferenceLinks(); ``` - *Type:* java.util.List<Reference> Gets list of {@link Reference} links (edges) where this node is the **source**. --- ##### `references`^Required ```java public java.util.List getReferences(); ``` - *Type:* java.util.List<Node> Get list of **Nodes** that *this node references*. > [{@link Node.referenceLinks }]({@link Node.referenceLinks }) --- ##### `reverseDependencyLinks`^Required ```java public java.util.List getReverseDependencyLinks(); ``` - *Type:* java.util.List<Dependency> Gets list of {@link Dependency} links (edges) where this node is the **target**. --- ##### `reverseLinks`^Required ```java public java.util.List getReverseLinks(); ``` - *Type:* java.util.List<Edge> Gets all links (edges) in which this node is the **target**. --- ##### `reverseReferenceLinks`^Required ```java public java.util.List getReverseReferenceLinks(); ``` - *Type:* java.util.List<Reference> Gets list of {@link Reference} links (edges) where this node is the **target**. --- ##### `scopes`^Required ```java public java.util.List getScopes(); ``` - *Type:* java.util.List<Node> Gets descending ordered list of ancestors from the root. --- ##### `siblings`^Required ```java public java.util.List getSiblings(); ``` - *Type:* java.util.List<Node> Get list of *siblings* of this node. --- ##### `cfnProps`^Optional ```java public PlainObject getCfnProps(); ``` - *Type:* PlainObject Gets CloudFormation properties for this node. --- ##### `cfnType`^Optional ```java public java.lang.String getCfnType(); ``` - *Type:* java.lang.String Get the CloudFormation resource type for this node. --- ##### `constructInfo`^Optional ```java public ConstructInfo getConstructInfo(); ``` - *Type:* ConstructInfo Synthesized construct information defining jii resolution data. --- ##### `constructInfoFqn`^Optional ```java public java.lang.String getConstructInfoFqn(); ``` - *Type:* java.lang.String Synthesized construct information defining jii resolution data. --- ##### `logicalId`^Optional ```java public java.lang.String getLogicalId(); ``` - *Type:* java.lang.String Logical id of the node, which is only unique within containing stack. --- ##### `parent`^Optional ```java public Node getParent(); ``` - *Type:* Node Parent node. Only the root node should not have parent. --- ##### `rootStack`^Optional ```java public StackNode getRootStack(); ``` - *Type:* StackNode Get **root** stack. --- ##### `stack`^Optional ```java public StackNode getStack(); ``` - *Type:* StackNode Stack the node is contained in. --- ##### `isStackReference`^Required ```java public java.lang.Boolean getIsStackReference(); ``` - *Type:* java.lang.Boolean Indicates if parameter is a reference to a stack. --- ##### `parameterType`^Required ```java public java.lang.Object getParameterType(); ``` - *Type:* java.lang.Object Get the parameter type attribute. --- ##### `value`^Required ```java public java.lang.Object getValue(); ``` - *Type:* java.lang.Object Get the value attribute. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ATTR_TYPE | java.lang.String | Attribute key where parameter type is stored. | | ATTR_VALUE | java.lang.String | Attribute key where parameter value is store. | --- ##### `ATTR_TYPE`^Required ```java public java.lang.String getAttrType(); ``` - *Type:* java.lang.String Attribute key where parameter type is stored. --- ##### `ATTR_VALUE`^Required ```java public java.lang.String getAttrValue(); ``` - *Type:* java.lang.String Attribute key where parameter value is store. --- ### Reference Reference edge class defines a directed relationship between nodes. #### Initializers ```java import software.aws.awsprototypingsdk.cdkgraph.Reference; new Reference(IReferenceProps props); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | IReferenceProps | *No description.* | --- ##### `props`^Required - *Type:* IReferenceProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAttribute | Add attribute. | | addFlag | Add flag. | | addMetadata | Add metadata entry. | | addTag | Add tag. | | applyData | Applies data (attributes, metadata, tags, flag) to entity. | | findMetadata | Retrieves all metadata entries of a given type. | | getAttribute | Get attribute by key. | | getTag | Get tag by key. | | hasAttribute | Indicates if entity has a given attribute defined, and optionally with a specific value. | | hasFlag | Indicates if entity has a given flag. | | hasMetadata | Indicates if entity has matching metadata entry. | | hasTag | Indicates if entity has tag, optionally verifying tag value. | | mutateDestroy | Destroy the edge. | | setAttribute | Set attribute. | | setTag | Set tag. | | isEquivalent | Indicates if this edge is equivalent to another edge. | | mutateConsume | Merge an equivalent edge's data into this edge and destroy the other edge. | | mutateDirection | Change the edge **direction**. | | mutateSource | Change the edge **source**. | | mutateTarget | Change the edge **target**. | | toString | Get string representation of this edge. | | resolveChain | Resolve reference chain. | | resolveTargets | Resolve targets by following potential edge chain. | --- ##### `addAttribute` ```java public void addAttribute(java.lang.String key, java.lang.Object value) ``` Add attribute. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.Object --- ##### `addFlag` ```java public void addFlag(FlagEnum flag) ``` Add flag. ###### `flag`^Required - *Type:* FlagEnum --- ##### `addMetadata` ```java public void addMetadata(java.lang.String metadataType, java.lang.Object data) ``` Add metadata entry. ###### `metadataType`^Required - *Type:* java.lang.String --- ###### `data`^Required - *Type:* java.lang.Object --- ##### `addTag` ```java public void addTag(java.lang.String key, java.lang.String value) ``` Add tag. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.String --- ##### `applyData` ```java public void applyData(IBaseEntityDataProps data) public void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite) public void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite, java.lang.Boolean applyFlags) ``` Applies data (attributes, metadata, tags, flag) to entity. Generally used only for mutations such as collapse and consume to retain data. ###### `data`^Required - *Type:* IBaseEntityDataProps The data to apply. --- ###### `overwrite`^Optional - *Type:* java.lang.Boolean --- ###### `applyFlags`^Optional - *Type:* java.lang.Boolean Indicates if data is overwritten - Indicates if flags should be applied. --- ##### `findMetadata` ```java public java.util.List findMetadata(java.lang.String metadataType) ``` Retrieves all metadata entries of a given type. ###### `metadataType`^Required - *Type:* java.lang.String --- ##### `getAttribute` ```java public java.lang.Object getAttribute(java.lang.String key) ``` Get attribute by key. ###### `key`^Required - *Type:* java.lang.String --- ##### `getTag` ```java public java.lang.String getTag(java.lang.String key) ``` Get tag by key. ###### `key`^Required - *Type:* java.lang.String --- ##### `hasAttribute` ```java public java.lang.Boolean hasAttribute(java.lang.String key) public java.lang.Boolean hasAttribute(java.lang.String key, java.lang.Object value) ``` Indicates if entity has a given attribute defined, and optionally with a specific value. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Optional - *Type:* java.lang.Object --- ##### `hasFlag` ```java public java.lang.Boolean hasFlag(FlagEnum flag) ``` Indicates if entity has a given flag. ###### `flag`^Required - *Type:* FlagEnum --- ##### `hasMetadata` ```java public java.lang.Boolean hasMetadata(java.lang.String metadataType, java.lang.Object data) ``` Indicates if entity has matching metadata entry. ###### `metadataType`^Required - *Type:* java.lang.String --- ###### `data`^Required - *Type:* java.lang.Object --- ##### `hasTag` ```java public java.lang.Boolean hasTag(java.lang.String key) public java.lang.Boolean hasTag(java.lang.String key, java.lang.String value) ``` Indicates if entity has tag, optionally verifying tag value. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Optional - *Type:* java.lang.String --- ##### `mutateDestroy` ```java public void mutateDestroy() public void mutateDestroy(java.lang.Boolean _strict) ``` Destroy the edge. Remove all references and remove from store. ###### `_strict`^Optional - *Type:* java.lang.Boolean --- ##### `setAttribute` ```java public void setAttribute(java.lang.String key, java.lang.Object value) ``` Set attribute. This will overwrite existing attribute. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.Object --- ##### `setTag` ```java public void setTag(java.lang.String key, java.lang.String value) ``` Set tag. Will overwrite existing tag. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.String --- ##### `isEquivalent` ```java public java.lang.Boolean isEquivalent(Edge edge) ``` Indicates if this edge is equivalent to another edge. Edges are considered equivalent if they share same type, source, and target. ###### `edge`^Required - *Type:* Edge --- ##### `mutateConsume` ```java public void mutateConsume(Edge edge) ``` Merge an equivalent edge's data into this edge and destroy the other edge. Used during filtering operations to consolidate equivalent edges. ###### `edge`^Required - *Type:* Edge The edge to consume. --- ##### `mutateDirection` ```java public void mutateDirection(EdgeDirectionEnum direction) ``` Change the edge **direction**. ###### `direction`^Required - *Type:* EdgeDirectionEnum --- ##### `mutateSource` ```java public void mutateSource(Node node) ``` Change the edge **source**. ###### `node`^Required - *Type:* Node --- ##### `mutateTarget` ```java public void mutateTarget(Node node) ``` Change the edge **target**. ###### `node`^Required - *Type:* Node --- ##### `toString` ```java public java.lang.String toString() ``` Get string representation of this edge. ##### `resolveChain` ```java public java.util.List resolveChain() ``` Resolve reference chain. ##### `resolveTargets` ```java public java.util.List resolveTargets() ``` Resolve targets by following potential edge chain. > [{@link EdgeChain }]({@link EdgeChain }) #### Static Functions | **Name** | **Description** | | --- | --- | | findAllInChain | Find all matching edges based on predicate within an EdgeChain. | | findInChain | Find first edge matching predicate within an EdgeChain. | | isRef | Indicates if edge is a **Ref** based {@link Reference} edge. | | isReference | Indicates if edge is a {@link Reference}. | --- ##### `findAllInChain` ```java import software.aws.awsprototypingsdk.cdkgraph.Reference; Reference.findAllInChain(java.util.List chain, IEdgePredicate predicate) ``` Find all matching edges based on predicate within an EdgeChain. ###### `chain`^Required - *Type:* java.util.List --- ###### `predicate`^Required - *Type:* IEdgePredicate --- ##### `findInChain` ```java import software.aws.awsprototypingsdk.cdkgraph.Reference; Reference.findInChain(java.util.List chain, IEdgePredicate predicate) ``` Find first edge matching predicate within an EdgeChain. ###### `chain`^Required - *Type:* java.util.List --- ###### `predicate`^Required - *Type:* IEdgePredicate --- ##### `isRef` ```java import software.aws.awsprototypingsdk.cdkgraph.Reference; Reference.isRef(Edge edge) ``` Indicates if edge is a **Ref** based {@link Reference} edge. ###### `edge`^Required - *Type:* Edge --- ##### `isReference` ```java import software.aws.awsprototypingsdk.cdkgraph.Reference; Reference.isReference(Edge edge) ``` Indicates if edge is a {@link Reference}. ###### `edge`^Required - *Type:* Edge --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | attributes | java.util.MapPlainObject OR java.util.ListPlainObject>> | Get *readonly* record of all attributes. | | flags | java.util.List<FlagEnum> | Get *readonly* list of all flags. | | isDestroyed | java.lang.Boolean | Indicates if the entity has been destroyed (eg: removed from store). | | isMutated | java.lang.Boolean | Indicates if the entity has had destructive mutations applied. | | metadata | java.util.List | Get *readonly* list of all metadata entries. | | store | Store | Reference to the store. | | tags | java.util.Map | Get *readonly* record of all tags. | | uuid | java.lang.String | Universally unique identifier. | | allowDestructiveMutations | java.lang.Boolean | Indicates if edge allows destructive mutations. | | direction | EdgeDirectionEnum | Indicates the direction in which the edge is directed. | | edgeType | EdgeTypeEnum | Type of edge. | | isClosed | java.lang.Boolean | Indicates if the Edge's **source** and **target** are the same, or were the same when it was created (prior to mutations). | | isCrossStack | java.lang.Boolean | Indicates if **source** and **target** nodes reside in different *root* stacks. | | isExtraneous | java.lang.Boolean | Indicates if edge is extraneous which is determined by explicitly having *EXTRANEOUS* flag added and/or being a closed loop (source===target). | | source | Node | Edge **source** is the node that defines the edge (tail). | | target | Node | Edge **target** is the node being referenced by the **source** (head). | | referenceType | ReferenceTypeEnum | Get type of reference. | --- ##### `attributes`^Required ```java public java.lang.Object getAttributes(); ``` - *Type:* java.util.MapPlainObject OR java.util.ListPlainObject>> Get *readonly* record of all attributes. --- ##### `flags`^Required ```java public java.util.List getFlags(); ``` - *Type:* java.util.List<FlagEnum> Get *readonly* list of all flags. --- ##### `isDestroyed`^Required ```java public java.lang.Boolean getIsDestroyed(); ``` - *Type:* java.lang.Boolean Indicates if the entity has been destroyed (eg: removed from store). --- ##### `isMutated`^Required ```java public java.lang.Boolean getIsMutated(); ``` - *Type:* java.lang.Boolean Indicates if the entity has had destructive mutations applied. --- ##### `metadata`^Required ```java public java.util.List getMetadata(); ``` - *Type:* java.util.List Get *readonly* list of all metadata entries. --- ##### `store`^Required ```java public Store getStore(); ``` - *Type:* Store Reference to the store. --- ##### `tags`^Required ```java public java.util.Map getTags(); ``` - *Type:* java.util.Map Get *readonly* record of all tags. --- ##### `uuid`^Required ```java public java.lang.String getUuid(); ``` - *Type:* java.lang.String Universally unique identifier. --- ##### `allowDestructiveMutations`^Required ```java public java.lang.Boolean getAllowDestructiveMutations(); ``` - *Type:* java.lang.Boolean Indicates if edge allows destructive mutations. --- ##### `direction`^Required ```java public EdgeDirectionEnum getDirection(); ``` - *Type:* EdgeDirectionEnum Indicates the direction in which the edge is directed. --- ##### `edgeType`^Required ```java public EdgeTypeEnum getEdgeType(); ``` - *Type:* EdgeTypeEnum Type of edge. --- ##### `isClosed`^Required ```java public java.lang.Boolean getIsClosed(); ``` - *Type:* java.lang.Boolean Indicates if the Edge's **source** and **target** are the same, or were the same when it was created (prior to mutations). To check whether it was originally closed, use `hasFlag(FlagEnum.CLOSED_EDGE)` instead. --- ##### `isCrossStack`^Required ```java public java.lang.Boolean getIsCrossStack(); ``` - *Type:* java.lang.Boolean Indicates if **source** and **target** nodes reside in different *root* stacks. --- ##### `isExtraneous`^Required ```java public java.lang.Boolean getIsExtraneous(); ``` - *Type:* java.lang.Boolean Indicates if edge is extraneous which is determined by explicitly having *EXTRANEOUS* flag added and/or being a closed loop (source===target). --- ##### `source`^Required ```java public Node getSource(); ``` - *Type:* Node Edge **source** is the node that defines the edge (tail). --- ##### `target`^Required ```java public Node getTarget(); ``` - *Type:* Node Edge **target** is the node being referenced by the **source** (head). --- ##### `referenceType`^Required ```java public ReferenceTypeEnum getReferenceType(); ``` - *Type:* ReferenceTypeEnum Get type of reference. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ATT_TYPE | java.lang.String | Attribute defining the type of reference. | | PREFIX | java.lang.String | Edge prefix to denote **Ref** type reference edge. | --- ##### `ATT_TYPE`^Required ```java public java.lang.String getAttType(); ``` - *Type:* java.lang.String Attribute defining the type of reference. --- ##### `PREFIX`^Required ```java public java.lang.String getPrefix(); ``` - *Type:* java.lang.String Edge prefix to denote **Ref** type reference edge. --- ### ResourceNode ResourceNode class defines a L2 cdk resource construct. #### Initializers ```java import software.aws.awsprototypingsdk.cdkgraph.ResourceNode; new ResourceNode(IResourceNodeProps props); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | IResourceNodeProps | *No description.* | --- ##### `props`^Required - *Type:* IResourceNodeProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAttribute | Add attribute. | | addFlag | Add flag. | | addMetadata | Add metadata entry. | | addTag | Add tag. | | applyData | Applies data (attributes, metadata, tags, flag) to entity. | | findMetadata | Retrieves all metadata entries of a given type. | | getAttribute | Get attribute by key. | | getTag | Get tag by key. | | hasAttribute | Indicates if entity has a given attribute defined, and optionally with a specific value. | | hasFlag | Indicates if entity has a given flag. | | hasMetadata | Indicates if entity has matching metadata entry. | | hasTag | Indicates if entity has tag, optionally verifying tag value. | | mutateDestroy | Destroys this node by removing all references and removing this node from the store. | | setAttribute | Set attribute. | | setTag | Set tag. | | addChild | Add *child* node. | | addLink | Add *link* to another node. | | addReverseLink | Add *link* from another node. | | doesDependOn | Indicates if *this node* depends on *another node*. | | doesReference | Indicates if *this node* references *another node*. | | find | Recursively find the nearest sub-node matching predicate. | | findAll | Return this construct and all of its sub-nodes in the given order. | | findAllLinks | Return all direct links of this node and that of all sub-nodes. | | findAncestor | Find nearest *ancestor* of *this node* matching given predicate. | | findChild | Find child with given *id*. | | findLink | Find link of this node based on predicate. | | findLinks | Find all links of this node based on predicate. | | getCfnProp | Get specific CloudFormation property. | | getChild | Get *child* node with given *id*. | | getLinkChains | Resolve all link chains. | | getNearestAncestor | Gets the nearest **common** *ancestor* shared between *this node* and another *node*. | | isAncestor | Indicates if a specific *node* is an *ancestor* of *this node*. | | isChild | Indicates if specific *node* is a *child* of *this node*. | | mutateCollapse | Collapses all sub-nodes of *this node* into *this node*. | | mutateCollapseTo | Collapses *this node* into *an ancestor*. | | mutateCollapseToParent | Collapses *this node* into *it's parent node*. | | mutateHoist | Hoist *this node* to an *ancestor* by removing it from its current parent node and in turn moving it to the ancestor. | | mutateMove | Move this node into a new parent node. | | mutateRemoveChild | Remove a *child* node from *this node*. | | mutateRemoveLink | Remove a *link* from *this node*. | | mutateRemoveReverseLink | Remove a *link* to *this node*. | | mutateUncluster | Hoist all children to parent and collapse node to parent. | | toString | Get string representation of this node. | | mutateCfnResource | Modifies the L1 resource wrapped by this L2 resource. | --- ##### `addAttribute` ```java public void addAttribute(java.lang.String key, java.lang.Object value) ``` Add attribute. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.Object --- ##### `addFlag` ```java public void addFlag(FlagEnum flag) ``` Add flag. ###### `flag`^Required - *Type:* FlagEnum --- ##### `addMetadata` ```java public void addMetadata(java.lang.String metadataType, java.lang.Object data) ``` Add metadata entry. ###### `metadataType`^Required - *Type:* java.lang.String --- ###### `data`^Required - *Type:* java.lang.Object --- ##### `addTag` ```java public void addTag(java.lang.String key, java.lang.String value) ``` Add tag. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.String --- ##### `applyData` ```java public void applyData(IBaseEntityDataProps data) public void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite) public void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite, java.lang.Boolean applyFlags) ``` Applies data (attributes, metadata, tags, flag) to entity. Generally used only for mutations such as collapse and consume to retain data. ###### `data`^Required - *Type:* IBaseEntityDataProps The data to apply. --- ###### `overwrite`^Optional - *Type:* java.lang.Boolean --- ###### `applyFlags`^Optional - *Type:* java.lang.Boolean Indicates if data is overwritten - Indicates if flags should be applied. --- ##### `findMetadata` ```java public java.util.List findMetadata(java.lang.String metadataType) ``` Retrieves all metadata entries of a given type. ###### `metadataType`^Required - *Type:* java.lang.String --- ##### `getAttribute` ```java public java.lang.Object getAttribute(java.lang.String key) ``` Get attribute by key. ###### `key`^Required - *Type:* java.lang.String --- ##### `getTag` ```java public java.lang.String getTag(java.lang.String key) ``` Get tag by key. ###### `key`^Required - *Type:* java.lang.String --- ##### `hasAttribute` ```java public java.lang.Boolean hasAttribute(java.lang.String key) public java.lang.Boolean hasAttribute(java.lang.String key, java.lang.Object value) ``` Indicates if entity has a given attribute defined, and optionally with a specific value. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Optional - *Type:* java.lang.Object --- ##### `hasFlag` ```java public java.lang.Boolean hasFlag(FlagEnum flag) ``` Indicates if entity has a given flag. ###### `flag`^Required - *Type:* FlagEnum --- ##### `hasMetadata` ```java public java.lang.Boolean hasMetadata(java.lang.String metadataType, java.lang.Object data) ``` Indicates if entity has matching metadata entry. ###### `metadataType`^Required - *Type:* java.lang.String --- ###### `data`^Required - *Type:* java.lang.Object --- ##### `hasTag` ```java public java.lang.Boolean hasTag(java.lang.String key) public java.lang.Boolean hasTag(java.lang.String key, java.lang.String value) ``` Indicates if entity has tag, optionally verifying tag value. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Optional - *Type:* java.lang.String --- ##### `mutateDestroy` ```java public void mutateDestroy() public void mutateDestroy(java.lang.Boolean strict) ``` Destroys this node by removing all references and removing this node from the store. ###### `strict`^Optional - *Type:* java.lang.Boolean Indicates that this node must not have references. --- ##### `setAttribute` ```java public void setAttribute(java.lang.String key, java.lang.Object value) ``` Set attribute. This will overwrite existing attribute. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.Object --- ##### `setTag` ```java public void setTag(java.lang.String key, java.lang.String value) ``` Set tag. Will overwrite existing tag. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.String --- ##### `addChild` ```java public void addChild(Node node) ``` Add *child* node. ###### `node`^Required - *Type:* Node --- ##### `addLink` ```java public void addLink(Edge edge) ``` Add *link* to another node. ###### `edge`^Required - *Type:* Edge --- ##### `addReverseLink` ```java public void addReverseLink(Edge edge) ``` Add *link* from another node. ###### `edge`^Required - *Type:* Edge --- ##### `doesDependOn` ```java public java.lang.Boolean doesDependOn(Node node) ``` Indicates if *this node* depends on *another node*. ###### `node`^Required - *Type:* Node --- ##### `doesReference` ```java public java.lang.Boolean doesReference(Node node) ``` Indicates if *this node* references *another node*. ###### `node`^Required - *Type:* Node --- ##### `find` ```java public Node find(INodePredicate predicate) ``` Recursively find the nearest sub-node matching predicate. ###### `predicate`^Required - *Type:* INodePredicate --- ##### `findAll` ```java public java.util.List findAll() public java.util.List findAll(IFindNodeOptions options) ``` Return this construct and all of its sub-nodes in the given order. Optionally filter nodes based on predicate. ###### `options`^Optional - *Type:* IFindNodeOptions --- ##### `findAllLinks` ```java public java.util.List findAllLinks() public java.util.List findAllLinks(IFindEdgeOptions options) ``` Return all direct links of this node and that of all sub-nodes. Optionally filter links based on predicate. ###### `options`^Optional - *Type:* IFindEdgeOptions --- ##### `findAncestor` ```java public Node findAncestor(INodePredicate predicate) public Node findAncestor(INodePredicate predicate, java.lang.Number max) ``` Find nearest *ancestor* of *this node* matching given predicate. ###### `predicate`^Required - *Type:* INodePredicate Predicate to match ancestor. --- ###### `max`^Optional - *Type:* java.lang.Number --- ##### `findChild` ```java public Node findChild(java.lang.String id) ``` Find child with given *id*. Similar to `find` but does not throw error if no child found. ###### `id`^Required - *Type:* java.lang.String --- ##### `findLink` ```java public Edge findLink(IEdgePredicate predicate) public Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse) public Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow) public Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow, java.lang.Boolean direct) ``` Find link of this node based on predicate. By default this will follow link chains to evaluate the predicate against and return the matching direct link of this node. ###### `predicate`^Required - *Type:* IEdgePredicate Edge predicate function to match edge. --- ###### `reverse`^Optional - *Type:* java.lang.Boolean Indicates if links are search in reverse order. --- ###### `follow`^Optional - *Type:* java.lang.Boolean Indicates if link chain is followed. --- ###### `direct`^Optional - *Type:* java.lang.Boolean Indicates that only *direct* links should be searched. --- ##### `findLinks` ```java public java.util.List findLinks(IEdgePredicate predicate) public java.util.List findLinks(IEdgePredicate predicate, java.lang.Boolean reverse) public java.util.List findLinks(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow) public java.util.List findLinks(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow, java.lang.Boolean direct) ``` Find all links of this node based on predicate. By default this will follow link chains to evaluate the predicate against and return the matching direct links of this node. ###### `predicate`^Required - *Type:* IEdgePredicate Edge predicate function to match edge. --- ###### `reverse`^Optional - *Type:* java.lang.Boolean Indicates if links are search in reverse order. --- ###### `follow`^Optional - *Type:* java.lang.Boolean Indicates if link chain is followed. --- ###### `direct`^Optional - *Type:* java.lang.Boolean Indicates that only *direct* links should be searched. --- ##### `getCfnProp` ```java public java.lang.String OR java.lang.Number OR java.lang.Boolean OR PlainObject OR java.util.List getCfnProp(java.lang.String key) ``` Get specific CloudFormation property. ###### `key`^Required - *Type:* java.lang.String --- ##### `getChild` ```java public Node getChild(java.lang.String id) ``` Get *child* node with given *id*. ###### `id`^Required - *Type:* java.lang.String --- ##### `getLinkChains` ```java public java.util.List> getLinkChains() public java.util.List> getLinkChains(java.lang.Boolean reverse) ``` Resolve all link chains. > [{@link EdgeChain }]({@link EdgeChain }) ###### `reverse`^Optional - *Type:* java.lang.Boolean --- ##### `getNearestAncestor` ```java public Node getNearestAncestor(Node node) ``` Gets the nearest **common** *ancestor* shared between *this node* and another *node*. ###### `node`^Required - *Type:* Node --- ##### `isAncestor` ```java public java.lang.Boolean isAncestor(Node ancestor) ``` Indicates if a specific *node* is an *ancestor* of *this node*. ###### `ancestor`^Required - *Type:* Node --- ##### `isChild` ```java public java.lang.Boolean isChild(Node node) ``` Indicates if specific *node* is a *child* of *this node*. ###### `node`^Required - *Type:* Node --- ##### `mutateCollapse` ```java public void mutateCollapse() ``` Collapses all sub-nodes of *this node* into *this node*. ##### `mutateCollapseTo` ```java public Node mutateCollapseTo(Node ancestor) ``` Collapses *this node* into *an ancestor*. ###### `ancestor`^Required - *Type:* Node --- ##### `mutateCollapseToParent` ```java public Node mutateCollapseToParent() ``` Collapses *this node* into *it's parent node*. ##### `mutateHoist` ```java public void mutateHoist(Node newParent) ``` Hoist *this node* to an *ancestor* by removing it from its current parent node and in turn moving it to the ancestor. ###### `newParent`^Required - *Type:* Node --- ##### `mutateMove` ```java public void mutateMove(Node newParent) ``` Move this node into a new parent node. ###### `newParent`^Required - *Type:* Node The parent to move this node to. --- ##### `mutateRemoveChild` ```java public java.lang.Boolean mutateRemoveChild(Node node) ``` Remove a *child* node from *this node*. ###### `node`^Required - *Type:* Node --- ##### `mutateRemoveLink` ```java public java.lang.Boolean mutateRemoveLink(Edge link) ``` Remove a *link* from *this node*. ###### `link`^Required - *Type:* Edge --- ##### `mutateRemoveReverseLink` ```java public java.lang.Boolean mutateRemoveReverseLink(Edge link) ``` Remove a *link* to *this node*. ###### `link`^Required - *Type:* Edge --- ##### `mutateUncluster` ```java public void mutateUncluster() ``` Hoist all children to parent and collapse node to parent. ##### `toString` ```java public java.lang.String toString() ``` Get string representation of this node. ##### `mutateCfnResource` ```java public void mutateCfnResource() public void mutateCfnResource(CfnResourceNode cfnResource) ``` Modifies the L1 resource wrapped by this L2 resource. ###### `cfnResource`^Optional - *Type:* CfnResourceNode --- #### Static Functions | **Name** | **Description** | | --- | --- | | isResourceNode | Indicates if node is a {@link ResourceNode}. | --- ##### `isResourceNode` ```java import software.aws.awsprototypingsdk.cdkgraph.ResourceNode; ResourceNode.isResourceNode(Node node) ``` Indicates if node is a {@link ResourceNode}. ###### `node`^Required - *Type:* Node --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | attributes | java.util.MapPlainObject OR java.util.ListPlainObject>> | Get *readonly* record of all attributes. | | flags | java.util.List<FlagEnum> | Get *readonly* list of all flags. | | isDestroyed | java.lang.Boolean | Indicates if the entity has been destroyed (eg: removed from store). | | isMutated | java.lang.Boolean | Indicates if the entity has had destructive mutations applied. | | metadata | java.util.List | Get *readonly* list of all metadata entries. | | store | Store | Reference to the store. | | tags | java.util.Map | Get *readonly* record of all tags. | | uuid | java.lang.String | Universally unique identifier. | | allowDestructiveMutations | java.lang.Boolean | Indicates if this node allows destructive mutations. | | children | java.util.List<Node> | Get all direct child nodes. | | dependedOnBy | java.util.List<Node> | Get list of **Nodes** that *depend on this node*. | | dependencies | java.util.List<Node> | Get list of **Nodes** that *this node depends on*. | | dependencyLinks | java.util.List<Dependency> | Gets list of {@link Dependency} links (edges) where this node is the **source**. | | depth | java.lang.Number | Indicates the depth of the node relative to root (0). | | id | java.lang.String | Node id, which is only unique within parent scope. | | isAsset | java.lang.Boolean | Indicates if this node is considered a {@link FlagEnum.ASSET}. | | isCfnFqn | java.lang.Boolean | Indicates if node ConstructInfoFqn denotes a `aws-cdk-lib.*.Cfn*` construct. | | isCluster | java.lang.Boolean | Indicates if this node is considered a {@link FlagEnum.CLUSTER}. | | isCustomResource | java.lang.Boolean | Indicates if node is a *Custom Resource*. | | isExtraneous | java.lang.Boolean | Indicates if this node is considered a {@link FlagEnum.EXTRANEOUS} node or determined to be extraneous: - Clusters that contain no children. | | isGraphContainer | java.lang.Boolean | Indicates if this node is considered a {@link FlagEnum.GRAPH_CONTAINER}. | | isLeaf | java.lang.Boolean | Indicates if this node is a *leaf* node, which means it does not have children. | | isTopLevel | java.lang.Boolean | Indicates if node is direct child of the graph root node. | | links | java.util.List<Edge> | Gets all links (edges) in which this node is the **source**. | | nodeType | NodeTypeEnum | Type of node. | | path | java.lang.String | Path of the node. | | referencedBy | java.util.List<Node> | Get list of **Nodes** that *reference this node*. | | referenceLinks | java.util.List<Reference> | Gets list of {@link Reference} links (edges) where this node is the **source**. | | references | java.util.List<Node> | Get list of **Nodes** that *this node references*. | | reverseDependencyLinks | java.util.List<Dependency> | Gets list of {@link Dependency} links (edges) where this node is the **target**. | | reverseLinks | java.util.List<Edge> | Gets all links (edges) in which this node is the **target**. | | reverseReferenceLinks | java.util.List<Reference> | Gets list of {@link Reference} links (edges) where this node is the **target**. | | scopes | java.util.List<Node> | Gets descending ordered list of ancestors from the root. | | siblings | java.util.List<Node> | Get list of *siblings* of this node. | | cfnProps | PlainObject | Get the cfn properties from the L1 resource that this L2 resource wraps. | | cfnType | java.lang.String | Get the CloudFormation resource type for this L2 resource or for the L1 resource is wraps. | | constructInfo | ConstructInfo | Synthesized construct information defining jii resolution data. | | constructInfoFqn | java.lang.String | Synthesized construct information defining jii resolution data. | | logicalId | java.lang.String | Logical id of the node, which is only unique within containing stack. | | parent | Node | Parent node. | | rootStack | StackNode | Get **root** stack. | | stack | StackNode | Stack the node is contained in. | | isCdkOwned | java.lang.Boolean | Indicates if this resource is owned by cdk (defined in cdk library). | | isWrapper | java.lang.Boolean | Indicates if Resource wraps a single CfnResource. | | cfnResource | CfnResourceNode | Get the default/primary CfnResource that this Resource wraps. | --- ##### `attributes`^Required ```java public java.lang.Object getAttributes(); ``` - *Type:* java.util.MapPlainObject OR java.util.ListPlainObject>> Get *readonly* record of all attributes. --- ##### `flags`^Required ```java public java.util.List getFlags(); ``` - *Type:* java.util.List<FlagEnum> Get *readonly* list of all flags. --- ##### `isDestroyed`^Required ```java public java.lang.Boolean getIsDestroyed(); ``` - *Type:* java.lang.Boolean Indicates if the entity has been destroyed (eg: removed from store). --- ##### `isMutated`^Required ```java public java.lang.Boolean getIsMutated(); ``` - *Type:* java.lang.Boolean Indicates if the entity has had destructive mutations applied. --- ##### `metadata`^Required ```java public java.util.List getMetadata(); ``` - *Type:* java.util.List Get *readonly* list of all metadata entries. --- ##### `store`^Required ```java public Store getStore(); ``` - *Type:* Store Reference to the store. --- ##### `tags`^Required ```java public java.util.Map getTags(); ``` - *Type:* java.util.Map Get *readonly* record of all tags. --- ##### `uuid`^Required ```java public java.lang.String getUuid(); ``` - *Type:* java.lang.String Universally unique identifier. --- ##### `allowDestructiveMutations`^Required ```java public java.lang.Boolean getAllowDestructiveMutations(); ``` - *Type:* java.lang.Boolean Indicates if this node allows destructive mutations. > [{@link Store.allowDestructiveMutations }]({@link Store.allowDestructiveMutations }) --- ##### `children`^Required ```java public java.util.List getChildren(); ``` - *Type:* java.util.List<Node> Get all direct child nodes. --- ##### `dependedOnBy`^Required ```java public java.util.List getDependedOnBy(); ``` - *Type:* java.util.List<Node> Get list of **Nodes** that *depend on this node*. > [{@link Node.reverseDependencyLinks }]({@link Node.reverseDependencyLinks }) --- ##### `dependencies`^Required ```java public java.util.List getDependencies(); ``` - *Type:* java.util.List<Node> Get list of **Nodes** that *this node depends on*. > [{@link Node.dependencyLinks }]({@link Node.dependencyLinks }) --- ##### `dependencyLinks`^Required ```java public java.util.List getDependencyLinks(); ``` - *Type:* java.util.List<Dependency> Gets list of {@link Dependency} links (edges) where this node is the **source**. --- ##### `depth`^Required ```java public java.lang.Number getDepth(); ``` - *Type:* java.lang.Number Indicates the depth of the node relative to root (0). --- ##### `id`^Required ```java public java.lang.String getId(); ``` - *Type:* java.lang.String Node id, which is only unique within parent scope. --- ##### `isAsset`^Required ```java public java.lang.Boolean getIsAsset(); ``` - *Type:* java.lang.Boolean Indicates if this node is considered a {@link FlagEnum.ASSET}. --- ##### `isCfnFqn`^Required ```java public java.lang.Boolean getIsCfnFqn(); ``` - *Type:* java.lang.Boolean Indicates if node ConstructInfoFqn denotes a `aws-cdk-lib.*.Cfn*` construct. > [{@link FlagEnum.CFN_FQN }]({@link FlagEnum.CFN_FQN }) --- ##### `isCluster`^Required ```java public java.lang.Boolean getIsCluster(); ``` - *Type:* java.lang.Boolean Indicates if this node is considered a {@link FlagEnum.CLUSTER}. --- ##### `isCustomResource`^Required ```java public java.lang.Boolean getIsCustomResource(); ``` - *Type:* java.lang.Boolean Indicates if node is a *Custom Resource*. --- ##### `isExtraneous`^Required ```java public java.lang.Boolean getIsExtraneous(); ``` - *Type:* java.lang.Boolean Indicates if this node is considered a {@link FlagEnum.EXTRANEOUS} node or determined to be extraneous: - Clusters that contain no children. --- ##### `isGraphContainer`^Required ```java public java.lang.Boolean getIsGraphContainer(); ``` - *Type:* java.lang.Boolean Indicates if this node is considered a {@link FlagEnum.GRAPH_CONTAINER}. --- ##### `isLeaf`^Required ```java public java.lang.Boolean getIsLeaf(); ``` - *Type:* java.lang.Boolean Indicates if this node is a *leaf* node, which means it does not have children. --- ##### `isTopLevel`^Required ```java public java.lang.Boolean getIsTopLevel(); ``` - *Type:* java.lang.Boolean Indicates if node is direct child of the graph root node. --- ##### `links`^Required ```java public java.util.List getLinks(); ``` - *Type:* java.util.List<Edge> Gets all links (edges) in which this node is the **source**. --- ##### `nodeType`^Required ```java public NodeTypeEnum getNodeType(); ``` - *Type:* NodeTypeEnum Type of node. --- ##### `path`^Required ```java public java.lang.String getPath(); ``` - *Type:* java.lang.String Path of the node. --- ##### `referencedBy`^Required ```java public java.util.List getReferencedBy(); ``` - *Type:* java.util.List<Node> Get list of **Nodes** that *reference this node*. > [{@link Node.reverseReferenceLinks }]({@link Node.reverseReferenceLinks }) --- ##### `referenceLinks`^Required ```java public java.util.List getReferenceLinks(); ``` - *Type:* java.util.List<Reference> Gets list of {@link Reference} links (edges) where this node is the **source**. --- ##### `references`^Required ```java public java.util.List getReferences(); ``` - *Type:* java.util.List<Node> Get list of **Nodes** that *this node references*. > [{@link Node.referenceLinks }]({@link Node.referenceLinks }) --- ##### `reverseDependencyLinks`^Required ```java public java.util.List getReverseDependencyLinks(); ``` - *Type:* java.util.List<Dependency> Gets list of {@link Dependency} links (edges) where this node is the **target**. --- ##### `reverseLinks`^Required ```java public java.util.List getReverseLinks(); ``` - *Type:* java.util.List<Edge> Gets all links (edges) in which this node is the **target**. --- ##### `reverseReferenceLinks`^Required ```java public java.util.List getReverseReferenceLinks(); ``` - *Type:* java.util.List<Reference> Gets list of {@link Reference} links (edges) where this node is the **target**. --- ##### `scopes`^Required ```java public java.util.List getScopes(); ``` - *Type:* java.util.List<Node> Gets descending ordered list of ancestors from the root. --- ##### `siblings`^Required ```java public java.util.List getSiblings(); ``` - *Type:* java.util.List<Node> Get list of *siblings* of this node. --- ##### `cfnProps`^Optional ```java public PlainObject getCfnProps(); ``` - *Type:* PlainObject Get the cfn properties from the L1 resource that this L2 resource wraps. --- ##### `cfnType`^Optional ```java public java.lang.String getCfnType(); ``` - *Type:* java.lang.String Get the CloudFormation resource type for this L2 resource or for the L1 resource is wraps. --- ##### `constructInfo`^Optional ```java public ConstructInfo getConstructInfo(); ``` - *Type:* ConstructInfo Synthesized construct information defining jii resolution data. --- ##### `constructInfoFqn`^Optional ```java public java.lang.String getConstructInfoFqn(); ``` - *Type:* java.lang.String Synthesized construct information defining jii resolution data. --- ##### `logicalId`^Optional ```java public java.lang.String getLogicalId(); ``` - *Type:* java.lang.String Logical id of the node, which is only unique within containing stack. --- ##### `parent`^Optional ```java public Node getParent(); ``` - *Type:* Node Parent node. Only the root node should not have parent. --- ##### `rootStack`^Optional ```java public StackNode getRootStack(); ``` - *Type:* StackNode Get **root** stack. --- ##### `stack`^Optional ```java public StackNode getStack(); ``` - *Type:* StackNode Stack the node is contained in. --- ##### `isCdkOwned`^Required ```java public java.lang.Boolean getIsCdkOwned(); ``` - *Type:* java.lang.Boolean Indicates if this resource is owned by cdk (defined in cdk library). --- ##### `isWrapper`^Required ```java public java.lang.Boolean getIsWrapper(); ``` - *Type:* java.lang.Boolean Indicates if Resource wraps a single CfnResource. --- ##### `cfnResource`^Optional ```java public CfnResourceNode getCfnResource(); ``` - *Type:* CfnResourceNode Get the default/primary CfnResource that this Resource wraps. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ATT_WRAPPED_CFN_PROPS | java.lang.String | Attribute key for cfn properties. | | ATT_WRAPPED_CFN_TYPE | java.lang.String | Attribute key for cfn resource type. | --- ##### `ATT_WRAPPED_CFN_PROPS`^Required ```java public java.lang.String getAttWrappedCfnProps(); ``` - *Type:* java.lang.String Attribute key for cfn properties. --- ##### `ATT_WRAPPED_CFN_TYPE`^Required ```java public java.lang.String getAttWrappedCfnType(); ``` - *Type:* java.lang.String Attribute key for cfn resource type. --- ### RootNode RootNode represents the root of the store tree. #### Initializers ```java import software.aws.awsprototypingsdk.cdkgraph.RootNode; new RootNode(Store store); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | store | Store | Reference to the store. | --- ##### `store`^Required - *Type:* Store Reference to the store. --- #### Methods | **Name** | **Description** | | --- | --- | | addAttribute | Add attribute. | | addFlag | Add flag. | | addMetadata | Add metadata entry. | | addTag | Add tag. | | applyData | Applies data (attributes, metadata, tags, flag) to entity. | | findMetadata | Retrieves all metadata entries of a given type. | | getAttribute | Get attribute by key. | | getTag | Get tag by key. | | hasAttribute | Indicates if entity has a given attribute defined, and optionally with a specific value. | | hasFlag | Indicates if entity has a given flag. | | hasMetadata | Indicates if entity has matching metadata entry. | | hasTag | Indicates if entity has tag, optionally verifying tag value. | | mutateDestroy | Destroys this node by removing all references and removing this node from the store. | | setAttribute | Set attribute. | | setTag | Set tag. | | addChild | Add *child* node. | | addLink | Add *link* to another node. | | addReverseLink | Add *link* from another node. | | doesDependOn | Indicates if *this node* depends on *another node*. | | doesReference | Indicates if *this node* references *another node*. | | find | Recursively find the nearest sub-node matching predicate. | | findAll | Return this construct and all of its sub-nodes in the given order. | | findAllLinks | Return all direct links of this node and that of all sub-nodes. | | findAncestor | Find nearest *ancestor* of *this node* matching given predicate. | | findChild | Find child with given *id*. | | findLink | Find link of this node based on predicate. | | findLinks | Find all links of this node based on predicate. | | getCfnProp | Get specific CloudFormation property. | | getChild | Get *child* node with given *id*. | | getLinkChains | Resolve all link chains. | | getNearestAncestor | Gets the nearest **common** *ancestor* shared between *this node* and another *node*. | | isAncestor | Indicates if a specific *node* is an *ancestor* of *this node*. | | isChild | Indicates if specific *node* is a *child* of *this node*. | | mutateCollapse | Collapses all sub-nodes of *this node* into *this node*. | | mutateCollapseTo | Collapses *this node* into *an ancestor* > {@link RootNode} does not support this mutation. | | mutateCollapseToParent | Collapses *this node* into *it's parent node* > {@link RootNode} does not support this mutation. | | mutateHoist | Hoist *this node* to an *ancestor* by removing it from its current parent node and in turn moving it to the ancestor. | | mutateMove | Move this node into a new parent node. | | mutateRemoveChild | Remove a *child* node from *this node*. | | mutateRemoveLink | Remove a *link* from *this node*. | | mutateRemoveReverseLink | Remove a *link* to *this node*. | | mutateUncluster | Hoist all children to parent and collapse node to parent. | | toString | Get string representation of this node. | --- ##### `addAttribute` ```java public void addAttribute(java.lang.String key, java.lang.Object value) ``` Add attribute. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.Object --- ##### `addFlag` ```java public void addFlag(FlagEnum flag) ``` Add flag. ###### `flag`^Required - *Type:* FlagEnum --- ##### `addMetadata` ```java public void addMetadata(java.lang.String metadataType, java.lang.Object data) ``` Add metadata entry. ###### `metadataType`^Required - *Type:* java.lang.String --- ###### `data`^Required - *Type:* java.lang.Object --- ##### `addTag` ```java public void addTag(java.lang.String key, java.lang.String value) ``` Add tag. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.String --- ##### `applyData` ```java public void applyData(IBaseEntityDataProps data) public void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite) public void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite, java.lang.Boolean applyFlags) ``` Applies data (attributes, metadata, tags, flag) to entity. Generally used only for mutations such as collapse and consume to retain data. ###### `data`^Required - *Type:* IBaseEntityDataProps The data to apply. --- ###### `overwrite`^Optional - *Type:* java.lang.Boolean --- ###### `applyFlags`^Optional - *Type:* java.lang.Boolean Indicates if data is overwritten - Indicates if flags should be applied. --- ##### `findMetadata` ```java public java.util.List findMetadata(java.lang.String metadataType) ``` Retrieves all metadata entries of a given type. ###### `metadataType`^Required - *Type:* java.lang.String --- ##### `getAttribute` ```java public java.lang.Object getAttribute(java.lang.String key) ``` Get attribute by key. ###### `key`^Required - *Type:* java.lang.String --- ##### `getTag` ```java public java.lang.String getTag(java.lang.String key) ``` Get tag by key. ###### `key`^Required - *Type:* java.lang.String --- ##### `hasAttribute` ```java public java.lang.Boolean hasAttribute(java.lang.String key) public java.lang.Boolean hasAttribute(java.lang.String key, java.lang.Object value) ``` Indicates if entity has a given attribute defined, and optionally with a specific value. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Optional - *Type:* java.lang.Object --- ##### `hasFlag` ```java public java.lang.Boolean hasFlag(FlagEnum flag) ``` Indicates if entity has a given flag. ###### `flag`^Required - *Type:* FlagEnum --- ##### `hasMetadata` ```java public java.lang.Boolean hasMetadata(java.lang.String metadataType, java.lang.Object data) ``` Indicates if entity has matching metadata entry. ###### `metadataType`^Required - *Type:* java.lang.String --- ###### `data`^Required - *Type:* java.lang.Object --- ##### `hasTag` ```java public java.lang.Boolean hasTag(java.lang.String key) public java.lang.Boolean hasTag(java.lang.String key, java.lang.String value) ``` Indicates if entity has tag, optionally verifying tag value. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Optional - *Type:* java.lang.String --- ##### `mutateDestroy` ```java public void mutateDestroy() public void mutateDestroy(java.lang.Boolean _strict) ``` Destroys this node by removing all references and removing this node from the store. > {@link RootNode} does not support this mutation ###### `_strict`^Optional - *Type:* java.lang.Boolean --- ##### `setAttribute` ```java public void setAttribute(java.lang.String key, java.lang.Object value) ``` Set attribute. This will overwrite existing attribute. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.Object --- ##### `setTag` ```java public void setTag(java.lang.String key, java.lang.String value) ``` Set tag. Will overwrite existing tag. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.String --- ##### `addChild` ```java public void addChild(Node node) ``` Add *child* node. ###### `node`^Required - *Type:* Node --- ##### `addLink` ```java public void addLink(Edge edge) ``` Add *link* to another node. ###### `edge`^Required - *Type:* Edge --- ##### `addReverseLink` ```java public void addReverseLink(Edge edge) ``` Add *link* from another node. ###### `edge`^Required - *Type:* Edge --- ##### `doesDependOn` ```java public java.lang.Boolean doesDependOn(Node node) ``` Indicates if *this node* depends on *another node*. ###### `node`^Required - *Type:* Node --- ##### `doesReference` ```java public java.lang.Boolean doesReference(Node node) ``` Indicates if *this node* references *another node*. ###### `node`^Required - *Type:* Node --- ##### `find` ```java public Node find(INodePredicate predicate) ``` Recursively find the nearest sub-node matching predicate. ###### `predicate`^Required - *Type:* INodePredicate --- ##### `findAll` ```java public java.util.List findAll() public java.util.List findAll(IFindNodeOptions options) ``` Return this construct and all of its sub-nodes in the given order. Optionally filter nodes based on predicate. **The root not is excluded from list** ###### `options`^Optional - *Type:* IFindNodeOptions --- ##### `findAllLinks` ```java public java.util.List findAllLinks() public java.util.List findAllLinks(IFindEdgeOptions options) ``` Return all direct links of this node and that of all sub-nodes. Optionally filter links based on predicate. ###### `options`^Optional - *Type:* IFindEdgeOptions --- ##### `findAncestor` ```java public Node findAncestor(INodePredicate predicate) public Node findAncestor(INodePredicate predicate, java.lang.Number max) ``` Find nearest *ancestor* of *this node* matching given predicate. ###### `predicate`^Required - *Type:* INodePredicate Predicate to match ancestor. --- ###### `max`^Optional - *Type:* java.lang.Number --- ##### `findChild` ```java public Node findChild(java.lang.String id) ``` Find child with given *id*. Similar to `find` but does not throw error if no child found. ###### `id`^Required - *Type:* java.lang.String --- ##### `findLink` ```java public Edge findLink(IEdgePredicate predicate) public Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse) public Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow) public Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow, java.lang.Boolean direct) ``` Find link of this node based on predicate. By default this will follow link chains to evaluate the predicate against and return the matching direct link of this node. ###### `predicate`^Required - *Type:* IEdgePredicate Edge predicate function to match edge. --- ###### `reverse`^Optional - *Type:* java.lang.Boolean Indicates if links are search in reverse order. --- ###### `follow`^Optional - *Type:* java.lang.Boolean Indicates if link chain is followed. --- ###### `direct`^Optional - *Type:* java.lang.Boolean Indicates that only *direct* links should be searched. --- ##### `findLinks` ```java public java.util.List findLinks(IEdgePredicate predicate) public java.util.List findLinks(IEdgePredicate predicate, java.lang.Boolean reverse) public java.util.List findLinks(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow) public java.util.List findLinks(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow, java.lang.Boolean direct) ``` Find all links of this node based on predicate. By default this will follow link chains to evaluate the predicate against and return the matching direct links of this node. ###### `predicate`^Required - *Type:* IEdgePredicate Edge predicate function to match edge. --- ###### `reverse`^Optional - *Type:* java.lang.Boolean Indicates if links are search in reverse order. --- ###### `follow`^Optional - *Type:* java.lang.Boolean Indicates if link chain is followed. --- ###### `direct`^Optional - *Type:* java.lang.Boolean Indicates that only *direct* links should be searched. --- ##### `getCfnProp` ```java public java.lang.String OR java.lang.Number OR java.lang.Boolean OR PlainObject OR java.util.List getCfnProp(java.lang.String key) ``` Get specific CloudFormation property. ###### `key`^Required - *Type:* java.lang.String --- ##### `getChild` ```java public Node getChild(java.lang.String id) ``` Get *child* node with given *id*. ###### `id`^Required - *Type:* java.lang.String --- ##### `getLinkChains` ```java public java.util.List> getLinkChains() public java.util.List> getLinkChains(java.lang.Boolean reverse) ``` Resolve all link chains. > [{@link EdgeChain }]({@link EdgeChain }) ###### `reverse`^Optional - *Type:* java.lang.Boolean --- ##### `getNearestAncestor` ```java public Node getNearestAncestor(Node node) ``` Gets the nearest **common** *ancestor* shared between *this node* and another *node*. ###### `node`^Required - *Type:* Node --- ##### `isAncestor` ```java public java.lang.Boolean isAncestor(Node ancestor) ``` Indicates if a specific *node* is an *ancestor* of *this node*. ###### `ancestor`^Required - *Type:* Node --- ##### `isChild` ```java public java.lang.Boolean isChild(Node node) ``` Indicates if specific *node* is a *child* of *this node*. ###### `node`^Required - *Type:* Node --- ##### `mutateCollapse` ```java public void mutateCollapse() ``` Collapses all sub-nodes of *this node* into *this node*. > {@link RootNode} does not support this mutation ##### `mutateCollapseTo` ```java public Node mutateCollapseTo(Node _ancestor) ``` Collapses *this node* into *an ancestor* > {@link RootNode} does not support this mutation. ###### `_ancestor`^Required - *Type:* Node --- ##### `mutateCollapseToParent` ```java public Node mutateCollapseToParent() ``` Collapses *this node* into *it's parent node* > {@link RootNode} does not support this mutation. ##### `mutateHoist` ```java public void mutateHoist(Node _newParent) ``` Hoist *this node* to an *ancestor* by removing it from its current parent node and in turn moving it to the ancestor. > {@link RootNode} does not support this mutation ###### `_newParent`^Required - *Type:* Node --- ##### `mutateMove` ```java public void mutateMove(Node newParent) ``` Move this node into a new parent node. ###### `newParent`^Required - *Type:* Node The parent to move this node to. --- ##### `mutateRemoveChild` ```java public java.lang.Boolean mutateRemoveChild(Node node) ``` Remove a *child* node from *this node*. ###### `node`^Required - *Type:* Node --- ##### `mutateRemoveLink` ```java public java.lang.Boolean mutateRemoveLink(Edge link) ``` Remove a *link* from *this node*. ###### `link`^Required - *Type:* Edge --- ##### `mutateRemoveReverseLink` ```java public java.lang.Boolean mutateRemoveReverseLink(Edge link) ``` Remove a *link* to *this node*. ###### `link`^Required - *Type:* Edge --- ##### `mutateUncluster` ```java public void mutateUncluster() ``` Hoist all children to parent and collapse node to parent. ##### `toString` ```java public java.lang.String toString() ``` Get string representation of this node. #### Static Functions | **Name** | **Description** | | --- | --- | | isRootNode | Indicates if node is a {@link RootNode}. | --- ##### `isRootNode` ```java import software.aws.awsprototypingsdk.cdkgraph.RootNode; RootNode.isRootNode(Node node) ``` Indicates if node is a {@link RootNode}. ###### `node`^Required - *Type:* Node --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | attributes | java.util.MapPlainObject OR java.util.ListPlainObject>> | Get *readonly* record of all attributes. | | flags | java.util.List<FlagEnum> | Get *readonly* list of all flags. | | isDestroyed | java.lang.Boolean | Indicates if the entity has been destroyed (eg: removed from store). | | isMutated | java.lang.Boolean | Indicates if the entity has had destructive mutations applied. | | metadata | java.util.List | Get *readonly* list of all metadata entries. | | store | Store | Reference to the store. | | tags | java.util.Map | Get *readonly* record of all tags. | | uuid | java.lang.String | Universally unique identifier. | | allowDestructiveMutations | java.lang.Boolean | Indicates if this node allows destructive mutations. | | children | java.util.List<Node> | Get all direct child nodes. | | dependedOnBy | java.util.List<Node> | Get list of **Nodes** that *depend on this node*. | | dependencies | java.util.List<Node> | Get list of **Nodes** that *this node depends on*. | | dependencyLinks | java.util.List<Dependency> | Gets list of {@link Dependency} links (edges) where this node is the **source**. | | depth | java.lang.Number | Indicates the depth of the node relative to root (0). | | id | java.lang.String | Node id, which is only unique within parent scope. | | isAsset | java.lang.Boolean | Indicates if this node is considered a {@link FlagEnum.ASSET}. | | isCfnFqn | java.lang.Boolean | Indicates if node ConstructInfoFqn denotes a `aws-cdk-lib.*.Cfn*` construct. | | isCluster | java.lang.Boolean | Indicates if this node is considered a {@link FlagEnum.CLUSTER}. | | isCustomResource | java.lang.Boolean | Indicates if node is a *Custom Resource*. | | isExtraneous | java.lang.Boolean | Indicates if this node is considered a {@link FlagEnum.EXTRANEOUS} node or determined to be extraneous: - Clusters that contain no children. | | isGraphContainer | java.lang.Boolean | Indicates if this node is considered a {@link FlagEnum.GRAPH_CONTAINER}. | | isLeaf | java.lang.Boolean | Indicates if this node is a *leaf* node, which means it does not have children. | | isTopLevel | java.lang.Boolean | Indicates if node is direct child of the graph root node. | | links | java.util.List<Edge> | Gets all links (edges) in which this node is the **source**. | | nodeType | NodeTypeEnum | Type of node. | | path | java.lang.String | Path of the node. | | referencedBy | java.util.List<Node> | Get list of **Nodes** that *reference this node*. | | referenceLinks | java.util.List<Reference> | Gets list of {@link Reference} links (edges) where this node is the **source**. | | references | java.util.List<Node> | Get list of **Nodes** that *this node references*. | | reverseDependencyLinks | java.util.List<Dependency> | Gets list of {@link Dependency} links (edges) where this node is the **target**. | | reverseLinks | java.util.List<Edge> | Gets all links (edges) in which this node is the **target**. | | reverseReferenceLinks | java.util.List<Reference> | Gets list of {@link Reference} links (edges) where this node is the **target**. | | scopes | java.util.List<Node> | Gets descending ordered list of ancestors from the root. | | siblings | java.util.List<Node> | Get list of *siblings* of this node. | | cfnProps | PlainObject | Gets CloudFormation properties for this node. | | cfnType | java.lang.String | Get the CloudFormation resource type for this node. | | constructInfo | ConstructInfo | Synthesized construct information defining jii resolution data. | | constructInfoFqn | java.lang.String | Synthesized construct information defining jii resolution data. | | logicalId | java.lang.String | Logical id of the node, which is only unique within containing stack. | | parent | Node | Parent node. | | rootStack | StackNode | Get **root** stack. | | stack | StackNode | Stack the node is contained in. | --- ##### `attributes`^Required ```java public java.lang.Object getAttributes(); ``` - *Type:* java.util.MapPlainObject OR java.util.ListPlainObject>> Get *readonly* record of all attributes. --- ##### `flags`^Required ```java public java.util.List getFlags(); ``` - *Type:* java.util.List<FlagEnum> Get *readonly* list of all flags. --- ##### `isDestroyed`^Required ```java public java.lang.Boolean getIsDestroyed(); ``` - *Type:* java.lang.Boolean Indicates if the entity has been destroyed (eg: removed from store). --- ##### `isMutated`^Required ```java public java.lang.Boolean getIsMutated(); ``` - *Type:* java.lang.Boolean Indicates if the entity has had destructive mutations applied. --- ##### `metadata`^Required ```java public java.util.List getMetadata(); ``` - *Type:* java.util.List Get *readonly* list of all metadata entries. --- ##### `store`^Required ```java public Store getStore(); ``` - *Type:* Store Reference to the store. --- ##### `tags`^Required ```java public java.util.Map getTags(); ``` - *Type:* java.util.Map Get *readonly* record of all tags. --- ##### `uuid`^Required ```java public java.lang.String getUuid(); ``` - *Type:* java.lang.String Universally unique identifier. --- ##### `allowDestructiveMutations`^Required ```java public java.lang.Boolean getAllowDestructiveMutations(); ``` - *Type:* java.lang.Boolean Indicates if this node allows destructive mutations. > [{@link Store.allowDestructiveMutations }]({@link Store.allowDestructiveMutations }) --- ##### `children`^Required ```java public java.util.List getChildren(); ``` - *Type:* java.util.List<Node> Get all direct child nodes. --- ##### `dependedOnBy`^Required ```java public java.util.List getDependedOnBy(); ``` - *Type:* java.util.List<Node> Get list of **Nodes** that *depend on this node*. > [{@link Node.reverseDependencyLinks }]({@link Node.reverseDependencyLinks }) --- ##### `dependencies`^Required ```java public java.util.List getDependencies(); ``` - *Type:* java.util.List<Node> Get list of **Nodes** that *this node depends on*. > [{@link Node.dependencyLinks }]({@link Node.dependencyLinks }) --- ##### `dependencyLinks`^Required ```java public java.util.List getDependencyLinks(); ``` - *Type:* java.util.List<Dependency> Gets list of {@link Dependency} links (edges) where this node is the **source**. --- ##### `depth`^Required ```java public java.lang.Number getDepth(); ``` - *Type:* java.lang.Number Indicates the depth of the node relative to root (0). --- ##### `id`^Required ```java public java.lang.String getId(); ``` - *Type:* java.lang.String Node id, which is only unique within parent scope. --- ##### `isAsset`^Required ```java public java.lang.Boolean getIsAsset(); ``` - *Type:* java.lang.Boolean Indicates if this node is considered a {@link FlagEnum.ASSET}. --- ##### `isCfnFqn`^Required ```java public java.lang.Boolean getIsCfnFqn(); ``` - *Type:* java.lang.Boolean Indicates if node ConstructInfoFqn denotes a `aws-cdk-lib.*.Cfn*` construct. > [{@link FlagEnum.CFN_FQN }]({@link FlagEnum.CFN_FQN }) --- ##### `isCluster`^Required ```java public java.lang.Boolean getIsCluster(); ``` - *Type:* java.lang.Boolean Indicates if this node is considered a {@link FlagEnum.CLUSTER}. --- ##### `isCustomResource`^Required ```java public java.lang.Boolean getIsCustomResource(); ``` - *Type:* java.lang.Boolean Indicates if node is a *Custom Resource*. --- ##### `isExtraneous`^Required ```java public java.lang.Boolean getIsExtraneous(); ``` - *Type:* java.lang.Boolean Indicates if this node is considered a {@link FlagEnum.EXTRANEOUS} node or determined to be extraneous: - Clusters that contain no children. --- ##### `isGraphContainer`^Required ```java public java.lang.Boolean getIsGraphContainer(); ``` - *Type:* java.lang.Boolean Indicates if this node is considered a {@link FlagEnum.GRAPH_CONTAINER}. --- ##### `isLeaf`^Required ```java public java.lang.Boolean getIsLeaf(); ``` - *Type:* java.lang.Boolean Indicates if this node is a *leaf* node, which means it does not have children. --- ##### `isTopLevel`^Required ```java public java.lang.Boolean getIsTopLevel(); ``` - *Type:* java.lang.Boolean Indicates if node is direct child of the graph root node. --- ##### `links`^Required ```java public java.util.List getLinks(); ``` - *Type:* java.util.List<Edge> Gets all links (edges) in which this node is the **source**. --- ##### `nodeType`^Required ```java public NodeTypeEnum getNodeType(); ``` - *Type:* NodeTypeEnum Type of node. --- ##### `path`^Required ```java public java.lang.String getPath(); ``` - *Type:* java.lang.String Path of the node. --- ##### `referencedBy`^Required ```java public java.util.List getReferencedBy(); ``` - *Type:* java.util.List<Node> Get list of **Nodes** that *reference this node*. > [{@link Node.reverseReferenceLinks }]({@link Node.reverseReferenceLinks }) --- ##### `referenceLinks`^Required ```java public java.util.List getReferenceLinks(); ``` - *Type:* java.util.List<Reference> Gets list of {@link Reference} links (edges) where this node is the **source**. --- ##### `references`^Required ```java public java.util.List getReferences(); ``` - *Type:* java.util.List<Node> Get list of **Nodes** that *this node references*. > [{@link Node.referenceLinks }]({@link Node.referenceLinks }) --- ##### `reverseDependencyLinks`^Required ```java public java.util.List getReverseDependencyLinks(); ``` - *Type:* java.util.List<Dependency> Gets list of {@link Dependency} links (edges) where this node is the **target**. --- ##### `reverseLinks`^Required ```java public java.util.List getReverseLinks(); ``` - *Type:* java.util.List<Edge> Gets all links (edges) in which this node is the **target**. --- ##### `reverseReferenceLinks`^Required ```java public java.util.List getReverseReferenceLinks(); ``` - *Type:* java.util.List<Reference> Gets list of {@link Reference} links (edges) where this node is the **target**. --- ##### `scopes`^Required ```java public java.util.List getScopes(); ``` - *Type:* java.util.List<Node> Gets descending ordered list of ancestors from the root. --- ##### `siblings`^Required ```java public java.util.List getSiblings(); ``` - *Type:* java.util.List<> Get list of *siblings* of this node. --- ##### `cfnProps`^Optional ```java public PlainObject getCfnProps(); ``` - *Type:* Gets CloudFormation properties for this node. --- ##### `cfnType`^Optional ```java public java.lang.String getCfnType(); ``` - *Type:* java.lang.String Get the CloudFormation resource type for this node. --- ##### `constructInfo`^Optional ```java public ConstructInfo getConstructInfo(); ``` - *Type:* Synthesized construct information defining jii resolution data. --- ##### `constructInfoFqn`^Optional ```java public java.lang.String getConstructInfoFqn(); ``` - *Type:* java.lang.String Synthesized construct information defining jii resolution data. --- ##### `logicalId`^Optional ```java public java.lang.String getLogicalId(); ``` - *Type:* java.lang.String Logical id of the node, which is only unique within containing stack. --- ##### `parent`^Optional ```java public Node getParent(); ``` - *Type:* Parent node. Only the root node should not have parent. --- ##### `rootStack`^Optional ```java public StackNode getRootStack(); ``` - *Type:* Get **root** stack. --- ##### `stack`^Optional ```java public StackNode getStack(); ``` - *Type:* Stack the node is contained in. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | PATH | java.lang.String | Fixed path of root. | | UUID | java.lang.String | Fixed UUID of root. | --- ##### `PATH`^Required ```java public java.lang.String getPath(); ``` - *Type:* java.lang.String Fixed path of root. --- ##### `UUID`^Required ```java public java.lang.String getUuid(); ``` - *Type:* java.lang.String Fixed UUID of root. --- ### StackNode StackNode defines a cdk Stack. #### Initializers ```java import software.aws.awsprototypingsdk.cdkgraph.StackNode; new StackNode(IStackNodeProps props); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | IStackNodeProps | *No description.* | --- ##### `props`^Required - *Type:* --- #### Methods | **Name** | **Description** | | --- | --- | | addAttribute | Add attribute. | | addFlag | Add flag. | | addMetadata | Add metadata entry. | | addTag | Add tag. | | applyData | Applies data (attributes, metadata, tags, flag) to entity. | | findMetadata | Retrieves all metadata entries of a given type. | | getAttribute | Get attribute by key. | | getTag | Get tag by key. | | hasAttribute | Indicates if entity has a given attribute defined, and optionally with a specific value. | | hasFlag | Indicates if entity has a given flag. | | hasMetadata | Indicates if entity has matching metadata entry. | | hasTag | Indicates if entity has tag, optionally verifying tag value. | | mutateDestroy | Destroys this node by removing all references and removing this node from the store. | | setAttribute | Set attribute. | | setTag | Set tag. | | addChild | Add *child* node. | | addLink | Add *link* to another node. | | addReverseLink | Add *link* from another node. | | doesDependOn | Indicates if *this node* depends on *another node*. | | doesReference | Indicates if *this node* references *another node*. | | find | Recursively find the nearest sub-node matching predicate. | | findAll | Return this construct and all of its sub-nodes in the given order. | | findAllLinks | Return all direct links of this node and that of all sub-nodes. | | findAncestor | Find nearest *ancestor* of *this node* matching given predicate. | | findChild | Find child with given *id*. | | findLink | Find link of this node based on predicate. | | findLinks | Find all links of this node based on predicate. | | getCfnProp | Get specific CloudFormation property. | | getChild | Get *child* node with given *id*. | | getLinkChains | Resolve all link chains. | | getNearestAncestor | Gets the nearest **common** *ancestor* shared between *this node* and another *node*. | | isAncestor | Indicates if a specific *node* is an *ancestor* of *this node*. | | isChild | Indicates if specific *node* is a *child* of *this node*. | | mutateCollapse | Collapses all sub-nodes of *this node* into *this node*. | | mutateCollapseTo | Collapses *this node* into *an ancestor*. | | mutateCollapseToParent | Collapses *this node* into *it's parent node*. | | mutateHoist | Hoist *this node* to an *ancestor* by removing it from its current parent node and in turn moving it to the ancestor. | | mutateMove | Move this node into a new parent node. | | mutateRemoveChild | Remove a *child* node from *this node*. | | mutateRemoveLink | Remove a *link* from *this node*. | | mutateRemoveReverseLink | Remove a *link* to *this node*. | | mutateUncluster | Hoist all children to parent and collapse node to parent. | | toString | Get string representation of this node. | | addOutput | Associate {@link OutputNode} with this stack. | | addParameter | Associate {@link ParameterNode} with this stack. | | findOutput | Find {@link OutputNode} with *logicalId* defined by this stack. | | findParameter | Find {@link ParameterNode} with *parameterId* defined by this stack. | | mutateRemoveOutput | Disassociate {@link OutputNode} from this stack. | | mutateRemoveParameter | Disassociate {@link ParameterNode} from this stack. | --- ##### `addAttribute` ```java public void addAttribute(java.lang.String key, java.lang.Object value) ``` Add attribute. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.Object --- ##### `addFlag` ```java public void addFlag(FlagEnum flag) ``` Add flag. ###### `flag`^Required - *Type:* --- ##### `addMetadata` ```java public void addMetadata(java.lang.String metadataType, java.lang.Object data) ``` Add metadata entry. ###### `metadataType`^Required - *Type:* java.lang.String --- ###### `data`^Required - *Type:* java.lang.Object --- ##### `addTag` ```java public void addTag(java.lang.String key, java.lang.String value) ``` Add tag. ###### `key`^Required - *Type:* java.lang.String --- ###### `value`^Required - *Type:* java.lang.String --- ##### `applyData` ```java public void applyData(IBaseEntityDataProps data) public void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite) public void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite, java.lang.Boolean applyFlags) ``` Applies data (attributes, metadata, tags, flag) to entity. Generally used only for mutations such as collapse and consume to retain data. ###### `data`^Required - *Type:* The data to apply. --- ###### `overwrite`^Optional - *Type:* java.lang.Boolean --- ###### `applyFlags`^Optional - *Type:* java.lang.Boolean Indicates if data is overwritten - Indicates if flags should be applied. --- ##### `findMetadata` ```java public java.util.List