Package software.aws.awsprototypingsdk.cdkgraph

Interface IGraphFilterPlan.Jsii$Default

All Superinterfaces:

IGraphFilterPlan, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IGraphFilterPlan.Jsii$Proxy

Enclosing interface:

IGraphFilterPlan

@Internal
public static interface IGraphFilterPlan.Jsii$Default
extends IGraphFilterPlan

Internal default implementation for IGraphFilterPlan.

Nested Class Summary

Nested classes/interfaces inherited from interface software.aws.awsprototypingsdk.cdkgraph.IGraphFilterPlan

IGraphFilterPlan.Jsii$Default, IGraphFilterPlan.Jsii$Proxy

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.

Specified by:

getAllNodes in interface IGraphFilterPlan

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.

Specified by:

getFilters in interface IGraphFilterPlan

getFocus

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

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

Specified by:

getFocus in interface IGraphFilterPlan

getOrder

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

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

Default: {ConstructOrder.PREORDER}

Specified by:

getOrder in interface IGraphFilterPlan

getPreset

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

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

Specified by:

getPreset in interface IGraphFilterPlan