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-Plug-ins
Diese Referenz beschreibt die Plugins, die Sie in einem Dokument vom Typ AWS Systems Manager (SSM) Command angeben können. Diese Plug-ins 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 Plug-Ins oder Schritte. Im Rahmen dieses Hilfethemas werden die Plug-Ins und Schritte als Plug-Ins bezeichnet. Dieser Abschnitt enthält Informationen zu allen Systems Manager-Plug-Ins. 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 Plug-Ins funktionieren nur auf Windows Server-Instances oder Linux-Instances. Für alle Plug-Ins werden Plattformabhängigkeiten angegeben.
Die folgenden Dokumentenplugins werden auf Amazon Elastic Compute Cloud (Amazon EC2)-Instances für macOS unterstützt:
-
aws:refreshAssociation
-
aws:runShellScript
-
aws:runPowerShellScript
-
aws:softwareInventory
-
aws:updateSsmAgent
Inhalt
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, deronFailure
- oderonSuccess
-Eingängen definiert ist. Damit ein Schritt mit dieser Eingabe erwartungsgemäß ausgeführt wird, muss der Schritt der letzte sein, der in denmainSteps
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 einfinallyStep
definiert. Wenn Sie diese Eingabe für ein Plugin mit dem WertsuccessAndExit
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 einfinallyStep
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
finallyStep
definiert.Typ: Zeichenfolge
Zulässige Werte:
exit
Erforderlich: Nein
aws:applications
Installieren, Reparieren oder Deinstallieren von Anwendungen auf einer EC2-Instance. Dieses Plug-In läuft nur unter Windows Server-Betriebssystemen.
Syntax
Schema 2.2
Schema 1.2
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-Hashwert 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 Plug-In 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:
- ApplicationEventProtokollieren
-
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 Plug-In 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 Plug-In 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.
- SecurityEventProtokollieren
-
Sendet Protokolldaten von Sicherheitsereignissen an CloudWatch Logs.
- SystemEventProtokoll
-
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 Abschnitte mit eindeutigen IDs hinzufügen (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 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 Instanz verwendet wird. Windows Server
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 auchDimensionValue
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. Um das benutzerdefinierte Protokoll, das ETW-Protokoll und das Systemprotokoll an das unter definierte CloudWatch Protokollziel zu senden"Id": "ETW"
, geben Sie ebenfalls „(ETW), CloudWatch Logs“ ein. 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 "ApplicationEventLog, (CloudWatchLogs, 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
- LogDirectoryPfad
-
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\ W3SVC n).
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 Protokollgruppen in der Konsole angezeigt. CloudWatch
Typ: Zeichenfolge
Erforderlich: Ja
- LogName
-
Der Name der Protokolldateien.
-
Zum Suchen des Protokollnamens klicken Sie in der Ereignisanzeige im Navigationsbereich auf Applications and Services Logs.
-
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.
-
Klicken Sie im Dialogfeld Create Custom View auf die Registerkarte XML. Der LogNamebefindet sich im Tag <Select Path=> (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 Log-Stream-Name wird auf dem Bildschirm Log Groups > Streams for
< YourLog Stream >
in der CloudWatch Konsole angezeigt.Erforderlich: Ja
- MetricName
-
Die CloudWatch Metrik, unter der 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: Regions-IDs der sowohl von Systems Manager als auch von CloudWatch Logs AWS-Regionen unterstützten Bereiche
us-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-ReferenzErforderlich: 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
- TimeZoneFreundlich
-
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 | Bytes | KB | MB | GB | TB | Bits | Kilobits | Megabits | Gigabits | Terabits | Prozent | Anzahl | Byte/Sekunde | KB/Sekunde | MB/Sekunde | GB/Sekunde | TB/Sekunde | Bits/Sekunde | Kilobit/Sekunde | Megabit/Sekunde | Gigabit/Sekunde | Terabit/Sekunde | Anzahl/Sekunde | Keine.
Erforderlich: Ja
aws:configureDocker
(Schemaversion 2.0 oder höher) Konfigurieren Sie eine Instance für die Arbeit mit Container und Docker. Dieses Plug-In wird unter Linux- und Windows Server-Betriebssystemen unterstützt.
Syntax
Schema 2.2
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 oder höher) Installieren oder deinstallieren Sie ein AWS Systems Manager Distributor 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 Plug-in 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: AWSPVDriver
AWSNVMe
,AwsEnaNetworkDriver
,AwsVssComponents
,AmazonCloudWatchAgent
,CodeDeployAgent
, und AWSSupport-EC2Rescue.
Zu den verfügbaren AWS Paketen für Linux-Betriebssysteme gehören die folgenden: AmazonCloudWatchAgent
CodeDeployAgent
, undAWSSupport-EC2Rescue
.
Syntax
Schema 2.2
Eingaben
- Name
-
Der Name des zu installierenden oder zu deinstallierenden AWS Pakets. In verfügbaren Paketen ist Folgendes enthalten:
AWSPVDriver
,AwsEnaNetworkDriver
,AwsVssComponents
undAmazonCloudWatchAgent
.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 SieIn-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. DieIn-place update
Option wird für Pakete mit dem Namen AWS-published nicht unterstützt.Uninstall and reinstall
ist 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:
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 dasparameter-name
}}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.Geben Sie ein: 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
Verbinden Sie eine EC2-Instance mit einer Domain. Dieses Plug-In läuft unter Linux- und Windows Server-Betriebssystemen. Dieses Plugin ändert den Hostnamen für Linux-Instances in das Format EC2AMAZ-XXXXXXX
. Weitere Informationen zum Beitreten von EC2-Instances finden Sie unter Join an EC2 Instance to Your AWS Managed Microsoft AD Directory im AWS Directory Service Administrationshandbuch.
Syntax
Schema 2.2
Schema 1.2
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"
- dns IpAddresses
-
Die IP-Adressen des DNS-Servers.
Typ: StringList
Erforderlich: Ja
Beispiel: „dns IpAddresses „: [" 198.51.100.1", "198.51.100.2"]
Beispiele
Beispiele finden Sie unter Verbinden einer Amazon-EC2-Instance mit Ihrem AWS Managed Microsoft AD im AWS Directory Service -Administratorhandbuch.
aws:downloadContent
(Schemaversion 2.0 oder höher) Laden Sie SSM-Dokumente und -Skripts von entfernten Standorten herunter. GitHub EnterpriseRepositorys werden nicht unterstützt. Dieses Plug-In wird unter Linux- und Windows Server-Betriebssystemen unterstützt.
Syntax
Schema 2.2
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
undSSMDocument
.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. Beispielsweise:
"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 alsmaster
gespeichert ist. Zum Beispiel:"getOptions": "branch:refs/head/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",
-
-
privateSSHKey
Der SSH-Schlüssel, der beim Herstellen einer Verbindung zur
repository
verwendet werden soll. Sie können das folgende Format verwenden, um auf einenSecureString
-Parameter für den Wert Ihres SSH-Schlüssels zu verweisen:{{ssm-secure:
.your-secure-string-parameter
}}Typ: Zeichenfolge
-
Überprüfung überspringen HostKey
Bestimmt den Wert der StrictHostKeyChecking Option, wenn eine Verbindung zu dem von
repository
Ihnen angegebenen hergestellt wird. Der Standardwert istfalse
.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 einenSecureString
-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 einenSecureString
-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:
-
zulassen InsecureDownload
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 SieBasic
oderDigest
angeben, müssen Sie Werte für dieusername
- undpassword
-Parameter bereitstellen. Um dieDigest
-Methode zu verwenden, muss SSM Agent-Version 3.0.1181.0 oder höher muss auf Ihrer Instance installiert sein. DieDigest
-Methode unterstützt MD5- und 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 mitBasic
-Authentifizierung angeben. Sie können das folgende Format verwenden, um auf einenSecureString
-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 mitBasic
-Authentifizierung angeben. Sie können das folgende Format verwenden, um auf einenSecureString
-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/
DOC-EXAMPLE-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 Amazon EC2 EC2-Instance. Dieses Plug-In läuft nur unter Windows Server-Betriebssystemen.
Syntax
Schema 2.2
Schema 1.2
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-Hashwert 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 Plug-In läuft unter Linux- und Microsoft Windows Server-Betriebssystemen.
Syntax
Schema 2.2
Eingaben
- associationIds
-
Liste der Verknüpfungs-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 Plug-In läuft unter Linux- und Microsoft Windows Server-Betriebssystemen.
Syntax
Schema 2.2
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
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 Plug-In mit dem Plug-In aws:downloadContent verwenden, um ein SSM-Dokument von einem Remote-Standort in ein lokal freigegebenes Verzeichnis herunterzuladen, und es dann ausführen. Dieses Plug-In wird unter Linux- und Windows Server-Betriebssystemen unterstützt. Dieses Plug-In unterstützt nicht das Ausführen des AWS-UpdateSSMAgent
-Dokuments oder eines anderen Dokuments, das den aws:updateSsmAgent
-Plug-In verwendet.
Syntax
Schema 2.2
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. WenndocumentType
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 Plug-In läuft unter Microsoft Windows Server- und Linux-Betriebssystemen.
Syntax
Schema 2.2
Schema 1.2
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 Plug-In läuft nur unter Linux-Betriebssystemen.
Syntax
Schema 2.2
Schema 1.2
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 Plug-In 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
-Plug-In 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
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
- windowsUpdates
-
(Optional) Erfassen von Metadaten für alle Windows-Updates.
Typ: Zeichenfolge
Erforderlich: Nein
- Instanz DetailedInformation
-
(Optional) Erfassen weiterer Instance-Informationen neben den Informationen des Standardbestands-Plug-ins (
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
aws:updateAgent
Aktualisieren Sie den EC2Config-Service auf die neueste Version oder geben Sie eine ältere Version an. Dieses Plug-In läuft nur unter Microsoft Windows Server-Betriebssystemen. Weitere Informationen zum EC2Config-Service finden Sie unter Configuring a Windows Instance using the EC2Config Service (legacy) im Amazon EC2 EC2-Benutzerhandbuch.
Syntax
Schema 2.2
Schema 1.2
Eigenschaften
- agentName
-
EC2Config. Dies ist der Name des Agenten, der den EC2Config-Service ausführt.
Typ: Zeichenfolge
Erforderlich: Ja
- allowDowngrade
-
Erlauben Sie, dass der EC2Config-Service auf eine ältere Version zurückgesetzt 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 Ort, an den Systems Manager die zu installierende Version von EC2Config kopiert. Sie können diesen Speicherort nicht ändern.
Typ: Zeichenfolge
Erforderlich: Ja
- targetVersion
-
Eine bestimmte zu installierende Version des EC2Config-Service. 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 Plug-In läuft unter Linux- und Windows Server-Betriebssystemen. Weitere Informationen finden Sie unter Arbeiten mit SSM Agent.
Syntax
Schema 2.2
Schema 1.2
Eigenschaften
- agentName
-
amazon-ssm-agent. Dies ist der Name des Systems Manager-Agenten, der Anforderungen verarbeitet und auf der Instance Befehle 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