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.
aws:runCommand
- Exécuter une commande sur une instance gérée
Exécute les commandes spécifiées.
Note
L'automatisation prend uniquement en charge la sortie d'une action AWS Systems Manager Run Command. Un runbook peut inclure plusieurs actions Run Command, mais la sortie est prise en charge pour une seule action à la fois.
Entrée
Cette action prend en charge la plupart des paramètres de la commande d'envoi. Pour plus d'informations, consultez SendCommand.
- DocumentName
-
Si le document de type Commande vous appartient AWS, ou spécifiez le nom du document. Si vous utilisez un document partagé avec un autre Compte AWS, spécifiez l'Amazon Resource Name (ARN) du document. Pour plus d'informations sur l'utilisation de documents partagés, consultez Utilisation de documents SSM partagés.
Type : chaîne
Obligatoire : oui
- InstanceIds
-
ID des instances dans lesquelles vous souhaitez que la commande s'exécute. Vous pouvez spécifier un maximum de 50 ID.
Vous pouvez également utiliser le pseudo-paramètre
{{RESOURCE_ID}}
à la place des ID d'instance pour exécuter la commande sur toutes les instances du groupe cible. Pour plus d'informations sur les pseudo-paramètres, consultez Utilisation de pseudo-paramètres lors de l'enregistrement des tâches de la fenêtre de maintenance.Une autre alternative consiste à envoyer des commandes à un parc d'instances à l'aide du paramètre
Targets
. Le paramètreTargets
accepte les balises Amazon Elastic Compute Cloud (Amazon EC2). Pour de plus amples informations sur l'utilisation du paramètreTargets
, veuillez consulter Exécuter des commandes à grande échelle.Type : StringList
Obligatoire : Non (Si vous ne spécifiez pas InstanceIds ou n'utilisez pas le
{{RESOURCE_ID}}
pseudo paramètre, vous devez leTargets
spécifier.) - Cibles
-
Ensemble de critères de recherche qui cible les instances en utilisant une combinaison clé/valeur que vous spécifiez.
Targets
est obligatoire si vous ne fournissez pas un ou plusieurs ID d'instance dans l'appel. Pour de plus amples informations sur l'utilisation du paramètreTargets
, veuillez consulter Exécuter des commandes à grande échelle.Type : MapList (Le schéma de la carte dans la liste doit correspondre à l'objet.) Pour de plus amples informations, veuillez consulter Cible dans la Référence d'API AWS Systems Manager .
Obligatoire : Non (Si vous ne le spécifiez pas
Targets
, vous devez spécifier InstanceIds ou utiliser le{{RESOURCE_ID}}
pseudo-paramètre.)Voici un exemple.
- Paramètres
-
Paramètres obligatoires et facultatifs spécifiés dans le document.
Type: carte (map)
Obligatoire : non
- CloudWatchOutputConfig
-
Options de configuration pour envoyer une sortie de commande à Amazon CloudWatch Logs. Pour plus d'informations sur l'envoi d'une sortie de commande à CloudWatch Logs, consultezConfiguration d'Amazon CloudWatch Logs pour Run Command.
Type : StringMap (Le schéma de la carte doit correspondre à l'objet. Pour plus d'informations, consultez CloudWatchOutputConfigla référence de AWS Systems Manager l'API).
Obligatoire : non
Voici un exemple.
- Comment
-
Informations définies par l'utilisateur au sujet de la commande.
Type : chaîne
Obligatoire : non
- DocumentHash
-
Hachage pour le document.
Type : chaîne
Obligatoire : non
- DocumentHashType
-
Type de hachage.
Type : chaîne
Valeurs valides :
Sha256
|Sha1
Obligatoire : non
- NotificationConfig
-
Configurations d'envoi des notifications.
Obligatoire : non
- Sorties 3 BucketName
-
Nom du compartiment S3 pour les réponses de sortie de la commande.
Type : chaîne
Obligatoire : non
- Sorties 3 KeyPrefix
-
Préfixe.
Type : chaîne
Obligatoire : non
- ServiceRoleArn
-
L'ARN du rôle AWS Identity and Access Management (IAM).
Type : chaîne
Obligatoire : non
- TimeoutSeconds
-
Temps d'attente, en secondes, avant qu'une commande ne soit délivrée AWS Systems Manager SSM Agent à une instance. Si la commande n'est pas reçue par l'SSM Agent sur l'instance avant expiration de la valeur spécifiée, le statut de la commande devient
Delivery Timed Out
.Type : entier
Obligatoire : non
Valeurs valides : 30-2592000
Sortie
- CommandId
-
ID de la commande.
- Statut
-
Statut de la commande.
- ResponseCode
-
Code de réponse de la commande. Si le document que vous exécutez comporte plus d'une étape, aucune valeur n'est renvoyée pour cette sortie.
- Sortie
-
Sortie de la commande. Si vous ciblez une balise ou plusieurs instances avec votre commande, aucune valeur de sortie n'est renvoyée. Vous pouvez utiliser les opérations
GetCommandInvocation
etListCommandInvocations
API pour récupérer la sortie pour des instances individuelles.