sam deploy

Esta página fornece informações de referência para o AWS Serverless Application Model comando Command Line Interface (AWS SAMCLI)sam deploy.

• Para obter uma introdução ao AWS SAMCLI, consulteO que é o AWS SAMCLI?.

• Para obter a documentação sobre o uso do AWS SAMCLI sam deploy comando, consulteIntrodução à implantação com o comando sam deploy.

O sam deploy comando implanta um aplicativo para o usuário Nuvem AWS . AWS CloudFormation

Uso

$ <environment variables> sam deploy <options>

Variáveis de ambiente

SAM_CLI_POLL_DELAY

Defina a variável de SAM_CLI_POLL_DELAY ambiente com um valor de segundos para configurar com que frequência a CLI do AWS SAM verifica o estado da AWS CloudFormation pilha, o que é útil ao ver a limitação de. AWS CloudFormation Essa variável env é usada para pesquisar chamadas de describe_stack API, que são feitas durante a execução. sam deploy

Veja a seguir um exemplo dessa variável:

$ SAM_CLI_POLL_DELAY=5 sam deploy

Opções

--capabilities LIST

Uma lista de recursos que você deve especificar para permitir AWS CloudFormation a criação de determinadas pilhas. Alguns modelos de pilha podem incluir recursos que afetam suas permissões Conta da AWS, por exemplo, criando novos usuários AWS Identity and Access Management (IAM). Para essas pilhas, você deve confirmar explicitamente seus recursos especificando esse opção. Os únicos valores válidos são CAPABILITY_IAM e CAPABILITY_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á especificar CAPABILITY_NAMED_IAM. Se você não especificar essa opção, a operação retornará um erro InsufficientCapabilities.

--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 é default. 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.

--confirm-changeset | --no-confirm-changeset

Solicite a confirmação se o AWS SAMCLI implanta o conjunto de alterações computado.

--debug

Ative o registro de depuração para imprimir a mensagem de depuração que o AWS SAMCLI gera e para exibir timestamps.

--disable-rollback | --no-disable-rollback

Especifique se deseja reverter sua AWS CloudFormation pilha se ocorrer um erro durante uma implantação. Por padrão, se houver um erro durante uma implantação, sua AWS CloudFormation pilha voltará ao último estado estável. Se você especificar --disable-rollback e 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 SAMCLI use prompts que o guiem durante a implantação.

--help

Mostre esta mensagem e saia.

--image-repositories TEXT

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-repositories Function1=123456789012.dkr.ecr.us-east-1.amazonaws.com/my-repo

Você pode especificar esta opção várias vezes em um único comando.

--image-repository TEXT

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-id TEXT

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, AWS SAM use as 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 AWS 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-arns LIST

Uma lista dos ARNs de tópicos do Amazon Simple Notification Service (Amazon SNS AWS CloudFormation ) associados à 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-rollback ou a opção --on-failure, mas não ambos.

--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). Por exemplo, ParameterKey=ParameterValue InstanceType=t1.micro.

--profile TEXT

O perfil específico do seu arquivo de credenciais que obtém as AWS credenciais.

--region TEXT

O Região da AWS para 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: Image especificado. Se você especificar a opção --guided, então o AWS SAMCLI 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, você excluir essas funções ou camadas do seu AWS SAM modelo, 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-bucket e --resolve-s3, ocorrerá um erro.

--role-arn TEXT

O Amazon Resource Name (ARN) de uma função do IAM que é AWS CloudFormation assumida ao aplicar o conjunto de alterações.

--s3-bucket TEXT

O nome do bucket do Amazon S3 em que esse comando carrega seu modelo. AWS CloudFormation Se seu modelo for maior que 51.200 bytes, a opção --s3-bucket ou a opção --resolve-s3 serão obrigatórias. Se você especificar as opções --s3-bucket e --resolve-s3, ocorrerá um erro.

--s3-prefix TEXT

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 AWS SAM de configuração.

--signing-profiles LIST

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-name TEXT

(Obrigatório) O nome da AWS CloudFormation pilha na qual você está implantando. Se você especificar uma pilha existente, o comando atualizará a pilha. Se você especificar uma nova pilha, o comando a criará.

--tags LIST

Uma lista de tags a serem associadas à pilha criada ou atualizada. AWS CloudFormation também propaga essas tags para recursos na pilha que as suportam.

--template-file, --template, -t PATH

O caminho e o nome do arquivo em que seu AWS SAM modelo está localizado.

nota

Se você especificar essa opção, AWS SAM implantará somente o modelo e os recursos locais para os quais ele aponta.

--use-json

JSON de saída para o AWS CloudFormation modelo. A saída padrão é YAML.