共用的輸入 aws:applications aws:cloudWatch aws:configureDocker aws:configurePackage aws:domainJoin aws:downloadContent aws:psModule aws:refreshAssociation aws:runDockerAction aws:runDocument aws:runPowerShellScript aws:runShellScript aws:softwareInventory aws:updateAgent aws:updateSsmAgent

Systems Manager 命令文件外掛程式參考

此參考說明您可在 AWS Systems Manager (SSM) 命令類型文件中指定的外掛程式。這些外掛程式無法在使用 Automation 動作時用於 SSM Automation Runbook。如需 AWS Systems Manager 自動化動作的相關資訊，請參閱Systems Manager Automation 動作參考。

Systems Manager 會讀取 SSM 文件的內容，以決定在受管執行個體上執行的動作。每個文件包含程式碼執行部分。根據您文件的結構描述版本，這個程式碼執行部分可以包含一或多個外掛程式或步驟。有關於此的說明主題，外掛程式和步驟稱為 外掛程式。本節包含關於每個 Systems Manager 外掛程式的資訊。如需有關文件，包含建立文件和結構描述版本之間差異的更多資訊，請參閱 AWS Systems Manager 文件。

注意

此處說明的一些外掛程式僅能夠在 Windows Server 執行個體或 Linux 執行個體上執行。每個外掛程式須注意平台相容性。

macOS 的 Amazon Elastic Compute Cloud (Amazon EC2) 執行個體支援下列文件外掛程式：

aws:refreshAssociation
aws:runShellScript
aws:runPowerShellScript
aws:softwareInventory
aws:updateSsmAgent

內容

共用的輸入
aws:applications
aws:cloudWatch
aws:configureDocker
aws:configurePackage
aws:domainJoin
aws:downloadContent
aws:psModule
aws:refreshAssociation
aws:runDockerAction
aws:runDocument
aws:runPowerShellScript
aws:runShellScript
aws:softwareInventory
aws:updateAgent
aws:updateSsmAgent

共用的輸入

透過 SSM Agent 3.0.502 版及更新版本，所有外掛程式都可使用以下輸入：

finallyStep

您想要文件執行的最後一個步驟。如果對步驟定義了此輸入，則它的優先順序高於在 onFailure 或 onSuccess 輸入中指定的 exit 值。若要讓具有此輸入的步驟預期執行，該步驟必須是在文件的 mainSteps 中定義的最後一步。

類型：布林值

有效值：true | false

必要：否

onFailure

如果您為具有 exit 值的外掛程式指定此輸入，且該步驟失敗，則步驟狀態會反映失敗，而且文件不會執行任何剩餘的步驟，除非已定義 finallyStep。如果您為具有 successAndExit 值的外掛程式指定此輸入，且該步驟失敗，則步驟狀態會顯示成功，而且文件不會執行任何剩餘的步驟，除非已定義 finallyStep。

類型：字串

有效值：exit | successAndExit

必要：否

onSuccess

如果您為外掛程式指定此輸入，且該步驟成功執行，則文件不會執行任何剩餘的步驟，除非已定義 finallyStep。

類型：字串

有效值：exit

必要：否

YAML


---
schemaVersion: '2.2'
description: Shared inputs example
parameters:
  customDocumentParameter:
    type: String
    description: Example parameter for a custom Command-type document.
mainSteps:
- action: aws:runDocument
  name: runCustomConfiguration
  inputs:
    documentType: SSMDocument
    documentPath: "yourCustomDocument"
    documentParameters: '"documentParameter":{{customDocumentParameter}}}'
    onSuccess: exit
- action: aws:runDocument
  name: ifConfigurationFailure
  inputs:
    documentType: SSMDocument
    documentPath: "yourCustomRepairDocument"
    onFailure: exit
- action: aws:runDocument
  name: finalConfiguration
  inputs:
    documentType: SSMDocument
    documentPath: "yourCustomFinalDocument"
    finallyStep: true

JSON


{
   "schemaVersion": "2.2",
   "description": "Shared inputs example",
   "parameters": {
      "customDocumentParameter": {
         "type": "String",
         "description": "Example parameter for a custom Command-type document."
      }
   },
   "mainSteps":[
      {
         "action": "aws:runDocument",
         "name": "runCustomConfiguration",
         "inputs": {
            "documentType": "SSMDocument",
            "documentPath": "yourCustomDocument",
            "documentParameters": "\"documentParameter\":{{customDocumentParameter}}}",
            "onSuccess": "exit"
         }
      },
      {
         "action": "aws:runDocument",
         "name": "ifConfigurationFailure",
         "inputs": {
            "documentType": "SSMDocument",
            "documentPath": "yourCustomRepairDocument",
            "onFailure": "exit"
         }
      },
      {
         "action": "aws:runDocument",
         "name":"finalConfiguration",
         "inputs": {
            "documentType": "SSMDocument",
            "documentPath": "yourCustomFinalDocument",
            "finallyStep": true
         }
      }
   ]
}

`aws:applications`

安裝、修復或解除安裝在 EC2 執行個體上的應用程式。這個外掛程式只能在 Windows Server 作業系統上執行。如需更多詳細資訊，請參閱 AWS Systems Manager 文件。

Syntax

結構描述 2.2

結構描述 1.2

Properties

action

採取動作

類型：列舉

有效值：Install |Repair |Uninstall

必要：是

parameters

安裝的參數。

類型：字串

必要：否

source

應用程式的 .msi 檔案URL。

類型：字串

必要：是

sourceHash

.msi 檔案的SHA256 雜湊。

類型：字串

必要：否

`aws:cloudWatch`

將資料從 Windows Server 匯出到 Amazon CloudWatch 或 Amazon CloudWatch Logs，並使用 CloudWatch 指標監控資料。這個外掛程式只能在 Windows Server 作業系統上執行。如需有關設定 CloudWatch 與 Amazon Elastic Compute Cloud (Amazon EC2) 整合的相關資訊，請參閱將日誌、事件和效能計數器傳送到 Amazon CloudWatch。如需有關文件的詳細資訊，請參閱 AWS Systems Manager 文件。

重要

此外掛程式已被取代。統一的 CloudWatch 代理程式已取代 SSM Agent 作為將日誌資料傳送至 Amazon CloudWatch Logs 的工具。建議只使用統一的 CloudWatch 代理程式來執行日誌收集流程。如需詳細資訊，請參閱下列主題：

將執行個體日誌傳送至 CloudWatch Logs (CloudWatch 代理程式)
將 Windows Server 執行個體日誌收集遷移到 CloudWatch 代理程式
《Amazon CloudWatch 使用者指南》中的使用 CloudWatch 代理程式從 Amazon Elastic Compute Cloud 執行個體和內部部署伺服器中收集指標

您可以匯出和監控以下資料類型：

ApplicationEventLog: 將應用程式事件日誌資料傳送至 CloudWatch Logs。
CustomLogs: 將任何文字類日誌檔案傳送至 Amazon CloudWatch Logs。CloudWatch 外掛程式為日誌檔案建立指紋。系統會將資料位移與每個指紋建立關聯。當檔案改變時，外掛程式上傳檔案並記錄位移然後建立與指紋的關聯。此方法用於避免使用者開啟外掛程式，將服務與包含大量檔案的目錄關聯，並且系統會上傳所有檔案。

警告
請注意，如果您的應用程式在輪詢時嘗試截斷或清理日誌的任何日誌，任何 LogDirectoryPath 指定的日誌將可能遺失項目。例如，如果您想要限制的日誌檔案大小，達到該限制時建立新的日誌檔，然後持續將資料寫入新的檔案。
ETW: 將 Event Tracing for Windows (ETW) 資料傳送到 CloudWatch Logs。
IIS –: 將 IIS 日誌資料傳送到 CloudWatch Logs。
PerformanceCounter: 將 Windows 效能計數器傳送到 CloudWatch。您可以選擇不同類別以作為指標上傳至 CloudWatch。對於每個您要上傳的效能計數器，建立一個 PerformanceCounter 部分具有唯一的 ID (例如，「PerformanceCounter2」、」 PerformanceCounter3」等) 和屬性設定。

注意
如果 AWS Systems Manager SSM Agent 或 CloudWatch 外掛程式停止，效能計數器資料不會記錄在 CloudWatch 中。此行為不同於自訂日誌或 Windows 事件日誌。自訂日誌和 Windows 事件日誌會保留效能計數器資料，並且在 SSM Agent 或 CloudWatch 外掛程式能夠使用之後，將這些資料上傳到 CloudWatch。
SecurityEventLog: 將安全性日誌資料傳送至 CloudWatch Logs。
SystemEventLog: 將系統事件日誌資料傳送至 CloudWatch Logs。

您可以定義以下資料的目的地：

CloudWatch: 傳送您的效能計數器指標資料的目的地。您可以用唯一的 ID 增加多個區段 (例如「CloudWatch2」和「CloudWatch3」)，並替不同的區域指定新的 ID 然後傳遞相同的資料到不同的地點。
CloudWatchLogs: 傳送您的效能計數器日誌資料的目的地。您可以用唯一的 ID 增加多個區段 (例如「CloudWatchLogs2」和「CloudWatchLogs3」)，並替不同的區域指定新的 ID 然後傳遞相同的資料到不同的地點。

Syntax


"runtimeConfig":{
        "aws:cloudWatch":{
            "settings":{
                "startType":"{{ status }}"
            },
            "properties":"{{ properties }}"
        }
    }

設定和屬性

AccessKey

您的存取金鑰 ID。此屬性是必要的，除非您使用 IAM 角色啟動執行個體。此屬性無法用於 SSM。

類型：字串

必要：否

CategoryName

效能監控從效能計數器類別而來。

類型：字串

必要：是

CounterName

效能監控的名稱從效能計數器類別而來。

類型：字串

必要：是

CultureName

要記錄時間戳記的所在地區。如果 CultureName 為空白，它會預設為 Windows Server 執行個體使用的相同地區設定。

類型：字串

有效的數值: 支援數值的清單，請參閱 Microsoft 網頁中的 National Language Support (NLS) (國家語言支援 (NLS) 參考)。不支援 div、div-MV、hu 和 hu-HU 值。

必要：否

DimensionName

Amazon CloudWatch 指標的維度。若您指定 DimensionName，您必須指定 DimensionValue。在列出指標時，這些參數會提供另一種視圖。您也可以針對多個指標使用同一種維度，如此就能檢視屬於特定維度的所有指標。

類型：字串

必要：否

DimensionValue

Amazon CloudWatch 指標的維度值。

類型：字串

必要：否

編碼

使用的檔案編碼 (例如，UTF-8)。使用編碼名稱，而非顯示名稱。

類型：字串

有效數值: 如需支援值的清單，請參閱 MSDN 上的編碼類別在 MSDN 程式庫。

必要：是

篩選條件

日誌名稱的字首。將此參數留白，以監控所有檔案。

類型：字串

有效數值: 如需支援值的清單，請參閱 MSDN 上的 FileSystemWatcherFilter 屬性主題。

必要：否

流程

要上傳的每個資料類型，以及資料目的地 (CloudWatch 或 CloudWatch Logs)。例如，若要將在 "Id": "PerformanceCounter" 下定義的效能計數器傳送至在 "Id": "CloudWatch" 下定義的 CloudWatch 目的地，請輸入 "PerformanceCounter,CloudWatch"。同樣，若要將自訂日誌、ETW 日誌和系統日誌傳送至在 "Id": "ETW" 下定義的 CloudWatch Logs 目的地，請輸入 "(ETW),CloudWatchLogs"。除此之外，您可以將相同的效能計數器或日誌檔案傳送到一個以上的目的地。例如，如果要將應用程式日誌傳送到您在 "Id": "CloudWatchLogs" 和 "Id": "CloudWatchLogs2" 區段中所定義的兩個不同目的地，輸入 "ApplicationEventLog,(CloudWatchLogs, CloudWatchLogs2)"。

類型：字串

有效值 (目的地)：CloudWatch | CloudWatchLogs | CloudWatchn | CloudWatchLogsn

必要：是

FullName

元件的完全名稱。

類型：字串

必要：是

Id

識別資料來源或目的地。這識別符在組態檔案中必須是唯一的。

類型：字串

必要：是

InstanceName

效能計數器執行個體的名稱。請勿使用星號 (*) 來表示所有的執行個體，因為每個效能計數器元件只支援一個指標。不過您可以使用 _Total。

類型：字串

必要：是

層級

要傳送至 Amazon CloudWatch 的訊息類型。

類型：字串

有效值：

1 – 只上傳錯誤訊息。
2 – 只上傳警告訊息。
4 – 只上傳資訊訊息。

您可以一起新增值，以包含多個類型訊息。例如，3 表示錯誤訊息 (1) 和警告訊息 (2)都包含。數值 7 表示包含錯誤訊息 (1)、警告訊息 (2) 和資訊訊息 (4)。

必要：是

注意

Windows Security Logs 應該設定層級為 7。

LineCount

標頭中的行數，以辨識日誌檔案。例如，IIS 日誌檔幾乎都具有相同的標頭。您可以輸入 3，這會讀取日誌檔標頭的前三行來進行辨識。在 IIS 日誌檔中，第三行是日期和時間戳記，這在不同的日誌檔中是不一樣的。

類型：整數

必要：否

LogDirectoryPath

對於 CustomLogs，此屬性是指 EC2 執行個體上存放日誌的路徑。對於 IIS 日誌，資料夾替個別的網站存放 IIS 日誌 (例如，C:\\inetpub\\logs\\LogFiles\\W3SVCn)。IIS 日誌只支援 W3C 日誌格式。不支援 IIS、NCSA 和自訂格式。

類型：字串

必要：是

LogGroup

您的日誌群組名稱。CloudWatch 主控台的 Log Groups (日誌群組) 畫面中會顯示此名稱。

類型：字串

必要：是

LogName

日誌檔案的名稱。

若要在導覽窗格的事件檢視器中查找日誌名稱，請選取 Applications and Services Logs (應用程式和服務日誌)。
在日誌清單中，在您要上傳的日誌上按一下滑鼠右鍵 (例如，Microsoft > Windows > 備份 > 操作)，然後選取 Create Custom View (建立自訂檢視)。
在 Create Custom View (建立自訂檢視) 對話方塊中，選取 XML 標籤。LogName 位於 < 選取途徑 => 標籤 (例如，Microsoft-Windows-Backup)。複製此文字到 LogName 參數。

類型：字串

有效值：Application |Security |System |Microsoft-Windows-WinINet/Analytic

必要：是

LogStream

日誌串流目的地的名稱若您使用 {instance_id}，日誌串流名稱是這個執行個體 ID 的預設值。

類型：字串

有效值：{instance_id} | {hostname} | {ip_address} <log_stream_name>

如果輸入的日誌串流名稱尚未存在，CloudWatch Logs 會自動為您建立。您可以使用文字字串或預先定義的變數 ({instance_id}, {hostname}, {ip_address}，或是組合全部三者來定義日誌串流名稱。

此參數中指定的日誌串流名稱會顯示在 CloudWatch 主控台的日誌群組 > <YourLogStream> 的串流畫面中。

必要：是

MetricName

您希望能包含效能資料的 CloudWatch 指標。

注意

請不要在名稱中使用特殊字元。如果您這麼做了、指標和相關警示可能不會運作。

類型：字串

必要：是

命名空間

將會在指標命名空間寫入效能計數器資料。

類型：字串

必要：是

PollInterval

上傳新的效能計數器和日誌資料時需要延遲多少秒。

類型：整數

有效值：將此屬性設為 5 個或多個秒。十五秒 (00:00:15) 是建議。

必要：是

區域

您要在其中傳送日誌資料的 AWS 區域。雖然您可以將效能計數器，傳送到與您傳送日誌資料所在位置不同的區域，還是建議您將此參數，設定為與執行個體執行位置相同的區域。

類型：字串

有效值：Systems Manager 和 CloudWatch Logs 支援的 AWS 區域的區域 ID，例如 us-east-2、eu-west-1 和 ap-southeast-1。如需每个服务支援的 AWS 區域清单，請參閱 Amazon Web Services 一般參考中的 Amazon CloudWatch Logs 服務端點和 Systems Manager 服務端點。

必要：是

SecretKey

您的私密存取金鑰。此屬性是必要的，除非您使用 IAM 角色啟動執行個體。

類型：字串

必要：否

startType

開啟或關閉執行個體上的 CloudWatch。

類型：字串

有效值：Enabled | Disabled

必要：是

TimestampFormat

要使用的時間戳記格式。如需支援值的清單，請參閱 MSDN 上的自訂日期和時間格式字串主題。

類型：字串

必要：是

TimeZoneKind

當您的日誌時間戳記中沒有時區資訊時，您需要提供時區資訊。如果此參數保留空白，且如果您的時間戳記不包含時區資訊，則 CloudWatch Logs 預設為本機時區。如果時間戳記已包含時區資訊，則會忽略此參數。

類型：字串

有效值：Local | UTC

必要：否

單位

適合指標的測量單位。

類型：字串

必要：是

`aws:configureDocker`

(結構描述 2.0 版本或更新版本) 設定執行個體來處理 Docker 和容器。Linux 和 Windows Server 作業系統上支援此外掛程式。如需更多詳細資訊，請參閱 AWS Systems Manager 文件。

Syntax

結構描述 2.2

Inputs

action

執行動作的類型。

類型：列舉

有效值：Install | Uninstall

必要：是

`aws:configurePackage`

(結構描述 2.0 版本或更新版本) 安裝或解除安裝 AWS Systems Manager Distributor 套件。您可以安裝最新版本、預設版本或您指定的套件版本。也支援 AWS 提供的套件。這個外掛程式可在 Windows Server 和 Linux 作業系統上執行，但 Linux 作業系統不支援所有的可用套件。

Windows Server 的可用 AWS 套件包括：AWSPVDriver、AWSNVMe、AwsEnaNetworkDriver、AwsVssComponents、AmazonCloudWatchAgent、CodeDeployAgent 和 AWSSupport-EC2Rescue.

Linux 作業系統的可用 AWS 套件包括：AmazonCloudWatchAgent、CodeDeployAgent 和 AWSSupport-EC2Rescue。

如需更多詳細資訊，請參閱 AWS Systems Manager 文件。

Syntax

結構描述 2.2

Inputs

name

要安裝或解除安裝的 AWS 套件名稱。可用套件包括：AWSPVDriver、AwsEnaNetworkDriver、AwsVssComponents 和 AmazonCloudWatchAgent。

類型：字串

必要：是

action

安裝或解除安裝套件

類型：列舉

有效值：Install | Uninstall

必要：是

安裝類型

要執行的安裝類型。如果您指定 Uninstall and reinstall，套件會完全解除安裝，然後重新安裝。在重新安裝完成之前，應用程式無法使用。如果您指定 In-place update，根據您在更新指令碼中提供的指示，只會將新的或變更的檔案新增至現有的安裝。應用程式在整個更新程序中仍然可用。AWS 已發佈的套件不支援 In-place update 選項。Uninstall and reinstall 為預設值。

類型：列舉

有效值：Uninstall and reinstall | In-place update

必要：否

additionalArguments

提供給安裝、解除安裝或更新指令碼的其他參數。每個參數必須加上字首 SSM_。通過使用慣例 {{ssm:parameter-name}}，您可以參考其他引數中的 Parameter Store 參數。若要在安裝、解除安裝或更新指令碼中使用其他參數，您必須使用適用於作業系統的語法，將參數作為環境變數參考。例如，在 PowerShell 中，將 SSM_arg 引數作為 $Env:SSM_arg 參考。您定義的引數數目沒有限制，但額外的引數輸入有 4096 個字元限制。此限制包括您定義的所有金鑰和值。

類型：StringMap

必要：否

version

特定版本的套件安裝或解除安裝。如果安裝，系統預設會安裝最新發佈的版本。如果移除，系統預設移除目前已安裝的版本。如果沒有找到任何安裝的版本，執行下載和解除安裝最新版本的動作。

類型：字串

必要：否

`aws:domainJoin`

將 EC2 執行個體加入網域。這個外掛程式可在 Linux 和 Windows Server 作業系統上執行。如需有關加入 EC2 執行個體的詳細資訊，請參閱 AWS Directory Service 管理指南中的將 EC2 執行個體加入您的 AWS 受管 Microsoft AD 目錄。如需有關文件的詳細資訊，請參閱 AWS Systems Manager 文件。

Syntax

結構描述 2.2

結構描述 1.2

Properties

directoryId

目錄的 ID。

類型：字串

必要：是

範例："directoryId": "d-1234567890"

directoryName

網域的名稱。

類型：字串

必要：是

範例："directoryName": "example.com"

directoryOU

組織單位 (OU)。

類型：字串

必要：否

範例："directoryOU": "OU=test,DC=example,DC=com"

dnsIpAddresses

DNS 的 IP 地址。

類型：StringList

必要：是

範例："dnsIpAddresses": ["198.51.100.1","198.51.100.2"]

Examples

如需相關範例，請參閱適用於 Windows 執行個體的 Amazon EC2 使用者指南中的將 Windows Server 執行個體加入 AWS Directory Service 網域。

`aws:downloadContent`

(結構描述 2.0 版本或更新版本) 從遠端位置下載 SSM 文件和指令碼。Linux 和 Windows Server 作業系統上支援此外掛程式。

Syntax

結構描述 2.2

Inputs

sourceType

下載來源。Systems Manager 支援下列來源類型，用於下載指令碼和 SSM 文件：GitHub、Git、HTTP、S3 和 SSMDocument。

類型：字串

必要：是

sourceInfo

從所需的來源中擷取所需的資訊內容。

類型：StringMap

必要：是

對於來源類型 GitHub,，請指定以下資訊：

擁有者：儲存庫擁有者。
儲存庫: 儲存庫的名稱。
路徑：您想要下載的檔案或目錄路徑。
getOptions：可從主要分支以外的分支或從儲存庫中的特定遞交中擷取內容的額外選項。如果您使用主要分支中的最新遞交，則可省略 getOptions。如果您的儲存庫是在 2020 年 10 月 1 日之後建立的，則預設分支可能被命名為 main 而不是 master。在此情況下，您需要指定 getOptions 參數的值。

此參數使用以下的格式：
- 分支：branch_name
  
  預設值為 master。
  
  只有當 SSM 文件存放於 master 以外的分支時，才需要 branch 參數。
- commitID：commitID
  
  預設值為 head。
  
  若要在最新遞交以外之其他遞交中使用您 SSM 文件的版本，請指定完整的遞交 ID。例如：
```
"getOptions": "commitID:bbc1ddb94...b76d3bEXAMPLE",
```
tokenInfo：您存放 GitHub 存取字符資訊所在的 Systems Manager 參數 (SecureString 參數)，格式為 {{ssm-secure:secure-string-token-name}}。

注意
此 tokenInfo 欄位是唯一支援 SecureString 參數的 SSM 文件外掛程式欄位。其他欄位不支援 SecureString 參數，其他 SSM 文件外掛程式也不支援。


{
    "owner":"TestUser",
    "repository":"GitHubTest",
    "path":"scripts/python/test-script",
    "getOptions":"branch:master",
    "tokenInfo":"{{ssm-secure:secure-string-token}}"
}

對於來源類型 Git，您必須指定以下資訊：

repository

您想要下載的檔案或目錄的 URL。

類型：字串

此外，您還可以指定下列選用參數：

getOptions

可從主要分支以外的分支或從儲存庫中的特定遞交中擷取內容的額外選項。如果您使用主要分支中的最新遞交，則可省略 getOptions。

類型：字串

此參數使用以下的格式：
- 分支：branch_name
  
  預設值為 master。
  
  "branch"只有當 SSM 文件存放於以外的分支時，才需要 master。
- commitID：commitID
  
  預設值為 head。
  
  若要在最新遞交以外之其他遞交中使用您 SSM 文件的版本，請指定完整的遞交 ID。例如：
```
"getOptions": "commitID:bbc1ddb94...b76d3bEXAMPLE",
```
privateSSHKey

連線至您指定的 repository 時，要使用的 SSH 金鑰。您可以使用下列格式來參考 SSH 金鑰值的 SecureString 參數：{{ssm-secure:your-secure-string-parameter}}。

類型：字串
skipHostKeyChecking

連線至您指定的 repository 時，確定 StrictHostKeyChecking 選項的值。預設值為 false。

類型：布林值
username

使用 HTTP 連線至您指定的 repository 時，要使用的使用者名稱。您可以使用下列格式來參考使用者名稱值的 SecureString 參數：{{ssm-secure:your-secure-string-parameter}}。

類型：字串
密碼：

使用 HTTP 連線至您指定的 repository 時，要使用的密碼。您可以使用下列格式來參考密碼值的 SecureString 參數：{{ssm-secure:your-secure-string-parameter}}。

類型：字串

對於來源類型 HTTP，您必須指定以下資訊：

url

您想要下載的檔案或目錄的 URL。

類型：字串

此外，您還可以指定下列選用參數：

allowInsecureDownload

判斷是否可透過未使用 Secure Socket Layer (SSL) 或 Transport Layer Security (TLS) 進行加密的連線來執行下載。預設值為 false。不建議在未加密的情況下執行下載。如果您選擇這樣做，您應承擔所有相關風險。安全是 AWS 與您共同肩負的責任。這被描述為共同的責任模式。如需進一步了解，請參閱共同的責任模型。

類型：布林值
authMethod

當連線至您指定的 url 時，判斷是否要使用使用者名稱和密碼進行身分驗證。如果您指定 Basic 或 Digest，則必須提供 username 和 password 參數的值。若要使用 Digest 方法，必須在您的執行個體上安裝 SSM Agent 3.0.1181.0 版或更新版本。Digest 方法支援 MD5 和 SHA256 加密。

類型：字串

有效值：None |Basic |Digest
username

使用 Basic 身分驗證連線至您指定的 url 時，要使用的使用者名稱。您可以使用下列格式來參考使用者名稱值的 SecureString 參數：{{ssm-secure:your-secure-string-parameter}}。

類型：字串
密碼：

使用 Basic 身分驗證連線至您指定的 url 時，要使用的密碼。您可以使用下列格式來參考密碼值的 SecureString 參數：{{ssm-secure:your-secure-string-parameter}}。

類型：字串

對於來源類型 S3，請指定以下資訊：

路徑：您想要從 Amazon S3 中下載的檔案或目錄的 URL。


{
    "path": "https://s3.amazonaws.com/doc-example-bucket/powershell/helloPowershell.ps1" 
}

對於來源類型 SSMDocument，請指定下列其中一項：

名稱：名稱和文件的版本，格式如下：name:version。版本是非必須的。
```
{
    "name": "Example-RunPowerShellScript:3" 
}
```
名稱：文件的 ARN，格式如下：arn:aws:ssm:region:account_id:document/document_name
```
{
   "name":"arn:aws:ssm:us-east-2:3344556677:document/MySharedDoc"
}
```

destinationPath

將您想要下載的檔案選用在的執行個體上的本機路徑。如果您不指定路徑的相對路徑，內容會下載到您的命令 ID 相對應的路徑。

類型：字串

必要：否

`aws:psModule`

在 Amazon EC2 執行個體上安裝 PowerShell 模組。這個外掛程式只能在 Windows Server 作業系統上執行。如需更多詳細資訊，請參閱 AWS Systems Manager 文件。

Syntax

結構描述 2.2

結構描述 1.2

Properties

runCommand

在模組安裝完畢後，PowerShell 的命令來執行。

類型：StringList

必要：否

source

在的執行個體上應用程式 .zip 檔案的本機路徑或 URL。

類型：字串

必要：是

sourceHash

.zip 檔案的SHA256 雜湊。

類型：字串

必要：否

timeoutSeconds

在命令完成到被認定為失敗之間的秒數。

類型：字串

必要：否

workingDirectory

在您的執行個體上的工作目錄路徑。

類型：字串

必要：否

`aws:refreshAssociation`

(結構描述 2.0 版本或更新版本) 更新 (強制套用) 有需要的關聯。這個動作會根據選中的關聯或者全部與目標有聯結的關聯裡的定義來改變系統的狀態。這個外掛程式可在 Linux 和 Microsoft Windows Server 作業系統上執行。如需更多詳細資訊，請參閱 AWS Systems Manager 文件。

Syntax

結構描述 2.2

Inputs

associationIds

列出的關聯 ID。如果空，所有綁定到指定的目標的關聯都會被套用。

類型：StringList

必要：否

`aws:runDockerAction`

(結構描述 2.0 版本或更新版本) 在容器上執行 Docker 動作。這個外掛程式可在 Linux 和 Microsoft Windows Server 作業系統上執行。如需更多詳細資訊，請參閱 AWS Systems Manager 文件。

Syntax

結構描述 2.2

Inputs

action

執行動作的類型。

類型：字串

必要：是

容器

Docker 容器的 ID。

類型：字串

必要：否

image

Docker 影像名稱

類型：字串

必要：否

命令提示字元

容器指令

類型：字串

必要：否

memory

容器記憶體限制。

類型：字串

必要：否

cpuShares

CPU 容器共享 (相對重量)。

類型：字串

必要：否

磁碟區

容器磁碟容量。

類型：StringList

必要：否

env

容器的環境變數。

類型：字串

必要：否

user

容器的使用者名稱。

類型：字串

必要：否

發佈

容器發佈的連接埠。

類型：字串

必要：否

`aws:runDocument`

(結構描述 2.0 版本或更新版本) 執行存放在 Systems Manager 或在本機共用的 SSM 文件。您可以搭配使用此外掛程式與 aws:downloadContent外掛程式，將 SSM 文件從遠端位置下載到本機共用，然後執行它。Linux 和 Windows Server 作業系統上支援此外掛程式。

Syntax

結構描述 2.2

Inputs

documentType

執行的文件類型。您可以執行本機文件 (LocalPath) 或存放在 Systems Manager (SSMDocument) 的文件。

類型：字串

必要：是

documentPath

文件的路徑。如果 documentType 是 LocalPath，請指定在本機共享的文件路徑。如果 documentType 是 SSMDocument，請指定文件的名稱。

類型：字串

必要：否

documentParameters

文件的參數。

類型：StringMap

必要：否

`aws:runPowerShellScript`

執行 PowerShell 指令碼或指定路徑來執行指令碼。這個外掛程式可在 Microsoft Windows Server 和 Linux 作業系統上執行。如需更多詳細資訊，請參閱 AWS Systems Manager 文件。

Syntax

結構描述 2.2

結構描述 1.2

Properties

runCommand

指定命令或指定在執行個體上現有的指令碼的路徑來執行。

類型：StringList

必要：是

timeoutSeconds

在命令完成到被認定為失敗之間的秒數。如果達到逾時，Systems Manager 停止命令執行。

類型：字串

必要：否

workingDirectory

在您的執行個體上的工作目錄路徑。

類型：字串

必要：否

`aws:runShellScript`

執行 Linux shell 指令碼或指定路徑來執行指令碼。這個外掛程式只可在 Linux 作業系統上執行。如需更多詳細資訊，請參閱 AWS Systems Manager 文件。

Syntax

結構描述 2.2

結構描述 1.2

Properties

runCommand

指定命令或指定在執行個體上現有的指令碼的路徑來執行。

類型：StringList

必要：是

timeoutSeconds

在命令完成到被認定為失敗之間的秒數。如果達到逾時，Systems Manager 停止命令執行。

類型：字串

必要：否

workingDirectory

在您的執行個體上的工作目錄路徑。

類型：字串

必要：否

`aws:softwareInventory`

(結構描述 2.0 版本或更新版本) 在受管執行個體上收集與應用程式、檔案和組態相關的中繼資料。這個外掛程式可在 Linux 和 Microsoft Windows Server 作業系統上執行。設定庫存集合時，首先要建立 AWS Systems Manager State Manager 關聯。Systems Manager 會在執行關聯時收集庫存資料。如果沒有先建立關聯，則當您試圖叫用 aws:softwareInventory 外掛程式時，系統會傳回以下錯誤：

The aws:softwareInventory plugin can only be invoked via ssm-associate.

執行個體一次只能設定一個清查關聯。若您為執行個體設定兩個以上的關聯，清查關聯便不會執行，並且也不會收集任何清查資料。如需收集庫存的相關資訊，請參閱 AWS Systems Manager 清查。

Syntax

結構描述 2.2

Inputs

應用程式

(選用) 收集已安裝應用程式的中繼資料。

類型：字串

必要：否

awsComponents

(選用) 收集 AWS 元件 (如 amazon-ssm-agent) 的中繼資料。

類型：字串

必要：否

files

(選用，需要 SSM Agent 2.2.64.0 版或更新版本) 收集檔案的中繼資料，包括檔案名稱、檔案的建立時間、上次修改和存取檔案的時間以及檔案大小等。如需收集檔案庫存的相關資訊，請參閱使用檔案與 Windows 登錄檔清查。

類型：字串

必要：否

networkConfig

(選用) 收集網路組態的中繼資料。

類型：字串

必要：否

windowsUpdates

(選用) 收集所有 Windows 更新的中繼資料。

類型：字串

必要：否

InstanceDetailedInformation

(選用) 收集的執行個體資訊比預設庫存外掛程式 (aws:instanceInformation) 提供的更多，包括 CPU 模型、速度和核心數量等。

類型：字串

必要：否

services

(選用，僅 Windows 作業系統需要 SSM Agent 2.2.64.0 版或更新版本) 收集服務組態的中繼資料。

類型：字串

必要：否

windowsRegistry

(選用，僅 Windows 作業系統需要 SSM Agent 2.2.64.0 版或更新版本) 收集 Windows 登錄機碼和值。而且，您還能選擇機碼路徑，並以遞迴方式收集所有機碼和值。此外，您也可以收集指定路徑的特定登錄機碼及其值。庫存將收集機碼路徑、名稱、類型與值。如需收集 Windows 登錄檔庫存的詳細資訊，請參閱使用檔案與 Windows 登錄檔清查。

類型：字串

必要：否

windowsRoles

(選用，僅 Windows 作業系統需要 SSM Agent 2.2.64.0 版或更新版本) 收集適用於 Microsoft Windows 角色組態的中繼資料。

類型：字串

必要：否

customInventory

(選用) 收集自訂庫存資料。如需自訂庫存的詳細資訊，請參閱使用自訂清查。

類型：字串

必要：否

`aws:updateAgent`

更新EC2Config服務到最新版本或指定 EC2Config 服務的舊版本。這個外掛程式只能在 Microsoft Windows Server 作業系統上執行。有關 EC2Config 服務的詳細資訊，請參閱使用 EC2Config 服務來設定 Windows 執行個體。如需有關文件的詳細資訊，請參閱 AWS Systems Manager 文件。

Syntax

結構描述 2.2

結構描述 1.2

Properties

agentName

EC2Config。這是執行 EC2Config 服務的代理名稱。

類型：字串

必要：是

allowDowngrade

允許 EC2Config 服務降級到較舊的版本。如果設定為非，該服務只可以升級到較新版本 (預設)。如果設定為是，指定之前的舊版本。

類型：布林值

必要：否

source

Systems Manager 複製 EC2Config 版本進行安裝的位置。您無法變更此位置。

類型：字串

必要：是

targetVersion

安裝指定版本的 EC2Config 服務。如果未指定，服務會更新到最新版本。

類型：字串

必要：否

`aws:updateSsmAgent`

將 SSM Agent 更新到最新版本或指定舊版本。這個外掛程式可在 Linux 和 Windows Server 作業系統上執行。如需更多詳細資訊，請參閱使用 SSM Agent。如需有關文件的詳細資訊，請參閱 AWS Systems Manager 文件。

Syntax

結構描述 2.2

結構描述 1.2

Properties

agentName

amazon-ssm-agent。這是在執行個體上處理請求和執行命令的 Systems Manager 代理程式名稱。

類型：字串

必要：是

allowDowngrade

允許 SSM Agent 降級到較早的版本。如果設定為非，代理程式只可以升級到較新版本 (預設)。如果設定為是，指定之前的舊版本。

類型：布林值

必要：是

source

Systems Manager 複製 SSM Agent 版本進行安裝的位置。您無法變更此位置。

類型：字串

必要：是

targetVersion

指定安裝 SSM Agent 的版本。如果未指定，代理程式會更新到最新版本。

類型：字串

必要：否

您的瀏覽器已停用或無法使用 Javascript。

您必須啟用 Javascript，才能使用 AWS 文件。請參閱您的瀏覽器說明頁以取得說明。

文件慣用形式

SSM 文件語法

檢視 SSM 命令文件內容