使用 Runbook - AWS Systems Manager

使用 Runbook

注意

Automation 文件現在稱為 Runbook。

Automation Runbook 會定義自動化執行時 Systems Manager 在受管執行個體和其他 AWS 資源上執行的動作。自動化是 AWS Systems Manager 的功能。Runbook 包含循序執行的一或多個步驟。每個步驟都是圍繞單一動作而建立的。來自一個步驟的輸出可以做為後續步驟中的輸入。

執行這些動作及其步驟的程序稱為自動化

Runbook 支援的動作類型可讓您將 AWS 環境中的各種操作自動化。例如,使用 executeScript 動作類型,您可以直接在 Runbook 中嵌入 Python 或 PowerShell 指令碼。(建立自訂 Runbook 時,您可以內嵌新增指令碼,或從 S3 儲存貯體或本機電腦連接指令碼。) 您可以使用 createStackdeleteStack 動作類型來將您的 AWS CloudFormation 資源的管理自動化。此外,使用 executeAwsApi 動作類型,某個步驟可以在任何 AWS 服務中執行任何 API 操作,包括建立或刪除 AWS 資源、開始其他程序、觸發通知等。

如需自動化所支援的全部 20 個動作類型清單,請參閱 Systems Manager Automation 動作參考

AWS Systems Manager Automation 提供包含預先定義步驟的數個 Runbook,供您用來執行常見任務,像是重新啟動一或多個 Amazon Elastic Compute Cloud (Amazon EC2) 執行個體或建立 Amazon Machine Image (AMI)。您也可以建立自己的 Runbook,並將文件與其他 AWS 帳戶 共用,或將其公開給所有自動化使用者。

Runbook 是使用 JavaScript 物件標記法 (JSON) 或 YAML 編寫。使用 Systems Manager Automation 主控台中的 Document Builder (文件建置器),不過,您可以建立 Runbook,而無需以原生 JSON 或 YAML 撰寫。

重要

如果您執行可使用 AWS Identity and Access Management (IAM) 服務角色叫用其他服務的自動化工作流程,請注意您必須為該服務角色設定可叫用這些服務的許可。此要求適用於所有 AWS Automation Runbook (AWS-* Runbook),例如 AWS-ConfigureS3BucketLoggingAWS-CreateDynamoDBBackupAWS-RestartEC2Instance Runbook 等。此要求也適用於您所建立會透過呼叫其他服務的動作來叫用其他 AWS 服務的任何自訂自動化 Runbooks。例如,如果您使用 aws:executeAwsApiaws:createStackaws:copyImage 動作,為服務角色設定可叫用這些服務的許可。您可新增 IAM 內嵌政策到角色,以啟用其他 AWS 服務的許可。如需詳細資訊,請參閱 (選用) 新增 Automation 內嵌政策以叫用其他 AWS 服務

如需您可以在 Runbook 中指定的動作的相關資訊,請參閱 Systems Manager Automation 動作參考

如需執行指令碼之 AWS 受管 Runbook 的相關資訊,請參閱 執行指令碼的 AWS 受管 Runbook

如需使用 AWS Toolkit for Visual Studio Code 建立 Runbook 的相關資訊,請參閱《AWS Toolkit for Visual Studio Code 使用者指南》中的使用 Systems Manager Automation 文件

若要取得使用文件建置器來建立自訂 Runbook 的相關資訊,請參閱 使用文件建置器建立 Runbook

如需建立可執行指令碼的自訂 Runbook 的相關資訊,請參閱下列主題: