This is the AWS CDK v2 Developer Guide. The older CDK v1 entered maintenance on June 1, 2022 and ended support on June 1, 2023.
Create a new AWS CDK project from a template.
Usage
$
cdk init
<arguments>
<options>
Arguments
- Template type
-
The CDK template type to initialize a new CDK project from.
-
app
– Template for a CDK application. -
lib
– Template for an AWS Construct Library. -
sample-app
– Example CDK application that includes some constructs.
Valid values:
app
,lib
,sample-app
-
Options
For a list of global options that work with all CDK CLI commands, see Global options.
--generate-only
BOOLEAN
-
Specify this option to generate project files without initiating additional operations such as setting up a git repository, installing dependencies, or compiling the project.
Default value:
false
--help, -h
BOOLEAN
-
Show command reference information for the
cdk init command
. --language, -l
STRING
-
The language to be used for the new project. This option can be configured in the project’s
cdk.json
configuration file or at~/.cdk.json
on your local development machine.Valid values:
csharp
,fsharp
,go
,java
,javascript
,python
,typescript
--list
BOOLEAN
-
List the available template types and languages.
Examples
List the available template types and languages
$
cdk init --list
Available templates: * app: Template for a CDK Application └─ cdk init app --language=[csharp|fsharp|go|java|javascript|python|typescript] * lib: Template for a CDK Construct Library └─ cdk init lib --language=typescript * sample-app: Example CDK Application with some constructs └─ cdk init sample-app --language=[csharp|fsharp|go|java|javascript|python|typescript]
Create a new CDK app in TypeScript from the library template
$
cdk init lib --language=typescript