View a markdown version of this page

synchronisation avec 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.

synchronisation avec sam

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

La commande sam sync synchronise les modifications apportées de l’application locale à AWS Cloud.

Important

Ne courez pas sam sync sur un code non fiable. La commande crée le projet dans votre environnement local, qui exécute les outils de génération et les scripts définis par le projet. Il déploie ensuite les ressources du modèle sur votre AWS compte avec vos informations d'identification.

Usage

$ sam sync <options>

Options

--base-dir, -s DIRECTORY

Résout les chemins relatifs au code source de la fonction ou de la couche par rapport à ce répertoire. Utilisez cette option pour modifier la façon dont les chemins d'accès relatifs aux dossiers de code source sont résolus. Par défaut, les chemins relatifs sont résolus par rapport à AWS SAM emplacement du modèle.

Outre les ressources de l'application ou de la pile racine que vous créez, cette option s'applique également aux applications ou piles imbriquées. En outre, cette option s'applique aux types de ressources et propriétés suivants :

  • Type de ressource : propriété AWS::Serverless::Function : CodeUri

  • Type de ressource : attribut de ressource AWS::Serverless::Function : entrée Metadata : DockerContext

  • Type de ressource : propriété AWS::Serverless::LayerVersion : ContentUri

  • Type de ressource : propriété AWS::Lambda::Function : Code

  • Type de ressource : propriété AWS::Lambda::LayerVersion : Content

--build-image TEXT

L'URI de l'image de conteneur que vous souhaitez utiliser lors de la création de votre application. Par défaut, AWS SAM utilise l'URI du référentiel d'images de conteneur provenant de Registre Amazon Elastic Container (Amazon ECR) public. Spécifiez cette option pour utiliser une autre image.

Vous pouvez utiliser cette option plusieurs fois au sein d'une même commande. Chaque option accepte une chaîne de caractères ou une paire clé-valeur.

  • Chaîne de caractères : si vous spécifiez une chaîne de caractères, il s'agit de l'URI de l'image de conteneur qui sera utilisée par toutes les ressources de l'application. En voici un exemple :

    $ sam sync --build-image amazon/aws-sam-cli-build-image-python3.8
  • Key-value paire — Spécifiez le nom de la ressource comme clé et l'URI de l'image de conteneur à utiliser avec cette ressource comme valeur. Utilisez ce format pour spécifier un URI d'image de conteneur différent pour chaque ressource de votre application. Voici un exemple :

    $ sam sync --build-image Function1=amazon/aws-sam-cli-build-image-python3.8

Cette option ne s’applique que si l’option --use-container est spécifiée, dans le cas contraire, une erreur se produit.

--build-in-source | --no-build-in-source

Fournit --build-in-source pour créer votre projet directement dans le dossier source.

L'option --build-in-source prend en charge les systèmes d’exécution ainsi que les méthodes de création suivantes :

  • exécutions : toute méthode d’exécution Node.js prise en charge par l'option sam init --runtime.

  • Méthodes de construction : Makefile, esbuild.

L'option --build-in-source n'est pas compatible avec celles suivantes :

  • --use-container

Par défaut : --no-build-in-source

--capabilities LIST

Liste des fonctionnalités que vous spécifiez pour autoriser CloudFormation pour créer certaines piles. Certains modèles de pile peuvent inclure des ressources susceptibles d'affecter les autorisations dans votre Compte AWS. Par exemple, en créant de nouveaux Gestion des identités et des accès AWS utilisateurs (IAM). Spécifiez cette option pour remplacer les valeurs par défaut. Les valeurs valides sont les suivantes :

  • CAPABILITY_IAM

  • CAPABILITY_NAMED_IAM

  • CAPABILITY_RESOURCE_POLICY

  • CAPABILITY_AUTO_EXPAND

Par défaut : CAPABILITY_NAMED_IAM et CAPABILITY_AUTO_EXPAND

--code

Par défaut, AWS SAM synchronise toutes les ressources de votre application. Spécifiez cette option pour synchroniser uniquement les ressources de code, qui comprennent les éléments suivants :

  • AWS::Serverless::Function

  • AWS::Lambda::Function

  • AWS::Serverless::LayerVersion

  • AWS::Lambda::LayerVersion

  • AWS::Serverless::Api

  • AWS::ApiGateway::RestApi

  • AWS::Serverless::HttpApi

  • AWS::ApiGatewayV2::Api

  • AWS::Serverless::StateMachine

  • AWS::StepFunctions::StateMachine

Pour synchroniser les ressources de code, AWS SAM les usages AWS API de service directement, au lieu de les déployer via AWS CloudFormation. Pour mettre à jour votre CloudFormation empiler, exécuter sam sync --watch ou sam deploy.

--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 « par défaut ». 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 » dans la racine du répertoire du projet. Pour plus d’informations sur les fichiers de configuration, consultez Fichier de configuration CLI AWS SAM.

--dependency-layer | --no-dependency-layer

Spécifie s'il faut séparer les dépendances des fonctions individuelles dans une autre couche pour accélérer le processus de synchronisation.

Un AWS::Serverless::WebFunction ne peut pas utiliser de couches, ses dépendances restent donc toujours dans son package de déploiement.

Par défaut : --dependency-layer

--express | --no-express

Spécifie s'il faut utiliser CloudFormation Mode Express pour les déploiements d'infrastructures. Lorsqu'elle est active, les opérations de pile se terminent une fois que la configuration des ressources est appliquée. Les ressources continuent d'être prêtes en arrière-plan.

Le mode Express s'applique uniquement au chemin de synchronisation de l'infrastructure. Code-only contournement des synchronisations (mises à jour de la fonction Lambda Event, déploiements) CloudFormation et ne sont pas concernés par cette option.

La valeur par défaut est --no-express.

Modification par défaut à venir

La valeur par défaut passe à --express le 1er septembre 2026.

--image-repository TEXT

Le nom du référentiel Amazon Elastic Container Registry (Amazon ECR) vers lequel cette commande télécharge l’image de la fonction. Requis pour les fonctions déclarées avec le type de package Image.

--image-repositories TEXT

Un mappage des fonctions vers l'URI de leur référentiel Amazon ECR. Référencez les fonctions par leur identifiant logique. Voici un exemple :

$ sam sync --image-repositories Function1=123456789012.dkr.ecr.us-east-1.amazonaws.com/my-repo

Vous pouvez spécifier cette option plusieurs fois au sein d'une même commande.

--kms-key-id TEXT

L'identifiant d'un AWS Key Management Service (AWS KMS) clé utilisée pour chiffrer les artefacts qui sont au repos dans le compartiment Amazon S3. Si vous ne spécifiez pas cette option, AWS SAM utilise Amazon S3-managed clés de chiffrement.

--metadata

Un mappage de métadonnées à attacher à tous les artefacts que vous référencez dans votre modèle.

--notification-arns LIST

Une liste des rubriques Amazon Simple Notification Service (Amazon SNS) qui CloudFormation s'associe à la pile.

--no-use-container

Option qui vous permet d'utiliser la boîte à outils IDE pour définir le comportement par défaut.

--parameter-overrides

Une chaîne qui contient CloudFormation les remplacements de paramètres sont codés sous forme de paires clé-valeur. Utilisez le même format que AWS Command Line Interface (AWS CLI). Le AWS SAM CLI format correspond à des mots-clés clé et valeur explicites, chaque remplacement est séparé par un espace. Voici deux exemples :

  • --parameter-overrides ParameterKey=hello,ParameterValue=world

  • --parameter-overrides ParameterKey=hello,ParameterValue=world ParameterKey=example1,ParameterValue=example2 ParameterKey=apple,ParameterValue=banana

--resource TEXT

Spécifie le type de ressource à synchroniser. Pour synchroniser plusieurs ressources, vous pouvez spécifier cette option plusieurs fois. Cette option est prise en charge avec l'option --code. La valeur doit correspondre à l'une des ressources répertoriées sous --code. Par exemple : --resource AWS::Serverless::Function --resource AWS::Serverless::LayerVersion.

--resource-id TEXT

Spécifie l’identifiant de la ressource à synchroniser. Pour synchroniser plusieurs ressources, vous pouvez spécifier cette option plusieurs fois. Cette option est prise en charge avec l'option --code. Par exemple : --resource-id Function1 --resource-id Function2.

--role-arn TEXT

Le nom de ressource Amazon (ARN) d'un rôle IAM qui CloudFormation suppose lors de l'application du changeset.

--s3-bucket TEXT

Le nom du compartiment Amazon Simple Storage Service (Amazon S3) dans lequel cette commande télécharge votre CloudFormation modèle. Si le modèle est supérieur à 51 200 octets, le --s3-bucket ou l’option --resolve-s3 sont obligatoires. Si vous spécifiez les deux options --s3-bucket et --resolve-s3, une erreur se produit.

Si vous spécifiez cette option, le code d'un AWS::Serverless::WebFunction est également chargé dans ce compartiment. Sinon, il est chargé dans un compartiment de code qui appartient à la pile. Pour plus d’informations, consultez Création et déploiement de fonctions Web Lambda.

--s3-prefix TEXT

Le préfixe ajouté aux noms des artefacts que vous chargez dans le compartiment Amazon S3. Le nom du préfixe est un nom de chemin d’accès (nom de dossier) pour le compartiment Amazon S3. Cela s'applique uniquement aux fonctions déclarées avec le type de package Zip.

--save-params

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

--skip-deploy-sync | --no-skip-deploy-sync

Spécifie --skip-deploy-sync pour ignorer la synchronisation initiale de l'infrastructure si elle n'est pas requise. Le AWS SAM CLI comparera votre local AWS SAM modèle avec le déploiement CloudFormation modélisez et effectuez un déploiement uniquement si une modification est détectée.

Spécifie --no-skip-deploy-sync pour effectuer une CloudFormation déploiement à chaque fois sam sync est exécuté.

Pour en savoir plus, consultez Ignorez l'initiale CloudFormation déploiement.

Par défaut : --skip-deploy-sync

--stack-name TEXT

Le nom du CloudFormation pile pour votre application.

Cette option est obligatoire.

--tags LIST

Liste de balises à associer à la pile créée ou mise à jour. CloudFormation propage également ces balises aux ressources de la pile qui les prennent en charge.

--template-file, --template, -t PATH

Le chemin et le nom du fichier où se trouve votre AWS SAM le modèle est situé.

Note

Si vous spécifiez cette option, AWS SAM déploie uniquement le modèle et les ressources locales vers lesquelles il pointe.

--use-container, -u

Si vos fonctions dépendent de packages dont les dépendances sont compilées de manière native, utilisez cette option pour créer votre fonction dans un AWS Lambda like Docker contenant.

Note

Actuellement, cette option n'est pas compatible avec --dependency-layer. Si vous utilisez --use-container avec --dependency-layer, la CLI  AWS SAM vous en informe et continue avec --no-dependency-layer.

--watch

Lance un processus qui surveille les modifications apportées à votre application locale et les synchronise automatiquement avec AWS Cloud. Par défaut, lorsque vous spécifiez cette option, AWS SAM synchronise toutes les ressources de votre application lorsque vous les mettez à jour. Avec cette option, AWS SAM effectue une première CloudFormation déploiement. Ensuite, AWS SAM les usages AWS API de service pour mettre à jour les ressources de code. AWS SAM les usages CloudFormation pour mettre à jour les ressources de l'infrastructure lorsque vous mettez à jour votre AWS SAM modèle.

Le code d'un AWS::Serverless::WebFunction n'est pas surveillé, car chaque modification de code crée une nouvelle révision. Les modifications de code sont déployées lors de la prochaine synchronisation de l'infrastructure.

--watch-exclude TEXT

Empêche un fichier ou un dossier d’être observé en cas de modification de fichier. Pour utiliser cette option, --watch doit également être fournie.

Cette option reçoit une paire clé-valeur :

  • clé : ID logique d'une fonction Lambda dans votre application.

  • valeur : nom du fichier ou du dossier associé à exclure.

Lorsque vous mettez à jour des fichiers ou des dossiers spécifiés avec --watch-exclude option, le AWS SAM CLI ne lancera pas de synchronisation. Toutefois, lorsqu'une mise à jour d'autres fichiers ou dossiers initie une synchronisation, ceux-ci ou sont inclus dans cette synchronisation.

Vous pouvez fournir cette option plusieurs fois dans une seule commande.

Exemples

Pour des exemples d'utilisation de cette commande, reportez-vous à Options pour la commande sam sync.