View a markdown version of this page

amorçage pipeline sam - AWS Serverless Application Model

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.

amorçage pipeline sam

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

Pour une introduction à AWS SAM CLI, voir Qu'est-ce que AWS SAM INTERFACE DE LIGNE DE COMMANDE (CLI)?

Le sam pipeline bootstrap la sous-commande génère la commande requise AWS ressources d'infrastructure pour vous connecter à votre CI/CD système. 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 éléments suivants AWS ressources d'infrastructure :

  • Option de configuration des autorisations du pipeline via :

  • Un CloudFormation rôle IAM d'exécution assumé par CloudFormation pour déployer le AWS SAM candidature.

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

  • Le cas échéant, un référentiel d’images Amazon ECR pour contenir des packages de déploiement Lambda de conteneur d’images (si vous disposez d’une ressource avec le type de package Image).

Important

Ne courez pas sam pipeline bootstrap avec un fichier de configuration non fiable. Le fournisseur OIDC et les paramètres d'autorisation du fichier déterminent qui peut assumer les rôles IAM créés par cette commande.

Usage

$ sam pipeline bootstrap <options>

Options

--bitbucket-repo-uuid TEXT

L'UUID du référentiel Bitbucket. Cette option est spécifique à l'utilisation d'OIDC avec Bitbucket pour les autorisations.

Note

Cette valeur se trouve à https://bitbucket.org/workspace/repository/admin/addon/admin/pipelines/openid-connect

--bucket TEXT

L'ARN du compartiment Amazon S3 qui contient le AWS SAM artefacts.

--cicd-provider TEXT

Le CI/CD plateforme pour AWS SAM oléoduc.

--cloudformation-execution-role TEXT

L'ARN du rôle IAM à assumer par 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 Fichier de configuration CLI AWS SAM.

--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 Fichier de configuration CLI AWS SAM.

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

Invitation à confirmer le déploiement de vos ressources.

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

Indiquez si vous souhaitez créer un référentiel d’images Amazon ECR si aucun n’est fourni. Le référentiel Amazon ECR contient les images de conteneur de Lambda Event Functions, ou des couches dont le type de package est Image. La valeur par défaut est --no-create-image-repository.

--debug

Active la journalisation de débogage, imprime les messages de débogage générés par la CLI  AWS SAM et affiche 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 Actions OIDC pour les autorisations.

--github-org TEXT

Le 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 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 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 GitLab nom 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

L'ARN d'un référentiel d'images Amazon ECR contenant les images de conteneur des fonctions Lambda ou des couches avec un type de package 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

Si --no-interactive est spécifié avec --use-oidc-provider, tous les paramètres requis pour votre fournisseur OIDC doivent être inclus.

--oidc-client-id TEXT

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

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

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

--oidc-provider-url TEXT

URL du fournisseur OIDC. 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

L’ARN du rôle IAM devant être assumé par l’utilisateur de pipeline pour fonctionner sur 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

Le nom de ressource Amazon (ARN) de l'utilisateur IAM dont l'ID de clé d'accès et la clé d'accès secrète sont partagés avec CI/CD système. Il est utilisé pour accorder à cet utilisateur IAM l'autorisation d'accéder au AWS compte. S'il n'est pas fourni, la commande crée un utilisateur IAM avec l'identifiant de la clé d'accès et les informations d'identification de clé d'accès secrète.

--profile TEXT

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

--region TEXT

Le AWS Région dans laquelle déployer. Par exemple : us-east-1.

--save-params

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

--stage TEXT

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

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 le AWS ressources nécessaires à la création de votre CI/CD système, et il active la journalisation du débogage et affiche les messages de débogage générés par AWS SAM CLI: utilise un événement généré pour les tests locaux à l'aide d'un s3.json événement pour invoquer une fonction Lambda localement

$ sam pipeline bootstrap --debug