目次

PlantUML内蔵AWSアイコン（awslib）活用ガイド

はじめに

PlantUMLには、AWSの公式アーキテクチャアイコンが標準ライブラリ（stdlib）として同梱されています。~ インターネット接続不要で、外部ファイルのダウンロードも不要です。~ !include <awslib/カテゴリ/アイコン名> と書くだけで、すぐにAWSアイコンが使えます。

重要: PlantUMLのバージョンによって同梱されているアイコンのバージョンが異なります。
本記事はPlantUML 1.2021.00に同梱されているawslibを基に記載しています。

基本的な使い方

最小構成

@startuml
!include <awslib/AWSCommon>
!include <awslib/AWSSimplified>

!include <awslib/Compute/EC2>
!include <awslib/Database/RDS>
!include <awslib/Storage/SimpleStorageServiceS3>

EC2(web, "Webサーバ", "")
RDS(db, "データベース", "")
SimpleStorageServiceS3(s3, "ストレージ", "")

web --> db
web --> s3
@enduml

マクロの書式

アイコン名(エイリアス, "ラベル", "テクノロジー")
アイコン名(エイリアス, "ラベル", "テクノロジー", "説明")

• 第1引数: エイリアス（変数名。接続線で使用）
• 第2引数: 表示ラベル
• 第3引数: テクノロジー名（空文字可）
• 第4引数: 説明文（省略可）

注意事項

パス名の罠

公式ドキュメントや新しいバージョンのawslibとはパス名が異なります。~ PlantUML 1.2021.00のstdlibでは以下の命名規則です。

カテゴリ名に And が入ります。

アイコン名の罠

アイコン名にも注意が必要です。

存在しないアイコン

PlantUML 1.2021.00のstdlibには以下のサービスのアイコンは含まれていません。~ （2021年以降に追加されたサービス）

• AWS Network Firewall
• AWS IAM Identity Center（旧SSO → SingleSignOnは存在）
• Amazon MemoryDB
• AWS App Runner
• Amazon OpenSearch Service（ElasticsearchServiceは存在）

同梱アイコンの確認方法

PlantUMLのjarファイルからstdlibを展開して確認できます。

手順

1. 作業ディレクトリを作成

2. PlantUMLのextract-stdlibコマンドを実行

   mkdir stdlib_work cd stdlib_work java -jar /path/to/plantuml.jar -extractstdlib

3. stdlib/awslib/ 配下にカテゴリごとのフォルダとpumlファイルが展開される

Kiro/VSCode拡張の場合

Kiroの場合、plantuml.jarは以下にあります。

C:\Users\<ユーザ名>\.kiro\extensions\jebbs.plantuml-2.18.1-universal\plantuml.jar

全カテゴリ・アイコン一覧

PlantUML 1.2021.00 stdlib には全27カテゴリ、約530個のアイコンが同梱されています。

Compute（69個）

Storage（28個）

Database（39個）

NetworkingAndContentDelivery（35個）

SecurityIdentityAndCompliance（37個）

ManagementAndGovernance（51個）

主要なもの:

その他の主要カテゴリ

構成図での活用例

@startuml aws_architecture
!include <awslib/AWSCommon>
!include <awslib/AWSSimplified>

!include <awslib/General/Users>
!include <awslib/NetworkingAndContentDelivery/CloudFront>
!include <awslib/NetworkingAndContentDelivery/ELBApplicationLoadBalancer>
!include <awslib/Compute/EC2>
!include <awslib/Database/Aurora>
!include <awslib/Storage/SimpleStorageServiceS3>
!include <awslib/SecurityIdentityAndCompliance/WAF>
!include <awslib/SecurityIdentityAndCompliance/Shield>

Users(users, "ユーザ", "")
Shield(shield, "Shield", "")
WAF(waf, "WAF", "")
CloudFront(cf, "CloudFront", "")
ELBApplicationLoadBalancer(alb, "ALB", "")
EC2(web1, "Webサーバ#1", "")
EC2(web2, "Webサーバ#2", "")
Aurora(db, "Aurora", "")
SimpleStorageServiceS3(s3, "静的コンテンツ", "")

users --> shield
shield --> waf
waf --> cf
cf --> alb
cf --> s3
alb --> web1
alb --> web2
web1 --> db
web2 --> db
@enduml

Graphvizについて

PlantUMLでAWSアイコンを使った図をレンダリングするには、Graphvizが必要です。

Windows環境での注意

PlantUML 1.2021.00は内蔵のGraphviz（dot.exe）を一時フォルダに展開して使いますが、~ ファイルロックの競合でエラーになることがあります。

java.io.FileNotFoundException: C:\Users\...\AppData\Local\Temp\_graphviz\dot.exe

対策: Graphvizを別途インストールし、VSCode/Kiroの設定で直接指定する。

choco install graphviz -y

.vscode/settings.json: { "plantuml.commandArgs": ["-DGRAPHVIZ_DOT=C:\Program Files\Graphviz\bin\dot.exe"] }

参考リンク

• https://plantuml.com/ja/stdlib

最新の30件