View a markdown version of this page

start-lambda sam local - AWS Serverless Application Model

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.

start-lambda sam local

Cette page fournit des informations de référence pour AWS Serverless Application Model Interface de ligne de commande (AWS SAM CLI) sam local start-lambda sous-commande.

Le sam local start-lambda la sous-commande démarre un point de terminaison local à émuler AWS Lambda.

Important

Ne pas utiliser sam local start-lambda avec un code non fiable, car le point de terminaison local exécute le code de fonction dans votre environnement local. Pour une isolation complète, appelez plutôt le code dans le service Lambda.

Usage

$ sam local start-lambda <options>

Options

--add-host LIST

Transmet un nom d'hôte à une adresse IP en mappant le fichier hôte du conteneur Docker. Ce paramètre peut être passé plusieurs fois.

Exemple

Exemple : --add-host example.com:127.0.0.1

--beta-features | --no-beta-features

Autorisez ou refusez les fonctionnalités bêta.

--config-env TEXT

Le nom d’environnement spécifiant les valeurs de paramètre par défaut dans le fichier de configuration à utiliser. La valeur par défaut est « par défaut ». Pour plus d'informations sur les fichiers de configuration, consultez Fichier de configuration CLI AWS SAM.

--config-file PATH

Le chemin d'accès et le nom du fichier de configuration contenant les valeurs de paramètres par défaut à utiliser. La valeur par défaut est « samconfig.toml » dans la racine du répertoire du projet. Pour plus d'informations sur les fichiers de configuration, consultez Fichier de configuration CLI AWS SAM.

--container-env-vars

Facultatif. Transmettez les variables d’environnement au conteneur d’images lors du débogage local.

--container-host TEXT

Hôte du conteneur Lambda émulé localement. La valeur par défaut est localhost. Si vous voulez exécuter la CLI  AWS SAM dans un conteneur Docker sous macOS, vous pouvez spécifier host.docker.internal. Si vous souhaitez exécuter le conteneur sur un hôte différent de AWS SAM CLI, vous pouvez spécifier l'adresse IP de l'hôte distant.

--container-host-interface TEXT

L’adresse IP de l’interface de réseau hôte à laquelle les ports de conteneur doivent se relier. La valeur par défaut est 127.0.0.1. Utiliser 0.0.0.0 pour se lier à toutes les interfaces.

--container-dns TEXT

Spécifie un serveur DNS personnalisé pour le conteneur Docker. Ce paramètre peut être transmis plusieurs fois pour spécifier plusieurs serveurs DNS.

Exemple

Exemple : --container-dns 8.8.8.8

--debug

Active la journalisation de débogage pour imprimer le message de débogage généré par la CLI  AWS SAM et pour afficher les horodatages.

--debug-args TEXT

Arguments facultatifs à transmettre au débogueur.

--debug-function

Facultatif. Spécifie la fonction événementielle Lambda à laquelle appliquer les options de débogage lorsque --warm-containers est spécifié. Ce paramètre s’applique à --debug-port, --debugger-path et --debug-args.

--debug-port, -d TEXT

Si spécifié, il démarre le conteneur de fonction Lambda en mode débogage et expose ce port sur l’hôte local.

--debugger-path TEXT

Le chemin d’accès de l’hôte vers un débogueur à monter dans le conteneur Lambda.

--docker-network TEXT

Le nom ou l’identifiant d’un réseau Docker existant auquel les conteneurs Docker Lambda doivent se connecter, avec le réseau de pont par défaut. Si ceci est spécifié, les conteneurs Lambda se connectent uniquement au réseau Docker de pont par défaut.

--docker-volume-basedir, -v TEXT

L'emplacement du répertoire de base où AWS SAM le fichier existe. Si Docker s'exécute sur une machine distante, vous devez monter le chemin où AWS SAM le fichier existe sur la machine Docker et modifiez cette valeur pour qu'elle corresponde à la machine distante.

--env-vars, -n PATH

Le JSON ou .env fichier contenant les valeurs des variables d'environnement de la fonction Lambda. Le format de fichier est automatiquement détecté.

--force-image-build

Spécifiez si CLI devrait reconstruire l'image utilisée pour invoquer des fonctions avec des couches.

--help

Affiche ce message, puis se ferme.

--hook-name TEXT

Nom du hook utilisé pour étendre la fonctionnalité de la CLI  AWS SAM.

Valeurs acceptées : terraform.

--host TEXT

Le nom d’hôte local ou adresse IP à relier (par défaut : '127.0.0.1').

--invoke-image TEXT

L’URI de l’image de conteneur que vous souhaitez utiliser pour l’appel de la fonction locale.

Pour les fonctions Lambda avec PackageType: Zip, cela remplace l'image de base d'exécution. Par défaut, AWS SAM extrait l’image de conteneur depuis Amazon ECR Public. Utilisez cette option pour extraire l’image à partir d’un autre emplacement.

Pour les fonctions Lambda avec PackageType: Image, cela remplace ImageUri à partir du modèle créé. Utilisez-le pour invoquer une autre image d'application localement sans modifier votre modèle.

Vous pouvez spécifier cette option plusieurs fois. Chaque instance de cette option peut prendre une chaîne ou une paire valeur clé. Si vous spécifiez une chaîne, il s’agit de l’URI de l’image de conteneur à utiliser pour toutes les fonctions de l’application. Par exemple : sam local start-lambda --invoke-image public.ecr.aws/sam/emu-python3.13. Si vous spécifiez une paire valeur clé, la clé est le nom de la ressource et la valeur est l’URI de l’image de conteneur à utiliser pour cette ressource. Par exemple : sam local start-lambda --invoke-image public.ecr.aws/sam/emu-python3.13 --invoke-image Function1=amazon/aws-sam-cli-emulation-image-python3.13. Avec les paires valeur clé, vous pouvez spécifier différentes images de conteneur pour différentes ressources.

--layer-cache-basedir DIRECTORY

Spécifie l’emplacement basedir dans lequel les couches utilisées par le modèle sont téléchargées.

--log-file, -l TEXT

Le fichier journal vers lequel envoyer les journaux d’exécution.

--no-memory-limit

Supprime la limite de mémoire dans le conteneur lors de l'appel local, même lorsque la mémoire est configurée dans AWS SAM modèle.

--no-watch

Désactive la surveillance des fichiers lorsqu'il est utilisé avec --warm-containers. Lorsque cela est spécifié, le AWS SAM CLI ne surveille pas les modifications apportées à votre code source ou à votre modèle, et les conteneurs chauds ne sont pas automatiquement redémarrés en cas de modification du code. Pour récupérer les modifications locales, arrêtez et relancez la commande.

Utilisez cette option lorsque la surveillance de fichiers entraîne une augmentation du processeur ou I/O frais généraux, tels que dans les monorepos de grande taille, les environnements avec analyse de logiciels antivirus ou les projets dans lesquels plusieurs fonctions Lambda partagent un CodeUri.

Cette option est ignorée si --warm-containers n'est pas précisé.

--parameter-overrides

Une chaîne qui contient CloudFormation les remplacements de paramètres sont codés sous forme de paires clé-valeur. Utilisez le même format que AWS Command Line Interface (AWS CLI). Le AWS SAM CLI format correspond à des mots-clés clé et valeur explicites, chaque remplacement est séparé par un espace. Voici deux exemples :

  • --parameter-overrides ParameterKey=hello,ParameterValue=world

  • --parameter-overrides ParameterKey=hello,ParameterValue=world ParameterKey=example1,ParameterValue=example2 ParameterKey=apple,ParameterValue=banana

--port, -p INTEGER

Numéro de port local à écouter (par défaut : '3001').

--profile TEXT

Le profil spécifique de votre fichier d'identification qui obtient AWS informations d'identification.

--region TEXT

Le AWS Région dans laquelle déployer. Par exemple, us-east-1.

--save-params

Enregistrez les paramètres que vous fournissez sur la ligne de commande dans AWS SAM fichier de configuration.

--shutdown

Imite un événement d’arrêt une fois l’appel terminé, afin de tester la gestion des extensions du comportement d’arrêt.

--skip-prepare-infra

Ignore l'étape de préparation si aucune modification d'infrastructure n'a été apportée. À utiliser avec l'option --hook-name.

--skip-pull-image

Spécifie si le CLI devrait ignorer la liste déroulante de la dernière image Docker pour le runtime Lambda.

--template, -t PATH

Le AWS SAM fichier modèle.

Note

Si vous spécifiez cette option, AWS SAM charge uniquement le modèle et les ressources locales vers lesquelles il pointe. Cette option n'est pas compatible avec --hook-name.

--terraform-plan-file

Le chemin relatif ou absolu vers votre fichier de plan Terraform local lorsque vous utilisez la CLI  AWS SAM avec Terraform Cloud. Cette option nécessite que --hook-name soit défini sur terraform.

--warm-containers [EAGER | LAZY]

Facultatif. Spécifie comment la CLI  AWS SAM gère les conteneurs pour chaque fonction.

Deux options sont disponibles :

  • EAGER : Les conteneurs pour toutes les fonctions sont chargés au démarrage et persistent entre les appels.

  • LAZY : Les conteneurs ne sont chargés que lorsque chaque fonction est appelée pour la première fois. Ces conteneurs persistent pour des appels supplémentaires.

Exemple

Pour un exemple détaillé et une présentation détaillée de l'utilisation du sam local start-lambda sous-commande, reportez-vous à Présentation des tests avec start-lambda sam local.