locals

locals は、Terraformコードの内部だけで使う「変数」を定義するものです。 変数とは、特定の値を入れる「箱」のようなものです。何度も使う値に名前をつけて定義しておくことで、コード内で使い回すことができます。

1. 記載方法

1.1 定義

まずは locals の定義方法です。下記は、stage という locals 変数に、test という値を初期値として設定した場合の例です。

locals {
  stage = "test"
}

このように、locals と書いたブロックの中に、変数を定義します。 また、複数の locals 変数を定義したい場合は、改行して複数定義することもできます。

locals {
  stage = "test"
  app_name = "app1"
}

1.2 利用方法

locals を利用する方法を説明します。

例えば下記は、VPCを定義する記載ですが、タグの中にNameタグとして値を設定しています。local.変数名 と記載することで、変数の値を使用できます。この場合、Nameタグに「test」という文字列が設定されます。

resource "aws_vpc" "vpc" {
  tags = {
    Name = local.stage
  }
}

また、文字列と結合する形で利用することもできます。例えば下記は、stage の値と、「-vpc」という文字列を組み合わせています。この場合「test-vpc」という名前が、Nameタグとして利用されます。

resource "aws_vpc" "vpc" {
  tags = {
    Name = "${local.stage}-vpc"
  }
}

2. 動作確認

locals を利用したコードを実行してみます。

2.1 コードの記載

まずはサンプルコードです。下記は、stage という locals 変数に「test」という値を定義し、それを利用してVPCのNameタグを指定しています。この場合、Nameタグには「test-vpc」という文字列が設定されます。

この内容を、main.tf に記載してください。

provider "aws" {
  region = "ap-northeast-1"
}

# Localsの定義
locals {
  stage = "test"
}

# 利用: local.名前 で参照する
resource "aws_vpc" "vpc" {
  cidr_block = "10.0.0.0/16"
  tags = {
    Name = "${local.stage}-vpc"
  }
}

2.2 リソースの作成

以下のコマンドで、Terraform がインストールされていることを確認します。

terraform --version

以下のように Terraform のバージョンが表示されれば、インストールは確認できています。

Terraform vX.X.X
on darwin_arm64

バージョンが表示されない場合は、Terraformのインストール を先に実施してください。

インストールが確認できたら、terraform apply を実行し、結果を反映させます。

terraform apply

実行が完了したら、AWSのリソースを確認します。

VPCのダッシュボードを開き、VPCの一覧から、test-vpc というVPCが作成されていることを確認します。これにより、locals を利用したNameタグの設定が正しく行われていることがわかります。

2.3 リソースの削除

確認が終わったら、terraform destroy コマンドで、リソースを削除しておきます。

terraform destroy