Outputs

outputs について解説します。

1. 記載方法

variables が「入力」を受け取るためのものであるのに対し、outputs は実行結果を「出力」するためのものです。

1.1 標準的な使い方

Terraformでリソースを作成した後、そのリソースのIDやIPアドレスなどの情報をコンソールに表示したり、他のシステムから参照できるようにするために利用します。プログラミングにおける「関数の戻り値(return)」のようなものとイメージすると分かりやすいでしょう。

基本的な定義方法は以下の通りです。output ブロックに名前を付け、value に出力したい値を記述します。

output "vpc_id" {
  value = aws_vpc.vpc.id
}

この例では、作成されたVPCのID(id)を、vpc_id という名前で出力するよう定義しています。

1.2 説明(description)

outputs でも、description や sensitive といった属性を利用できます。

description には、何を出力しているかの説明を記載します。

output "vpc_id" {
  value       = aws_vpc.vpc.id
  description = "作成されたVPCのID"
}

1.3 情報の保護(sensitive)

sensitive を true に設定すると、パスワードや秘密鍵など、コンソール画面に表示したくない機密情報を隠すことができます(ログには (sensitive value) と表示されます)。ログに出力せず、その後別の機能やアプリケーションに渡したい時に利用できます。

output "db_password" {
  value     = "super_secret_password"
  sensitive = true
}

2. 動作確認

それでは、実際にコードを書いて挙動を確認してみましょう。

2.1 コードの作成

前回の variables のハンズオンで使用した main.tf に、VPC IDを出力する設定を追加します。

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

resource "aws_vpc" "vpc" {
  cidr_block = "10.0.0.0/16"
  tags = {
    Name = "${var.stage}-vpc"
  }
}

output "vpc_id" {
  value       = aws_vpc.vpc.id
  description = "The ID of the VPC"
}

2.2 値の出力

この状態で、terraform apply を実行してみましょう

terraform apply

実行が完了すると、下記のようにVPCのIDが出力されます。なお、IDの実際の値は環境により異なります。

Apply complete! Resources: 1 added, 0 changed, 0 destroyed.

Outputs:

vpc_id = "vpc-076323da6ecf841b7"

実際に作成されたVPCのIDと一致していることを確認してみます。

このように、AWSマネジメントコンソールにログインして確認しなくても、作成されたリソースのIDなどの重要な情報をすぐに知ることができます。

2.3 コマンドによる出力

また、apply の実行直後だけでなく、いつでも以下のコマンドで出力値を確認することができます。

terraform output

そうすると、以下のように output に指定した内容が全て出力されます。

vpc_id = "vpc-076323da6ecf841b7"

2.4 特定の値の出力

特定の output 値だけを確認したい場合は、名前を指定します。

terraform output vpc_id

実際の値のみが出力されます。

"vpc-076323da6ecf841b7"

2.5 リソースの削除

確認ができたら、リソースを削除しておきましょう。

terraform destroy