スタックリファクタリング

現在のインフラストラクチャを評価する – 既存の CloudFormation スタックとリソースを見直して、スタックリファクタリングの機会を特定します。

リファクタリングを計画する – リソースの編成方法を定義します。依存関係、命名規則、運用上の制限を検討してください。後に CloudFormation の検証に影響する可能性があります。

リファクタリング先スタックを決定する – リソースをリファクタリングするスタックを決定します。リソースは、最小で 2 つ、最大で 5 つのスタック間で移動できます。リソースはネストされたスタック間で移動できます。

テンプレートを更新する – CloudFormation テンプレートを変更して、テンプレート間でのリソース定義の移動などの計画済みの変更を反映します。論理 ID の名前はこのプロセス中に変更できます。

スタックリファクタリングを作成する – リファクタリングするスタック名とテンプレートのリストを指定します。

リファクタリングによる影響を確認し、競合があれば解決する – CloudFormation が指定されたテンプレートを検証し、スタック間の依存関係、タグの更新問題があるリソースタイプ、リソース論理 ID の競合をチェックします。

検証が成功した場合は、リファクタリングの実行中に行われるリファクタリングアクションのプレビューを CloudFormation が生成します。

検証に失敗した場合は、特定された問題を解決して再試行します。競合が存在する場合は、競合するリソースのソースとリファクタリング先を示すリソース論理 ID マッピングを指定します。

リファクタリングを実行する – 変更がリファクタリングの目標と一致することを確認したら、スタックのリファクタリングを完了します。

監視する – 実行ステータスを追跡して、オペレーションが正常に完了することを確認します。

get-template コマンドを使用して、リファクタリングするスタックの CloudFormation テンプレートを取得します。

aws cloudformation get-template --stack-name Stack1

テンプレートを取得したら、希望の統合開発環境 (IDE) を使用してテンプレートを更新し、目的の構造とリソース組織を使用するようにします。

create-stack-refactor コマンドを使用して、リファクタリングするスタックのスタック名と更新されたテンプレートを指定します。新しいスタックがまだ存在しない場合は、CloudFormation が新しいスタックを作成できるようにする --enable-stack-creation オプションを含めます。

aws cloudformation create-stack-refactor \
  --stack-definitions \
    StackName=Stack1,TemplateBody@=file://template1-updated.yaml \
    StackName=Stack2,TemplateBody@=file://template2-updated.yaml \
  --enable-stack-creation

このコマンドは、今後のステップで使用する StackRefactorId を返します。

{
    "StackRefactorId": "9c384f70-4e07-4ed7-a65d-fee5eb430841"
}

テンプレートの検証中に競合が検出された場合は (次のステップで確認できます)、create-stack-refactor コマンドを --resource-mappings オプションとともに使用します。

aws cloudformation create-stack-refactor \
  --stack-definitions \
    StackName=Stack1,TemplateBody@=file://template1-updated.yaml \
    StackName=Stack2,TemplateBody@=file://template2-updated.yaml \
  --enable-stack-creation \ 
  --resource-mappings file://resource-mapping.json

次は、resource-mapping.json ファイルの例です。

[
    {
        "Source": {
            "StackName": "Stack1",
            "LogicalResourceId": "MySNSTopic"
        },
        "Destination": {
            "StackName": "Stack2",
            "LogicalResourceId": "MyLambdaSNSTopic"
        }
    }
]

describe-stack-refactor コマンドを使用して、Status が CREATE_COMPLETE であることを確認します。このコマンドは、検証が完了していることを実証します。

aws cloudformation describe-stack-refactor \
  --stack-refactor-id 9c384f70-4e07-4ed7-a65d-fee5eb430841

出力例:

{
    "StackRefactorId": "9c384f70-4e07-4ed7-a65d-fee5eb430841",
    "StackIds": [
        "arn:aws:cloudformation:us-east-1:123456789012:stack/Stack1/3e6a1ff0-94b1-11f0-aa6f-0a88d2e03acf",
        "arn:aws:cloudformation:us-east-1:123456789012:stack/Stack2/5da91650-94b1-11f0-81cf-0a23500e151b"
    ],
    "ExecutionStatus": "AVAILABLE",
    "Status": "CREATE_COMPLETE"
}

list-stack-refactor-actions コマンドを使用して、実行される特定のアクションをプレビューします。

aws cloudformation list-stack-refactor-actions \
  --stack-refactor-id 9c384f70-4e07-4ed7-a65d-fee5eb430841

出力例:

{
    "StackRefactorActions": [
        {
            "Action": "MOVE",
            "Entity": "RESOURCE",
            "PhysicalResourceId": "MyTestLambdaRole",
            "Description": "No configuration changes detected.",
            "Detection": "AUTO",
            "TagResources": [],
            "UntagResources": [],
            "ResourceMapping": {
                "Source": {
                    "StackName": "arn:aws:cloudformation:us-east-1:123456789012:stack/Stack1/3e6a1ff0-94b1-11f0-aa6f-0a88d2e03acf",
                    "LogicalResourceId": "MyLambdaRole"
                },
                "Destination": {
                    "StackName": "arn:aws:cloudformation:us-east-1:123456789012:stack/Stack2/5da91650-94b1-11f0-81cf-0a23500e151b",
                    "LogicalResourceId": "MyLambdaRole"
                }
            }
        },
        {
            "Action": "MOVE",
            "Entity": "RESOURCE",
            "PhysicalResourceId": "MyTestFunction",
            "Description": "Resource configuration changes will be validated during refactor execution.",
            "Detection": "AUTO",
            "TagResources": [
                {
                    "Key": "aws:cloudformation:stack-name",
                    "Value": "Stack2"
                },
                {
                    "Key": "aws:cloudformation:logical-id",
                    "Value": "MyFunction"
                },
                {
                    "Key": "aws:cloudformation:stack-id",
                    "Value": "arn:aws:cloudformation:us-east-1:123456789012:stack/Stack2/5da91650-94b1-11f0-81cf-0a23500e151b"
                }
            ],
            "UntagResources": [
                "aws:cloudformation:stack-name",
                "aws:cloudformation:logical-id",
                "aws:cloudformation:stack-id"
            ],
            "ResourceMapping": {
                "Source": {
                    "StackName": "arn:aws:cloudformation:us-east-1:123456789012:stack/Stack1/3e6a1ff0-94b1-11f0-aa6f-0a88d2e03acf",
                    "LogicalResourceId": "MyFunction"
                },
                "Destination": {
                    "StackName": "arn:aws:cloudformation:us-east-1:123456789012:stack/Stack2/5da91650-94b1-11f0-81cf-0a23500e151b",
                    "LogicalResourceId": "MyFunction"
                }
            }
        }
    ]
}

変更を確認して確認したら、execute-stack-refactor コマンドを使用してスタックリファクタリングオペレーションを完了します。

aws cloudformation execute-stack-refactor \
  --stack-refactor-id 9c384f70-4e07-4ed7-a65d-fee5eb430841

describe-stack-refactor コマンドを使用して、実行ステータスを監視します。

aws cloudformation describe-stack-refactor \
  --stack-refactor-id 9c384f70-4e07-4ed7-a65d-fee5eb430841

出力例:

{
    "StackRefactorId": "9c384f70-4e07-4ed7-a65d-fee5eb430841",
    "StackIds": [
        "arn:aws:cloudformation:us-east-1:123456789012:stack/Stack1/3e6a1ff0-94b1-11f0-aa6f-0a88d2e03acf",
        "arn:aws:cloudformation:us-east-1:123456789012:stack/Stack2/5da91650-94b1-11f0-81cf-0a23500e151b"
    ],
    "ExecutionStatus": "SUCCEEDED",
    "Status": "COMPLETE"
}