這是 AWS CDK v2 開發人員指南。較舊的 CDK v1 已於 2022 年 6 月 1 日進入維護，並於 2023 年 6 月 1 日結束支援。
本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
本節包含命令列介面 () 的 AWS Cloud Development Kit (AWS CDK) 命令參考資訊CLI。CDK CLI也稱為 CDK Toolkit。
用量
$cdk<command><arguments><options>
命令
acknowledge, ack-
依問題編號確認通知，並隱藏通知，使其不再顯示。
bootstrap-
將名為 的 CDK 引導堆疊部署到 AWS 環境中
CDKToolkit，以準備 CDK 部署 AWS 的環境。 context-
管理 CDK 應用程式的快取內容值。
deploy-
將一或多個 CDK 堆疊部署到您的 AWS 環境中。
destroy-
從 AWS 環境中刪除一或多個 CDK 堆疊。
diff-
執行差異以查看 CDK 堆疊之間的基礎設施變更。
docs, doc-
在瀏覽器中開啟 CDK 文件。
doctor-
檢查並顯示有關本機 CDK 專案和開發環境的實用資訊。
import-
使用 AWS CloudFormation 資源匯入將現有 AWS 資源匯入 CDK 堆疊。
init-
從範本建立新的 CDK 專案。
list, ls-
從 CDK 應用程式列出所有 CDK 堆疊及其相依性。
metadata-
顯示與 CDK 堆疊相關聯的中繼資料。
migrate-
將 AWS 資源、 AWS CloudFormation 堆疊和 AWS CloudFormation 範本遷移至新的 CDK 專案。
notices-
顯示 CDK 應用程式的通知。
synthesize, synth-
合成 CDK 應用程式以產生雲端組件，包括每個堆疊的 AWS CloudFormation 範本。
watch-
持續監看本機 CDK 專案是否有變更，以執行部署和熱交換。
全域選項
下列選項與所有 CDK CLI命令相容。
--app, -aSTRING-
提供執行應用程式或雲端組合目錄的 命令。
必要：是
--asset-metadataBOOLEAN-
包含使用資產之資源的
aws:asset:*AWS CloudFormation 中繼資料。必要：否
預設值：
true --buildSTRING-
執行合成前建置的命令。
必要：否
--ca-bundle-pathSTRING-
驗證 HTTPS 請求時要使用的 CA 憑證路徑。
如果未提供此選項，CDK CLI將從
AWS_CA_BUNDLE環境變數讀取。必要：是
--ciBOOLEAN-
表示 CDK CLI命令正在持續整合 (CI) 環境中執行。
此選項會修改 CDK 的行為CLI，以更適合 CI 管道中常見的自動化操作。
當您提供此選項時，日誌會傳送到
stdout，而不是stderr。必要：否
預設值：
false --context, -cARRAY-
將內容字串參數新增為索引鍵/值對。
--debugBOOLEAN-
啟用詳細的偵錯資訊。此選項會產生詳細輸出，其中包含有關 CDK 在幕後所CLI執行工作的詳細資訊。
必要：否
預設值：
false --ec2creds, -iBOOLEAN-
強制 CDK CLI嘗試並擷取 Amazon EC2 執行個體登入資料。
根據預設，CDK 會CLI猜測 Amazon EC2 執行個體狀態。
必要：否
預設值：
false --help, -hBOOLEAN-
顯示 CDK 的命令參考資訊CLI。
必要：否
預設值：
false --ignore-errorsBOOLEAN-
忽略合成錯誤，這可能會產生無效的輸出。
必要：否
預設值：
false --json, -jBOOLEAN-
針對列印到標準輸出 () 的 AWS CloudFormation 範本，請使用 JSON 而非 YAML
stdout。必要：否
預設值：
false --lookupsBOOLEAN-
執行內容查詢。
如果此值為
false且需要執行內容查詢，則合成將會失敗。必要：否
預設值：
true --no-colorBOOLEAN-
從主控台輸出中移除顏色和其他樣式。
必要：否
預設值：
false --noticesBOOLEAN-
顯示相關通知。
必要：否
預設值：
false --output, -oSTRING-
指定要輸出合成雲端組件的目錄。
必要：是
預設值：
cdk.out --path-metadataBOOLEAN-
包含每個資源的
aws::cdk::pathAWS CloudFormation 中繼資料。必要：否
預設值：
true --plugin, -pARRAY-
擴展 CDK 功能的node套件名稱或路徑。此選項可在單一命令中提供多次。
您可以在專案的
cdk.json檔案或本機開發機器~/.cdk.json上的 設定此選項：{ // ... "plugin": [ "module_1", "module_2" ], // ... }必要：否
--profileSTRING-
指定 AWS 設定檔的名稱，其中包含您的 AWS 環境資訊，以與 CDK 搭配使用CLI。
必要：是
--proxySTRING-
使用指定的代理。
如果未提供此選項，CDK CLI將從
HTTPS_PROXY環境變數讀取。必要：是
預設值：從
HTTPS_PROXY環境變數讀取。 --role-arn, -rSTRING-
與 CDK 互動時CLI將擔任之 IAM 角色的 ARN AWS CloudFormation。
必要：否
--stagingBOOLEAN-
將資產複製到輸出目錄。
指定
false以防止資產複製到輸出目錄。這可讓 在 AWS SAM 執行本機偵錯時CLI參考原始來源檔案。必要：否
預設值：
true --strictBOOLEAN-
請勿建構包含警告的堆疊。
必要：否
預設值：
false --traceBOOLEAN-
列印堆疊警告的追蹤。
必要：否
預設值：
false --verbose, -vCOUNT-
顯示偵錯日誌。您可以多次指定此選項，以提高動盪性。
必要：否
--versionBOOLEAN-
顯示 CDK CLI版本編號。
必要：否
預設值：
false --version-reportingBOOLEAN-
在合成的 AWS CloudFormation 範本中包含
AWS::CDK::Metadata資源。必要：否
預設值：
true
提供和設定選項
您可以透過命令列引數傳遞選項。對於大多數選項，您可以在cdk.json組態檔案中設定它們。當您使用多個組態來源時，CDK CLI會遵守下列優先順序：
-
命令列值 – 命令列提供的任何選項都會覆寫
cdk.json檔案中設定的選項。 -
專案組態檔案 – CDK 專案目錄中
cdk.json的檔案。 -
使用者組態檔案 –
cdk.json位於您本機電腦上~/.cdk.json的檔案。
在命令列傳遞選項
傳遞布林值
對於接受布林值的選項，您可以透過下列方式指定它們：
-
使用
true和false值 – 使用 命令提供布林值。以下是範例：$cdk deploy --watch=true$cdk deploy --watch=false -
提供選項的對應項目 – 新增
no以指定false值來修改選項名稱。以下是範例：$cdk deploy --watch$cdk deploy --no-watch -
對於預設為
true或 的選項false，您不需要提供 選項，除非您想要從預設值變更。
