Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

AppSpec “钩子” 部分

AppSpec 文件'hooks'部分中的内容因部署的计算平台而异。EC2/本地部署'hooks'部分包含将部署生命周期事件挂钩链接到一个或多个脚本的映射。有关 Lambda 或 Amazon ECS 部署的'hooks'部分指定了在部署生命周期事件期间运行的 Lambda 验证函数。如果某个事件的挂钩不存在，则不会对该事件执行任何操作。只有在部署过程中运行脚本或 Lambda 验证函数时，才需要此部分。

AppSpec 亚马逊 ECS 部署的 “挂钩” 部分

Amazon ECS 部署的生命周期事件挂钩列表

AmazonLambda 挂接是一个 Lambda 函数，在生命周期事件名称后的新行中使用字符串指定。对于每次部署，每个挂钩将执行一次。以下是生命周期事件的描述，您可以在 Amazon ECS 部署期间运行挂钩。

有关更多信息，请参阅 Amazon ECS 部署期间会发生什么 和 教程：通过验证测试部署 Amazon ECS 服务。

在 Amazon ECS 部署中运行挂钩顺序

在 Amazon ECS 部署中，事件挂钩按以下顺序运行：

“钩子” 部分的结构

以下示例说明了 'hooks' 部分的结构。

使用 YAML：

Hooks:
  - BeforeInstall: "BeforeInstallHookFunctionName"
  - AfterInstall: "AfterInstallHookFunctionName"
  - AfterAllowTestTraffic: "AfterAllowTestTrafficHookFunctionName"
  - BeforeAllowTraffic: "BeforeAllowTrafficHookFunctionName"
  - AfterAllowTraffic: "AfterAllowTrafficHookFunctionName"

使用 JSON：

"Hooks": [
		{
			"BeforeInstall": "BeforeInstallHookFunctionName"
		},
		{
			"AfterInstall": "AfterInstallHookFunctionName"
		},
		{
			"AfterAllowTestTraffic": "AfterAllowTestTrafficHookFunctionName"
		},
		{
			"BeforeAllowTraffic": "BeforeAllowTrafficHookFunctionName"
		},
		{
			"AfterAllowTraffic": "AfterAllowTrafficHookFunctionName"
		}
	]
}

示例 Lambda “挂钩” 函数

使用'hooks'部分指定 Lambda 函数，该函数 CodeDeploy 可以调用的用于验证 Amazon ECS 部署的 Lambda 函数。对于 BeforeInstall、AfterInstall、AfterAllowTestTraffic、BeforeAllowTraffic 和 AfterAllowTraffic 部署生命周期事件，您可以使用相同函数或不同函数。验证测试完成后，LambdaAfterAllowTraffic 函数会回调 CodeDeploy 并提供Succeeded或结果Failed。

在调用 Lambda 挂接函数之前，必须使用putLifecycleEventHookExecutionStatus命令将部署 ID 和生命周期事件挂接执行 ID 通知服务器。

以下是用 Node.js 编写的 Lambda 挂接函数示例。

'use strict';

const aws = require('aws-sdk');
const codedeploy = new aws.CodeDeploy({apiVersion: '2014-10-06'});

exports.handler = (event, context, callback) => {
    //Read the DeploymentId from the event payload.
    var deploymentId = event.DeploymentId;

    //Read the LifecycleEventHookExecutionId from the event payload
    var lifecycleEventHookExecutionId = event.LifecycleEventHookExecutionId;

    /*
     Enter validation tests here.
    */

    // Prepare the validation test results with the deploymentId and
    // the lifecycleEventHookExecutionId for CodeDeploy.
    var params = {
        deploymentId: deploymentId,
        lifecycleEventHookExecutionId: lifecycleEventHookExecutionId,
        status: 'Succeeded' // status can be 'Succeeded' or 'Failed'
    };
    
    // Pass CodeDeploy the prepared validation test results.
    codedeploy.putLifecycleEventHookExecutionStatus(params, function(err, data) {
        if (err) {
            // Validation failed.
            callback('Validation test failed');
        } else {
            // Validation succeeded.
            callback(null, 'Validation test succeeded');
        }
    });
};

AppSpec AmazonLambda 部署的 “挂钩” 部分

AmazonLambda 部署的生命周期事件挂钩列表

AmazonLambda 挂接是一个 Lambda 函数，在生命周期事件名称后的新行中使用字符串指定。对于每次部署，每个挂钩将执行一次。以下是可在您的 AppSpec 文件中使用的挂钩的描述。

在 Lambda 函数版本部署中挂钩的运行顺序

在无服务器 Lambda 函数版本部署中，事件挂钩按以下顺序运行：

“钩子” 部分的结构

以下示例说明了“hooks”部分的结构。

使用 YAML：

hooks:
   - BeforeAllowTraffic: BeforeAllowTrafficHookFunctionName
   - AfterAllowTraffic: AfterAllowTrafficHookFunctionName

使用 JSON：

"hooks": [{
    "BeforeAllowTraffic": "BeforeAllowTrafficHookFunctionName"
    },
    {
    "AfterAllowTraffic": "AfterAllowTrafficHookFunctionName"
}]

示例 Lambda “挂钩” 函数

使用 “钩指定 CodeDeploy 可以调用的用于验证 Lambda 部署的 Lambda 函数。对于 BeforeAllowTraffic 和 AfterAllowTraffic 部署生命周期事件，您可以使用相同函数或不同函数。验证测试完成后，Lambda 验证函数会回调 CodeDeploy 并提供Succeeded或结果Failed。

在调用 Lambda 挂接函数之前，必须使用putLifecycleEventHookExecutionStatus命令将部署 ID 和生命周期事件挂接执行 ID 通知服务器。

以下是用 Node.js 编写的 Lambda 挂接函数示例。

'use strict';

const aws = require('aws-sdk');
const codedeploy = new aws.CodeDeploy({apiVersion: '2014-10-06'});

exports.handler = (event, context, callback) => {
    //Read the DeploymentId from the event payload.
    var deploymentId = event.DeploymentId;

    //Read the LifecycleEventHookExecutionId from the event payload
    var lifecycleEventHookExecutionId = event.LifecycleEventHookExecutionId;

    /*
     Enter validation tests here.
    */

    // Prepare the validation test results with the deploymentId and
    // the lifecycleEventHookExecutionId for CodeDeploy.
    var params = {
        deploymentId: deploymentId,
        lifecycleEventHookExecutionId: lifecycleEventHookExecutionId,
        status: 'Succeeded' // status can be 'Succeeded' or 'Failed'
    };
    
    // Pass CodeDeploy the prepared validation test results.
    codedeploy.putLifecycleEventHookExecutionStatus(params, function(err, data) {
        if (err) {
            // Validation failed.
            callback('Validation test failed');
        } else {
            // Validation succeeded.
            callback(null, 'Validation test succeeded');
        }
    });
};

AppSpec EC2/本地部署

生命周期事件挂钩列表

每次部署到实例时，EC2/本地部署挂接都会执行一次。在一个挂钩中，可以指定运行一个或多个脚本。生命周期事件的每个挂钩在单独的行中使用字符串指定。以下是可在您的 AppSpec 文件中使用的挂钩的描述。

有关哪些生命周期事件挂钩对哪些部署和回滚类型有效的信息，请参阅Lifecycle event hook availability。

Lifecycle event hook availability

下表列出了适用于每个部署和回滚方案的生命周期事件挂钩。

部署中挂钩的运行顺序

就地部署

在就地部署中 (包括就地部署的回滚)，事件挂钩按以下顺序运行：

蓝/绿部署

在蓝/绿部署中，事件挂钩按以下顺序运行：

“钩子” 部分的结构

'hooks' 部分具有以下结构：

hooks:
   deployment-lifecycle-event-name:
     - location: script-location
       timeout: timeout-in-seconds
       runas: user-name

可以在 hook 条目中的部署生命周期事件名称后包括以下元素：

挂钩的环境变量可用性

在每个部署生命周期事件期间，挂钩脚本可以访问以下环境变量：

这些是每个部署生命周期事件的本地环境变量。

根据部署包的来源，还有其他可用于挂接脚本的环境变量：

来自Amazon S3 的捆绑包

捆绑来自 GitHub

如果 DEPLOYMENT_GROUP_NAME 的值等于 Staging，则以下脚本会将 Apache HTTP 服务器上的侦听端口更改为 9090 而非 80。必须在 BeforeInstall 部署生命周期事件期间调用此脚本：

if [ "$DEPLOYMENT_GROUP_NAME" == "Staging" ]
then
    sed -i -e 's/Listen 80/Listen 9090/g' /etc/httpd/conf/httpd.conf
fi

如果 DEPLOYMENT_GROUP_NAME 环境变量的值等于 Staging，则以下脚本示例会将其错误日志中记录的消息的详细级别从警告更改为调试。必须在 BeforeInstall 部署生命周期事件期间调用此脚本：

if [ "$DEPLOYMENT_GROUP_NAME" == "Staging" ]
then
    sed -i -e 's/LogLevel warn/LogLevel debug/g' /etc/httpd/conf/httpd.conf
fi

以下脚本示例将指定网页中的文本替换为显示这些环境变量值的文本。必须在 AfterInstall 部署生命周期事件期间调用此脚本：

#!/usr/bin/python

import os
 
strToSearch="<h2>This application was deployed using CodeDeploy.</h2>"
strToReplace="<h2>This page for "+os.environ['APPLICATION_NAME']+" application and "+os.environ['DEPLOYMENT_GROUP_NAME']+" deployment group with "+os.environ['DEPLOYMENT_GROUP_ID']+" deployment group ID was generated by a "+os.environ['LIFECYCLE_EVENT']+" script during "+os.environ['DEPLOYMENT_ID']+" deployment.</h2>"
 
fp=open("/var/www/html/index.html","r")
buffer=fp.read()
fp.close()
 
fp=open("/var/www/html/index.html","w")
fp.write(buffer.replace(strToSearch,strToReplace))
fp.close()

钩子示例

以下是 hooks 条目的示例，该条目为 AfterInstall 生命周期事件指定两个挂钩：

hooks:
   AfterInstall:
     - location: Scripts/RunResourceTests.sh
       timeout: 180
     - location: Scripts/PostDeploy.sh
       timeout: 180

Scripts/RunResourceTests.sh 脚本在部署过程的 AfterInstall 阶段运行。如果该脚本的运行时间超过 180 秒（3 分钟），则部署将失败。

您在“hooks”部分中指定的脚本的位置是应用程序修订包根目录的相对路径。在上述示例中，名为 RunResourceTests.sh 的文件位于名为 Scripts 的目录中。该 Scripts 目录位于包的根级别。有关更多信息，请参阅计划 CodeDeploy 的修订：