【파이썬 samconfig.yml에서 목록 (배열) 형식으로 CommaDelimitedList를 작성하는】 방법

📅 작성일: 2025/02/09, 수정일: 2025/02/09 ⏱️ 예상 읽기 시간 약 2분 (972자)

SAM CLI에서 samconfig.yml을 사용하여 배포할 때 CommaDelimitedList Type에 매개 변수를 작성하는 경우 문자열로 작성해야 합니다.
요소가 많으면 문자열로 작성하면 길이가 길어지고 읽기 쉬워집니다.
CommaDelimitedList는 samconfig.yml에 배열형식으로 작성되어 있기 때문에 변환과정이 Python으로 구현되어 있으므로 그 방법에 대해서 설명을 드리도록 하겠습니다.

코딩 표준 및 전제 조건
samconfig.yml을 사용하여 목록 형식의 CommadelimitedList를 변환하는 프로세스
(추가) CloudFormation 배포 시 YAML 파일에서 –cli-input-json에 대한 JSON 파일 생성

코딩 표준 및 전제 조건

이 문서에서 참조된 Python 스크립트는 PEP8을 준수합니다.
구문 검사에는 flake8을 사용하고 자동 서식 지정에는 black을 사용합니다.
처리상의 이유로 검사를 무시해야 하는 코드에는 #noqa 가 포함됩니다.
최대 줄 길이( max-line-length )는 200자로 설정됩니다.
Python 런타임 버전은 3.12.1이며 호환성 테스트를 거쳤습니다.

samconfig.yml을 사용하여 목록 형식의 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)

스크립트를 실행하는 방법의 예는 다음과 같습니다.예를 들어, 목록 형식으로 작성된 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
            # reference: 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=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

(추가) CloudFormation 배포 시 YAML 파일에서 –cli-input-json에 대한 JSON 파일 생성

CloudFormation 배포 시 매개변수를 외부 파일로 제공하고 --cli-input-json 옵션으로 JSON 파일을 지정할 수 있습니다.YAML 파일에서 이 JSON 파일을 생성하는 프로세스는 다음과 같습니다.
필수 모듈은 다음과 같습니다.
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"
        }
    ]
}