2022-10-09

TerraformのFor-EachとDynamic Blocks

For-EachとDynamic Blocksについて

Terraformの主要な機能の一つに、for-eachやdynamic blockを使用して、複数のリソースやモジュールを単一のコードブロック内で作成できることがあります。

for-eachは、Terraformに組み込まれた関数であり、値のリストやマップを繰り返し処理し、リソースやモジュールの複数のインスタンスを作成できます。例えば、複数のAWS EC2インスタンスを作成したい場合、for-each関数を使用して、インスタンス名のリストを反復処理し、リスト内の各名前に対してインスタンスを作成できます。

一方、dynamic blockを使用すると、動的な構成に基づいてリソースやモジュールの複数のインスタンスを作成できます。つまり、変数や他のリソースからの入力に基づいて、リソースやモジュールを作成できます。例えば、特定のリージョンの利用可能なゾーンの数に基づいて、AWSで複数のサブネットを作成する場合には、dynamic blockを使用できます。

for-eachとdynamic blockの両方は、開発者やオペレーションチームに対し、大規模なインフラストラクチャ環境の管理を簡素化する強力なツールを提供します。単一のコードブロック内でリソースやモジュールの複数のインスタンスを作成できるため、これらの機能により、大規模かつ複雑なインフラストラクチャ環境の管理プロセスが簡素化されます。

For-Each

for-each関数を使用すると、値のリストやマップを繰り返し処理し、リソースやモジュールの複数のインスタンスを作成できます。同じリソースやモジュールの複数のインスタンスを作成する必要があるが、属性や構成が異なる場合に特に役立ちます。

for-each関数は、マップやリストを入力として受け取り、マップやリスト内の各要素を繰り返し処理します。各反復ごとに、リソースやモジュールの新しいインスタンスが作成され、現在の反復の値が、構成可能な属性の入力として使用されます。

Terraformのfor-eachを使用するための構文は以下のとおりです。

resource "<resource_type>" "<resource_name>" {
  for_each = <map_or_list>
  <attribute_1> = <value_1>
  <attribute_2> = <value_2>
  ...
}

この構文では、 <resource_type>は作成するリソースの種類、 <resource_name>はリソースの名前、 <map_or_list>は繰り返し処理するマップまたはリストであり、<attribute_1>、 <attribute_2>などはリソースの設定可能な属性です。

以下は、複数のAWS EC2インスタンスを作成するためにfor-eachを使用する例です。

resource "aws_instance" "ec2_instances" {
  for_each = {
    "instance-1" = "ami-0c55b159cbfafe1f0"
    "instance-2" = "ami-0c55b159cbfafe1f0"
    "instance-3" = "ami-0c55b159cbfafe1f0"
  }

  instance_type = "t2.micro"
  ami = each.value
}

この例では、同じAMIを使用して異なるインスタンス名でaws_instanceリソースの3つのインスタンスを作成しています。for-each関数は、インスタンス名と対応するAMI IDを含むマップを繰り返します。instance_type属性は全てのインスタンスにt2.microに設定され、ami属性はeach.value構文を使用して現在の繰り返しの値に設定されます。

Dynamic Blocks

Dynamic blocksを使用すると、動的構成に基づいてリソースまたはモジュールの複数のインスタンスを作成できます。これは、AWSリージョンの可用性ゾーンの数など、変数や他のリソースからの入力に基づいてリソースやモジュールを作成する必要がある場合に役立ちます。

Dynamic blocksは、リソースまたはモジュールのタイプを指定し、各リソースまたはモジュールの属性を定義する動的ブロック構成を指定する特別な構文を使用して定義されます。この構成は実行時に動的に評価され、変数や他のリソースからの入力に基づいてリソースやモジュールを作成できます。

TerraformでDynamic blocksを使用する構文は以下のとおりです。

resource "<resource_type>" "<resource_name>" {
  dynamic "<block_name>" {
    for_each = <expression>

    <attribute_1> = <value_1>
    <attribute_2> = <value_2>
    ...
  }
}

この構文では、<resource_type>は作成したいリソースのタイプ、<resource_name>はリソースの名前、<block_name>はDynamic blocksの名前、<expression>は作成するインスタンスの数を定義する式です。<attribute_1>、<attribute_2>などは、リソースの各インスタンスの構成可能な属性です。

以下は、リージョン内のアベイラビリティーゾーンの数に基づいて複数のAWSサブネットを作成するために、Dynamic blocksを使用する例です。

resource "aws_subnet" "subnet" {
  dynamic "subnet" {
    for_each = var.availability_zones

    content {
      cidr_block = cidrsubnet(var.vpc_cidr_block, 8, each.key)
      availability_zone = each.value
    }
  }
}

この例では、ダイナミックブロックを使用して、リージョン内の各アベイラビリティーゾーンに1つのAWSサブネットを作成しています。for_each式は、リージョン内のアベイラビリティーゾーンのリストであるavailability_zonesという名前の変数を使用しています。ダイナミックブロック構成は、各サブネットの属性を指定しており、cidr_blockとavailability_zone属性を含みます。

ダイナミックブロックを使用すると、ダイナミックな入力に基づいてリソースまたはモジュールの複数のインスタンスを作成でき、複雑なインフラストラクチャ環境を管理しやすくなります。ダイナミックブロックを効果的に使用することで、変更に適応できるスケーラブルでメンテナンスしやすく効率的なTerraformコードを作成できます。

For-EachとDynamic Blocksの違い

For-eachとdynamic blocksは、単一のコードブロック内でリソースまたはモジュールの複数のインスタンスを作成できるが、それらにはいくつかの主な違いがあります。

For-EachとDynamic Blocksの比較

For-eachは、値のリストやマップに基づいて、リソースまたはモジュールの複数のインスタンスを作成できるTerraformの組み込み関数です。For-eachは、リソースまたはモジュールの固定数のインスタンスを作成する必要があり、異なる属性や構成を持つ場合に最適です。For-eachは静的な構造であり、インスタンスの数はコード作成時に定義され、実行時に変更できません。

一方、dynamic blocksは、動的構成に基づいて、リソースまたはモジュールの複数のインスタンスを作成できるようにします。dynamic blocksは、AWSリージョンの可用性ゾーンの数など、外部入力に応じてインスタンスの数が異なる場合に最適です。dynamic blocksは実行時に評価されるため、変数や他のリソースからの入力に基づいてリソースやモジュールを作成できます。

For-EachとDynamic Blocksの使用例

For-eachとdynamic blocksには、Terraformで異なる使用例があります。

For-eachの使用例には以下があります。

異なる属性や構成を持つ複数のリソースまたはモジュールのインスタンスを作成する
リソースまたはモジュールの固定数のインスタンスを作成する
似た構成を持つ複数のリソースまたはモジュールのコピーを回避することで、コードを簡素化する

Dynamic blocksの使用例には以下があります。

AWSリージョンの可用性ゾーンの数など、動的構成に基づいてリソースまたはモジュールの複数のインスタンスを作成する
変数や他のリソースからの入力に基づいてリソースやモジュールを作成する
インフラストラクチャの要件が変化した場合にコードを適応させる

一般的に、for-eachはコード作成時点でインスタンス数がわかっている場合に最適であり、一方でdynamic blocksはインスタンス数が外部入力に依存する場合に最適です。for-eachとdynamic blocksを効果的に使用することで、変化するインフラストラクチャの要件に適応できるスケーラブルで、メンテナンスが容易で、効率的なTerraformコードを作成することができます。