Package software.aws.awsprototypingsdk.cdkgraph

Interface IGraphFilterPlan

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IGraphFilterPlan.Jsii$Default

All Known Implementing Classes:

IGraphFilterPlan.Jsii$Proxy

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

(experimental) Graph filter plan.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IGraphFilterPlan.Jsii$Default	Internal default implementation for IGraphFilterPlan.
static class	IGraphFilterPlan.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 List<Object>	getFilters()	(experimental) Ordered list of IGraphFilter and IGraphStoreFilter filters to apply to the store.
default Object	getFocus()	(experimental) Config to focus the graph on specific node.
default software.constructs.ConstructOrder	getOrder()	(experimental) The order to visit nodes and edges during filtering.
default FilterPreset	getPreset()	(experimental) Optional preset filter to apply before other filters.

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.

Default: false By default only Resource and CfnResource nodes are filtered.

getFilters

@Stability(Experimental)
@Nullable
default List<Object> getFilters()

(experimental) Ordered list of IGraphFilter and IGraphStoreFilter filters to apply to the store.

• Filters are applied after the preset filtering is applied if present.
• Filters are applied sequentially against all nodes, as opposed to IAspect.visitor pattern which are sequentially applied per node.

getFocus

@Stability(Experimental)
@Nullable
default Object getFocus()

(experimental) Config to focus the graph on specific node.

getOrder

@Stability(Experimental)
@Nullable
default software.constructs.ConstructOrder getOrder()

(experimental) The order to visit nodes and edges during filtering.

Default: {ConstructOrder.PREORDER}

getPreset

@Stability(Experimental)
@Nullable
default FilterPreset getPreset()

(experimental) Optional preset filter to apply before other filters.