View a markdown version of this page

bootstrap cdk - AWS Kit di sviluppo cloud (AWS CDK) v2

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à.

bootstrap cdk

Prepara un AWS ambiente per le implementazioni CDK implementando lo stack di bootstrap CDK, denominatoCDKToolkit, nell'ambiente. AWS

Lo stack bootstrap è uno CloudFormation stack che fornisce un bucket Amazon S3 e un repository Amazon ECR nell'ambiente. AWS L'interfaccia a riga di AWS comando CDK utilizza queste risorse per archiviare modelli sintetizzati e risorse correlate durante l'implementazione.

Utilizzo

$ cdk bootstrap <arguments> <options>

Arguments (Argomenti)

AWS ambiente

L' AWS ambiente di destinazione in cui distribuire lo stack di bootstrap nel seguente formato:. aws://<account-id>/<region>

Ad esempio: aws://123456789012/us-east-1

Questo argomento può essere fornito più volte in un singolo comando per distribuire lo stack bootstrap in più ambienti.

Per impostazione predefinita, la CLI CDK avvierà tutti gli ambienti a cui si fa riferimento nell'app CDK o determinerà un ambiente a partire dalle fonti predefinite. Potrebbe trattarsi di un ambiente specificato utilizzando l'--profileopzione, da variabili di ambiente o da sorgenti CLI predefinite. AWS

Opzioni

Per un elenco delle opzioni globali che funzionano con tutti i comandi CLI CDK, vedi Opzioni globali.

--bootstrap-bucket-name, --toolkit-bucket-name, -b <STRING>

Il nome del bucket Amazon S3 che verrà utilizzato dalla CLI CDK. Questo bucket verrà creato e al momento non deve esistere.

Fornisci questa opzione per sovrascrivere il nome predefinito del bucket Amazon S3.

Quando si utilizza questa opzione, potrebbe essere necessario personalizzare la sintesi. Per saperne di più, consulta Personalizzare la sintesi dello stack CDK.

Valore predefinito: non definito

--bootstrap-customer-key <BOOLEAN>

Crea una Customer Master Key (CMK) per il bucket bootstrap (ti verrà addebitato ma puoi personalizzare le autorizzazioni, solo il bootstrap moderno).

Questa opzione non è compatibile con. --bootstrap-kms-key-id

Valore predefinito: non definito

--bootstrap-kms-key-id <STRING>

L'ID della chiave master AWS KMS da utilizzare per la SSE-KMS crittografia.

Fornisci questa opzione per sovrascrivere la chiave AWS KMS predefinita utilizzata per crittografare il bucket Amazon S3.

Questa opzione non è compatibile con. --bootstrap-customer-key

Valore predefinito: non definito

--express <BOOLEAN>

Bootstrap utilizzando la modalità CloudFormation express. La modalità Express consente implementazioni più rapide CloudFormation segnalando che le operazioni dello stack sono state completate non appena CloudFormation viene applicata la configurazione delle risorse. Tuttavia, CloudFormation segnala il successo senza attendere che le risorse si stabilizzino. Inoltre, la modalità express non esegue il rollback automaticamente e lascerà gli stack in uno stato di errore se qualcosa va storto.

Per ulteriori informazioni, vedere la modalità express nella Guida per l' AWS CloudFormation utente.

Valore predefinito: false

--cloudformation-execution-policies <ARRAY>

Le policy IAM gestite devono essere associate al ruolo di distribuzione assunto AWS CloudFormation durante la distribuzione degli stack.

Per impostazione predefinita, gli stack vengono distribuiti con le autorizzazioni di amministratore complete utilizzando la policy. AdministratorAccess

È possibile fornire questa opzione più volte in un unico comando. Puoi anche fornire più ARN come singola stringa, con i singoli ARN separati da virgole. Di seguito è riportato un esempio:

$ cdk bootstrap --cloudformation-execution-policies "arn:aws:iam::aws:policy/AWSLambda_FullAccess,arn:aws:iam::aws:policy/AWSCodeDeployFullAccess"

Per evitare errori di distribuzione, assicurati che le policy specificate siano sufficienti per tutte le distribuzioni che intendi eseguire nell'ambiente in cui viene avviato il bootstrap.

Questa opzione si applica solo al bootstrap moderno.

Importante

Il moderno modello di bootstrap concede effettivamente le autorizzazioni implicite --cloudformation-execution-policies a qualsiasi account nell'elenco. AWS --trust Per impostazione predefinita, questo estende le autorizzazioni di lettura e scrittura a qualsiasi risorsa nell'account di avvio. Assicurati di configurare lo stack di bootstrap con policy e account affidabili con cui ti senti a tuo agio.

Valore predefinito: []

--custom-permissions-boundary, -cpb <STRING>

Specifica il nome di un limite di autorizzazioni da utilizzare.

Questa opzione non è compatibile con. --example-permissions-boundary

Valore predefinito: non definito

--example-permissions-boundary, -epb <BOOLEAN>

Usa il limite delle autorizzazioni di esempio, fornito dal CDK. AWS

Questa opzione non è compatibile con. --custom-permissions-boundary

La politica dei limiti delle autorizzazioni fornita dal CDK dovrebbe essere considerata un esempio. Modifica il contenuto e fai riferimento alla politica di esempio se stai testando la funzionalità. Convertila in una nuova policy per le implementazioni effettive, se non ne esiste già una. La preoccupazione è evitare la deriva. Molto probabilmente, viene mantenuto un limite di autorizzazioni e ha convenzioni dedicate, denominazione inclusa.

Per ulteriori informazioni sulla configurazione delle autorizzazioni, incluso l'utilizzo dei limiti delle autorizzazioni, consulta la Security and Safety Dev Guide. https://github.com/aws/aws-cdk/wiki/Security-And-Safety-Dev-Guide

Valore predefinito: non definito

--execute <BOOLEAN>

Configura se eseguire il set di modifiche.

Valore predefinito: true

--force, -f <BOOLEAN>

Effettua sempre il bootstrap, anche se ciò comporterebbe il downgrade della versione del modello di bootstrap.

Valore predefinito: false

--help, -h <BOOLEAN>

Mostra le informazioni di riferimento relative al comando. cdk bootstrap

--previous-parameters <BOOLEAN>

Usa i valori precedenti per i parametri esistenti.

Una volta distribuito un modello di bootstrap con un set di parametri, è necessario impostare questa opzione su false per modificare qualsiasi parametro nelle distribuzioni future. Quandofalse, è necessario fornire nuovamente tutti i parametri forniti in precedenza.

Valore predefinito: true

--public-access-block-configuration <BOOLEAN>

Blocca la configurazione ad accesso pubblico sul bucket Amazon S3 creato e utilizzato dalla CLI CDK.

Valore predefinito: true

--qualifier <STRING>

Nine-digit valore di stringa univoco per ogni stack di bootstrap. Questo valore viene aggiunto all'ID fisico delle risorse nello stack bootstrap.

Fornendo un qualificatore, si evitano conflitti tra i nomi delle risorse quando si esegue il provisioning di più stack di bootstrap nello stesso ambiente.

Quando modificate il qualificatore, l'app CDK deve passare il valore modificato allo stack synthesizer. Per ulteriori informazioni, consulta Personalizzare la sintesi dello stack CDK.

Valore predefinito: hnb659fds. Questo valore non ha alcun significato.

--show-template <BOOLEAN>

Invece di eseguire il bootstrap, stampate il modello di bootstrap corrente sullo standard output (). stdout È quindi possibile copiare e personalizzare il modello secondo necessità.

Valore predefinito: false

--tags, -t <ARRAY>

Tag da aggiungere allo stack di bootstrap nel formato diKEY=VALUE.

Valore predefinito: []

--template <STRING>

Usa il modello del file specificato invece di quello integrato.

--termination-protection <BOOLEAN>

Attiva la protezione dalla AWS CloudFormation terminazione nello stack bootstrap.

Quandotrue, la protezione da terminazione è abilitata. Ciò impedisce l'eliminazione accidentale dello stack di bootstrap.

Per saperne di più sulla protezione dalla terminazione, vedi Proteggere uno stack dall'eliminazione nella Guida per l' AWS CloudFormation utente.

Valore predefinito: non definito

--toolkit-stack-name <STRING>

Il nome dello stack di bootstrap da creare.

Per impostazione predefinita, cdk bootstrap distribuisce uno stack denominato CDKToolkit nell'ambiente specificato AWS . Usa questa opzione per fornire un nome diverso per il tuo stack di bootstrap.

La CLI CDK utilizza questo valore per verificare la versione dello stack di bootstrap.

Valore predefinito: CDKToolkit

Obbligatorio: sì

--trust <ARRAY>

Gli ID degli AWS account che dovrebbero essere considerati attendibili per eseguire le implementazioni in questo ambiente.

L'account che esegue il bootstrap sarà sempre considerato attendibile.

Questa opzione richiede che tu fornisca anche. --cloudformation-execution-policies

È possibile fornire questa opzione più volte in un unico comando.

Questa opzione si applica solo al bootstrap moderno.

Per aggiungere account attendibili a uno stack di bootstrap esistente, devi specificare tutti gli account di cui fidarti, compresi quelli che potresti aver fornito in precedenza. Se fornisci solo nuovi account di cui fidarti, gli account precedentemente attendibili verranno rimossi.

Di seguito è riportato un esempio che considera attendibili due account:

$ cdk bootstrap aws://123456789012/us-west-2 --trust 234567890123 --trust 987654321098 --cloudformation-execution-policies arn:aws:iam::aws:policy/AdministratorAccess ⏳ Bootstrapping environment aws://123456789012/us-west-2... Trusted accounts for deployment: 234567890123, 987654321098 Trusted accounts for lookup: (none) Execution policies: arn:aws:iam::aws:policy/AdministratorAccess CDKToolkit: creating CloudFormation changeset... ✅ Environment aws://123456789012/us-west-2 bootstrapped.
Importante

Il moderno modello di bootstrap concede efficacemente le autorizzazioni implicite --cloudformation-execution-policies a qualsiasi AWS account nell'elenco. --trust Per impostazione predefinita, questo estende le autorizzazioni di lettura e scrittura a qualsiasi risorsa nell'account di avvio. Assicurati di configurare lo stack di bootstrap con policy e account affidabili con cui ti senti a tuo agio.

Valore predefinito: []

--trust-for-lookup <ARRAY>

Gli ID degli AWS account che dovrebbero essere considerati attendibili per la ricerca di valori in questo ambiente.

Utilizzate questa opzione per concedere agli account il permesso di sintetizzare gli stack che verranno distribuiti nell'ambiente, senza in realtà concedere loro il permesso di distribuire direttamente tali stack.

È possibile fornire questa opzione più volte in un unico comando.

Questa opzione si applica solo al bootstrap moderno.

Valore predefinito: []

Esempi

Avvia il AWS ambiente specificato nel profilo del prodotto

$ cdk bootstrap --profile prod

Distribuisci lo stack di bootstrap negli ambienti foo and bar

$ cdk bootstrap --app='node bin/main.js' foo bar

Esporta il modello di bootstrap per personalizzarlo

Se hai requisiti specifici che non sono soddisfatti dal modello bootstrap, puoi personalizzarlo in base alle tue esigenze.

Puoi esportare il modello bootstrap, modificarlo e distribuirlo utilizzando. AWS CloudFormation Di seguito è riportato un esempio di esportazione del modello esistente:

$ cdk bootstrap --show-template > bootstrap-template.yaml

Puoi anche dire alla CLI del CDK di usare un modello personalizzato. Di seguito è riportato un esempio:

$ cdk bootstrap --template my-bootstrap-template.yaml

Bootstrap con un limite di autorizzazioni. Quindi, rimuovi quel limite di autorizzazioni

Per eseguire il bootstrap con un limite di autorizzazioni personalizzato, eseguiamo quanto segue:

$ cdk bootstrap --custom-permissions-boundary my-permissions-boundary

Per rimuovere il limite delle autorizzazioni, eseguiamo quanto segue:

$ cdk bootstrap --no-previous-parameters

Utilizza un qualificatore per distinguere le risorse create per un ambiente di sviluppo

$ cdk bootstrap --qualifier dev2024