AWS CDK CLI 命令參考 - AWS 雲端開發套件 (AWS CDK) v2
使用方式命令全域選項提供和設定選項在命令列傳遞選項

這是 AWS CDK v2 開發人員指南。較舊的 CDK v1 已於 2022 年 6 月 1 日進入維護，並於 2023 年 6 月 1 日結束支援。

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

AWS CDK CLI 命令參考

本節包含 AWS 雲端開發套件 (AWS CDK) 命令列界面 (CLI) 的命令參考資訊。CDK CLI 也稱為 CDK Toolkit。

使用方式

$ cdk <command> <arguments> <options>

命令

acknowledge ack

依問題編號確認通知，並隱藏通知，使其無法再次顯示。

bootstrap

透過將名為 的 CDK 引導堆疊部署到 AWS 環境中CDKToolkit，為 CDK 部署準備 AWS 環境。

context

管理 CDK 應用程式的快取內容值。

deploy

在您的 AWS 環境中部署一或多個 CDK 堆疊。

destroy

從 AWS 環境中刪除一或多個 CDK 堆疊。

diff

執行差異以查看 CDK 堆疊之間的基礎設施變更。

docs doc

在瀏覽器中開啟 CDK 文件。

doctor

檢查並顯示有關本機 CDK 專案和開發環境的實用資訊。

drift

偵測您使用 CDK 定義、管理和部署之資源的組態偏離。

flags

檢視和修改 CDK CLI 的功能旗標組態。

import

Use AWS CloudFormation 資源匯入，將現有 AWS 資源匯入 CDK 堆疊。

init

從範本建立新的 CDK 專案。

list, ls

從 CDK 應用程式列出所有 CDK 堆疊及其相依性。

metadata

顯示與 CDK 堆疊相關聯的中繼資料。

migrate

將 AWS 資源、 AWS CloudFormation 堆疊和 AWS CloudFormation 範本遷移至新的 CDK 專案。

notices

顯示 CDK 應用程式的通知。

refactor

在 CDK 應用程式中重構程式碼時保留已部署的資源。

synthesize, synth

合成 CDK 應用程式以產生雲端組件，包括每個堆疊的 an AWS CloudFormation 範本。

watch

持續監看本機 CDK 專案的變更，以執行部署和熱交換。

全域選項

下列選項與所有 CDK CLI 命令相容。

--app, -a <STRING>

提供執行應用程式或雲端組件目錄的 命令。

必要：是

--asset-metadata <BOOLEAN>

包含使用資產之資源的 aws:asset:* AWS CloudFormation 中繼資料。

必要：否

預設值：true

--build <STRING>

執行預先合成建置的命令。

必要：否

--ca-bundle-path <STRING>

驗證 HTTPS 請求時要使用的 CA 憑證路徑。

如果未提供此選項，CDK CLI 將從AWS_CA_BUNDLE環境變數讀取。

必要：是

--ci <BOOLEAN>

表示 CDK CLI 命令正在持續整合 (CI) 環境中執行。

此選項會修改 CDK CLI 的行為，以更符合 CI 管道中典型的自動化操作。

當您提供此選項時，日誌會傳送到 ，stdout而不是 stderr。

必要：否

預設值：false

--context, -c <ARRAY>

將內容字串參數新增為索引鍵/值對。

--debug <BOOLEAN>

啟用詳細的偵錯資訊。此選項會產生詳細輸出，其中包含有關 CDK CLI 在幕後執行的操作的更多詳細資訊。

必要：否

預設值：false

--ec2creds, -i <BOOLEAN>

強制 CDK CLI 嘗試並擷取 Amazon EC2 執行個體登入資料。

根據預設，CDK CLI 會猜測 Amazon EC2 執行個體狀態。

必要：否

預設值：false

--help, -h <BOOLEAN>

顯示 CDK CLI 的命令參考資訊。

必要：否

預設值：false

--ignore-errors <BOOLEAN>

忽略合成錯誤，這可能會產生無效的輸出。

必要：否

預設值：false

--json, -j <BOOLEAN>

使用 JSON 而非列印到標準輸出的 YAML for AWS CloudFormation 範本 (stdout)。

必要：否

預設值：false

--lookups <BOOLEAN>

執行內容查詢。

如果此值為 false且需要執行內容查詢，則合成將會失敗。

必要：否

預設值：true

--no-color <BOOLEAN>

從主控台輸出中移除顏色和其他樣式。

必要：否

預設值：false

--notices <BOOLEAN>

顯示相關通知。

必要：否

預設值：false

--output, -o <STRING>

指定要輸出合成雲端組件的目錄。

必要：是

預設值：cdk.out

--path-metadata <BOOLEAN>

包含每個資源的 aws::cdk::path AWS CloudFormation 中繼資料。

必要：否

預設值：true

--plugin, -p <ARRAY>

延伸 CDK 功能的節點套件名稱或路徑。此選項可在單一命令中多次提供。

您可以在專案的 cdk.json 檔案或本機開發機器~/.cdk.json上的 設定此選項：

{
   // ...
   "plugin": [
      "module_1",
      "module_2"
   ],
   // ...
}

必要：否

--profile <STRING>

指定 AWS 設定檔的名稱，其中包含要與 CDK CLI 搭配使用 AWS 的環境資訊。

必要：是

--proxy <STRING>

使用指定的代理。

如果未提供此選項，CDK CLI 將從HTTPS_PROXY環境變數讀取。

必要：是

預設值：讀取HTTPS_PROXY環境變數。

--role-arn, -r <STRING>

與 AWS CloudFormation 互動時，CDK CLI 將擔任之 IAM 角色的 ARN。

必要：否

--staging <BOOLEAN>

將資產複製到輸出目錄。

指定 false以防止資產複製到輸出目錄。這可讓 AWS SAM CLI 在執行本機偵錯時參考原始來源檔案。

必要：否

預設值：true

--strict <BOOLEAN>

請勿建構包含警告的堆疊。

必要：否

預設值：false

--trace <BOOLEAN>

列印堆疊警告的追蹤。

必要：否

預設值：false

--verbose, -v <COUNT>

顯示偵錯日誌。您可以多次指定此選項，以提高詳細程度。

必要：否

--version <BOOLEAN>

顯示 CDK CLI 版本編號。

必要：否

預設值：false

--version-reporting <BOOLEAN>

在合成的 AWS CloudFormation 範本中包含 AWS::CDK::Metadata 資源。

必要：否

預設值：true

提供和設定選項

您可以透過命令列引數傳遞選項。對於大多數選項，您可以在cdk.json組態檔案中設定它們。當您使用多個組態來源時，CDK CLI 會遵循下列優先順序：

  1. 命令列值 – 命令列提供的任何選項都會覆寫cdk.json檔案中設定的選項。

  2. 專案組態檔案 – cdk.json CDK 專案目錄中的檔案。

  3. 使用者組態檔案 – 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，您不需要提供 選項，除非您想要從預設值變更。