這是 AWS CDK v2 開發人員指南。較舊的 CDK V1 已於 2022 年 6 月 1 日進入維護,並於 2023 年 6 月 1 日結束支援。
本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
AWS CDKCLI指令參考
本節包含指令行介面 (CLI) 的 AWS Cloud Development Kit (AWS CDK) 指令參考資訊。CDK 也CLI被稱為 CDK 工具包。
用量
$
cdk
<command>
<arguments>
<options>
命令
acknowledge, ack
-
依問題編號確認通知,並將其隱藏,以免再次顯示。
bootstrap
-
透過將名
CDKToolkit
為的 CDK 啟動程序堆疊部署到 AWS 環境中,準備 CDK 部署的 AWS 環境。 context
-
管理 CDK 應用程式的快取內容值。
deploy
-
在您的 AWS 環境中部署一或多個 CDK 堆疊。
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, -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猜測亞馬遜 EC2 執行個體狀態。
必要:否
預設值:
false
--help, -h
BOOLEAN
-
顯示 CDK CLI 的指令參考資訊。
必要:否
預設值:
false
--ignore-errors
BOOLEAN
-
忽略合成錯誤,這可能會產生無效的輸出。
必要:否
預設值:
false
--json, -j
BOOLEAN
-
對於列印至標準輸出 (
stdout
) 的 AWS CloudFormation 範本,請使用 JSON 而不是 YAML。必要:否
預設值:
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 功能之node套件的名稱或路徑。此選項可以在單個命令中多次提供。
您可以在專
cdk.json
案的檔案或本機開發電腦~/.cdk.json
上設定此選項:{ // ... "plugin": [ "module_1", "module_2" ], // ... }
必要:否
--profile
STRING
-
指定要與 CDK CLI 搭 AWS 配使用的設定檔名稱,其中包含您的 AWS 環境資訊。
必要:是
--proxy
STRING
-
使用指定的代理。
如果未提供此選項,CDK CLI 將從
HTTPS_PROXY
環境變數讀取。必要:是
預設值:從
HTTPS_PROXY
環境變數讀取。 --role-arn, -r
STRING
-
與之互動時,CDK CLI 將承擔的 IAM 角色的 ARN。 AWS CloudFormation
必要:否
--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::CDK::Metadata
資源包含在合成 AWS CloudFormation 模板中。必要:否
預設值:
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
,除非您想要變更預設值,否則您不必提供選項。