• Das AWS Systems Manager CloudWatch Dashboard wird nach dem 30. April 2026 nicht mehr verfügbar sein. Kunden können weiterhin die CloudWatch Amazon-Konsole verwenden, um ihre CloudWatch Amazon-Dashboards anzusehen, zu erstellen und zu verwalten, so wie sie es heute tun. Weitere Informationen finden Sie in der [Amazon CloudWatch Dashboard-Dokumentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Dashboards.html). 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. # Schema des Sitzungsdokuments Die folgenden Informationen beschreiben die Schemaelemente eines Session-Dokuments. AWS Systems Manager Session Managerverwendet Sitzungsdokumente, um zu bestimmen, welcher Sitzungstyp gestartet werden soll, z. B. eine Standardsitzung, eine Portweiterleitungssitzung oder eine Sitzung zur Ausführung eines interaktiven Befehls. [schemaVersion](#version) Die Schemaversion des Sitzungsdokuments. Sitzungsdokumente unterstützen nur die Version 1.0. Typ: Zeichenfolge Erforderlich: Ja [description](#descript) Eine Beschreibung, die Sie für das Sitzungsdokument angeben. Beispiel: „Dokument zum Starten der Port-Weiterleitungssitzung mit Session Manager“. Typ: Zeichenfolge Erforderlich: Nein [sessionType](#type) Der Sitzungstyp, mit dem das Sitzungsdokument erstellt wird. Typ: Zeichenfolge Erforderlich: Ja Zulässige Werte: `InteractiveCommands` \$1 `NonInteractiveCommands` \$1 `Port` \$1 `Standard_Stream` [inputs](#in) Die Sitzungseinstellungen, die für Sitzungen verwendet werden, die mit diesem Sitzungsdokument erstellt wurden. Dieses Element ist für Sitzungsdokumente erforderlich, die zum Erstellen von `Standard_Stream`-Sitzungen verwendet werden. Typ: StringMap Erforderlich: Nein [s3BucketName](#bucket) Der Amazon Simple Storage Service (Amazon S3)-Bucket, an den Sie am Ende Ihrer Sitzungen Sitzungsprotokolle senden möchten. Typ: Zeichenfolge Erforderlich: Nein [s3KeyPrefix](#prefix) Das Präfix, das beim Senden von Protokollen an den Amazon S3-Bucket verwendet werden soll, den Sie in der `s3BucketName`-Eingabe angegeben haben. Weitere Hinweise zur Verwendung eines freigegebenen Präfixes für in Amazon S3 gespeicherte Objekte finden Sie unter [Wie kann ich Ordner in einem S3-Bucket verwenden?](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/using-folders.html) im *Benutzerhandbuch zu Amazon Simple Storage Service*. Typ: Zeichenfolge Erforderlich: Nein [s3EncryptionEnabled](#s3Encrypt) Wenn auf `true` eingestellt ist, muss der Amazon S3-Bucket, den Sie in der `s3BucketName`-Eingabe angegeben haben, verschlüsselt werden. Typ: Boolescher Wert Erforderlich: Ja [cloudWatchLogGroupName](#logGroup) Der Name der Amazon CloudWatch Logs-Gruppe (CloudWatch Logs), an die Sie am Ende Ihrer Sitzungen Sitzungsprotokolle senden möchten. Typ: Zeichenfolge Erforderlich: Nein [cloudWatchEncryptionEnabled](#cwEncrypt) Wenn auf `true` eingestellt ist, muss die Protokollgruppe, die Sie in der `cloudWatchLogGroupName`-Eingabe angegeben haben, verschlüsselt werden. Typ: Boolescher Wert Erforderlich: Ja [cloudWatchStreamingEnabled](#cwStream) Wenn auf `true` eingestellt ist, wird ein kontinuierlicher Stream von Sitzungsdaten an die Protokollgruppe gesendet, die Sie in der `cloudWatchLogGroupName`-Eingabe angegeben haben. Wenn auf `false` eingestellt ist, werden Sitzungsprotokolle am Ende Ihrer Sitzungen an die Protokollgruppe gesendet, die Sie in der `cloudWatchLogGroupName`-Eingabe angegeben haben. Typ: Boolescher Wert Erforderlich: Ja [kmsKeyId](#kms) Die ID der, die AWS KMS key Sie verwenden möchten, um Daten zwischen Ihren lokalen Client-Computern und den von Amazon Elastic Compute Cloud (Amazon EC2) verwalteten Knoten, mit denen Sie eine Verbindung herstellen, weiter zu verschlüsseln. Typ: Zeichenfolge Erforderlich: Nein [runAsEnabled](#run) Wenn auf `true` eingestellt ist, müssen Sie in der `runAsDefaultUser`-Eingabe ein Benutzerkonto angeben, das auf den verwalteten Knoten vorhanden ist, mit denen Sie eine Verbindung herstellen möchten. Andernfalls können Sitzungen nicht gestartet werden. Standardmäßig werden Sitzungen mit dem von AWS Systems Manager SSM Agent erstellten `ssm-user`-Konto gestartet. Das Run-As-Feature wird nur für die Verbindung mit Linux und macOS-verwalteten Knoten unterstützt. Typ: Boolescher Wert Erforderlich: Ja [runAsDefaultUser](#runUser) Der Name des Benutzerkontos, mit dem Sitzungen auf Linux- und macOS-verwalteten Knoten gestartet werden sollen, wenn die `runAsEnabled`-Eingabe auf `true` eingestellt ist. Das Benutzerkonto, das Sie für diese Eingabe angeben, muss auf den verwalteten Knoten vorhanden sein, mit denen Sie eine Verbindung herstellen möchten. Andernfalls können Sitzungen nicht gestartet werden. Bei der Entscheidung, welches Betriebssystem-Benutzerkonto verwendet werden soll, wird in der folgenden Reihenfolge Session Manager geprüft: das `SSMSessionRunAs` Tag in den Sitzungs-Tags des IAM-Benutzers, dann das `SSMSessionRunAs` Tag für die angenommene IAM-Rolle und schließlich dieser `runAsDefaultUser` Wert aus den Sitzungseinstellungen. Weitere Informationen finden Sie unter [Run-As-Support für Linux- und macOS-verwaltete Knoten einschalten](session-preferences-run-as.md). Typ: Zeichenfolge Erforderlich: Nein [idleSessionTimeout](#timeout) Die Zeit der Inaktivität, die Sie zulassen möchten, bevor eine Sitzung beendet wird. Diese Eingabe wird in Minuten gemessen. Typ: Zeichenfolge Zulässige Werte: 1 bis 60 Erforderlich: Nein [maxSessionDuration](#maxDuration) Die maximale Zeit, die Sie erlauben möchten, bevor eine Sitzung beendet wird. Diese Eingabe wird in Minuten gemessen. Typ: Zeichenfolge Zulässige Werte: 1–1 440 Erforderlich: Nein [shellProfile](#shell) Die Einstellungen, die Sie pro Betriebssystem angeben und die in Sitzungen angewendet werden, wie Shell-Einstellungen, Umgebungsvariablen, Arbeitsverzeichnissen und das Ausführen mehrerer Befehle. Typ: StringMap Erforderlich: Nein [windows](#win) Die Shell-Einstellungen, Umgebungsvariablen, Arbeitsverzeichnisse und Befehle, die Sie für Sitzungen auf Windows Server-verwalteten Knoten angeben. Typ: Zeichenfolge Erforderlich: Nein [linux](#lin) Die Shell-Einstellungen, Umgebungsvariablen, Arbeitsverzeichnisse und Befehle, die Sie für Sitzungen auf Linux- und macOS-verwalteten Knoten angeben. Typ: Zeichenfolge Erforderlich: Nein [parameters](#param) Ein Objekt, das die Parameter definiert, die das Dokument akzeptiert. Weitere Informationen zum Definieren von Dokumentparametern finden Sie unter **Parameter** im [Top-Level-Datenelemente](documents-syntax-data-elements-parameters.md#top-level). Wir empfehlen, Parameter, auf die Sie häufig verweisen, im Systems Manager Parameter Store abzuspeichern und dann auf sie zu verweisen. In diesem Abschnitt des Dokuments können Sie die Parameter Store-Parameter `String` und `StringList` referenzieren. In diesem Abschnitt des Dokuments können Sie die Parameter Store-Parameter `SecureString` nicht referenzieren. Sie können über das folgende Format einen Parameter Store-Parameter referenzieren. ``` {{ssm:parameter-name}} ``` Mehr über Parameter Store erfahren Sie unter [AWS Systems Manager Parameter Store](systems-manager-parameter-store.md). Typ: StringMap Erforderlich: Nein [properties](#props) Ein Objekt, dessen Werte Sie angeben, die in der `StartSession` API-Operation verwendet werden. Für Sitzungsdokumente, die für `InteractiveCommands`-Sitzungen verwendet werden,enthält das Eigenschaftenobjekt die Befehle, die auf den von Ihnen angegebenen Betriebssystemen ausgeführt werden sollen. Mit der `runAsElevated` booleschen Eigenschaft können Sie auch festlegen, ob Befehle als `root` ausgeführt werden. Weitere Informationen finden Sie unter [Zugriff auf Befehle in einer Sitzung beschränken](session-manager-restrict-command-access.md). Für Sitzungsdokumente, die für `Port`-Sitzungen verwendet werden, enthält das Eigenschaftenobjekt die Portnummer, an die der Datenverkehr umgeleitet werden soll. Ein Beispiel ist das Beispiel zum Sitzungsdokument des Typs `Port` an späterer Stelle in diesem Thema. Typ: StringMap Erforderlich: Nein Beispiel für Sitzungsdokument vom Typ `Standard_Stream` ------ #### [ YAML ] ``` --- schemaVersion: '1.0' description: Document to hold regional settings for Session Manager sessionType: Standard_Stream inputs: s3BucketName: '' s3KeyPrefix: '' s3EncryptionEnabled: true cloudWatchLogGroupName: '' cloudWatchEncryptionEnabled: true cloudWatchStreamingEnabled: true kmsKeyId: '' runAsEnabled: true runAsDefaultUser: '' idleSessionTimeout: '20' maxSessionDuration: '60' shellProfile: windows: '' linux: '' ``` ------ #### [ JSON ] ``` { "schemaVersion": "1.0", "description": "Document to hold regional settings for Session Manager", "sessionType": "Standard_Stream", "inputs": { "s3BucketName": "", "s3KeyPrefix": "", "s3EncryptionEnabled": true, "cloudWatchLogGroupName": "", "cloudWatchEncryptionEnabled": true, "cloudWatchStreamingEnabled": true, "kmsKeyId": "", "runAsEnabled": true, "runAsDefaultUser": "", "idleSessionTimeout": "20", "maxSessionDuration": "60", "shellProfile": { "windows": "date", "linux": "pwd;ls" } } } ``` ------ Beispiel für Sitzungsdokument vom Typ `InteractiveCommands` ------ #### [ YAML ] ``` --- schemaVersion: '1.0' description: Document to view a log file on a Linux instance sessionType: InteractiveCommands parameters: logpath: type: String description: The log file path to read. default: "/var/log/amazon/ssm/amazon-ssm-agent.log" allowedPattern: "^[a-zA-Z0-9-_/]+(.log)$" properties: linux: commands: "tail -f {{ logpath }}" runAsElevated: true ``` ------ #### [ JSON ] ``` { "schemaVersion": "1.0", "description": "Document to view a log file on a Linux instance", "sessionType": "InteractiveCommands", "parameters": { "logpath": { "type": "String", "description": "The log file path to read.", "default": "/var/log/amazon/ssm/amazon-ssm-agent.log", "allowedPattern": "^[a-zA-Z0-9-_/]+(.log)$" } }, "properties": { "linux": { "commands": "tail -f {{ logpath }}", "runAsElevated": true } } } ``` ------ Beispiel für Sitzungsdokument vom Typ `Port` ------ #### [ YAML ] ``` --- schemaVersion: '1.0' description: Document to open given port connection over Session Manager sessionType: Port parameters: paramExample: type: string description: document parameter properties: portNumber: anyPortNumber ``` ------ #### [ JSON ] ``` { "schemaVersion": "1.0", "description": "Document to open given port connection over Session Manager", "sessionType": "Port", "parameters": { "paramExample": { "type": "string", "description": "document parameter" } }, "properties": { "portNumber": "anyPortNumber" } } ``` ------ Beispiel für Sitzungsdokument mit Sonderzeichen ------ #### [ YAML ] ``` --- schemaVersion: '1.0' description: Example document with quotation marks sessionType: InteractiveCommands parameters: Test: type: String description: Test Input maxChars: 32 properties: windows: commands: | $Test = '{{ Test }}' $myVariable = \"Computer name is $env:COMPUTERNAME\" Write-Host "Test variable: $myVariable`.`nInput parameter: $Test" runAsElevated: false ``` ------ #### [ JSON ] ``` { "schemaVersion":"1.0", "description":"Test document with quotation marks", "sessionType":"InteractiveCommands", "parameters":{ "Test":{ "type":"String", "description":"Test Input", "maxChars":32 } }, "properties":{ "windows":{ "commands":[ "$Test = '{{ Test }}'", "$myVariable = \\\"Computer name is $env:COMPUTERNAME\\\"", "Write-Host \"Test variable: $myVariable`.`nInput parameter: $Test\"" ], "runAsElevated":false } } } ``` ------