

• La AWS Systems Manager CloudWatch dashboard non sarà più disponibile dopo il 30 aprile 2026. I clienti possono continuare a utilizzare la CloudWatch console Amazon per visualizzare, creare e gestire le proprie CloudWatch dashboard Amazon, proprio come fanno oggi. Per ulteriori informazioni, consulta la [documentazione di Amazon CloudWatch Dashboard](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Dashboards.html). 

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

# Schema documento di sessione
<a name="session-manager-schema"></a>

Le informazioni seguenti descrivono gli elementi dello schema di un documento di sessione .AWS Systems Manager Session Managerutilizza i documenti di sessione per determinare quale tipo di sessione avviare, ad esempio una sessione standard, una sessione di inoltro alla porta o una sessione per eseguire un comando interattivo.

 [schemaVersion](#version)   
Versione dello schema del documento di sessione. I documenti delle sessioni supportano solo la versione 1.0.  
Tipo: string  
Campo obbligatorio: sì

 [description](#descript)   
Descrizione specificata per il documento di sessione. Ad esempio, «Documento per avviare la sessione di inoltro della porta con Session Manager>>.  
Tipo: string  
Campo obbligatorio: no

 [sessionType](#type)   
Il tipo di sessione che il documento di sessione viene utilizzato per stabilire.  
Tipo: string  
Campo obbligatorio: sì  
Valori validi: `InteractiveCommands`\$1 `NonInteractiveCommands`\$1 `Port`\$1 `Standard_Stream`

 [inputs](#in)   
Preferenze di sessione da utilizzare per le sessioni stabilite utilizzando questo documento di sessione. Questo elemento è necessario per i documenti di sessione utilizzati per creare sessioni `Standard_Stream`.  
Tipo: StringMap  
Campo obbligatorio: no    
 [s3BucketName](#bucket)   
Il bucket Amazon Simple Storage Service (Amazon S3) a cui desideri inviare i registri delle sessioni al termine delle sessioni.  
Tipo: string  
Campo obbligatorio: no  
 [s3KeyPrefix](#prefix)   
Il prefisso da utilizzare quando si inviano i registri al bucket Amazon S3 specificato nell'input `s3BucketName`. Per ulteriori informazioni sull'utilizzo di un prefisso condiviso con gli oggetti archiviati in Amazon S3, consulta [Come si utilizzano le cartelle in un bucket S3?](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/using-folders.html) nella *Guida per l'utente di Amazon Simple Storage Service*.  
Tipo: string  
Campo obbligatorio: no  
 [s3EncryptionEnabled](#s3Encrypt)   
Se impostato su `true`, il bucket Amazon S3 specificato nell'input `s3BucketName` deve essere crittografato.  
Tipo: Booleano  
Campo obbligatorio: sì  
 [cloudWatchLogGroupName](#logGroup)   
Il nome del gruppo Amazon CloudWatch Logs (CloudWatch Logs) a cui si desidera inviare i registri di sessione al termine delle sessioni.  
Tipo: string  
Campo obbligatorio: no  
 [cloudWatchEncryptionEnabled](#cwEncrypt)   
Se impostato su `true`, il gruppo di registro specificato nell'input `cloudWatchLogGroupName` deve essere crittografato.  
Tipo: Booleano  
Campo obbligatorio: sì  
 [cloudWatchStreamingEnabled](#cwStream)   
Se impostato su `true`, un flusso continuo di registri di dati delle sessioni viene inviato al gruppo di registro specificato nell'input `cloudWatchLogGroupName`. Se impostati su`false`, i registri delle sessioni vengono inviati al gruppo di registri specificato nella `cloudWatchLogGroupName` alla fine delle sessioni.  
Tipo: Booleano  
Campo obbligatorio: sì  
 [kmsKeyId](#kms)   
L'ID del AWS KMS key da utilizzare per crittografare ulteriormente i dati tra i computer client locali e i nodi gestiti Amazon Elastic Compute Cloud (Amazon EC2) a cui ti connetti.  
Tipo: string  
Campo obbligatorio: no  
 [runAsEnabled](#run)   
Se impostato su `true`, è necessario specificare un account utente esistente nei nodi gestiti a cui ci si connetterà nell'input `runAsDefaultUser`. In caso contrario, le sessioni non verranno avviate. Per impostazione predefinita, le sessioni vengono avviate utilizzando `ssm-user` creato dall'account AWS Systems Manager SSM Agent. La funzionalità Esegui come è supportata solo per la connessione ai nodi gestiti .  
Tipo: Booleano  
Campo obbligatorio: sì  
 [runAsDefaultUser](#runUser)   
Il nome dell'account utente con cui avviare le sessioni sui nodi gestiti Linux quando l'input macOS è impostato su . L'account utente specificato per questo input deve esistere nei nodi gestiti a cui ci si connetterà; in caso contrario, le sessioni non verranno avviate.  
Tipo: string  
Campo obbligatorio: no  
 [idleSessionTimeout](#timeout)   
La quantità di tempo di inattività che si desidera consentire prima del termine di una sessione. Questo input viene misurato in minuti.  
Tipo: string  
Valori validi: 1-60  
Campo obbligatorio: no  
 [maxSessionDuration](#maxDuration)   
La quantità di tempo che si desidera permettere prima del termine di una sessione. Questo input viene misurato in minuti.  
Tipo: string  
Valori validi: 1-1440  
Campo obbligatorio: no  
 [shellProfile](#shell)   
Le preferenze specificate per il sistema operativo da applicare alle sessioni quali le preferenze della shell, le variabili di ambiente, le directory di lavoro e l'esecuzione di più comandi all'avvio di una sessione.  
Tipo: StringMap  
Campo obbligatorio: no    
 [windows](#win)   
Le preferenze della shell, le variabili di ambiente, le directory di lavoro e i comandi specificati per le sessioni sui nodi gestiti Windows Server.  
Tipo: string  
Campo obbligatorio: no  
 [linux](#lin)   
Le preferenze della shell, le variabili di ambiente, le directory di lavoro e i comandi specificati per le sessioni sui nodi gestiti .  
Tipo: string  
Campo obbligatorio: no

 [parameters](#param)   
Una struttura che definisce i parametri accettati dal documento. ì Per ulteriori informazioni su come specificare i parametri del documento, consulta **Parametri di definizione del processo** nella [Elementi di dati di primo livello](documents-syntax-data-elements-parameters.md#top-level). Per i parametri a cui fai spesso riferimento, è consigliabile archiviare questi parametri in Systems Manager Parameter Store e farvi riferimento. Puoi fare riferimento ai parametri `String`, `StringList` e Parameter Store in questa sezione di un documento. Puoi fare riferimento ai parametri Parameter Store `SecureString` in questa sezione di un documento. È possibile fare riferimento a un parametro Parameter Store utilizzando il seguente formato.  

```
{{ssm:parameter-name}}
```
Per ulteriori informazioni su Parameter Store, consulta [AWS Systems Manager Parameter Store](systems-manager-parameter-store.md).  
Tipo: StringMap  
Campo obbligatorio: no

 [properties](#props)   
Un oggetto i cui valori specificati vengono utilizzati nell' operazione API `StartSession`.  
Per i documenti di sessione utilizzati per sessioni `InteractiveCommands`, l'oggetto proprietà include i comandi da eseguire nei sistemi operativi specificati. Puoi inoltre determinare se i comandi vengono eseguiti come `root` utilizzando la proprietà booleana `runAsElevated`. Per ulteriori informazioni consulta [Limitare l'accesso ai comandi in una sessione](session-manager-restrict-command-access.md).  
Per i documenti di sessione utilizzati per sessioni `Port`, l'oggetto proprietà contiene il numero di porta verso cui deve essere reindirizzato il traffico. Per un esempio, consulta il documento di Sessione tipo `Port` più avanti in questo argomento.  
Tipo: StringMap  
Campo obbligatorio: no

Esempio di documento di sessione tipo `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"
        }
    }
}
```

------

Esempio di documento di sessione tipo `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
        }
    }
}
```

------

Esempio di documento di sessione tipo `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"
    }
}
```

------

Esempio di documento di sessione con caratteri speciali

------
#### [ 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
      }
   }
}
```

------