ぶろとよ

ネットワーク系クラウドエンジニア（AWS）の技術ブログ。自動化に興味があるためAWS CLIを勉強＆アウトプット中。

トップ > AWS > AWSリソースの命名規則について

AWSリソースの命名規則について

AWS

[更新履歴]

  • 2021/09/23, 命名規則ルール lowerCamelCase を CamelCase に変更。分かりづらかったため。
  • 2022/08/18, CloudFormation化する時の考慮事項を削除。一覧にVGW、CGW、VPNを追加。
  • 2022/09/24, 付与名が長過ぎる場合は、「 (付与例の blog-)」をNameタグとは別にタグに付ける旨を表の下に追記。

自分のAWS環境で利用するAWSリソースの命名規則をこれまでまとめたことが無かったため、ルール決めに挑戦してみました。
あくまでも「自分用の命名規則」となりますので、変な箇所があったり、ちょくちょく更新して変えていきます。

目次

命名規則の表記方法

  • 命名規則の表記方法は「シスコ テクニカル ティップスの表記法」を参照しています。

    • シスコ テクニカル ティップスの表記法

    • 本ページで使用している表記法
      • < > : 引数、ユーザが入力する文字列
      • [ ] : オプション
      • {選択肢A|選択肢B} : 必須選択事項
      • [{選択肢A|選択肢B}] : オプションの中に選択事項がある


命名規則 一覧

AWSリソース 命名規則　　　　　　　　　　　　　　　　　　　　 付与例　　　　
VPC <System>-<Env><Region><Az>-Vpc blog-P1x-Vpc
InternetGateway <System>-<Env><Region><Az>-Igw blog-P1x-Igw
NatGateway <System>-<Env><Region><Az>-Ngw-<Layer><連番> blog-P1a-Ngw-Pub01
VirtualPrivateGateway <System>-<Env><Region><Az>-Vgw blog-P1x-Vgw
CustomerGateway <System>-<Env><Region><Az>-Cgw-<接続先情報> blog-P1x-Cgw-JitakuRouter
Site-to-Site VPN <System>-<Env><Region><Az>-Vpn-<接続先情報> blog-P1x-Vpc-JitakuRouter
サブネット <System>-<Env><Region><Az>-Sub-<Layer><連番> blog-P1a-Sub-Pri01
ネットワークACL <System>-<Env><Region><Az>-Ncl-<Layer><連番> blog-P1a-Ncl-Pri01
RouteTable <System>-<Env><Region><Az>-Rtb-<Layer><連番> blog-P1x-Rtb-Pri01
ElasticIP <System>-<Env><Region><Az>-Eip-<使用目的,Hostname等> blog-P1x-Eip-Hostname
EC2 <System>-<Env><Region><Az>-Ec2-<Type>-<Hostname> blog-P1a-Ec2-Web-Hostname
EBS <System>-<Env><Region><Az>-Ebs-<Type>-<Hostname>-<Device> blog-P1a-Ebs-Web-Hostname-Sda1
ENI <System>-<Env><Region><Az>-Eni-<Type>-<Hostname>-<Device> blog-P1a-Eni-Web-Hostname-Eth0
SecurityGroup
(共有)		 <System>-<Env><Region><Az>-Sgr-<Type>-Share[<連番>] blog-P1a-Sgr-Mnt-Share
SecurityGroup
(個別)		 <System>-<Env><Region><Az>-Sgr-<Type>-<Hostname>[<連番>] blog-P1a-Sgr-Web-Hostname
CLB <System>-<Env><Region><Az>-Clb-<Type>-{In|Ex}[<連番>] blog-P1x-Clb-Web-In
ALB <System>-<Env><Region><Az>-Alb-<Type>-{In|Ex}[<連番>] blog-P1x-Alb-Web-Ex
NLB <System>-<Env><Region><Az>-Nlb-<Type>-{In|Ex}[<連番>] blog-P1a-Nlb-Web-Ex01
ターゲットグループ <System>-<Env><Region><Az>-Tgr-<Type>-{In|Ex}[<連番>] blog-P1x-Tgr-Web-Ex
IAMグループ <System>-<Env><Region><Az>-Igr-<Authority> blog-P1x-Igr-Adm
IAMユーザー <System>-<Env><Region><Az>-Iur-<Authority>-<Freeword> blog-P1x-Iur-Rdo-Username
IAMロール <System>-<Env><Region><Az>-Irl-<Authority>-<Freeword> blog-P1x-Irl-Ope-Lambda
IAMポリシー <System>-<Env><Region><Az>-Ipl-<Freeword> blog-P1x-Ipl-Ec2-To-Systemmanager
CloudFormation
スタック		 <System>-<Env><Region><Az>-Cfs<構築順>-<Freeword> blog-P1x-Cfs01-Vpc-Subnet-Routetable
S3バケット <System>-<Env><Region><Az>-S3b-<Freeword> blog-p1x-s3b-elbaccesslogs ※S3は大文字不可
KeyPair <System>-<Env><Region><Az>-key-<Freeword> blog-Pxx-Key-Username

※「<Env><Region><Az>」は全AWSリソースで共通です。 <AZ>の分別不要な場合は x にしています。例: P1x ※付与名が長過ぎる場合は、「 (付与例の blog-)」をNameタグとは別にタグに付けてもよい


命名規則内のパーツについて

  • System
    • Unyo : 運用監視
    • Sales : 営業部
    • Tech : 技術部
    • blog : ブログ記事用
  • Env
    • P : Production, 本番
    • T : Test, テスト
    • D : Development, 開発
    • M : Maintenance, メンテナンス・運用
  • Region
    • 1 : ap-northeast-1, 東京リージョン
    • 3 : ap-northeast-3, 大阪リージョン
    • t : 東京リージョン, 他国も使う場合
    • s : シンガポールリージョン, 他国も使う場合
    • x : 指定不要やグローバルサービスの場合 ※他リソースと桁数を合わせたい
  • Az
    • a : ap-northeast-1a, ap-northeast-3a
    • b : ap-northeast-3b
    • c : ap-northeast-1c, ap-northeast-3c
    • d : ap-northeast-1d
    • x : 指定不要やリージョンサービスの場合 ※他リソースと桁数を合わせたい
  • Layer
    • Pub : パブリック, VPC内およびインターネットと通信可能
    • Pri : プライベート, VPC内およびプライベート空間と通信可能
    • Pro : プロテクト, VPC内のみ通信可能
  • Type
    • App : アプリケーションサーバー
    • Bsv : 踏み台サーバー(Bastion)
    • Web : WEBサーバー
    • Srv : 単にServer
    • Fsv : ファイルサーバー
    • Msv : メールサーバー
    • Ads : ADサーバー
    • Pxy : Proxyサーバー
    • Dns : DNSサーバー
    • Log : Syslogサーバー
    • Mnt : メンテナンス
  • Authority
    • Adm : 管理者権限
    • Ope : オペレーター
    • Rdo : リードオンリー
    • Api : API使用
  • Device
    • Eth0 : ENI Ethernet0
    • Eth1 : ENI Ethernet1
    • Sda1 : EBS ルート(Windows)
    • Xvda : EBS ルート(Linux)
    • Xvdb : EBS 2つ目


参考URL

dev.classmethod.jp

www.cisco.com