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
-
Die Schemaversion des Sitzungsdokuments. Sitzungsdokumente unterstützen nur die Version 1.0.
Typ: Zeichenfolge
Erforderlich: Ja
- description
-
Eine Beschreibung, die Sie für das Sitzungsdokument angeben. Beispiel: „Dokument zum Starten der Port-Weiterleitungssitzung mit Session Manager“.
Typ: Zeichenfolge
Erforderlich: Nein
- sessionType
-
Der Sitzungstyp, mit dem das Sitzungsdokument erstellt wird.
Typ: Zeichenfolge
Erforderlich: Ja
Zulässige Werte:
InteractiveCommands
|NonInteractiveCommands
|Port
|Standard_Stream
- inputs
-
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
-
Der Amazon Simple Storage Service (Amazon S3)-Bucket, an den Sie am Ende Ihrer Sitzungen Sitzungsprotokolle senden möchten.
Typ: Zeichenfolge
Erforderlich: Nein
- s3KeyPrefix
-
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? im Benutzerhandbuch zu Amazon Simple Storage Service.Typ: Zeichenfolge
Erforderlich: Nein
- s3EncryptionEnabled
-
Wenn auf
true
eingestellt ist, muss der Amazon S3-Bucket, den Sie in ders3BucketName
-Eingabe angegeben haben, verschlüsselt werden.Typ: Boolesch
Erforderlich: Ja
- cloudWatchLogGroupName
-
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
-
Wenn auf
true
eingestellt ist, muss die Protokollgruppe, die Sie in dercloudWatchLogGroupName
-Eingabe angegeben haben, verschlüsselt werden.Typ: Boolesch
Erforderlich: Ja
- cloudWatchStreamingEnabled
-
Wenn auf
true
eingestellt ist, wird ein kontinuierlicher Stream von Sitzungsdaten an die Protokollgruppe gesendet, die Sie in dercloudWatchLogGroupName
-Eingabe angegeben haben. Wenn auffalse
eingestellt ist, werden Sitzungsprotokolle am Ende Ihrer Sitzungen an die Protokollgruppe gesendet, die Sie in dercloudWatchLogGroupName
-Eingabe angegeben haben.Typ: Boolesch
Erforderlich: Ja
- kmsKeyId
-
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
-
Wenn auf
true
eingestellt ist, müssen Sie in derrunAsDefaultUser
-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 erstelltenssm-user
-Konto gestartet. Das Run-As-Feature wird nur für die Verbindung mit Linux-verwalteten Knoten unterstützt.Typ: Boolesch
Erforderlich: Ja
- runAsDefaultUser
-
Der Name des Benutzerkontos, mit dem Sitzungen auf Linux-verwalteten Knoten gestartet werden sollen, wenn die
runAsEnabled
-Eingabe auftrue
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.Typ: Zeichenfolge
Erforderlich: Nein
- idleSessionTimeout
-
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
-
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
-
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
-
Die Shell-Einstellungen, Umgebungsvariablen, Arbeitsverzeichnisse und Befehle, die Sie für Sitzungen auf Windows-verwalteten Knoten angeben.
Typ: Zeichenfolge
Erforderlich: Nein
- linux
-
Die Shell-Einstellungen, Umgebungsvariablen, Arbeitsverzeichnisse und Befehle, die Sie für Sitzungen auf Linux-verwalteten Knoten angeben.
Typ: Zeichenfolge
Erforderlich: Nein
- parameters
-
Ein Objekt, das die Parameter definiert, die das Dokument akzeptiert. Weitere Informationen zum Definieren von Dokumentparametern finden Sie unter Parameter im Top-Level-Datenelemente. 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
undStringList
referenzieren. In diesem Abschnitt des Dokuments können Sie die Parameter Store-ParameterSecureString
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.
Typ: StringMap
Erforderlich: Nein
- properties
-
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 derrunAsElevated
booleschen Eigenschaft können Sie auch festlegen, ob Befehle alsroot
ausgeführt werden. Weitere Informationen finden Sie unter Zugriff auf Befehle in einer Sitzung beschränken.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 TypsPort
an späterer Stelle in diesem Thema.Typ: StringMap
Erforderlich: Nein
Beispiel für Sitzungsdokument vom Typ Standard_Stream
Beispiel für Sitzungsdokument vom Typ InteractiveCommands
Beispiel für Sitzungsdokument vom Typ Port
Beispiel für Sitzungsdokument mit Sonderzeichen