Skip to content

API Reference

Structs

ArrowFormat

Theme arrow format definition.

Initializer

import software.aws.pdk.aws_arch.aws_arch.ArrowFormat;

ArrowFormat.builder()
    .color(java.lang.String)
    .color(java.lang.Boolean)
    .head(java.lang.String)
    .style(java.lang.String)
    .tail(java.lang.String)
    .width(java.lang.Number)
    .build();

Properties

Name Type Description
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.

colorRequired
public java.lang.Object getColor();
  • Type: java.lang.String OR java.lang.Boolean

headRequired
public java.lang.String getHead();
  • Type: java.lang.String

styleRequired
public java.lang.String getStyle();
  • Type: java.lang.String

tailRequired
public java.lang.String getTail();
  • Type: java.lang.String

widthRequired
public java.lang.Number getWidth();
  • Type: java.lang.Number

AwsCategoryDefinition

Category definition.

Initializer

import software.aws.pdk.aws_arch.aws_arch.AwsCategoryDefinition;

AwsCategoryDefinition.builder()
    .fillColor(java.lang.String)
    .gradientColor(java.lang.String)
    .id(java.lang.String)
    .name(java.lang.String)
//  .fontColor(java.lang.String)
//  .variants(java.util.List<java.lang.String>)
    .build();

Properties

Name Type Description
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.

fillColorRequired
public java.lang.String getFillColor();
  • Type: java.lang.String

gradientColorRequired
public java.lang.String getGradientColor();
  • Type: java.lang.String

idRequired
public java.lang.String getId();
  • Type: java.lang.String

nameRequired
public java.lang.String getName();
  • Type: java.lang.String

fontColorOptional
public java.lang.String getFontColor();
  • Type: java.lang.String

variantsOptional
public java.util.List<java.lang.String> getVariants();
  • Type: java.util.List

AwsDrawioResourceIconStyle

Drawio resource icon style definition for AWS Resources.

Initializer

import software.aws.pdk.aws_arch.AwsDrawioResourceIconStyle;

AwsDrawioResourceIconStyle.builder()
    .align(java.lang.String)
    .aspect(java.lang.String)
    .dashed(java.lang.Number)
    .fontSize(java.lang.Number)
    .fontStyle(java.lang.String)
    .fontStyle(java.lang.Number)
    .gradientDirection(java.lang.String)
    .html(java.lang.Number)
    .outlineConnect(java.lang.Number)
    .strokeColor(java.lang.String)
    .verticalAlign(java.lang.String)
    .verticalLabelPosition(java.lang.String)
//  .pointerEvent(java.lang.Number)
    .fillColor(java.lang.String)
    .fontColor(java.lang.String)
    .gradientColor(java.lang.String)
    .resIcon(ShapeNames)
    .shape(DrawioAws4ParentShapes)
    .build();

Properties

Name Type 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.
resIcon software.aws.pdk.aws_arch.aws_arch.DrawioSpec.Aws4.ShapeNames No description.
shape software.aws.pdk.aws_arch.aws_arch.DrawioAws4ParentShapes No description.

alignRequired
public java.lang.String getAlign();
  • Type: java.lang.String

aspectRequired
public java.lang.String getAspect();
  • Type: java.lang.String

dashedRequired
public java.lang.Number getDashed();
  • Type: java.lang.Number

fontSizeRequired
public java.lang.Number getFontSize();
  • Type: java.lang.Number

fontStyleRequired
public java.lang.Object getFontStyle();
  • Type: java.lang.String OR java.lang.Number

gradientDirectionRequired
public java.lang.String getGradientDirection();
  • Type: java.lang.String

htmlRequired
public java.lang.Number getHtml();
  • Type: java.lang.Number

outlineConnectRequired
public java.lang.Number getOutlineConnect();
  • Type: java.lang.Number

strokeColorRequired
public java.lang.String getStrokeColor();
  • Type: java.lang.String

verticalAlignRequired
public java.lang.String getVerticalAlign();
  • Type: java.lang.String

verticalLabelPositionRequired
public java.lang.String getVerticalLabelPosition();
  • Type: java.lang.String

pointerEventOptional
public java.lang.Number getPointerEvent();
  • Type: java.lang.Number

fillColorRequired
public java.lang.String getFillColor();
  • Type: java.lang.String

fontColorRequired
public java.lang.String getFontColor();
  • Type: java.lang.String

gradientColorRequired
public java.lang.String getGradientColor();
  • Type: java.lang.String

resIconRequired
public ShapeNames getResIcon();
  • Type: software.aws.pdk.aws_arch.aws_arch.DrawioSpec.Aws4.ShapeNames

shapeRequired
public DrawioAws4ParentShapes getShape();
  • Type: software.aws.pdk.aws_arch.aws_arch.DrawioAws4ParentShapes

AwsDrawioShapeStyle

Drawio shape based style definition.

Initializer

import software.aws.pdk.aws_arch.AwsDrawioShapeStyle;

AwsDrawioShapeStyle.builder()
    .align(java.lang.String)
    .aspect(java.lang.String)
    .dashed(java.lang.Number)
    .fontSize(java.lang.Number)
    .fontStyle(java.lang.String)
    .fontStyle(java.lang.Number)
    .gradientDirection(java.lang.String)
    .html(java.lang.Number)
    .outlineConnect(java.lang.Number)
    .strokeColor(java.lang.String)
    .verticalAlign(java.lang.String)
    .verticalLabelPosition(java.lang.String)
//  .pointerEvent(java.lang.Number)
    .fillColor(java.lang.String)
    .fontColor(java.lang.String)
    .gradientColor(java.lang.String)
    .shape(ShapeNames)
    .build();

Properties

Name Type 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.
shape software.aws.pdk.aws_arch.aws_arch.DrawioSpec.Aws4.ShapeNames No description.

alignRequired
public java.lang.String getAlign();
  • Type: java.lang.String

aspectRequired
public java.lang.String getAspect();
  • Type: java.lang.String

dashedRequired
public java.lang.Number getDashed();
  • Type: java.lang.Number

fontSizeRequired
public java.lang.Number getFontSize();
  • Type: java.lang.Number

fontStyleRequired
public java.lang.Object getFontStyle();
  • Type: java.lang.String OR java.lang.Number

gradientDirectionRequired
public java.lang.String getGradientDirection();
  • Type: java.lang.String

htmlRequired
public java.lang.Number getHtml();
  • Type: java.lang.Number

outlineConnectRequired
public java.lang.Number getOutlineConnect();
  • Type: java.lang.Number

strokeColorRequired
public java.lang.String getStrokeColor();
  • Type: java.lang.String

verticalAlignRequired
public java.lang.String getVerticalAlign();
  • Type: java.lang.String

verticalLabelPositionRequired
public java.lang.String getVerticalLabelPosition();
  • Type: java.lang.String

pointerEventOptional
public java.lang.Number getPointerEvent();
  • Type: java.lang.Number

fillColorRequired
public java.lang.String getFillColor();
  • Type: java.lang.String

fontColorRequired
public java.lang.String getFontColor();
  • Type: java.lang.String

gradientColorRequired
public java.lang.String getGradientColor();
  • Type: java.lang.String

shapeRequired
public ShapeNames getShape();
  • Type: software.aws.pdk.aws_arch.aws_arch.DrawioSpec.Aws4.ShapeNames

DrawioAwsResourceIconStyleBase

Based style definition for drawio aws resource icon.

Initializer

import software.aws.pdk.aws_arch.aws_arch.DrawioAwsResourceIconStyleBase;

DrawioAwsResourceIconStyleBase.builder()
    .align(java.lang.String)
    .aspect(java.lang.String)
    .dashed(java.lang.Number)
    .fontSize(java.lang.Number)
    .fontStyle(java.lang.String)
    .fontStyle(java.lang.Number)
    .gradientDirection(java.lang.String)
    .html(java.lang.Number)
    .outlineConnect(java.lang.Number)
    .strokeColor(java.lang.String)
    .verticalAlign(java.lang.String)
    .verticalLabelPosition(java.lang.String)
//  .pointerEvent(java.lang.Number)
    .fillColor(java.lang.String)
    .fontColor(java.lang.String)
    .gradientColor(java.lang.String)
    .build();

Properties

Name Type 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.

alignRequired
public java.lang.String getAlign();
  • Type: java.lang.String

aspectRequired
public java.lang.String getAspect();
  • Type: java.lang.String

dashedRequired
public java.lang.Number getDashed();
  • Type: java.lang.Number

fontSizeRequired
public java.lang.Number getFontSize();
  • Type: java.lang.Number

fontStyleRequired
public java.lang.Object getFontStyle();
  • Type: java.lang.String OR java.lang.Number

gradientDirectionRequired
public java.lang.String getGradientDirection();
  • Type: java.lang.String

htmlRequired
public java.lang.Number getHtml();
  • Type: java.lang.Number

outlineConnectRequired
public java.lang.Number getOutlineConnect();
  • Type: java.lang.Number

strokeColorRequired
public java.lang.String getStrokeColor();
  • Type: java.lang.String

verticalAlignRequired
public java.lang.String getVerticalAlign();
  • Type: java.lang.String

verticalLabelPositionRequired
public java.lang.String getVerticalLabelPosition();
  • Type: java.lang.String

pointerEventOptional
public java.lang.Number getPointerEvent();
  • Type: java.lang.Number

fillColorRequired
public java.lang.String getFillColor();
  • Type: java.lang.String

fontColorRequired
public java.lang.String getFontColor();
  • Type: java.lang.String

gradientColorRequired
public java.lang.String getGradientColor();
  • Type: java.lang.String

DrawioAwsShapeStyleBase

Base definition of drawio aws shape style.

Initializer

import software.aws.pdk.aws_arch.aws_arch.DrawioAwsShapeStyleBase;

DrawioAwsShapeStyleBase.builder()
    .align(java.lang.String)
    .aspect(java.lang.String)
    .dashed(java.lang.Number)
    .fontSize(java.lang.Number)
    .fontStyle(java.lang.String)
    .fontStyle(java.lang.Number)
    .gradientDirection(java.lang.String)
    .html(java.lang.Number)
    .outlineConnect(java.lang.Number)
    .strokeColor(java.lang.String)
    .verticalAlign(java.lang.String)
    .verticalLabelPosition(java.lang.String)
//  .pointerEvent(java.lang.Number)
    .build();

Properties

Name Type 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.

alignRequired
public java.lang.String getAlign();
  • Type: java.lang.String

aspectRequired
public java.lang.String getAspect();
  • Type: java.lang.String

dashedRequired
public java.lang.Number getDashed();
  • Type: java.lang.Number

fontSizeRequired
public java.lang.Number getFontSize();
  • Type: java.lang.Number

fontStyleRequired
public java.lang.Object getFontStyle();
  • Type: java.lang.String OR java.lang.Number

gradientDirectionRequired
public java.lang.String getGradientDirection();
  • Type: java.lang.String

htmlRequired
public java.lang.Number getHtml();
  • Type: java.lang.Number

outlineConnectRequired
public java.lang.Number getOutlineConnect();
  • Type: java.lang.Number

strokeColorRequired
public java.lang.String getStrokeColor();
  • Type: java.lang.String

verticalAlignRequired
public java.lang.String getVerticalAlign();
  • Type: java.lang.String

verticalLabelPositionRequired
public java.lang.String getVerticalLabelPosition();
  • Type: java.lang.String

pointerEventOptional
public java.lang.Number getPointerEvent();
  • Type: java.lang.Number

GroupFormat

Theme group format definition.

Initializer

import software.aws.pdk.aws_arch.aws_arch.GroupFormat;

GroupFormat.builder()
    .bgcolor(java.lang.String)
    .bgcolor(java.lang.Boolean)
    .borderColor(java.lang.String)
    .borderColor(java.lang.Boolean)
    .borderStyle(java.lang.String)
    .color(java.lang.String)
    .color(java.lang.Boolean)
//  .iconPng(java.lang.String)
//  .labelLocation(java.lang.String)
    .build();

Properties

Name Type Description
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.

bgcolorRequired
public java.lang.Object getBgcolor();
  • Type: java.lang.String OR java.lang.Boolean

borderColorRequired
public java.lang.Object getBorderColor();
  • Type: java.lang.String OR java.lang.Boolean

borderStyleRequired
public java.lang.String getBorderStyle();
  • Type: java.lang.String

colorRequired
public java.lang.Object getColor();
  • Type: java.lang.String OR java.lang.Boolean

iconPngOptional
public java.lang.String getIconPng();
  • Type: java.lang.String

labelLocationOptional
public java.lang.String getLabelLocation();
  • Type: java.lang.String

ParsedAssetKey

Parsed asset key.

Initializer

import software.aws.pdk.aws_arch.ParsedAssetKey;

ParsedAssetKey.builder()
    .assetKey(java.lang.String)
    .basename(java.lang.String)
    .category(java.lang.String)
//  .instanceType(java.lang.String)
//  .iotThing(java.lang.String)
//  .resource(java.lang.String)
//  .service(java.lang.String)
    .build();

Properties

Name Type Description
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.

assetKeyRequired
public java.lang.String getAssetKey();
  • Type: java.lang.String

Reference to the full key that was parsed.


basenameRequired
public java.lang.String getBasename();
  • Type: java.lang.String

The last segment of the key (which is the nested icon).

For instances and things this includes the dir prefix.


categoryRequired
public java.lang.String getCategory();
  • Type: java.lang.String

Category id.


instanceTypeOptional
public java.lang.String getInstanceType();
  • Type: java.lang.String

The instance type if key is for an ec2 instance.


iotThingOptional
public java.lang.String getIotThing();
  • Type: java.lang.String

The iot thing if key is for an iot thing.


resourceOptional
public java.lang.String getResource();
  • Type: java.lang.String

Resource id if key is for a resource.


serviceOptional
public java.lang.String getService();
  • Type: java.lang.String

Service id if key is partitioned by resource.


ParsedAssetKey

Parsed asset key.

Initializer

import software.aws.pdk.aws_arch.aws_arch.ParsedAssetKey;

ParsedAssetKey.builder()
    .assetKey(java.lang.String)
    .basename(java.lang.String)
    .category(java.lang.String)
//  .instanceType(java.lang.String)
//  .iotThing(java.lang.String)
//  .resource(java.lang.String)
//  .service(java.lang.String)
    .build();

Properties

Name Type Description
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.

assetKeyRequired
public java.lang.String getAssetKey();
  • Type: java.lang.String

Reference to the full key that was parsed.


basenameRequired
public java.lang.String getBasename();
  • Type: java.lang.String

The last segment of the key (which is the nested icon).

For instances and things this includes the dir prefix.


categoryRequired
public java.lang.String getCategory();
  • Type: java.lang.String

Category id.


instanceTypeOptional
public java.lang.String getInstanceType();
  • Type: java.lang.String

The instance type if key is for an ec2 instance.


iotThingOptional
public java.lang.String getIotThing();
  • Type: java.lang.String

The iot thing if key is for an iot thing.


resourceOptional
public java.lang.String getResource();
  • Type: java.lang.String

Resource id if key is for a resource.


serviceOptional
public java.lang.String getService();
  • Type: java.lang.String

Service id if key is partitioned by resource.


Theme

Theme definition.

Initializer

import software.aws.pdk.aws_arch.aws_arch.Theme;

Theme.builder()
    .arrows(ThemeArrows)
    .backgrounds(ThemeBackgrounds)
    .groups(ThemeGroups)
    .id(java.lang.String)
    .text(ThemeText)
    .build();

Properties

Name Type Description
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.

arrowsRequired
public ThemeArrows getArrows();
  • Type: software.aws.pdk.aws_arch.aws_arch.ThemeArrows

backgroundsRequired
public ThemeBackgrounds getBackgrounds();
  • Type: software.aws.pdk.aws_arch.aws_arch.ThemeBackgrounds

groupsRequired
public ThemeGroups getGroups();
  • Type: software.aws.pdk.aws_arch.aws_arch.ThemeGroups

idRequired
public java.lang.String getId();
  • Type: java.lang.String

textRequired
public ThemeText getText();
  • Type: software.aws.pdk.aws_arch.aws_arch.ThemeText

ThemeArrows

Theme arrow dictionary.

Initializer

import software.aws.pdk.aws_arch.aws_arch.ThemeArrows;

ThemeArrows.builder()
    .child(ArrowFormat)
    .default(ArrowFormat)
    .dependency(ArrowFormat)
    .reference(ArrowFormat)
    .build();

Properties

Name Type Description
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.

childRequired
public ArrowFormat getChild();
  • Type: software.aws.pdk.aws_arch.aws_arch.ArrowFormat

defaultRequired
public ArrowFormat getDefault();
  • Type: software.aws.pdk.aws_arch.aws_arch.ArrowFormat

dependencyRequired
public ArrowFormat getDependency();
  • Type: software.aws.pdk.aws_arch.aws_arch.ArrowFormat

referenceRequired
public ArrowFormat getReference();
  • Type: software.aws.pdk.aws_arch.aws_arch.ArrowFormat

ThemeBackgrounds

Theme background dictionary.

Initializer

import software.aws.pdk.aws_arch.aws_arch.ThemeBackgrounds;

ThemeBackgrounds.builder()
    .base(java.lang.String)
    .generic(java.lang.String)
    .private(java.lang.String)
    .public(java.lang.String)
    .build();

Properties

Name Type Description
base java.lang.String No description.
generic java.lang.String No description.
private java.lang.String No description.
public java.lang.String No description.

baseRequired
public java.lang.String getBase();
  • Type: java.lang.String

genericRequired
public java.lang.String getGeneric();
  • Type: java.lang.String

privateRequired
public java.lang.String getPrivate();
  • Type: java.lang.String

publicRequired
public java.lang.String getPublic();
  • Type: java.lang.String

ThemeGroups

Theme group dicionary.

Initializer

import software.aws.pdk.aws_arch.aws_arch.ThemeGroups;

ThemeGroups.builder()
    .autoScalingGroup(GroupFormat)
    .availabilityZone(GroupFormat)
    .awsAccount(GroupFormat)
    .awsIoTGreengrass(GroupFormat)
    .awsIoTGreengrassDeployment(GroupFormat)
    .awsStepFunctionsWorkflow(GroupFormat)
    .cloud(GroupFormat)
    .cloudAlt(GroupFormat)
    .corporateDataCenter(GroupFormat)
    .ec2InstanceContents(GroupFormat)
    .elasticBeanstalkContainer(GroupFormat)
    .generic(GroupFormat)
    .genericAlt(GroupFormat)
    .privateSubnet(GroupFormat)
    .publicSubnet(GroupFormat)
    .region(GroupFormat)
    .securityGroup(GroupFormat)
    .serverContents(GroupFormat)
    .spotFleet(GroupFormat)
    .vpc(GroupFormat)
    .build();

Properties

Name Type Description
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.

autoScalingGroupRequired
public GroupFormat getAutoScalingGroup();
  • Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat

availabilityZoneRequired
public GroupFormat getAvailabilityZone();
  • Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat

awsAccountRequired
public GroupFormat getAwsAccount();
  • Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat

awsIoTGreengrassRequired
public GroupFormat getAwsIoTGreengrass();
  • Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat

awsIoTGreengrassDeploymentRequired
public GroupFormat getAwsIoTGreengrassDeployment();
  • Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat

awsStepFunctionsWorkflowRequired
public GroupFormat getAwsStepFunctionsWorkflow();
  • Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat

cloudRequired
public GroupFormat getCloud();
  • Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat

cloudAltRequired
public GroupFormat getCloudAlt();
  • Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat

corporateDataCenterRequired
public GroupFormat getCorporateDataCenter();
  • Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat

ec2InstanceContentsRequired
public GroupFormat getEc2InstanceContents();
  • Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat

elasticBeanstalkContainerRequired
public GroupFormat getElasticBeanstalkContainer();
  • Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat

genericRequired
public GroupFormat getGeneric();
  • Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat

genericAltRequired
public GroupFormat getGenericAlt();
  • Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat

privateSubnetRequired
public GroupFormat getPrivateSubnet();
  • Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat

publicSubnetRequired
public GroupFormat getPublicSubnet();
  • Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat

regionRequired
public GroupFormat getRegion();
  • Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat

securityGroupRequired
public GroupFormat getSecurityGroup();
  • Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat

serverContentsRequired
public GroupFormat getServerContents();
  • Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat

spotFleetRequired
public GroupFormat getSpotFleet();
  • Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat

vpcRequired
public GroupFormat getVpc();
  • Type: software.aws.pdk.aws_arch.aws_arch.GroupFormat

ThemeText

Theme text dictionary.

Initializer

import software.aws.pdk.aws_arch.aws_arch.ThemeText;

ThemeText.builder()
    .default(java.lang.String)
    .primary(java.lang.String)
    .secondary(java.lang.String)
    .tertiary(java.lang.String)
    .build();

Properties

Name Type Description
default java.lang.String No description.
primary java.lang.String No description.
secondary java.lang.String No description.
tertiary java.lang.String No description.

defaultRequired
public java.lang.String getDefault();
  • Type: java.lang.String

primaryRequired
public java.lang.String getPrimary();
  • Type: java.lang.String

secondaryRequired
public java.lang.String getSecondary();
  • Type: java.lang.String

tertiaryRequired
public java.lang.String getTertiary();
  • Type: java.lang.String

Classes

AwsArchitecture

AwsArchitecture provides an interface for retrieving the inferred normalization between @aws-cdk/cfnspec and AWS Architecture Icons systems for all CloudFormation "services" and "resources".

Static Functions

Name Description
formatAssetPath 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.

formatAssetPath
import software.aws.pdk.aws_arch.AwsArchitecture;

AwsArchitecture.formatAssetPath(java.lang.String qualifiedAssetKey, java.lang.String format),AwsArchitecture.formatAssetPath(java.lang.String qualifiedAssetKey, java.lang.String format, java.lang.String theme)

Gets formatted asset path including extension and theme.

qualifiedAssetKeyRequired
  • Type: java.lang.String

The qualified asset key (eg: compute/ec2/service_icon, storage/s3/bucket).


formatRequired
  • Type: java.lang.String

The format to return (eg: png, svg).


themeOptional
  • Type: java.lang.String

(Optional) The theme to use, if not specific or now matching asset for the them, the default theme is used.


getCategory
import software.aws.pdk.aws_arch.AwsArchitecture;

AwsArchitecture.getCategory(java.lang.String category)

Get specific category based on id.

{@link AwsCategory.getCategory }

categoryRequired
  • Type: java.lang.String

getInstanceTypeIcon
import software.aws.pdk.aws_arch.AwsArchitecture;

AwsArchitecture.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)

Get icon for EC2 instance type.

instanceTypeRequired
  • Type: java.lang.String

The {@link AwsAsset.InstanceType} to get icon for.


formatOptional
  • Type: java.lang.String

The format of icon.


themeOptional
  • Type: java.lang.String

Optional theme.


getRdsInstanceTypeIcon
import software.aws.pdk.aws_arch.AwsArchitecture;

AwsArchitecture.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)

Get icon for RDS instance type.

instanceTypeRequired
  • Type: java.lang.String

The {@link AwsAsset.RdsInstanceType} to get icon for.


formatOptional
  • Type: java.lang.String

The format of icon.


themeOptional
  • Type: java.lang.String

Optional theme.


getResource
import software.aws.pdk.aws_arch.AwsArchitecture;

AwsArchitecture.getResource(java.lang.String cfnType)

Get resource based on Cfn Resource Type (eg: AWS::S3::Bucket).

{@link AwsResource.getResource }

cfnTypeRequired
  • Type: java.lang.String

getService
import software.aws.pdk.aws_arch.AwsArchitecture;

AwsArchitecture.getService(java.lang.String identifier)

Get specific service based on identifier (eg: S3, AWS::S3, AWS::S3::Bucket).

{@link AwsSerfice.getService }

identifierRequired
  • Type: java.lang.String

parseAssetPath
import software.aws.pdk.aws_arch.AwsArchitecture;

AwsArchitecture.parseAssetPath(java.lang.String assetPath)

Parse assets path into part descriptor.

assetPathRequired
  • Type: java.lang.String

Absolute or relative asset file path to parse.


resolveAssetPath
import software.aws.pdk.aws_arch.AwsArchitecture;

AwsArchitecture.resolveAssetPath(java.lang.String assetPath)

Resolve relative asset path to absolute asset path.

assetPathRequired
  • Type: java.lang.String

The relative asset path to resolve.


resolveAssetSvgDataUrl
import software.aws.pdk.aws_arch.AwsArchitecture;

AwsArchitecture.resolveAssetSvgDataUrl(java.lang.String svgAssetPath)

Resolve relative asset path as SVG Data URL.

data:image/svg+xml;base64,...

svgAssetPathRequired
  • Type: java.lang.String

The relative path of svg asset to resolve.


Properties

Name Type Description
assetDirectory 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.

assetDirectoryRequired
public java.lang.String getAssetDirectory();
  • Type: java.lang.String

The absolute directory where AWS Architecture Icons are stored and retrieved.


categoriesRequired
public java.util.Map<java.lang.String, AwsCategory> getCategories();
  • Type: java.util.MapAwsCategory\>

Get all categories.

{@link AwsCategory.categories }


resourcesRequired
public java.util.Map<java.lang.String, AwsResource> getResources();
  • Type: java.util.MapAwsResource\>

Get all resources.

{@link AwsResource.resources }


servicesRequired
public java.util.Map<java.lang.String, AwsService> getServices();
  • Type: java.util.MapAwsService\>

Get all services.

{@link AwsService.services }


AwsCategory

AwsCategory class provides an interface for normalizing category metadata between mapped systems.

Methods

Name Description
categoryServices 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.

categoryServices
public java.util.List<AwsService> categoryServices()

Gets a list of all services within this category.

icon
public java.lang.String icon(java.lang.String format)
public java.lang.String icon(java.lang.String format, java.lang.String theme)

Retrieves a well-formatted relative path to the icon for this given category in the specified format.

formatRequired
  • Type: java.lang.String

themeOptional
  • Type: java.lang.String

Static Functions

Name Description
getCategory Get {@link AwsCategory} based on {@link AwsCategoryId}.

getCategory
import software.aws.pdk.aws_arch.AwsCategory;

AwsCategory.getCategory(java.lang.String id)

Get {@link AwsCategory} based on {@link AwsCategoryId}.

idRequired
  • Type: java.lang.String

The id of the category to retrieve.


Properties

Name Type Description
categories 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.

categoriesRequired
public java.util.Map<java.lang.String, AwsCategory> getCategories();
  • Type: java.util.MapAwsCategory\>

Get record of all categories keyed by category id.


fillColorRequired
public java.lang.String getFillColor();
  • Type: java.lang.String

Fill color for the category.


fontColorRequired
public java.lang.String getFontColor();
  • Type: java.lang.String

Font color for the category.


gradientColorRequired
public java.lang.String getGradientColor();
  • Type: java.lang.String

Gradien color for the category.


idRequired
public java.lang.String getId();
  • Type: java.lang.String

The unique id of the category.


Example

"security_identity_compliance";
nameRequired
public java.lang.String getName();
  • Type: java.lang.String

The proper name of the category.


Example

"Security, Identity, & Compliance";
variantsRequired
public java.util.List<java.lang.String> getVariants();
  • Type: java.util.List

Alternative names used to identity this category.


drawioStylesOptional
public AwsCategoryDrawioStyles getDrawioStyles();

Drawio style definition for this category.


AwsCategoryDrawioStyles

AwsCategoryDrawioStyles is a utility class for constructing drawio shape styles for services and resources.

Initializers

import software.aws.pdk.aws_arch.AwsCategoryDrawioStyles;

AwsCategoryDrawioStyles.Builder.create(ShapeNames categoryShape)
    .align(java.lang.String)
    .aspect(java.lang.String)
    .dashed(java.lang.Number)
    .fontSize(java.lang.Number)
    .fontStyle(java.lang.String)
    .fontStyle(java.lang.Number)
    .gradientDirection(java.lang.String)
    .html(java.lang.Number)
    .outlineConnect(java.lang.Number)
    .strokeColor(java.lang.String)
    .verticalAlign(java.lang.String)
    .verticalLabelPosition(java.lang.String)
//  .pointerEvent(java.lang.Number)
    .fillColor(java.lang.String)
    .fontColor(java.lang.String)
    .gradientColor(java.lang.String)
    .build();
Name Type Description
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.

categoryShapeRequired
  • Type: software.aws.pdk.aws_arch.aws_arch.DrawioSpec.Aws4.ShapeNames

alignRequired
  • Type: java.lang.String

aspectRequired
  • Type: java.lang.String

dashedRequired
  • Type: java.lang.Number

fontSizeRequired
  • Type: java.lang.Number

fontStyleRequired
  • Type: java.lang.String OR java.lang.Number

gradientDirectionRequired
  • Type: java.lang.String

htmlRequired
  • Type: java.lang.Number

outlineConnectRequired
  • Type: java.lang.Number

strokeColorRequired
  • Type: java.lang.String

verticalAlignRequired
  • Type: java.lang.String

verticalLabelPositionRequired
  • Type: java.lang.String

pointerEventOptional
  • Type: java.lang.Number

fillColorRequired
  • Type: java.lang.String

fontColorRequired
  • Type: java.lang.String

gradientColorRequired
  • Type: java.lang.String

Methods

Name Description
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.

getResourceStyle
public AwsDrawioShapeStyle getResourceStyle(ShapeNames resourceShape)

Gets the drawio style for a resource based on the category style.

resourceShapeRequired
  • Type: software.aws.pdk.aws_arch.aws_arch.DrawioSpec.Aws4.ShapeNames

The resource shape to style based on category.


getServiceStyle
public AwsDrawioResourceIconStyle getServiceStyle(ShapeNames serviceShape)

Gets the drawio style for a service based on the category style.

serviceShapeRequired
  • Type: software.aws.pdk.aws_arch.aws_arch.DrawioSpec.Aws4.ShapeNames

The service shape to style based on category.


Properties

Name Type Description
base 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.

baseRequired
public DrawioAwsResourceIconStyleBase getBase();
  • Type: software.aws.pdk.aws_arch.aws_arch.DrawioAwsResourceIconStyleBase

categoryShapeRequired
public ShapeNames getCategoryShape();
  • Type: software.aws.pdk.aws_arch.aws_arch.DrawioSpec.Aws4.ShapeNames

categoryStyleRequired
public AwsDrawioResourceIconStyle getCategoryStyle();

Get the drawio style for this category.


AwsResource

AwsResource class provides an interface for normalizing resource metadata between mapped systems.

Methods

Name Description
drawioStyle 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.

drawioStyle
public AwsDrawioShapeStyle drawioStyle()

Gets the draiwio style for the resource.

getCategoryIcon
public java.lang.String getCategoryIcon(java.lang.String format)
public java.lang.String getCategoryIcon(java.lang.String format, java.lang.String theme)

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 }

formatRequired
  • Type: java.lang.String

The format of icon.


themeOptional
  • Type: java.lang.String

Optional theme.


getGeneralIcon
public java.lang.String getGeneralIcon(java.lang.String format)
public java.lang.String getGeneralIcon(java.lang.String format, java.lang.String theme)

Gets the general icon for the resource if available.

formatRequired
  • Type: java.lang.String

The format of icon.


themeOptional
  • Type: java.lang.String

Optional theme.


getResourceIcon
public java.lang.String getResourceIcon(java.lang.String format)
public java.lang.String getResourceIcon(java.lang.String format, java.lang.String theme)

Gets the resource specific icon for the resource.

formatRequired
  • Type: java.lang.String

The format of icon.


themeOptional
  • Type: java.lang.String

Optional theme.


getServiceIcon
public java.lang.String getServiceIcon(java.lang.String format)
public java.lang.String getServiceIcon(java.lang.String format, java.lang.String theme)

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 }

formatRequired
  • Type: java.lang.String

The format of icon.


themeOptional
  • Type: java.lang.String

Optional theme.


icon
public java.lang.String icon(java.lang.String format)
public java.lang.String icon(java.lang.String format, java.lang.String theme)

Gets the best icon match for the resource following the order of: 1.

explicit resource icon 2. general icon 3. service icon

formatRequired
  • Type: java.lang.String

The format of icon.


themeOptional
  • Type: java.lang.String

Optional theme.


Static Functions

Name Description
findResource Find {@link AwsResource} associated with given value.
getResource Get {@link AwsResource} by CloudFormation resource type.

findResource
import software.aws.pdk.aws_arch.AwsResource;

AwsResource.findResource(java.lang.String value)

Find {@link AwsResource} associated with given value.

valueRequired
  • Type: java.lang.String

The value to match {@link AwsResource};

can be id, asset key, full name, etc.


getResource
import software.aws.pdk.aws_arch.AwsResource;

AwsResource.getResource(java.lang.String cfnResourceType)

Get {@link AwsResource} by CloudFormation resource type.

cfnResourceTypeRequired
  • Type: java.lang.String

Fully qualifief CloudFormation resource type (eg: AWS:S3:Bucket).


Properties

Name Type Description
resources 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.

resourcesRequired
public java.util.Map<java.lang.String, AwsResource> getResources();
  • Type: java.util.MapAwsResource\>

Get record of all resources keyed by resource id.


cfnResourceTypeRequired
public java.lang.String getCfnResourceType();
  • Type: java.lang.String

Fully-qualified CloudFormation resource type (eg: "AWS:S3:Bucket").


serviceRequired
public AwsService getService();

The {@link AwsService} the resource belongs to.


drawioShapeOptional
public ShapeNames getDrawioShape();
  • Type: software.aws.pdk.aws_arch.aws_arch.DrawioSpec.Aws4.ShapeNames

The drawio shape mapped to this resource, or undefined if no mapping.


fullNameOptional
public java.lang.String getFullName();
  • Type: java.lang.String

The proper full name of the resource.


Example

// Example automatically generated from non-compiling source. May contain errors.
"Bucket" , "Amazon S3 on Outposts";

AwsService

AwsService class provides an interface for normalizing service metadata between mapped systems.

Methods

Name Description
drawioStyle 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.

drawioStyle
public AwsDrawioResourceIconStyle drawioStyle()

Get drawio style for this service.

icon
public java.lang.String icon(java.lang.String format)
public java.lang.String icon(java.lang.String format, java.lang.String theme)

Get relative asset icon for the service for a given format and optional theme.

formatRequired
  • Type: java.lang.String

The format of icon.


themeOptional
  • Type: java.lang.String

Optional theme.


serviceResources
public java.util.List<AwsResource> serviceResources()

List all resources of this service.

Static Functions

Name Description
findService 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>.

findService
import software.aws.pdk.aws_arch.AwsService;

AwsService.findService(java.lang.String value)

Finds the {@link AwsService} associated with a given value.

valueRequired
  • Type: java.lang.String

Value to match {@link AwsService}, which can be id, assetKey, fullName, etc.


getService
import software.aws.pdk.aws_arch.AwsService;

AwsService.getService(java.lang.String cfnService)

Get {@link AwsService} by CloudFormation "service" name, where service name is expressed as <provider>::<service>::<resource>.

cfnServiceRequired
  • Type: java.lang.String

The service name to retrieve {@link AwsService} for.


Properties

Name Type Description
services 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 pricing serviceCode associated with this service, or undefined if service not mapped to pricing.

servicesRequired
public java.util.Map<java.lang.String, AwsService> getServices();
  • Type: java.util.MapAwsService\>

Get record of all {@link AwsService}s keyed by id.


cfnProviderRequired
public java.lang.String getCfnProvider();
  • Type: java.lang.String

The CloudFormation "provider" for the service, as expressed by <provicer>::<service>::<resource>.


cfnServiceRequired
public java.lang.String getCfnService();
  • Type: java.lang.String

The CloudFormation "service" for the service, as expressed by <provicer>::<service>::<resource>.


fullNameRequired
public java.lang.String getFullName();
  • Type: java.lang.String

The proper full name of the service.


Example

// Example automatically generated from non-compiling source. May contain errors.
"AWS Glue" , "Amazon S3";
categoryOptional
public AwsCategory getCategory();

The category the service belongs to, or undefined if does not belong to a category.


drawioShapeOptional
public ShapeNames getDrawioShape();
  • 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.


pricingMetadataOptional
public Service getPricingMetadata();
  • Type: software.aws.pdk.aws_arch.aws_arch.PricingManifest.Service

Get service pricing metadata.


pricingServiceCodeOptional
public java.lang.String getPricingServiceCode();
  • Type: java.lang.String

The pricing serviceCode associated with this service, or undefined if service not mapped to pricing.


Enums

DarkPalette

Dark theme color palette.

Members

Name Description
PUBLIC No description.
PRIVATE No description.
GENERIC No description.
PRIMARY No description.
SECONDARY No description.
TERTIARY No description.

PUBLIC

PRIVATE

GENERIC

PRIMARY

SECONDARY

TERTIARY

DrawioAws4ParentShapes

Draiwio aws4 parent shapes enum.

Members

Name Description
RESOURCE_ICON No description.

RESOURCE_ICON

LightPalette

Light theme color palette.

Members

Name Description
PUBLIC No description.
PRIVATE No description.
GENERIC No description.
PRIMARY No description.
SECONDARY No description.
TERTIARY No description.

PUBLIC

PRIVATE

GENERIC

PRIMARY

SECONDARY

TERTIARY


Last update: 2024-12-20