使用文件建置器建立 Runbook - AWS Systems Manager

使用文件建置器建立 Runbook

如果 AWS Systems Manager 公有 Runbook 不支援您想要在 AWS 資源上執行的所有動作,您可以建立自己的 Runbook。若要建立自訂 Runbook,您可以使用適當的自動化動作來手動建立本機 JavaScript 物件標記法 (JSON) 或 YAML 格式檔案。或者,您可以使用 Systems Manager 主控台中的文件建置器來建置自訂 Runbook。

使用文件建置器,您可以將自動化動作新增至自訂 Runbook,並提供必要的參數,而不需使用 JSON 或 YAML 語法。新增步驟並建立 Runbook 之後,系統會將您新增的動作轉換成 YAML 格式,以便 Systems Manager 可以用來執行自動化。

Runbook 支援使用 Markdown (一種標示語言),可讓您新增維基樣式的描述至 Runbook 內,以及在 Runbook 內新增個別步驟。如需使用 Markdown 的相關資訊,請參閱在 AWS 中使用 Markdown

提示

本主題提供將文件建置器與任何支援的動作類型搭配使用的一般資訊。如需建立可執行指令碼的 Runbook 的相關資訊,請參閱下列主題:

開始之前

使用文件建置器建立自訂 Runbook 之前,建議您先閱讀可在 Runbook 中使用的不同動作。如需詳細資訊,請參閱 Systems Manager Automation 動作參考

使用文件建置器建立自訂 Runbook

  1. 開啟位於 AWS Systems Managerhttps://console.aws.amazon.com/systems-manager/ 的 主控台。https://console.aws.amazon.com/systems-manager/

  2. 在導覽窗格中,選擇 Documents (文件)

    -或-

    如果 AWS Systems Manager 首頁先開啟,選擇選單圖示 ( ) 以開啟導覽窗格,然後在導覽窗格中,選擇 Documents (文件)。

  3. 選擇 Create automation (建立自動化)

  4. 對於 Name (名稱),輸入 Runbook 的描述性名稱。

  5. 對於 Document description (文件描述),提供 Runbook 的 Markdown 樣式描述。您可以提供使用 Runbook、編號步驟或任何其他類型的資訊的指示來描述 Runbook。如需格式化內容的相關資訊,請參閱預設文字。

    提示

    Hide preview (隱藏預覽)Show preview (顯示預覽) 之間切換,即可在撰寫時查看描述內容的外觀。

  6. (選用) 對於 Assume role (擔任角色),輸入要代表您執行動作的服務角色的名稱或 ARN。如果您未指定角色,自動化會使用執行自動化之使用者的存取許可。

    重要

    對於使用 aws:executeScript 動作的非 Amazon 擁有的 Runbook,必須指定角色。如需相關資訊,請參閱 使用 Runbook 的許可

  7. (選用) 對於 Outputs (輸出),輸入用於此 Runbook 自動化以提供其他處理程序使用的任何輸出。

    例如,如果您的 Runbook 建立了新的 AMI,您可以指定 ["CreateImage.ImageId"],然後使用此輸出在後續的自動化中建立新的執行個體。

  8. (選用) 展開 Input parameters (輸入參數) 區段,並執行下列動作。

    1. 對於 Parameter name (參數名稱),輸入您要建立的 Runbook 參數的描述性名稱。

    2. 對於 Type (類型),選擇參數的類型,例如 StringMapList

    3. 對於 Required (必要),執行下列其中一項作業:

      • 如果必須在執行時間提供此 Runbook 參數的值,請選擇 Yes (是)。

      • 如果不需要參數,請選擇 No (否),並 (選擇性地) 在 Default value (預設值) 中輸入預設參數值。

    4. 對於 Description (描述),輸入 Runbook 參數的描述。

    注意

    若要新增更多 Runbook 參數,請選擇 Add a parameter (新增參數)。若要移除 Runbook 參數,請選擇 X (移除) 按鈕。

  9. (選用) 展開 Target type (目標類型) 區段,並選擇目標類型,以定義自動化可執行所在的資源類型。例如,若要在 EC2 執行個體上使用 Runbook,請選擇 /AWS::EC2::Instance

    注意

    如果您指定 '/' 的值,則 Runbook 可以在所有類型的資源上執行。如需有效資源類型的清單,請參閱《AWS CloudFormation 使用者指南》 中的 AWS 資源類型參考

  10. (選用) 展開 Document tags (文件標籤) 區段,並輸入要套用至 Runbook 的一或多個標籤鍵值組。標籤可讓您更容易識別、組織和搜尋資源。如需詳細資訊,請參閱 標記 Systems Manager 文件

  11. Step 1 (步驟 1) 區段中,提供下列資訊。

    • 對於 Step name (步驟名稱),輸入自動化第一個步驟的描述性名稱。

    • 對於 Action type (動作類型),選取要用於此步驟的動作類型。

      如需可用動作類型的清單和資訊,請參閱Systems Manager Automation 動作參考

    • 對於 Description (描述),輸入自動化步驟的描述。您可以使用 Markdown 來將文字格式化。

    • 根據選取的 Action type (動作類型),在 Step inputs (步驟輸入) 區段中輸入動作類型的必要輸入。例如,如果您選取動作 aws:approve,則必須指定 Approvers 屬性的值。

      如需步驟輸入欄位的相關資訊,請參閱 Systems Manager Automation 動作參考 中您所選動作類型的項目。例如:aws:executeStateMachine - 執行 AWS Step Functions 狀態機器。

    • (選用) 對於 Additional inputs (其他輸入),提供 Runbook 所需的任何其他輸入值。可用的輸入類型取決於您為步驟選取的動作類型。(請注意,某些動作類型需要輸入值。)

      注意

      若要新增更多輸入,請選擇 Add optional input (新增選用輸入)。若要移除輸入,請選擇 X (移除) 按鈕。

    • (選用) 對於 Outputs (輸出),輸入用於此步驟以提供其他處理程序使用的任何輸出。

      注意

      Outputs (輸出) 不適用所有動作類型。

    • (選用) 展開 Common properties (一般屬性) 區段,並指定所有 Automation 動作通用的動作屬性。例如,對於 Timeout seconds (逾時秒),您可以以秒為單位提供值,以指定步驟在停止之前可以執行的時間長度。

      如需詳細資訊,請參閱 依所有動作共用的屬性

    注意

    若要新增更多步驟,請選取 Add step (新增步驟),然後重複建立步驟的程序。若要移除步驟,請選擇 Remove step (移除步驟)。

  12. 選擇 Create automation (建立自動化) 以儲存 Runbook。