View a markdown version of this page

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

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

AWS::Serverless::WebFunction

Crea un AWS Lambda Funzione Web, che serve le richieste HTTP tramite un endpoint gestito. A differenza di una Lambda Event Function, che viene eseguita in risposta a invocazioni ed eventi, una Web Function esegue il server Web e riceve direttamente le richieste HTTP. Da un singolo AWS::Serverless::WebFunction, AWS SAM genera la Web Function, una revisione immutabile che contiene il codice e la configurazione e un endpoint che indirizza il traffico verso una o più revisioni.

Nota

Quando esegui la distribuzione su AWS CloudFormation, AWS SAM trasforma il tuo AWS SAM risorse in CloudFormation risorse. Per ulteriori informazioni, consulta Generato CloudFormation risorse per AWS SAM.

Importante

Il codice funzione deve eseguire un server HTTP in ascolto sull'host e sulla porta in AWS_LAMBDA_HTTP_ENDPOINT variabile di ambiente. Il runtime non è impostato PORT. Per impostazione predefinita, il runtime viene eseguito index.js nella radice del pacchetto di distribuzione. Usa EntryPoint per eseguire un file diverso.

Importante

Il bucket Amazon S3 che contiene il pacchetto di distribuzione deve soddisfare i seguenti requisiti:

  • Il controllo delle versioni è abilitato.

  • Una politica bucket garantisce lambda.amazonaws.com lo s3:GetObject e s3:GetObjectVersion autorizzazioni. Ti consigliamo di definire la politica con un ArnLike condizione su aws:SourceArn che corrisponde alle revisioni della funzione, ad esempio arn:aws:lambda:us-east-1:111122223333:web-function/my-function/revision/*.

  • Se l'oggetto è crittografato con SSE-KMS, utilizza una chiave gestita dal cliente la cui politica chiave lo consente lambda.amazonaws.com chiamare kms:Decrypt. Il AWS chiave gestita per Amazon S3 (aws/s3) non è supportato, perché non è possibile modificarne la politica chiave.

Per un esempio di bucket policy, consulta Politica bucket per Lambda nel AWS Lambda Guida per gli sviluppatori.

Se CodeUri è un percorso locale, AWS SAM CLI crea e carica il codice per te. Per ulteriori informazioni, consulta Creazione e distribuzione di Lambda Web Functions.

Sintassi

Per dichiarare questa entità nel tuo AWS Serverless Application Model (AWS SAM) modello, utilizzare la seguente sintassi.

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

Properties

AuthType

In che modo l'endpoint autorizza le richieste.

  • IamAuth: Lambda autorizza le richieste con Signature Version 4 e IAM. I chiamanti hanno bisogno del lambda:InvokeWebFunctionEndpoint autorizzazione, concessa tramite una politica sulla funzione basata sulle risorse.

  • ApplicationManaged: l'endpoint è pubblico. La tua funzione deve autorizzare ogni richiesta stessa.

Valori validi: IamAuth, ApplicationManaged

Tipo: stringa

Obbligatorio: sì

CloudFormation compatibilità: Questa proprietà viene passata direttamente al AuthType proprietà di un AWS::Lambda::WebFunctionEndpoint risorsa.

AutoDeploymentMode

In che modo l'endpoint indirizza il traffico tra le revisioni.

  • LatestRevision: invia il 100% del traffico alla revisione creata da questa distribuzione.

  • Disabled: indirizza il traffico in base a RevisionWeights.

Quali valori è possibile utilizzare e se RevisionWeights è obbligatorio, dipende da EndpointType:

  • HomeRegion: usa uno dei due valori. Con Disabled, RevisionWeights è obbligatorio.

  • MultiRegion o PerRegion: utilizzare Disabled. Se ometti RevisionWeights, l'endpoint indirizza il 100% del traffico verso la revisione creata nello stesso stack, in modo da poter creare l'endpoint in un'unica distribuzione. Il traffico non viene trasferito alle revisioni create da implementazioni successive.

Il valore deve risolversi quando AWS SAM trasforma il modello. A Ref a un parametro è supportato. Altre funzioni intrinseche non sono supportate.

Valori validi: LatestRevision, Disabled

▬Tipo: stringa

Obbligatorio: no

Default: LatestRevision

CloudFormation compatibilità: Questa proprietà è unica per AWS SAM e non ha un CloudFormation equivalente.

CodeUri

La posizione del pacchetto di distribuzione. Specificare un s3://bucket/key URI o un oggetto con Bucket, Key, e facoltativo Version tasti. Per i requisiti del bucket, consulta la nota all'inizio di questa pagina.

Puoi anche specificare un percorso locale. Il AWS SAM CLI carica il codice e sostituisce il percorso con la relativa posizione Amazon S3. Per ulteriori informazioni, consulta Creazione e distribuzione di Lambda Web Functions.

Digitare: Stringa | CodeUri

Obbligatorio: sì

CloudFormation compatibilità: Questa proprietà è simile alla BuildConfig.CodeConfig.S3Object proprietà di un AWS::Lambda::WebFunctionRevision risorsa. AWS SAM converte un s3:// URI in Bucket, Key, e VersionId.

EgressNetworkConnectorArn

L'ARN qualificato per versione di un connettore di rete che indirizza il traffico in uscita della funzione attraverso il tuo VPC. L'ARN deve terminare con un numero di versione, ad esempio arn:aws:lambda:us-east-1:123456789012:network-connector:my-connector:1. Per utilizzare la versione più recente di un connettore nello stesso modello, specificare !GetAtt MyConnector.LatestVersionArn. Il connettore è ComputeTypes deve essere WebFunction.

Se si specifica una stringa letterale, AWS SAM verifica che si tratti di un connettore di rete ARN qualificato dalla versione. Le funzioni intrinseche vengono trasmesse e convalidate dal servizio. La modifica di questo valore crea una nuova revisione.

▬Tipo: stringa

Obbligatorio: no

CloudFormation compatibilità: Questa proprietà viene passata direttamente al ServiceConfig.EgressNetworkConnectorArn proprietà di un AWS::Lambda::WebFunctionRevision risorsa.

EndpointDescription

Una descrizione dell'endpoint.

▬Tipo: stringa

Obbligatorio: no

CloudFormation compatibilità: Questa proprietà viene passata direttamente al Descrizione proprietà di un AWS::Lambda::WebFunctionEndpoint risorsa.

EndpointName

Il nome dell'endpoint. La modifica del nome sostituisce l'endpoint. Modifica EndpointType sostituisce anche l'endpoint, quindi cambia EndpointName allo stesso tempo. CloudFormation non è possibile sostituire una risorsa con nome personalizzato senza un nuovo nome.

▬Tipo: stringa

Obbligatorio: no

Default: prod

CloudFormation compatibilità: Questa proprietà viene passata direttamente al EndpointName proprietà di un AWS::Lambda::WebFunctionEndpoint risorsa.

EndpointType

Dove l'endpoint serve il traffico.

  • HomeRegion: serve dalla regione dello stack.

  • MultiRegion: replica la funzione nelle Regioni in ReplicaRegions e indirizza ogni richiesta alla Regione più vicina.

  • PerRegion: espone un endpoint separato in ogni regione di replica.

MultiRegion e PerRegion richiedere AutoDeploymentMode: Disabled.

Valori validi: HomeRegion, MultiRegion, PerRegion

▬Tipo: stringa

Obbligatorio: no

Default: HomeRegion

CloudFormation compatibilità: Questa proprietà viene passata direttamente al EndpointType proprietà di un AWS::Lambda::WebFunctionEndpoint risorsa.

EntryPoint

Il file eseguito dal runtime, relativo alla radice del pacchetto di distribuzione. AWS SAM lo passa al runtime nel file riservato AWS_LAMBDA_NODEJS_ENTRYPOINT variabile di ambiente.

Non puoi usare questa proprietà quando EnvironmentVariables è una funzione intrinseca.

▬Tipo: stringa

Obbligatorio: no

Default: index.js

CloudFormation compatibilità: Questa proprietà è unica per AWS SAM e non ha un CloudFormation equivalente.

EnvironmentVariables

Key-value coppie da impostare come variabili di ambiente per la revisione.

  • Le chiavi devono iniziare con una lettera e contenere solo lettere, numeri e caratteri di sottolineatura.

  • I valori non devono essere vuoti e contenere al massimo 4.096 caratteri.

  • AWS SAM converte numeri e valori booleani in stringhe.

Tipo: Mappa

Obbligatorio: no

CloudFormation compatibilità: Questa proprietà viene passata direttamente al ServiceConfig.EnvironmentVariables proprietà di un AWS::Lambda::WebFunctionRevision risorsa.

ExecutionRoleArn

L'ARN del ruolo IAM che la funzione assume quando viene eseguita. Se non specifichi un ruolo, AWS SAM ne crea uno con AWSLambdaBasicExecutionRole politica gestita e un ID logico di <resource-logical-id>Role.

▬Tipo: stringa

Obbligatorio: no

CloudFormation compatibilità: Questa proprietà viene passata direttamente al ServiceConfig.ExecutionRoleArn proprietà di un AWS::Lambda::WebFunctionRevision risorsa.

FunctionName

Il nome della funzione. I nomi delle funzioni devono essere univoci all'interno di un account in tutte le regioni. Se non specifichi un nome, AWS SAM ne genera uno dall'ID logico e dall'ID dello stack, con un massimo di 64 caratteri. La modifica del nome sostituisce la funzione, la relativa revisione e il relativo endpoint.

▬Tipo: stringa

Obbligatorio: no

CloudFormation compatibilità: Questa proprietà viene passata direttamente al FunctionName proprietà di un AWS::Lambda::WebFunction risorsa. Il generato AWS::Lambda::WebFunctionRevision e AWS::Lambda::WebFunctionEndpoint utilizzo delle risorse Ref per fare riferimento alla funzione.

InlineCode

Non supportato per AWS::Serverless::WebFunction. Utilizza CodeUri.

▬Tipo: stringa

Obbligatorio: no

CloudFormation compatibilità: Questa proprietà è unica per AWS SAM e non ha un CloudFormation equivalente.

KmsKeyArn

L'ARN del AWS KMS chiave utilizzata per crittografare le variabili di ambiente della revisione.

▬Tipo: stringa

Obbligatorio: no

CloudFormation compatibilità: Questa proprietà viene passata direttamente al KmsKeyArn proprietà di un AWS::Lambda::WebFunctionRevision risorsa.

LoggingConfig

La configurazione di registrazione per la revisione, ad esempio il gruppo di log e i livelli di log.

Tipo: Mappa

Obbligatorio: no

CloudFormation compatibilità: Questa proprietà viene passata direttamente al ServiceConfig.TelemetryConfig.LoggingConfig proprietà di un AWS::Lambda::WebFunctionRevision risorsa.

MaxConcurrencyPerEnvironment

Il numero massimo di richieste simultanee gestite da ciascun ambiente di esecuzione.

Tipo: integer

Obbligatorio: no

CloudFormation compatibilità: Questa proprietà viene passata direttamente al ServiceConfig.MaxConcurrencyPerEnvironment proprietà di un AWS::Lambda::WebFunctionRevision risorsa.

ReplicaRegions

Le regioni in cui replicare la funzione. Usa questa proprietà con MultiRegion e PerRegion punti finali. Specifica un elenco di codici regionali e gruppi di regioni o un oggetto con IncludeRegions e facoltativo ExcludeRegions.

Tipo: Elenco | ReplicaRegions

Obbligatorio: no

CloudFormation compatibilità: Questa proprietà è simile alla Regioni proprietà di un AWS::Lambda::WebFunctionEndpoint risorsa. AWS SAM espande i gruppi di regioni e si applica ExcludeRegions per produrre l'elenco delle regioni.

RevisionDescription

Una descrizione della revisione creata da questa distribuzione.

▬Tipo: stringa

Obbligatorio: no

CloudFormation compatibilità: Questa proprietà viene passata direttamente al Descrizione proprietà di un AWS::Lambda::WebFunctionRevision risorsa.

RevisionWeights

Una mappa degli ID di revisione rispetto ai pesi del traffico. Usa questa proprietà quando AutoDeploymentMode è Disabled. Specifica fino a due revisioni. Ogni peso è un numero intero compreso tra 1 e 100 e la somma dei pesi deve essere 100.

Tipo: RevisionWeights

Obbligatorio: condizionale. Obbligatorio quando AutoDeploymentMode è Disabled e EndpointType è HomeRegion.

CloudFormation compatibilità: Questa proprietà è simile alla RevisionWeights proprietà di un AWS::Lambda::WebFunctionEndpoint risorsa. AWS SAM converte la mappa in un elenco di RevisionId e Weight oggetti.

Runtime

Il runtime della funzione, ad esempio nodejs24.x.

Tipo: stringa

Obbligatorio: sì

CloudFormation compatibilità: Questa proprietà viene passata direttamente al BuildConfig.RuntimeConfig.Runtime proprietà di un AWS::Lambda::WebFunctionRevision risorsa.

ScalingConfig

La configurazione di scalabilità per l'endpoint, ad esempio il numero massimo di ambienti di esecuzione.

Tipo: Mappa

Obbligatorio: no

CloudFormation compatibilità: Questa proprietà viene passata direttamente al ScalingConfig proprietà di un AWS::Lambda::WebFunctionEndpoint risorsa.

Tags

Una mappa di coppie chiave-valore che specifica i tag aggiunti alla funzione e al ruolo di esecuzione che AWS SAM genera.

Tipo: Mappa

Obbligatorio: no

CloudFormation compatibilità: Questa proprietà è simile alla Etichette proprietà di un AWS::Lambda::WebFunction risorsa. La Tags proprietà in AWS SAM è costituito da coppie chiave-valore (mentre in CloudFormation questa proprietà è costituita da un elenco di Tag oggetti). Inoltre AWS SAM aggiunge automaticamente un lambda:createdBy:SAM tag alla funzione e al ruolo predefinito che viene generato per essa.

ThrottleConfig

La configurazione della limitazione per l'endpoint, ad esempio la frequenza massima di richieste.

Tipo: Mappa

Obbligatorio: no

CloudFormation compatibilità: Questa proprietà viene passata direttamente al ThrottleConfig proprietà di un AWS::Lambda::WebFunctionEndpoint risorsa.

Timeout

Il tempo massimo, in secondi, che la funzione può eseguire per richiesta. I valori validi sono compresi tra 3 e 900.

Tipo: integer

Obbligatorio: no

Default: 30

CloudFormation compatibilità: Questa proprietà viene passata direttamente al ServiceConfig.TimeoutSeconds proprietà di un AWS::Lambda::WebFunctionRevision risorsa.

Valori restituiti

Ref

Quando l'ID logico di questa risorsa viene fornito a Ref funzione intrinseca, restituisce l'ARN della funzione Web. Se è necessario il nome della funzione, utilizzare il valore di FunctionName invece.

Per ulteriori informazioni sull'uso di Ref funzione, vedere Ref nel AWS CloudFormation Guida per l'utente.

Ventola::GetAtt

Fn::GetAtt restituisce un valore per un attributo specificato di questo tipo. Di seguito sono riportati gli attributi disponibili e i valori restituiti di esempio.

Per ulteriori informazioni sull'uso Fn::GetAtt, vedi Fn::GetAtt nel AWS CloudFormation Guida per l'utente.

FunctionArn

L'Amazon Resource Name (ARN) della Web Function.

State

Lo stato attuale della Web Function.

StateReason

Il motivo dello stato attuale della funzione Web.

CreatedAt

L'ora in cui è stata creata la funzione Web.

UpdatedAt

L'ora dell'ultimo aggiornamento della funzione Web.

Per fare riferimento alla revisione o all'endpoint che AWS SAM genera, usa i loro ID logici, <resource-logical-id>Revision e <resource-logical-id>Endpoint. Ad esempio !GetAtt MyWebFunctionEndpoint.DomainName restituisce il nome di dominio dell'endpoint per una funzione Web con l'ID logico MyWebFunction. Per ulteriori informazioni, consulta CloudFormation risorse generate quando AWS::Serverless::WebFunction è specificato.

Esempi

Funzione Web di base

L'esempio seguente crea una funzione Web con una IAM-authorized endpoint nella regione dello stack. AWS SAM genera il ruolo di esecuzione e l'endpoint indirizza tutto il traffico alla revisione creata da questa distribuzione.

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}

Dividi il traffico tra due revisioni

L'esempio seguente disabilita la distribuzione automatica e invia il 90% del traffico a una revisione esistente e il 10% a un'altra. Entrambe le revisioni devono già esistere.

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

L'esempio seguente replica la funzione nelle regioni degli Stati Uniti tranne us-west-1 e indirizza ogni richiesta alla regione più vicina. Perché RevisionWeights viene omesso, l'endpoint indirizza tutto il traffico alla revisione creata in questo stack.

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

Funzione Web con uscita VPC

L'esempio seguente crea un connettore di rete per Web Functions e indirizza il traffico in uscita della funzione attraverso le sottoreti e i gruppi di sicurezza del connettore.

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