Referenz für Befehlsdokument-Plugins - AWS Systems Manager
Gemeinsame Eingabenaws:applicationsaws:cloudWatchaws:configureDockeraws:configurePackageaws:domainJoinaws:downloadContentaws:psModuleaws:refreshAssociationaws:runDockerActionaws:runDocumentaws:runPowerShellScriptaws:runShellScriptaws:softwareInventoryaws:updateAgentaws:updateSsmAgent

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Referenz für Befehlsdokument-Plugins

Diese Referenz beschreibt die Plugins, die Sie in einem Dokument vom Typ AWS Systems Manager (SSM) Command angeben können. Diese Plugins können nicht in SSM-Automation-Runbooks verwendet werden, die Automation-Aktionen verwenden. Informationen zu AWS Systems Manager Automatisierungsaktionen finden Sie unterSystems Manager Automation Aktionen-Referenz.

Systems Manager bestimmt die Aktionen, die auf einer verwalteten Instance ausgeführt werden sollen, durch Lesen der Inhalte eines SSM-Dokuments. Jedes Dokument enthält einen Abschnitt zur Ausführung von Code. Abhängig von der Schemaversion des Dokuments umfasst dieser Abschnitt zu Codeausführung ein oder mehrere Plugins oder Schritte. Im Rahmen dieses Hilfethemas werden die Plugins und Schritte als Plugins bezeichnet. Dieser Abschnitt enthält Informationen zu allen Systems Manager-Plugins. Weitere Informationen zu Dokumenten, einschließlich Informationen zum Erstellen von Dokumenten und zu den Unterschiede zwischen Schemaversionen finden Sie unter AWS Systems Manager-Documents.

Anmerkung

Manche der hier beschriebenen Plugins funktionieren nur auf Windows Server-Instances oder Linux-Instances. Für alle Plugins werden Plattformabhängigkeiten angegeben.

Die folgenden Dokument-Plugins werden auf Amazon Elastic Compute Cloud (Amazon EC2) -Instances unterstützt fürmacOS:

  • aws:refreshAssociation

  • aws:runShellScript

  • aws:runPowerShellScript

  • aws:softwareInventory

  • aws:updateSsmAgent

Gemeinsame Eingaben

Mit SSM Agent Version 3.0.502 und höher, können alle Plugins die folgenden Eingaben verwenden:

finallyStep

Der letzte Schritt, in dem das Dokument ausgeführt werden soll. Wenn diese Eingabe für einen Schritt definiert ist, hat sie Vorrang vor einem exit-Wert, der onFailure- oder onSuccess-Eingängen definiert ist. Damit ein Schritt mit dieser Eingabe erwartungsgemäß ausgeführt wird, muss der Schritt der letzte sein, der in den mainSteps Ihres Dokuments ausgeführt wird.

Typ: Boolesch

Zulässige Werte: true | false

Erforderlich: Nein

onFailure

Wenn Sie diese Eingabe für ein Plugin mit dem Wert exit angeben und der Schritt fehlschlägt, spiegelt der Schrittstatus den Fehler wider und das Dokument führt keine weiteren Schritte aus, es sei denn, es wurde ein finallyStep definiert. Wenn Sie diese Eingabe für ein Plugin mit dem Wert successAndExit angeben und der Schritt fehlschlägt, zeigt der Schrittstatus Erfolg an und das Dokument führt keine weiteren Schritte aus, es sei denn, es wurde ein finallyStep definiert.

Typ: Zeichenfolge

Zulässige Werte: exit | successAndExit

Erforderlich: Nein

onSuccess

Wenn Sie diese Eingabe für ein Plugin angeben und der Schritt erfolgreich ausgeführt wird, führt das Dokument keine weiteren Schritte durch, es sei denn, es wurde ein finallyStepdefiniert.

Typ: Zeichenfolge

Zulässige Werte: exit

Erforderlich: Nein

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

Installieren, reparieren oder deinstallieren Sie Anwendungen auf einer EC2 Instance. Dieses Plugin läuft nur unter Windows Server-Betriebssystemen.

Syntax

Schema 2.2

YAML
---
schemaVersion: '2.2'
description: aws:applications plugin
parameters:
  source:
    description: "(Required) Source of msi."
    type: String
mainSteps:
- action: aws:applications
  name: example
  inputs:
    action: Install
    source: "{{ source }}"
JSON
{
  "schemaVersion":"2.2",
  "description":"aws:applications",
  "parameters":{
    "source":{
    "description":"(Required) Source of msi.",
    "type":"String"
    }
  },
  "mainSteps":[
    {
      "action":"aws:applications",
      "name":"example",
      "inputs":{
        "action":"Install",
        "source":"{{ source }}"
      }
    }
  ]
}

Schema 1.2

YAML
---
runtimeConfig:
  aws:applications:
    properties:
    - id: 0.aws:applications
      action: "{{ action }}"
      parameters: "{{ parameters }}"
      source: "{{ source }}"
      sourceHash: "{{ sourceHash }}"
JSON
{
   "runtimeConfig":{
      "aws:applications":{
         "properties":[
            {
               "id":"0.aws:applications",
               "action":"{{ action }}",
               "parameters":"{{ parameters }}",
               "source":"{{ source }}",
               "sourceHash":"{{ sourceHash }}"
            }
         ]
      }
   }
}

Eigenschaften

action

Die zu ergreifende Maßnahme.

Type: Zähler

Zulässige Werte: Install | Repair | Uninstall

Erforderlich: Ja

Parameter

Die Parameter für das Installationsprogramm.

Typ: Zeichenfolge

Erforderlich: Nein

Quelle

Die URL der .msi-Datei der Anwendung.

Typ: Zeichenfolge

Erforderlich: Ja

sourceHash

Der SHA256 Hash der .msi Datei.

Typ: Zeichenfolge

Erforderlich: Nein

aws:cloudWatch

Exportieren Sie Daten aus Windows Server Amazon CloudWatch oder Amazon CloudWatch Logs und überwachen Sie die Daten anhand von CloudWatch Metriken. Dieses Plugin läuft nur unter Windows Server-Betriebssystemen. Weitere Informationen zur Konfiguration der CloudWatch Integration mit Amazon Elastic Compute Cloud (Amazon EC2) finden Sie unter Erfassung von Metriken, Protokollen und Traces mit dem CloudWatch Agenten im CloudWatch Amazon-Benutzerhandbuch.

Wichtig

Der Unified CloudWatch Agent wurde SSM Agent als Tool zum Senden von Protokolldaten an Amazon CloudWatch Logs ersetzt. Das SSM Agent-aws:cloudWatch-Plugin wird nicht unterstützt. Wir empfehlen, nur den Unified CloudWatch Agent für Ihre Protokollerfassungsprozesse zu verwenden. Weitere Informationen finden Sie unter den folgenden Themen:

Sie können die folgenden Datentypen exportieren und überwachen:

ApplicationEventLog

Sendet Daten aus dem Anwendungsereignisprotokoll an CloudWatch Logs.

CustomLogs

Sendet jede textbasierte Protokolldatei an Amazon CloudWatch Logs. Das CloudWatch Plugin erstellt einen Fingerabdruck für Protokolldateien. Anschließend verknüpft das System einen Datenversatz mit jedem Fingerabdruck. Das Plugin lädt Dateien hoch, wenn Änderungen vorliegen, erfasst den Versatz und verknüpft ihn mit einem Fingerabdruck. Diese Methode wird verwendet, um zu verhindern, dass ein Benutzer das Plugin aktiviert, den Service mit einem Verzeichnis verknüpft, in dem sich eine große Anzahl von Dateien befindet, und das System alle Dateien hochlädt.

Warnung

Hinweis: Falls Ihre Anwendung während der Abfrage Protokolle kürzt oder zu säubern versucht, besteht die Möglichkeit, dass alle Protokolle, die für LogDirectoryPath angegeben wurden, Einträge verlieren. Wenn Sie beispielsweise die Größe der Protokolldatei einschränken möchten, erstellen Sie eine neue Protokolldatei, wenn diese Beschränkung erreicht ist, und lassen Sie neue Daten dann in die neue Datei schreiben.

ETW

Sendet ETW-Daten (Event Tracing for Windows) an CloudWatch Logs.

IIS

Sendet IIS-Protokolldaten an CloudWatch Logs.

PerformanceCounter

Sendet Windows-Leistungsindikatoren an CloudWatch. Sie können verschiedene Kategorien auswählen, in die Daten hochgeladen CloudWatch werden sollen. Erstellen Sie für jeden Leistungsindikator, den Sie hochladen möchten, einen PerformanceCounterAbschnitt mit einer eindeutigen ID (z. B. "PerformanceCounter2"," PerformanceCounter 3" usw.) und konfigurieren Sie dessen Eigenschaften.

Anmerkung

Wenn das AWS Systems Manager SSM Agent oder das CloudWatch Plugin gestoppt ist, werden die Leistungsindikatordaten nicht protokolliert CloudWatch. Diese Verhaltensweise unterscheidet sich von der von benutzerdefinierten oder von Windows-Event-Protokollen.. In benutzerdefinierten Protokollen und Windows-Ereignisprotokollen werden die SSM Agent Leistungsindikatordaten gespeichert und CloudWatch nach der Verfügbarkeit des CloudWatch Plug-ins hochgeladen.

SecurityEventLog

Sendet Daten aus dem Sicherheitsereignisprotokoll an CloudWatch Logs.

SystemEventLog

Sendet Daten aus dem Systemereignisprotokoll an CloudWatch Logs.

Sie können die folgenden Ziele für die Daten definieren:

CloudWatch

Das Ziel, an das die Leistungsindikatormetrikdaten gesendet werden. Sie können weitere eindeutige Abschnitte hinzufügen IDs (z. B. "CloudWatch2", CloudWatch 3" usw.) und für jede neue ID eine andere Region angeben, um dieselben Daten an verschiedene Speicherorte zu senden.

CloudWatchLogs

Das Ziel, an das die Protokolldaten gesendet werden. Sie können weitere Abschnitte mit eindeutigen IDs Merkmalen hinzufügen (z. B. "CloudWatchLogs2", CloudWatchLogs 3" usw.) und für jede neue ID eine andere Region angeben, um dieselben Daten an verschiedene Standorte zu senden.

Syntax

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

Einstellungen und Eigenschaften

AccessKey

Ihre -Zugriffsschlüssel-ID Diese Eigenschaft ist erforderlich, wenn Sie die Instance mithilfe einer IAM-Rolle gestartet haben. Diese Eigenschaft kann nicht mit SSM verwendet werden.

Typ: Zeichenfolge

Erforderlich: Nein

CategoryName

Die Leistungsindikatorkategorie von Performance Monitor.

Typ: Zeichenfolge

Erforderlich: Ja

CounterName

Der Name des Leistungsindikators von Performance Monitor.

Typ: Zeichenfolge

Erforderlich: Ja

CultureName

Das Gebietsschema, unter dem der Zeitstempel protokolliert wird. Wenn dieses Feld leer CultureNameist, wird standardmäßig dasselbe Gebietsschema verwendet, das von Ihrer Windows Server Instanz verwendet wird.

Typ: Zeichenfolge

Gültige Werte: Eine Liste der unterstützten Werte finden Sie unter National Language Support (NLS) auf der Microsoft-Website. Die Werte div, div-MV, hu und hu-HU werden nicht unterstützt.

Erforderlich: Nein

DimensionName

Eine Dimension für Ihre CloudWatch Amazon-Metrik. Wenn Sie DimensionName angeben, müssen Sie auch DimensionValue angeben. Diese Parameter bieten eine andere Ansicht bei der Auflistung von Metriken. Sie können eine Dimension auch für mehrere Metriken verwenden, sodass Sie alle Metriken anzeigen können, die zu einer bestimmten Dimension gehören.

Typ: Zeichenfolge

Erforderlich: Nein

DimensionValue

Ein Dimensionswert für Ihre CloudWatch Amazon-Metrik.

Typ: Zeichenfolge

Erforderlich: Nein

Codierung

Die zu verwendende Dateikodierung (z. B: UTF-8). Verwenden Sie den Kodierungsnamen, nicht den Anzeigenamen.

Typ: Zeichenfolge

Gültige Werte: Eine Liste der unterstützten Werte finden Sie unter Encoding Class in der Microsoft Learn Bibliothek.

Erforderlich: Ja

Filter

Das Präfix des Protokollnamens. Lassen Sie diesen Parameter leer, um alle Dateien zu überwachen.

Typ: Zeichenfolge

Gültige Werte: Eine Liste der unterstützten Werte finden Sie unter „FileSystemWatcherFilter Eigenschaft“ in der MSDN-Bibliothek.

Erforderlich: Nein

Flows

Jeder Datentyp, der hochgeladen werden soll, zusammen mit dem Ziel für die Daten (CloudWatch oder CloudWatch Protokolle). Um beispielsweise einen unter definierten Leistungsindikator an das unter definierte CloudWatch Ziel "Id": "PerformanceCounter" zu senden"Id": "CloudWatch", geben Sie "PerformanceCounter,CloudWatch" ein. Geben Sie auf ähnliche Weise „(ETW)," ein, um das benutzerdefinierte Protokoll"Id": "ETW", das ETW-Protokoll und das Systemprotokoll an das unter definierte CloudWatch Protokollziel zu senden. CloudWatchLogs Außerdem können Sie dieselbe Leistungsindikator- oder Protokolldatei an mehrere Ziele senden. Um beispielsweise das Anwendungsprotokoll an zwei verschiedene Ziele zu senden, die Sie unter "Id": "CloudWatchLogs" und definiert haben"Id": "CloudWatchLogs2", geben Sie ", (ApplicationEventLogCloudWatchLogs, CloudWatchLogs 2)“ ein.

Typ: Zeichenfolge

Gültige Werte (Quelle): ApplicationEventLog | CustomLogs | ETW | PerformanceCounter | SystemEventLog | SecurityEventLog

Gültige Werte (Ziel): CloudWatch | CloudWatchLogs | CloudWatch n | CloudWatchLogs n

Erforderlich: Ja

FullName

Der vollständige Name der Komponente.

Typ: Zeichenfolge

Erforderlich: Ja

Id

Identifiziert die Datenquelle bzw. das Ziel. Die ID muss innerhalb der Konfigurationsdatei eindeutig sein.

Typ: Zeichenfolge

Erforderlich: Ja

InstanceName

Der Name der Leistungsindikator-Instance. Verwenden Sie kein Sternchen (*) für alle Instances, da jede Leistungszählerkomponente nur eine Metrik unterstützt. Sie können jedoch _Total verwenden.

Typ: Zeichenfolge

Erforderlich: Ja

Levels

Die Arten von Nachrichten, die an Amazon gesendet werden sollen CloudWatch.

Typ: Zeichenfolge

Zulässige Werte:

  • 1 – Nur Fehlermeldungen werden hochgeladen.

  • 2 – Nur Warnmeldungen werden hochgeladen.

  • 4 – Nur Informationsmeldungen werden hochgeladen.

Sie können Werte kombinieren, um mehr als einen Meldungstyp einzuschließen. Beispiel: 3 bedeutet, dass Fehlermeldungen (1) und Warnmeldungen (2) enthalten sind. Wenn Sie den Wert 7 eingeben, werden Fehlermeldungen (1), Warnmeldungen (2) und Informationsmeldungen (4) einbezogen.

Erforderlich: Ja

Anmerkung

Windows-Sicherheitsprotokolle müssen für „Levels“ den Wert „7“ festlegen.

LineCount

Die Anzahl der Zeilen im Header zur Identifikation der Protokolldatei. Beispielsweise haben IIS-Protokolldateien praktisch identische Header. Sie können 3 eingeben; dann würden die ersten drei Zeilen des Headers der Protokolldatei gelesen, um diese zu identifizieren. In IIS-Protokolldateien ist die dritte Zeile Datum und Zeitstempel, die sich zwischen Protokolldateien unterscheiden.

Typ: Ganzzahl

Erforderlich: Nein

LogDirectoryPath

Für den Pfad CustomLogs, in dem Protokolle auf Ihrer EC2 Instance gespeichert werden. Bei IIS-Protokollen der Ordner, in dem IIS-Protokolle für eine einzelne Site gespeichert werden (z. B. C:\\ inetpub\\ logs\\\LogFiles\ n W3SVC). Hinsichtlich IIS-Protokolle wird nur das Protokollformat W3C unterstützt. IIS, NCSA und benutzerdefinierte Formate werden nicht unterstützt.

Typ: Zeichenfolge

Erforderlich: Ja

LogGroup

Der Name für Ihre Protokollgruppe. Dieser Name wird auf dem Bildschirm Log Groups (Protokollgruppen) in der CloudWatch-Konsole angezeigt.

Typ: Zeichenfolge

Erforderlich: Ja

LogName

Der Name der Protokolldateien.

  1. Zum Suchen des Protokollnamens klicken Sie in der Ereignisanzeige im Navigationsbereich auf Applications and Services Logs.

  2. Klicken Sie in der Liste der Protokolle mit der rechten Maustaste auf das Protokoll, das Sie hochladen möchten (z. B. Microsoft > Windows > Backup > Operational), und klicken Sie dann auf Create Custom View.

  3. Klicken Sie im Dialogfeld Create Custom View auf die Registerkarte XML. Das LogNamebefindet sich im <Select Path=> -Tag (zum Beispiel). Microsoft-Windows-Backup Kopieren Sie diesen Text in den LogNameParameter.

Typ: Zeichenfolge

Zulässige Werte: Application | Security | System | Microsoft-Windows-WinINet/Analytic

Erforderlich: Ja

LogStream

Der Zielprotokollstream. Wenn Sie {instance_id}, verwenden, also den Standard, wird die Instance-ID dieser Instance als Name des Protokollstreams verwendet.

Typ: Zeichenfolge

Gültige Werte: {instance_id} | {hostname} | {ip_address} <log_stream_name>

Wenn Sie einen Log-Stream-Namen eingeben, der noch nicht existiert, erstellt CloudWatch Logs ihn automatisch für Sie. Sie können den Protokollstream mit einer Literalzeichenfolge, einer vordefinierten Variablen ({instance_id}, {hostname}, {ip_address}) oder einer Kombination aus allen drei Variablen definieren.

Der in diesem Parameter angegebene Protokollstreamname wird auf dem <YourLogStream> Bildschirm Protokollgruppen > Streams für in der CloudWatch Konsole angezeigt.

Erforderlich: Ja

MetricName

Die CloudWatch Metrik, unter der die Leistungsdaten enthalten sein sollen.

Anmerkung

Verwenden Sie keine Sonderzeichen in dem Namen. Andernfalls funktionieren die Metrik und die zugehörigen Alarme möglicherweise nicht.

Typ: Zeichenfolge

Erforderlich: Ja

NameSpace

Der Metrik-Namespace, in dem die Leistungsindikatordaten geschrieben werden sollen.

Typ: Zeichenfolge

Erforderlich: Ja

PollInterval

Die Anzahl der Sekunden, die vergehen muss, bevor neue Leistungsindikator- und Protokolldaten hochgeladen werden.

Typ: Ganzzahl

Gültige Werte: Legen Sie für diesen Wert 5 oder mehr Sekunden fest. Fünfzehn Sekunden (00:00:15) sind empfohlen.

Erforderlich: Ja

Region

Der AWS-Region Ort, an den Sie Protokolldaten senden möchten. Obwohl Sie Leistungszähler an eine andere Region als die, an die Sie Ihre Protokolldaten senden, senden können, empfehlen wir, diesen Parameter auf dieselbe Region zu setzen, in der Ihre Instance ausgeführt wird.

Typ: Zeichenfolge

Gültige Werte: Regionen IDs , die sowohl von Systems Manager als auch von CloudWatch Logs AWS-Regionen unterstützt werdenus-east-2, wieeu-west-1, undap-southeast-1. Eine Liste der von den einzelnen Services AWS-Regionen unterstützten Services finden Sie unter Amazon CloudWatch Logs Service Endpoints und Systems Manager Service Endpoints in der. Allgemeine Amazon Web Services-Referenz

Erforderlich: Ja

SecretKey

Ihr geheimer -Zugriffsschlüssel Diese Eigenschaft ist erforderlich, wenn Sie die Instance mithilfe einer IAM-Rolle gestartet haben.

Typ: Zeichenfolge

Erforderlich: Nein

startType

Schalten Sie die Instance ein oder aus CloudWatch .

Typ: Zeichenfolge

Zulässige Werte: Enabled | Disabled

Erforderlich: Ja

TimestampFormat

Das Zeitstempelformat, das Sie verwenden möchten. Eine Liste der unterstützten Werte finden Sie unter Custom Date and Time Format Strings in der MSDN-Bibliothek.

Typ: Zeichenfolge

Erforderlich: Ja

TimeZoneKind

Stellt Zeitzoneninformationen bereit, wenn der Zeitstempel Ihres Protokolls keine Zeitzoneninformationen enthält. Wenn dieser Parameter leer gelassen wird und Ihr Zeitstempel keine Zeitzoneninformationen enthält, verwendet CloudWatch Logs standardmäßig die lokale Zeitzone. Dieser Parameter wird ignoriert, wenn der Zeitstempel bereits Zeitzoneninformationen enthält.

Typ: Zeichenfolge

Zulässige Werte: Local | UTC

Erforderlich: Nein

Einheit

Die korrekte Maßeinheit für die Metrik.

Typ: Zeichenfolge

Gültige Werte: Sekunden | Mikrosekunden | Millisekunden | Byte | Kilobyte | Megabyte | Gigabyte | Terabyte | Bits | Kilobits | Megabit | Gigabit | Terabit | Prozent | Anzahl | | Keine Bytes/Second | Kilobytes/Second | Megabytes/Second | Gigabytes/Second | Terabytes/Second | Bits/Second | Kilobits/Second | Megabits/Second | Gigabits/Second | Terabits/Second | Count/Second

Erforderlich: Ja

aws:configureDocker

(Schemaversion 2.0 oder höher) Konfigurieren Sie eine Instance für die Arbeit mit Container und Docker. Dieses Plugin wird unter den meisten Linux-Varianten und Windows Server-Betriebssystemen unterstützt.

Syntax

Schema 2.2

YAML
---
schemaVersion: '2.2'
description: aws:configureDocker
parameters:
  action:
    description: "(Required) The type of action to perform."
    type: String
    default: Install
    allowedValues:
    - Install
    - Uninstall
mainSteps:
- action: aws:configureDocker
  name: configureDocker
  inputs:
    action: "{{ action }}"
JSON
{
  "schemaVersion": "2.2",
  "description": "aws:configureDocker plugin",
  "parameters": {
    "action": {
      "description": "(Required) The type of action to perform.",
      "type": "String",
      "default": "Install",
      "allowedValues": [
        "Install",
        "Uninstall"
      ]
    }
  },
  "mainSteps": [
    {
      "action": "aws:configureDocker",
      "name": "configureDocker",
      "inputs": {
        "action": "{{ action }}"
      }
    }
  ]
}

Eingaben

action

Der Typ der Aktion, die durchgeführt werden soll.

Type: Zähler

Zulässige Werte: Install | Uninstall

Erforderlich: Ja

aws:configurePackage

(Schemaversion 2.0 AWS Systems Manager Distributor oder höher) Installieren oder deinstallieren Sie ein Paket. Sie können die neueste Version, die Standardversion oder eine Version des angegebenen Pakets installieren. Pakete, die von bereitgestellt AWS werden, werden ebenfalls unterstützt. Dieses Plugin läuft unter Windows Server- und Linux-Betriebssystemen, wobei jedoch in Linux-Betriebssystemen nicht alle verfügbaren Pakete unterstützt werden.

Zu den verfügbaren AWS Paketen für Windows Server gehören die folgenden: AWSPVDriver AWSNVMeAwsEnaNetworkDriver,,AwsVssComponents,AmazonCloudWatchAgent,CodeDeployAgent, und AWSSupport-EC2Rescue.

Zu den verfügbaren AWS Paketen für Linux-Betriebssysteme gehören die folgenden: AmazonCloudWatchAgentCodeDeployAgent, undAWSSupport-EC2Rescue.

Syntax

Schema 2.2

YAML
---
schemaVersion: '2.2'
description: aws:configurePackage
parameters:
  name:
    description: "(Required) The name of the AWS package to install or uninstall."
    type: String
  action:
    description: "(Required) The type of action to perform."
    type: String
    default: Install
    allowedValues:
    - Install
    - Uninstall
  ssmParameter:
    description: "(Required) Argument stored in Parameter Store."
    type: String
    default: "{{ ssm:parameter_store_arg }}"
mainSteps:
- action: aws:configurePackage
  name: configurePackage
  inputs:
    name: "{{ name }}"
    action: "{{ action }}"
    additionalArguments: 
      "{\"SSM_parameter_store_arg\": \"{{ ssmParameter }}\", \"SSM_custom_arg\": \"myValue\"}"
JSON
{
   "schemaVersion": "2.2",
   "description": "aws:configurePackage",
   "parameters": {
      "name": {
         "description": "(Required) The name of the AWS package to install or uninstall.",
         "type": "String"
      },
      "action": {
         "description": "(Required) The type of action to perform.",
         "type": "String",
         "default": "Install",
         "allowedValues": [
            "Install",
            "Uninstall"
         ]
      },
      "ssmParameter": {
         "description": "(Required) Argument stored in Parameter Store.",
         "type": "String",
         "default": "{{ ssm:parameter_store_arg }}"
      }
   },
   "mainSteps": [
      {
         "action": "aws:configurePackage",
         "name": "configurePackage",
         "inputs": {
            "name": "{{ name }}",
            "action": "{{ action }}",
            "additionalArguments": "{\"SSM_parameter_store_arg\": \"{{ ssmParameter }}\", \"SSM_custom_arg\": \"myValue\"}"
         }
      }
   ]
}

Eingaben

Name

Der Name des zu installierenden oder zu deinstallierenden AWS Pakets. In verfügbaren Paketen ist Folgendes enthalten: AWSPVDriver, AwsEnaNetworkDriver, AwsVssComponents und AmazonCloudWatchAgent.

Typ: Zeichenfolge

Erforderlich: Ja

action

Installieren oder deinstallieren Sie ein Paket.

Type: Zähler

Zulässige Werte: Install | Uninstall

Erforderlich: Ja

installationType

Der Typ der auszuführenden Installation. Wenn Sie Uninstall and reinstall angeben, wird das Paket vollständig deinstalliert und anschließend neu installiert. Die Anwendung ist bis zum Abschluss der Neuinstallation nicht verfügbar. Wenn Sie In-place update angeben, werden der vorhandenen Installation nur neue oder geänderte Dateien hinzugefügt, entsprechend den Anweisungen, die Sie in einem Update-Skript bereitstellen. Die Anwendung ist während des Aktualisierungsprozesses weiterhin verfügbar. Die In-place update Option wird für Pakete mit dem Namen AWS-published nicht unterstützt. Uninstall and reinstallist der Standardwert.

Type: Zähler

Zulässige Werte: Uninstall and reinstall | In-place update

Erforderlich: Nein

additionalArguments

Eine JSON-Zeichenkette mit den zusätzlichen Parametern, die Sie Ihren Installations-, Deinstallations- oder Update-Skripten bereitstellen müssen. Jedem Parameter muss das Präfix SSM_ angefügt werden. Sie können in Ihren zusätzlichen Argumenten auf einen Parameter Store-Parameter verweisen, indem Sie die Konvention {{ssm:parameter-name}} verwenden. Um den zusätzlichen Parameter in Ihrem Installations-, Deinstallations- oder Updateskript zu verwenden, müssen Sie den Parameter mithilfe der für das Betriebssystem geeigneten Syntax als Umgebungsvariable referenzieren. In verweisen Sie PowerShell beispielsweise auf das SSM_arg Argument als$Env:SSM_arg. Es gibt keine Begrenzung für die Anzahl der von Ihnen definierten Argumente, aber die Eingabe von zusätzlichen Argumenten hat eine Begrenzung von 4096 Zeichen. Dieser Grenzwert umfasst alle von Ihnen definierten Schlüssel und Werte.

Typ: StringMap

Erforderlich: Nein

version

Installieren oder deinstallieren Sie eine bestimmte Version des Pakets. Wenn Sie ein Installation vornehmen, installiert das System standardmäßig die neueste veröffentlichte Version. Wenn Sie eine Deinstallation vornehmen, deinstalliert das System standardmäßig die derzeit installierte Version. Wenn keine installierte Version gefunden wird, wird die neueste veröffentlichte Version heruntergeladen und die Deinstallationsaktion ausgeführt.

Typ: Zeichenfolge

Erforderlich: Nein

aws:domainJoin

Verknüpfen Sie eine EC2 Instanz mit einer Domain. Dieses Plugin läuft unter Linux- und Windows Server-Betriebssystemen. Dieses Plugin ändert den Hostnamen für Linux-Instances in das Format EC2 AMAZ-. XXXXXXX Weitere Informationen zum Beitreten von EC2 Instanzen finden Sie unter Join an EC2 Instance to Your AWS Managed Microsoft AD Directory im AWS Directory Service Administratorhandbuch.

Syntax

Schema 2.2

YAML
---
schemaVersion: '2.2'
description: aws:domainJoin
parameters:
  directoryId:
    description: "(Required) The ID of the directory."
    type: String
  directoryName:
    description: "(Required) The name of the domain."
    type: String
  directoryOU:
    description: "(Optional) The organizational unit to assign the computer object to."
    type: String
  dnsIpAddresses:
    description: "(Required) The IP addresses of the DNS servers for your directory."
    type: StringList
  hostname:
    description: "(Optional) The hostname you want to assign to the node."
    type: String
mainSteps:
- action: aws:domainJoin
  name: domainJoin
  inputs:
    directoryId: "{{ directoryId }}"
    directoryName: "{{ directoryName }}"
    directoryOU: "{{ directoryOU }}"
    dnsIpAddresses: "{{ dnsIpAddresses }}"
    hostname: "{{ hostname }}"
JSON
{
  "schemaVersion": "2.2",
  "description": "aws:domainJoin",
  "parameters": {
    "directoryId": {
      "description": "(Required) The ID of the directory.",
      "type": "String"
    },
    "directoryName": {
      "description": "(Required) The name of the domain.",
      "type": "String"
    },
    "directoryOU": {
        "description": "(Optional) The organizational unit to assign the computer object to.",
        "type": "String"
      },
    "dnsIpAddresses": {
      "description": "(Required) The IP addresses of the DNS servers for your directory.",
      "type": "StringList"
    },
    "hostname": {
        "description": "(Optional) The hostname you want to assign to the node.",
        "type": "String"
      }
  },
  "mainSteps": [
    {
      "action": "aws:domainJoin",
      "name": "domainJoin",
      "inputs": {
        "directoryId": "{{ directoryId }}",
        "directoryName": "{{ directoryName }}",
        "directoryOU":"{{ directoryOU }}",
        "dnsIpAddresses":"{{ dnsIpAddresses }}",
        "hostname":"{{ hostname }}"
      }
    }
  ]
}

Schema 1.2

YAML
---
runtimeConfig:
  aws:domainJoin:
    properties:
      directoryId: "{{ directoryId }}"
      directoryName: "{{ directoryName }}"
      directoryOU: "{{ directoryOU }}"
      dnsIpAddresses: "{{ dnsIpAddresses }}"
JSON
{
   "runtimeConfig":{
      "aws:domainJoin":{
         "properties":{
            "directoryId":"{{ directoryId }}",
            "directoryName":"{{ directoryName }}",
            "directoryOU":"{{ directoryOU }}",
            "dnsIpAddresses":"{{ dnsIpAddresses }}"
         }
      }
   }
}

Eigenschaften

directoryId

Die ID des Verzeichnisses.

Typ: Zeichenfolge

Erforderlich: Ja

Beispiel: "directoryId": "d-1234567890"

directoryName

Der Name der Domain.

Typ: Zeichenfolge

Erforderlich: Ja

Beispiel: "directoryName": "example.com"

directoryOU

Die Organisationseinheit (OU).

Typ: Zeichenfolge

Erforderlich: Nein

Beispiel: "directoryOU": "OU=test,DC=example,DC=com"

dnsIpAddresses

Die IP-Adressen des DNS-Servers.

Typ: StringList

Erforderlich: Ja

Beispiel: "dnsIpAddresses„: [" 198.51.100.1", "198.51.100.2"]

hostname

Der Hostname, den Sie dem Knoten zuweisen möchten. Falls nicht angegeben, gibt es keine Namensänderung für Windows-Instanzen, während Linux-Instanzen das Standard-Benennungsmuster verwenden. Falls angegeben, verwenden Windows-Instanzen genau den angegebenen Wert, während er für Linux-Instanzen als Präfix dient (sofern er nicht auf „true“ gesetzt keepHostName ist).

Typ: Zeichenfolge

Erforderlich: Nein

keepHostName

Ermittelt, ob der Hostname für Linux-Instances geändert wird, wenn sie der Domain beitreten. Dies ist ein reiner Linux-Parameter. Standardmäßig (ohne Eingaben für hostnamehostnameNumAppendDigits, und mit keepHostName „false“) werden Linux-Hosts nach dem Muster EC2 AMAZ-XXXXXX umbenannt. Wenn es auf „true“ gesetzt ist, behält es den ursprünglichen Hostnamen bei und ignoriert Eingaben von und. hostname hostnameNumAppendDigits

Typ: Boolesch

Erforderlich: Nein

hostnameNumAppendZiffern

Definiert die Anzahl der zufälligen numerischen Ziffern, die nach dem Hostnamenwert angehängt werden sollen. Dies ist ein reiner Linux-Parameter und wird zusammen mit dem Parameter verwendet. hostname Er wird ignoriert, wenn er nicht angegeben hostname ist.

Typ: Zeichenfolge

Zulässige Werte: 1 bis 5

Erforderlich: Nein

Beispiele

Beispiele finden Sie unter Join an Amazon EC2 Instance to your AWS Managed Microsoft AD im AWS Directory Service Administratorhandbuch.

aws:downloadContent

(Schemaversion 2.0 oder höher) Laden Sie SSM-Dokumente und -Skripte von Remote-Standorten herunter. GitHub Enterprise-Repositorys werden nicht unterstützt. Dieses Plugin wird unter Linux- und Windows Server-Betriebssystemen unterstützt.

Syntax

Schema 2.2

YAML
---
schemaVersion: '2.2'
description: aws:downloadContent
parameters:
  sourceType:
    description: "(Required) The download source."
    type: String
  sourceInfo:
    description: "(Required) The information required to retrieve the content from
      the required source."
    type: StringMap
mainSteps:
- action: aws:downloadContent
  name: downloadContent
  inputs:
    sourceType: "{{ sourceType }}"
    sourceInfo: "{{ sourceInfo }}"
JSON
{
  "schemaVersion": "2.2",
  "description": "aws:downloadContent",
  "parameters": {
    "sourceType": {
    "description": "(Required) The download source.",
    "type": "String"
  },
  "sourceInfo": {
    "description": "(Required) The information required to retrieve the content from the required source.",
    "type": "StringMap"
    }
  },
  "mainSteps": [
    {
      "action": "aws:downloadContent",
      "name": "downloadContent",
      "inputs": {
        "sourceType":"{{ sourceType }}",
        "sourceInfo":"{{ sourceInfo }}"
      }
    }
  ]
}

Eingaben

sourceType

Die Downloadquelle. Systems Manager unterstützt derzeit die folgenden Quellarten für das Herunterladen von Skripts und SSM documents:-Dokumenten: GitHub, Git, HTTP, S3 und SSMDocument.

Typ: Zeichenfolge

Erforderlich: Ja

sourceInfo

Die erforderlichen Informationen zum Abrufen der Inhalte aus der erforderlichen Quelle.

Typ: StringMap

Erforderlich: Ja

Für sourceType GitHub, geben Sie Folgendes an:

  • owner: Die Eigentümer des Repositorys.

  • repository: Der Name des Repositorys.

  • path: Der Pfad zu der Datei oder dem Verzeichnis, die bzw. das Sie herunterladen möchten.

  • getOptions: Zusätzliche Optionen zum Abrufen von Inhalten aus einem anderen Branch als dem Master-Branch oder aus einem bestimmten Commit im Repository. getOptions kann weggelassen werden, wenn Sie den letzten Commit in der Master-Branch verwenden. Wenn Ihr Repository nach dem 1. Oktober 2020 erstellt wurde, wird der Standardzweig möglicherweise „main“ statt „master“ genannt. In diesem Fall müssen Sie Werte für den getOptions-Parameter angeben.

    Dieser Parameter verwendet das folgende Format:

    • branch:refs/heads/ branch_name

      Der Standardwert ist master.

      Verwenden Sie das folgende Format, um einen nicht standardmäßigen Zweig anzugeben:

      Branch:refs/heads/ branch_name

    • commitID: commitID

      Der Standardwert ist head.

      Um die Version Ihres SSM-Dokuments in einem anderen als dem letzten Commit zu verwenden, geben Sie die vollständige Commit-ID an. Zum Beispiel:

      "getOptions": "commitID:bbc1ddb94...b76d3bEXAMPLE",

  • tokenInfo: Der Systems Manager Manager-Parameter (ein SecureString Parameter), in dem Sie Ihre GitHub Zugriffstoken-Informationen speichern, im Format. {{ssm-secure:secure-string-token-name}}

    Anmerkung

    Dieses tokenInfo Feld ist das einzige SSM-Dokument-Plugin-Feld, das einen Parameter unterstützt. SecureString SecureString Parameter werden weder für andere Felder noch für andere SSM-Dokument-Plugins unterstützt.

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

Für sourceType Git müssen Sie Folgendes angeben:

  • Repository

    Die URL des Git-Repositorys zu der Datei oder dem Verzeichnis, die bzw. das Sie herunterladen möchten.

    Typ: Zeichenfolge

Sie können zusätzlich einen der folgenden optionalen Parameter angeben:

  • getOptions

    Zusätzliche Optionen zum Abrufen von Inhalten aus einem anderen Branch als dem Master-Branch oder aus einem bestimmten Commit im Repository. getOptions kann weggelassen werden, wenn Sie den letzten Commit in der Master-Branch verwenden.

    Typ: Zeichenfolge

    Dieser Parameter verwendet das folgende Format:

    • Branch:refs/heads/ branch_name

      Der Standardwert ist master.

      "branch" ist nur erforderlich, wenn Ihr SSM-Dokument in einer anderen Verzweigung als master gespeichert ist. Zum Beispiel:

      "getOptions": "branch:refs/heads/main"

    • commitID: commitID

      Der Standardwert ist head.

      Um die Version Ihres SSM-Dokuments in einem anderen als dem letzten Commit zu verwenden, geben Sie die vollständige Commit-ID an. Zum Beispiel:

      "getOptions": "commitID:bbc1ddb94...b76d3bEXAMPLE",

  • privat SSHKey

    Der SSH-Schlüssel, der beim Herstellen einer Verbindung zur repository verwendet werden soll. Sie können das folgende Format verwenden, um auf einen SecureString-Parameter für den Wert Ihres SSH-Schlüssels zu verweisen: {{ssm-secure:your-secure-string-parameter}}.

    Typ: Zeichenfolge

  • skipHostKeyÜberprüfend

    Bestimmt den Wert der StrictHostKeyChecking Option, wenn eine Verbindung zu dem von repository Ihnen angegebenen hergestellt wird. Der Standardwert ist false.

    Typ: Boolesch

  • username

    Der Benutzername, der bei der Verbindung mit der repository verwendet werden soll, die Sie mit HTTP angeben. Sie können das folgende Format verwenden, um auf einen SecureString-Parameter für den Wert Ihres Benutzernamens zu verweisen: {{ssm-secure:your-secure-string-parameter}}.

    Typ: Zeichenfolge

  • password

    Das Passwort, das bei der Verbindung mit der repository verwendet werden soll, die Sie mit HTTP angeben. Sie können das folgende Format verwenden, um auf einen SecureString-Parameter für den Wert Ihres Passworts zu verweisen: {{ssm-secure:your-secure-string-parameter}}.

    Typ: Zeichenfolge

Für sourceType HTTP müssen Sie Folgendes angeben:

  • URL

    Die URL zu der Datei oder dem Verzeichnis, die bzw. das Sie herunterladen möchten.

    Typ: Zeichenfolge

Sie können zusätzlich einen der folgenden optionalen Parameter angeben:

  • allowInsecureDownload

    Bestimmt, ob ein Download über eine Verbindung durchgeführt werden kann, die nicht mit Secure Socket Layer (SSL) oder Transport Layer Security (TLS) verschlüsselt ist. Der Standardwert ist false. Wir raten davon ab, Downloads ohne Verschlüsselung durchzuführen. Wenn Sie sich dafür entscheiden, übernehmen Sie alle damit verbundenen Risiken. Sicherheit ist eine gemeinsame Verantwortung zwischen Ihnen AWS und Ihnen. Dies wird als Modell der geteilten Verantwortung beschrieben. Weitere Informationen hierzu finden Sie in Modell der geteilten Verantwortung.

    Typ: Boolesch

  • authMethod

    Bestimmt, ob ein Benutzername und ein Passwort für die Authentifizierung verwendet werden, wenn eine Verbindung mit der url hergestellt wird, die Sie angeben. Wenn Sie Basic oder Digest angeben, müssen Sie Werte für die username- und password-Parameter bereitstellen. Um die Digest-Methode zu verwenden, muss SSM Agent-Version 3.0.1181.0 oder höher muss auf Ihrer Instance installiert sein. Die Digest Methode unterstützt MD5 SHA256 Verschlüsselung.

    Typ: Zeichenfolge

    Zulässige Werte: None | Basic | Digest

  • username

    Der Benutzername, der bei der Verbindung mit der url verwendet werden soll, die Sie mit Basic-Authentifizierung angeben. Sie können das folgende Format verwenden, um auf einen SecureString-Parameter für den Wert Ihres Benutzernamens zu verweisen: {{ssm-secure:your-secure-string-parameter}}.

    Typ: Zeichenfolge

  • password

    Das Passwort, das bei der Verbindung mit der url verwendet werden soll, die Sie mit Basic-Authentifizierung angeben. Sie können das folgende Format verwenden, um auf einen SecureString-Parameter für den Wert Ihres Passworts zu verweisen: {{ssm-secure:your-secure-string-parameter}}.

    Typ: Zeichenfolge

Für sourceType S3 geben Sie Folgendes an:

  • Die URL zu der Datei oder dem Verzeichnis, die bzw. das Sie von Amazon S3 herunterladen möchten.

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

Geben Sie für sourceType SSMDocument eine der folgenden Optionen an:

  • name: Der Name und die Version des Dokuments in folgendem Format: name:version. Version ist optional. 

    {
    "name": "Example-RunPowerShellScript:3" 
}

  • name: Der ARN für das Dokument im folgenden Format: arn:aws:ssm:region:account_id:document/document_name

    {
   "name":"arn:aws:ssm:us-east-2:3344556677:document/MySharedDoc"
}
destinationPath

Ein optionaler lokaler Pfad auf der Instance, in den die Datei heruntergeladen werden soll. Wenn Sie keinen Pfad angeben, wird der Inhalt in einen Pfad relativ zu Ihrer Befehls-ID heruntergeladen.

Typ: Zeichenfolge

Erforderlich: Nein

aws:psModule

Installieren Sie PowerShell Module auf einer EC2 Amazon-Instance. Dieses Plugin läuft nur unter Windows Server-Betriebssystemen.

Syntax

Schema 2.2

YAML
---
schemaVersion: '2.2'
description: aws:psModule
parameters:
  source:
    description: "(Required) The URL or local path on the instance to the application
      .zip file."
    type: String
mainSteps:
- action: aws:psModule
  name: psModule
  inputs:
    source: "{{ source }}"
JSON
{
  "schemaVersion": "2.2",
  "description": "aws:psModule",
  "parameters": {
    "source": {
      "description": "(Required) The URL or local path on the instance to the application .zip file.",
      "type": "String"
    }
  },
  "mainSteps": [
    {
      "action": "aws:psModule",
      "name": "psModule",
      "inputs": {
        "source": "{{ source }}"
      }
    }
  ]
}

Schema 1.2

YAML
---
runtimeConfig:
  aws:psModule:
    properties:
    - runCommand: "{{ commands }}"
      source: "{{ source }}"
      sourceHash: "{{ sourceHash }}"
      workingDirectory: "{{ workingDirectory }}"
      timeoutSeconds: "{{ executionTimeout }}"
JSON
{
   "runtimeConfig":{
      "aws:psModule":{
         "properties":[
            {
               "runCommand":"{{ commands }}",
               "source":"{{ source }}",
               "sourceHash":"{{ sourceHash }}",
               "workingDirectory":"{{ workingDirectory }}",
               "timeoutSeconds":"{{ executionTimeout }}"
            }
         ]
      }
   }
}

Eigenschaften

runCommand

Der PowerShell Befehl, der nach der Installation des Moduls ausgeführt werden soll.

Typ: StringList

Erforderlich: Nein

Quelle

Die URL bzw. der lokale Pfad auf der Instance zur .zip-Datei der Anwendung.

Typ: Zeichenfolge

Erforderlich: Ja

sourceHash

Der SHA256 Hash der .zip Datei.

Typ: Zeichenfolge

Erforderlich: Nein

timeoutSeconds

Die Zeit in Sekunden, die ein Befehl in Anspruch nehmen darf, bevor er als fehlgeschlagen betrachtet wird.

Typ: Zeichenfolge

Erforderlich: Nein

workingDirectory

Der Pfad zum Arbeitsverzeichnis auf der Instance.

Typ: Zeichenfolge

Erforderlich: Nein

aws:refreshAssociation

(Schemaversion 2.0 oder höher) Aktualisieren (Erzwingen) Sie bei Bedarf eine Zuweisung. Diese Aktion ändert den Systemstatus basierend auf was in der ausgewählten Verknüpfungen bzw. in allen zielgebundenen Verknüpfungen definiert ist. Dieses Plugin läuft unter Linux- und Microsoft Windows Server-Betriebssystemen.

Syntax

Schema 2.2

YAML
---
schemaVersion: '2.2'
description: aws:refreshAssociation
parameters:
  associationIds:
    description: "(Optional) List of association IDs. If empty, all associations bound
      to the specified target are applied."
    type: StringList
mainSteps:
- action: aws:refreshAssociation
  name: refreshAssociation
  inputs:
    associationIds:
    - "{{ associationIds }}"
JSON
{
  "schemaVersion": "2.2",
  "description": "aws:refreshAssociation",
  "parameters": {
    "associationIds": {
      "description": "(Optional) List of association IDs. If empty, all associations bound to the specified target are applied.",
      "type": "StringList"
    }
  },
  "mainSteps": [
    {
      "action": "aws:refreshAssociation",
      "name": "refreshAssociation",
      "inputs": {
        "associationIds": [
          "{{ associationIds }}"
        ]
      }
    }
  ]
}

Eingaben

associationIds

Liste der Assoziationen IDs. Wenn das Feld leer ist, werden alle Verknüpfungen mit dem angegebenen Ziel angewendet.

Typ: StringList

Erforderlich: Nein

aws:runDockerAction

(Schemaversion 2.0 oder höher) Führen Sie Docker-Aktionen auf Containern aus. Dieses Plugin läuft unter Linux- und Microsoft Windows Server-Betriebssystemen.

Syntax

Schema 2.2

YAML
---
mainSteps:
- action: aws:runDockerAction
  name: RunDockerAction
  inputs:
    action: "{{ action }}"
    container: "{{ container }}"
    image: "{{ image }}"
    memory: "{{ memory }}"
    cpuShares: "{{ cpuShares }}"
    volume: "{{ volume }}"
    cmd: "{{ cmd }}"
    env: "{{ env }}"
    user: "{{ user }}"
    publish: "{{ publish }}"
    workingDirectory: "{{ workingDirectory }}"
    timeoutSeconds: "{{ timeoutSeconds }}"
JSON
{
   "mainSteps":[
      {
         "action":"aws:runDockerAction",
         "name":"RunDockerAction",
         "inputs":{
            "action":"{{ action }}",
            "container":"{{ container }}",
            "image":"{{ image }}",
            "memory":"{{ memory }}",
            "cpuShares":"{{ cpuShares }}",
            "volume":"{{ volume }}",
            "cmd":"{{ cmd }}",
            "env":"{{ env }}",
            "user":"{{ user }}",
            "publish":"{{ publish }}",
            "workingDirectory": "{{ workingDirectory }}",
            "timeoutSeconds": "{{ timeoutSeconds }}"
         }
      }
   ]
}

Eingaben

action

Der Typ der Aktion, die durchgeführt werden soll.

Typ: Zeichenfolge

Erforderlich: Ja

Container

Die Container-ID des Dockers.

Typ: Zeichenfolge

Erforderlich: Nein

Abbild

Der Name des Docker-Image.

Typ: Zeichenfolge

Erforderlich: Nein

cmd

Der Container-Befehl.

Typ: Zeichenfolge

Erforderlich: Nein

memory

Die Grenze des Container-Speichers.

Typ: Zeichenfolge

Erforderlich: Nein

cpuShares

Die Container-CPU-Anteile (relative Gewichtung).

Typ: Zeichenfolge

Erforderlich: Nein

Volume

Die Container-Volume-Mounts.

Typ: StringList

Erforderlich: Nein

env

Die Container-Umgebungsvariablen.

Typ: Zeichenfolge

Erforderlich: Nein

user

Der Container-Benutzername.

Typ: Zeichenfolge

Erforderlich: Nein

publish

Die veröffentlichten Container-Ports.

Typ: Zeichenfolge

Erforderlich: Nein

workingDirectory

Der Pfad zum Arbeitsverzeichnis auf Ihrem verwalteten Knoten.

Typ: Zeichenfolge

Erforderlich: Nein

timeoutSeconds

Die Zeit in Sekunden, die ein Befehl in Anspruch nehmen darf, bevor er als fehlgeschlagen betrachtet wird.

Typ: Zeichenfolge

Erforderlich: Nein

aws:runDocument

(Schema-Version 2.0 oder höher) Führt SSM-Dokumente aus, die in Systems Manager oder einem lokal freigegebenen Verzeichnis gespeichert sind. Sie können dieses Plugin mit dem Plugin aws:downloadContent verwenden, um ein SSM-Dokument von einem Remote-Standort in ein lokal freigegebenes Verzeichnis herunterzuladen, und es dann ausführen. Dieses Plugin wird unter Linux- und Windows Server-Betriebssystemen unterstützt. Dieses Plugin unterstützt nicht das Ausführen des AWS-UpdateSSMAgent-Dokuments oder eines anderen Dokuments, das den aws:updateSsmAgent-Plugin verwendet.

Syntax

Schema 2.2

YAML
---
schemaVersion: '2.2'
description: aws:runDocument
parameters:
  documentType:
    description: "(Required) The document type to run."
    type: String
    allowedValues:
    - LocalPath
    - SSMDocument
mainSteps:
- action: aws:runDocument
  name: runDocument
  inputs:
    documentType: "{{ documentType }}"
JSON
{
  "schemaVersion": "2.2",
  "description": "aws:runDocument",
  "parameters": {
    "documentType": {
      "description": "(Required) The document type to run.",
      "type": "String",
      "allowedValues": [
        "LocalPath",
        "SSMDocument"
      ]
    }
  },
  "mainSteps": [
    {
      "action": "aws:runDocument",
      "name": "runDocument",
      "inputs": {
        "documentType": "{{ documentType }}"
      }
    }
  ]
}

Eingaben

documentType

Der auszuführende Dokumenttyp. Sie können lokale Dokumente (LocalPath) oder in Systems Manager gespeicherte Dokumente (SSMDocument) ausführen.

Typ: Zeichenfolge

Erforderlich: Ja

documentPath

Der Pfad zu dem Dokument. Wenn documentType LocalPath ist, geben Sie den Pfad des Dokuments im lokal freigegebenen Verzeichnis an. Wenn documentType SSMDocument ist, geben Sie den Namen des Dokuments an.

Typ: Zeichenfolge

Erforderlich: Nein

documentParameters

Parameter für das Dokument.

Typ: StringMap

Erforderlich: Nein

aws:runPowerShellScript

Führen Sie PowerShell Skripts aus oder geben Sie den Pfad zu einem auszuführenden Skript an. Dieses Plugin läuft unter Microsoft Windows Server- und Linux-Betriebssystemen.

Syntax

Schema 2.2

YAML
---
schemaVersion: '2.2'
description: aws:runPowerShellScript
parameters:
  commands:
    type: String
    description: "(Required) The commands to run or the path to an existing script
      on the instance."
    default: Write-Host "Hello World"
mainSteps:
- action: aws:runPowerShellScript
  name: runPowerShellScript
  inputs:
    timeoutSeconds: '60'
    runCommand:
    - "{{ commands }}"
JSON
{
  "schemaVersion": "2.2",
  "description": "aws:runPowerShellScript",
  "parameters": {
    "commands": {
      "type": "String",
      "description": "(Required) The commands to run or the path to an existing script on the instance.",
      "default": "Write-Host \"Hello World\""
    }
  },
  "mainSteps": [
    {
      "action": "aws:runPowerShellScript",
      "name": "runPowerShellScript",
      "inputs": {
        "timeoutSeconds": "60",
        "runCommand": [
          "{{ commands }}"
        ]
      }
    }
  ]
}

Schema 1.2

YAML
---
runtimeConfig:
  aws:runPowerShellScript:
    properties:
    - id: 0.aws:runPowerShellScript
      runCommand: "{{ commands }}"
      workingDirectory: "{{ workingDirectory }}"
      timeoutSeconds: "{{ executionTimeout }}"
JSON
{
   "runtimeConfig":{
      "aws:runPowerShellScript":{
         "properties":[
            {
               "id":"0.aws:runPowerShellScript",
               "runCommand":"{{ commands }}",
               "workingDirectory":"{{ workingDirectory }}",
               "timeoutSeconds":"{{ executionTimeout }}"
            }
         ]
      }
   }
}

Eigenschaften

runCommand

Geben Sie die auszuführenden Befehle oder den Pfad zu einem vorhandenen Skript auf der Instance an.

Typ: StringList

Erforderlich: Ja

timeoutSeconds

Die Zeit in Sekunden, die ein Befehl in Anspruch nehmen darf, bevor er als fehlgeschlagen betrachtet wird. Wenn der Wert für den Timeout erreicht ist, hält Systems Manager die Ausführung des Befehls an.

Typ: Zeichenfolge

Erforderlich: Nein

workingDirectory

Der Pfad zum Arbeitsverzeichnis auf der Instance.

Typ: Zeichenfolge

Erforderlich: Nein

aws:runShellScript

Führen Sie Linux-Shell-Skripts aus oder geben Sie den Pfad zu einem auszuführenden Skript an. Dieses Plugin läuft nur unter Linux-Betriebssystemen.

Syntax

Schema 2.2

YAML
---
schemaVersion: '2.2'
description: aws:runShellScript
parameters:
  commands:
    type: String
    description: "(Required) The commands to run or the path to an existing script
      on the instance."
    default: echo Hello World
mainSteps:
- action: aws:runShellScript
  name: runShellScript
  inputs:
    timeoutSeconds: '60'
    runCommand:
    - "{{ commands }}"
JSON
{
  "schemaVersion": "2.2",
  "description": "aws:runShellScript",
  "parameters": {
    "commands": {
      "type": "String",
      "description": "(Required) The commands to run or the path to an existing script on the instance.",
      "default": "echo Hello World"
    }
  },
  "mainSteps": [
    {
      "action": "aws:runShellScript",
      "name": "runShellScript",
      "inputs": {
        "timeoutSeconds": "60",
        "runCommand": [
          "{{ commands }}"
        ]
      }
    }
  ]
}

Schema 1.2

YAML
---
runtimeConfig:
  aws:runShellScript:
    properties:
    - runCommand: "{{ commands }}"
      workingDirectory: "{{ workingDirectory }}"
      timeoutSeconds: "{{ executionTimeout }}"
JSON
{
   "runtimeConfig":{
      "aws:runShellScript":{
         "properties":[
            {
               "runCommand":"{{ commands }}",
               "workingDirectory":"{{ workingDirectory }}",
               "timeoutSeconds":"{{ executionTimeout }}"
            }
         ]
      }
   }
}

Eigenschaften

runCommand

Geben Sie die auszuführenden Befehle oder den Pfad zu einem vorhandenen Skript auf der Instance an.

Typ: StringList

Erforderlich: Ja

timeoutSeconds

Die Zeit in Sekunden, die ein Befehl in Anspruch nehmen darf, bevor er als fehlgeschlagen betrachtet wird. Wenn der Wert für den Timeout erreicht ist, hält Systems Manager die Ausführung des Befehls an.

Typ: Zeichenfolge

Erforderlich: Nein

workingDirectory

Der Pfad zum Arbeitsverzeichnis auf der Instance.

Typ: Zeichenfolge

Erforderlich: Nein

aws:softwareInventory

(Schema-Version 2.0 oder höher) Erfassen von Metadaten zu Anwendungen, Dateien und Konfigurationen auf Ihren verwalteten Instances. Dieses Plugin läuft unter Linux- und Microsoft Windows Server-Betriebssystemen. Wenn Sie die Inventarerfassung konfigurieren, erstellen Sie zunächst eine AWS Systems Manager State Manager Zuordnung. Systems Manager erfasst die Bestandsdaten, wenn der Zuordnungsstatus ausgeführt wird. Wenn Sie den Zuordnungsstatus nicht zuerst erstellen und versuchen, das aws:softwareInventory-Plugin aufzurufen, gibt das System den folgenden Fehler aus:

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

Pro Instance kann nur jeweils ein Bestandszuordnungsstatus konfiguriert werden. Wenn Sie eine Instance mit zwei oder mehr Zuordnungen konfigurieren, wird der Bestandszuordnungsstatus nicht ausgeführt und es werden keine Bestandsdaten erfasst. Weitere Informationen über das Erfassen des Bestands finden Sie unter AWS Systems Manager-Bestand.

Syntax

Schema 2.2

YAML
---
mainSteps:
- action: aws:softwareInventory
  name: collectSoftwareInventoryItems
  inputs:
    applications: "{{ applications }}"
    awsComponents: "{{ awsComponents }}"
    networkConfig: "{{ networkConfig }}"
    files: "{{ files }}"
    services: "{{ services }}"
    windowsRoles: "{{ windowsRoles }}"
    windowsRegistry: "{{ windowsRegistry}}"
    windowsUpdates: "{{ windowsUpdates }}"
    instanceDetailedInformation: "{{ instanceDetailedInformation }}"
    customInventory: "{{ customInventory }}"
JSON
{
   "mainSteps":[
      {
         "action":"aws:softwareInventory",
         "name":"collectSoftwareInventoryItems",
         "inputs":{
            "applications":"{{ applications }}",
            "awsComponents":"{{ awsComponents }}",
            "networkConfig":"{{ networkConfig }}",
            "files":"{{ files }}",
            "services":"{{ services }}",
            "windowsRoles":"{{ windowsRoles }}",
            "windowsRegistry":"{{ windowsRegistry}}",
            "windowsUpdates":"{{ windowsUpdates }}",
            "instanceDetailedInformation":"{{ instanceDetailedInformation }}",
            "customInventory":"{{ customInventory }}"
         }
      }
   ]
}

Eingaben

applications

(Optional) Erfassen von Metadaten für installierte Anwendungen.

Typ: Zeichenfolge

Erforderlich: Nein

awsComponents

(Optional) Sammeln Sie Metadaten für AWS Komponenten wie amazon-ssm-agent.

Typ: Zeichenfolge

Erforderlich: Nein

files

(Optional, erfordert SSM Agent-Version 2.2.64.0 oder höher) Erfassen von Metadaten für Dateien, einschließlich Dateinamen, der Erstellungszeit der Dateien, der letzten Änderungs- und Zugriffszeit der Dateien oder Dateigrößen usw. Weitere Informationen zum Erfassen eines Dateibestands finden Sie unter Arbeiten mit Datei- und Windows-Registrierungsbestand.

Typ: Zeichenfolge

Erforderlich: Nein

networkConfig

(Optional) Erfassen von Metadaten für Netzwerkkonfigurationen.

Typ: Zeichenfolge

Erforderlich: Nein

Fakturierungsinformationen

(Optional) Sammeln Sie Metadaten für Plattformdetails, die mit dem Abrechnungscode von verknüpft sind. AMI

Typ: Zeichenfolge

Erforderlich: Nein

windowsUpdates

(Optional) Erfassen von Metadaten für alle Windows-Updates.

Typ: Zeichenfolge

Erforderlich: Nein

instanceDetailedInformation

(Optional) Erfassen weiterer Instance-Informationen neben den Informationen des Standardbestands-Plugins (aws:instanceInformation), einschließlich CPU-Modell, Geschwindigkeit und Anzahl der Kerne usw.

Typ: Zeichenfolge

Erforderlich: Nein

service

(Optional, nur Windows-BS, erfordert SSM Agent-Version 2.2.64.0 oder höher) Erfassen von Daten für Servicekonfigurationen.

Typ: Zeichenfolge

Erforderlich: Nein

windowsRegistry

(Optional, nur Windows-BS, erfordert SSM Agent-Version 2.2.64.0 oder höher) Erfassen von Windows Registry-Schlüsseln und -Werten. Sie können einen Schlüssel-Pfad auswählen und alle Schlüssel und Werte rekursiv erfassen. Sie können auch einen bestimmten Registrierungsschlüssel und seinen Wert für einen bestimmten Pfad erfassen. Inventory erfasst den Schlüsselpfad, den Namen, Typ und Wert. Weitere Informationen zur Erfassung von Windows Registry-Bestand finden Sie unter Arbeiten mit Datei- und Windows-Registrierungsbestand.

Typ: Zeichenfolge

Erforderlich: Nein

windowsRoles

(Optional, nur Windows-BS, erfordert SSM Agent-Version 2.2.64.0 oder höher) Erfassen von Metadaten für Microsoft Windows-Rollenkonfigurationen.

Typ: Zeichenfolge

Erforderlich: Nein

customInventory

(Optional) Erfassen von benutzerdefinierten Bestandsdaten. Weitere Informationen zum benutzerdefinierten Bestand finden Sie unter Arbeiten mit benutzerdefiniertem Bestand

Typ: Zeichenfolge

Erforderlich: Nein

customInventoryDirectory

(Optional) Erfassen Sie benutzerdefinierte Inventardaten aus dem angegebenen Verzeichnis. Weitere Informationen zum benutzerdefinierten Bestand finden Sie unter Arbeiten mit benutzerdefiniertem Bestand

Typ: Zeichenfolge

Erforderlich: Nein

aws:updateAgent

Aktualisieren Sie den EC2 Config-Dienst auf die neueste Version oder geben Sie eine ältere Version an. Dieses Plugin läuft nur unter Microsoft Windows Server-Betriebssystemen. Weitere Informationen zum EC2 Config-Service finden Sie unter Konfiguration einer Windows-Instance mithilfe des EC2 Config-Service (Legacy) im EC2 Amazon-Benutzerhandbuch.

Syntax

Schema 2.2

YAML
---
schemaVersion: '2.2'
description: aws:updateAgent
mainSteps:
- action: aws:updateAgent
  name: updateAgent
  inputs:
    agentName: Ec2Config
    source: https://s3.{Region}.amazonaws.com/aws-ssm-{Region}/manifest.json
JSON
{
  "schemaVersion": "2.2",
  "description": "aws:updateAgent",
  "mainSteps": [
    {
      "action": "aws:updateAgent",
      "name": "updateAgent",
      "inputs": {
        "agentName": "Ec2Config",
        "source": "https://s3.{Region}.amazonaws.com/aws-ssm-{Region}/manifest.json"
      }
    }
  ]
}

Schema 1.2

YAML
---
runtimeConfig:
  aws:updateAgent:
    properties:
      agentName: Ec2Config
      source: https://s3.{Region}.amazonaws.com/aws-ssm-{Region}/manifest.json
      allowDowngrade: "{{ allowDowngrade }}"
      targetVersion: "{{ version }}"
JSON
{
   "runtimeConfig":{
      "aws:updateAgent":{
         "properties":{
            "agentName":"Ec2Config",
            "source":"https://s3.{Region}.amazonaws.com/aws-ssm-{Region}/manifest.json",
            "allowDowngrade":"{{ allowDowngrade }}",
            "targetVersion":"{{ version }}"
         }
      }
   }
}

Eigenschaften

agentName

EC2Config. Dies ist der Name des Agenten, der den EC2 Config-Dienst ausführt.

Typ: Zeichenfolge

Erforderlich: Ja

allowDowngrade

Erlauben Sie, dass der EC2 Config-Dienst auf eine frühere Version herabgestuft wird. Wenn hierfür „false“ festgelegt ist, kann der Service nur auf neuere Versionen aktualisiert werden (Standard). Wenn hierfür „true“ festgelegt wurde, geben Sie die ältere Version an.

Typ: Boolesch

Erforderlich: Nein

Quelle

Der Speicherort, an den Systems Manager die Version von EC2 Config kopiert, um sie zu installieren. Sie können diesen Speicherort nicht ändern.

Typ: Zeichenfolge

Erforderlich: Ja

targetVersion

Eine bestimmte Version des EC2 Config-Dienstes, die installiert werden soll. Ist hierfür nichts angegeben, wird der Dienst auf die neueste Version aktualisiert.

Typ: Zeichenfolge

Erforderlich: Nein

aws:updateSsmAgent

Aktualisieren Sie SSM Agent auf die neueste Version oder geben Sie eine ältere Version an. Dieses Plugin läuft unter Linux- und Windows Server-Betriebssystemen. Weitere Informationen finden Sie unter Arbeiten mit SSM Agent.

Syntax

Schema 2.2

YAML
---
schemaVersion: '2.2'
description: aws:updateSsmAgent
parameters:
  allowDowngrade:
    default: 'false'
    description: "(Optional) Allow the Amazon SSM Agent service to be downgraded to
      an earlier version. If set to false, the service can be upgraded to newer versions
      only (default). If set to true, specify the earlier version."
    type: String
    allowedValues:
    - 'true'
    - 'false'
mainSteps:
- action: aws:updateSsmAgent
  name: updateSSMAgent
  inputs:
    agentName: amazon-ssm-agent
    source: https://s3.{Region}.amazonaws.com/amazon-ssm-{Region}/ssm-agent-manifest.json
    allowDowngrade: "{{ allowDowngrade }}"
JSON
{
  "schemaVersion": "2.2",
  "description": "aws:updateSsmAgent",
  "parameters": {
    "allowDowngrade": {
      "default": "false",
      "description": "(Required) Allow the Amazon SSM Agent service to be downgraded to an earlier version. If set to false, the service can be upgraded to newer versions only (default). If set to true, specify the earlier version.",
      "type": "String",
      "allowedValues": [
        "true",
        "false"
      ]
    }
  },
  "mainSteps": [
    {
      "action": "aws:updateSsmAgent",
      "name": "awsupdateSsmAgent",
      "inputs": {
        "agentName": "amazon-ssm-agent",
        "source": "https://s3.{Region}.amazonaws.com/amazon-ssm-{Region}/ssm-agent-manifest.json",
        "allowDowngrade": "{{ allowDowngrade }}"
      }
    }
  ]
}

Schema 1.2

YAML
---
runtimeConfig:
  aws:updateSsmAgent:
    properties:
    - agentName: amazon-ssm-agent
      source: https://s3.{Region}.amazonaws.com/aws-ssm-{Region}/manifest.json
      allowDowngrade: "{{ allowDowngrade }}"
JSON
{
   "runtimeConfig":{
      "aws:updateSsmAgent":{
         "properties":[
            {
               "agentName":"amazon-ssm-agent",
               "source":"https://s3.{Region}.amazonaws.com/aws-ssm-{Region}/manifest.json",
               "allowDowngrade":"{{ allowDowngrade }}"
            }
         ]
      }
   }
}

Eigenschaften

agentName

amazon-ssm-agent. Dies ist der Name des Systems Manager Manager-Agenten, der Anfragen verarbeitet und Befehle auf der Instanz ausführt.

Typ: Zeichenfolge

Erforderlich: Ja

allowDowngrade

Erlauben Sie, dass SSM Agent auf eine ältere Version zurückgesetzt wird. Wenn hierfür „false“ festgelegt ist, kann der Agent nur auf neuere Versionen aktualisiert werden (Standard). Wenn hierfür „true“ festgelegt wurde, geben Sie die ältere Version an.

Typ: Boolesch

Erforderlich: Ja

Quelle

Der Ort, an den Systems Manager die zu installierende Version von SSM Agent kopiert. Sie können diesen Speicherort nicht ändern.

Typ: Zeichenfolge

Erforderlich: Ja

targetVersion

Eine bestimmte zu installierende Version von SSM Agent. Ist hierfür nichts angegeben, wird der Agent auf die neueste Version aktualisiert.

Typ: Zeichenfolge

Erforderlich: Nein