sam deploy

Cette page fournit des informations de référence pour la AWS Serverless Application Model commande Command Line Interface (AWS SAMCLI)sam deploy.

• Pour une introduction à la AWS SAMCLI, voirQu'est-ce que c'est AWS SAMCLI ?.

• Pour obtenir de la documentation sur l'utilisation de la AWS SAMCLI sam deploy commande, consultezPrésentation du déploiement avec AWS SAM.

La sam deploy commande déploie une application auprès de l'utilisateur AWS Cloud . AWS CloudFormation

Utilisation

$ <environment variables> sam deploy <options>

Variables d’environnement

SAM_CLI_POLL_DELAY

Définissez la variable d'SAM_CLI_POLL_DELAYenvironnement avec une valeur de secondes pour configurer la fréquence à laquelle la CLI AWS SAM vérifie l'état de la AWS CloudFormation pile, ce qui est utile lorsque vous observez une limitation. AWS CloudFormation Cette variable d'environnement est utilisée pour interroger les appels d'describe_stackAPI effectués pendant l'exécutionsam deploy.

Voici un exemple de cette variable :

$ SAM_CLI_POLL_DELAY=5 sam deploy

Options

--capabilities LIST

Liste des fonctionnalités que vous devez spécifier pour autoriser la création AWS CloudFormation de certaines piles. Certains modèles de pile peuvent inclure des ressources qui affectent vos autorisations Compte AWS, par exemple en créant de nouveaux utilisateurs AWS Identity and Access Management (IAM). Pour ces piles, vous devez explicitement reconnaître leurs capacités en spécifiant cette option. Les seules valeurs valides sont CAPABILITY_IAM et CAPABILITY_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écifier CAPABILITY_NAMED_IAM. Si vous ne spécifiez pas cette option, l'opération renvoie une erreur InsufficientCapabilities.

--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

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

Spécifiez si vous souhaitez annuler votre AWS CloudFormation pile en cas d'erreur lors d'un déploiement. Par défaut, en cas d'erreur lors d'un déploiement, votre AWS CloudFormation pile revient à son dernier état stable. Si vous spécifiez --disable-rollback et une erreur se produit pendant un déploiement, les ressources créées ou mises à jour avant l'erreur ne sont pas restaurées.

--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-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 deploy --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.

--image-repository TEXT

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-id TEXT

L'ID d'une clé AWS Key Management Service (AWS KMS) utilisée pour chiffrer les artefacts inactifs dans le compartiment Amazon S3. Si vous ne spécifiez pas cette option, AWS SAM utilise les clés de chiffrement gérées par Amazon S3.

--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 AWS 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-arns LIST

Liste des ARN thématiques Amazon Simple Notification Service (Amazon SNS) associés à la pile AWS CloudFormation .

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

Note

Vous pouvez spécifier l'--disable-rollbackoption ou l'--on-failureoption, mais pas les deux.

--parameter-overrides

Chaîne contenant des remplacements de AWS CloudFormation paramètres codés sous forme de paires clé-valeur. Utilisez le même format que le AWS Command Line Interface (AWS CLI). Par exemple, ParameterKey=ParameterValue InstanceType=t1.micro.

--profile TEXT

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

--region TEXT

Le Région AWS vers lequel 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: Image spécifié. Si vous spécifiez l'option --guided, la CLI  AWS SAM ignore --resolve-image-repos.

Note

Si vous créez AWS SAM automatiquement des référentiels Amazon ECR pour des fonctions ou des couches avec cette option, et que vous supprimez ultérieurement 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-bucket et --resolve-s3, une erreur se produit.

--role-arn TEXT

Nom de ressource Amazon (ARN) d'un rôle IAM AWS CloudFormation assumé lors de l'application de l'ensemble de modifications.

--s3-bucket TEXT

Le nom du compartiment Amazon S3 dans lequel cette commande télécharge votre AWS CloudFormation modèle. Si le modèle a une taille supérieure à 51 200 octets, l'option --s3-bucket ou l'option --resolve-s3 est obligatoire. Si vous spécifiez les deux options --s3-bucket et --resolve-s3, une erreur se produit.

--s3-prefix TEXT

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 le fichier AWS SAM de configuration.

--signing-profiles LIST

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-name TEXT

(Obligatoire) Le nom de la AWS 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.

--tags LIST

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

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

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

Note

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

--use-json

Sortie JSON pour le AWS CloudFormation modèle. La sortie par défaut est YAML.