【파이썬 AWS:: SSM:: 문서의 스크립트 속성을 사용하여 로컬 파일을 지정하는】 방법

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

aws cloudformation package 명령은 AWS:: SSM:: Document에서 SSM 자동화를 위한 런북을 정의하는 데 사용되는 aws: executeScript 단계의 스크립트 속성에 지정된 파일을 S3에 업로드할 수 없습니다.이 프로세스가 한동안 AWS 기능 업데이트에서 지원되지 않은 이유는 AWS:: SSM:: 문서의 S3 버킷에 배치된 스크립트를 지정하기 위해 S3 버킷의 이름과 파일이 저장된 파일 이름뿐만 아니라 체크섬을 AWS:: SSM:: 문서의 해시 값으로 지정해야 하기 때문인 것으로 추정됩니다.이 문서에서는 AWS:: SSM:: 문서의 스크립트 속성에 경로별로 로컬 파일을 지정하고 배포할 수 있도록 파이썬에서 변환 프로세스를 구현했습니다. 방법은 여기에 설명되어 있습니다.

메모
코딩 표준 및 전제 조건
AWS::SSM::Document의 스크립트 속성에 지정된 파일 콘텐츠를 CloudFormation 템플릿에 포함하는 방법

메모

이 문서에 설명된 Python 스크립트를 실행하면 AWS::SSM::Document 리소스의 Script 속성에 지정된 파일 내용을 CloudFormation 템플릿에 포함할 수 있습니다.
Python 스크립트의 경우 표준 Lambda 환경에서 사용 가능한 모듈만 사용할 수 있습니다.표준 Lambda 모듈 외부의 모듈을 사용해야 하는 경우 이 Python 스크립트는 이를 처리할 수 없습니다.
os , argparse , boto3 , json , logging , time , datetime 등의 표준 모듈을 사용할 수 있습니다.
표준 Lambda 모듈 이외의 모듈을 사용해야 하는 경우 Python 스크립트와 패키지가 포함된 ZIP 파일을 S3 버킷에 수동으로 업로드한 다음 CloudFormation 템플릿을 배포해야 합니다.

코딩 표준 및 전제 조건

이 문서의 Python 스크립트는 PEP8을 따릅니다.
’flake8’로 문법 검사를 하고, ’black’으로 자동 포맷팅을 합니다.
처리 요구사항으로 인해 검사를 무시해야 하는 코드에는 ’#noqa’가 추가됩니다.
최대 줄 길이( max-line-length )는 200자로 설정됩니다.
검증에 사용되는 Python 런타임 버전은 3.12.1입니다.

AWS::SSM::Document의 스크립트 속성에 지정된 파일 콘텐츠를 CloudFormation 템플릿에 포함하는 방법

실행에 필요한 모듈은 다음과 같습니다. argparse 와 os 는 표준 라이브러리의 일부이므로 추가 설치가 필요하지 않습니다.

ruamel.yaml

다음 Python 스크립트는 AWS::SSM::Document 의 Script 속성에 지정된 파일의 내용을 CloudFormation 템플릿에 포함합니다.적절한 Python 파일 이름(예: package-ssm-document.py )으로 저장합니다.
aws cloudformation package 명령과 마찬가지로 CloudFormation 템플릿을 배포하기 전에 실행해야 합니다.배포 단계의 일부로 사용하거나 CI/CD 파이프라인에 통합하세요.

import argparse
import os
from ruamel.yaml import YAML
from ruamel.yaml.scalarstring import LiteralScalarString

yaml = YAML()
yaml.default_flow_style = False
yaml.sort_keys = False

def replace_script_with_inline_code(input_file, output_file):
    base_dir = os.path.dirname(input_file)

    with open(input_file, "r") as file:
        yaml_content = yaml.load(file)

    def process_main_steps(main_steps):
        for step in main_steps:
            if step.get("action") == "aws:executeScript" and "Script" in step["inputs"]:
                script_path = step["inputs"]["Script"]
                full_script_path = os.path.normpath(os.path.join(base_dir, script_path))
                if os.path.exists(full_script_path):
                    with open(full_script_path, "r") as script_file:
                        script_content = script_file.read()
                    step["inputs"]["Script"] = apply_literal_block_style(script_content)
                else:
                    print(f"Warning: Script file not found at {full_script_path}")
            elif step.get("action") == "aws:loop" and "Steps" in step["inputs"]:
                process_main_steps(step["inputs"]["Steps"])
            if "nextStep" in step:
                process_main_steps(step.get("nextStep", []))

    def apply_literal_block_style(script_content):
        return LiteralScalarString(script_content)

    for resource in yaml_content.get("Resources", {}).values():
        if resource.get("Type") == "AWS::SSM::Document":
            content = resource.get("Properties", {}).get("Content", {})
            if "mainSteps" in content:
                process_main_steps(content["mainSteps"])

    output_dir = os.path.dirname(output_file)
    if output_dir and not os.path.exists(output_dir):
        os.makedirs(output_dir)

    with open(output_file, "w") as file:
        yaml.dump(yaml_content, file)

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="template.original.yml")
    parser.add_argument("--output-file", help="Path to the output YAML file.", default="template.yml")
    args = parser.parse_args()
    replace_script_with_inline_code(args.input_file, args.output_file)

아래는 실행 예시입니다.
옵션은 template.original.yml 을 template.yml 로 변환하도록 지정합니다.
요구 사항에 따라 파일 경로를 인수로 지정합니다.

python package-ssm-document.py \
--input-file tests/template1.original.yml \
--output-file .alcache/template.yml

template.original.yml 의 내용은 다음과 같습니다. Script 속성에 지정된 파일은 src/sample1.py 입니다.

AWSTemplateFormatVersion: 2010-09-09
Description: template.yml
Resources:
  TestRunbook:
    Type: AWS::SSM::Document
    Properties:
      Name: Sample-TestRunbook
      DocumentType: Automation
      DocumentFormat: YAML
      UpdateMethod: NewVersion
      Content:
        schemaVersion: '0.3'
        mainSteps:
          - name: SampleStep
            action: aws:executeScript
            isEnd: true
            inputs:
              Runtime: python3.11
              Handler: main
              Script: src/sample1.py

아래는 변환된 template.yml 의 내용입니다. Script 속성에 지정된 파일의 내용이 Script 속성 값으로 대체된 것을 확인할 수 있습니다.

AWSTemplateFormatVersion: 2010-09-09
Description: template.yml
Resources:
  TestRunbook:
    Type: AWS::SSM::Document
    Properties:
      Name: Sample-TestRunbook
      DocumentType: Automation
      DocumentFormat: YAML
      UpdateMethod: NewVersion
      Content:
        schemaVersion: '0.3'
        mainSteps:
        - name: SampleStep
          action: aws:executeScript
          isEnd: true
          inputs:
            Runtime: python3.11
            Handler: main
            Script: |
              def main(event, context):
                  print("[sample1] Hello, World!")

              if __name__ == "__main__":
                  main(None, None)