スタックへの既存リソースのインポート - AWS CloudFormation

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

このインポートオペレーションでは、以下の情報を指定する必要があります。

  • スタックにすでに含まれているリソースとインポートするリソースの両方を含む、スタック全体を記述するテンプレート。インポートする各リソースは、テンプレートに DeletionPolicy 属性がある必要があります。

  • 各ターゲットリソースの一意の識別子。適切なサービスコンソールにアクセスして、一意の識別子を取得します。

このチュートリアルでは、templateToImport.json というテンプレートの例を示します。ServiceTable は現在スタックの一部であり、GamesTable はインポートのターゲットです。

{ "AWSTemplateFormatVersion": "2010-09-09", "Description": "Import test", "Resources": { "ServiceTable":{ "Type":"AWS::DynamoDB::Table", "Properties":{ "TableName":"Service", "AttributeDefinitions":[ { "AttributeName":"key", "AttributeType":"S" } ], "KeySchema":[ { "AttributeName":"key", "KeyType":"HASH" } ], "ProvisionedThroughput":{ "ReadCapacityUnits":5, "WriteCapacityUnits":1 } } }, "GamesTable": { "Type": "AWS::DynamoDB::Table", "DeletionPolicy": "Retain", "Properties": { "TableName": "Games", "AttributeDefinitions": [ { "AttributeName": "key", "AttributeType": "S" } ], "KeySchema": [ { "AttributeName": "key", "KeyType": "HASH" } ], "ProvisionedThroughput": { "ReadCapacityUnits": 5, "WriteCapacityUnits": 1 } } } } }

AWS CloudFormation コンソールを使用した既存のリソースのスタックへのインポート

  1. AWS CloudFormation コンソールを開きます。

  2. [スタック] ページで、リソースのインポート先のスタックを選択します。

  3. [Stack actions (スタックアクション)] を選択し、[Import resources into stack (リソースをスタックにインポートする)] を選択します。

    
                            コンソールの [Import resources into stack (リソースをスタックにインポートする)] オプション。
  4. [インポートの概要] ページを確認し、[次へ] を選択します。

  5. [Specify template (テンプレートを指定)] ページで、以下のいずれかの方法を使用して更新したテンプレートを指定し、[次へ] を選択します。

    • [Amazon S3 URL] を選択し、テキストボックスでテンプレートの URL を指定します。

    • [Upload a template file (テンプレートファイルのアップロード)] を選択し、テンプレートを参照します。

  6. [Identify resources (リソースの識別)] ページで、各ターゲットリソースを識別します。

    1. [Identifier property (識別子のプロパティ)] で、リソース識別子のタイプを選択します。たとえば、AWS::DynamoDB::Table リソースは TableName プロパティを使用して識別できます。

    2. [Identifier value (識別子の値)] に、実際のプロパティ値を入力します。たとえば、サンプルテンプレートの GamesTable リソースの TableNameGames です。

      
                                    コンソールの [Identify resources (リソースの識別)] ページ。
    3. [Next] を選択します。

  7. [Specify stack details (スタック詳細の指定)] ページで、任意のパラメータを更新し、[次へ] を選択します。これにより、変更セットが自動的に作成されます。

    注記

    作成、更新、または削除操作をトリガーする既存のパラメータを変更すると、インポートオペレーションは失敗します。

  8. [Review stack-name (スタック名の確認)] ページで、インポートするリソースを確認し、[Import resources (リソースのインポート)] を選択します。これにより、最後のステップで作成した変更セットが自動的に実行されます。この時点で、インポートされたリソースにはスタックレベルのタグが適用されます。

    スタックの [イベント] ページが表示されます。

    
                            コンソールの [イベント] タブ。
  9. (任意)スタックでドリフト検出を実行し、インポートされたリソースのテンプレートと実際の設定が一致していることを確認します。ドリフトの検出の詳細については、「CloudFormation スタック全体のドリフトの検出」を参照してください。

  10. (オプション)インポートしたリソースが予想されるテンプレート設定と一致しない場合は、テンプレート設定を修正するか、リソースを直接更新します。ドリフトしたリソースのインポートの詳細については、「インポートオペレーションでドリフトを解決する」を参照してください。

AWS CLI を使用した既存のリソースのスタックへのインポート

  1. オプションで GetTemplateSummary を実行して、テンプレート内の各リソースタイプを識別するプロパティを確認できます。たとえば、AWS::DynamoDB::Table リソースは TableName プロパティを使用して識別できます。サンプルテンプレートの GamesTable リソースの場合、TableName の値は Games です。

    > aws cloudformation get-template-summary --template-body file://templateToImport.json
  2. インポートするリソースとその一意の識別子のリストを次の形式で作成します。

    "[{\"ResourceType\":\"AWS::DynamoDB::Table\",\"LogicalResourceId\":\"GamesTable\",\"ResourceIdentifier\":{\"TableName\":\"Games\"}}]"

  3. 以下のパラメータを使用して、タイプ IMPORT の変更セットを作成します。--resources-to-import はインライン YAML をサポートしていません。

    > aws cloudformation create-change-set --stack-name TargetStack --change-set-name ImportChangeSet --change-set-type IMPORT --resources-to-import "[{\"ResourceType\":\"AWS::DynamoDB::Table\",\"LogicalResourceId\":\"GamesTable\",\"ResourceIdentifier\":{\"TableName\":\"Games\"}}]" --template-body file://templateToImport.json

    AWS CLI は、次の例に示すように、resources-to-import パラメータへの入力としてテキストファイルもサポートします。

    --resources-to-import: file://resourcesToImport.txt

    このチュートリアルでは、file://resourcesToImport.txt に次の内容が含まれています。

    [ { "ResourceType":"AWS::DynamoDB::Table", "LogicalResourceId":"GamesTable", "ResourceIdentifier": { "TableName":"Games" } } ]
  4. 変更セットを確認し、正しいリソースがインポートされることを確認します。

    > aws cloudformation describe-change-set --change-set-name ImportChangeSet --stack-name TargetStack
  5. 変更セットを実行して、リソースをインポートします。この時点で、インポートされたリソースにはスタックレベルのタグが適用されます。オペレーション (IMPORT_COMPLETE) が正常に完了すると、リソースは正常にインポートされています。

    > aws cloudformation execute-change-set --change-set-name ImportChangeSet --stack-name TargetStack
  6. (オプション)IMPORT_COMPLETE スタックでドリフト検出を実行し、インポートされたリソースのテンプレートと実際の設定が一致していることを確認します。ドリフトの検出の詳細については、「CloudFormation スタック全体のドリフトの検出」を参照してください。

    > aws cloudformation detect-stack-drift --stack-name TargetStack { "Stack-Drift-Detection-Id" : "624af370-311a-11e8-b6b7-500cexample" } > aws cloudformation describe-stack-drift-detection-status --stack-drift-detection-id 624af370-311a-11e8-b6b7-500cexample > aws cloudformation describe-stack-resource-drifts --stack-name TargetStack
  7. (オプション)インポートしたリソースが予想されるテンプレート設定と一致しない場合は、テンプレート設定を修正するか、リソースを直接更新します。ドリフトしたリソースのインポートの詳細については、「インポートオペレーションでドリフトを解決する」を参照してください。