这是 AWS CDK v2 开发者指南。较旧的 CDK v1 于 2022 年 6 月 1 日进入维护阶段,并于 2023 年 6 月 1 日终止支持。
本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
AWS CDK 是什么?
AWS Cloud Development Kit (AWS CDK) 是一个开源软件开发框架,可用于在代码中定义云基础设施并通过 AWS CloudFormation 进行配置。
AWS CDK 包含两个主要部分:
-
AWS CDK 构造库:一组预先编写的模块化和可重用代码,称为构造,您可以使用、修改它,也可将其集成以便快速开发基础设施。AWS CDK 构造库的目标是降低在 AWS 上构建应用程序时同时定义和集成 AWS 服务的复杂性。
-
AWS CDK 命令行界面(AWS CDKCLI):用于与 CDK 应用程序交互的命令行工具。使用 CDK CLI 创建、管理和部署 AWS CDK 项目。CDK CLI 也被称为 CDK Toolkit。
AWS CDK 支持 TypeScript、JavaScript、Python、Java、C#/.Net、和 Go。您可以使用其中任何一种编程语言中来定义称为构造的可重用的云组件。您可以将构造组合成堆栈和应用程序。然后,将 CDK 应用程序部署到 AWS CloudFormation 以预置或更新资源。
AWS CDK 的优势
通过 AWS CDK,您可借助编程语言的强大表达能力,在云中构建可靠、可扩展且成本高效的应用程序。这种方法有许多好处,包括:
- 开发和管理基础设施即代码(IaC)
-
实践基础设施即代码,以编程、描述性和声明性的方式创建、部署和维护基础设施。通过 IaC,您可以像开发人员对待代码一样对待基础设施。这为您提供了一种可扩展的结构化方法来管理基础设施。要了解有关 IaC 的更多信息,请参阅《AWS 上的 DevOps 简介白皮书》中的基础设施即代码。
通过 AWS CDK,您可以将基础设施、应用程序代码和配置集中放置于一处,确保在每个里程碑上都获得可在云上部署的完整系统。采用代码审查、单元测试和源代码控制等软件工程最佳实践,使您的基础设施更可靠。
- 使用通用编程语言定义您的云基础设施
-
通过 AWS CDK,您可以使用以下任何一种编程语言来定义云基础设施:TypeScript、JavaScript、Python、Java、C#/.Net、和 Go。选择首选语言,并使用参数、条件、循环、组合和继承等编程元素来定义基础设施的预期结果。
使用相同的编程语言来定义基础设施和应用程序逻辑。
享受在首选集成式开发环境(IDE)中开发基础设施的好处,例如语法高亮显示和智能代码补全。
- 通过 AWS CloudFormation 部署基础设施
-
AWS CDK 与 AWS CloudFormation 集成,以便在 AWS 上部署和预置基础设施。AWS CloudFormation 是一种托管 AWS 服务,可为资源和属性配置提供广泛支持,以便在 AWS 上预置服务。通过 AWS CloudFormation,您可以可预测地重复执行基础设施部署,并在出错时进行回滚。如果您已经熟悉 AWS CloudFormation,则无需了解新的 IaC 管理服务即可开始使用 AWS CDK。
- 使用构造快速开始开发应用程序
-
通过使用和共享称为构造的可重用组件加快开发速度。使用低级别构造定义单个 AWS CloudFormation 资源及其属性。使用高级别构造快速定义应用程序的较大组件,为 AWS 资源设置合理、安全的默认值,进而用更少的代码定义更多的基础设施。
根据您的独特用例自行创建构造,并在组织内共享甚至与公众共享。
AWS CDK 的示例
以下是使用 AWS CDK 构造库创建启动类型为 AWS Fargate 的 Amazon Elastic Container Service(Amazon ECS)服务的示例。有关此示例的详细信息,请参阅 示例:使用 AWS CDK 服务创建 AWS Fargate 服务。
- TypeScript
-
export class MyEcsConstructStack extends Stack {
constructor(scope: App, id: string, props?: StackProps) {
super(scope, id, props);
const vpc = new ec2.Vpc(this, "MyVpc", {
maxAzs: 3 // Default is all AZs in region
});
const cluster = new ecs.Cluster(this, "MyCluster", {
vpc: vpc
});
// Create a load-balanced Fargate service and make it public
new ecs_patterns.ApplicationLoadBalancedFargateService(this, "MyFargateService", {
cluster: cluster, // Required
cpu: 512, // Default is 256
desiredCount: 6, // Default is 1
taskImageOptions: { image: ecs.ContainerImage.fromRegistry("amazon/amazon-ecs-sample") },
memoryLimitMiB: 2048, // Default is 512
publicLoadBalancer: true // Default is false
});
}
}
- JavaScript
-
class MyEcsConstructStack extends Stack {
constructor(scope, id, props) {
super(scope, id, props);
const vpc = new ec2.Vpc(this, "MyVpc", {
maxAzs: 3 // Default is all AZs in region
});
const cluster = new ecs.Cluster(this, "MyCluster", {
vpc: vpc
});
// Create a load-balanced Fargate service and make it public
new ecs_patterns.ApplicationLoadBalancedFargateService(this, "MyFargateService", {
cluster: cluster, // Required
cpu: 512, // Default is 256
desiredCount: 6, // Default is 1
taskImageOptions: { image: ecs.ContainerImage.fromRegistry("amazon/amazon-ecs-sample") },
memoryLimitMiB: 2048, // Default is 512
publicLoadBalancer: true // Default is false
});
}
}
module.exports = { MyEcsConstructStack }
- Python
-
class MyEcsConstructStack(Stack):
def __init__(self, scope: Construct, id: str, **kwargs) -> None:
super().__init__(scope, id, **kwargs)
vpc = ec2.Vpc(self, "MyVpc", max_azs=3) # default is all AZs in region
cluster = ecs.Cluster(self, "MyCluster", vpc=vpc)
ecs_patterns.ApplicationLoadBalancedFargateService(self, "MyFargateService",
cluster=cluster, # Required
cpu=512, # Default is 256
desired_count=6, # Default is 1
task_image_options=ecs_patterns.ApplicationLoadBalancedTaskImageOptions(
image=ecs.ContainerImage.from_registry("amazon/amazon-ecs-sample")),
memory_limit_mib=2048, # Default is 512
public_load_balancer=True) # Default is False
- Java
-
public class MyEcsConstructStack extends Stack {
public MyEcsConstructStack(final Construct scope, final String id) {
this(scope, id, null);
}
public MyEcsConstructStack(final Construct scope, final String id,
StackProps props) {
super(scope, id, props);
Vpc vpc = Vpc.Builder.create(this, "MyVpc").maxAzs(3).build();
Cluster cluster = Cluster.Builder.create(this, "MyCluster")
.vpc(vpc).build();
ApplicationLoadBalancedFargateService.Builder.create(this, "MyFargateService")
.cluster(cluster)
.cpu(512)
.desiredCount(6)
.taskImageOptions(
ApplicationLoadBalancedTaskImageOptions.builder()
.image(ContainerImage
.fromRegistry("amazon/amazon-ecs-sample"))
.build()).memoryLimitMiB(2048)
.publicLoadBalancer(true).build();
}
}
- C#
-
public class MyEcsConstructStack : Stack
{
public MyEcsConstructStack(Construct scope, string id, IStackProps props=null) : base(scope, id, props)
{
var vpc = new Vpc(this, "MyVpc", new VpcProps
{
MaxAzs = 3
});
var cluster = new Cluster(this, "MyCluster", new ClusterProps
{
Vpc = vpc
});
new ApplicationLoadBalancedFargateService(this, "MyFargateService",
new ApplicationLoadBalancedFargateServiceProps
{
Cluster = cluster,
Cpu = 512,
DesiredCount = 6,
TaskImageOptions = new ApplicationLoadBalancedTaskImageOptions
{
Image = ContainerImage.FromRegistry("amazon/amazon-ecs-sample")
},
MemoryLimitMiB = 2048,
PublicLoadBalancer = true,
});
}
}
- Go
-
func NewMyEcsConstructStack(scope constructs.Construct, id string, props *MyEcsConstructStackProps) awscdk.Stack {
var sprops awscdk.StackProps
if props != nil {
sprops = props.StackProps
}
stack := awscdk.NewStack(scope, &id, &sprops)
vpc := awsec2.NewVpc(stack, jsii.String("MyVpc"), &awsec2.VpcProps{
MaxAzs: jsii.Number(3), // Default is all AZs in region
})
cluster := awsecs.NewCluster(stack, jsii.String("MyCluster"), &awsecs.ClusterProps{
Vpc: vpc,
})
awsecspatterns.NewApplicationLoadBalancedFargateService(stack, jsii.String("MyFargateService"),
&awsecspatterns.ApplicationLoadBalancedFargateServiceProps{
Cluster: cluster, // required
Cpu: jsii.Number(512), // default is 256
DesiredCount: jsii.Number(5), // default is 1
MemoryLimitMiB: jsii.Number(2048), // Default is 512
TaskImageOptions: &awsecspatterns.ApplicationLoadBalancedTaskImageOptions{
Image: awsecs.ContainerImage_FromRegistry(jsii.String("amazon/amazon-ecs-sample"), nil),
},
PublicLoadBalancer: jsii.Bool(true), // Default is false
})
return stack
}
该类会生成包含超过 500 行代码的 AWS CloudFormation 模板。部署该 AWS CDK 应用程序会生成 50 多种以下类型的资源。
AWS CDK 功能
AWS CDKGitHub 存储库
有关官方 AWS CDK GitHub 存储库,请参阅 aws-cdk。您可以在其中提交问题、查看我们的许可证、跟踪版本等。
由于 AWS CDK 是开源的,其开发团队鼓励您贡献内容,使其成为更好的工具。有关详细信息,请参阅 Contributing to the AWS Cloud Development Kit (AWS CDK)。
AWS CDK API 参考
AWS CDK 构造库提供了各种 API,供您定义 CDK 应用程序并向应用程序添加 CDK 构造。有关更多信息,请参阅 AWS CDK API 参考。
构造编程模型
构造编程模型(CPM)将 AWS CDK 背后的相关概念扩展到其他领域。使用 CPM 的其他工具包括:
Construct Hub
Construct Hub 是一个在线注册表,您可以在其中查找、发布和共享开源 AWS CDK 库。
后续步骤
要开始使用 AWS CDK,请参阅开始使用 AWS CDK。
了解更多
要进一步了解 AWS CDK 的更多信息,请参阅以下资源:
要了解 AWS CDK 相关主题的更多信息,请参阅以下资源:
要了解可用于简化无服务器应用程序开发和部署的 AWS CDK 相关工具的更多信息,请参阅以下资源: