View a markdown version of this page

sam pipeline bootstrap - AWS Serverless Application Model

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

sam pipeline bootstrap

Esta página proporciona información de referencia para AWS Serverless Application Model Interfaz de línea de comandos (AWS SAM CLI) sam local pipeline bootstrap subcomando.

Para una introducción a la AWS SAM CLI, véase ¿Qué es el AWS SAM CLI?

El sam pipeline bootstrap el subcomando genera lo requerido AWS recursos de infraestructura para conectarse a su CI/CD sistema. Este paso debe ejecutarse en cada etapa de implementación de la canalización antes de ejecutar el comando sam pipeline init.

Este subcomando configura lo siguiente AWS recursos de infraestructura:

  • Opción de configurar los permisos de canalización mediante:

  • Un CloudFormation rol de ejecución de IAM asumido por CloudFormation para implementar el AWS SAM aplicación.

  • Un bucket de Amazon S3 para almacenar el AWS SAM artefactos.

  • Opcionalmente, un repositorio de imágenes de Amazon ECR para almacenar paquetes de implementación de Lambda con imágenes de contenedor (si tiene un recurso del tipo de paquete Image).

importante

No corras sam pipeline bootstrap con un archivo de configuración que no es de confianza. El proveedor OIDC y la configuración de permisos del archivo determinan quién puede asumir las funciones de IAM que crea este comando.

De uso

$ sam pipeline bootstrap <options>

Opciones

--bitbucket-repo-uuid TEXT

El UUID del repositorio de Bitbucket. Esta opción es específica del uso de Bitbucket OIDC para permisos.

nota

Este valor se puede encontrar en https://bitbucket.org/workspace/repository/admin/addon/admin/pipelines/openid-connect

--bucket TEXT

El ARN del bucket de Amazon S3 que contiene el AWS SAM artefactos.

--cicd-provider TEXT

El CI/CD plataforma para el AWS SAM oleoducto.

--cloudformation-execution-role TEXT

El ARN de la función de IAM que asumirá CloudFormation al implementar la pila de aplicaciones. índícalo solo si quiere utilizar su propio rol. De lo contrario, el comando creará un nuevo rol.

--config-env TEXT

El nombre del entorno que especifica los valores de los parámetros predeterminados del archivo de configuración que se va a utilizar. El valor predeterminado es default. Para obtener más información sobre los archivos de configuración, consulta Archivo de configuración de la CLI de AWS SAM.

--config-file PATH

La ruta y el nombre del archivo de configuración que contiene los valores de los parámetros predeterminados que se van a utilizar. El valor por defecto es samconfig.toml en la raíz del directorio del proyecto. Para obtener más información sobre los archivos de configuración, consulta Archivo de configuración de la CLI de AWS SAM.

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

Permite solicitar la confirmación de la implementación de los recursos.

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

Especifica si quiere crear un repositorio de imágenes de Amazon ECR si no se proporciona ninguno. El repositorio de Amazon ECR contiene las imágenes contenedoras de Lambda Event Functions o capas con un tipo de paquete de Image. El valor predeterminado es --no-create-image-repository.

--debug

Activa el registro de depuración e imprime los mensajes de depuración que genera la CLI de AWS SAM, además de mostrar las marcas de tiempo.

--deployment-branch TEXT

Nombre de la rama desde la que se realizarán las implementaciones. Esta opción es específica para usar GitHub Acciones OIDC para obtener permisos.

--github-org TEXT

El GitHub organización a la que pertenece el repositorio. Si no existe ninguna organización, escriba el nombre de usuario del propietario del repositorio. Esta opción es específica para usar GitHub Acciones OIDC para obtener permisos.

--github-repo TEXT

Nombre del GitHub repositorio desde el que se realizarán las implementaciones. Esta opción es específica para usar GitHub Acciones OIDC para obtener permisos.

--gitlab-group TEXT

El GitLab grupo al que pertenece el repositorio. Esta opción es específica para usar GitLab OIDC para los permisos.

--gitlab-project TEXT

El GitLab nombre del proyecto. Esta opción es específica para usar GitLab OIDC para los permisos.

--help, -h

Muestra este mensaje y sale.

--image-repository TEXT

El ARN de un repositorio de imágenes de Amazon ECR en el que se encuentran las imágenes de contenedor de las funciones de Lambda o las capas que tienen un tipo de paquete de Image. Si se proporcionan, se ignora la opción --create-image-repository. Si no se proporciona y --create-image-repository se especifica, el comando crea una.

--interactive | --no-interactive

Se deshabilita la solicitud interactiva de los parámetros de arranque y devuelve un error si falta alguno de los parámetros necesarios. El valor predeterminado es --interactive. Para este comando, --stage es el único parámetro requerido.

nota

Si --no-interactive se especifica junto con --use-oidc-provider, se deben incluir todos los parámetros necesarios de su proveedor de OIDC.

--oidc-client-id TEXT

El ID de cliente configurado para su uso con su proveedor de OIDC.

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

Nombre del CI/CD proveedor que se utilizará para los permisos de OIDC. GitLab, GitHub, y Bitbucket son compatibles.

--oidc-provider-url TEXT

La dirección URL del emisor del proveedor OIDC. El valor debe empezar por https://.

--permissions-provider [oidc | iam]

Elija un proveedor de permisos para que asuma la función de ejecución de la canalización. El valor predeterminado es iam.

--pipeline-execution-role TEXT

El ARN del rol de IAM que asumirá el usuario de la canalización y que usará en esta etapa. índícalo solo si quiere utilizar su propio rol. Si no se proporciona, este comando creará un nuevo rol.

--pipeline-user TEXT

El nombre de recurso de Amazon (ARN) del usuario de IAM, cuyo identificador de clave de acceso y clave de acceso secreta están compartidos con el CI/CD sistema. Se utiliza para conceder a este usuario de IAM el permiso de acceso al correspondiente AWS cuenta. Si no se proporciona, el comando creará un usuario de IAM junto con el ID de clave de acceso y las credenciales de clave de acceso secreta.

--profile TEXT

El perfil específico de su archivo de credenciales que obtiene AWS credenciales.

--region TEXT

El AWS Región en la que realizar el despliegue. Por ejemplo, us-east-1.

--save-params

Guarde los parámetros que proporciona en la línea de comandos en AWS SAM archivo de configuración.

--stage TEXT

El nombre de la fase de implementación correspondiente. Se usa como sufijo para el creado AWS recursos de infraestructura.

Resolución de problemas

Error: falta el parámetro obligatorio

Si --no-interactive se especifica junto con --use-oidc-provider y ninguno de los parámetros requeridos se proporciona, se mostrará este mensaje de error junto con una descripción de los parámetros que faltan.

Ejemplo

El siguiente ejemplo crea la AWS recursos necesarios para crear su CI/CD sistema, y activa el registro de depuración e imprime los mensajes de depuración generados por el AWS SAM CLI: usa un evento generado para las pruebas locales mediante el uso de un s3.json evento para invocar una función Lambda localmente

$ sam pipeline bootstrap --debug