Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
sam-Synchronisierung
Diese Seite enthält Referenzinformationen für AWS Serverless Application Model Befehlszeilenschnittstelle (AWS SAM CLI) sam sync Befehl.
-
Für eine Einführung in die AWS SAM CLI, siehe Was ist der AWS SAM CLI?
-
Eine Dokumentation zur Verwendung des AWS SAM CLI, siehe AWS SAM CLI.
Das sam sync Befehl synchronisiert lokale Anwendungsänderungen mit AWS Cloud.
Lauf nicht sam sync kein nicht vertrauenswürdiger Code. Der Befehl erstellt das Projekt in Ihrer lokalen Umgebung, in der die vom Projekt definierten Build-Tools und Skripts ausgeführt werden. Anschließend werden die Ressourcen in der Vorlage für Sie bereitgestellt AWS Konto mit Ihren Zugangsdaten.
Usage
$sam sync<options>
Optionen
--base-dir, -sDIRECTORY-
Löst relative Pfade zum Quellcode der Funktion oder Ebene in Bezug auf dieses Verzeichnis auf. Verwenden Sie diese Option, um zu ändern, wie relative Pfade zu Quellcode-Ordnern aufgelöst werden. Standardmäßig werden relative Pfade in Bezug auf die aufgelöst AWS SAM der Speicherort der Vorlage.
Zusätzlich zu den Ressourcen in der Stammanwendung oder dem Stack, den Sie erstellen, gilt diese Option auch für verschachtelte Anwendungen oder Stacks. Darüber hinaus gilt diese Option für die folgenden Ressourcentypen und Eigenschaften:
-
Ressourcentyp:
AWS::Serverless::FunctionEigentum:CodeUri -
Art der Ressource:
AWS::Serverless::FunctionRessourcenattribut:MetadataEintrag:DockerContext -
Art der Ressource:
AWS::Serverless::LayerVersionEigentum:ContentUri -
Art der Ressource:
AWS::Lambda::FunctionEigentum:Code -
Art der Ressource:
AWS::Lambda::LayerVersionEigentum:Content
-
--build-imageTEXT-
Die URI für die Container-Bild das Sie beim Erstellen Ihrer Anwendung verwenden möchten. In der Standardeinstellung AWS SAM verwendet den URI des Container-Image-Repositorys von Amazon Elastic Container Registry (Amazon ECR) Öffentlich. Geben Sie diese Option an, um ein anderes Bild zu verwenden.
Sie können diese Option mehrmals in einem einzigen Befehl verwenden. Jede Option akzeptiert eine Zeichenfolge oder ein Schlüssel-Wert-Paar.
-
Zeichenfolge — Geben Sie die URI des Container-Images an, das alle Ressourcen in Ihrer Anwendung verwenden werden. Im Folgenden wird ein Beispiel gezeigt:
$sam sync --build-imageamazon/aws-sam-cli-build-image-python3.8 -
Key-value Paar — Geben Sie den Ressourcennamen als Schlüssel und den Container-Image-URI an, der mit dieser Ressource als Wert verwendet werden soll. Verwenden Sie dieses Format, um für jede Ressource in Ihrer Anwendung einen anderen Container-Image-URI anzugeben. Im Folgenden wird ein Beispiel gezeigt:
$sam sync --build-imageFunction1=amazon/aws-sam-cli-build-image-python3.8
Diese Option gilt nur, wenn
--use-containerDie Option ist angegeben, andernfalls wird ein Fehler auftreten. -
--build-in-source | --no-build-in-source-
Bietet
--build-in-sourceum Ihr Projekt direkt im Quellordner zu erstellen.Das
--build-in-sourceDie Option unterstützt die folgenden Laufzeiten und Build-Methoden:-
Laufzeiten — Irgendein Node.js Laufzeit, unterstützt von
sam init --runtimeOption. -
Methoden erstellen —
Makefile,esbuild.
Das
--build-in-sourceDie Option ist nicht mit den folgenden Optionen kompatibel:-
--use-container
Standardwert:
--no-build-in-source -
--capabilitiesLIST-
Eine Liste von Funktionen, die Sie als zulässig angeben CloudFormation um bestimmte Stapel zu erstellen. Einige Stack-Vorlagen enthalten möglicherweise Ressourcen, die sich auf Ihre Berechtigungen auswirken können AWS-Konto. Zum Beispiel durch das Erstellen neuer AWS Identity and Access Management (IAM) -Benutzer. Geben Sie diese Option an, um die Standardwerte zu überschreiben. Gültige Werte sind z. B. die Folgenden:
-
CAPABILITY_IAM
-
CAPABILITY_NAMED_IAM
-
CAPABILITY_RESOURCE_POLICY
-
CAPABILITY_AUTO_EXPAND
Standard:
CAPABILITY_NAMED_IAMundCAPABILITY_AUTO_EXPAND -
--code-
In der Standardeinstellung AWS SAM synchronisiert alle Ressourcen in Ihrer Anwendung. Geben Sie diese Option an, um nur Coderessourcen zu synchronisieren, zu denen Folgendes gehört:
-
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
Um Coderessourcen zu synchronisieren, AWS SAM Verwendungszwecke AWS Service-APIs direkt, anstatt sie über bereitzustellen AWS CloudFormation. Um Ihre zu aktualisieren CloudFormation stapeln, rennen sam sync --watch oder sam deploy.
-
--config-envTEXT-
Der Umgebungsname, der die zu verwendenden Standardparameterwerte in der Konfigurationsdatei angibt. Der Standardwert ist „default“. Weitere Informationen zu Konfigurationsdateien finden Sie unter AWS SAMCLIKonfigurationsdatei.
--config-filePATH-
Der Pfad und der Dateiname der Konfigurationsdatei, die die zu verwendenden Standardparameterwerte enthält. Der Standardwert ist“
samconfig.toml"im Stammverzeichnis des Projektverzeichnisses. Weitere Informationen zu Konfigurationsdateien finden Sie unter AWS SAMCLIKonfigurationsdatei. --dependency-layer | --no-dependency-layer-
Gibt an, ob die Abhängigkeiten einzelner Funktionen in eine andere Ebene aufgeteilt werden sollen, um den Synchronisierungsvorgang zu beschleunigen.
Ein
AWS::Serverless::WebFunctionkann keine Ebenen verwenden, daher bleiben seine Abhängigkeiten immer in seinem Bereitstellungspaket.Standardwert:
--dependency-layer --express | --no-express-
Gibt an, ob verwendet werden soll CloudFormation Expressmodus für Infrastrukturbereitstellungen. Wenn diese Option aktiv ist, werden die Stack-Operationen abgeschlossen, sobald die Ressourcenkonfiguration angewendet wurde. Die Ressourcen werden weiterhin im Hintergrund bereit gestellt.
Der Expressmodus gilt nur für den Infrastruktur-Synchronisierungspfad. Code-only Umgehung von Synchronisationen (Aktualisierungen der Lambda-Event-Funktion, Bereitstellungen) CloudFormation und sind von dieser Option nicht betroffen.
Der Standardwert ist
--no-express.Bevorstehende StandardänderungDie Standardeinstellung ändert sich zu
--expressam 1. September 2026. --image-repositoryTEXT-
Der Name des Amazon Elastic Container Registry (Amazon ECR) -Repositorys, in das dieser Befehl das Bild Ihrer Funktion hochlädt. Erforderlich für Funktionen, die mit dem deklariert wurden
ImagePakettyp. --image-repositoriesTEXT-
Eine Zuordnung von Funktionen zu ihrer Amazon ECR-Repository-URI. Referenzfunktionen anhand ihrer logischen ID. Im Folgenden wird ein Beispiel gezeigt:
$sam sync --image-repositoriesFunction1=123456789012.dkr.ecr.us-east-1.amazonaws.com/my-repoSie können diese Option mehrmals in einem einzigen Befehl angeben.
--kms-key-idTEXT-
Die ID eines AWS Key Management Service (AWS KMS) Schlüssel, der zum Verschlüsseln von Artefakten verwendet wird, die sich im Amazon S3-Bucket befinden. Wenn Sie diese Option nicht angeben, dann AWS SAM verwendet Amazon S3-managed Verschlüsselungsschlüssel.
--metadata-
Eine Karte mit Metadaten, die an alle Artefakte angehängt werden können, auf die Sie in Ihrer Vorlage verweisen.
--notification-arnsLIST-
Eine Liste der thematischen ARNs von Amazon Simple Notification Service (Amazon SNS), die CloudFormation verknüpft sich mit dem Stack.
--no-use-container-
Eine Option, mit der Sie das IDE-Toolkit verwenden können, um das Standardverhalten festzulegen.
--parameter-overrides-
Eine Zeichenfolge, die enthält CloudFormation Parameterüberschreibungen, die als Schlüssel-Wert-Paare kodiert sind. Verwenden Sie dasselbe Format wie AWS Command Line Interface (AWS CLI). Das AWS SAM CLI format besteht aus expliziten Schlüssel- und Wert-Schlüsselwörtern. Jede Überschreibung ist durch ein Leerzeichen getrennt. Nachfolgend finden Sie zwei Beispiele:
--parameter-overrides ParameterKey=hello,ParameterValue=world--parameter-overrides ParameterKey=hello,ParameterValue=world ParameterKey=example1,ParameterValue=example2 ParameterKey=apple,ParameterValue=banana
--resourceTEXT-
Gibt den Ressourcentyp an, der synchronisiert werden soll. Um mehrere Ressourcen zu synchronisieren, können Sie diese Option mehrfach angeben. Diese Option wird unterstützt mit
--codeOption. Der Wert muss eine der aufgelisteten Ressourcen sein unter--code. Beispiel,--resource AWS::Serverless::Function --resource AWS::Serverless::LayerVersion. --resource-idTEXT-
Gibt die zu synchronisierende Ressourcen-ID an. Um mehrere Ressourcen zu synchronisieren, können Sie diese Option mehrfach angeben. Diese Option wird unterstützt mit
--codeOption. Beispiel,--resource-id Function1 --resource-id Function2. --role-arnTEXT-
Der Amazon-Ressourcenname (ARN) einer IAM-Rolle CloudFormation nimmt bei der Anwendung des Changesets an.
--s3-bucketTEXT-
Der Name des Amazon Simple Storage Service (Amazon S3) -Buckets, in den dieser Befehl Ihren hochlädt CloudFormation Vorlage. Wenn Ihre Vorlage größer als 51.200 Byte ist, dann entweder
--s3-bucketoder der--resolve-s3Option ist erforderlich. Wenn Sie beide angeben--s3-bucketund--resolve-s3Optionen, dann tritt ein Fehler auf.Wenn Sie diese Option angeben, wird der Code eines
AWS::Serverless::WebFunctionwird auch in diesen Bucket hochgeladen. Andernfalls wird es in einen Code-Bucket hochgeladen, der zum Stack gehört. Weitere Informationen finden Sie unter Erstellen und Bereitstellen von Lambda-Webfunktionen. --s3-prefixTEXT-
Das Präfix, das zu den Namen der Artefakte hinzugefügt wird, die Sie in den Amazon S3-Bucket hochladen. Der Präfixname ist ein Pfadname (Ordnername) für den Amazon S3-Bucket. Dies gilt nur für Funktionen, die mit dem deklariert wurden
ZipPakettyp. --save-params-
Speichert die Parameter, die Sie in der Befehlszeile angeben, im AWS SAM Konfigurationsdatei.
--skip-deploy-sync | --no-skip-deploy-sync-
Spezifiziert
--skip-deploy-syncum die anfängliche Infrastruktursynchronisierung zu überspringen, falls sie nicht erforderlich ist. Das AWS SAM CLI wird dein Lokal vergleichen AWS SAM Vorlage mit der bereitgestellten CloudFormation Vorlage erstellen und nur dann eine Bereitstellung durchführen, wenn eine Änderung festgestellt wird.Spezifiziert
--no-skip-deploy-syncum eine durchzuführen CloudFormation Bereitstellung jedes Malsam syncwird ausgeführt.Weitere Informationen hierzu finden Sie unter Überspringe die Initiale CloudFormation Einsatz.
Standardwert:
--skip-deploy-sync --stack-nameTEXT-
Der Name des CloudFormation Stapel für Ihre Anwendung.
Diese Option ist erforderlich.
-
Eine Liste von Tags, die dem Stack zugeordnet werden sollen, der erstellt oder aktualisiert wird. CloudFormation gibt diese Tags auch an Ressourcen im Stack weiter, die sie unterstützen.
--template-file, --template, -tPATH-
Der Pfad und der Dateiname, in dem Ihr AWS SAM Die Vorlage befindet sich.
AnmerkungWenn Sie diese Option angeben, dann AWS SAM stellt nur die Vorlage und die lokalen Ressourcen bereit, auf die sie verweist.
--use-container, -u-
Wenn Ihre Funktionen von Paketen abhängen, die nativ kompilierte Abhängigkeiten haben, verwenden Sie diese Option, um Ihre Funktion in einem AWS Lambda-Like Docker Behälter.
AnmerkungDerzeit ist diese Option nicht kompatibel mit
--dependency-layer. Wenn du verwendest--use-containermit--dependency-layer, der AWS SAM CLI informiert Sie und fährt fort mit--no-dependency-layer. --watch-
Startet einen Prozess, der Ihre lokale Anwendung auf Änderungen überwacht und diese automatisch mit dem synchronisiert AWS Cloud. Wenn Sie diese Option angeben, wird standardmäßig AWS SAM synchronisiert alle Ressourcen in Ihrer Anwendung, während Sie sie aktualisieren. Mit dieser Option AWS SAM führt eine Initiale durch CloudFormation Einsatz. Dann AWS SAM Verwendungszwecke AWS Service-APIs zur Aktualisierung der Coderessourcen. AWS SAM Verwendungszwecke CloudFormation um die Infrastrukturressourcen zu aktualisieren, wenn Sie Ihre aktualisieren AWS SAM Vorlage.
Der Code eines
AWS::Serverless::WebFunctionwird nicht beobachtet, weil jede Codeänderung eine neue Revision erzeugt. Codeänderungen werden bei der nächsten Infrastruktursynchronisierung bereitgestellt. --watch-excludeTEXT-
Schließt eine Datei oder einen Ordner von der Überwachung auf Dateiänderungen aus. Um diese Option zu verwenden,
--watchmuss ebenfalls bereitgestellt werden.Diese Option erhält ein Schlüssel-Wert-Paar:
-
Schlüssel — Die logische ID einer Lambda-Funktion in Ihrer Anwendung.
-
Wert — Der zugehörige Dateiname oder Ordner, der ausgeschlossen werden soll.
Wenn Sie Dateien oder Ordner aktualisieren, die mit dem
--watch-excludeOption, die AWS SAM CLI wird keine Synchronisation einleiten. Wenn jedoch eine Aktualisierung anderer Dateien oder Ordner eine Synchronisierung initiiert, werden diese Dateien oder Ordner in diese Synchronisierung einbezogen.Sie können diese Option mehrmals in einem einzigen Befehl angeben.
-
Beispiele
Beispiele zur Verwendung dieses Befehls finden Sie unter Optionen für den Befehl sam sync.