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 deploy
Esta página fornece informações de referência para o comando Interface da Linha de Comando (AWS SAM CLI) sam deploy do AWS Serverless Application Model.
-
Para obter uma introdução à CLI do AWS SAM, consulte O que é o AWS SAMCLI?
-
Para obter a documentação sobre como usar o comando
sam deploydo AWS SAM CLI, consulte Introdução à implantação com o AWS SAM.
O comando sam deploy implanta um aplicativo para o Nuvem AWS usando o AWS CloudFormation.
Uso
$<environment variables>sam deploy<options>
Variáveis de ambiente
SAM_CLI_POLL_DELAY-
Defina a variável de ambiente
SAM_CLI_POLL_DELAYcom um valor de segundos no shell para configurar com que frequência a CLI do AWS SAM verifica o estado da pilha CloudFormation, o que é útil ao ser observado controle de utilização no CloudFormation. Essa variável de ambiente é usada para a sondagem de chamadas de APIdescribe_stack, que são feitas durante a execução desam deploy.Veja um exemplo dessa variável:
$SAM_CLI_POLL_DELAY=5sam deploy
Opções
--capabilitiesLIST-
Uma lista de capacidades que você deve especificar para permitir que o CloudFormation possa criar determinadas pilhas. Alguns modelos de pilhas podem incluir recursos que afetam permissões na sua Conta da AWS, por exemplo, criando novos usuários do (IAM) AWS Identity and Access Management. Para essas pilhas, você deve confirmar explicitamente seus recursos especificando esse opção. Os únicos valores válidos são
CAPABILITY_IAMeCAPABILITY_NAMED_IAM. Se você tiver recursos do IAM, então poderá especificar qualquer recurso. Se tiver recursos do IAM com nomes personalizados, então você deverá especificarCAPABILITY_NAMED_IAM. Se você não especificar essa opção, a operação retornará um erroInsufficientCapabilities.Quando você implanta uma aplicação que contém aplicações aninhadas, deve usar
CAPABILITY_AUTO_EXPANDpara reconhecer que a aplicação contém aplicações aninhadas. Para obter mais informações, consulte Implantar aplicativos aninhados. --config-envTEXT-
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 é
default. Para obter mais informações sobre esses arquivos de configuração, consulte Arquivo de configuração do AWS SAM CLI. --config-filePATH-
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.tomlna 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. --confirm-changeset | --no-confirm-changeset-
Solicite a confirmação se o AWS SAM CLI implanta o conjunto de alterações computado.
--debug-
Ative o registro de depuração para imprimir a mensagem de depuração que o AWS SAM CLI gera e para exibir timestamps.
--disable-rollback | --no-disable-rollback-
Especifique se deseja reverter sua pilha CloudFormation se ocorrer um erro durante uma implantação. Por padrão, se houver um erro durante uma implantação, sua pilha CloudFormation voltará ao último estado estável. Se você especificar
--disable-rollbacke ocorrer um erro durante uma implantação, os recursos que foram criados ou atualizados antes da ocorrência do erro não serão revertidos. --fail-on-empty-changeset | --no-fail-on-empty-changeset-
Especifique se deseja retornar um código de saída diferente de zero se não houver alterações a serem feitas na pilha. O comportamento padrão é retornar um código de saída diferente de zero.
--force-upload-
Especifique essa opção para fazer upload de artefatos, mesmo que eles correspondam aos artefatos existentes no bucket do Amazon S3. Os artefatos correspondentes são sobrescritos.
--guided, -g-
Especifique essa opção para que o AWS SAM CLI use prompts que o guiem durante a implantação.
--help-
Mostre esta mensagem e saia.
--image-repositoriesTEXT-
Um mapeamento de funções para o URI do repositório Amazon ECR. Funções de referência por meio de sua ID lógica. Veja um exemplo a seguir:
$sam deploy --image-repositoriesFunction1=123456789012.dkr.ecr.us-east-1.amazonaws.com/my-repoVocê pode especificar esta opção várias vezes em um único comando.
--image-repositoryTEXT-
O nome do repositório Amazon ECR em que esse comando carrega a imagem da sua função. Essa opção é necessária para funções declaradas com o tipo de pacote
Image. --kms-key-idTEXT-
O ID de uma chave AWS Key Management Service (AWS KMS) usada para criptografar artefatos que estão em repouso no bucket do Amazon S3. Se você não especificar essa opção, o AWS SAM usará chaves de criptografia gerenciadas pelo Amazon S3.
--metadata-
Um mapa de metadados para anexar a todos os artefatos referenciados em seu modelo.
--no-execute-changeset-
Indica se o conjunto de alterações deve ser aplicado. Especifique essa opção se quiser visualizar as alterações da pilha antes de aplicar o conjunto de alterações. Esse comando cria um conjunto de alterações CloudFormation e, em seguida, sai sem aplicar o conjunto de alterações. Para aplicar o conjunto de alterações, execute o mesmo comando sem essa opção.
--no-progressbar-
Não exiba uma barra de progresso ao fazer o upload de artefatos para o Amazon S3.
--notification-arnsLIST-
Uma lista dos ARNs de tópicos do Amazon Simple Notification Service (Amazon SNS) que o CloudFormation associa à pilha.
--on-failure [ROLLBACK | DELETE | DO_NOTHING]-
Especifique a ação a ser tomada quando uma pilha falhar na criação.
As seguintes opções estão disponíveis:
-
ROLLBACK— Reverte a pilha para um estado anterior em boas condições. -
DELETE— Reverte a pilha para um estado anterior em boas condições, se existir um. Caso contrário, exclui a pilha. -
DO_NOTHING— Nem reverte nem exclui a pilha. O efeito é o mesmo do--disable-rollback.
O comportamento padrão é
ROLLBACK.nota
Você pode especificar a opção
--disable-rollbackou a opção--on-failure, mas não ambos. -
--parameter-overridesLIST-
Uma sequência que contém substituições de parâmetros CloudFormation codificados como pares chave-valor. Cada substituição usa o formato
ParameterKey=name,ParameterValue=value. As substituições múltiplas são separadas por espaços. Veja dois exemplos a seguir:$sam deploy --parameter-overridesParameterKey=value1,ParameterValue=value2$sam deploy --parameter-overridesParameterKey=value1,ParameterValue=value2 ParameterKey=hello,ParameterValue=world ParameterKey=apple,ParameterValue=banana --profileTEXT-
O perfil específico do seu arquivo de credenciais que obtém credenciais da AWS.
--regionTEXT-
O Região da AWS para o qual implantar. Por exemplo, us-east-1.
--resolve-image-repos-
Crie automaticamente repositórios do Amazon ECR para uso no empacotamento e implantação em implantações não guiadas. Esta opção se aplica apenas às funções e camadas com o
PackageType: Imageespecificado. Se você especificar a opção--guided, então o AWS SAM CLI ignora o--resolve-image-repos.nota
Se você criar AWS SAM automaticamente qualquer repositório do Amazon ECR para funções ou camadas com essa opção e, posteriormente, excluir essas funções ou camadas do seu modelo AWS SAM, os repositórios correspondentes do Amazon ECR serão automaticamente excluídos.
--resolve-s3-
Crie automaticamente um bucket do Amazon S3 para uso no empacotamento e implantação em implantações não guiadas. Se você especificar a opção
--guided, então a CLI AWS SAM ignora o--resolve-s3. Se você especificar as opções--s3-buckete--resolve-s3, ocorrerá um erro. --role-arnTEXT-
O nome de recurso da Amazon (ARN) de um perfil do IAM que CloudFormation assume ao aplicar o conjunto de alterações.
--s3-bucketTEXT-
O nome do bucket do Amazon S3 onde esse comando faz upload seu modelo CloudFormation. Se seu modelo for maior que 51.200 bytes, a opção
--s3-bucketou a opção--resolve-s3serão obrigatórias. Se você especificar as opções--s3-buckete--resolve-s3, ocorrerá um erro. --s3-prefixTEXT-
O prefixo adicionado aos nomes dos artefatos que são enviados ao bucket do Amazon S3. O nome do prefixo é um nome de caminho (nome da pasta) para o bucket do Amazon S3.
--save-params-
Salve os parâmetros fornecidos na linha de comando no arquivo de configuração AWS SAM.
--signing-profilesLIST-
A lista de perfis de assinatura com os quais assinar seus pacotes de implantação. Essa opção usa uma lista de pares de valores-chave, em que a chave é o nome da função ou camada a ser assinada e o valor é o perfil de assinatura, com um proprietário de perfil opcional delimitado por
:. Por exemplo,FunctionNameToSign=SigningProfileName1 LayerNameToSign=SigningProfileName2:SigningProfileOwner. --stack-nameTEXT-
(Obrigatório) O nome da pilha CloudFormation na qual você estiver implantando. Se você especificar uma pilha existente, o comando atualizará a pilha. Se você especificar uma nova pilha, o comando a criará.
-
Uma lista de tags a serem associadas à pilha criada ou atualizada. O CloudFormation também propaga essas tags para recursos na pilha que as suportam.
--template-file, --template, -tPATH-
O caminho e o nome do arquivo em que seu modelo AWS SAM está localizado.
nota
Se você especificar essa opção, então AWS SAM implantará somente o modelo e os recursos locais para os quais ele aponta.
--use-json-
JSON de saída para o modelo CloudFormation. A saída padrão é YAML.
Exemplo
Para obter um exemplo detalhado e uma explicação aprofundada sobre o uso do subcomando sam deploy, consulte Introdução à implantação com o AWS SAM.