• AWS Systems Manager CloudWatch Dasbor tidak akan lagi tersedia setelah 30 April 2026. Pelanggan dapat terus menggunakan CloudWatch konsol Amazon untuk melihat, membuat, dan mengelola CloudWatch dasbor Amazon mereka, seperti yang mereka lakukan hari ini. Untuk informasi selengkapnya, lihat [dokumentasi CloudWatch Dasbor Amazon](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Dashboards.html). Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris. # Skema dokumen sesi Informasi berikut menjelaskan elemen skema dari dokumen Sesi. AWS Systems Manager Session ManagerMenggunakan dokumen Sesi untuk menentukan jenis sesi yang akan dimulai, seperti sesi standar, sesi penerusan port, atau sesi untuk menjalankan perintah interaktif. [schemaVersion](#version) Versi skema dokumen Sesi. Dokumen Sesi hanya mendukung versi 1.0. Tipe: String Wajib: Ya [description](#descript) Deskripsi yang Anda tentukan untuk dokumen Sesi. Misalnya, “Dokumen untuk memulai sesi penerusan port denganSession Manager”. Tipe: String Wajib: Tidak [sessionType](#type) Tipe sesi dokumen Sesi digunakan untuk membuat. Tipe: String Wajib: Ya Nilai valid: `InteractiveCommands` \$1 `NonInteractiveCommands` \$1 `Port` \$1 `Standard_Stream` [inputs](#in) Preferensi sesi yang akan digunakan untuk sesi yang dibuat menggunakan dokumen Sesi ini. Elemen ini diperlukan untuk dokumen Sesi yang digunakan untuk membuat sesi `Standard_Stream`. Jenis: StringMap Wajib: Tidak [s3BucketName](#bucket) Bucket Amazon Simple Storage Service (Amazon S3) yang ingin Anda kirimkan log sesi di akhir sesi Anda. Tipe: String Wajib: Tidak [s3KeyPrefix](#prefix) Prefiks yang digunakan saat mengirim log ke bucket Amazon S3 yang Anda tentukan di input `s3BucketName`. Untuk informasi selengkapnya tentang menggunakan awalan bersama dengan objek yang disimpan di Amazon S3, [lihat Bagaimana cara menggunakan folder di bucket S3?](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/using-folders.html) di *Panduan Pengguna Layanan Penyimpanan Sederhana Amazon*. Tipe: String Wajib: Tidak [s3EncryptionEnabled](#s3Encrypt) Jika diatur ke `true`, bucket Amazon S3 yang Anda tentukan di input `s3BucketName` harus dienkripsi. Tipe: Boolean Wajib: Ya [cloudWatchLogGroupName](#logGroup) Nama grup Amazon CloudWatch Logs (CloudWatch Log) yang ingin Anda kirimi log sesi di akhir sesi. Tipe: String Wajib: Tidak [cloudWatchEncryptionEnabled](#cwEncrypt) Jika diatur ke `true`, grup log yang Anda tentukan dalam input `cloudWatchLogGroupName` harus dienkripsi. Tipe: Boolean Wajib: Ya [cloudWatchStreamingEnabled](#cwStream) Jika diatur ke `true`, aliran terus-menerus sesi data log dikirim ke grup log yang Anda tentukan di input `cloudWatchLogGroupName`. Jika diatur ke `false`, log sesi dikirim ke grup log yang Anda tentukan di input `cloudWatchLogGroupName` di akhir sesi Anda. Tipe: Boolean Wajib: Ya [kmsKeyId](#kms) ID yang ingin AWS KMS key Anda gunakan untuk mengenkripsi data lebih lanjut antara mesin klien lokal Anda dan node terkelola Amazon Elastic Compute Cloud (Amazon EC2) yang Anda sambungkan. Tipe: String Wajib: Tidak [runAsEnabled](#run) Jika disetel ke`true`, Anda harus menentukan akun pengguna yang ada di node terkelola yang akan Anda sambungkan di `runAsDefaultUser` input. Jika tidak, sesi akan gagal untuk memulai. Secara default, sesi dimulai menggunakan `ssm-user` akun yang dibuat oleh AWS Systems Manager SSM Agent. Fitur Run As hanya didukung untuk menghubungkan ke Linux dan macOS mengelola node. Jenis: Boolean Wajib: Ya [runAsDefaultUser](#runUser) Nama akun pengguna untuk memulai sesi dengan node aktif Linux dan macOS terkelola saat `runAsEnabled` input disetel ke`true`. Akun pengguna yang Anda tentukan untuk input ini harus ada pada node terkelola yang akan Anda sambungkan; jika tidak, sesi akan gagal dimulai. Saat menentukan akun pengguna OS mana yang akan digunakan, Session Manager periksa dengan urutan berikut: `SSMSessionRunAs` tag pada tag sesi pengguna IAM, lalu `SSMSessionRunAs` tag pada peran IAM yang diasumsikan, dan akhirnya `runAsDefaultUser` nilai ini dari preferensi sesi. Untuk informasi selengkapnya, lihat [Aktifkan dukungan Run As untuk Linux dan node macOS terkelola](session-preferences-run-as.md). Tipe: String Wajib: Tidak [idleSessionTimeout](#timeout) Jumlah waktu tidak aktif yang ingin Anda izinkan sebelum sesi berakhir. Input ini diukur dalam hitungan menit. Tipe: String Nilai valid: 1–60 Wajib: Tidak [maxSessionDuration](#maxDuration) Jumlah maksimum waktu yang ingin Anda izinkan sebelum sesi berakhir. Input ini diukur dalam hitungan menit. Tipe: String Nilai yang valid: 1-1440 Wajib: Tidak [shellProfile](#shell) Preferensi yang Anda tentukan per sistem operasi untuk diterapkan dalam sesi seperti preferensi shell, variabel lingkungan, direktori kerja, dan menjalankan beberapa perintah ketika sesi dimulai. Jenis: StringMap Wajib: Tidak [windows](#win) Preferensi shell, variabel lingkungan, direktori kerja, dan perintah yang Anda tentukan untuk sesi pada node Windows Server terkelola. Tipe: String Wajib: Tidak [linux](#lin) Preferensi shell, variabel lingkungan, direktori kerja, dan perintah yang Anda tentukan untuk sesi pada Linux dan node macOS terkelola. Tipe: String Wajib: Tidak [parameters](#param) Objek yang menentukan parameter yang diterima dokumen. Untuk informasi lebih lanjut tentang menentukan parameter dokumen, lihat **parameter** di [Elemen data tingkat atas](documents-syntax-data-elements-parameters.md#top-level). Untuk parameter yang sering Anda referensikan, kami sarankan Anda menyimpan parameter tersebut di Systems Manager Parameter Store dan kemudian mereferensikannya. Anda dapat referensi `String` dan `StringList` Parameter Store parameter di bagian dokumen ini. Anda tidak dapat mereferensikan `SecureString` Parameter Store parameter di bagian dokumen ini. Anda dapat mereferensikan Parameter Store parameter menggunakan format berikut. ``` {{ssm:parameter-name}} ``` Untuk informasi selengkapnya tentang Parameter Store, lihat [AWS Systems Manager Parameter Store](systems-manager-parameter-store.md). Jenis: StringMap Wajib: Tidak [properties](#props) Objek yang nilainya Anda tentukan yang digunakan dalam operasi API `StartSession`. Untuk dokumen Sesi yang digunakan untuk sesi `InteractiveCommands`, objek properti termasuk perintah untuk berjalan pada sistem operasi yang Anda tentukan. Anda juga dapat menentukan apakah perintah dijalankan seperti `root` menggunakan properti `runAsElevated` boolean. Untuk informasi selengkapnya, lihat [Membatasi akses ke perintah dalam sesi](session-manager-restrict-command-access.md). Untuk dokumen Sesi yang digunakan untuk sesi `Port`, objek properti berisi nomor port tempat lalu lintas harus diarahkan. Sebagai contoh, lihat contoh dokumen Sesi tipe `Port` nanti di topik ini. Jenis: StringMap Wajib: Tidak Contoh dokumen sesi tipe `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" } } } ``` ------ Contoh dokumen sesi tipe `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 } } } ``` ------ Contoh dokumen sesi tipe `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" } } ``` ------ Contoh dokumen sesi dengan karakter khusus ------ #### [ 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 } } } ``` ------