AWS SAM テンプレートに既存リソースをインポートする

2021/07/21

# AWS

クラウド事業部エンジニアの川勝です。

サーバレスアプリケーションの開発やデプロイにはいくつかツールがありますが AWS SAM CLI を使用しています。

AWS SAM CLI では各種リソースの定義には AWS SAM テンプレートを使用しますが、これは AWS CloudFormation を拡張したもので通常の CloudFormation で使用できる定義を書くことができます。

今回このAWS SAM テンプレートに既存リソースをインポートしようとしたらすんなりといかなかったのでその方法をまとめます。

概要

AWS CloudFormation スタックに既存リソースをインポート

AWS SAM アプリケーションに作成済みの Amazon DynamoDB をインポートしたいと思います。まずはインポート方法をドキュメントで確認。

簡単にいうと現在使用している CloudFormation テンプレートにインポートしたいリソースを追加する。

インポートするリソースは DeletionPolicy: Retain をつける、ということのようです。

テンプレートは以下のようになります。

テンプレート

sam init で作成されるテンプレートをほぼそのまま使い sam build && sam deploy で一旦デプロイします。

deploy 後に AWS CloudFormation コンソールからテンプレートをコピーしてもってきます。

（deploy 前の template.yml は CodeUri などがローカルのパスになっているため）

そこに作成済みという想定の HelloWorldTable を追加します。

Properties は現在の設定にそったものを設定しましょう。

1AWSTemplateFormatVersion: '2010-09-09'
2Transform: AWS::Serverless-2016-10-31
3Description: 'blog-cloudformation
4
5  Sample SAM Template for blog-cloudformation
6
7  '
8Globals:
9  Function:
10    Timeout: 5
11Resources:
12  HelloWorldFunction:
13    Type: AWS::Serverless::Function
14    Properties:
15      CodeUri: s3://aws-sam-cli-managed-default-samclisourcebucket-xxxxxxxxx/blog-cloudformation/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
16      Handler: hello-world
17      Runtime: go1.x
18      Events:
19        CatchAll:
20          Type: Api
21          Properties:
22            Path: /hello
23            Method: GET
24  HelloWorldTable:
25    Type: AWS::DynamoDB::Table
26    DeletionPolicy: Retain
27    Properties:
28      TableName: HelloWorld
29      AttributeDefinitions:
30        - AttributeName: key
31          AttributeType: S
32      KeySchema:
33        - AttributeName: key
34          KeyType: HASH
35      ProvisionedThroughput:
36        ReadCapacityUnits: 1
37        WriteCapacityUnits: 1
38Outputs:
39  HelloWorldAPI:
40    Description: API Gateway endpoint URL for Prod environment for First Function
41    Value:
42      Fn::Sub: https://${ServerlessRestApi}.execute-api.${AWS::Region}.amazonaws.com/Prod/hello/
43  HelloWorldFunction:
44    Description: First Lambda Function ARN
45    Value:
46      Fn::GetAtt:
47      - HelloWorldFunction
48      - Arn
49  HelloWorldFunctionIamRole:
50    Description: Implicit IAM Role created for Hello World function
51    Value:
52      Fn::GetAtt:
53      - HelloWorldFunctionRole
54      - Arn

注意点

インポート時には既存のテンプレートの Outputs セクションを変更すると失敗します。

例えばインポートしたリソースの Arn を Outputs に入れる場合一度インポートを完了させてからスタックの更新で追加する必要がありました。

インポート先が AWS SAM テンプレートの場合

AWS CloudFormation コンソールから「スタックへのリソースのインポート」を実行していきます。

続いて「テンプレートの指定」でさきほどの HelloWorldTable を追加したテンプレートをアップロードすると…

「このテンプレートにはインポートするリソースが含まれていません」とエラーになりました。「詳細はこちら」の情報では解決せず、しばらく調べていると以下記事にたどり着きました。

AWS サーバーレスアプリケーションモデル (AWS SAM) テンプレート。 AWS SAM テンプレートでは、AWS::Serverless transform を使用するリソースをインポートする機能はサポートされていません。https://aws.amazon.com/jp/premiumsupport/knowledge-center/cloudformation-template-resources-error/

なんと… AWS SAM では使えないのか、、と思ったらその下に

> このエラーを解決するには、AWS CloudFormation コンソールの代わりに AWS コマンドラインインターフェイス (AWS CLI) を使用できます。

これだ！ AWS CLI からならできそうです。

AWS CLI で解決

前述の記事ではインポートまで AWS CLI で完結していますが、変更セットさえ作れれば実行はコンソールから行っても大丈夫でした。

AWS CLI で変更セットの作成、実行は AWS CloudFormation コンソールで行う流れで進めていきます。

AWS CLI で変更セットの作成

前述の記事の手順に沿って変更セットを作成します。

import.txt という名前のリソースインポートファイルを作成します。

既存リソースを特定するためのパラメータを設定します。

ResourceType はテンプレートの [Type]、LogicalResourceId は今回のテンプレートだと [HelloWorldTable]、 Amazon DynamoDB の場合はResourceIdentifier に TableName を指定します。

1[
2    {
3        "ResourceType": "AWS::DynamoDB::Table",
4        "LogicalResourceId":
5            "HelloWorldTable"
6        ,
7        "ResourceIdentifier": {
8            "TableName":"HelloWorld"
9        }
10    }
11]

スタックに対して変更セットを作成するには、次のコマンドを実行します。

変更セットが作れたら良いので ID を環境変数にセット、、、などは省いています。

import.txt と HelloWorldTable を追加した template.yml を同ディレクトリに配置して実行。

1aws cloudformation create-change-set \
2    --stack-name blog-cloudformation \
3    --change-set-name import-test-set \
4    --resources-to-import file://import.txt \
5    --change-set-type IMPORT \
6    --template-body file://template.yml \
7    --capabilities CAPABILITY_IAM

実行できたら再びコンソールを見てみましょう。