From 520fb1e26501f7579dbc1760c05b2f6655d1dd74 Mon Sep 17 00:00:00 2001
From: AWS PDK Automation Properties
-
+html2
Optional ~~
+html2
~~Optional
+
public GeneratedHtml2DocumentationOptions getHtml2();
@@ -14943,7 +14946,10 @@
Properties
-
+html2
Optional ~~
+html2
~~Optional
+
public Project getHtml2();
@@ -46158,7 +46164,10 @@
HTML_REDOC
Redocly/redoc
HTML2
HTML2
~~ OpenAPI Generator 'html2' documentation.
https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/html2.md
diff --git a/api/python/type-safe-api/index.html b/api/python/type-safe-api/index.html index 97b93abb2..c9dd70e19 100644 --- a/api/python/type-safe-api/index.html +++ b/api/python/type-safe-api/index.html @@ -17001,7 +17001,10 @@Properties
-+
html2
Optional~~
+html2
~~Optional+
- Deprecated: Will be removed in 0.24.0. Please use HTML_REDOC for HTML documentation.
+html2: GeneratedHtml2DocumentationOptions
@@ -17078,7 +17081,10 @@
Properties
-+
html2
Optional~~
+html2
~~Optional+
- Deprecated: Will be removed in 0.24.0. Please use HTML_REDOC for HTML documentation.
+html2: Project
@@ -49037,7 +49043,10 @@
HTML_REDOC
Redocly/redoc
HTML2
HTML2
~~ OpenAPI Generator 'html2' documentation.
https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/html2.md
diff --git a/api/typescript/type-safe-api/index.html b/api/typescript/type-safe-api/index.html index a5be528e8..722037384 100644 --- a/api/typescript/type-safe-api/index.html +++ b/api/typescript/type-safe-api/index.html @@ -12437,7 +12437,10 @@Properties
-+
html2
Optional~~
+html2
~~Optional+
- Deprecated: Will be removed in 0.24.0. Please use HTML_REDOC for HTML documentation.
+public readonly html2: GeneratedHtml2DocumentationOptions;
@@ -12509,7 +12512,10 @@
Properties
-+
html2
Optional~~
+html2
~~Optional+
- Deprecated: Will be removed in 0.24.0. Please use HTML_REDOC for HTML documentation.
+public readonly html2: Project;
@@ -41676,7 +41682,10 @@
HTML_REDOC
Redocly/redoc
HTML2
HTML2
~~ OpenAPI Generator 'html2' documentation.
https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/html2.md
diff --git a/search/search_index.json b/search/search_index.json index 0838600d2..5e8983990 100644 --- a/search/search_index.json +++ b/search/search_index.json @@ -1 +1 @@ -{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"api/index.html","title":"API Reference","text":"The AWS PDK is organized into submodules. Each submodules can contain a combination of either (or both) CDK and Projen constructs.
Submodules which are experimental will have an experimental banner to indicate that breaking changes are not subject to major version bumps.
Language specific API docs can be navigated to by selecting your desired language and then selecting the submodule you wish to view.
"},{"location":"api/java/aws-arch/index.html","title":"API Reference","text":""},{"location":"api/java/aws-arch/index.html#structs","title":"Structs","text":""},{"location":"api/java/aws-arch/index.html#arrowformat","title":"ArrowFormat","text":"Theme arrow format definition.
"},{"location":"api/java/aws-arch/index.html#initializer","title":"Initializer","text":""},{"location":"api/java/aws-arch/index.html#properties","title":"Properties","text":"Name Type Descriptionimport software.aws.pdk.aws_arch.aws_arch.ArrowFormat;\n\nArrowFormat.builder()\n.color(java.lang.String)\n.color(java.lang.Boolean)\n.head(java.lang.String)\n.style(java.lang.String)\n.tail(java.lang.String)\n.width(java.lang.Number)\n.build();\n
color
java.lang.String OR java.lang.Boolean
No description.head
java.lang.String
No description.style
java.lang.String
No description.tail
java.lang.String
No description.width
java.lang.Number
No description."},{"location":"api/java/aws-arch/index.html#colorrequired","title":"color
Required","text":"public java.lang.Object getColor();\n
"},{"location":"api/java/aws-arch/index.html#headrequired","title":"
- Type: java.lang.String OR java.lang.Boolean
head
Required","text":"public java.lang.String getHead();\n
"},{"location":"api/java/aws-arch/index.html#stylerequired","title":"
- Type: java.lang.String
style
Required","text":"public java.lang.String getStyle();\n
"},{"location":"api/java/aws-arch/index.html#tailrequired","title":"
- Type: java.lang.String
tail
Required","text":"public java.lang.String getTail();\n
"},{"location":"api/java/aws-arch/index.html#widthrequired","title":"
- Type: java.lang.String
width
Required","text":"public java.lang.Number getWidth();\n
"},{"location":"api/java/aws-arch/index.html#awscategorydefinition","title":"AwsCategoryDefinition","text":"
- Type: java.lang.Number
Category definition.
"},{"location":"api/java/aws-arch/index.html#initializer_1","title":"Initializer","text":""},{"location":"api/java/aws-arch/index.html#properties_1","title":"Properties","text":"Name Type Descriptionimport software.aws.pdk.aws_arch.aws_arch.AwsCategoryDefinition;\n\nAwsCategoryDefinition.builder()\n.fillColor(java.lang.String)\n.gradientColor(java.lang.String)\n.id(java.lang.String)\n.name(java.lang.String)\n// .fontColor(java.lang.String)\n// .variants(java.util.List<java.lang.String>)\n.build();\n
fillColor
java.lang.String
No description.gradientColor
java.lang.String
No description.id
java.lang.String
No description.name
java.lang.String
No description.fontColor
java.lang.String
No description.variants
java.util.List No description."},{"location":"api/java/aws-arch/index.html#fillcolorrequired","title":"
fillColor
Required","text":"public java.lang.String getFillColor();\n
"},{"location":"api/java/aws-arch/index.html#gradientcolorrequired","title":"
- Type: java.lang.String
gradientColor
Required","text":"public java.lang.String getGradientColor();\n
"},{"location":"api/java/aws-arch/index.html#idrequired","title":"
- Type: java.lang.String
id
Required","text":"public java.lang.String getId();\n
"},{"location":"api/java/aws-arch/index.html#namerequired","title":"
- Type: java.lang.String
name
Required","text":"public java.lang.String getName();\n
"},{"location":"api/java/aws-arch/index.html#fontcoloroptional","title":"
- Type: java.lang.String
fontColor
Optional","text":"public java.lang.String getFontColor();\n
"},{"location":"api/java/aws-arch/index.html#variantsoptional","title":"
- Type: java.lang.String
variants
Optional","text":"public java.util.List<java.lang.String> getVariants();\n
- Type: java.util.List"},{"location":"api/java/aws-arch/index.html#awsdrawioresourceiconstyle","title":"AwsDrawioResourceIconStyle","text":"
Drawio resource icon style definition for AWS Resources.
"},{"location":"api/java/aws-arch/index.html#initializer_2","title":"Initializer","text":""},{"location":"api/java/aws-arch/index.html#properties_2","title":"Properties","text":"Name Type Descriptionimport software.aws.pdk.aws_arch.AwsDrawioResourceIconStyle;\n\nAwsDrawioResourceIconStyle.builder()\n.align(java.lang.String)\n.aspect(java.lang.String)\n.dashed(java.lang.Number)\n.fontSize(java.lang.Number)\n.fontStyle(java.lang.String)\n.fontStyle(java.lang.Number)\n.gradientDirection(java.lang.String)\n.html(java.lang.Number)\n.outlineConnect(java.lang.Number)\n.strokeColor(java.lang.String)\n.verticalAlign(java.lang.String)\n.verticalLabelPosition(java.lang.String)\n// .pointerEvent(java.lang.Number)\n.fillColor(java.lang.String)\n.fontColor(java.lang.String)\n.gradientColor(java.lang.String)\n.resIcon(ShapeNames)\n.shape(DrawioAws4ParentShapes)\n.build();\n
align
java.lang.String
No description.aspect
java.lang.String
No description.dashed
java.lang.Number
No description.fontSize
java.lang.Number
No description.fontStyle
java.lang.String OR java.lang.Number
No description.gradientDirection
java.lang.String
No description.html
java.lang.Number
No description.outlineConnect
java.lang.Number
No description.strokeColor
java.lang.String
No description.verticalAlign
java.lang.String
No description.verticalLabelPosition
java.lang.String
No description.pointerEvent
java.lang.Number
No description.fillColor
java.lang.String
No description.fontColor
java.lang.String
No description.gradientColor
java.lang.String
No description.resIcon
software.aws.pdk.aws_arch.aws_arch.DrawioSpec.Aws4.ShapeNames
No description.shape
software.aws.pdk.aws_arch.aws_arch.DrawioAws4ParentShapes
No description."},{"location":"api/java/aws-arch/index.html#alignrequired","title":"align
Required","text":"public java.lang.String getAlign();\n
"},{"location":"api/java/aws-arch/index.html#aspectrequired","title":"
- Type: java.lang.String
aspect
Required","text":"public java.lang.String getAspect();\n
"},{"location":"api/java/aws-arch/index.html#dashedrequired","title":"
- Type: java.lang.String
dashed
Required","text":"public java.lang.Number getDashed();\n
"},{"location":"api/java/aws-arch/index.html#fontsizerequired","title":"
- Type: java.lang.Number
fontSize
Required","text":"public java.lang.Number getFontSize();\n
"},{"location":"api/java/aws-arch/index.html#fontstylerequired","title":"
- Type: java.lang.Number
fontStyle
Required","text":"public java.lang.Object getFontStyle();\n
"},{"location":"api/java/aws-arch/index.html#gradientdirectionrequired","title":"
- Type: java.lang.String OR java.lang.Number
gradientDirection
Required","text":"public java.lang.String getGradientDirection();\n
"},{"location":"api/java/aws-arch/index.html#htmlrequired","title":"
- Type: java.lang.String
html
Required","text":"public java.lang.Number getHtml();\n
"},{"location":"api/java/aws-arch/index.html#outlineconnectrequired","title":"
- Type: java.lang.Number
outlineConnect
Required","text":"public java.lang.Number getOutlineConnect();\n
"},{"location":"api/java/aws-arch/index.html#strokecolorrequired","title":"
- Type: java.lang.Number
strokeColor
Required","text":"public java.lang.String getStrokeColor();\n
"},{"location":"api/java/aws-arch/index.html#verticalalignrequired","title":"
- Type: java.lang.String
verticalAlign
Required","text":"public java.lang.String getVerticalAlign();\n
"},{"location":"api/java/aws-arch/index.html#verticallabelpositionrequired","title":"
- Type: java.lang.String
verticalLabelPosition
Required","text":"public java.lang.String getVerticalLabelPosition();\n
"},{"location":"api/java/aws-arch/index.html#pointereventoptional","title":"
- Type: java.lang.String
pointerEvent
Optional","text":"public java.lang.Number getPointerEvent();\n
"},{"location":"api/java/aws-arch/index.html#fillcolorrequired_1","title":"
- Type: java.lang.Number
fillColor
Required","text":"public java.lang.String getFillColor();\n
"},{"location":"api/java/aws-arch/index.html#fontcolorrequired","title":"
- Type: java.lang.String
fontColor
Required","text":"public java.lang.String getFontColor();\n
"},{"location":"api/java/aws-arch/index.html#gradientcolorrequired_1","title":"
- Type: java.lang.String
gradientColor
Required","text":"public java.lang.String getGradientColor();\n
"},{"location":"api/java/aws-arch/index.html#resiconrequired","title":"
- Type: java.lang.String
resIcon
Required","text":"public ShapeNames getResIcon();\n
"},{"location":"api/java/aws-arch/index.html#shaperequired","title":"
- Type: software.aws.pdk.aws_arch.aws_arch.DrawioSpec.Aws4.ShapeNames
shape
Required","text":"public DrawioAws4ParentShapes getShape();\n
"},{"location":"api/java/aws-arch/index.html#awsdrawioshapestyle","title":"AwsDrawioShapeStyle","text":"
- Type: software.aws.pdk.aws_arch.aws_arch.DrawioAws4ParentShapes
Drawio shape based style definition.
"},{"location":"api/java/aws-arch/index.html#initializer_3","title":"Initializer","text":""},{"location":"api/java/aws-arch/index.html#properties_3","title":"Properties","text":"Name Type Descriptionimport software.aws.pdk.aws_arch.AwsDrawioShapeStyle;\n\nAwsDrawioShapeStyle.builder()\n.align(java.lang.String)\n.aspect(java.lang.String)\n.dashed(java.lang.Number)\n.fontSize(java.lang.Number)\n.fontStyle(java.lang.String)\n.fontStyle(java.lang.Number)\n.gradientDirection(java.lang.String)\n.html(java.lang.Number)\n.outlineConnect(java.lang.Number)\n.strokeColor(java.lang.String)\n.verticalAlign(java.lang.String)\n.verticalLabelPosition(java.lang.String)\n// .pointerEvent(java.lang.Number)\n.fillColor(java.lang.String)\n.fontColor(java.lang.String)\n.gradientColor(java.lang.String)\n.shape(ShapeNames)\n.build();\n
align
java.lang.String
No description.aspect
java.lang.String
No description.dashed
java.lang.Number
No description.fontSize
java.lang.Number
No description.fontStyle
java.lang.String OR java.lang.Number
No description.gradientDirection
java.lang.String
No description.html
java.lang.Number
No description.outlineConnect
java.lang.Number
No description.strokeColor
java.lang.String
No description.verticalAlign
java.lang.String
No description.verticalLabelPosition
java.lang.String
No description.pointerEvent
java.lang.Number
No description.fillColor
java.lang.String
No description.fontColor
java.lang.String
No description.gradientColor
java.lang.String
No description.shape
software.aws.pdk.aws_arch.aws_arch.DrawioSpec.Aws4.ShapeNames
No description."},{"location":"api/java/aws-arch/index.html#alignrequired_1","title":"align
Required","text":"public java.lang.String getAlign();\n
"},{"location":"api/java/aws-arch/index.html#aspectrequired_1","title":"
- Type: java.lang.String
aspect
Required","text":"public java.lang.String getAspect();\n
"},{"location":"api/java/aws-arch/index.html#dashedrequired_1","title":"
- Type: java.lang.String
dashed
Required","text":"public java.lang.Number getDashed();\n
"},{"location":"api/java/aws-arch/index.html#fontsizerequired_1","title":"
- Type: java.lang.Number
fontSize
Required","text":"public java.lang.Number getFontSize();\n
"},{"location":"api/java/aws-arch/index.html#fontstylerequired_1","title":"
- Type: java.lang.Number
fontStyle
Required","text":"public java.lang.Object getFontStyle();\n
"},{"location":"api/java/aws-arch/index.html#gradientdirectionrequired_1","title":"
- Type: java.lang.String OR java.lang.Number
gradientDirection
Required","text":"public java.lang.String getGradientDirection();\n
"},{"location":"api/java/aws-arch/index.html#htmlrequired_1","title":"
- Type: java.lang.String
html
Required","text":"public java.lang.Number getHtml();\n
"},{"location":"api/java/aws-arch/index.html#outlineconnectrequired_1","title":"
- Type: java.lang.Number
outlineConnect
Required","text":"public java.lang.Number getOutlineConnect();\n
"},{"location":"api/java/aws-arch/index.html#strokecolorrequired_1","title":"
- Type: java.lang.Number
strokeColor
Required","text":"public java.lang.String getStrokeColor();\n
"},{"location":"api/java/aws-arch/index.html#verticalalignrequired_1","title":"
- Type: java.lang.String
verticalAlign
Required","text":"public java.lang.String getVerticalAlign();\n
"},{"location":"api/java/aws-arch/index.html#verticallabelpositionrequired_1","title":"
- Type: java.lang.String
verticalLabelPosition
Required","text":"public java.lang.String getVerticalLabelPosition();\n
"},{"location":"api/java/aws-arch/index.html#pointereventoptional_1","title":"
- Type: java.lang.String
pointerEvent
Optional","text":"public java.lang.Number getPointerEvent();\n
"},{"location":"api/java/aws-arch/index.html#fillcolorrequired_2","title":"
- Type: java.lang.Number
fillColor
Required","text":"public java.lang.String getFillColor();\n
"},{"location":"api/java/aws-arch/index.html#fontcolorrequired_1","title":"
- Type: java.lang.String
fontColor
Required","text":"public java.lang.String getFontColor();\n
"},{"location":"api/java/aws-arch/index.html#gradientcolorrequired_2","title":"
- Type: java.lang.String
gradientColor
Required","text":"public java.lang.String getGradientColor();\n
"},{"location":"api/java/aws-arch/index.html#shaperequired_1","title":"
- Type: java.lang.String
shape
Required","text":"public ShapeNames getShape();\n
"},{"location":"api/java/aws-arch/index.html#drawioawsresourceiconstylebase","title":"DrawioAwsResourceIconStyleBase","text":"
- Type: software.aws.pdk.aws_arch.aws_arch.DrawioSpec.Aws4.ShapeNames
Based style definition for drawio aws resource icon.
"},{"location":"api/java/aws-arch/index.html#initializer_4","title":"Initializer","text":""},{"location":"api/java/aws-arch/index.html#properties_4","title":"Properties","text":"Name Type Descriptionimport software.aws.pdk.aws_arch.aws_arch.DrawioAwsResourceIconStyleBase;\n\nDrawioAwsResourceIconStyleBase.builder()\n.align(java.lang.String)\n.aspect(java.lang.String)\n.dashed(java.lang.Number)\n.fontSize(java.lang.Number)\n.fontStyle(java.lang.String)\n.fontStyle(java.lang.Number)\n.gradientDirection(java.lang.String)\n.html(java.lang.Number)\n.outlineConnect(java.lang.Number)\n.strokeColor(java.lang.String)\n.verticalAlign(java.lang.String)\n.verticalLabelPosition(java.lang.String)\n// .pointerEvent(java.lang.Number)\n.fillColor(java.lang.String)\n.fontColor(java.lang.String)\n.gradientColor(java.lang.String)\n.build();\n
align
java.lang.String
No description.aspect
java.lang.String
No description.dashed
java.lang.Number
No description.fontSize
java.lang.Number
No description.fontStyle
java.lang.String OR java.lang.Number
No description.gradientDirection
java.lang.String
No description.html
java.lang.Number
No description.outlineConnect
java.lang.Number
No description.strokeColor
java.lang.String
No description.verticalAlign
java.lang.String
No description.verticalLabelPosition
java.lang.String
No description.pointerEvent
java.lang.Number
No description.fillColor
java.lang.String
No description.fontColor
java.lang.String
No description.gradientColor
java.lang.String
No description."},{"location":"api/java/aws-arch/index.html#alignrequired_2","title":"align
Required","text":"public java.lang.String getAlign();\n
"},{"location":"api/java/aws-arch/index.html#aspectrequired_2","title":"
- Type: java.lang.String
aspect
Required","text":"public java.lang.String getAspect();\n
"},{"location":"api/java/aws-arch/index.html#dashedrequired_2","title":"
- Type: java.lang.String
dashed
Required","text":"public java.lang.Number getDashed();\n
"},{"location":"api/java/aws-arch/index.html#fontsizerequired_2","title":"
- Type: java.lang.Number
fontSize
Required","text":"public java.lang.Number getFontSize();\n
"},{"location":"api/java/aws-arch/index.html#fontstylerequired_2","title":"
- Type: java.lang.Number
fontStyle
Required","text":"public java.lang.Object getFontStyle();\n
"},{"location":"api/java/aws-arch/index.html#gradientdirectionrequired_2","title":"
- Type: java.lang.String OR java.lang.Number
gradientDirection
Required","text":"public java.lang.String getGradientDirection();\n
"},{"location":"api/java/aws-arch/index.html#htmlrequired_2","title":"
- Type: java.lang.String
html
Required","text":"public java.lang.Number getHtml();\n
"},{"location":"api/java/aws-arch/index.html#outlineconnectrequired_2","title":"
- Type: java.lang.Number
outlineConnect
Required","text":"public java.lang.Number getOutlineConnect();\n
"},{"location":"api/java/aws-arch/index.html#strokecolorrequired_2","title":"
- Type: java.lang.Number
strokeColor
Required","text":"public java.lang.String getStrokeColor();\n
"},{"location":"api/java/aws-arch/index.html#verticalalignrequired_2","title":"
- Type: java.lang.String
verticalAlign
Required","text":"public java.lang.String getVerticalAlign();\n
"},{"location":"api/java/aws-arch/index.html#verticallabelpositionrequired_2","title":"
- Type: java.lang.String
verticalLabelPosition
Required","text":"public java.lang.String getVerticalLabelPosition();\n
"},{"location":"api/java/aws-arch/index.html#pointereventoptional_2","title":"
- Type: java.lang.String
pointerEvent
Optional","text":"public java.lang.Number getPointerEvent();\n
"},{"location":"api/java/aws-arch/index.html#fillcolorrequired_3","title":"
- Type: java.lang.Number
fillColor
Required","text":"public java.lang.String getFillColor();\n
"},{"location":"api/java/aws-arch/index.html#fontcolorrequired_2","title":"
- Type: java.lang.String
fontColor
Required","text":"public java.lang.String getFontColor();\n
"},{"location":"api/java/aws-arch/index.html#gradientcolorrequired_3","title":"
- Type: java.lang.String
gradientColor
Required","text":"public java.lang.String getGradientColor();\n
"},{"location":"api/java/aws-arch/index.html#drawioawsshapestylebase","title":"DrawioAwsShapeStyleBase","text":"
- Type: java.lang.String
Base definition of drawio aws shape style.
"},{"location":"api/java/aws-arch/index.html#initializer_5","title":"Initializer","text":""},{"location":"api/java/aws-arch/index.html#properties_5","title":"Properties","text":"Name Type Descriptionimport software.aws.pdk.aws_arch.aws_arch.DrawioAwsShapeStyleBase;\n\nDrawioAwsShapeStyleBase.builder()\n.align(java.lang.String)\n.aspect(java.lang.String)\n.dashed(java.lang.Number)\n.fontSize(java.lang.Number)\n.fontStyle(java.lang.String)\n.fontStyle(java.lang.Number)\n.gradientDirection(java.lang.String)\n.html(java.lang.Number)\n.outlineConnect(java.lang.Number)\n.strokeColor(java.lang.String)\n.verticalAlign(java.lang.String)\n.verticalLabelPosition(java.lang.String)\n// .pointerEvent(java.lang.Number)\n.build();\n
align
java.lang.String
No description.aspect
java.lang.String
No description.dashed
java.lang.Number
No description.fontSize
java.lang.Number
No description.fontStyle
java.lang.String OR java.lang.Number
No description.gradientDirection
java.lang.String
No description.html
java.lang.Number
No description.outlineConnect
java.lang.Number
No description.strokeColor
java.lang.String
No description.verticalAlign
java.lang.String
No description.verticalLabelPosition
java.lang.String
No description.pointerEvent
java.lang.Number
No description."},{"location":"api/java/aws-arch/index.html#alignrequired_3","title":"align
Required","text":"public java.lang.String getAlign();\n
"},{"location":"api/java/aws-arch/index.html#aspectrequired_3","title":"
- Type: java.lang.String
aspect
Required","text":"public java.lang.String getAspect();\n
"},{"location":"api/java/aws-arch/index.html#dashedrequired_3","title":"
- Type: java.lang.String
dashed
Required","text":"public java.lang.Number getDashed();\n
"},{"location":"api/java/aws-arch/index.html#fontsizerequired_3","title":"
- Type: java.lang.Number
fontSize
Required","text":"public java.lang.Number getFontSize();\n
"},{"location":"api/java/aws-arch/index.html#fontstylerequired_3","title":"
- Type: java.lang.Number
fontStyle
Required","text":"public java.lang.Object getFontStyle();\n
"},{"location":"api/java/aws-arch/index.html#gradientdirectionrequired_3","title":"
- Type: java.lang.String OR java.lang.Number
gradientDirection
Required","text":"public java.lang.String getGradientDirection();\n
"},{"location":"api/java/aws-arch/index.html#htmlrequired_3","title":"
- Type: java.lang.String
html
Required","text":"public java.lang.Number getHtml();\n
"},{"location":"api/java/aws-arch/index.html#outlineconnectrequired_3","title":"
- Type: java.lang.Number
outlineConnect
Required","text":"public java.lang.Number getOutlineConnect();\n
"},{"location":"api/java/aws-arch/index.html#strokecolorrequired_3","title":"
- Type: java.lang.Number
strokeColor
Required","text":"public java.lang.String getStrokeColor();\n
"},{"location":"api/java/aws-arch/index.html#verticalalignrequired_3","title":"
- Type: java.lang.String
verticalAlign
Required","text":"public java.lang.String getVerticalAlign();\n
"},{"location":"api/java/aws-arch/index.html#verticallabelpositionrequired_3","title":"
- Type: java.lang.String
verticalLabelPosition
Required","text":"public java.lang.String getVerticalLabelPosition();\n
"},{"location":"api/java/aws-arch/index.html#pointereventoptional_3","title":"
- Type: java.lang.String
pointerEvent
Optional","text":"public java.lang.Number getPointerEvent();\n
"},{"location":"api/java/aws-arch/index.html#groupformat","title":"GroupFormat","text":"
- Type: java.lang.Number
Theme group format definition.
"},{"location":"api/java/aws-arch/index.html#initializer_6","title":"Initializer","text":""},{"location":"api/java/aws-arch/index.html#properties_6","title":"Properties","text":"Name Type Descriptionimport software.aws.pdk.aws_arch.aws_arch.GroupFormat;\n\nGroupFormat.builder()\n.bgcolor(java.lang.String)\n.bgcolor(java.lang.Boolean)\n.borderColor(java.lang.String)\n.borderColor(java.lang.Boolean)\n.borderStyle(java.lang.String)\n.color(java.lang.String)\n.color(java.lang.Boolean)\n// .iconPng(java.lang.String)\n// .labelLocation(java.lang.String)\n.build();\n
bgcolor
java.lang.String OR java.lang.Boolean
No description.borderColor
java.lang.String OR java.lang.Boolean
No description.borderStyle
java.lang.String
No description.color
java.lang.String OR java.lang.Boolean
No description.iconPng
java.lang.String
No description.labelLocation
java.lang.String
No description."},{"location":"api/java/aws-arch/index.html#bgcolorrequired","title":"bgcolor
Required","text":"public java.lang.Object getBgcolor();\n
"},{"location":"api/java/aws-arch/index.html#bordercolorrequired","title":"
- Type: java.lang.String OR java.lang.Boolean
borderColor
Required","text":"public java.lang.Object getBorderColor();\n
"},{"location":"api/java/aws-arch/index.html#borderstylerequired","title":"
- Type: java.lang.String OR java.lang.Boolean
borderStyle
Required","text":"public java.lang.String getBorderStyle();\n
"},{"location":"api/java/aws-arch/index.html#colorrequired_1","title":"
- Type: java.lang.String
color
Required","text":"public java.lang.Object getColor();\n
"},{"location":"api/java/aws-arch/index.html#iconpngoptional","title":"
- Type: java.lang.String OR java.lang.Boolean
iconPng
Optional","text":"public java.lang.String getIconPng();\n
"},{"location":"api/java/aws-arch/index.html#labellocationoptional","title":"
- Type: java.lang.String
labelLocation
Optional","text":"public java.lang.String getLabelLocation();\n
"},{"location":"api/java/aws-arch/index.html#parsedassetkey","title":"ParsedAssetKey","text":"
- Type: java.lang.String
Parsed asset key.
"},{"location":"api/java/aws-arch/index.html#initializer_7","title":"Initializer","text":""},{"location":"api/java/aws-arch/index.html#properties_7","title":"Properties","text":"Name Type Descriptionimport software.aws.pdk.aws_arch.ParsedAssetKey;\n\nParsedAssetKey.builder()\n.assetKey(java.lang.String)\n.basename(java.lang.String)\n.category(java.lang.String)\n// .instanceType(java.lang.String)\n// .iotThing(java.lang.String)\n// .resource(java.lang.String)\n// .service(java.lang.String)\n.build();\n
assetKey
java.lang.String
Reference to the full key that was parsed.basename
java.lang.String
The last segment of the key (which is the nested icon).category
java.lang.String
Category id.instanceType
java.lang.String
The instance type if key is for an ec2 instance.iotThing
java.lang.String
The iot thing if key is for an iot thing.resource
java.lang.String
Resource id if key is for a resource.service
java.lang.String
Service id if key is partitioned by resource."},{"location":"api/java/aws-arch/index.html#assetkeyrequired","title":"assetKey
Required","text":"public java.lang.String getAssetKey();\n
- Type: java.lang.String
Reference to the full key that was parsed.
"},{"location":"api/java/aws-arch/index.html#basenamerequired","title":"basename
Required","text":"public java.lang.String getBasename();\n
- Type: java.lang.String
The last segment of the key (which is the nested icon).
For instances and things this includes the dir prefix.
"},{"location":"api/java/aws-arch/index.html#categoryrequired","title":"category
Required","text":"public java.lang.String getCategory();\n
- Type: java.lang.String
Category id.
"},{"location":"api/java/aws-arch/index.html#instancetypeoptional","title":"instanceType
Optional","text":"public java.lang.String getInstanceType();\n
- Type: java.lang.String
The instance type if key is for an ec2 instance.
"},{"location":"api/java/aws-arch/index.html#iotthingoptional","title":"iotThing
Optional","text":"public java.lang.String getIotThing();\n
- Type: java.lang.String
The iot thing if key is for an iot thing.
"},{"location":"api/java/aws-arch/index.html#resourceoptional","title":"resource
Optional","text":"public java.lang.String getResource();\n
- Type: java.lang.String
Resource id if key is for a resource.
"},{"location":"api/java/aws-arch/index.html#serviceoptional","title":"service
Optional","text":"public java.lang.String getService();\n
- Type: java.lang.String
Service id if key is partitioned by resource.
"},{"location":"api/java/aws-arch/index.html#parsedassetkey_1","title":"ParsedAssetKey","text":"Parsed asset key.
"},{"location":"api/java/aws-arch/index.html#initializer_8","title":"Initializer","text":""},{"location":"api/java/aws-arch/index.html#properties_8","title":"Properties","text":"Name Type Descriptionimport software.aws.pdk.aws_arch.aws_arch.ParsedAssetKey;\n\nParsedAssetKey.builder()\n.assetKey(java.lang.String)\n.basename(java.lang.String)\n.category(java.lang.String)\n// .instanceType(java.lang.String)\n// .iotThing(java.lang.String)\n// .resource(java.lang.String)\n// .service(java.lang.String)\n.build();\n
assetKey
java.lang.String
Reference to the full key that was parsed.basename
java.lang.String
The last segment of the key (which is the nested icon).category
java.lang.String
Category id.instanceType
java.lang.String
The instance type if key is for an ec2 instance.iotThing
java.lang.String
The iot thing if key is for an iot thing.resource
java.lang.String
Resource id if key is for a resource.service
java.lang.String
Service id if key is partitioned by resource."},{"location":"api/java/aws-arch/index.html#assetkeyrequired_1","title":"assetKey
Required","text":"public java.lang.String getAssetKey();\n
- Type: java.lang.String
Reference to the full key that was parsed.
"},{"location":"api/java/aws-arch/index.html#basenamerequired_1","title":"basename
Required","text":"public java.lang.String getBasename();\n
- Type: java.lang.String
The last segment of the key (which is the nested icon).
For instances and things this includes the dir prefix.
"},{"location":"api/java/aws-arch/index.html#categoryrequired_1","title":"category
Required","text":"public java.lang.String getCategory();\n
- Type: java.lang.String
Category id.
"},{"location":"api/java/aws-arch/index.html#instancetypeoptional_1","title":"instanceType
Optional","text":"public java.lang.String getInstanceType();\n
- Type: java.lang.String
The instance type if key is for an ec2 instance.
"},{"location":"api/java/aws-arch/index.html#iotthingoptional_1","title":"iotThing
Optional","text":"public java.lang.String getIotThing();\n
- Type: java.lang.String
The iot thing if key is for an iot thing.
"},{"location":"api/java/aws-arch/index.html#resourceoptional_1","title":"resource
Optional","text":"public java.lang.String getResource();\n
- Type: java.lang.String
Resource id if key is for a resource.
"},{"location":"api/java/aws-arch/index.html#serviceoptional_1","title":"service
Optional","text":"public java.lang.String getService();\n
- Type: java.lang.String
Service id if key is partitioned by resource.
"},{"location":"api/java/aws-arch/index.html#theme","title":"Theme","text":"Theme definition.
"},{"location":"api/java/aws-arch/index.html#initializer_9","title":"Initializer","text":""},{"location":"api/java/aws-arch/index.html#properties_9","title":"Properties","text":"Name Type Descriptionimport software.aws.pdk.aws_arch.aws_arch.Theme;\n\nTheme.builder()\n.arrows(ThemeArrows)\n.backgrounds(ThemeBackgrounds)\n.groups(ThemeGroups)\n.id(java.lang.String)\n.text(ThemeText)\n.build();\n
arrows
software.aws.pdk.aws_arch.aws_arch.ThemeArrows
No description.backgrounds
software.aws.pdk.aws_arch.aws_arch.ThemeBackgrounds
No description.groups
software.aws.pdk.aws_arch.aws_arch.ThemeGroups
No description.id
java.lang.String
No description.text
software.aws.pdk.aws_arch.aws_arch.ThemeText
No description."},{"location":"api/java/aws-arch/index.html#arrowsrequired","title":"arrows
Required","text":"public ThemeArrows getArrows();\n
"},{"location":"api/java/aws-arch/index.html#backgroundsrequired","title":"
- Type: software.aws.pdk.aws_arch.aws_arch.ThemeArrows
backgrounds
Required","text":"public ThemeBackgrounds getBackgrounds();\n
"},{"location":"api/java/aws-arch/index.html#groupsrequired","title":"
- Type: software.aws.pdk.aws_arch.aws_arch.ThemeBackgrounds
groups
Required","text":"public ThemeGroups getGroups();\n
"},{"location":"api/java/aws-arch/index.html#idrequired_1","title":"
- Type: software.aws.pdk.aws_arch.aws_arch.ThemeGroups
id
Required","text":"public java.lang.String getId();\n
"},{"location":"api/java/aws-arch/index.html#textrequired","title":"
- Type: java.lang.String
text
Required","text":"public ThemeText getText();\n
"},{"location":"api/java/aws-arch/index.html#themearrows","title":"ThemeArrows","text":"
- Type: software.aws.pdk.aws_arch.aws_arch.ThemeText
Theme arrow dictionary.
"},{"location":"api/java/aws-arch/index.html#initializer_10","title":"Initializer","text":""},{"location":"api/java/aws-arch/index.html#properties_10","title":"Properties","text":"Name Type Descriptionimport software.aws.pdk.aws_arch.aws_arch.ThemeArrows;\n\nThemeArrows.builder()\n.child(ArrowFormat)\n.default(ArrowFormat)\n.dependency(ArrowFormat)\n.reference(ArrowFormat)\n.build();\n
child
software.aws.pdk.aws_arch.aws_arch.ArrowFormat
No description.default
software.aws.pdk.aws_arch.aws_arch.ArrowFormat
No description.dependency
software.aws.pdk.aws_arch.aws_arch.ArrowFormat
No description.reference
software.aws.pdk.aws_arch.aws_arch.ArrowFormat
No description."},{"location":"api/java/aws-arch/index.html#childrequired","title":"child
Required","text":"public ArrowFormat getChild();\n
"},{"location":"api/java/aws-arch/index.html#defaultrequired","title":"
- Type: software.aws.pdk.aws_arch.aws_arch.ArrowFormat
default
Required","text":"public ArrowFormat getDefault();\n
"},{"location":"api/java/aws-arch/index.html#dependencyrequired","title":"
- Type: software.aws.pdk.aws_arch.aws_arch.ArrowFormat
dependency
Required","text":"public ArrowFormat getDependency();\n
"},{"location":"api/java/aws-arch/index.html#referencerequired","title":"
- Type: software.aws.pdk.aws_arch.aws_arch.ArrowFormat
reference
Required","text":"public ArrowFormat getReference();\n
"},{"location":"api/java/aws-arch/index.html#themebackgrounds","title":"ThemeBackgrounds","text":"
- Type: software.aws.pdk.aws_arch.aws_arch.ArrowFormat
Theme background dictionary.
"},{"location":"api/java/aws-arch/index.html#initializer_11","title":"Initializer","text":""},{"location":"api/java/aws-arch/index.html#properties_11","title":"Properties","text":"Name Type Descriptionimport software.aws.pdk.aws_arch.aws_arch.ThemeBackgrounds;\n\nThemeBackgrounds.builder()\n.base(java.lang.String)\n.generic(java.lang.String)\n.private(java.lang.String)\n.public(java.lang.String)\n.build();\n
base
java.lang.String
No description.generic
java.lang.String
No description.private
java.lang.String
No description.public
java.lang.String
No description."},{"location":"api/java/aws-arch/index.html#baserequired","title":"base
Required","text":"public java.lang.String getBase();\n
"},{"location":"api/java/aws-arch/index.html#genericrequired","title":"
- Type: java.lang.String
generic
Required","text":"public java.lang.String getGeneric();\n
"},{"location":"api/java/aws-arch/index.html#privaterequired","title":"
- Type: java.lang.String
private
Required","text":"public java.lang.String getPrivate();\n
"},{"location":"api/java/aws-arch/index.html#publicrequired","title":"
- Type: java.lang.String
public
Required","text":"public java.lang.String getPublic();\n
"},{"location":"api/java/aws-arch/index.html#themegroups","title":"ThemeGroups","text":"
- Type: java.lang.String
Theme group dicionary.
"},{"location":"api/java/aws-arch/index.html#initializer_12","title":"Initializer","text":""},{"location":"api/java/aws-arch/index.html#properties_12","title":"Properties","text":"Name Type Descriptionimport software.aws.pdk.aws_arch.aws_arch.ThemeGroups;\n\nThemeGroups.builder()\n.autoScalingGroup(GroupFormat)\n.availabilityZone(GroupFormat)\n.awsAccount(GroupFormat)\n.awsIoTGreengrass(GroupFormat)\n.awsIoTGreengrassDeployment(GroupFormat)\n.awsStepFunctionsWorkflow(GroupFormat)\n.cloud(GroupFormat)\n.cloudAlt(GroupFormat)\n.corporateDataCenter(GroupFormat)\n.ec2InstanceContents(GroupFormat)\n.elasticBeanstalkContainer(GroupFormat)\n.generic(GroupFormat)\n.genericAlt(GroupFormat)\n.privateSubnet(GroupFormat)\n.publicSubnet(GroupFormat)\n.region(GroupFormat)\n.securityGroup(GroupFormat)\n.serverContents(GroupFormat)\n.spotFleet(GroupFormat)\n.vpc(GroupFormat)\n.build();\n
autoScalingGroup
software.aws.pdk.aws_arch.aws_arch.GroupFormat
No description.availabilityZone
software.aws.pdk.aws_arch.aws_arch.GroupFormat
No description.awsAccount
software.aws.pdk.aws_arch.aws_arch.GroupFormat
No description.awsIoTGreengrass
software.aws.pdk.aws_arch.aws_arch.GroupFormat
No description.awsIoTGreengrassDeployment
software.aws.pdk.aws_arch.aws_arch.GroupFormat
No description.awsStepFunctionsWorkflow
software.aws.pdk.aws_arch.aws_arch.GroupFormat
No description.cloud
software.aws.pdk.aws_arch.aws_arch.GroupFormat
No description.cloudAlt
software.aws.pdk.aws_arch.aws_arch.GroupFormat
No description.corporateDataCenter
software.aws.pdk.aws_arch.aws_arch.GroupFormat
No description.ec2InstanceContents
software.aws.pdk.aws_arch.aws_arch.GroupFormat
No description.elasticBeanstalkContainer
software.aws.pdk.aws_arch.aws_arch.GroupFormat
No description.generic
software.aws.pdk.aws_arch.aws_arch.GroupFormat
No description.genericAlt
software.aws.pdk.aws_arch.aws_arch.GroupFormat
No description.privateSubnet
software.aws.pdk.aws_arch.aws_arch.GroupFormat
No description.publicSubnet
software.aws.pdk.aws_arch.aws_arch.GroupFormat
No description.region
software.aws.pdk.aws_arch.aws_arch.GroupFormat
No description.securityGroup
software.aws.pdk.aws_arch.aws_arch.GroupFormat
No description.serverContents
software.aws.pdk.aws_arch.aws_arch.GroupFormat
No description.spotFleet
software.aws.pdk.aws_arch.aws_arch.GroupFormat
No description.vpc
software.aws.pdk.aws_arch.aws_arch.GroupFormat
No description."},{"location":"api/java/aws-arch/index.html#autoscalinggrouprequired","title":"autoScalingGroup
Required","text":"public GroupFormat getAutoScalingGroup();\n
"},{"location":"api/java/aws-arch/index.html#availabilityzonerequired","title":"
- Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat
availabilityZone
Required","text":"public GroupFormat getAvailabilityZone();\n
"},{"location":"api/java/aws-arch/index.html#awsaccountrequired","title":"
- Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat
awsAccount
Required","text":"public GroupFormat getAwsAccount();\n
"},{"location":"api/java/aws-arch/index.html#awsiotgreengrassrequired","title":"
- Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat
awsIoTGreengrass
Required","text":"public GroupFormat getAwsIoTGreengrass();\n
"},{"location":"api/java/aws-arch/index.html#awsiotgreengrassdeploymentrequired","title":"
- Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat
awsIoTGreengrassDeployment
Required","text":"public GroupFormat getAwsIoTGreengrassDeployment();\n
"},{"location":"api/java/aws-arch/index.html#awsstepfunctionsworkflowrequired","title":"
- Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat
awsStepFunctionsWorkflow
Required","text":"public GroupFormat getAwsStepFunctionsWorkflow();\n
"},{"location":"api/java/aws-arch/index.html#cloudrequired","title":"
- Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat
cloud
Required","text":"public GroupFormat getCloud();\n
"},{"location":"api/java/aws-arch/index.html#cloudaltrequired","title":"
- Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat
cloudAlt
Required","text":"public GroupFormat getCloudAlt();\n
"},{"location":"api/java/aws-arch/index.html#corporatedatacenterrequired","title":"
- Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat
corporateDataCenter
Required","text":"public GroupFormat getCorporateDataCenter();\n
"},{"location":"api/java/aws-arch/index.html#ec2instancecontentsrequired","title":"
- Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat
ec2InstanceContents
Required","text":"public GroupFormat getEc2InstanceContents();\n
"},{"location":"api/java/aws-arch/index.html#elasticbeanstalkcontainerrequired","title":"
- Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat
elasticBeanstalkContainer
Required","text":"public GroupFormat getElasticBeanstalkContainer();\n
"},{"location":"api/java/aws-arch/index.html#genericrequired_1","title":"
- Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat
generic
Required","text":"public GroupFormat getGeneric();\n
"},{"location":"api/java/aws-arch/index.html#genericaltrequired","title":"
- Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat
genericAlt
Required","text":"public GroupFormat getGenericAlt();\n
"},{"location":"api/java/aws-arch/index.html#privatesubnetrequired","title":"
- Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat
privateSubnet
Required","text":"public GroupFormat getPrivateSubnet();\n
"},{"location":"api/java/aws-arch/index.html#publicsubnetrequired","title":"
- Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat
publicSubnet
Required","text":"public GroupFormat getPublicSubnet();\n
"},{"location":"api/java/aws-arch/index.html#regionrequired","title":"
- Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat
region
Required","text":"public GroupFormat getRegion();\n
"},{"location":"api/java/aws-arch/index.html#securitygrouprequired","title":"
- Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat
securityGroup
Required","text":"public GroupFormat getSecurityGroup();\n
"},{"location":"api/java/aws-arch/index.html#servercontentsrequired","title":"
- Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat
serverContents
Required","text":"public GroupFormat getServerContents();\n
"},{"location":"api/java/aws-arch/index.html#spotfleetrequired","title":"
- Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat
spotFleet
Required","text":"public GroupFormat getSpotFleet();\n
"},{"location":"api/java/aws-arch/index.html#vpcrequired","title":"
- Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat
vpc
Required","text":"public GroupFormat getVpc();\n
"},{"location":"api/java/aws-arch/index.html#themetext","title":"ThemeText","text":"
- Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat
Theme text dictionary.
"},{"location":"api/java/aws-arch/index.html#initializer_13","title":"Initializer","text":""},{"location":"api/java/aws-arch/index.html#properties_13","title":"Properties","text":"Name Type Descriptionimport software.aws.pdk.aws_arch.aws_arch.ThemeText;\n\nThemeText.builder()\n.default(java.lang.String)\n.primary(java.lang.String)\n.secondary(java.lang.String)\n.tertiary(java.lang.String)\n.build();\n
default
java.lang.String
No description.primary
java.lang.String
No description.secondary
java.lang.String
No description.tertiary
java.lang.String
No description."},{"location":"api/java/aws-arch/index.html#defaultrequired_1","title":"default
Required","text":"public java.lang.String getDefault();\n
"},{"location":"api/java/aws-arch/index.html#primaryrequired","title":"
- Type: java.lang.String
primary
Required","text":"public java.lang.String getPrimary();\n
"},{"location":"api/java/aws-arch/index.html#secondaryrequired","title":"
- Type: java.lang.String
secondary
Required","text":"public java.lang.String getSecondary();\n
"},{"location":"api/java/aws-arch/index.html#tertiaryrequired","title":"
- Type: java.lang.String
tertiary
Required","text":"public java.lang.String getTertiary();\n
"},{"location":"api/java/aws-arch/index.html#classes","title":"Classes","text":""},{"location":"api/java/aws-arch/index.html#awsarchitecture","title":"AwsArchitecture","text":"
- Type: java.lang.String
AwsArchitecture provides an interface for retrieving the inferred normalization between @aws-cdk/cfnspec and AWS Architecture Icons systems for all CloudFormation \"services\" and \"resources\".
"},{"location":"api/java/aws-arch/index.html#static-functions","title":"Static Functions","text":"Name DescriptionformatAssetPath
Gets formatted asset path including extension and theme.getCategory
Get specific category based on id.getInstanceTypeIcon
Get icon for EC2 instance type.getRdsInstanceTypeIcon
Get icon for RDS instance type.getResource
Get resource based on Cfn Resource Type (eg: AWS::S3::Bucket).getService
Get specific service based on identifier (eg: S3, AWS::S3, AWS::S3::Bucket).parseAssetPath
Parse assets path into part descriptor.resolveAssetPath
Resolve relative asset path to absolute asset path.resolveAssetSvgDataUrl
Resolve relative asset path as SVG Data URL."},{"location":"api/java/aws-arch/index.html#formatassetpath","title":"formatAssetPath
","text":"import software.aws.pdk.aws_arch.AwsArchitecture;\n\nAwsArchitecture.formatAssetPath(java.lang.String qualifiedAssetKey, java.lang.String format),AwsArchitecture.formatAssetPath(java.lang.String qualifiedAssetKey, java.lang.String format, java.lang.String theme)\n
Gets formatted asset path including extension and theme.
"},{"location":"api/java/aws-arch/index.html#qualifiedassetkeyrequired","title":"qualifiedAssetKey
Required","text":"
- Type: java.lang.String
The qualified asset key (eg: compute/ec2/service_icon, storage/s3/bucket).
"},{"location":"api/java/aws-arch/index.html#formatrequired","title":"format
Required","text":"
- Type: java.lang.String
The format to return (eg: png, svg).
"},{"location":"api/java/aws-arch/index.html#themeoptional","title":"theme
Optional","text":"
- Type: java.lang.String
(Optional) The theme to use, if not specific or now matching asset for the them, the default theme is used.
"},{"location":"api/java/aws-arch/index.html#getcategory","title":"getCategory
","text":"import software.aws.pdk.aws_arch.AwsArchitecture;\n\nAwsArchitecture.getCategory(java.lang.String category)\n
Get specific category based on id.
{@link AwsCategory.getCategory }
"},{"location":"api/java/aws-arch/index.html#categoryrequired_2","title":"category
Required","text":""},{"location":"api/java/aws-arch/index.html#getinstancetypeicon","title":"
- Type: java.lang.String
getInstanceTypeIcon
","text":"import software.aws.pdk.aws_arch.AwsArchitecture;\n\nAwsArchitecture.getInstanceTypeIcon(java.lang.String instanceType),AwsArchitecture.getInstanceTypeIcon(java.lang.String instanceType, java.lang.String format),AwsArchitecture.getInstanceTypeIcon(java.lang.String instanceType, java.lang.String format, java.lang.String theme)\n
Get icon for EC2 instance type.
"},{"location":"api/java/aws-arch/index.html#instancetyperequired","title":"instanceType
Required","text":"
- Type: java.lang.String
The {@link AwsAsset.InstanceType} to get icon for.
"},{"location":"api/java/aws-arch/index.html#formatoptional","title":"format
Optional","text":"
- Type: java.lang.String
The format of icon.
"},{"location":"api/java/aws-arch/index.html#themeoptional_1","title":"theme
Optional","text":"
- Type: java.lang.String
Optional theme.
"},{"location":"api/java/aws-arch/index.html#getrdsinstancetypeicon","title":"getRdsInstanceTypeIcon
","text":"import software.aws.pdk.aws_arch.AwsArchitecture;\n\nAwsArchitecture.getRdsInstanceTypeIcon(java.lang.String instanceType),AwsArchitecture.getRdsInstanceTypeIcon(java.lang.String instanceType, java.lang.String format),AwsArchitecture.getRdsInstanceTypeIcon(java.lang.String instanceType, java.lang.String format, java.lang.String theme)\n
Get icon for RDS instance type.
"},{"location":"api/java/aws-arch/index.html#instancetyperequired_1","title":"instanceType
Required","text":"
- Type: java.lang.String
The {@link AwsAsset.RdsInstanceType} to get icon for.
"},{"location":"api/java/aws-arch/index.html#formatoptional_1","title":"format
Optional","text":"
- Type: java.lang.String
The format of icon.
"},{"location":"api/java/aws-arch/index.html#themeoptional_2","title":"theme
Optional","text":"
- Type: java.lang.String
Optional theme.
"},{"location":"api/java/aws-arch/index.html#getresource","title":"getResource
","text":"import software.aws.pdk.aws_arch.AwsArchitecture;\n\nAwsArchitecture.getResource(java.lang.String cfnType)\n
Get resource based on Cfn Resource Type (eg: AWS::S3::Bucket).
{@link AwsResource.getResource }
"},{"location":"api/java/aws-arch/index.html#cfntyperequired","title":"cfnType
Required","text":""},{"location":"api/java/aws-arch/index.html#getservice","title":"
- Type: java.lang.String
getService
","text":"import software.aws.pdk.aws_arch.AwsArchitecture;\n\nAwsArchitecture.getService(java.lang.String identifier)\n
Get specific service based on identifier (eg: S3, AWS::S3, AWS::S3::Bucket).
{@link AwsSerfice.getService }
"},{"location":"api/java/aws-arch/index.html#identifierrequired","title":"identifier
Required","text":""},{"location":"api/java/aws-arch/index.html#parseassetpath","title":"
- Type: java.lang.String
parseAssetPath
","text":"import software.aws.pdk.aws_arch.AwsArchitecture;\n\nAwsArchitecture.parseAssetPath(java.lang.String assetPath)\n
Parse assets path into part descriptor.
"},{"location":"api/java/aws-arch/index.html#assetpathrequired","title":"assetPath
Required","text":"
- Type: java.lang.String
Absolute or relative asset file path to parse.
"},{"location":"api/java/aws-arch/index.html#resolveassetpath","title":"resolveAssetPath
","text":"import software.aws.pdk.aws_arch.AwsArchitecture;\n\nAwsArchitecture.resolveAssetPath(java.lang.String assetPath)\n
Resolve relative asset path to absolute asset path.
"},{"location":"api/java/aws-arch/index.html#assetpathrequired_1","title":"assetPath
Required","text":"
- Type: java.lang.String
The relative asset path to resolve.
"},{"location":"api/java/aws-arch/index.html#resolveassetsvgdataurl","title":"resolveAssetSvgDataUrl
","text":"import software.aws.pdk.aws_arch.AwsArchitecture;\n\nAwsArchitecture.resolveAssetSvgDataUrl(java.lang.String svgAssetPath)\n
Resolve relative asset path as SVG Data URL.
"},{"location":"api/java/aws-arch/index.html#svgassetpathrequired","title":"
data:image/svg+xml;base64,...
svgAssetPath
Required","text":"
- Type: java.lang.String
The relative path of svg asset to resolve.
"},{"location":"api/java/aws-arch/index.html#properties_14","title":"Properties","text":"Name Type DescriptionassetDirectory
java.lang.String
The absolute directory where AWS Architecture Icons are stored and retrieved.categories
java.util.MapAwsCategory\\> Get all categories.
resources
java.util.MapAwsResource\\> Get all resources.
services
java.util.MapAwsService\\> Get all services."},{"location":"api/java/aws-arch/index.html#assetdirectoryrequired","title":"
assetDirectory
Required","text":"public java.lang.String getAssetDirectory();\n
- Type: java.lang.String
The absolute directory where AWS Architecture Icons are stored and retrieved.
"},{"location":"api/java/aws-arch/index.html#categoriesrequired","title":"categories
Required","text":"public java.util.Map<java.lang.String, AwsCategory> getCategories();\n
- Type: java.util.MapAwsCategory\\>
Get all categories.
{@link AwsCategory.categories }
"},{"location":"api/java/aws-arch/index.html#resourcesrequired","title":"resources
Required","text":"public java.util.Map<java.lang.String, AwsResource> getResources();\n
- Type: java.util.MapAwsResource\\>
Get all resources.
{@link AwsResource.resources }
"},{"location":"api/java/aws-arch/index.html#servicesrequired","title":"services
Required","text":"public java.util.Map<java.lang.String, AwsService> getServices();\n
- Type: java.util.MapAwsService\\>
Get all services.
{@link AwsService.services }
"},{"location":"api/java/aws-arch/index.html#awscategory","title":"AwsCategory","text":"AwsCategory class provides an interface for normalizing category metadata between mapped systems.
"},{"location":"api/java/aws-arch/index.html#methods","title":"Methods","text":"Name DescriptioncategoryServices
Gets a list of all services within this category.icon
Retrieves a well-formatted relative path to the icon for this given category in the specified format."},{"location":"api/java/aws-arch/index.html#categoryservices","title":"categoryServices
","text":"public java.util.List<AwsService> categoryServices()\n
Gets a list of all services within this category.
"},{"location":"api/java/aws-arch/index.html#icon","title":"icon
","text":"public java.lang.String icon(java.lang.String format)\npublic java.lang.String icon(java.lang.String format, java.lang.String theme)\n
Retrieves a well-formatted relative path to the icon for this given category in the specified format.
"},{"location":"api/java/aws-arch/index.html#formatrequired_1","title":"format
Required","text":""},{"location":"api/java/aws-arch/index.html#themeoptional_3","title":"
- Type: java.lang.String
theme
Optional","text":""},{"location":"api/java/aws-arch/index.html#static-functions_1","title":"Static Functions","text":"Name Description
- Type: java.lang.String
getCategory
Get {@link AwsCategory} based on {@link AwsCategoryId}."},{"location":"api/java/aws-arch/index.html#getcategory_1","title":"getCategory
","text":"import software.aws.pdk.aws_arch.AwsCategory;\n\nAwsCategory.getCategory(java.lang.String id)\n
Get {@link AwsCategory} based on {@link AwsCategoryId}.
"},{"location":"api/java/aws-arch/index.html#idrequired_2","title":"id
Required","text":"
- Type: java.lang.String
The id of the category to retrieve.
"},{"location":"api/java/aws-arch/index.html#properties_15","title":"Properties","text":"Name Type Descriptioncategories
java.util.MapAwsCategory\\> Get record of all categories keyed by category id.
fillColor
java.lang.String
Fill color for the category.fontColor
java.lang.String
Font color for the category.gradientColor
java.lang.String
Gradien color for the category.id
java.lang.String
The unique id of the category.name
java.lang.String
The proper name of the category.variants
java.util.List Alternative names used to identity this category.
drawioStyles
AwsCategoryDrawioStyles
Drawio style definition for this category."},{"location":"api/java/aws-arch/index.html#categoriesrequired_1","title":"categories
Required","text":"public java.util.Map<java.lang.String, AwsCategory> getCategories();\n
- Type: java.util.MapAwsCategory\\>
Get record of all categories keyed by category id.
"},{"location":"api/java/aws-arch/index.html#fillcolorrequired_4","title":"fillColor
Required","text":"public java.lang.String getFillColor();\n
- Type: java.lang.String
Fill color for the category.
"},{"location":"api/java/aws-arch/index.html#fontcolorrequired_3","title":"fontColor
Required","text":"public java.lang.String getFontColor();\n
- Type: java.lang.String
Font color for the category.
"},{"location":"api/java/aws-arch/index.html#gradientcolorrequired_4","title":"gradientColor
Required","text":"public java.lang.String getGradientColor();\n
- Type: java.lang.String
Gradien color for the category.
"},{"location":"api/java/aws-arch/index.html#idrequired_3","title":"id
Required","text":"public java.lang.String getId();\n
- Type: java.lang.String
The unique id of the category.
Example
"},{"location":"api/java/aws-arch/index.html#namerequired_1","title":"\"security_identity_compliance\";\n
name
Required","text":"public java.lang.String getName();\n
- Type: java.lang.String
The proper name of the category.
Example
"},{"location":"api/java/aws-arch/index.html#variantsrequired","title":"\"Security, Identity, & Compliance\";\n
variants
Required","text":"public java.util.List<java.lang.String> getVariants();\n
- Type: java.util.List
Alternative names used to identity this category.
"},{"location":"api/java/aws-arch/index.html#drawiostylesoptional","title":"drawioStyles
Optional","text":"public AwsCategoryDrawioStyles getDrawioStyles();\n
- Type: AwsCategoryDrawioStyles
Drawio style definition for this category.
"},{"location":"api/java/aws-arch/index.html#awscategorydrawiostyles","title":"AwsCategoryDrawioStyles","text":"AwsCategoryDrawioStyles is a utility class for constructing drawio shape styles for services and resources.
"},{"location":"api/java/aws-arch/index.html#initializers","title":"Initializers","text":"Name Type Descriptionimport software.aws.pdk.aws_arch.AwsCategoryDrawioStyles;\n\nAwsCategoryDrawioStyles.Builder.create(ShapeNames categoryShape)\n.align(java.lang.String)\n.aspect(java.lang.String)\n.dashed(java.lang.Number)\n.fontSize(java.lang.Number)\n.fontStyle(java.lang.String)\n.fontStyle(java.lang.Number)\n.gradientDirection(java.lang.String)\n.html(java.lang.Number)\n.outlineConnect(java.lang.Number)\n.strokeColor(java.lang.String)\n.verticalAlign(java.lang.String)\n.verticalLabelPosition(java.lang.String)\n// .pointerEvent(java.lang.Number)\n.fillColor(java.lang.String)\n.fontColor(java.lang.String)\n.gradientColor(java.lang.String)\n.build();\n
categoryShape
software.aws.pdk.aws_arch.aws_arch.DrawioSpec.Aws4.ShapeNames
No description.align
java.lang.String
No description.aspect
java.lang.String
No description.dashed
java.lang.Number
No description.fontSize
java.lang.Number
No description.fontStyle
java.lang.String OR java.lang.Number
No description.gradientDirection
java.lang.String
No description.html
java.lang.Number
No description.outlineConnect
java.lang.Number
No description.strokeColor
java.lang.String
No description.verticalAlign
java.lang.String
No description.verticalLabelPosition
java.lang.String
No description.pointerEvent
java.lang.Number
No description.fillColor
java.lang.String
No description.fontColor
java.lang.String
No description.gradientColor
java.lang.String
No description."},{"location":"api/java/aws-arch/index.html#categoryshaperequired","title":"categoryShape
Required","text":""},{"location":"api/java/aws-arch/index.html#alignrequired_4","title":"
- Type: software.aws.pdk.aws_arch.aws_arch.DrawioSpec.Aws4.ShapeNames
align
Required","text":""},{"location":"api/java/aws-arch/index.html#aspectrequired_4","title":"
- Type: java.lang.String
aspect
Required","text":""},{"location":"api/java/aws-arch/index.html#dashedrequired_4","title":"
- Type: java.lang.String
dashed
Required","text":""},{"location":"api/java/aws-arch/index.html#fontsizerequired_4","title":"
- Type: java.lang.Number
fontSize
Required","text":""},{"location":"api/java/aws-arch/index.html#fontstylerequired_4","title":"
- Type: java.lang.Number
fontStyle
Required","text":""},{"location":"api/java/aws-arch/index.html#gradientdirectionrequired_4","title":"
- Type: java.lang.String OR java.lang.Number
gradientDirection
Required","text":""},{"location":"api/java/aws-arch/index.html#htmlrequired_4","title":"
- Type: java.lang.String
html
Required","text":""},{"location":"api/java/aws-arch/index.html#outlineconnectrequired_4","title":"
- Type: java.lang.Number
outlineConnect
Required","text":""},{"location":"api/java/aws-arch/index.html#strokecolorrequired_4","title":"
- Type: java.lang.Number
strokeColor
Required","text":""},{"location":"api/java/aws-arch/index.html#verticalalignrequired_4","title":"
- Type: java.lang.String
verticalAlign
Required","text":""},{"location":"api/java/aws-arch/index.html#verticallabelpositionrequired_4","title":"
- Type: java.lang.String
verticalLabelPosition
Required","text":""},{"location":"api/java/aws-arch/index.html#pointereventoptional_4","title":"
- Type: java.lang.String
pointerEvent
Optional","text":""},{"location":"api/java/aws-arch/index.html#fillcolorrequired_5","title":"
- Type: java.lang.Number
fillColor
Required","text":""},{"location":"api/java/aws-arch/index.html#fontcolorrequired_4","title":"
- Type: java.lang.String
fontColor
Required","text":""},{"location":"api/java/aws-arch/index.html#gradientcolorrequired_5","title":"
- Type: java.lang.String
gradientColor
Required","text":""},{"location":"api/java/aws-arch/index.html#methods_1","title":"Methods","text":"Name Description
- Type: java.lang.String
getResourceStyle
Gets the drawio style for a resource based on the category style.getServiceStyle
Gets the drawio style for a service based on the category style."},{"location":"api/java/aws-arch/index.html#getresourcestyle","title":"getResourceStyle
","text":"public AwsDrawioShapeStyle getResourceStyle(ShapeNames resourceShape)\n
Gets the drawio style for a resource based on the category style.
"},{"location":"api/java/aws-arch/index.html#resourceshaperequired","title":"resourceShape
Required","text":"
- Type: software.aws.pdk.aws_arch.aws_arch.DrawioSpec.Aws4.ShapeNames
The resource shape to style based on category.
"},{"location":"api/java/aws-arch/index.html#getservicestyle","title":"getServiceStyle
","text":"public AwsDrawioResourceIconStyle getServiceStyle(ShapeNames serviceShape)\n
Gets the drawio style for a service based on the category style.
"},{"location":"api/java/aws-arch/index.html#serviceshaperequired","title":"serviceShape
Required","text":"
- Type: software.aws.pdk.aws_arch.aws_arch.DrawioSpec.Aws4.ShapeNames
The service shape to style based on category.
"},{"location":"api/java/aws-arch/index.html#properties_16","title":"Properties","text":"Name Type Descriptionbase
software.aws.pdk.aws_arch.aws_arch.DrawioAwsResourceIconStyleBase
No description.categoryShape
software.aws.pdk.aws_arch.aws_arch.DrawioSpec.Aws4.ShapeNames
No description.categoryStyle
AwsDrawioResourceIconStyle
Get the drawio style for this category."},{"location":"api/java/aws-arch/index.html#baserequired_1","title":"base
Required","text":"public DrawioAwsResourceIconStyleBase getBase();\n
"},{"location":"api/java/aws-arch/index.html#categoryshaperequired_1","title":"
- Type: software.aws.pdk.aws_arch.aws_arch.DrawioAwsResourceIconStyleBase
categoryShape
Required","text":"public ShapeNames getCategoryShape();\n
"},{"location":"api/java/aws-arch/index.html#categorystylerequired","title":"
- Type: software.aws.pdk.aws_arch.aws_arch.DrawioSpec.Aws4.ShapeNames
categoryStyle
Required","text":"public AwsDrawioResourceIconStyle getCategoryStyle();\n
- Type: AwsDrawioResourceIconStyle
Get the drawio style for this category.
"},{"location":"api/java/aws-arch/index.html#awsresource","title":"AwsResource","text":"AwsResource class provides an interface for normalizing resource metadata between mapped systems.
"},{"location":"api/java/aws-arch/index.html#methods_2","title":"Methods","text":"Name DescriptiondrawioStyle
Gets the draiwio style for the resource.getCategoryIcon
Gets the category icon for the resource.getGeneralIcon
Gets the general icon for the resource if available.getResourceIcon
Gets the resource specific icon for the resource.getServiceIcon
Gets the service icon for the resource.icon
Gets the best icon match for the resource following the order of: 1."},{"location":"api/java/aws-arch/index.html#drawiostyle","title":"drawioStyle
","text":"public AwsDrawioShapeStyle drawioStyle()\n
Gets the draiwio style for the resource.
"},{"location":"api/java/aws-arch/index.html#getcategoryicon","title":"getCategoryIcon
","text":"public java.lang.String getCategoryIcon(java.lang.String format)\npublic java.lang.String getCategoryIcon(java.lang.String format, java.lang.String theme)\n
Gets the category icon for the resource.
This maybe different than {@link AwsResource.service.category.icon } based on mappings overrides, which if do not exist will fallback to {@link AwsResource.service.category.icon }.
{@link AwsService.icon }
"},{"location":"api/java/aws-arch/index.html#formatrequired_2","title":"format
Required","text":"
- Type: java.lang.String
The format of icon.
"},{"location":"api/java/aws-arch/index.html#themeoptional_4","title":"theme
Optional","text":"
- Type: java.lang.String
Optional theme.
"},{"location":"api/java/aws-arch/index.html#getgeneralicon","title":"getGeneralIcon
","text":"public java.lang.String getGeneralIcon(java.lang.String format)\npublic java.lang.String getGeneralIcon(java.lang.String format, java.lang.String theme)\n
Gets the general icon for the resource if available.
"},{"location":"api/java/aws-arch/index.html#formatrequired_3","title":"format
Required","text":"
- Type: java.lang.String
The format of icon.
"},{"location":"api/java/aws-arch/index.html#themeoptional_5","title":"theme
Optional","text":"
- Type: java.lang.String
Optional theme.
"},{"location":"api/java/aws-arch/index.html#getresourceicon","title":"getResourceIcon
","text":"public java.lang.String getResourceIcon(java.lang.String format)\npublic java.lang.String getResourceIcon(java.lang.String format, java.lang.String theme)\n
Gets the resource specific icon for the resource.
"},{"location":"api/java/aws-arch/index.html#formatrequired_4","title":"format
Required","text":"
- Type: java.lang.String
The format of icon.
"},{"location":"api/java/aws-arch/index.html#themeoptional_6","title":"theme
Optional","text":"
- Type: java.lang.String
Optional theme.
"},{"location":"api/java/aws-arch/index.html#getserviceicon","title":"getServiceIcon
","text":"public java.lang.String getServiceIcon(java.lang.String format)\npublic java.lang.String getServiceIcon(java.lang.String format, java.lang.String theme)\n
Gets the service icon for the resource.
This maybe different than {@link AwsResource.service.icon } based on mappings overrides, which if do not exist will fallback to {@link AwsResource.service.icon }.
{@link AwsService.icon }
"},{"location":"api/java/aws-arch/index.html#formatrequired_5","title":"format
Required","text":"
- Type: java.lang.String
The format of icon.
"},{"location":"api/java/aws-arch/index.html#themeoptional_7","title":"theme
Optional","text":"
- Type: java.lang.String
Optional theme.
"},{"location":"api/java/aws-arch/index.html#icon_1","title":"icon
","text":"public java.lang.String icon(java.lang.String format)\npublic java.lang.String icon(java.lang.String format, java.lang.String theme)\n
Gets the best icon match for the resource following the order of: 1.
explicit resource icon 2. general icon 3. service icon
"},{"location":"api/java/aws-arch/index.html#formatrequired_6","title":"format
Required","text":"
- Type: java.lang.String
The format of icon.
"},{"location":"api/java/aws-arch/index.html#themeoptional_8","title":"theme
Optional","text":"
- Type: java.lang.String
Optional theme.
"},{"location":"api/java/aws-arch/index.html#static-functions_2","title":"Static Functions","text":"Name DescriptionfindResource
Find {@link AwsResource} associated with given value.getResource
Get {@link AwsResource} by CloudFormation resource type."},{"location":"api/java/aws-arch/index.html#findresource","title":"findResource
","text":"import software.aws.pdk.aws_arch.AwsResource;\n\nAwsResource.findResource(java.lang.String value)\n
Find {@link AwsResource} associated with given value.
"},{"location":"api/java/aws-arch/index.html#valuerequired","title":"value
Required","text":"
- Type: java.lang.String
The value to match {@link AwsResource};
can be id, asset key, full name, etc.
"},{"location":"api/java/aws-arch/index.html#getresource_1","title":"getResource
","text":"import software.aws.pdk.aws_arch.AwsResource;\n\nAwsResource.getResource(java.lang.String cfnResourceType)\n
Get {@link AwsResource} by CloudFormation resource type.
"},{"location":"api/java/aws-arch/index.html#cfnresourcetyperequired","title":"cfnResourceType
Required","text":"
- Type: java.lang.String
Fully qualifief CloudFormation resource type (eg: AWS:S3:Bucket).
"},{"location":"api/java/aws-arch/index.html#properties_17","title":"Properties","text":"Name Type Descriptionresources
java.util.MapAwsResource\\> Get record of all resources keyed by resource id.
cfnResourceType
java.lang.String
Fully-qualified CloudFormation resource type (eg: \"AWS:S3:Bucket\").service
AwsService
The {@link AwsService} the resource belongs to.drawioShape
software.aws.pdk.aws_arch.aws_arch.DrawioSpec.Aws4.ShapeNames
The drawio shape mapped to this resource, or undefined if no mapping.fullName
java.lang.String
The proper full name of the resource."},{"location":"api/java/aws-arch/index.html#resourcesrequired_1","title":"resources
Required","text":"public java.util.Map<java.lang.String, AwsResource> getResources();\n
- Type: java.util.MapAwsResource\\>
Get record of all resources keyed by resource id.
"},{"location":"api/java/aws-arch/index.html#cfnresourcetyperequired_1","title":"cfnResourceType
Required","text":"public java.lang.String getCfnResourceType();\n
- Type: java.lang.String
Fully-qualified CloudFormation resource type (eg: \"AWS:S3:Bucket\").
"},{"location":"api/java/aws-arch/index.html#servicerequired","title":"service
Required","text":"public AwsService getService();\n
- Type: AwsService
The {@link AwsService} the resource belongs to.
"},{"location":"api/java/aws-arch/index.html#drawioshapeoptional","title":"drawioShape
Optional","text":"public ShapeNames getDrawioShape();\n
- Type: software.aws.pdk.aws_arch.aws_arch.DrawioSpec.Aws4.ShapeNames
The drawio shape mapped to this resource, or undefined if no mapping.
"},{"location":"api/java/aws-arch/index.html#fullnameoptional","title":"fullName
Optional","text":"public java.lang.String getFullName();\n
- Type: java.lang.String
The proper full name of the resource.
Example
"},{"location":"api/java/aws-arch/index.html#awsservice","title":"AwsService","text":"// Example automatically generated from non-compiling source. May contain errors.\n\"Bucket\" , \"Amazon S3 on Outposts\";\n
AwsService class provides an interface for normalizing service metadata between mapped systems.
"},{"location":"api/java/aws-arch/index.html#methods_3","title":"Methods","text":"Name DescriptiondrawioStyle
Get drawio style for this service.icon
Get relative asset icon for the service for a given format and optional theme.serviceResources
List all resources of this service."},{"location":"api/java/aws-arch/index.html#drawiostyle_1","title":"drawioStyle
","text":"public AwsDrawioResourceIconStyle drawioStyle()\n
Get drawio style for this service.
"},{"location":"api/java/aws-arch/index.html#icon_2","title":"icon
","text":"public java.lang.String icon(java.lang.String format)\npublic java.lang.String icon(java.lang.String format, java.lang.String theme)\n
Get relative asset icon for the service for a given format and optional theme.
"},{"location":"api/java/aws-arch/index.html#formatrequired_7","title":"format
Required","text":"
- Type: java.lang.String
The format of icon.
"},{"location":"api/java/aws-arch/index.html#themeoptional_9","title":"theme
Optional","text":"
- Type: java.lang.String
Optional theme.
"},{"location":"api/java/aws-arch/index.html#serviceresources","title":"serviceResources
","text":"public java.util.List<AwsResource> serviceResources()\n
List all resources of this service.
"},{"location":"api/java/aws-arch/index.html#static-functions_3","title":"Static Functions","text":"Name DescriptionfindService
Finds the {@link AwsService} associated with a given value.getService
Get {@link AwsService} by CloudFormation \"service\" name, where service name is expressed as<provider>::<service>::<resource>
."},{"location":"api/java/aws-arch/index.html#findservice","title":"findService
","text":"import software.aws.pdk.aws_arch.AwsService;\n\nAwsService.findService(java.lang.String value)\n
Finds the {@link AwsService} associated with a given value.
"},{"location":"api/java/aws-arch/index.html#valuerequired_1","title":"value
Required","text":"
- Type: java.lang.String
Value to match {@link AwsService}, which can be
"},{"location":"api/java/aws-arch/index.html#getservice_1","title":"id
,assetKey
,fullName
, etc.getService
","text":"import software.aws.pdk.aws_arch.AwsService;\n\nAwsService.getService(java.lang.String cfnService)\n
Get {@link AwsService} by CloudFormation \"service\" name, where service name is expressed as
"},{"location":"api/java/aws-arch/index.html#cfnservicerequired","title":"<provider>::<service>::<resource>
.cfnService
Required","text":"
- Type: java.lang.String
The service name to retrieve {@link AwsService} for.
"},{"location":"api/java/aws-arch/index.html#properties_18","title":"Properties","text":"Name Type Descriptionservices
java.util.MapAwsService\\> Get record of all {@link AwsService}s keyed by
id
.cfnProvider
java.lang.String
The CloudFormation \"provider\" for the service, as expressed by<provicer>::<service>::<resource>
.cfnService
java.lang.String
The CloudFormation \"service\" for the service, as expressed by<provicer>::<service>::<resource>
.fullName
java.lang.String
The proper full name of the service.category
AwsCategory
The category the service belongs to, or undefined if does not belong to a category.drawioShape
software.aws.pdk.aws_arch.aws_arch.DrawioSpec.Aws4.ShapeNames
Drawio shape associated with this service, or undefined if service not mapped to draiwio shape.pricingMetadata
software.aws.pdk.aws_arch.aws_arch.PricingManifest.Service
Get service pricing metadata.pricingServiceCode
java.lang.String
The pricingserviceCode
associated with this service, or undefined if service not mapped to pricing."},{"location":"api/java/aws-arch/index.html#servicesrequired_1","title":"services
Required","text":"public java.util.Map<java.lang.String, AwsService> getServices();\n
- Type: java.util.MapAwsService\\>
Get record of all {@link AwsService}s keyed by
"},{"location":"api/java/aws-arch/index.html#cfnproviderrequired","title":"id
.cfnProvider
Required","text":"public java.lang.String getCfnProvider();\n
- Type: java.lang.String
The CloudFormation \"provider\" for the service, as expressed by
"},{"location":"api/java/aws-arch/index.html#cfnservicerequired_1","title":"<provicer>::<service>::<resource>
.cfnService
Required","text":"public java.lang.String getCfnService();\n
- Type: java.lang.String
The CloudFormation \"service\" for the service, as expressed by
"},{"location":"api/java/aws-arch/index.html#fullnamerequired","title":"<provicer>::<service>::<resource>
.fullName
Required","text":"public java.lang.String getFullName();\n
- Type: java.lang.String
The proper full name of the service.
Example
"},{"location":"api/java/aws-arch/index.html#categoryoptional","title":"// Example automatically generated from non-compiling source. May contain errors.\n\"AWS Glue\" , \"Amazon S3\";\n
category
Optional","text":"public AwsCategory getCategory();\n
- Type: AwsCategory
The category the service belongs to, or undefined if does not belong to a category.
"},{"location":"api/java/aws-arch/index.html#drawioshapeoptional_1","title":"drawioShape
Optional","text":"public ShapeNames getDrawioShape();\n
- Type: software.aws.pdk.aws_arch.aws_arch.DrawioSpec.Aws4.ShapeNames
Drawio shape associated with this service, or undefined if service not mapped to draiwio shape.
"},{"location":"api/java/aws-arch/index.html#pricingmetadataoptional","title":"pricingMetadata
Optional","text":"public Service getPricingMetadata();\n
- Type: software.aws.pdk.aws_arch.aws_arch.PricingManifest.Service
Get service pricing metadata.
"},{"location":"api/java/aws-arch/index.html#pricingservicecodeoptional","title":"pricingServiceCode
Optional","text":"public java.lang.String getPricingServiceCode();\n
- Type: java.lang.String
The pricing
"},{"location":"api/java/aws-arch/index.html#enums","title":"Enums","text":""},{"location":"api/java/aws-arch/index.html#darkpalette","title":"DarkPalette","text":"serviceCode
associated with this service, or undefined if service not mapped to pricing.Dark theme color palette.
"},{"location":"api/java/aws-arch/index.html#members","title":"Members","text":"Name DescriptionPUBLIC
No description.PRIVATE
No description.GENERIC
No description.PRIMARY
No description.SECONDARY
No description.TERTIARY
No description."},{"location":"api/java/aws-arch/index.html#public","title":"PUBLIC
","text":""},{"location":"api/java/aws-arch/index.html#private","title":"PRIVATE
","text":""},{"location":"api/java/aws-arch/index.html#generic","title":"GENERIC
","text":""},{"location":"api/java/aws-arch/index.html#primary","title":"PRIMARY
","text":""},{"location":"api/java/aws-arch/index.html#secondary","title":"SECONDARY
","text":""},{"location":"api/java/aws-arch/index.html#tertiary","title":"TERTIARY
","text":""},{"location":"api/java/aws-arch/index.html#drawioaws4parentshapes","title":"DrawioAws4ParentShapes","text":"Draiwio aws4 parent shapes enum.
"},{"location":"api/java/aws-arch/index.html#members_1","title":"Members","text":"Name DescriptionRESOURCE_ICON
No description."},{"location":"api/java/aws-arch/index.html#resource_icon","title":"RESOURCE_ICON
","text":""},{"location":"api/java/aws-arch/index.html#lightpalette","title":"LightPalette","text":"Light theme color palette.
"},{"location":"api/java/aws-arch/index.html#members_2","title":"Members","text":"Name DescriptionPUBLIC
No description.PRIVATE
No description.GENERIC
No description.PRIMARY
No description.SECONDARY
No description.TERTIARY
No description."},{"location":"api/java/aws-arch/index.html#public_1","title":"PUBLIC
","text":""},{"location":"api/java/aws-arch/index.html#private_1","title":"PRIVATE
","text":""},{"location":"api/java/aws-arch/index.html#generic_1","title":"GENERIC
","text":""},{"location":"api/java/aws-arch/index.html#primary_1","title":"PRIMARY
","text":""},{"location":"api/java/aws-arch/index.html#secondary_1","title":"SECONDARY
","text":""},{"location":"api/java/aws-arch/index.html#tertiary_1","title":"TERTIARY
","text":""},{"location":"api/java/cdk-graph/index.html","title":"API Reference","text":""},{"location":"api/java/cdk-graph/index.html#constructs","title":"Constructs","text":""},{"location":"api/java/cdk-graph/index.html#cdkgraph","title":"CdkGraph","text":"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.
"},{"location":"api/java/cdk-graph/index.html#initializers","title":"Initializers","text":"Name Type Descriptionimport software.aws.pdk.cdk_graph.CdkGraph;\n\nCdkGraph.Builder.create(Construct root)\n// .plugins(java.util.List<ICdkGraphPlugin>)\n.build();\n
root
software.constructs.Construct
No description.plugins
java.util.List<ICdkGraphPlugin>
List of plugins to extends the graph."},{"location":"api/java/cdk-graph/index.html#rootrequired","title":"root
Required","text":""},{"location":"api/java/cdk-graph/index.html#pluginsoptional","title":"
- Type: software.constructs.Construct
plugins
Optional","text":"
- Type: java.util.List<ICdkGraphPlugin>
List of plugins to extends the graph.
Plugins are invoked at each phases in fifo order.
"},{"location":"api/java/cdk-graph/index.html#methods","title":"Methods","text":"Name DescriptiontoString
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."},{"location":"api/java/cdk-graph/index.html#tostring","title":"toString
","text":"public java.lang.String toString()\n
Returns a string representation of this construct.
"},{"location":"api/java/cdk-graph/index.html#report","title":"report
","text":"public void report()\n
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
"},{"location":"api/java/cdk-graph/index.html#static-functions","title":"Static Functions","text":"Name Descriptionreport
rather thansynthesize
.isConstruct
Checks ifx
is a construct."},{"location":"api/java/cdk-graph/index.html#isconstruct","title":"isConstruct
","text":"import software.aws.pdk.cdk_graph.CdkGraph;\n\nCdkGraph.isConstruct(java.lang.Object x)\n
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
"},{"location":"api/java/cdk-graph/index.html#xrequired","title":"constructs
library on disk are seen as independent, completely different libraries. As a consequence, the classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
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 theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.x
Required","text":"
- Type: java.lang.Object
Any object.
"},{"location":"api/java/cdk-graph/index.html#properties","title":"Properties","text":"Name Type Descriptionnode
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."},{"location":"api/java/cdk-graph/index.html#noderequired","title":"node
Required","text":"public Node getNode();\n
- Type: software.constructs.Node
The tree node.
"},{"location":"api/java/cdk-graph/index.html#configrequired","title":"config
Required","text":"public java.util.Map<java.lang.String, java.lang.Object> getConfig();\n
- Type: java.util.Map
Config.
"},{"location":"api/java/cdk-graph/index.html#pluginsrequired","title":"plugins
Required","text":"public java.util.List<ICdkGraphPlugin> getPlugins();\n
- Type: java.util.List<ICdkGraphPlugin>
List of plugins registered with this instance.
"},{"location":"api/java/cdk-graph/index.html#rootrequired_1","title":"root
Required","text":"public Construct getRoot();\n
"},{"location":"api/java/cdk-graph/index.html#graphcontextoptional","title":"
- Type: software.constructs.Construct
graphContext
Optional","text":"public CdkGraphContext getGraphContext();\n
- Type: CdkGraphContext
Get the context for the graph instance.
This will be
"},{"location":"api/java/cdk-graph/index.html#constants","title":"Constants","text":"Name Type Descriptionundefined
before construct synthesis has initiated.ID
java.lang.String
Fixed CdkGraph construct id.VERSION
java.lang.String
Current CdkGraph semantic version."},{"location":"api/java/cdk-graph/index.html#idrequired","title":"ID
Required","text":"public java.lang.String getId();\n
- Type: java.lang.String
Fixed CdkGraph construct id.
"},{"location":"api/java/cdk-graph/index.html#versionrequired","title":"VERSION
Required","text":"public java.lang.String getVersion();\n
- Type: java.lang.String
Current CdkGraph semantic version.
"},{"location":"api/java/cdk-graph/index.html#structs","title":"Structs","text":""},{"location":"api/java/cdk-graph/index.html#cdkgraphartifact","title":"CdkGraphArtifact","text":"CdkGraph artifact definition.
"},{"location":"api/java/cdk-graph/index.html#initializer","title":"Initializer","text":""},{"location":"api/java/cdk-graph/index.html#properties_1","title":"Properties","text":"Name Type Descriptionimport software.aws.pdk.cdk_graph.CdkGraphArtifact;\n\nCdkGraphArtifact.builder()\n.filename(java.lang.String)\n.filepath(java.lang.String)\n.id(java.lang.String)\n.source(java.lang.String)\n// .description(java.lang.String)\n.build();\n
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."},{"location":"api/java/cdk-graph/index.html#filenamerequired","title":"filename
Required","text":"public java.lang.String getFilename();\n
- Type: java.lang.String
Filename of the artifact.
"},{"location":"api/java/cdk-graph/index.html#filepathrequired","title":"filepath
Required","text":"public java.lang.String getFilepath();\n
- Type: java.lang.String
Full path where artifact is stored.
"},{"location":"api/java/cdk-graph/index.html#idrequired_1","title":"id
Required","text":"public java.lang.String getId();\n
- Type: java.lang.String
The unique type of the artifact.
"},{"location":"api/java/cdk-graph/index.html#sourcerequired","title":"source
Required","text":"public java.lang.String getSource();\n
- Type: java.lang.String
The source of the artifact (such as plugin, or core system, etc).
"},{"location":"api/java/cdk-graph/index.html#descriptionoptional","title":"description
Optional","text":"public java.lang.String getDescription();\n
- Type: java.lang.String
Description of artifact.
"},{"location":"api/java/cdk-graph/index.html#constructinfo","title":"ConstructInfo","text":"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
"},{"location":"api/java/cdk-graph/index.html#initializer_1","title":"Initializer","text":""},{"location":"api/java/cdk-graph/index.html#properties_2","title":"Properties","text":"Name Type Descriptionimport software.aws.pdk.cdk_graph.ConstructInfo;\n\nConstructInfo.builder()\n.fqn(java.lang.String)\n.version(java.lang.String)\n.build();\n
fqn
java.lang.String
No description.version
java.lang.String
No description."},{"location":"api/java/cdk-graph/index.html#fqnrequired","title":"fqn
Required","text":"public java.lang.String getFqn();\n
"},{"location":"api/java/cdk-graph/index.html#versionrequired_1","title":"
- Type: java.lang.String
version
Required","text":"public java.lang.String getVersion();\n
"},{"location":"api/java/cdk-graph/index.html#filtervalue","title":"FilterValue","text":"
- Type: java.lang.String
Filter value to use.
"},{"location":"api/java/cdk-graph/index.html#initializer_2","title":"Initializer","text":""},{"location":"api/java/cdk-graph/index.html#properties_3","title":"Properties","text":"Name Type Descriptionimport software.aws.pdk.cdk_graph.FilterValue;\n\nFilterValue.builder()\n// .regex(java.lang.String)\n// .value(java.lang.String)\n.build();\n
regex
java.lang.String
String representation of a regex.value
java.lang.String
Raw value."},{"location":"api/java/cdk-graph/index.html#regexoptional","title":"regex
Optional","text":"public java.lang.String getRegex();\n
- Type: java.lang.String
String representation of a regex.
"},{"location":"api/java/cdk-graph/index.html#valueoptional","title":"value
Optional","text":"public java.lang.String getValue();\n
- Type: java.lang.String
Raw value.
"},{"location":"api/java/cdk-graph/index.html#icdkgraphprops","title":"ICdkGraphProps","text":"{@link CdkGraph} props.
"},{"location":"api/java/cdk-graph/index.html#initializer_3","title":"Initializer","text":""},{"location":"api/java/cdk-graph/index.html#properties_4","title":"Properties","text":"Name Type Descriptionimport software.aws.pdk.cdk_graph.ICdkGraphProps;\n\nICdkGraphProps.builder()\n// .plugins(java.util.List<ICdkGraphPlugin>)\n.build();\n
plugins
java.util.List<ICdkGraphPlugin>
List of plugins to extends the graph."},{"location":"api/java/cdk-graph/index.html#pluginsoptional_1","title":"plugins
Optional","text":"public java.util.List<ICdkGraphPlugin> getPlugins();\n
- Type: java.util.List<ICdkGraphPlugin>
List of plugins to extends the graph.
Plugins are invoked at each phases in fifo order.
"},{"location":"api/java/cdk-graph/index.html#ifilter","title":"IFilter","text":"A filter than can be applied to the graph.
"},{"location":"api/java/cdk-graph/index.html#initializer_4","title":"Initializer","text":""},{"location":"api/java/cdk-graph/index.html#properties_5","title":"Properties","text":"Name Type Descriptionimport software.aws.pdk.cdk_graph.IFilter;\n\nIFilter.builder()\n// .graph(IGraphFilter)\n// .store(IGraphStoreFilter)\n.build();\n
graph
IGraphFilter
Graph Filter.store
IGraphStoreFilter
Store Filter."},{"location":"api/java/cdk-graph/index.html#graphoptional","title":"graph
Optional","text":"public IGraphFilter getGraph();\n
- Type: IGraphFilter
Graph Filter.
"},{"location":"api/java/cdk-graph/index.html#storeoptional","title":"store
Optional","text":"public IGraphStoreFilter getStore();\n
- Type: IGraphStoreFilter
Store Filter.
"},{"location":"api/java/cdk-graph/index.html#igraphfilter","title":"IGraphFilter","text":"Graph filter.
"},{"location":"api/java/cdk-graph/index.html#initializer_5","title":"Initializer","text":""},{"location":"api/java/cdk-graph/index.html#properties_6","title":"Properties","text":"Name Type Descriptionimport software.aws.pdk.cdk_graph.IGraphFilter;\n\nIGraphFilter.builder()\n// .allNodes(java.lang.Boolean)\n// .edge(IEdgePredicate)\n// .inverse(java.lang.Boolean)\n// .node(INodePredicate)\n// .strategy(FilterStrategy)\n.build();\n
allNodes
java.lang.Boolean
Indicates that all nodes will be filtered, rather than just Resource and CfnResource nodes.edge
IEdgePredicate
Predicate to match edges.inverse
java.lang.Boolean
Indicates that matches will be filtered, as opposed to non-matches.node
INodePredicate
Predicate to match nodes.strategy
FilterStrategy
Filter strategy to apply to matching nodes."},{"location":"api/java/cdk-graph/index.html#allnodesoptional","title":"allNodes
Optional","text":"public java.lang.Boolean getAllNodes();\n
- Type: java.lang.Boolean
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 {@link IGraphFilterPlan.allNodes}
"},{"location":"api/java/cdk-graph/index.html#edgeoptional","title":"edge
Optional","text":"public IEdgePredicate getEdge();\n
- Type: IEdgePredicate
Predicate to match edges.
Edges are evaluated after nodes are filtered.
"},{"location":"api/java/cdk-graph/index.html#inverseoptional","title":"inverse
Optional","text":"public java.lang.Boolean getInverse();\n
- Type: java.lang.Boolean
- Default: false - Preserve matches, and filter out non-matches.
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.
"},{"location":"api/java/cdk-graph/index.html#nodeoptional","title":"node
Optional","text":"public INodePredicate getNode();\n
- Type: INodePredicate
Predicate to match nodes.
"},{"location":"api/java/cdk-graph/index.html#strategyoptional","title":"strategy
Optional","text":"public FilterStrategy getStrategy();\n
- Type: FilterStrategy
- Default: {FilterStrategy.PRUNE}
Filter strategy to apply to matching nodes.
Edges do not have a strategy, they are always pruned.
"},{"location":"api/java/cdk-graph/index.html#igraphfilterplan","title":"IGraphFilterPlan","text":"Graph filter plan.
"},{"location":"api/java/cdk-graph/index.html#initializer_6","title":"Initializer","text":""},{"location":"api/java/cdk-graph/index.html#properties_7","title":"Properties","text":"Name Type Descriptionimport software.aws.pdk.cdk_graph.IGraphFilterPlan;\n\nIGraphFilterPlan.builder()\n// .allNodes(java.lang.Boolean)\n// .filters(java.util.List<IFilter>)\n// .focus(IGraphFilterPlanFocusConfig)\n// .order(ConstructOrder)\n// .preset(FilterPreset)\n.build();\n
allNodes
java.lang.Boolean
Indicates that all nodes will be filtered, rather than just Resource and CfnResource nodes.filters
java.util.List<IFilter>
Ordered list of {@link IGraphFilter} and {@link IGraphStoreFilter} filters to apply to the store.focus
IGraphFilterPlanFocusConfig
Config to focus the graph on specific node.order
software.constructs.ConstructOrder
The order to visit nodes and edges during filtering.preset
FilterPreset
Optional preset filter to apply before other filters."},{"location":"api/java/cdk-graph/index.html#allnodesoptional_1","title":"allNodes
Optional","text":"public java.lang.Boolean getAllNodes();\n
- Type: java.lang.Boolean
- Default: false By default only Resource and CfnResource nodes are filtered.
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.
"},{"location":"api/java/cdk-graph/index.html#filtersoptional","title":"filters
Optional","text":"public java.util.List<IFilter> getFilters();\n
- Type: java.util.List<IFilter>
Ordered list of {@link IGraphFilter} and {@link IGraphStoreFilter} filters to apply to the store.
"},{"location":"api/java/cdk-graph/index.html#focusoptional","title":"
- 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.
focus
Optional","text":"public IGraphFilterPlanFocusConfig getFocus();\n
- Type: IGraphFilterPlanFocusConfig
Config to focus the graph on specific node.
"},{"location":"api/java/cdk-graph/index.html#orderoptional","title":"order
Optional","text":"public ConstructOrder getOrder();\n
- Type: software.constructs.ConstructOrder
- Default: {ConstructOrder.PREORDER}
The order to visit nodes and edges during filtering.
"},{"location":"api/java/cdk-graph/index.html#presetoptional","title":"preset
Optional","text":"public FilterPreset getPreset();\n
- Type: FilterPreset
Optional preset filter to apply before other filters.
"},{"location":"api/java/cdk-graph/index.html#igraphfilterplanfocusconfig","title":"IGraphFilterPlanFocusConfig","text":""},{"location":"api/java/cdk-graph/index.html#initializer_7","title":"Initializer","text":""},{"location":"api/java/cdk-graph/index.html#properties_8","title":"Properties","text":"Name Type Descriptionimport software.aws.pdk.cdk_graph.IGraphFilterPlanFocusConfig;\n\nIGraphFilterPlanFocusConfig.builder()\n.filter(IFilterFocusCallback)\n// .noHoist(java.lang.Boolean)\n.build();\n
filter
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)."},{"location":"api/java/cdk-graph/index.html#filterrequired","title":"filter
Required","text":"public IFilterFocusCallback getFilter();\n
- Type: IFilterFocusCallback
The node or resolver to determine the node to focus on.
"},{"location":"api/java/cdk-graph/index.html#nohoistoptional","title":"noHoist
Optional","text":"public java.lang.Boolean getNoHoist();\n
- Type: java.lang.Boolean
- Default: true
Indicates if ancestral containers are preserved (eg: Stages, Stack).
If
"},{"location":"api/java/cdk-graph/index.html#inferrednodeprops","title":"InferredNodeProps","text":"false
, the \"focused node\" will be hoisted to the graph root and all ancestors will be pruned. Iftrue
, the \"focused\" will be left in-place, while all siblings and non-scope ancestors will be pruned.Inferred node props.
"},{"location":"api/java/cdk-graph/index.html#initializer_8","title":"Initializer","text":""},{"location":"api/java/cdk-graph/index.html#properties_9","title":"Properties","text":"Name Type Descriptionimport software.aws.pdk.cdk_graph.InferredNodeProps;\n\nInferredNodeProps.builder()\n.uuid(java.lang.String)\n// .attributes(java.util.Map<java.lang.String, java.lang.String)\n// .attributes(java.lang.Number)\n// .attributes(java.lang.Boolean)\n// .attributes(PlainObject)\n// .attributes(java.util.List<java.lang.String)\n// .attributes(java.lang.Number)\n// .attributes(java.lang.Boolean)\n// .attributes(PlainObject>>)\n// .flags(java.util.List<FlagEnum>)\n// .metadata(java.util.List<MetadataEntry>)\n// .tags(java.util.Map<java.lang.String, java.lang.String>)\n.dependencies(java.util.List<java.lang.String>)\n.unresolvedReferences(java.util.List<SGUnresolvedReference>)\n// .cfnType(java.lang.String)\n// .constructInfo(ConstructInfo)\n// .logicalId(java.lang.String)\n.build();\n
uuid
java.lang.String
Universally unique identity.attributes
java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>> 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."},{"location":"api/java/cdk-graph/index.html#uuidrequired","title":"uuid
Required","text":"public java.lang.String getUuid();\n
- Type: java.lang.String
Universally unique identity.
"},{"location":"api/java/cdk-graph/index.html#attributesoptional","title":"attributes
Optional","text":"public java.lang.Object getAttributes();\n
- Type: java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>>
Serializable entity attributes.
{@link Attributes }
"},{"location":"api/java/cdk-graph/index.html#flagsoptional","title":"flags
Optional","text":"public java.util.List<FlagEnum> getFlags();\n
- Type: java.util.List<FlagEnum>
Serializable entity flags.
{@link FlagEnum }
"},{"location":"api/java/cdk-graph/index.html#metadataoptional","title":"metadata
Optional","text":"public java.util.List<MetadataEntry> getMetadata();\n
- Type: java.util.List
Serializable entity metadata.
{@link Metadata }
"},{"location":"api/java/cdk-graph/index.html#tagsoptional","title":"tags
Optional","text":"public java.util.Map<java.lang.String, java.lang.String> getTags();\n
- Type: java.util.Map
Serializable entity tags.
{@link Tags }
"},{"location":"api/java/cdk-graph/index.html#dependenciesrequired","title":"dependencies
Required","text":"public java.util.List<java.lang.String> getDependencies();\n
- Type: java.util.List"},{"location":"api/java/cdk-graph/index.html#unresolvedreferencesrequired","title":"
unresolvedReferences
Required","text":"public java.util.List<SGUnresolvedReference> getUnresolvedReferences();\n
"},{"location":"api/java/cdk-graph/index.html#cfntypeoptional","title":"
- Type: java.util.List<SGUnresolvedReference>
cfnType
Optional","text":"public java.lang.String getCfnType();\n
"},{"location":"api/java/cdk-graph/index.html#constructinfooptional","title":"
- Type: java.lang.String
constructInfo
Optional","text":"public ConstructInfo getConstructInfo();\n
"},{"location":"api/java/cdk-graph/index.html#logicalidoptional","title":"
- Type: ConstructInfo
logicalId
Optional","text":"public java.lang.String getLogicalId();\n
"},{"location":"api/java/cdk-graph/index.html#plainobject","title":"PlainObject","text":"
- Type: java.lang.String
Serializable plain object value (JSII supported).
"},{"location":"api/java/cdk-graph/index.html#initializer_9","title":"Initializer","text":""},{"location":"api/java/cdk-graph/index.html#sgedge","title":"SGEdge","text":"import software.aws.pdk.cdk_graph.PlainObject;\n\nPlainObject.builder()\n.build();\n
Serializable graph edge entity.
"},{"location":"api/java/cdk-graph/index.html#initializer_10","title":"Initializer","text":""},{"location":"api/java/cdk-graph/index.html#properties_10","title":"Properties","text":"Name Type Descriptionimport software.aws.pdk.cdk_graph.SGEdge;\n\nSGEdge.builder()\n.uuid(java.lang.String)\n// .attributes(java.util.Map<java.lang.String, java.lang.String)\n// .attributes(java.lang.Number)\n// .attributes(java.lang.Boolean)\n// .attributes(PlainObject)\n// .attributes(java.util.List<java.lang.String)\n// .attributes(java.lang.Number)\n// .attributes(java.lang.Boolean)\n// .attributes(PlainObject>>)\n// .flags(java.util.List<FlagEnum>)\n// .metadata(java.util.List<MetadataEntry>)\n// .tags(java.util.Map<java.lang.String, java.lang.String>)\n.direction(EdgeDirectionEnum)\n.edgeType(EdgeTypeEnum)\n.source(java.lang.String)\n.target(java.lang.String)\n.build();\n
uuid
java.lang.String
Universally unique identity.attributes
java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>> 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)."},{"location":"api/java/cdk-graph/index.html#uuidrequired_1","title":"uuid
Required","text":"public java.lang.String getUuid();\n
- Type: java.lang.String
Universally unique identity.
"},{"location":"api/java/cdk-graph/index.html#attributesoptional_1","title":"attributes
Optional","text":"public java.lang.Object getAttributes();\n
- Type: java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>>
Serializable entity attributes.
{@link Attributes }
"},{"location":"api/java/cdk-graph/index.html#flagsoptional_1","title":"flags
Optional","text":"public java.util.List<FlagEnum> getFlags();\n
- Type: java.util.List<FlagEnum>
Serializable entity flags.
{@link FlagEnum }
"},{"location":"api/java/cdk-graph/index.html#metadataoptional_1","title":"metadata
Optional","text":"public java.util.List<MetadataEntry> getMetadata();\n
- Type: java.util.List
Serializable entity metadata.
{@link Metadata }
"},{"location":"api/java/cdk-graph/index.html#tagsoptional_1","title":"tags
Optional","text":"public java.util.Map<java.lang.String, java.lang.String> getTags();\n
- Type: java.util.Map
Serializable entity tags.
{@link Tags }
"},{"location":"api/java/cdk-graph/index.html#directionrequired","title":"direction
Required","text":"public EdgeDirectionEnum getDirection();\n
- Type: EdgeDirectionEnum
Indicates the direction in which the edge is directed.
"},{"location":"api/java/cdk-graph/index.html#edgetyperequired","title":"edgeType
Required","text":"public EdgeTypeEnum getEdgeType();\n
- Type: EdgeTypeEnum
Type of edge.
"},{"location":"api/java/cdk-graph/index.html#sourcerequired_1","title":"source
Required","text":"public java.lang.String getSource();\n
- Type: java.lang.String
UUID of edge source node (tail).
"},{"location":"api/java/cdk-graph/index.html#targetrequired","title":"target
Required","text":"public java.lang.String getTarget();\n
- Type: java.lang.String
UUID of edge target node (head).
"},{"location":"api/java/cdk-graph/index.html#sgentity","title":"SGEntity","text":"Serializable graph entity.
"},{"location":"api/java/cdk-graph/index.html#initializer_11","title":"Initializer","text":""},{"location":"api/java/cdk-graph/index.html#properties_11","title":"Properties","text":"Name Type Descriptionimport software.aws.pdk.cdk_graph.SGEntity;\n\nSGEntity.builder()\n.uuid(java.lang.String)\n// .attributes(java.util.Map<java.lang.String, java.lang.String)\n// .attributes(java.lang.Number)\n// .attributes(java.lang.Boolean)\n// .attributes(PlainObject)\n// .attributes(java.util.List<java.lang.String)\n// .attributes(java.lang.Number)\n// .attributes(java.lang.Boolean)\n// .attributes(PlainObject>>)\n// .flags(java.util.List<FlagEnum>)\n// .metadata(java.util.List<MetadataEntry>)\n// .tags(java.util.Map<java.lang.String, java.lang.String>)\n.build();\n
uuid
java.lang.String
Universally unique identity.attributes
java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>> 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."},{"location":"api/java/cdk-graph/index.html#uuidrequired_2","title":"
uuid
Required","text":"public java.lang.String getUuid();\n
- Type: java.lang.String
Universally unique identity.
"},{"location":"api/java/cdk-graph/index.html#attributesoptional_2","title":"attributes
Optional","text":"public java.lang.Object getAttributes();\n
- Type: java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>>
Serializable entity attributes.
{@link Attributes }
"},{"location":"api/java/cdk-graph/index.html#flagsoptional_2","title":"flags
Optional","text":"public java.util.List<FlagEnum> getFlags();\n
- Type: java.util.List<FlagEnum>
Serializable entity flags.
{@link FlagEnum }
"},{"location":"api/java/cdk-graph/index.html#metadataoptional_2","title":"metadata
Optional","text":"public java.util.List<MetadataEntry> getMetadata();\n
- Type: java.util.List
Serializable entity metadata.
{@link Metadata }
"},{"location":"api/java/cdk-graph/index.html#tagsoptional_2","title":"tags
Optional","text":"public java.util.Map<java.lang.String, java.lang.String> getTags();\n
- Type: java.util.Map
Serializable entity tags.
{@link Tags }
"},{"location":"api/java/cdk-graph/index.html#sggraphstore","title":"SGGraphStore","text":"Serializable graph store.
"},{"location":"api/java/cdk-graph/index.html#initializer_12","title":"Initializer","text":""},{"location":"api/java/cdk-graph/index.html#properties_12","title":"Properties","text":"Name Type Descriptionimport software.aws.pdk.cdk_graph.SGGraphStore;\n\nSGGraphStore.builder()\n.edges(java.util.List<SGEdge>)\n.tree(SGNode)\n.version(java.lang.String)\n.build();\n
edges
java.util.List<SGEdge>
List of edges.tree
SGNode
Node tree.version
java.lang.String
Store version."},{"location":"api/java/cdk-graph/index.html#edgesrequired","title":"edges
Required","text":"public java.util.List<SGEdge> getEdges();\n
- Type: java.util.List<SGEdge>
List of edges.
"},{"location":"api/java/cdk-graph/index.html#treerequired","title":"tree
Required","text":"public SGNode getTree();\n
- Type: SGNode
Node tree.
"},{"location":"api/java/cdk-graph/index.html#versionrequired_2","title":"version
Required","text":"public java.lang.String getVersion();\n
- Type: java.lang.String
Store version.
"},{"location":"api/java/cdk-graph/index.html#sgnode","title":"SGNode","text":"Serializable graph node entity.
"},{"location":"api/java/cdk-graph/index.html#initializer_13","title":"Initializer","text":""},{"location":"api/java/cdk-graph/index.html#properties_13","title":"Properties","text":"Name Type Descriptionimport software.aws.pdk.cdk_graph.SGNode;\n\nSGNode.builder()\n.uuid(java.lang.String)\n// .attributes(java.util.Map<java.lang.String, java.lang.String)\n// .attributes(java.lang.Number)\n// .attributes(java.lang.Boolean)\n// .attributes(PlainObject)\n// .attributes(java.util.List<java.lang.String)\n// .attributes(java.lang.Number)\n// .attributes(java.lang.Boolean)\n// .attributes(PlainObject>>)\n// .flags(java.util.List<FlagEnum>)\n// .metadata(java.util.List<MetadataEntry>)\n// .tags(java.util.Map<java.lang.String, java.lang.String>)\n.id(java.lang.String)\n.nodeType(NodeTypeEnum)\n.path(java.lang.String)\n// .cfnType(java.lang.String)\n// .children(java.util.Map<java.lang.String, SGNode>)\n// .constructInfo(ConstructInfo)\n// .edges(java.util.List<java.lang.String>)\n// .logicalId(java.lang.String)\n// .parent(java.lang.String)\n// .stack(java.lang.String)\n.build();\n
uuid
java.lang.String
Universally unique identity.attributes
java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>> 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."},{"location":"api/java/cdk-graph/index.html#uuidrequired_3","title":"uuid
Required","text":"public java.lang.String getUuid();\n
- Type: java.lang.String
Universally unique identity.
"},{"location":"api/java/cdk-graph/index.html#attributesoptional_3","title":"attributes
Optional","text":"public java.lang.Object getAttributes();\n
- Type: java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>>
Serializable entity attributes.
{@link Attributes }
"},{"location":"api/java/cdk-graph/index.html#flagsoptional_3","title":"flags
Optional","text":"public java.util.List<FlagEnum> getFlags();\n
- Type: java.util.List<FlagEnum>
Serializable entity flags.
{@link FlagEnum }
"},{"location":"api/java/cdk-graph/index.html#metadataoptional_3","title":"metadata
Optional","text":"public java.util.List<MetadataEntry> getMetadata();\n
- Type: java.util.List
Serializable entity metadata.
{@link Metadata }
"},{"location":"api/java/cdk-graph/index.html#tagsoptional_3","title":"tags
Optional","text":"public java.util.Map<java.lang.String, java.lang.String> getTags();\n
- Type: java.util.Map
Serializable entity tags.
{@link Tags }
"},{"location":"api/java/cdk-graph/index.html#idrequired_2","title":"id
Required","text":"public java.lang.String getId();\n
- Type: java.lang.String
Node id within parent (unique only between parent child nodes).
"},{"location":"api/java/cdk-graph/index.html#nodetyperequired","title":"nodeType
Required","text":"public NodeTypeEnum getNodeType();\n
- Type: NodeTypeEnum
Node type.
"},{"location":"api/java/cdk-graph/index.html#pathrequired","title":"path
Required","text":"public java.lang.String getPath();\n
- Type: java.lang.String
Node path.
"},{"location":"api/java/cdk-graph/index.html#cfntypeoptional_1","title":"cfnType
Optional","text":"public java.lang.String getCfnType();\n
- Type: java.lang.String
CloudFormation resource type for this node.
"},{"location":"api/java/cdk-graph/index.html#childrenoptional","title":"children
Optional","text":"public java.util.Map<java.lang.String, SGNode> getChildren();\n
- Type: java.util.MapSGNode\\>
Child node record.
"},{"location":"api/java/cdk-graph/index.html#constructinfooptional_1","title":"constructInfo
Optional","text":"public ConstructInfo getConstructInfo();\n
- Type: ConstructInfo
Synthesized construct information defining jii resolution data.
"},{"location":"api/java/cdk-graph/index.html#edgesoptional","title":"edges
Optional","text":"public java.util.List<java.lang.String> getEdges();\n
- Type: java.util.List
List of edge UUIDs where this node is the source.
"},{"location":"api/java/cdk-graph/index.html#logicalidoptional_1","title":"logicalId
Optional","text":"public java.lang.String getLogicalId();\n
- Type: java.lang.String
Logical id of the node, which is only unique within containing stack.
"},{"location":"api/java/cdk-graph/index.html#parentoptional","title":"parent
Optional","text":"public java.lang.String getParent();\n
- Type: java.lang.String
UUID of node parent.
"},{"location":"api/java/cdk-graph/index.html#stackoptional","title":"stack
Optional","text":"public java.lang.String getStack();\n
- Type: java.lang.String
UUID of node stack.
"},{"location":"api/java/cdk-graph/index.html#sgunresolvedreference","title":"SGUnresolvedReference","text":"Unresolved reference struct.
During graph computation references are unresolved and stored in this struct.
"},{"location":"api/java/cdk-graph/index.html#initializer_14","title":"Initializer","text":""},{"location":"api/java/cdk-graph/index.html#properties_14","title":"Properties","text":"Name Type Descriptionimport software.aws.pdk.cdk_graph.SGUnresolvedReference;\n\nSGUnresolvedReference.builder()\n.referenceType(ReferenceTypeEnum)\n.source(java.lang.String)\n.target(java.lang.String)\n// .value(java.lang.String)\n// .value(java.lang.Number)\n// .value(java.lang.Boolean)\n// .value(PlainObject)\n// .value(java.util.List<java.lang.String)\n// .value(java.lang.Number)\n// .value(java.lang.Boolean)\n// .value(PlainObject>)\n.build();\n
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."},{"location":"api/java/cdk-graph/index.html#referencetyperequired","title":"
referenceType
Required","text":"public ReferenceTypeEnum getReferenceType();\n
"},{"location":"api/java/cdk-graph/index.html#sourcerequired_2","title":"
- Type: ReferenceTypeEnum
source
Required","text":"public java.lang.String getSource();\n
"},{"location":"api/java/cdk-graph/index.html#targetrequired_1","title":"
- Type: java.lang.String
target
Required","text":"public java.lang.String getTarget();\n
"},{"location":"api/java/cdk-graph/index.html#valueoptional_1","title":"
- Type: java.lang.String
value
Optional","text":"public java.lang.Object getValue();\n
- Type: java.lang.String OR java.lang.Number OR java.lang.Boolean OR PlainObject OR java.util.ListPlainObject\\>"},{"location":"api/java/cdk-graph/index.html#classes","title":"Classes","text":""},{"location":"api/java/cdk-graph/index.html#appnode","title":"AppNode","text":"
AppNode defines a cdk App.
"},{"location":"api/java/cdk-graph/index.html#initializers_1","title":"Initializers","text":"Name Type Descriptionimport software.aws.pdk.cdk_graph.AppNode;\n\nnew AppNode(IAppNodeProps props);\n
props
IAppNodeProps
No description."},{"location":"api/java/cdk-graph/index.html#propsrequired","title":"props
Required","text":""},{"location":"api/java/cdk-graph/index.html#methods_1","title":"Methods","text":"Name Description
- Type: IAppNodeProps
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."},{"location":"api/java/cdk-graph/index.html#addattribute","title":"addAttribute
","text":"public void addAttribute(java.lang.String key, java.lang.Object value)\n
Add attribute.
"},{"location":"api/java/cdk-graph/index.html#keyrequired","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#addflag","title":"
- Type: java.lang.Object
addFlag
","text":"public void addFlag(FlagEnum flag)\n
Add flag.
"},{"location":"api/java/cdk-graph/index.html#flagrequired","title":"flag
Required","text":""},{"location":"api/java/cdk-graph/index.html#addmetadata","title":"
- Type: FlagEnum
addMetadata
","text":"public void addMetadata(java.lang.String metadataType, java.lang.Object data)\n
Add metadata entry.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#datarequired","title":"
- Type: java.lang.String
data
Required","text":""},{"location":"api/java/cdk-graph/index.html#addtag","title":"
- Type: java.lang.Object
addTag
","text":"public void addTag(java.lang.String key, java.lang.String value)\n
Add tag.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_1","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_1","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#applydata","title":"
- Type: java.lang.String
applyData
","text":"public void applyData(IBaseEntityDataProps data)\npublic void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite)\npublic void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite, java.lang.Boolean applyFlags)\n
Applies data (attributes, metadata, tags, flag) to entity.
Generally used only for mutations such as collapse and consume to retain data.
"},{"location":"api/java/cdk-graph/index.html#datarequired_1","title":"data
Required","text":"
- Type: IBaseEntityDataProps
The data to apply.
"},{"location":"api/java/cdk-graph/index.html#overwriteoptional","title":"overwrite
Optional","text":""},{"location":"api/java/cdk-graph/index.html#applyflagsoptional","title":"
- Type: java.lang.Boolean
applyFlags
Optional","text":"
- Type: java.lang.Boolean
Indicates if data is overwritten - Indicates if flags should be applied.
"},{"location":"api/java/cdk-graph/index.html#findmetadata","title":"findMetadata
","text":"public java.util.List<MetadataEntry> findMetadata(java.lang.String metadataType)\n
Retrieves all metadata entries of a given type.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_1","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#getattribute","title":"
- Type: java.lang.String
getAttribute
","text":"public java.lang.Object getAttribute(java.lang.String key)\n
Get attribute by key.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_2","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#gettag","title":"
- Type: java.lang.String
getTag
","text":"public java.lang.String getTag(java.lang.String key)\n
Get tag by key.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_3","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#hasattribute","title":"
- Type: java.lang.String
hasAttribute
","text":"public java.lang.Boolean hasAttribute(java.lang.String key)\npublic java.lang.Boolean hasAttribute(java.lang.String key, java.lang.Object value)\n
Indicates if entity has a given attribute defined, and optionally with a specific value.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_4","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valueoptional_2","title":"
- Type: java.lang.String
value
Optional","text":""},{"location":"api/java/cdk-graph/index.html#hasflag","title":"
- Type: java.lang.Object
hasFlag
","text":"public java.lang.Boolean hasFlag(FlagEnum flag)\n
Indicates if entity has a given flag.
"},{"location":"api/java/cdk-graph/index.html#flagrequired_1","title":"flag
Required","text":""},{"location":"api/java/cdk-graph/index.html#hasmetadata","title":"
- Type: FlagEnum
hasMetadata
","text":"public java.lang.Boolean hasMetadata(java.lang.String metadataType, java.lang.Object data)\n
Indicates if entity has matching metadata entry.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_2","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#datarequired_2","title":"
- Type: java.lang.String
data
Required","text":""},{"location":"api/java/cdk-graph/index.html#hastag","title":"
- Type: java.lang.Object
hasTag
","text":"public java.lang.Boolean hasTag(java.lang.String key)\npublic java.lang.Boolean hasTag(java.lang.String key, java.lang.String value)\n
Indicates if entity has tag, optionally verifying tag value.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_5","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valueoptional_3","title":"
- Type: java.lang.String
value
Optional","text":""},{"location":"api/java/cdk-graph/index.html#mutatedestroy","title":"
- Type: java.lang.String
mutateDestroy
","text":"public void mutateDestroy()\npublic void mutateDestroy(java.lang.Boolean strict)\n
Destroys this node by removing all references and removing this node from the store.
"},{"location":"api/java/cdk-graph/index.html#strictoptional","title":"strict
Optional","text":"
- Type: java.lang.Boolean
Indicates that this node must not have references.
"},{"location":"api/java/cdk-graph/index.html#setattribute","title":"setAttribute
","text":"public void setAttribute(java.lang.String key, java.lang.Object value)\n
Set attribute.
This will overwrite existing attribute.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_6","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_2","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#settag","title":"
- Type: java.lang.Object
setTag
","text":"public void setTag(java.lang.String key, java.lang.String value)\n
Set tag.
Will overwrite existing tag.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_7","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_3","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#addchild","title":"
- Type: java.lang.String
addChild
","text":"public void addChild(Node node)\n
Add child node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_1","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#addlink","title":"
- Type: Node
addLink
","text":"public void addLink(Edge edge)\n
Add link to another node.
"},{"location":"api/java/cdk-graph/index.html#edgerequired","title":"edge
Required","text":""},{"location":"api/java/cdk-graph/index.html#addreverselink","title":"
- Type: Edge
addReverseLink
","text":"public void addReverseLink(Edge edge)\n
Add link from another node.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_1","title":"edge
Required","text":""},{"location":"api/java/cdk-graph/index.html#doesdependon","title":"
- Type: Edge
doesDependOn
","text":"public java.lang.Boolean doesDependOn(Node node)\n
Indicates if this node depends on another node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_2","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#doesreference","title":"
- Type: Node
doesReference
","text":"public java.lang.Boolean doesReference(Node node)\n
Indicates if this node references another node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_3","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#find","title":"
- Type: Node
find
","text":"public Node find(INodePredicate predicate)\n
Recursively find the nearest sub-node matching predicate.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired","title":"predicate
Required","text":""},{"location":"api/java/cdk-graph/index.html#findall","title":"
- Type: INodePredicate
findAll
","text":"public java.util.List<Node> findAll()\npublic java.util.List<Node> findAll(IFindNodeOptions options)\n
Return this construct and all of its sub-nodes in the given order.
Optionally filter nodes based on predicate.
"},{"location":"api/java/cdk-graph/index.html#optionsoptional","title":"options
Optional","text":""},{"location":"api/java/cdk-graph/index.html#findalllinks","title":"
- Type: IFindNodeOptions
findAllLinks
","text":"public java.util.List<Edge> findAllLinks()\npublic java.util.List<Edge> findAllLinks(IFindEdgeOptions options)\n
Return all direct links of this node and that of all sub-nodes.
Optionally filter links based on predicate.
"},{"location":"api/java/cdk-graph/index.html#optionsoptional_1","title":"options
Optional","text":""},{"location":"api/java/cdk-graph/index.html#findancestor","title":"
- Type: IFindEdgeOptions
findAncestor
","text":"public Node findAncestor(INodePredicate predicate)\npublic Node findAncestor(INodePredicate predicate, java.lang.Number max)\n
Find nearest ancestor of this node matching given predicate.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_1","title":"predicate
Required","text":"
- Type: INodePredicate
Predicate to match ancestor.
"},{"location":"api/java/cdk-graph/index.html#maxoptional","title":"max
Optional","text":""},{"location":"api/java/cdk-graph/index.html#findchild","title":"
- Type: java.lang.Number
findChild
","text":"public Node findChild(java.lang.String id)\n
Find child with given id.
Similar to
"},{"location":"api/java/cdk-graph/index.html#idrequired_3","title":"find
but does not throw error if no child found.id
Required","text":""},{"location":"api/java/cdk-graph/index.html#findlink","title":"
- Type: java.lang.String
findLink
","text":"public Edge findLink(IEdgePredicate predicate)\npublic Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse)\npublic Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow)\npublic Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow, java.lang.Boolean direct)\n
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.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_2","title":"predicate
Required","text":"
- Type: IEdgePredicate
Edge predicate function to match edge.
"},{"location":"api/java/cdk-graph/index.html#reverseoptional","title":"reverse
Optional","text":"
- Type: java.lang.Boolean
Indicates if links are search in reverse order.
"},{"location":"api/java/cdk-graph/index.html#followoptional","title":"follow
Optional","text":"
- Type: java.lang.Boolean
Indicates if link chain is followed.
"},{"location":"api/java/cdk-graph/index.html#directoptional","title":"direct
Optional","text":"
- Type: java.lang.Boolean
Indicates that only direct links should be searched.
"},{"location":"api/java/cdk-graph/index.html#findlinks","title":"findLinks
","text":"public java.util.List<Edge> findLinks(IEdgePredicate predicate)\npublic java.util.List<Edge> findLinks(IEdgePredicate predicate, java.lang.Boolean reverse)\npublic java.util.List<Edge> findLinks(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow)\npublic java.util.List<Edge> findLinks(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow, java.lang.Boolean direct)\n
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.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_3","title":"predicate
Required","text":"
- Type: IEdgePredicate
Edge predicate function to match edge.
"},{"location":"api/java/cdk-graph/index.html#reverseoptional_1","title":"reverse
Optional","text":"
- Type: java.lang.Boolean
Indicates if links are search in reverse order.
"},{"location":"api/java/cdk-graph/index.html#followoptional_1","title":"follow
Optional","text":"
- Type: java.lang.Boolean
Indicates if link chain is followed.
"},{"location":"api/java/cdk-graph/index.html#directoptional_1","title":"direct
Optional","text":"
- Type: java.lang.Boolean
Indicates that only direct links should be searched.
"},{"location":"api/java/cdk-graph/index.html#getcfnprop","title":"getCfnProp
","text":"public java.lang.String OR java.lang.Number OR java.lang.Boolean OR PlainObject OR java.util.List<java.lang.String OR java.lang.Number OR java.lang.Boolean OR PlainObject> getCfnProp(java.lang.String key)\n
Get specific CloudFormation property.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_8","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#getchild","title":"
- Type: java.lang.String
getChild
","text":"public Node getChild(java.lang.String id)\n
Get child node with given id.
"},{"location":"api/java/cdk-graph/index.html#idrequired_4","title":"id
Required","text":""},{"location":"api/java/cdk-graph/index.html#getlinkchains","title":"
- Type: java.lang.String
getLinkChains
","text":"public java.util.List<java.util.List<java.lang.Object>> getLinkChains()\npublic java.util.List<java.util.List<java.lang.Object>> getLinkChains(java.lang.Boolean reverse)\n
Resolve all link chains.
{@link EdgeChain }
"},{"location":"api/java/cdk-graph/index.html#reverseoptional_2","title":"reverse
Optional","text":""},{"location":"api/java/cdk-graph/index.html#getnearestancestor","title":"
- Type: java.lang.Boolean
getNearestAncestor
","text":"public Node getNearestAncestor(Node node)\n
Gets the nearest common ancestor shared between this node and another node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_4","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#isancestor","title":"
- Type: Node
isAncestor
","text":"public java.lang.Boolean isAncestor(Node ancestor)\n
Indicates if a specific node is an ancestor of this node.
"},{"location":"api/java/cdk-graph/index.html#ancestorrequired","title":"ancestor
Required","text":""},{"location":"api/java/cdk-graph/index.html#ischild","title":"
- Type: Node
isChild
","text":"public java.lang.Boolean isChild(Node node)\n
Indicates if specific node is a child of this node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_5","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatecollapse","title":"
- Type: Node
mutateCollapse
","text":"public void mutateCollapse()\n
Collapses all sub-nodes of this node into this node.
"},{"location":"api/java/cdk-graph/index.html#mutatecollapseto","title":"mutateCollapseTo
","text":"public Node mutateCollapseTo(Node ancestor)\n
Collapses this node into an ancestor.
"},{"location":"api/java/cdk-graph/index.html#ancestorrequired_1","title":"ancestor
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatecollapsetoparent","title":"
- Type: Node
mutateCollapseToParent
","text":"public Node mutateCollapseToParent()\n
Collapses this node into it's parent node.
"},{"location":"api/java/cdk-graph/index.html#mutatehoist","title":"mutateHoist
","text":"public void mutateHoist(Node newParent)\n
Hoist this node to an ancestor by removing it from its current parent node and in turn moving it to the ancestor.
"},{"location":"api/java/cdk-graph/index.html#newparentrequired","title":"newParent
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatemove","title":"
- Type: Node
mutateMove
","text":"public void mutateMove(Node newParent)\n
Move this node into a new parent node.
"},{"location":"api/java/cdk-graph/index.html#newparentrequired_1","title":"newParent
Required","text":"
- Type: Node
The parent to move this node to.
"},{"location":"api/java/cdk-graph/index.html#mutateremovechild","title":"mutateRemoveChild
","text":"public java.lang.Boolean mutateRemoveChild(Node node)\n
Remove a child node from this node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_6","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateremovelink","title":"
- Type: Node
mutateRemoveLink
","text":"public java.lang.Boolean mutateRemoveLink(Edge link)\n
Remove a link from this node.
"},{"location":"api/java/cdk-graph/index.html#linkrequired","title":"link
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateremovereverselink","title":"
- Type: Edge
mutateRemoveReverseLink
","text":"public java.lang.Boolean mutateRemoveReverseLink(Edge link)\n
Remove a link to this node.
"},{"location":"api/java/cdk-graph/index.html#linkrequired_1","title":"link
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateuncluster","title":"
- Type: Edge
mutateUncluster
","text":"public void mutateUncluster()\n
Hoist all children to parent and collapse node to parent.
"},{"location":"api/java/cdk-graph/index.html#tostring_1","title":"toString
","text":"public java.lang.String toString()\n
Get string representation of this node.
"},{"location":"api/java/cdk-graph/index.html#static-functions_1","title":"Static Functions","text":"Name DescriptionisAppNode
Indicates if node is a {@link AppNode}."},{"location":"api/java/cdk-graph/index.html#isappnode","title":"isAppNode
","text":"import software.aws.pdk.cdk_graph.AppNode;\n\nAppNode.isAppNode(Node node)\n
Indicates if node is a {@link AppNode}.
"},{"location":"api/java/cdk-graph/index.html#noderequired_7","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#properties_15","title":"Properties","text":"Name Type Description
- Type: Node
attributes
java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>> 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 aaws-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."},{"location":"api/java/cdk-graph/index.html#attributesrequired","title":"attributes
Required","text":"public java.lang.Object getAttributes();\n
- Type: java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>>
Get readonly record of all attributes.
"},{"location":"api/java/cdk-graph/index.html#flagsrequired","title":"flags
Required","text":"public java.util.List<FlagEnum> getFlags();\n
- Type: java.util.List<FlagEnum>
Get readonly list of all flags.
"},{"location":"api/java/cdk-graph/index.html#isdestroyedrequired","title":"isDestroyed
Required","text":"public java.lang.Boolean getIsDestroyed();\n
- Type: java.lang.Boolean
Indicates if the entity has been destroyed (eg: removed from store).
"},{"location":"api/java/cdk-graph/index.html#ismutatedrequired","title":"isMutated
Required","text":"public java.lang.Boolean getIsMutated();\n
- Type: java.lang.Boolean
Indicates if the entity has had destructive mutations applied.
"},{"location":"api/java/cdk-graph/index.html#metadatarequired","title":"metadata
Required","text":"public java.util.List<MetadataEntry> getMetadata();\n
- Type: java.util.List
Get readonly list of all metadata entries.
"},{"location":"api/java/cdk-graph/index.html#storerequired","title":"store
Required","text":"public Store getStore();\n
- Type: Store
Reference to the store.
"},{"location":"api/java/cdk-graph/index.html#tagsrequired","title":"tags
Required","text":"public java.util.Map<java.lang.String, java.lang.String> getTags();\n
- Type: java.util.Map
Get readonly record of all tags.
"},{"location":"api/java/cdk-graph/index.html#uuidrequired_4","title":"uuid
Required","text":"public java.lang.String getUuid();\n
- Type: java.lang.String
Universally unique identifier.
"},{"location":"api/java/cdk-graph/index.html#allowdestructivemutationsrequired","title":"allowDestructiveMutations
Required","text":"public java.lang.Boolean getAllowDestructiveMutations();\n
- Type: java.lang.Boolean
Indicates if this node allows destructive mutations.
{@link Store.allowDestructiveMutations }
"},{"location":"api/java/cdk-graph/index.html#childrenrequired","title":"children
Required","text":"public java.util.List<Node> getChildren();\n
- Type: java.util.List<Node>
Get all direct child nodes.
"},{"location":"api/java/cdk-graph/index.html#dependedonbyrequired","title":"dependedOnBy
Required","text":"public java.util.List<Node> getDependedOnBy();\n
- Type: java.util.List<Node>
Get list of Nodes that depend on this node.
{@link Node.reverseDependencyLinks }
"},{"location":"api/java/cdk-graph/index.html#dependenciesrequired_1","title":"dependencies
Required","text":"public java.util.List<Node> getDependencies();\n
- Type: java.util.List<Node>
Get list of Nodes that this node depends on.
{@link Node.dependencyLinks }
"},{"location":"api/java/cdk-graph/index.html#dependencylinksrequired","title":"dependencyLinks
Required","text":"public java.util.List<Dependency> getDependencyLinks();\n
- Type: java.util.List<Dependency>
Gets list of {@link Dependency} links (edges) where this node is the source.
"},{"location":"api/java/cdk-graph/index.html#depthrequired","title":"depth
Required","text":"public java.lang.Number getDepth();\n
- Type: java.lang.Number
Indicates the depth of the node relative to root (0).
"},{"location":"api/java/cdk-graph/index.html#idrequired_5","title":"id
Required","text":"public java.lang.String getId();\n
- Type: java.lang.String
Node id, which is only unique within parent scope.
"},{"location":"api/java/cdk-graph/index.html#isassetrequired","title":"isAsset
Required","text":"public java.lang.Boolean getIsAsset();\n
- Type: java.lang.Boolean
Indicates if this node is considered a {@link FlagEnum.ASSET}.
"},{"location":"api/java/cdk-graph/index.html#iscfnfqnrequired","title":"isCfnFqn
Required","text":"public java.lang.Boolean getIsCfnFqn();\n
- Type: java.lang.Boolean
Indicates if node ConstructInfoFqn denotes a
aws-cdk-lib.*.Cfn*
construct.{@link FlagEnum.CFN_FQN }
"},{"location":"api/java/cdk-graph/index.html#isclusterrequired","title":"isCluster
Required","text":"public java.lang.Boolean getIsCluster();\n
- Type: java.lang.Boolean
Indicates if this node is considered a {@link FlagEnum.CLUSTER}.
"},{"location":"api/java/cdk-graph/index.html#iscustomresourcerequired","title":"isCustomResource
Required","text":"public java.lang.Boolean getIsCustomResource();\n
- Type: java.lang.Boolean
Indicates if node is a Custom Resource.
"},{"location":"api/java/cdk-graph/index.html#isextraneousrequired","title":"isExtraneous
Required","text":"public java.lang.Boolean getIsExtraneous();\n
- 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.
"},{"location":"api/java/cdk-graph/index.html#isgraphcontainerrequired","title":"isGraphContainer
Required","text":"public java.lang.Boolean getIsGraphContainer();\n
- Type: java.lang.Boolean
Indicates if this node is considered a {@link FlagEnum.GRAPH_CONTAINER}.
"},{"location":"api/java/cdk-graph/index.html#isleafrequired","title":"isLeaf
Required","text":"public java.lang.Boolean getIsLeaf();\n
- Type: java.lang.Boolean
Indicates if this node is a leaf node, which means it does not have children.
"},{"location":"api/java/cdk-graph/index.html#istoplevelrequired","title":"isTopLevel
Required","text":"public java.lang.Boolean getIsTopLevel();\n
- Type: java.lang.Boolean
Indicates if node is direct child of the graph root node.
"},{"location":"api/java/cdk-graph/index.html#linksrequired","title":"links
Required","text":"public java.util.List<Edge> getLinks();\n
- Type: java.util.List<Edge>
Gets all links (edges) in which this node is the source.
"},{"location":"api/java/cdk-graph/index.html#nodetyperequired_1","title":"nodeType
Required","text":"public NodeTypeEnum getNodeType();\n
- Type: NodeTypeEnum
Type of node.
"},{"location":"api/java/cdk-graph/index.html#pathrequired_1","title":"path
Required","text":"public java.lang.String getPath();\n
- Type: java.lang.String
Path of the node.
"},{"location":"api/java/cdk-graph/index.html#referencedbyrequired","title":"referencedBy
Required","text":"public java.util.List<Node> getReferencedBy();\n
- Type: java.util.List<Node>
Get list of Nodes that reference this node.
{@link Node.reverseReferenceLinks }
"},{"location":"api/java/cdk-graph/index.html#referencelinksrequired","title":"referenceLinks
Required","text":"public java.util.List<Reference> getReferenceLinks();\n
- Type: java.util.List<Reference>
Gets list of {@link Reference} links (edges) where this node is the source.
"},{"location":"api/java/cdk-graph/index.html#referencesrequired","title":"references
Required","text":"public java.util.List<Node> getReferences();\n
- Type: java.util.List<Node>
Get list of Nodes that this node references.
{@link Node.referenceLinks }
"},{"location":"api/java/cdk-graph/index.html#reversedependencylinksrequired","title":"reverseDependencyLinks
Required","text":"public java.util.List<Dependency> getReverseDependencyLinks();\n
- Type: java.util.List<Dependency>
Gets list of {@link Dependency} links (edges) where this node is the target.
"},{"location":"api/java/cdk-graph/index.html#reverselinksrequired","title":"reverseLinks
Required","text":"public java.util.List<Edge> getReverseLinks();\n
- Type: java.util.List<Edge>
Gets all links (edges) in which this node is the target.
"},{"location":"api/java/cdk-graph/index.html#reversereferencelinksrequired","title":"reverseReferenceLinks
Required","text":"public java.util.List<Reference> getReverseReferenceLinks();\n
- Type: java.util.List<Reference>
Gets list of {@link Reference} links (edges) where this node is the target.
"},{"location":"api/java/cdk-graph/index.html#scopesrequired","title":"scopes
Required","text":"public java.util.List<Node> getScopes();\n
- Type: java.util.List<Node>
Gets descending ordered list of ancestors from the root.
"},{"location":"api/java/cdk-graph/index.html#siblingsrequired","title":"siblings
Required","text":"public java.util.List<Node> getSiblings();\n
- Type: java.util.List<Node>
Get list of siblings of this node.
"},{"location":"api/java/cdk-graph/index.html#cfnpropsoptional","title":"cfnProps
Optional","text":"public PlainObject getCfnProps();\n
- Type: PlainObject
Gets CloudFormation properties for this node.
"},{"location":"api/java/cdk-graph/index.html#cfntypeoptional_2","title":"cfnType
Optional","text":"public java.lang.String getCfnType();\n
- Type: java.lang.String
Get the CloudFormation resource type for this node.
"},{"location":"api/java/cdk-graph/index.html#constructinfooptional_2","title":"constructInfo
Optional","text":"public ConstructInfo getConstructInfo();\n
- Type: ConstructInfo
Synthesized construct information defining jii resolution data.
"},{"location":"api/java/cdk-graph/index.html#constructinfofqnoptional","title":"constructInfoFqn
Optional","text":"public java.lang.String getConstructInfoFqn();\n
- Type: java.lang.String
Synthesized construct information defining jii resolution data.
"},{"location":"api/java/cdk-graph/index.html#logicalidoptional_2","title":"logicalId
Optional","text":"public java.lang.String getLogicalId();\n
- Type: java.lang.String
Logical id of the node, which is only unique within containing stack.
"},{"location":"api/java/cdk-graph/index.html#parentoptional_1","title":"parent
Optional","text":"public Node getParent();\n
- Type: Node
Parent node.
Only the root node should not have parent.
"},{"location":"api/java/cdk-graph/index.html#rootstackoptional","title":"rootStack
Optional","text":"public StackNode getRootStack();\n
- Type: StackNode
Get root stack.
"},{"location":"api/java/cdk-graph/index.html#stackoptional_1","title":"stack
Optional","text":"public StackNode getStack();\n
- Type: StackNode
Stack the node is contained in.
"},{"location":"api/java/cdk-graph/index.html#constants_1","title":"Constants","text":"Name Type DescriptionPATH
java.lang.String
Fixed path of the App.UUID
java.lang.String
Fixed UUID for App node."},{"location":"api/java/cdk-graph/index.html#pathrequired_2","title":"PATH
Required","text":"public java.lang.String getPath();\n
- Type: java.lang.String
Fixed path of the App.
"},{"location":"api/java/cdk-graph/index.html#uuidrequired_5","title":"UUID
Required","text":"public java.lang.String getUuid();\n
- Type: java.lang.String
Fixed UUID for App node.
"},{"location":"api/java/cdk-graph/index.html#attributereference","title":"AttributeReference","text":"Attribute type reference edge.
"},{"location":"api/java/cdk-graph/index.html#initializers_2","title":"Initializers","text":"Name Type Descriptionimport software.aws.pdk.cdk_graph.AttributeReference;\n\nnew AttributeReference(IAttributeReferenceProps props);\n
props
IAttributeReferenceProps
No description."},{"location":"api/java/cdk-graph/index.html#propsrequired_1","title":"props
Required","text":""},{"location":"api/java/cdk-graph/index.html#methods_2","title":"Methods","text":"Name Description
- Type: IAttributeReferenceProps
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."},{"location":"api/java/cdk-graph/index.html#addattribute_1","title":"addAttribute
","text":"public void addAttribute(java.lang.String key, java.lang.Object value)\n
Add attribute.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_9","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_4","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#addflag_1","title":"
- Type: java.lang.Object
addFlag
","text":"public void addFlag(FlagEnum flag)\n
Add flag.
"},{"location":"api/java/cdk-graph/index.html#flagrequired_2","title":"flag
Required","text":""},{"location":"api/java/cdk-graph/index.html#addmetadata_1","title":"
- Type: FlagEnum
addMetadata
","text":"public void addMetadata(java.lang.String metadataType, java.lang.Object data)\n
Add metadata entry.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_3","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#datarequired_3","title":"
- Type: java.lang.String
data
Required","text":""},{"location":"api/java/cdk-graph/index.html#addtag_1","title":"
- Type: java.lang.Object
addTag
","text":"public void addTag(java.lang.String key, java.lang.String value)\n
Add tag.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_10","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_5","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#applydata_1","title":"
- Type: java.lang.String
applyData
","text":"public void applyData(IBaseEntityDataProps data)\npublic void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite)\npublic void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite, java.lang.Boolean applyFlags)\n
Applies data (attributes, metadata, tags, flag) to entity.
Generally used only for mutations such as collapse and consume to retain data.
"},{"location":"api/java/cdk-graph/index.html#datarequired_4","title":"data
Required","text":"
- Type: IBaseEntityDataProps
The data to apply.
"},{"location":"api/java/cdk-graph/index.html#overwriteoptional_1","title":"overwrite
Optional","text":""},{"location":"api/java/cdk-graph/index.html#applyflagsoptional_1","title":"
- Type: java.lang.Boolean
applyFlags
Optional","text":"
- Type: java.lang.Boolean
Indicates if data is overwritten - Indicates if flags should be applied.
"},{"location":"api/java/cdk-graph/index.html#findmetadata_1","title":"findMetadata
","text":"public java.util.List<MetadataEntry> findMetadata(java.lang.String metadataType)\n
Retrieves all metadata entries of a given type.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_4","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#getattribute_1","title":"
- Type: java.lang.String
getAttribute
","text":"public java.lang.Object getAttribute(java.lang.String key)\n
Get attribute by key.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_11","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#gettag_1","title":"
- Type: java.lang.String
getTag
","text":"public java.lang.String getTag(java.lang.String key)\n
Get tag by key.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_12","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#hasattribute_1","title":"
- Type: java.lang.String
hasAttribute
","text":"public java.lang.Boolean hasAttribute(java.lang.String key)\npublic java.lang.Boolean hasAttribute(java.lang.String key, java.lang.Object value)\n
Indicates if entity has a given attribute defined, and optionally with a specific value.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_13","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valueoptional_4","title":"
- Type: java.lang.String
value
Optional","text":""},{"location":"api/java/cdk-graph/index.html#hasflag_1","title":"
- Type: java.lang.Object
hasFlag
","text":"public java.lang.Boolean hasFlag(FlagEnum flag)\n
Indicates if entity has a given flag.
"},{"location":"api/java/cdk-graph/index.html#flagrequired_3","title":"flag
Required","text":""},{"location":"api/java/cdk-graph/index.html#hasmetadata_1","title":"
- Type: FlagEnum
hasMetadata
","text":"public java.lang.Boolean hasMetadata(java.lang.String metadataType, java.lang.Object data)\n
Indicates if entity has matching metadata entry.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_5","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#datarequired_5","title":"
- Type: java.lang.String
data
Required","text":""},{"location":"api/java/cdk-graph/index.html#hastag_1","title":"
- Type: java.lang.Object
hasTag
","text":"public java.lang.Boolean hasTag(java.lang.String key)\npublic java.lang.Boolean hasTag(java.lang.String key, java.lang.String value)\n
Indicates if entity has tag, optionally verifying tag value.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_14","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valueoptional_5","title":"
- Type: java.lang.String
value
Optional","text":""},{"location":"api/java/cdk-graph/index.html#mutatedestroy_1","title":"
- Type: java.lang.String
mutateDestroy
","text":"public void mutateDestroy()\npublic void mutateDestroy(java.lang.Boolean _strict)\n
Destroy the edge.
Remove all references and remove from store.
"},{"location":"api/java/cdk-graph/index.html#_strictoptional","title":"_strict
Optional","text":""},{"location":"api/java/cdk-graph/index.html#setattribute_1","title":"
- Type: java.lang.Boolean
setAttribute
","text":"public void setAttribute(java.lang.String key, java.lang.Object value)\n
Set attribute.
This will overwrite existing attribute.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_15","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_6","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#settag_1","title":"
- Type: java.lang.Object
setTag
","text":"public void setTag(java.lang.String key, java.lang.String value)\n
Set tag.
Will overwrite existing tag.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_16","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_7","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#isequivalent","title":"
- Type: java.lang.String
isEquivalent
","text":"public java.lang.Boolean isEquivalent(Edge edge)\n
Indicates if this edge is equivalent to another edge.
Edges are considered equivalent if they share same type, source, and target.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_2","title":"edge
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateconsume","title":"
- Type: Edge
mutateConsume
","text":"public void mutateConsume(Edge edge)\n
Merge an equivalent edge's data into this edge and destroy the other edge.
Used during filtering operations to consolidate equivalent edges.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_3","title":"edge
Required","text":"
- Type: Edge
The edge to consume.
"},{"location":"api/java/cdk-graph/index.html#mutatedirection","title":"mutateDirection
","text":"public void mutateDirection(EdgeDirectionEnum direction)\n
Change the edge direction.
"},{"location":"api/java/cdk-graph/index.html#directionrequired_1","title":"direction
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatesource","title":"
- Type: EdgeDirectionEnum
mutateSource
","text":"public void mutateSource(Node node)\n
Change the edge source.
"},{"location":"api/java/cdk-graph/index.html#noderequired_8","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatetarget","title":"
- Type: Node
mutateTarget
","text":"public void mutateTarget(Node node)\n
Change the edge target.
"},{"location":"api/java/cdk-graph/index.html#noderequired_9","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#tostring_2","title":"
- Type: Node
toString
","text":"public java.lang.String toString()\n
Get string representation of this edge.
"},{"location":"api/java/cdk-graph/index.html#resolvechain","title":"resolveChain
","text":"public java.util.List<java.lang.Object> resolveChain()\n
Resolve reference chain.
"},{"location":"api/java/cdk-graph/index.html#resolvetargets","title":"resolveTargets
","text":"public java.util.List<Node> resolveTargets()\n
Resolve targets by following potential edge chain.
{@link EdgeChain }
"},{"location":"api/java/cdk-graph/index.html#static-functions_2","title":"Static Functions","text":"Name DescriptionfindAllInChain
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}."},{"location":"api/java/cdk-graph/index.html#findallinchain","title":"findAllInChain
","text":"import software.aws.pdk.cdk_graph.AttributeReference;\n\nAttributeReference.findAllInChain(java.util.List<java.lang.Object> chain, IEdgePredicate predicate)\n
Find all matching edges based on predicate within an EdgeChain.
"},{"location":"api/java/cdk-graph/index.html#chainrequired","title":"chain
Required","text":"
- Type: java.util.List"},{"location":"api/java/cdk-graph/index.html#predicaterequired_4","title":"
predicate
Required","text":""},{"location":"api/java/cdk-graph/index.html#findinchain","title":"
- Type: IEdgePredicate
findInChain
","text":"import software.aws.pdk.cdk_graph.AttributeReference;\n\nAttributeReference.findInChain(java.util.List<java.lang.Object> chain, IEdgePredicate predicate)\n
Find first edge matching predicate within an EdgeChain.
"},{"location":"api/java/cdk-graph/index.html#chainrequired_1","title":"chain
Required","text":"
- Type: java.util.List"},{"location":"api/java/cdk-graph/index.html#predicaterequired_5","title":"
predicate
Required","text":""},{"location":"api/java/cdk-graph/index.html#isref","title":"
- Type: IEdgePredicate
isRef
","text":"import software.aws.pdk.cdk_graph.AttributeReference;\n\nAttributeReference.isRef(Edge edge)\n
Indicates if edge is a Ref based {@link Reference} edge.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_4","title":"edge
Required","text":""},{"location":"api/java/cdk-graph/index.html#isreference","title":"
- Type: Edge
isReference
","text":"import software.aws.pdk.cdk_graph.AttributeReference;\n\nAttributeReference.isReference(Edge edge)\n
Indicates if edge is a {@link Reference}.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_5","title":"edge
Required","text":""},{"location":"api/java/cdk-graph/index.html#isatt","title":"
- Type: Edge
isAtt
","text":"import software.aws.pdk.cdk_graph.AttributeReference;\n\nAttributeReference.isAtt(Edge edge)\n
Indicates if edge in an Fn::GetAtt {@link Reference}.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_6","title":"edge
Required","text":""},{"location":"api/java/cdk-graph/index.html#properties_16","title":"Properties","text":"Name Type Description
- Type: Edge
attributes
java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>> 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."},{"location":"api/java/cdk-graph/index.html#attributesrequired_1","title":"attributes
Required","text":"public java.lang.Object getAttributes();\n
- Type: java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>>
Get readonly record of all attributes.
"},{"location":"api/java/cdk-graph/index.html#flagsrequired_1","title":"flags
Required","text":"public java.util.List<FlagEnum> getFlags();\n
- Type: java.util.List<FlagEnum>
Get readonly list of all flags.
"},{"location":"api/java/cdk-graph/index.html#isdestroyedrequired_1","title":"isDestroyed
Required","text":"public java.lang.Boolean getIsDestroyed();\n
- Type: java.lang.Boolean
Indicates if the entity has been destroyed (eg: removed from store).
"},{"location":"api/java/cdk-graph/index.html#ismutatedrequired_1","title":"isMutated
Required","text":"public java.lang.Boolean getIsMutated();\n
- Type: java.lang.Boolean
Indicates if the entity has had destructive mutations applied.
"},{"location":"api/java/cdk-graph/index.html#metadatarequired_1","title":"metadata
Required","text":"public java.util.List<MetadataEntry> getMetadata();\n
- Type: java.util.List
Get readonly list of all metadata entries.
"},{"location":"api/java/cdk-graph/index.html#storerequired_1","title":"store
Required","text":"public Store getStore();\n
- Type: Store
Reference to the store.
"},{"location":"api/java/cdk-graph/index.html#tagsrequired_1","title":"tags
Required","text":"public java.util.Map<java.lang.String, java.lang.String> getTags();\n
- Type: java.util.Map
Get readonly record of all tags.
"},{"location":"api/java/cdk-graph/index.html#uuidrequired_6","title":"uuid
Required","text":"public java.lang.String getUuid();\n
- Type: java.lang.String
Universally unique identifier.
"},{"location":"api/java/cdk-graph/index.html#allowdestructivemutationsrequired_1","title":"allowDestructiveMutations
Required","text":"public java.lang.Boolean getAllowDestructiveMutations();\n
- Type: java.lang.Boolean
Indicates if edge allows destructive mutations.
"},{"location":"api/java/cdk-graph/index.html#directionrequired_2","title":"direction
Required","text":"public EdgeDirectionEnum getDirection();\n
- Type: EdgeDirectionEnum
Indicates the direction in which the edge is directed.
"},{"location":"api/java/cdk-graph/index.html#edgetyperequired_1","title":"edgeType
Required","text":"public EdgeTypeEnum getEdgeType();\n
- Type: EdgeTypeEnum
Type of edge.
"},{"location":"api/java/cdk-graph/index.html#isclosedrequired","title":"isClosed
Required","text":"public java.lang.Boolean getIsClosed();\n
- 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
"},{"location":"api/java/cdk-graph/index.html#iscrossstackrequired","title":"hasFlag(FlagEnum.CLOSED_EDGE)
instead.isCrossStack
Required","text":"public java.lang.Boolean getIsCrossStack();\n
- Type: java.lang.Boolean
Indicates if source and target nodes reside in different root stacks.
"},{"location":"api/java/cdk-graph/index.html#isextraneousrequired_1","title":"isExtraneous
Required","text":"public java.lang.Boolean getIsExtraneous();\n
- 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).
"},{"location":"api/java/cdk-graph/index.html#sourcerequired_3","title":"source
Required","text":"public Node getSource();\n
- Type: Node
Edge source is the node that defines the edge (tail).
"},{"location":"api/java/cdk-graph/index.html#targetrequired_2","title":"target
Required","text":"public Node getTarget();\n
- Type: Node
Edge target is the node being referenced by the source (head).
"},{"location":"api/java/cdk-graph/index.html#referencetyperequired_1","title":"referenceType
Required","text":"public ReferenceTypeEnum getReferenceType();\n
- Type: ReferenceTypeEnum
Get type of reference.
"},{"location":"api/java/cdk-graph/index.html#valuerequired_8","title":"value
Required","text":"public java.lang.String getValue();\n
- Type: java.lang.String
Get the resolved attribute value.
"},{"location":"api/java/cdk-graph/index.html#constants_2","title":"Constants","text":"Name Type DescriptionATT_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."},{"location":"api/java/cdk-graph/index.html#att_typerequired","title":"ATT_TYPE
Required","text":"public java.lang.String getAttType();\n
- Type: java.lang.String
Attribute defining the type of reference.
"},{"location":"api/java/cdk-graph/index.html#prefixrequired","title":"PREFIX
Required","text":"public java.lang.String getPrefix();\n
- Type: java.lang.String
Edge prefix to denote Fn::GetAtt type reference edge.
"},{"location":"api/java/cdk-graph/index.html#att_valuerequired","title":"ATT_VALUE
Required","text":"public java.lang.String getAttValue();\n
- Type: java.lang.String
Attribute key for resolved value of attribute reference.
"},{"location":"api/java/cdk-graph/index.html#baseentity","title":"BaseEntity","text":"
- Implements: ISerializableEntity
Base class for all store entities (Node and Edges).
"},{"location":"api/java/cdk-graph/index.html#initializers_3","title":"Initializers","text":"Name Type Descriptionimport software.aws.pdk.cdk_graph.BaseEntity;\n\nnew BaseEntity(IBaseEntityProps props);\n
props
IBaseEntityProps
No description."},{"location":"api/java/cdk-graph/index.html#propsrequired_2","title":"props
Required","text":""},{"location":"api/java/cdk-graph/index.html#methods_3","title":"Methods","text":"Name Description
- Type: IBaseEntityProps
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."},{"location":"api/java/cdk-graph/index.html#addattribute_2","title":"addAttribute
","text":"public void addAttribute(java.lang.String key, java.lang.Object value)\n
Add attribute.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_17","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_9","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#addflag_2","title":"
- Type: java.lang.Object
addFlag
","text":"public void addFlag(FlagEnum flag)\n
Add flag.
"},{"location":"api/java/cdk-graph/index.html#flagrequired_4","title":"flag
Required","text":""},{"location":"api/java/cdk-graph/index.html#addmetadata_2","title":"
- Type: FlagEnum
addMetadata
","text":"public void addMetadata(java.lang.String metadataType, java.lang.Object data)\n
Add metadata entry.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_6","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#datarequired_6","title":"
- Type: java.lang.String
data
Required","text":""},{"location":"api/java/cdk-graph/index.html#addtag_2","title":"
- Type: java.lang.Object
addTag
","text":"public void addTag(java.lang.String key, java.lang.String value)\n
Add tag.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_18","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_10","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#applydata_2","title":"
- Type: java.lang.String
applyData
","text":"public void applyData(IBaseEntityDataProps data)\npublic void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite)\npublic void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite, java.lang.Boolean applyFlags)\n
Applies data (attributes, metadata, tags, flag) to entity.
Generally used only for mutations such as collapse and consume to retain data.
"},{"location":"api/java/cdk-graph/index.html#datarequired_7","title":"data
Required","text":"
- Type: IBaseEntityDataProps
The data to apply.
"},{"location":"api/java/cdk-graph/index.html#overwriteoptional_2","title":"overwrite
Optional","text":""},{"location":"api/java/cdk-graph/index.html#applyflagsoptional_2","title":"
- Type: java.lang.Boolean
applyFlags
Optional","text":"
- Type: java.lang.Boolean
Indicates if data is overwritten - Indicates if flags should be applied.
"},{"location":"api/java/cdk-graph/index.html#findmetadata_2","title":"findMetadata
","text":"public java.util.List<MetadataEntry> findMetadata(java.lang.String metadataType)\n
Retrieves all metadata entries of a given type.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_7","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#getattribute_2","title":"
- Type: java.lang.String
getAttribute
","text":"public java.lang.Object getAttribute(java.lang.String key)\n
Get attribute by key.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_19","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#gettag_2","title":"
- Type: java.lang.String
getTag
","text":"public java.lang.String getTag(java.lang.String key)\n
Get tag by key.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_20","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#hasattribute_2","title":"
- Type: java.lang.String
hasAttribute
","text":"public java.lang.Boolean hasAttribute(java.lang.String key)\npublic java.lang.Boolean hasAttribute(java.lang.String key, java.lang.Object value)\n
Indicates if entity has a given attribute defined, and optionally with a specific value.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_21","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valueoptional_6","title":"
- Type: java.lang.String
value
Optional","text":""},{"location":"api/java/cdk-graph/index.html#hasflag_2","title":"
- Type: java.lang.Object
hasFlag
","text":"public java.lang.Boolean hasFlag(FlagEnum flag)\n
Indicates if entity has a given flag.
"},{"location":"api/java/cdk-graph/index.html#flagrequired_5","title":"flag
Required","text":""},{"location":"api/java/cdk-graph/index.html#hasmetadata_2","title":"
- Type: FlagEnum
hasMetadata
","text":"public java.lang.Boolean hasMetadata(java.lang.String metadataType, java.lang.Object data)\n
Indicates if entity has matching metadata entry.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_8","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#datarequired_8","title":"
- Type: java.lang.String
data
Required","text":""},{"location":"api/java/cdk-graph/index.html#hastag_2","title":"
- Type: java.lang.Object
hasTag
","text":"public java.lang.Boolean hasTag(java.lang.String key)\npublic java.lang.Boolean hasTag(java.lang.String key, java.lang.String value)\n
Indicates if entity has tag, optionally verifying tag value.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_22","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valueoptional_7","title":"
- Type: java.lang.String
value
Optional","text":""},{"location":"api/java/cdk-graph/index.html#mutatedestroy_2","title":"
- Type: java.lang.String
mutateDestroy
","text":"public void mutateDestroy()\npublic void mutateDestroy(java.lang.Boolean strict)\n
Destroy the entity be removing all references and removing from store.
"},{"location":"api/java/cdk-graph/index.html#strictoptional_1","title":"strict
Optional","text":"
- Type: java.lang.Boolean
If
"},{"location":"api/java/cdk-graph/index.html#setattribute_2","title":"strict
, then entity must not have any references remaining when attempting to destroy.setAttribute
","text":"public void setAttribute(java.lang.String key, java.lang.Object value)\n
Set attribute.
This will overwrite existing attribute.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_23","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_11","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#settag_2","title":"
- Type: java.lang.Object
setTag
","text":"public void setTag(java.lang.String key, java.lang.String value)\n
Set tag.
Will overwrite existing tag.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_24","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_12","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#properties_17","title":"Properties","text":"Name Type Description
- Type: java.lang.String
attributes
java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>> 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."},{"location":"api/java/cdk-graph/index.html#attributesrequired_2","title":"attributes
Required","text":"public java.lang.Object getAttributes();\n
- Type: java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>>
Get readonly record of all attributes.
"},{"location":"api/java/cdk-graph/index.html#flagsrequired_2","title":"flags
Required","text":"public java.util.List<FlagEnum> getFlags();\n
- Type: java.util.List<FlagEnum>
Get readonly list of all flags.
"},{"location":"api/java/cdk-graph/index.html#isdestroyedrequired_2","title":"isDestroyed
Required","text":"public java.lang.Boolean getIsDestroyed();\n
- Type: java.lang.Boolean
Indicates if the entity has been destroyed (eg: removed from store).
"},{"location":"api/java/cdk-graph/index.html#ismutatedrequired_2","title":"isMutated
Required","text":"public java.lang.Boolean getIsMutated();\n
- Type: java.lang.Boolean
Indicates if the entity has had destructive mutations applied.
"},{"location":"api/java/cdk-graph/index.html#metadatarequired_2","title":"metadata
Required","text":"public java.util.List<MetadataEntry> getMetadata();\n
- Type: java.util.List
Get readonly list of all metadata entries.
"},{"location":"api/java/cdk-graph/index.html#storerequired_2","title":"store
Required","text":"public Store getStore();\n
- Type: Store
Reference to the store.
"},{"location":"api/java/cdk-graph/index.html#tagsrequired_2","title":"tags
Required","text":"public java.util.Map<java.lang.String, java.lang.String> getTags();\n
- Type: java.util.Map
Get readonly record of all tags.
"},{"location":"api/java/cdk-graph/index.html#uuidrequired_7","title":"uuid
Required","text":"public java.lang.String getUuid();\n
- Type: java.lang.String
Universally unique identifier.
"},{"location":"api/java/cdk-graph/index.html#cdkgraphcontext","title":"CdkGraphContext","text":"CdkGraph context.
"},{"location":"api/java/cdk-graph/index.html#initializers_4","title":"Initializers","text":"Name Type Descriptionimport software.aws.pdk.cdk_graph.CdkGraphContext;\n\nnew CdkGraphContext(Store store, java.lang.String outdir);\n
store
Store
No description.outdir
java.lang.String
No description."},{"location":"api/java/cdk-graph/index.html#storerequired_3","title":"store
Required","text":""},{"location":"api/java/cdk-graph/index.html#outdirrequired","title":"
- Type: Store
outdir
Required","text":""},{"location":"api/java/cdk-graph/index.html#methods_4","title":"Methods","text":"Name Description
- Type: java.lang.String
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."},{"location":"api/java/cdk-graph/index.html#getartifact","title":"getArtifact
","text":"public CdkGraphArtifact getArtifact(java.lang.String id)\n
Get CdkGraph artifact by id.
"},{"location":"api/java/cdk-graph/index.html#idrequired_6","title":"id
Required","text":""},{"location":"api/java/cdk-graph/index.html#hasartifactfile","title":"
- Type: java.lang.String
hasArtifactFile
","text":"public java.lang.Boolean hasArtifactFile(java.lang.String filename)\n
Indicates if context has an artifact with filename defined.
"},{"location":"api/java/cdk-graph/index.html#filenamerequired_1","title":"filename
Required","text":""},{"location":"api/java/cdk-graph/index.html#logartifact","title":"
- Type: java.lang.String
logArtifact
","text":"public CdkGraphArtifact logArtifact(CdkGraph OR ICdkGraphPlugin source, java.lang.String id, java.lang.String filepath)\npublic CdkGraphArtifact logArtifact(CdkGraph OR ICdkGraphPlugin source, java.lang.String id, java.lang.String filepath, java.lang.String description)\n
Logs an artifact entry.
In general this should not be called directly, as
"},{"location":"api/java/cdk-graph/index.html#sourcerequired_4","title":"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","text":"
- Type: CdkGraph OR ICdkGraphPlugin
The source of the artifact, such as the name of plugin.
"},{"location":"api/java/cdk-graph/index.html#idrequired_7","title":"id
Required","text":"
- Type: java.lang.String
Unique id of the artifact.
"},{"location":"api/java/cdk-graph/index.html#filepathrequired_1","title":"filepath
Required","text":"
- Type: java.lang.String
Full path where the artifact is stored.
"},{"location":"api/java/cdk-graph/index.html#descriptionoptional_1","title":"description
Optional","text":"
- Type: java.lang.String
Description of the artifact.
"},{"location":"api/java/cdk-graph/index.html#writeartifact","title":"writeArtifact
","text":"public CdkGraphArtifact writeArtifact(CdkGraph OR ICdkGraphPlugin source, java.lang.String id, java.lang.String filename, java.lang.String data)\npublic CdkGraphArtifact writeArtifact(CdkGraph OR ICdkGraphPlugin source, java.lang.String id, java.lang.String filename, java.lang.String data, java.lang.String description)\n
Writes artifact data to outdir and logs the entry.
"},{"location":"api/java/cdk-graph/index.html#sourcerequired_5","title":"source
Required","text":"
- Type: CdkGraph OR ICdkGraphPlugin
The source of the artifact, such as the name of plugin.
"},{"location":"api/java/cdk-graph/index.html#idrequired_8","title":"id
Required","text":"
- Type: java.lang.String
Unique id of the artifact.
"},{"location":"api/java/cdk-graph/index.html#filenamerequired_2","title":"filename
Required","text":"
- Type: java.lang.String
Relative name of the file.
"},{"location":"api/java/cdk-graph/index.html#datarequired_9","title":"data
Required","text":""},{"location":"api/java/cdk-graph/index.html#descriptionoptional_2","title":"
- Type: java.lang.String
description
Optional","text":"
- Type: java.lang.String
Description of the artifact.
"},{"location":"api/java/cdk-graph/index.html#properties_18","title":"Properties","text":"Name Type Descriptionartifacts
java.util.MapCdkGraphArtifact\\> Get record of all graph artifacts keyed by artifact id.
graphJson
CdkGraphArtifact
Get CdkGraph coregraph.json
artifact.outdir
java.lang.String
No description.store
Store
No description."},{"location":"api/java/cdk-graph/index.html#artifactsrequired","title":"artifacts
Required","text":"public java.util.Map<java.lang.String, CdkGraphArtifact> getArtifacts();\n
- Type: java.util.MapCdkGraphArtifact\\>
Get record of all graph artifacts keyed by artifact id.
"},{"location":"api/java/cdk-graph/index.html#graphjsonrequired","title":"graphJson
Required","text":"public CdkGraphArtifact getGraphJson();\n
- Type: CdkGraphArtifact
Get CdkGraph core
"},{"location":"api/java/cdk-graph/index.html#outdirrequired_1","title":"graph.json
artifact.outdir
Required","text":"public java.lang.String getOutdir();\n
"},{"location":"api/java/cdk-graph/index.html#storerequired_4","title":"
- Type: java.lang.String
store
Required","text":"public Store getStore();\n
"},{"location":"api/java/cdk-graph/index.html#cfnresourcenode","title":"CfnResourceNode","text":"
- Type: Store
CfnResourceNode defines an L1 cdk resource.
"},{"location":"api/java/cdk-graph/index.html#initializers_5","title":"Initializers","text":"Name Type Descriptionimport software.aws.pdk.cdk_graph.CfnResourceNode;\n\nnew CfnResourceNode(ICfnResourceNodeProps props);\n
props
ICfnResourceNodeProps
No description."},{"location":"api/java/cdk-graph/index.html#propsrequired_3","title":"props
Required","text":""},{"location":"api/java/cdk-graph/index.html#methods_5","title":"Methods","text":"Name Description
- Type: ICfnResourceNodeProps
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."},{"location":"api/java/cdk-graph/index.html#addattribute_3","title":"addAttribute
","text":"public void addAttribute(java.lang.String key, java.lang.Object value)\n
Add attribute.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_25","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_13","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#addflag_3","title":"
- Type: java.lang.Object
addFlag
","text":"public void addFlag(FlagEnum flag)\n
Add flag.
"},{"location":"api/java/cdk-graph/index.html#flagrequired_6","title":"flag
Required","text":""},{"location":"api/java/cdk-graph/index.html#addmetadata_3","title":"
- Type: FlagEnum
addMetadata
","text":"public void addMetadata(java.lang.String metadataType, java.lang.Object data)\n
Add metadata entry.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_9","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#datarequired_10","title":"
- Type: java.lang.String
data
Required","text":""},{"location":"api/java/cdk-graph/index.html#addtag_3","title":"
- Type: java.lang.Object
addTag
","text":"public void addTag(java.lang.String key, java.lang.String value)\n
Add tag.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_26","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_14","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#applydata_3","title":"
- Type: java.lang.String
applyData
","text":"public void applyData(IBaseEntityDataProps data)\npublic void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite)\npublic void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite, java.lang.Boolean applyFlags)\n
Applies data (attributes, metadata, tags, flag) to entity.
Generally used only for mutations such as collapse and consume to retain data.
"},{"location":"api/java/cdk-graph/index.html#datarequired_11","title":"data
Required","text":"
- Type: IBaseEntityDataProps
The data to apply.
"},{"location":"api/java/cdk-graph/index.html#overwriteoptional_3","title":"overwrite
Optional","text":""},{"location":"api/java/cdk-graph/index.html#applyflagsoptional_3","title":"
- Type: java.lang.Boolean
applyFlags
Optional","text":"
- Type: java.lang.Boolean
Indicates if data is overwritten - Indicates if flags should be applied.
"},{"location":"api/java/cdk-graph/index.html#findmetadata_3","title":"findMetadata
","text":"public java.util.List<MetadataEntry> findMetadata(java.lang.String metadataType)\n
Retrieves all metadata entries of a given type.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_10","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#getattribute_3","title":"
- Type: java.lang.String
getAttribute
","text":"public java.lang.Object getAttribute(java.lang.String key)\n
Get attribute by key.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_27","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#gettag_3","title":"
- Type: java.lang.String
getTag
","text":"public java.lang.String getTag(java.lang.String key)\n
Get tag by key.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_28","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#hasattribute_3","title":"
- Type: java.lang.String
hasAttribute
","text":"public java.lang.Boolean hasAttribute(java.lang.String key)\npublic java.lang.Boolean hasAttribute(java.lang.String key, java.lang.Object value)\n
Indicates if entity has a given attribute defined, and optionally with a specific value.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_29","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valueoptional_8","title":"
- Type: java.lang.String
value
Optional","text":""},{"location":"api/java/cdk-graph/index.html#hasflag_3","title":"
- Type: java.lang.Object
hasFlag
","text":"public java.lang.Boolean hasFlag(FlagEnum flag)\n
Indicates if entity has a given flag.
"},{"location":"api/java/cdk-graph/index.html#flagrequired_7","title":"flag
Required","text":""},{"location":"api/java/cdk-graph/index.html#hasmetadata_3","title":"
- Type: FlagEnum
hasMetadata
","text":"public java.lang.Boolean hasMetadata(java.lang.String metadataType, java.lang.Object data)\n
Indicates if entity has matching metadata entry.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_11","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#datarequired_12","title":"
- Type: java.lang.String
data
Required","text":""},{"location":"api/java/cdk-graph/index.html#hastag_3","title":"
- Type: java.lang.Object
hasTag
","text":"public java.lang.Boolean hasTag(java.lang.String key)\npublic java.lang.Boolean hasTag(java.lang.String key, java.lang.String value)\n
Indicates if entity has tag, optionally verifying tag value.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_30","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valueoptional_9","title":"
- Type: java.lang.String
value
Optional","text":""},{"location":"api/java/cdk-graph/index.html#mutatedestroy_3","title":"
- Type: java.lang.String
mutateDestroy
","text":"public void mutateDestroy()\npublic void mutateDestroy(java.lang.Boolean strict)\n
Destroys this node by removing all references and removing this node from the store.
"},{"location":"api/java/cdk-graph/index.html#strictoptional_2","title":"strict
Optional","text":""},{"location":"api/java/cdk-graph/index.html#setattribute_3","title":"
- Type: java.lang.Boolean
setAttribute
","text":"public void setAttribute(java.lang.String key, java.lang.Object value)\n
Set attribute.
This will overwrite existing attribute.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_31","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_15","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#settag_3","title":"
- Type: java.lang.Object
setTag
","text":"public void setTag(java.lang.String key, java.lang.String value)\n
Set tag.
Will overwrite existing tag.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_32","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_16","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#addchild_1","title":"
- Type: java.lang.String
addChild
","text":"public void addChild(Node node)\n
Add child node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_10","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#addlink_1","title":"
- Type: Node
addLink
","text":"public void addLink(Edge edge)\n
Add link to another node.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_7","title":"edge
Required","text":""},{"location":"api/java/cdk-graph/index.html#addreverselink_1","title":"
- Type: Edge
addReverseLink
","text":"public void addReverseLink(Edge edge)\n
Add link from another node.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_8","title":"edge
Required","text":""},{"location":"api/java/cdk-graph/index.html#doesdependon_1","title":"
- Type: Edge
doesDependOn
","text":"public java.lang.Boolean doesDependOn(Node node)\n
Indicates if this node depends on another node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_11","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#doesreference_1","title":"
- Type: Node
doesReference
","text":"public java.lang.Boolean doesReference(Node node)\n
Indicates if this node references another node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_12","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#find_1","title":"
- Type: Node
find
","text":"public Node find(INodePredicate predicate)\n
Recursively find the nearest sub-node matching predicate.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_6","title":"predicate
Required","text":""},{"location":"api/java/cdk-graph/index.html#findall_1","title":"
- Type: INodePredicate
findAll
","text":"public java.util.List<Node> findAll()\npublic java.util.List<Node> findAll(IFindNodeOptions options)\n
Return this construct and all of its sub-nodes in the given order.
Optionally filter nodes based on predicate.
"},{"location":"api/java/cdk-graph/index.html#optionsoptional_2","title":"options
Optional","text":""},{"location":"api/java/cdk-graph/index.html#findalllinks_1","title":"
- Type: IFindNodeOptions
findAllLinks
","text":"public java.util.List<Edge> findAllLinks()\npublic java.util.List<Edge> findAllLinks(IFindEdgeOptions options)\n
Return all direct links of this node and that of all sub-nodes.
Optionally filter links based on predicate.
"},{"location":"api/java/cdk-graph/index.html#optionsoptional_3","title":"options
Optional","text":""},{"location":"api/java/cdk-graph/index.html#findancestor_1","title":"
- Type: IFindEdgeOptions
findAncestor
","text":"public Node findAncestor(INodePredicate predicate)\npublic Node findAncestor(INodePredicate predicate, java.lang.Number max)\n
Find nearest ancestor of this node matching given predicate.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_7","title":"predicate
Required","text":"
- Type: INodePredicate
Predicate to match ancestor.
"},{"location":"api/java/cdk-graph/index.html#maxoptional_1","title":"max
Optional","text":""},{"location":"api/java/cdk-graph/index.html#findchild_1","title":"
- Type: java.lang.Number
findChild
","text":"public Node findChild(java.lang.String id)\n
Find child with given id.
Similar to
"},{"location":"api/java/cdk-graph/index.html#idrequired_9","title":"find
but does not throw error if no child found.id
Required","text":""},{"location":"api/java/cdk-graph/index.html#findlink_1","title":"
- Type: java.lang.String
findLink
","text":"public Edge findLink(IEdgePredicate predicate)\npublic Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse)\npublic Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow)\npublic Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow, java.lang.Boolean direct)\n
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.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_8","title":"predicate
Required","text":"
- Type: IEdgePredicate
Edge predicate function to match edge.
"},{"location":"api/java/cdk-graph/index.html#reverseoptional_3","title":"reverse
Optional","text":"
- Type: java.lang.Boolean
Indicates if links are search in reverse order.
"},{"location":"api/java/cdk-graph/index.html#followoptional_2","title":"follow
Optional","text":"
- Type: java.lang.Boolean
Indicates if link chain is followed.
"},{"location":"api/java/cdk-graph/index.html#directoptional_2","title":"direct
Optional","text":"
- Type: java.lang.Boolean
Indicates that only direct links should be searched.
"},{"location":"api/java/cdk-graph/index.html#findlinks_1","title":"findLinks
","text":"public java.util.List<Edge> findLinks(IEdgePredicate predicate)\npublic java.util.List<Edge> findLinks(IEdgePredicate predicate, java.lang.Boolean reverse)\npublic java.util.List<Edge> findLinks(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow)\npublic java.util.List<Edge> findLinks(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow, java.lang.Boolean direct)\n
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.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_9","title":"predicate
Required","text":"
- Type: IEdgePredicate
Edge predicate function to match edge.
"},{"location":"api/java/cdk-graph/index.html#reverseoptional_4","title":"reverse
Optional","text":"
- Type: java.lang.Boolean
Indicates if links are search in reverse order.
"},{"location":"api/java/cdk-graph/index.html#followoptional_3","title":"follow
Optional","text":"
- Type: java.lang.Boolean
Indicates if link chain is followed.
"},{"location":"api/java/cdk-graph/index.html#directoptional_3","title":"direct
Optional","text":"
- Type: java.lang.Boolean
Indicates that only direct links should be searched.
"},{"location":"api/java/cdk-graph/index.html#getcfnprop_1","title":"getCfnProp
","text":"public java.lang.String OR java.lang.Number OR java.lang.Boolean OR PlainObject OR java.util.List<java.lang.String OR java.lang.Number OR java.lang.Boolean OR PlainObject> getCfnProp(java.lang.String key)\n
Get specific CloudFormation property.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_33","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#getchild_1","title":"
- Type: java.lang.String
getChild
","text":"public Node getChild(java.lang.String id)\n
Get child node with given id.
"},{"location":"api/java/cdk-graph/index.html#idrequired_10","title":"id
Required","text":""},{"location":"api/java/cdk-graph/index.html#getlinkchains_1","title":"
- Type: java.lang.String
getLinkChains
","text":"public java.util.List<java.util.List<java.lang.Object>> getLinkChains()\npublic java.util.List<java.util.List<java.lang.Object>> getLinkChains(java.lang.Boolean reverse)\n
Resolve all link chains.
{@link EdgeChain }
"},{"location":"api/java/cdk-graph/index.html#reverseoptional_5","title":"reverse
Optional","text":""},{"location":"api/java/cdk-graph/index.html#getnearestancestor_1","title":"
- Type: java.lang.Boolean
getNearestAncestor
","text":"public Node getNearestAncestor(Node node)\n
Gets the nearest common ancestor shared between this node and another node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_13","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#isancestor_1","title":"
- Type: Node
isAncestor
","text":"public java.lang.Boolean isAncestor(Node ancestor)\n
Indicates if a specific node is an ancestor of this node.
"},{"location":"api/java/cdk-graph/index.html#ancestorrequired_2","title":"ancestor
Required","text":""},{"location":"api/java/cdk-graph/index.html#ischild_1","title":"
- Type: Node
isChild
","text":"public java.lang.Boolean isChild(Node node)\n
Indicates if specific node is a child of this node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_14","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatecollapse_1","title":"
- Type: Node
mutateCollapse
","text":"public void mutateCollapse()\n
Collapses all sub-nodes of this node into this node.
"},{"location":"api/java/cdk-graph/index.html#mutatecollapseto_1","title":"mutateCollapseTo
","text":"public Node mutateCollapseTo(Node ancestor)\n
Collapses this node into an ancestor.
"},{"location":"api/java/cdk-graph/index.html#ancestorrequired_3","title":"ancestor
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatecollapsetoparent_1","title":"
- Type: Node
mutateCollapseToParent
","text":"public Node mutateCollapseToParent()\n
Collapses this node into it's parent node.
"},{"location":"api/java/cdk-graph/index.html#mutatehoist_1","title":"mutateHoist
","text":"public void mutateHoist(Node newParent)\n
Hoist this node to an ancestor by removing it from its current parent node and in turn moving it to the ancestor.
"},{"location":"api/java/cdk-graph/index.html#newparentrequired_2","title":"newParent
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatemove_1","title":"
- Type: Node
mutateMove
","text":"public void mutateMove(Node newParent)\n
Move this node into a new parent node.
"},{"location":"api/java/cdk-graph/index.html#newparentrequired_3","title":"newParent
Required","text":"
- Type: Node
The parent to move this node to.
"},{"location":"api/java/cdk-graph/index.html#mutateremovechild_1","title":"mutateRemoveChild
","text":"public java.lang.Boolean mutateRemoveChild(Node node)\n
Remove a child node from this node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_15","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateremovelink_1","title":"
- Type: Node
mutateRemoveLink
","text":"public java.lang.Boolean mutateRemoveLink(Edge link)\n
Remove a link from this node.
"},{"location":"api/java/cdk-graph/index.html#linkrequired_2","title":"link
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateremovereverselink_1","title":"
- Type: Edge
mutateRemoveReverseLink
","text":"public java.lang.Boolean mutateRemoveReverseLink(Edge link)\n
Remove a link to this node.
"},{"location":"api/java/cdk-graph/index.html#linkrequired_3","title":"link
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateuncluster_1","title":"
- Type: Edge
mutateUncluster
","text":"public void mutateUncluster()\n
Hoist all children to parent and collapse node to parent.
"},{"location":"api/java/cdk-graph/index.html#tostring_3","title":"toString
","text":"public java.lang.String toString()\n
Get string representation of this node.
"},{"location":"api/java/cdk-graph/index.html#isequivalentfqn","title":"isEquivalentFqn
","text":"public java.lang.Boolean isEquivalentFqn(ResourceNode resource)\n
Evaluates if CfnResourceNode fqn is equivalent to ResourceNode fqn.
Example
"},{"location":"api/java/cdk-graph/index.html#resourcerequired","title":"// Example automatically generated from non-compiling source. May contain errors.\n\"aws-cdk-lib.aws_lambda.Function\";\"aws-cdk-lib.aws_lambda.CfnFunction\";\n
resource
Required","text":"
- Type: ResourceNode
{@link Graph.ResourceNode } to compare.
"},{"location":"api/java/cdk-graph/index.html#static-functions_3","title":"Static Functions","text":"Name DescriptionisCfnResourceNode
Indicates if a node is a {@link CfnResourceNode}."},{"location":"api/java/cdk-graph/index.html#iscfnresourcenode","title":"isCfnResourceNode
","text":"import software.aws.pdk.cdk_graph.CfnResourceNode;\n\nCfnResourceNode.isCfnResourceNode(Node node)\n
Indicates if a node is a {@link CfnResourceNode}.
"},{"location":"api/java/cdk-graph/index.html#noderequired_16","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#properties_19","title":"Properties","text":"Name Type Description
- Type: Node
attributes
java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>> 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 aaws-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."},{"location":"api/java/cdk-graph/index.html#attributesrequired_3","title":"attributes
Required","text":"public java.lang.Object getAttributes();\n
- Type: java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>>
Get readonly record of all attributes.
"},{"location":"api/java/cdk-graph/index.html#flagsrequired_3","title":"flags
Required","text":"public java.util.List<FlagEnum> getFlags();\n
- Type: java.util.List<FlagEnum>
Get readonly list of all flags.
"},{"location":"api/java/cdk-graph/index.html#isdestroyedrequired_3","title":"isDestroyed
Required","text":"public java.lang.Boolean getIsDestroyed();\n
- Type: java.lang.Boolean
Indicates if the entity has been destroyed (eg: removed from store).
"},{"location":"api/java/cdk-graph/index.html#ismutatedrequired_3","title":"isMutated
Required","text":"public java.lang.Boolean getIsMutated();\n
- Type: java.lang.Boolean
Indicates if the entity has had destructive mutations applied.
"},{"location":"api/java/cdk-graph/index.html#metadatarequired_3","title":"metadata
Required","text":"public java.util.List<MetadataEntry> getMetadata();\n
- Type: java.util.List
Get readonly list of all metadata entries.
"},{"location":"api/java/cdk-graph/index.html#storerequired_5","title":"store
Required","text":"public Store getStore();\n
- Type: Store
Reference to the store.
"},{"location":"api/java/cdk-graph/index.html#tagsrequired_3","title":"tags
Required","text":"public java.util.Map<java.lang.String, java.lang.String> getTags();\n
- Type: java.util.Map
Get readonly record of all tags.
"},{"location":"api/java/cdk-graph/index.html#uuidrequired_8","title":"uuid
Required","text":"public java.lang.String getUuid();\n
- Type: java.lang.String
Universally unique identifier.
"},{"location":"api/java/cdk-graph/index.html#allowdestructivemutationsrequired_2","title":"allowDestructiveMutations
Required","text":"public java.lang.Boolean getAllowDestructiveMutations();\n
- Type: java.lang.Boolean
Indicates if this node allows destructive mutations.
{@link Store.allowDestructiveMutations }
"},{"location":"api/java/cdk-graph/index.html#childrenrequired_1","title":"children
Required","text":"public java.util.List<Node> getChildren();\n
- Type: java.util.List<Node>
Get all direct child nodes.
"},{"location":"api/java/cdk-graph/index.html#dependedonbyrequired_1","title":"dependedOnBy
Required","text":"public java.util.List<Node> getDependedOnBy();\n
- Type: java.util.List<Node>
Get list of Nodes that depend on this node.
{@link Node.reverseDependencyLinks }
"},{"location":"api/java/cdk-graph/index.html#dependenciesrequired_2","title":"dependencies
Required","text":"public java.util.List<Node> getDependencies();\n
- Type: java.util.List<Node>
Get list of Nodes that this node depends on.
{@link Node.dependencyLinks }
"},{"location":"api/java/cdk-graph/index.html#dependencylinksrequired_1","title":"dependencyLinks
Required","text":"public java.util.List<Dependency> getDependencyLinks();\n
- Type: java.util.List<Dependency>
Gets list of {@link Dependency} links (edges) where this node is the source.
"},{"location":"api/java/cdk-graph/index.html#depthrequired_1","title":"depth
Required","text":"public java.lang.Number getDepth();\n
- Type: java.lang.Number
Indicates the depth of the node relative to root (0).
"},{"location":"api/java/cdk-graph/index.html#idrequired_11","title":"id
Required","text":"public java.lang.String getId();\n
- Type: java.lang.String
Node id, which is only unique within parent scope.
"},{"location":"api/java/cdk-graph/index.html#isassetrequired_1","title":"isAsset
Required","text":"public java.lang.Boolean getIsAsset();\n
- Type: java.lang.Boolean
Indicates if this node is considered a {@link FlagEnum.ASSET}.
"},{"location":"api/java/cdk-graph/index.html#iscfnfqnrequired_1","title":"isCfnFqn
Required","text":"public java.lang.Boolean getIsCfnFqn();\n
- Type: java.lang.Boolean
Indicates if node ConstructInfoFqn denotes a
aws-cdk-lib.*.Cfn*
construct.{@link FlagEnum.CFN_FQN }
"},{"location":"api/java/cdk-graph/index.html#isclusterrequired_1","title":"isCluster
Required","text":"public java.lang.Boolean getIsCluster();\n
- Type: java.lang.Boolean
Indicates if this node is considered a {@link FlagEnum.CLUSTER}.
"},{"location":"api/java/cdk-graph/index.html#iscustomresourcerequired_1","title":"isCustomResource
Required","text":"public java.lang.Boolean getIsCustomResource();\n
- Type: java.lang.Boolean
Indicates if node is a Custom Resource.
"},{"location":"api/java/cdk-graph/index.html#isextraneousrequired_2","title":"isExtraneous
Required","text":"public java.lang.Boolean getIsExtraneous();\n
- 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.
"},{"location":"api/java/cdk-graph/index.html#isgraphcontainerrequired_1","title":"isGraphContainer
Required","text":"public java.lang.Boolean getIsGraphContainer();\n
- Type: java.lang.Boolean
Indicates if this node is considered a {@link FlagEnum.GRAPH_CONTAINER}.
"},{"location":"api/java/cdk-graph/index.html#isleafrequired_1","title":"isLeaf
Required","text":"public java.lang.Boolean getIsLeaf();\n
- Type: java.lang.Boolean
Indicates if this node is a leaf node, which means it does not have children.
"},{"location":"api/java/cdk-graph/index.html#istoplevelrequired_1","title":"isTopLevel
Required","text":"public java.lang.Boolean getIsTopLevel();\n
- Type: java.lang.Boolean
Indicates if node is direct child of the graph root node.
"},{"location":"api/java/cdk-graph/index.html#linksrequired_1","title":"links
Required","text":"public java.util.List<Edge> getLinks();\n
- Type: java.util.List<Edge>
Gets all links (edges) in which this node is the source.
"},{"location":"api/java/cdk-graph/index.html#nodetyperequired_2","title":"nodeType
Required","text":"public NodeTypeEnum getNodeType();\n
- Type: NodeTypeEnum
Type of node.
"},{"location":"api/java/cdk-graph/index.html#pathrequired_3","title":"path
Required","text":"public java.lang.String getPath();\n
- Type: java.lang.String
Path of the node.
"},{"location":"api/java/cdk-graph/index.html#referencedbyrequired_1","title":"referencedBy
Required","text":"public java.util.List<Node> getReferencedBy();\n
- Type: java.util.List<Node>
Get list of Nodes that reference this node.
{@link Node.reverseReferenceLinks }
"},{"location":"api/java/cdk-graph/index.html#referencelinksrequired_1","title":"referenceLinks
Required","text":"public java.util.List<Reference> getReferenceLinks();\n
- Type: java.util.List<Reference>
Gets list of {@link Reference} links (edges) where this node is the source.
"},{"location":"api/java/cdk-graph/index.html#referencesrequired_1","title":"references
Required","text":"public java.util.List<Node> getReferences();\n
- Type: java.util.List<Node>
Get list of Nodes that this node references.
{@link Node.referenceLinks }
"},{"location":"api/java/cdk-graph/index.html#reversedependencylinksrequired_1","title":"reverseDependencyLinks
Required","text":"public java.util.List<Dependency> getReverseDependencyLinks();\n
- Type: java.util.List<Dependency>
Gets list of {@link Dependency} links (edges) where this node is the target.
"},{"location":"api/java/cdk-graph/index.html#reverselinksrequired_1","title":"reverseLinks
Required","text":"public java.util.List<Edge> getReverseLinks();\n
- Type: java.util.List<Edge>
Gets all links (edges) in which this node is the target.
"},{"location":"api/java/cdk-graph/index.html#reversereferencelinksrequired_1","title":"reverseReferenceLinks
Required","text":"public java.util.List<Reference> getReverseReferenceLinks();\n
- Type: java.util.List<Reference>
Gets list of {@link Reference} links (edges) where this node is the target.
"},{"location":"api/java/cdk-graph/index.html#scopesrequired_1","title":"scopes
Required","text":"public java.util.List<Node> getScopes();\n
- Type: java.util.List<Node>
Gets descending ordered list of ancestors from the root.
"},{"location":"api/java/cdk-graph/index.html#siblingsrequired_1","title":"siblings
Required","text":"public java.util.List<Node> getSiblings();\n
- Type: java.util.List<Node>
Get list of siblings of this node.
"},{"location":"api/java/cdk-graph/index.html#cfnpropsoptional_1","title":"cfnProps
Optional","text":"public PlainObject getCfnProps();\n
- Type: PlainObject
Gets CloudFormation properties for this node.
"},{"location":"api/java/cdk-graph/index.html#cfntypeoptional_3","title":"cfnType
Optional","text":"public java.lang.String getCfnType();\n
- Type: java.lang.String
Get the CloudFormation resource type for this node.
"},{"location":"api/java/cdk-graph/index.html#constructinfooptional_3","title":"constructInfo
Optional","text":"public ConstructInfo getConstructInfo();\n
- Type: ConstructInfo
Synthesized construct information defining jii resolution data.
"},{"location":"api/java/cdk-graph/index.html#constructinfofqnoptional_1","title":"constructInfoFqn
Optional","text":"public java.lang.String getConstructInfoFqn();\n
- Type: java.lang.String
Synthesized construct information defining jii resolution data.
"},{"location":"api/java/cdk-graph/index.html#logicalidoptional_3","title":"logicalId
Optional","text":"public java.lang.String getLogicalId();\n
- Type: java.lang.String
Logical id of the node, which is only unique within containing stack.
"},{"location":"api/java/cdk-graph/index.html#parentoptional_2","title":"parent
Optional","text":"public Node getParent();\n
- Type: Node
Parent node.
Only the root node should not have parent.
"},{"location":"api/java/cdk-graph/index.html#rootstackoptional_1","title":"rootStack
Optional","text":"public StackNode getRootStack();\n
- Type: StackNode
Get root stack.
"},{"location":"api/java/cdk-graph/index.html#stackoptional_2","title":"stack
Optional","text":"public StackNode getStack();\n
- Type: StackNode
Stack the node is contained in.
"},{"location":"api/java/cdk-graph/index.html#isimportrequired","title":"isImport
Required","text":"public java.lang.Boolean getIsImport();\n
- Type: java.lang.Boolean
Indicates if this CfnResource is imported (eg:
"},{"location":"api/java/cdk-graph/index.html#resourceoptional","title":"s3.Bucket.fromBucketArn
).resource
Optional","text":"public ResourceNode getResource();\n
- Type: ResourceNode
Reference to the L2 Resource that wraps this L1 CfnResource if it is wrapped.
"},{"location":"api/java/cdk-graph/index.html#constants_3","title":"Constants","text":"Name Type DescriptionATT_IMPORT_ARN_TOKEN
java.lang.String
Normalized CfnReference attribute."},{"location":"api/java/cdk-graph/index.html#att_import_arn_tokenrequired","title":"ATT_IMPORT_ARN_TOKEN
Required","text":"public java.lang.String getAttImportArnToken();\n
- Type: java.lang.String
Normalized CfnReference attribute.
"},{"location":"api/java/cdk-graph/index.html#dependency","title":"Dependency","text":"Dependency edge class defines CloudFormation dependency between resources.
"},{"location":"api/java/cdk-graph/index.html#initializers_6","title":"Initializers","text":"Name Type Descriptionimport software.aws.pdk.cdk_graph.Dependency;\n\nnew Dependency(ITypedEdgeProps props);\n
props
ITypedEdgeProps
No description."},{"location":"api/java/cdk-graph/index.html#propsrequired_4","title":"props
Required","text":""},{"location":"api/java/cdk-graph/index.html#methods_6","title":"Methods","text":"Name Description
- Type: ITypedEdgeProps
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."},{"location":"api/java/cdk-graph/index.html#addattribute_4","title":"addAttribute
","text":"public void addAttribute(java.lang.String key, java.lang.Object value)\n
Add attribute.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_34","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_17","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#addflag_4","title":"
- Type: java.lang.Object
addFlag
","text":"public void addFlag(FlagEnum flag)\n
Add flag.
"},{"location":"api/java/cdk-graph/index.html#flagrequired_8","title":"flag
Required","text":""},{"location":"api/java/cdk-graph/index.html#addmetadata_4","title":"
- Type: FlagEnum
addMetadata
","text":"public void addMetadata(java.lang.String metadataType, java.lang.Object data)\n
Add metadata entry.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_12","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#datarequired_13","title":"
- Type: java.lang.String
data
Required","text":""},{"location":"api/java/cdk-graph/index.html#addtag_4","title":"
- Type: java.lang.Object
addTag
","text":"public void addTag(java.lang.String key, java.lang.String value)\n
Add tag.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_35","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_18","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#applydata_4","title":"
- Type: java.lang.String
applyData
","text":"public void applyData(IBaseEntityDataProps data)\npublic void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite)\npublic void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite, java.lang.Boolean applyFlags)\n
Applies data (attributes, metadata, tags, flag) to entity.
Generally used only for mutations such as collapse and consume to retain data.
"},{"location":"api/java/cdk-graph/index.html#datarequired_14","title":"data
Required","text":"
- Type: IBaseEntityDataProps
The data to apply.
"},{"location":"api/java/cdk-graph/index.html#overwriteoptional_4","title":"overwrite
Optional","text":""},{"location":"api/java/cdk-graph/index.html#applyflagsoptional_4","title":"
- Type: java.lang.Boolean
applyFlags
Optional","text":"
- Type: java.lang.Boolean
Indicates if data is overwritten - Indicates if flags should be applied.
"},{"location":"api/java/cdk-graph/index.html#findmetadata_4","title":"findMetadata
","text":"public java.util.List<MetadataEntry> findMetadata(java.lang.String metadataType)\n
Retrieves all metadata entries of a given type.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_13","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#getattribute_4","title":"
- Type: java.lang.String
getAttribute
","text":"public java.lang.Object getAttribute(java.lang.String key)\n
Get attribute by key.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_36","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#gettag_4","title":"
- Type: java.lang.String
getTag
","text":"public java.lang.String getTag(java.lang.String key)\n
Get tag by key.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_37","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#hasattribute_4","title":"
- Type: java.lang.String
hasAttribute
","text":"public java.lang.Boolean hasAttribute(java.lang.String key)\npublic java.lang.Boolean hasAttribute(java.lang.String key, java.lang.Object value)\n
Indicates if entity has a given attribute defined, and optionally with a specific value.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_38","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valueoptional_10","title":"
- Type: java.lang.String
value
Optional","text":""},{"location":"api/java/cdk-graph/index.html#hasflag_4","title":"
- Type: java.lang.Object
hasFlag
","text":"public java.lang.Boolean hasFlag(FlagEnum flag)\n
Indicates if entity has a given flag.
"},{"location":"api/java/cdk-graph/index.html#flagrequired_9","title":"flag
Required","text":""},{"location":"api/java/cdk-graph/index.html#hasmetadata_4","title":"
- Type: FlagEnum
hasMetadata
","text":"public java.lang.Boolean hasMetadata(java.lang.String metadataType, java.lang.Object data)\n
Indicates if entity has matching metadata entry.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_14","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#datarequired_15","title":"
- Type: java.lang.String
data
Required","text":""},{"location":"api/java/cdk-graph/index.html#hastag_4","title":"
- Type: java.lang.Object
hasTag
","text":"public java.lang.Boolean hasTag(java.lang.String key)\npublic java.lang.Boolean hasTag(java.lang.String key, java.lang.String value)\n
Indicates if entity has tag, optionally verifying tag value.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_39","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valueoptional_11","title":"
- Type: java.lang.String
value
Optional","text":""},{"location":"api/java/cdk-graph/index.html#mutatedestroy_4","title":"
- Type: java.lang.String
mutateDestroy
","text":"public void mutateDestroy()\npublic void mutateDestroy(java.lang.Boolean _strict)\n
Destroy the edge.
Remove all references and remove from store.
"},{"location":"api/java/cdk-graph/index.html#_strictoptional_1","title":"_strict
Optional","text":""},{"location":"api/java/cdk-graph/index.html#setattribute_4","title":"
- Type: java.lang.Boolean
setAttribute
","text":"public void setAttribute(java.lang.String key, java.lang.Object value)\n
Set attribute.
This will overwrite existing attribute.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_40","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_19","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#settag_4","title":"
- Type: java.lang.Object
setTag
","text":"public void setTag(java.lang.String key, java.lang.String value)\n
Set tag.
Will overwrite existing tag.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_41","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_20","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#isequivalent_1","title":"
- Type: java.lang.String
isEquivalent
","text":"public java.lang.Boolean isEquivalent(Edge edge)\n
Indicates if this edge is equivalent to another edge.
Edges are considered equivalent if they share same type, source, and target.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_9","title":"edge
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateconsume_1","title":"
- Type: Edge
mutateConsume
","text":"public void mutateConsume(Edge edge)\n
Merge an equivalent edge's data into this edge and destroy the other edge.
Used during filtering operations to consolidate equivalent edges.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_10","title":"edge
Required","text":"
- Type: Edge
The edge to consume.
"},{"location":"api/java/cdk-graph/index.html#mutatedirection_1","title":"mutateDirection
","text":"public void mutateDirection(EdgeDirectionEnum direction)\n
Change the edge direction.
"},{"location":"api/java/cdk-graph/index.html#directionrequired_3","title":"direction
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatesource_1","title":"
- Type: EdgeDirectionEnum
mutateSource
","text":"public void mutateSource(Node node)\n
Change the edge source.
"},{"location":"api/java/cdk-graph/index.html#noderequired_17","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatetarget_1","title":"
- Type: Node
mutateTarget
","text":"public void mutateTarget(Node node)\n
Change the edge target.
"},{"location":"api/java/cdk-graph/index.html#noderequired_18","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#tostring_4","title":"
- Type: Node
toString
","text":"public java.lang.String toString()\n
Get string representation of this edge.
"},{"location":"api/java/cdk-graph/index.html#static-functions_4","title":"Static Functions","text":"Name DescriptionfindAllInChain
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."},{"location":"api/java/cdk-graph/index.html#findallinchain_1","title":"findAllInChain
","text":"import software.aws.pdk.cdk_graph.Dependency;\n\nDependency.findAllInChain(java.util.List<java.lang.Object> chain, IEdgePredicate predicate)\n
Find all matching edges based on predicate within an EdgeChain.
"},{"location":"api/java/cdk-graph/index.html#chainrequired_2","title":"chain
Required","text":"
- Type: java.util.List"},{"location":"api/java/cdk-graph/index.html#predicaterequired_10","title":"
predicate
Required","text":""},{"location":"api/java/cdk-graph/index.html#findinchain_1","title":"
- Type: IEdgePredicate
findInChain
","text":"import software.aws.pdk.cdk_graph.Dependency;\n\nDependency.findInChain(java.util.List<java.lang.Object> chain, IEdgePredicate predicate)\n
Find first edge matching predicate within an EdgeChain.
"},{"location":"api/java/cdk-graph/index.html#chainrequired_3","title":"chain
Required","text":"
- Type: java.util.List"},{"location":"api/java/cdk-graph/index.html#predicaterequired_11","title":"
predicate
Required","text":""},{"location":"api/java/cdk-graph/index.html#isdependency","title":"
- Type: IEdgePredicate
isDependency
","text":"import software.aws.pdk.cdk_graph.Dependency;\n\nDependency.isDependency(Edge edge)\n
Indicates if given edge is a {@link Dependency} edge.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_11","title":"edge
Required","text":""},{"location":"api/java/cdk-graph/index.html#properties_20","title":"Properties","text":"Name Type Description
- Type: Edge
attributes
java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>> 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)."},{"location":"api/java/cdk-graph/index.html#attributesrequired_4","title":"attributes
Required","text":"public java.lang.Object getAttributes();\n
- Type: java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>>
Get readonly record of all attributes.
"},{"location":"api/java/cdk-graph/index.html#flagsrequired_4","title":"flags
Required","text":"public java.util.List<FlagEnum> getFlags();\n
- Type: java.util.List<FlagEnum>
Get readonly list of all flags.
"},{"location":"api/java/cdk-graph/index.html#isdestroyedrequired_4","title":"isDestroyed
Required","text":"public java.lang.Boolean getIsDestroyed();\n
- Type: java.lang.Boolean
Indicates if the entity has been destroyed (eg: removed from store).
"},{"location":"api/java/cdk-graph/index.html#ismutatedrequired_4","title":"isMutated
Required","text":"public java.lang.Boolean getIsMutated();\n
- Type: java.lang.Boolean
Indicates if the entity has had destructive mutations applied.
"},{"location":"api/java/cdk-graph/index.html#metadatarequired_4","title":"metadata
Required","text":"public java.util.List<MetadataEntry> getMetadata();\n
- Type: java.util.List
Get readonly list of all metadata entries.
"},{"location":"api/java/cdk-graph/index.html#storerequired_6","title":"store
Required","text":"public Store getStore();\n
- Type: Store
Reference to the store.
"},{"location":"api/java/cdk-graph/index.html#tagsrequired_4","title":"tags
Required","text":"public java.util.Map<java.lang.String, java.lang.String> getTags();\n
- Type: java.util.Map
Get readonly record of all tags.
"},{"location":"api/java/cdk-graph/index.html#uuidrequired_9","title":"uuid
Required","text":"public java.lang.String getUuid();\n
- Type: java.lang.String
Universally unique identifier.
"},{"location":"api/java/cdk-graph/index.html#allowdestructivemutationsrequired_3","title":"allowDestructiveMutations
Required","text":"public java.lang.Boolean getAllowDestructiveMutations();\n
- Type: java.lang.Boolean
Indicates if edge allows destructive mutations.
"},{"location":"api/java/cdk-graph/index.html#directionrequired_4","title":"direction
Required","text":"public EdgeDirectionEnum getDirection();\n
- Type: EdgeDirectionEnum
Indicates the direction in which the edge is directed.
"},{"location":"api/java/cdk-graph/index.html#edgetyperequired_2","title":"edgeType
Required","text":"public EdgeTypeEnum getEdgeType();\n
- Type: EdgeTypeEnum
Type of edge.
"},{"location":"api/java/cdk-graph/index.html#isclosedrequired_1","title":"isClosed
Required","text":"public java.lang.Boolean getIsClosed();\n
- 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
"},{"location":"api/java/cdk-graph/index.html#iscrossstackrequired_1","title":"hasFlag(FlagEnum.CLOSED_EDGE)
instead.isCrossStack
Required","text":"public java.lang.Boolean getIsCrossStack();\n
- Type: java.lang.Boolean
Indicates if source and target nodes reside in different root stacks.
"},{"location":"api/java/cdk-graph/index.html#isextraneousrequired_3","title":"isExtraneous
Required","text":"public java.lang.Boolean getIsExtraneous();\n
- 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).
"},{"location":"api/java/cdk-graph/index.html#sourcerequired_6","title":"source
Required","text":"public Node getSource();\n
- Type: Node
Edge source is the node that defines the edge (tail).
"},{"location":"api/java/cdk-graph/index.html#targetrequired_3","title":"target
Required","text":"public Node getTarget();\n
- Type: Node
Edge target is the node being referenced by the source (head).
"},{"location":"api/java/cdk-graph/index.html#constants_4","title":"Constants","text":"Name Type DescriptionPREFIX
java.lang.String
Edge prefix to denote dependency edge."},{"location":"api/java/cdk-graph/index.html#prefixrequired_1","title":"PREFIX
Required","text":"public java.lang.String getPrefix();\n
- Type: java.lang.String
Edge prefix to denote dependency edge.
"},{"location":"api/java/cdk-graph/index.html#edge","title":"Edge","text":"
- Implements: ISerializableEdge
Edge class defines a link (relationship) between nodes, as in standard graph theory.
"},{"location":"api/java/cdk-graph/index.html#initializers_7","title":"Initializers","text":"Name Type Descriptionimport software.aws.pdk.cdk_graph.Edge;\n\nnew Edge(IEdgeProps props);\n
props
IEdgeProps
No description."},{"location":"api/java/cdk-graph/index.html#propsrequired_5","title":"props
Required","text":""},{"location":"api/java/cdk-graph/index.html#methods_7","title":"Methods","text":"Name Description
- Type: IEdgeProps
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."},{"location":"api/java/cdk-graph/index.html#addattribute_5","title":"addAttribute
","text":"public void addAttribute(java.lang.String key, java.lang.Object value)\n
Add attribute.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_42","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_21","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#addflag_5","title":"
- Type: java.lang.Object
addFlag
","text":"public void addFlag(FlagEnum flag)\n
Add flag.
"},{"location":"api/java/cdk-graph/index.html#flagrequired_10","title":"flag
Required","text":""},{"location":"api/java/cdk-graph/index.html#addmetadata_5","title":"
- Type: FlagEnum
addMetadata
","text":"public void addMetadata(java.lang.String metadataType, java.lang.Object data)\n
Add metadata entry.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_15","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#datarequired_16","title":"
- Type: java.lang.String
data
Required","text":""},{"location":"api/java/cdk-graph/index.html#addtag_5","title":"
- Type: java.lang.Object
addTag
","text":"public void addTag(java.lang.String key, java.lang.String value)\n
Add tag.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_43","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_22","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#applydata_5","title":"
- Type: java.lang.String
applyData
","text":"public void applyData(IBaseEntityDataProps data)\npublic void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite)\npublic void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite, java.lang.Boolean applyFlags)\n
Applies data (attributes, metadata, tags, flag) to entity.
Generally used only for mutations such as collapse and consume to retain data.
"},{"location":"api/java/cdk-graph/index.html#datarequired_17","title":"data
Required","text":"
- Type: IBaseEntityDataProps
The data to apply.
"},{"location":"api/java/cdk-graph/index.html#overwriteoptional_5","title":"overwrite
Optional","text":""},{"location":"api/java/cdk-graph/index.html#applyflagsoptional_5","title":"
- Type: java.lang.Boolean
applyFlags
Optional","text":"
- Type: java.lang.Boolean
Indicates if data is overwritten - Indicates if flags should be applied.
"},{"location":"api/java/cdk-graph/index.html#findmetadata_5","title":"findMetadata
","text":"public java.util.List<MetadataEntry> findMetadata(java.lang.String metadataType)\n
Retrieves all metadata entries of a given type.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_16","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#getattribute_5","title":"
- Type: java.lang.String
getAttribute
","text":"public java.lang.Object getAttribute(java.lang.String key)\n
Get attribute by key.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_44","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#gettag_5","title":"
- Type: java.lang.String
getTag
","text":"public java.lang.String getTag(java.lang.String key)\n
Get tag by key.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_45","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#hasattribute_5","title":"
- Type: java.lang.String
hasAttribute
","text":"public java.lang.Boolean hasAttribute(java.lang.String key)\npublic java.lang.Boolean hasAttribute(java.lang.String key, java.lang.Object value)\n
Indicates if entity has a given attribute defined, and optionally with a specific value.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_46","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valueoptional_12","title":"
- Type: java.lang.String
value
Optional","text":""},{"location":"api/java/cdk-graph/index.html#hasflag_5","title":"
- Type: java.lang.Object
hasFlag
","text":"public java.lang.Boolean hasFlag(FlagEnum flag)\n
Indicates if entity has a given flag.
"},{"location":"api/java/cdk-graph/index.html#flagrequired_11","title":"flag
Required","text":""},{"location":"api/java/cdk-graph/index.html#hasmetadata_5","title":"
- Type: FlagEnum
hasMetadata
","text":"public java.lang.Boolean hasMetadata(java.lang.String metadataType, java.lang.Object data)\n
Indicates if entity has matching metadata entry.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_17","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#datarequired_18","title":"
- Type: java.lang.String
data
Required","text":""},{"location":"api/java/cdk-graph/index.html#hastag_5","title":"
- Type: java.lang.Object
hasTag
","text":"public java.lang.Boolean hasTag(java.lang.String key)\npublic java.lang.Boolean hasTag(java.lang.String key, java.lang.String value)\n
Indicates if entity has tag, optionally verifying tag value.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_47","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valueoptional_13","title":"
- Type: java.lang.String
value
Optional","text":""},{"location":"api/java/cdk-graph/index.html#mutatedestroy_5","title":"
- Type: java.lang.String
mutateDestroy
","text":"public void mutateDestroy()\npublic void mutateDestroy(java.lang.Boolean _strict)\n
Destroy the edge.
Remove all references and remove from store.
"},{"location":"api/java/cdk-graph/index.html#_strictoptional_2","title":"_strict
Optional","text":""},{"location":"api/java/cdk-graph/index.html#setattribute_5","title":"
- Type: java.lang.Boolean
setAttribute
","text":"public void setAttribute(java.lang.String key, java.lang.Object value)\n
Set attribute.
This will overwrite existing attribute.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_48","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_23","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#settag_5","title":"
- Type: java.lang.Object
setTag
","text":"public void setTag(java.lang.String key, java.lang.String value)\n
Set tag.
Will overwrite existing tag.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_49","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_24","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#isequivalent_2","title":"
- Type: java.lang.String
isEquivalent
","text":"public java.lang.Boolean isEquivalent(Edge edge)\n
Indicates if this edge is equivalent to another edge.
Edges are considered equivalent if they share same type, source, and target.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_12","title":"edge
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateconsume_2","title":"
- Type: Edge
mutateConsume
","text":"public void mutateConsume(Edge edge)\n
Merge an equivalent edge's data into this edge and destroy the other edge.
Used during filtering operations to consolidate equivalent edges.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_13","title":"edge
Required","text":"
- Type: Edge
The edge to consume.
"},{"location":"api/java/cdk-graph/index.html#mutatedirection_2","title":"mutateDirection
","text":"public void mutateDirection(EdgeDirectionEnum direction)\n
Change the edge direction.
"},{"location":"api/java/cdk-graph/index.html#directionrequired_5","title":"direction
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatesource_2","title":"
- Type: EdgeDirectionEnum
mutateSource
","text":"public void mutateSource(Node node)\n
Change the edge source.
"},{"location":"api/java/cdk-graph/index.html#noderequired_19","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatetarget_2","title":"
- Type: Node
mutateTarget
","text":"public void mutateTarget(Node node)\n
Change the edge target.
"},{"location":"api/java/cdk-graph/index.html#noderequired_20","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#tostring_5","title":"
- Type: Node
toString
","text":"public java.lang.String toString()\n
Get string representation of this edge.
"},{"location":"api/java/cdk-graph/index.html#static-functions_5","title":"Static Functions","text":"Name DescriptionfindAllInChain
Find all matching edges based on predicate within an EdgeChain.findInChain
Find first edge matching predicate within an EdgeChain."},{"location":"api/java/cdk-graph/index.html#findallinchain_2","title":"findAllInChain
","text":"import software.aws.pdk.cdk_graph.Edge;\n\nEdge.findAllInChain(java.util.List<java.lang.Object> chain, IEdgePredicate predicate)\n
Find all matching edges based on predicate within an EdgeChain.
"},{"location":"api/java/cdk-graph/index.html#chainrequired_4","title":"chain
Required","text":"
- Type: java.util.List"},{"location":"api/java/cdk-graph/index.html#predicaterequired_12","title":"
predicate
Required","text":""},{"location":"api/java/cdk-graph/index.html#findinchain_2","title":"
- Type: IEdgePredicate
findInChain
","text":"import software.aws.pdk.cdk_graph.Edge;\n\nEdge.findInChain(java.util.List<java.lang.Object> chain, IEdgePredicate predicate)\n
Find first edge matching predicate within an EdgeChain.
"},{"location":"api/java/cdk-graph/index.html#chainrequired_5","title":"chain
Required","text":"
- Type: java.util.List"},{"location":"api/java/cdk-graph/index.html#predicaterequired_13","title":"
predicate
Required","text":""},{"location":"api/java/cdk-graph/index.html#properties_21","title":"Properties","text":"Name Type Description
- Type: IEdgePredicate
attributes
java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>> 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)."},{"location":"api/java/cdk-graph/index.html#attributesrequired_5","title":"attributes
Required","text":"public java.lang.Object getAttributes();\n
- Type: java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>>
Get readonly record of all attributes.
"},{"location":"api/java/cdk-graph/index.html#flagsrequired_5","title":"flags
Required","text":"public java.util.List<FlagEnum> getFlags();\n
- Type: java.util.List<FlagEnum>
Get readonly list of all flags.
"},{"location":"api/java/cdk-graph/index.html#isdestroyedrequired_5","title":"isDestroyed
Required","text":"public java.lang.Boolean getIsDestroyed();\n
- Type: java.lang.Boolean
Indicates if the entity has been destroyed (eg: removed from store).
"},{"location":"api/java/cdk-graph/index.html#ismutatedrequired_5","title":"isMutated
Required","text":"public java.lang.Boolean getIsMutated();\n
- Type: java.lang.Boolean
Indicates if the entity has had destructive mutations applied.
"},{"location":"api/java/cdk-graph/index.html#metadatarequired_5","title":"metadata
Required","text":"public java.util.List<MetadataEntry> getMetadata();\n
- Type: java.util.List
Get readonly list of all metadata entries.
"},{"location":"api/java/cdk-graph/index.html#storerequired_7","title":"store
Required","text":"public Store getStore();\n
- Type: Store
Reference to the store.
"},{"location":"api/java/cdk-graph/index.html#tagsrequired_5","title":"tags
Required","text":"public java.util.Map<java.lang.String, java.lang.String> getTags();\n
- Type: java.util.Map
Get readonly record of all tags.
"},{"location":"api/java/cdk-graph/index.html#uuidrequired_10","title":"uuid
Required","text":"public java.lang.String getUuid();\n
- Type: java.lang.String
Universally unique identifier.
"},{"location":"api/java/cdk-graph/index.html#allowdestructivemutationsrequired_4","title":"allowDestructiveMutations
Required","text":"public java.lang.Boolean getAllowDestructiveMutations();\n
- Type: java.lang.Boolean
Indicates if edge allows destructive mutations.
"},{"location":"api/java/cdk-graph/index.html#directionrequired_6","title":"direction
Required","text":"public EdgeDirectionEnum getDirection();\n
- Type: EdgeDirectionEnum
Indicates the direction in which the edge is directed.
"},{"location":"api/java/cdk-graph/index.html#edgetyperequired_3","title":"edgeType
Required","text":"public EdgeTypeEnum getEdgeType();\n
- Type: EdgeTypeEnum
Type of edge.
"},{"location":"api/java/cdk-graph/index.html#isclosedrequired_2","title":"isClosed
Required","text":"public java.lang.Boolean getIsClosed();\n
- 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
"},{"location":"api/java/cdk-graph/index.html#iscrossstackrequired_2","title":"hasFlag(FlagEnum.CLOSED_EDGE)
instead.isCrossStack
Required","text":"public java.lang.Boolean getIsCrossStack();\n
- Type: java.lang.Boolean
Indicates if source and target nodes reside in different root stacks.
"},{"location":"api/java/cdk-graph/index.html#isextraneousrequired_4","title":"isExtraneous
Required","text":"public java.lang.Boolean getIsExtraneous();\n
- 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).
"},{"location":"api/java/cdk-graph/index.html#sourcerequired_7","title":"source
Required","text":"public Node getSource();\n
- Type: Node
Edge source is the node that defines the edge (tail).
"},{"location":"api/java/cdk-graph/index.html#targetrequired_4","title":"target
Required","text":"public Node getTarget();\n
- Type: Node
Edge target is the node being referenced by the source (head).
"},{"location":"api/java/cdk-graph/index.html#filters","title":"Filters","text":""},{"location":"api/java/cdk-graph/index.html#initializers_8","title":"Initializers","text":"Name Type Description"},{"location":"api/java/cdk-graph/index.html#static-functions_6","title":"Static Functions","text":"Name Descriptionimport software.aws.pdk.cdk_graph.Filters;\n\nnew Filters();\n
collapseCdkOwnedResources
Collapses all Cdk Owned containers, which more closely mirrors the application code by removing resources that are automatically created by cdk.collapseCdkWrappers
Collapses all Cdk Resource wrappers that wrap directly wrap a CfnResource.collapseCustomResources
Collapses Custom Resource nodes to a single node.compact
Collapses extraneous nodes to parent and cdk created nodes on themselves, and prunes extraneous edges.excludeCfnType
Prune all {@link Graph.ResourceNode} and {@link Graph.CfnResourceNode} nodes matching specified list of CloudFormation types.excludeNodeType
Prune all {@link Graph.Node}s matching specified list.includeCfnType
Prune all {@link Graph.ResourceNode} and {@link Graph.CfnResourceNode} nodes except those matching specified list of CloudFormation types.includeNodeType
Prune all {@link Graph.Node}s except those matching specified list.pruneCustomResources
Prune Custom Resource nodes.pruneEmptyContainers
Prune empty containers, which are non-resource default nodes without any children.pruneExtraneous
Prune extraneous nodes and edges.uncluster
Remove clusters by hoisting their children to the parent of the cluster and collapsing the cluster itself to its parent.verifyFilterable
Verify that store is filterable, meaning it allows destructive mutations."},{"location":"api/java/cdk-graph/index.html#collapsecdkownedresources","title":"collapseCdkOwnedResources
","text":"import software.aws.pdk.cdk_graph.Filters;\n\nFilters.collapseCdkOwnedResources()\n
Collapses all Cdk Owned containers, which more closely mirrors the application code by removing resources that are automatically created by cdk.
"},{"location":"api/java/cdk-graph/index.html#collapsecdkwrappers","title":"collapseCdkWrappers
","text":"import software.aws.pdk.cdk_graph.Filters;\n\nFilters.collapseCdkWrappers()\n
Collapses all Cdk Resource wrappers that wrap directly wrap a CfnResource.
Example, s3.Bucket wraps s3.CfnBucket.
"},{"location":"api/java/cdk-graph/index.html#collapsecustomresources","title":"collapseCustomResources
","text":"import software.aws.pdk.cdk_graph.Filters;\n\nFilters.collapseCustomResources()\n
Collapses Custom Resource nodes to a single node.
"},{"location":"api/java/cdk-graph/index.html#compact","title":"compact
","text":"import software.aws.pdk.cdk_graph.Filters;\n\nFilters.compact()\n
Collapses extraneous nodes to parent and cdk created nodes on themselves, and prunes extraneous edges.
This most closely represents the developers code for the current application and reduces the noise one expects.
Invokes: 1.
"},{"location":"api/java/cdk-graph/index.html#excludecfntype","title":"
- pruneExtraneous()(store);
- collapseCdkOwnedResources()(store);
- collapseCdkWrappers()(store);
- collapseCustomResources()(store);
- ~pruneCustomResources()(store);~
- pruneEmptyContainers()(store);
excludeCfnType
","text":"import software.aws.pdk.cdk_graph.Filters;\n\nFilters.excludeCfnType(java.util.List<FilterValue> cfnTypes)\n
Prune all {@link Graph.ResourceNode} and {@link Graph.CfnResourceNode} nodes matching specified list of CloudFormation types.
"},{"location":"api/java/cdk-graph/index.html#cfntypesrequired","title":"cfnTypes
Required","text":""},{"location":"api/java/cdk-graph/index.html#excludenodetype","title":"
- Type: java.util.List<FilterValue>
excludeNodeType
","text":"import software.aws.pdk.cdk_graph.Filters;\n\nFilters.excludeNodeType(java.util.List<FilterValue> nodeTypes)\n
Prune all {@link Graph.Node}s matching specified list.
This filter targets all nodes (except root) - {@link IGraphFilter.allNodes}
"},{"location":"api/java/cdk-graph/index.html#nodetypesrequired","title":"nodeTypes
Required","text":""},{"location":"api/java/cdk-graph/index.html#includecfntype","title":"
- Type: java.util.List<FilterValue>
includeCfnType
","text":"import software.aws.pdk.cdk_graph.Filters;\n\nFilters.includeCfnType(java.util.List<FilterValue> cfnTypes)\n
Prune all {@link Graph.ResourceNode} and {@link Graph.CfnResourceNode} nodes except those matching specified list of CloudFormation types.
"},{"location":"api/java/cdk-graph/index.html#cfntypesrequired_1","title":"cfnTypes
Required","text":""},{"location":"api/java/cdk-graph/index.html#includenodetype","title":"
- Type: java.util.List<FilterValue>
includeNodeType
","text":"import software.aws.pdk.cdk_graph.Filters;\n\nFilters.includeNodeType(java.util.List<FilterValue> nodeTypes)\n
Prune all {@link Graph.Node}s except those matching specified list.
This filter targets all nodes (except root) - {@link IGraphFilter.allNodes}
"},{"location":"api/java/cdk-graph/index.html#nodetypesrequired_1","title":"nodeTypes
Required","text":""},{"location":"api/java/cdk-graph/index.html#prunecustomresources","title":"
- Type: java.util.List<FilterValue>
pruneCustomResources
","text":"import software.aws.pdk.cdk_graph.Filters;\n\nFilters.pruneCustomResources()\n
Prune Custom Resource nodes.
"},{"location":"api/java/cdk-graph/index.html#pruneemptycontainers","title":"pruneEmptyContainers
","text":"import software.aws.pdk.cdk_graph.Filters;\n\nFilters.pruneEmptyContainers()\n
Prune empty containers, which are non-resource default nodes without any children.
Generally L3 constructs in which all children have already been pruned, which would be useful as containers, but without children are considered extraneous.
"},{"location":"api/java/cdk-graph/index.html#pruneextraneous","title":"pruneExtraneous
","text":"import software.aws.pdk.cdk_graph.Filters;\n\nFilters.pruneExtraneous()\n
Prune extraneous nodes and edges.
"},{"location":"api/java/cdk-graph/index.html#uncluster","title":"uncluster
","text":"import software.aws.pdk.cdk_graph.Filters;\n\nFilters.uncluster(),Filters.uncluster(java.util.List<NodeTypeEnum> clusterTypes)\n
Remove clusters by hoisting their children to the parent of the cluster and collapsing the cluster itself to its parent.
{@link Graph.Node.mutateUncluster }
"},{"location":"api/java/cdk-graph/index.html#clustertypesoptional","title":"clusterTypes
Optional","text":""},{"location":"api/java/cdk-graph/index.html#verifyfilterable","title":"
- Type: java.util.List<NodeTypeEnum>
verifyFilterable
","text":"import software.aws.pdk.cdk_graph.Filters;\n\nFilters.verifyFilterable(Store store)\n
Verify that store is filterable, meaning it allows destructive mutations.
"},{"location":"api/java/cdk-graph/index.html#storerequired_8","title":"store
Required","text":""},{"location":"api/java/cdk-graph/index.html#importreference","title":"ImportReference","text":"
- Type: Store
Import reference defines Fn::ImportValue type reference edge.
"},{"location":"api/java/cdk-graph/index.html#initializers_9","title":"Initializers","text":"Name Type Descriptionimport software.aws.pdk.cdk_graph.ImportReference;\n\nnew ImportReference(ITypedEdgeProps props);\n
props
ITypedEdgeProps
No description."},{"location":"api/java/cdk-graph/index.html#propsrequired_6","title":"props
Required","text":""},{"location":"api/java/cdk-graph/index.html#methods_8","title":"Methods","text":"Name Description
- Type: ITypedEdgeProps
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."},{"location":"api/java/cdk-graph/index.html#addattribute_6","title":"addAttribute
","text":"public void addAttribute(java.lang.String key, java.lang.Object value)\n
Add attribute.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_50","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_25","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#addflag_6","title":"
- Type: java.lang.Object
addFlag
","text":"public void addFlag(FlagEnum flag)\n
Add flag.
"},{"location":"api/java/cdk-graph/index.html#flagrequired_12","title":"flag
Required","text":""},{"location":"api/java/cdk-graph/index.html#addmetadata_6","title":"
- Type: FlagEnum
addMetadata
","text":"public void addMetadata(java.lang.String metadataType, java.lang.Object data)\n
Add metadata entry.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_18","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#datarequired_19","title":"
- Type: java.lang.String
data
Required","text":""},{"location":"api/java/cdk-graph/index.html#addtag_6","title":"
- Type: java.lang.Object
addTag
","text":"public void addTag(java.lang.String key, java.lang.String value)\n
Add tag.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_51","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_26","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#applydata_6","title":"
- Type: java.lang.String
applyData
","text":"public void applyData(IBaseEntityDataProps data)\npublic void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite)\npublic void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite, java.lang.Boolean applyFlags)\n
Applies data (attributes, metadata, tags, flag) to entity.
Generally used only for mutations such as collapse and consume to retain data.
"},{"location":"api/java/cdk-graph/index.html#datarequired_20","title":"data
Required","text":"
- Type: IBaseEntityDataProps
The data to apply.
"},{"location":"api/java/cdk-graph/index.html#overwriteoptional_6","title":"overwrite
Optional","text":""},{"location":"api/java/cdk-graph/index.html#applyflagsoptional_6","title":"
- Type: java.lang.Boolean
applyFlags
Optional","text":"
- Type: java.lang.Boolean
Indicates if data is overwritten - Indicates if flags should be applied.
"},{"location":"api/java/cdk-graph/index.html#findmetadata_6","title":"findMetadata
","text":"public java.util.List<MetadataEntry> findMetadata(java.lang.String metadataType)\n
Retrieves all metadata entries of a given type.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_19","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#getattribute_6","title":"
- Type: java.lang.String
getAttribute
","text":"public java.lang.Object getAttribute(java.lang.String key)\n
Get attribute by key.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_52","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#gettag_6","title":"
- Type: java.lang.String
getTag
","text":"public java.lang.String getTag(java.lang.String key)\n
Get tag by key.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_53","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#hasattribute_6","title":"
- Type: java.lang.String
hasAttribute
","text":"public java.lang.Boolean hasAttribute(java.lang.String key)\npublic java.lang.Boolean hasAttribute(java.lang.String key, java.lang.Object value)\n
Indicates if entity has a given attribute defined, and optionally with a specific value.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_54","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valueoptional_14","title":"
- Type: java.lang.String
value
Optional","text":""},{"location":"api/java/cdk-graph/index.html#hasflag_6","title":"
- Type: java.lang.Object
hasFlag
","text":"public java.lang.Boolean hasFlag(FlagEnum flag)\n
Indicates if entity has a given flag.
"},{"location":"api/java/cdk-graph/index.html#flagrequired_13","title":"flag
Required","text":""},{"location":"api/java/cdk-graph/index.html#hasmetadata_6","title":"
- Type: FlagEnum
hasMetadata
","text":"public java.lang.Boolean hasMetadata(java.lang.String metadataType, java.lang.Object data)\n
Indicates if entity has matching metadata entry.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_20","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#datarequired_21","title":"
- Type: java.lang.String
data
Required","text":""},{"location":"api/java/cdk-graph/index.html#hastag_6","title":"
- Type: java.lang.Object
hasTag
","text":"public java.lang.Boolean hasTag(java.lang.String key)\npublic java.lang.Boolean hasTag(java.lang.String key, java.lang.String value)\n
Indicates if entity has tag, optionally verifying tag value.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_55","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valueoptional_15","title":"
- Type: java.lang.String
value
Optional","text":""},{"location":"api/java/cdk-graph/index.html#mutatedestroy_6","title":"
- Type: java.lang.String
mutateDestroy
","text":"public void mutateDestroy()\npublic void mutateDestroy(java.lang.Boolean _strict)\n
Destroy the edge.
Remove all references and remove from store.
"},{"location":"api/java/cdk-graph/index.html#_strictoptional_3","title":"_strict
Optional","text":""},{"location":"api/java/cdk-graph/index.html#setattribute_6","title":"
- Type: java.lang.Boolean
setAttribute
","text":"public void setAttribute(java.lang.String key, java.lang.Object value)\n
Set attribute.
This will overwrite existing attribute.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_56","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_27","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#settag_6","title":"
- Type: java.lang.Object
setTag
","text":"public void setTag(java.lang.String key, java.lang.String value)\n
Set tag.
Will overwrite existing tag.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_57","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_28","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#isequivalent_3","title":"
- Type: java.lang.String
isEquivalent
","text":"public java.lang.Boolean isEquivalent(Edge edge)\n
Indicates if this edge is equivalent to another edge.
Edges are considered equivalent if they share same type, source, and target.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_14","title":"edge
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateconsume_3","title":"
- Type: Edge
mutateConsume
","text":"public void mutateConsume(Edge edge)\n
Merge an equivalent edge's data into this edge and destroy the other edge.
Used during filtering operations to consolidate equivalent edges.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_15","title":"edge
Required","text":"
- Type: Edge
The edge to consume.
"},{"location":"api/java/cdk-graph/index.html#mutatedirection_3","title":"mutateDirection
","text":"public void mutateDirection(EdgeDirectionEnum direction)\n
Change the edge direction.
"},{"location":"api/java/cdk-graph/index.html#directionrequired_7","title":"direction
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatesource_3","title":"
- Type: EdgeDirectionEnum
mutateSource
","text":"public void mutateSource(Node node)\n
Change the edge source.
"},{"location":"api/java/cdk-graph/index.html#noderequired_21","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatetarget_3","title":"
- Type: Node
mutateTarget
","text":"public void mutateTarget(Node node)\n
Change the edge target.
"},{"location":"api/java/cdk-graph/index.html#noderequired_22","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#tostring_6","title":"
- Type: Node
toString
","text":"public java.lang.String toString()\n
Get string representation of this edge.
"},{"location":"api/java/cdk-graph/index.html#resolvechain_1","title":"resolveChain
","text":"public java.util.List<java.lang.Object> resolveChain()\n
Resolve reference chain.
"},{"location":"api/java/cdk-graph/index.html#resolvetargets_1","title":"resolveTargets
","text":"public java.util.List<Node> resolveTargets()\n
Resolve targets by following potential edge chain.
{@link EdgeChain }
"},{"location":"api/java/cdk-graph/index.html#static-functions_7","title":"Static Functions","text":"Name DescriptionfindAllInChain
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}."},{"location":"api/java/cdk-graph/index.html#findallinchain_3","title":"findAllInChain
","text":"import software.aws.pdk.cdk_graph.ImportReference;\n\nImportReference.findAllInChain(java.util.List<java.lang.Object> chain, IEdgePredicate predicate)\n
Find all matching edges based on predicate within an EdgeChain.
"},{"location":"api/java/cdk-graph/index.html#chainrequired_6","title":"chain
Required","text":"
- Type: java.util.List"},{"location":"api/java/cdk-graph/index.html#predicaterequired_14","title":"
predicate
Required","text":""},{"location":"api/java/cdk-graph/index.html#findinchain_3","title":"
- Type: IEdgePredicate
findInChain
","text":"import software.aws.pdk.cdk_graph.ImportReference;\n\nImportReference.findInChain(java.util.List<java.lang.Object> chain, IEdgePredicate predicate)\n
Find first edge matching predicate within an EdgeChain.
"},{"location":"api/java/cdk-graph/index.html#chainrequired_7","title":"chain
Required","text":"
- Type: java.util.List"},{"location":"api/java/cdk-graph/index.html#predicaterequired_15","title":"
predicate
Required","text":""},{"location":"api/java/cdk-graph/index.html#isref_1","title":"
- Type: IEdgePredicate
isRef
","text":"import software.aws.pdk.cdk_graph.ImportReference;\n\nImportReference.isRef(Edge edge)\n
Indicates if edge is a Ref based {@link Reference} edge.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_16","title":"edge
Required","text":""},{"location":"api/java/cdk-graph/index.html#isreference_1","title":"
- Type: Edge
isReference
","text":"import software.aws.pdk.cdk_graph.ImportReference;\n\nImportReference.isReference(Edge edge)\n
Indicates if edge is a {@link Reference}.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_17","title":"edge
Required","text":""},{"location":"api/java/cdk-graph/index.html#isimport","title":"
- Type: Edge
isImport
","text":"import software.aws.pdk.cdk_graph.ImportReference;\n\nImportReference.isImport(Edge edge)\n
Indicates if edge is Fn::ImportValue based {@link Reference}.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_18","title":"edge
Required","text":""},{"location":"api/java/cdk-graph/index.html#properties_22","title":"Properties","text":"Name Type Description
- Type: Edge
attributes
java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>> 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."},{"location":"api/java/cdk-graph/index.html#attributesrequired_6","title":"attributes
Required","text":"public java.lang.Object getAttributes();\n
- Type: java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>>
Get readonly record of all attributes.
"},{"location":"api/java/cdk-graph/index.html#flagsrequired_6","title":"flags
Required","text":"public java.util.List<FlagEnum> getFlags();\n
- Type: java.util.List<FlagEnum>
Get readonly list of all flags.
"},{"location":"api/java/cdk-graph/index.html#isdestroyedrequired_6","title":"isDestroyed
Required","text":"public java.lang.Boolean getIsDestroyed();\n
- Type: java.lang.Boolean
Indicates if the entity has been destroyed (eg: removed from store).
"},{"location":"api/java/cdk-graph/index.html#ismutatedrequired_6","title":"isMutated
Required","text":"public java.lang.Boolean getIsMutated();\n
- Type: java.lang.Boolean
Indicates if the entity has had destructive mutations applied.
"},{"location":"api/java/cdk-graph/index.html#metadatarequired_6","title":"metadata
Required","text":"public java.util.List<MetadataEntry> getMetadata();\n
- Type: java.util.List
Get readonly list of all metadata entries.
"},{"location":"api/java/cdk-graph/index.html#storerequired_9","title":"store
Required","text":"public Store getStore();\n
- Type: Store
Reference to the store.
"},{"location":"api/java/cdk-graph/index.html#tagsrequired_6","title":"tags
Required","text":"public java.util.Map<java.lang.String, java.lang.String> getTags();\n
- Type: java.util.Map
Get readonly record of all tags.
"},{"location":"api/java/cdk-graph/index.html#uuidrequired_11","title":"uuid
Required","text":"public java.lang.String getUuid();\n
- Type: java.lang.String
Universally unique identifier.
"},{"location":"api/java/cdk-graph/index.html#allowdestructivemutationsrequired_5","title":"allowDestructiveMutations
Required","text":"public java.lang.Boolean getAllowDestructiveMutations();\n
- Type: java.lang.Boolean
Indicates if edge allows destructive mutations.
"},{"location":"api/java/cdk-graph/index.html#directionrequired_8","title":"direction
Required","text":"public EdgeDirectionEnum getDirection();\n
- Type: EdgeDirectionEnum
Indicates the direction in which the edge is directed.
"},{"location":"api/java/cdk-graph/index.html#edgetyperequired_4","title":"edgeType
Required","text":"public EdgeTypeEnum getEdgeType();\n
- Type: EdgeTypeEnum
Type of edge.
"},{"location":"api/java/cdk-graph/index.html#isclosedrequired_3","title":"isClosed
Required","text":"public java.lang.Boolean getIsClosed();\n
- 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
"},{"location":"api/java/cdk-graph/index.html#iscrossstackrequired_3","title":"hasFlag(FlagEnum.CLOSED_EDGE)
instead.isCrossStack
Required","text":"public java.lang.Boolean getIsCrossStack();\n
- Type: java.lang.Boolean
Indicates if source and target nodes reside in different root stacks.
"},{"location":"api/java/cdk-graph/index.html#isextraneousrequired_5","title":"isExtraneous
Required","text":"public java.lang.Boolean getIsExtraneous();\n
- 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).
"},{"location":"api/java/cdk-graph/index.html#sourcerequired_8","title":"source
Required","text":"public Node getSource();\n
- Type: Node
Edge source is the node that defines the edge (tail).
"},{"location":"api/java/cdk-graph/index.html#targetrequired_5","title":"target
Required","text":"public Node getTarget();\n
- Type: Node
Edge target is the node being referenced by the source (head).
"},{"location":"api/java/cdk-graph/index.html#referencetyperequired_2","title":"referenceType
Required","text":"public ReferenceTypeEnum getReferenceType();\n
- Type: ReferenceTypeEnum
Get type of reference.
"},{"location":"api/java/cdk-graph/index.html#constants_5","title":"Constants","text":"Name Type DescriptionATT_TYPE
java.lang.String
Attribute defining the type of reference.PREFIX
java.lang.String
Edge prefix to denote Fn::ImportValue type reference edge."},{"location":"api/java/cdk-graph/index.html#att_typerequired_1","title":"ATT_TYPE
Required","text":"public java.lang.String getAttType();\n
- Type: java.lang.String
Attribute defining the type of reference.
"},{"location":"api/java/cdk-graph/index.html#prefixrequired_2","title":"PREFIX
Required","text":"public java.lang.String getPrefix();\n
- Type: java.lang.String
Edge prefix to denote Fn::ImportValue type reference edge.
"},{"location":"api/java/cdk-graph/index.html#nestedstacknode","title":"NestedStackNode","text":"NestedStackNode defines a cdk NestedStack.
"},{"location":"api/java/cdk-graph/index.html#initializers_10","title":"Initializers","text":"Name Type Descriptionimport software.aws.pdk.cdk_graph.NestedStackNode;\n\nnew NestedStackNode(INestedStackNodeProps props);\n
props
INestedStackNodeProps
No description."},{"location":"api/java/cdk-graph/index.html#propsrequired_7","title":"props
Required","text":""},{"location":"api/java/cdk-graph/index.html#methods_9","title":"Methods","text":"Name Description
- Type: INestedStackNodeProps
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."},{"location":"api/java/cdk-graph/index.html#addattribute_7","title":"addAttribute
","text":"public void addAttribute(java.lang.String key, java.lang.Object value)\n
Add attribute.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_58","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_29","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#addflag_7","title":"
- Type: java.lang.Object
addFlag
","text":"public void addFlag(FlagEnum flag)\n
Add flag.
"},{"location":"api/java/cdk-graph/index.html#flagrequired_14","title":"flag
Required","text":""},{"location":"api/java/cdk-graph/index.html#addmetadata_7","title":"
- Type: FlagEnum
addMetadata
","text":"public void addMetadata(java.lang.String metadataType, java.lang.Object data)\n
Add metadata entry.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_21","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#datarequired_22","title":"
- Type: java.lang.String
data
Required","text":""},{"location":"api/java/cdk-graph/index.html#addtag_7","title":"
- Type: java.lang.Object
addTag
","text":"public void addTag(java.lang.String key, java.lang.String value)\n
Add tag.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_59","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_30","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#applydata_7","title":"
- Type: java.lang.String
applyData
","text":"public void applyData(IBaseEntityDataProps data)\npublic void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite)\npublic void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite, java.lang.Boolean applyFlags)\n
Applies data (attributes, metadata, tags, flag) to entity.
Generally used only for mutations such as collapse and consume to retain data.
"},{"location":"api/java/cdk-graph/index.html#datarequired_23","title":"data
Required","text":"
- Type: IBaseEntityDataProps
The data to apply.
"},{"location":"api/java/cdk-graph/index.html#overwriteoptional_7","title":"overwrite
Optional","text":""},{"location":"api/java/cdk-graph/index.html#applyflagsoptional_7","title":"
- Type: java.lang.Boolean
applyFlags
Optional","text":"
- Type: java.lang.Boolean
Indicates if data is overwritten - Indicates if flags should be applied.
"},{"location":"api/java/cdk-graph/index.html#findmetadata_7","title":"findMetadata
","text":"public java.util.List<MetadataEntry> findMetadata(java.lang.String metadataType)\n
Retrieves all metadata entries of a given type.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_22","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#getattribute_7","title":"
- Type: java.lang.String
getAttribute
","text":"public java.lang.Object getAttribute(java.lang.String key)\n
Get attribute by key.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_60","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#gettag_7","title":"
- Type: java.lang.String
getTag
","text":"public java.lang.String getTag(java.lang.String key)\n
Get tag by key.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_61","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#hasattribute_7","title":"
- Type: java.lang.String
hasAttribute
","text":"public java.lang.Boolean hasAttribute(java.lang.String key)\npublic java.lang.Boolean hasAttribute(java.lang.String key, java.lang.Object value)\n
Indicates if entity has a given attribute defined, and optionally with a specific value.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_62","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valueoptional_16","title":"
- Type: java.lang.String
value
Optional","text":""},{"location":"api/java/cdk-graph/index.html#hasflag_7","title":"
- Type: java.lang.Object
hasFlag
","text":"public java.lang.Boolean hasFlag(FlagEnum flag)\n
Indicates if entity has a given flag.
"},{"location":"api/java/cdk-graph/index.html#flagrequired_15","title":"flag
Required","text":""},{"location":"api/java/cdk-graph/index.html#hasmetadata_7","title":"
- Type: FlagEnum
hasMetadata
","text":"public java.lang.Boolean hasMetadata(java.lang.String metadataType, java.lang.Object data)\n
Indicates if entity has matching metadata entry.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_23","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#datarequired_24","title":"
- Type: java.lang.String
data
Required","text":""},{"location":"api/java/cdk-graph/index.html#hastag_7","title":"
- Type: java.lang.Object
hasTag
","text":"public java.lang.Boolean hasTag(java.lang.String key)\npublic java.lang.Boolean hasTag(java.lang.String key, java.lang.String value)\n
Indicates if entity has tag, optionally verifying tag value.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_63","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valueoptional_17","title":"
- Type: java.lang.String
value
Optional","text":""},{"location":"api/java/cdk-graph/index.html#mutatedestroy_7","title":"
- Type: java.lang.String
mutateDestroy
","text":"public void mutateDestroy()\npublic void mutateDestroy(java.lang.Boolean strict)\n
Destroys this node by removing all references and removing this node from the store.
"},{"location":"api/java/cdk-graph/index.html#strictoptional_3","title":"strict
Optional","text":""},{"location":"api/java/cdk-graph/index.html#setattribute_7","title":"
- Type: java.lang.Boolean
setAttribute
","text":"public void setAttribute(java.lang.String key, java.lang.Object value)\n
Set attribute.
This will overwrite existing attribute.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_64","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_31","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#settag_7","title":"
- Type: java.lang.Object
setTag
","text":"public void setTag(java.lang.String key, java.lang.String value)\n
Set tag.
Will overwrite existing tag.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_65","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_32","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#addchild_2","title":"
- Type: java.lang.String
addChild
","text":"public void addChild(Node node)\n
Add child node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_23","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#addlink_2","title":"
- Type: Node
addLink
","text":"public void addLink(Edge edge)\n
Add link to another node.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_19","title":"edge
Required","text":""},{"location":"api/java/cdk-graph/index.html#addreverselink_2","title":"
- Type: Edge
addReverseLink
","text":"public void addReverseLink(Edge edge)\n
Add link from another node.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_20","title":"edge
Required","text":""},{"location":"api/java/cdk-graph/index.html#doesdependon_2","title":"
- Type: Edge
doesDependOn
","text":"public java.lang.Boolean doesDependOn(Node node)\n
Indicates if this node depends on another node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_24","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#doesreference_2","title":"
- Type: Node
doesReference
","text":"public java.lang.Boolean doesReference(Node node)\n
Indicates if this node references another node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_25","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#find_2","title":"
- Type: Node
find
","text":"public Node find(INodePredicate predicate)\n
Recursively find the nearest sub-node matching predicate.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_16","title":"predicate
Required","text":""},{"location":"api/java/cdk-graph/index.html#findall_2","title":"
- Type: INodePredicate
findAll
","text":"public java.util.List<Node> findAll()\npublic java.util.List<Node> findAll(IFindNodeOptions options)\n
Return this construct and all of its sub-nodes in the given order.
Optionally filter nodes based on predicate.
"},{"location":"api/java/cdk-graph/index.html#optionsoptional_4","title":"options
Optional","text":""},{"location":"api/java/cdk-graph/index.html#findalllinks_2","title":"
- Type: IFindNodeOptions
findAllLinks
","text":"public java.util.List<Edge> findAllLinks()\npublic java.util.List<Edge> findAllLinks(IFindEdgeOptions options)\n
Return all direct links of this node and that of all sub-nodes.
Optionally filter links based on predicate.
"},{"location":"api/java/cdk-graph/index.html#optionsoptional_5","title":"options
Optional","text":""},{"location":"api/java/cdk-graph/index.html#findancestor_2","title":"
- Type: IFindEdgeOptions
findAncestor
","text":"public Node findAncestor(INodePredicate predicate)\npublic Node findAncestor(INodePredicate predicate, java.lang.Number max)\n
Find nearest ancestor of this node matching given predicate.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_17","title":"predicate
Required","text":"
- Type: INodePredicate
Predicate to match ancestor.
"},{"location":"api/java/cdk-graph/index.html#maxoptional_2","title":"max
Optional","text":""},{"location":"api/java/cdk-graph/index.html#findchild_2","title":"
- Type: java.lang.Number
findChild
","text":"public Node findChild(java.lang.String id)\n
Find child with given id.
Similar to
"},{"location":"api/java/cdk-graph/index.html#idrequired_12","title":"find
but does not throw error if no child found.id
Required","text":""},{"location":"api/java/cdk-graph/index.html#findlink_2","title":"
- Type: java.lang.String
findLink
","text":"public Edge findLink(IEdgePredicate predicate)\npublic Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse)\npublic Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow)\npublic Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow, java.lang.Boolean direct)\n
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.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_18","title":"predicate
Required","text":"
- Type: IEdgePredicate
Edge predicate function to match edge.
"},{"location":"api/java/cdk-graph/index.html#reverseoptional_6","title":"reverse
Optional","text":"
- Type: java.lang.Boolean
Indicates if links are search in reverse order.
"},{"location":"api/java/cdk-graph/index.html#followoptional_4","title":"follow
Optional","text":"
- Type: java.lang.Boolean
Indicates if link chain is followed.
"},{"location":"api/java/cdk-graph/index.html#directoptional_4","title":"direct
Optional","text":"
- Type: java.lang.Boolean
Indicates that only direct links should be searched.
"},{"location":"api/java/cdk-graph/index.html#findlinks_2","title":"findLinks
","text":"public java.util.List<Edge> findLinks(IEdgePredicate predicate)\npublic java.util.List<Edge> findLinks(IEdgePredicate predicate, java.lang.Boolean reverse)\npublic java.util.List<Edge> findLinks(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow)\npublic java.util.List<Edge> findLinks(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow, java.lang.Boolean direct)\n
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.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_19","title":"predicate
Required","text":"
- Type: IEdgePredicate
Edge predicate function to match edge.
"},{"location":"api/java/cdk-graph/index.html#reverseoptional_7","title":"reverse
Optional","text":"
- Type: java.lang.Boolean
Indicates if links are search in reverse order.
"},{"location":"api/java/cdk-graph/index.html#followoptional_5","title":"follow
Optional","text":"
- Type: java.lang.Boolean
Indicates if link chain is followed.
"},{"location":"api/java/cdk-graph/index.html#directoptional_5","title":"direct
Optional","text":"
- Type: java.lang.Boolean
Indicates that only direct links should be searched.
"},{"location":"api/java/cdk-graph/index.html#getcfnprop_2","title":"getCfnProp
","text":"public java.lang.String OR java.lang.Number OR java.lang.Boolean OR PlainObject OR java.util.List<java.lang.String OR java.lang.Number OR java.lang.Boolean OR PlainObject> getCfnProp(java.lang.String key)\n
Get specific CloudFormation property.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_66","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#getchild_2","title":"
- Type: java.lang.String
getChild
","text":"public Node getChild(java.lang.String id)\n
Get child node with given id.
"},{"location":"api/java/cdk-graph/index.html#idrequired_13","title":"id
Required","text":""},{"location":"api/java/cdk-graph/index.html#getlinkchains_2","title":"
- Type: java.lang.String
getLinkChains
","text":"public java.util.List<java.util.List<java.lang.Object>> getLinkChains()\npublic java.util.List<java.util.List<java.lang.Object>> getLinkChains(java.lang.Boolean reverse)\n
Resolve all link chains.
{@link EdgeChain }
"},{"location":"api/java/cdk-graph/index.html#reverseoptional_8","title":"reverse
Optional","text":""},{"location":"api/java/cdk-graph/index.html#getnearestancestor_2","title":"
- Type: java.lang.Boolean
getNearestAncestor
","text":"public Node getNearestAncestor(Node node)\n
Gets the nearest common ancestor shared between this node and another node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_26","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#isancestor_2","title":"
- Type: Node
isAncestor
","text":"public java.lang.Boolean isAncestor(Node ancestor)\n
Indicates if a specific node is an ancestor of this node.
"},{"location":"api/java/cdk-graph/index.html#ancestorrequired_4","title":"ancestor
Required","text":""},{"location":"api/java/cdk-graph/index.html#ischild_2","title":"
- Type: Node
isChild
","text":"public java.lang.Boolean isChild(Node node)\n
Indicates if specific node is a child of this node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_27","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatecollapse_2","title":"
- Type: Node
mutateCollapse
","text":"public void mutateCollapse()\n
Collapses all sub-nodes of this node into this node.
"},{"location":"api/java/cdk-graph/index.html#mutatecollapseto_2","title":"mutateCollapseTo
","text":"public Node mutateCollapseTo(Node ancestor)\n
Collapses this node into an ancestor.
"},{"location":"api/java/cdk-graph/index.html#ancestorrequired_5","title":"ancestor
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatecollapsetoparent_2","title":"
- Type: Node
mutateCollapseToParent
","text":"public Node mutateCollapseToParent()\n
Collapses this node into it's parent node.
"},{"location":"api/java/cdk-graph/index.html#mutatehoist_2","title":"mutateHoist
","text":"public void mutateHoist(Node newParent)\n
Hoist this node to an ancestor by removing it from its current parent node and in turn moving it to the ancestor.
"},{"location":"api/java/cdk-graph/index.html#newparentrequired_4","title":"newParent
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatemove_2","title":"
- Type: Node
mutateMove
","text":"public void mutateMove(Node newParent)\n
Move this node into a new parent node.
"},{"location":"api/java/cdk-graph/index.html#newparentrequired_5","title":"newParent
Required","text":"
- Type: Node
The parent to move this node to.
"},{"location":"api/java/cdk-graph/index.html#mutateremovechild_2","title":"mutateRemoveChild
","text":"public java.lang.Boolean mutateRemoveChild(Node node)\n
Remove a child node from this node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_28","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateremovelink_2","title":"
- Type: Node
mutateRemoveLink
","text":"public java.lang.Boolean mutateRemoveLink(Edge link)\n
Remove a link from this node.
"},{"location":"api/java/cdk-graph/index.html#linkrequired_4","title":"link
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateremovereverselink_2","title":"
- Type: Edge
mutateRemoveReverseLink
","text":"public java.lang.Boolean mutateRemoveReverseLink(Edge link)\n
Remove a link to this node.
"},{"location":"api/java/cdk-graph/index.html#linkrequired_5","title":"link
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateuncluster_2","title":"
- Type: Edge
mutateUncluster
","text":"public void mutateUncluster()\n
Hoist all children to parent and collapse node to parent.
"},{"location":"api/java/cdk-graph/index.html#tostring_7","title":"toString
","text":"public java.lang.String toString()\n
Get string representation of this node.
"},{"location":"api/java/cdk-graph/index.html#addoutput","title":"addOutput
","text":"public void addOutput(OutputNode node)\n
Associate {@link OutputNode} with this stack.
"},{"location":"api/java/cdk-graph/index.html#noderequired_29","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#addparameter","title":"
- Type: OutputNode
addParameter
","text":"public void addParameter(ParameterNode node)\n
Associate {@link ParameterNode} with this stack.
"},{"location":"api/java/cdk-graph/index.html#noderequired_30","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#findoutput","title":"
- Type: ParameterNode
findOutput
","text":"public OutputNode findOutput(java.lang.String logicalId)\n
Find {@link OutputNode} with logicalId defined by this stack.
"},{"location":"api/java/cdk-graph/index.html#logicalidrequired","title":"logicalId
Required","text":""},{"location":"api/java/cdk-graph/index.html#findparameter","title":"
- Type: java.lang.String
findParameter
","text":"public ParameterNode findParameter(java.lang.String parameterId)\n
Find {@link ParameterNode} with parameterId defined by this stack.
"},{"location":"api/java/cdk-graph/index.html#parameteridrequired","title":"parameterId
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateremoveoutput","title":"
- Type: java.lang.String
mutateRemoveOutput
","text":"public java.lang.Boolean mutateRemoveOutput(OutputNode node)\n
Disassociate {@link OutputNode} from this stack.
"},{"location":"api/java/cdk-graph/index.html#noderequired_31","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateremoveparameter","title":"
- Type: OutputNode
mutateRemoveParameter
","text":"public java.lang.Boolean mutateRemoveParameter(ParameterNode node)\n
Disassociate {@link ParameterNode} from this stack.
"},{"location":"api/java/cdk-graph/index.html#noderequired_32","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#static-functions_8","title":"Static Functions","text":"Name Description
- Type: ParameterNode
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}."},{"location":"api/java/cdk-graph/index.html#isstacknode","title":"isStackNode
","text":"import software.aws.pdk.cdk_graph.NestedStackNode;\n\nNestedStackNode.isStackNode(Node node)\n
Indicates if node is a {@link StackNode}.
"},{"location":"api/java/cdk-graph/index.html#noderequired_33","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#of","title":"
- Type: Node
of
","text":"import software.aws.pdk.cdk_graph.NestedStackNode;\n\nNestedStackNode.of(Node node)\n
Gets the {@link StackNode} containing a given resource.
"},{"location":"api/java/cdk-graph/index.html#noderequired_34","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#isnestedstacknode","title":"
- Type: Node
isNestedStackNode
","text":"import software.aws.pdk.cdk_graph.NestedStackNode;\n\nNestedStackNode.isNestedStackNode(Node node)\n
Indicates if node is a {@link NestedStackNode}.
"},{"location":"api/java/cdk-graph/index.html#noderequired_35","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#properties_23","title":"Properties","text":"Name Type Description
- Type: Node
attributes
java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>> 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 aaws-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."},{"location":"api/java/cdk-graph/index.html#attributesrequired_7","title":"attributes
Required","text":"public java.lang.Object getAttributes();\n
- Type: java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>>
Get readonly record of all attributes.
"},{"location":"api/java/cdk-graph/index.html#flagsrequired_7","title":"flags
Required","text":"public java.util.List<FlagEnum> getFlags();\n
- Type: java.util.List<FlagEnum>
Get readonly list of all flags.
"},{"location":"api/java/cdk-graph/index.html#isdestroyedrequired_7","title":"isDestroyed
Required","text":"public java.lang.Boolean getIsDestroyed();\n
- Type: java.lang.Boolean
Indicates if the entity has been destroyed (eg: removed from store).
"},{"location":"api/java/cdk-graph/index.html#ismutatedrequired_7","title":"isMutated
Required","text":"public java.lang.Boolean getIsMutated();\n
- Type: java.lang.Boolean
Indicates if the entity has had destructive mutations applied.
"},{"location":"api/java/cdk-graph/index.html#metadatarequired_7","title":"metadata
Required","text":"public java.util.List<MetadataEntry> getMetadata();\n
- Type: java.util.List
Get readonly list of all metadata entries.
"},{"location":"api/java/cdk-graph/index.html#storerequired_10","title":"store
Required","text":"public Store getStore();\n
- Type: Store
Reference to the store.
"},{"location":"api/java/cdk-graph/index.html#tagsrequired_7","title":"tags
Required","text":"public java.util.Map<java.lang.String, java.lang.String> getTags();\n
- Type: java.util.Map
Get readonly record of all tags.
"},{"location":"api/java/cdk-graph/index.html#uuidrequired_12","title":"uuid
Required","text":"public java.lang.String getUuid();\n
- Type: java.lang.String
Universally unique identifier.
"},{"location":"api/java/cdk-graph/index.html#allowdestructivemutationsrequired_6","title":"allowDestructiveMutations
Required","text":"public java.lang.Boolean getAllowDestructiveMutations();\n
- Type: java.lang.Boolean
Indicates if this node allows destructive mutations.
{@link Store.allowDestructiveMutations }
"},{"location":"api/java/cdk-graph/index.html#childrenrequired_2","title":"children
Required","text":"public java.util.List<Node> getChildren();\n
- Type: java.util.List<Node>
Get all direct child nodes.
"},{"location":"api/java/cdk-graph/index.html#dependedonbyrequired_2","title":"dependedOnBy
Required","text":"public java.util.List<Node> getDependedOnBy();\n
- Type: java.util.List<Node>
Get list of Nodes that depend on this node.
{@link Node.reverseDependencyLinks }
"},{"location":"api/java/cdk-graph/index.html#dependenciesrequired_3","title":"dependencies
Required","text":"public java.util.List<Node> getDependencies();\n
- Type: java.util.List<Node>
Get list of Nodes that this node depends on.
{@link Node.dependencyLinks }
"},{"location":"api/java/cdk-graph/index.html#dependencylinksrequired_2","title":"dependencyLinks
Required","text":"public java.util.List<Dependency> getDependencyLinks();\n
- Type: java.util.List<Dependency>
Gets list of {@link Dependency} links (edges) where this node is the source.
"},{"location":"api/java/cdk-graph/index.html#depthrequired_2","title":"depth
Required","text":"public java.lang.Number getDepth();\n
- Type: java.lang.Number
Indicates the depth of the node relative to root (0).
"},{"location":"api/java/cdk-graph/index.html#idrequired_14","title":"id
Required","text":"public java.lang.String getId();\n
- Type: java.lang.String
Node id, which is only unique within parent scope.
"},{"location":"api/java/cdk-graph/index.html#isassetrequired_2","title":"isAsset
Required","text":"public java.lang.Boolean getIsAsset();\n
- Type: java.lang.Boolean
Indicates if this node is considered a {@link FlagEnum.ASSET}.
"},{"location":"api/java/cdk-graph/index.html#iscfnfqnrequired_2","title":"isCfnFqn
Required","text":"public java.lang.Boolean getIsCfnFqn();\n
- Type: java.lang.Boolean
Indicates if node ConstructInfoFqn denotes a
aws-cdk-lib.*.Cfn*
construct.{@link FlagEnum.CFN_FQN }
"},{"location":"api/java/cdk-graph/index.html#isclusterrequired_2","title":"isCluster
Required","text":"public java.lang.Boolean getIsCluster();\n
- Type: java.lang.Boolean
Indicates if this node is considered a {@link FlagEnum.CLUSTER}.
"},{"location":"api/java/cdk-graph/index.html#iscustomresourcerequired_2","title":"isCustomResource
Required","text":"public java.lang.Boolean getIsCustomResource();\n
- Type: java.lang.Boolean
Indicates if node is a Custom Resource.
"},{"location":"api/java/cdk-graph/index.html#isextraneousrequired_6","title":"isExtraneous
Required","text":"public java.lang.Boolean getIsExtraneous();\n
- 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.
"},{"location":"api/java/cdk-graph/index.html#isgraphcontainerrequired_2","title":"isGraphContainer
Required","text":"public java.lang.Boolean getIsGraphContainer();\n
- Type: java.lang.Boolean
Indicates if this node is considered a {@link FlagEnum.GRAPH_CONTAINER}.
"},{"location":"api/java/cdk-graph/index.html#isleafrequired_2","title":"isLeaf
Required","text":"public java.lang.Boolean getIsLeaf();\n
- Type: java.lang.Boolean
Indicates if this node is a leaf node, which means it does not have children.
"},{"location":"api/java/cdk-graph/index.html#istoplevelrequired_2","title":"isTopLevel
Required","text":"public java.lang.Boolean getIsTopLevel();\n
- Type: java.lang.Boolean
Indicates if node is direct child of the graph root node.
"},{"location":"api/java/cdk-graph/index.html#linksrequired_2","title":"links
Required","text":"public java.util.List<Edge> getLinks();\n
- Type: java.util.List<Edge>
Gets all links (edges) in which this node is the source.
"},{"location":"api/java/cdk-graph/index.html#nodetyperequired_3","title":"nodeType
Required","text":"public NodeTypeEnum getNodeType();\n
- Type: NodeTypeEnum
Type of node.
"},{"location":"api/java/cdk-graph/index.html#pathrequired_4","title":"path
Required","text":"public java.lang.String getPath();\n
- Type: java.lang.String
Path of the node.
"},{"location":"api/java/cdk-graph/index.html#referencedbyrequired_2","title":"referencedBy
Required","text":"public java.util.List<Node> getReferencedBy();\n
- Type: java.util.List<Node>
Get list of Nodes that reference this node.
{@link Node.reverseReferenceLinks }
"},{"location":"api/java/cdk-graph/index.html#referencelinksrequired_2","title":"referenceLinks
Required","text":"public java.util.List<Reference> getReferenceLinks();\n
- Type: java.util.List<Reference>
Gets list of {@link Reference} links (edges) where this node is the source.
"},{"location":"api/java/cdk-graph/index.html#referencesrequired_2","title":"references
Required","text":"public java.util.List<Node> getReferences();\n
- Type: java.util.List<Node>
Get list of Nodes that this node references.
{@link Node.referenceLinks }
"},{"location":"api/java/cdk-graph/index.html#reversedependencylinksrequired_2","title":"reverseDependencyLinks
Required","text":"public java.util.List<Dependency> getReverseDependencyLinks();\n
- Type: java.util.List<Dependency>
Gets list of {@link Dependency} links (edges) where this node is the target.
"},{"location":"api/java/cdk-graph/index.html#reverselinksrequired_2","title":"reverseLinks
Required","text":"public java.util.List<Edge> getReverseLinks();\n
- Type: java.util.List<Edge>
Gets all links (edges) in which this node is the target.
"},{"location":"api/java/cdk-graph/index.html#reversereferencelinksrequired_2","title":"reverseReferenceLinks
Required","text":"public java.util.List<Reference> getReverseReferenceLinks();\n
- Type: java.util.List<Reference>
Gets list of {@link Reference} links (edges) where this node is the target.
"},{"location":"api/java/cdk-graph/index.html#scopesrequired_2","title":"scopes
Required","text":"public java.util.List<Node> getScopes();\n
- Type: java.util.List<Node>
Gets descending ordered list of ancestors from the root.
"},{"location":"api/java/cdk-graph/index.html#siblingsrequired_2","title":"siblings
Required","text":"public java.util.List<Node> getSiblings();\n
- Type: java.util.List<Node>
Get list of siblings of this node.
"},{"location":"api/java/cdk-graph/index.html#cfnpropsoptional_2","title":"cfnProps
Optional","text":"public PlainObject getCfnProps();\n
- Type: PlainObject
Gets CloudFormation properties for this node.
"},{"location":"api/java/cdk-graph/index.html#cfntypeoptional_4","title":"cfnType
Optional","text":"public java.lang.String getCfnType();\n
- Type: java.lang.String
Get the CloudFormation resource type for this node.
"},{"location":"api/java/cdk-graph/index.html#constructinfooptional_4","title":"constructInfo
Optional","text":"public ConstructInfo getConstructInfo();\n
- Type: ConstructInfo
Synthesized construct information defining jii resolution data.
"},{"location":"api/java/cdk-graph/index.html#constructinfofqnoptional_2","title":"constructInfoFqn
Optional","text":"public java.lang.String getConstructInfoFqn();\n
- Type: java.lang.String
Synthesized construct information defining jii resolution data.
"},{"location":"api/java/cdk-graph/index.html#logicalidoptional_4","title":"logicalId
Optional","text":"public java.lang.String getLogicalId();\n
- Type: java.lang.String
Logical id of the node, which is only unique within containing stack.
"},{"location":"api/java/cdk-graph/index.html#parentoptional_3","title":"parent
Optional","text":"public Node getParent();\n
- Type: Node
Parent node.
Only the root node should not have parent.
"},{"location":"api/java/cdk-graph/index.html#rootstackoptional_2","title":"rootStack
Optional","text":"public StackNode getRootStack();\n
- Type: StackNode
Get root stack.
"},{"location":"api/java/cdk-graph/index.html#stackoptional_3","title":"stack
Optional","text":"public StackNode getStack();\n
- Type: StackNode
Stack the node is contained in.
"},{"location":"api/java/cdk-graph/index.html#exportsrequired","title":"exports
Required","text":"public java.util.List<OutputNode> getExports();\n
- Type: java.util.List<OutputNode>
Get all exported {@link OutputNode}s defined by this stack.
"},{"location":"api/java/cdk-graph/index.html#outputsrequired","title":"outputs
Required","text":"public java.util.List<OutputNode> getOutputs();\n
- Type: java.util.List<OutputNode>
Get all {@link OutputNode}s defined by this stack.
"},{"location":"api/java/cdk-graph/index.html#parametersrequired","title":"parameters
Required","text":"public java.util.List<ParameterNode> getParameters();\n
- Type: java.util.List<ParameterNode>
Get all {@link ParameterNode}s defined by this stack.
"},{"location":"api/java/cdk-graph/index.html#stageoptional","title":"stage
Optional","text":"public StageNode getStage();\n
- Type: StageNode
Get {@link StageNode} containing this stack.
"},{"location":"api/java/cdk-graph/index.html#parentstackoptional","title":"parentStack
Optional","text":"public StackNode getParentStack();\n
- Type: StackNode
Get parent stack of this nested stack.
"},{"location":"api/java/cdk-graph/index.html#node","title":"Node","text":"
- Implements: ISerializableNode
Node class is the base definition of node entities in the graph, as in standard graph theory.
"},{"location":"api/java/cdk-graph/index.html#initializers_11","title":"Initializers","text":"Name Type Descriptionimport software.aws.pdk.cdk_graph.Node;\n\nnew Node(INodeProps props);\n
props
INodeProps
No description."},{"location":"api/java/cdk-graph/index.html#propsrequired_8","title":"props
Required","text":""},{"location":"api/java/cdk-graph/index.html#methods_10","title":"Methods","text":"Name Description
- Type: INodeProps
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."},{"location":"api/java/cdk-graph/index.html#addattribute_8","title":"addAttribute
","text":"public void addAttribute(java.lang.String key, java.lang.Object value)\n
Add attribute.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_67","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_33","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#addflag_8","title":"
- Type: java.lang.Object
addFlag
","text":"public void addFlag(FlagEnum flag)\n
Add flag.
"},{"location":"api/java/cdk-graph/index.html#flagrequired_16","title":"flag
Required","text":""},{"location":"api/java/cdk-graph/index.html#addmetadata_8","title":"
- Type: FlagEnum
addMetadata
","text":"public void addMetadata(java.lang.String metadataType, java.lang.Object data)\n
Add metadata entry.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_24","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#datarequired_25","title":"
- Type: java.lang.String
data
Required","text":""},{"location":"api/java/cdk-graph/index.html#addtag_8","title":"
- Type: java.lang.Object
addTag
","text":"public void addTag(java.lang.String key, java.lang.String value)\n
Add tag.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_68","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_34","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#applydata_8","title":"
- Type: java.lang.String
applyData
","text":"public void applyData(IBaseEntityDataProps data)\npublic void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite)\npublic void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite, java.lang.Boolean applyFlags)\n
Applies data (attributes, metadata, tags, flag) to entity.
Generally used only for mutations such as collapse and consume to retain data.
"},{"location":"api/java/cdk-graph/index.html#datarequired_26","title":"data
Required","text":"
- Type: IBaseEntityDataProps
The data to apply.
"},{"location":"api/java/cdk-graph/index.html#overwriteoptional_8","title":"overwrite
Optional","text":""},{"location":"api/java/cdk-graph/index.html#applyflagsoptional_8","title":"
- Type: java.lang.Boolean
applyFlags
Optional","text":"
- Type: java.lang.Boolean
Indicates if data is overwritten - Indicates if flags should be applied.
"},{"location":"api/java/cdk-graph/index.html#findmetadata_8","title":"findMetadata
","text":"public java.util.List<MetadataEntry> findMetadata(java.lang.String metadataType)\n
Retrieves all metadata entries of a given type.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_25","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#getattribute_8","title":"
- Type: java.lang.String
getAttribute
","text":"public java.lang.Object getAttribute(java.lang.String key)\n
Get attribute by key.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_69","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#gettag_8","title":"
- Type: java.lang.String
getTag
","text":"public java.lang.String getTag(java.lang.String key)\n
Get tag by key.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_70","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#hasattribute_8","title":"
- Type: java.lang.String
hasAttribute
","text":"public java.lang.Boolean hasAttribute(java.lang.String key)\npublic java.lang.Boolean hasAttribute(java.lang.String key, java.lang.Object value)\n
Indicates if entity has a given attribute defined, and optionally with a specific value.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_71","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valueoptional_18","title":"
- Type: java.lang.String
value
Optional","text":""},{"location":"api/java/cdk-graph/index.html#hasflag_8","title":"
- Type: java.lang.Object
hasFlag
","text":"public java.lang.Boolean hasFlag(FlagEnum flag)\n
Indicates if entity has a given flag.
"},{"location":"api/java/cdk-graph/index.html#flagrequired_17","title":"flag
Required","text":""},{"location":"api/java/cdk-graph/index.html#hasmetadata_8","title":"
- Type: FlagEnum
hasMetadata
","text":"public java.lang.Boolean hasMetadata(java.lang.String metadataType, java.lang.Object data)\n
Indicates if entity has matching metadata entry.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_26","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#datarequired_27","title":"
- Type: java.lang.String
data
Required","text":""},{"location":"api/java/cdk-graph/index.html#hastag_8","title":"
- Type: java.lang.Object
hasTag
","text":"public java.lang.Boolean hasTag(java.lang.String key)\npublic java.lang.Boolean hasTag(java.lang.String key, java.lang.String value)\n
Indicates if entity has tag, optionally verifying tag value.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_72","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valueoptional_19","title":"
- Type: java.lang.String
value
Optional","text":""},{"location":"api/java/cdk-graph/index.html#mutatedestroy_8","title":"
- Type: java.lang.String
mutateDestroy
","text":"public void mutateDestroy()\npublic void mutateDestroy(java.lang.Boolean strict)\n
Destroys this node by removing all references and removing this node from the store.
"},{"location":"api/java/cdk-graph/index.html#strictoptional_4","title":"strict
Optional","text":"
- Type: java.lang.Boolean
Indicates that this node must not have references.
"},{"location":"api/java/cdk-graph/index.html#setattribute_8","title":"setAttribute
","text":"public void setAttribute(java.lang.String key, java.lang.Object value)\n
Set attribute.
This will overwrite existing attribute.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_73","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_35","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#settag_8","title":"
- Type: java.lang.Object
setTag
","text":"public void setTag(java.lang.String key, java.lang.String value)\n
Set tag.
Will overwrite existing tag.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_74","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_36","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#addchild_3","title":"
- Type: java.lang.String
addChild
","text":"public void addChild(Node node)\n
Add child node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_36","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#addlink_3","title":"
- Type: Node
addLink
","text":"public void addLink(Edge edge)\n
Add link to another node.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_21","title":"edge
Required","text":""},{"location":"api/java/cdk-graph/index.html#addreverselink_3","title":"
- Type: Edge
addReverseLink
","text":"public void addReverseLink(Edge edge)\n
Add link from another node.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_22","title":"edge
Required","text":""},{"location":"api/java/cdk-graph/index.html#doesdependon_3","title":"
- Type: Edge
doesDependOn
","text":"public java.lang.Boolean doesDependOn(Node node)\n
Indicates if this node depends on another node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_37","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#doesreference_3","title":"
- Type: Node
doesReference
","text":"public java.lang.Boolean doesReference(Node node)\n
Indicates if this node references another node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_38","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#find_3","title":"
- Type: Node
find
","text":"public Node find(INodePredicate predicate)\n
Recursively find the nearest sub-node matching predicate.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_20","title":"predicate
Required","text":""},{"location":"api/java/cdk-graph/index.html#findall_3","title":"
- Type: INodePredicate
findAll
","text":"public java.util.List<Node> findAll()\npublic java.util.List<Node> findAll(IFindNodeOptions options)\n
Return this construct and all of its sub-nodes in the given order.
Optionally filter nodes based on predicate.
"},{"location":"api/java/cdk-graph/index.html#optionsoptional_6","title":"options
Optional","text":""},{"location":"api/java/cdk-graph/index.html#findalllinks_3","title":"
- Type: IFindNodeOptions
findAllLinks
","text":"public java.util.List<Edge> findAllLinks()\npublic java.util.List<Edge> findAllLinks(IFindEdgeOptions options)\n
Return all direct links of this node and that of all sub-nodes.
Optionally filter links based on predicate.
"},{"location":"api/java/cdk-graph/index.html#optionsoptional_7","title":"options
Optional","text":""},{"location":"api/java/cdk-graph/index.html#findancestor_3","title":"
- Type: IFindEdgeOptions
findAncestor
","text":"public Node findAncestor(INodePredicate predicate)\npublic Node findAncestor(INodePredicate predicate, java.lang.Number max)\n
Find nearest ancestor of this node matching given predicate.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_21","title":"predicate
Required","text":"
- Type: INodePredicate
Predicate to match ancestor.
"},{"location":"api/java/cdk-graph/index.html#maxoptional_3","title":"max
Optional","text":""},{"location":"api/java/cdk-graph/index.html#findchild_3","title":"
- Type: java.lang.Number
findChild
","text":"public Node findChild(java.lang.String id)\n
Find child with given id.
Similar to
"},{"location":"api/java/cdk-graph/index.html#idrequired_15","title":"find
but does not throw error if no child found.id
Required","text":""},{"location":"api/java/cdk-graph/index.html#findlink_3","title":"
- Type: java.lang.String
findLink
","text":"public Edge findLink(IEdgePredicate predicate)\npublic Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse)\npublic Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow)\npublic Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow, java.lang.Boolean direct)\n
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.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_22","title":"predicate
Required","text":"
- Type: IEdgePredicate
Edge predicate function to match edge.
"},{"location":"api/java/cdk-graph/index.html#reverseoptional_9","title":"reverse
Optional","text":"
- Type: java.lang.Boolean
Indicates if links are search in reverse order.
"},{"location":"api/java/cdk-graph/index.html#followoptional_6","title":"follow
Optional","text":"
- Type: java.lang.Boolean
Indicates if link chain is followed.
"},{"location":"api/java/cdk-graph/index.html#directoptional_6","title":"direct
Optional","text":"
- Type: java.lang.Boolean
Indicates that only direct links should be searched.
"},{"location":"api/java/cdk-graph/index.html#findlinks_3","title":"findLinks
","text":"public java.util.List<Edge> findLinks(IEdgePredicate predicate)\npublic java.util.List<Edge> findLinks(IEdgePredicate predicate, java.lang.Boolean reverse)\npublic java.util.List<Edge> findLinks(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow)\npublic java.util.List<Edge> findLinks(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow, java.lang.Boolean direct)\n
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.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_23","title":"predicate
Required","text":"
- Type: IEdgePredicate
Edge predicate function to match edge.
"},{"location":"api/java/cdk-graph/index.html#reverseoptional_10","title":"reverse
Optional","text":"
- Type: java.lang.Boolean
Indicates if links are search in reverse order.
"},{"location":"api/java/cdk-graph/index.html#followoptional_7","title":"follow
Optional","text":"
- Type: java.lang.Boolean
Indicates if link chain is followed.
"},{"location":"api/java/cdk-graph/index.html#directoptional_7","title":"direct
Optional","text":"
- Type: java.lang.Boolean
Indicates that only direct links should be searched.
"},{"location":"api/java/cdk-graph/index.html#getcfnprop_3","title":"getCfnProp
","text":"public java.lang.String OR java.lang.Number OR java.lang.Boolean OR PlainObject OR java.util.List<java.lang.String OR java.lang.Number OR java.lang.Boolean OR PlainObject> getCfnProp(java.lang.String key)\n
Get specific CloudFormation property.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_75","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#getchild_3","title":"
- Type: java.lang.String
getChild
","text":"public Node getChild(java.lang.String id)\n
Get child node with given id.
"},{"location":"api/java/cdk-graph/index.html#idrequired_16","title":"id
Required","text":""},{"location":"api/java/cdk-graph/index.html#getlinkchains_3","title":"
- Type: java.lang.String
getLinkChains
","text":"public java.util.List<java.util.List<java.lang.Object>> getLinkChains()\npublic java.util.List<java.util.List<java.lang.Object>> getLinkChains(java.lang.Boolean reverse)\n
Resolve all link chains.
{@link EdgeChain }
"},{"location":"api/java/cdk-graph/index.html#reverseoptional_11","title":"reverse
Optional","text":""},{"location":"api/java/cdk-graph/index.html#getnearestancestor_3","title":"
- Type: java.lang.Boolean
getNearestAncestor
","text":"public Node getNearestAncestor(Node node)\n
Gets the nearest common ancestor shared between this node and another node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_39","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#isancestor_3","title":"
- Type: Node
isAncestor
","text":"public java.lang.Boolean isAncestor(Node ancestor)\n
Indicates if a specific node is an ancestor of this node.
"},{"location":"api/java/cdk-graph/index.html#ancestorrequired_6","title":"ancestor
Required","text":""},{"location":"api/java/cdk-graph/index.html#ischild_3","title":"
- Type: Node
isChild
","text":"public java.lang.Boolean isChild(Node node)\n
Indicates if specific node is a child of this node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_40","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatecollapse_3","title":"
- Type: Node
mutateCollapse
","text":"public void mutateCollapse()\n
Collapses all sub-nodes of this node into this node.
"},{"location":"api/java/cdk-graph/index.html#mutatecollapseto_3","title":"mutateCollapseTo
","text":"public Node mutateCollapseTo(Node ancestor)\n
Collapses this node into an ancestor.
"},{"location":"api/java/cdk-graph/index.html#ancestorrequired_7","title":"ancestor
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatecollapsetoparent_3","title":"
- Type: Node
mutateCollapseToParent
","text":"public Node mutateCollapseToParent()\n
Collapses this node into it's parent node.
"},{"location":"api/java/cdk-graph/index.html#mutatehoist_3","title":"mutateHoist
","text":"public void mutateHoist(Node newParent)\n
Hoist this node to an ancestor by removing it from its current parent node and in turn moving it to the ancestor.
"},{"location":"api/java/cdk-graph/index.html#newparentrequired_6","title":"newParent
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatemove_3","title":"
- Type: Node
mutateMove
","text":"public void mutateMove(Node newParent)\n
Move this node into a new parent node.
"},{"location":"api/java/cdk-graph/index.html#newparentrequired_7","title":"newParent
Required","text":"
- Type: Node
The parent to move this node to.
"},{"location":"api/java/cdk-graph/index.html#mutateremovechild_3","title":"mutateRemoveChild
","text":"public java.lang.Boolean mutateRemoveChild(Node node)\n
Remove a child node from this node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_41","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateremovelink_3","title":"
- Type: Node
mutateRemoveLink
","text":"public java.lang.Boolean mutateRemoveLink(Edge link)\n
Remove a link from this node.
"},{"location":"api/java/cdk-graph/index.html#linkrequired_6","title":"link
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateremovereverselink_3","title":"
- Type: Edge
mutateRemoveReverseLink
","text":"public java.lang.Boolean mutateRemoveReverseLink(Edge link)\n
Remove a link to this node.
"},{"location":"api/java/cdk-graph/index.html#linkrequired_7","title":"link
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateuncluster_3","title":"
- Type: Edge
mutateUncluster
","text":"public void mutateUncluster()\n
Hoist all children to parent and collapse node to parent.
"},{"location":"api/java/cdk-graph/index.html#tostring_8","title":"toString
","text":"public java.lang.String toString()\n
Get string representation of this node.
"},{"location":"api/java/cdk-graph/index.html#properties_24","title":"Properties","text":"Name Type Descriptionattributes
java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>> 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 aaws-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."},{"location":"api/java/cdk-graph/index.html#attributesrequired_8","title":"attributes
Required","text":"public java.lang.Object getAttributes();\n
- Type: java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>>
Get readonly record of all attributes.
"},{"location":"api/java/cdk-graph/index.html#flagsrequired_8","title":"flags
Required","text":"public java.util.List<FlagEnum> getFlags();\n
- Type: java.util.List<FlagEnum>
Get readonly list of all flags.
"},{"location":"api/java/cdk-graph/index.html#isdestroyedrequired_8","title":"isDestroyed
Required","text":"public java.lang.Boolean getIsDestroyed();\n
- Type: java.lang.Boolean
Indicates if the entity has been destroyed (eg: removed from store).
"},{"location":"api/java/cdk-graph/index.html#ismutatedrequired_8","title":"isMutated
Required","text":"public java.lang.Boolean getIsMutated();\n
- Type: java.lang.Boolean
Indicates if the entity has had destructive mutations applied.
"},{"location":"api/java/cdk-graph/index.html#metadatarequired_8","title":"metadata
Required","text":"public java.util.List<MetadataEntry> getMetadata();\n
- Type: java.util.List
Get readonly list of all metadata entries.
"},{"location":"api/java/cdk-graph/index.html#storerequired_11","title":"store
Required","text":"public Store getStore();\n
- Type: Store
Reference to the store.
"},{"location":"api/java/cdk-graph/index.html#tagsrequired_8","title":"tags
Required","text":"public java.util.Map<java.lang.String, java.lang.String> getTags();\n
- Type: java.util.Map
Get readonly record of all tags.
"},{"location":"api/java/cdk-graph/index.html#uuidrequired_13","title":"uuid
Required","text":"public java.lang.String getUuid();\n
- Type: java.lang.String
Universally unique identifier.
"},{"location":"api/java/cdk-graph/index.html#allowdestructivemutationsrequired_7","title":"allowDestructiveMutations
Required","text":"public java.lang.Boolean getAllowDestructiveMutations();\n
- Type: java.lang.Boolean
Indicates if this node allows destructive mutations.
{@link Store.allowDestructiveMutations }
"},{"location":"api/java/cdk-graph/index.html#childrenrequired_3","title":"children
Required","text":"public java.util.List<Node> getChildren();\n
- Type: java.util.List<Node>
Get all direct child nodes.
"},{"location":"api/java/cdk-graph/index.html#dependedonbyrequired_3","title":"dependedOnBy
Required","text":"public java.util.List<Node> getDependedOnBy();\n
- Type: java.util.List<Node>
Get list of Nodes that depend on this node.
{@link Node.reverseDependencyLinks }
"},{"location":"api/java/cdk-graph/index.html#dependenciesrequired_4","title":"dependencies
Required","text":"public java.util.List<Node> getDependencies();\n
- Type: java.util.List<Node>
Get list of Nodes that this node depends on.
{@link Node.dependencyLinks }
"},{"location":"api/java/cdk-graph/index.html#dependencylinksrequired_3","title":"dependencyLinks
Required","text":"public java.util.List<Dependency> getDependencyLinks();\n
- Type: java.util.List<Dependency>
Gets list of {@link Dependency} links (edges) where this node is the source.
"},{"location":"api/java/cdk-graph/index.html#depthrequired_3","title":"depth
Required","text":"public java.lang.Number getDepth();\n
- Type: java.lang.Number
Indicates the depth of the node relative to root (0).
"},{"location":"api/java/cdk-graph/index.html#idrequired_17","title":"id
Required","text":"public java.lang.String getId();\n
- Type: java.lang.String
Node id, which is only unique within parent scope.
"},{"location":"api/java/cdk-graph/index.html#isassetrequired_3","title":"isAsset
Required","text":"public java.lang.Boolean getIsAsset();\n
- Type: java.lang.Boolean
Indicates if this node is considered a {@link FlagEnum.ASSET}.
"},{"location":"api/java/cdk-graph/index.html#iscfnfqnrequired_3","title":"isCfnFqn
Required","text":"public java.lang.Boolean getIsCfnFqn();\n
- Type: java.lang.Boolean
Indicates if node ConstructInfoFqn denotes a
aws-cdk-lib.*.Cfn*
construct.{@link FlagEnum.CFN_FQN }
"},{"location":"api/java/cdk-graph/index.html#isclusterrequired_3","title":"isCluster
Required","text":"public java.lang.Boolean getIsCluster();\n
- Type: java.lang.Boolean
Indicates if this node is considered a {@link FlagEnum.CLUSTER}.
"},{"location":"api/java/cdk-graph/index.html#iscustomresourcerequired_3","title":"isCustomResource
Required","text":"public java.lang.Boolean getIsCustomResource();\n
- Type: java.lang.Boolean
Indicates if node is a Custom Resource.
"},{"location":"api/java/cdk-graph/index.html#isextraneousrequired_7","title":"isExtraneous
Required","text":"public java.lang.Boolean getIsExtraneous();\n
- 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.
"},{"location":"api/java/cdk-graph/index.html#isgraphcontainerrequired_3","title":"isGraphContainer
Required","text":"public java.lang.Boolean getIsGraphContainer();\n
- Type: java.lang.Boolean
Indicates if this node is considered a {@link FlagEnum.GRAPH_CONTAINER}.
"},{"location":"api/java/cdk-graph/index.html#isleafrequired_3","title":"isLeaf
Required","text":"public java.lang.Boolean getIsLeaf();\n
- Type: java.lang.Boolean
Indicates if this node is a leaf node, which means it does not have children.
"},{"location":"api/java/cdk-graph/index.html#istoplevelrequired_3","title":"isTopLevel
Required","text":"public java.lang.Boolean getIsTopLevel();\n
- Type: java.lang.Boolean
Indicates if node is direct child of the graph root node.
"},{"location":"api/java/cdk-graph/index.html#linksrequired_3","title":"links
Required","text":"public java.util.List<Edge> getLinks();\n
- Type: java.util.List<Edge>
Gets all links (edges) in which this node is the source.
"},{"location":"api/java/cdk-graph/index.html#nodetyperequired_4","title":"nodeType
Required","text":"public NodeTypeEnum getNodeType();\n
- Type: NodeTypeEnum
Type of node.
"},{"location":"api/java/cdk-graph/index.html#pathrequired_5","title":"path
Required","text":"public java.lang.String getPath();\n
- Type: java.lang.String
Path of the node.
"},{"location":"api/java/cdk-graph/index.html#referencedbyrequired_3","title":"referencedBy
Required","text":"public java.util.List<Node> getReferencedBy();\n
- Type: java.util.List<Node>
Get list of Nodes that reference this node.
{@link Node.reverseReferenceLinks }
"},{"location":"api/java/cdk-graph/index.html#referencelinksrequired_3","title":"referenceLinks
Required","text":"public java.util.List<Reference> getReferenceLinks();\n
- Type: java.util.List<Reference>
Gets list of {@link Reference} links (edges) where this node is the source.
"},{"location":"api/java/cdk-graph/index.html#referencesrequired_3","title":"references
Required","text":"public java.util.List<Node> getReferences();\n
- Type: java.util.List<Node>
Get list of Nodes that this node references.
{@link Node.referenceLinks }
"},{"location":"api/java/cdk-graph/index.html#reversedependencylinksrequired_3","title":"reverseDependencyLinks
Required","text":"public java.util.List<Dependency> getReverseDependencyLinks();\n
- Type: java.util.List<Dependency>
Gets list of {@link Dependency} links (edges) where this node is the target.
"},{"location":"api/java/cdk-graph/index.html#reverselinksrequired_3","title":"reverseLinks
Required","text":"public java.util.List<Edge> getReverseLinks();\n
- Type: java.util.List<Edge>
Gets all links (edges) in which this node is the target.
"},{"location":"api/java/cdk-graph/index.html#reversereferencelinksrequired_3","title":"reverseReferenceLinks
Required","text":"public java.util.List<Reference> getReverseReferenceLinks();\n
- Type: java.util.List<Reference>
Gets list of {@link Reference} links (edges) where this node is the target.
"},{"location":"api/java/cdk-graph/index.html#scopesrequired_3","title":"scopes
Required","text":"public java.util.List<Node> getScopes();\n
- Type: java.util.List<Node>
Gets descending ordered list of ancestors from the root.
"},{"location":"api/java/cdk-graph/index.html#siblingsrequired_3","title":"siblings
Required","text":"public java.util.List<Node> getSiblings();\n
- Type: java.util.List<Node>
Get list of siblings of this node.
"},{"location":"api/java/cdk-graph/index.html#cfnpropsoptional_3","title":"cfnProps
Optional","text":"public PlainObject getCfnProps();\n
- Type: PlainObject
Gets CloudFormation properties for this node.
"},{"location":"api/java/cdk-graph/index.html#cfntypeoptional_5","title":"cfnType
Optional","text":"public java.lang.String getCfnType();\n
- Type: java.lang.String
Get the CloudFormation resource type for this node.
"},{"location":"api/java/cdk-graph/index.html#constructinfooptional_5","title":"constructInfo
Optional","text":"public ConstructInfo getConstructInfo();\n
- Type: ConstructInfo
Synthesized construct information defining jii resolution data.
"},{"location":"api/java/cdk-graph/index.html#constructinfofqnoptional_3","title":"constructInfoFqn
Optional","text":"public java.lang.String getConstructInfoFqn();\n
- Type: java.lang.String
Synthesized construct information defining jii resolution data.
"},{"location":"api/java/cdk-graph/index.html#logicalidoptional_5","title":"logicalId
Optional","text":"public java.lang.String getLogicalId();\n
- Type: java.lang.String
Logical id of the node, which is only unique within containing stack.
"},{"location":"api/java/cdk-graph/index.html#parentoptional_4","title":"parent
Optional","text":"public Node getParent();\n
- Type: Node
Parent node.
Only the root node should not have parent.
"},{"location":"api/java/cdk-graph/index.html#rootstackoptional_3","title":"rootStack
Optional","text":"public StackNode getRootStack();\n
- Type: StackNode
Get root stack.
"},{"location":"api/java/cdk-graph/index.html#stackoptional_4","title":"stack
Optional","text":"public StackNode getStack();\n
- Type: StackNode
Stack the node is contained in.
"},{"location":"api/java/cdk-graph/index.html#outputnode","title":"OutputNode","text":"OutputNode defines a cdk CfnOutput resources.
"},{"location":"api/java/cdk-graph/index.html#initializers_12","title":"Initializers","text":"Name Type Descriptionimport software.aws.pdk.cdk_graph.OutputNode;\n\nnew OutputNode(IOutputNodeProps props);\n
props
IOutputNodeProps
No description."},{"location":"api/java/cdk-graph/index.html#propsrequired_9","title":"props
Required","text":""},{"location":"api/java/cdk-graph/index.html#methods_11","title":"Methods","text":"Name Description
- Type: IOutputNodeProps
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."},{"location":"api/java/cdk-graph/index.html#addattribute_9","title":"addAttribute
","text":"public void addAttribute(java.lang.String key, java.lang.Object value)\n
Add attribute.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_76","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_37","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#addflag_9","title":"
- Type: java.lang.Object
addFlag
","text":"public void addFlag(FlagEnum flag)\n
Add flag.
"},{"location":"api/java/cdk-graph/index.html#flagrequired_18","title":"flag
Required","text":""},{"location":"api/java/cdk-graph/index.html#addmetadata_9","title":"
- Type: FlagEnum
addMetadata
","text":"public void addMetadata(java.lang.String metadataType, java.lang.Object data)\n
Add metadata entry.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_27","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#datarequired_28","title":"
- Type: java.lang.String
data
Required","text":""},{"location":"api/java/cdk-graph/index.html#addtag_9","title":"
- Type: java.lang.Object
addTag
","text":"public void addTag(java.lang.String key, java.lang.String value)\n
Add tag.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_77","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_38","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#applydata_9","title":"
- Type: java.lang.String
applyData
","text":"public void applyData(IBaseEntityDataProps data)\npublic void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite)\npublic void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite, java.lang.Boolean applyFlags)\n
Applies data (attributes, metadata, tags, flag) to entity.
Generally used only for mutations such as collapse and consume to retain data.
"},{"location":"api/java/cdk-graph/index.html#datarequired_29","title":"data
Required","text":"
- Type: IBaseEntityDataProps
The data to apply.
"},{"location":"api/java/cdk-graph/index.html#overwriteoptional_9","title":"overwrite
Optional","text":""},{"location":"api/java/cdk-graph/index.html#applyflagsoptional_9","title":"
- Type: java.lang.Boolean
applyFlags
Optional","text":"
- Type: java.lang.Boolean
Indicates if data is overwritten - Indicates if flags should be applied.
"},{"location":"api/java/cdk-graph/index.html#findmetadata_9","title":"findMetadata
","text":"public java.util.List<MetadataEntry> findMetadata(java.lang.String metadataType)\n
Retrieves all metadata entries of a given type.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_28","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#getattribute_9","title":"
- Type: java.lang.String
getAttribute
","text":"public java.lang.Object getAttribute(java.lang.String key)\n
Get attribute by key.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_78","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#gettag_9","title":"
- Type: java.lang.String
getTag
","text":"public java.lang.String getTag(java.lang.String key)\n
Get tag by key.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_79","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#hasattribute_9","title":"
- Type: java.lang.String
hasAttribute
","text":"public java.lang.Boolean hasAttribute(java.lang.String key)\npublic java.lang.Boolean hasAttribute(java.lang.String key, java.lang.Object value)\n
Indicates if entity has a given attribute defined, and optionally with a specific value.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_80","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valueoptional_20","title":"
- Type: java.lang.String
value
Optional","text":""},{"location":"api/java/cdk-graph/index.html#hasflag_9","title":"
- Type: java.lang.Object
hasFlag
","text":"public java.lang.Boolean hasFlag(FlagEnum flag)\n
Indicates if entity has a given flag.
"},{"location":"api/java/cdk-graph/index.html#flagrequired_19","title":"flag
Required","text":""},{"location":"api/java/cdk-graph/index.html#hasmetadata_9","title":"
- Type: FlagEnum
hasMetadata
","text":"public java.lang.Boolean hasMetadata(java.lang.String metadataType, java.lang.Object data)\n
Indicates if entity has matching metadata entry.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_29","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#datarequired_30","title":"
- Type: java.lang.String
data
Required","text":""},{"location":"api/java/cdk-graph/index.html#hastag_9","title":"
- Type: java.lang.Object
hasTag
","text":"public java.lang.Boolean hasTag(java.lang.String key)\npublic java.lang.Boolean hasTag(java.lang.String key, java.lang.String value)\n
Indicates if entity has tag, optionally verifying tag value.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_81","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valueoptional_21","title":"
- Type: java.lang.String
value
Optional","text":""},{"location":"api/java/cdk-graph/index.html#mutatedestroy_9","title":"
- Type: java.lang.String
mutateDestroy
","text":"public void mutateDestroy()\npublic void mutateDestroy(java.lang.Boolean strict)\n
Destroys this node by removing all references and removing this node from the store.
"},{"location":"api/java/cdk-graph/index.html#strictoptional_5","title":"strict
Optional","text":""},{"location":"api/java/cdk-graph/index.html#setattribute_9","title":"
- Type: java.lang.Boolean
setAttribute
","text":"public void setAttribute(java.lang.String key, java.lang.Object value)\n
Set attribute.
This will overwrite existing attribute.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_82","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_39","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#settag_9","title":"
- Type: java.lang.Object
setTag
","text":"public void setTag(java.lang.String key, java.lang.String value)\n
Set tag.
Will overwrite existing tag.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_83","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_40","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#addchild_4","title":"
- Type: java.lang.String
addChild
","text":"public void addChild(Node node)\n
Add child node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_42","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#addlink_4","title":"
- Type: Node
addLink
","text":"public void addLink(Edge edge)\n
Add link to another node.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_23","title":"edge
Required","text":""},{"location":"api/java/cdk-graph/index.html#addreverselink_4","title":"
- Type: Edge
addReverseLink
","text":"public void addReverseLink(Edge edge)\n
Add link from another node.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_24","title":"edge
Required","text":""},{"location":"api/java/cdk-graph/index.html#doesdependon_4","title":"
- Type: Edge
doesDependOn
","text":"public java.lang.Boolean doesDependOn(Node node)\n
Indicates if this node depends on another node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_43","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#doesreference_4","title":"
- Type: Node
doesReference
","text":"public java.lang.Boolean doesReference(Node node)\n
Indicates if this node references another node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_44","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#find_4","title":"
- Type: Node
find
","text":"public Node find(INodePredicate predicate)\n
Recursively find the nearest sub-node matching predicate.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_24","title":"predicate
Required","text":""},{"location":"api/java/cdk-graph/index.html#findall_4","title":"
- Type: INodePredicate
findAll
","text":"public java.util.List<Node> findAll()\npublic java.util.List<Node> findAll(IFindNodeOptions options)\n
Return this construct and all of its sub-nodes in the given order.
Optionally filter nodes based on predicate.
"},{"location":"api/java/cdk-graph/index.html#optionsoptional_8","title":"options
Optional","text":""},{"location":"api/java/cdk-graph/index.html#findalllinks_4","title":"
- Type: IFindNodeOptions
findAllLinks
","text":"public java.util.List<Edge> findAllLinks()\npublic java.util.List<Edge> findAllLinks(IFindEdgeOptions options)\n
Return all direct links of this node and that of all sub-nodes.
Optionally filter links based on predicate.
"},{"location":"api/java/cdk-graph/index.html#optionsoptional_9","title":"options
Optional","text":""},{"location":"api/java/cdk-graph/index.html#findancestor_4","title":"
- Type: IFindEdgeOptions
findAncestor
","text":"public Node findAncestor(INodePredicate predicate)\npublic Node findAncestor(INodePredicate predicate, java.lang.Number max)\n
Find nearest ancestor of this node matching given predicate.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_25","title":"predicate
Required","text":"
- Type: INodePredicate
Predicate to match ancestor.
"},{"location":"api/java/cdk-graph/index.html#maxoptional_4","title":"max
Optional","text":""},{"location":"api/java/cdk-graph/index.html#findchild_4","title":"
- Type: java.lang.Number
findChild
","text":"public Node findChild(java.lang.String id)\n
Find child with given id.
Similar to
"},{"location":"api/java/cdk-graph/index.html#idrequired_18","title":"find
but does not throw error if no child found.id
Required","text":""},{"location":"api/java/cdk-graph/index.html#findlink_4","title":"
- Type: java.lang.String
findLink
","text":"public Edge findLink(IEdgePredicate predicate)\npublic Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse)\npublic Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow)\npublic Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow, java.lang.Boolean direct)\n
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.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_26","title":"predicate
Required","text":"
- Type: IEdgePredicate
Edge predicate function to match edge.
"},{"location":"api/java/cdk-graph/index.html#reverseoptional_12","title":"reverse
Optional","text":"
- Type: java.lang.Boolean
Indicates if links are search in reverse order.
"},{"location":"api/java/cdk-graph/index.html#followoptional_8","title":"follow
Optional","text":"
- Type: java.lang.Boolean
Indicates if link chain is followed.
"},{"location":"api/java/cdk-graph/index.html#directoptional_8","title":"direct
Optional","text":"
- Type: java.lang.Boolean
Indicates that only direct links should be searched.
"},{"location":"api/java/cdk-graph/index.html#findlinks_4","title":"findLinks
","text":"public java.util.List<Edge> findLinks(IEdgePredicate predicate)\npublic java.util.List<Edge> findLinks(IEdgePredicate predicate, java.lang.Boolean reverse)\npublic java.util.List<Edge> findLinks(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow)\npublic java.util.List<Edge> findLinks(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow, java.lang.Boolean direct)\n
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.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_27","title":"predicate
Required","text":"
- Type: IEdgePredicate
Edge predicate function to match edge.
"},{"location":"api/java/cdk-graph/index.html#reverseoptional_13","title":"reverse
Optional","text":"
- Type: java.lang.Boolean
Indicates if links are search in reverse order.
"},{"location":"api/java/cdk-graph/index.html#followoptional_9","title":"follow
Optional","text":"
- Type: java.lang.Boolean
Indicates if link chain is followed.
"},{"location":"api/java/cdk-graph/index.html#directoptional_9","title":"direct
Optional","text":"
- Type: java.lang.Boolean
Indicates that only direct links should be searched.
"},{"location":"api/java/cdk-graph/index.html#getcfnprop_4","title":"getCfnProp
","text":"public java.lang.String OR java.lang.Number OR java.lang.Boolean OR PlainObject OR java.util.List<java.lang.String OR java.lang.Number OR java.lang.Boolean OR PlainObject> getCfnProp(java.lang.String key)\n
Get specific CloudFormation property.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_84","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#getchild_4","title":"
- Type: java.lang.String
getChild
","text":"public Node getChild(java.lang.String id)\n
Get child node with given id.
"},{"location":"api/java/cdk-graph/index.html#idrequired_19","title":"id
Required","text":""},{"location":"api/java/cdk-graph/index.html#getlinkchains_4","title":"
- Type: java.lang.String
getLinkChains
","text":"public java.util.List<java.util.List<java.lang.Object>> getLinkChains()\npublic java.util.List<java.util.List<java.lang.Object>> getLinkChains(java.lang.Boolean reverse)\n
Resolve all link chains.
{@link EdgeChain }
"},{"location":"api/java/cdk-graph/index.html#reverseoptional_14","title":"reverse
Optional","text":""},{"location":"api/java/cdk-graph/index.html#getnearestancestor_4","title":"
- Type: java.lang.Boolean
getNearestAncestor
","text":"public Node getNearestAncestor(Node node)\n
Gets the nearest common ancestor shared between this node and another node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_45","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#isancestor_4","title":"
- Type: Node
isAncestor
","text":"public java.lang.Boolean isAncestor(Node ancestor)\n
Indicates if a specific node is an ancestor of this node.
"},{"location":"api/java/cdk-graph/index.html#ancestorrequired_8","title":"ancestor
Required","text":""},{"location":"api/java/cdk-graph/index.html#ischild_4","title":"
- Type: Node
isChild
","text":"public java.lang.Boolean isChild(Node node)\n
Indicates if specific node is a child of this node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_46","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatecollapse_4","title":"
- Type: Node
mutateCollapse
","text":"public void mutateCollapse()\n
Collapses all sub-nodes of this node into this node.
"},{"location":"api/java/cdk-graph/index.html#mutatecollapseto_4","title":"mutateCollapseTo
","text":"public Node mutateCollapseTo(Node ancestor)\n
Collapses this node into an ancestor.
"},{"location":"api/java/cdk-graph/index.html#ancestorrequired_9","title":"ancestor
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatecollapsetoparent_4","title":"
- Type: Node
mutateCollapseToParent
","text":"public Node mutateCollapseToParent()\n
Collapses this node into it's parent node.
"},{"location":"api/java/cdk-graph/index.html#mutatehoist_4","title":"mutateHoist
","text":"public void mutateHoist(Node newParent)\n
Hoist this node to an ancestor by removing it from its current parent node and in turn moving it to the ancestor.
"},{"location":"api/java/cdk-graph/index.html#newparentrequired_8","title":"newParent
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatemove_4","title":"
- Type: Node
mutateMove
","text":"public void mutateMove(Node newParent)\n
Move this node into a new parent node.
"},{"location":"api/java/cdk-graph/index.html#newparentrequired_9","title":"newParent
Required","text":"
- Type: Node
The parent to move this node to.
"},{"location":"api/java/cdk-graph/index.html#mutateremovechild_4","title":"mutateRemoveChild
","text":"public java.lang.Boolean mutateRemoveChild(Node node)\n
Remove a child node from this node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_47","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateremovelink_4","title":"
- Type: Node
mutateRemoveLink
","text":"public java.lang.Boolean mutateRemoveLink(Edge link)\n
Remove a link from this node.
"},{"location":"api/java/cdk-graph/index.html#linkrequired_8","title":"link
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateremovereverselink_4","title":"
- Type: Edge
mutateRemoveReverseLink
","text":"public java.lang.Boolean mutateRemoveReverseLink(Edge link)\n
Remove a link to this node.
"},{"location":"api/java/cdk-graph/index.html#linkrequired_9","title":"link
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateuncluster_4","title":"
- Type: Edge
mutateUncluster
","text":"public void mutateUncluster()\n
Hoist all children to parent and collapse node to parent.
"},{"location":"api/java/cdk-graph/index.html#tostring_9","title":"toString
","text":"public java.lang.String toString()\n
Get string representation of this node.
"},{"location":"api/java/cdk-graph/index.html#static-functions_9","title":"Static Functions","text":"Name DescriptionisOutputNode
Indicates if node is an {@link OutputNode}."},{"location":"api/java/cdk-graph/index.html#isoutputnode","title":"isOutputNode
","text":"import software.aws.pdk.cdk_graph.OutputNode;\n\nOutputNode.isOutputNode(Node node)\n
Indicates if node is an {@link OutputNode}.
"},{"location":"api/java/cdk-graph/index.html#noderequired_48","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#properties_25","title":"Properties","text":"Name Type Description
- Type: Node
attributes
java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>> 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 aaws-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."},{"location":"api/java/cdk-graph/index.html#attributesrequired_9","title":"attributes
Required","text":"public java.lang.Object getAttributes();\n
- Type: java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>>
Get readonly record of all attributes.
"},{"location":"api/java/cdk-graph/index.html#flagsrequired_9","title":"flags
Required","text":"public java.util.List<FlagEnum> getFlags();\n
- Type: java.util.List<FlagEnum>
Get readonly list of all flags.
"},{"location":"api/java/cdk-graph/index.html#isdestroyedrequired_9","title":"isDestroyed
Required","text":"public java.lang.Boolean getIsDestroyed();\n
- Type: java.lang.Boolean
Indicates if the entity has been destroyed (eg: removed from store).
"},{"location":"api/java/cdk-graph/index.html#ismutatedrequired_9","title":"isMutated
Required","text":"public java.lang.Boolean getIsMutated();\n
- Type: java.lang.Boolean
Indicates if the entity has had destructive mutations applied.
"},{"location":"api/java/cdk-graph/index.html#metadatarequired_9","title":"metadata
Required","text":"public java.util.List<MetadataEntry> getMetadata();\n
- Type: java.util.List
Get readonly list of all metadata entries.
"},{"location":"api/java/cdk-graph/index.html#storerequired_12","title":"store
Required","text":"public Store getStore();\n
- Type: Store
Reference to the store.
"},{"location":"api/java/cdk-graph/index.html#tagsrequired_9","title":"tags
Required","text":"public java.util.Map<java.lang.String, java.lang.String> getTags();\n
- Type: java.util.Map
Get readonly record of all tags.
"},{"location":"api/java/cdk-graph/index.html#uuidrequired_14","title":"uuid
Required","text":"public java.lang.String getUuid();\n
- Type: java.lang.String
Universally unique identifier.
"},{"location":"api/java/cdk-graph/index.html#allowdestructivemutationsrequired_8","title":"allowDestructiveMutations
Required","text":"public java.lang.Boolean getAllowDestructiveMutations();\n
- Type: java.lang.Boolean
Indicates if this node allows destructive mutations.
{@link Store.allowDestructiveMutations }
"},{"location":"api/java/cdk-graph/index.html#childrenrequired_4","title":"children
Required","text":"public java.util.List<Node> getChildren();\n
- Type: java.util.List<Node>
Get all direct child nodes.
"},{"location":"api/java/cdk-graph/index.html#dependedonbyrequired_4","title":"dependedOnBy
Required","text":"public java.util.List<Node> getDependedOnBy();\n
- Type: java.util.List<Node>
Get list of Nodes that depend on this node.
{@link Node.reverseDependencyLinks }
"},{"location":"api/java/cdk-graph/index.html#dependenciesrequired_5","title":"dependencies
Required","text":"public java.util.List<Node> getDependencies();\n
- Type: java.util.List<Node>
Get list of Nodes that this node depends on.
{@link Node.dependencyLinks }
"},{"location":"api/java/cdk-graph/index.html#dependencylinksrequired_4","title":"dependencyLinks
Required","text":"public java.util.List<Dependency> getDependencyLinks();\n
- Type: java.util.List<Dependency>
Gets list of {@link Dependency} links (edges) where this node is the source.
"},{"location":"api/java/cdk-graph/index.html#depthrequired_4","title":"depth
Required","text":"public java.lang.Number getDepth();\n
- Type: java.lang.Number
Indicates the depth of the node relative to root (0).
"},{"location":"api/java/cdk-graph/index.html#idrequired_20","title":"id
Required","text":"public java.lang.String getId();\n
- Type: java.lang.String
Node id, which is only unique within parent scope.
"},{"location":"api/java/cdk-graph/index.html#isassetrequired_4","title":"isAsset
Required","text":"public java.lang.Boolean getIsAsset();\n
- Type: java.lang.Boolean
Indicates if this node is considered a {@link FlagEnum.ASSET}.
"},{"location":"api/java/cdk-graph/index.html#iscfnfqnrequired_4","title":"isCfnFqn
Required","text":"public java.lang.Boolean getIsCfnFqn();\n
- Type: java.lang.Boolean
Indicates if node ConstructInfoFqn denotes a
aws-cdk-lib.*.Cfn*
construct.{@link FlagEnum.CFN_FQN }
"},{"location":"api/java/cdk-graph/index.html#isclusterrequired_4","title":"isCluster
Required","text":"public java.lang.Boolean getIsCluster();\n
- Type: java.lang.Boolean
Indicates if this node is considered a {@link FlagEnum.CLUSTER}.
"},{"location":"api/java/cdk-graph/index.html#iscustomresourcerequired_4","title":"isCustomResource
Required","text":"public java.lang.Boolean getIsCustomResource();\n
- Type: java.lang.Boolean
Indicates if node is a Custom Resource.
"},{"location":"api/java/cdk-graph/index.html#isextraneousrequired_8","title":"isExtraneous
Required","text":"public java.lang.Boolean getIsExtraneous();\n
- 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.
"},{"location":"api/java/cdk-graph/index.html#isgraphcontainerrequired_4","title":"isGraphContainer
Required","text":"public java.lang.Boolean getIsGraphContainer();\n
- Type: java.lang.Boolean
Indicates if this node is considered a {@link FlagEnum.GRAPH_CONTAINER}.
"},{"location":"api/java/cdk-graph/index.html#isleafrequired_4","title":"isLeaf
Required","text":"public java.lang.Boolean getIsLeaf();\n
- Type: java.lang.Boolean
Indicates if this node is a leaf node, which means it does not have children.
"},{"location":"api/java/cdk-graph/index.html#istoplevelrequired_4","title":"isTopLevel
Required","text":"public java.lang.Boolean getIsTopLevel();\n
- Type: java.lang.Boolean
Indicates if node is direct child of the graph root node.
"},{"location":"api/java/cdk-graph/index.html#linksrequired_4","title":"links
Required","text":"public java.util.List<Edge> getLinks();\n
- Type: java.util.List<Edge>
Gets all links (edges) in which this node is the source.
"},{"location":"api/java/cdk-graph/index.html#nodetyperequired_5","title":"nodeType
Required","text":"public NodeTypeEnum getNodeType();\n
- Type: NodeTypeEnum
Type of node.
"},{"location":"api/java/cdk-graph/index.html#pathrequired_6","title":"path
Required","text":"public java.lang.String getPath();\n
- Type: java.lang.String
Path of the node.
"},{"location":"api/java/cdk-graph/index.html#referencedbyrequired_4","title":"referencedBy
Required","text":"public java.util.List<Node> getReferencedBy();\n
- Type: java.util.List<Node>
Get list of Nodes that reference this node.
{@link Node.reverseReferenceLinks }
"},{"location":"api/java/cdk-graph/index.html#referencelinksrequired_4","title":"referenceLinks
Required","text":"public java.util.List<Reference> getReferenceLinks();\n
- Type: java.util.List<Reference>
Gets list of {@link Reference} links (edges) where this node is the source.
"},{"location":"api/java/cdk-graph/index.html#referencesrequired_4","title":"references
Required","text":"public java.util.List<Node> getReferences();\n
- Type: java.util.List<Node>
Get list of Nodes that this node references.
{@link Node.referenceLinks }
"},{"location":"api/java/cdk-graph/index.html#reversedependencylinksrequired_4","title":"reverseDependencyLinks
Required","text":"public java.util.List<Dependency> getReverseDependencyLinks();\n
- Type: java.util.List<Dependency>
Gets list of {@link Dependency} links (edges) where this node is the target.
"},{"location":"api/java/cdk-graph/index.html#reverselinksrequired_4","title":"reverseLinks
Required","text":"public java.util.List<Edge> getReverseLinks();\n
- Type: java.util.List<Edge>
Gets all links (edges) in which this node is the target.
"},{"location":"api/java/cdk-graph/index.html#reversereferencelinksrequired_4","title":"reverseReferenceLinks
Required","text":"public java.util.List<Reference> getReverseReferenceLinks();\n
- Type: java.util.List<Reference>
Gets list of {@link Reference} links (edges) where this node is the target.
"},{"location":"api/java/cdk-graph/index.html#scopesrequired_4","title":"scopes
Required","text":"public java.util.List<Node> getScopes();\n
- Type: java.util.List<Node>
Gets descending ordered list of ancestors from the root.
"},{"location":"api/java/cdk-graph/index.html#siblingsrequired_4","title":"siblings
Required","text":"public java.util.List<Node> getSiblings();\n
- Type: java.util.List<Node>
Get list of siblings of this node.
"},{"location":"api/java/cdk-graph/index.html#cfnpropsoptional_4","title":"cfnProps
Optional","text":"public PlainObject getCfnProps();\n
- Type: PlainObject
Gets CloudFormation properties for this node.
"},{"location":"api/java/cdk-graph/index.html#cfntypeoptional_6","title":"cfnType
Optional","text":"public java.lang.String getCfnType();\n
- Type: java.lang.String
Get the CloudFormation resource type for this node.
"},{"location":"api/java/cdk-graph/index.html#constructinfooptional_6","title":"constructInfo
Optional","text":"public ConstructInfo getConstructInfo();\n
- Type: ConstructInfo
Synthesized construct information defining jii resolution data.
"},{"location":"api/java/cdk-graph/index.html#constructinfofqnoptional_4","title":"constructInfoFqn
Optional","text":"public java.lang.String getConstructInfoFqn();\n
- Type: java.lang.String
Synthesized construct information defining jii resolution data.
"},{"location":"api/java/cdk-graph/index.html#logicalidoptional_6","title":"logicalId
Optional","text":"public java.lang.String getLogicalId();\n
- Type: java.lang.String
Logical id of the node, which is only unique within containing stack.
"},{"location":"api/java/cdk-graph/index.html#parentoptional_5","title":"parent
Optional","text":"public Node getParent();\n
- Type: Node
Parent node.
Only the root node should not have parent.
"},{"location":"api/java/cdk-graph/index.html#rootstackoptional_4","title":"rootStack
Optional","text":"public StackNode getRootStack();\n
- Type: StackNode
Get root stack.
"},{"location":"api/java/cdk-graph/index.html#stackoptional_5","title":"stack
Optional","text":"public StackNode getStack();\n
- Type: StackNode
Stack the node is contained in.
"},{"location":"api/java/cdk-graph/index.html#isexportrequired","title":"isExport
Required","text":"public java.lang.Boolean getIsExport();\n
- Type: java.lang.Boolean
Indicates if {@link OutputNode} is exported.
"},{"location":"api/java/cdk-graph/index.html#valuerequired_41","title":"value
Required","text":"public java.lang.Object getValue();\n
- Type: java.lang.Object
Get the value* attribute.
"},{"location":"api/java/cdk-graph/index.html#exportnameoptional","title":"exportName
Optional","text":"public java.lang.String getExportName();\n
- Type: java.lang.String
Get the export name attribute.
"},{"location":"api/java/cdk-graph/index.html#constants_6","title":"Constants","text":"Name Type DescriptionATTR_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."},{"location":"api/java/cdk-graph/index.html#attr_export_namerequired","title":"ATTR_EXPORT_NAME
Required","text":"public java.lang.String getAttrExportName();\n
- Type: java.lang.String
Attribute key where output export name is stored.
"},{"location":"api/java/cdk-graph/index.html#attr_valuerequired","title":"ATTR_VALUE
Required","text":"public java.lang.String getAttrValue();\n
- Type: java.lang.String
Attribute key where output value is stored.
"},{"location":"api/java/cdk-graph/index.html#parameternode","title":"ParameterNode","text":"ParameterNode defines a CfnParameter node.
"},{"location":"api/java/cdk-graph/index.html#initializers_13","title":"Initializers","text":"Name Type Descriptionimport software.aws.pdk.cdk_graph.ParameterNode;\n\nnew ParameterNode(IParameterNodeProps props);\n
props
IParameterNodeProps
No description."},{"location":"api/java/cdk-graph/index.html#propsrequired_10","title":"props
Required","text":""},{"location":"api/java/cdk-graph/index.html#methods_12","title":"Methods","text":"Name Description
- Type: IParameterNodeProps
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."},{"location":"api/java/cdk-graph/index.html#addattribute_10","title":"addAttribute
","text":"public void addAttribute(java.lang.String key, java.lang.Object value)\n
Add attribute.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_85","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_42","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#addflag_10","title":"
- Type: java.lang.Object
addFlag
","text":"public void addFlag(FlagEnum flag)\n
Add flag.
"},{"location":"api/java/cdk-graph/index.html#flagrequired_20","title":"flag
Required","text":""},{"location":"api/java/cdk-graph/index.html#addmetadata_10","title":"
- Type: FlagEnum
addMetadata
","text":"public void addMetadata(java.lang.String metadataType, java.lang.Object data)\n
Add metadata entry.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_30","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#datarequired_31","title":"
- Type: java.lang.String
data
Required","text":""},{"location":"api/java/cdk-graph/index.html#addtag_10","title":"
- Type: java.lang.Object
addTag
","text":"public void addTag(java.lang.String key, java.lang.String value)\n
Add tag.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_86","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_43","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#applydata_10","title":"
- Type: java.lang.String
applyData
","text":"public void applyData(IBaseEntityDataProps data)\npublic void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite)\npublic void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite, java.lang.Boolean applyFlags)\n
Applies data (attributes, metadata, tags, flag) to entity.
Generally used only for mutations such as collapse and consume to retain data.
"},{"location":"api/java/cdk-graph/index.html#datarequired_32","title":"data
Required","text":"
- Type: IBaseEntityDataProps
The data to apply.
"},{"location":"api/java/cdk-graph/index.html#overwriteoptional_10","title":"overwrite
Optional","text":""},{"location":"api/java/cdk-graph/index.html#applyflagsoptional_10","title":"
- Type: java.lang.Boolean
applyFlags
Optional","text":"
- Type: java.lang.Boolean
Indicates if data is overwritten - Indicates if flags should be applied.
"},{"location":"api/java/cdk-graph/index.html#findmetadata_10","title":"findMetadata
","text":"public java.util.List<MetadataEntry> findMetadata(java.lang.String metadataType)\n
Retrieves all metadata entries of a given type.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_31","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#getattribute_10","title":"
- Type: java.lang.String
getAttribute
","text":"public java.lang.Object getAttribute(java.lang.String key)\n
Get attribute by key.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_87","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#gettag_10","title":"
- Type: java.lang.String
getTag
","text":"public java.lang.String getTag(java.lang.String key)\n
Get tag by key.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_88","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#hasattribute_10","title":"
- Type: java.lang.String
hasAttribute
","text":"public java.lang.Boolean hasAttribute(java.lang.String key)\npublic java.lang.Boolean hasAttribute(java.lang.String key, java.lang.Object value)\n
Indicates if entity has a given attribute defined, and optionally with a specific value.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_89","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valueoptional_22","title":"
- Type: java.lang.String
value
Optional","text":""},{"location":"api/java/cdk-graph/index.html#hasflag_10","title":"
- Type: java.lang.Object
hasFlag
","text":"public java.lang.Boolean hasFlag(FlagEnum flag)\n
Indicates if entity has a given flag.
"},{"location":"api/java/cdk-graph/index.html#flagrequired_21","title":"flag
Required","text":""},{"location":"api/java/cdk-graph/index.html#hasmetadata_10","title":"
- Type: FlagEnum
hasMetadata
","text":"public java.lang.Boolean hasMetadata(java.lang.String metadataType, java.lang.Object data)\n
Indicates if entity has matching metadata entry.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_32","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#datarequired_33","title":"
- Type: java.lang.String
data
Required","text":""},{"location":"api/java/cdk-graph/index.html#hastag_10","title":"
- Type: java.lang.Object
hasTag
","text":"public java.lang.Boolean hasTag(java.lang.String key)\npublic java.lang.Boolean hasTag(java.lang.String key, java.lang.String value)\n
Indicates if entity has tag, optionally verifying tag value.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_90","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valueoptional_23","title":"
- Type: java.lang.String
value
Optional","text":""},{"location":"api/java/cdk-graph/index.html#mutatedestroy_10","title":"
- Type: java.lang.String
mutateDestroy
","text":"public void mutateDestroy()\npublic void mutateDestroy(java.lang.Boolean strict)\n
Destroys this node by removing all references and removing this node from the store.
"},{"location":"api/java/cdk-graph/index.html#strictoptional_6","title":"strict
Optional","text":""},{"location":"api/java/cdk-graph/index.html#setattribute_10","title":"
- Type: java.lang.Boolean
setAttribute
","text":"public void setAttribute(java.lang.String key, java.lang.Object value)\n
Set attribute.
This will overwrite existing attribute.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_91","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_44","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#settag_10","title":"
- Type: java.lang.Object
setTag
","text":"public void setTag(java.lang.String key, java.lang.String value)\n
Set tag.
Will overwrite existing tag.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_92","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_45","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#addchild_5","title":"
- Type: java.lang.String
addChild
","text":"public void addChild(Node node)\n
Add child node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_49","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#addlink_5","title":"
- Type: Node
addLink
","text":"public void addLink(Edge edge)\n
Add link to another node.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_25","title":"edge
Required","text":""},{"location":"api/java/cdk-graph/index.html#addreverselink_5","title":"
- Type: Edge
addReverseLink
","text":"public void addReverseLink(Edge edge)\n
Add link from another node.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_26","title":"edge
Required","text":""},{"location":"api/java/cdk-graph/index.html#doesdependon_5","title":"
- Type: Edge
doesDependOn
","text":"public java.lang.Boolean doesDependOn(Node node)\n
Indicates if this node depends on another node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_50","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#doesreference_5","title":"
- Type: Node
doesReference
","text":"public java.lang.Boolean doesReference(Node node)\n
Indicates if this node references another node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_51","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#find_5","title":"
- Type: Node
find
","text":"public Node find(INodePredicate predicate)\n
Recursively find the nearest sub-node matching predicate.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_28","title":"predicate
Required","text":""},{"location":"api/java/cdk-graph/index.html#findall_5","title":"
- Type: INodePredicate
findAll
","text":"public java.util.List<Node> findAll()\npublic java.util.List<Node> findAll(IFindNodeOptions options)\n
Return this construct and all of its sub-nodes in the given order.
Optionally filter nodes based on predicate.
"},{"location":"api/java/cdk-graph/index.html#optionsoptional_10","title":"options
Optional","text":""},{"location":"api/java/cdk-graph/index.html#findalllinks_5","title":"
- Type: IFindNodeOptions
findAllLinks
","text":"public java.util.List<Edge> findAllLinks()\npublic java.util.List<Edge> findAllLinks(IFindEdgeOptions options)\n
Return all direct links of this node and that of all sub-nodes.
Optionally filter links based on predicate.
"},{"location":"api/java/cdk-graph/index.html#optionsoptional_11","title":"options
Optional","text":""},{"location":"api/java/cdk-graph/index.html#findancestor_5","title":"
- Type: IFindEdgeOptions
findAncestor
","text":"public Node findAncestor(INodePredicate predicate)\npublic Node findAncestor(INodePredicate predicate, java.lang.Number max)\n
Find nearest ancestor of this node matching given predicate.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_29","title":"predicate
Required","text":"
- Type: INodePredicate
Predicate to match ancestor.
"},{"location":"api/java/cdk-graph/index.html#maxoptional_5","title":"max
Optional","text":""},{"location":"api/java/cdk-graph/index.html#findchild_5","title":"
- Type: java.lang.Number
findChild
","text":"public Node findChild(java.lang.String id)\n
Find child with given id.
Similar to
"},{"location":"api/java/cdk-graph/index.html#idrequired_21","title":"find
but does not throw error if no child found.id
Required","text":""},{"location":"api/java/cdk-graph/index.html#findlink_5","title":"
- Type: java.lang.String
findLink
","text":"public Edge findLink(IEdgePredicate predicate)\npublic Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse)\npublic Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow)\npublic Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow, java.lang.Boolean direct)\n
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.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_30","title":"predicate
Required","text":"
- Type: IEdgePredicate
Edge predicate function to match edge.
"},{"location":"api/java/cdk-graph/index.html#reverseoptional_15","title":"reverse
Optional","text":"
- Type: java.lang.Boolean
Indicates if links are search in reverse order.
"},{"location":"api/java/cdk-graph/index.html#followoptional_10","title":"follow
Optional","text":"
- Type: java.lang.Boolean
Indicates if link chain is followed.
"},{"location":"api/java/cdk-graph/index.html#directoptional_10","title":"direct
Optional","text":"
- Type: java.lang.Boolean
Indicates that only direct links should be searched.
"},{"location":"api/java/cdk-graph/index.html#findlinks_5","title":"findLinks
","text":"public java.util.List<Edge> findLinks(IEdgePredicate predicate)\npublic java.util.List<Edge> findLinks(IEdgePredicate predicate, java.lang.Boolean reverse)\npublic java.util.List<Edge> findLinks(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow)\npublic java.util.List<Edge> findLinks(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow, java.lang.Boolean direct)\n
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.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_31","title":"predicate
Required","text":"
- Type: IEdgePredicate
Edge predicate function to match edge.
"},{"location":"api/java/cdk-graph/index.html#reverseoptional_16","title":"reverse
Optional","text":"
- Type: java.lang.Boolean
Indicates if links are search in reverse order.
"},{"location":"api/java/cdk-graph/index.html#followoptional_11","title":"follow
Optional","text":"
- Type: java.lang.Boolean
Indicates if link chain is followed.
"},{"location":"api/java/cdk-graph/index.html#directoptional_11","title":"direct
Optional","text":"
- Type: java.lang.Boolean
Indicates that only direct links should be searched.
"},{"location":"api/java/cdk-graph/index.html#getcfnprop_5","title":"getCfnProp
","text":"public java.lang.String OR java.lang.Number OR java.lang.Boolean OR PlainObject OR java.util.List<java.lang.String OR java.lang.Number OR java.lang.Boolean OR PlainObject> getCfnProp(java.lang.String key)\n
Get specific CloudFormation property.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_93","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#getchild_5","title":"
- Type: java.lang.String
getChild
","text":"public Node getChild(java.lang.String id)\n
Get child node with given id.
"},{"location":"api/java/cdk-graph/index.html#idrequired_22","title":"id
Required","text":""},{"location":"api/java/cdk-graph/index.html#getlinkchains_5","title":"
- Type: java.lang.String
getLinkChains
","text":"public java.util.List<java.util.List<java.lang.Object>> getLinkChains()\npublic java.util.List<java.util.List<java.lang.Object>> getLinkChains(java.lang.Boolean reverse)\n
Resolve all link chains.
{@link EdgeChain }
"},{"location":"api/java/cdk-graph/index.html#reverseoptional_17","title":"reverse
Optional","text":""},{"location":"api/java/cdk-graph/index.html#getnearestancestor_5","title":"
- Type: java.lang.Boolean
getNearestAncestor
","text":"public Node getNearestAncestor(Node node)\n
Gets the nearest common ancestor shared between this node and another node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_52","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#isancestor_5","title":"
- Type: Node
isAncestor
","text":"public java.lang.Boolean isAncestor(Node ancestor)\n
Indicates if a specific node is an ancestor of this node.
"},{"location":"api/java/cdk-graph/index.html#ancestorrequired_10","title":"ancestor
Required","text":""},{"location":"api/java/cdk-graph/index.html#ischild_5","title":"
- Type: Node
isChild
","text":"public java.lang.Boolean isChild(Node node)\n
Indicates if specific node is a child of this node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_53","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatecollapse_5","title":"
- Type: Node
mutateCollapse
","text":"public void mutateCollapse()\n
Collapses all sub-nodes of this node into this node.
"},{"location":"api/java/cdk-graph/index.html#mutatecollapseto_5","title":"mutateCollapseTo
","text":"public Node mutateCollapseTo(Node ancestor)\n
Collapses this node into an ancestor.
"},{"location":"api/java/cdk-graph/index.html#ancestorrequired_11","title":"ancestor
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatecollapsetoparent_5","title":"
- Type: Node
mutateCollapseToParent
","text":"public Node mutateCollapseToParent()\n
Collapses this node into it's parent node.
"},{"location":"api/java/cdk-graph/index.html#mutatehoist_5","title":"mutateHoist
","text":"public void mutateHoist(Node newParent)\n
Hoist this node to an ancestor by removing it from its current parent node and in turn moving it to the ancestor.
"},{"location":"api/java/cdk-graph/index.html#newparentrequired_10","title":"newParent
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatemove_5","title":"
- Type: Node
mutateMove
","text":"public void mutateMove(Node newParent)\n
Move this node into a new parent node.
"},{"location":"api/java/cdk-graph/index.html#newparentrequired_11","title":"newParent
Required","text":"
- Type: Node
The parent to move this node to.
"},{"location":"api/java/cdk-graph/index.html#mutateremovechild_5","title":"mutateRemoveChild
","text":"public java.lang.Boolean mutateRemoveChild(Node node)\n
Remove a child node from this node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_54","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateremovelink_5","title":"
- Type: Node
mutateRemoveLink
","text":"public java.lang.Boolean mutateRemoveLink(Edge link)\n
Remove a link from this node.
"},{"location":"api/java/cdk-graph/index.html#linkrequired_10","title":"link
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateremovereverselink_5","title":"
- Type: Edge
mutateRemoveReverseLink
","text":"public java.lang.Boolean mutateRemoveReverseLink(Edge link)\n
Remove a link to this node.
"},{"location":"api/java/cdk-graph/index.html#linkrequired_11","title":"link
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateuncluster_5","title":"
- Type: Edge
mutateUncluster
","text":"public void mutateUncluster()\n
Hoist all children to parent and collapse node to parent.
"},{"location":"api/java/cdk-graph/index.html#tostring_10","title":"toString
","text":"public java.lang.String toString()\n
Get string representation of this node.
"},{"location":"api/java/cdk-graph/index.html#static-functions_10","title":"Static Functions","text":"Name DescriptionisParameterNode
Indicates if node is a {@link ParameterNode}."},{"location":"api/java/cdk-graph/index.html#isparameternode","title":"isParameterNode
","text":"import software.aws.pdk.cdk_graph.ParameterNode;\n\nParameterNode.isParameterNode(Node node)\n
Indicates if node is a {@link ParameterNode}.
"},{"location":"api/java/cdk-graph/index.html#noderequired_55","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#properties_26","title":"Properties","text":"Name Type Description
- Type: Node
attributes
java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>> 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 aaws-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."},{"location":"api/java/cdk-graph/index.html#attributesrequired_10","title":"attributes
Required","text":"public java.lang.Object getAttributes();\n
- Type: java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>>
Get readonly record of all attributes.
"},{"location":"api/java/cdk-graph/index.html#flagsrequired_10","title":"flags
Required","text":"public java.util.List<FlagEnum> getFlags();\n
- Type: java.util.List<FlagEnum>
Get readonly list of all flags.
"},{"location":"api/java/cdk-graph/index.html#isdestroyedrequired_10","title":"isDestroyed
Required","text":"public java.lang.Boolean getIsDestroyed();\n
- Type: java.lang.Boolean
Indicates if the entity has been destroyed (eg: removed from store).
"},{"location":"api/java/cdk-graph/index.html#ismutatedrequired_10","title":"isMutated
Required","text":"public java.lang.Boolean getIsMutated();\n
- Type: java.lang.Boolean
Indicates if the entity has had destructive mutations applied.
"},{"location":"api/java/cdk-graph/index.html#metadatarequired_10","title":"metadata
Required","text":"public java.util.List<MetadataEntry> getMetadata();\n
- Type: java.util.List
Get readonly list of all metadata entries.
"},{"location":"api/java/cdk-graph/index.html#storerequired_13","title":"store
Required","text":"public Store getStore();\n
- Type: Store
Reference to the store.
"},{"location":"api/java/cdk-graph/index.html#tagsrequired_10","title":"tags
Required","text":"public java.util.Map<java.lang.String, java.lang.String> getTags();\n
- Type: java.util.Map
Get readonly record of all tags.
"},{"location":"api/java/cdk-graph/index.html#uuidrequired_15","title":"uuid
Required","text":"public java.lang.String getUuid();\n
- Type: java.lang.String
Universally unique identifier.
"},{"location":"api/java/cdk-graph/index.html#allowdestructivemutationsrequired_9","title":"allowDestructiveMutations
Required","text":"public java.lang.Boolean getAllowDestructiveMutations();\n
- Type: java.lang.Boolean
Indicates if this node allows destructive mutations.
{@link Store.allowDestructiveMutations }
"},{"location":"api/java/cdk-graph/index.html#childrenrequired_5","title":"children
Required","text":"public java.util.List<Node> getChildren();\n
- Type: java.util.List<Node>
Get all direct child nodes.
"},{"location":"api/java/cdk-graph/index.html#dependedonbyrequired_5","title":"dependedOnBy
Required","text":"public java.util.List<Node> getDependedOnBy();\n
- Type: java.util.List<Node>
Get list of Nodes that depend on this node.
{@link Node.reverseDependencyLinks }
"},{"location":"api/java/cdk-graph/index.html#dependenciesrequired_6","title":"dependencies
Required","text":"public java.util.List<Node> getDependencies();\n
- Type: java.util.List<Node>
Get list of Nodes that this node depends on.
{@link Node.dependencyLinks }
"},{"location":"api/java/cdk-graph/index.html#dependencylinksrequired_5","title":"dependencyLinks
Required","text":"public java.util.List<Dependency> getDependencyLinks();\n
- Type: java.util.List<Dependency>
Gets list of {@link Dependency} links (edges) where this node is the source.
"},{"location":"api/java/cdk-graph/index.html#depthrequired_5","title":"depth
Required","text":"public java.lang.Number getDepth();\n
- Type: java.lang.Number
Indicates the depth of the node relative to root (0).
"},{"location":"api/java/cdk-graph/index.html#idrequired_23","title":"id
Required","text":"public java.lang.String getId();\n
- Type: java.lang.String
Node id, which is only unique within parent scope.
"},{"location":"api/java/cdk-graph/index.html#isassetrequired_5","title":"isAsset
Required","text":"public java.lang.Boolean getIsAsset();\n
- Type: java.lang.Boolean
Indicates if this node is considered a {@link FlagEnum.ASSET}.
"},{"location":"api/java/cdk-graph/index.html#iscfnfqnrequired_5","title":"isCfnFqn
Required","text":"public java.lang.Boolean getIsCfnFqn();\n
- Type: java.lang.Boolean
Indicates if node ConstructInfoFqn denotes a
aws-cdk-lib.*.Cfn*
construct.{@link FlagEnum.CFN_FQN }
"},{"location":"api/java/cdk-graph/index.html#isclusterrequired_5","title":"isCluster
Required","text":"public java.lang.Boolean getIsCluster();\n
- Type: java.lang.Boolean
Indicates if this node is considered a {@link FlagEnum.CLUSTER}.
"},{"location":"api/java/cdk-graph/index.html#iscustomresourcerequired_5","title":"isCustomResource
Required","text":"public java.lang.Boolean getIsCustomResource();\n
- Type: java.lang.Boolean
Indicates if node is a Custom Resource.
"},{"location":"api/java/cdk-graph/index.html#isextraneousrequired_9","title":"isExtraneous
Required","text":"public java.lang.Boolean getIsExtraneous();\n
- 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.
"},{"location":"api/java/cdk-graph/index.html#isgraphcontainerrequired_5","title":"isGraphContainer
Required","text":"public java.lang.Boolean getIsGraphContainer();\n
- Type: java.lang.Boolean
Indicates if this node is considered a {@link FlagEnum.GRAPH_CONTAINER}.
"},{"location":"api/java/cdk-graph/index.html#isleafrequired_5","title":"isLeaf
Required","text":"public java.lang.Boolean getIsLeaf();\n
- Type: java.lang.Boolean
Indicates if this node is a leaf node, which means it does not have children.
"},{"location":"api/java/cdk-graph/index.html#istoplevelrequired_5","title":"isTopLevel
Required","text":"public java.lang.Boolean getIsTopLevel();\n
- Type: java.lang.Boolean
Indicates if node is direct child of the graph root node.
"},{"location":"api/java/cdk-graph/index.html#linksrequired_5","title":"links
Required","text":"public java.util.List<Edge> getLinks();\n
- Type: java.util.List<Edge>
Gets all links (edges) in which this node is the source.
"},{"location":"api/java/cdk-graph/index.html#nodetyperequired_6","title":"nodeType
Required","text":"public NodeTypeEnum getNodeType();\n
- Type: NodeTypeEnum
Type of node.
"},{"location":"api/java/cdk-graph/index.html#pathrequired_7","title":"path
Required","text":"public java.lang.String getPath();\n
- Type: java.lang.String
Path of the node.
"},{"location":"api/java/cdk-graph/index.html#referencedbyrequired_5","title":"referencedBy
Required","text":"public java.util.List<Node> getReferencedBy();\n
- Type: java.util.List<Node>
Get list of Nodes that reference this node.
{@link Node.reverseReferenceLinks }
"},{"location":"api/java/cdk-graph/index.html#referencelinksrequired_5","title":"referenceLinks
Required","text":"public java.util.List<Reference> getReferenceLinks();\n
- Type: java.util.List<Reference>
Gets list of {@link Reference} links (edges) where this node is the source.
"},{"location":"api/java/cdk-graph/index.html#referencesrequired_5","title":"references
Required","text":"public java.util.List<Node> getReferences();\n
- Type: java.util.List<Node>
Get list of Nodes that this node references.
{@link Node.referenceLinks }
"},{"location":"api/java/cdk-graph/index.html#reversedependencylinksrequired_5","title":"reverseDependencyLinks
Required","text":"public java.util.List<Dependency> getReverseDependencyLinks();\n
- Type: java.util.List<Dependency>
Gets list of {@link Dependency} links (edges) where this node is the target.
"},{"location":"api/java/cdk-graph/index.html#reverselinksrequired_5","title":"reverseLinks
Required","text":"public java.util.List<Edge> getReverseLinks();\n
- Type: java.util.List<Edge>
Gets all links (edges) in which this node is the target.
"},{"location":"api/java/cdk-graph/index.html#reversereferencelinksrequired_5","title":"reverseReferenceLinks
Required","text":"public java.util.List<Reference> getReverseReferenceLinks();\n
- Type: java.util.List<Reference>
Gets list of {@link Reference} links (edges) where this node is the target.
"},{"location":"api/java/cdk-graph/index.html#scopesrequired_5","title":"scopes
Required","text":"public java.util.List<Node> getScopes();\n
- Type: java.util.List<Node>
Gets descending ordered list of ancestors from the root.
"},{"location":"api/java/cdk-graph/index.html#siblingsrequired_5","title":"siblings
Required","text":"public java.util.List<Node> getSiblings();\n
- Type: java.util.List<Node>
Get list of siblings of this node.
"},{"location":"api/java/cdk-graph/index.html#cfnpropsoptional_5","title":"cfnProps
Optional","text":"public PlainObject getCfnProps();\n
- Type: PlainObject
Gets CloudFormation properties for this node.
"},{"location":"api/java/cdk-graph/index.html#cfntypeoptional_7","title":"cfnType
Optional","text":"public java.lang.String getCfnType();\n
- Type: java.lang.String
Get the CloudFormation resource type for this node.
"},{"location":"api/java/cdk-graph/index.html#constructinfooptional_7","title":"constructInfo
Optional","text":"public ConstructInfo getConstructInfo();\n
- Type: ConstructInfo
Synthesized construct information defining jii resolution data.
"},{"location":"api/java/cdk-graph/index.html#constructinfofqnoptional_5","title":"constructInfoFqn
Optional","text":"public java.lang.String getConstructInfoFqn();\n
- Type: java.lang.String
Synthesized construct information defining jii resolution data.
"},{"location":"api/java/cdk-graph/index.html#logicalidoptional_7","title":"logicalId
Optional","text":"public java.lang.String getLogicalId();\n
- Type: java.lang.String
Logical id of the node, which is only unique within containing stack.
"},{"location":"api/java/cdk-graph/index.html#parentoptional_6","title":"parent
Optional","text":"public Node getParent();\n
- Type: Node
Parent node.
Only the root node should not have parent.
"},{"location":"api/java/cdk-graph/index.html#rootstackoptional_5","title":"rootStack
Optional","text":"public StackNode getRootStack();\n
- Type: StackNode
Get root stack.
"},{"location":"api/java/cdk-graph/index.html#stackoptional_6","title":"stack
Optional","text":"public StackNode getStack();\n
- Type: StackNode
Stack the node is contained in.
"},{"location":"api/java/cdk-graph/index.html#isstackreferencerequired","title":"isStackReference
Required","text":"public java.lang.Boolean getIsStackReference();\n
- Type: java.lang.Boolean
Indicates if parameter is a reference to a stack.
"},{"location":"api/java/cdk-graph/index.html#parametertyperequired","title":"parameterType
Required","text":"public java.lang.Object getParameterType();\n
- Type: java.lang.Object
Get the parameter type attribute.
"},{"location":"api/java/cdk-graph/index.html#valuerequired_46","title":"value
Required","text":"public java.lang.Object getValue();\n
- Type: java.lang.Object
Get the value attribute.
"},{"location":"api/java/cdk-graph/index.html#constants_7","title":"Constants","text":"Name Type DescriptionATTR_TYPE
java.lang.String
Attribute key where parameter type is stored.ATTR_VALUE
java.lang.String
Attribute key where parameter value is store."},{"location":"api/java/cdk-graph/index.html#attr_typerequired","title":"ATTR_TYPE
Required","text":"public java.lang.String getAttrType();\n
- Type: java.lang.String
Attribute key where parameter type is stored.
"},{"location":"api/java/cdk-graph/index.html#attr_valuerequired_1","title":"ATTR_VALUE
Required","text":"public java.lang.String getAttrValue();\n
- Type: java.lang.String
Attribute key where parameter value is store.
"},{"location":"api/java/cdk-graph/index.html#reference","title":"Reference","text":"Reference edge class defines a directed relationship between nodes.
"},{"location":"api/java/cdk-graph/index.html#initializers_14","title":"Initializers","text":"Name Type Descriptionimport software.aws.pdk.cdk_graph.Reference;\n\nnew Reference(IReferenceProps props);\n
props
IReferenceProps
No description."},{"location":"api/java/cdk-graph/index.html#propsrequired_11","title":"props
Required","text":""},{"location":"api/java/cdk-graph/index.html#methods_13","title":"Methods","text":"Name Description
- Type: IReferenceProps
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."},{"location":"api/java/cdk-graph/index.html#addattribute_11","title":"addAttribute
","text":"public void addAttribute(java.lang.String key, java.lang.Object value)\n
Add attribute.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_94","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_47","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#addflag_11","title":"
- Type: java.lang.Object
addFlag
","text":"public void addFlag(FlagEnum flag)\n
Add flag.
"},{"location":"api/java/cdk-graph/index.html#flagrequired_22","title":"flag
Required","text":""},{"location":"api/java/cdk-graph/index.html#addmetadata_11","title":"
- Type: FlagEnum
addMetadata
","text":"public void addMetadata(java.lang.String metadataType, java.lang.Object data)\n
Add metadata entry.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_33","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#datarequired_34","title":"
- Type: java.lang.String
data
Required","text":""},{"location":"api/java/cdk-graph/index.html#addtag_11","title":"
- Type: java.lang.Object
addTag
","text":"public void addTag(java.lang.String key, java.lang.String value)\n
Add tag.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_95","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_48","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#applydata_11","title":"
- Type: java.lang.String
applyData
","text":"public void applyData(IBaseEntityDataProps data)\npublic void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite)\npublic void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite, java.lang.Boolean applyFlags)\n
Applies data (attributes, metadata, tags, flag) to entity.
Generally used only for mutations such as collapse and consume to retain data.
"},{"location":"api/java/cdk-graph/index.html#datarequired_35","title":"data
Required","text":"
- Type: IBaseEntityDataProps
The data to apply.
"},{"location":"api/java/cdk-graph/index.html#overwriteoptional_11","title":"overwrite
Optional","text":""},{"location":"api/java/cdk-graph/index.html#applyflagsoptional_11","title":"
- Type: java.lang.Boolean
applyFlags
Optional","text":"
- Type: java.lang.Boolean
Indicates if data is overwritten - Indicates if flags should be applied.
"},{"location":"api/java/cdk-graph/index.html#findmetadata_11","title":"findMetadata
","text":"public java.util.List<MetadataEntry> findMetadata(java.lang.String metadataType)\n
Retrieves all metadata entries of a given type.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_34","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#getattribute_11","title":"
- Type: java.lang.String
getAttribute
","text":"public java.lang.Object getAttribute(java.lang.String key)\n
Get attribute by key.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_96","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#gettag_11","title":"
- Type: java.lang.String
getTag
","text":"public java.lang.String getTag(java.lang.String key)\n
Get tag by key.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_97","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#hasattribute_11","title":"
- Type: java.lang.String
hasAttribute
","text":"public java.lang.Boolean hasAttribute(java.lang.String key)\npublic java.lang.Boolean hasAttribute(java.lang.String key, java.lang.Object value)\n
Indicates if entity has a given attribute defined, and optionally with a specific value.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_98","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valueoptional_24","title":"
- Type: java.lang.String
value
Optional","text":""},{"location":"api/java/cdk-graph/index.html#hasflag_11","title":"
- Type: java.lang.Object
hasFlag
","text":"public java.lang.Boolean hasFlag(FlagEnum flag)\n
Indicates if entity has a given flag.
"},{"location":"api/java/cdk-graph/index.html#flagrequired_23","title":"flag
Required","text":""},{"location":"api/java/cdk-graph/index.html#hasmetadata_11","title":"
- Type: FlagEnum
hasMetadata
","text":"public java.lang.Boolean hasMetadata(java.lang.String metadataType, java.lang.Object data)\n
Indicates if entity has matching metadata entry.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_35","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#datarequired_36","title":"
- Type: java.lang.String
data
Required","text":""},{"location":"api/java/cdk-graph/index.html#hastag_11","title":"
- Type: java.lang.Object
hasTag
","text":"public java.lang.Boolean hasTag(java.lang.String key)\npublic java.lang.Boolean hasTag(java.lang.String key, java.lang.String value)\n
Indicates if entity has tag, optionally verifying tag value.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_99","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valueoptional_25","title":"
- Type: java.lang.String
value
Optional","text":""},{"location":"api/java/cdk-graph/index.html#mutatedestroy_11","title":"
- Type: java.lang.String
mutateDestroy
","text":"public void mutateDestroy()\npublic void mutateDestroy(java.lang.Boolean _strict)\n
Destroy the edge.
Remove all references and remove from store.
"},{"location":"api/java/cdk-graph/index.html#_strictoptional_4","title":"_strict
Optional","text":""},{"location":"api/java/cdk-graph/index.html#setattribute_11","title":"
- Type: java.lang.Boolean
setAttribute
","text":"public void setAttribute(java.lang.String key, java.lang.Object value)\n
Set attribute.
This will overwrite existing attribute.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_100","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_49","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#settag_11","title":"
- Type: java.lang.Object
setTag
","text":"public void setTag(java.lang.String key, java.lang.String value)\n
Set tag.
Will overwrite existing tag.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_101","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_50","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#isequivalent_4","title":"
- Type: java.lang.String
isEquivalent
","text":"public java.lang.Boolean isEquivalent(Edge edge)\n
Indicates if this edge is equivalent to another edge.
Edges are considered equivalent if they share same type, source, and target.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_27","title":"edge
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateconsume_4","title":"
- Type: Edge
mutateConsume
","text":"public void mutateConsume(Edge edge)\n
Merge an equivalent edge's data into this edge and destroy the other edge.
Used during filtering operations to consolidate equivalent edges.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_28","title":"edge
Required","text":"
- Type: Edge
The edge to consume.
"},{"location":"api/java/cdk-graph/index.html#mutatedirection_4","title":"mutateDirection
","text":"public void mutateDirection(EdgeDirectionEnum direction)\n
Change the edge direction.
"},{"location":"api/java/cdk-graph/index.html#directionrequired_9","title":"direction
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatesource_4","title":"
- Type: EdgeDirectionEnum
mutateSource
","text":"public void mutateSource(Node node)\n
Change the edge source.
"},{"location":"api/java/cdk-graph/index.html#noderequired_56","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatetarget_4","title":"
- Type: Node
mutateTarget
","text":"public void mutateTarget(Node node)\n
Change the edge target.
"},{"location":"api/java/cdk-graph/index.html#noderequired_57","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#tostring_11","title":"
- Type: Node
toString
","text":"public java.lang.String toString()\n
Get string representation of this edge.
"},{"location":"api/java/cdk-graph/index.html#resolvechain_2","title":"resolveChain
","text":"public java.util.List<java.lang.Object> resolveChain()\n
Resolve reference chain.
"},{"location":"api/java/cdk-graph/index.html#resolvetargets_2","title":"resolveTargets
","text":"public java.util.List<Node> resolveTargets()\n
Resolve targets by following potential edge chain.
{@link EdgeChain }
"},{"location":"api/java/cdk-graph/index.html#static-functions_11","title":"Static Functions","text":"Name DescriptionfindAllInChain
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}."},{"location":"api/java/cdk-graph/index.html#findallinchain_4","title":"findAllInChain
","text":"import software.aws.pdk.cdk_graph.Reference;\n\nReference.findAllInChain(java.util.List<java.lang.Object> chain, IEdgePredicate predicate)\n
Find all matching edges based on predicate within an EdgeChain.
"},{"location":"api/java/cdk-graph/index.html#chainrequired_8","title":"chain
Required","text":"
- Type: java.util.List"},{"location":"api/java/cdk-graph/index.html#predicaterequired_32","title":"
predicate
Required","text":""},{"location":"api/java/cdk-graph/index.html#findinchain_4","title":"
- Type: IEdgePredicate
findInChain
","text":"import software.aws.pdk.cdk_graph.Reference;\n\nReference.findInChain(java.util.List<java.lang.Object> chain, IEdgePredicate predicate)\n
Find first edge matching predicate within an EdgeChain.
"},{"location":"api/java/cdk-graph/index.html#chainrequired_9","title":"chain
Required","text":"
- Type: java.util.List"},{"location":"api/java/cdk-graph/index.html#predicaterequired_33","title":"
predicate
Required","text":""},{"location":"api/java/cdk-graph/index.html#isref_2","title":"
- Type: IEdgePredicate
isRef
","text":"import software.aws.pdk.cdk_graph.Reference;\n\nReference.isRef(Edge edge)\n
Indicates if edge is a Ref based {@link Reference} edge.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_29","title":"edge
Required","text":""},{"location":"api/java/cdk-graph/index.html#isreference_2","title":"
- Type: Edge
isReference
","text":"import software.aws.pdk.cdk_graph.Reference;\n\nReference.isReference(Edge edge)\n
Indicates if edge is a {@link Reference}.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_30","title":"edge
Required","text":""},{"location":"api/java/cdk-graph/index.html#properties_27","title":"Properties","text":"Name Type Description
- Type: Edge
attributes
java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>> 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."},{"location":"api/java/cdk-graph/index.html#attributesrequired_11","title":"attributes
Required","text":"public java.lang.Object getAttributes();\n
- Type: java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>>
Get readonly record of all attributes.
"},{"location":"api/java/cdk-graph/index.html#flagsrequired_11","title":"flags
Required","text":"public java.util.List<FlagEnum> getFlags();\n
- Type: java.util.List<FlagEnum>
Get readonly list of all flags.
"},{"location":"api/java/cdk-graph/index.html#isdestroyedrequired_11","title":"isDestroyed
Required","text":"public java.lang.Boolean getIsDestroyed();\n
- Type: java.lang.Boolean
Indicates if the entity has been destroyed (eg: removed from store).
"},{"location":"api/java/cdk-graph/index.html#ismutatedrequired_11","title":"isMutated
Required","text":"public java.lang.Boolean getIsMutated();\n
- Type: java.lang.Boolean
Indicates if the entity has had destructive mutations applied.
"},{"location":"api/java/cdk-graph/index.html#metadatarequired_11","title":"metadata
Required","text":"public java.util.List<MetadataEntry> getMetadata();\n
- Type: java.util.List
Get readonly list of all metadata entries.
"},{"location":"api/java/cdk-graph/index.html#storerequired_14","title":"store
Required","text":"public Store getStore();\n
- Type: Store
Reference to the store.
"},{"location":"api/java/cdk-graph/index.html#tagsrequired_11","title":"tags
Required","text":"public java.util.Map<java.lang.String, java.lang.String> getTags();\n
- Type: java.util.Map
Get readonly record of all tags.
"},{"location":"api/java/cdk-graph/index.html#uuidrequired_16","title":"uuid
Required","text":"public java.lang.String getUuid();\n
- Type: java.lang.String
Universally unique identifier.
"},{"location":"api/java/cdk-graph/index.html#allowdestructivemutationsrequired_10","title":"allowDestructiveMutations
Required","text":"public java.lang.Boolean getAllowDestructiveMutations();\n
- Type: java.lang.Boolean
Indicates if edge allows destructive mutations.
"},{"location":"api/java/cdk-graph/index.html#directionrequired_10","title":"direction
Required","text":"public EdgeDirectionEnum getDirection();\n
- Type: EdgeDirectionEnum
Indicates the direction in which the edge is directed.
"},{"location":"api/java/cdk-graph/index.html#edgetyperequired_5","title":"edgeType
Required","text":"public EdgeTypeEnum getEdgeType();\n
- Type: EdgeTypeEnum
Type of edge.
"},{"location":"api/java/cdk-graph/index.html#isclosedrequired_4","title":"isClosed
Required","text":"public java.lang.Boolean getIsClosed();\n
- 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
"},{"location":"api/java/cdk-graph/index.html#iscrossstackrequired_4","title":"hasFlag(FlagEnum.CLOSED_EDGE)
instead.isCrossStack
Required","text":"public java.lang.Boolean getIsCrossStack();\n
- Type: java.lang.Boolean
Indicates if source and target nodes reside in different root stacks.
"},{"location":"api/java/cdk-graph/index.html#isextraneousrequired_10","title":"isExtraneous
Required","text":"public java.lang.Boolean getIsExtraneous();\n
- 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).
"},{"location":"api/java/cdk-graph/index.html#sourcerequired_9","title":"source
Required","text":"public Node getSource();\n
- Type: Node
Edge source is the node that defines the edge (tail).
"},{"location":"api/java/cdk-graph/index.html#targetrequired_6","title":"target
Required","text":"public Node getTarget();\n
- Type: Node
Edge target is the node being referenced by the source (head).
"},{"location":"api/java/cdk-graph/index.html#referencetyperequired_3","title":"referenceType
Required","text":"public ReferenceTypeEnum getReferenceType();\n
- Type: ReferenceTypeEnum
Get type of reference.
"},{"location":"api/java/cdk-graph/index.html#constants_8","title":"Constants","text":"Name Type DescriptionATT_TYPE
java.lang.String
Attribute defining the type of reference.PREFIX
java.lang.String
Edge prefix to denote Ref type reference edge."},{"location":"api/java/cdk-graph/index.html#att_typerequired_2","title":"ATT_TYPE
Required","text":"public java.lang.String getAttType();\n
- Type: java.lang.String
Attribute defining the type of reference.
"},{"location":"api/java/cdk-graph/index.html#prefixrequired_3","title":"PREFIX
Required","text":"public java.lang.String getPrefix();\n
- Type: java.lang.String
Edge prefix to denote Ref type reference edge.
"},{"location":"api/java/cdk-graph/index.html#resourcenode","title":"ResourceNode","text":"ResourceNode class defines a L2 cdk resource construct.
"},{"location":"api/java/cdk-graph/index.html#initializers_15","title":"Initializers","text":"Name Type Descriptionimport software.aws.pdk.cdk_graph.ResourceNode;\n\nnew ResourceNode(IResourceNodeProps props);\n
props
IResourceNodeProps
No description."},{"location":"api/java/cdk-graph/index.html#propsrequired_12","title":"props
Required","text":""},{"location":"api/java/cdk-graph/index.html#methods_14","title":"Methods","text":"Name Description
- Type: IResourceNodeProps
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."},{"location":"api/java/cdk-graph/index.html#addattribute_12","title":"addAttribute
","text":"public void addAttribute(java.lang.String key, java.lang.Object value)\n
Add attribute.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_102","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_51","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#addflag_12","title":"
- Type: java.lang.Object
addFlag
","text":"public void addFlag(FlagEnum flag)\n
Add flag.
"},{"location":"api/java/cdk-graph/index.html#flagrequired_24","title":"flag
Required","text":""},{"location":"api/java/cdk-graph/index.html#addmetadata_12","title":"
- Type: FlagEnum
addMetadata
","text":"public void addMetadata(java.lang.String metadataType, java.lang.Object data)\n
Add metadata entry.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_36","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#datarequired_37","title":"
- Type: java.lang.String
data
Required","text":""},{"location":"api/java/cdk-graph/index.html#addtag_12","title":"
- Type: java.lang.Object
addTag
","text":"public void addTag(java.lang.String key, java.lang.String value)\n
Add tag.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_103","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_52","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#applydata_12","title":"
- Type: java.lang.String
applyData
","text":"public void applyData(IBaseEntityDataProps data)\npublic void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite)\npublic void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite, java.lang.Boolean applyFlags)\n
Applies data (attributes, metadata, tags, flag) to entity.
Generally used only for mutations such as collapse and consume to retain data.
"},{"location":"api/java/cdk-graph/index.html#datarequired_38","title":"data
Required","text":"
- Type: IBaseEntityDataProps
The data to apply.
"},{"location":"api/java/cdk-graph/index.html#overwriteoptional_12","title":"overwrite
Optional","text":""},{"location":"api/java/cdk-graph/index.html#applyflagsoptional_12","title":"
- Type: java.lang.Boolean
applyFlags
Optional","text":"
- Type: java.lang.Boolean
Indicates if data is overwritten - Indicates if flags should be applied.
"},{"location":"api/java/cdk-graph/index.html#findmetadata_12","title":"findMetadata
","text":"public java.util.List<MetadataEntry> findMetadata(java.lang.String metadataType)\n
Retrieves all metadata entries of a given type.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_37","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#getattribute_12","title":"
- Type: java.lang.String
getAttribute
","text":"public java.lang.Object getAttribute(java.lang.String key)\n
Get attribute by key.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_104","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#gettag_12","title":"
- Type: java.lang.String
getTag
","text":"public java.lang.String getTag(java.lang.String key)\n
Get tag by key.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_105","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#hasattribute_12","title":"
- Type: java.lang.String
hasAttribute
","text":"public java.lang.Boolean hasAttribute(java.lang.String key)\npublic java.lang.Boolean hasAttribute(java.lang.String key, java.lang.Object value)\n
Indicates if entity has a given attribute defined, and optionally with a specific value.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_106","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valueoptional_26","title":"
- Type: java.lang.String
value
Optional","text":""},{"location":"api/java/cdk-graph/index.html#hasflag_12","title":"
- Type: java.lang.Object
hasFlag
","text":"public java.lang.Boolean hasFlag(FlagEnum flag)\n
Indicates if entity has a given flag.
"},{"location":"api/java/cdk-graph/index.html#flagrequired_25","title":"flag
Required","text":""},{"location":"api/java/cdk-graph/index.html#hasmetadata_12","title":"
- Type: FlagEnum
hasMetadata
","text":"public java.lang.Boolean hasMetadata(java.lang.String metadataType, java.lang.Object data)\n
Indicates if entity has matching metadata entry.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_38","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#datarequired_39","title":"
- Type: java.lang.String
data
Required","text":""},{"location":"api/java/cdk-graph/index.html#hastag_12","title":"
- Type: java.lang.Object
hasTag
","text":"public java.lang.Boolean hasTag(java.lang.String key)\npublic java.lang.Boolean hasTag(java.lang.String key, java.lang.String value)\n
Indicates if entity has tag, optionally verifying tag value.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_107","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valueoptional_27","title":"
- Type: java.lang.String
value
Optional","text":""},{"location":"api/java/cdk-graph/index.html#mutatedestroy_12","title":"
- Type: java.lang.String
mutateDestroy
","text":"public void mutateDestroy()\npublic void mutateDestroy(java.lang.Boolean strict)\n
Destroys this node by removing all references and removing this node from the store.
"},{"location":"api/java/cdk-graph/index.html#strictoptional_7","title":"strict
Optional","text":"
- Type: java.lang.Boolean
Indicates that this node must not have references.
"},{"location":"api/java/cdk-graph/index.html#setattribute_12","title":"setAttribute
","text":"public void setAttribute(java.lang.String key, java.lang.Object value)\n
Set attribute.
This will overwrite existing attribute.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_108","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_53","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#settag_12","title":"
- Type: java.lang.Object
setTag
","text":"public void setTag(java.lang.String key, java.lang.String value)\n
Set tag.
Will overwrite existing tag.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_109","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_54","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#addchild_6","title":"
- Type: java.lang.String
addChild
","text":"public void addChild(Node node)\n
Add child node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_58","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#addlink_6","title":"
- Type: Node
addLink
","text":"public void addLink(Edge edge)\n
Add link to another node.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_31","title":"edge
Required","text":""},{"location":"api/java/cdk-graph/index.html#addreverselink_6","title":"
- Type: Edge
addReverseLink
","text":"public void addReverseLink(Edge edge)\n
Add link from another node.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_32","title":"edge
Required","text":""},{"location":"api/java/cdk-graph/index.html#doesdependon_6","title":"
- Type: Edge
doesDependOn
","text":"public java.lang.Boolean doesDependOn(Node node)\n
Indicates if this node depends on another node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_59","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#doesreference_6","title":"
- Type: Node
doesReference
","text":"public java.lang.Boolean doesReference(Node node)\n
Indicates if this node references another node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_60","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#find_6","title":"
- Type: Node
find
","text":"public Node find(INodePredicate predicate)\n
Recursively find the nearest sub-node matching predicate.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_34","title":"predicate
Required","text":""},{"location":"api/java/cdk-graph/index.html#findall_6","title":"
- Type: INodePredicate
findAll
","text":"public java.util.List<Node> findAll()\npublic java.util.List<Node> findAll(IFindNodeOptions options)\n
Return this construct and all of its sub-nodes in the given order.
Optionally filter nodes based on predicate.
"},{"location":"api/java/cdk-graph/index.html#optionsoptional_12","title":"options
Optional","text":""},{"location":"api/java/cdk-graph/index.html#findalllinks_6","title":"
- Type: IFindNodeOptions
findAllLinks
","text":"public java.util.List<Edge> findAllLinks()\npublic java.util.List<Edge> findAllLinks(IFindEdgeOptions options)\n
Return all direct links of this node and that of all sub-nodes.
Optionally filter links based on predicate.
"},{"location":"api/java/cdk-graph/index.html#optionsoptional_13","title":"options
Optional","text":""},{"location":"api/java/cdk-graph/index.html#findancestor_6","title":"
- Type: IFindEdgeOptions
findAncestor
","text":"public Node findAncestor(INodePredicate predicate)\npublic Node findAncestor(INodePredicate predicate, java.lang.Number max)\n
Find nearest ancestor of this node matching given predicate.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_35","title":"predicate
Required","text":"
- Type: INodePredicate
Predicate to match ancestor.
"},{"location":"api/java/cdk-graph/index.html#maxoptional_6","title":"max
Optional","text":""},{"location":"api/java/cdk-graph/index.html#findchild_6","title":"
- Type: java.lang.Number
findChild
","text":"public Node findChild(java.lang.String id)\n
Find child with given id.
Similar to
"},{"location":"api/java/cdk-graph/index.html#idrequired_24","title":"find
but does not throw error if no child found.id
Required","text":""},{"location":"api/java/cdk-graph/index.html#findlink_6","title":"
- Type: java.lang.String
findLink
","text":"public Edge findLink(IEdgePredicate predicate)\npublic Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse)\npublic Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow)\npublic Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow, java.lang.Boolean direct)\n
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.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_36","title":"predicate
Required","text":"
- Type: IEdgePredicate
Edge predicate function to match edge.
"},{"location":"api/java/cdk-graph/index.html#reverseoptional_18","title":"reverse
Optional","text":"
- Type: java.lang.Boolean
Indicates if links are search in reverse order.
"},{"location":"api/java/cdk-graph/index.html#followoptional_12","title":"follow
Optional","text":"
- Type: java.lang.Boolean
Indicates if link chain is followed.
"},{"location":"api/java/cdk-graph/index.html#directoptional_12","title":"direct
Optional","text":"
- Type: java.lang.Boolean
Indicates that only direct links should be searched.
"},{"location":"api/java/cdk-graph/index.html#findlinks_6","title":"findLinks
","text":"public java.util.List<Edge> findLinks(IEdgePredicate predicate)\npublic java.util.List<Edge> findLinks(IEdgePredicate predicate, java.lang.Boolean reverse)\npublic java.util.List<Edge> findLinks(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow)\npublic java.util.List<Edge> findLinks(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow, java.lang.Boolean direct)\n
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.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_37","title":"predicate
Required","text":"
- Type: IEdgePredicate
Edge predicate function to match edge.
"},{"location":"api/java/cdk-graph/index.html#reverseoptional_19","title":"reverse
Optional","text":"
- Type: java.lang.Boolean
Indicates if links are search in reverse order.
"},{"location":"api/java/cdk-graph/index.html#followoptional_13","title":"follow
Optional","text":"
- Type: java.lang.Boolean
Indicates if link chain is followed.
"},{"location":"api/java/cdk-graph/index.html#directoptional_13","title":"direct
Optional","text":"
- Type: java.lang.Boolean
Indicates that only direct links should be searched.
"},{"location":"api/java/cdk-graph/index.html#getcfnprop_6","title":"getCfnProp
","text":"public java.lang.String OR java.lang.Number OR java.lang.Boolean OR PlainObject OR java.util.List<java.lang.String OR java.lang.Number OR java.lang.Boolean OR PlainObject> getCfnProp(java.lang.String key)\n
Get specific CloudFormation property.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_110","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#getchild_6","title":"
- Type: java.lang.String
getChild
","text":"public Node getChild(java.lang.String id)\n
Get child node with given id.
"},{"location":"api/java/cdk-graph/index.html#idrequired_25","title":"id
Required","text":""},{"location":"api/java/cdk-graph/index.html#getlinkchains_6","title":"
- Type: java.lang.String
getLinkChains
","text":"public java.util.List<java.util.List<java.lang.Object>> getLinkChains()\npublic java.util.List<java.util.List<java.lang.Object>> getLinkChains(java.lang.Boolean reverse)\n
Resolve all link chains.
{@link EdgeChain }
"},{"location":"api/java/cdk-graph/index.html#reverseoptional_20","title":"reverse
Optional","text":""},{"location":"api/java/cdk-graph/index.html#getnearestancestor_6","title":"
- Type: java.lang.Boolean
getNearestAncestor
","text":"public Node getNearestAncestor(Node node)\n
Gets the nearest common ancestor shared between this node and another node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_61","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#isancestor_6","title":"
- Type: Node
isAncestor
","text":"public java.lang.Boolean isAncestor(Node ancestor)\n
Indicates if a specific node is an ancestor of this node.
"},{"location":"api/java/cdk-graph/index.html#ancestorrequired_12","title":"ancestor
Required","text":""},{"location":"api/java/cdk-graph/index.html#ischild_6","title":"
- Type: Node
isChild
","text":"public java.lang.Boolean isChild(Node node)\n
Indicates if specific node is a child of this node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_62","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatecollapse_6","title":"
- Type: Node
mutateCollapse
","text":"public void mutateCollapse()\n
Collapses all sub-nodes of this node into this node.
"},{"location":"api/java/cdk-graph/index.html#mutatecollapseto_6","title":"mutateCollapseTo
","text":"public Node mutateCollapseTo(Node ancestor)\n
Collapses this node into an ancestor.
"},{"location":"api/java/cdk-graph/index.html#ancestorrequired_13","title":"ancestor
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatecollapsetoparent_6","title":"
- Type: Node
mutateCollapseToParent
","text":"public Node mutateCollapseToParent()\n
Collapses this node into it's parent node.
"},{"location":"api/java/cdk-graph/index.html#mutatehoist_6","title":"mutateHoist
","text":"public void mutateHoist(Node newParent)\n
Hoist this node to an ancestor by removing it from its current parent node and in turn moving it to the ancestor.
"},{"location":"api/java/cdk-graph/index.html#newparentrequired_12","title":"newParent
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatemove_6","title":"
- Type: Node
mutateMove
","text":"public void mutateMove(Node newParent)\n
Move this node into a new parent node.
"},{"location":"api/java/cdk-graph/index.html#newparentrequired_13","title":"newParent
Required","text":"
- Type: Node
The parent to move this node to.
"},{"location":"api/java/cdk-graph/index.html#mutateremovechild_6","title":"mutateRemoveChild
","text":"public java.lang.Boolean mutateRemoveChild(Node node)\n
Remove a child node from this node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_63","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateremovelink_6","title":"
- Type: Node
mutateRemoveLink
","text":"public java.lang.Boolean mutateRemoveLink(Edge link)\n
Remove a link from this node.
"},{"location":"api/java/cdk-graph/index.html#linkrequired_12","title":"link
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateremovereverselink_6","title":"
- Type: Edge
mutateRemoveReverseLink
","text":"public java.lang.Boolean mutateRemoveReverseLink(Edge link)\n
Remove a link to this node.
"},{"location":"api/java/cdk-graph/index.html#linkrequired_13","title":"link
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateuncluster_6","title":"
- Type: Edge
mutateUncluster
","text":"public void mutateUncluster()\n
Hoist all children to parent and collapse node to parent.
"},{"location":"api/java/cdk-graph/index.html#tostring_12","title":"toString
","text":"public java.lang.String toString()\n
Get string representation of this node.
"},{"location":"api/java/cdk-graph/index.html#mutatecfnresource","title":"mutateCfnResource
","text":"public void mutateCfnResource()\npublic void mutateCfnResource(CfnResourceNode cfnResource)\n
Modifies the L1 resource wrapped by this L2 resource.
"},{"location":"api/java/cdk-graph/index.html#cfnresourceoptional","title":"cfnResource
Optional","text":""},{"location":"api/java/cdk-graph/index.html#static-functions_12","title":"Static Functions","text":"Name Description
- Type: CfnResourceNode
isResourceNode
Indicates if node is a {@link ResourceNode}."},{"location":"api/java/cdk-graph/index.html#isresourcenode","title":"isResourceNode
","text":"import software.aws.pdk.cdk_graph.ResourceNode;\n\nResourceNode.isResourceNode(Node node)\n
Indicates if node is a {@link ResourceNode}.
"},{"location":"api/java/cdk-graph/index.html#noderequired_64","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#properties_28","title":"Properties","text":"Name Type Description
- Type: Node
attributes
java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>> 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 aaws-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."},{"location":"api/java/cdk-graph/index.html#attributesrequired_12","title":"attributes
Required","text":"public java.lang.Object getAttributes();\n
- Type: java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>>
Get readonly record of all attributes.
"},{"location":"api/java/cdk-graph/index.html#flagsrequired_12","title":"flags
Required","text":"public java.util.List<FlagEnum> getFlags();\n
- Type: java.util.List<FlagEnum>
Get readonly list of all flags.
"},{"location":"api/java/cdk-graph/index.html#isdestroyedrequired_12","title":"isDestroyed
Required","text":"public java.lang.Boolean getIsDestroyed();\n
- Type: java.lang.Boolean
Indicates if the entity has been destroyed (eg: removed from store).
"},{"location":"api/java/cdk-graph/index.html#ismutatedrequired_12","title":"isMutated
Required","text":"public java.lang.Boolean getIsMutated();\n
- Type: java.lang.Boolean
Indicates if the entity has had destructive mutations applied.
"},{"location":"api/java/cdk-graph/index.html#metadatarequired_12","title":"metadata
Required","text":"public java.util.List<MetadataEntry> getMetadata();\n
- Type: java.util.List
Get readonly list of all metadata entries.
"},{"location":"api/java/cdk-graph/index.html#storerequired_15","title":"store
Required","text":"public Store getStore();\n
- Type: Store
Reference to the store.
"},{"location":"api/java/cdk-graph/index.html#tagsrequired_12","title":"tags
Required","text":"public java.util.Map<java.lang.String, java.lang.String> getTags();\n
- Type: java.util.Map
Get readonly record of all tags.
"},{"location":"api/java/cdk-graph/index.html#uuidrequired_17","title":"uuid
Required","text":"public java.lang.String getUuid();\n
- Type: java.lang.String
Universally unique identifier.
"},{"location":"api/java/cdk-graph/index.html#allowdestructivemutationsrequired_11","title":"allowDestructiveMutations
Required","text":"public java.lang.Boolean getAllowDestructiveMutations();\n
- Type: java.lang.Boolean
Indicates if this node allows destructive mutations.
{@link Store.allowDestructiveMutations }
"},{"location":"api/java/cdk-graph/index.html#childrenrequired_6","title":"children
Required","text":"public java.util.List<Node> getChildren();\n
- Type: java.util.List<Node>
Get all direct child nodes.
"},{"location":"api/java/cdk-graph/index.html#dependedonbyrequired_6","title":"dependedOnBy
Required","text":"public java.util.List<Node> getDependedOnBy();\n
- Type: java.util.List<Node>
Get list of Nodes that depend on this node.
{@link Node.reverseDependencyLinks }
"},{"location":"api/java/cdk-graph/index.html#dependenciesrequired_7","title":"dependencies
Required","text":"public java.util.List<Node> getDependencies();\n
- Type: java.util.List<Node>
Get list of Nodes that this node depends on.
{@link Node.dependencyLinks }
"},{"location":"api/java/cdk-graph/index.html#dependencylinksrequired_6","title":"dependencyLinks
Required","text":"public java.util.List<Dependency> getDependencyLinks();\n
- Type: java.util.List<Dependency>
Gets list of {@link Dependency} links (edges) where this node is the source.
"},{"location":"api/java/cdk-graph/index.html#depthrequired_6","title":"depth
Required","text":"public java.lang.Number getDepth();\n
- Type: java.lang.Number
Indicates the depth of the node relative to root (0).
"},{"location":"api/java/cdk-graph/index.html#idrequired_26","title":"id
Required","text":"public java.lang.String getId();\n
- Type: java.lang.String
Node id, which is only unique within parent scope.
"},{"location":"api/java/cdk-graph/index.html#isassetrequired_6","title":"isAsset
Required","text":"public java.lang.Boolean getIsAsset();\n
- Type: java.lang.Boolean
Indicates if this node is considered a {@link FlagEnum.ASSET}.
"},{"location":"api/java/cdk-graph/index.html#iscfnfqnrequired_6","title":"isCfnFqn
Required","text":"public java.lang.Boolean getIsCfnFqn();\n
- Type: java.lang.Boolean
Indicates if node ConstructInfoFqn denotes a
aws-cdk-lib.*.Cfn*
construct.{@link FlagEnum.CFN_FQN }
"},{"location":"api/java/cdk-graph/index.html#isclusterrequired_6","title":"isCluster
Required","text":"public java.lang.Boolean getIsCluster();\n
- Type: java.lang.Boolean
Indicates if this node is considered a {@link FlagEnum.CLUSTER}.
"},{"location":"api/java/cdk-graph/index.html#iscustomresourcerequired_6","title":"isCustomResource
Required","text":"public java.lang.Boolean getIsCustomResource();\n
- Type: java.lang.Boolean
Indicates if node is a Custom Resource.
"},{"location":"api/java/cdk-graph/index.html#isextraneousrequired_11","title":"isExtraneous
Required","text":"public java.lang.Boolean getIsExtraneous();\n
- 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.
"},{"location":"api/java/cdk-graph/index.html#isgraphcontainerrequired_6","title":"isGraphContainer
Required","text":"public java.lang.Boolean getIsGraphContainer();\n
- Type: java.lang.Boolean
Indicates if this node is considered a {@link FlagEnum.GRAPH_CONTAINER}.
"},{"location":"api/java/cdk-graph/index.html#isleafrequired_6","title":"isLeaf
Required","text":"public java.lang.Boolean getIsLeaf();\n
- Type: java.lang.Boolean
Indicates if this node is a leaf node, which means it does not have children.
"},{"location":"api/java/cdk-graph/index.html#istoplevelrequired_6","title":"isTopLevel
Required","text":"public java.lang.Boolean getIsTopLevel();\n
- Type: java.lang.Boolean
Indicates if node is direct child of the graph root node.
"},{"location":"api/java/cdk-graph/index.html#linksrequired_6","title":"links
Required","text":"public java.util.List<Edge> getLinks();\n
- Type: java.util.List<Edge>
Gets all links (edges) in which this node is the source.
"},{"location":"api/java/cdk-graph/index.html#nodetyperequired_7","title":"nodeType
Required","text":"public NodeTypeEnum getNodeType();\n
- Type: NodeTypeEnum
Type of node.
"},{"location":"api/java/cdk-graph/index.html#pathrequired_8","title":"path
Required","text":"public java.lang.String getPath();\n
- Type: java.lang.String
Path of the node.
"},{"location":"api/java/cdk-graph/index.html#referencedbyrequired_6","title":"referencedBy
Required","text":"public java.util.List<Node> getReferencedBy();\n
- Type: java.util.List<Node>
Get list of Nodes that reference this node.
{@link Node.reverseReferenceLinks }
"},{"location":"api/java/cdk-graph/index.html#referencelinksrequired_6","title":"referenceLinks
Required","text":"public java.util.List<Reference> getReferenceLinks();\n
- Type: java.util.List<Reference>
Gets list of {@link Reference} links (edges) where this node is the source.
"},{"location":"api/java/cdk-graph/index.html#referencesrequired_6","title":"references
Required","text":"public java.util.List<Node> getReferences();\n
- Type: java.util.List<Node>
Get list of Nodes that this node references.
{@link Node.referenceLinks }
"},{"location":"api/java/cdk-graph/index.html#reversedependencylinksrequired_6","title":"reverseDependencyLinks
Required","text":"public java.util.List<Dependency> getReverseDependencyLinks();\n
- Type: java.util.List<Dependency>
Gets list of {@link Dependency} links (edges) where this node is the target.
"},{"location":"api/java/cdk-graph/index.html#reverselinksrequired_6","title":"reverseLinks
Required","text":"public java.util.List<Edge> getReverseLinks();\n
- Type: java.util.List<Edge>
Gets all links (edges) in which this node is the target.
"},{"location":"api/java/cdk-graph/index.html#reversereferencelinksrequired_6","title":"reverseReferenceLinks
Required","text":"public java.util.List<Reference> getReverseReferenceLinks();\n
- Type: java.util.List<Reference>
Gets list of {@link Reference} links (edges) where this node is the target.
"},{"location":"api/java/cdk-graph/index.html#scopesrequired_6","title":"scopes
Required","text":"public java.util.List<Node> getScopes();\n
- Type: java.util.List<Node>
Gets descending ordered list of ancestors from the root.
"},{"location":"api/java/cdk-graph/index.html#siblingsrequired_6","title":"siblings
Required","text":"public java.util.List<Node> getSiblings();\n
- Type: java.util.List<Node>
Get list of siblings of this node.
"},{"location":"api/java/cdk-graph/index.html#cfnpropsoptional_6","title":"cfnProps
Optional","text":"public PlainObject getCfnProps();\n
- Type: PlainObject
Get the cfn properties from the L1 resource that this L2 resource wraps.
"},{"location":"api/java/cdk-graph/index.html#cfntypeoptional_8","title":"cfnType
Optional","text":"public java.lang.String getCfnType();\n
- Type: java.lang.String
Get the CloudFormation resource type for this L2 resource or for the L1 resource is wraps.
"},{"location":"api/java/cdk-graph/index.html#constructinfooptional_8","title":"constructInfo
Optional","text":"public ConstructInfo getConstructInfo();\n
- Type: ConstructInfo
Synthesized construct information defining jii resolution data.
"},{"location":"api/java/cdk-graph/index.html#constructinfofqnoptional_6","title":"constructInfoFqn
Optional","text":"public java.lang.String getConstructInfoFqn();\n
- Type: java.lang.String
Synthesized construct information defining jii resolution data.
"},{"location":"api/java/cdk-graph/index.html#logicalidoptional_8","title":"logicalId
Optional","text":"public java.lang.String getLogicalId();\n
- Type: java.lang.String
Logical id of the node, which is only unique within containing stack.
"},{"location":"api/java/cdk-graph/index.html#parentoptional_7","title":"parent
Optional","text":"public Node getParent();\n
- Type: Node
Parent node.
Only the root node should not have parent.
"},{"location":"api/java/cdk-graph/index.html#rootstackoptional_6","title":"rootStack
Optional","text":"public StackNode getRootStack();\n
- Type: StackNode
Get root stack.
"},{"location":"api/java/cdk-graph/index.html#stackoptional_7","title":"stack
Optional","text":"public StackNode getStack();\n
- Type: StackNode
Stack the node is contained in.
"},{"location":"api/java/cdk-graph/index.html#iscdkownedrequired","title":"isCdkOwned
Required","text":"public java.lang.Boolean getIsCdkOwned();\n
- Type: java.lang.Boolean
Indicates if this resource is owned by cdk (defined in cdk library).
"},{"location":"api/java/cdk-graph/index.html#iswrapperrequired","title":"isWrapper
Required","text":"public java.lang.Boolean getIsWrapper();\n
- Type: java.lang.Boolean
Indicates if Resource wraps a single CfnResource.
"},{"location":"api/java/cdk-graph/index.html#cfnresourceoptional_1","title":"cfnResource
Optional","text":"public CfnResourceNode getCfnResource();\n
- Type: CfnResourceNode
Get the default/primary CfnResource that this Resource wraps.
"},{"location":"api/java/cdk-graph/index.html#constants_9","title":"Constants","text":"Name Type DescriptionATT_WRAPPED_CFN_PROPS
java.lang.String
Attribute key for cfn properties.ATT_WRAPPED_CFN_TYPE
java.lang.String
Attribute key for cfn resource type."},{"location":"api/java/cdk-graph/index.html#att_wrapped_cfn_propsrequired","title":"ATT_WRAPPED_CFN_PROPS
Required","text":"public java.lang.String getAttWrappedCfnProps();\n
- Type: java.lang.String
Attribute key for cfn properties.
"},{"location":"api/java/cdk-graph/index.html#att_wrapped_cfn_typerequired","title":"ATT_WRAPPED_CFN_TYPE
Required","text":"public java.lang.String getAttWrappedCfnType();\n
- Type: java.lang.String
Attribute key for cfn resource type.
"},{"location":"api/java/cdk-graph/index.html#rootnode","title":"RootNode","text":"RootNode represents the root of the store tree.
"},{"location":"api/java/cdk-graph/index.html#initializers_16","title":"Initializers","text":"Name Type Descriptionimport software.aws.pdk.cdk_graph.RootNode;\n\nnew RootNode(Store store);\n
store
Store
Reference to the store."},{"location":"api/java/cdk-graph/index.html#storerequired_16","title":"store
Required","text":"
- Type: Store
Reference to the store.
"},{"location":"api/java/cdk-graph/index.html#methods_15","title":"Methods","text":"Name DescriptionaddAttribute
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."},{"location":"api/java/cdk-graph/index.html#addattribute_13","title":"addAttribute
","text":"public void addAttribute(java.lang.String key, java.lang.Object value)\n
Add attribute.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_111","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_55","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#addflag_13","title":"
- Type: java.lang.Object
addFlag
","text":"public void addFlag(FlagEnum flag)\n
Add flag.
"},{"location":"api/java/cdk-graph/index.html#flagrequired_26","title":"flag
Required","text":""},{"location":"api/java/cdk-graph/index.html#addmetadata_13","title":"
- Type: FlagEnum
addMetadata
","text":"public void addMetadata(java.lang.String metadataType, java.lang.Object data)\n
Add metadata entry.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_39","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#datarequired_40","title":"
- Type: java.lang.String
data
Required","text":""},{"location":"api/java/cdk-graph/index.html#addtag_13","title":"
- Type: java.lang.Object
addTag
","text":"public void addTag(java.lang.String key, java.lang.String value)\n
Add tag.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_112","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_56","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#applydata_13","title":"
- Type: java.lang.String
applyData
","text":"public void applyData(IBaseEntityDataProps data)\npublic void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite)\npublic void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite, java.lang.Boolean applyFlags)\n
Applies data (attributes, metadata, tags, flag) to entity.
Generally used only for mutations such as collapse and consume to retain data.
"},{"location":"api/java/cdk-graph/index.html#datarequired_41","title":"data
Required","text":"
- Type: IBaseEntityDataProps
The data to apply.
"},{"location":"api/java/cdk-graph/index.html#overwriteoptional_13","title":"overwrite
Optional","text":""},{"location":"api/java/cdk-graph/index.html#applyflagsoptional_13","title":"
- Type: java.lang.Boolean
applyFlags
Optional","text":"
- Type: java.lang.Boolean
Indicates if data is overwritten - Indicates if flags should be applied.
"},{"location":"api/java/cdk-graph/index.html#findmetadata_13","title":"findMetadata
","text":"public java.util.List<MetadataEntry> findMetadata(java.lang.String metadataType)\n
Retrieves all metadata entries of a given type.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_40","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#getattribute_13","title":"
- Type: java.lang.String
getAttribute
","text":"public java.lang.Object getAttribute(java.lang.String key)\n
Get attribute by key.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_113","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#gettag_13","title":"
- Type: java.lang.String
getTag
","text":"public java.lang.String getTag(java.lang.String key)\n
Get tag by key.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_114","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#hasattribute_13","title":"
- Type: java.lang.String
hasAttribute
","text":"public java.lang.Boolean hasAttribute(java.lang.String key)\npublic java.lang.Boolean hasAttribute(java.lang.String key, java.lang.Object value)\n
Indicates if entity has a given attribute defined, and optionally with a specific value.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_115","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valueoptional_28","title":"
- Type: java.lang.String
value
Optional","text":""},{"location":"api/java/cdk-graph/index.html#hasflag_13","title":"
- Type: java.lang.Object
hasFlag
","text":"public java.lang.Boolean hasFlag(FlagEnum flag)\n
Indicates if entity has a given flag.
"},{"location":"api/java/cdk-graph/index.html#flagrequired_27","title":"flag
Required","text":""},{"location":"api/java/cdk-graph/index.html#hasmetadata_13","title":"
- Type: FlagEnum
hasMetadata
","text":"public java.lang.Boolean hasMetadata(java.lang.String metadataType, java.lang.Object data)\n
Indicates if entity has matching metadata entry.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_41","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#datarequired_42","title":"
- Type: java.lang.String
data
Required","text":""},{"location":"api/java/cdk-graph/index.html#hastag_13","title":"
- Type: java.lang.Object
hasTag
","text":"public java.lang.Boolean hasTag(java.lang.String key)\npublic java.lang.Boolean hasTag(java.lang.String key, java.lang.String value)\n
Indicates if entity has tag, optionally verifying tag value.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_116","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valueoptional_29","title":"
- Type: java.lang.String
value
Optional","text":""},{"location":"api/java/cdk-graph/index.html#mutatedestroy_13","title":"
- Type: java.lang.String
mutateDestroy
","text":"public void mutateDestroy()\npublic void mutateDestroy(java.lang.Boolean _strict)\n
Destroys this node by removing all references and removing this node from the store.
{@link RootNode} does not support this mutation
"},{"location":"api/java/cdk-graph/index.html#_strictoptional_5","title":"_strict
Optional","text":""},{"location":"api/java/cdk-graph/index.html#setattribute_13","title":"
- Type: java.lang.Boolean
setAttribute
","text":"public void setAttribute(java.lang.String key, java.lang.Object value)\n
Set attribute.
This will overwrite existing attribute.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_117","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_57","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#settag_13","title":"
- Type: java.lang.Object
setTag
","text":"public void setTag(java.lang.String key, java.lang.String value)\n
Set tag.
Will overwrite existing tag.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_118","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_58","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#addchild_7","title":"
- Type: java.lang.String
addChild
","text":"public void addChild(Node node)\n
Add child node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_65","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#addlink_7","title":"
- Type: Node
addLink
","text":"public void addLink(Edge edge)\n
Add link to another node.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_33","title":"edge
Required","text":""},{"location":"api/java/cdk-graph/index.html#addreverselink_7","title":"
- Type: Edge
addReverseLink
","text":"public void addReverseLink(Edge edge)\n
Add link from another node.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_34","title":"edge
Required","text":""},{"location":"api/java/cdk-graph/index.html#doesdependon_7","title":"
- Type: Edge
doesDependOn
","text":"public java.lang.Boolean doesDependOn(Node node)\n
Indicates if this node depends on another node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_66","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#doesreference_7","title":"
- Type: Node
doesReference
","text":"public java.lang.Boolean doesReference(Node node)\n
Indicates if this node references another node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_67","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#find_7","title":"
- Type: Node
find
","text":"public Node find(INodePredicate predicate)\n
Recursively find the nearest sub-node matching predicate.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_38","title":"predicate
Required","text":""},{"location":"api/java/cdk-graph/index.html#findall_7","title":"
- Type: INodePredicate
findAll
","text":"public java.util.List<Node> findAll()\npublic java.util.List<Node> findAll(IFindNodeOptions options)\n
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
"},{"location":"api/java/cdk-graph/index.html#optionsoptional_14","title":"options
Optional","text":""},{"location":"api/java/cdk-graph/index.html#findalllinks_7","title":"
- Type: IFindNodeOptions
findAllLinks
","text":"public java.util.List<Edge> findAllLinks()\npublic java.util.List<Edge> findAllLinks(IFindEdgeOptions options)\n
Return all direct links of this node and that of all sub-nodes.
Optionally filter links based on predicate.
"},{"location":"api/java/cdk-graph/index.html#optionsoptional_15","title":"options
Optional","text":""},{"location":"api/java/cdk-graph/index.html#findancestor_7","title":"
- Type: IFindEdgeOptions
findAncestor
","text":"public Node findAncestor(INodePredicate predicate)\npublic Node findAncestor(INodePredicate predicate, java.lang.Number max)\n
Find nearest ancestor of this node matching given predicate.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_39","title":"predicate
Required","text":"
- Type: INodePredicate
Predicate to match ancestor.
"},{"location":"api/java/cdk-graph/index.html#maxoptional_7","title":"max
Optional","text":""},{"location":"api/java/cdk-graph/index.html#findchild_7","title":"
- Type: java.lang.Number
findChild
","text":"public Node findChild(java.lang.String id)\n
Find child with given id.
Similar to
"},{"location":"api/java/cdk-graph/index.html#idrequired_27","title":"find
but does not throw error if no child found.id
Required","text":""},{"location":"api/java/cdk-graph/index.html#findlink_7","title":"
- Type: java.lang.String
findLink
","text":"public Edge findLink(IEdgePredicate predicate)\npublic Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse)\npublic Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow)\npublic Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow, java.lang.Boolean direct)\n
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.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_40","title":"predicate
Required","text":"
- Type: IEdgePredicate
Edge predicate function to match edge.
"},{"location":"api/java/cdk-graph/index.html#reverseoptional_21","title":"reverse
Optional","text":"
- Type: java.lang.Boolean
Indicates if links are search in reverse order.
"},{"location":"api/java/cdk-graph/index.html#followoptional_14","title":"follow
Optional","text":"
- Type: java.lang.Boolean
Indicates if link chain is followed.
"},{"location":"api/java/cdk-graph/index.html#directoptional_14","title":"direct
Optional","text":"
- Type: java.lang.Boolean
Indicates that only direct links should be searched.
"},{"location":"api/java/cdk-graph/index.html#findlinks_7","title":"findLinks
","text":"public java.util.List<Edge> findLinks(IEdgePredicate predicate)\npublic java.util.List<Edge> findLinks(IEdgePredicate predicate, java.lang.Boolean reverse)\npublic java.util.List<Edge> findLinks(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow)\npublic java.util.List<Edge> findLinks(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow, java.lang.Boolean direct)\n
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.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_41","title":"predicate
Required","text":"
- Type: IEdgePredicate
Edge predicate function to match edge.
"},{"location":"api/java/cdk-graph/index.html#reverseoptional_22","title":"reverse
Optional","text":"
- Type: java.lang.Boolean
Indicates if links are search in reverse order.
"},{"location":"api/java/cdk-graph/index.html#followoptional_15","title":"follow
Optional","text":"
- Type: java.lang.Boolean
Indicates if link chain is followed.
"},{"location":"api/java/cdk-graph/index.html#directoptional_15","title":"direct
Optional","text":"
- Type: java.lang.Boolean
Indicates that only direct links should be searched.
"},{"location":"api/java/cdk-graph/index.html#getcfnprop_7","title":"getCfnProp
","text":"public java.lang.String OR java.lang.Number OR java.lang.Boolean OR PlainObject OR java.util.List<java.lang.String OR java.lang.Number OR java.lang.Boolean OR PlainObject> getCfnProp(java.lang.String key)\n
Get specific CloudFormation property.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_119","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#getchild_7","title":"
- Type: java.lang.String
getChild
","text":"public Node getChild(java.lang.String id)\n
Get child node with given id.
"},{"location":"api/java/cdk-graph/index.html#idrequired_28","title":"id
Required","text":""},{"location":"api/java/cdk-graph/index.html#getlinkchains_7","title":"
- Type: java.lang.String
getLinkChains
","text":"public java.util.List<java.util.List<java.lang.Object>> getLinkChains()\npublic java.util.List<java.util.List<java.lang.Object>> getLinkChains(java.lang.Boolean reverse)\n
Resolve all link chains.
{@link EdgeChain }
"},{"location":"api/java/cdk-graph/index.html#reverseoptional_23","title":"reverse
Optional","text":""},{"location":"api/java/cdk-graph/index.html#getnearestancestor_7","title":"
- Type: java.lang.Boolean
getNearestAncestor
","text":"public Node getNearestAncestor(Node node)\n
Gets the nearest common ancestor shared between this node and another node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_68","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#isancestor_7","title":"
- Type: Node
isAncestor
","text":"public java.lang.Boolean isAncestor(Node ancestor)\n
Indicates if a specific node is an ancestor of this node.
"},{"location":"api/java/cdk-graph/index.html#ancestorrequired_14","title":"ancestor
Required","text":""},{"location":"api/java/cdk-graph/index.html#ischild_7","title":"
- Type: Node
isChild
","text":"public java.lang.Boolean isChild(Node node)\n
Indicates if specific node is a child of this node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_69","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatecollapse_7","title":"
- Type: Node
mutateCollapse
","text":"public void mutateCollapse()\n
Collapses all sub-nodes of this node into this node.
{@link RootNode} does not support this mutation
"},{"location":"api/java/cdk-graph/index.html#mutatecollapseto_7","title":"mutateCollapseTo
","text":"public Node mutateCollapseTo(Node _ancestor)\n
Collapses this node into an ancestor > {@link RootNode} does not support this mutation.
"},{"location":"api/java/cdk-graph/index.html#_ancestorrequired","title":"_ancestor
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatecollapsetoparent_7","title":"
- Type: Node
mutateCollapseToParent
","text":"public Node mutateCollapseToParent()\n
Collapses this node into it's parent node > {@link RootNode} does not support this mutation.
"},{"location":"api/java/cdk-graph/index.html#mutatehoist_7","title":"mutateHoist
","text":"public void mutateHoist(Node _newParent)\n
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
"},{"location":"api/java/cdk-graph/index.html#_newparentrequired","title":"_newParent
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatemove_7","title":"
- Type: Node
mutateMove
","text":"public void mutateMove(Node newParent)\n
Move this node into a new parent node.
"},{"location":"api/java/cdk-graph/index.html#newparentrequired_14","title":"newParent
Required","text":"
- Type: Node
The parent to move this node to.
"},{"location":"api/java/cdk-graph/index.html#mutateremovechild_7","title":"mutateRemoveChild
","text":"public java.lang.Boolean mutateRemoveChild(Node node)\n
Remove a child node from this node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_70","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateremovelink_7","title":"
- Type: Node
mutateRemoveLink
","text":"public java.lang.Boolean mutateRemoveLink(Edge link)\n
Remove a link from this node.
"},{"location":"api/java/cdk-graph/index.html#linkrequired_14","title":"link
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateremovereverselink_7","title":"
- Type: Edge
mutateRemoveReverseLink
","text":"public java.lang.Boolean mutateRemoveReverseLink(Edge link)\n
Remove a link to this node.
"},{"location":"api/java/cdk-graph/index.html#linkrequired_15","title":"link
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateuncluster_7","title":"
- Type: Edge
mutateUncluster
","text":"public void mutateUncluster()\n
Hoist all children to parent and collapse node to parent.
"},{"location":"api/java/cdk-graph/index.html#tostring_13","title":"toString
","text":"public java.lang.String toString()\n
Get string representation of this node.
"},{"location":"api/java/cdk-graph/index.html#static-functions_13","title":"Static Functions","text":"Name DescriptionisRootNode
Indicates if node is a {@link RootNode}."},{"location":"api/java/cdk-graph/index.html#isrootnode","title":"isRootNode
","text":"import software.aws.pdk.cdk_graph.RootNode;\n\nRootNode.isRootNode(Node node)\n
Indicates if node is a {@link RootNode}.
"},{"location":"api/java/cdk-graph/index.html#noderequired_71","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#properties_29","title":"Properties","text":"Name Type Description
- Type: Node
attributes
java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>> 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 aaws-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."},{"location":"api/java/cdk-graph/index.html#attributesrequired_13","title":"attributes
Required","text":"public java.lang.Object getAttributes();\n
- Type: java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>>
Get readonly record of all attributes.
"},{"location":"api/java/cdk-graph/index.html#flagsrequired_13","title":"flags
Required","text":"public java.util.List<FlagEnum> getFlags();\n
- Type: java.util.List<FlagEnum>
Get readonly list of all flags.
"},{"location":"api/java/cdk-graph/index.html#isdestroyedrequired_13","title":"isDestroyed
Required","text":"public java.lang.Boolean getIsDestroyed();\n
- Type: java.lang.Boolean
Indicates if the entity has been destroyed (eg: removed from store).
"},{"location":"api/java/cdk-graph/index.html#ismutatedrequired_13","title":"isMutated
Required","text":"public java.lang.Boolean getIsMutated();\n
- Type: java.lang.Boolean
Indicates if the entity has had destructive mutations applied.
"},{"location":"api/java/cdk-graph/index.html#metadatarequired_13","title":"metadata
Required","text":"public java.util.List<MetadataEntry> getMetadata();\n
- Type: java.util.List
Get readonly list of all metadata entries.
"},{"location":"api/java/cdk-graph/index.html#storerequired_17","title":"store
Required","text":"public Store getStore();\n
- Type: Store
Reference to the store.
"},{"location":"api/java/cdk-graph/index.html#tagsrequired_13","title":"tags
Required","text":"public java.util.Map<java.lang.String, java.lang.String> getTags();\n
- Type: java.util.Map
Get readonly record of all tags.
"},{"location":"api/java/cdk-graph/index.html#uuidrequired_18","title":"uuid
Required","text":"public java.lang.String getUuid();\n
- Type: java.lang.String
Universally unique identifier.
"},{"location":"api/java/cdk-graph/index.html#allowdestructivemutationsrequired_12","title":"allowDestructiveMutations
Required","text":"public java.lang.Boolean getAllowDestructiveMutations();\n
- Type: java.lang.Boolean
Indicates if this node allows destructive mutations.
{@link Store.allowDestructiveMutations }
"},{"location":"api/java/cdk-graph/index.html#childrenrequired_7","title":"children
Required","text":"public java.util.List<Node> getChildren();\n
- Type: java.util.List<Node>
Get all direct child nodes.
"},{"location":"api/java/cdk-graph/index.html#dependedonbyrequired_7","title":"dependedOnBy
Required","text":"public java.util.List<Node> getDependedOnBy();\n
- Type: java.util.List<Node>
Get list of Nodes that depend on this node.
{@link Node.reverseDependencyLinks }
"},{"location":"api/java/cdk-graph/index.html#dependenciesrequired_8","title":"dependencies
Required","text":"public java.util.List<Node> getDependencies();\n
- Type: java.util.List<Node>
Get list of Nodes that this node depends on.
{@link Node.dependencyLinks }
"},{"location":"api/java/cdk-graph/index.html#dependencylinksrequired_7","title":"dependencyLinks
Required","text":"public java.util.List<Dependency> getDependencyLinks();\n
- Type: java.util.List<Dependency>
Gets list of {@link Dependency} links (edges) where this node is the source.
"},{"location":"api/java/cdk-graph/index.html#depthrequired_7","title":"depth
Required","text":"public java.lang.Number getDepth();\n
- Type: java.lang.Number
Indicates the depth of the node relative to root (0).
"},{"location":"api/java/cdk-graph/index.html#idrequired_29","title":"id
Required","text":"public java.lang.String getId();\n
- Type: java.lang.String
Node id, which is only unique within parent scope.
"},{"location":"api/java/cdk-graph/index.html#isassetrequired_7","title":"isAsset
Required","text":"public java.lang.Boolean getIsAsset();\n
- Type: java.lang.Boolean
Indicates if this node is considered a {@link FlagEnum.ASSET}.
"},{"location":"api/java/cdk-graph/index.html#iscfnfqnrequired_7","title":"isCfnFqn
Required","text":"public java.lang.Boolean getIsCfnFqn();\n
- Type: java.lang.Boolean
Indicates if node ConstructInfoFqn denotes a
aws-cdk-lib.*.Cfn*
construct.{@link FlagEnum.CFN_FQN }
"},{"location":"api/java/cdk-graph/index.html#isclusterrequired_7","title":"isCluster
Required","text":"public java.lang.Boolean getIsCluster();\n
- Type: java.lang.Boolean
Indicates if this node is considered a {@link FlagEnum.CLUSTER}.
"},{"location":"api/java/cdk-graph/index.html#iscustomresourcerequired_7","title":"isCustomResource
Required","text":"public java.lang.Boolean getIsCustomResource();\n
- Type: java.lang.Boolean
Indicates if node is a Custom Resource.
"},{"location":"api/java/cdk-graph/index.html#isextraneousrequired_12","title":"isExtraneous
Required","text":"public java.lang.Boolean getIsExtraneous();\n
- 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.
"},{"location":"api/java/cdk-graph/index.html#isgraphcontainerrequired_7","title":"isGraphContainer
Required","text":"public java.lang.Boolean getIsGraphContainer();\n
- Type: java.lang.Boolean
Indicates if this node is considered a {@link FlagEnum.GRAPH_CONTAINER}.
"},{"location":"api/java/cdk-graph/index.html#isleafrequired_7","title":"isLeaf
Required","text":"public java.lang.Boolean getIsLeaf();\n
- Type: java.lang.Boolean
Indicates if this node is a leaf node, which means it does not have children.
"},{"location":"api/java/cdk-graph/index.html#istoplevelrequired_7","title":"isTopLevel
Required","text":"public java.lang.Boolean getIsTopLevel();\n
- Type: java.lang.Boolean
Indicates if node is direct child of the graph root node.
"},{"location":"api/java/cdk-graph/index.html#linksrequired_7","title":"links
Required","text":"public java.util.List<Edge> getLinks();\n
- Type: java.util.List<Edge>
Gets all links (edges) in which this node is the source.
"},{"location":"api/java/cdk-graph/index.html#nodetyperequired_8","title":"nodeType
Required","text":"public NodeTypeEnum getNodeType();\n
- Type: NodeTypeEnum
Type of node.
"},{"location":"api/java/cdk-graph/index.html#pathrequired_9","title":"path
Required","text":"public java.lang.String getPath();\n
- Type: java.lang.String
Path of the node.
"},{"location":"api/java/cdk-graph/index.html#referencedbyrequired_7","title":"referencedBy
Required","text":"public java.util.List<Node> getReferencedBy();\n
- Type: java.util.List<Node>
Get list of Nodes that reference this node.
{@link Node.reverseReferenceLinks }
"},{"location":"api/java/cdk-graph/index.html#referencelinksrequired_7","title":"referenceLinks
Required","text":"public java.util.List<Reference> getReferenceLinks();\n
- Type: java.util.List<Reference>
Gets list of {@link Reference} links (edges) where this node is the source.
"},{"location":"api/java/cdk-graph/index.html#referencesrequired_7","title":"references
Required","text":"public java.util.List<Node> getReferences();\n
- Type: java.util.List<Node>
Get list of Nodes that this node references.
{@link Node.referenceLinks }
"},{"location":"api/java/cdk-graph/index.html#reversedependencylinksrequired_7","title":"reverseDependencyLinks
Required","text":"public java.util.List<Dependency> getReverseDependencyLinks();\n
- Type: java.util.List<Dependency>
Gets list of {@link Dependency} links (edges) where this node is the target.
"},{"location":"api/java/cdk-graph/index.html#reverselinksrequired_7","title":"reverseLinks
Required","text":"public java.util.List<Edge> getReverseLinks();\n
- Type: java.util.List<Edge>
Gets all links (edges) in which this node is the target.
"},{"location":"api/java/cdk-graph/index.html#reversereferencelinksrequired_7","title":"reverseReferenceLinks
Required","text":"public java.util.List<Reference> getReverseReferenceLinks();\n
- Type: java.util.List<Reference>
Gets list of {@link Reference} links (edges) where this node is the target.
"},{"location":"api/java/cdk-graph/index.html#scopesrequired_7","title":"scopes
Required","text":"public java.util.List<Node> getScopes();\n
- Type: java.util.List<Node>
Gets descending ordered list of ancestors from the root.
"},{"location":"api/java/cdk-graph/index.html#siblingsrequired_7","title":"siblings
Required","text":"public java.util.List<Node> getSiblings();\n
- Type: java.util.List<Node>
Get list of siblings of this node.
"},{"location":"api/java/cdk-graph/index.html#cfnpropsoptional_7","title":"cfnProps
Optional","text":"public PlainObject getCfnProps();\n
- Type: PlainObject
Gets CloudFormation properties for this node.
"},{"location":"api/java/cdk-graph/index.html#cfntypeoptional_9","title":"cfnType
Optional","text":"public java.lang.String getCfnType();\n
- Type: java.lang.String
Get the CloudFormation resource type for this node.
"},{"location":"api/java/cdk-graph/index.html#constructinfooptional_9","title":"constructInfo
Optional","text":"public ConstructInfo getConstructInfo();\n
- Type: ConstructInfo
Synthesized construct information defining jii resolution data.
"},{"location":"api/java/cdk-graph/index.html#constructinfofqnoptional_7","title":"constructInfoFqn
Optional","text":"public java.lang.String getConstructInfoFqn();\n
- Type: java.lang.String
Synthesized construct information defining jii resolution data.
"},{"location":"api/java/cdk-graph/index.html#logicalidoptional_9","title":"logicalId
Optional","text":"public java.lang.String getLogicalId();\n
- Type: java.lang.String
Logical id of the node, which is only unique within containing stack.
"},{"location":"api/java/cdk-graph/index.html#parentoptional_8","title":"parent
Optional","text":"public Node getParent();\n
- Type: Node
Parent node.
Only the root node should not have parent.
"},{"location":"api/java/cdk-graph/index.html#rootstackoptional_7","title":"rootStack
Optional","text":"public StackNode getRootStack();\n
- Type: StackNode
Get root stack.
"},{"location":"api/java/cdk-graph/index.html#stackoptional_8","title":"stack
Optional","text":"public StackNode getStack();\n
- Type: StackNode
Stack the node is contained in.
"},{"location":"api/java/cdk-graph/index.html#constants_10","title":"Constants","text":"Name Type DescriptionPATH
java.lang.String
Fixed path of root.UUID
java.lang.String
Fixed UUID of root."},{"location":"api/java/cdk-graph/index.html#pathrequired_10","title":"PATH
Required","text":"public java.lang.String getPath();\n
- Type: java.lang.String
Fixed path of root.
"},{"location":"api/java/cdk-graph/index.html#uuidrequired_19","title":"UUID
Required","text":"public java.lang.String getUuid();\n
- Type: java.lang.String
Fixed UUID of root.
"},{"location":"api/java/cdk-graph/index.html#stacknode","title":"StackNode","text":"StackNode defines a cdk Stack.
"},{"location":"api/java/cdk-graph/index.html#initializers_17","title":"Initializers","text":"Name Type Descriptionimport software.aws.pdk.cdk_graph.StackNode;\n\nnew StackNode(IStackNodeProps props);\n
props
IStackNodeProps
No description."},{"location":"api/java/cdk-graph/index.html#propsrequired_13","title":"props
Required","text":""},{"location":"api/java/cdk-graph/index.html#methods_16","title":"Methods","text":"Name Description
- Type: IStackNodeProps
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."},{"location":"api/java/cdk-graph/index.html#addattribute_14","title":"addAttribute
","text":"public void addAttribute(java.lang.String key, java.lang.Object value)\n
Add attribute.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_120","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_59","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#addflag_14","title":"
- Type: java.lang.Object
addFlag
","text":"public void addFlag(FlagEnum flag)\n
Add flag.
"},{"location":"api/java/cdk-graph/index.html#flagrequired_28","title":"flag
Required","text":""},{"location":"api/java/cdk-graph/index.html#addmetadata_14","title":"
- Type: FlagEnum
addMetadata
","text":"public void addMetadata(java.lang.String metadataType, java.lang.Object data)\n
Add metadata entry.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_42","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#datarequired_43","title":"
- Type: java.lang.String
data
Required","text":""},{"location":"api/java/cdk-graph/index.html#addtag_14","title":"
- Type: java.lang.Object
addTag
","text":"public void addTag(java.lang.String key, java.lang.String value)\n
Add tag.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_121","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_60","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#applydata_14","title":"
- Type: java.lang.String
applyData
","text":"public void applyData(IBaseEntityDataProps data)\npublic void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite)\npublic void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite, java.lang.Boolean applyFlags)\n
Applies data (attributes, metadata, tags, flag) to entity.
Generally used only for mutations such as collapse and consume to retain data.
"},{"location":"api/java/cdk-graph/index.html#datarequired_44","title":"data
Required","text":"
- Type: IBaseEntityDataProps
The data to apply.
"},{"location":"api/java/cdk-graph/index.html#overwriteoptional_14","title":"overwrite
Optional","text":""},{"location":"api/java/cdk-graph/index.html#applyflagsoptional_14","title":"
- Type: java.lang.Boolean
applyFlags
Optional","text":"
- Type: java.lang.Boolean
Indicates if data is overwritten - Indicates if flags should be applied.
"},{"location":"api/java/cdk-graph/index.html#findmetadata_14","title":"findMetadata
","text":"public java.util.List<MetadataEntry> findMetadata(java.lang.String metadataType)\n
Retrieves all metadata entries of a given type.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_43","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#getattribute_14","title":"
- Type: java.lang.String
getAttribute
","text":"public java.lang.Object getAttribute(java.lang.String key)\n
Get attribute by key.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_122","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#gettag_14","title":"
- Type: java.lang.String
getTag
","text":"public java.lang.String getTag(java.lang.String key)\n
Get tag by key.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_123","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#hasattribute_14","title":"
- Type: java.lang.String
hasAttribute
","text":"public java.lang.Boolean hasAttribute(java.lang.String key)\npublic java.lang.Boolean hasAttribute(java.lang.String key, java.lang.Object value)\n
Indicates if entity has a given attribute defined, and optionally with a specific value.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_124","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valueoptional_30","title":"
- Type: java.lang.String
value
Optional","text":""},{"location":"api/java/cdk-graph/index.html#hasflag_14","title":"
- Type: java.lang.Object
hasFlag
","text":"public java.lang.Boolean hasFlag(FlagEnum flag)\n
Indicates if entity has a given flag.
"},{"location":"api/java/cdk-graph/index.html#flagrequired_29","title":"flag
Required","text":""},{"location":"api/java/cdk-graph/index.html#hasmetadata_14","title":"
- Type: FlagEnum
hasMetadata
","text":"public java.lang.Boolean hasMetadata(java.lang.String metadataType, java.lang.Object data)\n
Indicates if entity has matching metadata entry.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_44","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#datarequired_45","title":"
- Type: java.lang.String
data
Required","text":""},{"location":"api/java/cdk-graph/index.html#hastag_14","title":"
- Type: java.lang.Object
hasTag
","text":"public java.lang.Boolean hasTag(java.lang.String key)\npublic java.lang.Boolean hasTag(java.lang.String key, java.lang.String value)\n
Indicates if entity has tag, optionally verifying tag value.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_125","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valueoptional_31","title":"
- Type: java.lang.String
value
Optional","text":""},{"location":"api/java/cdk-graph/index.html#mutatedestroy_14","title":"
- Type: java.lang.String
mutateDestroy
","text":"public void mutateDestroy()\npublic void mutateDestroy(java.lang.Boolean strict)\n
Destroys this node by removing all references and removing this node from the store.
"},{"location":"api/java/cdk-graph/index.html#strictoptional_8","title":"strict
Optional","text":""},{"location":"api/java/cdk-graph/index.html#setattribute_14","title":"
- Type: java.lang.Boolean
setAttribute
","text":"public void setAttribute(java.lang.String key, java.lang.Object value)\n
Set attribute.
This will overwrite existing attribute.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_126","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_61","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#settag_14","title":"
- Type: java.lang.Object
setTag
","text":"public void setTag(java.lang.String key, java.lang.String value)\n
Set tag.
Will overwrite existing tag.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_127","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_62","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#addchild_8","title":"
- Type: java.lang.String
addChild
","text":"public void addChild(Node node)\n
Add child node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_72","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#addlink_8","title":"
- Type: Node
addLink
","text":"public void addLink(Edge edge)\n
Add link to another node.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_35","title":"edge
Required","text":""},{"location":"api/java/cdk-graph/index.html#addreverselink_8","title":"
- Type: Edge
addReverseLink
","text":"public void addReverseLink(Edge edge)\n
Add link from another node.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_36","title":"edge
Required","text":""},{"location":"api/java/cdk-graph/index.html#doesdependon_8","title":"
- Type: Edge
doesDependOn
","text":"public java.lang.Boolean doesDependOn(Node node)\n
Indicates if this node depends on another node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_73","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#doesreference_8","title":"
- Type: Node
doesReference
","text":"public java.lang.Boolean doesReference(Node node)\n
Indicates if this node references another node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_74","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#find_8","title":"
- Type: Node
find
","text":"public Node find(INodePredicate predicate)\n
Recursively find the nearest sub-node matching predicate.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_42","title":"predicate
Required","text":""},{"location":"api/java/cdk-graph/index.html#findall_8","title":"
- Type: INodePredicate
findAll
","text":"public java.util.List<Node> findAll()\npublic java.util.List<Node> findAll(IFindNodeOptions options)\n
Return this construct and all of its sub-nodes in the given order.
Optionally filter nodes based on predicate.
"},{"location":"api/java/cdk-graph/index.html#optionsoptional_16","title":"options
Optional","text":""},{"location":"api/java/cdk-graph/index.html#findalllinks_8","title":"
- Type: IFindNodeOptions
findAllLinks
","text":"public java.util.List<Edge> findAllLinks()\npublic java.util.List<Edge> findAllLinks(IFindEdgeOptions options)\n
Return all direct links of this node and that of all sub-nodes.
Optionally filter links based on predicate.
"},{"location":"api/java/cdk-graph/index.html#optionsoptional_17","title":"options
Optional","text":""},{"location":"api/java/cdk-graph/index.html#findancestor_8","title":"
- Type: IFindEdgeOptions
findAncestor
","text":"public Node findAncestor(INodePredicate predicate)\npublic Node findAncestor(INodePredicate predicate, java.lang.Number max)\n
Find nearest ancestor of this node matching given predicate.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_43","title":"predicate
Required","text":"
- Type: INodePredicate
Predicate to match ancestor.
"},{"location":"api/java/cdk-graph/index.html#maxoptional_8","title":"max
Optional","text":""},{"location":"api/java/cdk-graph/index.html#findchild_8","title":"
- Type: java.lang.Number
findChild
","text":"public Node findChild(java.lang.String id)\n
Find child with given id.
Similar to
"},{"location":"api/java/cdk-graph/index.html#idrequired_30","title":"find
but does not throw error if no child found.id
Required","text":""},{"location":"api/java/cdk-graph/index.html#findlink_8","title":"
- Type: java.lang.String
findLink
","text":"public Edge findLink(IEdgePredicate predicate)\npublic Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse)\npublic Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow)\npublic Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow, java.lang.Boolean direct)\n
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.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_44","title":"predicate
Required","text":"
- Type: IEdgePredicate
Edge predicate function to match edge.
"},{"location":"api/java/cdk-graph/index.html#reverseoptional_24","title":"reverse
Optional","text":"
- Type: java.lang.Boolean
Indicates if links are search in reverse order.
"},{"location":"api/java/cdk-graph/index.html#followoptional_16","title":"follow
Optional","text":"
- Type: java.lang.Boolean
Indicates if link chain is followed.
"},{"location":"api/java/cdk-graph/index.html#directoptional_16","title":"direct
Optional","text":"
- Type: java.lang.Boolean
Indicates that only direct links should be searched.
"},{"location":"api/java/cdk-graph/index.html#findlinks_8","title":"findLinks
","text":"public java.util.List<Edge> findLinks(IEdgePredicate predicate)\npublic java.util.List<Edge> findLinks(IEdgePredicate predicate, java.lang.Boolean reverse)\npublic java.util.List<Edge> findLinks(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow)\npublic java.util.List<Edge> findLinks(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow, java.lang.Boolean direct)\n
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.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_45","title":"predicate
Required","text":"
- Type: IEdgePredicate
Edge predicate function to match edge.
"},{"location":"api/java/cdk-graph/index.html#reverseoptional_25","title":"reverse
Optional","text":"
- Type: java.lang.Boolean
Indicates if links are search in reverse order.
"},{"location":"api/java/cdk-graph/index.html#followoptional_17","title":"follow
Optional","text":"
- Type: java.lang.Boolean
Indicates if link chain is followed.
"},{"location":"api/java/cdk-graph/index.html#directoptional_17","title":"direct
Optional","text":"
- Type: java.lang.Boolean
Indicates that only direct links should be searched.
"},{"location":"api/java/cdk-graph/index.html#getcfnprop_8","title":"getCfnProp
","text":"public java.lang.String OR java.lang.Number OR java.lang.Boolean OR PlainObject OR java.util.List<java.lang.String OR java.lang.Number OR java.lang.Boolean OR PlainObject> getCfnProp(java.lang.String key)\n
Get specific CloudFormation property.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_128","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#getchild_8","title":"
- Type: java.lang.String
getChild
","text":"public Node getChild(java.lang.String id)\n
Get child node with given id.
"},{"location":"api/java/cdk-graph/index.html#idrequired_31","title":"id
Required","text":""},{"location":"api/java/cdk-graph/index.html#getlinkchains_8","title":"
- Type: java.lang.String
getLinkChains
","text":"public java.util.List<java.util.List<java.lang.Object>> getLinkChains()\npublic java.util.List<java.util.List<java.lang.Object>> getLinkChains(java.lang.Boolean reverse)\n
Resolve all link chains.
{@link EdgeChain }
"},{"location":"api/java/cdk-graph/index.html#reverseoptional_26","title":"reverse
Optional","text":""},{"location":"api/java/cdk-graph/index.html#getnearestancestor_8","title":"
- Type: java.lang.Boolean
getNearestAncestor
","text":"public Node getNearestAncestor(Node node)\n
Gets the nearest common ancestor shared between this node and another node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_75","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#isancestor_8","title":"
- Type: Node
isAncestor
","text":"public java.lang.Boolean isAncestor(Node ancestor)\n
Indicates if a specific node is an ancestor of this node.
"},{"location":"api/java/cdk-graph/index.html#ancestorrequired_15","title":"ancestor
Required","text":""},{"location":"api/java/cdk-graph/index.html#ischild_8","title":"
- Type: Node
isChild
","text":"public java.lang.Boolean isChild(Node node)\n
Indicates if specific node is a child of this node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_76","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatecollapse_8","title":"
- Type: Node
mutateCollapse
","text":"public void mutateCollapse()\n
Collapses all sub-nodes of this node into this node.
"},{"location":"api/java/cdk-graph/index.html#mutatecollapseto_8","title":"mutateCollapseTo
","text":"public Node mutateCollapseTo(Node ancestor)\n
Collapses this node into an ancestor.
"},{"location":"api/java/cdk-graph/index.html#ancestorrequired_16","title":"ancestor
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatecollapsetoparent_8","title":"
- Type: Node
mutateCollapseToParent
","text":"public Node mutateCollapseToParent()\n
Collapses this node into it's parent node.
"},{"location":"api/java/cdk-graph/index.html#mutatehoist_8","title":"mutateHoist
","text":"public void mutateHoist(Node newParent)\n
Hoist this node to an ancestor by removing it from its current parent node and in turn moving it to the ancestor.
"},{"location":"api/java/cdk-graph/index.html#newparentrequired_15","title":"newParent
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatemove_8","title":"
- Type: Node
mutateMove
","text":"public void mutateMove(Node newParent)\n
Move this node into a new parent node.
"},{"location":"api/java/cdk-graph/index.html#newparentrequired_16","title":"newParent
Required","text":"
- Type: Node
The parent to move this node to.
"},{"location":"api/java/cdk-graph/index.html#mutateremovechild_8","title":"mutateRemoveChild
","text":"public java.lang.Boolean mutateRemoveChild(Node node)\n
Remove a child node from this node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_77","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateremovelink_8","title":"
- Type: Node
mutateRemoveLink
","text":"public java.lang.Boolean mutateRemoveLink(Edge link)\n
Remove a link from this node.
"},{"location":"api/java/cdk-graph/index.html#linkrequired_16","title":"link
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateremovereverselink_8","title":"
- Type: Edge
mutateRemoveReverseLink
","text":"public java.lang.Boolean mutateRemoveReverseLink(Edge link)\n
Remove a link to this node.
"},{"location":"api/java/cdk-graph/index.html#linkrequired_17","title":"link
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateuncluster_8","title":"
- Type: Edge
mutateUncluster
","text":"public void mutateUncluster()\n
Hoist all children to parent and collapse node to parent.
"},{"location":"api/java/cdk-graph/index.html#tostring_14","title":"toString
","text":"public java.lang.String toString()\n
Get string representation of this node.
"},{"location":"api/java/cdk-graph/index.html#addoutput_1","title":"addOutput
","text":"public void addOutput(OutputNode node)\n
Associate {@link OutputNode} with this stack.
"},{"location":"api/java/cdk-graph/index.html#noderequired_78","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#addparameter_1","title":"
- Type: OutputNode
addParameter
","text":"public void addParameter(ParameterNode node)\n
Associate {@link ParameterNode} with this stack.
"},{"location":"api/java/cdk-graph/index.html#noderequired_79","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#findoutput_1","title":"
- Type: ParameterNode
findOutput
","text":"public OutputNode findOutput(java.lang.String logicalId)\n
Find {@link OutputNode} with logicalId defined by this stack.
"},{"location":"api/java/cdk-graph/index.html#logicalidrequired_1","title":"logicalId
Required","text":""},{"location":"api/java/cdk-graph/index.html#findparameter_1","title":"
- Type: java.lang.String
findParameter
","text":"public ParameterNode findParameter(java.lang.String parameterId)\n
Find {@link ParameterNode} with parameterId defined by this stack.
"},{"location":"api/java/cdk-graph/index.html#parameteridrequired_1","title":"parameterId
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateremoveoutput_1","title":"
- Type: java.lang.String
mutateRemoveOutput
","text":"public java.lang.Boolean mutateRemoveOutput(OutputNode node)\n
Disassociate {@link OutputNode} from this stack.
"},{"location":"api/java/cdk-graph/index.html#noderequired_80","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateremoveparameter_1","title":"
- Type: OutputNode
mutateRemoveParameter
","text":"public java.lang.Boolean mutateRemoveParameter(ParameterNode node)\n
Disassociate {@link ParameterNode} from this stack.
"},{"location":"api/java/cdk-graph/index.html#noderequired_81","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#static-functions_14","title":"Static Functions","text":"Name Description
- Type: ParameterNode
isStackNode
Indicates if node is a {@link StackNode}.of
Gets the {@link StackNode} containing a given resource."},{"location":"api/java/cdk-graph/index.html#isstacknode_1","title":"isStackNode
","text":"import software.aws.pdk.cdk_graph.StackNode;\n\nStackNode.isStackNode(Node node)\n
Indicates if node is a {@link StackNode}.
"},{"location":"api/java/cdk-graph/index.html#noderequired_82","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#of_1","title":"
- Type: Node
of
","text":"import software.aws.pdk.cdk_graph.StackNode;\n\nStackNode.of(Node node)\n
Gets the {@link StackNode} containing a given resource.
"},{"location":"api/java/cdk-graph/index.html#noderequired_83","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#properties_30","title":"Properties","text":"Name Type Description
- Type: Node
attributes
java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>> 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 aaws-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."},{"location":"api/java/cdk-graph/index.html#attributesrequired_14","title":"attributes
Required","text":"public java.lang.Object getAttributes();\n
- Type: java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>>
Get readonly record of all attributes.
"},{"location":"api/java/cdk-graph/index.html#flagsrequired_14","title":"flags
Required","text":"public java.util.List<FlagEnum> getFlags();\n
- Type: java.util.List<FlagEnum>
Get readonly list of all flags.
"},{"location":"api/java/cdk-graph/index.html#isdestroyedrequired_14","title":"isDestroyed
Required","text":"public java.lang.Boolean getIsDestroyed();\n
- Type: java.lang.Boolean
Indicates if the entity has been destroyed (eg: removed from store).
"},{"location":"api/java/cdk-graph/index.html#ismutatedrequired_14","title":"isMutated
Required","text":"public java.lang.Boolean getIsMutated();\n
- Type: java.lang.Boolean
Indicates if the entity has had destructive mutations applied.
"},{"location":"api/java/cdk-graph/index.html#metadatarequired_14","title":"metadata
Required","text":"public java.util.List<MetadataEntry> getMetadata();\n
- Type: java.util.List
Get readonly list of all metadata entries.
"},{"location":"api/java/cdk-graph/index.html#storerequired_18","title":"store
Required","text":"public Store getStore();\n
- Type: Store
Reference to the store.
"},{"location":"api/java/cdk-graph/index.html#tagsrequired_14","title":"tags
Required","text":"public java.util.Map<java.lang.String, java.lang.String> getTags();\n
- Type: java.util.Map
Get readonly record of all tags.
"},{"location":"api/java/cdk-graph/index.html#uuidrequired_20","title":"uuid
Required","text":"public java.lang.String getUuid();\n
- Type: java.lang.String
Universally unique identifier.
"},{"location":"api/java/cdk-graph/index.html#allowdestructivemutationsrequired_13","title":"allowDestructiveMutations
Required","text":"public java.lang.Boolean getAllowDestructiveMutations();\n
- Type: java.lang.Boolean
Indicates if this node allows destructive mutations.
{@link Store.allowDestructiveMutations }
"},{"location":"api/java/cdk-graph/index.html#childrenrequired_8","title":"children
Required","text":"public java.util.List<Node> getChildren();\n
- Type: java.util.List<Node>
Get all direct child nodes.
"},{"location":"api/java/cdk-graph/index.html#dependedonbyrequired_8","title":"dependedOnBy
Required","text":"public java.util.List<Node> getDependedOnBy();\n
- Type: java.util.List<Node>
Get list of Nodes that depend on this node.
{@link Node.reverseDependencyLinks }
"},{"location":"api/java/cdk-graph/index.html#dependenciesrequired_9","title":"dependencies
Required","text":"public java.util.List<Node> getDependencies();\n
- Type: java.util.List<Node>
Get list of Nodes that this node depends on.
{@link Node.dependencyLinks }
"},{"location":"api/java/cdk-graph/index.html#dependencylinksrequired_8","title":"dependencyLinks
Required","text":"public java.util.List<Dependency> getDependencyLinks();\n
- Type: java.util.List<Dependency>
Gets list of {@link Dependency} links (edges) where this node is the source.
"},{"location":"api/java/cdk-graph/index.html#depthrequired_8","title":"depth
Required","text":"public java.lang.Number getDepth();\n
- Type: java.lang.Number
Indicates the depth of the node relative to root (0).
"},{"location":"api/java/cdk-graph/index.html#idrequired_32","title":"id
Required","text":"public java.lang.String getId();\n
- Type: java.lang.String
Node id, which is only unique within parent scope.
"},{"location":"api/java/cdk-graph/index.html#isassetrequired_8","title":"isAsset
Required","text":"public java.lang.Boolean getIsAsset();\n
- Type: java.lang.Boolean
Indicates if this node is considered a {@link FlagEnum.ASSET}.
"},{"location":"api/java/cdk-graph/index.html#iscfnfqnrequired_8","title":"isCfnFqn
Required","text":"public java.lang.Boolean getIsCfnFqn();\n
- Type: java.lang.Boolean
Indicates if node ConstructInfoFqn denotes a
aws-cdk-lib.*.Cfn*
construct.{@link FlagEnum.CFN_FQN }
"},{"location":"api/java/cdk-graph/index.html#isclusterrequired_8","title":"isCluster
Required","text":"public java.lang.Boolean getIsCluster();\n
- Type: java.lang.Boolean
Indicates if this node is considered a {@link FlagEnum.CLUSTER}.
"},{"location":"api/java/cdk-graph/index.html#iscustomresourcerequired_8","title":"isCustomResource
Required","text":"public java.lang.Boolean getIsCustomResource();\n
- Type: java.lang.Boolean
Indicates if node is a Custom Resource.
"},{"location":"api/java/cdk-graph/index.html#isextraneousrequired_13","title":"isExtraneous
Required","text":"public java.lang.Boolean getIsExtraneous();\n
- 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.
"},{"location":"api/java/cdk-graph/index.html#isgraphcontainerrequired_8","title":"isGraphContainer
Required","text":"public java.lang.Boolean getIsGraphContainer();\n
- Type: java.lang.Boolean
Indicates if this node is considered a {@link FlagEnum.GRAPH_CONTAINER}.
"},{"location":"api/java/cdk-graph/index.html#isleafrequired_8","title":"isLeaf
Required","text":"public java.lang.Boolean getIsLeaf();\n
- Type: java.lang.Boolean
Indicates if this node is a leaf node, which means it does not have children.
"},{"location":"api/java/cdk-graph/index.html#istoplevelrequired_8","title":"isTopLevel
Required","text":"public java.lang.Boolean getIsTopLevel();\n
- Type: java.lang.Boolean
Indicates if node is direct child of the graph root node.
"},{"location":"api/java/cdk-graph/index.html#linksrequired_8","title":"links
Required","text":"public java.util.List<Edge> getLinks();\n
- Type: java.util.List<Edge>
Gets all links (edges) in which this node is the source.
"},{"location":"api/java/cdk-graph/index.html#nodetyperequired_9","title":"nodeType
Required","text":"public NodeTypeEnum getNodeType();\n
- Type: NodeTypeEnum
Type of node.
"},{"location":"api/java/cdk-graph/index.html#pathrequired_11","title":"path
Required","text":"public java.lang.String getPath();\n
- Type: java.lang.String
Path of the node.
"},{"location":"api/java/cdk-graph/index.html#referencedbyrequired_8","title":"referencedBy
Required","text":"public java.util.List<Node> getReferencedBy();\n
- Type: java.util.List<Node>
Get list of Nodes that reference this node.
{@link Node.reverseReferenceLinks }
"},{"location":"api/java/cdk-graph/index.html#referencelinksrequired_8","title":"referenceLinks
Required","text":"public java.util.List<Reference> getReferenceLinks();\n
- Type: java.util.List<Reference>
Gets list of {@link Reference} links (edges) where this node is the source.
"},{"location":"api/java/cdk-graph/index.html#referencesrequired_8","title":"references
Required","text":"public java.util.List<Node> getReferences();\n
- Type: java.util.List<Node>
Get list of Nodes that this node references.
{@link Node.referenceLinks }
"},{"location":"api/java/cdk-graph/index.html#reversedependencylinksrequired_8","title":"reverseDependencyLinks
Required","text":"public java.util.List<Dependency> getReverseDependencyLinks();\n
- Type: java.util.List<Dependency>
Gets list of {@link Dependency} links (edges) where this node is the target.
"},{"location":"api/java/cdk-graph/index.html#reverselinksrequired_8","title":"reverseLinks
Required","text":"public java.util.List<Edge> getReverseLinks();\n
- Type: java.util.List<Edge>
Gets all links (edges) in which this node is the target.
"},{"location":"api/java/cdk-graph/index.html#reversereferencelinksrequired_8","title":"reverseReferenceLinks
Required","text":"public java.util.List<Reference> getReverseReferenceLinks();\n
- Type: java.util.List<Reference>
Gets list of {@link Reference} links (edges) where this node is the target.
"},{"location":"api/java/cdk-graph/index.html#scopesrequired_8","title":"scopes
Required","text":"public java.util.List<Node> getScopes();\n
- Type: java.util.List<Node>
Gets descending ordered list of ancestors from the root.
"},{"location":"api/java/cdk-graph/index.html#siblingsrequired_8","title":"siblings
Required","text":"public java.util.List<Node> getSiblings();\n
- Type: java.util.List<Node>
Get list of siblings of this node.
"},{"location":"api/java/cdk-graph/index.html#cfnpropsoptional_8","title":"cfnProps
Optional","text":"public PlainObject getCfnProps();\n
- Type: PlainObject
Gets CloudFormation properties for this node.
"},{"location":"api/java/cdk-graph/index.html#cfntypeoptional_10","title":"cfnType
Optional","text":"public java.lang.String getCfnType();\n
- Type: java.lang.String
Get the CloudFormation resource type for this node.
"},{"location":"api/java/cdk-graph/index.html#constructinfooptional_10","title":"constructInfo
Optional","text":"public ConstructInfo getConstructInfo();\n
- Type: ConstructInfo
Synthesized construct information defining jii resolution data.
"},{"location":"api/java/cdk-graph/index.html#constructinfofqnoptional_8","title":"constructInfoFqn
Optional","text":"public java.lang.String getConstructInfoFqn();\n
- Type: java.lang.String
Synthesized construct information defining jii resolution data.
"},{"location":"api/java/cdk-graph/index.html#logicalidoptional_10","title":"logicalId
Optional","text":"public java.lang.String getLogicalId();\n
- Type: java.lang.String
Logical id of the node, which is only unique within containing stack.
"},{"location":"api/java/cdk-graph/index.html#parentoptional_9","title":"parent
Optional","text":"public Node getParent();\n
- Type: Node
Parent node.
Only the root node should not have parent.
"},{"location":"api/java/cdk-graph/index.html#rootstackoptional_8","title":"rootStack
Optional","text":"public StackNode getRootStack();\n
- Type: StackNode
Get root stack.
"},{"location":"api/java/cdk-graph/index.html#stackoptional_9","title":"stack
Optional","text":"public StackNode getStack();\n
- Type: StackNode
Stack the node is contained in.
"},{"location":"api/java/cdk-graph/index.html#exportsrequired_1","title":"exports
Required","text":"public java.util.List<OutputNode> getExports();\n
- Type: java.util.List<OutputNode>
Get all exported {@link OutputNode}s defined by this stack.
"},{"location":"api/java/cdk-graph/index.html#outputsrequired_1","title":"outputs
Required","text":"public java.util.List<OutputNode> getOutputs();\n
- Type: java.util.List<OutputNode>
Get all {@link OutputNode}s defined by this stack.
"},{"location":"api/java/cdk-graph/index.html#parametersrequired_1","title":"parameters
Required","text":"public java.util.List<ParameterNode> getParameters();\n
- Type: java.util.List<ParameterNode>
Get all {@link ParameterNode}s defined by this stack.
"},{"location":"api/java/cdk-graph/index.html#stageoptional_1","title":"stage
Optional","text":"public StageNode getStage();\n
- Type: StageNode
Get {@link StageNode} containing this stack.
"},{"location":"api/java/cdk-graph/index.html#stagenode","title":"StageNode","text":"StageNode defines a cdk Stage.
"},{"location":"api/java/cdk-graph/index.html#initializers_18","title":"Initializers","text":"Name Type Descriptionimport software.aws.pdk.cdk_graph.StageNode;\n\nnew StageNode(ITypedNodeProps props);\n
props
ITypedNodeProps
No description."},{"location":"api/java/cdk-graph/index.html#propsrequired_14","title":"props
Required","text":""},{"location":"api/java/cdk-graph/index.html#methods_17","title":"Methods","text":"Name Description
- Type: ITypedNodeProps
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.addStack
Associate a {@link StackNode} with this stage.mutateRemoveStack
Disassociate {@link StackNode} from this stage."},{"location":"api/java/cdk-graph/index.html#addattribute_15","title":"addAttribute
","text":"public void addAttribute(java.lang.String key, java.lang.Object value)\n
Add attribute.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_129","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_63","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#addflag_15","title":"
- Type: java.lang.Object
addFlag
","text":"public void addFlag(FlagEnum flag)\n
Add flag.
"},{"location":"api/java/cdk-graph/index.html#flagrequired_30","title":"flag
Required","text":""},{"location":"api/java/cdk-graph/index.html#addmetadata_15","title":"
- Type: FlagEnum
addMetadata
","text":"public void addMetadata(java.lang.String metadataType, java.lang.Object data)\n
Add metadata entry.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_45","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#datarequired_46","title":"
- Type: java.lang.String
data
Required","text":""},{"location":"api/java/cdk-graph/index.html#addtag_15","title":"
- Type: java.lang.Object
addTag
","text":"public void addTag(java.lang.String key, java.lang.String value)\n
Add tag.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_130","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_64","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#applydata_15","title":"
- Type: java.lang.String
applyData
","text":"public void applyData(IBaseEntityDataProps data)\npublic void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite)\npublic void applyData(IBaseEntityDataProps data, java.lang.Boolean overwrite, java.lang.Boolean applyFlags)\n
Applies data (attributes, metadata, tags, flag) to entity.
Generally used only for mutations such as collapse and consume to retain data.
"},{"location":"api/java/cdk-graph/index.html#datarequired_47","title":"data
Required","text":"
- Type: IBaseEntityDataProps
The data to apply.
"},{"location":"api/java/cdk-graph/index.html#overwriteoptional_15","title":"overwrite
Optional","text":""},{"location":"api/java/cdk-graph/index.html#applyflagsoptional_15","title":"
- Type: java.lang.Boolean
applyFlags
Optional","text":"
- Type: java.lang.Boolean
Indicates if data is overwritten - Indicates if flags should be applied.
"},{"location":"api/java/cdk-graph/index.html#findmetadata_15","title":"findMetadata
","text":"public java.util.List<MetadataEntry> findMetadata(java.lang.String metadataType)\n
Retrieves all metadata entries of a given type.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_46","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#getattribute_15","title":"
- Type: java.lang.String
getAttribute
","text":"public java.lang.Object getAttribute(java.lang.String key)\n
Get attribute by key.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_131","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#gettag_15","title":"
- Type: java.lang.String
getTag
","text":"public java.lang.String getTag(java.lang.String key)\n
Get tag by key.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_132","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#hasattribute_15","title":"
- Type: java.lang.String
hasAttribute
","text":"public java.lang.Boolean hasAttribute(java.lang.String key)\npublic java.lang.Boolean hasAttribute(java.lang.String key, java.lang.Object value)\n
Indicates if entity has a given attribute defined, and optionally with a specific value.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_133","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valueoptional_32","title":"
- Type: java.lang.String
value
Optional","text":""},{"location":"api/java/cdk-graph/index.html#hasflag_15","title":"
- Type: java.lang.Object
hasFlag
","text":"public java.lang.Boolean hasFlag(FlagEnum flag)\n
Indicates if entity has a given flag.
"},{"location":"api/java/cdk-graph/index.html#flagrequired_31","title":"flag
Required","text":""},{"location":"api/java/cdk-graph/index.html#hasmetadata_15","title":"
- Type: FlagEnum
hasMetadata
","text":"public java.lang.Boolean hasMetadata(java.lang.String metadataType, java.lang.Object data)\n
Indicates if entity has matching metadata entry.
"},{"location":"api/java/cdk-graph/index.html#metadatatyperequired_47","title":"metadataType
Required","text":""},{"location":"api/java/cdk-graph/index.html#datarequired_48","title":"
- Type: java.lang.String
data
Required","text":""},{"location":"api/java/cdk-graph/index.html#hastag_15","title":"
- Type: java.lang.Object
hasTag
","text":"public java.lang.Boolean hasTag(java.lang.String key)\npublic java.lang.Boolean hasTag(java.lang.String key, java.lang.String value)\n
Indicates if entity has tag, optionally verifying tag value.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_134","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valueoptional_33","title":"
- Type: java.lang.String
value
Optional","text":""},{"location":"api/java/cdk-graph/index.html#mutatedestroy_15","title":"
- Type: java.lang.String
mutateDestroy
","text":"public void mutateDestroy()\npublic void mutateDestroy(java.lang.Boolean strict)\n
Destroys this node by removing all references and removing this node from the store.
"},{"location":"api/java/cdk-graph/index.html#strictoptional_9","title":"strict
Optional","text":"
- Type: java.lang.Boolean
Indicates that this node must not have references.
"},{"location":"api/java/cdk-graph/index.html#setattribute_15","title":"setAttribute
","text":"public void setAttribute(java.lang.String key, java.lang.Object value)\n
Set attribute.
This will overwrite existing attribute.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_135","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_65","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#settag_15","title":"
- Type: java.lang.Object
setTag
","text":"public void setTag(java.lang.String key, java.lang.String value)\n
Set tag.
Will overwrite existing tag.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_136","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#valuerequired_66","title":"
- Type: java.lang.String
value
Required","text":""},{"location":"api/java/cdk-graph/index.html#addchild_9","title":"
- Type: java.lang.String
addChild
","text":"public void addChild(Node node)\n
Add child node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_84","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#addlink_9","title":"
- Type: Node
addLink
","text":"public void addLink(Edge edge)\n
Add link to another node.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_37","title":"edge
Required","text":""},{"location":"api/java/cdk-graph/index.html#addreverselink_9","title":"
- Type: Edge
addReverseLink
","text":"public void addReverseLink(Edge edge)\n
Add link from another node.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_38","title":"edge
Required","text":""},{"location":"api/java/cdk-graph/index.html#doesdependon_9","title":"
- Type: Edge
doesDependOn
","text":"public java.lang.Boolean doesDependOn(Node node)\n
Indicates if this node depends on another node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_85","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#doesreference_9","title":"
- Type: Node
doesReference
","text":"public java.lang.Boolean doesReference(Node node)\n
Indicates if this node references another node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_86","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#find_9","title":"
- Type: Node
find
","text":"public Node find(INodePredicate predicate)\n
Recursively find the nearest sub-node matching predicate.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_46","title":"predicate
Required","text":""},{"location":"api/java/cdk-graph/index.html#findall_9","title":"
- Type: INodePredicate
findAll
","text":"public java.util.List<Node> findAll()\npublic java.util.List<Node> findAll(IFindNodeOptions options)\n
Return this construct and all of its sub-nodes in the given order.
Optionally filter nodes based on predicate.
"},{"location":"api/java/cdk-graph/index.html#optionsoptional_18","title":"options
Optional","text":""},{"location":"api/java/cdk-graph/index.html#findalllinks_9","title":"
- Type: IFindNodeOptions
findAllLinks
","text":"public java.util.List<Edge> findAllLinks()\npublic java.util.List<Edge> findAllLinks(IFindEdgeOptions options)\n
Return all direct links of this node and that of all sub-nodes.
Optionally filter links based on predicate.
"},{"location":"api/java/cdk-graph/index.html#optionsoptional_19","title":"options
Optional","text":""},{"location":"api/java/cdk-graph/index.html#findancestor_9","title":"
- Type: IFindEdgeOptions
findAncestor
","text":"public Node findAncestor(INodePredicate predicate)\npublic Node findAncestor(INodePredicate predicate, java.lang.Number max)\n
Find nearest ancestor of this node matching given predicate.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_47","title":"predicate
Required","text":"
- Type: INodePredicate
Predicate to match ancestor.
"},{"location":"api/java/cdk-graph/index.html#maxoptional_9","title":"max
Optional","text":""},{"location":"api/java/cdk-graph/index.html#findchild_9","title":"
- Type: java.lang.Number
findChild
","text":"public Node findChild(java.lang.String id)\n
Find child with given id.
Similar to
"},{"location":"api/java/cdk-graph/index.html#idrequired_33","title":"find
but does not throw error if no child found.id
Required","text":""},{"location":"api/java/cdk-graph/index.html#findlink_9","title":"
- Type: java.lang.String
findLink
","text":"public Edge findLink(IEdgePredicate predicate)\npublic Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse)\npublic Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow)\npublic Edge findLink(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow, java.lang.Boolean direct)\n
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.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_48","title":"predicate
Required","text":"
- Type: IEdgePredicate
Edge predicate function to match edge.
"},{"location":"api/java/cdk-graph/index.html#reverseoptional_27","title":"reverse
Optional","text":"
- Type: java.lang.Boolean
Indicates if links are search in reverse order.
"},{"location":"api/java/cdk-graph/index.html#followoptional_18","title":"follow
Optional","text":"
- Type: java.lang.Boolean
Indicates if link chain is followed.
"},{"location":"api/java/cdk-graph/index.html#directoptional_18","title":"direct
Optional","text":"
- Type: java.lang.Boolean
Indicates that only direct links should be searched.
"},{"location":"api/java/cdk-graph/index.html#findlinks_9","title":"findLinks
","text":"public java.util.List<Edge> findLinks(IEdgePredicate predicate)\npublic java.util.List<Edge> findLinks(IEdgePredicate predicate, java.lang.Boolean reverse)\npublic java.util.List<Edge> findLinks(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow)\npublic java.util.List<Edge> findLinks(IEdgePredicate predicate, java.lang.Boolean reverse, java.lang.Boolean follow, java.lang.Boolean direct)\n
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.
"},{"location":"api/java/cdk-graph/index.html#predicaterequired_49","title":"predicate
Required","text":"
- Type: IEdgePredicate
Edge predicate function to match edge.
"},{"location":"api/java/cdk-graph/index.html#reverseoptional_28","title":"reverse
Optional","text":"
- Type: java.lang.Boolean
Indicates if links are search in reverse order.
"},{"location":"api/java/cdk-graph/index.html#followoptional_19","title":"follow
Optional","text":"
- Type: java.lang.Boolean
Indicates if link chain is followed.
"},{"location":"api/java/cdk-graph/index.html#directoptional_19","title":"direct
Optional","text":"
- Type: java.lang.Boolean
Indicates that only direct links should be searched.
"},{"location":"api/java/cdk-graph/index.html#getcfnprop_9","title":"getCfnProp
","text":"public java.lang.String OR java.lang.Number OR java.lang.Boolean OR PlainObject OR java.util.List<java.lang.String OR java.lang.Number OR java.lang.Boolean OR PlainObject> getCfnProp(java.lang.String key)\n
Get specific CloudFormation property.
"},{"location":"api/java/cdk-graph/index.html#keyrequired_137","title":"key
Required","text":""},{"location":"api/java/cdk-graph/index.html#getchild_9","title":"
- Type: java.lang.String
getChild
","text":"public Node getChild(java.lang.String id)\n
Get child node with given id.
"},{"location":"api/java/cdk-graph/index.html#idrequired_34","title":"id
Required","text":""},{"location":"api/java/cdk-graph/index.html#getlinkchains_9","title":"
- Type: java.lang.String
getLinkChains
","text":"public java.util.List<java.util.List<java.lang.Object>> getLinkChains()\npublic java.util.List<java.util.List<java.lang.Object>> getLinkChains(java.lang.Boolean reverse)\n
Resolve all link chains.
{@link EdgeChain }
"},{"location":"api/java/cdk-graph/index.html#reverseoptional_29","title":"reverse
Optional","text":""},{"location":"api/java/cdk-graph/index.html#getnearestancestor_9","title":"
- Type: java.lang.Boolean
getNearestAncestor
","text":"public Node getNearestAncestor(Node node)\n
Gets the nearest common ancestor shared between this node and another node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_87","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#isancestor_9","title":"
- Type: Node
isAncestor
","text":"public java.lang.Boolean isAncestor(Node ancestor)\n
Indicates if a specific node is an ancestor of this node.
"},{"location":"api/java/cdk-graph/index.html#ancestorrequired_17","title":"ancestor
Required","text":""},{"location":"api/java/cdk-graph/index.html#ischild_9","title":"
- Type: Node
isChild
","text":"public java.lang.Boolean isChild(Node node)\n
Indicates if specific node is a child of this node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_88","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatecollapse_9","title":"
- Type: Node
mutateCollapse
","text":"public void mutateCollapse()\n
Collapses all sub-nodes of this node into this node.
"},{"location":"api/java/cdk-graph/index.html#mutatecollapseto_9","title":"mutateCollapseTo
","text":"public Node mutateCollapseTo(Node ancestor)\n
Collapses this node into an ancestor.
"},{"location":"api/java/cdk-graph/index.html#ancestorrequired_18","title":"ancestor
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatecollapsetoparent_9","title":"
- Type: Node
mutateCollapseToParent
","text":"public Node mutateCollapseToParent()\n
Collapses this node into it's parent node.
"},{"location":"api/java/cdk-graph/index.html#mutatehoist_9","title":"mutateHoist
","text":"public void mutateHoist(Node newParent)\n
Hoist this node to an ancestor by removing it from its current parent node and in turn moving it to the ancestor.
"},{"location":"api/java/cdk-graph/index.html#newparentrequired_17","title":"newParent
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutatemove_9","title":"
- Type: Node
mutateMove
","text":"public void mutateMove(Node newParent)\n
Move this node into a new parent node.
"},{"location":"api/java/cdk-graph/index.html#newparentrequired_18","title":"newParent
Required","text":"
- Type: Node
The parent to move this node to.
"},{"location":"api/java/cdk-graph/index.html#mutateremovechild_9","title":"mutateRemoveChild
","text":"public java.lang.Boolean mutateRemoveChild(Node node)\n
Remove a child node from this node.
"},{"location":"api/java/cdk-graph/index.html#noderequired_89","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateremovelink_9","title":"
- Type: Node
mutateRemoveLink
","text":"public java.lang.Boolean mutateRemoveLink(Edge link)\n
Remove a link from this node.
"},{"location":"api/java/cdk-graph/index.html#linkrequired_18","title":"link
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateremovereverselink_9","title":"
- Type: Edge
mutateRemoveReverseLink
","text":"public java.lang.Boolean mutateRemoveReverseLink(Edge link)\n
Remove a link to this node.
"},{"location":"api/java/cdk-graph/index.html#linkrequired_19","title":"link
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateuncluster_9","title":"
- Type: Edge
mutateUncluster
","text":"public void mutateUncluster()\n
Hoist all children to parent and collapse node to parent.
"},{"location":"api/java/cdk-graph/index.html#tostring_15","title":"toString
","text":"public java.lang.String toString()\n
Get string representation of this node.
"},{"location":"api/java/cdk-graph/index.html#addstack","title":"addStack
","text":"public void addStack(StackNode stack)\n
Associate a {@link StackNode} with this stage.
"},{"location":"api/java/cdk-graph/index.html#stackrequired","title":"stack
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateremovestack","title":"
- Type: StackNode
mutateRemoveStack
","text":"public java.lang.Boolean mutateRemoveStack(StackNode stack)\n
Disassociate {@link StackNode} from this stage.
"},{"location":"api/java/cdk-graph/index.html#stackrequired_1","title":"stack
Required","text":""},{"location":"api/java/cdk-graph/index.html#static-functions_15","title":"Static Functions","text":"Name Description
- Type: StackNode
isStageNode
Indicates if node is a {@link StageNode}.of
Gets the {@link StageNode} containing a given resource."},{"location":"api/java/cdk-graph/index.html#isstagenode","title":"isStageNode
","text":"import software.aws.pdk.cdk_graph.StageNode;\n\nStageNode.isStageNode(Node node)\n
Indicates if node is a {@link StageNode}.
"},{"location":"api/java/cdk-graph/index.html#noderequired_90","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#of_2","title":"
- Type: Node
of
","text":"import software.aws.pdk.cdk_graph.StageNode;\n\nStageNode.of(Node node)\n
Gets the {@link StageNode} containing a given resource.
"},{"location":"api/java/cdk-graph/index.html#noderequired_91","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#properties_31","title":"Properties","text":"Name Type Description
- Type: Node
attributes
java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>> 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 aaws-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.stacks
java.util.List<StackNode>
Gets all stacks contained by this stage."},{"location":"api/java/cdk-graph/index.html#attributesrequired_15","title":"attributes
Required","text":"public java.lang.Object getAttributes();\n
- Type: java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>>
Get readonly record of all attributes.
"},{"location":"api/java/cdk-graph/index.html#flagsrequired_15","title":"flags
Required","text":"public java.util.List<FlagEnum> getFlags();\n
- Type: java.util.List<FlagEnum>
Get readonly list of all flags.
"},{"location":"api/java/cdk-graph/index.html#isdestroyedrequired_15","title":"isDestroyed
Required","text":"public java.lang.Boolean getIsDestroyed();\n
- Type: java.lang.Boolean
Indicates if the entity has been destroyed (eg: removed from store).
"},{"location":"api/java/cdk-graph/index.html#ismutatedrequired_15","title":"isMutated
Required","text":"public java.lang.Boolean getIsMutated();\n
- Type: java.lang.Boolean
Indicates if the entity has had destructive mutations applied.
"},{"location":"api/java/cdk-graph/index.html#metadatarequired_15","title":"metadata
Required","text":"public java.util.List<MetadataEntry> getMetadata();\n
- Type: java.util.List
Get readonly list of all metadata entries.
"},{"location":"api/java/cdk-graph/index.html#storerequired_19","title":"store
Required","text":"public Store getStore();\n
- Type: Store
Reference to the store.
"},{"location":"api/java/cdk-graph/index.html#tagsrequired_15","title":"tags
Required","text":"public java.util.Map<java.lang.String, java.lang.String> getTags();\n
- Type: java.util.Map
Get readonly record of all tags.
"},{"location":"api/java/cdk-graph/index.html#uuidrequired_21","title":"uuid
Required","text":"public java.lang.String getUuid();\n
- Type: java.lang.String
Universally unique identifier.
"},{"location":"api/java/cdk-graph/index.html#allowdestructivemutationsrequired_14","title":"allowDestructiveMutations
Required","text":"public java.lang.Boolean getAllowDestructiveMutations();\n
- Type: java.lang.Boolean
Indicates if this node allows destructive mutations.
{@link Store.allowDestructiveMutations }
"},{"location":"api/java/cdk-graph/index.html#childrenrequired_9","title":"children
Required","text":"public java.util.List<Node> getChildren();\n
- Type: java.util.List<Node>
Get all direct child nodes.
"},{"location":"api/java/cdk-graph/index.html#dependedonbyrequired_9","title":"dependedOnBy
Required","text":"public java.util.List<Node> getDependedOnBy();\n
- Type: java.util.List<Node>
Get list of Nodes that depend on this node.
{@link Node.reverseDependencyLinks }
"},{"location":"api/java/cdk-graph/index.html#dependenciesrequired_10","title":"dependencies
Required","text":"public java.util.List<Node> getDependencies();\n
- Type: java.util.List<Node>
Get list of Nodes that this node depends on.
{@link Node.dependencyLinks }
"},{"location":"api/java/cdk-graph/index.html#dependencylinksrequired_9","title":"dependencyLinks
Required","text":"public java.util.List<Dependency> getDependencyLinks();\n
- Type: java.util.List<Dependency>
Gets list of {@link Dependency} links (edges) where this node is the source.
"},{"location":"api/java/cdk-graph/index.html#depthrequired_9","title":"depth
Required","text":"public java.lang.Number getDepth();\n
- Type: java.lang.Number
Indicates the depth of the node relative to root (0).
"},{"location":"api/java/cdk-graph/index.html#idrequired_35","title":"id
Required","text":"public java.lang.String getId();\n
- Type: java.lang.String
Node id, which is only unique within parent scope.
"},{"location":"api/java/cdk-graph/index.html#isassetrequired_9","title":"isAsset
Required","text":"public java.lang.Boolean getIsAsset();\n
- Type: java.lang.Boolean
Indicates if this node is considered a {@link FlagEnum.ASSET}.
"},{"location":"api/java/cdk-graph/index.html#iscfnfqnrequired_9","title":"isCfnFqn
Required","text":"public java.lang.Boolean getIsCfnFqn();\n
- Type: java.lang.Boolean
Indicates if node ConstructInfoFqn denotes a
aws-cdk-lib.*.Cfn*
construct.{@link FlagEnum.CFN_FQN }
"},{"location":"api/java/cdk-graph/index.html#isclusterrequired_9","title":"isCluster
Required","text":"public java.lang.Boolean getIsCluster();\n
- Type: java.lang.Boolean
Indicates if this node is considered a {@link FlagEnum.CLUSTER}.
"},{"location":"api/java/cdk-graph/index.html#iscustomresourcerequired_9","title":"isCustomResource
Required","text":"public java.lang.Boolean getIsCustomResource();\n
- Type: java.lang.Boolean
Indicates if node is a Custom Resource.
"},{"location":"api/java/cdk-graph/index.html#isextraneousrequired_14","title":"isExtraneous
Required","text":"public java.lang.Boolean getIsExtraneous();\n
- 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.
"},{"location":"api/java/cdk-graph/index.html#isgraphcontainerrequired_9","title":"isGraphContainer
Required","text":"public java.lang.Boolean getIsGraphContainer();\n
- Type: java.lang.Boolean
Indicates if this node is considered a {@link FlagEnum.GRAPH_CONTAINER}.
"},{"location":"api/java/cdk-graph/index.html#isleafrequired_9","title":"isLeaf
Required","text":"public java.lang.Boolean getIsLeaf();\n
- Type: java.lang.Boolean
Indicates if this node is a leaf node, which means it does not have children.
"},{"location":"api/java/cdk-graph/index.html#istoplevelrequired_9","title":"isTopLevel
Required","text":"public java.lang.Boolean getIsTopLevel();\n
- Type: java.lang.Boolean
Indicates if node is direct child of the graph root node.
"},{"location":"api/java/cdk-graph/index.html#linksrequired_9","title":"links
Required","text":"public java.util.List<Edge> getLinks();\n
- Type: java.util.List<Edge>
Gets all links (edges) in which this node is the source.
"},{"location":"api/java/cdk-graph/index.html#nodetyperequired_10","title":"nodeType
Required","text":"public NodeTypeEnum getNodeType();\n
- Type: NodeTypeEnum
Type of node.
"},{"location":"api/java/cdk-graph/index.html#pathrequired_12","title":"path
Required","text":"public java.lang.String getPath();\n
- Type: java.lang.String
Path of the node.
"},{"location":"api/java/cdk-graph/index.html#referencedbyrequired_9","title":"referencedBy
Required","text":"public java.util.List<Node> getReferencedBy();\n
- Type: java.util.List<Node>
Get list of Nodes that reference this node.
{@link Node.reverseReferenceLinks }
"},{"location":"api/java/cdk-graph/index.html#referencelinksrequired_9","title":"referenceLinks
Required","text":"public java.util.List<Reference> getReferenceLinks();\n
- Type: java.util.List<Reference>
Gets list of {@link Reference} links (edges) where this node is the source.
"},{"location":"api/java/cdk-graph/index.html#referencesrequired_9","title":"references
Required","text":"public java.util.List<Node> getReferences();\n
- Type: java.util.List<Node>
Get list of Nodes that this node references.
{@link Node.referenceLinks }
"},{"location":"api/java/cdk-graph/index.html#reversedependencylinksrequired_9","title":"reverseDependencyLinks
Required","text":"public java.util.List<Dependency> getReverseDependencyLinks();\n
- Type: java.util.List<Dependency>
Gets list of {@link Dependency} links (edges) where this node is the target.
"},{"location":"api/java/cdk-graph/index.html#reverselinksrequired_9","title":"reverseLinks
Required","text":"public java.util.List<Edge> getReverseLinks();\n
- Type: java.util.List<Edge>
Gets all links (edges) in which this node is the target.
"},{"location":"api/java/cdk-graph/index.html#reversereferencelinksrequired_9","title":"reverseReferenceLinks
Required","text":"public java.util.List<Reference> getReverseReferenceLinks();\n
- Type: java.util.List<Reference>
Gets list of {@link Reference} links (edges) where this node is the target.
"},{"location":"api/java/cdk-graph/index.html#scopesrequired_9","title":"scopes
Required","text":"public java.util.List<Node> getScopes();\n
- Type: java.util.List<Node>
Gets descending ordered list of ancestors from the root.
"},{"location":"api/java/cdk-graph/index.html#siblingsrequired_9","title":"siblings
Required","text":"public java.util.List<Node> getSiblings();\n
- Type: java.util.List<Node>
Get list of siblings of this node.
"},{"location":"api/java/cdk-graph/index.html#cfnpropsoptional_9","title":"cfnProps
Optional","text":"public PlainObject getCfnProps();\n
- Type: PlainObject
Gets CloudFormation properties for this node.
"},{"location":"api/java/cdk-graph/index.html#cfntypeoptional_11","title":"cfnType
Optional","text":"public java.lang.String getCfnType();\n
- Type: java.lang.String
Get the CloudFormation resource type for this node.
"},{"location":"api/java/cdk-graph/index.html#constructinfooptional_11","title":"constructInfo
Optional","text":"public ConstructInfo getConstructInfo();\n
- Type: ConstructInfo
Synthesized construct information defining jii resolution data.
"},{"location":"api/java/cdk-graph/index.html#constructinfofqnoptional_9","title":"constructInfoFqn
Optional","text":"public java.lang.String getConstructInfoFqn();\n
- Type: java.lang.String
Synthesized construct information defining jii resolution data.
"},{"location":"api/java/cdk-graph/index.html#logicalidoptional_11","title":"logicalId
Optional","text":"public java.lang.String getLogicalId();\n
- Type: java.lang.String
Logical id of the node, which is only unique within containing stack.
"},{"location":"api/java/cdk-graph/index.html#parentoptional_10","title":"parent
Optional","text":"public Node getParent();\n
- Type: Node
Parent node.
Only the root node should not have parent.
"},{"location":"api/java/cdk-graph/index.html#rootstackoptional_9","title":"rootStack
Optional","text":"public StackNode getRootStack();\n
- Type: StackNode
Get root stack.
"},{"location":"api/java/cdk-graph/index.html#stackoptional_10","title":"stack
Optional","text":"public StackNode getStack();\n
- Type: StackNode
Stack the node is contained in.
"},{"location":"api/java/cdk-graph/index.html#stacksrequired","title":"stacks
Required","text":"public java.util.List<StackNode> getStacks();\n
- Type: java.util.List<StackNode>
Gets all stacks contained by this stage.
"},{"location":"api/java/cdk-graph/index.html#store","title":"Store","text":"
- Implements: ISerializableGraphStore
Store class provides the in-memory database-like interface for managing all entities in the graph.
"},{"location":"api/java/cdk-graph/index.html#initializers_19","title":"Initializers","text":"Name Type Descriptionimport software.aws.pdk.cdk_graph.Store;\n\nnew Store();,new Store(java.lang.Boolean allowDestructiveMutations);\n
allowDestructiveMutations
java.lang.Boolean
No description."},{"location":"api/java/cdk-graph/index.html#allowdestructivemutationsoptional","title":"allowDestructiveMutations
Optional","text":""},{"location":"api/java/cdk-graph/index.html#methods_18","title":"Methods","text":"Name Description
- Type: java.lang.Boolean
addEdge
Add edge to the store.addNode
Add node to the store.addStack
Add stack node to the store.addStage
Add stage to the store.clone
Clone the store to allow destructive mutations.computeLogicalUniversalId
Compute universal logicalId based on parent stack and construct logicalId (<stack>:<logicalId>
).findNodeByImportArn
Attempts to lookup the {@link Node} associated with a given import arn token.findNodeByLogicalId
Find node within given stack with given logicalId.findNodeByLogicalUniversalId
Find node by universal logicalId (<stack>:<logicalId>
).getEdge
Get stored edge by UUID.getNode
Get stored node by UUID.getStack
Get stored stack node by UUID.getStage
Get stored stage node by UUID.mutateRemoveEdge
Remove edge from the store.mutateRemoveNode
Remove node from the store.recordImportArn
Records arn tokens from imported resources (eg:s3.Bucket.fromBucketArn()
) that are used for resolving references.recordLogicalId
Record a universal logicalId to node mapping in the store.serialize
Serialize the store.verifyDestructiveMutationAllowed
Verifies that the store allows destructive mutations."},{"location":"api/java/cdk-graph/index.html#addedge","title":"addEdge
","text":"public void addEdge(Edge edge)\n
Add edge to the store.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_39","title":"edge
Required","text":""},{"location":"api/java/cdk-graph/index.html#addnode","title":"
- Type: Edge
addNode
","text":"public void addNode(Node node)\n
Add node to the store.
"},{"location":"api/java/cdk-graph/index.html#noderequired_92","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#addstack_1","title":"
- Type: Node
addStack
","text":"public void addStack(StackNode stack)\n
Add stack node to the store.
"},{"location":"api/java/cdk-graph/index.html#stackrequired_2","title":"stack
Required","text":""},{"location":"api/java/cdk-graph/index.html#addstage","title":"
- Type: StackNode
addStage
","text":"public void addStage(StageNode stage)\n
Add stage to the store.
"},{"location":"api/java/cdk-graph/index.html#stagerequired","title":"stage
Required","text":""},{"location":"api/java/cdk-graph/index.html#clone","title":"
- Type: StageNode
clone
","text":"public Store clone()\npublic Store clone(java.lang.Boolean allowDestructiveMutations)\n
Clone the store to allow destructive mutations.
"},{"location":"api/java/cdk-graph/index.html#allowdestructivemutationsoptional_1","title":"allowDestructiveMutations
Optional","text":"
- Type: java.lang.Boolean
Indicates if destructive mutations are allowed;
defaults to
"},{"location":"api/java/cdk-graph/index.html#computelogicaluniversalid","title":"true
computeLogicalUniversalId
","text":"public java.lang.String computeLogicalUniversalId(StackNode stack, java.lang.String logicalId)\n
Compute universal logicalId based on parent stack and construct logicalId (
<stack>:<logicalId>
).Construct logicalIds are only unique within their containing stack, so to use logicalId* lookups universally (like resolving references) we need a universal key.
"},{"location":"api/java/cdk-graph/index.html#stackrequired_3","title":"stack
Required","text":""},{"location":"api/java/cdk-graph/index.html#logicalidrequired_2","title":"
- Type: StackNode
logicalId
Required","text":""},{"location":"api/java/cdk-graph/index.html#findnodebyimportarn","title":"
- Type: java.lang.String
findNodeByImportArn
","text":"public Node findNodeByImportArn(java.lang.Object value)\n
Attempts to lookup the {@link Node} associated with a given import arn token.
"},{"location":"api/java/cdk-graph/index.html#valuerequired_67","title":"value
Required","text":"
- Type: java.lang.Object
Import arn value, which is either object to tokenize or already tokenized string.
"},{"location":"api/java/cdk-graph/index.html#findnodebylogicalid","title":"findNodeByLogicalId
","text":"public Node findNodeByLogicalId(StackNode stack, java.lang.String logicalId)\n
Find node within given stack with given logicalId.
"},{"location":"api/java/cdk-graph/index.html#stackrequired_4","title":"stack
Required","text":""},{"location":"api/java/cdk-graph/index.html#logicalidrequired_3","title":"
- Type: StackNode
logicalId
Required","text":""},{"location":"api/java/cdk-graph/index.html#findnodebylogicaluniversalid","title":"
- Type: java.lang.String
findNodeByLogicalUniversalId
","text":"public Node findNodeByLogicalUniversalId(java.lang.String uid)\n
Find node by universal logicalId (
"},{"location":"api/java/cdk-graph/index.html#uidrequired","title":"<stack>:<logicalId>
).uid
Required","text":""},{"location":"api/java/cdk-graph/index.html#getedge","title":"
- Type: java.lang.String
getEdge
","text":"public Edge getEdge(java.lang.String uuid)\n
Get stored edge by UUID.
"},{"location":"api/java/cdk-graph/index.html#uuidrequired_22","title":"uuid
Required","text":""},{"location":"api/java/cdk-graph/index.html#getnode","title":"
- Type: java.lang.String
getNode
","text":"public Node getNode(java.lang.String uuid)\n
Get stored node by UUID.
"},{"location":"api/java/cdk-graph/index.html#uuidrequired_23","title":"uuid
Required","text":""},{"location":"api/java/cdk-graph/index.html#getstack","title":"
- Type: java.lang.String
getStack
","text":"public StackNode getStack(java.lang.String uuid)\n
Get stored stack node by UUID.
"},{"location":"api/java/cdk-graph/index.html#uuidrequired_24","title":"uuid
Required","text":""},{"location":"api/java/cdk-graph/index.html#getstage","title":"
- Type: java.lang.String
getStage
","text":"public StageNode getStage(java.lang.String uuid)\n
Get stored stage node by UUID.
"},{"location":"api/java/cdk-graph/index.html#uuidrequired_25","title":"uuid
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateremoveedge","title":"
- Type: java.lang.String
mutateRemoveEdge
","text":"public java.lang.Boolean mutateRemoveEdge(Edge edge)\n
Remove edge from the store.
"},{"location":"api/java/cdk-graph/index.html#edgerequired_40","title":"edge
Required","text":""},{"location":"api/java/cdk-graph/index.html#mutateremovenode","title":"
- Type: Edge
mutateRemoveNode
","text":"public java.lang.Boolean mutateRemoveNode(Node node)\n
Remove node from the store.
"},{"location":"api/java/cdk-graph/index.html#noderequired_93","title":"node
Required","text":""},{"location":"api/java/cdk-graph/index.html#recordimportarn","title":"
- Type: Node
recordImportArn
","text":"public void recordImportArn(java.lang.String arnToken, Node resource)\n
Records arn tokens from imported resources (eg:
"},{"location":"api/java/cdk-graph/index.html#arntokenrequired","title":"s3.Bucket.fromBucketArn()
) that are used for resolving references.arnToken
Required","text":""},{"location":"api/java/cdk-graph/index.html#resourcerequired_1","title":"
- Type: java.lang.String
resource
Required","text":""},{"location":"api/java/cdk-graph/index.html#recordlogicalid","title":"
- Type: Node
recordLogicalId
","text":"public void recordLogicalId(StackNode stack, java.lang.String logicalId, Node resource)\n
Record a universal logicalId to node mapping in the store.
"},{"location":"api/java/cdk-graph/index.html#stackrequired_5","title":"stack
Required","text":""},{"location":"api/java/cdk-graph/index.html#logicalidrequired_4","title":"
- Type: StackNode
logicalId
Required","text":""},{"location":"api/java/cdk-graph/index.html#resourcerequired_2","title":"
- Type: java.lang.String
resource
Required","text":""},{"location":"api/java/cdk-graph/index.html#serialize","title":"
- Type: Node
serialize
","text":"public SGGraphStore serialize()\n
Serialize the store.
"},{"location":"api/java/cdk-graph/index.html#verifydestructivemutationallowed","title":"verifyDestructiveMutationAllowed
","text":"public void verifyDestructiveMutationAllowed()\n
Verifies that the store allows destructive mutations.
"},{"location":"api/java/cdk-graph/index.html#static-functions_16","title":"Static Functions","text":"Name DescriptionfromSerializedStore
Builds store from serialized store data."},{"location":"api/java/cdk-graph/index.html#fromserializedstore","title":"fromSerializedStore
","text":"import software.aws.pdk.cdk_graph.Store;\n\nStore.fromSerializedStore(SGGraphStore serializedStore)\n
Builds store from serialized store data.
"},{"location":"api/java/cdk-graph/index.html#serializedstorerequired","title":"serializedStore
Required","text":""},{"location":"api/java/cdk-graph/index.html#properties_32","title":"Properties","text":"Name Type Description
- Type: SGGraphStore
allowDestructiveMutations
java.lang.Boolean
Indicates if the store allows destructive mutations.counts
IStoreCounts
Get record of all store counters.edges
java.util.List<Edge>
Gets all stored edges.nodes
java.util.List<Node>
Gets all stored nodes.root
RootNode
Root node in the store.rootStacks
java.util.List<StackNode>
Gets all stored root stack nodes.stacks
java.util.List<StackNode>
Gets all stored stack nodes.stages
java.util.List<StageNode>
Gets all stored stage nodes.version
java.lang.String
Current SemVer version of the store."},{"location":"api/java/cdk-graph/index.html#allowdestructivemutationsrequired_15","title":"allowDestructiveMutations
Required","text":"public java.lang.Boolean getAllowDestructiveMutations();\n
- Type: java.lang.Boolean
Indicates if the store allows destructive mutations.
Destructive mutations are only allowed on clones of the store to prevent plugins and filters from mutating the store for downstream plugins.
All
mutate*
methods are only allowed on stores that allow destructive mutations.This behavior may change in the future if the need arises for plugins to pass mutated stores to downstream plugins. But it will be done cautiously with ensuring the intent of downstream plugin is to receive the mutated store.
"},{"location":"api/java/cdk-graph/index.html#countsrequired","title":"counts
Required","text":"public IStoreCounts getCounts();\n
- Type: IStoreCounts
Get record of all store counters.
"},{"location":"api/java/cdk-graph/index.html#edgesrequired_1","title":"edges
Required","text":"public java.util.List<Edge> getEdges();\n
- Type: java.util.List<Edge>
Gets all stored edges.
"},{"location":"api/java/cdk-graph/index.html#nodesrequired","title":"nodes
Required","text":"public java.util.List<Node> getNodes();\n
- Type: java.util.List<Node>
Gets all stored nodes.
"},{"location":"api/java/cdk-graph/index.html#rootrequired_2","title":"root
Required","text":"public RootNode getRoot();\n
- Type: RootNode
Root node in the store.
The root node is not the computed root, but the graph root which is auto-generated and can not be mutated.
"},{"location":"api/java/cdk-graph/index.html#rootstacksrequired","title":"rootStacks
Required","text":"public java.util.List<StackNode> getRootStacks();\n
- Type: java.util.List<StackNode>
Gets all stored root stack nodes.
"},{"location":"api/java/cdk-graph/index.html#stacksrequired_1","title":"stacks
Required","text":"public java.util.List<StackNode> getStacks();\n
- Type: java.util.List<StackNode>
Gets all stored stack nodes.
"},{"location":"api/java/cdk-graph/index.html#stagesrequired","title":"stages
Required","text":"public java.util.List<StageNode> getStages();\n
- Type: java.util.List<StageNode>
Gets all stored stage nodes.
"},{"location":"api/java/cdk-graph/index.html#versionrequired_3","title":"version
Required","text":"public java.lang.String getVersion();\n
- Type: java.lang.String
Current SemVer version of the store.
"},{"location":"api/java/cdk-graph/index.html#protocols","title":"Protocols","text":""},{"location":"api/java/cdk-graph/index.html#iappnodeprops","title":"IAppNodeProps","text":"
Extends: IBaseEntityDataProps
Implemented By: IAppNodeProps
{@link AppNode} props.
"},{"location":"api/java/cdk-graph/index.html#properties_33","title":"Properties","text":"Name Type Descriptionattributes
java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>> Attributes.
flags
java.util.List<FlagEnum>
Flags.metadata
java.util.List Metadata entries.
tags
java.util.Map Tags.
store
Store
Store.cfnType
java.lang.String
Type of CloudFormation resource.constructInfo
ConstructInfo
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."},{"location":"api/java/cdk-graph/index.html#attributesoptional_4","title":"attributes
Optional","text":"public java.lang.Object getAttributes();\n
- Type: java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>>
Attributes.
"},{"location":"api/java/cdk-graph/index.html#flagsoptional_4","title":"flags
Optional","text":"public java.util.List<FlagEnum> getFlags();\n
- Type: java.util.List<FlagEnum>
Flags.
"},{"location":"api/java/cdk-graph/index.html#metadataoptional_4","title":"metadata
Optional","text":"public java.util.List<MetadataEntry> getMetadata();\n
- Type: java.util.List
Metadata entries.
"},{"location":"api/java/cdk-graph/index.html#tagsoptional_4","title":"tags
Optional","text":"public java.util.Map<java.lang.String, java.lang.String> getTags();\n
- Type: java.util.Map
Tags.
"},{"location":"api/java/cdk-graph/index.html#storerequired_20","title":"store
Required","text":"public Store getStore();\n
- Type: Store
Store.
"},{"location":"api/java/cdk-graph/index.html#cfntypeoptional_12","title":"cfnType
Optional","text":"public java.lang.String getCfnType();\n
- Type: java.lang.String
Type of CloudFormation resource.
"},{"location":"api/java/cdk-graph/index.html#constructinfooptional_12","title":"constructInfo
Optional","text":"public ConstructInfo getConstructInfo();\n
- Type: ConstructInfo
Synthesized construct information defining jii resolution data.
"},{"location":"api/java/cdk-graph/index.html#logicalidoptional_12","title":"logicalId
Optional","text":"public java.lang.String getLogicalId();\n
- Type: java.lang.String
Logical id of the node, which is only unique within containing stack.
"},{"location":"api/java/cdk-graph/index.html#parentoptional_11","title":"parent
Optional","text":"public Node getParent();\n
- Type: Node
Parent node.
"},{"location":"api/java/cdk-graph/index.html#iattributereferenceprops","title":"IAttributeReferenceProps","text":"
Extends: ITypedEdgeProps
Implemented By: IAttributeReferenceProps
Attribute type reference props.
"},{"location":"api/java/cdk-graph/index.html#properties_34","title":"Properties","text":"Name Type Descriptionattributes
java.util.MapPlainObject\\ OR java.util.List\\PlainObject\\>> Attributes.
flags
java.util.List<FlagEnum>
Flags.metadata
java.util.List Metadata entries.
tags
java.util.Map Tags.