Questa è la guida per sviluppatori AWS CDK v2. La versione precedente della CDK versione 1 è entrata 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à.
Tutorial: crea la tua prima AWS CDK app
Inizia a utilizzare AWS Cloud Development Kit (AWS CDK) utilizzando l'interfaccia a riga di AWS CDK comando (AWS CDK CLI) per sviluppare la tua prima CDK app, avviare il tuo AWS ambiente e distribuire l'applicazione su. AWS
Prerequisiti
Prima di iniziare questo tutorial, completa tutti i passaggi di configurazione indicati in. Iniziare con AWS CDK
Informazioni sul tutorial
In questo tutorial, creerai e distribuirai una semplice applicazione sull' AWS AWS CDK utilizzo di. L'applicazione è costituita da una AWS Lambda funzione che restituisce un Hello World!
messaggio quando viene richiamata. La funzione verrà richiamata tramite una funzione Lambda che funge da endpoint (S) HTTP dedicato per la URL funzione Lambda.
Attraverso questo tutorial, eseguirai quanto segue:
-
Crea il tuo progetto: crea un CDK progetto utilizzando il CDK CLI
cdk init
comando. -
Configura il tuo AWS ambiente: configura l' AWS ambiente in cui distribuirai l'applicazione.
-
Avvia il tuo AWS ambiente: prepara AWS l'ambiente per la distribuzione avviandolo utilizzando il CDK CLI
cdk bootstrap
comando. -
Sviluppa la tua app: utilizza i costrutti della AWS Construct Library per definire le risorse della funzione Lambda e della funzione Lambda. URL
-
Prepara la tua app per la distribuzione: utilizza il CDK CLI per creare la tua app e sintetizzare un AWS CloudFormation modello.
-
Distribuisci la tua app: utilizza il CDK CLI
cdk deploy
comando per distribuire l'applicazione e fornire le AWS risorse. -
Interagisci con la tua applicazione: interagisci con la funzione Lambda distribuita AWS richiamandola e ricevendo una risposta.
-
Modifica la tua app: modifica la funzione Lambda e distribuiscila per implementare le modifiche.
-
Elimina la tua app: elimina tutte le risorse che hai creato utilizzando il CDK CLI
cdk destroy
comando.
Fase 1: Crea il tuo CDK progetto
In questo passaggio, crei un nuovo CDK progetto. Un CDK progetto dovrebbe trovarsi nella propria directory, con le proprie dipendenze dei moduli locali.
Per creare un progetto CDK
-
Da una directory iniziale a tua scelta, crea e naviga fino a una directory denominata
hello-cdk
:$
mkdir hello-cdk && cd hello-cdk
Importante
Assicuratevi di assegnare un nome alla cartella del progetto
hello-cdk
, esattamente come mostrato qui. La CDK CLI usa questo nome di directory per denominare le cose all'interno CDK del codice. Se usi un nome di directory diverso, incontrerai dei problemi durante questo tutorial. -
Dalla
hello-cdk
directory, inizializza un nuovo CDK progetto usando il CDK CLIcdk init
comando. Specificate ilapp
modello e il linguaggio di programmazione preferito con l'--language
opzione:
Il cdk init
comando crea una struttura di file e cartelle all'interno della hello-cdk
directory per aiutare a organizzare il codice sorgente CDK dell'app. Questa struttura di file e cartelle si chiama CDK progetto. Prenditi un momento per esplorare il tuo CDK progetto.
Se hai Git installato, ogni progetto creato utilizzando cdk init
viene inoltre inizializzato come Git archivio.
Durante l'inizializzazione del progetto, CDK CLI crea un'CDKapp contenente un singolo CDK stack. L'istanza CDK dell'app viene creata utilizzando il App
costrutto. Quanto segue è una parte di questo codice dal file CDK dell'applicazione:
Lo CDK stack viene creato utilizzando il Stack
costrutto. Di seguito è riportata una parte di questo codice dal file CDK stack:
Fase 2: Configurare AWS l'ambiente
In questo passaggio, configuri l' AWS ambiente per il tuo CDK stack. In questo modo, specifichi in quale ambiente verrà distribuito lo CDK stack.
Innanzitutto, stabilite l' AWS ambiente che desiderate utilizzare. Un AWS ambiente è costituito da un Account AWS e Regione AWS.
Quando si utilizza AWS CLI per configurare le credenziali di sicurezza sul computer locale, è possibile utilizzarle per AWS CLI ottenere informazioni AWS sull'ambiente per un profilo specifico.
Da utilizzare AWS CLI per ottenere il proprio ID Account AWS
-
Esegui il AWS CLI comando seguente per ottenere l' Account AWS ID del tuo
default
profilo:$
aws sts get-caller-identity --query "Account" --output text
-
Se preferisci utilizzare un profilo denominato, fornisci il nome del tuo profilo utilizzando l'
--profile
opzione:$
aws sts get-caller-identity --profile
your-profile-name
--query "Account" --output text
Per AWS CLI utilizzarlo per ottenere il Regione AWS
-
Esegui il AWS CLI comando seguente per ottenere la regione che hai configurato per il tuo
default
profilo:$
aws configure get region
-
Se preferisci usare un profilo denominato, fornisci il nome del tuo profilo utilizzando l'
--profile
opzione:$
aws configure get region --profile
your-profile-name
Successivamente, configurerai l' AWS ambiente per il tuo CDK stack modificando l'HelloCdkStack
istanza nel file dell'applicazione. In questo tutorial, codificherete le informazioni AWS sull'ambiente. È consigliato per gli ambienti di produzione. Per informazioni su altri modi di configurare gli ambienti, vedereConfigurare gli ambienti da utilizzare con AWS CDK.
Per configurare l'ambiente per il tuo CDK stack
-
Nel file dell'applicazione, utilizzate la
env
proprietà delStack
costrutto per configurare l'ambiente. Di seguito è riportato un esempio:
Fase 3: Avvia il tuo ambiente AWS
In questo passaggio, esegui il bootstrap dell' AWS ambiente configurato nel passaggio precedente. Questo prepara l'ambiente per CDK le distribuzioni.
Per avviare il tuo ambiente, esegui quanto segue dalla radice del tuo progetto: CDK
$
cdk bootstrap
Effettuando il bootstrap dalla radice del CDK progetto, non è necessario fornire alcuna informazione aggiuntiva. Il CDK CLI ottiene informazioni sull'ambiente dal progetto. Quando esegui il bootstrap all'esterno di un CDK progetto, devi fornire informazioni sull'ambiente con il cdk bootstrap
comando. Per ulteriori informazioni, consulta Avvia il tuo ambiente per utilizzarlo con AWS CDK.
Passaggio 4: crea la tua app CDK
Nella maggior parte degli ambienti di programmazione, il codice viene creato o compilato dopo aver apportato modifiche. Questo non è necessario AWS CDK dal momento che CDK CLI eseguirà automaticamente questo passaggio. Tuttavia, puoi comunque creare manualmente se desideri catturare errori di sintassi e di tipo. Di seguito è riportato un esempio:
Passaggio 5: Elenca gli CDK stack nella tua app
A questo punto, dovresti avere un'CDKapp contenente un singolo CDK stack. Per verificare, usa il CDK CLI cdk list
comando per visualizzare gli stack. L'output dovrebbe mostrare un singolo stack denominato: HelloCdkStack
$
cdk list
HelloCdkStack
Se non vedi questo output, verifica di trovarti nella directory di lavoro corretta del progetto e riprova. Se ancora non vedi il tuo stack, ripeti Fase 1: Crea il tuo CDK progetto e riprova.
Fase 6: Definizione della funzione Lambda
In questo passaggio, importate il aws_lambda
modulo dalla AWS Construct Library e utilizzate il costrutto Function
L2.
Modificate il file CDK dello stack come segue:
Diamo un'occhiata più da vicino al Function
costrutto. Come tutti i costrutti, la Function
classe accetta tre parametri:
-
scope: definisce l'
Stack
istanza come genitore delFunction
costrutto. Tutti i costrutti che definiscono AWS le risorse vengono creati nell'ambito di uno stack. È possibile definire costrutti all'interno dei costrutti, creando una gerarchia (albero). Qui, e nella maggior parte dei casi, l'ambito è (inthis
self
Python). -
Id: l'ID di costruzione
Function
all'interno della tua AWS CDK app. Questo ID, più un hash basato sulla posizione della funzione all'interno dello stack, identifica in modo univoco la funzione durante la distribuzione. AWS CDK Inoltre, fa riferimento a questo ID quando aggiorni il costrutto nell'app e lo ridistribuisci per aggiornare la risorsa distribuita. Qui, il tuo ID di costruzione è.HelloWorldFunction
Le funzioni possono anche avere un nome, specificato con lafunctionName
proprietà. Questo è diverso dall'ID del costrutto. -
props — Un insieme di valori che definiscono le proprietà della funzione. Qui si definiscono le
runtime
proprietàhandler
, ecode
.Gli oggetti di scena sono rappresentati in modo diverso nelle lingue supportate da. AWS CDK
-
In TypeScript e JavaScript,
props
è un singolo argomento e si passa un oggetto contenente le proprietà desiderate. -
In Python, gli oggetti di scena vengono passati come argomenti di parole chiave.
-
In Java, viene fornito un Builder per passare gli oggetti di scena. Ce ne sono due: uno per
FunctionProps
e un secondo per consentirviFunction
di costruire il costrutto e il relativo oggetto props in un unico passaggio. Questo codice utilizza quest'ultimo. -
In C#, si crea un'istanza di un
FunctionProps
oggetto utilizzando un inizializzatore di oggetti e lo si passa come terzo parametro.
Se gli oggetti di scena di un costrutto sono opzionali, potete omettere completamente il parametro.
props
-
Tutti i costrutti utilizzano gli stessi tre argomenti, quindi è facile rimanere orientati man mano che si imparano a conoscerne di nuovi. E come ci si potrebbe aspettare, è possibile sottoclassificare qualsiasi costrutto per estenderlo in base alle proprie esigenze o se si desidera modificarne i valori predefiniti.
Fase 7: Definizione della funzione Lambda URL
In questo passaggio, si utilizza il metodo addFunctionUrl
helper del Function
costrutto per definire una funzione Lambda. URL Per restituire il valore di questo valore URL al momento dell'implementazione, creerai un AWS CloudFormation output utilizzando il costrutto. CfnOutput
Aggiungi quanto segue al tuo file CDK stack:
avvertimento
Per semplificare questo tutorial, la funzione Lambda URL è definita senza autenticazione. Una volta distribuito, questo crea un endpoint accessibile pubblicamente che può essere utilizzato per richiamare la funzione. Quando hai finito con questo tutorial, segui Passaggio 12: Eliminare l'applicazione per eliminare queste risorse.
Fase 8: Sintetizzare un modello CloudFormation
In questo passaggio, ci si prepara per la distribuzione sintetizzando un modello con CloudFormation CDK CLI cdk
synth
comando. Questo comando esegue la convalida di base del CDK codice, esegue CDK l'app e genera un CloudFormation modello dal tuo CDK stack.
Se l'app contiene più di uno stack, devi specificare quali stack sintetizzare. Poiché l'app contiene un singolo stack, CDK CLI rileva automaticamente lo stack da sintetizzare.
Se non sintetizzi un modello, CDK CLI eseguirà automaticamente questo passaggio al momento della distribuzione. Tuttavia, si consiglia di eseguire questo passaggio prima di ogni distribuzione per verificare la presenza di errori di sintesi.
Prima di sintetizzare un modello, puoi facoltativamente creare la tua applicazione per catturare errori di sintassi e di tipo. Per istruzioni, consulta Passaggio 4: crea la tua app CDK.
Per sintetizzare un CloudFormation modello, esegui quanto segue dalla radice del progetto:
$
cdk synth
Nota
Se ricevete un errore come il seguente, verificate di trovarvi nella hello-cdk
directory e riprovate:
--app is required either in command-line, in cdk.json or in ~/.cdk.json
In caso di successo, CDK CLI produrrà un YAML CloudFormation —modello formattato stdout
e salvato un JSON—modello formattato nella cdk.out
directory del progetto.
Di seguito è riportato un esempio di output del CloudFormation modello:
Resources: HelloWorldFunctionServiceRole
unique-identifier
: Type: AWS::IAM::Role Properties: AssumeRolePolicyDocument: Statement: - Action: sts:AssumeRole Effect: Allow Principal: Service: lambda.amazonaws.com Version: "2012-10-17" ManagedPolicyArns: - Fn::Join: - "" - - "arn:" - Ref: AWS::Partition - :iam::aws:policy/service-role/AWSLambdaBasicExecutionRole Metadata: aws:cdk:path: HelloCdkStack/HelloWorldFunction/ServiceRole/Resource HelloWorldFunctionunique-identifier
: Type: AWS::Lambda::Function Properties: Code: ZipFile: " \ exports.handler = async function(event) { \ return { \ statusCode: 200, \ body: JSON.stringify('Hello World!'), \ }; \ }; \ " Handler: index.handler Role: Fn::GetAtt: - HelloWorldFunctionServiceRoleunique-identifier
- Arn Runtime: nodejs20.x DependsOn: - HelloWorldFunctionServiceRoleunique-identifier
Metadata: aws:cdk:path: HelloCdkStack/HelloWorldFunction/Resource HelloWorldFunctionFunctionUrlunique-identifier
: Type: AWS::Lambda::Url Properties: AuthType: NONE TargetFunctionArn: Fn::GetAtt: - HelloWorldFunctionunique-identifier
- Arn Metadata: aws:cdk:path: HelloCdkStack/HelloWorldFunction/FunctionUrl/Resource HelloWorldFunctioninvokefunctionurlunique-identifier
: Type: AWS::Lambda::Permission Properties: Action: lambda:InvokeFunctionUrl FunctionName: Fn::GetAtt: - HelloWorldFunctionunique-identifier
- Arn FunctionUrlAuthType: NONE Principal: "*" Metadata: aws:cdk:path: HelloCdkStack/HelloWorldFunction/invoke-function-url CDKMetadata: Type: AWS::CDK::Metadata Properties: Analytics: v2:deflate64:unique-identifier
Metadata: aws:cdk:path: HelloCdkStack/CDKMetadata/Default Condition: CDKMetadataAvailable Outputs: myFunctionUrlOutput: Value: Fn::GetAtt: - HelloWorldFunctionFunctionUrlunique-identifier
- FunctionUrl Parameters: BootstrapVersion: Type: AWS::SSM::Parameter::Value<String> Default: /cdk-bootstrap/unique-identifier
/version Description: Version of the CDK Bootstrap resources in this environment, automatically retrieved from SSM Parameter Store. [cdk:skip] Rules: CheckBootstrapVersion: Assertions: - Assert: Fn::Not: - Fn::Contains: - - "1" - "2" - "3" - "4" - "5" - Ref: BootstrapVersion AssertDescription: CDK bootstrap stack version 6 required. Please run 'cdk bootstrap' with a recent version of the CDK CLI.
Nota
Per impostazione predefinita, ogni modello generato contiene una AWS::CDK::Metadata
risorsa. Il AWS CDK team utilizza questi metadati per ottenere informazioni sull' AWS CDK utilizzo e trovare modi per migliorarlo. Per i dettagli, incluso come disattivare la segnalazione delle versioni, consultaRapporti sulle versioni.
Definendo un singolo costrutto L2, AWS CDK crea un CloudFormation modello completo contenente le risorse Lambda, insieme alle autorizzazioni e alla logica di collegamento necessarie per consentire alle risorse di interagire all'interno dell'applicazione.
Fase 9: Implementa il tuo stack CDK
In questo passaggio, si utilizza il CDK CLI cdk deploy
comando per distribuire lo CDK stack. Questo comando recupera il CloudFormation modello generato e lo distribuisce AWS CloudFormation, il che fornisce le risorse come parte di uno stack. CloudFormation
Dalla radice del progetto, esegui quanto segue. Conferma le modifiche se richiesto:
$
cdk deploy
✨ Synthesis time: 2.69s HelloCdkStack: start: Buildingunique-identifier
:current_account-current_region HelloCdkStack: success: Builtunique-identifier
:current_account-current_region HelloCdkStack: start: Publishingunique-identifier
:current_account-current_region HelloCdkStack: success: Publishedunique-identifier
:current_account-current_region This deployment will make potentially sensitive changes according to your current security approval level (--require-approval broadening). Please confirm you intend to make the following modifications: IAM Statement Changes ┌───┬───────────────────────────────────────┬────────┬──────────────────────────┬──────────────────────────────┬───────────┐ │ │ Resource │ Effect │ Action │ Principal │ Condition │ ├───┼───────────────────────────────────────┼────────┼──────────────────────────┼──────────────────────────────┼───────────┤ │ + │ ${HelloWorldFunction.Arn} │ Allow │ lambda:InvokeFunctionUrl │ * │ │ ├───┼───────────────────────────────────────┼────────┼──────────────────────────┼──────────────────────────────┼───────────┤ │ + │ ${HelloWorldFunction/ServiceRole.Arn} │ Allow │ sts:AssumeRole │ Service:lambda.amazonaws.com │ │ └───┴───────────────────────────────────────┴────────┴──────────────────────────┴──────────────────────────────┴───────────┘ IAM Policy Changes ┌───┬───────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────┐ │ │ Resource │ Managed Policy ARN │ ├───┼───────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────┤ │ + │ ${HelloWorldFunction/ServiceRole} │ arn:${AWS::Partition}:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole │ └───┴───────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────┘ (NOTE: There may be security-related changes not in this list. See https://github.com/aws/aws-cdk/issues/1299) Do you wish to deploy these changes (y/n)?y
Analogamentecdk synth
, non è necessario specificare lo AWS CDK stack poiché l'app contiene un unico stack.
Durante la distribuzione, CDK CLI visualizza le informazioni sullo stato di avanzamento man mano che lo stack viene distribuito. Al termine, puoi accedere alla AWS CloudFormation consoleHelloCdkStack
Puoi anche accedere alla console Lambda per visualizzare la tua HelloWorldFunction
risorsa.
Una volta completata la distribuzione, CDK CLI produrrà il tuo endpointURL. Copia questo URL per il passaggio successivo. Di seguito è riportato un esempio:
... HelloCdkStack: deploying... [1/1] HelloCdkStack: creating CloudFormation changeset... ✅ HelloCdkStack ✨ Deployment time: 41.65s Outputs: HelloCdkStack.myFunctionUrlOutput = https://
<api-id>
.lambda-url.<Region>
.on.aws/ Stack ARN: arn:aws:cloudformation:Region
:account-id
:stack/HelloCdkStack/unique-identifier
✨ Total time: 44.34s
Passaggio 10: Interagisci con la tua applicazione su AWS
In questo passaggio, interagisci con l'applicazione richiamando la funzione Lambda tramite la funzione. AWS URL Quando si accede aURL, la funzione Lambda restituisce il Hello World!
messaggio.
Per richiamare la tua funzione, accedi alla funzione URL tramite il browser o dalla riga di comando. Di seguito è riportato un esempio:
$
curl https://
"Hello World!"%<api-id>
.lambda-url.<Region>
.on.aws/
Passaggio 11: modifica l'applicazione
In questo passaggio, si modifica il messaggio che la funzione Lambda restituisce quando viene richiamata. Si esegue una differenza utilizzando il CDK CLI cdk diff
comando per visualizzare in anteprima le modifiche e distribuirlo per aggiornare l'applicazione. Quindi interagisci con la tua applicazione AWS per visualizzare il tuo nuovo messaggio.
Modifica l'myFunction
istanza nel tuo file CDK stack come segue:
Attualmente, le modifiche al codice non hanno apportato alcun aggiornamento diretto alla risorsa Lambda distribuita. Il codice definisce lo stato desiderato della risorsa. Per modificare la risorsa distribuita, utilizzerai il CDK CLI per sintetizzare lo stato desiderato in un nuovo modello. AWS CloudFormation Quindi, distribuirai il nuovo CloudFormation modello come set di modifiche. I set di modifiche apportano solo le modifiche necessarie per raggiungere il nuovo stato desiderato.
Per visualizzare in anteprima le modifiche, esegui il cdk diff
comando. Di seguito è riportato un esempio:
$
cdk diff
Stack HelloCdkStack Hold on while we create a read-only change set to get a diff with accurate replacement information (use --no-change-set to use a less accurate but faster template-only diff) Resources [~] AWS::Lambda::Function HelloWorldFunction HelloWorldFunctionunique-identifier
└─ [~] Code └─ [~] .ZipFile: ├─ [-] exports.handler = async function(event) { return { statusCode: 200, body: JSON.stringify('Hello World!'), }; }; └─ [+] exports.handler = async function(event) { return { statusCode: 200, body: JSON.stringify('Hello CDK!'), }; }; ✨ Number of stacks with differences: 1
Per creare questa differenza, CDK CLI chiede al tuo Account AWS account il AWS CloudFormation modello più recente per lo HelloCdkStack
stack. Quindi, confronta il modello più recente con il modello appena sintetizzato dalla tua app.
Per implementare le modifiche, esegui il comando. cdk deploy
Di seguito è riportato un esempio:
$
cdk deploy
✨ Synthesis time: 2.12s HelloCdkStack: start: Buildingunique-identifier
:current_account-current_region HelloCdkStack: success: Builtunique-identifier
:current_account-current_region HelloCdkStack: start: Publishingunique-identifier
:current_account-current_region HelloCdkStack: success: Publishedunique-identifier
:current_account-current_region HelloCdkStack: deploying... [1/1] HelloCdkStack: creating CloudFormation changeset... ✅ HelloCdkStack ✨ Deployment time: 26.96s Outputs: HelloCdkStack.myFunctionUrlOutput = https://unique-identifier
.lambda-url.<Region>
.on.aws/ Stack ARN: arn:aws:cloudformation:Region
:account-id
:stack/HelloCdkStack/unique-identifier
✨ Total time: 29.07s
Per interagire con l'applicazione, ripetiPassaggio 10: Interagisci con la tua applicazione su AWS. Di seguito è riportato un esempio:
$
curl https://
"Hello CDK!"%<api-id>
.lambda-url.<Region>
.on.aws/
Passaggio 12: Eliminare l'applicazione
In questo passaggio, si utilizza il CDK CLI cdk destroy
comando per eliminare l'applicazione. Questo comando elimina lo CloudFormation stack associato allo CDK stack, che include le risorse create.
Per eliminare l'applicazione, esegui il cdk destroy
comando e conferma la richiesta di eliminazione dell'applicazione. Di seguito è riportato un esempio:
$
cdk destroy
Are you sure you want to delete: HelloCdkStack (y/n)?y
HelloCdkStack: destroying... [1/1] ✅ HelloCdkStack: destroyed
Passaggi successivi
Complimenti! Hai completato questo tutorial e lo hai utilizzato AWS CDK per creare, modificare ed eliminare correttamente le risorse in Cloud AWS. Ora sei pronto per iniziare a utilizzare il AWS CDK.
Per ulteriori informazioni sull'utilizzo di AWS CDK nel linguaggio di programmazione preferito, consultaLavora con la AWS CDK libreria.
Per ulteriori risorse, consulta quanto segue:
-
Prova il CDKWorkshop
per un tour più approfondito che coinvolge un progetto più complesso. -
Consulta il APIriferimento per iniziare a esplorare CDK i costrutti disponibili per i tuoi servizi preferiti AWS .
-
Visita Construct Hub
per scoprire i costrutti creati da AWS e altri. -
Esplora esempi
di utilizzo di. AWS CDK
AWS CDK È un progetto open source. Per contribuire, vedere Contributing to the AWS Cloud Development Kit (AWS CDK)