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 structure de règles Cette section est une référence pour la configuration des règles uniquement. Pour obtenir une présentation conceptuelle de la structure du pipeline, veuillez consulter [CodePipeline référence de structure de pipeline](reference-pipeline-structure.md). Chaque fournisseur de règles CodePipeline utilise un ensemble de champs de configuration obligatoires et facultatifs dans la structure du pipeline. Cette section fournit les informations de référence suivantes par fournisseur de règles : + Valeurs valides pour les `RuleType` champs inclus dans le bloc de règles de structure du pipeline, telles que `Owner` et`Provider`. + Descriptions et autres informations de référence relatives aux `Configuration` paramètres (obligatoires et facultatifs) inclus dans la section des règles relatives à la structure du pipeline. + Exemples de champs de configuration de règles JSON et YAML valides. Des informations de référence sont disponibles pour les fournisseurs de règles suivants : **Topics** + [CloudWatchAlarm](rule-reference-CloudWatchAlarm.md) + [CodeBuild règle](rule-reference-CodeBuild.md) + [Commandes](rule-reference-Commands.md) + [DeploymentWindow](rule-reference-DeploymentWindow.md) + [LambdaInvoke](rule-reference-LambdaInvoke.md) + [VariableCheck](rule-reference-VariableCheck.md) # CloudWatchAlarm Lorsque vous créez une condition, vous pouvez ajouter la `CloudWatchAlarm` règle. Cette section fournit une référence pour les paramètres des règles. Pour plus d'informations sur les règles et conditions, consultez[Comment fonctionnent les conditions scéniques ?](concepts-how-it-works-conditions.md). Vous devez déjà avoir créé une alarme dans Amazon en CloudWatch tant que ressource distincte. **Topics** + [Type de règle](#rule-reference-CloudWatchAlarm-type) + [Paramètres de configuration](#rule-reference-CloudWatchAlarm-config) + [Exemple de configuration de règles](#rule-reference-CloudWatchAlarm-example) + [Consultez aussi](#rule-reference-CloudWatchAlarm-links) ## Type de règle + Catégorie : `Rule` + Propriétaire : `AWS` + Fournisseur : `CloudWatchAlarm` + Version : `1` ## Paramètres de configuration **AlarmName** Obligatoire : oui Le nom de l' CloudWatch alarme. Il s'agit d'une ressource distincte créée dans CloudWatch. **AlarmStates** Obligatoire : non Les états CloudWatch d'alarme souhaités pour la règle à surveiller. Les valeurs valides sont ALARM, OK et INSUSUFFISENT\$1DATA. **WaitTime** Obligatoire : non Temps d'attente en minutes pour autoriser un changement d'état avant d'exécuter le résultat de la règle. Par exemple, configurez 20 minutes pour attendre qu'un état d'alarme passe à OK avant d'appliquer le résultat de la règle. ## Exemple de configuration de règles ------ #### [ YAML ] ``` rules: - name: MyMonitorRule ruleTypeId: category: Rule owner: AWS provider: CloudWatchAlarm version: '1' configuration: AlarmName: CWAlarm WaitTime: '1' inputArtifacts: [] region: us-east-1 ``` ------ #### [ JSON ] ``` "rules": [ { "name": "MyMonitorRule", "ruleTypeId": { "category": "Rule", "owner": "AWS", "provider": "CloudWatchAlarm", "version": "1" }, "configuration": { "AlarmName": "CWAlarm", "WaitTime": "1" }, "inputArtifacts": [], "region": "us-east-1" } ] } ``` ------ ## Consultez aussi Les ressources connexes suivantes peuvent vous aider à utiliser cette règle. + [Création de conditions en cas de défaillance](stage-conditions.md#stage-conditions-onfailure)— Cette section décrit les étapes à suivre pour créer une condition En cas de défaillance avec une règle d'alarme. # CodeBuild règle Lorsque vous créez une condition, vous pouvez ajouter la CodeBuild règle. Cette section fournit une référence pour les paramètres des règles. Pour plus d'informations sur les règles et conditions, consultez[Comment fonctionnent les conditions scéniques ?](concepts-how-it-works-conditions.md). Vous pouvez utiliser la CodeBuild règle pour créer une condition dans laquelle l'exécution réussie de votre projet de génération répond aux critères de la règle, tels que la réussite de l'exécution de la génération pour une condition BeforeEntry. **Note** Pour les conditions BeforeEntry configurées avec le résultat **Skip**, seules les règles suivantes sont disponibles : `LambdaInvoke` et`VariableCheck`. **Topics** + [Autorisations de politique des rôles de service](#rule-reference-Commands-policy) + [Type de règle](#rule-reference-Commands-type) + [Paramètres de configuration](#rule-reference-Commands-config) + [Exemple de configuration de règles](#rule-reference-Commands-example) + [Consultez aussi](#rule-reference-Commands-links) ## Autorisations de politique des rôles de service Pour les autorisations relatives à cette règle, ajoutez ce qui suit à votre déclaration de politique de rôle de CodePipeline service. Limitez les autorisations au niveau des ressources. ``` { "Effect": "Allow", "Action": [ "codebuild:BatchGetBuilds", "codebuild:StartBuild" ], "Resource": "resource_ARN" }, ``` ## Type de règle + Catégorie : `Rule` + Propriétaire : `AWS` + Fournisseur : `CodeBuild` + Version : `1` ## Paramètres de configuration **ProjectName** Obligatoire : oui `ProjectName`est le nom du projet de construction dans CodeBuild. **PrimarySource** Obligatoire : Conditionnelle La valeur du `PrimarySource` paramètre doit être le nom de l'un des artefacts d'entrée de l'action. CodeBuild recherche le fichier buildspec et exécute les commandes buildspec dans le répertoire qui contient la version décompressée de cet artefact. Ce paramètre est obligatoire si plusieurs artefacts d'entrée sont spécifiés pour une action CodeBuild . Lorsqu'il n'y a qu'un seul artefact source pour l'action, l'artefact `PrimarySource` correspond par défaut à cet artefact. **BatchEnabled** Obligatoire : non La valeur booléenne du `BatchEnabled` paramètre permet à l'action d'exécuter plusieurs builds au cours de la même exécution de build. Lorsque cette option est activée, elle est disponible. `CombineArtifacts` Pour des exemples de pipeline dans lesquels les builds par lots sont activés, voir [CodePipeline Intégration avec CodeBuild et builds par lots](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-pipeline-batch.html). **CombineArtifacts** Obligatoire : non La valeur booléenne du `CombineArtifacts` paramètre combine tous les artefacts de construction d'une génération par lots dans un seul fichier d'artefact pour l'action de génération. Pour utiliser cette option, le `BatchEnabled` paramètre doit être activé. **EnvironmentVariables** Obligatoire : non La valeur de ce paramètre est utilisée pour définir des variables d'environnement pour l'action CodeBuild dans votre pipeline. La valeur du paramètre `EnvironmentVariables` prend la forme d'un tableau JSON d'objets variables d'environnement. Consultez l'exemple de paramètre dans [Déclaration d'action (CodeBuild exemple)](action-reference-CodeBuild.md#action-reference-CodeBuild-example). Chaque objet comporte trois parties, qui sont toutes des chaînes : + `name` : Nom ou clé de la variable d'environnement. + `value` : Valeur de la variable d'environnement. Lorsque vous utilisez le `SECRETS_MANAGER` type `PARAMETER_STORE` ou, cette valeur doit être le nom d'un paramètre que vous avez déjà stocké dans le magasin de paramètres de AWS Systems Manager ou d'un secret que vous avez déjà enregistré dans AWS Secrets Manager, respectivement. **Note** Nous déconseillons vivement l'utilisation de variables d'environnement pour stocker des valeurs sensibles, en particulier des AWS informations d'identification. Lorsque vous utilisez la CodeBuild console ou la AWS CLI, les variables d'environnement sont affichées en texte brut. Pour les valeurs sensibles, nous vous recommandons d'utiliser plutôt le type `SECRETS_MANAGER`. + `type` : (facultatif) Type de la variable d'environnement. Les valeurs valides sont `PARAMETER_STORE`, `SECRETS_MANAGER` ou `PLAINTEXT`. Si rien spécifié, la valeur par défaut est `PLAINTEXT`. Lorsque vous entrez la configuration `name``value`, et `type` pour vos variables d'environnement, en particulier si la variable d'environnement contient une syntaxe de variable de CodePipeline sortie, ne dépassez pas la limite de 1 000 caractères pour le champ de valeur de la configuration. Une erreur de validation est renvoyée lorsque cette limite est dépassée. Pour plus d'informations, consultez [ EnvironmentVariable](https://docs.aws.amazon.com/codebuild/latest/APIReference/API_EnvironmentVariable.html)la référence de AWS CodeBuild l'API. Pour un exemple CodeBuild d'action avec une variable d'environnement qui correspond au nom de la GitHub branche, consultez[Exemple : utilisation d'une BranchName variable avec des variables d' CodeBuild environnement](actions-variables.md#actions-variables-examples-env-branchname). ## Exemple de configuration de règles ------ #### [ YAML ] ``` name: codebuild-rule ruleTypeId: category: Rule owner: AWS provider: CodeBuild version: '1' configuration: ProjectName: my-buildproject EnvironmentVariables: '[{"name":"VAR1","value":"variable","type":"PLAINTEXT"}]' inputArtifacts: - name: SourceArtifact region: us-east-1 ``` ------ #### [ JSON ] ``` { "name": "codebuild-rule", "ruleTypeId": { "category": "Rule", "owner": "AWS", "provider": "CodeBuild", "version": "1" }, "configuration": { "ProjectName": "my-buildproject" }, "inputArtifacts": [ { "name": "SourceArtifact", "EnvironmentVariables": "[{\"name\":\"VAR1\",\"value\":\"variable\",\"type\":\"PLAINTEXT\"}]" } ], "region": "us-east-1" } ``` ------ ## Consultez aussi Les ressources connexes suivantes peuvent vous aider à utiliser cette règle. + Pour plus d'informations sur les règles et conditions, consultez la section [Condition](https://docs.aws.amazon.com/codepipeline/latest/APIReference/API_Condition.html) et [RuleExecution](https://docs.aws.amazon.com/codepipeline/latest/APIReference/API_RuleExecution.html)le *guide de l'CodePipeline API*. [RuleTypeId](https://docs.aws.amazon.com/codepipeline/latest/APIReference/API_RuleTypeId.html) # Commandes Lorsque vous créez une condition, vous pouvez ajouter la `Commands` règle. Cette section fournit une référence pour les paramètres des règles. Pour plus d'informations sur les règles et conditions, consultez[Comment fonctionnent les conditions scéniques ?](concepts-how-it-works-conditions.md). Vous pouvez utiliser la `Commands` règle pour créer une condition dans laquelle les commandes réussies répondent aux critères de la règle, tels que le chemin de sortie et de fichier des commandes réussies pour une condition BeforeEntry. **Note** Pour les conditions BeforeEntry configurées avec le résultat **Skip**, seules les règles suivantes sont disponibles : `LambdaInvoke` et`VariableCheck`. **Topics** + [Considérations relatives à la règle des commandes](#rule-reference-Commands-considerations) + [Autorisations de politique des rôles de service](#rule-reference-Commands-policy) + [Type de règle](#rule-reference-Commands-type) + [Paramètres de configuration](#rule-reference-Commands-config) + [Exemple de configuration de règles](#rule-reference-Commands-example) + [Consultez aussi](#rule-reference-Commands-links) ## Considérations relatives à la règle des commandes Les considérations suivantes s'appliquent à la règle Commandes. + La règle des commandes utilise CodeBuild des ressources similaires à l' CodeBuild action, tout en autorisant les commandes de l'environnement shell dans une instance de calcul virtuelle sans qu'il soit nécessaire d'associer ou de créer un projet de génération. **Note** L'exécution de la règle des commandes entraînera des frais distincts. AWS CodeBuild + Comme la règle Commands CodePipeline utilise CodeBuild des ressources, les builds exécutés par l'action seront attribués aux limites de build de votre compte dans CodeBuild. Les builds exécutés selon la règle Commands seront pris en compte dans les limites de build simultanées configurées pour ce compte. + Le délai d'expiration des builds utilisant la règle Commands est de 55 minutes, selon les CodeBuild builds. + L'instance de calcul utilise un environnement de construction isolé dans CodeBuild. **Note** Étant donné que l'environnement de construction isolé est utilisé au niveau du compte, une instance peut être réutilisée pour une autre exécution de pipeline. + Tous les formats sont pris en charge, à l'exception des formats multilignes. Vous devez utiliser le format d'une seule ligne lors de la saisie des commandes. + Pour cette règle, CodePipeline assumera le rôle de service de pipeline et utilisera ce rôle pour autoriser l'accès aux ressources lors de l'exécution. Il est recommandé de configurer le rôle de service de manière à ce que les autorisations soient limitées au niveau de l'action. + Les autorisations ajoutées au rôle CodePipeline de service sont détaillées dans[Ajouter des autorisations au rôle CodePipeline de service](how-to-custom-role.md#how-to-update-role-new-services). + Les autorisations nécessaires pour consulter les journaux dans la console sont détaillées dans[Autorisations requises pour consulter les journaux de calcul dans la console](security-iam-permissions-console-logs.md). Dans les exemples d'écrans suivants, utilisez le lien **Journaux** pour afficher les journaux indiquant si une règle de commandes a été utilisée correctement dans les CloudWatch journaux. ![\[La page d'état d'un pipeline avec la règle Commandes\]](http://docs.aws.amazon.com/fr_fr/codepipeline/latest/userguide/images/commands-rule-status.png) ![\[La page Logs CloudWatch pour un pipeline avec la règle Commands\]](http://docs.aws.amazon.com/fr_fr/codepipeline/latest/userguide/images/commands-rule-logs.png) + Contrairement aux autres actions dans CodePipeline, vous ne définissez pas de champs dans la configuration des actions ; vous définissez les champs de configuration des actions en dehors de la configuration des actions. ## Autorisations de politique des rôles de service Lors de l' CodePipeline exécution de la règle, CodePipeline crée un groupe de journaux en utilisant le nom du pipeline comme suit. Cela vous permet de limiter les autorisations de journalisation des ressources en utilisant le nom du pipeline. ``` /aws/codepipeline/MyPipelineName ``` Si vous utilisez un rôle de service existant, pour utiliser l'action Commandes, vous devez ajouter les autorisations suivantes pour le rôle de service. + journaux : CreateLogGroup + journaux : CreateLogStream + journaux : PutLogEvents Dans la déclaration de politique relative aux rôles de service, limitez les autorisations au niveau du pipeline, comme indiqué dans l'exemple suivant. ``` { "Effect": "Allow", "Action": [ "logs:CreateLogGroup", "logs:CreateLogStream", "logs:PutLogEvents" ], "Resource": "arn:aws:logs:*:YOUR_AWS_ACCOUNT_ID:log-group:/aws/codepipeline/YOUR_PIPELINE_NAME:*" } ``` Pour afficher les journaux dans la console à l'aide de la page de dialogue des détails de l'action, l'autorisation d'afficher les journaux doit être ajoutée au rôle de console. Pour plus d'informations, consultez l'exemple de politique d'autorisation de console dans[Autorisations requises pour consulter les journaux de calcul dans la console](security-iam-permissions-console-logs.md). ## Type de règle + Catégorie : `Rule` + Propriétaire : `AWS` + Fournisseur : `Commands` + Version : `1` ## Paramètres de configuration **Commandes** Obligatoire : oui Vous pouvez fournir des commandes shell pour que la `Commands` règle s'exécute. Dans la console, les commandes sont entrées sur des lignes séparées. Dans la CLI, les commandes sont entrées sous forme de chaînes distinctes. Les formats multilignes ne sont pas pris en charge et un message d'erreur s'affichera. Le format d'une seule ligne doit être utilisé pour saisir des commandes dans le champ **Commandes**. Les informations suivantes indiquent le calcul par défaut utilisé pour la règle Commands. Pour plus d'informations, consultez la section Référence [des modes et types de calcul de l'environnement](https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html) de génération dans le guide de CodeBuild l'utilisateur. + **CodeBuild image : aws/codebuild/amazonlinux 2-x86\$164 standard :** 5.0 + **Type de calcul :** Linux Small + **Valeur ComputeType de l'environnement** : BUILD\$1 \$1SMALL GENERAL1 + **Valeur du type d'environnement :** LINUX\$1CONTAINER ## Exemple de configuration de règles ------ #### [ YAML ] ``` result: FAIL rules: - name: CommandsRule ruleTypeId: category: Rule owner: AWS provider: Commands version: '1' configuration: {} commands: - ls - printenv inputArtifacts: - name: SourceArtifact region: us-east-1 ``` ------ #### [ JSON ] ``` { "result": "FAIL", "rules": [ { "name": "CommandsRule", "ruleTypeId": { "category": "Rule", "owner": "AWS", "provider": "Commands", "version": "1" }, "configuration": {}, "commands": [ "ls", "printenv" ], "inputArtifacts": [ { "name": "SourceArtifact" } ], "region": "us-east-1" } ] } ``` ------ ## Consultez aussi Les ressources connexes suivantes peuvent vous aider à utiliser cette règle. + Pour plus d'informations sur les règles et conditions, consultez la section [Condition](https://docs.aws.amazon.com/codepipeline/latest/APIReference/API_Condition.html) et [RuleExecution](https://docs.aws.amazon.com/codepipeline/latest/APIReference/API_RuleExecution.html)le *guide de l'CodePipeline API*. [RuleTypeId](https://docs.aws.amazon.com/codepipeline/latest/APIReference/API_RuleTypeId.html) # DeploymentWindow Lorsque vous créez une condition, vous pouvez ajouter la `DeploymentWindow` règle. Cette section fournit une référence pour les paramètres des règles. Pour plus d'informations sur les règles et conditions, consultez[Comment fonctionnent les conditions scéniques ?](concepts-how-it-works-conditions.md). **Topics** + [Type de règle](#rule-reference-DeploymentWindow-type) + [Paramètres de configuration](#rule-reference-DeploymentWindow-config) + [Exemple de configuration de règles](#rule-reference-DeploymentWindow-example) + [Consultez aussi](#rule-reference-DeploymentWindow-links) ## Type de règle + Catégorie : `Rule` + Propriétaire : `AWS` + Fournisseur : `DeploymentWindow` + Version : `1` ## Paramètres de configuration **Cron** Obligatoire : oui Expression qui définit les jours et heures auxquels le déploiement sera autorisé. Les expressions Cron sont composées de 6 champs obligatoires et d'un champ facultatif séparés par un espace. Les champs d'expression cron vous permettent de spécifier un modèle de planification avec une expression cron comme suit. **** [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/fr_fr/codepipeline/latest/userguide/rule-reference-DeploymentWindow.html) + Le caractère « \$1 » est utilisé pour spécifier toutes les valeurs. Par exemple, « \$1 » dans le champ des minutes signifie « toutes les minutes ». + Le « ? » le caractère est autorisé pour les day-of-week champs day-of-month et. Il est utilisé pour spécifier « aucune valeur spécifique ». Cela est utile lorsque vous devez spécifier quelque chose dans l'un des deux champs, mais pas dans l'autre. + Le caractère « - » est utilisé pour spécifier des plages. Par exemple, « 10-12 » dans le champ des heures signifie « les heures 10, 11 et 12 ». + Le caractère «, » est utilisé pour spécifier des valeurs supplémentaires. Par exemple, « LUNDI, MERCREDI, VENDREDI » dans le day-of-week champ signifie « les jours du lundi, du mercredi et du vendredi ». + Le caractère «/» est utilisé pour spécifier les incréments. Par exemple, « 0/15 » dans le champ des secondes signifie « les secondes 0, 15, 30 et 45 ». Et « 5/15 » dans le champ des secondes signifie « les secondes 5, 20, 35 et 50 ». Spécifier « \$1 » avant le «/» équivaut à spécifier 0 comme valeur de départ. + Le caractère « L » est autorisé pour les day-of-week champs day-of-month et. Ce caractère est un raccourci pour « dernier », mais il a une signification différente dans chacun des deux champs. Par exemple, la valeur « L » dans le day-of-month champ signifie « le dernier jour du mois » : 31 pour janvier, 28 pour février les années non bissextiles. S'il est utilisé seul day-of-week sur le terrain, cela signifie simplement « 7 » ou « SAT ». Mais s'il est utilisé dans le day-of-week champ après une autre valeur, cela signifie « le dernier jour du mois ». Par exemple, « 6L » signifie « le dernier vendredi du mois ». Vous pouvez également spécifier un décalage par rapport au dernier jour du mois, tel que « L-3 » qui signifierait le third-to-last jour du mois civil. + Le caractère « W » est autorisé day-of-month dans le champ. Ce caractère est utilisé pour indiquer le jour de la semaine (du lundi au vendredi) le plus proche du jour donné. Par exemple, si vous deviez spécifier « 15 W » comme valeur du day-of-month champ, cela signifierait : « le jour de la semaine le plus proche du 15 du mois ». Donc, si le 15 est un samedi, le déclencheur se déclenchera le vendredi 14. Si le 15 est un dimanche, le déclencheur se déclenchera le lundi 16. Si le 15 est un mardi, il se déclenchera le mardi 15. + Les caractères « L » et « W » peuvent également être combinés pour que l' day-of-monthexpression produise « LW », qui se traduit par « dernier jour de semaine du mois ». + Le caractère « \$1 » est autorisé pour le day-of-week champ. Ce caractère est utilisé pour indiquer « le nième » jour du mois. Par exemple, la valeur « 6 \$13 » dans le day-of-week champ signifie le troisième vendredi du mois (jour 6 = vendredi et « \$13 » = le troisième du mois). + Les caractères juridiques et les noms des mois et des jours de la semaine ne distinguent pas les majuscules et minuscules. **TimeZone** Obligatoire : non Fuseau horaire correspondant à la fenêtre de déploiement. L'expression régulière correspond à des modèles dans les formats suivants : + **Format région/ville**. La valeur correspond à un fuseau horaire au format Region/City Region/City\$1City. Par exemple, `America/New_York` ou `Europe/Berlin`. + **Format UTC**. La valeur correspond à la chaîne UTC suivie éventuellement d'un décalage au format \$1HH:MM ou -HH:MM. Par exemple, ou. `UTC` `UTC+05:30` `UTC-03:00` Il s'agit du format par défaut si le paramètre n'est pas défini autrement. + **Format d'abréviation**. La valeur correspond à une abréviation de 3 à 5 caractères pour un fuseau horaire. Par exemple, `EST` ou `IST`. Pour un tableau des valeurs d' TimeZoneidentification valides, voir [https://docs.oracle.com/middleware/1221/ wcs/tag-ref/MISC/TimeZones](https://docs.oracle.com/middleware/1221/wcs/tag-ref/MISC/TimeZones.html) .html. Notez que certaines abréviations sont des abréviations dupliquées, telles que CST pour l'heure normale du Centre, l'heure normale de Chine et l'heure normale de Cuba. ## Exemple de configuration de règles ------ #### [ YAML ] ``` - name: MyDeploymentRule ruleTypeId: category: Rule owner: AWS provider: DeploymentWindow version: '1' configuration: Cron: 0 0 9-17 ? * MON-FRI * TimeZone: PST inputArtifacts: [] region: us-east-1 ``` ------ #### [ JSON ] ``` [ { "name": "MyDeploymentRule", "ruleTypeId": { "category": "Rule", "owner": "AWS", "provider": "DeploymentWindow", "version": "1" }, "configuration": { "Cron": "0 0 9-17 ? * MON-FRI *", "TimeZone": "PST" }, "inputArtifacts": [], "region": "us-east-1" } ] ``` ------ ## Consultez aussi Les ressources connexes suivantes peuvent vous aider à utiliser cette règle. + [Conditions de création en cas de réussite](stage-conditions.md#stage-conditions-onsuccess)— Cette section décrit les étapes à suivre pour créer une condition En cas de réussite avec une règle de fenêtre de déploiement. + Pour plus d'informations sur les règles et conditions, consultez la section [Condition](https://docs.aws.amazon.com/codepipeline/latest/APIReference/API_Condition.html) et [RuleExecution](https://docs.aws.amazon.com/codepipeline/latest/APIReference/API_RuleExecution.html)le *guide de l'CodePipeline API*. [RuleTypeId](https://docs.aws.amazon.com/codepipeline/latest/APIReference/API_RuleTypeId.html) # LambdaInvoke Lorsque vous créez une condition, vous pouvez ajouter la `LambdaInvoke` règle. Cette section fournit une référence pour les paramètres des règles. Pour plus d'informations sur les règles et conditions, consultez[Comment fonctionnent les conditions scéniques ?](concepts-how-it-works-conditions.md). Vous devez déjà avoir créé une fonction dans Lambda en tant que ressource distincte. **Topics** + [Type de règle](#rule-reference-CloudWatchAlarm-type) + [Paramètres de configuration](#rule-reference-LambdaInvoke-config) + [Exemple de configuration de règles](#rule-reference-LambdaInvoke-example) + [Consultez aussi](#rule-reference-LambdaInvoke-links) ## Type de règle + Catégorie : `Rule` + Propriétaire : `AWS` + Fournisseur : `LambdaInvoke` + Version : `1` ## Paramètres de configuration **FunctionName** Obligatoire : oui Nom de la fonction Lambda. **UserParameters** Obligatoire : non Il s'agit de paramètres fournis en entrée pour la fonction sous forme de paire clé-valeur. ## Exemple de configuration de règles ------ #### [ YAML ] ``` - name: MyLambdaRule ruleTypeId: category: Rule owner: AWS provider: LambdaInvoke version: '1' configuration: FunctionName: my-function inputArtifacts: - name: SourceArtifact region: us-east-1 ``` ------ #### [ JSON ] ``` [ { "name": "MyLambdaRule", "ruleTypeId": { "category": "Rule", "owner": "AWS", "provider": "LambdaInvoke", "version": "1" }, "configuration": { "FunctionName": "my-function" }, "inputArtifacts": [ { "name": "SourceArtifact" } ], "region": "us-east-1" } ] ``` ------ ## Consultez aussi Les ressources connexes suivantes peuvent vous aider à utiliser cette règle. + [Création de conditions en cas de défaillance](stage-conditions.md#stage-conditions-onfailure)— Cette section décrit les étapes à suivre pour créer une condition En cas de défaillance avec une règle d'alarme. # VariableCheck Lorsque vous créez une condition, vous pouvez ajouter la `VariableCheck` règle. Cette section fournit une référence pour les paramètres des règles. Pour plus d'informations sur les règles et conditions, consultez[Comment fonctionnent les conditions scéniques ?](concepts-how-it-works-conditions.md). Vous pouvez utiliser la `VariableCheck` règle pour créer une condition dans laquelle la variable de sortie est vérifiée par rapport à une expression fournie. La règle passe le contrôle lorsque la valeur de la variable répond aux critères de la règle, tels que la valeur égale ou supérieure à une variable de sortie spécifiée. **Topics** + [Type de règle](#rule-reference-VariableCheck-type) + [Paramètres de configuration](#rule-reference-VariableCheck-config) + [Exemple de configuration de règles](#rule-reference-VariableCheck-example) + [Consultez aussi](#rule-reference-VariableCheck-links) ## Type de règle + Catégorie : `Rule` + Propriétaire : `AWS` + Fournisseur : `VariableCheck` + Version : `1` ## Paramètres de configuration **Opérateur** Obligatoire : oui L'opérateur qui indique l'opération à effectuer pour le contrôle des variables. Dans l'exemple suivant, la variable de sortie pour le nom du référentiel sera vérifiée pour savoir si elle est égale à`MyDemoRepo`. ``` "configuration": { "Variable": "#{SourceVariables.RepositoryName}", "Value": "MyDemoRepo", "Operator": "EQ" }, ``` Les opérateurs suivants sont disponibles pour créer une expression comme suit. + **Égal** - Choisissez cet opérateur pour vérifier si la variable est égale à la valeur de la chaîne. **Paramètre CLI :** `EQ` + **Contient** : choisissez cet opérateur pour vérifier si la variable contient la valeur de la chaîne sous forme de sous-chaîne. **Paramètre CLI :** `CONTAINS` + **Correspondances** : choisissez cet opérateur pour vérifier si la variable correspond à une expression régulière donnée en tant que valeur de chaîne. Toutes les expressions régulières CodePipeline sont conformes à la syntaxe Java regex. Pour une description complète de cette syntaxe et de ses constructions, consultez [java.util.regex.Pattern](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/regex/Pattern.html). **Paramètre CLI :** `MATCHES` + **Non égal** - Choisissez cet opérateur pour vérifier si la variable n'est pas égale à la valeur de la chaîne. **Paramètre CLI :** `NE` **Variable** Obligatoire : oui Les variables de pipeline à vérifier. **Value** Obligatoire : oui La valeur de l'expression à vérifier. Dans l'exemple suivant, la variable de sortie pour le nom du référentiel sera vérifiée pour savoir si elle est égale à`MyDemoRepo`. ``` "configuration": { "Variable": "#{SourceVariables.RepositoryName}", "Value": "MyDemoRepo", "Operator": "EQ" }, ``` Dans l'exemple JSON suivant, deux règles distinctes sont définies, l'une pour une instruction `EQ` (equals) qui vérifie le dépôt et le nom de branche au format \$1 \$1SourceVariables. RepositoryName\$1 et un pour `CONTAINS` cela vérifie la variable de sortie du message de validation formatée sous la forme \$1 \$1SourceVariables. CommitMessage\$1 contre la valeur « update » fournie. ``` "beforeEntry": { "conditions": [ { "result": "FAIL", "rules": [ { "name": "MyVarCheckRule", "ruleTypeId": { "category": "Rule", "owner": "AWS", "provider": "VariableCheck", "version": "1" }, "configuration": { "Operator": "EQ", "Value": "MyDemoRepo", "Variable": "#{SourceVariables.RepositoryName}" }, "inputArtifacts": [], "region": "us-east-1" }, { "name": "MyVarCheckRuleContains", "ruleTypeId": { "category": "Rule", "owner": "AWS", "provider": "VariableCheck", "version": "1" }, "configuration": { "Operator": "CONTAINS", "Value": "update", "Variable": "#{SourceVariables.CommitMessage}" }, "inputArtifacts": [], "region": "us-east-1" } ] } ] } } ], ``` ## Exemple de configuration de règles ------ #### [ YAML ] ``` - name: MyVariableCheck ruleTypeId: category: Rule owner: AWS provider: VariableCheck version: '1' configuration: Variable: "#{SourceVariables.RepositoryName}" Value: MyDemoRepo Operator: EQ inputArtifacts: [] region: us-west-2 ``` ------ #### [ JSON ] ``` "rules": [ { "name": "MyVariableCheck", "ruleTypeId": { "category": "Rule", "owner": "AWS", "provider": "VariableCheck", "version": "1" }, "configuration": { "Variable": "#{SourceVariables.RepositoryName}", "Value": "MyDemoRepo", "Operator": "EQ" }, "inputArtifacts": [], "region": "us-west-2" } ] ``` ------ ## Consultez aussi Les ressources connexes suivantes peuvent vous aider à utiliser cette règle. + [Tutoriel : Création d'une règle de vérification des variables pour un pipeline comme condition d'entrée](tutorials-varcheckrule.md)— Cette section fournit un didacticiel expliquant les étapes à suivre pour créer une condition On Entry avec une règle de vérification des variables. + [Référence aux variables](reference-variables.md)— Cette section fournit des informations de référence et des exemples pour les variables de pipeline. + Pour plus d'informations sur les règles et conditions, consultez la section [Condition](https://docs.aws.amazon.com/codepipeline/latest/APIReference/API_Condition.html) et [RuleExecution](https://docs.aws.amazon.com/codepipeline/latest/APIReference/API_RuleExecution.html)le *guide de l'CodePipeline API*. [RuleTypeId](https://docs.aws.amazon.com/codepipeline/latest/APIReference/API_RuleTypeId.html)