sam sync - AWS Serverless Application Model

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 sync

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

O comando sam sync sincroniza as alterações do aplicativo local com o Nuvem AWS.

Usage

$ sam sync <options>

Opções

--base-dir, -s DIRECTORY

Resolve caminhos relativos para o código-fonte da função ou da camada em relação a esse diretório. Use essa opção para alterar a forma como os caminhos relativos para as pastas de código-fonte são resolvidos. Por padrão, os caminhos relativos são resolvidos com relação à localização do AWS SAM modelo.

Além dos recursos no aplicativo raiz ou na pilha que você está criando, essa opção também se aplica a aplicativos ou pilhas aninhados. Além disso, essa opção se aplica aos seguintes tipos e propriedades de recursos:

  • Tipo de recursos: AWS::Serverless::Function Propriedade: CodeUri

  • Tipo de recurso: AWS::Serverless::Function Atributo do recurso: Metadata Entrada: DockerContext

  • Tipo de recursos: AWS::Serverless::LayerVersion Propriedade: ContentUri

  • Tipo de recursos: AWS::Lambda::Function Propriedade: Code

  • Tipo de recursos: AWS::Lambda::LayerVersion Propriedade: Content

--build-image TEXT

O URI da imagem do contêiner que você deseja usar ao criar o aplicativo. Por padrão, AWS SAM usa o URI do repositório de imagens de contêiner do Amazon Elastic Container Registry (Amazon ECR) Public. Especifique essa opção para usar uma imagem diferente.

Você pode usar essa opção várias vezes em um único comando. Cada opção aceita uma sequência ou um par de chave/valor.

  • String - Especifique o URI da imagem do contêiner que todos os recursos do seu aplicativo usarão. Veja um exemplo a seguir:

    $ sam sync --build-image amazon/aws-sam-cli-build-image-python3.8
  • Par de valores-chave - especifique o nome do recurso como chave e o URI da imagem do contêiner a ser usado com esse recurso como valor. Use esse formato para especificar um URI de imagem de contêiner diferente para cada recurso em seu aplicativo. Veja um exemplo a seguir:

    $ sam sync --build-image Function1=amazon/aws-sam-cli-build-image-python3.8

Essa opção só se aplica se a opção --use-container for especificada, caso contrário, ocorrerá um erro.

--build-in-source | --no-build-in-source

Providencie --build-in-source para compilar seu projeto diretamente na pasta de origem.

A opção --build-in-source oferece suporte aos seguintes runtimes e métodos de compilação:

  • Runtimes — Qualquer runtime Node.js suportado pela opção sam init --runtime.

  • Métodos de compilaçãoMakefile, esbuild.

A opção --build-in-source não é compatível com as seguintes opções:

  • --use-container

Padrão: --no-build-in-source

--capabilities LIST

Uma lista de recursos que você especifica para permitir CloudFormation a criação de determinadas pilhas. Alguns modelos de pilha podem incluir recursos que podem afetar as permissões em seu Conta da AWS. Por exemplo, criando novos usuários AWS Identity and Access Management (IAM). Especifique essa opção para substituir os valores padrão. Os valores válidos incluem:

  • CAPACIDADE_IAM

  • CAPACIDADE_NAMED_IAM

  • POLÍTICA DE RECURSOS DE CAPACIDADE

  • CAPABILITY_AUTO_EXPAND

Padrão: CAPABILITY_NAMED_IAM e CAPABILITY_AUTO_EXPAND

--code

Por padrão, AWS SAM sincroniza todos os recursos em seu aplicativo. Especifique essa opção para sincronizar somente recursos de código, que incluem o seguinte:

  • AWS::Serverless::Function

  • AWS::Lambda::Function

  • AWS::Serverless::LayerVersion

  • AWS::Lambda::LayerVersion

  • AWS::Serverless::Api

  • AWS::ApiGateway::RestApi

  • AWS::Serverless::HttpApi

  • AWS::ApiGatewayV2::Api

  • AWS::Serverless::StateMachine

  • AWS::StepFunctions::StateMachine

Para sincronizar recursos de código, AWS SAM usa o AWS serviço APIs diretamente, em vez de implantar por meio AWS CloudFormation de. Para atualizar sua CloudFormation pilha, execute sam sync --watch ousam deploy.

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

--dependency-layer | --no-dependency-layer

Especifica se as dependências de funções individuais devem ser separadas em outra camada para acelerar o processo de sincronização.

Padrão: --dependency-layer

--image-repository TEXT

O nome do repositório do Amazon Elastic Container Registry (Amazon ECR) no qual esse comando faz upload da imagem da função. Necessário para funções declaradas com o tipo de pacote Image.

--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 sync --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.

--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 que você faz referência no seu modelo.

--notification-arns LIST

Uma lista dos ARNs tópicos CloudFormation do Amazon Simple Notification Service (Amazon SNS) associados à pilha.

--no-use-container

Uma opção que permite usar o kit de ferramentas do IDE para definir o comportamento padrão.

--parameter-overrides

Uma string que contém substituições de CloudFormation parâmetros codificadas como pares de valores-chave. Use o mesmo formato do AWS Command Line Interface (AWS CLI). O formato da CLI do AWS SAMé uma palavra-chave explícita de chave e valor e 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

--resource TEXT

Especifica o tipo de recurso a ser sincronizado. Para sincronizar vários recursos, você pode especificar essa opção várias vezes. Essa opção é compatível com a opção --code. O valor deve ser um dos recursos listados em --code. Por exemplo, .--resource AWS::Serverless::Function --resource AWS::Serverless::LayerVersion

--resource-id TEXT

Especifica o ID do recurso a ser sincronizado. Para sincronizar vários recursos, você pode especificar essa opção várias vezes. Essa opção é compatível com a opção --code. Por exemplo, .--resource-id Function1 --resource-id Function2

--role-arn TEXT

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

--s3-bucket TEXT

O nome do bucket do Amazon Simple Storage Service (Amazon S3) no qual esse comando carrega seu modelo. 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 você faz upload para o bucket do Amazon S3. O nome do prefixo é um nome de caminho (nome da pasta) para o bucket do Amazon S3. Isso se aplica somente às funções declaradas com o tipo de pacote Zip.

--save-params

Salva os parâmetros que você fornece na linha de comando no arquivo AWS SAM de configuração.

--skip-deploy-sync | --no-skip-deploy-sync

Especifica --skip-deploy-sync para ignorar a sincronização inicial da infraestrutura se ela não for necessária. Ele AWS SAMCLI comparará seu AWS SAM modelo local com o CloudFormation modelo implantado e executará uma implantação somente se uma alteração for detectada.

Especifica --no-skip-deploy-sync a realização de uma CloudFormation implantação sempre que sam sync for executada.

Para saber mais, consulte Ignore a implantação inicial CloudFormation.

Padrão: --skip-deploy-sync

--stack-name TEXT

O nome da CloudFormation pilha do seu aplicativo.

Essa opção é obrigatória.

--tags LIST

Uma lista de tags a serem associadas à pilha criada ou atualizada. 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-container, -u

Se suas funções dependerem de pacotes que tenham dependências compiladas de forma nativa, use essa opção para criar sua função dentro de um contêiner AWS Lambda semelhante Docker a.

nota

Atualmente, essa opção não é compatível com o --dependency-layer. Se você usa --use-container com --dependency-layer, AWS SAMCLI informa e continua com --no-dependency-layer.

--watch

Inicia um processo que monitora o aplicativo local em busca de alterações e as sincroniza automaticamente com o. Nuvem AWS Por padrão, quando você especifica essa opção, AWS SAM sincroniza todos os recursos em seu aplicativo à medida que você os atualiza. Com essa opção, AWS SAM executa uma CloudFormation implantação inicial. Em seguida, AWS SAM usa o AWS serviço APIs para atualizar os recursos de código. AWS SAM usa CloudFormation para atualizar recursos de infraestrutura quando você atualiza seu AWS SAM modelo.

--watch-exclude TEXT

Exclui um arquivo ou pasta da observação de alterações no arquivo. Para usar essa opção, --watch deverá ser fornecido.

Cada opção recebe um par de valores-chave:

  • Chave — O ID lógico de uma função do Lambda em seu aplicativo.

  • Valor — O nome do arquivo ou pasta associado a ser excluído.

Quando você atualiza quaisquer arquivos ou pastas especificados com a --watch-exclude opção, AWS SAM CLI eles não iniciarão uma sincronização. No entanto, quando uma atualização de outros arquivos ou pastas inicia uma sincronização, esses arquivos ou pastas serão incluídos nessa sincronização.

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

Exemplos

Para obter exemplos sobre como usar esse comando, consulte Opções para o comando sam sync.