As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
sam local start-api
Esta página fornece informações de referência para a interface de linha de AWS Serverless Application Model comando (AWS SAM CLI) sam local start-api
subcomando.
-
Para uma introdução ao AWS SAM CLI, veja O que é o AWS SAM CLI?
-
Para obter documentação sobre o uso do AWS SAM CLI
sam local start-api
subcomando, consulteIntrodução aos testes com sam local start-api.
O sam local start-api
subcomando executa suas AWS Lambda funções localmente para testar por meio de um host de HTTP servidor local.
Uso
$
sam local start-api
<options>
Opções
--add-host
LIST
-
Passa um nome de host para mapeamento de endereço IP para o arquivo host do contêiner Docker. Esse parâmetro pode ser passado várias vezes.
Exemplo:
--add-host
example.com:127.0.0.1
--beta-features | --no-beta-features
-
Permita ou negue recursos beta.
--config-env
TEXT
-
O nome do ambiente que especifica os valores de parâmetros padrão no arquivo de configuração a serem usados. O valor padrão é “padrão”. Para obter mais informações sobre esses arquivos de configuração, consulte Arquivo de configuração do AWS SAM CLI.
--config-file
PATH
-
O caminho e o nome do arquivo de configuração contendo valores de parâmetros padrão a serem usados. O valor padrão é “samconfig.toml” na raiz do diretório do projeto. Para obter mais informações sobre esses arquivos de configuração, consulte Arquivo de configuração do AWS SAM CLI.
--container-env-vars
-
Opcional. Passe variáveis de ambiente para o contêiner de imagem ao depurar localmente.
--container-host
TEXT
-
Host do contêiner Lambda emulado localmente. O valor padrão é
localhost
. Se você quiser correr AWS SAM CLI em um contêiner Docker no macOS, você pode especificar.host.docker.internal
Se você quiser executar o contêiner em um host diferente do AWS SAM CLI, você pode especificar o endereço IP do host remoto. --container-host-interface
TEXT
-
O endereço IP da interface de rede do host à qual as portas do contêiner devem se vincular. O valor padrão é
127.0.0.1
. Use0.0.0.0
para vincular a todas as interfaces. --debug
-
Ativa o registro de depuração para imprimir a mensagem de depuração gerada pelo AWS SAM CLI e exiba carimbos de data/hora.
--debug-args
TEXT
-
Argumentos adicionais a serem transmitidos para o depurador.
--debug-function
-
Opcional. Especifica a função do Lambda para aplicar opções de depuração quando for especificado como
--warm-containers
. Esse parâmetro se aplica a--debug-port
,--debugger-path
e--debug-args
. --debug-port, -d
TEXT
-
Quando especificado, inicia o contêiner da função do Lambda no modo de depuração e expõe essa porta no host local.
--debugger-path
TEXT
-
O caminho do host para um depurador que será montado no contêiner Lambda.
--docker-network
TEXT
-
Especifica o nome ou ID de uma rede Docker existente à qual os contêineres do Docker do Lambda devem se conectar, juntamente com a rede de ponte padrão. Se não for especificado, os contêineres do Lambda se conectarão somente à rede de Docker de ponte padrão.
--docker-volume-basedir, -v
TEXT
-
A localização do diretório base em que o AWS SAM arquivo existe. Se o Docker estiver sendo executado em uma máquina remota, você deverá montar o caminho em que o AWS SAM arquivo existe na máquina Docker e modificar esse valor para corresponder à máquina remota.
--env-vars, -n
PATH
-
O JSON arquivo que contém valores para as variáveis de ambiente da função Lambda.
--force-image-build
-
Especifica se AWS SAM CLI deve reconstruir a imagem usada para invocar funções com camadas.
--help
-
Mostra esta mensagem e sai.
--hook-name
TEXT
-
O nome do gancho usado para estender AWS SAM CLI funcionalidade.
Valores aceitos:
terraform
. --host
TEXT
-
O nome do host local ou endereço IP ao qual se vincular (padrão: '127.0.0.1').
--invoke-image
TEXT
-
A imagem URI do contêiner que você deseja usar para suas funções do Lambda. Por padrão, AWS SAM extrai a imagem do contêiner do Amazon ECR Public. Use essa opção para extrair a imagem de outro localização.
Especifique essa opção várias vezes. Cada instância dessa opção pode ter uma string ou um par de valores-chave. Se você especificar uma string, ela será a imagem URI do contêiner a ser usada para todas as funções em seu aplicativo. Por exemplo,
sam local start-api --invoke-image public.ecr.aws/sam/emu-python3.8
. Se você especificar um par de valores-chave, a chave será o nome do recurso e o valor será o da imagem URI do contêiner a ser usada para esse recurso. Por exemplo,sam local start-api --invoke-image public.ecr.aws/sam/emu-python3.8 --invoke-image Function1=amazon/aws-sam-cli-emulation-image-python3.8
. Com pares de valores-chave, você pode especificar imagens de contêiner diferentes para recursos diferentes. --layer-cache-basedir
DIRECTORY
-
Especifica a localização com base na qual as camadas que seu modelo usa são baixadas.
--log-file, -l
TEXT
-
O arquivo de log para o qual enviar os registros de tempo de execução.
--parameter-overrides
-
Uma string que contém substituições de AWS CloudFormation parâmetros codificadas como pares de valores-chave. Use o mesmo formato do AWS Command Line Interface (AWS CLI). O AWS SAM CLI formato são palavras-chave explícitas de chave e valor, cada substituição é separada por um espaço. Veja dois exemplos a seguir:
--parameter-overrides ParameterKey=hello,ParameterValue=world
--parameter-overrides ParameterKey=hello,ParameterValue=world ParameterKey=example1,ParameterValue=example2 ParameterKey=apple,ParameterValue=banana
--port, -p
INTEGER
-
O número da porta local para escutar (padrão: '3000').
--profile
TEXT
-
O perfil específico do seu arquivo de credenciais que obtém as AWS credenciais.
--region
TEXT
-
A AWS região para a qual implantar. Por exemplo, us-east-1.
--save-params
-
Salve os parâmetros fornecidos na linha de comando no arquivo AWS SAM de configuração.
--shutdown
-
Emula um evento de desligamento após a conclusão da invocação, a fim de testar o tratamento da extensão sobre o comportamento de desligamento.
--skip-prepare-infra
-
Ignora a fase de preparação se nenhuma alteração na infraestrutura tiver sido feita. Execute com a opção
--hook-name
. --skip-pull-image
-
Especifica se você CLI deve pular a extração da imagem mais recente do Docker para o tempo de execução do Lambda.
--ssl-cert-file
PATH
-
Caminho para o arquivo de SSL certificado (padrão: Nenhum). Ao usar essa opção, a
--ssl-key-file
opção também deve ser usada. --ssl-key-file
PATH
-
Caminho para o arquivo de SSL chave (padrão: Nenhum). Ao usar essa opção, a
--ssl-cert-file
opção também deve ser usada. --static-dir, -s
TEXT
-
Todos os arquivos de ativos estáticos (por exemplo,CSS/JavaScript/HTML) localizados nesse diretório são apresentados em
/
. --template, -t
PATH
-
O arquivo AWS SAM de modelo.
nota
Se você especificar essa opção, AWS SAM carrega somente o modelo e os recursos locais para os quais ele aponta.
--terraform-plan-file
-
O caminho relativo ou absoluto até seu local Terraform arquivo de plano ao usar o AWS SAM CLI with Terraform Cloud. Essa opção exige que
--hook-name
seja definida comoterraform
. --warm-containers
[EAGER | LAZY]
-
Opcional. Especifica como AWS SAM CLI gerencia contêineres para cada função.
Existem duas opções:
EAGER
: os contêineres de todas as funções são carregados na inicialização e persistem entre as invocações.LAZY
: os contêineres são carregados somente quando cada função é invocada pela primeira vez. Esses contêineres persistem para invocações adicionais.