Questa è la AWS CDK v2 Developer Guide. 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à. # AWS Riferimento alla CLI CDK L'interfaccia a riga di comando (AWS CDK) del AWS Cloud Development Kit (AWS CDK), nota anche come CDK Toolkit, è lo strumento principale per interagire con l'app CDK. AWS Esegue la tua app, interroga il modello di applicazione che hai definito e produce e distribuisce i modelli generati dal CDK. AWS CloudFormation AWS Fornisce anche altre funzionalità utili per creare e lavorare con progetti CDK. AWS Questo argomento contiene informazioni sui casi d'uso comuni della CLI CDK. La CLI CDK viene installata con Node Package Manager. Nella maggior parte dei casi, consigliamo di installarlo a livello globale. ``` npm install -g aws-cdk # install latest version npm install -g aws-cdk@X.YY.Z # install specific version ``` **Suggerimento** Se lavori regolarmente con più versioni del AWS CDK, prendi in considerazione l'installazione di una versione corrispondente della CLI CDK nei singoli progetti CDK. Per fare ciò, `-g` omettete dal comando. `npm install` Quindi usa `npx aws-cdk` per invocarlo. Questo esegue la versione locale se ne esiste una, tornando a una versione globale in caso contrario. ## Comandi CDK CLI Tutti i comandi CDK CLI iniziano `cdk` con, seguito da un sottocomando `list` (`synthesize`,`deploy`, ecc.). Alcuni sottocomandi hanno una versione più breve (`ls`,`synth`, ecc.) che è equivalente. Le opzioni e gli argomenti seguono il sottocomando in qualsiasi ordine. Per una descrizione di tutti i sottocomandi, le opzioni e gli argomenti, consultate il riferimento ai comandi [AWS CDK CLI](ref-cli-cmd.md). ## Specificate le opzioni e i relativi valori Le opzioni della riga di comando iniziano con due trattini ()`--`. Alcune opzioni utilizzate di frequente hanno sinonimi composti da una sola lettera che iniziano con un solo trattino (ad esempio, `--app` ha un sinonimo). `-a` L'ordine delle opzioni in un comando CDK CLI non è importante. Tutte le opzioni accettano un valore, che deve seguire il nome dell'opzione. Il valore può essere separato dal nome con uno spazio bianco o con un segno di uguale. `=` Le due opzioni seguenti sono equivalenti. ``` --toolkit-stack-name MyBootstrapStack --toolkit-stack-name=MyBootstrapStack ``` Alcune opzioni sono bandiere (booleane). È possibile specificare `true` o `false` specificare il loro valore. Se non si fornisce un valore, il valore viene considerato uguale a`true`. È inoltre possibile aggiungere al nome dell'opzione il prefisso «`no-`da `false` implicare». ``` # sets staging flag to true --staging --staging=true --staging true # sets staging flag to false --no-staging --staging=false --staging false ``` Alcune opzioni, vale a dire`--context`,`--parameters`, e `--plugin` `--tags``--trust`, possono essere specificate più di una volta per specificare più valori. Questi sono indicati come `[array]` digitati nella guida della CLI di CDK. Esempio: ``` cdk bootstrap --tags costCenter=0123 --tags responsibleParty=jdoe ``` ## Aiuto integrato La CLI CDK dispone di una guida integrata. È possibile visualizzare una guida generale sull'utilità e un elenco dei sottocomandi forniti eseguendo: ``` cdk --help ``` Per visualizzare l'aiuto relativo a un particolare sottocomando, ad esempio`deploy`, specificatelo prima del flag. `--help` ``` cdk deploy --help ``` Problema `cdk version` per visualizzare la versione della CLI CDK. Fornisci queste informazioni quando richiedi assistenza. ## Reportistica delle versioni Per ottenere informazioni su come viene utilizzato il AWS CDK, i costrutti utilizzati dalle applicazioni AWS CDK vengono raccolti e riportati utilizzando una risorsa identificata come. ` AWS::CDK::Metadata` Per ulteriori informazioni, consulta [Configurare la reportistica dei dati di utilizzo di AWS CDK.](usage-data.md) ## Autenticazione con AWS Esistono diversi modi in cui è possibile configurare l'accesso programmatico alle AWS risorse, a seconda dell'ambiente e dell' AWS accesso a disposizione. Per scegliere il metodo di autenticazione e configurarlo per la CLI CDK, [consulta Configurare le credenziali di sicurezza per la AWS](configure-access.md) CLI CDK. L'approccio consigliato per i nuovi utenti che si sviluppano localmente, ai quali non viene fornito un metodo di autenticazione dal datore di lavoro, consiste nel configurare IAM Identity Center. AWS Questo metodo include l'installazione della AWS CLI per facilitare la configurazione e per accedere regolarmente al portale di AWS accesso. Se scegli questo metodo, il tuo ambiente dovrebbe contenere i seguenti elementi dopo aver completato la procedura per l'[autenticazione di IAM Identity Center](https://docs.aws.amazon.com/sdkref/latest/guide/access-sso.html) nella * AWS SDKs and Tools Reference Guide:* + La AWS CLI, che viene utilizzata per avviare una sessione del portale di AWS accesso prima di eseguire l'applicazione. + Un [file di AWS configurazione condiviso](https://docs.aws.amazon.com/sdkref/latest/guide/file-format.html) con un `[default]` profilo con un set di valori di configurazione a cui è possibile fare riferimento dal CDK. AWS Per trovare la posizione di questo file, consulta [Posizione dei file condivisi nella Guida](https://docs.aws.amazon.com/sdkref/latest/guide/file-location.html) di riferimento *agli strumenti AWS SDKs e strumenti*. + Il `config` file condiviso imposta l'impostazione [della regione](https://docs.aws.amazon.com/sdkref/latest/guide/feature-region.html). Questo imposta la AWS regione predefinita utilizzata da AWS CDK e CDK CLI per le richieste. AWS + La CLI CDK utilizza la configurazione del [provider di token SSO del](https://docs.aws.amazon.com/sdkref/latest/guide/feature-sso-credentials.html#feature-sso-credentials-profile) profilo per acquisire le credenziali prima di inviare richieste a. AWS Il `sso_role_name` valore, che è un ruolo IAM connesso a un set di autorizzazioni IAM Identity Center, dovrebbe consentire l'accesso ai AWS servizi utilizzati nell'applicazione. Il seguente `config` file di esempio mostra un profilo predefinito impostato con la configurazione del provider di token SSO. L'`sso_session`impostazione del profilo si riferisce alla [`sso-session`sezione](https://docs.aws.amazon.com/sdkref/latest/guide/file-format.html#section-session) denominata. La `sso-session` sezione contiene le impostazioni per avviare una sessione del portale di AWS accesso. ``` [default] sso_session = sso_account_id = <111122223333> sso_role_name = region = output = [sso-session ] sso_region = sso_start_url = sso_registration_scopes = sso:account:access ``` ### Avviare una sessione del portale di AWS accesso Prima di accedere ai AWS servizi, è necessaria una sessione attiva del portale di AWS accesso affinché la CLI CDK utilizzi l'autenticazione IAM Identity Center per risolvere le credenziali. A seconda della durata della sessione configurata, l'accesso alla fine scadrà e la CLI CDK riscontrerà un errore di autenticazione. Esegui il seguente comando nella AWS CLI per accedere al portale di AWS accesso. ``` aws sso login ``` Se la configurazione del provider di token SSO utilizza un profilo denominato anziché il profilo predefinito, il comando è. `aws sso login --profile ` Specificate inoltre questo profilo quando emettete `cdk` comandi utilizzando l'`--profile`opzione o la variabile di `AWS_PROFILE` ambiente. Per verificare se hai già una sessione attiva, esegui il seguente comando AWS CLI. ``` aws sts get-caller-identity ``` La risposta a questo comando dovrebbe restituire l'account IAM Identity Center e il set di autorizzazioni configurati nel file `config` condiviso. **Nota** Se hai già una sessione attiva del portale di AWS accesso ed esegui`aws sso login`, non ti verrà richiesto di fornire credenziali. La procedura di accesso potrebbe richiedere all'utente di consentire l'accesso ai dati da parte della AWS CLI. Poiché la AWS CLI è basata sull'SDK per Python, i messaggi di autorizzazione possono contenere variazioni del nome. `botocore` ## Specificare la regione e altre configurazioni La CLI CDK deve conoscere AWS la regione in cui stai distribuendo e come autenticarti. AWS Ciò è necessario per le operazioni di distribuzione e per recuperare i valori di contesto durante la sintesi. Insieme, l'account e la regione costituiscono l'*ambiente.* La regione può essere specificata utilizzando variabili di ambiente o nei file di configurazione. Queste sono le stesse variabili e gli stessi file utilizzati da altri AWS strumenti come la AWS CLI e vari. AWS SDKs La CLI CDK cerca queste informazioni nell'ordine seguente. + Variabile di ambiente `AWS_DEFAULT_REGION` + Un profilo denominato definito nel AWS `config` file standard e specificato utilizzando l'`--profile`opzione sui `cdk` comandi. + La `[default]` sezione del AWS `config` file standard. Oltre a specificare AWS l'autenticazione e una regione nella `[default]` sezione, puoi anche aggiungere una o più `[profile ]` sezioni, dove `` è il nome del profilo. Per ulteriori informazioni sui profili denominati, consulta [File di configurazione e credenziali condivisi](https://docs.aws.amazon.com/sdkref/latest/guide/file-format.html) nella Guida di riferimento *agli strumenti AWS SDKs e agli strumenti*. Il AWS `config` file standard si trova in `~/.aws/config` (macOS/Linux) o `%USERPROFILE%\.aws\config` (Windows). *Per dettagli e posizioni alternative, consulta [Posizione dei file di configurazione e credenziali condivisi nella Guida di riferimento di and](https://docs.aws.amazon.com/sdkref/latest/guide/file-location.html) Tools AWS SDKs * L'ambiente specificato nell'app AWS CDK utilizzando la `env` proprietà dello stack viene utilizzato durante la sintesi. Viene utilizzato per generare un AWS CloudFormation modello specifico per l'ambiente e, durante la distribuzione, sostituisce l'account o la regione specificati con uno dei metodi precedenti. [Per ulteriori informazioni, consulta Environments for the CDK. AWS](environments.md) **Nota** Il AWS CDK utilizza le credenziali degli stessi file sorgente AWS degli altri strumenti SDKs, inclusa l'interfaccia a riga di [AWS comando](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html). Tuttavia, il AWS CDK potrebbe comportarsi in modo leggermente diverso da questi strumenti. Utilizza l' AWS SDK per essere utilizzato JavaScript sotto il cofano. [Per i dettagli completi sulla configurazione delle credenziali per l' AWS SDK per JavaScript, consulta Impostazione delle credenziali.](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/setting-credentials.html) Facoltativamente, puoi utilizzare l'opzione `--role-arn` (or`-r`) per specificare l'ARN di un ruolo IAM da utilizzare per la distribuzione. Questo ruolo deve essere assunto dall' AWS account utilizzato. ## Specificare il comando dell'app Molte funzionalità della CLI CDK richiedono la sintesi di uno o AWS CloudFormation più modelli, il che a sua volta richiede l'esecuzione dell'applicazione. Il AWS CDK supporta programmi scritti in diversi linguaggi. Pertanto, utilizza un'opzione di configurazione per specificare l'esatto comando necessario per eseguire l'app. Questa opzione può essere specificata in due modi. Innanzitutto, e più comunemente, può essere specificata utilizzando la `app` chiave all'interno del file`cdk.json`. Si trova nella directory principale del progetto AWS CDK. La CLI CDK fornisce un comando appropriato per la creazione di un nuovo progetto con. `cdk init` Ecco, ad esempio, il `cdk.json` brano tratto da un nuovo TypeScript progetto. ``` { "app": "npx ts-node bin/hello-cdk.ts" } ``` La CLI CDK `cdk.json` cerca nella directory di lavoro corrente quando tenta di eseguire l'app. Per questo motivo, potresti tenere aperta una shell nella directory principale del tuo progetto per l'emissione di comandi CDK CLI. La CLI CDK cerca anche la chiave dell'app (cioè `~/.cdk.json` nella tua home directory) se non riesce a trovarla. `./cdk.json` Aggiungere qui il comando dell'app può essere utile se di solito lavori con codice CDK nella stessa lingua. Se ti trovi in un'altra directory o desideri eseguire l'app utilizzando un comando diverso da quello in`cdk.json`, usa l'opzione `--app` (or`-a`) per specificarlo. ``` cdk --app "npx ts-node bin/hello-cdk.ts" ls ``` Durante la distribuzione, puoi anche specificare una directory contenente assembly cloud sintetizzati, ad esempio`cdk.out`, come valore di. `--app` Gli stack specificati vengono distribuiti da questa directory; l'app non viene sintetizzata. ## Specificare gli stack Molti comandi CDK CLI (ad esempio`cdk deploy`) funzionano sugli stack definiti nell'app. Se la tua app contiene solo uno stack, la CLI CDK presuppone che tu intenda quello se non specifichi uno stack in modo esplicito. Altrimenti, devi specificare lo stack o gli stack con cui vuoi lavorare. È possibile farlo specificando singolarmente gli stack desiderati per ID sulla riga di comando. Ricorda che l'ID è il valore specificato dal secondo argomento quando crei un'istanza dello stack. ``` cdk synth PipelineStack LambdaStack ``` Potete anche usare i caratteri jolly per specificare IDs che corrispondono a un pattern. + `?`corrisponde a qualsiasi carattere singolo + `*`corrisponde a qualsiasi numero di caratteri (`*`da solo corrisponde a tutte le pile) + `**`corrisponde a tutto ciò che è in una gerarchia Puoi anche usare l'`--all`opzione per specificare tutti gli stack. Se la tua app utilizza [CDK Pipelines, la CLI CDK](cdk-pipeline.md) interpreta i tuoi stack e le tue fasi come una gerarchia. Inoltre, l'`--all`opzione e la jolly corrispondono solo agli stack di primo livello. `*` Per abbinare tutte le pile, usa. `**` Utilizzalo anche `**` per indicare tutte le pile in una particolare gerarchia. Quando usate i caratteri jolly, racchiudete il pattern tra virgolette o uscite dai caratteri jolly con. `\` Se non lo fate, la vostra shell potrebbe cercare di espandere il pattern ai nomi dei file nella directory corrente. Nella migliore delle ipotesi, questo non farà quello che ti aspetti; nel peggiore dei casi, potresti distribuire stack che non avevi intenzione di fare. Questo non è strettamente necessario su Windows perché `cmd.exe` non espande i caratteri jolly, ma è comunque una buona pratica. ``` cdk synth "*Stack" # PipelineStack, LambdaStack, etc. cdk synth 'Stack?' # StackA, StackB, Stack1, etc. cdk synth \* # All stacks in the app, or all top-level stacks in a CDK Pipelines app cdk synth '**' # All stacks in a CDK Pipelines app cdk synth 'PipelineStack/Prod/**' # All stacks in Prod stage in a CDK Pipelines app ``` **Nota** L'ordine in cui si specificano gli stack non è necessariamente l'ordine in cui verranno elaborati. La CLI CDK tiene conto delle dipendenze tra gli stack quando decide l'ordine in cui elaborarli. Ad esempio, supponiamo che uno stack utilizzi un valore prodotto da un altro (come l'ARN di una risorsa definita nel secondo stack). In questo caso, il secondo stack viene sintetizzato prima del primo a causa di questa dipendenza. È possibile aggiungere dipendenze tra gli stack manualmente utilizzando il metodo dello stack. ` [addDependency()](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.Stack.html#addwbrdependencytarget-reason) ` ## Avvia il tuo ambiente AWS L'implementazione degli stack con il CDK richiede il provisioning di risorse AWS CDK speciali dedicate. Il `cdk bootstrap` comando crea le risorse necessarie per te. È necessario eseguire il bootstrap solo se si distribuisce uno stack che richiede queste risorse dedicate. Vedi [AWS CDK](bootstrapping.md) bootstrapping per i dettagli. ``` cdk bootstrap ``` Se emesso senza argomenti, come mostrato qui, il `cdk bootstrap` comando sintetizza l'app corrente e avvia gli ambienti in cui verranno distribuiti i suoi stack. Se l'app contiene stack indipendenti dall'ambiente, che non specificano esplicitamente un ambiente, l'account e la regione predefiniti vengono avviati oppure l'ambiente specificato viene utilizzato. `--profile` All'esterno di un'app, è necessario specificare in modo esplicito l'ambiente da avviare. Puoi farlo anche per avviare un ambiente non specificato nella tua app o nel tuo profilo locale. AWS Le credenziali devono essere configurate (ad esempio in`~/.aws/credentials`) per l'account e la regione specificati. È possibile specificare un profilo che contenga le credenziali richieste. ``` cdk bootstrap / # e.g. cdk bootstrap 1111111111/us-east-1 cdk bootstrap --profile test 1111111111/us-east-1 ``` **Importante** Ogni ambiente (combinazione account/regione) in cui viene distribuito tale stack deve essere avviato separatamente. È possibile che vengano AWS addebitati costi per ciò che il CDK archivia nelle risorse avviate. AWS Inoltre, se si utilizza`--bootstrap-customer-key`, verrà creata una chiave AWS KMS, che comporta anche addebiti per ambiente. **Nota** Le versioni precedenti del modello bootstrap creavano una chiave KMS per impostazione predefinita. Per evitare addebiti, riavvia il sistema utilizzando. `--no-bootstrap-customer-key` **Nota** CDK CLI v2 non supporta il modello di bootstrap originale, soprannominato modello legacy, utilizzato di default con CDK v1. **Importante** Il moderno modello di bootstrap concede in modo efficace le autorizzazioni implicite da a qualsiasi account presente nell'elenco. `--cloudformation-execution-policies` AWS `--trust` Per impostazione predefinita, questo estende le autorizzazioni di lettura e scrittura a qualsiasi risorsa nell'account avviato. Assicurati di [configurare lo stack di bootstrap](bootstrapping-customizing.md) con politiche e account affidabili con cui ti senti a tuo agio. ## Crea una nuova app Per creare una nuova app, crea una cartella corrispondente, quindi, all'interno della directory, emetti`cdk init`. ``` mkdir my-cdk-app cd my-cdk-app cdk init