sam local start-api

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.

Autorisez ou refusez les fonctionnalités bêta.

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 AWS SAM CLI Fichier de configuration  .

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 AWS SAM CLI Fichier de configuration  .

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

Hôte du conteneur Lambda émulé localement. La valeur par défaut est localhost. Si tu veux courir AWS SAM CLI dans un conteneur Docker sous macOS, vous pouvez spécifierhost.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.

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.

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

Arguments facultatifs à transmettre au débogueur.

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.

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

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

Nom ou identifiant d’un réseau Docker existant auquel les conteneurs Docker Lambda devraient se connecter, avec le réseau de pont par défaut. Si cela n’est pas spécifié, les conteneurs Lambda se connectent uniquement au réseau Docker de pont par défaut.

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.

JSONFichier contenant les valeurs des variables d'environnement de la fonction Lambda.

Spécifie si AWS SAM CLI devrait reconstruire l'image utilisée pour appeler des fonctions avec des couches.

Affiche ce message, puis se ferme.

Le nom du hook utilisé pour étendre AWS SAM CLI fonctionnalité.

Valeurs acceptées : terraform.

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

L'image URI du conteneur que vous souhaitez utiliser pour vos fonctions Lambda. 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.

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 URI de l'image du conteneur à utiliser pour toutes les fonctions de votre application. Par exemple, sam local start-api --invoke-image public.ecr.aws/sam/emu-python3.8. Si vous spécifiez une paire clé-valeur, la clé est le nom de la ressource et la valeur est celle URI de l'image du conteneur à utiliser pour cette ressource. Par exemple sam local start-api --invoke-image public.ecr.aws/sam/emu-python3.8 --invoke-image Function1=amazon/aws-sam-cli-emulation-image-python3.8 . Avec les paires valeur clé, vous pouvez spécifier différentes images de conteneur pour différentes ressources.

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

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

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

Le numéro de port local à écouter (par défaut : '3000').

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

AWS Région dans laquelle le déploiement doit être effectué. Par exemple, us-east-1.

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

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

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

Spécifie s'il CLI faut ignorer l'extraction de la dernière image Docker vers le bas pour le runtime Lambda.

Chemin d'accès au fichier de SSL certificat (par défaut : aucun). Lorsque vous utilisez cette option, elle doit également être utilisée. --ssl-key-file

Chemin d'accès au fichier SSL clé (par défaut : aucun). Lorsque vous utilisez cette option, elle doit également être utilisée. --ssl-cert-file

Tous les fichiers d'actifs statiques (par exempleCSS/JavaScript/HTML) situés dans ce répertoire sont présentés à l'adresse/.

Le fichier AWS SAM modèle.

Le chemin relatif ou absolu vers votre local Terraform fichier de plan lors de l'utilisation du AWS SAM CLI avec Terraform Cloud. Cette option nécessite qu'elle --hook-name soit définie surterraform.

Facultatif. Spécifie comment AWS SAM CLI 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.