AWS リソースを手動作成後に CloudFormation で管理する方法

はじめに

皆さんこんにちは、asmgです。今回は、手動で作成したAWSリソースをCloudFormation (以下、cfnと呼びます) の機能「リソースのインポート」を使って、簡単にcfnで管理できるようにする方法についてまとめたいと思います。

手動で作ったAWS リソースをcfn管理したくなった背景

自分のチームでは基本的にAWSのリソースは、cfnでリソースを管理しています。しかし、開発時に手動で作った環境はcfnでは管理されていません。

ただこの状態だと、AWSリソースが何らかの理由で壊してしまった時に復旧できなくなってしまうので簡単に手動で作った環境をcfnに移行する方法を検討していました。

本記事では、CloudFormationの「リソースのインポート」機能を利用してcfn管理にする方法を使ってcfn管理をしてみました。

ref: スタックへの既存リソースのインポート

手動で作ったリソースをcfn管理するまでの手順

本記事では、Amazon SQSを例に解説していこうと思います。

1, 手動で作ったAmazon SQSの情報をもとにAmazon SQSのcfnテンプレートを作成する。

上記の情報をもとにAmazon SQSのテンプレートを作成していきます。

template.yaml

AWSTemplateFormatVersion: '2010-09-09'
Resources:
  TestSqs:
    Type: 'AWS::SQS::Queue'
    DeletionPolicy: Retain
    Properties:
      QueueName: test-sqs
      VisibilityTimeout: 30
      MaximumMessageSize: 2048
      # MaximumMessageSize
      # 256KB * 8bit = 2048B
      MessageRetentionPeriod: 345600
      # MessageRetentionPeriod
      # 345600/1440 = 240
      # 240/60 = 4 days
      ReceiveMessageWaitTimeSeconds: 0

Amazon SQS のcfnテンプレートを作成する際のtips

• VisibilityTimeout

  • コンソール上だと、デフォルトの可視性タイムアウトを指しています。

• MaximumMessageSize

  • コンソール上だと、最大のメッセージサイズを指しています。
    • ※ここの表記はバイトなので今回の場合、KBをBに変換しています。

• MessageRetentionPeriod

  • コンソール上だと、メッセージの保存期間を指しています。
    • ※ここの表記は秒数になるので今回の場合、日数を秒数に変換しています。

各パラメータの詳細については以下のドキュメントを参考にしてください。
ref: AWS::SQS::Queue

2, 作成したAmazon SQSのcfnテンプレートをもとにリソースをimportする

(1) CloudFormationを開いて既存のリソースを使用(リソースをインポート)を押します。

(2) リソースを識別ページに飛ぶので次へに進みます。

(3) テンプレートの指定ページに飛ぶので(1)で作ったtemplateをアップロードして次へ進みます。

※アップロードの方法はS3にアップロードしておく方法とテンプレートファイルのアップロードの２種類の方法がありますが、私の環境ではcfnをs3等で管理しているわけではなくgithubのリポジトリで管理しているのでs3からアップロードではなく手動でテンプレートファイルをアップロードしています。

(4) インポートするリソースを選択するページに移動するので今回インポートするSQSのQueueURLを入力して次へ進みます。

※Amazon SQSのQueueURLは、Amazon SQSのコンソールのURLの部分にあります。

(5) スタックの詳細を指定ページに移動するのでスタック名を入力します。

ここで定義するスタックの名前は今後cfnで管理するリソースのスタック名になるのでリソースを識別できる名前にするのが良いと思います。

(6) 最後にスタックの詳細を確認してリソースをインポートを押します。

変更点を確認してインポートされるリソースで間違っていないかを確認してインポートを押す必要があります。

3, Amazon SQSリソースがcfnでインポートされているかを確認する。

cfnのコンソールを確認するとimportされていることが確認できます。

該当スタック名のステータスがIMPORT_COMPLETEになっていればimportが成功していますので、(1)で作ったテンプレートをもとにcfn管理をすることができるようになります。

まとめ

CloudFormationの既存リソースのimportを行うことで、手動で作成したAWSリソースをcfn管理することができました。

今回はAmazon SQSを用いてimportを行いましたが、もし他の手動で作成したリソースをcfnで管理したいと考えている場合にはこの方法を使ってみると良いと思います。

既存リソースのimportが行えるリソースを以下にまとめておきたいと思いますので参考にしてください。

ref: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html

参考情報