這是 AWS CDK v2 開發人員指南。較舊的 CDK v1 已於 2022 年 6 月 1 日進入維護,並於 2023 年 6 月 1 日結束支援。
本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
匯入並使用 AWS Cloud Development Kit (AWS CDK) 程式庫,以支援的程式設計語言定義您的 AWS 雲端 基礎設施。
匯入 AWS CDK 程式庫
AWS CDK 程式庫的TypeScript套件名稱通常稱為 aws-cdk-lib
。實際套件名稱會因語言而異。以下是如何安裝和匯入 CDK 程式庫的範例:
安裝 | npm 安裝 aws-cdk-lib |
---|---|
Import | 從 'aws-cdk-lib' 匯入 * 做為 cdk; |
construct
基礎類別和支援程式碼位於 constructs
程式庫中。實驗建構,其中 API 仍在進行精簡,會以個別模組的形式分發。
使用 AWS CDK API 參考
使用 開發時,請使用 AWS CDK API 參考 AWS CDK。
每個模組的參考材料會分成以下各節。
-
概觀:使用 中的服務時,您需要了解的簡介資料 AWS CDK,包括概念和範例。
-
建構:代表一或多個具體 AWS 資源的程式庫類別。這些是「精選」 (L2) 資源或模式 (L3 資源),可提供具有 Sane 預設值的高階界面。
-
類別:提供模組中建構所使用的功能的非建構類別。
-
結構:定義複合值結構的資料結構 (屬性套件),例如屬性 (建構的
props
引數) 和選項。 -
界面:名稱全部以「I」開頭的界面,定義對應建構或其他類別的絕對最小功能。CDK 使用建構介面來表示在您 AWS CDK 應用程式外部定義,並由 等方法參考 AWS 的資源
Bucket.fromBucketArn()
。 -
列舉:具名值的集合,可用於指定特定建構參數。使用列舉值可讓 CDK 在合成期間檢查這些值的有效性。
-
CloudFormation 資源:這些 L1 建構名稱以 "Cfn" 開頭,完全代表 CloudFormation 規格中定義的資源。每個 CDK 版本都會自動從該規格產生。每個 L2 或 L3 建構會封裝一或多個 CloudFormation 資源。
-
CloudFormation 屬性類型:命名值的集合,可定義每個 CloudFormation 資源的屬性。
與建構類別比較的界面
以特定方式 AWS CDK 使用界面,即使您熟悉界面做為程式設計概念,這些界面可能不明顯。
AWS CDK 支援使用在 CDK 應用程式外部定義的資源,方法如 Bucket.fromBucketArn()
。外部資源無法修改,而且可能無法使用 Bucket
類別等 CDK 應用程式中定義的資源,使用所有功能。然後,界面代表 CDK 中針對特定 AWS 資源類型可用的裸機最低功能,包括外部資源。
在 CDK 應用程式中執行個體化資源時,您應該一律使用具體類別,例如 Bucket
。在您自己的其中一個建構中指定您接受的引數類型時,請使用界面類型,例如,IBucket
如果您準備好處理外部資源 (也就是說,您不需要變更它們)。如果您需要 CDK 定義的建構,請指定您可以使用的最一般類型。
某些介面是與特定類別相關聯的屬性或選項套件的最小版本,而不是建構。當子分類接受您要傳遞給父類別的引數時,這類界面很有用。如果您需要一或多個額外的屬性,建議您實作或衍生自此界面,或更具體的類型。
注意
支援的某些程式設計語言 AWS CDK 沒有介面功能。在這些語言中,介面只是一般類別。您可以依名稱來識別它們,其遵循初始 "I" 模式,接著是其他建構的名稱 (例如 IBucket
)。適用相同的規則。
管理相依性
AWS CDK 應用程式或程式庫的相依性是使用套件管理工具來管理。這些工具通常與程式設計語言搭配使用。
一般而言,如果有語言的標準或官方套件管理工具,則 會 AWS CDK 支援。否則, AWS CDK 將支援語言最熱門或廣泛支援的語言。您也可以使用其他工具,尤其是使用支援的工具時。不過,其他工具的官方支援有限。
AWS CDK 支援下列套件管理員:
語言 | 支援的套件管理工具 |
---|---|
TypeScript/JavaScript | NPM (節點套件管理員) 或 Yarn |
Python | PIP (Package Installer for Python) |
Java | Maven |
C# | NuGet |
Go | Go 模組 |
當您使用 AWS CDK CLIcdk init
命令建立新專案時,會自動指定 CDK 核心程式庫和穩定建構的相依性。
如需管理支援程式設計語言相依性的詳細資訊,請參閱下列內容:
AWS CDK 將 TypeScript與其他語言進行比較
TypeScript 是支援開發 AWS CDK 應用程式的第一個語言。因此,大量範例 CDK 程式碼會寫入 TypeScript。如果您使用其他語言進行開發,比較 TypeScript 中 AWS CDK 程式碼的實作方式與您選擇的語言可能很有用。這可協助您在整個文件中使用範例。
匯入模組
TypeScript 支援從命名空間匯入整個命名空間或個別物件。每個命名空間都包含要與指定 AWS 服務搭配使用的建構和其他類別。
// Import main CDK library as cdk
import * as cdk from 'aws-cdk-lib'; // ES6 import preferred in TS
const cdk = require('aws-cdk-lib'); // Node.js require() preferred in JS
// Import specific core CDK classes
import { Stack, App } from 'aws-cdk-lib';
const { Stack, App } = require('aws-cdk-lib');
// Import AWS S3 namespace as s3 into current namespace
import { aws_s3 as s3 } from 'aws-cdk-lib'; // TypeScript
const s3 = require('aws-cdk-lib/aws-s3'); // JavaScript
// Having imported cdk already as above, this is also valid
const s3 = cdk.aws_s3;
// Now use s3 to access the S3 types
const bucket = s3.Bucket(...);
// Selective import of s3.Bucket
import { Bucket } from 'aws-cdk-lib/aws-s3'; // TypeScript
const { Bucket } = require('aws-cdk-lib/aws-s3'); // JavaScript
// Now use Bucket to instantiate an S3 bucket
const bucket = Bucket(...);
如同 TypeScript,Python 支援命名空間模組匯入和選擇性匯入。Python 中的命名空間看起來像 aws_cdk.xxx,其中 xxx 代表 AWS 服務名稱,例如 s3 for Amazon S3。(Amazon S3 用於這些範例)。
# Import main CDK library as cdk
import aws_cdk as cdk
# Selective import of specific core classes
from aws_cdk import Stack, App
# Import entire module as s3 into current namespace
import aws_cdk.aws_s3 as s3
# s3 can now be used to access classes it contains
bucket = s3.Bucket(...)
# Selective import of s3.Bucket into current namespace
from aws_cdk.s3 import Bucket
# Bucket can now be used to instantiate a bucket
bucket = Bucket(...)
執行個體化建構
AWS CDK 建構類別在所有支援的語言中具有相同的名稱。大多數語言都使用 new
關鍵字來執行個體化類別 (Python 和 Go 不會)。此外,在大多數語言中,關鍵字this
是指目前的執行個體。(Python self
依慣例使用。) 您應該將參考傳遞給目前的執行個體,做為您建立的每個建構的 scope
參數。
AWS CDK 建構的第三個引數是 props
,此物件包含建置建構所需的屬性。此引數可能是選用的,但當需要時,支援的語言會以慣用方式處理。屬性的名稱也會適應語言的標準命名模式。
// Instantiate default Bucket
const bucket = new s3.Bucket(this, 'amzn-s3-demo-bucket');
// Instantiate Bucket with bucketName and versioned properties
const bucket = new s3.Bucket(this, 'amzn-s3-demo-bucket', {
bucketName: 'amzn-s3-demo-bucket',
versioned: true,
});
// Instantiate Bucket with websiteRedirect, which has its own sub-properties
const bucket = new s3.Bucket(this, 'amzn-s3-demo-bucket', {
websiteRedirect: {host: 'aws.amazon.com'}});
Python 在執行個體化類別時不使用new
關鍵字。屬性引數是使用關鍵字引數來表示,而引數是使用 命名snake_case
。
如果 props 值本身是一組屬性,則會以 屬性命名的類別表示,該類別接受子屬性的關鍵字引數。
在 Python 中,目前執行個體會傳遞至 方法做為第一個引數,以self
慣例命名。
# Instantiate default Bucket
bucket = s3.Bucket(self, "amzn-s3-demo-bucket")
# Instantiate Bucket with bucket_name and versioned properties
bucket = s3.Bucket(self, "amzn-s3-demo-bucket", bucket_name="amzn-s3-demo-bucket", versioned=true)
# Instantiate Bucket with website_redirect, which has its own sub-properties
bucket = s3.Bucket(self, "amzn-s3-demo-bucket", website_redirect=s3.WebsiteRedirect(
host_name="aws.amazon.com"))
存取成員
通常參考建構和其他 AWS CDK 類別的屬性或屬性,並使用這些值做為例如,輸入來建置其他建構。上述方法的命名差異也適用於此處。此外,在 Java 中,無法直接存取成員。而是提供 getter 方法。
名稱為 camelCase
。
bucket.bucketArn
名稱為 snake_case
。
bucket.bucket_arn
列舉常數
列舉常數的範圍是 類別,且具有大寫名稱和所有語言的底線 (有時稱為 SCREAMING_SNAKE_CASE
)。由於類別名稱也在所有支援的語言中使用相同的外殼,但 Go 除外,因此這些語言中的合格列舉名稱也相同。
s3.BucketEncryption.KMS_MANAGED
在 Go 中,列舉常數是模組命名空間的屬性,寫入方式如下。
awss3.BucketEncryption_KMS_MANAGED
物件界面
AWS CDK 使用 TypeScript 物件界面來表示 類別實作預期的一組方法和屬性。您可以辨識物件界面,因為其名稱開頭為 I
。混凝土類別會指出其使用implements
關鍵字實作的界面。
注意
JavaScript 沒有界面功能。您可以忽略implements
關鍵字及其後面的類別名稱。
import { IAspect, IConstruct } from 'aws-cdk-lib';
class MyAspect implements IAspect {
public visit(node: IConstruct) {
console.log('Visited', node.node.path);
}
}
Python 沒有介面功能。不過,對於 AWS CDK ,您可以透過使用 裝飾您的類別來指示介面實作@jsii.implements(interface)
。
from aws_cdk import IAspect, IConstruct
import jsii
@jsii.implements(IAspect)
class MyAspect():
def visit(self, node: IConstruct) -> None:
print("Visited", node.node.path)