TypeScript Agent vers DynamoDB

Le générateur connection relie un TypeScript Agent à un projet TypeScript DynamoDB, en configurant le développement local pour que les deux démarrent ensemble automatiquement.

Prérequis

Avant d’utiliser ce générateur, assurez-vous d’avoir :

1. Un projet ts#agent
2. Un projet ts#dynamodb

Utilisation

Exécuter le générateur

Exécuter ce générateur@aws/nx-plugin:connection

CLI

pnpm

$ pnpm nx g @aws/nx-plugin:connection

yarn

$ yarn nx g @aws/nx-plugin:connection

npm

$ npx nx g @aws/nx-plugin:connection

bun

$ bunx nx g @aws/nx-plugin:connection

VSCode

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

Composez votre commande5

sourceProjectRequis

targetProjectRequis

sourceComponent

targetComponent

preferInstallDependencies

true

--dry-runVous pouvez également effectuer une simulation pour voir quels fichiers seraient modifiés

Sélectionnez votre projet Agent comme source et votre projet DynamoDB comme cible. Si le projet contient plusieurs composants agent, spécifiez sourceComponent pour lever l’ambiguïté.

Options

Options du générateur5 options

sourceProjectRequisstring

Le projet source

targetProjectRequisstring

Le projet cible auquel se connecter

sourceComponentstring

Le composant source depuis lequel se connecter (nom du composant, chemin relatif à la racine du projet source, ou identifiant de générateur). Utilisez '.' pour sélectionner explicitement le projet comme source.

targetComponentstring

Le composant cible auquel se connecter (nom du composant, chemin relatif à la racine du projet cible, ou identifiant de générateur). Utilisez '.' pour sélectionner explicitement le projet comme cible.

preferInstallDependenciesbooleanPar défaut: true

Indique s'il faut privilégier l'installation des dépendances après l'exécution du générateur. Définir à false pour différer l'installation lors de l'exécution de plusieurs générateurs en lot (une installation s'exécute quand même si nécessaire pour que les générateurs suivants puissent calculer le graphe de projet Nx) ; installer une seule fois à la fin.

Sortie du générateur

Le générateur met à jour la cible <agent-name>-dev de l’agent dans project.json pour dépendre de la cible dev du projet DynamoDB. Aucun fichier source n’est modifié.

Utiliser DynamoDB dans les Agents

Importez les factories d’entités depuis le package DynamoDB et utilisez-les dans votre définition d’agent :

packages/my-service/src/my-agent/agent.ts

import { createExampleEntity } from '@my-scope/my-table';
import { z } from 'zod';

const listExamples = tool({
  name: 'list_examples',
  description: 'List all example items',
  inputSchema: z.object({}),
  callback: async () => {
    const entity = await createExampleEntity();
    const result = await entity.scan.go();
    return result.data;
  },
});

export const getAgent = async () => {
  // ...
  return new Agent({
    tools: [listExamples],
  });
};

Infrastructure

Pour permettre à la fonction Lambda de l’agent d’accéder à la table DynamoDB, accordez les permissions nécessaires dans votre infrastructure.

CDK

packages/infra/src/stacks/application-stack.ts

import { MyTable } from '@my-scope/common-constructs';

const table = new MyTable(this, 'Table');
const myAgent = new MyAgent(this, 'MyAgent');

table.grantReadWriteData(myAgent);

grantReadWriteData accorde à la fois les permissions DynamoDB et KMS au rôle d’exécution de l’agent.

Terraform

Accordez au rôle d’exécution de l’agent l’accès à la table et à sa clé de chiffrement KMS via additional_iam_policy_statements :

packages/infra/src/main.tf

module "my_table" {
  source = "../../common/terraform/src/app/dynamodb/my-table"
}

module "my_agent" {
  source = "../../common/terraform/src/app/agents/my-agent"

  additional_iam_policy_statements = [
    {
      Effect = "Allow"
      Action = [
        "dynamodb:GetItem", "dynamodb:PutItem", "dynamodb:UpdateItem",
        "dynamodb:DeleteItem", "dynamodb:Query", "dynamodb:Scan",
        "dynamodb:BatchGetItem", "dynamodb:BatchWriteItem",
      ]
      Resource = [
        module.my_table.table_arn,
        "${module.my_table.table_arn}/index/*",
      ]
    },
    {
      Effect = "Allow"
      Action = [
        "kms:Encrypt",
        "kms:Decrypt",
        "kms:ReEncrypt*",
        "kms:GenerateDataKey*",
        "kms:DescribeKey",
      ]
      Resource = [module.my_table.kms_key_arn]
    },
  ]
}

Développement local

Le générateur connection configure la cible dev de votre projet pour dépendre de la cible dev du projet DynamoDB. DynamoDB Local démarrera automatiquement en même temps que votre projet lors de l’exécution de dev.

La variable d’environnement LOCAL_DEV=true est définie automatiquement, de sorte que getDynamoDBClient() et resolveTableName() se connectent à l’instance locale DynamoDB Local au lieu d’AWS.