Questa è la guida per sviluppatori AWS CDK v2. Il vecchio CDK v1 è entrato in manutenzione il 1° giugno 2022 e ha terminato il supporto il 1° giugno 2023.
Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.
Un AWS Cloud Development Kit (AWS CDK) progetto rappresenta i file e le cartelle che contengono il codice CDK. I contenuti varieranno in base al linguaggio di programmazione.
È possibile creare il AWS CDK progetto manualmente o con l'interfaccia a riga di AWS CDK comando (AWS CDK CLI) cdk init
comando. In questo argomento, faremo riferimento alla struttura del progetto e alle convenzioni di denominazione di file e cartelle create dalla CLI di AWS CDK. Puoi personalizzare e organizzare i tuoi progetti CDK in base alle tue esigenze.
Nota
Struttura del progetto creata da AWS CDK CLI può variare tra le versioni nel tempo.
File e cartelle universali
- .git
-
Se è stato
git
installato, il AWS CDK CLI inizializza automaticamente un Git archivio per il tuo progetto. La.git
directory contiene informazioni sul repository. - .gitignore
-
File di testo utilizzato da Git per specificare file e cartelle da ignorare.
- README.md
-
File di testo che fornisce indicazioni di base e informazioni importanti per la gestione AWS CDK del progetto. Se necessario, modificate questo file per documentare informazioni importanti relative al progetto CDK.
- cdk.json
-
File di configurazione per. AWS CDK Questo file fornisce istruzioni per AWS CDK CLI su come eseguire l'app.
File e cartelle specifici della lingua
I file e le cartelle seguenti sono unici per ogni linguaggio di programmazione supportato.
Di seguito è riportato un esempio di progetto creato nella my-cdk-ts-project
directory utilizzando il cdk init --language typescript
comando:
my-cdk-ts-project ├── .git ├── .gitignore ├── .npmignore ├── README.md ├── bin │ └── my-cdk-ts-project.ts ├── cdk.json ├── jest.config.js ├── lib │ └── my-cdk-ts-project-stack.ts ├── node_modules ├── package-lock.json ├── package.json ├── test │ └── my-cdk-ts-project.test.ts └── tsconfig.json
- .npmignore
-
File che specifica quali file e cartelle ignorare quando si pubblica un pacchetto su npm registro. Questo file è simile a
.gitignore
, ma è specifico npm pacchetti. - bin/.ts my-cdk-ts-project
-
Il file dell'applicazione definisce l'app CDK. I progetti CDK possono contenere uno o più file di applicazione. I file dell'applicazione vengono memorizzati nella
bin
cartella.Di seguito è riportato un esempio di file applicativo di base che definisce un'app CDK:
#!/usr/bin/env node import 'source-map-support/register'; import * as cdk from 'aws-cdk-lib'; import { MyCdkTsProjectStack } from '../lib/my-cdk-ts-project-stack'; const app = new cdk.App(); new MyCdkTsProjectStack(app, 'MyCdkTsProjectStack');
- jest.config.js
-
File di configurazione per Jest. Jestè un popolare JavaScript framework di test.
- lib/ my-cdk-ts-project -stack.ts
-
Il file stack definisce lo stack CDK. All'interno dello stack, definisci AWS risorse e proprietà utilizzando costrutti.
Di seguito è riportato un esempio di file stack di base che definisce uno stack CDK:
import * as cdk from 'aws-cdk-lib'; import { Construct } from 'constructs'; export class MyCdkTsProjectStack extends cdk.Stack { constructor(scope: Construct, id: string, props?: cdk.StackProps) { super(scope, id, props); // code that defines your resources and properties go here } }
- node_modules
-
Cartella comune in Node.js progetti che contengono dipendenze per il tuo progetto.
- package-lock.json
-
File di metadati che funziona con il file per gestire le versioni delle dipendenze
package.json
. - pacchetto.json
-
File di metadati comunemente usato in Node.js progetti. Questo file contiene informazioni sul progetto CDK come il nome del progetto, le definizioni degli script, le dipendenze e altre informazioni a livello di progetto di importazione.
- test/ .test.ts my-cdk-ts-project
-
Viene creata una cartella di test per organizzare i test per il progetto CDK. Viene inoltre creato un file di test di esempio.
È possibile scrivere test in TypeScript e usa Jest per compilare il tuo TypeScript codice prima di eseguire i test.
- tsconfig.json
-
File di configurazione utilizzato in TypeScript progetti che specificano le opzioni del compilatore e le impostazioni del progetto.