aws:runCommand - Exécuter une commande sur une instance gérée - AWS Systems Manager

aws:runCommand - Exécuter une commande sur une instance gérée

Exécute les commandes spécifiées.

Note

Automation 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.

YAML
- name: checkMembership
  action: 'aws:runCommand'
  inputs:
    DocumentName: AWS-RunPowerShellScript
    InstanceIds:
      - '{{InstanceIds}}'
    Parameters:
      commands:
        - (Get-WmiObject -Class Win32_ComputerSystem).PartOfDomain
JSON
{
    "name": "checkMembership",
    "action": "aws:runCommand",
    "inputs": {
        "DocumentName": "AWS-RunPowerShellScript",
        "InstanceIds": [
            "{{InstanceIds}}"
        ],
        "Parameters": {
            "commands": [
                "(Get-WmiObject -Class Win32_ComputerSystem).PartOfDomain"
            ]
        }
    }
}
DocumentName

Si le document de type Commande vous appartient ou appartient à AWS, 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 : String

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 Utiliser des 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ètre Targets accepte les balises Amazon Elastic Compute Cloud (Amazon EC2). Pour de plus amples informations sur l'utilisation du paramètre Targets, veuillez consulter Exécuter des commandes à grande échelle.

Type : StringList

Obligatoire : non (si vous ne spécifiez pas InstanceIds ou si vous utilisez le pseudo-paramètre {{RESOURCE_ID}}, vous devez spécifier le paramètre Targets.)

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ètre Targets, veuillez consulter Exécuter des commandes à grande échelle.

Type : MapList (le schéma de mappage 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 spécifiez pas de Targets, vous devez spécifier InstanceIds ou utiliser le pseudo-paramètre {{RESOURCE_ID}}).

Voici un exemple.

YAML
- name: checkMembership
  action: aws:runCommand
  inputs:
    DocumentName: AWS-RunPowerShellScript
    Targets:
      - Key: tag:Stage
        Values:
          - Gamma
          - Beta
      - Key: tag-key
        Values:
          - Suite
    Parameters:
      commands:
        - (Get-WmiObject -Class Win32_ComputerSystem).PartOfDomain
JSON
{
    "name": "checkMembership",
    "action": "aws:runCommand",
    "inputs": {
        "DocumentName": "AWS-RunPowerShellScript",
        "Targets": [                   
            {
                "Key": "tag:Stage",
                "Values": [
                    "Gamma", "Beta"
                ]
            },
            {
                "Key": "tag:Application",
                "Values": [
                    "Suite"
                ]
            }
        ],
        "Parameters": {
            "commands": [
                "(Get-WmiObject -Class Win32_ComputerSystem).PartOfDomain"
            ]
        }
    }
}
Paramètres

Paramètres obligatoires et facultatifs spécifiés dans le document.

Type: carte (map)

Obligatoire : non

CloudWatchOutputConfig

Options de configuration pour l'envoi d'une sortie de commande vers Amazon CloudWatch Logs. Pour de plus amples informations sur l'envoi de la sortie d'une commande à CloudWatch Logs, veuillez consulter Configurer des journaux Amazon CloudWatch Logs pour Run Command.

Type : StringMap (le schéma de la carte doit correspondre à l'objet) .Pour de plus amples informations, veuillez consulter CloudWatchOutputConfig dans la Référence d'API AWS Systems Manager).

Obligatoire : non

Voici un exemple.

YAML
- name: checkMembership
  action: aws:runCommand
  inputs:
    DocumentName: AWS-RunPowerShellScript
    InstanceIds:
      - "{{InstanceIds}}"
    Parameters:
      commands:
        - "(Get-WmiObject -Class Win32_ComputerSystem).PartOfDomain"
    CloudWatchOutputConfig:
      CloudWatchLogGroupName: CloudWatchGroupForSSMAutomationService
      CloudWatchOutputEnabled: true
JSON
{
    "name": "checkMembership",
    "action": "aws:runCommand",
    "inputs": {
        "DocumentName": "AWS-RunPowerShellScript",
        "InstanceIds": [
            "{{InstanceIds}}"
        ],
        "Parameters": {
            "commands": [
                "(Get-WmiObject -Class Win32_ComputerSystem).PartOfDomain"
            ]
        },
        "CloudWatchOutputConfig" : { 
                "CloudWatchLogGroupName": "CloudWatchGroupForSSMAutomationService",
                "CloudWatchOutputEnabled": true
        }
    }
}
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 : String

Valeurs valides : Sha256 | Sha1

Obligatoire : non

NotificationConfig

Configurations d'envoi des notifications.

Obligatoire : non

OutputS3BucketName

Nom du compartiment S3 pour les réponses de sortie de la commande.

Type : chaîne

Obligatoire : non

OutputS3KeyPrefix

Préfixe.

Type : chaîne

Obligatoire : non

ServiceRoleArn

ARN du rôle AWS Identity and Access Management (IAM).

Type : chaîne

Obligatoire : non

TimeoutSeconds

Durée d'attente, en secondes, avant la remise d'une commande à l'SSM Agent AWS Systems Manager sur 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 d’API GetCommandInvocation et ListCommandInvocations pour récupérer la sortie pour des instances individuelles.