Python Agent vers DynamoDB
Le générateur connection relie un Python Agent à un projet Python DynamoDB, en configurant le développement local pour que les deux démarrent ensemble automatiquement.
Prérequis
Section intitulée « Prérequis »Avant d’utiliser ce générateur, assurez-vous d’avoir :
- Un projet
py#agent - Un projet
py#dynamodb
Utilisation
Section intitulée « Utilisation »Exécuter le générateur
Section intitulée « Exécuter le générateur »- 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 - connection - Remplissez les paramètres requis
- Cliquez sur
Generate
pnpm nx g @aws/nx-plugin:connectionyarn nx g @aws/nx-plugin:connectionnpx nx g @aws/nx-plugin:connectionbunx nx g @aws/nx-plugin:connectionVous pouvez également effectuer une simulation pour voir quels fichiers seraient modifiés
pnpm nx g @aws/nx-plugin:connection --dry-runyarn nx g @aws/nx-plugin:connection --dry-runnpx nx g @aws/nx-plugin:connection --dry-runbunx nx g @aws/nx-plugin:connection --dry-runSé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é.
| Paramètre | Type | Par défaut | Description |
|---|---|---|---|
| sourceProject Requis | string | - | Le projet source |
| targetProject Requis | string | - | Le projet cible auquel se connecter |
| sourceComponent | string | - | Le composant source depuis lequel se connecter (nom du composant, chemin relatif à la racine du projet source, ou identifiant du générateur). Utilisez '.' pour sélectionner explicitement le projet comme source. |
| targetComponent | string | - | Le composant cible auquel se connecter (nom du composant, chemin relatif à la racine du projet cible, ou identifiant du générateur). Utilisez '.' pour sélectionner explicitement le projet comme cible. |
| preferInstallDependencies | boolean | 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
Section intitulée « 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, et ajoute le package DynamoDB comme dépendance de workspace. Aucun fichier source n’est modifié.
Utilisation de DynamoDB dans les Agents
Section intitulée « Utilisation de DynamoDB dans les Agents »Importez les classes d’entités depuis le package DynamoDB et utilisez-les dans vos outils d’agent :
from my_scope.my_table.entities.example import ExampleModelfrom strands import tool
@tooldef list_examples() -> list: """List all example items.""" return [item.attribute_values for item in ExampleModel.scan()]Infrastructure
Section intitulée « Infrastructure »Pour permettre à la fonction Lambda de l’agent d’accéder à la table DynamoDB, accordez les permissions nécessaires dans votre infrastructure.
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.
module "my_table" { source = "../../common/terraform/src/app/dynamodb/my-table"}
resource "aws_iam_role_policy" "dynamodb_access" { role = module.my_agent.lambda_role_name
policy = jsonencode({ Version = "2012-10-17" Statement = [ { 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
Section intitulée « 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, donc is_local() retourne True et vos entités PynamoDB se connectent à l’instance DynamoDB locale au lieu d’AWS.