API Reference

Structs

ArrowFormat

Theme arrow format definition.

Initializer

import { aws_arch } from '@aws/pdk/aws-arch'

const arrowFormat: aws_arch.ArrowFormat = { ... }

Properties

Name	Type	Description
color	string | boolean	No description.
head	string	No description.
style	string	No description.
tail	string	No description.
width	number	No description.

---

color^Required

public readonly color: string | boolean;

• Type: string | boolean

---

head^Required

public readonly head: string;

• Type: string

---

style^Required

public readonly style: string;

• Type: string

---

tail^Required

public readonly tail: string;

• Type: string

---

width^Required

public readonly width: number;

• Type: number

---

AwsCategoryDefinition

Category definition.

Initializer

import { aws_arch } from '@aws/pdk/aws-arch'

const awsCategoryDefinition: aws_arch.AwsCategoryDefinition = { ... }

Properties

Name	Type	Description
fillColor	string	No description.
gradientColor	string	No description.
id	string	No description.
name	string	No description.
fontColor	string	No description.
variants	string[]	No description.

---

fillColor^Required

public readonly fillColor: string;

• Type: string

---

gradientColor^Required

public readonly gradientColor: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

name^Required

public readonly name: string;

• Type: string

---

fontColor^Optional

public readonly fontColor: string;

• Type: string

---

variants^Optional

public readonly variants: string[];

• Type: string[]

---

AwsDrawioResourceIconStyle

Drawio resource icon style definition for AWS Resources.

Initializer

import { AwsDrawioResourceIconStyle } from '@aws/pdk/aws-arch'

const awsDrawioResourceIconStyle: AwsDrawioResourceIconStyle = { ... }

Properties

Name	Type	Description
align	string	No description.
aspect	string	No description.
dashed	number	No description.
fontSize	number	No description.
fontStyle	string | number	No description.
gradientDirection	string	No description.
html	number	No description.
outlineConnect	number	No description.
strokeColor	string	No description.
verticalAlign	string	No description.
verticalLabelPosition	string	No description.
pointerEvent	number	No description.
fillColor	string	No description.
fontColor	string	No description.
gradientColor	string	No description.
resIcon	aws/pdk/aws-arch.aws_arch.DrawioSpec.Aws4.ShapeNames	No description.
shape	aws/pdk/aws-arch.aws_arch.DrawioAws4ParentShapes	No description.

---

align^Required

public readonly align: string;

• Type: string

---

aspect^Required

public readonly aspect: string;

• Type: string

---

dashed^Required

public readonly dashed: number;

• Type: number

---

fontSize^Required

public readonly fontSize: number;

• Type: number

---

fontStyle^Required

public readonly fontStyle: string | number;

• Type: string | number

---

gradientDirection^Required

public readonly gradientDirection: string;

• Type: string

---

html^Required

public readonly html: number;

• Type: number

---

outlineConnect^Required

public readonly outlineConnect: number;

• Type: number

---

strokeColor^Required

public readonly strokeColor: string;

• Type: string

---

verticalAlign^Required

public readonly verticalAlign: string;

• Type: string

---

verticalLabelPosition^Required

public readonly verticalLabelPosition: string;

• Type: string

---

pointerEvent^Optional

public readonly pointerEvent: number;

• Type: number

---

fillColor^Required

public readonly fillColor: string;

• Type: string

---

fontColor^Required

public readonly fontColor: string;

• Type: string

---

gradientColor^Required

public readonly gradientColor: string;

• Type: string

---

resIcon^Required

public readonly resIcon: ShapeNames;

• Type: aws/pdk/aws-arch.aws_arch.DrawioSpec.Aws4.ShapeNames

---

shape^Required

public readonly shape: DrawioAws4ParentShapes;

• Type: aws/pdk/aws-arch.aws_arch.DrawioAws4ParentShapes

---

AwsDrawioShapeStyle

Drawio shape based style definition.

Initializer

import { AwsDrawioShapeStyle } from '@aws/pdk/aws-arch'

const awsDrawioShapeStyle: AwsDrawioShapeStyle = { ... }

Properties

Name	Type	Description
align	string	No description.
aspect	string	No description.
dashed	number	No description.
fontSize	number	No description.
fontStyle	string | number	No description.
gradientDirection	string	No description.
html	number	No description.
outlineConnect	number	No description.
strokeColor	string	No description.
verticalAlign	string	No description.
verticalLabelPosition	string	No description.
pointerEvent	number	No description.
fillColor	string	No description.
fontColor	string	No description.
gradientColor	string	No description.
shape	aws/pdk/aws-arch.aws_arch.DrawioSpec.Aws4.ShapeNames	No description.

---

align^Required

public readonly align: string;

• Type: string

---

aspect^Required

public readonly aspect: string;

• Type: string

---

dashed^Required

public readonly dashed: number;

• Type: number

---

fontSize^Required

public readonly fontSize: number;

• Type: number

---

fontStyle^Required

public readonly fontStyle: string | number;

• Type: string | number

---

gradientDirection^Required

public readonly gradientDirection: string;

• Type: string

---

html^Required

public readonly html: number;

• Type: number

---

outlineConnect^Required

public readonly outlineConnect: number;

• Type: number

---

strokeColor^Required

public readonly strokeColor: string;

• Type: string

---

verticalAlign^Required

public readonly verticalAlign: string;

• Type: string

---

verticalLabelPosition^Required

public readonly verticalLabelPosition: string;

• Type: string

---

pointerEvent^Optional

public readonly pointerEvent: number;

• Type: number

---

fillColor^Required

public readonly fillColor: string;

• Type: string

---

fontColor^Required

public readonly fontColor: string;

• Type: string

---

gradientColor^Required

public readonly gradientColor: string;

• Type: string

---

shape^Required

public readonly shape: ShapeNames;

• Type: aws/pdk/aws-arch.aws_arch.DrawioSpec.Aws4.ShapeNames

---

DrawioAwsResourceIconStyleBase

Based style definition for drawio aws resource icon.

Initializer

import { aws_arch } from '@aws/pdk/aws-arch'

const drawioAwsResourceIconStyleBase: aws_arch.DrawioAwsResourceIconStyleBase = { ... }

Properties

Name	Type	Description
align	string	No description.
aspect	string	No description.
dashed	number	No description.
fontSize	number	No description.
fontStyle	string | number	No description.
gradientDirection	string	No description.
html	number	No description.
outlineConnect	number	No description.
strokeColor	string	No description.
verticalAlign	string	No description.
verticalLabelPosition	string	No description.
pointerEvent	number	No description.
fillColor	string	No description.
fontColor	string	No description.
gradientColor	string	No description.

---

align^Required

public readonly align: string;

• Type: string

---

aspect^Required

public readonly aspect: string;

• Type: string

---

dashed^Required

public readonly dashed: number;

• Type: number

---

fontSize^Required

public readonly fontSize: number;

• Type: number

---

fontStyle^Required

public readonly fontStyle: string | number;

• Type: string | number

---

gradientDirection^Required

public readonly gradientDirection: string;

• Type: string

---

html^Required

public readonly html: number;

• Type: number

---

outlineConnect^Required

public readonly outlineConnect: number;

• Type: number

---

strokeColor^Required

public readonly strokeColor: string;

• Type: string

---

verticalAlign^Required

public readonly verticalAlign: string;

• Type: string

---

verticalLabelPosition^Required

public readonly verticalLabelPosition: string;

• Type: string

---

pointerEvent^Optional

public readonly pointerEvent: number;

• Type: number

---

fillColor^Required

public readonly fillColor: string;

• Type: string

---

fontColor^Required

public readonly fontColor: string;

• Type: string

---

gradientColor^Required

public readonly gradientColor: string;

• Type: string

---

DrawioAwsShapeStyleBase

Base definition of drawio aws shape style.

Initializer

import { aws_arch } from '@aws/pdk/aws-arch'

const drawioAwsShapeStyleBase: aws_arch.DrawioAwsShapeStyleBase = { ... }

Properties

Name	Type	Description
align	string	No description.
aspect	string	No description.
dashed	number	No description.
fontSize	number	No description.
fontStyle	string | number	No description.
gradientDirection	string	No description.
html	number	No description.
outlineConnect	number	No description.
strokeColor	string	No description.
verticalAlign	string	No description.
verticalLabelPosition	string	No description.
pointerEvent	number	No description.

---

align^Required

public readonly align: string;

• Type: string

---

aspect^Required

public readonly aspect: string;

• Type: string

---

dashed^Required

public readonly dashed: number;

• Type: number

---

fontSize^Required

public readonly fontSize: number;

• Type: number

---

fontStyle^Required

public readonly fontStyle: string | number;

• Type: string | number

---

gradientDirection^Required

public readonly gradientDirection: string;

• Type: string

---

html^Required

public readonly html: number;

• Type: number

---

outlineConnect^Required

public readonly outlineConnect: number;

• Type: number

---

strokeColor^Required

public readonly strokeColor: string;

• Type: string

---

verticalAlign^Required

public readonly verticalAlign: string;

• Type: string

---

verticalLabelPosition^Required

public readonly verticalLabelPosition: string;

• Type: string

---

pointerEvent^Optional

public readonly pointerEvent: number;

• Type: number

---

GroupFormat

Theme group format definition.

Initializer

import { aws_arch } from '@aws/pdk/aws-arch'

const groupFormat: aws_arch.GroupFormat = { ... }

Properties

Name	Type	Description
bgcolor	string | boolean	No description.
borderColor	string | boolean	No description.
borderStyle	string	No description.
color	string | boolean	No description.
iconPng	string	No description.
labelLocation	string	No description.

---

bgcolor^Required

public readonly bgcolor: string | boolean;

• Type: string | boolean

---

borderColor^Required

public readonly borderColor: string | boolean;

• Type: string | boolean

---

borderStyle^Required

public readonly borderStyle: string;

• Type: string

---

color^Required

public readonly color: string | boolean;

• Type: string | boolean

---

iconPng^Optional

public readonly iconPng: string;

• Type: string

---

labelLocation^Optional

public readonly labelLocation: string;

• Type: string

---

ParsedAssetKey

Parsed asset key.

Initializer

import { ParsedAssetKey } from '@aws/pdk/aws-arch'

const parsedAssetKey: ParsedAssetKey = { ... }

Properties

Name	Type	Description
assetKey	string	Reference to the full key that was parsed.
basename	string	The last segment of the key (which is the nested icon).
category	string	Category id.
instanceType	string	The instance type if key is for an ec2 instance.
iotThing	string	The iot thing if key is for an iot thing.
resource	string	Resource id if key is for a resource.
service	string	Service id if key is partitioned by resource.

---

assetKey^Required

public readonly assetKey: string;

• Type: string

Reference to the full key that was parsed.

---

basename^Required

public readonly basename: string;

• Type: string

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

For instances and things this includes the dir prefix.

---

category^Required

public readonly category: string;

• Type: string

Category id.

---

instanceType^Optional

public readonly instanceType: string;

• Type: string

The instance type if key is for an ec2 instance.

---

iotThing^Optional

public readonly iotThing: string;

• Type: string

The iot thing if key is for an iot thing.

---

resource^Optional

public readonly resource: string;

• Type: string

Resource id if key is for a resource.

---

service^Optional

public readonly service: string;

• Type: string

Service id if key is partitioned by resource.

---

ParsedAssetKey

Parsed asset key.

Initializer

import { aws_arch } from '@aws/pdk/aws-arch'

const parsedAssetKey: aws_arch.ParsedAssetKey = { ... }

Properties

Name	Type	Description
assetKey	string	Reference to the full key that was parsed.
basename	string	The last segment of the key (which is the nested icon).
category	string	Category id.
instanceType	string	The instance type if key is for an ec2 instance.
iotThing	string	The iot thing if key is for an iot thing.
resource	string	Resource id if key is for a resource.
service	string	Service id if key is partitioned by resource.

---

assetKey^Required

public readonly assetKey: string;

• Type: string

Reference to the full key that was parsed.

---

basename^Required

public readonly basename: string;

• Type: string

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

For instances and things this includes the dir prefix.

---

category^Required

public readonly category: string;

• Type: string

Category id.

---

instanceType^Optional

public readonly instanceType: string;

• Type: string

The instance type if key is for an ec2 instance.

---

iotThing^Optional

public readonly iotThing: string;

• Type: string

The iot thing if key is for an iot thing.

---

resource^Optional

public readonly resource: string;

• Type: string

Resource id if key is for a resource.

---

service^Optional

public readonly service: string;

• Type: string

Service id if key is partitioned by resource.

---

Theme

Theme definition.

Initializer

import { aws_arch } from '@aws/pdk/aws-arch'

const theme: aws_arch.Theme = { ... }

Properties

Name	Type	Description
arrows	aws/pdk/aws-arch.aws_arch.ThemeArrows	No description.
backgrounds	aws/pdk/aws-arch.aws_arch.ThemeBackgrounds	No description.
groups	aws/pdk/aws-arch.aws_arch.ThemeGroups	No description.
id	string	No description.
text	aws/pdk/aws-arch.aws_arch.ThemeText	No description.

---

arrows^Required

public readonly arrows: ThemeArrows;

• Type: aws/pdk/aws-arch.aws_arch.ThemeArrows

---

backgrounds^Required

public readonly backgrounds: ThemeBackgrounds;

• Type: aws/pdk/aws-arch.aws_arch.ThemeBackgrounds

---

groups^Required

public readonly groups: ThemeGroups;

• Type: aws/pdk/aws-arch.aws_arch.ThemeGroups

---

id^Required

public readonly id: string;

• Type: string

---

text^Required

public readonly text: ThemeText;

• Type: aws/pdk/aws-arch.aws_arch.ThemeText

---

ThemeArrows

Theme arrow dictionary.

Initializer

import { aws_arch } from '@aws/pdk/aws-arch'

const themeArrows: aws_arch.ThemeArrows = { ... }

Properties

Name	Type	Description
child	aws/pdk/aws-arch.aws_arch.ArrowFormat	No description.
default	aws/pdk/aws-arch.aws_arch.ArrowFormat	No description.
dependency	aws/pdk/aws-arch.aws_arch.ArrowFormat	No description.
reference	aws/pdk/aws-arch.aws_arch.ArrowFormat	No description.

---

child^Required

public readonly child: ArrowFormat;

• Type: aws/pdk/aws-arch.aws_arch.ArrowFormat

---

default^Required

public readonly default: ArrowFormat;

• Type: aws/pdk/aws-arch.aws_arch.ArrowFormat

---

dependency^Required

public readonly dependency: ArrowFormat;

• Type: aws/pdk/aws-arch.aws_arch.ArrowFormat

---

reference^Required

public readonly reference: ArrowFormat;

• Type: aws/pdk/aws-arch.aws_arch.ArrowFormat

---

ThemeBackgrounds

Theme background dictionary.

Initializer

import { aws_arch } from '@aws/pdk/aws-arch'

const themeBackgrounds: aws_arch.ThemeBackgrounds = { ... }

Properties

Name	Type	Description
base	string	No description.
generic	string	No description.
private	string	No description.
public	string	No description.

---

base^Required

public readonly base: string;

• Type: string

---

generic^Required

public readonly generic: string;

• Type: string

---

private^Required

public readonly private: string;

• Type: string

---

public^Required

public readonly public: string;

• Type: string

---

ThemeGroups

Theme group dicionary.

Initializer

import { aws_arch } from '@aws/pdk/aws-arch'

const themeGroups: aws_arch.ThemeGroups = { ... }

Properties

Name	Type	Description
autoScalingGroup	aws/pdk/aws-arch.aws_arch.GroupFormat	No description.
availabilityZone	aws/pdk/aws-arch.aws_arch.GroupFormat	No description.
awsAccount	aws/pdk/aws-arch.aws_arch.GroupFormat	No description.
awsIoTGreengrass	aws/pdk/aws-arch.aws_arch.GroupFormat	No description.
awsIoTGreengrassDeployment	aws/pdk/aws-arch.aws_arch.GroupFormat	No description.
awsStepFunctionsWorkflow	aws/pdk/aws-arch.aws_arch.GroupFormat	No description.
cloud	aws/pdk/aws-arch.aws_arch.GroupFormat	No description.
cloudAlt	aws/pdk/aws-arch.aws_arch.GroupFormat	No description.
corporateDataCenter	aws/pdk/aws-arch.aws_arch.GroupFormat	No description.
ec2InstanceContents	aws/pdk/aws-arch.aws_arch.GroupFormat	No description.
elasticBeanstalkContainer	aws/pdk/aws-arch.aws_arch.GroupFormat	No description.
generic	aws/pdk/aws-arch.aws_arch.GroupFormat	No description.
genericAlt	aws/pdk/aws-arch.aws_arch.GroupFormat	No description.
privateSubnet	aws/pdk/aws-arch.aws_arch.GroupFormat	No description.
publicSubnet	aws/pdk/aws-arch.aws_arch.GroupFormat	No description.
region	aws/pdk/aws-arch.aws_arch.GroupFormat	No description.
securityGroup	aws/pdk/aws-arch.aws_arch.GroupFormat	No description.
serverContents	aws/pdk/aws-arch.aws_arch.GroupFormat	No description.
spotFleet	aws/pdk/aws-arch.aws_arch.GroupFormat	No description.
vpc	aws/pdk/aws-arch.aws_arch.GroupFormat	No description.

---

autoScalingGroup^Required

public readonly autoScalingGroup: GroupFormat;

• Type: aws/pdk/aws-arch.aws_arch.GroupFormat

---

availabilityZone^Required

public readonly availabilityZone: GroupFormat;

• Type: aws/pdk/aws-arch.aws_arch.GroupFormat

---

awsAccount^Required

public readonly awsAccount: GroupFormat;

• Type: aws/pdk/aws-arch.aws_arch.GroupFormat

---

awsIoTGreengrass^Required

public readonly awsIoTGreengrass: GroupFormat;

• Type: aws/pdk/aws-arch.aws_arch.GroupFormat

---

awsIoTGreengrassDeployment^Required

public readonly awsIoTGreengrassDeployment: GroupFormat;

• Type: aws/pdk/aws-arch.aws_arch.GroupFormat

---

awsStepFunctionsWorkflow^Required

public readonly awsStepFunctionsWorkflow: GroupFormat;

• Type: aws/pdk/aws-arch.aws_arch.GroupFormat

---

cloud^Required

public readonly cloud: GroupFormat;

• Type: aws/pdk/aws-arch.aws_arch.GroupFormat

---

cloudAlt^Required

public readonly cloudAlt: GroupFormat;

• Type: aws/pdk/aws-arch.aws_arch.GroupFormat

---

corporateDataCenter^Required

public readonly corporateDataCenter: GroupFormat;

• Type: aws/pdk/aws-arch.aws_arch.GroupFormat

---

ec2InstanceContents^Required

public readonly ec2InstanceContents: GroupFormat;

• Type: aws/pdk/aws-arch.aws_arch.GroupFormat

---

elasticBeanstalkContainer^Required

public readonly elasticBeanstalkContainer: GroupFormat;

• Type: aws/pdk/aws-arch.aws_arch.GroupFormat

---

generic^Required

public readonly generic: GroupFormat;

• Type: aws/pdk/aws-arch.aws_arch.GroupFormat

---

genericAlt^Required

public readonly genericAlt: GroupFormat;

• Type: aws/pdk/aws-arch.aws_arch.GroupFormat

---

privateSubnet^Required

public readonly privateSubnet: GroupFormat;

• Type: aws/pdk/aws-arch.aws_arch.GroupFormat

---

publicSubnet^Required

public readonly publicSubnet: GroupFormat;

• Type: aws/pdk/aws-arch.aws_arch.GroupFormat

---

region^Required

public readonly region: GroupFormat;

• Type: aws/pdk/aws-arch.aws_arch.GroupFormat

---

securityGroup^Required

public readonly securityGroup: GroupFormat;

• Type: aws/pdk/aws-arch.aws_arch.GroupFormat

---

serverContents^Required

public readonly serverContents: GroupFormat;

• Type: aws/pdk/aws-arch.aws_arch.GroupFormat

---

spotFleet^Required

public readonly spotFleet: GroupFormat;

• Type: aws/pdk/aws-arch.aws_arch.GroupFormat

---

vpc^Required

public readonly vpc: GroupFormat;

• Type: aws/pdk/aws-arch.aws_arch.GroupFormat

---

ThemeText

Theme text dictionary.

Initializer

import { aws_arch } from '@aws/pdk/aws-arch'

const themeText: aws_arch.ThemeText = { ... }

Properties

Name	Type	Description
default	string	No description.
primary	string	No description.
secondary	string	No description.
tertiary	string	No description.

---

default^Required

public readonly default: string;

• Type: string

---

primary^Required

public readonly primary: string;

• Type: string

---

secondary^Required

public readonly secondary: string;

• Type: string

---

tertiary^Required

public readonly tertiary: string;

• Type: 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 { AwsArchitecture } from '@aws/pdk/aws-arch'

AwsArchitecture.formatAssetPath(qualifiedAssetKey: string, format: string, theme?: string)

Gets formatted asset path including extension and theme.

qualifiedAssetKey^Required

• Type: string

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

---

format^Required

• Type: string

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

---

theme^Optional

• Type: string

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

---

getCategory

import { AwsArchitecture } from '@aws/pdk/aws-arch'

AwsArchitecture.getCategory(category: string)

Get specific category based on id.

{@link AwsCategory.getCategory }

category^Required

• Type: string

---

getInstanceTypeIcon

import { AwsArchitecture } from '@aws/pdk/aws-arch'

AwsArchitecture.getInstanceTypeIcon(instanceType: string, format?: string, theme?: string)

Get icon for EC2 instance type.

instanceType^Required

• Type: string

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

---

format^Optional

• Type: string

The format of icon.

---

theme^Optional

• Type: string

Optional theme.

---

getRdsInstanceTypeIcon

import { AwsArchitecture } from '@aws/pdk/aws-arch'

AwsArchitecture.getRdsInstanceTypeIcon(instanceType: string, format?: string, theme?: string)

Get icon for RDS instance type.

instanceType^Required

• Type: string

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

---

format^Optional

• Type: string

The format of icon.

---

theme^Optional

• Type: string

Optional theme.

---

getResource

import { AwsArchitecture } from '@aws/pdk/aws-arch'

AwsArchitecture.getResource(cfnType: string)

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

{@link AwsResource.getResource }

cfnType^Required

• Type: string

---

getService

import { AwsArchitecture } from '@aws/pdk/aws-arch'

AwsArchitecture.getService(identifier: string)

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

{@link AwsSerfice.getService }

identifier^Required

• Type: string

---

parseAssetPath

import { AwsArchitecture } from '@aws/pdk/aws-arch'

AwsArchitecture.parseAssetPath(assetPath: string)

Parse assets path into part descriptor.

assetPath^Required

• Type: string

Absolute or relative asset file path to parse.

---

resolveAssetPath

import { AwsArchitecture } from '@aws/pdk/aws-arch'

AwsArchitecture.resolveAssetPath(assetPath: string)

Resolve relative asset path to absolute asset path.

assetPath^Required

• Type: string

The relative asset path to resolve.

---

resolveAssetSvgDataUrl

import { AwsArchitecture } from '@aws/pdk/aws-arch'

AwsArchitecture.resolveAssetSvgDataUrl(svgAssetPath: string)

Resolve relative asset path as SVG Data URL.

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

svgAssetPath^Required

• Type: string

The relative path of svg asset to resolve.

---

Properties

Name	Type	Description
assetDirectory	string	The absolute directory where AWS Architecture Icons are stored and retrieved.
categories	{[ key: string ]: AwsCategory}	Get all categories.
resources	{[ key: string ]: AwsResource}	Get all resources.
services	{[ key: string ]: AwsService}	Get all services.

---

assetDirectory^Required

public readonly assetDirectory: string;

• Type: string

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

---

categories^Required

public readonly categories: {[ key: string ]: AwsCategory};

• Type: {[ key: string ]: AwsCategory}

Get all categories.

{@link AwsCategory.categories }

---

resources^Required

public readonly resources: {[ key: string ]: AwsResource};

• Type: {[ key: string ]: AwsResource}

Get all resources.

{@link AwsResource.resources }

---

services^Required

public readonly services: {[ key: string ]: AwsService};

• Type: {[ key: string ]: AwsService}

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 categoryServices(): AwsService[]

Gets a list of all services within this category.

icon

public icon(format: string, theme?: string): string

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

format^Required

• Type: string

---

theme^Optional

• Type: string

---

Static Functions

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

---

getCategory

import { AwsCategory } from '@aws/pdk/aws-arch'

AwsCategory.getCategory(id: string)

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

id^Required

• Type: string

The id of the category to retrieve.

---

Properties

Name	Type	Description
categories	{[ key: string ]: AwsCategory}	Get record of all categories keyed by category id.
fillColor	string	Fill color for the category.
fontColor	string	Font color for the category.
gradientColor	string	Gradien color for the category.
id	string	The unique id of the category.
name	string	The proper name of the category.
variants	string[]	Alternative names used to identity this category.
drawioStyles	AwsCategoryDrawioStyles	Drawio style definition for this category.

---

categories^Required

public readonly categories: {[ key: string ]: AwsCategory};

• Type: {[ key: string ]: AwsCategory}

Get record of all categories keyed by category id.

---

fillColor^Required

public readonly fillColor: string;

• Type: string

Fill color for the category.

---

fontColor^Required

public readonly fontColor: string;

• Type: string

Font color for the category.

---

gradientColor^Required

public readonly gradientColor: string;

• Type: string

Gradien color for the category.

---

id^Required

public readonly id: string;

• Type: string

The unique id of the category.

---

Example

"security_identity_compliance"

name^Required

public readonly name: string;

• Type: string

The proper name of the category.

---

Example

"Security, Identity, & Compliance"

variants^Required

public readonly variants: string[];

• Type: string[]

Alternative names used to identity this category.

---

drawioStyles^Optional

public readonly drawioStyles: AwsCategoryDrawioStyles;

• Type: AwsCategoryDrawioStyles

Drawio style definition for this category.

---

AwsCategoryDrawioStyles

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

Initializers

import { AwsCategoryDrawioStyles } from '@aws/pdk/aws-arch'

new AwsCategoryDrawioStyles(categoryShape: ShapeNames, base: DrawioAwsResourceIconStyleBase)

Name	Type	Description
categoryShape	aws/pdk/aws-arch.aws_arch.DrawioSpec.Aws4.ShapeNames	No description.
base	aws/pdk/aws-arch.aws_arch.DrawioAwsResourceIconStyleBase	No description.

---

categoryShape^Required

• Type: aws/pdk/aws-arch.aws_arch.DrawioSpec.Aws4.ShapeNames

---

base^Required

• Type: aws/pdk/aws-arch.aws_arch.DrawioAwsResourceIconStyleBase

---

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 getResourceStyle(resourceShape: ShapeNames): AwsDrawioShapeStyle

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

resourceShape^Required

• Type: aws/pdk/aws-arch.aws_arch.DrawioSpec.Aws4.ShapeNames

The resource shape to style based on category.

---

getServiceStyle

public getServiceStyle(serviceShape: ShapeNames): AwsDrawioResourceIconStyle

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

serviceShape^Required

• Type: aws/pdk/aws-arch.aws_arch.DrawioSpec.Aws4.ShapeNames

The service shape to style based on category.

---

Properties

Name	Type	Description
base	aws/pdk/aws-arch.aws_arch.DrawioAwsResourceIconStyleBase	No description.
categoryShape	aws/pdk/aws-arch.aws_arch.DrawioSpec.Aws4.ShapeNames	No description.
categoryStyle	AwsDrawioResourceIconStyle	Get the drawio style for this category.

---

base^Required

public readonly base: DrawioAwsResourceIconStyleBase;

• Type: aws/pdk/aws-arch.aws_arch.DrawioAwsResourceIconStyleBase

---

categoryShape^Required

public readonly categoryShape: ShapeNames;

• Type: aws/pdk/aws-arch.aws_arch.DrawioSpec.Aws4.ShapeNames

---

categoryStyle^Required

public readonly categoryStyle: AwsDrawioResourceIconStyle;

• Type: AwsDrawioResourceIconStyle

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 drawioStyle(): AwsDrawioShapeStyle

Gets the draiwio style for the resource.

getCategoryIcon

public getCategoryIcon(format: string, theme?: string): string

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 }

format^Required

• Type: string

The format of icon.

---

theme^Optional

• Type: string

Optional theme.

---

getGeneralIcon

public getGeneralIcon(format: string, theme?: string): string

Gets the general icon for the resource if available.

format^Required

• Type: string

The format of icon.

---

theme^Optional

• Type: string

Optional theme.

---

getResourceIcon

public getResourceIcon(format: string, theme?: string): string

Gets the resource specific icon for the resource.

format^Required

• Type: string

The format of icon.

---

theme^Optional

• Type: string

Optional theme.

---

getServiceIcon

public getServiceIcon(format: string, theme?: string): string

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 }

format^Required

• Type: string

The format of icon.

---

theme^Optional

• Type: string

Optional theme.

---

icon

public icon(format: string, theme?: string): string

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

explicit resource icon 2. general icon 3. service icon

format^Required

• Type: string

The format of icon.

---

theme^Optional

• Type: 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 { AwsResource } from '@aws/pdk/aws-arch'

AwsResource.findResource(value: string)

Find {@link AwsResource} associated with given value.

value^Required

• Type: string

The value to match {@link AwsResource};

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

---

getResource

import { AwsResource } from '@aws/pdk/aws-arch'

AwsResource.getResource(cfnResourceType: string)

Get {@link AwsResource} by CloudFormation resource type.

cfnResourceType^Required

• Type: string

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

---

Properties

Name	Type	Description
resources	{[ key: string ]: AwsResource}	Get record of all resources keyed by resource id.
cfnResourceType	string	Fully-qualified CloudFormation resource type (eg: "AWS:S3:Bucket").
service	AwsService	The {@link AwsService} the resource belongs to.
drawioShape	aws/pdk/aws-arch.aws_arch.DrawioSpec.Aws4.ShapeNames	The drawio shape mapped to this resource, or undefined if no mapping.
fullName	string	The proper full name of the resource.

---

resources^Required

public readonly resources: {[ key: string ]: AwsResource};

• Type: {[ key: string ]: AwsResource}

Get record of all resources keyed by resource id.

---

cfnResourceType^Required

public readonly cfnResourceType: string;

• Type: string

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

---

service^Required

public readonly service: AwsService;

• Type: AwsService

The {@link AwsService} the resource belongs to.

---

drawioShape^Optional

public readonly drawioShape: ShapeNames;

• Type: aws/pdk/aws-arch.aws_arch.DrawioSpec.Aws4.ShapeNames

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

---

fullName^Optional

public readonly fullName: string;

• Type: string

The proper full name of the resource.

---

Example

"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 drawioStyle(): AwsDrawioResourceIconStyle

Get drawio style for this service.

icon

public icon(format: string, theme?: string): string

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

format^Required

• Type: string

The format of icon.

---

theme^Optional

• Type: string

Optional theme.

---

serviceResources

public serviceResources(): AwsResource[]

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 { AwsService } from '@aws/pdk/aws-arch'

AwsService.findService(value: string)

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

value^Required

• Type: string

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

---

getService

import { AwsService } from '@aws/pdk/aws-arch'

AwsService.getService(cfnService: string)

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

cfnService^Required

• Type: string

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

---

Properties

Name	Type	Description
services	{[ key: string ]: AwsService}	Get record of all {@link AwsService}s keyed by id.
cfnProvider	string	The CloudFormation "provider" for the service, as expressed by <provicer>::<service>::<resource>.
cfnService	string	The CloudFormation "service" for the service, as expressed by <provicer>::<service>::<resource>.
fullName	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	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	aws/pdk/aws-arch.aws_arch.PricingManifest.Service	Get service pricing metadata.
pricingServiceCode	string	The pricing serviceCode associated with this service, or undefined if service not mapped to pricing.

---

services^Required

public readonly services: {[ key: string ]: AwsService};

• Type: {[ key: string ]: AwsService}

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

---

cfnProvider^Required

public readonly cfnProvider: string;

• Type: string

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

---

cfnService^Required

public readonly cfnService: string;

• Type: string

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

---

fullName^Required

public readonly fullName: string;

• Type: string

The proper full name of the service.

---

Example

"AWS Glue", "Amazon S3"

category^Optional

public readonly category: AwsCategory;

• Type: AwsCategory

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

---

drawioShape^Optional

public readonly drawioShape: ShapeNames;

• Type: 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^Optional

public readonly pricingMetadata: Service;

• Type: aws/pdk/aws-arch.aws_arch.PricingManifest.Service

Get service pricing metadata.

---

pricingServiceCode^Optional

public readonly pricingServiceCode: string;

• Type: 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-11-28