sam pipeline bootstrap

Esta página proporciona información de referencia para el comando sam local pipeline bootstrap de la interfaz de línea de subcomandos AWS Serverless Application Model (AWS SAM CLI).

Para obtener una introducción a la CLI de AWS SAM, consulte ¿Qué es el? AWS SAMCLI.

El subcomando sam pipeline bootstrap genera los recursos de infraestructura de AWS necesarios para conectarse a su sistema de CI/CD. 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 los siguientes recursos de infraestructura de AWS:

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

  • Un usuario de IAM de canalización con un ID de clave de acceso y unas credenciales de acceso con clave secreta para compartirlas con el sistema CI/CD.

    nota

    Recomendamos rotar periódicamente las claves de acceso de forma regular. Para obtener más información, consulte Rotar las claves de acceso periódicamente para casos de uso que requieran credenciales de larga duración en la Guía del usuario de IAM.

  • Plataformas CI/CD compatibles a través del OIDC. Para obtener una introducción sobre el uso de OIDC con la canalización AWS SAM, vaya a Uso de la autenticación OIDC con canalización de AWS SAM.

• Un rol de IAM de ejecución de AWS CloudFormation que asume AWS CloudFormation para implementar la aplicación AWS SAM.

• Un bucket de Amazon S3 para guardar los artefactos de AWS SAM.

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

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 encuentra en https://bitbucket.org/workspace/repository/admin/addon/admin/pipelines/openid-connect

--bucket TEXT

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

--cicd-provider TEXT

La plataforma de CI/CD para la canalización de AWS SAM.

--cloudformation-execution-role TEXT

El ARN del rol de IAM que debe asumir AWS CloudFormation al implementar la pila de aplicaciones. Indíquelo 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, consulte 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, consulte 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

Especifique si quiere crear un repositorio de imágenes de Amazon ECR si no se proporciona ninguno. En el repositorio de Amazon ECR se encuentran las imágenes de contenedor de las funciones o capas de Lambda que tienen 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 del uso de GitHub Actions OIDC para los permisos.

--github-org TEXT

La 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 del uso de GitHub Actions OIDC para los permisos.

--github-repo TEXT

Nombre del GitHub repositorio desde el que se realizarán las implementaciones. Esta opción es específica del uso de GitHub Actions OIDC para los permisos.

--gitlab-group TEXT

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

--gitlab-project TEXT

El nombre del GitLab proyecto. Esta opción es específica del uso de 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 proveedor de CI/CD que se utilizará para los permisos de OIDC. GitLab, y GitHub 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. Indíquelo 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 que comparte su ID de clave de acceso y su clave de acceso secreta con el sistema CI/CD. Se utiliza para conceder permiso a este usuario de IAM para acceder a la cuenta de AWS correspondiente. 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 las credenciales de AWS.

--region TEXT

La región de AWS en la que se va a realizar la implementación. Por ejemplo, us-east-1.

--save-params

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

--stage TEXT

El nombre de la fase de implementación correspondiente. Se utiliza como sufijo para los recursos de infraestructura de AWS creados.

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