sam sync

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 modelo AWS SAM.

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:

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 imagem do recipiente a partir 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.

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

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:

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

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

Uma lista de recursos que você especifica para permitir que CloudFormation crie certas pilhas. Alguns modelos de pilha podem incluir recursos que podem afetar as permissões em sua 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. Entre os valores válidos estão os seguintes:

Padrão: CAPABILITY_NAMED_IAM e CAPABILITY_AUTO_EXPAND

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:

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

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.

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.

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

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.

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.

O ID de uma chave (AWS KMS) do AWS Key Management Service usada para criptografar artefatos que estão em repouso no bucket do Amazon S3. Se não for especificada essa opção, AWS SAM usará chaves de criptografia gerenciadas pelo Amazon S3.

Um mapa de metadados para anexar a todos os artefatos que você faz referência no seu modelo.

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

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

Uma sequência que contém substituições de parâmetros CloudFormation codificados como pares chave-valor. Use o mesmo formato de 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:

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.

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.

O nome de recurso da Amazon (ARN) de um perfil do IAM que CloudFormation assume ao aplicar o conjunto de alterações.

O nome do bucket do Amazon Simple Storage Service (Amazon S3) no qual esse comando faz upload do 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.

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.

Salva os parâmetros fornecidos na linha de comando no arquivo de configuração AWS SAM.

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

Especifica --no-skip-deploy-sync para realizar uma implantação CloudFormation sempre que sam sync for executada.

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

Padrão: --skip-deploy-sync

O nome da pilha CloudFormation do seu aplicativo.

Essa opção é obrigatória.

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

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

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

Inicia um processo que monitora o aplicativo local em busca de alterações e as sincroniza automaticamente com 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 implantação CloudFormation inicial. Em seguida, AWS SAM usa APIs de serviço AWS para atualizar os recursos de código. AWS SAM usa CloudFormation para atualizar recursos de infraestrutura quando você atualiza seu modelo AWS SAM.

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:

Ao atualizar quaisquer arquivos ou pastas especificados com a opção --watch-exclude, o AWS SAM CLI não iniciará 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.