本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

AppSpec 「掛鉤」區段

AppSpec 檔案 'hooks'區段中的內容會因部署的運算平台而異。EC2/內部部署的 'hooks'區段包含將部署生命週期事件掛鉤連結至一或多個指令碼的映射。Lambda 或 Amazon ECS 部署的 'hooks'區段指定要在部署生命週期事件期間執行的 Lambda 驗證函數。如果事件勾點不存在，則不會為該事件執行任何操作。只有在您作為部署的一部分執行指令碼或 Lambda 驗證函數時，才需要本節。

AppSpec Amazon ECS 部署的 'hooks' 區段

Amazon ECS 部署的生命週期事件掛鉤清單

AWS Lambda 掛鉤是 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' 函數範例

使用 'hooks'區段指定 CodeDeploy 可呼叫的 Lambda 函數，以驗證 Amazon ECS 部署。您可以針對 BeforeInstall、AfterInstall、BeforeAllowTraffic、 AfterAllowTestTraffic和 AfterAllowTraffic 部署生命週期事件使用相同的函數或不同的函數。完成驗證測試後，Lambda AfterAllowTraffic函數會回 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 AWS Lambda 部署的 'hooks' 區段

AWS Lambda 部署的生命週期事件掛鉤清單

AWS Lambda 掛鉤是 Lambda 函數，指定的字串位於生命週期事件名稱後面的新行上。每個部署執行每個勾點一次。以下是 AppSpec 檔案中可用掛鉤的說明。

在 Lambda 函數版本部署中執行掛鉤順序

在無伺服器 Lambda 函數版本部署中，事件掛鉤會以下列順序執行：

「掛鉤」區段的結構

下列為 'hooks' 部分的結構範例。

使用 YAML：

hooks:
   - BeforeAllowTraffic: BeforeAllowTrafficHookFunctionName
   - AfterAllowTraffic: AfterAllowTrafficHookFunctionName

使用 JSON：

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

Lambda 'hooks' 函數範例

使用 'hooks' 區段指定 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 檔案中可用掛鉤的說明。

如需有關哪些生命週期事件勾點對於哪些部署和復原類型有效的詳細資訊，請參閱生命週期事件掛鉤可用性。

生命週期事件掛鉤可用性

下表列出生命週期事件勾點可用於每一個部署及復原案例。

在部署中執行掛鉤順序

Auto Scaling 啟動部署

在 Auto Scaling 啟動部署期間， 會以下列順序 CodeDeploy 執行事件掛鉤。

如需 Auto Scaling 啟動部署的詳細資訊，請參閱 亞馬遜 EC2 Auto Scaling 如何與 CodeDeploy。

Auto Scaling 終止部署

在 Auto Scaling 終止部署期間， 會以下列順序 CodeDeploy 執行事件掛鉤。

如需 Auto Scaling 終止部署的詳細資訊，請參閱 在 Auto Scaling 擴充事件期間啟用終止部署。

就地部署：

在就地部署中，包括就地部署的復原，事件勾點以下列順序執行：

藍/綠部署

在藍/綠部署中，事件勾點以下列順序執行：

「掛鉤」區段的結構

'hooks' 區段的結構如下：

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

您可以在 hook 項目中，在部署生命週期事件名稱後包含下列元素：

參考掛鉤指令碼中的檔案

如果您要將指令碼掛鉤至 中所述的 CodeDeploy 生命週期事件AppSpec 「掛鉤」區段，而且想要參考指令碼中的檔案 （例如 helper.sh），則需要helper.sh使用下列方式指定 ：

使用絕對路徑

若要使用檔案的絕對路徑來參考檔案，您可以：

部署封存位置

在DownloadBundle生命週期事件期間， CodeDeploy 代理程式會將部署的修訂版本擷取到具有下列格式的目錄：

root-directory/deployment-group-id/deployment-id/deployment-archive

所以此 root-directory 路徑的 部分一律設定為下表所示的預設值，或由 :root_dir 組態設定控制。如需組態設定的詳細資訊，請參閱 CodeDeploy 用戶端組態參考。

從掛鉤指令碼中，您可以使用根目錄路徑和 DEPLOYMENT_ID和 DEPLOYMENT_GROUP_ID環境變數來存取目前的部署封存。如需有關您可以使用之變數的詳細資訊，請參閱 勾點的環境變數可用性。

例如，以下是您可以存取 Linux 修訂版根目錄data.json的檔案的方式：

#!/bin/bash

rootDirectory="/opt/codedeploy-agent/deployment-root" # note: this will be different if you
                                                      # customize the :root_dir configuration
dataFile="$rootDirectory/$DEPLOYMENT_GROUP_ID/$DEPLOYMENT_ID/deployment-archive/data.json"
data=$(cat dataFile)

作為另一個範例，以下是如何在 Windows 上使用 Powershell 存取位於修訂根data.json目錄的檔案：

$rootDirectory="$env:ProgramData\Amazon\CodeDeploy" # note: this will be different if you
                                                    # customize the :root_dir configuration
$dataFile="$rootDirectory\$env:DEPLOYMENT_GROUP_ID\$env:DEPLOYMENT_ID\deployment-archive\data.json"
$data=(Get-Content $dataFile)

使用相對路徑

若要使用檔案的相對路徑來參考檔案，您需要知道 CodeDeploy 客服人員的工作目錄。檔案路徑與此目錄相關。

下表顯示 CodeDeploy 代理程式每個支援平台的工作目錄。

勾點的環境變數可用性

在每個部署生命週期事件期間，勾點指令碼能存取以下環境變數：

這些環境變數在每個部署生命週期事件的本機。

根據部署套件的來源，還有其他環境變數可用於掛鉤指令碼：

Amazon S3 的套件

來自 的套件 GitHub

如果 DEPLOYMENT_GROUP_NAME 的值等於 ，則下列指令碼會將 Apache HTTP伺服器上的接聽連接埠變更為 9090，而不是 80Staging。這個指令碼必須在 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。