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à.
Documentazione di riferimento del plugin per i documenti di comando
Questo riferimento descrive i plugin che è possibile specificare in un documento di tipo Command AWS Systems Manager (SSM). Questi plugin non possono essere utilizzati nei runbook Automation SSM che usano operazioni di Automation. Per informazioni sulle azioni di AWS Systems Manager automazione, vedere. Riferimento alle operazioni del servizio di automazione di Systems Manager
Systems Manager determina le operazioni da eseguire su un'istanza gestita mediante la lettura dei contenuti di un documento SSM. Ogni documento include una sezione di esecuzione di codice. A seconda della versione dello schema del documento, questa sezione di esecuzione di codice può includere uno o più plugin o fasi. Ai fini di questo argomento della Guida, i plugin e le fasi sono chiamati plugin. Questa sezione include informazioni su ciascun plugin di Systems Manager. Per ulteriori informazioni sui documenti, incluse informazioni sulla creazione di documenti e sulle differenze tra le versioni dello schema, consulta Documenti di AWS Systems Manager.
Nota
Alcuni dei plugin qui descritti funzionano solo su entrambi Windows Server istanze o istanze Linux. Sono riportate le dipendenze della piattaforma per ogni plugin.
I seguenti plug-in per documenti sono supportati sulle istanze Amazon Elastic Compute Cloud EC2 (Amazon) per macOS:
-
aws:refreshAssociation
-
aws:runShellScript
-
aws:runPowerShellScript
-
aws:softwareInventory
-
aws:updateSsmAgent
Indice
Input condivisi
Con SSM Agent Solo nella versione 3.0.502 e successive, tutti i plugin possono utilizzare i seguenti input:
- finallyStep
-
L'ultimo passaggio è l'esecuzione del documento. Se questo input è definito per un passaggio, ha la precedenza su un valore
exit
specificato negli inputonFailure
oonSuccess
. Affinché un passaggio con questo input sia eseguito come previsto, il passaggio deve essere l'ultimo definito nelmainSteps
del documento.Tipo: Booleano
Valori validi:
true
|false
Campo obbligatorio: no
- onFailure
-
Se si specifica questo input per un plugin con il valore
exit
e il passaggio non riesce, lo stato del passaggio riflette l'errore e il documento non esegue i passaggi rimanenti a meno che non sia stato definito unfinallyStep
. Se si specifica questo input per un plugin con il valoresuccessAndExit
e il passaggio non riesce, lo stato del passaggio riflette l'errore e il documento non esegue i passaggi rimanenti a meno che non sia stato definito unfinallyStep
.Tipo: stringa
Valori validi:
exit
|successAndExit
Campo obbligatorio: no
- onSuccess
-
Se si specifica questo input per un plugin e il passaggio viene eseguito correttamente, il documento non esegue i passaggi rimanenti a meno che non sia stato definito un
finallyStep
.Tipo: stringa
Valori validi:
exit
Campo obbligatorio: no
aws:applications
Installa, ripara o disinstalla applicazioni su un'istanza. EC2 Questo plugin funziona solo su Windows Server sistemi operativi.
Sintassi
Schema 2.2
Schema 1.2
Proprietà
- action
-
L'operazione da eseguire.
Tipo: Enum
Valori validi:
Install
|Repair
|Uninstall
Campo obbligatorio: sì
- parametri
-
I parametri per il programma di installazione.
Tipo: string
Campo obbligatorio: no
- source
-
L'URL del file
.msi
per l'applicazione.Tipo: stringa
Campo obbligatorio: sì
- sourceHash
-
L' SHA256 hash del
.msi
file.Tipo: string
Campo obbligatorio: no
aws:cloudWatch
Esporta dati da Windows Server su Amazon CloudWatch o Amazon CloudWatch Logs e monitora i dati utilizzando i CloudWatch parametri. Questo plugin funziona solo su Windows Server sistemi operativi. Per ulteriori informazioni sulla configurazione CloudWatch dell'integrazione con Amazon Elastic Compute Cloud EC2 (Amazon), consulta Raccolta di metriche, log e tracce con l'agente CloudWatch nella Amazon User Guide. CloudWatch
Importante
L'agente unificato è stato sostituito CloudWatch SSM Agent come strumento per inviare dati di registro ad Amazon CloudWatch Logs. Il SSM Agent AWS: il plug-in CloudWatch non è supportato. Ti consigliamo di utilizzare solo l' CloudWatch agente unificato per i processi di raccolta dei log. Per ulteriori informazioni, consulta i seguenti argomenti:
Puoi esportare e monitorare i seguenti tipi di dati:
- ApplicationEventLog
-
Invia i dati del registro degli eventi dell'applicazione a CloudWatch Logs.
- CustomLogs
-
Invia qualsiasi file di registro basato su testo ad Amazon CloudWatch Logs. Il CloudWatch plug-in crea un'impronta digitale per i file di registro. Quindi, il sistema associa un offset dei dati con ciascun ID digitale. Il plugin carica i file quando sono presenti modifiche, registra l'offset e lo associa a un ID digitale. Questo metodo viene utilizzato per evitare una situazione in cui un utente attiva il plugin, associa il servizio a una directory che contiene un numero elevato di file e il sistema carica tutti i file.
avvertimento
Se l'applicazione tronca o tenta di eliminare i log durante il polling, qualsiasi log specificato per
LogDirectoryPath
può perdere voci. Se, ad esempio, desideri limitare le dimensioni del file di log, devi creare un nuovo file di log quando viene raggiunto il limite, quindi devi continuare a scrivere i dati sul nuovo file. - ETW
-
Invia i dati di Event Tracing for Windows (ETW) ai registri. CloudWatch
- IIS
-
Invia i dati di registro IIS ai registri. CloudWatch
- PerformanceCounter
-
Invia i contatori delle prestazioni di Windows a. CloudWatch Puoi selezionare diverse categorie in cui caricare CloudWatch come metriche. Per ogni contatore delle prestazioni che desideri caricare, crea una PerformanceCountersezione con un ID univoco (ad esempio, "PerformanceCounter2"," PerformanceCounter 3" e così via) e configurane le proprietà.
Nota
Se il AWS Systems Manager SSM Agent oppure il CloudWatch plug-in è interrotto, i dati del contatore delle prestazioni non vengono registrati. CloudWatch Questo comportamento è diverso rispetto ai log personalizzati o ai log di eventi di Windows. I registri personalizzati e i registri degli eventi di Windows conservano i dati del contatore delle prestazioni e li caricano in seguito CloudWatch SSM Agent oppure il CloudWatch plugin è disponibile.
- SecurityEventLog
-
Invia i dati del registro degli eventi di sicurezza a CloudWatch Logs.
- SystemEventLog
-
Invia i dati del registro degli eventi di sistema ai CloudWatch registri.
Puoi definire le seguenti destinazioni per i dati:
- CloudWatch
-
La destinazione in cui vengono inviati i dati dei parametri del contatore delle prestazioni. È possibile aggiungere altre sezioni con caratteri univoci IDs (ad esempio, "CloudWatch2", CloudWatch 3" e così via) e specificare una regione diversa per ogni nuovo ID per inviare gli stessi dati a posizioni diverse.
- CloudWatchLogs
-
La destinazione in cui vengono inviati i dati di log. Puoi aggiungere altre sezioni con un valore univoco IDs (ad esempio, "CloudWatchLogs2", CloudWatchLogs 3" e così via) e specificare una regione diversa per ogni nuovo ID per inviare gli stessi dati a posizioni diverse.
Sintassi
"runtimeConfig":{ "aws:cloudWatch":{ "settings":{ "startType":"{{ status }}" }, "properties":"{{ properties }}" } }
Impostazioni e proprietà
- AccessKey
-
L'ID chiave di accesso . Questa proprietà è obbligatoria, a meno che l'utente non abbia avviato l'istanza usando un ruolo IAM. Questa proprietà non può essere utilizzata con SSM.
Tipo: string
Campo obbligatorio: no
- CategoryName
-
La categoria del contatore delle prestazioni da Performance Monitor.
Tipo: stringa
Campo obbligatorio: sì
- CounterName
-
Il nome del contatore delle prestazioni da Performance Monitor.
Tipo: stringa
Campo obbligatorio: sì
- CultureName
-
L'impostazione locale in cui viene registrato il timestamp. Se CultureNameè vuoto, il valore predefinito è lo stesso locale usato dal tuo Windows Server istanza.
Tipo: stringa
Valori validi: per un elenco dei valori supportati, consulta National Language Support (NLS)
sul sito Web Microsoft. I valori div, div-MV, hu e hu-HU non sono supportati. Campo obbligatorio: no
- DimensionName
-
Una dimensione per la tua CloudWatch metrica Amazon. Se specifichi
DimensionName
, devi specificareDimensionValue
. Questi parametri forniscono un'altra vista al momento della creazione di elenchi di parametri. Puoi utilizzare la stessa dimensione per più parametri per poter visualizzare tutti i parametri appartenenti a una dimensione specifica.Tipo: string
Campo obbligatorio: no
- DimensionValue
-
Un valore dimensionale per la tua CloudWatch metrica Amazon.
Tipo: string
Campo obbligatorio: no
- Encoding
-
La codifica del file da utilizzare (ad esempio, UTF-8). Utilizza il nome di codifica, non il nome di visualizzazione.
Tipo: stringa
Valori validi: per un elenco dei valori supportati, consulta l'argomento relativo alla classe di codifica
nella libreria di Microsoft Learn. Campo obbligatorio: sì
- Filtro
-
Il prefisso dei nomi di log. Lascia questo parametro bianco per monitorare tutti i file.
Tipo: stringa
Valori validi: per un elenco dei valori supportati, consulta la FileSystemWatcherFilter proprietà
nella libreria MSDN. Campo obbligatorio: no
- Flows
-
Ogni tipo di dati da caricare, insieme alla destinazione dei dati (CloudWatch o dei CloudWatch registri). Ad esempio, per inviare un contatore delle prestazioni definito in
"Id": "PerformanceCounter"
alla CloudWatch destinazione definita in"Id": "CloudWatch"
, inserisci CloudWatch"PerformanceCounter,». Analogamente, per inviare il registro personalizzato, il registro ETW e il registro di sistema alla destinazione dei CloudWatch registri definita in"Id": "ETW"
, immettete «(ETW),". CloudWatchLogs Inoltre, puoi inviare lo stesso contatore delle prestazioni o file di log a più destinazioni. Ad esempio, per inviare il registro dell'applicazione a due diverse destinazioni definite in"Id": "CloudWatchLogs"
e"Id": "CloudWatchLogs2"
, immettete ", (ApplicationEventLogCloudWatchLogs, CloudWatchLogs 2)».Tipo: stringa
Valori validi (origine):
ApplicationEventLog
|CustomLogs
|ETW
|PerformanceCounter
|SystemEventLog
|SecurityEventLog
Valori validi (destinazione):
CloudWatch
|CloudWatchLogs
|CloudWatch
n
|CloudWatchLogs
n
Campo obbligatorio: sì
- FullName
-
Il nome completo del componente.
Tipo: stringa
Campo obbligatorio: sì
- Id
-
Identifica l'origine o la destinazione dei dati. Questo identificatore deve essere univoco all'interno del file di configurazione.
Tipo: stringa
Campo obbligatorio: sì
- InstanceName
-
Il nome dell'istanza del contatore delle prestazioni. Non utilizzare un asterisco (*) per indicare tutte le istanze perché ciascun componente del contatore delle prestazioni supporta solo un parametro. Tuttavia, puoi utilizzare _Total.
Tipo: stringa
Campo obbligatorio: sì
- Levels
-
I tipi di messaggi da inviare ad Amazon CloudWatch.
Tipo: stringa
Valori validi:
-
1 - Solo i messaggi di errore caricati.
-
2 - Solo i messaggi di avviso caricati.
-
4 - Solo i messaggi informativi caricati.
È possibile aggiungere valori per includere più di un tipo di messaggio. Ad esempio, 3 indica che i messaggi di errore (1) e i messaggi di avviso (2) sono inclusi. Un valore pari a 7 indica che i messaggi di errore (1), i messaggi di avviso (2) e i messaggi informativi (4) sono inclusi.
Campo obbligatorio: sì
Nota
I log di sicurezza di Windows dovrebbero impostare livelli fino a 7.
-
- LineCount
-
Il numero di righe dell'intestazione per identificare il file di log. Ad esempio, i file di log IIS dispongono di intestazioni praticamente identiche. Puoi inserire 3, che può leggere le prime tre righe dell'intestazione del file di log per identificarlo. Nei file di log IIS, la terza riga è costituita dalla data e dal timestamp, che è diverso tra i file di log.
Tipo: integer
Campo obbligatorio: no
- LogDirectoryPath
-
Per CustomLogs, il percorso in cui vengono archiviati i log sulla tua EC2 istanza. Per i registri IIS, la cartella in cui sono archiviati i registri IIS per un singolo sito (ad esempio, C:\\ inetpub\\ logs\\\\ W3SVC). LogFiles
n
Per i log di IIS, è supportato solo il formato di log W3C. I formati IIS, NCSA e quelli personalizzati non sono supportati.Tipo: stringa
Campo obbligatorio: sì
- LogGroup
-
Nome del gruppo di log. Questo nome viene visualizzato sulla schermata Log Groups (Gruppi di log) nella console CloudWatch.
Tipo: stringa
Campo obbligatorio: sì
- LogName
-
Nome del file di log.
-
Per individuare il nome del log , in Event Viewer (Visualizzatore eventi), nel riquadro di navigazione, scegli Applications and Services Logs (Log di applicazioni e servizi).
-
Nell'elenco dei registri, fai clic con il pulsante destro del mouse sul log che desideri caricare (ad esempio, Microsoft>Windows>Backup>Operativo), quindi seleziona Create Custom View (Crea visualizzazione personalizzata).
-
Nella finestra di dialogo Create Custom View (Crea visualizzazione personalizzata), scegliere la scheda XML. LogNameSi trova nel tag <Select Path=> (ad esempio,).
Microsoft-Windows-Backup
Copia questo testo nel parametro. LogName
Tipo: stringa
Valori validi:
Application
|Security
|System
|Microsoft-Windows-WinINet/Analytic
Campo obbligatorio: sì
-
- LogStream
-
Il flusso di log di destinazione. Se utilizzi {instance_id}, il valore predefinito, l'ID di questa istanza viene utilizzato come nome del flusso di log.
Tipo: stringa
Valori validi:
{instance_id}
|{hostname}
|{ip_address}
<log_stream_name>
Se inserisci un nome di log stream che non esiste già, CloudWatch Logs lo crea automaticamente per te. Puoi utilizzare una stringa letterale o variabili predefinite ({instance_id}, {hostname}, {ip_address}) o una combinazione di tutte e tre per definire un nome di flusso di log.
Il nome del flusso di log specificato in questo parametro viene visualizzato nella
<YourLogStream>
schermata Log Groups > Streams for della CloudWatch console.Campo obbligatorio: sì
- MetricName
-
La CloudWatch metrica in cui desideri includere i dati sulle prestazioni.
Nota
Non utilizzare caratteri speciali nel nome. In caso contrario, il parametro e gli allarmi associati potrebbero non funzionare.
Tipo: stringa
Campo obbligatorio: sì
- NameSpace
-
Il namespace parametro in cui desideri che vengano scritti i dati dei contatori delle prestazioni.
Tipo: stringa
Campo obbligatorio: sì
- PollInterval
-
Il numero di secondi che devono trascorrere prima che un nuovo contatore delle prestazioni e i dati di log vengano caricati.
Tipo: integer
Valori validi: imposta questo valore su 5 o più secondi. Quindici secondi (00:00:15) è il valore consigliato.
Campo obbligatorio: sì
- Regione
-
Regione AWS Dove vuoi inviare i dati di registro. Sebbene possa inviare contatori delle prestazioni a una regione diversa rispetto a quella a cui invii i dati di log, è consigliabile impostare questo parametro sulla stessa regione in cui l'istanza è in esecuzione.
Tipo: stringa
Valori validi: aree IDs Regioni AWS supportate sia da Systems Manager che da CloudWatch Logs, ad esempio
us-east-2
eu-west-1
, eap-southeast-1
. Per gli elenchi degli endpoint del servizio Regioni AWS supportati da ciascun servizio, consulta Amazon CloudWatch Logs Service Endpoints and Systems Manager nel. Riferimenti generali di Amazon Web ServicesCampo obbligatorio: sì
- SecretKey
-
La chiave di accesso segreta . Questa proprietà è obbligatoria, a meno che l'utente non abbia avviato l'istanza usando un ruolo IAM.
Tipo: string
Campo obbligatorio: no
- startType
-
Attiva o disattiva l'istanza CloudWatch .
Tipo: stringa
Valori validi:
Enabled
|Disabled
Campo obbligatorio: sì
- TimestampFormat
-
Il formato del timestamp che desideri utilizzare. Per un elenco dei valori supportati, consulta l'argomento Stringhe di formato di data e ora personalizzato
nella libreria MSDN. Tipo: stringa
Campo obbligatorio: sì
- TimeZoneKind
-
Fornisce le informazioni sul fuso orario se non sono incluse nel timestamp del log. Se questo parametro viene lasciato vuoto e se il timestamp non include informazioni sul fuso orario, CloudWatch Logs utilizza per impostazione predefinita il fuso orario locale. Questo parametro viene ignorato se il timestamp contiene già informazioni sul fuso orario.
Tipo: stringa
Valori validi:
Local
|UTC
Campo obbligatorio: no
- Unità
-
L'unità di misura appropriata per il parametro.
Tipo: stringa
Valori validi: Secondi | Microsecondi | Millisecondi | Byte | Kilobyte | Megabyte | Gigabyte | Terabyte | Bit | Kilobit | Megabit | Gigabit | Terabit | Percentuale | Numero | Nessuno Bytes/Second | Kilobytes/Second | Megabytes/Second | Gigabytes/Second | Terabytes/Second | Bits/Second | Kilobits/Second | Megabits/Second | Gigabits/Second | Terabits/Second | Count/Second
Campo obbligatorio: sì
aws:configureDocker
(Versione dello schema 2.0 o successiva) Configura un'istanza da utilizzare con contenitori e Docker. Questo plugin è supportato sulla maggior parte delle varianti di Linux e Windows Server sistemi operativi.
Sintassi
Schema 2.2
Input
- action
-
Il tipo di operazione da eseguire.
Tipo: Enum
Valori validi:
Install
|Uninstall
Campo obbligatorio: sì
aws:configurePackage
(Schema versione 2.0 o successiva) Installare o disinstallare un AWS Systems Manager Distributor pacchetto. Puoi installare la versione più recente, la versione predefinita o una versione del pacchetto specificata. Sono supportati anche AWS i pacchetti forniti da. Questo plugin funziona su Windows Server e sistemi operativi Linux, ma non tutti i pacchetti disponibili sono supportati sui sistemi operativi Linux.
AWS Pacchetti disponibili per Windows Server includono quanto segue: AWSPVDriver
AWSNVMe
,AwsEnaNetworkDriver
,AwsVssComponents
,AmazonCloudWatchAgent
,CodeDeployAgent
, e AWSSupport-EC2Rescue.
AWS I pacchetti disponibili per i sistemi operativi Linux includono quanto segue:AmazonCloudWatchAgent
,CodeDeployAgent
, eAWSSupport-EC2Rescue
.
Sintassi
Schema 2.2
Input
- nome
-
Il nome del AWS pacchetto da installare o disinstallare. I pacchetti disponibili includono:
AWSPVDriver
,AwsEnaNetworkDriver
,AwsVssComponents
eAmazonCloudWatchAgent
.Tipo: stringa
Campo obbligatorio: sì
- action
-
Installa o disinstalla un pacchetto.
Tipo: Enum
Valori validi:
Install
|Uninstall
Campo obbligatorio: sì
- Tipo di installazione
-
Il tipo di installazione da eseguire. Se si specifica
Uninstall and reinstall
, il pacchetto viene completamente disinstallato e quindi reinstallato. L'applicazione non è disponibile fino al completamento della reinstallazione. Se si specificaIn-place update
, solo i file nuovi o modificati vengono aggiunti all'installazione esistente in base alle istruzioni fornite in uno script di aggiornamento. L'applicazione rimane disponibile durante tutto il processo di aggiornamento. L'In-place update
opzione non è supportata per i pacchetti AWS-published.Uninstall and reinstall
è il valore predefinito.Tipo: Enum
Valori validi:
Uninstall and reinstall
|In-place update
Campo obbligatorio: no
- additionalArguments
-
Una stringa JSON di parametri aggiuntivi da fornire agli script di installazione, disinstallazione o aggiornamento. Ogni parametro deve essere preceduto da
SSM_
. È possibile fare riferimento a Parameter Store parametro negli argomenti aggiuntivi utilizzando la convenzione{{ssm:
. Per utilizzare il parametro aggiuntivo nello script di installazione, disinstallazione o aggiornamento, è necessario fare riferimento al parametro come variabile di ambiente utilizzando la sintassi appropriata per il sistema operativo. Ad esempio, in PowerShell, si fa riferimento all'parameter-name
}}SSM_arg
argomento come$Env:SSM_arg
. Non vi è alcun limite al numero di argomenti definiti, ma l'input dell'argomento aggiuntivo ha un limite di 4096 caratteri. Questo limite include tutte le chiavi e i valori definiti.Tipo: StringMap
Campo obbligatorio: no
- version
-
Una versione specifica del pacchetto da installare o disinstallare. In caso di installazione, il sistema installa per impostazione predefinita l'ultima versione pubblicata. In caso di disinstallazione, il sistema disinstalla per impostazione predefinita la versione attualmente installata. Se non viene trovata nessuna versione installata, viene scaricata l'ultima versione pubblicata e viene eseguita l'operazione di disinstallazione.
Tipo: string
Campo obbligatorio: no
aws:domainJoin
Unisci un' EC2 istanza a un dominio. Questo plugin funziona su Linux e Windows Server sistemi operativi. Questo plugin modifica il nome host per le istanze Linux nel formato EC2 AMAZ-. XXXXXXX
Per ulteriori informazioni sull'aggiunta di EC2 istanze, consulta Aggiungere un' EC2 istanza alla directory AWS gestita di Microsoft AD nella Guida all'AWS Directory Service amministrazione.
Sintassi
Schema 2.2
Schema 1.2
Proprietà
- directoryId
-
L'ID della directory.
Tipo: stringa
Campo obbligatorio: sì
Esempio: "directoryId": "d-1234567890"
- directoryName
-
Il nome del dominio.
Tipo: stringa
Campo obbligatorio: sì
Esempio: "directoryName": "example.com"
- directoryOU
-
L'unità organizzativa (OU).
Tipo: string
Campo obbligatorio: no
Esempio: "directoryOU": "OU=test,DC=example,DC=com"
- dnsIpAddresses
-
Gli indirizzi IP dei server DNS.
Tipo: StringList
Campo obbligatorio: sì
Esempio: "dnsIpAddresses«: [" 198.51.100.1", "198.51.100.2"]
- hostname
-
Il nome host che si desidera assegnare al nodo.
Tipo: string
Campo obbligatorio: no
- keepHostName
-
Determina se il nome host viene modificato per le istanze Linux quando vengono aggiunte al dominio.
Tipo: Booleano
Campo obbligatorio: no
Esempi
Ad esempio, consulta Aggiungere un' EC2 istanza Amazon alla tua AWS Managed Microsoft AD nella Guida all'AWS Directory Service amministrazione.
aws:downloadContent
(Versione dello schema 2.0 o successiva) Scaricare documenti e script SSM da posizioni remote. GitHub Enterprise i repository non sono supportati. Questo plugin è supportato su Linux e Windows Server sistemi operativi.
Sintassi
Schema 2.2
Input
- sourceType
-
Origine del download Systems Manager supporta i seguenti tipi di origine per il download di script e di documenti SSM:
GitHub
,Git
,HTTP
,S3
eSSMDocument
.Tipo: stringa
Campo obbligatorio: sì
- sourceInfo
-
Le informazioni necessarie per recuperare il contenuto dall'origine richiesta.
Tipo: StringMap
Campo obbligatorio: sì
Per sourceType
GitHub,
, specificare quanto segue:-
owner: il proprietario del repository.
-
repository: il nome del repository.
-
path: il percorso del file o della directory che desideri scaricare.
-
getOptions: opzioni aggiuntive per recuperare il contenuto da un ramo diverso dal master o da un commit specifico nel repository. getOptions può essere omesso se si utilizza l'ultimo commit nel ramo master. Se il repository è stato creato dopo il 1° ottobre 2020, il ramo predefinito potrebbe essere denominato main anziché master. In questo caso, si dovranno specificare i valori per il parametro getOptions.
Questo parametro utilizza il seguente formato:
-
ramo: refs/heads/
branch_name
Il valore predefinito è
master
.Per specificare un ramo non predefinito, utilizza il formato seguente:
ramo:refs/heads/
branch_name
-
CommitID:
commitID
Il valore predefinito è
head
.Per utilizzare la versione del documento SSM in un commit diverso da quello più recente, specificare l'ID di commit completo. Per esempio:
"getOptions": "commitID:bbc1ddb94...b76d3bEXAMPLE",
-
-
TokenInfo: il parametro Systems Manager ( SecureStringun parametro) in cui memorizzi il GitHub informazioni sul token di accesso, nel formato.
{{ssm-secure:
secure-string-token-name
}}Nota
Questo
tokenInfo
campo è l'unico campo del plug-in di documenti SSM che supporta un SecureString parametro. SecureString i parametri non sono supportati per nessun altro campo, né per altri plugin di documenti SSM.
{ "owner":"TestUser", "repository":"
GitHubTest
", "path":"scripts/python/test-script
", "getOptions":"branch:master", "tokenInfo":"{{ssm-secure:secure-string-token
}}" }Per sourceType
Git
, si deve specificare quanto segue:-
repository
L'URL del repository Git relativo al file o alla directory che si desidera scaricare.
Tipo: stringa
Inoltre, è possibile specificare i seguenti parametri facoltativi:
-
getOptions
Opzioni aggiuntive per recuperare il contenuto da un ramo diverso dal master o da un commit specifico nel repository. getOptions può essere omesso se si utilizza l'ultimo commit nel ramo master.
Tipo: stringa
Questo parametro utilizza il seguente formato:
-
ramo: refs/heads/
branch_name
Il valore predefinito è
master
."branch"
è necessario solo se il documento SSM è memorizzato in un ramo diverso damaster
. Per esempio:"getOptions": "branch:refs/heads/main"
-
CommitID:
commitID
Il valore predefinito è
head
.Per utilizzare la versione del documento SSM in un commit diverso da quello più recente, specificare l'ID di commit completo. Per esempio:
"getOptions": "commitID:bbc1ddb94...b76d3bEXAMPLE",
-
-
privato SSHKey
La chiave SSH da usare durante la connessione al
repository
specificato. È possibile utilizzare il formato seguente per riferirsi a un parametroSecureString
per il valore della chiave SSH:{{ssm-secure:
.your-secure-string-parameter
}}Tipo: stringa
-
skipHostKeyControllando
Determina il valore dell' StrictHostKeyCheckingopzione quando ci si
repository
connette all'indirizzo specificato. Il valore predefinito èfalse
.Tipo: Booleano
-
username
Il nome utente da usare durante la connessione al
repository
specificato utilizzando HTTP. È possibile utilizzare il formato seguente per riferirsi a un parametroSecureString
per il valore del nome utente:{{ssm-secure:
.your-secure-string-parameter
}}Tipo: stringa
-
password
La password da usare durante la connessione al
repository
specificato utilizzando HTTP. È possibile utilizzare il formato seguente per riferirsi a un parametroSecureString
per il valore della password:{{ssm-secure:
.your-secure-string-parameter
}}Tipo: stringa
Per sourceType
HTTP
, si deve specificare quanto segue:-
url
L'URL del file o della directory che si desidera scaricare.
Tipo: stringa
Inoltre, è possibile specificare i seguenti parametri facoltativi:
-
allowInsecureDownload
Determina se è possibile eseguire un download tramite una connessione non crittografata con Secure Socket Layer (SSL) o Transport Layer Security (TLS). Il valore predefinito è
false
. Si sconsiglia l'esecuzione di download senza crittografia. Se si sceglie di farlo, si assumono tutti i relativi rischi. La sicurezza è una responsabilità condivisa tra te AWS e te. Questo è descritto come il modello di responsabilità condivisa. Per ulteriori informazioni, consulta il modello di responsabilità condivisa. Tipo: Booleano
-
authMethod
Determina se un nome utente e una password vengono utilizzati per l'autenticazione durante la connessione all'
url
specificato. Se si specificaBasic
oDigest
, è necessario fornire valori per i parametriusername
epassword
. Per utilizzare ilDigest
metodo, SSM Agent la versione 3.0.1181.0 o successiva deve essere installata sull'istanza. IlDigest
metodo supporta la crittografia. MD5 SHA256Tipo: stringa
Valori validi:
None
|Basic
|Digest
-
username
Il nome utente da usare durante la connessione all'
url
specificato utilizzando l'autenticazioneBasic
. È possibile utilizzare il formato seguente per riferirsi a un parametroSecureString
per il valore del nome utente:{{ssm-secure:
.your-secure-string-parameter
}}Tipo: stringa
-
password
La password da usare durante la connessione all'
url
specificato utilizzando l'autenticazioneBasic
. È possibile utilizzare il formato seguente per riferirsi a un parametroSecureString
per il valore della password:{{ssm-secure:
.your-secure-string-parameter
}}Tipo: stringa
Per sourceType
S3
, specificare quanto segue:-
path: l'URL del file o della directory che si desidera scaricare da Amazon S3.
{ "path": "https://s3.amazonaws.com/
amzn-s3-demo-bucket
/powershell/helloPowershell.ps1" }Per sourceType
SSMDocument
, specificare uno dei seguenti valori:-
name: il nome e la versione del documento nel formato seguente:
name:version
. La versione è facoltativa.{ "name": "Example-RunPowerShellScript:3" }
-
name: l'ARN del documento nel seguente formato:
arn:aws:ssm:
region
:account_id
:document/document_name
{ "name":"arn:aws:ssm:us-east-2:3344556677:document/MySharedDoc" }
-
- destinationPath
-
Un percorso locale facoltativo nell'istanza in cui desideri scaricare il file. Se non specifichi un percorso, i contenuti vengono scaricati in un percorso relativo al tuo ID comando.
Tipo: string
Campo obbligatorio: no
aws:psModule
Installa PowerShell i moduli su un' EC2 istanza Amazon. Questo plugin funziona solo su Windows Server sistemi operativi.
Sintassi
Schema 2.2
Schema 1.2
Proprietà
- runCommand
-
Il PowerShell comando da eseguire dopo l'installazione del modulo.
Tipo: StringList
Campo obbligatorio: no
- source
-
L'URL o il percorso locale nell'istanza al file
.zip
dell'applicazione.Tipo: stringa
Campo obbligatorio: sì
- sourceHash
-
L' SHA256 hash del
.zip
file.Tipo: string
Campo obbligatorio: no
- timeoutSeconds
-
Il tempo in secondi entro cui un comando deve essere portato a termine prima di essere considerato non riuscito.
Tipo: string
Campo obbligatorio: no
- workingDirectory
-
Il percorso alla directory di lavoro nell'istanza.
Tipo: string
Campo obbligatorio: no
aws:refreshAssociation
(Versione dello schema 2.0 o successiva) Aggiorna (applicazione di forza) un'associazione on demand. Questa operazione modificherà lo stato del sistema in base a quanto definito nell'associazione selezionata o in tutte le associazioni dei target. Questo plugin funziona su Linux e Microsoft Windows Server sistemi operativi.
Sintassi
Schema 2.2
Input
- associationIds
-
Elenco delle associazioni IDs. Se vuoto, vengono applicate tutte le associazioni ai target specificati.
Tipo: StringList
Campo obbligatorio: no
aws:runDockerAction
(Versione dello schema 2.0 o successiva) Esegui operazioni Docker sui contenitori. Questo plugin funziona su Linux e Microsoft Windows Server sistemi operativi.
Sintassi
Schema 2.2
Input
- action
-
Il tipo di operazione da eseguire.
Tipo: stringa
Campo obbligatorio: sì
- container
-
L'ID del container Docker.
Tipo: string
Campo obbligatorio: no
- image
-
Il nome dell'immagine Docker.
Tipo: string
Campo obbligatorio: no
- cmd
-
Il comando del container.
Tipo: string
Campo obbligatorio: no
- memory
-
Il limite di memoria del container.
Tipo: string
Campo obbligatorio: no
- cpuShares
-
Le condivisioni di CPU del container (peso relativo).
Tipo: string
Campo obbligatorio: no
- volume
-
I montaggi dei volumi del container.
Tipo: StringList
Campo obbligatorio: no
- env
-
Le variabili di ambiente del container.
Tipo: string
Campo obbligatorio: no
- Utente
-
Il nome dell'utente del container.
Tipo: string
Campo obbligatorio: no
- pubblicazione
-
Le porte pubblicate del container.
Tipo: string
Campo obbligatorio: no
aws:runDocument
(Versione dello schema 2.0 o successiva) Esegue documenti SSM archiviati in Systems Manager o in una condivisione locale. È possibile utilizzare questo plugin con il plugin aws:downloadContent per scaricare un documento SSM da una posizione remota a una condivisione locale, quindi eseguirlo. Questo plugin è supportato su Linux e Windows Server sistemi operativi. Questo plug-in non supporta l'esecuzione del documento AWS-UpdateSSMAgent
o qualsiasi documento che utilizza il plugin aws:updateSsmAgent
.
Sintassi
Schema 2.2
Input
- documentType
-
Il tipo di documento da eseguire. È possibile eseguire documenti locali (
LocalPath
) o documenti archiviati in Systems Manager (SSMDocument
).Tipo: stringa
Campo obbligatorio: sì
- documentPath
-
Il percorso del documento. Se
documentType
èLocalPath
, specifica il percorso al documento nella condivisione locale. SedocumentType
èSSMDocument
, specifica il nome del documento.Tipo: string
Campo obbligatorio: no
- documentParameters
-
I parametri per il documento.
Tipo: StringMap
Campo obbligatorio: no
aws:runPowerShellScript
Esegui PowerShell script o specifica il percorso di uno script da eseguire. Questo plugin funziona su Microsoft Windows Server e sistemi operativi Linux.
Sintassi
Schema 2.2
Schema 1.2
Proprietà
- runCommand
-
Specifica i comandi da eseguire o il percorso a uno script esistente nell'istanza.
Tipo: StringList
Campo obbligatorio: sì
- timeoutSeconds
-
Il tempo in secondi entro cui un comando deve essere portato a termine prima di essere considerato non riuscito. Quando viene raggiunto il timeout, Systems Manager interrompe l'esecuzione del comando.
Tipo: string
Campo obbligatorio: no
- workingDirectory
-
Il percorso alla directory di lavoro nell'istanza.
Tipo: string
Campo obbligatorio: no
aws:runShellScript
Esegui script di shell Linux o specifica il percorso a uno script da eseguire. Questo plugin può essere eseguito solo su sistemi operativi Linux.
Sintassi
Schema 2.2
Schema 1.2
Proprietà
- runCommand
-
Specifica i comandi da eseguire o il percorso a uno script esistente nell'istanza.
Tipo: StringList
Campo obbligatorio: sì
- timeoutSeconds
-
Il tempo in secondi entro cui un comando deve essere portato a termine prima di essere considerato non riuscito. Quando viene raggiunto il timeout, Systems Manager interrompe l'esecuzione del comando.
Tipo: string
Campo obbligatorio: no
- workingDirectory
-
Il percorso alla directory di lavoro nell'istanza.
Tipo: string
Campo obbligatorio: no
aws:softwareInventory
(Versione dello schema 2.0 o successiva) è possibile ottenere i metadati su applicazioni, file e configurazioni sulle istanze gestite. Questo plugin funziona su Linux e Microsoft Windows Server sistemi operativi. Quando si configura la raccolta dell'inventario, si inizia con la creazione di un AWS Systems Manager State Manager associazione. Systems Manager raccoglie i dati dell'inventario quando viene eseguita l'associazione. Se non si crea prima l'associazione e si tenta di richiamare il plugin aws:softwareInventory
, il sistema restituisce il seguente errore:
The aws:softwareInventory
plugin can only be invoked via ssm-associate.
Un'istanza può avere una sola associazione di Inventory configurata alla volta. Se configuri un'istanza con due o più associazioni, l'associazione di Inventory non viene eseguita e non viene raccolto alcun dato dell'inventario. Per ulteriori informazioni sulla raccolta dell'inventario, consulta AWS Systems Manager Inventory.
Sintassi
Schema 2.2
Inputs
- applications
-
(Facoltativo) Consente di raccogliere i metadati per le applicazioni installate.
Tipo: string
Campo obbligatorio: no
- awsComponents
-
(Facoltativo) Raccogli metadati per AWS componenti come amazon-ssm-agent.
Tipo: string
Campo obbligatorio: no
- files
-
(Facoltativo, richiede SSM Agent versione 2.2.64.0 o successiva) Raccogli i metadati per i file, inclusi i nomi dei file, l'ora in cui i file sono stati creati, l'ora dell'ultima modifica e dell'ultimo accesso ai file e le dimensioni dei file, solo per citarne alcuni. Per ulteriori informazioni sulla raccolta dell'inventario dei file, consulta Utilizzo dell'inventario dei file e del registro di sistema di Windows.
Tipo: string
Campo obbligatorio: no
- networkConfig
-
(Facoltativo) Consente di raccogliere i metadati relativi alle configurazioni di rete.
Tipo: string
Campo obbligatorio: no
- Informazioni di fatturazione
-
(Facoltativo) Raccogli i metadati per i dettagli della piattaforma associati al codice di fatturazione del AMI.
Tipo: string
Campo obbligatorio: no
- windowsUpdates
-
(Facoltativo) Consente di raccogliere i metadati per tutti gli aggiornamenti di Windows.
Tipo: string
Campo obbligatorio: no
- instanceDetailedInformation
-
(Facoltativo) Consente di raccogliere ulteriori informazioni sulle istanze rispetto a quelle fornite dal plugin dell'inventario predefinito (
aws:instanceInformation
), tra cui ad esempio il modello della CPU, la velocità e il numero di core.Tipo: string
Campo obbligatorio: no
- services
-
(Facoltativo, solo sistema operativo Windows, richiede SSM Agent versione 2.2.64.0 o successiva) Raccogli i metadati per le configurazioni dei servizi.
Tipo: string
Campo obbligatorio: no
- windowsRegistry
-
(Facoltativo, solo sistema operativo Windows, richiede SSM Agent versione 2.2.64.0 o successiva) Raccogli chiavi e valori del registro di Windows. È possibile scegliere un percorso chiave e raccogliere tutte le chiavi e i valori in modo ricorsivo. È possibile inoltre raccogliere una determinata chiave di registro e il relativo valore per un percorso specifico. Inventory raccoglie il percorso, il nome, il tipo e il valore delle chiave. Per ulteriori informazioni sulla raccolta dell'inventario del Registro di sistema di Windows, consulta Utilizzo dell'inventario dei file e del registro di sistema di Windows.
Tipo: string
Campo obbligatorio: no
- windowsRoles
-
(Facoltativo, solo sistema operativo Windows, richiede SSM Agent versione 2.2.64.0 o successiva) Raccogli i metadati per le configurazioni dei ruoli di Microsoft Windows.
Tipo: string
Campo obbligatorio: no
- customInventory
-
(Facoltativo) Consente di raccogliere i dati dell'inventario personalizzato. Per ulteriori informazioni sull'inventario personalizzato, consulta Utilizzo di inventari personalizzati
Tipo: string
Campo obbligatorio: no
- customInventoryDirectory
-
(Facoltativo) Raccogli dati di inventario personalizzati dalla directory specificata. Per ulteriori informazioni sull'inventario personalizzato, consulta Utilizzo di inventari personalizzati
Tipo: string
Campo obbligatorio: no
aws:updateAgent
Aggiorna il servizio EC2 Config alla versione più recente o specifica una versione precedente. Questo plugin funziona solo su Microsoft Windows Server sistemi operativi. Per ulteriori informazioni sul servizio EC2 Config, consulta Configurazione di un'istanza Windows utilizzando il servizio EC2 Config (legacy) nella Amazon User Guide. EC2
Sintassi
Schema 2.2
Schema 1.2
Proprietà
- agentName
-
EC2Config. Questo è il nome dell'agente che esegue il servizio EC2 Config.
Tipo: stringa
Campo obbligatorio: sì
- allowDowngrade
-
EC2Consenti il downgrade del servizio Config a una versione precedente. Se impostato su "false", il servizio può essere aggiornato solo a versioni più recenti (impostazione predefinita). Se impostato su "true", specifica la versione precedente.
Tipo: Booleano
Campo obbligatorio: no
- source
-
La posizione in cui Systems Manager copia la versione di EC2 Config da installare. Non puoi modificare questa posizione.
Tipo: stringa
Campo obbligatorio: sì
- targetVersion
-
Una versione specifica del servizio EC2 Config da installare. Se non è specificata, il servizio verrà aggiornato alla versione più recente.
Tipo: string
Campo obbligatorio: no
aws:updateSsmAgent
Aggiorna il SSM Agent alla versione più recente o specifica una versione precedente. Questo plugin funziona su Linux e Windows Server sistemi operativi. Per ulteriori informazioni, consulta Utilizzo di SSM Agent.
Sintassi
Schema 2.2
Schema 1.2
Proprietà
- agentName
-
amazon-ssm-agent. Questo è il nome dell'agente Systems Manager che elabora le richieste ed esegue i comandi sull'istanza.
Tipo: stringa
Campo obbligatorio: sì
- allowDowngrade
-
Consenti il SSM Agent per effettuare il downgrade a una versione precedente. Se impostato su "false", l'agente può essere aggiornato solo a versioni più recenti (impostazione predefinita). Se impostato su "true", specifica la versione precedente.
Tipo: Booleano
Campo obbligatorio: sì
- source
-
La posizione in cui Systems Manager copia il SSM Agent versione da installare. Non puoi modificare questa posizione.
Tipo: stringa
Campo obbligatorio: sì
- targetVersion
-
Una versione specifica di SSM Agent da installare. Se non è specificata, l'agente verrà aggiornato alla versione più recente.
Tipo: string
Campo obbligatorio: no