sam local start-lambda

Cette page fournit des informations de référence pour la AWS Serverless Application Model sam local start-lambda sous-commande Command Line Interface (AWS SAMCLI).

• Pour une introduction à la AWS SAMCLI, voirQu'est-ce que c'est AWS SAMCLI ?.

• Pour obtenir de la documentation sur l'utilisation de la AWS SAMCLI sam local start-lambda sous-commande, consultezPrésentation des tests avec sam local start-lambda.

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

Utilisation

$ sam local start-lambda <options>

Options

--add-host LIST

Transmet un mappage de nom d'hôte à adresse IP au fichier hôte du conteneur Docker. Ce paramètre peut être transmis plusieurs fois.

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 autre hôte AWS SAMCLI, 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.

--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 Lambda pour appliquer les options de débogage lorsque --warm-containersest 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

Emplacement du répertoire de base où se trouve le AWS SAM fichier. Si Docker est exécuté sur une machine distante, vous devez monter le chemin où se trouve le AWS SAM fichier sur la machine Docker et modifier cette valeur pour qu'elle corresponde à la machine distante.

--env-vars, -n PATH

Le fichier JSON contenant les valeurs des variables d’environnement de la fonction Lambda.

--force-image-build

Spécifiez s'il CLI faut reconstruire l'image utilisée pour appeler 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. Par défaut, AWS SAM extrait l'image du conteneur depuis Amazon ECR Public. Utilisez cette option pour extraire l’image à partir d’un autre emplacement.

Par exemple, sam local start-lambda MyFunction --invoke-image amazon/aws-sam-cli-emulation-image-python3.8.

--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.

--parameter-overrides

Facultatif. Chaîne contenant des remplacements de AWS CloudFormation paramètres codés sous forme de paires clé-valeur. Utilisez le même format que AWS CLI—par exemple, 'ParameterKey=, = ParameterValue MyKey ParameterKey = KeyPairNameInstanceType, ParameterValue =t1.micro'. Cette option n'est pas compatible avec --hook-name.

--port, -p INTEGER

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

--profile TEXT

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

--region TEXT

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 le fichier AWS SAM 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 s'il CLI faut ignorer l'extraction de la dernière image Docker pour le runtime Lambda.

--template, -t PATH

Le fichier AWS SAM modèle.

Note

Si vous spécifiez cette option, AWS SAM charge uniquement le modèle et les ressources locales vers lesquels 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.