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à.
AWS CDKCLIriferimento al comando
Questa sezione contiene informazioni di riferimento sui comandi per l'interfaccia a riga di AWS Cloud Development Kit (AWS CDK) comando ()CLI. Il CDK CLI viene anche chiamato CDK Toolkit.
Utilizzo
$
cdk
<command>
<arguments>
<options>
Comandi
acknowledge, ack
-
Riconosci un avviso per numero di emissione e impedisci che venga nuovamente visualizzato.
bootstrap
-
Prepara un AWS ambiente per le implementazioni CDK distribuendo lo stack di bootstrap CDK, denominato, nell'ambiente.
CDKToolkit
AWS context
-
Gestisci i valori di contesto memorizzati nella cache per la tua applicazione CDK.
deploy
-
Implementa uno o più stack CDK nel tuo ambiente. AWS
destroy
-
Elimina uno o più stack CDK dal tuo ambiente. AWS
diff
-
Esegui una differenza per vedere le modifiche all'infrastruttura tra gli stack CDK.
docs, doc
-
Apri la documentazione CDK nel tuo browser.
doctor
-
Consulta e visualizza informazioni utili sul progetto CDK locale e sull'ambiente di sviluppo.
import
-
Utilizzate le importazioni di AWS CloudFormation risorse per importare AWS le risorse esistenti in uno stack CDK.
init
-
Crea un nuovo progetto CDK da un modello.
list, ls
-
Elenca tutti gli stack CDK e le relative dipendenze da un'app CDK.
metadata
-
Visualizza i metadati associati a uno stack CDK.
migrate
-
Migra AWS risorse, AWS CloudFormation stack e AWS CloudFormation modelli in un nuovo progetto CDK.
notices
-
Visualizza gli avvisi per la tua applicazione CDK.
synthesize, synth
-
Sintetizza un'app CDK per produrre un assembly cloud, incluso un AWS CloudFormation modello per ogni stack.
watch
-
Monitora continuamente un progetto CDK locale per verificare eventuali modifiche, eseguire distribuzioni e hotswap.
Opzioni globali
Le seguenti opzioni sono compatibili con tutti i CLI comandi CDK.
--app, -a
STRING
-
Fornisci il comando per eseguire l'app o la directory di assemblaggio cloud.
Campo obbligatorio: sì
--asset-metadata
BOOLEAN
-
Includi
aws:asset:*
AWS CloudFormation i metadati per le risorse che utilizzano risorse.Required: No
Valore predefinito:
true
--build
STRING
-
Comando per eseguire una build di pre-sintesi.
Required: No
--ca-bundle-path
STRING
-
Percorso di un certificato CA da utilizzare per la convalida delle richieste HTTPS.
Se questa opzione non viene fornita, il CDK CLI leggerà dalla variabile di
AWS_CA_BUNDLE
ambiente.Campo obbligatorio: sì
--ci
BOOLEAN
-
Indica che CLI i comandi CDK vengono eseguiti in un ambiente di integrazione continua (CI).
Questa opzione modifica il comportamento del CDK CLI per adattarlo meglio alle operazioni automatizzate tipiche delle pipeline CI.
Quando si fornisce questa opzione, i log vengono inviati invece di.
stdout
stderr
Required: No
Valore predefinito:
false
--context, -c
ARRAY
-
Aggiungi parametri di stringa contestuali come coppie chiave-valore.
--debug
BOOLEAN
-
Abilita informazioni di debug dettagliate. Questa opzione produce un output dettagliato che include molti più dettagli su ciò che il CDK CLI sta facendo dietro le quinte.
Required: No
Valore predefinito:
false
--ec2creds, -i
BOOLEAN
-
Imponi al CDK di CLI cercare di recuperare le credenziali dell'istanza Amazon EC2.
Per impostazione predefinita, il CDK CLI indovina lo stato dell'istanza Amazon EC2.
Required: No
Valore predefinito:
false
--help, -h
BOOLEAN
-
Mostra le informazioni di riferimento dei comandi per il CDK. CLI
Required: No
Valore predefinito:
false
--ignore-errors
BOOLEAN
-
Ignora gli errori di sintesi, che probabilmente produrranno un output non valido.
Required: No
Valore predefinito:
false
--json, -j
BOOLEAN
-
Utilizzate JSON anziché YAML per i AWS CloudFormation modelli stampati su standard output ().
stdout
Required: No
Valore predefinito:
false
--lookups
BOOLEAN
-
Esegui ricerche contestuali.
La sintesi avrà esito negativo se questo valore è valido
false
e se è necessario eseguire ricerche di contesto.Required: No
Valore predefinito:
true
--no-color
BOOLEAN
-
Rimuovi il colore e altri stili dall'output della console.
Required: No
Valore predefinito:
false
--notices
BOOLEAN
-
Mostra gli avvisi pertinenti.
Required: No
Valore predefinito:
false
--output, -o
STRING
-
Specificate la directory in cui inviare l'assembly cloud sintetizzato.
Campo obbligatorio: sì
Valore predefinito:
cdk.out
--path-metadata
BOOLEAN
-
Includi
aws::cdk::path
AWS CloudFormation i metadati per ogni risorsa.Required: No
Valore predefinito:
true
--plugin, -p
ARRAY
-
Nome o percorso di un node pacchetto che estende le funzionalità CDK. Questa opzione può essere fornita più volte in un unico comando.
Puoi configurare questa opzione nel
cdk.json
file del progetto o~/.cdk.json
sul tuo computer di sviluppo locale:{ // ... "plugin": [ "module_1", "module_2" ], // ... }
Required: No
--profile
STRING
-
Specificate il nome del AWS profilo, contenente le informazioni AWS sull'ambiente, da utilizzare con il CDKCLI.
Campo obbligatorio: sì
--proxy
STRING
-
Usa il proxy indicato.
Se questa opzione non viene fornita, il CDK CLI leggerà la variabile di
HTTPS_PROXY
ambiente.Campo obbligatorio: sì
Valore predefinito: letto dalla variabile di
HTTPS_PROXY
ambiente. --role-arn, -r
STRING
-
L'ARN del ruolo IAM che il CDK CLI assumerà durante l'interazione. AWS CloudFormation
Required: No
--staging
BOOLEAN
-
Copia le risorse nella directory di output.
Specificate
false
per impedire la copia delle risorse nella directory di output. Ciò consente di AWS SAM CLI fare riferimento ai file sorgente originali durante il debug locale.Required: No
Valore predefinito:
true
--strict
BOOLEAN
-
Non costruite pile che contengano avvertenze.
Required: No
Valore predefinito:
false
--trace
BOOLEAN
-
Stampa la traccia per gli avvisi relativi agli stack.
Required: No
Valore predefinito:
false
--verbose, -v
COUNT
-
Mostra i registri di debug. È possibile specificare questa opzione più volte per aumentare la verbosità.
Required: No
--version
BOOLEAN
-
Mostra il numero di versione del CDK. CLI
Required: No
Valore predefinito:
false
--version-reporting
BOOLEAN
-
Includi la
AWS::CDK::Metadata
risorsa nei modelli sintetizzati AWS CloudFormation .Required: No
Valore predefinito:
true
Fornitura e configurazione delle opzioni
È possibile passare le opzioni tramite argomenti della riga di comando. Per la maggior parte delle opzioni, è possibile configurarle in un cdk.json
file di configurazione. Quando si utilizzano più fonti di configurazione, il CDK CLI rispetta la seguente priorità:
-
Valori della riga di comando: qualsiasi opzione fornita nella riga di comando sostituisce le opzioni configurate nei file.
cdk.json
-
File di configurazione del progetto: il
cdk.json
file nella directory del progetto CDK. -
File di configurazione utente: il
cdk.json
file che si trova~/.cdk.json
sul computer locale.
Passaggio di opzioni dalla riga di comando
Passaggio di valori booleani
Per le opzioni che accettano un valore booleano, è possibile specificarle nei seguenti modi:
-
Uso
true
efalse
valori: fornite il valore booleano con il comando. Di seguito è riportato un esempio:$
cdk deploy --watch=true
$
cdk deploy --watch=false
-
Fornisci la controparte dell'opzione: modifica il nome dell'opzione aggiungendo o specificando
no
un valore.false
Di seguito è riportato un esempio:$
cdk deploy --watch
$
cdk deploy --no-watch
-
Per le opzioni il cui valore predefinito è
true
ofalse
, non è necessario fornire l'opzione a meno che non si desideri modificare l'impostazione predefinita.