cdk flags - AWS Kit de développement Cloud (AWS CDK) v2

Ceci est le guide du développeur du 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.

cdk flags

Affichez et modifiez les configurations de vos indicateurs de fonctionnalité pour la CLI CDK.

Les indicateurs de fonctionnalité contrôlent le comportement de la CLI CDK et vous pouvez les utiliser pour activer ou désactiver des fonctionnalités spécifiques. Utilisez la cdk flags commande pour afficher les configurations actuelles de vos indicateurs de fonctionnalité et modifiez-les selon vos besoins.

Avertissement

La cdk flags commande est en cours de développement pour le AWS CDK. Les fonctionnalités actuelles de cette commande sont considérées comme prêtes pour la production et peuvent être utilisées en toute sécurité. Cependant, la portée de cette commande et ses fonctionnalités sont susceptibles d'être modifiées. Par conséquent, vous devez vous inscrire en fournissant l'unstable=flagsoption d'utiliser cette commande.

Utilisation

$ cdk flags <arguments> <options>

Arguments

NOM DU DRAPEAU

Le nom de l'indicateur de fonctionnalité spécifique que vous souhaitez afficher ou modifier.

Type : chaîne

Obligatoire : non

Options

Pour une liste des options globales qui fonctionnent avec toutes les commandes de la CLI CDK, consultez la section Options globales.

--set <BOOLEAN>

Modifiez la configuration d'un indicateur de fonctionnalité.

--all <BOOLEAN>

Modifiez ou affichez tous les indicateurs de fonctionnalités.

--recommended <BOOLEAN>

Remplacez les drapeaux par les états recommandés.

--default <BOOLEAN>

Remplacez les drapeaux par défaut.

--unconfigured <BOOLEAN>

Modifiez les indicateurs de fonctionnalités non configurés.

--value <STRING>

La valeur à laquelle définir la configuration de l'indicateur de fonctionnalité.

requireArg : vrai

--safe <BOOLEAN>

Activez tous les indicateurs de fonctionnalités qui n'ont aucun impact sur votre application.

--interactive, -i <BOOLEAN>

Option interactive pour la commande flags.

Exemples

Afficher les configurations des indicateurs de fonctionnalités

Exécutez cdk flags pour afficher un rapport sur les configurations de vos indicateurs de fonctionnalités qui diffèrent des états recommandés. Les drapeaux non configurés sont étiquetés avec une <unset> étiquette indiquant qu'ils n'ont actuellement aucune valeur. Les drapeaux sont affichés dans l'ordre suivant :

  • Drapeaux définis sur une valeur qui ne correspond pas à notre valeur recommandée

  • Drapeaux que vous n'avez pas configurés

$ cdk flags --unstable=flags Feature Flag Recommended User * @aws-cdk/... true false * @aws-cdk/... true false * @aws-cdk/... true <unset>

Vous pouvez également exécuter cdk flags --all pour voir un rapport de tous les indicateurs de fonctionnalités dans l'ordre suivant :

  • Drapeaux définis sur une valeur correspondant à notre valeur recommandée

  • Drapeaux définis sur une valeur qui ne correspond pas à notre valeur recommandée

  • Drapeaux que vous n'avez pas configurés

$ cdk flags --unstable=flags --all Feature Flag Recommended User @aws-cdk/... true true * @aws-cdk/... true false * @aws-cdk/... true false * @aws-cdk/... true <unset>

Modifier les valeurs des indicateurs de fonction

Pour modifier vos indicateurs de fonctionnalités de manière interactive, exécutez cdk flags --interactive (oucdk flags -i) pour afficher une liste d'options de menu.

Pour remplacer chaque indicateur de fonctionnalité par notre valeur recommandée, exécutezcdk flags --set --recommended --all. Cette commande conserve la configuration de votre indicateur de fonctionnalité up-to-date avec les dernières configurations d'indicateur de fonctionnalité du CDK. Sachez que l'exécution de cette commande peut potentiellement remplacer les valeurs configurées existantes.

$ cdk flags --unstable=flags --set --recommended --all Feature Flag Recommended Value User Value * @aws-cdk/... true false * @aws-cdk/... true false * @aws-cdk/... true <unset> Synthesizing... Resources [~] AWS::S3::Bucket MyBucket └─ [~] Properties └─ [~] Encryption ... Number of stacks with differences: 2 Do you want to accept these changes? (y/n) y Resynthesizing...

Si vous souhaitez conserver l'état de vos drapeaux configurés existants, exécutezcdk flags --set --recommended --unconfigured. Cette option remplace uniquement les indicateurs de fonctionnalité non configurés par nos valeurs recommandées.

$ cdk flags --unstable=flags --set --recommended --unconfigured Feature Flag Recommended Value User Value * @aws-cdk/... true <unset> * @aws-cdk/... true <unset> Synthesizing... Resources [~] AWS::S3::Bucket MyBucket └─ [~] Properties └─ [~] Encryption ├─ [-] None └─ [+] ServerSideEncryptionConfiguration: - ... ... Number of stacks with differences: 2 Do you want to accept these changes? (y/n) y Resynthesizing...

Pour vous assurer qu'aucun indicateur de fonctionnalité non configuré n'interfère avec votre application, exécutez la cdk flags --set --default --unconfigured commande pour rétablir les valeurs par défaut des indicateurs non configurés. Par exemple, s'il @aws-cdk/aws-cloudfront:defaultSecurityPolicyTLSv1.2_2021 n'est pas configuré, une notification s'affiche après l'exécutioncdk synth. Toutefois, si vous réglez l'indicateur sur son état par défaut (faux), il sera configuré, désactivé et n'aura aucun impact sur votre application.

$ cdk flags --unstable=flags --set --default --unconfigured Feature Flag Recommended Value User Value * @aws-cdk/... true <unset> * @aws-cdk/... true <unset> Synthesizing... Do you want to accept these changes? (y/n) y Resynthesizing...

Inspectez les indicateurs de fonctionnalités spécifiques

Afficher plus d'informations sur un drapeau

En plus d'exécuter cdk flags et de cdk flags --all visualiser la configuration de votre indicateur de fonctionnalité, vous pouvez également l'utiliser cdk flags "FLAGNAME" pour inspecter un indicateur de fonctionnalité spécifique et découvrir à quoi sert cet indicateur. Cela peut être utile dans les cas où vous souhaitez comprendre un indicateur en particulier et son impact sur votre application.

$ cdk flags --unstable=flags "@aws-cdk/aws-cloudfront:defaultSecurityPolicyTLSv1.2_2021" Description: Enable this feature flag to have cloudfront distributions use the security policy TLSv1.2_2021 by default. Recommended Value: true User Value: true

Filtrer les drapeaux par sous-chaîne

Vous pouvez également courir cdk flags substring pour voir tous les indicateurs de fonctionnalités correspondants. Si un seul indicateur de fonctionnalité correspond à cette sous-chaîne, des détails spécifiques sont affichés.

$ cdk flags --unstable=flags ebs @aws-cdk/aws-ec2:ebsDefaultGp3Volume Description: When enabled, the default volume type of the EBS volume will be GP3 Recommended Value: true User Value: true

Si plusieurs indicateurs correspondent à la sous-chaîne, tous les indicateurs correspondants sont affichés dans un tableau. Si vous entrez plusieurs sous-chaînes, tous les indicateurs correspondants contenant l'une des sous-chaînes sont renvoyés.

$ cdk flags --unstable=flags s3 lambda Feature Flag Recommended User * @aws-cdk/s3... true false * @aws-cdk/lambda... true false * @aws-cdk/lambda... true <unset>

Modifier un drapeau spécifique

Si vous devez modifier la valeur d'un indicateur et vous assurer que vous le définissez sur un état correct et compatible, exécutezcdk flags --set "FLAGNAME" --value="state".

$ cdk flags --unstable=flags --set "@aws-cdk/aws-cloudfront:defaultSecurityPolicyTLSv1.2_2021" --value="true" Synthesizing... Resources [~] AWS::CloudFront::Distribution MyDistribution └─ [~] Properties └─ [~] DefaultSecurityPolicy ├─ [-] TLSv1.0 └─ [+] TLSv1.2_2021 - ... Number of stacks with differences: 2 Do you want to accept these changes? (y/n) y Resynthesizing...