View a markdown version of this page

AWS::Serverless::WebFunction - AWS Serverless Application Model

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.

AWS::Serverless::WebFunction

Erzeugt eine AWS Lambda Webfunktion, die HTTP-Anfragen über einen verwalteten Endpunkt bedient. Im Gegensatz zu einer Lambda-Event-Funktion, die als Reaktion auf Aufrufe und Ereignisse ausgeführt wird, führt eine Webfunktion Ihren Webserver aus und empfängt HTTP-Anfragen direkt. Aus einer einzigen AWS::Serverless::WebFunction, AWS SAM generiert die Web-Funktion, eine unveränderliche Revision, die Ihren Code und Ihre Konfiguration enthält, und einen Endpunkt, der den Datenverkehr an eine oder mehrere Revisionen weiterleitet.

Anmerkung

Bei der Bereitstellung für AWS CloudFormation, AWS SAM transformiert deine AWS SAM Ressourcen in CloudFormation Ressourcen. Weitere Informationen finden Sie unter Generiert CloudFormation Ressourcen für AWS SAM.

Wichtig

Ihr Funktionscode muss einen HTTP-Server ausführen, der auf dem Host und dem Port im lauscht AWS_LAMBDA_HTTP_ENDPOINT Umgebungsvariable. Die Laufzeit wird nicht festgelegt PORT. Standardmäßig läuft die Runtime index.js im Stammverzeichnis des Bereitstellungspakets. Verwenden EntryPoint um eine andere Datei auszuführen.

Wichtig

Der Amazon S3-Bucket, der Ihr Bereitstellungspaket enthält, muss die folgenden Anforderungen erfüllen:

  • Die Versionierung ist aktiviert.

  • Eine Bucket-Richtlinie gewährt lambda.amazonaws.com die s3:GetObject und s3:GetObjectVersion Genehmigungen. Wir empfehlen Ihnen, die Richtlinie mit einem ArnLike Bedingung: aws:SourceArn das entspricht zum Beispiel den Revisionen der Funktion arn:aws:lambda:us-east-1:111122223333:web-function/my-function/revision/*.

  • Wenn das Objekt verschlüsselt ist mit SSE-KMS, es verwendet einen vom Kunden verwalteten Schlüssel, dessen Schlüsselrichtlinie dies zulässt lambda.amazonaws.com anrufen kms:Decrypt. Das AWS verwalteter Schlüssel für Amazon S3 (aws/s3) wird nicht unterstützt, da Sie seine Schlüsselrichtlinie nicht ändern können.

Ein Beispiel für eine Bucket-Richtlinie finden Sie unter Bucket-Richtlinie für Lambda in der AWS Lambda Leitfaden für Entwickler.

Wenn CodeUri ist ein lokaler Pfad, der AWS SAM CLI erstellt und lädt den Code für Sie hoch. Weitere Informationen finden Sie unter Erstellen und Bereitstellen von Lambda-Webfunktionen.

Syntax

Um diese Entität in Ihrem zu deklarieren AWS Serverless Application Model (AWS SAM) Vorlage, verwenden Sie die folgende Syntax.

YAML

Type: AWS::Serverless::WebFunction Properties: AuthType: String AutoDeploymentMode: String CodeUri: String | CodeUri EgressNetworkConnectorArn: String EndpointDescription: String EndpointName: String EndpointType: String EntryPoint: String EnvironmentVariables: Map ExecutionRoleArn: String FunctionName: String InlineCode: String KmsKeyArn: String LoggingConfig: Map MaxConcurrencyPerEnvironment: Integer ReplicaRegions: List | ReplicaRegions RevisionDescription: String RevisionWeights: RevisionWeights Runtime: String ScalingConfig: Map Tags: Map ThrottleConfig: Map Timeout: Integer

Eigenschaften

AuthType

Wie der Endpunkt Anfragen autorisiert.

  • IamAuth: Lambda autorisiert Anfragen mit Signature Version 4 und IAM. Anrufer benötigen lambda:InvokeWebFunctionEndpoint Genehmigung, die durch eine ressourcenbasierte Richtlinie für die Funktion erteilt wird.

  • ApplicationManaged: Der Endpunkt ist öffentlich. Ihre Funktion muss jede Anfrage selbst autorisieren.

Zulässige Werte: IamAuth, ApplicationManaged

Typ: Zeichenfolge

Erforderlich: Ja

CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben AuthType Eigentum eines AWS::Lambda::WebFunctionEndpoint Ressource.

AutoDeploymentMode

Wie der Endpunkt den Verkehr über Revisionen hinweg weiterleitet.

  • LatestRevision: sendet 100% des Datenverkehrs an die Revision, die durch diese Bereitstellung erstellt wird.

  • Disabled: leitet den Verkehr gemäß RevisionWeights.

Welche Werte können Sie verwenden und ob RevisionWeights erforderlich ist, hängt ab von EndpointType:

  • HomeRegion: verwende einen der Werte. Mit Disabled, RevisionWeights ist erforderlich.

  • MultiRegion oder PerRegion: verwenden Disabled. Wenn du weglässt RevisionWeightsleitet der Endpunkt 100% des Datenverkehrs an die Revision weiter, die im gleichen Stack erstellt wurde, sodass Sie den Endpunkt in einer einzigen Bereitstellung erstellen können. Der Datenverkehr wird nicht auf Revisionen übertragen, die bei späteren Bereitstellungen erstellt werden.

Wann muss der Wert aufgelöst werden AWS SAM transformiert die Vorlage. A Ref zu einem Parameter wird unterstützt. Andere intrinsische Funktionen werden nicht unterstützt.

Zulässige Werte: LatestRevision, Disabled

Typ: Zeichenfolge

Required: No

Standardwert: LatestRevision

CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat keine CloudFormation gleichwertig.

CodeUri

Der Speicherort des Bereitstellungspakets. Geben Sie einen an s3://bucket/key URI oder ein Objekt mit Bucket, Key, und optional Version Schlüssel. Informationen zu den Bucket-Anforderungen finden Sie im Hinweis oben auf dieser Seite.

Sie können auch einen lokalen Pfad angeben. Der AWS SAM CLI lädt den Code hoch und ersetzt den Pfad durch seinen Amazon S3-Standort. Weitere Informationen finden Sie unter Erstellen und Bereitstellen von Lambda-Webfunktionen.

Geben Sie: Zeichenfolge | CodeUri

Erforderlich: Ja

CloudFormation Kompatibilität: Diese Eigenschaft ähnelt der BuildConfig.CodeConfig.S3Object Eigentum eines AWS::Lambda::WebFunctionRevision Ressource. AWS SAM konvertiert eine s3:// URI in Bucket, Key, und VersionId.

EgressNetworkConnectorArn

Der versionsqualifizierte ARN eines Netzwerkkonnektors, der den ausgehenden Datenverkehr der Funktion durch Ihre VPC leitet. Der ARN muss beispielsweise mit einer Versionsnummer enden arn:aws:lambda:us-east-1:123456789012:network-connector:my-connector:1. Um die neueste Version eines Connectors in derselben Vorlage zu verwenden, geben Sie Folgendes an !GetAtt MyConnector.LatestVersionArn. Der Stecker ist ComputeTypes muss sein WebFunction.

Wenn Sie eine literale Zeichenfolge angeben, AWS SAM überprüft, ob es sich um einen versionsqualifizierten Netzwerkconnector-ARN handelt. Intrinsische Funktionen werden vom Dienst durchgegeben und validiert. Wenn Sie diesen Wert ändern, wird eine neue Revision erstellt.

Typ: Zeichenfolge

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben ServiceConfig.EgressNetworkConnectorArn Eigentum eines AWS::Lambda::WebFunctionRevision Ressource.

EndpointDescription

Eine Beschreibung des Endpunkts.

Typ: Zeichenfolge

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben Beschreibung Eigentum eines AWS::Lambda::WebFunctionEndpoint Ressource.

EndpointName

Der Name des Endpunkts. Durch das Ändern des Namens wird der Endpunkt ersetzt. Ändern EndpointType ersetzt auch den Endpunkt, also ändere EndpointName zur gleichen Zeit. CloudFormation kann eine Ressource mit benutzerdefiniertem Namen nicht ohne einen neuen Namen ersetzen.

Typ: Zeichenfolge

Required: No

Standardwert: prod

CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben EndpointName Eigentum eines AWS::Lambda::WebFunctionEndpoint Ressource.

EndpointType

Wo der Endpunkt den Verkehr abwickelt.

  • HomeRegion: dient aus der Region des Stacks.

  • MultiRegion: repliziert die Funktion auf die Regionen in ReplicaRegions und leitet jede Anfrage an die nächstgelegene Region weiter.

  • PerRegion: Macht in jeder Replikatregion einen separaten Endpunkt verfügbar.

MultiRegion und PerRegion benötigen AutoDeploymentMode: Disabled.

Gültige Werte: HomeRegion, MultiRegion, PerRegion

Typ: Zeichenfolge

Required: No

Standardwert: HomeRegion

CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben EndpointType Eigentum eines AWS::Lambda::WebFunctionEndpoint Ressource.

EntryPoint

Die Datei, die von der Laufzeitumgebung ausgeführt wird, relativ zum Stammverzeichnis des Bereitstellungspakets. AWS SAM übergibt sie an die Laufzeit in der reservierten Datei AWS_LAMBDA_NODEJS_ENTRYPOINT Umgebungsvariable.

Sie können diese Eigenschaft nicht verwenden, wenn EnvironmentVariables ist eine intrinsische Funktion.

Typ: Zeichenfolge

Required: No

Standardwert: index.js

CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat keine CloudFormation gleichwertig.

EnvironmentVariables

Key-value Paare, die als Umgebungsvariablen für die Revision festgelegt werden sollen.

  • Schlüssel müssen mit einem Buchstaben beginnen und dürfen nur Buchstaben, Zahlen und Unterstriche enthalten.

  • Werte dürfen nicht leer sein und dürfen maximal 4.096 Zeichen lang sein.

  • AWS SAM wandelt Zahlen und boolesche Werte in Zeichenketten um.

Typ: Landkarte

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben ServiceConfig.EnvironmentVariables Eigentum eines AWS::Lambda::WebFunctionRevision Ressource.

ExecutionRoleArn

Der ARN der IAM-Rolle, die die Funktion annimmt, wenn sie ausgeführt wird. Wenn Sie keine Rolle angeben, AWS SAM erstellt eine mit dem AWSLambdaBasicExecutionRole verwaltete Richtlinie und eine logische ID von <resource-logical-id>Role.

Typ: Zeichenfolge

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben ServiceConfig.ExecutionRoleArn Eigentum eines AWS::Lambda::WebFunctionRevision Ressource.

FunctionName

Der Name der Funktion. Funktionsnamen müssen innerhalb eines Kontos in allen Regionen eindeutig sein. Wenn Sie keinen Namen angeben, AWS SAM generiert einen aus der logischen ID und der Stack-ID, maximal 64 Zeichen. Wenn Sie den Namen ändern, werden die Funktion, ihre Revision und ihr Endpunkt ersetzt.

Typ: Zeichenfolge

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben FunctionName Eigentum eines AWS::Lambda::WebFunction Ressource. Das generierte AWS::Lambda::WebFunctionRevision und AWS::Lambda::WebFunctionEndpoint Ressourcen nutzen Ref um auf die Funktion zu verweisen.

InlineCode

Wird nicht unterstützt für AWS::Serverless::WebFunction. Verwenden Sie CodeUri.

Typ: Zeichenfolge

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat keine CloudFormation gleichwertig.

KmsKeyArn

Der ARN des AWS KMS Schlüssel, der zum Verschlüsseln der Umgebungsvariablen der Revision verwendet wird.

Typ: Zeichenfolge

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben KmsKeyArn Eigentum eines AWS::Lambda::WebFunctionRevision Ressource.

LoggingConfig

Die Protokollierungskonfiguration für die Revision, z. B. die Protokollgruppe und die Protokollebenen.

Geben Sie: Landkarte

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben ServiceConfig.TelemetryConfig.LoggingConfig Eigentum eines AWS::Lambda::WebFunctionRevision Ressource.

MaxConcurrencyPerEnvironment

Die maximale Anzahl gleichzeitiger Anforderungen, die jede Ausführungsumgebung verarbeitet.

Typ: Ganzzahl

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben ServiceConfig.MaxConcurrencyPerEnvironment Eigentum eines AWS::Lambda::WebFunctionRevision Ressource.

ReplicaRegions

Die Regionen, in die die Funktion repliziert werden soll. Verwenden Sie diese Eigenschaft mit MultiRegion und PerRegion Endpunkte. Geben Sie eine Liste von Regionscodes und Regionsgruppen an, oder ein Objekt mit IncludeRegions und optional ExcludeRegions.

Typ: Liste | ReplicaRegions

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft ähnelt der Regionen Eigentum eines AWS::Lambda::WebFunctionEndpoint Ressource. AWS SAM erweitert Regionsgruppen und gilt ExcludeRegions um die Regionsliste zu erstellen.

RevisionDescription

Eine Beschreibung der Revision, die durch diese Bereitstellung erstellt wird.

Typ: Zeichenfolge

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben Beschreibung Eigentum eines AWS::Lambda::WebFunctionRevision Ressource.

RevisionWeights

Eine Zuordnung von Revisions-IDs zu Verkehrsgewichten. Verwenden Sie diese Eigenschaft, wenn AutoDeploymentMode ist Disabled. Geben Sie bis zu zwei Revisionen an. Jede Gewichtung ist eine Ganzzahl von 1 bis 100, und die Summe der Gewichtungen muss 100 ergeben.

Typ: RevisionWeights

Erforderlich: Bedingt. Erforderlich wenn AutoDeploymentMode ist Disabled und EndpointType ist HomeRegion.

CloudFormation Kompatibilität: Diese Eigenschaft ähnelt der RevisionWeights Eigentum eines AWS::Lambda::WebFunctionEndpoint Ressource. AWS SAM konvertiert die Karte in eine Liste von RevisionId und Weight Objekte.

Runtime

Die Laufzeit für die Funktion, zum Beispiel nodejs24.x.

Typ: Zeichenfolge

Erforderlich: Ja

CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben BuildConfig.RuntimeConfig.Runtime Eigentum eines AWS::Lambda::WebFunctionRevision Ressource.

ScalingConfig

Die Skalierungskonfiguration für den Endpunkt, z. B. die maximale Anzahl von Ausführungsumgebungen.

Typ: Landkarte

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben ScalingConfig Eigentum eines AWS::Lambda::WebFunctionEndpoint Ressource.

Tags

Eine Zuordnung von Schlüssel-Wert-Paaren, die die der Funktion und der Ausführungsrolle hinzugefügten Tags angibt AWS SAM generiert.

Typ: Landkarte

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft ähnelt der Schlagworte Eigentum eines AWS::Lambda::WebFunction Ressource. Die Tags Eigentum in AWS SAM besteht aus Schlüssel-Wert-Paaren (wohingegen in CloudFormation diese Eigenschaft besteht aus einer Liste von Tag Objekte). Außerdem AWS SAM fügt automatisch eine hinzu lambda:createdBy:SAM Tag für die Funktion und für die Standardrolle, die dafür generiert wird.

ThrottleConfig

Die Drosselungskonfiguration für den Endpunkt, z. B. die maximale Anforderungsrate.

Geben Sie: Landkarte

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben ThrottleConfig Eigentum eines AWS::Lambda::WebFunctionEndpoint Ressource.

Timeout

Die maximale Zeit in Sekunden, für die die Funktion pro Anfrage ausgeführt werden kann. Gültige Werte liegen zwischen 3 und 900.

Typ: Ganzzahl

Required: No

Standardwert: 30

CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben ServiceConfig.TimeoutSeconds Eigentum eines AWS::Lambda::WebFunctionRevision Ressource.

Rückgabewerte

Punkt

Wenn die logische ID dieser Ressource dem bereitgestellt wird Ref Intrinsische Funktion, sie gibt den ARN der Webfunktion zurück. Wenn Sie den Funktionsnamen benötigen, verwenden Sie den Wert von FunctionName stattdessen.

Für weitere Informationen zur Verwendung der Ref Funktion, siehe Ref in der AWS CloudFormation Benutzerleitfaden.

Fn::GetAtt

Fn::GetAtt gibt einen Wert für ein angegebenes Attribut dieses Typs zurück. Im Folgenden sehen Sie die verfügbaren Attribute und Beispielrückgabewerte.

Für weitere Informationen zur Verwendung Fn::GetAtt, siehe Fn::GetAtt in der AWS CloudFormation Benutzerleitfaden.

FunctionArn

Der Amazon-Ressourcenname (ARN) der Webfunktion.

State

Der aktuelle Status der Web-Funktion.

StateReason

Der Grund für den aktuellen Status der Web-Funktion.

CreatedAt

Die Uhrzeit, zu der die Web-Funktion erstellt wurde.

UpdatedAt

Die Uhrzeit, zu der die Webfunktion zuletzt aktualisiert wurde.

Um auf die Revision oder den Endpunkt zu verweisen, die AWS SAM generiert, verwende ihre logischen IDs, <resource-logical-id>Revision und <resource-logical-id>Endpoint. Zum Beispiel !GetAtt MyWebFunctionEndpoint.DomainName gibt den Domänennamen des Endpunkts für eine Web-Funktion mit der logischen ID zurück MyWebFunction. Weitere Informationen finden Sie unter CloudFormation Ressourcen, die generiert wurden, wenn AWS::Serverless::WebFunction ist spezifiziert.

Beispiele

Grundlegende Web-Funktion

Das folgende Beispiel erstellt eine Webfunktion mit einer IAM-authorized Endpunkt in der Region des Stacks. AWS SAM generiert die Ausführungsrolle, und der Endpunkt leitet den gesamten Datenverkehr an die Revision weiter, die diese Bereitstellung erstellt.

AWSTemplateFormatVersion: '2010-09-09' Transform: AWS::Serverless-2016-10-31 Resources: MyWebFunction: Type: AWS::Serverless::WebFunction Properties: Runtime: nodejs24.x AuthType: IamAuth CodeUri: Bucket: amzn-s3-demo-bucket Key: webfn.zip Version: object-version-id Timeout: 30 Outputs: EndpointUrl: Value: !Sub https://${MyWebFunctionEndpoint.DomainName}

Teilen Sie den Verkehr zwischen zwei Revisionen auf

Das folgende Beispiel deaktiviert die automatische Bereitstellung und sendet 90% des Datenverkehrs an eine vorhandene Revision und 10% an eine andere. Beide Revisionen müssen bereits vorhanden sein.

AWSTemplateFormatVersion: '2010-09-09' Transform: AWS::Serverless-2016-10-31 Resources: MyWebFunction: Type: AWS::Serverless::WebFunction Properties: Runtime: nodejs24.x AuthType: IamAuth CodeUri: s3://amzn-s3-demo-bucket/webfn-v2.zip AutoDeploymentMode: Disabled RevisionWeights: rev-abc123: 90 rev-def456: 10

Multi-Region Web-Funktion

Das folgende Beispiel repliziert die Funktion auf die US-Regionen mit folgenden Ausnahmen us-west-1 und leitet jede Anfrage an die nächstgelegene Region weiter. Weil RevisionWeights weggelassen wird, leitet der Endpunkt den gesamten Datenverkehr an die in diesem Stack erstellte Revision weiter.

AWSTemplateFormatVersion: '2010-09-09' Transform: AWS::Serverless-2016-10-31 Resources: MyWebFunction: Type: AWS::Serverless::WebFunction Properties: Runtime: nodejs24.x AuthType: IamAuth CodeUri: Bucket: amzn-s3-demo-bucket Key: webfn.zip Version: object-version-id EndpointName: prodmr EndpointType: MultiRegion AutoDeploymentMode: Disabled ReplicaRegions: IncludeRegions: - US ExcludeRegions: - us-west-1

Web-Funktion mit VPC-Ausgang

Das folgende Beispiel erstellt einen Netzwerkconnector für Web Functions und leitet den ausgehenden Datenverkehr der Funktion durch die Subnetze und Sicherheitsgruppen des Connectors weiter.

AWSTemplateFormatVersion: '2010-09-09' Transform: AWS::Serverless-2016-10-31 Resources: MyConnector: Type: AWS::Serverless::NetworkConnector Properties: ComputeTypes: - WebFunction VpcConfig: SubnetIds: - subnet-0abc123def4567890 - subnet-0def456abc7890123 SecurityGroupIds: - sg-0abc1234abcde0001 NetworkProtocol: IPv4 MyWebFunction: Type: AWS::Serverless::WebFunction Properties: Runtime: nodejs24.x AuthType: IamAuth CodeUri: Bucket: amzn-s3-demo-bucket Key: webfn.zip Version: object-version-id EgressNetworkConnectorArn: !GetAtt MyConnector.LatestVersionArn