sam local start-api

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.

Permitir o denegar las características beta.

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.

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.

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

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 quiere ejecutar el contenedor en un host diferente al de la CLI de AWS SAM, puede especificar la dirección IP del host remoto.

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.

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.

Los argumentos adicionales que se pasarán al depurador.

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.

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

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

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.

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

Archivo JSON que contiene valores para las variables de entorno de la función de Lambda.

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

Muestra este mensaje y sale.

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

Valores aceptados: terraform.

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

El URI de la imagen del contenedor que quiere usar para las funciones de Lambda. Por defecto, AWS SAM extrae la imagen del contenedor desde Amazon ECR Public. Utiliza esta opción para extraer la imagen desde otra ubicación.

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.8. 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.8 --invoke-image Function1=amazon/aws-sam-cli-emulation-image-python3.8 . Con los pares clave-valor, puede especificar distintas imágenes de contenedor para distintos recursos.

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

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

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

Una cadena que contiene anulaciones de parámetros CloudFormation codificadas como pares de clave-valor. Usa el mismo formato que 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:

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

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

La región de AWS en la que se va a realizar la implementación. Por ejemplo, us-east-1.

Guarda los parámetros que proporciones en la línea de comandos en el archivo de configuración de AWS SAM.

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.

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

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

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

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

Todos los archivos de recursos estáticos (por ejemplo, CSS/JavaScript/HTML) ubicados en este directorio se presentan en /.

El archivo de la plantilla AWS SAM.

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.

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.