sam pipeline bootstrap - AWS Serverless Application Model
UsoOpçõesSolução de problemasExemplo

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 pipeline bootstrap

Esta página fornece informações de referência para o subcomando Interface da Linha de Comando (AWS SAM CLI) sam local pipeline bootstrap do AWS Serverless Application Model.

Para obter uma introdução à CLI do AWS SAM, consulte O que é o AWS SAMCLI?

O subcomando sam pipeline bootstrap gera os recursos de infraestrutura AWS necessários para se conectar ao seu sistema de CI/CD. Essa etapa deve ser executada em cada estágio de implantação em seu pipeline antes de executar o comando sam pipeline init.

Esse subcomando configura os seguintes recursos de infraestrutura AWS:

  • Opção de configurar as permissões do pipeline por meio de:

  • Uma função CloudFormation de execução do perfil do IAM assumida pela CloudFormation para implantar o aplicativo AWS SAM.

  • Um bucket Amazon S3 para armazenar os artefatos AWS SAM.

  • Opcionalmente, um repositório de imagens do Amazon ECR para armazenar pacotes de implantação Lambda de imagens de contêiner (se você tiver um recurso do tipo de pacote Image).

Uso

$ sam pipeline bootstrap <options>

Opções

--bitbucket-repo-uuid TEXT

O UUID do repositório do Bitbucket. Essa opção é específica ao uso do Bitbucket OIDC para obter permissões.

nota

Esse valor pode ser encontrado em https://bitbucket.org/ workspace/repository /admin/addon/admin/pipelines/openid-connect

--bucket TEXT

O ARN do bucket do Amazon S3 que contém os artefatos AWS SAM.

--cicd-provider TEXT

A plataforma CI/CD para o pipeline AWS SAM.

--cloudformation-execution-role TEXT

O ARN do perfil do IAM a ser assumida pelo CloudFormation durante a implantação da pilha do aplicativo. Forneça somente se quiser usar sua própria função. Caso contrário, o comando criará uma nova função.

--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 os 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 da implantação de seus recursos.

--create-image-repository | --no-create-image-repository

Especifique se deseja criar um repositório de imagens do Amazon ECR se nenhum for fornecido. O repositório Amazon ECR contém as imagens de contêiner das funções do Lambda, ou camadas com um tipo de pacote de Image. O padrão é “”. --no-create-image-repository.

--debug

Ativa o registro de depuração e imprime as mensagens de depuração que o AWS SAM CLI gera e para exibir timestamps.

--deployment-branch TEXT

Nome da filial a partir da qual as implantações ocorrerão. Essa opção é específica para usar o OIDC do GitHub Actions para obter permissões.

--github-org TEXT

A organização do GitHub à qual o repositório pertence. Se nenhuma organização existir, insira o nome de usuário do proprietário do repositório. Essa opção é específica para usar o OIDC do GitHub Actions para obter permissões.

--github-repo TEXT

Nome do repositório do GitHub a partir do qual as implantações ocorrerão. Essa opção é específica para usar o OIDC do GitHub Actions para obter permissões.

--gitlab-group TEXT

O grupo GitLab ao qual o repositório pertence. Essa opção é específica ao uso do GitLab OIDC para obter permissões.

--gitlab-project TEXT

O nome do projeto GitLab. Essa opção é específica ao uso do GitLab OIDC para obter permissões.

--help, -h

Mostra esta mensagem e sai.

--image-repository TEXT

O ARN de um repositório de imagens do Amazon ECR que contém as imagens de contêiner das funções do Lambda, ou camadas que têm um tipo de pacote de Image. Se fornecidas, as opções --create-image-repository serão ignoradas. Se não for fornecido e --create-image-repository for especificado, o comando cria um.

--interactive | --no-interactive

Desative a solicitação interativa para parâmetros de bootstrap e falhe se algum parâmetro necessário estiver ausente. O valor padrão é --interactive. Para esse comando, --stage é o único parâmetro obrigatório.

nota

Se --no-interactive for especificado junto com --use-oidc-provider, todos os parâmetros necessários para seu provedor de OIDC devem ser incluídos.

--oidc-client-id TEXT

O ID do cliente configurado para uso com seu provedor OIDC.

--oidc-provider [github-actions | gitlab | bitbucket-pipelines]

Nome do provedor de CI/CD que será usado para permissões do OIDC. O GitLab, o GitHub e o Bitbucket são compatíveis.

--oidc-provider-url TEXT

O URL do provedor de OIDC. O valor deve começar com https://.

--permissions-provider [oidc | iam]

Escolha um provedor de permissões para assumir a função de execução do pipeline. O valor padrão é iam.

--pipeline-execution-role TEXT

O ARN do perfil do IAM a ser assumida pelo usuário do pipeline para operar nesse estágio. Forneça somente se quiser usar sua própria função. Se não for fornecido, esse comando criará uma nova função.

--pipeline-user TEXT

O nome de recurso da Amazon (ARN) do usuário do IAM com o ID da chave de acesso e a chave de acesso secreta compartilhados com o sistema CI/CD. Ele é usado para conceder permissão a esse usuário do IAM para acessar a conta da AWS correspondente. Se não for fornecido, o comando criará um usuário do IAM junto com o ID da chave de acesso e as credenciais da chave de acesso secreta.

--profile TEXT

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

--region TEXT

A região AWS para a qual implantar. Por exemplo, us-east-1.

--save-params

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

--stage TEXT

O nome do estágio de implantação correspondente. Ele é usado como um sufixo para os recursos de infraestrutura AWS criados.

Solução de problemas

Erro: Falta o parâmetro necessário

Quando --no-interactive for especificado junto com --use-oidc-provider e nenhum dos parâmetros necessários for fornecido, essa mensagem de erro será exibida junto com uma descrição dos parâmetros ausentes.

Exemplo

O exemplo a seguir cria os recursos da AWS necessários para a criação do sistema de CI/CD e ativa o registro em log de depuração e imprime mensagens de depuração geradas pela CLI do AWS SAM: usa um evento gerado para testes locais usando um evento s3.json para invocar uma função do Lambda localmente.

$ sam pipeline bootstrap --debug