Zenn
👋

Terraformにおけるリソースのローカル名とタグの名前の違い

2024/07/03に公開
Terraform
tech

Terraformを使ってインフラストラクチャをコードで管理する際、リソースのローカル名とタグの役割について学習した内容を自分の備忘録として記載しておきます。

リソースブロックの構造

まず、Terraformのリソースブロックの基本構造を見てみましょう：

resource "aws_vpc" "main_vpc" {
  cidr_block           = "10.0.0.0/16"
  enable_dns_support   = true
  enable_dns_hostnames = true
  tags = {
    Name = "dev-vpc"
  }
}

この構造には次の3つの重要な要素があります：

  1. リソースタイプ: 例えば aws_vpc などのリソースタイプは、AWSのVPCリソースを作成することを示しています。
  2. リソースのローカル名: 例えば main_vpc は、このリソースをTerraformの設定ファイル内で一意に識別するための名前です。
  3. 属性とタグ: cidr_block や tags などの属性は、リソースの設定やメタデータを定義します。

リソースのローカル名とは

リソースのローカル名は、Terraformの設定ファイル内でリソースを一意に識別し、他のリソースから参照するための名前です。この名前は同じ構成ファイル内で一意である必要があります。ローカル名を使用することで、リソース間の依存関係を明確にし、構成をより直感的に管理することができます。

例：ローカル名を使用したリソースの参照

resource "aws_vpc" "main_vpc" {
  cidr_block           = "10.0.0.0/16"
  enable_dns_support   = true
  enable_dns_hostnames = true
  tags = {
    Name = "dev-vpc"
  }
}

resource "aws_subnet" "main_subnet" {
  vpc_id            = aws_vpc.main_vpc.id  # ここでmain_vpcを参照
  cidr_block        = "10.0.1.0/24"
  availability_zone = "ap-northeast-1"
}

この例では、aws_subnet リソースが vpc_id 属性を通じて aws_vpc.main_vpc.id を参照しています。つまり、サブネットリソースがVPCリソースに依存していることを示しています。このように、リソースのローカル名を使って他のリソースと連携させることができます。

タグの名前とは

タグは、リソースに付加するメタデータです。タグを使うことで、リソースを識別しやすくし、AWSコンソールやAPIを通じてリソースを検索、フィルタリング、グループ化する際に役立ちます。タグはリソース自体に対して追加されるため、Terraformの構成ファイル内でなくても他のツールからも利用できます。

例：タグの定義

resource "aws_vpc" "main_vpc" {
  cidr_block           = "10.0.0.0/16"
  enable_dns_support   = true
  enable_dns_hostnames = true
  tags = {
    Name        = "dev-vpc"  # タグの名前
    Environment = "Development"
  }
}

この例では、VPCに2つのタグが追加されています：Name と Environment。これにより、AWSコンソール上でこのVPCを「dev-vpc」という名前で識別し、「Development」環境に属していることを示しています。

リソースのローカル名とタグの名前の違い

  • リソースのローカル名：

    • 役割: Terraform構成ファイル内でリソースを一意に識別し、他のリソースから参照するための名前。
    • 使用場所: Terraformの構成ファイル内でのみ使用される。
    • 例: main_vpc というローカル名。

  • タグの名前：

    • 役割: リソースにメタデータを追加し、AWSコンソールやAPIでの管理を容易にする。
    • 使用場所: AWSコンソールや他の管理ツールでも使用される。
    • 例: Name = "dev-vpc" というタグ。

まとめ

リソースのローカル名とタグの名前は、Terraformにおける重要な概念です。リソースのローカル名は、構成ファイル内でリソースを一意に識別し、他のリソースから参照するために使用されます。一方、タグの名前は、リソースに付加するメタデータで、リソースの管理や識別を容易にします。これらを適切に理解し活用することで、Terraformを使ったインフラストラクチャのコード管理がより効率的かつ効果的になります。

Discussion