AWS SAM CLI での Terraform のサポートの準備

1. AWS SAM CLI をインストールまたはアップグレードする

   AWS SAM CLI がインストールされているかを確認するには、次のコマンドを実行します。

   $ sam --version

   AWS SAM CLI がインストールされている場合は、出力にバージョンが表示されます。最新バージョンにアップグレードするには、「AWS SAM CLI のアップグレード」 を参照してください。

   AWS SAM CLI のインストール手順とインストールに必要な前提条件については、「AWS SAM CLI のインストール」を参照してください。

2. Terraform をインストールする

   Terraform がインストールされているかを確認するには、次のコマンドを実行します。

   $ terraform -version

   Terraform をインストールするには、Terraform レジストリで「Install Terraform」を参照してください。

3. ローカルテスト用の Docker のインストール

   AWS SAM CLI でローカルテストを実行するには Docker が必要です。Docker をインストールするには、「AWS SAM CLI で Docker を使用するためのインストール方法」を参照してください。

sam metadata リソースを定義します。

1. リソースには sam_metadata_ で始まる名前を付けます。sam metadata リソースとして認識できるようにするためです。

2. リソースの triggers ブロック内で Lambda アーティファクトプロパティを定義します。

3. Lambda ビルドロジックを含む null_resource を depends_on 引数で指定します。

   以下はテンプレートの例です。

   resource "null_resource" "sam_metadata_..." {
     triggers = {
       resource_name = resource_name
       resource_type = resource_type
       original_source_code = original_source_code
       built_output_path = built_output_path
     }
     depends_on = [
       null_resource.build_lambda_function # ref to your build logic
     ]
   }

   以下に、sam metadata リソースの例を示します。

   resource "null_resource" "sam_metadata_aws_lambda_function_publish_book_review" {
       triggers = {
           resource_name = "aws_lambda_function.publish_book_review"
           resource_type = "ZIP_LAMBDA_FUNCTION"
           original_source_code = "${local.lambda_src_path}"
           built_output_path = "${local.building_path}/${local.lambda_code_filename}"
       }
       depends_on = [
           null_resource.build_lambda_function
       ]
   }

サムビルドでビルドするには

1. Terraform ルートモジュールを含むディレクトリから、以下の操作を実行する。

   $ sam build --hook-name terraform

2. 特定の Lambda 関数または Layer を構築するには、以下を実行します。

   $ sam build --hook-name terraform lambda-resource-id

   許容される ID は、Lambda 関数名または完全な Terraform リソースアドレス (aws_lambda_function.list_books または module.list_book_function.aws_lambda_function.this[0] など) です。

コンテナを使用してビルドするには

1. Terraform、Python、および Make ツールを含む Dockerfile を作成します。Lambda 関数ランタイムも含める必要があります。

   次に Dockerfile の例を示します。

   FROM public.ecr.aws/amazonlinux/amazonlinux:2
   
   RUN yum -y update \
       && yum install -y unzip tar gzip bzip2-devel ed gcc gcc-c++ gcc-gfortran \
       less libcurl-devel openssl openssl-devel readline-devel xz-devel \
       zlib-devel glibc-static libcxx libcxx-devel llvm-toolset-7 zlib-static \
       && rm -rf /var/cache/yum
   
   RUN yum -y install make \
       && yum -y install zip
   
   RUN yum install -y yum-utils \
       && yum-config-manager --add-repo https://rpm.releases.hashicorp.com/AmazonLinux/hashicorp.repo \
       && yum -y install terraform \
       && terraform --version
   
   # AWS Lambda Builders
   RUN amazon-linux-extras enable python3.8
   RUN yum clean metadata && yum -y install python3.8
   RUN curl -L get-pip.io | python3.8
   RUN pip3 install aws-lambda-builders
   RUN ln -s /usr/bin/python3.8 /usr/bin/python3
   RUN python3 --version
   
   VOLUME /project
   WORKDIR /project
   
   ENTRYPOINT ["sh"]

2. docker build を使用して Docker イメージをビルドします。

   以下に例を示します。

   $ docker build --tag terraform-build:v1 <path-to-directory-containing-Dockerfile>

3. --use-container と --build-image オプションを指定して AWS SAM CLI sam build コマンドを実行します。

   以下に例を示します。

   $ sam build --use-container --build-image terraform-build:v1

ローカルプランファイルを生成するには

1. API トークンの設定 — トークンのタイプはアクセスレベルによって異なります。詳細については、「Terraform Cloud ドキュメント」で「API Tokens」を参照してください。

2. API トークンの環境変数を設定する — 以下はコマンドラインからの例です。

   $ export TOKEN="<api-token-value>"

3. 実行 ID の取得 — Terraform Cloud コンソールから、AWS SAMCLI で使用したい Terraform ランの実行 ID を探します。

   実行 ID は実行のブレッドクラムパスにあります。

   

4. プランファイルの取得 — API トークンを使用して、ローカルのプランファイルを取得します。コマンドからの出力例を次に示します。

   curl \
      --header "Authorization: Bearer $TOKEN" \
      --header "Content-Type: application/vnd.api+json" \
      --location \
      https://app.terraform.io/api/v2/runs/<run ID>/plan/json-output \
      > custom_plan.json