【Terraform】countで作成したリソースの参照はインデックスを指定しないとダメみたい

Terraformでcountを使用してValidateしたらエラーになりました。

文法的なエラーになったので、原因調査⇒修正の過程をまとめていきます

結論
countとは？
やりたいこと
作ったmodule
1. ディレクトリ構成
2. コード
エラー内容
原因調査
修正して再度確認
最後に
参考

結論

タイトル通りですが、

Terraformでcountを使用して作成したリソースを参照するにはインデックスを指定しないとダメ

みたいです

countとは？

countとは数値型で、指定した数だけリソースを作成します。

例えば、↓のようにcountを使用するとEC2を２つ作成します

resource "aws_instance" "server" {
  count = 2

...

}

resource "aws_instance" "server" {

count = 2

...

}

複数同じものを作成するときに便利ですよね～

でも、これもうひとつ素晴らしい使い方があります

リソースを作成するかのフラグとしても使えるんです！！

例えば↓のように変数を使用して

// EC2をいくつ作るかをしていする変数
variable "count_ec2" {
  default = 0
}

resource "aws_instance" "server" {
  count = var.count_ec2

...

}

// EC2をいくつ作るかをしていする変数

variable "count_ec2" {

default = 0

}

resource "aws_instance" "server" {

count = var.count_ec2

...

}

作成しない→count_ec2 は０

作成する　→count_ec2 は作成したい個数

とすることで簡単に作成するしないを制御することができます

やりたいこと

このインフラを構築するTerraformのコードを↓の要件に沿って作成

２つのAZで同じようなSubnetなどを作成するのでmodule化する
ただし、片方のAZのみNAT Gatewayを作成する

これを満たすようにmoduleを作ろうと思ったら、countを使ってみるかとなった

作ったmodule

ディレクトリ構成

./modules/subnet
├── README.md
├── main.tf
├── outputs.tf
└── variables.tf

コード

NAT Gatewayに関したところだけ切り出します

・main.tf

# NATゲートウェイ
resource "aws_nat_gateway" "main" {
  # リソースを作成するか
  # 0：作成しない、1：作成する
  count = var.count_nat_gateway
  # EIPの指定
  allocation_id = aws_eip.nat_gateway.id
  # パブリックサブネットを指定
  subnet_id = aws_subnet.public.id
  tags = {
    Name = "${var.prefix}-nat_gateway-${var.az}"
  }
}

# NATゲートウェイ用EIP
resource "aws_eip" "nat_gateway" {
  count  = var.count_nat_gateway
  domain = "vpc"
  tags = {
    Name = "${var.prefix}-eip-nat_gateway-${var.az}"
  }
}

# Route
# プライベートサブネット → NATゲートウェイへの通信を許可
resource "aws_route" "private" {
  count                  = var.count_nat_gateway
  route_table_id         = aws_route_table.private.id
  nat_gateway_id         = aws_nat_gateway.main.id
  destination_cidr_block = "0.0.0.0/0"
}

# NATゲートウェイ

resource "aws_nat_gateway" "main" {

# リソースを作成するか

# 0：作成しない、1：作成する

count = var.count_nat_gateway

# EIPの指定

allocation_id = aws_eip.nat_gateway.id

# パブリックサブネットを指定

subnet_id = aws_subnet.public.id

tags = {

Name = "${var.prefix}-nat_gateway-${var.az}"

}

# NATゲートウェイ用EIP

resource "aws_eip" "nat_gateway" {

count = var.count_nat_gateway

domain = "vpc"

tags = {

Name = "${var.prefix}-eip-nat_gateway-${var.az}"

}

# Route

# プライベートサブネット → NATゲートウェイへの通信を許可

resource "aws_route" "private" {

count = var.count_nat_gateway

route_table_id = aws_route_table.private.id

nat_gateway_id = aws_nat_gateway.main.id

destination_cidr_block = "0.0.0.0/0"

}

・variables.tf

# NAT Gatewayをいくつ作るか
variable "count_nat_gateway" {
  default = 0
}

# Prefix
variable "prefix" {
  type = string
}

# NAT Gatewayをいくつ作るか

variable "count_nat_gateway" {

default = 0

}

# Prefix

variable "prefix" {

type = string

}

・README.mdとoutputs.tf

本記事の内容に関係ないため省略します

エラー内容

先ほどのコードでterraform validateをすると、エラーになりました

│ Error: Missing resource instance key
│ 
│   on ../../modules/subnet/main.tf line 92, in resource "aws_nat_gateway" "main":
│   92:   allocation_id = aws_eip.nat_gateway.id
│ 
│ Because aws_eip.nat_gateway has "count" set, its attributes must be
│ accessed on specific instances.
│ 
│ For example, to correlate with indices of a referring resource, use:
│     aws_eip.nat_gateway[count.index]
╵
Error: Terraform exited with code 1.
Error: Process completed with exit code 1.

│ Error: Missing resource instance key

│

│ on ../../modules/subnet/main.tf line 92, in resource "aws_nat_gateway" "main":

│ 92: allocation_id = aws_eip.nat_gateway.id

│

│ Because aws_eip.nat_gateway has "count" set, its attributes must be

│ accessed on specific instances.

│

│ For example, to correlate with indices of a referring resource, use:

│ aws_eip.nat_gateway[count.index]

╵

Error: Terraform exited with code 1.

Error: Process completed with exit code 1.

EIPでcountを使用しているため、

aws_nat_gatewayブロック内でEIPを指定する際にインデックスが必要そう。

ちゃんと調べてみましょう！

原因調査

公式ドキュメントのcountのページに答えがありました

The count Meta-Argument - Configuration Language | Terraform | HashiCorp Developer

Count helps you efficiently manage nearly identical infrastructure resources without writing a separate block for each one.

When count is set, Terraform distinguishes between the block itself and the multiple resource or module instances associated with it. Instances are identified by an index number, starting with 0.

<TYPE>.<NAME> or module.<NAME> (for example, aws_instance.server) refers to the resource block.

<TYPE>.<NAME>[<INDEX>] or module.<NAME>[<INDEX>] (for example, aws_instance.server[0], aws_instance.server[1], etc.) refers to individual instances.

DeepLさんに翻訳してもらいました

countを設定すると、Terraformはブロックそのものと、それに関連する複数のリソースやモジュールのインスタンスを区別する。インスタンスは0から始まるインデックス番号で識別される。

・<TYPE>.<NAME>またはmodule.<NAME>（例えばaws_instance.server）はリソースブロックを指します。
・<TYPE>.<NAME>[<INDEX>]またはmodule.<NAME>[<INDEX>](例えばaws_instance.server[0]、aws_instance.server[1]など)は個々のインスタンスを指します。

countを使用して作成したリソースについて、

個々のインスタンス（作成したもの？）を指定するにはインデックスが必要ということ。

（「リソースブロックを指します。」はよくわかりません。）

修正して再度確認

原因わかったので、インデックスを指定します

・main.tf

# NATゲートウェイ
resource "aws_nat_gateway" "main" {
  # リソースを作成するか
  # 0：作成しない、1：作成する
  count = var.count_nat_gateway
  # EIPの指定
  allocation_id = aws_eip.nat_gateway[0].id
  # パブリックサブネットを指定
  subnet_id = aws_subnet.public.id
  tags = {
    Name = "${var.prefix}-nat_gateway-${var.az}"
  }
}

# NATゲートウェイ用EIP
resource "aws_eip" "nat_gateway" {
  count  = var.count_nat_gateway
  domain = "vpc"
  tags = {
    Name = "${var.prefix}-eip-nat_gateway-${var.az}"
  }
}

# Route
# プライベートサブネット → NATゲートウェイへの通信を許可
resource "aws_route" "private" {
  count                  = var.count_nat_gateway
  route_table_id         = aws_route_table.private.id
  nat_gateway_id         = aws_nat_gateway.main[0].id
  destination_cidr_block = "0.0.0.0/0"
}