【Python】如何使用AWS:: SSM:: Document的Script屬性指定本地檔案

📅 發布日: 2025/04/13, 更新日: 2025/04/13 ⏱️ 預計閱讀時間約2分鐘 (778字)

aws cloudformation package命令無法將aws: executeScript步驟的Script屬性中指定的檔案上傳到S3 ，該步驟用於在AWS:: SSM:: Document中定義SSM自動化的Runbook。AWS功能更新暫時不支援此過程的原因可能是，為了指定放置在AWS:: SSM:: Document的S3儲存桶中的指令碼，不僅需要指定儲存該指令碼的S3儲存桶的名稱和檔名，還需要將校驗和指定為AWS:: SSM:: Document中的雜湊值。在本文中，我們在Python中實現了一個轉換過程，以便可以透過AWS:: SSM:: Document的Script屬性中的PATH指定本地檔案並部署。該方法在這裡描述。

筆記
編碼標準和先決條件
如何將 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)