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.
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.
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.
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.comdies3:GetObjectunds3:GetObjectVersionGenehmigungen. Wir empfehlen Ihnen, die Richtlinie mit einemArnLikeBedingung:aws:SourceArndas entspricht zum Beispiel den Revisionen der Funktionarn: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.comanrufenkms: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:StringAutoDeploymentMode:StringCodeUri:String | CodeUriEgressNetworkConnectorArn:StringEndpointDescription:StringEndpointName:StringEndpointType:StringEntryPoint:StringEnvironmentVariables:MapExecutionRoleArn:StringFunctionName:StringInlineCode:StringKmsKeyArn:StringLoggingConfig:MapMaxConcurrencyPerEnvironment:IntegerReplicaRegions:List | ReplicaRegionsRevisionDescription:StringRevisionWeights:RevisionWeightsRuntime:StringScalingConfig:MapTags:MapThrottleConfig:MapTimeout:Integer
Eigenschaften
-
AuthType -
Wie der Endpunkt Anfragen autorisiert.
-
IamAuth: Lambda autorisiert Anfragen mit Signature Version 4 und IAM. Anrufer benötigenlambda:InvokeWebFunctionEndpointGenehmigung, 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,ApplicationManagedTyp: Zeichenfolge
Erforderlich: Ja
CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben AuthType Eigentum eines
AWS::Lambda::WebFunctionEndpointRessource. -
-
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
RevisionWeightserforderlich ist, hängt ab von EndpointType:-
HomeRegion: verwende einen der Werte. MitDisabled,RevisionWeightsist erforderlich. -
MultiRegionoderPerRegion: verwendenDisabled. Wenn du weglässtRevisionWeightsleitet 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
Refzu einem Parameter wird unterstützt. Andere intrinsische Funktionen werden nicht unterstützt.Zulässige Werte:
LatestRevision,DisabledTyp: Zeichenfolge
Required: No
Standardwert:
LatestRevisionCloudFormation 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://URI oder ein Objekt mitbucket/keyBucket,Key, und optionalVersionSchlü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::WebFunctionRevisionRessource. AWS SAM konvertiert eines3://URI inBucket,Key, undVersionId. -
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. Der Stecker ist ComputeTypes muss seinMyConnector.LatestVersionArnWebFunction.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::WebFunctionRevisionRessource. -
EndpointDescription -
Eine Beschreibung des Endpunkts.
Typ: Zeichenfolge
Required: No
CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben Beschreibung Eigentum eines
AWS::Lambda::WebFunctionEndpointRessource. -
EndpointName -
Der Name des Endpunkts. Durch das Ändern des Namens wird der Endpunkt ersetzt. Ändern
EndpointTypeersetzt auch den Endpunkt, also ändereEndpointNamezur gleichen Zeit. CloudFormation kann eine Ressource mit benutzerdefiniertem Namen nicht ohne einen neuen Namen ersetzen.Typ: Zeichenfolge
Required: No
Standardwert:
prodCloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben EndpointName Eigentum eines
AWS::Lambda::WebFunctionEndpointRessource. -
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.
MultiRegionundPerRegionbenötigenAutoDeploymentMode: Disabled.Gültige Werte:
HomeRegion,MultiRegion,PerRegionTyp: Zeichenfolge
Required: No
Standardwert:
HomeRegionCloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben EndpointType Eigentum eines
AWS::Lambda::WebFunctionEndpointRessource. -
-
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_ENTRYPOINTUmgebungsvariable.Sie können diese Eigenschaft nicht verwenden, wenn
EnvironmentVariablesist eine intrinsische Funktion.Typ: Zeichenfolge
Required: No
Standardwert:
index.jsCloudFormation 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::WebFunctionRevisionRessource. -
-
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
AWSLambdaBasicExecutionRoleverwaltete Richtlinie und eine logische ID von.<resource-logical-id>RoleTyp: Zeichenfolge
Required: No
CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben ServiceConfig.ExecutionRoleArn Eigentum eines
AWS::Lambda::WebFunctionRevisionRessource. -
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::WebFunctionRessource. Das generierteAWS::Lambda::WebFunctionRevisionundAWS::Lambda::WebFunctionEndpointRessourcen nutzenRefum 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::WebFunctionRevisionRessource. -
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::WebFunctionRevisionRessource. -
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::WebFunctionRevisionRessource. -
ReplicaRegions -
Die Regionen, in die die Funktion repliziert werden soll. Verwenden Sie diese Eigenschaft mit
MultiRegionundPerRegionEndpunkte. Geben Sie eine Liste von Regionscodes und Regionsgruppen an, oder ein Objekt mitIncludeRegionsund optionalExcludeRegions.Typ: Liste | ReplicaRegions
Required: No
CloudFormation Kompatibilität: Diese Eigenschaft ähnelt der Regionen Eigentum eines
AWS::Lambda::WebFunctionEndpointRessource. AWS SAM erweitert Regionsgruppen und giltExcludeRegionsum 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::WebFunctionRevisionRessource. -
RevisionWeights -
Eine Zuordnung von Revisions-IDs zu Verkehrsgewichten. Verwenden Sie diese Eigenschaft, wenn
AutoDeploymentModeistDisabled. 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
AutoDeploymentModeistDisabledundEndpointTypeistHomeRegion.CloudFormation Kompatibilität: Diese Eigenschaft ähnelt der RevisionWeights Eigentum eines
AWS::Lambda::WebFunctionEndpointRessource. AWS SAM konvertiert die Karte in eine Liste vonRevisionIdundWeightObjekte. -
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::WebFunctionRevisionRessource. -
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::WebFunctionEndpointRessource. -
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::WebFunctionRessource. DieTagsEigentum in AWS SAM besteht aus Schlüssel-Wert-Paaren (wohingegen in CloudFormation diese Eigenschaft besteht aus einer Liste vonTagObjekte). Außerdem AWS SAM fügt automatisch eine hinzulambda:createdBy:SAMTag 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::WebFunctionEndpointRessource. -
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:
30CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben ServiceConfig.TimeoutSeconds Eigentum eines
AWS::Lambda::WebFunctionRevisionRessource.
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, und <resource-logical-id>Revision. Zum Beispiel <resource-logical-id>Endpoint!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-idTimeout: 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-idEndpointName: 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-idEgressNetworkConnectorArn: !GetAtt MyConnector.LatestVersionArn