ロールバックの設定

デフォルトでは、スタックのデプロイ AWS CloudFormation アクションが失敗すると、 AWS CloudFormation はスタックを最後の既知の安定状態にロールバックします。アクションが失敗したときだけでなく、指定された Amazon CloudWatch アラームが発生したときにもロールバックが発生するように動作を変更できます。CloudWatch アラームの使用の詳細については、Amazon CloudWatch ユーザーガイドの「Amazon CloudWatch アラームの使用」を参照してください。

デフォルトの動作を変更して、アクションが失敗しても CloudFormation がスタックをロールバックしないようにすることもできます。

ロールバックを設定するには、以下の手順に従います。

注記

ロールバックを手動で開始することはできません。

Visual

[開始する前に]

1. 機能しているスタックのデプロイ AWS CloudFormation アクションを含むワークフローがあることを確認します。詳細については、「AWS CloudFormation スタックのデプロイ」を参照してください。

2. スタックロール - スタックのデプロイアクションのオプションフィールドで指定されたロールに、CloudWatchFullAccess アクセス許可を必ず含めてください。 AWS CloudFormation 必要なアクセス許可を持つロールの作成の詳細については、「ステップ 2: AWS ロールを作成する」を参照してください。

AWS CloudFormation 「スタックをデプロイ」アクションのロールバックアラームを設定するには

1. https://codecatalyst.aws/ で CodeCatalyst コンソールを開きます。

2. プロジェクトを選択します。

3. ナビゲーションペインで [CI/CD]、[ワークフロー] の順に選択します。

4. ワークフローの名前を選択します。ワークフローが定義されているソースリポジトリまたはブランチ名でフィルタリングすることも、ワークフロー名またはステータスでフィルタリングすることもできます。

5. [編集] を選択します。

6. [ビジュアル] を選択します。

7. AWS CloudFormation スタックのデプロイアクションを選択します。

8. 詳細ペインで、[設定] を選択します。

9. 下部で、[アドバンスト] を展開します。

10. [モニターアラーム ARN] で、[アラームを追加] を選択します。

11. 次のフィールドに情報を入力します。

    • アラーム ARN

      ロールバックトリガーを追加するには、Amazon CloudWatch アラームの Amazon リソースネーム (ARN) を指定します。例えば、arn:aws:cloudwatch::123456789012:alarm/MyAlarm と指定します。最大 5 個のロールバックトリガーを持つことができます。

      注記

      CloudWatch アラーム ARN を指定する場合は、アクションが CloudWatch にアクセスできるようにする追加のアクセス許可も設定する必要があります。詳細については、「ロールバックの設定」を参照してください。

    • モニタリングタイム

      CloudFormation が指定されたアラームをモニタリングする 0 ～ 180 分の時間を指定します。モニタリングは、すべてのスタックリソースがデプロイされた後に開始します。アラームが指定されたモニタリング時間内に発生した場合、デプロイは失敗し、CloudFormation はスタックオペレーション全体をロールバックします。

      デフォルト: 0。CloudFormation は、スタックリソースがデプロイされている間だけアラームをモニタリングします。その後はモニタリングしません。

YAML

AWS CloudFormation 「スタックをデプロイ」アクションのロールバックトリガーを設定するには

1. https://codecatalyst.aws/ で CodeCatalyst コンソールを開きます。

2. プロジェクトを選択します。

3. ナビゲーションペインで [CI/CD]、[ワークフロー] の順に選択します。

4. [ AWS CloudFormation スタックをデプロイ] アクションを含むワークフローの名前を選択します。ワークフローが定義されているソースリポジトリまたはブランチ名でフィルタリングすることも、ワークフロー名またはステータスでフィルタリングすることもできます。

5. [編集] を選択します。

6. [YAML] を選択します。

7. ロールバックトリガーを追加するには、YAML コードに monitor-alarm-arns および monitor-timeout-in-minutes プロパティを追加します。各プロパティの説明については、「「AWS CloudFormation スタックをデプロイ」アクション YAML」を参照してください。

8. AWS CloudFormation スタックのデプロイアクションの role-arnプロパティで指定されたロールに、CloudWatchFullAccess アクセス許可を必ず含めてください。必要なアクセス許可を持つロールの作成の詳細については、「ステップ 2: AWS ロールを作成する」を参照してください。

Visual

AWS CloudFormation 「スタックをデプロイ」アクションのロールバックを無効にするには

1. https://codecatalyst.aws/ で CodeCatalyst コンソールを開きます。

2. プロジェクトを選択します。

3. ナビゲーションペインで [CI/CD]、[ワークフロー] の順に選択します。

4. [ AWS CloudFormation スタックをデプロイ] アクションを含むワークフローの名前を選択します。ワークフローが定義されているソースリポジトリまたはブランチ名でフィルタリングすることも、ワークフロー名またはステータスでフィルタリングすることもできます。

5. [編集] を選択します。

6. [ビジュアル] を選択します。

7. AWS CloudFormation スタックのデプロイアクションを選択します。

8. 詳細ペインで、[設定] を選択します。

9. 下部で、[アドバンスト] を展開します。

10. [ロールバックを無効化] をオンにします。

YAML

AWS CloudFormation 「スタックをデプロイ」アクションのロールバックを無効にするには

1. https://codecatalyst.aws/ で CodeCatalyst コンソールを開きます。

2. プロジェクトを選択します。

3. ナビゲーションペインで [CI/CD]、[ワークフロー] の順に選択します。

4. [ AWS CloudFormation スタックをデプロイ] アクションを含むワークフローの名前を選択します。ワークフローが定義されているソースリポジトリまたはブランチ名でフィルタリングすることも、ワークフロー名またはステータスでフィルタリングすることもできます。

5. [編集] を選択します。

6. [YAML] を選択します。

7. ロールバックを停止するには、YAML コードに disable-rollback: 1 プロパティを追加します。この動作の説明については、「「AWS CloudFormation スタックをデプロイ」アクション YAML」を参照してください。