Ceci est le guide du AWS CDK développeur de la version 2. L'ancienne CDK version 1 est entrée en maintenance le 1er juin 2022 et a pris fin le 1er juin 2023.
Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
cdk bootstrap
Préparez un AWS environnement pour les CDK déploiements en déployant la pile CDK bootstrap, nomméeCDKToolkit
, dans l' AWS environnement.
La pile bootstrap est une CloudFormation pile qui approvisionne un compartiment Amazon S3 et un ECR référentiel Amazon dans l' AWS environnement. Le AWS CDK CLI utilise ces ressources pour stocker les modèles synthétisés et les ressources associées lors du déploiement.
Utilisation
$
cdk bootstrap
<arguments>
<options>
Arguments
- AWS environnement
-
L' AWS environnement cible dans lequel déployer la pile bootstrap au format suivant :
aws://<account-id>/<region>
.Exemple :
aws://123456789012/us-east-1
Cet argument peut être fourni plusieurs fois dans une seule commande pour déployer la pile bootstrap dans plusieurs environnements.
Par défaut, le CDK CLI amorcera tous les environnements référencés dans l'CDKapplication ou déterminera un environnement à partir de sources par défaut. Il peut s'agir d'un environnement spécifié à l'aide de l'
--profile
option, à partir de variables d'environnement ou de AWS CLI sources par défaut.
Options
Pour obtenir une liste des options globales qui fonctionnent avec tous CDK CLI commandes, voirOptions globales.
--bootstrap-bucket-name, --toolkit-bucket-name, -b
STRING
-
Le nom du compartiment Amazon S3 qui sera utilisé par CDK CLI. Ce bucket va être créé et ne doit pas exister actuellement.
Fournissez cette option pour remplacer le nom par défaut du compartiment Amazon S3.
Lorsque vous utilisez cette option, vous devrez peut-être personnaliser la synthèse. Pour en savoir plus, consultez Personnalisez la synthèse des CDK piles.
Valeur par défaut : Non défini
--bootstrap-customer-key
BOOLEAN
-
Créez une clé principale client (CMK) pour le bucket bootstrap (vous serez facturé mais vous pouvez personnaliser les autorisations, uniquement pour le bootstrap moderne).
Cette option n'est pas compatible avec
--bootstrap-kms-key-id
.Valeur par défaut : Non défini
--bootstrap-kms-key-id
STRING
-
L'ID de clé AWS KMS principale à utiliser pour SSE-KMS chiffrement.
Fournissez cette option pour remplacer la AWS KMS clé par défaut utilisée pour chiffrer le compartiment Amazon S3.
Cette option n'est pas compatible avec
--bootstrap-customer-key
.Valeur par défaut : Non défini
--cloudformation-execution-policies
ARRAY
-
La IAM politique gérée ARNs qui doit être attachée au rôle de déploiement assumé AWS CloudFormation lors du déploiement de vos piles.
Par défaut, les piles sont déployées avec des autorisations d'administrateur complètes à l'aide de cette
AdministratorAccess
politique.Vous pouvez fournir cette option plusieurs fois dans une seule commande. Vous pouvez également fournir plusieurs ARNs sous forme de chaîne unique, les individus étant ARNs séparés par des virgules. Voici un exemple :
$
cdk bootstrap --cloudformation-execution-policies
"arn:aws:iam::aws:policy/AWSLambda_FullAccess,arn:aws:iam::aws:policy/AWSCodeDeployFullAccess"
Pour éviter les échecs de déploiement, assurez-vous que les politiques que vous spécifiez sont suffisantes pour tous les déploiements que vous allez effectuer dans l'environnement en cours de démarrage.
Cette option s'applique uniquement au bootstrap moderne.
Important
Le modèle bootstrap moderne accorde efficacement les autorisations implicites
--cloudformation-execution-policies
à n'importe quel AWS compte de la--trust
liste. Par défaut, cela étend les autorisations de lecture et d'écriture à n'importe quelle ressource du compte bootstrap. Assurez-vous de configurer la pile d'amorçage avec des politiques et des comptes fiables avec lesquels vous êtes à l'aise.Valeur par défaut :
[]
--custom-permissions-boundary, -cpb
STRING
-
Spécifiez le nom d'une limite d'autorisation à utiliser.
Cette option n'est pas compatible avec
--example-permissions-boundary
.Valeur par défaut : Non défini
--example-permissions-boundary, -epb
BOOLEAN
-
Utilisez l'exemple de limite d'autorisations, fourni par le AWS CDK.
Cette option n'est pas compatible avec
--custom-permissions-boundary
.La politique de délimitation des autorisations CDK fournie doit être considérée comme un exemple. Modifiez le contenu et faites référence à l'exemple de politique si vous testez la fonctionnalité. Convertissez-la en une nouvelle politique pour les déploiements réels, s'il n'en existe pas déjà une. Le souci est d'éviter la dérive. Très probablement, une limite d'autorisations est maintenue et comporte des conventions spécifiques, y compris la dénomination.
Pour plus d'informations sur la configuration des autorisations, notamment sur l'utilisation des limites d'autorisations, consultez le Guide de développement de la sécurité et
de la sûreté. Valeur par défaut : Non défini
--execute
BOOLEAN
-
Configurez s'il faut exécuter l'ensemble de modifications.
Valeur par défaut :
true
--force, -f
BOOLEAN
-
Démarrez toujours, même si cela rétrograde la version du modèle de bootstrap.
Valeur par défaut :
false
--help, -h
BOOLEAN
-
Afficher les informations de référence de commande pour la
cdk bootstrap
commande. --previous-parameters
BOOLEAN
-
Utilisez les valeurs précédentes pour les paramètres existants.
Une fois qu'un modèle de bootstrap est déployé avec un ensemble de paramètres, vous devez définir cette option
false
pour modifier les paramètres lors de futurs déploiements. Quandfalse
, vous devez réapprovisionner tous les paramètres précédemment fournis.Valeur par défaut :
true
--public-access-block-configuration
BOOLEAN
-
Bloquer la configuration de l'accès public sur le compartiment Amazon S3 créé et utilisé par CDK CLI.
Valeur par défaut :
true
--qualifier
STRING
-
Valeur de chaîne à neuf chiffres unique pour chaque pile bootstrap. Cette valeur est ajoutée à l'identifiant physique des ressources de la pile bootstrap.
En fournissant un qualificatif, vous évitez les conflits de noms de ressources lors du provisionnement de plusieurs piles de bootstrap dans le même environnement.
Lorsque vous modifiez le qualificatif, votre CDK application doit transmettre la valeur modifiée au synthétiseur de pile. Pour de plus amples informations, veuillez consulter Personnalisez la synthèse des CDK piles.
Valeur par défaut :
hnb659fds
. Cette valeur n'a aucune signification. --show-template
BOOLEAN
-
Au lieu d'amorcer, imprimez le modèle de bootstrap actuel sur la sortie standard ().
stdout
Vous pouvez ensuite copier et personnaliser le modèle selon vos besoins.Valeur par défaut :
false
-
Tags à ajouter à la pile bootstrap au format de
KEY=VALUE
.Valeur par défaut :
[]
--template
STRING
-
Utilisez le modèle du fichier donné au lieu du modèle intégré.
--termination-protection
BOOLEAN
-
Activez AWS CloudFormation la protection de terminaison sur la pile bootstrap.
Quand
true
, la protection contre les résiliations est activée. Cela empêche la suppression accidentelle de la pile bootstrap.Pour en savoir plus sur la protection contre le licenciement, consultez la section Protection d'une pile contre la suppression dans le Guide de AWS CloudFormation l'utilisateur.
Valeur par défaut : Non défini
--toolkit-stack-name
STRING
-
Nom de la pile bootstrap à créer.
Par défaut,
cdk bootstrap
déploie une pile nomméeCDKToolkit
dans l' AWS environnement spécifié. Utilisez cette option pour attribuer un nom différent à votre stack bootstrap.Le CDK CLI utilise cette valeur pour vérifier la version de votre stack bootstrap.
Valeur par défaut :
CDKToolkit
Obligatoire : oui
--trust
ARRAY
-
Celui Compte AWS IDs qui doit être fiable pour effectuer des déploiements dans cet environnement.
Le compte effectuant le bootstrap sera toujours fiable.
Cette option nécessite que vous fournissiez également
--cloudformation-execution-policies
.Vous pouvez fournir cette option plusieurs fois dans une seule commande.
Cette option s'applique uniquement au bootstrap moderne.
Pour ajouter des comptes fiables à une pile bootstrap existante, vous devez spécifier tous les comptes auxquels faire confiance, y compris ceux que vous avez fournis précédemment. Si vous ne fournissez que de nouveaux comptes auxquels faire confiance, les comptes précédemment approuvés seront supprimés.
Voici un exemple qui fait confiance à deux comptes :
$
cdk bootstrap
⏳ 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.aws://123456789012/us-west-2
--trust234567890123
--trust987654321098
--cloudformation-execution-policiesarn:aws:iam::aws:policy/AdministratorAccess
Important
Le modèle bootstrap moderne accorde efficacement les autorisations implicites
--cloudformation-execution-policies
à n'importe quel AWS compte de la--trust
liste. Par défaut, cela étend les autorisations de lecture et d'écriture à n'importe quelle ressource du compte bootstrap. Assurez-vous de configurer la pile d'amorçage avec des politiques et des comptes fiables avec lesquels vous êtes à l'aise.Valeur par défaut :
[]
--trust-for-lookup
ARRAY
-
Il faut faire confiance à Compte AWS IDs qui il faut faire confiance pour rechercher des valeurs dans cet environnement.
Utilisez cette option pour autoriser les comptes à synthétiser les piles qui seront déployées dans l'environnement, sans pour autant leur donner l'autorisation de déployer ces piles directement.
Vous pouvez fournir cette option plusieurs fois dans une seule commande.
Cette option s'applique uniquement au bootstrap moderne.
Valeur par défaut :
[]
Exemples
Bootstrap l' AWS environnement spécifié dans le profil de production
$
cdk bootstrap --profile prod
Déployez la pile bootstrap dans les environnements foo et bar
$
cdk bootstrap --app='node bin/main.js' foo bar
Exportez le modèle bootstrap pour le personnaliser
Si vous avez des exigences spécifiques qui ne sont pas satisfaites par le modèle bootstrap, vous pouvez le personnaliser en fonction de vos besoins.
Vous pouvez exporter le modèle bootstrap, le modifier et le déployer à l'aide AWS CloudFormation de. Voici un exemple d'exportation du modèle existant :
$
cdk bootstrap --show-template > bootstrap-template.yaml
Vous pouvez également indiquer CDK CLI pour utiliser un modèle personnalisé. Voici un exemple :
$
cdk bootstrap --template my-bootstrap-template.yaml
Bootstrap avec une limite d'autorisations. Supprimez ensuite cette limite d'autorisations
Pour démarrer avec une limite d'autorisation personnalisée, nous exécutons ce qui suit :
$
cdk bootstrap --custom-permissions-boundary my-permissions-boundary
Pour supprimer la limite des autorisations, nous exécutons ce qui suit :
$
cdk bootstrap --no-previous-parameters
Utilisez un qualificatif pour distinguer les ressources créées pour un environnement de développement
$
cdk bootstrap --qualifier dev2024