Toyokky's Tech Notes

ネットワーク系クラウドエンジニアとして学んだことの技術メモ。

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

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

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

目次

命名規則の作成にあたって

  • 命名規則の表記方法は「シスコ テクニカル ティップスの表記法」を参照しています。
  • 以下は「Nameタグ」と「CloudFormationの論理ID」の変換で悩んで付けてるルールです。CloudFormationを使わない時や、面倒な時はスルーしてください。
    • lowerCamelCasekebab-case のハイブリッドで記載する。
      • CloudFormation化する際、「-」だけ抜けばそのまま論理IDとして使えるようにしたい。
    • 最初から「-」を無くそうかと思ったが、視認性のため「-」は付与したい。
      • 「-」の後に数字が来ないようにする。
      • 「-」の後は大英文字にする。
      • CloudFormation化する際の、論理ID変換する正規表現


命名規則 一覧

AWSリソース 命名規則                     付与例    
VPC <Env><Region><Az>-Vpc p1x-Vpc
InternetGateway <Env><Region><Az>-Igw p1x-Igw
NatGateway <Env><Region><Az>-Ngw p1x-Ngw
サブネット <Env><Region><Az>-Sub-<Layer><連番> p1a-Sub-Pri01
ネットワークACL <Env><Region><Az>-Ncl-<Layer><連番> p1a-Ncl-Pri01
RouteTable <Env><Region><Az>-Rtb-<Layer><連番> p1x-Rtb-Pri01
ElasticIP <Env><Region><Az>-Eip-<使用目的,Hostname等> p1x-Eip-Hostname
EC2 <Env><Region><Az>-Ec2-<Type>-<Hostname> p1a-Ec2-Web-Hostname
EBS <Env><Region><Az>-Ebs-<Type>-<Hostname>-<Device> p1a-Ebs-Web-Hostname-Sda1
ENI <Env><Region><Az>-Eni-<Type>-<Hostname>-<Device> p1a-Eni-Web-Hostname-Eth0
SecurityGroup
(共有)
<Env><Region><Az>-Sgr-<Type>-Share[<連番>] p1a-Sgr-Mnt-Share
SecurityGroup
(個別)
<Env><Region><Az>-Sgr-<Type>-<Hostname>[<連番>] p1a-Sgr-Web-Hostname
CLB <Env><Region><Az>-Clb-<Type>-{In|Ex}[<連番>] p1x-Clb-Web-In
ALB <Env><Region><Az>-Alb-<Type>-{In|Ex}[<連番>] p1x-Alb-Web-Ex
NLB <Env><Region><Az>-Nlb-<Type>-{In|Ex}[<連番>] p1a-Nlb-Web-Ex01
ターゲットグループ <Env><Region><Az>-Tgr-<Type>-{In|Ex}[<連番>] p1x-Tgr-Web-Ex
IAMグループ <Env><Region><Az>-Igr-<Authority> p1x-Igr-Adm
IAMユーザー <Env><Region><Az>-Iur-<Authority>-<Freeword> p1x-Iur-Rdo-Username
IAMロール <Env><Region><Az>-Irl-<Authority>-<Freeword> p1x-Irl-Ope-Lambda
IAMポリシー <Env><Region><Az>-Ipl-<Freeword> p1x-Ipl-Ec2-To-Systemmanager
CloudFormation
スタック
<Env><Region><Az>-Cfs<構築順>-<Freeword> p1x-Cfs01-Vpc-Subnet-Routetable
S3バケット <Env><Region><Az>-S3b-<Freeword> p1x-S3b-Elbaccesslogs
KeyPair <Env><Region><Az>-key-<Freeword> pxx-Key-Username

※複数システムが混在する環境では命名規則の頭に<system>-を付与します。例) sales-, tech-, unyo-


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

  • System
    • note : toyokkyの技術ノート用
    • Cisy : 共通基盤
    • Sale : 営業部
    • Tech : 技術部
  • Env
    • P : Production, 本番
    • T : Test, テスト
    • D : Development, 開発
    • M : Maintenance, メンテナンス・運用
  • Region
    • 1 : ap-northeast-1, 東京リージョン
    • 3 : ap-northeast-3, 大阪リージョン
    • t : 東京リージョン, 他国も使う場合
    • s : シンガポールリージョン, 他国も使う場合
    • x : 指定不要の場合
  • Az
    • a :
    • c :
    • d :
    • 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 ルート
    • Xvdb : EBS 2つ目



参考URL

dev.classmethod.jp

www.cisco.com