Il s'agit du guide du développeur AWS CDK v2. L'ancien CDK v1 est entré 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.
bootstrap cdk
Préparez un AWS environnement pour les déploiements CDK en déployant la pile d'amorçage CDK, nomméeCDKToolkit, dans l'environnement. AWS
La pile bootstrap est une CloudFormation pile qui fournit un compartiment Amazon S3 et un référentiel Amazon ECR dans l' AWS environnement. La CLI AWS CDK utilise ces ressources pour stocker des modèles synthétisés et des actifs associés pendant le déploiement.
Usage
$ 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-1Cet argument peut être fourni plusieurs fois dans une seule commande pour déployer la pile d'amorçage dans plusieurs environnements.
Par défaut, la CLI CDK amorce tous les environnements référencés dans l'application CDK ou détermine un environnement à partir des sources par défaut. Il peut s'agir d'un environnement spécifié à l'aide de l'
--profileoption, à partir de variables d'environnement ou de sources AWS CLI par défaut.
Options
Pour obtenir la liste des options globales qui fonctionnent avec toutes les commandes de l'interface de ligne de commande CDK, consultez la section Options Options globales globales.
-
--bootstrap-bucket-name, --toolkit-bucket-name, -b <STRING> -
Nom du compartiment Amazon S3 qui sera utilisé par la CLI CDK. Ce compartiment sera 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, il se peut que vous deviez personnaliser la synthèse. Pour en savoir plus, voir Personnaliser la synthèse de la pile CDK.
Valeur par défaut : Non définie
-
--bootstrap-customer-key <BOOLEAN> -
Créez une clé principale client (CMK) pour le compartiment d'amorçage (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éfinie
-
--bootstrap-kms-key-id <STRING> -
ID de clé principale AWS KMS à utiliser pour le
SSE-KMSchiffrement.Fournissez cette option pour remplacer la clé AWS KMS 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éfinie
-
--express <BOOLEAN> -
Bootstrap en utilisant le mode CloudFormation express. Le mode Express permet des déploiements plus rapides CloudFormation en signalant les opérations de pile comme étant terminées dès que la configuration des ressources est CloudFormation appliquée. Toutefois, CloudFormation rapporte des succès sans attendre que les ressources se stabilisent. De plus, le mode express n'effectue pas de restauration automatiquement et laissera les piles en état d'échec en cas de problème.
Pour plus d'informations, consultez le mode express dans le Guide de AWS CloudFormation l'utilisateur.
Valeur par défaut :
false
-
--cloudformation-execution-policies <ARRAY> -
La politique IAM gérée ARN qui doit être associé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 conformément à la
AdministratorAccesspolitique.Vous pouvez fournir cette option plusieurs fois dans une seule commande. Vous pouvez également fournir plusieurs ARN sous la forme d'une seule chaîne, les ARN individuels étant 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 effectuerez 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 par le
--cloudformation-execution-policiesà n'importe quel AWS compte de la--trustliste. Par défaut, cela étend les autorisations de lecture et d'écriture sur n'importe quelle ressource du compte bootstrapped. 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 de la limite d'autorisations à utiliser.
Cette option n'est pas compatible avec
--example-permissions-boundary.Valeur par défaut : Non définie
-
--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 limitation des autorisations fournie par le CDK 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 les dérives. Très probablement, une limite d'autorisations est maintenue et comporte des conventions dédiées, y compris la dénomination.
Pour plus d'informations sur la configuration des autorisations, y compris l'utilisation des limites des autorisations, consultez le Guide de développement de la sécurité et de la sûreté
. Valeur par défaut : Non définie
-
--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 revient à rétrograder la version du modèle de bootstrap.
Valeur par défaut :
false
-
--help, -h <BOOLEAN> -
Afficher les informations de référence relatives à la
cdk bootstrapcommande.
-
--previous-parameters <BOOLEAN> -
Utilisez les valeurs précédentes pour les paramètres existants.
Une fois qu'un modèle d'amorçage est déployé avec un ensemble de paramètres, vous devez définir cette option
falsepour modifier tous les paramètres lors des déploiements futurs. Quandfalse, vous devez réapprovisionner tous les paramètres précédemment fournis.Valeur par défaut :
true
-
--public-access-block-configuration <BOOLEAN> -
Bloquez la configuration d'accès public sur le compartiment Amazon S3 créé et utilisé par la CLI CDK.
Valeur par défaut :
true
-
--qualifier <STRING> -
Nine-digit valeur de chaîne unique pour chaque pile de bootstrap. Cette valeur est ajoutée à l'identifiant physique des ressources de la pile d'amorçage.
En fournissant un qualificatif, vous évitez les conflits de noms de ressources lors du provisionnement de plusieurs piles d'amorçage dans le même environnement.
Lorsque vous modifiez le qualificatif, votre application CDK doit transmettre la valeur modifiée au synthétiseur de pile. Pour plus d'informations, voir Personnaliser la synthèse de la pile CDK.
Valeur par défaut :
hnb659fds. Cette valeur n'a aucune signification.
-
--show-template <BOOLEAN> -
Au lieu d'effectuer un bootstrap, imprimez le modèle d'amorçage actuel sur la sortie standard ().
stdoutVous pouvez ensuite copier et personnaliser le modèle selon vos besoins.Valeur par défaut :
false
-
--tags, -t <ARRAY> -
Tags à ajouter à la pile bootstrap au format.
KEY=VALUEValeur par défaut :
[]
-
--template <STRING> -
Utilisez le modèle du fichier donné au lieu du modèle intégré.
-
--termination-protection <BOOLEAN> -
Activez la protection contre les AWS CloudFormation terminaisons sur la pile Bootstrap.
Quand
truela protection contre les interruptions de service est activée. Cela empêche la suppression accidentelle de la pile bootstrap.Pour en savoir plus sur la protection contre la résiliation, consultez la section Protection d'une pile contre la suppression dans le Guide de AWS CloudFormation l'utilisateur.
Valeur par défaut : Non définie
-
--toolkit-stack-name <STRING> -
Le nom de la pile bootstrap à créer.
Par défaut,
cdk bootstrapdéploie une pile nomméeCDKToolkitdans l' AWS environnement spécifié. Utilisez cette option pour donner un nom différent à votre pile Bootstrap.La CLI CDK utilise cette valeur pour vérifier la version de votre pile d'amorçage.
Valeur par défaut :
CDKToolkitObligatoire : oui
-
--trust <ARRAY> -
Les identifiants de AWS compte auxquels il convient de faire confiance pour effectuer des déploiements dans cet environnement.
Le compte effectuant le bootstrapping 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 sécurisés à une pile bootstrap existante, vous devez spécifier tous les comptes à approuver, y compris ceux que vous avez peut-être précédemment fournis. Si vous ne fournissez que de nouveaux comptes fiables, les comptes précédemment approuvés seront supprimés.
Voici un exemple qui fait confiance à deux comptes :
$ 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.Important
Le modèle bootstrap moderne accorde efficacement les autorisations implicites par le
--cloudformation-execution-policiesà n'importe quel AWS compte de la--trustliste. Par défaut, cela étend les autorisations de lecture et d'écriture sur n'importe quelle ressource du compte bootstrapped. 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> -
Les identifiants de AWS compte auxquels il convient de se fier 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 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 le AWS environnement spécifié dans le profil du produit
$ 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 demander à la CLI CDK d'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'autorisations 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 les opérations suivantes :
$ cdk bootstrap --no-previous-parameters
Utilisez un qualificatif pour distinguer les ressources créées pour un environnement de développement
$ cdk bootstrap --qualifier dev2024