説明
説明がない場合や汎用的な文言だけの場合は、セキュリティグループの用途が分かりにくくなります。具体的な説明は、似たグループの区別や変更の確認に役立ちます。
想定される影響
目的が不明確だと、誤ったグループを選んだり、不要なグループの削除が遅れたりする場合があります。
対処方法
descriptionにシステムでの役割と利用対象を記載してください。Terraformで既存グループの説明を変更するとリソースが置き換わるため、先にプランを確認してください。頻繁に変わる分類情報はタグで管理してください。
例
以下は用途を示す説明を追加する例です。AWSの説明フィールドの文字制限に合わせて英語を使用します。
変更前
hcl
resource "aws_security_group" "app" {
name = "app-sg"
vpc_id = aws_vpc.main.id
}
変更後
hcl
resource "aws_security_group" "app" {
name = "app-sg"
description = "Application server security group"
vpc_id = aws_vpc.main.id
}