Exécution d’automatisations basées sur les événements EventBridge - AWS Systems Manager
Création d'un événement EventBridge utilisant un runbook (console)Créer un événement EventBridge utilisant un runbook (ligne de commande)

Exécution d’automatisations basées sur les événements EventBridge

Vous pouvez démarrer une automatisation en spécifiant un runbook comme cible d'un événement Amazon EventBridge. Vous pouvez démarrer des automatisations selon un programme ou lorsqu'un événement de système AWS spécifique se produit. Par exemple, imaginons que vous créez un runbook nommé BootStrapInstances qui installe le logiciel sur une instance lors du démarrage de cette dernière. Pour spécifier le runbook BootStrapInstances (ainsi que l'automatisation correspondante) en tant que cible d'un événement EventBridge, vous devez d'abord créer une règle EventBridge. (Voici un exemple de règle : Nom de service: EC2, Type d'événement: Notification de modification d'état d'instance EC2, État(s) spécifique(s): en cours exécution, Toute instance.) Vous utilisez ensuite les procédures suivantes afin de spécifier le runbook BootStrapInstances comme cible de l'événement à l'aide de la console EventBridge et de l'AWS Command Line Interface (AWS CLI). Lors du démarrage d'une nouvelle instance, le système exécute l'automatisation et installe le logiciel.

Pour plus d'informations sur la création de runbooks, consultez Créer vos propres runbooks.

Création d'un événement EventBridge utilisant un runbook (console)

Utilisez la procédure suivante afin de configurer un runbook comme cible d'un événement EventBridge.

Pour configurer un runbook comme cible d'une règle d'événement EventBridge

  1. Ouvrez la console Amazon EventBridge à l'adresse https://console.aws.amazon.com/events/.

  2. Dans le volet de navigation, choisissez Rules.

  3. Choisissez Créer une règle.

  4. Saisissez un nom et une description pour la règle.

    Une règle ne peut pas avoir le même nom qu'une autre règle de la même région et sur le même bus d'événement.

  5. Pour Event bus (Bus d'événement), sélectionnez le bus d'événement que vous souhaitez associer à cette règle. Si vous souhaitez que cette règle s'applique aux événements correspondants provenant de votre propre Compte AWS, sélectionnez défaut. Lorsqu'un Service AWS de votre compte émet un événement, il accède toujours au bus d'événement par défaut de votre compte.

  6. Choisissez comment la règle est déclenchée.

    Pour créer une règle basée sur… Faites ceci...

    Événement

    1. Pour Rule type (Type de règle), choisissez Rule with an event pattern (Règle avec un modèle d'événement).

    2. Choisissez Suivant.

    3. Pour Event source (Origine de l'événement), choisissez events or EventBridge partner events (Événements AWS ou événements partenaires EventBridge).

    4. Pour la section Event pattern (Modèle d'événement), effectuez l'une des opérations suivantes :

      • Pour utiliser un modèle afin de créer votre modèle d'événement, sélectionnez Formulaire de modèle d'événement et choisissez Source de l'événement, AWS Service, et Type d'évènement. Si vous choisissez All Events (Tous les événements) comme type d'événement, tous les événements émis par le Service AWS correspondent à la règle.

        Pour personnaliser le modèle, choisissez Custom pattern (JSON editor) (Modèle personnalisé [éditeur JSON]) et effectuez vos modifications.

      • Pour utiliser un modèle d'événement personnalisé, choisissez Custom pattern (JSON editor) (Modèle personnalisé [éditeur JSON]) et créez votre modèle d'événement.
    Planificateur

    1. Pour Rule type (Type de règle), choisissez Schedule (Planifier).

    2. Choisissez Suivant.

    3. Pour Schedule pattern (Planifier le modèle), effectuez l'une des étapes suivantes :

      • Pour utiliser une expression cron pour définir la planification, choisissez A fine-grained schedule that runs at a specific time, such as 8:00 a.m. (Un programme détaillé qui s'exécute à une heure précise, par exemple 8 h). PST on the first Monday of every month (PST le premier du lundi de chaque mois) et saisissez l'expression cron.

      • Pour utiliser une expression de rythme pour définir la planification, choisissez un programme qui fonctionne à un rythme régulier, par exemple toutes les 10 minutes et saisissez l'expression de rythme.

  7. Choisissez Suivant.

  8. Pour Types de cibles, choisissez service AWS.

  9. Pour Select a target (Sélectionner une cible), choisissez Systems Manager Automation.

  10. Pour Document, sélectionnez un runbook à utiliser lorsque votre cible est appelée.

  11. Dans la section Configure automation parameter(s) (Configurer le(s) paramètre(s) d'automatisation), conservez les valeurs de paramètre par défaut (si disponibles) ou saisissez vos propres valeurs.

    Note

    Pour créer une cible, vous devez spécifier une valeur pour chaque paramètre requis. Si vous ne le faites pas, le système crée la règle mais elle ne s'exécute pas.

  12. Pour de nombreux types de cibles, EventBridge a besoin d'autorisations pour envoyer des événements à la cible. Dans ce cas, EventBridge peut créer le rôle IAM nécessaire à l'exécution de votre règle. Effectuez l'une des actions suivantes :

    • Pour créer un rôle IAM automatiquement, sélectionnez Create a new role for this specific resource.

    • Pour utiliser un rôle IAM que vous avez créé précédemment, choisissez Use existing role (Utiliser un rôle existant) et sélectionnez le rôle existant dans la liste déroulante. Notez que vous devrez peut-être mettre à jour la politique de confiance de votre rôle IAM afin d'inclure EventBridge. Voici un exemple :

    JSON
    {
    "Version":"2012-10-17",		 	 	 
    "Statement": [
        {
            "Sid": "",
            "Effect": "Allow",
            "Principal": {
                "Service": [
                    "events.amazonaws.com",
                    "ssm.amazonaws.com"
                ]
            },
            "Action": "sts:AssumeRole"
        }
    ]
}

  13. Choisissez Suivant.

  14. (Facultatif) Saisissez une ou plusieurs balises pour la règle. Pour plus d'informations, consultez Balisage de vos ressources Amazon EventBridge dans le Guide de l'utilisateur Amazon EventBridge.

  15. Choisissez Suivant.

  16. Consultez les détails de la règle et choisissez Create rule (Créer une règle).

Créer un événement EventBridge utilisant un runbook (ligne de commande)

La procédure suivante décrit comment utiliser la AWS CLI (sous Linux ou Windows) ou les Outils AWS pour PowerShell pour créer une règle d'événement EventBridge et configurer un runbook en tant que cible.

Pour configurer un runbook comme cible d'une règle d'événement EventBridge

  1. Installez et configurez l'AWS CLI ou Outils AWS pour PowerShell si vous ne l'avez pas déjà fait.

    Pour plus d'informations, consultez la section Installation ou mise à jour de la version la plus récente de l'AWS CLI et Installation d'Outils AWS pour PowerShell.

  2. Créez une commande pour spécifier une nouvelle règle d'événement EventBridge. Remplacez chaque example resource placeholder (espace réservé pour les ressources) avec vos propres informations.

    Déclencheurs basés sur un calendrier

    Linux & macOS
    aws events put-rule \
--name "rule name" \
--schedule-expression "cron or rate expression"
    Windows
    aws events put-rule ^
--name "rule name" ^
--schedule-expression "cron or rate expression"
    PowerShell
    Write-CWERule `
-Name "rule name" `
-ScheduleExpression "cron or rate expression"

    L'exemple suivant crée une règle d'événement EventBridge qui se déclenche tous les jours à 9 h 00 (UTC).

    Linux & macOS
    aws events put-rule \
--name "DailyAutomationRule" \
--schedule-expression "cron(0 9 * * ? *)"
    Windows
    aws events put-rule ^
--name "DailyAutomationRule" ^
--schedule-expression "cron(0 9 * * ? *)"
    PowerShell
    Write-CWERule `
-Name "DailyAutomationRule" `
-ScheduleExpression "cron(0 9 * * ? *)"

    Déclencheurs basés sur un événement

    Linux & macOS
    aws events put-rule \
--name "rule name" \
--event-pattern "{\"source\":[\"aws.service\"],\"detail-type\":[\"service event detail type\"]}"
    Windows
    aws events put-rule ^
--name "rule name" ^
--event-pattern "{\"source\":[\"aws.service\"],\"detail-type\":[\"service event detail type\"]}"
    PowerShell
    Write-CWERule `
-Name "rule name" `
-EventPattern '{"source":["aws.service"],"detail-type":["service event detail type"]}'

    L'exemple suivant crée une règle d'événement EventBridge qui se déclenche lorsqu'une instance EC2 de la région change d'état.

    Linux & macOS
    aws events put-rule \
--name "EC2InstanceStateChanges" \
--event-pattern "{\"source\":[\"aws.ec2\"],\"detail-type\":[\"EC2 Instance State-change Notification\"]}"
    Windows
    aws events put-rule ^
--name "EC2InstanceStateChanges" ^
--event-pattern "{\"source\":[\"aws.ec2\"],\"detail-type\":[\"EC2 Instance State-change Notification\"]}"
    PowerShell
    Write-CWERule `
-Name "EC2InstanceStateChanges" `
-EventPattern '{"source":["aws.ec2"],"detail-type":["EC2 Instance State-change Notification"]}'

    La commande renvoie des détails concernant la nouvelle règle EventBridge similaires à ce qui suit.

    Linux & macOS
    {
"RuleArn": "arn:aws:events:us-east-1:123456789012:rule/automationrule"
}
    Windows
    {
"RuleArn": "arn:aws:events:us-east-1:123456789012:rule/automationrule"
}
    PowerShell
    arn:aws:events:us-east-1:123456789012:rule/EC2InstanceStateChanges

  3. Créez une commande pour spécifier un runbook comme cible de la règle d'événement EventBridge que vous avez créée à l'étape 2. Remplacez chaque example resource placeholder (espace réservé pour les ressources) avec vos propres informations.

    Linux & macOS
    aws events put-targets \
--rule rule name \
--targets '{"Arn": " arn:aws:ssm:region:account ID:automation-definition/runbook name","Input":"{\"Message\":[\"{\\\"Key\\\":\\\"key name\\\",\\\"Values\\\":[\\\"value\\\"]}\"]}","Id": "target ID","RoleArn": "arn:aws:iam::123456789012:role/service-role/EventBridge service role"}'
    Windows
    aws events put-targets ^
--rule rule name ^
--targets '{"Arn": "arn:aws:ssm:region:account ID:automation-definition/runbook name","Input":"{\"Message\":[\"{\\\"Key\\\":\\\"key name\\\",\\\"Values\\\":[\\\"value\\\"]}\"]}","Id": "target ID","RoleArn": "arn:aws:iam::123456789012:role/service-role/EventBridge service role"}'
    PowerShell
    $Target = New-Object Amazon.CloudWatchEvents.Model.Target
$Target.Id = "target ID"
$Target.Arn = "arn:aws:ssm:region:account ID:automation-definition/runbook name"
$Target.RoleArn = "arn:aws:iam::123456789012:role/service-role/EventBridge service role"
$Target.Input = '{"input parameter":["value"],"AutomationAssumeRole":["arn:aws:iam::123456789012:role/AutomationServiceRole"]}'

Write-CWETarget `
-Rule "rule name" `
-Target $Target

    L'exemple suivant crée une cible d'événement EventBridge qui démarre l'ID d'instance spécifié à l'aide du runbook AWS-StartEC2Instance.

    Linux & macOS
    aws events put-targets \
--rule DailyAutomationRule \
--targets '{"Arn": "arn:aws:ssm:region:*:automation-definition/AWS-StartEC2Instance","Input":"{\"InstanceId\":[\"i-02573cafcfEXAMPLE\"],\"AutomationAssumeRole\":[\"arn:aws:iam::123456789012:role/AutomationServiceRole\"]}","Id": "Target1","RoleArn": "arn:aws:iam::123456789012:role/service-role/AWS_Events_Invoke_Start_Automation_Execution_1213609520"}'
    Windows
    aws events put-targets ^
--rule DailyAutomationRule ^
--targets '{"Arn": "arn:aws:ssm:region:*:automation-definition/AWS-StartEC2Instance","Input":"{\"InstanceId\":[\"i-02573cafcfEXAMPLE\"],\"AutomationAssumeRole\":[\"arn:aws:iam::123456789012:role/AutomationServiceRole\"]}","Id": "Target1","RoleArn": "arn:aws:iam::123456789012:role/service-role/AWS_Events_Invoke_Start_Automation_Execution_1213609520"}'
    PowerShell
    $Target = New-Object Amazon.CloudWatchEvents.Model.Target
$Target.Id = "Target1"
$Target.Arn = "arn:aws:ssm:region:*:automation-definition/AWS-StartEC2Instance"
$Target.RoleArn = "arn:aws:iam::123456789012:role/service-role/AWS_Events_Invoke_Start_Automation_Execution_1213609520"
$Target.Input = '{"InstanceId":["i-02573cafcfEXAMPLE"],"AutomationAssumeRole":["arn:aws:iam::123456789012:role/AutomationServiceRole"]}'

Write-CWETarget `
-Rule "DailyAutomationRule" `
-Target $Target

    Le système retourne des informations telles que les suivantes.

    Linux & macOS
    {
"FailedEntries": [],
"FailedEntryCount": 0
}
    Windows
    {
"FailedEntries": [],
"FailedEntryCount": 0
}
    PowerShell

    Il n'y a pas de sortie si la commande réussit pour PowerShell.