Configuration des conditions d'une étape

Configuration d'une condition d'entrée (console)

1. Remplissez tous les prérequis, tels que la création de la ressource et de l'ARN pour une règle dans laquelle une ressource est fournie, telle que le AWS CloudWatchAlarm.

2. Connectez-vous à la CodePipeline console AWS Management Console et ouvrez-la à l'adresse http://console.aws.amazon. com/codesuite/codepipeline/home.

   Les noms et le statut de tous les pipelines associés à votre pipeline Compte AWS sont affichés.

3. Dans Name, choisissez le nom du pipeline que vous souhaitez modifier.

4. Sur la page des détails du pipeline, choisissez Edit.

5. Sur la page Modifier, pour l'action que vous souhaitez modifier, choisissez Modifier l'étape.

6. Choisissez Ajouter une condition de saisie. La carte des conditions d'entrée avant l'étape s'affiche avec l'option Échec disponible pour cette condition.

7. Choisissez Ajouter une règle, puis effectuez les opérations suivantes.

   1. Dans Nom de la règle, entrez le nom de votre règle. Pour cet exemple, entrez MyAlarmRule.

   2. Dans Fournisseur de règles, choisissez le fournisseur de règles préconfiguré à ajouter à votre condition. Pour cet exemple, choisissez AWS CloudWatchAlarm, puis effectuez les étapes suivantes.

   3. Dans Région, choisissez la région correspondant à votre état ou conservez la région par défaut.

   4. Dans Nom de l'alarme, choisissez la CloudWatch ressource à utiliser pour la règle. Vous devez déjà avoir créé la ressource dans votre compte.

   5. (Facultatif) Dans Temps d'attente, entrez le temps CodePipeline d'attente si l'alarme est en état ALARM lors de sa première évaluation. Si l'alarme est OK lorsque la règle est vérifiée pour la première fois, la règle aboutira immédiatement.

   6. (Facultatif) Entrez les états d'alarme spécifiques à surveiller et entrez l'ARN du rôle le cas échéant.

   7. Lorsque vous avez terminé de modifier la scène, choisissez OK. Sur la page de modification du pipeline, choisissez Enregistrer.

8. Après l'exécution, visualisez le résultat.

Configuration d'une condition d'entrée avec un résultat Ignorer (console)

1. Remplissez tous les prérequis, tels que la création de la ressource et de l'ARN pour une règle dans laquelle une ressource est fournie, telle que le AWS CloudWatchAlarm.

2. Connectez-vous à la CodePipeline console AWS Management Console et ouvrez-la à l'adresse http://console.aws.amazon. com/codesuite/codepipeline/home.

   Les noms et le statut de tous les pipelines associés à votre pipeline Compte AWS sont affichés.

3. Dans Name, choisissez le nom du pipeline que vous souhaitez modifier.

4. Sur la page des détails du pipeline, choisissez Edit.

5. Sur la page Modifier, pour l'action que vous souhaitez modifier, choisissez Modifier l'étape.

6. Choisissez Ajouter une condition de saisie, puis choisissez Ignorer comme résultat.

7. Choisissez Ajouter une règle, puis effectuez les opérations suivantes.

   1. Dans Nom de la règle, entrez le nom de votre règle. Pour cet exemple, entrez MyAlarmRule.

   2. Dans Fournisseur de règles, choisissez le fournisseur de règles préconfiguré à ajouter à votre condition. Pour cet exemple, choisissez VariableCheck, puis effectuez les étapes suivantes.

      

   3. Dans Région, choisissez la région correspondant à votre état ou conservez la région par défaut.

   4. Dans Variable, choisissez la variable à comparer, par exemple #{SourceVariables.FullRepositoryName} pour un pipeline comportant une action source GitHub (via GitHub App). Entrez le nom du référentiel et choisissez l'opérateur, tel que Equals.

   5. Lorsque vous avez terminé de modifier la scène, choisissez OK. Sur la page de modification du pipeline, choisissez Enregistrer.

8. Après l'exécution, visualisez le résultat.

   

9. Pour consulter les détails, choisissez Réviser. Le détail de l'exemple suivant montre que le résultat configuré pour la condition est Skip, qui ne peut pas être remplacé. Le statut de la règle est Échoué car la condition n'est pas remplie.

   

Configuration de la condition et de la ou des règles (CLI)

• Ouvrez un terminal (Linux, macOS ou Unix) ou une invite de commande (Windows) et utilisez le AWS CLI pour exécuter la update-pipeline commande, en spécifiant la condition de défaillance dans la structure du pipeline. L'exemple suivant configure une condition d'entrée pour un stage nommé Deploy :

  {
      "name": "Deploy",
      "actions": [
          {
              "name": "Deploy",
              "actionTypeId": {
                  "category": "Deploy",
                  "owner": "AWS",
                  "provider": "S3",
                  "version": "1"
              },
              "runOrder": 1,
              "configuration": {
                  "BucketName": "MyBucket",
                  "Extract": "false",
                  "ObjectKey": "object.xml"
              },
              "outputArtifacts": [],
              "inputArtifacts": [
                  {
                      "name": "SourceArtifact"
                  }
              ],
              "region": "us-east-1",
              "namespace": "DeployVariables"
          }
      ],
      "beforeEntry": {
          "conditions": [
              {
                  "result": "FAIL",
                  "rules": [
                      {
                          "name": "MyAlarmRule",
                          "ruleTypeId": {
                              "category": "Rule",
                              "owner": "AWS",
                              "provider": "CloudWatchAlarm",
                              "version": "1"
                          },
                          "configuration": {
                              "AlarmName": "CWAlarm",
                              "WaitTime": "1"
                          },
                          "inputArtifacts": [],
                          "region": "us-east-1"
                      }
                  ]
              }
          ]
      }
  } 

  Pour plus d'informations sur la configuration des conditions de réussite pour l'annulation d'une étape, consultez SuccessConditionsla référence de l'CodePipeline API.

• Mettez à jour le modèle comme indiqué dans l'extrait suivant. L'exemple suivant configure une condition d'entrée avec une règle nommée MyMonitorRule :

  Name: Deploy
  Actions:
  - Name: Deploy
    ActionTypeId:
      Category: Deploy
      Owner: AWS
      Provider: S3
      Version: '1'
    RunOrder: 1
    Configuration:
      BucketName: MyBucket
      Extract: 'false'
      ObjectKey: object.xml
    OutputArtifacts: []
    InputArtifacts:
    - Name: SourceArtifact
    Region: us-east-1
    Namespace: DeployVariables
  BeforeEntry:
    Conditions:
    - Result: FAIL
      Rules:
      - Name: MyMonitorRule
        RuleTypeId:
          Category: Rule
          Owner: AWS
          Provider: CloudWatchAlarm
          Version: '1'
        Configuration:
          AlarmName: CWAlarm
          WaitTime: '1'
        InputArtifacts: []
        Region: us-east-1 

  Pour plus d'informations sur la configuration des conditions BeforeEntry, consultez AWS::CodePipeline::Pipeline BeforeEntryConditionsle Guide StageDeclaration de l'AWS CloudFormation utilisateur ci-dessous.

Configurer une condition en cas de défaillance (console)

1. Remplissez tous les prérequis, tels que la création de la ressource et de l'ARN pour une règle dans laquelle une ressource est fournie, telle que la LambdaInvokerègle.

2. Connectez-vous à la CodePipeline console AWS Management Console et ouvrez-la à l'adresse http://console.aws.amazon. com/codesuite/codepipeline/home.

   Les noms et le statut de tous les pipelines associés à votre pipeline Compte AWS sont affichés.

3. Dans Name, choisissez le nom du pipeline que vous souhaitez modifier.

4. Sur la page des détails du pipeline, choisissez Edit.

5. Sur la page Modifier, pour l'action que vous souhaitez modifier, choisissez Modifier l'étape.

6. Choisissez Ajouter une condition de défaillance. La carte de condition de défaillance s'affiche avec l'option Annulation disponible pour cette condition.

7. Choisissez Ajouter une règle, puis effectuez les opérations suivantes.

   1. Dans Nom de la règle, entrez le nom de votre règle. Pour cet exemple, entrez MyLambdaRule.

   2. Dans Fournisseur de règles, choisissez le fournisseur de règles préconfiguré à ajouter à votre condition. Pour cet exemple, choisissez AWS LambdaInvoke, puis effectuez les étapes suivantes.

   3. Dans Région, choisissez la région correspondant à votre état ou conservez la région par défaut.

   4. Dans Artefacts d'entrée, choisissez l'artefact source.

   5. Dans Nom de la fonction, choisissez la ressource Lambda à utiliser pour la règle. Vous devez déjà avoir créé la ressource dans votre compte.

   6. (Facultatif) Dans Paramètres utilisateur, entrez les paires qui représentent des paramètres pour une configuration supplémentaire.

   7. (Facultatif) Dans Role Arn, entrez l'ARN du rôle s'il est configuré.

   8. (Facultatif) Dans Délai d'expiration en minutes, entrez le temps en minutes pendant lequel la règle doit attendre avant le délai d'expiration.

   9. Lorsque vous avez terminé de modifier la scène, choisissez OK. Sur la page de modification du pipeline, choisissez Enregistrer.

Configuration d'une condition OnFailure avec un résultat de nouvelle tentative (console)

1. Remplissez tous les prérequis, tels que la création de la ressource et de l'ARN pour une règle dans laquelle une ressource est fournie, telle que le AWS CloudWatchAlarm.

2. Connectez-vous à la CodePipeline console AWS Management Console et ouvrez-la à l'adresse http://console.aws.amazon. com/codesuite/codepipeline/home.

   Les noms et le statut de tous les pipelines associés à votre pipeline Compte AWS sont affichés.

3. Dans Name, choisissez le nom du pipeline que vous souhaitez modifier.

4. Sur la page des détails du pipeline, choisissez Edit.

5. Sur la page Modifier, pour l'action que vous souhaitez modifier, choisissez Modifier l'étape.

6. Au bas de l'étape, sous Configuration automatique de l'étape :, choisissez Activer la nouvelle tentative automatique en cas d'échec de l'étape. En mode Réessayer, choisissez Réessayer l'étape ayant échoué ou Réessayer les actions ayant échoué.

   

7. Choisissez d'ajouter une condition OnFailure, puis choisissez Ajouter une règle et entrez une règle pour la condition.

   1. Dans Nom de la règle, entrez le nom de votre règle. Pour cet exemple, entrez MyAlarmRule.

   2. Dans Fournisseur de règles, choisissez le fournisseur de règles préconfiguré à ajouter à votre condition. Pour cet exemple, choisissez CloudWatchAlarm, puis effectuez les étapes suivantes.

   3. Dans Région, choisissez la région correspondant à votre état ou conservez la région par défaut.

   4. Dans Nom de l'alarme, choisissez la ressource configurée pour l'alerte.

   5. Lorsque vous avez terminé de modifier la scène, choisissez OK. Sur la page de modification du pipeline, choisissez Enregistrer.

8. Après l'exécution, visualisez le résultat.

Configuration de la condition et de la ou des règles (CLI)

• Ouvrez un terminal (Linux, macOS ou Unix) ou une invite de commande (Windows) et utilisez le AWS CLI pour exécuter la update-pipeline commande, en spécifiant la condition de défaillance dans la structure du pipeline. L'exemple suivant configure une condition On Failure pour un stage nommé Deploy :

  {
      "name": "Deploy",
      "actions": [
          {
              "name": "Deploy",
              "actionTypeId": {
                  "category": "Deploy",
                  "owner": "AWS",
                  "provider": "S3",
                  "version": "1"
              },
              "runOrder": 1,
              "configuration": {
                  "BucketName": "MyBucket",
                  "Extract": "false",
                  "ObjectKey": "object.xml"
              },
              "outputArtifacts": [],
              "inputArtifacts": [
                  {
                      "name": "SourceArtifact"
                  }
              ],
              "region": "us-east-1",
              "namespace": "DeployVariables"
          }
      ],
      "onFailure": {
          "conditions": [
              {
                  "result": "ROLLBACK",
                  "rules": [
                      {
                          "name": "MyLambdaRule",
                          "ruleTypeId": {
                              "category": "Rule",
                              "owner": "AWS",
                              "provider": "LambdaInvoke",
                              "version": "1"
                          },
                          "configuration": {
                              "FunctionName": "my-function"
                          },
                          "inputArtifacts": [
                              {
                                  "name": "SourceArtifact"
                              }
                          ],
                          "region": "us-east-1"
                      }
                  ]
              }
          ]
      }
  }

  Pour plus d'informations sur la configuration des conditions de défaillance, consultez FailureConditionsla référence de l'CodePipeline API.

• Mettez à jour le modèle comme indiqué dans l'extrait suivant. L'exemple suivant configure une OnFailure condition avec une règle nommée MyMonitorRule :

  name: Deploy
  actions:
  - name: Deploy
    actionTypeId:
      category: Deploy
      owner: AWS
      provider: S3
      version: '1'
    runOrder: 1
    configuration:
      BucketName: MyBucket
      Extract: 'false'
      ObjectKey: object.xml
    outputArtifacts: []
    inputArtifacts:
    - name: SourceArtifact
    region: us-east-1
    namespace: DeployVariables
  onFailure:
    conditions:
    - result: ROLLBACK
      rules:
      - name: MyMonitorRule
        ruleTypeId:
          category: Rule
          owner: AWS
          provider: CloudWatchAlarm
          version: '1'
        configuration:
          AlarmName: AlarmOnHelloWorldInvocation
          AlarmStates: ALARM
          WaitTime: '1'
        inputArtifacts: []
        region: us-east-1
  

  Pour plus d'informations sur la configuration des conditions de défaillance, voir OnFailureStageDeclarationle Guide de l'AWS CloudFormation utilisateur ci-dessous.

Configurer une condition « En cas de réussite » (console)

1. Remplissez tous les prérequis, tels que la création de la ressource et de l'ARN pour une règle dans laquelle une ressource est fournie, telle que le AWS LambdaRule.

2. Connectez-vous à la CodePipeline console AWS Management Console et ouvrez-la à l'adresse http://console.aws.amazon. com/codesuite/codepipeline/home.

   Les noms et le statut de tous les pipelines associés à votre pipeline Compte AWS sont affichés.

3. Dans Name, choisissez le nom du pipeline que vous souhaitez modifier.

4. Sur la page des détails du pipeline, choisissez Edit.

5. Sur la page Modifier, pour l'action que vous souhaitez modifier, choisissez Modifier l'étape.

6. Choisissez Ajouter une condition de réussite. La carte des conditions de réussite sur scène s'affiche. Choisissez l'option Annulation ou Echec comme résultat disponible pour ce type de condition.

7. Choisissez Ajouter une règle, puis effectuez les opérations suivantes.

   1. Dans Nom de la règle, entrez le nom de votre condition. Pour cet exemple, entrez MyDeploymentRule.

   2. Dans Fournisseur de règles, choisissez la règle préconfigurée à ajouter à votre condition. Pour cet exemple, choisissez AWS DeploymentWindow, puis effectuez les étapes suivantes.

   3. Dans Région, choisissez la région correspondant à votre état ou conservez la région par défaut.

   4. Dans Cron, entrez l'expression cron pour la fenêtre de déploiement. L'expression cron définit les jours et heures auxquels le déploiement doit être autorisé. Pour des informations de référence sur les expressions cron, consultez la section Utilisation des expressions cron et rate pour planifier les règles.

   5. (Facultatif) Dans TimeZone, entrez le fuseau horaire de la fenêtre de déploiement.

8. Après l'exécution, visualisez le résultat.

   

Configuration de la condition et de la ou des règles (CLI)

• Ouvrez un terminal (Linux, macOS ou Unix) ou une invite de commande (Windows) et utilisez le AWS CLI pour exécuter la update-pipeline commande, en spécifiant la condition de défaillance dans la structure du pipeline. L'exemple suivant configure une condition On Success pour une étape nomméeDeploy, où la règle est nommée MyDeploymentRule :

  {
      "name": "Deploy",
      "actions": [
          {
              "name": "Deploy",
              "actionTypeId": {
                  "category": "Deploy",
                  "owner": "AWS",
                  "provider": "S3",
                  "version": "1"
              },
              "runOrder": 1,
              "configuration": {
                  "BucketName": "MyBucket",
                  "Extract": "false",
                  "ObjectKey": "object.xml"
              },
              "outputArtifacts": [],
              "inputArtifacts": [
                  {
                      "name": "SourceArtifact"
                  }
              ],
              "region": "us-east-1",
              "namespace": "DeployVariables"
          }
      ],
      "onSuccess": {
         "conditions": [
              {
                  "result": "FAIL",
                  "rules": [
                      {
                          "name": "MyAlarmRule",
                          "ruleTypeId": {
                              "category": "Rule",
                              "owner": "AWS",
                              "provider": "CloudWatchAlarm",
                              "version": "1"
                          },
                          "configuration": {
                              "AlarmName": "CWAlarm",
                              "WaitTime": "1"
                          },
                          "inputArtifacts": [],
                          "region": "us-east-1"
                      }
                  ]
              }
          ]
      }
  }

  Pour plus d'informations sur la configuration des conditions de réussite, consultez SuccessConditionsla référence des CodePipeline API.

• Mettez à jour le modèle comme indiqué dans l'extrait suivant. L'exemple suivant configure une OnSuccess condition avec une règle nommée MyDeploymentWindowRule :

  name: Deploy
  actions:
  - name: Deploy
    actionTypeId:
      category: Deploy
      owner: AWS
      provider: S3
      version: '1'
    runOrder: 1
    configuration:
      BucketName: MyBucket
      Extract: 'false'
      ObjectKey: object.xml
    outputArtifacts: []
    inputArtifacts:
    - name: SourceArtifact
    region: us-east-1
    namespace: DeployVariables
  onSuccess:
     conditions:
    - result: FAIL
      rules:
      - name: MyMonitorRule
        ruleTypeId:
          category: Rule
          owner: AWS
          provider: CloudWatchAlarm
          version: '1'
        configuration:
          AlarmName: CWAlarm
          WaitTime: '1'
        inputArtifacts: []
        region: us-east-1
  

  Pour plus d'informations sur la configuration des conditions de défaillance pour la restauration par étapes, voir OnFailurele Guide StageDeclaration de l'AWS CloudFormation utilisateur ci-dessous.

Pour supprimer une condition d'étape

1. Connectez-vous à la CodePipeline console AWS Management Console et ouvrez-la à l'adresse http://console.aws.amazon. com/codesuite/codepipeline/home.

   Les noms et le statut de tous les pipelines associés à votre pipeline Compte AWS sont affichés.

2. Dans Name, choisissez le nom du pipeline que vous souhaitez modifier.

3. Sur la page des détails du pipeline, choisissez Edit.

4. Sur la page Modifier, pour la condition que vous souhaitez modifier, choisissez Modifier l'étape.

5. À côté de la condition que vous souhaitez supprimer, choisissez Supprimer la condition.

Pour annuler une condition d'étape

1. Dans cet exemple, l'étape du pipeline est exécutée avec une condition. Le bouton Override est activé.

   

2. À côté de la condition que vous souhaitez annuler, choisissez Remplacer.

   

3. Pour consulter les détails, choisissez Réviser. Le détail de l'exemple suivant montre que le résultat configuré pour la condition est Fail, qui a été remplacé. Le statut de la règle est abandonné en raison de la dérogation.