Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
Référence de plug-in de document Command
Cette référence décrit les plugins que vous pouvez spécifier dans un document de type commande AWS Systems Manager (SSM). Ces plugins ne peuvent pas être utilisés dans les runbooks SSM d'automatisation, qui utilisent des actions d'automatisation. Pour plus d'informations sur les actions AWS Systems Manager d'automatisation, consultezRéférence sur les actions Systems Manager Automation.
Systems Manager détermine les actions à effectuer sur une instance gérée en lisant le contenu d'un SSM document. Chaque document comprend une section d'exécution de code. En fonction de la version de schéma de votre document, cette section d'exécution de code peut inclure un ou plusieurs plug-ins, ou bien une ou plusieurs étapes. Dans le cadre de cette rubrique d'aide, les plug-ins et les étapes sont appelés plug-ins. Cette section comprend des informations sur chacun des plugins Systems Manager. Pour plus d'informations sur les documents, la création de documents et les différences entre les versions de schéma, consultez AWS Systems Manager Documents.
Note
Certains plug-ins décrits ici s'exécutent uniquement sur des instances Windows Server ou sur des instances Linux. Les dépendances de plate-forme sont notées pour chaque plug-in.
Les plug-ins de documents suivants sont pris en charge sur les instances Amazon Elastic Compute Cloud (AmazonEC2) pour macOS :
-
aws:refreshAssociation
-
aws:runShellScript
-
aws:runPowerShellScript
-
aws:softwareInventory
-
aws:updateSsmAgent
Table des matières
Entrées partagées
Avec SSM Agent version 3.0.502 et ultérieure uniquement, tous les plugins peuvent utiliser les entrées suivantes :
- finallyStep
-
La dernière étape que le document doit exécuter. Si cette entrée est définie pour une étape, elle a priorité sur une valeur
exit
spécifiée dans les entréesonFailure
ouonSuccess
. Pour qu'une étape avec cette entrée s'exécute comme prévu, elle doit être la dernière étape définie dans lesmainSteps
de votre document.Type : booléen
Valeurs valides :
true
|false
Obligatoire : non
- onFailure
-
Si vous spécifiez cette entrée pour un plugin avec la valeur
exit
et que l'étape échoue, le statut de l'étape reflète l'échec et le document n'exécute pas les étapes restantes sauf si unefinallyStep
a été définie. Si vous spécifiez cette entrée pour un plugin avec la valeursuccessAndExit
et que l'étape échoue, le statut de l'étape affiche la réussite et le document n'exécute pas les étapes restantes sauf si unefinallyStep
a été définie.Type : String
Valeurs valides :
exit
|successAndExit
Obligatoire : non
- onSuccess
-
Si vous spécifiez cette entrée pour un plugin et que l'étape s'exécute correctement, le document n'exécute pas les étapes restantes sauf si une
finallyStep
a été définie.Type : String
Valeurs valides :
exit
Obligatoire : non
aws:applications
Installez, réparez ou désinstallez des applications sur une EC2 instance. Ce plug-in s'exécute uniquement sur les systèmes d'exploitation Windows Server.
Syntaxe
Schéma 2.2
Schéma 1.2
Propriétés
- action
-
Action à effectuer.
Type : énumération
Valeurs valides :
Install
|Repair
|Uninstall
Obligatoire : oui
- parameters
-
Paramètres pour le programme d'installation.
Type : chaîne
Obligatoire : non
- source
-
Le URL du
.msi
dossier de candidature.Type : String
Obligatoire : oui
- sourceHash
-
Le SHA256 hachage du
.msi
fichier.Type : chaîne
Obligatoire : non
aws:cloudWatch
Exportez des données depuis Windows Server Amazon CloudWatch ou Amazon CloudWatch Logs et surveillez-les à l'aide de CloudWatch métriques. Ce plug-in s'exécute uniquement sur les systèmes d'exploitation Windows Server. Pour plus d'informations sur la configuration de CloudWatch l'intégration avec Amazon Elastic Compute Cloud (AmazonEC2), consultez la section Collecte de métriques, de journaux et de traces avec l' CloudWatch agent dans le guide de CloudWatch l'utilisateur Amazon.
Important
L' CloudWatch agent unifié a été remplacé SSM Agent en tant qu'outil d'envoi des données de journal à Amazon CloudWatch Logs. Le cloudWatch plugin SSM Agent aws : n'est pas pris en charge. Nous vous recommandons de n'utiliser que l' CloudWatch agent unifié pour vos processus de collecte de journaux. Pour plus d’informations, consultez les rubriques suivantes :
Vous pouvez exporter et contrôler les types de données suivants :
- ApplicationEventLog
-
Envoie les données du journal des événements de l'application à CloudWatch Logs.
- CustomLogs
-
Envoie n'importe quel fichier journal sous forme de texte à Amazon CloudWatch Logs. Le CloudWatch plugin crée une empreinte digitale pour les fichiers journaux. Le système associe ensuite un décalage des données à chaque empreinte. Le plug-in charge les fichiers en cas de modifications, enregistre le décalage et associe celui-ci à une empreinte. Cette méthode est utilisée pour éviter que le système charge tous le fichiers si un utilisateur active le plugin et associe le service à un répertoire contenant un grand nombre de fichiers.
Avertissement
N'oubliez pas que si votre application tronque ou tente de nettoyer des journaux au cours d'une interrogation, tous les journaux spécifiés pour
LogDirectoryPath
peuvent perdre des entrées. Si, par exemple, vous souhaitez limiter la taille des fichiers journaux, créez un nouveau fichier lorsque cette limite est atteinte, puis continuez à écrire les données dans le nouveau fichier. - ETW
-
Envoie les données de suivi des événements pour Windows (ETW) aux CloudWatch journaux.
- IIS
-
Envoie les données du IIS journal à CloudWatch Logs.
- PerformanceCounter
-
Envoie les compteurs de performance Windows à. CloudWatch Vous pouvez sélectionner différentes catégories dans lesquelles vous souhaitez effectuer le téléchargement CloudWatch sous forme de statistiques. Pour chaque compteur de performance que vous souhaitez télécharger, créez une PerformanceCountersection avec un identifiant unique (par exemple, « PerformanceCounter 2 », « PerformanceCounter 3 », etc.) et configurez ses propriétés.
Note
Si le plugin AWS Systems Manager SSM Agent ou le CloudWatch plugin est arrêté, les données du compteur de performance ne sont pas enregistrées CloudWatch. Ce comportement est différent des journaux personnalisés ou des journaux d'événements Windows. Les journaux personnalisés et les journaux d'événements Windows préservent les données des compteurs de performance et les CloudWatch téléchargent SSM Agent une fois que le CloudWatch plug-in est disponible.
- SecurityEventLog
-
Envoie les données du journal des événements de sécurité à CloudWatch Logs.
- SystemEventLog
-
Envoie les données du journal des événements du système à CloudWatch Logs.
Vous pouvez définir les destinations suivantes pour les données :
- CloudWatch
-
La destination où vos données de métriques de compteur de performances sont envoyées. Vous pouvez ajouter d'autres sections avec un identifiant unique IDs (par exempleCloudWatch, « 2 », CloudWatch 3, etc.) et spécifier une région différente pour chaque nouvel identifiant afin d'envoyer les mêmes données à différents emplacements.
- CloudWatchLogs
-
La destination où vos données de journaux sont envoyées. Vous pouvez ajouter d'autres sections avec un identifiant unique IDs (par exempleCloudWatchLogs, « 2 », CloudWatchLogs 3, etc.) et spécifier une région différente pour chaque nouvel identifiant afin d'envoyer les mêmes données à différents emplacements.
Syntaxe
"runtimeConfig":{ "aws:cloudWatch":{ "settings":{ "startType":"{{ status }}" }, "properties":"{{ properties }}" } }
Paramètres et propriétés
- AccessKey
-
Votre ID de clé d’accès . Cette propriété est obligatoire sauf si vous avez lancé votre instance à l'aide d'un IAM rôle. Cette propriété ne peut pas être utilisée avecSSM.
Type : chaîne
Obligatoire : non
- CategoryName
-
Catégorie du compteur de performances en provenance de Performance Monitor.
Type : String
Obligatoire : oui
- CounterName
-
Nom du compteur de performances en provenance de Performance Monitor.
Type : String
Obligatoire : oui
- CultureName
-
Paramètres régionaux où l'horodatage est consigné. S'il CultureNameest vide, il utilise par défaut les mêmes paramètres régionaux que ceux utilisés par votre Windows Server instance.
Type : String
Valeurs valides : pour obtenir la liste des valeurs prises en charge, consultez National Language Support (NLS)
sur le site Web de Microsoft. Les valeurs div, div-MV, hu, et hu-HU ne sont pas prises en charge. Obligatoire : non
- DimensionName
-
Une dimension pour votre CloudWatch métrique Amazon. Si vous spécifiez
DimensionName
, vous devez spécifierDimensionValue
. Ces paramètres offrent une autre vue lors de la création de listes de métriques. Vous pouvez utiliser la même dimension pour plusieurs métriques afin d'afficher toutes les métriques appartenant à une dimension spécifique.Type : chaîne
Obligatoire : non
- DimensionValue
-
Une valeur de dimension pour votre CloudWatch métrique Amazon.
Type : chaîne
Obligatoire : non
- Encodage
-
Le codage de fichier à utiliser (par exemple, UTF -8). Utilisez le nom d'encodage, pas le nom complet.
Type : String
Valeurs valides : pour obtenir une liste des valeurs prises en charge, veuillez consulter la rubrique Classe d'encodage
dans la bibliothèque Microsoft Learn (langue française non garantie). Obligatoire : oui
- Filtre
-
Préfixe des noms de journaux. Laissez ce paramètre vide de façon à surveiller tous les fichiers.
Type : String
Valeurs valides : pour obtenir la liste des valeurs prises en charge, consultez la FileSystemWatcherFilter propriété
dans la MSDN bibliothèque. Obligatoire : non
- Flux
-
Chaque type de données à télécharger, ainsi que la destination des données (CloudWatch ou CloudWatch journaux). Par exemple, pour envoyer un compteur de performance défini sous
"Id": "PerformanceCounter"
vers la CloudWatch destination définie sous"Id": "CloudWatch"
, entrez «PerformanceCounter, CloudWatch ». De même, pour envoyer le journal personnalisé, le ETW journal et le journal système vers la destination CloudWatch des journaux définie"Id": "ETW"
ci-dessous, entrez « (ETW), CloudWatchLogs ». En outre, vous pouvez envoyer le même compteur de performances ou fichier journal à plus d'une destination. Par exemple, pour envoyer le journal de l'application vers deux destinations différentes que vous avez définies sous"Id": "CloudWatchLogs"
et"Id": "CloudWatchLogs2"
, entrez «ApplicationEventLog, (CloudWatchLogs, CloudWatchLogs 2) ».Type : String
Valeurs valides (source) :
ApplicationEventLog
|CustomLogs
|ETW
|PerformanceCounter
|SystemEventLog
|SecurityEventLog
Valeurs valides (destination) :
CloudWatch
|CloudWatchLogs
|CloudWatch
n
|CloudWatchLogs
n
Obligatoire : oui
- FullName
-
Nom complet du composant.
Type : String
Obligatoire : oui
- Id
-
Identifie la source ou la destination des données. Cet identificateur doit être unique au sein du fichier de configuration.
Type : String
Obligatoire : oui
- InstanceName
-
Nom de l'instance du compteur de performances. N'utilisez pas d'astérisque (*) pour indiquer toutes les instances, car chaque composant du compteur de performance prend en charge un seul élément. Cependant, vous pouvez utiliser _Total.
Type : String
Obligatoire : oui
- Niveaux
-
Les types de messages à envoyer à Amazon CloudWatch.
Type : String
Valeurs valides :
-
1 - Uniquement les messages d'erreur chargés.
-
2 - Uniquement les messages d'avertissement chargés.
-
4 - Uniquement les messages d'information chargés.
Vous pouvez ajouter des valeurs pour inclure plusieurs types de message. Par exemple, 3 signifie que les messages d'erreur (1) et les messages d'avertissement (2) sont inclus. Une valeur de 7 signifie que les messages d'erreur (1), les messages d'avertissement (2) et les messages d'information (4) sont inclus.
Obligatoire : oui
Note
Pour les journaux de sécurité Windows, Levels doit être défini sur 7.
-
- LineCount
-
Nombre de lignes de l'en-tête permettant d'identifier le fichier journal. Par exemple, les fichiers IIS journaux ont des en-têtes pratiquement identiques. Vous pouvez entrer 3, qui lirait les trois premières lignes de l'en-tête du fichier journal pour l'identifier. Dans les fichiers IIS journaux, la troisième ligne correspond à la date et à l'heure, qui diffèrent d'un fichier journal à l'autre.
Type : entier
Obligatoire : non
- LogDirectoryPath
-
Pour CustomLogs, le chemin où les journaux sont stockés sur votre EC2 instance. Pour les IIS journaux, dossier dans lequel les IIS journaux sont stockés pour un site individuel (par exemple, C : \ \ inetpub \ \ logs \ \ \ LogFiles \ W3 SVC
n
). Pour les IIS journaux, seul le format de journal W3C est pris en charge. IISNCSA, et les formats personnalisés ne sont pas pris en charge.Type : String
Obligatoire : oui
- LogGroup
-
Nom de votre groupe de journaux. Ce nom est affiché sur l'écran Log Groups de la CloudWatch console.
Type : String
Obligatoire : oui
- LogName
-
Nom du fichier journal.
-
Pour trouver le nom du journal, dans l'observateur d'événements, dans le panneau de navigation, sélectionnez Applications and Services Logs (Journaux d'applications et de services).
-
Dans la liste des journaux, cliquez avec le bouton droit de la souris sur le journal que vous voulez télécharger (par exemple, Microsoft > Windows > Sauvegarde > Opérationnelle), puis cliquez sur Create Custom View (Créer une vue personnalisée).
-
Dans la boîte de dialogue Créer un affichage personnalisé, sélectionnez l'XMLonglet. Cela LogNamese trouve dans la balise <Select Path=> (par exemple,
Microsoft-Windows-Backup
). Copiez ce texte dans le LogNameparamètre.
Type : String
Valeurs valides :
Application
|Security
|System
|Microsoft-Windows-WinINet/Analytic
Obligatoire : oui
-
- LogStream
-
Flux de journal de destination. Si vous utilisez {instance_id}, la valeur par défaut, l'ID d'instance de cette instance est utilisée en tant que nom du flux de journal.
Type : String
Valeurs valides :
{instance_id}
|{hostname}
|{ip_address}
<log_stream_name>
Si vous entrez un nom de flux de journal qui n'existe pas encore, CloudWatch Logs le crée automatiquement pour vous. Vous pouvez utiliser une chaîne littérale ou des variables prédéfinies ({instance_id}, {hostname}, {ip_address}), ou une combinaison des trois pour définir un nom de flux de journal.
Le nom du flux de journal spécifié dans ce paramètre est affiché dans Groupes de journaux > Streams pour
<YourLogStream>
écran de la CloudWatch console.Obligatoire : oui
- MetricName
-
CloudWatch Mesure dans laquelle vous souhaitez que les données de performance soient incluses.
Note
N'utilisez pas de caractères spéciaux dans ce nom. Sinon, la métrique et les alarmes associées risquent de ne pas fonctionner.
Type : String
Obligatoire : oui
- NameSpace
-
Namespace de la métrique où vous voulez écrire les données des compteurs de performances.
Type : String
Obligatoire : oui
- PollInterval
-
Nombre de secondes avant qu'un nouveau compteur de performances et des données de journal soient chargés.
Type : entier
Valeurs valides : indiquez une valeur égale ou supérieure à 5 secondes. La valeur recommandée est 15 secondes (00:00:15).
Obligatoire : oui
- Région
-
L' Région AWS endroit où vous souhaitez envoyer les données du journal. Même si vous pouvez envoyer des compteurs de performances à une autre région où vous envoyez vos données de journal, nous vous recommandons de définir ce paramètre sur la même région où votre instance est en cours d'exécution.
Type : String
Valeurs valides : Régions IDs Régions AWS prises en charge à la fois par Systems Manager et CloudWatch Logs
us-east-2
, telles queeu-west-1
, etap-southeast-1
. Pour obtenir la liste des points de terminaison Régions AWS pris en charge par chaque service, consultez Amazon CloudWatch Logs Service Endpoints et Systems Manager dans le. Référence générale d'Amazon Web ServicesObligatoire : oui
- SecretKey
-
Clé d’accès secrète de votre compte . Cette propriété est obligatoire sauf si vous avez lancé votre instance à l'aide d'un IAM rôle.
Type : chaîne
Obligatoire : non
- startType
-
Activez ou CloudWatch désactivez l'instance.
Type : String
Valeurs valides :
Enabled
|Disabled
Obligatoire : oui
- TimestampFormat
-
Format d'horodatage que vous voulez utiliser. Pour obtenir la liste des valeurs prises en charge, consultez la section Chaînes de format de date et d'heure personnalisées
dans la MSDN bibliothèque. Type : String
Obligatoire : oui
- TimeZoneKind
-
Fournit des informations de fuseau horaire si aucune n'est comprise dans l'horodatage de vos journaux. Si ce paramètre est laissé vide et si votre horodatage n'inclut aucune information de fuseau horaire, CloudWatch Logs utilise par défaut le fuseau horaire local. Ce paramètre est ignoré si votre horodatage contient déjà des informations de fuseau horaire.
Type : String
Valeurs valides :
Local
|UTC
Obligatoire : non
- Unité
-
Unité de mesure appropriée pour la métrique.
Type : String
Valeurs valides : Secondes | Microsecondes | Millisecondes | Octets | Kilo-octets | Mégaoctets | Gigaoctets | Téraoctets | Bits | Kilobits | Mégabits | Gigabits | Térabits | Pourcentage | Nombre | Octets/seconde | Kilo-octets/seconde | Mégaoctets/seconde | Gigaoctets/seconde | Téraoctets/seconde | Bits/seconde | Kilobits/seconde | Mégabits/seconde | Gigabits/seconde | Térabits/seconde | Nombre/seconde | Aucune.
Obligatoire : oui
aws:configureDocker
(Version de schéma 2.0 ou ultérieure) Configuration d'une instance pour un fonctionnement avec des conteneurs et Docker. Ce plug-in est pris en charge sur les systèmes d'exploitation Linux et Windows Server.
Syntaxe
Schéma 2.2
Inputs
- action
-
Type d'action à effectuer.
Type : énumération
Valeurs valides :
Install
|Uninstall
Obligatoire : oui
aws:configurePackage
(Schema version 2.0 ou ultérieure) Installez ou désinstallez un AWS Systems Manager Distributor package. Vous pouvez installer la dernière version, la version par défaut ou une version du package que vous spécifiez. Les packages fournis par AWS sont également pris en charge. Ce plug-in s'exécute sur Windows Server et les systèmes d'exploitation Linux, mais tous les packages disponibles ne sont pas pris en charge sur les systèmes d'exploitation Linux.
Les AWS packages disponibles pour Windows Server incluent les suivants : AWSPVDriver
AWSNVMe
AwsEnaNetworkDriver
,AwsVssComponents
,AmazonCloudWatchAgent
,CodeDeployAgent
, et AWSSupport-EC2Rescue.
AWS Les packages disponibles pour les systèmes d'exploitation Linux sont les suivants : AmazonCloudWatchAgent
CodeDeployAgent
, etAWSSupport-EC2Rescue
.
Syntaxe
Schéma 2.2
Inputs
- name
-
Nom du AWS package à installer ou à désinstaller. Les packages disponibles sont les suivants :
AWSPVDriver
,AwsEnaNetworkDriver
,AwsVssComponents
etAmazonCloudWatchAgent
.Type : String
Obligatoire : oui
- action
-
Installe ou désinstalle un package.
Type : énumération
Valeurs valides :
Install
|Uninstall
Obligatoire : oui
- installationType
-
Type d'installation à effectuer. Si vous spécifiez
Uninstall and reinstall
, le package est complètement désinstallé, puis réinstallé. L'application n'est pas disponible tant que la réinstallation n'est pas terminée. Si vous spécifiezIn-place update
, seuls les fichiers nouveaux ou modifiés sont ajoutés à l'installation existante, conformément aux instructions que vous fournissez dans un script mis à jour. L'application reste disponible tout au long du processus de mise à jour. L'In-place update
option n'est pas prise en charge pour les packages AWS publiés.Uninstall and reinstall
est la valeur par défaut.Type : énumération
Valeurs valides :
Uninstall and reinstall
|In-place update
Obligatoire : non
- additionalArguments
-
JSONChaîne contenant les paramètres supplémentaires à fournir à vos scripts d'installation, de désinstallation ou de mise à jour. Chaque paramètre doit être préfixé avec
SSM_
. Vous pouvez référencer un paramètre Parameter Store dans vos arguments supplémentaires en utilisant la convention{{ssm:
. Pour utiliser le paramètre supplémentaire dans vos scripts d'installation, de désinstallation ou de mise à jour, vous devez référencer le paramètre en tant que variable d'environnement en utilisant la syntaxe qui correspond au système d'exploitation. Par exemple, dans PowerShell, vous référencez l'parameter-name
}}SSM_arg
argument comme$Env:SSM_arg
. Le nombre d'arguments que vous définissez n'est pas limité, mais la saisie d'un argument supplémentaire est limitée à 4 096 caractères. Cette limite inclut l'ensemble des clés et des valeurs que vous définissez.Type : StringMap
Obligatoire : non
- version
-
Version spécifique du package à installer ou désinstaller. Dans le cas d'une installation, le système installe par défaut la version publiée la plus récente. Dans le cas d'une désinstallation, le système désinstalle par défaut la version actuellement installée. Si aucune version installée n'est détectée, la version publiée la plus récente est téléchargée et l'action de désinstallation est exécutée.
Type : chaîne
Obligatoire : non
aws:domainJoin
Associez une EC2 instance à un domaine. Ce plug-in s'exécute sur les systèmes d'exploitation Linux et Windows Server. Ce plugin remplace le nom d'hôte des instances Linux par le format - EC2AMAZXXXXXXX
. Pour plus d'informations sur la jonction d'EC2instances, voir Joindre une EC2 instance à votre répertoire Microsoft AD AWS géré dans le Guide d'AWS Directory Service administration.
Syntaxe
Schéma 2.2
Schéma 1.2
Propriétés
- directoryId
-
ID du répertoire.
Type : String
Obligatoire : oui
Exemple : "directoryId« : « d-1234567890"
- directoryName
-
Nom du domaine.
Type : String
Obligatoire : oui
Exemple : "directoryName« : « example.com »
- directoryOU
-
Unité d'organisation (UO).
Type : chaîne
Obligatoire : non
Exemple : "directoryOU": "OU=test,DC=example,DC=com"
- dnsIpAddresses
-
Les adresses IP des DNS serveurs.
Type : StringList
Obligatoire : oui
Exemple : "dnsIpAddresses« : [" 198.51.100.1", "198.51.100.2"]
- keepHostName
-
Détermine si le nom d'hôte est modifié pour les instances Linux lorsqu'elles sont jointes au domaine.
Type : booléen
Obligatoire : non
Exemples
Pour des exemples, consultez Joindre une EC2 instance Amazon à votre instance AWS Managed Microsoft AD dans le guide d'AWS Directory Service administration.
aws:downloadContent
(Schema version 2.0 ou ultérieure) Téléchargez SSM des documents et des scripts depuis des sites distants. GitHub Enterpriseles référentiels ne sont pas pris en charge. Ce plug-in est pris en charge sur les systèmes d'exploitation Linux et Windows Server.
Syntaxe
Schéma 2.2
Inputs
- sourceType
-
La source du téléchargement. Systems Manager prend en charge les types de sources suivants pour le téléchargement de scripts et de SSM documents :
GitHub
Git
HTTP
,S3
,, etSSMDocument
.Type : String
Obligatoire : oui
- sourceInfo
-
Informations obligatoires pour récupérer le contenu à partir de la source requise.
Type : StringMap
Obligatoire : oui
Pour sourceType
GitHub,
spécifier les éléments suivants :-
owner: propriétaire du référentiel.
-
repository: nom du référentiel.
-
path: chemin d'accès au fichier ou au répertoire que vous souhaitez télécharger.
-
getOptions: options supplémentaires pour récupérer le contenu d'une branche autre que master ou d'un commit spécifique dans le référentiel. getOptions peut être omis si vous utilisez le dernier commit dans la branche master. Si votre référentiel a été créé après le 1er octobre 2020, la branche par défaut peut être nommée « main » au lieu de « master ». Dans ce cas, vous devez spécifier des valeurs pour le getOptions paramètre.
Ce paramètre utilise le format suivant :
-
branche : refs/heads/
branch_name
L’argument par défaut est
master
.Pour spécifier une branche autre que celle par défaut, utilisez le format suivant :
branche : refs/heads/
branch_name
-
CommitiD :
commitID
L’argument par défaut est
head
.Pour utiliser la version de votre SSM document dans un commit autre que le dernier, spécifiez l'ID de validation complet. Par exemple :
"getOptions": "commitID:bbc1ddb94...b76d3bEXAMPLE",
-
-
tokenInfo: le paramètre Systems Manager (un SecureString paramètre) dans lequel vous stockez les informations de votre jeton d'GitHubaccès, au format
{{ssm-secure:
.secure-string-token-name
}}Note
Ce
tokenInfo
champ est le seul champ du plugin de SSM document qui prend en charge un SecureString paramètre. SecureString les paramètres ne sont pris en charge pour aucun autre champ, ni pour aucun autre plugin de SSM document.
{ "owner":"TestUser", "repository":"
GitHubTest
", "path":"scripts/python/test-script
", "getOptions":"branch:master", "tokenInfo":"{{ssm-secure:secure-string-token
}}" }Pour sourceType
Git
, vous devez spécifier les éléments suivants :-
référentiels
Le dépôt Git URL vers le fichier ou le répertoire que vous souhaitez télécharger.
Type : String
En outre, vous pouvez préciser les paramètres facultatifs suivants :
-
getOptions
Options supplémentaires pour récupérer le contenu d'une branche autre que master ou d'un commit spécifique dans le référentiel. getOptions peut être omis si vous utilisez le dernier commit dans la branche master.
Type : String
Ce paramètre utilise le format suivant :
-
branche : refs/heads/
branch_name
L’argument par défaut est
master
."branch"
n'est requis que si votre SSM document est stocké dans une succursale autre quemaster
. Par exemple :"getOptions": "branch:refs/head/main"
-
CommitiD :
commitID
L’argument par défaut est
head
.Pour utiliser la version de votre SSM document dans un commit autre que le dernier, spécifiez l'ID de validation complet. Par exemple :
"getOptions": "commitID:bbc1ddb94...b76d3bEXAMPLE",
-
-
privateSSHKey
La SSH clé à utiliser lors de la connexion à celle
repository
que vous spécifiez. Vous pouvez utiliser le format suivant pour référencer unSecureString
paramètre pour la valeur de votre SSH clé :{{ssm-secure:
.your-secure-string-parameter
}}Type : String
-
skipHostKeyVérification
Détermine la valeur de l' StrictHostKeyCheckingoption lors de la connexion à celle
repository
que vous spécifiez. La valeur par défaut estfalse
.Type : booléen
-
nom d’utilisateur
Le nom d'utilisateur à utiliser lors de la connexion à celui
repository
que vous spécifiez en utilisantHTTP. Vous pouvez utiliser le format suivant pour référencer un paramètreSecureString
pour la valeur de votre nom d'utilisateur :{{ssm-secure:
.your-secure-string-parameter
}}Type : String
-
mot de passe
Le mot de passe à utiliser lors de la connexion au
repository
que vous spécifiez en utilisantHTTP. Vous pouvez utiliser le format suivant pour référencer un paramètreSecureString
pour la valeur de votre mot de passe :{{ssm-secure:
.your-secure-string-parameter
}}Type : String
Pour sourceType
HTTP
, vous devez spécifier les éléments suivants :-
url
Dans URL le fichier ou le répertoire que vous souhaitez télécharger.
Type : String
En outre, vous pouvez préciser les paramètres facultatifs suivants :
-
allowInsecureDownload
Détermine si un téléchargement peut être effectué via une connexion qui n'est pas cryptée avec Secure Socket Layer (SSL) ou Transport Layer Security (TLS). La valeur par défaut est
false
. Nous vous déconseillons d'effectuer des téléchargements sans chiffrement. Si vous choisissez de le faire, vous en assumez les risques associés. La sécurité est une responsabilité partagée entre vous AWS et vous. Cela est décrit comme un modèle de responsabilité partagée. Pour en savoir plus, veuillez consulter le Modèle de responsabilité partagée. Type : booléen
-
authMethod
Détermine si un nom d'utilisateur et un mot de passe sont utilisés pour l'authentification lors de la connexion au
url
spécifié. Si vous spécifiezBasic
ouDigest
, vous devez fournir des valeurs pour les paramètresusername
etpassword
. Pour utiliser la méthodeDigest
, SSM Agent version 3.0.1181.0 ou une version ultérieure doit être installé sur votre instance. LaDigest
méthode prend en charge MD5 et SHA256 crypte.Type : String
Valeurs valides :
None
|Basic
|Digest
-
nom d’utilisateur
Nom d'utilisateur à utiliser lors de la connexion au
url
spécifié avec l'authentificationBasic
. Vous pouvez utiliser le format suivant pour référencer un paramètreSecureString
pour la valeur de votre nom d'utilisateur :{{ssm-secure:
.your-secure-string-parameter
}}Type : String
-
mot de passe
Mot de passe à utiliser lors de la connexion au
url
spécifié avec l'authentificationBasic
. Vous pouvez utiliser le format suivant pour référencer un paramètreSecureString
pour la valeur de votre mot de passe :{{ssm-secure:
.your-secure-string-parameter
}}Type : String
Pour sourceType
S3
, spécifiez les éléments suivants :-
chemin : le chemin URL vers le fichier ou le répertoire que vous souhaitez télécharger depuis Amazon S3.
{ "path": "https://s3.amazonaws.com/
amzn-s3-demo-bucket
/powershell/helloPowershell.ps1" }Pour sourceType
SSMDocument
, spécifiez l'une des options suivantes :-
name: nom et version du document au format suivant :
name:version
. La version est facultative.{ "name": "Example-RunPowerShellScript:3" }
-
nom : Le ARN nom du document au format suivant :
arn:aws:ssm:
region
:account_id
:document/document_name
{ "name":"arn:aws:ssm:us-east-2:3344556677:document/MySharedDoc" }
-
- destinationPath
-
Chemin local facultatif sur l'instance dans laquelle vous souhaitez télécharger le fichier. Si vous ne spécifiez pas de chemin, le contenu est téléchargé sur un chemin d'accès relatif à votre ID de commande.
Type : chaîne
Obligatoire : non
aws:psModule
Installez PowerShell des modules sur une EC2 instance Amazon. Ce plug-in s'exécute uniquement sur les systèmes d'exploitation Windows Server.
Syntaxe
Schéma 2.2
Schéma 1.2
Propriétés
- runCommand
-
PowerShell Commande à exécuter après l'installation du module.
Type : StringList
Obligatoire : non
- source
-
Le chemin URL ou le chemin local de l'instance vers le
.zip
fichier d'application.Type : String
Obligatoire : oui
- sourceHash
-
Le SHA256 hachage du
.zip
fichier.Type : chaîne
Obligatoire : non
- timeoutSeconds
-
Nombre de secondes accordées à l'exécution d'une commande avant qu'elle soit considérée comme ayant échoué.
Type : chaîne
Obligatoire : non
- workingDirectory
-
Chemin d'accès au répertoire de travail sur votre instance.
Type : chaîne
Obligatoire : non
aws:refreshAssociation
(Version de schéma 2.0 ou ultérieure) Actualisation (application forcée) d'une association à la demande. Cette action modifie l'état du système en fonction de ce qui est défini dans l'association sélectionnée ou dans toutes les associations liées aux cibles. Ce plug-in s'exécute sur les systèmes d'exploitation Linux et Microsoft Windows Server.
Syntaxe
Schéma 2.2
Inputs
- associationIds
-
Liste des associationsIDs. Si ce paramètre est vide, toutes les associations liées à la cible spécifiée sont appliquées.
Type : StringList
Obligatoire : non
aws:runDockerAction
(Version de schéma 2.0 ou ultérieure) Exécution des actions Docker sur les conteneurs. Ce plug-in s'exécute sur les systèmes d'exploitation Linux et Microsoft Windows Server.
Syntaxe
Schéma 2.2
Inputs
- action
-
Type d'action à effectuer.
Type : String
Obligatoire : oui
- conteneur
-
ID du conteneur Docker.
Type : chaîne
Obligatoire : non
- image
-
Nom de l'image Docker.
Type : chaîne
Obligatoire : non
- cmd
-
Commande du conteneur.
Type : chaîne
Obligatoire : non
- memory
-
Limite de mémoire du conteneur.
Type : chaîne
Obligatoire : non
- cpuShares
-
Le conteneur se CPU partage (poids relatif).
Type : chaîne
Obligatoire : non
- volume
-
Montages de volume du conteneur.
Type : StringList
Obligatoire : non
- env
-
Variables d'environnement du conteneur.
Type : chaîne
Obligatoire : non
- utilisateur
-
Nom d'utilisateur du conteneur.
Type : chaîne
Obligatoire : non
- publish
-
Ports publiés du conteneur.
Type : chaîne
Obligatoire : non
aws:runDocument
(Schema version 2.0 ou ultérieure) Exécute SSM les documents stockés dans Systems Manager ou sur un partage local. Vous pouvez utiliser ce plugin avec le aws:downloadContent plugin pour télécharger un SSM document depuis un emplacement distant vers un partage local, puis l'exécuter. Ce plug-in est pris en charge sur les systèmes d'exploitation Linux et Windows Server. Ce plugin ne prend pas en charge l'exécution du document AWS-UpdateSSMAgent
ou de tout autre document utilisant le plugin aws:updateSsmAgent
.
Syntaxe
Schéma 2.2
Inputs
- documentType
-
Type du document à exécuter. Vous pouvez exécuter des documents locaux (
LocalPath
) ou des documents stockés dans Systems Manager (SSMDocument
).Type : String
Obligatoire : oui
- documentPath
-
Chemin d'accès du document. Si
documentType
estLocalPath
, spécifiez le chemin d'accès au document sur le partage local. SidocumentType
estSSMDocument
, spécifiez le nom du document.Type : chaîne
Obligatoire : non
- documentParameters
-
Paramètres pour le document.
Type : StringMap
Obligatoire : non
aws:runPowerShellScript
Exécutez PowerShell des scripts ou spécifiez le chemin d'accès au script à exécuter. Ce plug-in s'exécute sur les systèmes d'exploitation Linux et Microsoft Windows Server.
Syntaxe
Schéma 2.2
Schéma 1.2
Propriétés
- runCommand
-
Spécifiez les commandes à exécuter ou le chemin d'accès à un script existant sur l'instance.
Type : StringList
Obligatoire : oui
- timeoutSeconds
-
Nombre de secondes accordées à l'exécution d'une commande avant qu'elle soit considérée comme ayant échoué. Une fois le délai atteint, Systems Manager arrête l'exécution de la commande.
Type : chaîne
Obligatoire : non
- workingDirectory
-
Chemin d'accès au répertoire de travail sur votre instance.
Type : chaîne
Obligatoire : non
aws:runShellScript
Exécution des scripts shell Linux ou spécification du chemin d'accès à un script à exécuter. Ce plug-in s'exécute uniquement sur les systèmes d'exploitation Linux.
Syntaxe
Schéma 2.2
Schéma 1.2
Propriétés
- runCommand
-
Spécifiez les commandes à exécuter ou le chemin d'accès à un script existant sur l'instance.
Type : StringList
Obligatoire : oui
- timeoutSeconds
-
Nombre de secondes accordées à l'exécution d'une commande avant qu'elle soit considérée comme ayant échoué. Une fois le délai atteint, Systems Manager arrête l'exécution de la commande.
Type : chaîne
Obligatoire : non
- workingDirectory
-
Chemin d'accès au répertoire de travail sur votre instance.
Type : chaîne
Obligatoire : non
aws:softwareInventory
(Version de schéma 2.0 ou version ultérieure) Recueil des métadonnées sur des applications, des fichiers et des configurations sur vos instances gérées. Ce plug-in s'exécute sur les systèmes d'exploitation Linux et Microsoft Windows Server. Lorsque vous configurez la collecte d'inventaire, vous commencez par créer une AWS Systems Manager State Manager association. Systems Manager collecte les données d'inventaire lorsque l'association est exécutée. Si vous ne créez pas l'association en premier et essayez d'appeler le plugin aws:softwareInventory
, le système renvoie l'erreur suivante :
The aws:softwareInventory
plugin can only be invoked via ssm-associate.
Une instance ne peut avoir qu'une association d'inventaire configurée en même temps. Si vous configurez une instance avec plusieurs associations, l'association d'inventaire n'est pas exécutée et aucune donnée d'inventaire n'est collectée. Pour de plus amples informations sur la collecte de l'inventaire, veuillez consulter AWS Systems Manager Inventory.
Syntaxe
Schéma 2.2
Inputs
- applications
-
(Facultatif) Collecter les métadonnées pour les applications installées.
Type : chaîne
Obligatoire : non
- awsComponents
-
(Facultatif) Collectez des métadonnées pour AWS des composants tels que amazon-ssm-agent.
Type : chaîne
Obligatoire : non
- files
-
(Facultatif, nécessite la version de l'SSM Agent 2.2.64.0 ou d'une version ultérieure) Collectez les métadonnées pour les fichiers, notamment leurs noms, leur heure de création, l'heure de leur dernière modification et de leur dernier accès, leur taille, etc. Pour de plus amples informations sur la collecte de l'inventaire de fichiers, veuillez consulter Utilisation de l'inventaire de fichiers et du registre Windows.
Type : chaîne
Obligatoire : non
- networkConfig
-
(Facultatif) Collectez les métadonnées pour les configurations de réseau.
Type : chaîne
Obligatoire : non
- windowsUpdates
-
(Facultatif) Collectez les métadonnées pour toutes les mises à jour Windows.
Type : chaîne
Obligatoire : non
- instanceDetailedInformation
-
(Facultatif) Collectez plus d'informations sur les instances que celles fournies par le plugin d'inventaire par défaut (
aws:instanceInformation
), notamment le CPU modèle, la vitesse et le nombre de cœurs, pour n'en citer que quelques-unes.Type : chaîne
Obligatoire : non
- services
-
(Facultatif, système d'exploitation, Windows nécessite uniquement la version de l'SSM Agent 2.2.64.0 ou une version ultérieure) Collectez les métadonnées pour les configurations de service.
Type : chaîne
Obligatoire : non
- windowsRegistry
-
(Facultatif, système d'exploitation, Windows nécessite uniquement la version de l'SSM Agent 2.2.64.0 ou une version ultérieure) Collectez les valeurs et clés de registre Windows. Vous pouvez choisir un chemin de clé et collecter toutes les clés et valeurs de manière récursive. Vous pouvez également collecter une clé de registre spécifique et sa valeur pour un chemin donné. Inventory collecte le chemin de clé, le nom, le type et la valeur. Pour de plus amples informations sur la collecte de l'inventaire de fichiers et du registre Windows, veuillez consulter Utilisation de l'inventaire de fichiers et du registre Windows.
Type : chaîne
Obligatoire : non
- windowsRoles
-
(Facultatif, système d'exploitation, Windows nécessite uniquement la version de l'SSM Agent 2.2.64.0 ou une version ultérieure) Collectez les métadonnées pour les configurations de rôle Microsoft Windows.
Type : chaîne
Obligatoire : non
- customInventory
-
(Facultatif) Collectez les données d'inventaire personnalisées. Pour de plus amples informations sur l'inventaire personnalisé, veuillez consulter Utilisation de l'inventaire personnalisé.
Type : chaîne
Obligatoire : non
aws:updateAgent
Mettez à jour le EC2Config service vers la dernière version ou spécifiez une version plus ancienne. Ce plug-in s'exécute uniquement sur les systèmes d'exploitation Microsoft Windows Server. Pour plus d'informations sur le EC2Config service, consultez Configuration d'une instance Windows à l'aide du EC2Config service (ancien) dans le guide de EC2 l'utilisateur Amazon.
Syntaxe
Schéma 2.2
Schéma 1.2
Propriétés
- agentName
-
EC2Config. Il s'agit du nom de l'agent qui exécute le EC2Config service.
Type : String
Obligatoire : oui
- allowDowngrade
-
Autoriser la rétrogradation du EC2Config service vers une version antérieure. Si false est défini, le service peut uniquement être mis à jour vers des versions plus récentes (valeur par défaut). Si true est défini, vous devez spécifier la version antérieure.
Type : booléen
Obligatoire : non
- source
-
Emplacement où Systems Manager copie la version de EC2Config à installer. Vous ne pouvez pas modifier cet emplacement.
Type : String
Obligatoire : oui
- targetVersion
-
Version spécifique du EC2Config service à installer. Si vous ne spécifiez pas de version, le service est mis à jour avec la dernière version.
Type : chaîne
Obligatoire : non
aws:updateSsmAgent
Mise à jour de l'SSM Agent à la version la plus récente ou spécification d'une version plus ancienne. Ce plug-in s'exécute sur les systèmes d'exploitation Linux et Windows Server. Pour de plus amples informations, veuillez consulter Utilisation de l’option SSM Agent.
Syntaxe
Schéma 2.2
Schéma 1.2
Propriétés
- agentName
-
amazon-ssm-agent. Nom de l'agent Systems Manager qui traite les demandes et exécute les commandes sur l'instance.
Type : String
Obligatoire : oui
- allowDowngrade
-
Permet à l'SSM Agent d'être dégradé vers une version antérieure. Si false est défini, l'agent peut uniquement être mis à jour vers des versions plus récentes (valeur par défaut). Si true est défini, vous devez spécifier la version antérieure.
Type : booléen
Obligatoire : oui
- source
-
Emplacement où Systems Manager copie la version de l'SSM Agent à installer. Vous ne pouvez pas modifier cet emplacement.
Type : String
Obligatoire : oui
- targetVersion
-
Version spécifique de SSM Agent à installer. Si vous ne spécifiez pas de version, l'agent est mis à jour avec la dernière version.
Type : chaîne
Obligatoire : non