sam pipeline bootstrap - AWS Serverless Application Model
UtilisationOptionsRésolution des problèmesExemple

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

sam pipeline bootstrap

Cette page fournit des informations de référence pour l'interface de ligne de AWS Serverless Application Model commande (AWS SAM CLI) sam local pipeline bootstrap sous-commande.

Pour une introduction au AWS SAM CLI, voir Qu'est-ce que le AWS SAM CLI?

La sam pipeline bootstrap sous-commande génère les ressources AWS d'infrastructure requises pour se connecter à votre système CI/CD. Cette étape doit être exécutée pour chaque étape de déploiement du pipeline, avant d'exécuter la commande sam pipeline init.

Cette sous-commande configure les ressources AWS d'infrastructure suivantes :

  • Option de configuration des autorisations du pipeline via :

  • IAMRôle d' AWS CloudFormation exécution assumé par AWS CloudFormation le déploiement de l' AWS SAM application.

  • Un compartiment Amazon S3 pour contenir les AWS SAM artefacts.

  • Facultativement, un référentiel d'ECRimages Amazon pour contenir les packages de déploiement Lambda d'images de conteneur (si vous avez une ressource de type Image package).

Utilisation

$ sam pipeline bootstrap <options>

Options

--bitbucket-repo-uuid TEXT

Le UUID du dépôt Bitbucket. Cette option est spécifique à l'utilisation de Bitbucket OIDC pour les autorisations.

Note

Cette valeur se trouve à l'adresse https://bitbucket.org/workspace/repository/admin/addon/admin/pipelines/openid-connecter

--bucket TEXT

Celui ARN du compartiment Amazon S3 qui contient les AWS SAM artefacts.

--cicd-provider TEXT

La plate-forme CI/CD pour le AWS SAM pipeline.

--cloudformation-execution-role TEXT

Le ARN IAM rôle à assumer AWS CloudFormation lors du déploiement de la pile de l'application. Fournissez-le uniquement si vous voulez utiliser votre propre rôle. Sinon, la commande crée un nouveau rôle.

--config-env TEXT

Le nom d'environnement spécifiant les valeurs de paramètre par défaut dans le fichier de configuration à utiliser. La valeur par défaut est default. Pour plus d'informations sur les fichiers de configuration, consultez AWS SAM CLI Fichier de configuration  .

--config-file PATH

Le chemin d'accès et le nom du fichier de configuration contenant les valeurs de paramètres par défaut à utiliser. La valeur par défaut est samconfig.toml à la racine du répertoire du projet. Pour plus d'informations sur les fichiers de configuration, consultez AWS SAM CLI Fichier de configuration  .

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

Invitation à confirmer le déploiement de vos ressources.

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

Spécifiez s'il faut créer un référentiel ECR d'images Amazon si aucun n'est fourni. Le ECR référentiel Amazon contient les images de conteneur des fonctions Lambda, ou des couches dont le type de package est de. Image L’argument par défaut est --no-create-image-repository.

--debug

Active la journalisation du débogage et imprime les messages de débogage indiquant que AWS SAM CLI génère et pour afficher les horodatages.

--deployment-branch TEXT

Nom de la branche à partir de laquelle les déploiements seront effectués. Cette option est spécifique à l'utilisation GitHub des actions OIDC pour les autorisations.

--github-org TEXT

L' GitHub organisation à laquelle appartient le référentiel. Si aucune organisation n'existe, saisissez le nom d'utilisateur du propriétaire du référentiel. Cette option est spécifique à l'utilisation GitHub des actions OIDC pour les autorisations.

--github-repo TEXT

Nom du GitHub référentiel à partir duquel les déploiements seront effectués. Cette option est spécifique à l'utilisation GitHub des actions OIDC pour les autorisations.

--gitlab-group TEXT

Le GitLab groupe auquel appartient le référentiel. Cette option est spécifique à l'utilisation GitLab OIDC pour les autorisations.

--gitlab-project TEXT

Le nom GitLab du projet. Cette option est spécifique à l'utilisation GitLab OIDC pour les autorisations.

--help, -h

Affiche ce message, puis se ferme.

--image-repository TEXT

ARND'un référentiel d'ECRimages Amazon qui contient les images de conteneur des fonctions Lambda, ou des couches dont le type de package est de. Image S’il est fourni, l’option --create-image-repository est ignorée. S'il n'est pas fourni et que --create-image-repository est spécifié, la commande en crée un.

--interactive | --no-interactive

Désactivez l'invite interactive pour les paramètres d'amorçage et attendez si des paramètres requis sont manquants. La valeur par défaut est --interactive. Avec cette commande, --stage est le seul paramètre obligatoire.

Note

S'il --no-interactive est spécifié en même temps que--use-oidc-provider, tous les paramètres requis pour votre OIDC fournisseur doivent être inclus.

--oidc-client-id TEXT

L'ID client configuré pour être utilisé avec votre OIDC fournisseur.

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

Nom du fournisseur CI/CD qui sera utilisé pour les OIDC autorisations. GitLab, GitHub, et Bitbucket sont pris en charge.

--oidc-provider-url TEXT

Le URL pour le OIDC fournisseur. La valeur doit commencer par https://.

--permissions-provider [oidc | iam]

Choisissez un fournisseur d'autorisations pour assumer le rôle d'exécution du pipeline. La valeur par défaut est iam.

--pipeline-execution-role TEXT

Le ARN IAM rôle que doit assumer l'utilisateur du pipeline pour opérer à cette étape. Fournissez-le uniquement si vous voulez utiliser votre propre rôle. S'il n'est pas fourni, cette commande crée un nouveau rôle.

--pipeline-user TEXT

Nom de ressource Amazon (ARN) de l'IAMutilisateur dont l'ID de clé d'accès et la clé d'accès secrète sont partagés avec le système CI/CD. Il est utilisé pour accorder à cet IAM utilisateur l'autorisation d'accéder au AWS compte correspondant. Si elle n'est pas fournie, la commande créera un IAM utilisateur avec l'ID de la clé d'accès et les informations d'identification de la clé d'accès secrète.

--profile TEXT

Le profil spécifique de votre fichier d'informations d'identification qui obtient les AWS informations d'identification.

--region TEXT

AWS Région dans laquelle le déploiement doit être effectué. Par exemple, us-east-1.

--save-params

Enregistrez les paramètres que vous fournissez sur la ligne de commande dans le fichier AWS SAM de configuration.

--stage TEXT

Le nom de l’étape de déploiement correspondante. Il est utilisé comme suffixe pour les ressources AWS d'infrastructure créées.

Résolution des problèmes

Error: Missing required parameter (Erreur : paramètre requis manquant)

Quand --no-interactive est spécifié avec --use-oidc-provider et qu'aucun des paramètres requis n'est fourni, ce message d'erreur s'affiche avec une description des paramètres manquants.

Exemple

L'exemple suivant crée les AWS ressources nécessaires à la création de votre système CI/CD, active la journalisation du débogage et imprime les messages de débogage générés par le AWS SAM CLI: utilise un événement généré pour les tests locaux en utilisant un s3.json événement pour appeler une fonction Lambda localement

$ sam pipeline bootstrap --debug