リソース名にリソースタイプ名を含めない

ルール

Do not include the resource type name in the resource name (e.g., avoid aws_instance.ec2_instance).

(リソース名にリソースタイプ名を含めない)

解説

二つの理由により、リソース名にリソースタイプ名を含めるべきではありません。

  1. リソースタイプを見ればわかることは書くべきでない
  2. 命名が雑になりやすい

悪い例としてはaws_instance.ec2_instance のような命名が該当します。

AWS公式のベストプラクティスでもこの命名規則が推奨されています。

サンプルコード

# 良い例: リソースタイプを重複させない
resource "aws_instance" "web_server" {
  instance_type = "t3.micro"
  ami           = var.ami_id
}

resource "aws_security_group" "api" {
  name   = "${var.environment}-${var.project}-api"
  vpc_id = aws_vpc.main.id
}

参考リンク

Show Text to Share
リソース名にリソースタイプ名を含めない
https://www.tricrow.com/infrastructure/development-guidline/coding_standards.naming_conventions.no_duplication.html
この記事を書いた人
T.Nakamura
T.Nakamura
SRE | セキュリティ前提の設計・運用・監査対応(PCI DSS) | ドキュメント整備と仕組み化で開発・運用を整えます | AWS SAP / 日商簿記一級フォローはこちら

カテゴリ

タグ