View a markdown version of this page

bootstrap do mesmo pipeline - 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á.

bootstrap do mesmo pipeline

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

Para uma introdução ao AWS SAM CLI, veja O que é o AWS SAM CLI?

O sam pipeline bootstrap o subcomando gera o necessário AWS recursos de infraestrutura para se conectar ao seu CI/CD sistema. 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 o seguinte AWS recursos de infraestrutura:

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

  • Um CloudFormation função de execução do IAM assumida por CloudFormation para implantar o AWS SAM aplicativo.

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

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

Importante

Não corra sam pipeline bootstrap com um arquivo de configuração não confiável. O provedor OIDC e as configurações de permissão do arquivo determinam quem pode assumir as funções do IAM que esse comando cria.

Usage

$ 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 o AWS SAM artefatos.

--cicd-provider TEXT

O CI/CD plataforma para o AWS SAM oleoduto.

--cloudformation-execution-role TEXT

O ARN da função do IAM a ser assumida por CloudFormation ao implantar a 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 do Lambda Event Functions, 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 SAMCLI 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 GitHub Ações OIDC para permissões.

--github-org TEXT

O GitHub organização à 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 GitHub Ações OIDC para permissões.

--github-repo TEXT

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

--gitlab-group TEXT

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

--gitlab-project TEXT

O GitLab nome do projeto. Essa opção é específica para usar GitLab OIDC para 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 CI/CD provedor que será usado para permissões do OIDC. GitLab, GitHub, e o Bitbucket são suportados.

--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 seu ID de chave de acesso e chave de acesso secreta compartilhados com o CI/CD sistema. Ele é usado para conceder a esse usuário do IAM permissão para acessar o correspondente AWS conta. 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 recebe AWS credenciais.

--region TEXT

O AWS Região para a qual implantar. Por exemplo, .us-east-1

--save-params

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

--stage TEXT

O nome do estágio de implantação correspondente. É usado como sufixo para o criado AWS recursos de infraestrutura.

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 o AWS recursos necessários para criar seu CI/CD sistema, e ativa o registro de depuração e imprime as mensagens de depuração geradas pelo AWS SAM CLI: usa um evento gerado para testes locais usando um s3.json evento para invocar uma função Lambda localmente

$ sam pipeline bootstrap --debug