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.
déploiement sam
Cette page fournit des informations de référence pour AWS Serverless Application Model Interface de ligne de commande (AWS SAM CLI) sam deploy commande.
-
Pour une introduction à AWS SAM CLI, voir Qu'est-ce que AWS SAM INTERFACE DE LIGNE DE COMMANDE (CLI)?
-
Pour obtenir de la documentation sur l'utilisation du AWS SAM CLI
sam deploycommande, voir Présentation du déploiement avec AWS SAM.
Le sam deploy la commande déploie une application sur AWS Cloud en utilisant AWS CloudFormation.
Ne courez pas sam deploy sur un code non fiable. La commande utilise votre AWS informations d'identification pour créer les ressources définies par le modèle, y compris les rôles et les politiques IAM, et télécharge les fichiers locaux auxquels le modèle fait référence. Il applique également les options du fichier de configuration du projet tel qu'il est écrit. Passez en revue le modèle et le fichier de configuration avant de déployer un projet dont vous n'êtes pas l'auteur.
Usage
$<environment variables>sam deploy<options>
Variables d’environnement
SAM_CLI_POLL_DELAY-
Réglez le
SAM_CLI_POLL_DELAYvariable d'environnement avec une valeur en secondes dans votre shell pour configurer la fréquence AWS L'interface de ligne de commande SAM vérifie le CloudFormation état de la pile, ce qui est utile lorsque vous constatez une limitation de CloudFormation. Cette variable d'environnement est utilisée pour le sondagedescribe_stackLes appels d'API, qui sont effectués pendant l'exécutionsam deploy.Voici un exemple de cette variable :
$SAM_CLI_POLL_DELAY=5sam deploy
Options
--capabilitiesLIST-
Liste des fonctionnalités que vous devez spécifier pour autoriser CloudFormation pour créer certaines piles. Certains modèles de pile peuvent inclure des ressources qui affectent les autorisations dans votre Compte AWS, par exemple, en créant de nouveaux Gestion des identités et des accès AWS utilisateurs (IAM). Pour ces piles, vous devez explicitement reconnaître leurs capacités en spécifiant cette option. Les seules valeurs valides sont
CAPABILITY_IAMetCAPABILITY_NAMED_IAM. Si vous disposez de ressources IAM, vous pouvez spécifier l'une ou l'autre de ces capacités. Si vous disposez de ressources IAM avec des noms personnalisés, vous devez spécifierCAPABILITY_NAMED_IAM. Si vous ne spécifiez pas cette option, l'opération renvoie une erreurInsufficientCapabilities.Lorsque vous déployez une application contenant des applications imbriquées, vous devez utiliser
CAPABILITY_AUTO_EXPANDpour confirmer que l'application contient des applications imbriquées. Pour plus d’informations, consultez Déploiement d'applications imbriquées. --config-envTEXT-
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-filePATH-
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-
Invite à confirmer si la CLI AWS SAM déploie le jeu de modifications calculé.
--debug-
Activez la journalisation de débogage pour imprimer le message de débogage généré par la CLI AWS SAM et pour afficher les horodatages.
--disable-rollback | --no-disable-rollback-
Indiquez si vous souhaitez annuler votre CloudFormation pile si une erreur survient lors d'un déploiement. Par défaut, en cas d'erreur lors d'un déploiement, votre CloudFormation la pile revient à son dernier état stable. Si vous spécifiez
--disable-rollbacket une erreur se produit pendant un déploiement, les ressources créées ou mises à jour avant l'erreur ne sont pas restaurées. --express | --no-express-
Spécifie s'il faut utiliser CloudFormation Mode express. 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 temps de déploiement peut être réduit jusqu'à 4 fois.
Le AWS SAM CLI transmet le comportement d'annulation au CloudFormation
DeploymentConfigparamètre lorsque vous spécifiez également--disable-rollback.La valeur par défaut est
--no-express. --fail-on-empty-changeset | --no-fail-on-empty-changeset-
Indiquez s'il faut renvoyer un code de sortie différent de zéro s'il n'existe aucune modification à apporter à la pile. Le comportement par défaut consiste à renvoyer un code de sortie autre que zéro.
--force-upload-
Spécifiez cette option pour télécharger des artefacts, même s’ils correspondent à des artefacts existants dans le compartiment Amazon S3. Les artefacts correspondants sont remplacés.
--guided, -g-
Spécifiez cette option pour que la CLI AWS SAM utilise des invites pour vous guider tout au long du déploiement.
--help-
Affichez ce message et quittez.
--image-repositoriesTEXT-
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 deploy --image-repositoriesFunction1=123456789012.dkr.ecr.us-east-1.amazonaws.com/my-repoVous pouvez spécifier cette option plusieurs fois au sein d'une même commande.
--image-repositoryTEXT-
Le nom du référentiel Amazon ECR vers lequel cette commande charge l'image de la fonction. Cette option est requise pour les fonctions déclarées avec le type de package
Image. --kms-key-idTEXT-
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.
Pour un
AWS::Serverless::WebFunctionchargé dans le compartiment que vous spécifiez avec--s3-bucket, la clé doit être une clé gérée par le client dont la politique de clé permetlambda.amazonaws.com.rproxy.govskope.caappelerkms:Decrypt. --metadata-
Une carte de métadonnées à attacher à tous les artefacts référencés dans le modèle.
--no-execute-changeset-
Indique s'il faut appliquer le jeu de modifications. Spécifiez cette option si vous voulez afficher les modifications de la pile avant d'appliquer le jeu de modifications. Cette commande crée un jeu de modifications CloudFormation puis se termine sans appliquer le jeu de modifications. Pour appliquer le jeu de modifications, exécutez la même commande sans cette option.
--no-progressbar-
N’affichez pas de barre de progression lors du téléchargement d’artefacts sur Amazon S3.
--notification-arnsLIST-
Une liste des rubriques Amazon Simple Notification Service (Amazon SNS) qui CloudFormation s'associe à la pile.
--on-failure [ROLLBACK | DELETE | DO_NOTHING]-
Spécifiez l'action à entreprendre lorsqu'une pile ne peut pas être créée.
Les options suivantes sont disponibles :
-
ROLLBACK– Récupère la pile à un état antérieur connu et valide. -
DELETE– Récupère la pile à un état antérieur connu et valide, s'il en existe un. Sinon, supprime la pile. -
DO_NOTHING– Ne récupère ni ne supprime la pile. L'effet est le même que celui de--disable-rollback.
Le comportement par défaut est
ROLLBACK.NoteVous pouvez spécifier soit
--disable-rollbackoption ou--on-failureoption, mais pas les deux. -
--output[ text | json ]-
Format de la sortie de commande :
-
text— Imprime une sortie régulière et lisible par l'homme. C’est la valeur par défaut. -
json— Imprime une sortie structurée et lisible par machine. Utilisez ce format lorsque vous souhaitez utiliser la sortie par programmation, par exemple dans CI/CD pipelines, extensions IDE et AI-assisted outils.
Un déploiement s'effectue sur une certaine période. Lorsque vous spécifiez
--output json, le AWS SAM CLI imprime un flux d'objets JSON, un par ligne, au fur et à mesure de la progression du déploiement. Chaque objet comprend untypechamp qui identifie le type d'informations qu'il contient, telles que l'ensemble de modifications, les événements de déploiement, les sorties de la pile et le résultat final. En cas d'échec, l'objet final inclut unerrorobjet qui décrit ce qui s'est mal passé.NoteLe
--output jsonl'option n'est pas compatible avec les options qui nécessitent des instructions interactives, telles que--guidedet--confirm-changeset. -
--parameter-overridesLIST-
Une chaîne qui contient CloudFormation les remplacements de paramètres sont codés sous forme de paires clé-valeur. Chaque remplacement utilise le format
ParameterKey=name,ParameterValue=value. Les remplacements multiples sont séparés par des espaces. Voici deux exemples :$sam deploy --parameter-overridesParameterKey=value1,ParameterValue=value2$sam deploy --parameter-overridesParameterKey=value1,ParameterValue=value2 ParameterKey=hello,ParameterValue=world ParameterKey=apple,ParameterValue=banana --profileTEXT-
Le profil spécifique de votre fichier d'identification qui obtient AWS informations d'identification.
--regionTEXT-
Le Région AWS pour déployer. Par exemple, us-east-1.
--resolve-image-repos-
Créez automatiquement des référentiels Amazon ECR à utiliser pour l’empaquetage et le déploiement de déploiements non guidés. Cette option s’applique uniquement aux fonctions et aux couches avec un
PackageType: Imagespécifié. Si vous spécifiez l'option--guided, la CLI AWS SAM ignore--resolve-image-repos.NoteSi AWS SAM crée automatiquement tous les référentiels Amazon ECR pour les fonctions ou les couches avec cette option, et vous pouvez ensuite supprimer ces fonctions ou couches de votre AWS SAM modèle, les référentiels Amazon ECR correspondants sont automatiquement supprimés.
--resolve-s3-
Créez automatiquement un compartiment Amazon S3 à utiliser pour l’empaquetage et le déploiement de déploiements non guidés. Si vous spécifiez l'option
--guided, l'interface CLI AWS SAM ignore--resolve-s3. Si vous spécifiez les deux options--s3-bucketet--resolve-s3, une erreur se produit.Avec cette option ou
--guided, le code d'unAWS::Serverless::WebFunctionest chargé dans un compartiment de code qui appartient à la pile, et non au compartiment géré. Pour plus d’informations, consultez Création et déploiement de fonctions Web Lambda. --role-arnTEXT-
Le nom de ressource Amazon (ARN) d'un rôle IAM qui CloudFormation suppose lors de l'application du changeset.
--s3-bucketTEXT-
Le nom du compartiment Amazon S3 dans lequel cette commande télécharge votre CloudFormation modèle. Si le modèle a une taille supérieure à 51 200 octets, l'option
--s3-bucketou l'option--resolve-s3est obligatoire. Si vous spécifiez les deux options--s3-bucketet--resolve-s3, une erreur se produit.Le code d'un
AWS::Serverless::WebFunctionest également chargé dans ce compartiment, pour lequel le contrôle de version doit être activé et permettre à Lambda de lire le code. Pour plus d’informations, consultez Création et déploiement de fonctions Web Lambda. --s3-prefixTEXT-
Le préfixe ajouté aux noms des artefacts téléchargés vers 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.
--save-params-
Enregistrez les paramètres que vous fournissez sur la ligne de commande dans AWS SAM fichier de configuration.
--signing-profilesLIST-
Liste des profils de signature pour signer les packages de déploiement. Cette option prend une liste de paires valeur clé, où la clé est le nom de la fonction ou de la couche à signer et la valeur est le profil de signature, avec un propriétaire de profil optionnel délimité par
:. Par exemple :FunctionNameToSign=SigningProfileName1 LayerNameToSign=SigningProfileName2:SigningProfileOwner. --stack-nameTEXT-
(Obligatoire) Le nom du CloudFormation pile sur laquelle vous effectuez le déploiement. Si vous spécifiez une pile existante, la commande met à jour la pile. Si vous spécifiez une nouvelle pile, celle-ci est créée par la commande.
-
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, -tPATH-
Le chemin et le nom du fichier où se trouve votre AWS SAM le modèle est situé.
NoteSi vous spécifiez cette option, AWS SAM déploie uniquement le modèle et les ressources locales vers lesquelles il pointe.
--use-json-
JSON de sortie pour CloudFormation modèle. La sortie par défaut est YAML.
Exemple
Pour un exemple détaillé et une présentation détaillée de l'utilisation du sam deploy sous-commande, reportez-vous à Présentation du déploiement avec AWS SAM.