【Python】samconfig.yml で CommaDelimitedList を List (配列)形式で記述する方法

作成日: 2025/02/09, 更新日: 2025/02/09

SAM CLI で samconfig.yml を利用してデプロイする際、パラメータを CommaDelimitedList Type で記述する場合、文字列で記述する必要があります。
要素数が多い場合、文字列で記述すると横長になり可読性が悪くなります。
samconfig.yml で CommaDelimitedList を配列形式で記述するため、変換処理を Python で実装しましたので、その方法を記載いたします。

コーディングルール・前提条件
samconfig.yml で List 形式の CommadelimitedList を変換する処理
（番外編）CloudFormation をデプロイする際に –cli-input-json で指定する JSON ファイルを YAML ファイルから生成する処理

コーディングルール・前提条件

本記事に記載の Python スクリプトでは、PEP8 に準拠しています。
- flake 8 による構文チェックと、 black による自動フォーマットを実施しています。
- 処理の都合上チェックを無視する必要があるコードには、 # noqa を記載しています。
- 1行当たりの最大文字数（ max-line-length ）は 170 に設定しています。

Python のランタイムバージョンは 3.12.1 を利用して動作確認を行っています。

samconfig.yml で List 形式の CommadelimitedList を変換する処理

実行に必要なモジュールは以下の通りです。 argparse は標準ライブラリのため、追加のインストールは不要です。


          pyyaml

以下の Python スクリプトが、 samconfig.yml に記載された parameter_overrides の値を、配列形式から CommadelimitedList 形式に変換します。適当 Python ファイルの名前（例： transform_parameter_overrides.py ）で保存してください。
- SAM CLI のオプションで切り替えることができるわけではないため、実行手順や CI/CD に組み込んでご利用ください。


          import yaml
          import argparse


          def is_already_transformed(overrides):
              return all(isinstance(item, str) and "=" in item for item in overrides)


          def transform_parameter_overrides(data):
              for key, value in data.items():
                  if isinstance(value, dict) and "global" in value and "parameters" in value["global"]:
                      parameters = value["global"]["parameters"]
                      if "parameter_overrides" in parameters:
                          if not is_already_transformed(parameters["parameter_overrides"]):
                              new_overrides = []
                              for override in parameters["parameter_overrides"]:
                                  if isinstance(override, dict):
                                      for k, v in override.items():
                                          if isinstance(v, list):
                                              v = ",".join(v)
                                          new_overrides.append(f"{k}={v}")
                              parameters["parameter_overrides"] = new_overrides
              return data


          def main(input_file, output_file):
              with open(input_file, "r") as f:
                  data = yaml.safe_load(f)

              transformed_data = transform_parameter_overrides(data)

              with open(output_file, "w") as f:
                  yaml.dump(transformed_data, f, default_flow_style=False, sort_keys=False)


          if __name__ == "__main__":
              parser = argparse.ArgumentParser(description="Transform parameter overrides in a YAML file.")
              parser.add_argument("--input-file", help="Path to the input YAML file.", default="samconfig.original.yml")
              parser.add_argument("--output-file", help="Path to the output YAML file.", default="samconfig.yml")
              args = parser.parse_args()

              main(args.input_file, args.output_file)

以下は実行例となります。例えば、List 形式で記載した samconfig.original.yml を samconfig.yml に変換する場合です。
- これは上のスクリプトではデフォルト値として設定しているため、引数を指定せずに実行できます。
- 要件に応じて、引数でファイルパスを指定して実行してください。


          python transform_parameter_overrides.py

samconfig.original.yml の例を以下に示します。このファイルを変換することで、 samconfig.yml が生成されます。


          version: 0.1
          dev:
            global:
              parameters:
                parameter_overrides:
                  - Environment: dev
                  - Whitelist:
                      # Windows Update
                      # 参考: https://learn.microsoft.com/en-us/windows-server/administration/windows-server-update-services/deploy/2-configure-wsus#211-configure-your-firewall-to-allow-your-first-wsus-server-to-connect-to-microsoft-domains-on-the-internet
                      - .windowsupdate.microsoft.com
                      - .update.microsoft.com
                      - .windowsupdate.com
                      - download.microsoft.com
                      - .download.windowsupdate.com
                      - wustat.windows.com
                      - ntservicepack.microsoft.com
                      - go.microsoft.com
                      - dl.delivery.mp.microsoft.com
                      - .delivery.mp.microsoft.com
                      - .microsoft.com

以下は、変換後の samconfig.yml の例です。 Whitelist の値が CommadelimitedList 形式に変換されていることが確認できます。


          version: 0.1
          dev:
            global:
              parameters:
                parameter_overrides:
                - Environment=com1
                - Whitelist=.windowsupdate.microsoft.com,.update.microsoft.com,.windowsupdate.com,download.microsoft.com,.download.windowsupdate.com,wustat.windows.com,ntservicepack.microsoft.com,go.microsoft.com,dl.delivery.mp.microsoft.com,.delivery.mp.microsoft.com,.microsoft.com

（番外編）CloudFormation をデプロイする際に –cli-input-json で指定する JSON ファイルを YAML ファイルから生成する処理

CloudFormation をデプロイする際に、パラメータを外部ファイルとして用意し --cli-input-json オプションで JSON ファイルを指定することができます。この JSON ファイルを YAML ファイルから生成する処理を以下に示します。

実行に必要なモジュールは以下の通りです。 argparse は標準ライブラリのため、追加のインストールは不要です。


          pyyaml
          json

以下の Python スクリプトが、 parameter.original.yml に記載された Parameters の値を、 --cli-input-json で指定する JSON ファイルに変換します。適当 Python ファイルの名前（例： transform_parameters.py ）で保存してください。


          import yaml
          import json
          import argparse


          def transform_parameters(data):
              if "Parameters" in data:
                  new_parameters = []
                  for param in data["Parameters"]:
                      for key, value in param.items():
                          if isinstance(value, list):
                              value = ",".join(value)
                          new_parameters.append({"ParameterKey": key, "ParameterValue": value})
                  data["Parameters"] = new_parameters
              return data


          def main(input_file, output_file):
              with open(input_file, "r") as f:
                  data = yaml.safe_load(f)

              transformed_data = transform_parameters(data)

              with open(output_file, "w") as f:
                  json.dump(transformed_data, f, indent=4)


          if __name__ == "__main__":
              parser = argparse.ArgumentParser(description="Transform parameters in a YAML file.")
              parser.add_argument("--input-file", help="Path to the input YAML file.", default="parameter.original.yml")
              parser.add_argument("--output-file", help="Path to the output JSON file.", default="parameter.json")
              args = parser.parse_args()

              main(args.input_file, args.output_file)

以下は実行例となります。例えば、YAML 形式で記載した parameter.original.yml を parameter.json に変換する場合です。
- これは上のスクリプトではデフォルト値として設定しているため、引数を指定せずに実行できます。
- 要件に応じて、引数でファイルパスを指定して実行してください。


          python transform_parameters.py

parameter.original.yml の例を以下に示します。このファイルを変換することで、 parameter.json が生成されます。


          Parameters:
            Environment:
              - dev
            Whitelist:
              - .windowsupdate.microsoft.com
              - .update.microsoft.com
              - .windowsupdate.com
              - download.microsoft.com
              - .download.windowsupdate.com
              - wustat.windows.com
              - ntservicepack.microsoft.com
              - go.microsoft.com
              - dl.delivery.mp.microsoft.com
              - .delivery.mp.microsoft.com
              - .microsoft.com

以下は、変換後の parameter.json の例です。 Parameters の値が --cli-input-json で指定する JSON ファイル形式に変換されていることが確認できます。


          {
              "Parameters": [
                  {
                      "ParameterKey": "Environment",
                      "ParameterValue": "dev"
                  },
                  {
                      "ParameterKey": "Whitelist",
                      "ParameterValue": ".windowsupdate.microsoft.com,.update.microsoft.com,.windowsupdate.com,download.microsoft.com,.download.windowsupdate.com,wustat.windows.com,ntservicepack.microsoft.com,go.microsoft.com,dl.delivery.mp.microsoft.com,.delivery.mp.microsoft.com,.microsoft.com"
                  }
              ]
          }