Infrastructure CDK

AWS CDK est un framework permettant de définir une infrastructure cloud via du code et de la déployer via AWS CloudFormation.

Le générateur d’infrastructure TypeScript crée une application d’infrastructure AWS CDK écrite en TypeScript. L’application générée intègre des bonnes pratiques de sécurité via des vérifications CFN Guard.

Utilisation

Générer un projet d’infrastructure

Vous pouvez générer un nouveau projet d’infrastructure de deux manières :

VSCode
CLI

Installez le Nx Console VSCode Plugin si ce n'est pas déjà fait
Ouvrez la console Nx dans VSCode
Cliquez sur Generate (UI) dans la section "Common Nx Commands"
Recherchez @aws/nx-plugin - ts#infra
Remplissez les paramètres requis
Cliquez sur Generate

pnpm nx g @aws/nx-plugin:ts#infra

yarn nx g @aws/nx-plugin:ts#infra

npx nx g @aws/nx-plugin:ts#infra

bunx nx g @aws/nx-plugin:ts#infra

Vous pouvez également effectuer une simulation pour voir quels fichiers seraient modifiés

pnpm nx g @aws/nx-plugin:ts#infra --dry-run

yarn nx g @aws/nx-plugin:ts#infra --dry-run

npx nx g @aws/nx-plugin:ts#infra --dry-run

bunx nx g @aws/nx-plugin:ts#infra --dry-run

Options

Paramètre	Type	Par défaut	Description
name Requis	string	-	The name of the application.
ruleSet	string	aws_prototyping	Rule set to validate your AWS resources with.
directory	string	packages	The directory of the new application.

Résultat du générateur

Le générateur créera la structure de projet suivante dans le répertoire <directory>/<name> :

Répertoiresrc
- main.ts Point d’entrée de l’application instanciant les stacks CDK à déployer
- Répertoirestacks Définitions des stacks CDK
  - application-stack.ts Stack applicative principale
cdk.json Configuration CDK
project.json Configuration du projet et cibles de build

Implémentation de votre infrastructure CDK

Vous pouvez commencer à écrire votre infrastructure CDK dans src/stacks/application-stack.ts, par exemple :

import * as cdk from 'aws-cdk-lib';
import { Bucket } from 'aws-cdk-lib/aws-s3'
import { Construct } from 'constructs';

export class ApplicationStack extends cdk.Stack {
  constructor(scope: Construct, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    // Déclarez votre infrastructure ici
    new Bucket(this, 'MyBucket');
  }
}

Infrastructure d’API

Si vous avez utilisé les générateurs tRPC API ou FastAPI pour créer des APIs, vous remarquerez que des constructs sont déjà disponibles dans packages/common/constructs pour les déployer.

Par exemple, si vous avez créé une API tRPC appelée my-api, vous pouvez simplement importer et instancier le construct pour ajouter toute l’infrastructure nécessaire :

import * as cdk from 'aws-cdk-lib';
import { Construct } from 'constructs';
import { MyApi } from ':my-scope/common-constructs';

export class ApplicationStack extends cdk.Stack {
  constructor(scope: Construct, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    // Ajoutez l'infrastructure pour votre API
    new MyApi(this, 'MyApi');
  }
}

Infrastructure de site web

Si vous avez utilisé le générateur site web CloudScape, un construct est disponible dans packages/common/constructs pour le déployer. Par exemple :

import * as cdk from 'aws-cdk-lib';
import { Construct } from 'constructs';
import { MyWebsite } from ':my-scope/common-constructs';

export class ApplicationStack extends cdk.Stack {
  constructor(scope: Construct, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    // Ajoutez l'infrastructure pour votre site web
    new MyWebsite(this, 'MyWebsite');
  }
}

Il est important de déclarer le site web après tout construct d’API afin que la configuration runtime du site inclue tous les paramètres des APIs.

Synthèse de votre infrastructure

Dans le cadre de votre cible build, en plus des tâches de compilation, lint et test par défaut, votre projet d’infrastructure est synthétisé en CloudFormation. Ceci peut aussi être exécuté séparément via la cible synth :

pnpm nx run <my-infra>:synth

yarn nx run <my-infra>:synth

npx nx run <my-infra>:synth

bunx nx run <my-infra>:synth

Vous trouverez votre assembly cloud synthétisée dans le dossier dist racine, sous dist/packages/<my-infra-project>/cdk.out.

Bootstrap de votre/vos compte(s) AWS

Si vous déployez une application CDK sur un compte AWS pour la première fois, celui-ci doit d’abord être bootstrappé.

Assurez-vous d’avoir configuré les credentials pour votre compte AWS.
Utilisez la commande cdk bootstrap :

npx cdk bootstrap aws://<account-id>/<region>

Pour plus de détails, consultez la documentation CDK.

Déploiement sur AWS

Après un build, vous pouvez déployer votre infrastructure sur AWS via la cible deploy.

Assurez-vous d’avoir configuré les credentials pour votre compte AWS.
Exécutez la cible de déploiement :

pnpm nx run <my-infra>:deploy --all

yarn nx run <my-infra>:deploy --all

npx nx run <my-infra>:deploy --all

bunx nx run <my-infra>:deploy --all

La commande ci-dessus déploie toutes les stacks définies dans main.ts. Vous pouvez cibler une stack spécifique, notamment si vous avez configuré plusieurs environnements :

pnpm nx run <my-infra>:deploy my-sandbox-stack

yarn nx run <my-infra>:deploy my-sandbox-stack

npx nx run <my-infra>:deploy my-sandbox-stack

bunx nx run <my-infra>:deploy my-sandbox-stack

Déploiement sur AWS en pipeline CI/CD

Utilisez la cible deploy-ci pour déployer sur AWS dans un pipeline CI/CD :

pnpm nx run <my-infra>:deploy-ci my-stack

yarn nx run <my-infra>:deploy-ci my-stack

npx nx run <my-infra>:deploy-ci my-stack

bunx nx run <my-infra>:deploy-ci my-stack

Cette cible diffère légèrement de deploy en ce qu’elle déploie une assembly cloud pré-synthétisée plutôt que de synthétiser à la volée. Cela évite les problèmes de non-déterminisme liés aux versions de packages, garantissant que chaque étape du pipeline déploie la même assembly cloud.

Informations complémentaires

Pour en savoir plus sur CDK, consultez le Guide développeur CDK et la Référence d’API.