View a markdown version of this page

sam local start-api - AWS Serverless Application Model

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

sam local start-api

Esta página proporciona información de referencia para AWS Serverless Application Model Interfaz de línea de comandos (AWS SAM CLI) sam local start-api subcomando.

El sam local start-api el subcomando ejecuta tu AWS Lambda El evento funciona localmente para realizar pruebas a través de un servidor HTTP local.

importante

No utilices sam local start-api con código que no es de confianza, porque ejecuta sus funciones en su entorno local. Para lograr un aislamiento total, prueba el código en el servicio Lambda en su lugar.

De uso

$ sam local start-api <options>

Opciones

--add-host LIST

Pasa una asignación de nombre de host a dirección IP al archivo de host del contenedor de Docker. Este parámetro se puede pasar varias veces.

ejemplo

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

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

Permitir o denegar las características beta.

--config-env TEXT

El nombre del entorno que especifica los valores de los parámetros predeterminados del archivo de configuración que se va a utilizar. El valor por defecto es «predeterminado». Para obtener más información sobre los archivos de configuración, consulta Archivo de configuración de la CLI de AWS SAM.

--config-file PATH

La ruta y el nombre del archivo de configuración que contiene los valores de parámetros predeterminados que se van a utilizar. El valor predeterminado es «samconfig.toml» en la raíz del directorio del proyecto. Para obtener más información sobre los archivos de configuración, consulta Archivo de configuración de la CLI de AWS SAM.

--container-env-vars

Opcional. Al realizar la depuración local, pasa las variables de entorno al contenedor de imágenes.

--container-host TEXT

Host del contenedor Lambda emulado localmente. El valor predeterminado es localhost. Si quiere ejecutar la CLI de AWS SAM en un contenedor Docker en macOS, puede especificar host.docker.internal. Si desea ejecutar el contenedor en un host diferente al AWS SAM CLI, puede especificar la dirección IP del host remoto.

--container-host-interface TEXT

La dirección IP de la interfaz de red del host a la que deben enlazarse los puertos del contenedor. El valor predeterminado es 127.0.0.1. Utiliza 0.0.0.0 para enlazarse a todas las interfaces.

--container-dns TEXT

Especifica un servidor DNS personalizado para el contenedor Docker. Este parámetro se puede pasar varias veces para especificar varios servidores DNS.

ejemplo

Ejemplo: --container-dns 8.8.8.8

--debug

Activa el registro de depuración para imprimir el mensaje de depuración que genera la CLI de AWS SAM y muestra las marcas temporales.

--debug-args TEXT

Los argumentos adicionales que se pasarán al depurador.

--debug-function

Opcional. Especifica la función de Lambda a la que se aplicarán las opciones de depuración cuando --warm-containers se especifica. Este parámetro se aplica a --debug-port, --debugger-path y --debug-args.

--debug-port, -d TEXT

Cuando se especifica, inicia el contenedor de funciones de Lambda en modo de depuración y expone este puerto en el host local.

--debugger-path TEXT

La ruta del host a un depurador que se montará en el contenedor de Lambda.

--docker-network TEXT

Especifica el nombre o el ID de una red de Docker existente a la que deben conectarse los contenedores de Lambda y Docker, junto con la red en modo puente predeterminada. Si esto no se especifica, los contenedores de Lambda solo se conectan a la red Docker en modo puente predeterminada.

--docker-volume-basedir, -v TEXT

La ubicación del directorio base donde se encuentra el AWS SAM existe el archivo. Si Docker se ejecuta en una máquina remota, debe montar la ruta donde AWS SAM el archivo existe en la máquina Docker y modifique este valor para que coincida con la máquina remota.

--env-vars, -n PATH

El JSON o .env archivo que contiene los valores de las variables de entorno de la función Lambda. El formato del archivo se detecta automáticamente.

--force-image-build

Especifica si AWS SAM CLI debe reconstruir la imagen utilizada para invocar funciones con capas.

--help

Muestra este mensaje y sale.

--hook-name TEXT

El nombre del enlace que se utiliza para ampliar la funcionalidad de la CLI de AWS SAM.

Valores aceptados: terraform.

--host TEXT

El nombre de host local o la dirección IP a la que se va a vincular (predeterminado: «127.0.0.1»).

--invoke-image TEXT

El URI de la imagen del contenedor que quiere usar para las funciones de Lambda.

Para funciones de Lambda con PackageType: Zip, esto anula la imagen base en tiempo de ejecución. De forma predeterminada, AWS SAM extrae la imagen del contenedor de Amazon ECR Public. Utiliza esta opción para extraer la imagen desde otra ubicación.

Para funciones de Lambda con PackageType: Image, esto anula el ImageUri de la plantilla creada. Utilícela para invocar una imagen de aplicación diferente de forma local sin modificar la plantilla.

Puedes especificar esta opción varias veces. Cada instancia de esta opción puede tomar una cadena o un par clave-valor. Si especificas una cadena, será el URI de la imagen del contenedor que se usará en todas las funciones de la aplicación. Por ejemplo, sam local start-api --invoke-image public.ecr.aws/sam/emu-python3.13. Si especificas un par clave-valor, la clave es el nombre del recurso y el valor es el URI de la imagen del contenedor que se va a usar para ese recurso. Por ejemplo, sam local start-api --invoke-image public.ecr.aws/sam/emu-python3.13 --invoke-image Function1=amazon/aws-sam-cli-emulation-image-python3.13. Con los pares clave-valor, puede especificar distintas imágenes de contenedor para distintos recursos.

--layer-cache-basedir DIRECTORY

Especifica la ubicación basada en el lugar en el que se descargan las capas que utiliza la plantilla.

--log-file, -l TEXT

El archivo de registro al que se van a enviar los registros de tiempo de ejecución.

--no-memory-limit

Elimina la limitación de memoria del contenedor durante la invocación local, incluso cuando la memoria está configurada en AWS SAM plantilla.

--no-watch

Deshabilita la visualización de archivos cuando se usa con --warm-containers. Cuando se especifica, el AWS SAM CLI no supervisa el código fuente o la plantilla para detectar cambios, y los contenedores calientes no se reinician automáticamente al modificar el código. Para detectar los cambios locales, detenga el comando y vuelva a ejecutarlo.

Utilice esta opción cuando la visualización de archivos provoque un aumento de la CPU o I/O gastos generales, como en monorepos de gran tamaño, entornos en los que se escanea el software antivirus o proyectos en los que varias funciones de Lambda comparten una CodeUri.

Esta opción se ignora si --warm-containers no está especificada.

--parameter-overrides

Una cadena que contiene CloudFormation anulaciones de parámetros codificadas como pares clave-valor. Utilice el mismo formato que el AWS Command Line Interface (AWS CLI). El formato de la CLI de AWS SAM es de palabras clave y de valor explícitas, y cada modificación está separada por un espacio. A continuación, se incluyen dos ejemplos:

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

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

--port, -p INTEGER

El número de puerto local en el que se va a escuchar (valor predeterminado: «3000»).

--profile TEXT

El perfil específico de su archivo de credenciales que obtiene AWS credenciales.

--region TEXT

El AWS Región en la que realizar el despliegue. Por ejemplo, us-east-1.

--save-params

Guarde los parámetros que proporciona en la línea de comandos en AWS SAM archivo de configuración.

--shutdown

Emula un evento de apagado una vez finalizada la invocación, para probar la forma en que la extensión gestiona el comportamiento del apagado.

--skip-prepare-infra

Omite la fase de preparación si no se ha realizado ningún cambio en la infraestructura. Úsalo con la opción --hook-name.

--skip-pull-image

Especifica si la CLI debe omitir la extracción de la última imagen de Docker para el tiempo de ejecución de Lambda.

--ssl-cert-file PATH

Ruta al archivo de certificado SSL (predeterminado: ninguno). Al usar esta opción, también debes usarse la opción --ssl-key-file.

--ssl-key-file PATH

Ruta al archivo de clave SSL (predeterminado: ninguno). Al usar esta opción, también debes usarse la opción --ssl-cert-file.

--static-dir, -s TEXT

Cualquier activo estático (por ejemplo, CSS/JavaScript/HTML) los archivos que se encuentran en este directorio se presentan en /.

--template, -t PATH

El AWS SAM archivo de plantilla.

nota

Si especifica esta opción, AWS SAM carga solo la plantilla y los recursos locales a los que apunta.

--terraform-plan-file

La ruta relativa o absoluta al archivo del plan local Terraform cuando se utiliza la CLI de AWS SAM con Terraform Cloud. Esta opción requiere que --hook-name esté configurado en terraform.

--warm-containers [EAGER | LAZY]

Opcional. Especifica cómo la CLI de AWS SAM administra los contenedores para cada función.

Hay dos opciones disponibles:

   EAGER: los contenedores de todas las funciones se cargan al inicio y se conservan entre las invocaciones.

   LAZY: los contenedores solo se cargan cuando se invoca cada función por primera vez. Esos contenedores se conservan para realizar más invocaciones.

Ejemplo

En el siguiente ejemplo se inicia un servidor local, lo que le permite probar la aplicación mediante la API. Para que este comando funcione, la aplicación debe estar instalada y Docker debe estar en ejecución.

$ sam local start-api --port 3000