Schema del documento di - AWS Systems Manager

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 del documento di

Le informazioni seguenti descrivono gli elementi dello schema di un documento Session.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

La versione dello schema del documento Session. I documenti di sessione supportano solo la versione 1.0.

Type: Stringa

: campo obbligatorio Sì

description

Descrizione specificata per il documento Sessione. Ad esempio, «Documento per avviare la sessione di inoltro della porta conSession Manager«.

Type: Stringa

: campo obbligatorio No

sessionType

Il tipo di sessione che il documento di sessione viene utilizzato per stabilire.

Type: Stringa

: campo obbligatorio Sì

Valori validi: InteractiveCommands | NonInteractiveCommands | Port | Standard_Stream

inputs

Preferenze di sessione da utilizzare per le sessioni stabilite utilizzando questo documento Sessione. Questo elemento è necessario per i documenti di sessione utilizzati per creareStandard_StreamSessioni.

Type: StringMap

: campo obbligatorio No

s3BucketName

Il bucket Amazon Simple Storage Service (Amazon S3) a cui desideri inviare i log delle sessioni al termine delle sessioni.

Type: Stringa

: campo obbligatorio No

s3KeyPrefix

Il prefisso da utilizzare quando si inviano i log al bucket Amazon S3 specificato nels3BucketNameInput. Per ulteriori informazioni sull'utilizzo di un prefisso condiviso con oggetti archiviati in Amazon S3, consultaCome si utilizzano le cartelle in un bucket S3?nellaGuida per l'utente di Amazon Simple Storage Service.

Type: Stringa

: campo obbligatorio No

s3EncryptionEnabled

Se impostato sutrue, il bucket Amazon S3 specificato nellas3BucketNameL'input deve essere crittografato.

Type: Booleano

: campo obbligatorio Sì

cloudWatchLogGroupName

Il nome del gruppo Amazon CloudWatch Logs (CloudWatch Logs) a cui si desidera inviare i log di sessione al termine delle sessioni.

Type: Stringa

: campo obbligatorio No

cloudWatchEncryptionEnabled

Se impostato sutrue, il gruppo di log specificato nellacloudWatchLogGroupNameL'input deve essere crittografato.

Type: Booleano

: campo obbligatorio Sì

cloudWatchStreamingEnabled

Se impostato sutrue, un flusso continuo di log dei dati delle sessioni viene inviato al gruppo di log specificato nellacloudWatchLogGroupNameInput. Se impostato sufalseI log delle sessioni vengono inviati al gruppo di log specificato nellacloudWatchLogGroupNamealla fine delle sessioni.

Type: Booleano

: campo obbligatorio Sì

kmsKeyId

L'ID del pluginAWS KMS keyDa utilizzare per crittografare ulteriormente i dati tra i computer client locali e le istanze Amazon Elastic Compute Cloud (Amazon EC2) a cui ti connetti.

Type: Stringa

: campo obbligatorio No

runAsEnabled

Se impostato sutrue, è necessario specificare un account utente esistente nelle istanze a cui ci si connetterà nelrunAsDefaultUserInput. In caso contrario, le sessioni non verranno avviate. Per impostazione predefinita, le sessioni vengono avviate utilizzandossm-usercreato dall'accountAWS Systems Manager SSM Agent. La caratteristica Esegui come è supportata solo per la connessione a istanze Linux.

Type: Booleano

: campo obbligatorio Sì

runAsDefaultUser

Il nome dell'account utente con cui avviare le sessioni su istanze Linux quando ilrunAsEnabledL'input è impostato sutrue. L'account utente specificato per questo input deve esistere nelle istanze a cui ci si connetterà; in caso contrario, le sessioni non verranno avviate.

Type: Stringa

: campo obbligatorio No

idleSessionTimeout

La quantità di tempo di inattività che si desidera consentire prima del termine di una sessione. Questo input viene misurato in minuti.

Type: Stringa

Valori validi: 1-60

: campo obbligatorio No

shellProfile

Le preferenze specificate per sistema operativo da applicare all'interno delle sessioni, ad esempio le preferenze della shell, le variabili di ambiente, le directory di lavoro e l'esecuzione di più comandi all'avvio di una sessione.

Type: StringMap

: campo obbligatorio No

windows

Le preferenze della shell, le variabili di ambiente, le directory di lavoro e i comandi specificati per le sessioni sulle istanze di Windows.

Type: Stringa

: campo obbligatorio No

linux

Le preferenze della shell, le variabili di ambiente, le directory di lavoro e i comandi specificati per le sessioni su istanze Linux.

Type: Stringa

: campo obbligatorio No

parameters

Un oggetto che definisce i parametri accettati dal documento. Per ulteriori informazioni sulla definizione dei parametri del documento, consultaParametrinellaElementi di primo livello. Per i parametri a cui fai spesso riferimento, è consigliabile archiviare questi parametri in Systems ManagerParameter Storee quindi fare riferimento a loro. Puoi fare riferimento ai parametri Parameter Store String e StringList in questa sezione di un documento. Puoi fare riferimento ai parametri Parameter Store SecureString in questa sezione di un documento. È possibile fare riferimento a unParameter StoreUtilizzando il formato seguente.

{{ssm:parameter-name}}

Per ulteriori informazioni su Parameter Store, consulta AWS Systems Manager Parameter Store.

Type: StringMap

: campo obbligatorio No

properties

Un oggetto di cui si specificano i valori utilizzati nella proprietàStartSessionOperazione API.

Per i documenti di sessione utilizzati perInteractiveCommands, l'oggetto properties include i comandi da eseguire nei sistemi operativi specificati. Per ulteriori informazioni, consultaLimitazione dell'accesso ai comandi in una sessione.

Per i documenti di sessione utilizzati perPortsessioni, l'oggetto properties contiene il numero di porta a cui il traffico deve essere reindirizzato. Per un esempio, consulta l'PortEsempio di documento Session più avanti in questo argomento.

Type: StringMap

: campo obbligatorio No

Standard_StreamEsempio di documento di sessione

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' 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", "shellProfile": { "windows": "date", "linux": "pwd;ls" } } }

InteractiveCommandsEsempio di documento di sessione

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 } } }

PortEsempio di documento di sessione

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 } } }