LanguageExtensionsを利用したスタックを更新する時には「既存テンプレートを置き換える」を選択しよう

#AWS CloudFormation

木村優太

2024.02.21

こんにちは、AWS事業部の木村です。

以下の記事を参考にCloudWatchアラーム群を定期的にON, OFFする仕組みをCloudFormationを利用して作成しました。

停止期間を変更するためにパラメーターを調整してスタックの更新を行おうとしたのですが、変更が認識されずテンプレートの更新が行えないという事象に直面しました。

当初AWS::LanguageExtensionsを利用していることが理由とは気付けず、
TypeがAWS::Scheduler::Scheduleの時に発生する事象だと思っていました。

テンプレートを置き換えることで更新ができることはわかっていたのですが、自分では事象が発生している原因に辿りつくことができずAWSサポートの方に教えていただきましたので共有させていただきます。

いきなり結論

タイトルの通りですが、AWS::LanguageExtensionsを利用したスタックを更新する際には、テンプレートに変更がない場合でも「既存テンプレートを置き換える」を選択してスタックの更新が必要です。

AWS::LanguageExtensionsに関するドキュメントにも以下のように記載がありました。

If you update a stack using a different parameter value, don't use the --use-previous-template option where the original template contains the transform. Use the original template, before transformation, in the UpdateStack call. The stack will update with the new parameter values.

(簡単に意訳)

パラメーターを変更するためにスタック更新が必要な時は「現在のテンプレートの使用」を選択しないで「既存テンプレートを置き換える」を選択してください。

AWS::LanguageExtensions transform(AWS公式ドキュメント)

やってみた

というわけでここからは実際に試してみていきたいと思います。

テンプレートは先ほど紹介させていただいた記事の以下のものを利用してスタックを作成します。

AWSTemplateFormatVersion: 2010-09-09
Transform: AWS::LanguageExtensions
Parameters:
  Project:
    Type: String
  ScheduleExpressionOFF:
    Type: String
  ScheduleExpressionON:
    Type: String
  AlarmNames:
    Type: CommaDelimitedList

Resources:
  # EventBridge Scheduler (Disable CloudWatch Alarms)
  ScheduleCWAlarmOFF:
    Type: AWS::Scheduler::Schedule
    Properties:
      Name: !Sub "${Project}-cwalarm-off"
      Description: !Sub "Disable ${Project} CloudWatch Alarms"
      ScheduleExpression: !Ref ScheduleExpressionOFF
      ScheduleExpressionTimezone: "Japan"
      FlexibleTimeWindow:
        Mode: "OFF"
      State: ENABLED
      Target:
        Arn: arn:aws:scheduler:::aws-sdk:cloudwatch:disableAlarmActions
        Input:
          Fn::ToJsonString:
            AlarmNames: !Ref AlarmNames
        RoleArn: !GetAtt "SchedulerRole.Arn"

  # EventBridge Scheduler (Enable CloudWatch Alarms)
  ScheduleCWAlarmON:
    Type: AWS::Scheduler::Schedule
    Properties:
      Name: !Sub "${Project}-cwalarm-on"
      Description: !Sub "Enable ${Project} CloudWatch Alarms"
      ScheduleExpression: !Ref ScheduleExpressionON
      ScheduleExpressionTimezone: "Japan"
      FlexibleTimeWindow:
        Mode: "OFF"
      State: ENABLED
      Target:
        Arn: arn:aws:scheduler:::aws-sdk:cloudwatch:enableAlarmActions
        Input:
          Fn::ToJsonString:
            AlarmNames: !Ref AlarmNames
        RoleArn: !GetAtt "SchedulerRole.Arn"

  # Role for EventBridge Scheduler
  SchedulerRole:
    Type: AWS::IAM::Role
    Properties:
      RoleName: !Sub "${Project}-scheduler-role-for-cwalarm"
      AssumeRolePolicyDocument:
        Version: '2012-10-17'
        Statement:
        - Effect: Allow
          Principal:
            Service:
            - scheduler.amazonaws.com
          Action:
          - sts:AssumeRole
      Path: "/"
      Policies:
        - PolicyName: CloudWatchAlarmONOFF
          PolicyDocument:
            Version: "2012-10-17"
            Statement:
              - Effect: Allow
                Action:
                  - cloudwatch:DisableAlarmActions
                  - cloudwatch:EnableAlarmActions
                Resource:
                  - "*"