Package software.aws.awsprototypingsdk.cdkgraph

Interface IGraphFilter

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IGraphFilter.Jsii$Default

All Known Implementing Classes:

IGraphFilter.Jsii$Proxy

@Generated(value="jsii-pacmak/1.82.0 (build 2d2ddd7)",
           date="2023-08-24T23:07:44.374Z")
@Stability(Experimental)
public interface IGraphFilter
extends software.amazon.jsii.JsiiSerializable

(experimental) Graph filter.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IGraphFilter.Jsii$Default	Internal default implementation for IGraphFilter.
static class	IGraphFilter.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
default Boolean	getAllNodes()	(experimental) Indicates that all nodes will be filtered, rather than just Resource and CfnResource nodes.
default IEdgePredicate	getEdge()	(experimental) Predicate to match edges.
default Boolean	getInverse()	(experimental) Indicates that matches will be filtered, as opposed to non-matches.
default INodePredicate	getNode()	(experimental) Predicate to match nodes.
default FilterStrategy	getStrategy()	(experimental) Filter strategy to apply to matching nodes.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAllNodes

@Stability(Experimental)
@Nullable
default Boolean getAllNodes()

(experimental) Indicates that all nodes will be filtered, rather than just Resource and CfnResource nodes.

By enabling this, all Stages, Stacks, and structural construct boundaries will be filtered as well. In general, most users intent is to operate against resources and desire to preserve structural groupings, which is common in most Cfn/Cdk based filtering where inputs are "include" lists. Defaults to value of containing IGraphFilterPlan.allNodes

getEdge

@Stability(Experimental)
@Nullable
default IEdgePredicate getEdge()

(experimental) Predicate to match edges.

Edges are evaluated after nodes are filtered.

getInverse

@Stability(Experimental)
@Nullable
default Boolean getInverse()

(experimental) Indicates that matches will be filtered, as opposed to non-matches.

The default follows common Javascript Array.filter precedence of preserving matches during filtering, while pruning non-matches.

Default: false - Preserve matches, and filter out non-matches.

getNode

@Stability(Experimental)
@Nullable
default INodePredicate getNode()

(experimental) Predicate to match nodes.

getStrategy

@Stability(Experimental)
@Nullable
default FilterStrategy getStrategy()

(experimental) Filter strategy to apply to matching nodes.

Edges do not have a strategy, they are always pruned.

Default: {FilterStrategy.PRUNE}