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.

Configurer des constructions avec des plans CDK

Utilisez les plans AWS CDK pour standardiser et distribuer les configurations de construction L2 au sein de votre organisation. Avec Blueprints, vous pouvez vous assurer que les AWS ressources sont configurées de manière cohérente conformément aux normes et aux meilleures pratiques de votre organisation. Par exemple, vous pouvez activer automatiquement le chiffrement pour tous les compartiments Amazon S3, appliquer des configurations de journalisation spécifiques à toutes les fonctions AWS Lambda ou appliquer des règles de sécurité standard pour tous les groupes de sécurité.

Les plans sont alimentés par injection de propriétés, un mécanisme introduit dans AWS CDK v2.196.0 qui vous permet de modifier les propriétés des constructions au moment de l'instanciation. Un Blueprint est un ensemble d'injecteurs de propriétés, où chaque injecteur de propriétés spécifie une configuration optimale pour une construction L2 spécifique. Le plan directeur représente l'ensemble des meilleures pratiques pour votre organisation.

Les plans ne sont pas un mécanisme d'application de la conformité. Les développeurs peuvent toujours remplacer les valeurs par défaut si nécessaire. Pour une application stricte de la conformité, pensez à utiliser AWS CloudFormation Guard, Service Control Policies ou CDK Aspects en plus des Blueprints.

Pour des informations détaillées sur la mise en œuvre, consultez la RFC sur l'injection de propriétés.

Principaux éléments des Blueprints

Les Blueprints sont des ensembles d'injecteurs de propriétés qui appliquent des propriétés par défaut aux constructions lors de leur instanciation. Un injecteur de propriétés est un composant qui implémente l'IPropertyInjectorinterface, qui intercepte la création de la construction et modifie ou ajoute des propriétés avant la création de la construction.

Cas d'utilisation courants des Blueprints

Vous pouvez utiliser les plans CDK pour standardiser de nombreux aspects de vos ressources AWS. Voici quelques cas d'utilisation courants :

Commencer à utiliser Blueprints

Voici un exemple simple de création et d'utilisation d'un injecteur de propriétés :

Créez d'abord un injecteur de propriétés pour les compartiments Amazon S3 :

import { IPropertyInjector, InjectionContext } from 'aws-cdk-lib';
import { Bucket, BucketProps, BlockPublicAccess } from 'aws-cdk-lib/aws-s3';

export class SecureBucketDefaults implements IPropertyInjector {
  public readonly constructUniqueId: string;

  constructor() {
    this.constructUniqueId = Bucket.PROPERTY_INJECTION_ID;
  }

  public inject(originalProps: BucketProps, _context: InjectionContext): BucketProps {
    return {
      // Set security defaults
      blockPublicAccess: BlockPublicAccess.BLOCK_ALL,
      enforceSSL: true,

      // Include original props to allow overrides
      ...originalProps,
    };
  }
}

Ensuite, utilisez l'injecteur dans votre application CDK :

import { App, Stack } from 'aws-cdk-lib';
import { Bucket } from 'aws-cdk-lib/aws-s3';
import { SecureBucketDefaults } from './secure-bucket-defaults';

// Attach injectors when creating the App
const app = new App({
  propertyInjectors: [new SecureBucketDefaults()]
});

const stack = new Stack(app, 'MyStack');

// This bucket automatically gets the default properties
const myBucket = new Bucket(stack, 'MyBucket');

Vous pouvez également utiliser la PropertyInjectors.of() méthode suivante :

import { App, Stack, PropertyInjectors } from 'aws-cdk-lib';
import { SecureBucketDefaults } from './secure-bucket-defaults';

const app = new App();
PropertyInjectors.of(app).add(new SecureBucketDefaults());

const stack = new Stack(app, 'MyStack');
const myBucket = new Bucket(stack, 'MyBucket');

Bonnes pratiques

Pour des informations plus détaillées sur l'injection de propriétés, notamment les détails de mise en œuvre, les conseils de dépannage et les informations de référence, consultez la RFC sur l'injection de propriétés.