View a markdown version of this page

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

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

AWS::Serverless::WebFunction

Crea un AWS Lambda Función web, que atiende las solicitudes HTTP a través de un punto final administrado. A diferencia de una función de eventos de Lambda, que se ejecuta en respuesta a las invocaciones y los eventos, una función web ejecuta el servidor web y recibe las solicitudes HTTP directamente. Desde una sola AWS::Serverless::WebFunction, AWS SAM genera la función web, una revisión inmutable que contiene el código y la configuración, y un punto final que dirige el tráfico a una o más revisiones.

nota

Cuando se implementa en AWS CloudFormation, AWS SAM transforma tu AWS SAM recursos en CloudFormation recursos. Para obtener más información, consulte Generado CloudFormation recursos para AWS SAM.

importante

El código de función debe ejecutar un servidor HTTP que escuche en el host y el puerto del AWS_LAMBDA_HTTP_ENDPOINT variable de entorno. El tiempo de ejecución no está establecido PORT. De forma predeterminada, el tiempo de ejecución se ejecuta index.js en la raíz del paquete de implementación. Utilice EntryPoint para ejecutar un archivo diferente.

importante

El bucket de Amazon S3 que contiene su paquete de implementación debe cumplir los siguientes requisitos:

  • El control de versiones está habilitado.

  • Una política de cubos otorga lambda.amazonaws.com la s3:GetObject y s3:GetObjectVersion permisos. Le recomendamos que defina el alcance de la política con un ArnLike con la condición de aws:SourceArn que coincida con las revisiones de la función, por ejemplo arn:aws:lambda:us-east-1:111122223333:web-function/my-function/revision/*.

  • Si el objeto está cifrado con SSE-KMS, utiliza una clave gestionada por el cliente cuya política de claves lo permite lambda.amazonaws.com para llamar kms:Decrypt. El AWS clave gestionada para Amazon S3 (aws/s3) no es compatible porque no puede cambiar su política de claves.

Para ver un ejemplo de política de cubos, consulta Política de cubos para Lambda en el AWS Lambda Guía para desarrolladores.

Si CodeUri es una ruta local, el AWS SAM CLI compila y carga el código por ti. Para obtener más información, consulte Creación e implementación de funciones web de Lambda.

Sintaxis

Para declarar esta entidad en su AWS Serverless Application Model (AWS SAM), utilice la siguiente sintaxis.

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

Propiedades

AuthType

Cómo el punto final autoriza las solicitudes.

  • IamAuth: Lambda autoriza las solicitudes con la versión 4 de Signature e IAM. Las personas que llaman necesitan el lambda:InvokeWebFunctionEndpoint permiso, otorgado a través de una política basada en los recursos de la función.

  • ApplicationManaged: el punto final es público. Su función debe autorizar cada solicitud por sí misma.

Valores válidos: IamAuth, ApplicationManaged

Tipo: cadena

Obligatorio: sí

CloudFormation compatibilidad: Esta propiedad se pasa directamente al AuthType propiedad de un AWS::Lambda::WebFunctionEndpoint recurso.

AutoDeploymentMode

Cómo el punto final dirige el tráfico entre las revisiones.

  • LatestRevision: envía el 100% del tráfico a la revisión que crea esta implementación.

  • Disabled: enruta el tráfico de acuerdo con RevisionWeights.

Qué valores puede usar y si RevisionWeights es obligatorio, depende de EndpointType:

  • HomeRegion: utilice cualquiera de los valores. Con Disabled, RevisionWeights es obligatorio.

  • MultiRegion o PerRegion: usar Disabled. Si omites RevisionWeights, el punto final dirige el 100% del tráfico a la revisión creada en la misma pila, por lo que puede crear el punto final en una sola implementación. El tráfico no se traslada a las revisiones que crean las implementaciones posteriores.

El valor debe resolverse cuando AWS SAM transforma la plantilla. UN Ref se admite a un parámetro. No se admiten otras funciones intrínsecas.

Valores válidos: LatestRevision, Disabled

Tipo: cadena

Obligatorio: no

Valor predeterminado: LatestRevision

CloudFormation compatibilidad: Esta propiedad es exclusiva de AWS SAM y no tiene un CloudFormation equivalente.

CodeUri

La ubicación del paquete de despliegue. Especifique un s3://bucket/key Un URI o un objeto con Bucket, Key, y opcional Version llaves. Para conocer los requisitos de los cubos, consulta la nota que aparece en la parte superior de esta página.

También puedes especificar una ruta local. El AWS SAM CLI carga el código y reemplaza la ruta por su ubicación en Amazon S3. Para obtener más información, consulte Creación e implementación de funciones web de Lambda.

Escriba: Cadena | CodeUri

Obligatorio: sí

CloudFormation compatibilidad: Esta propiedad es similar a BuildConfig.CodeConfig.S3Object propiedad de un AWS::Lambda::WebFunctionRevision recurso. AWS SAM convierte un s3:// URI en Bucket, Key, y VersionId.

EgressNetworkConnectorArn

El ARN con certificación de versión de un conector de red que dirige el tráfico saliente de la función a través de la VPC. El ARN debe terminar en un número de versión, por ejemplo arn:aws:lambda:us-east-1:123456789012:network-connector:my-connector:1. Para usar la versión más reciente de un conector en la misma plantilla, especifique !GetAtt MyConnector.LatestVersionArn. El conector ComputeTypes debe ser WebFunction.

Si especificas una cadena literal, AWS SAM comprueba que se trata de un ARN de conector de red que cumple con los requisitos de versión. El servicio transfiere y valida las funciones intrínsecas. Al cambiar este valor, se crea una nueva revisión.

Tipo: cadena

Obligatorio: no

CloudFormation compatibilidad: Esta propiedad se pasa directamente al ServiceConfig.EgressNetworkConnectorArn propiedad de un AWS::Lambda::WebFunctionRevision recurso.

EndpointDescription

Una descripción del punto final.

Tipo: cadena

Obligatorio: no

CloudFormation compatibilidad: Esta propiedad se pasa directamente al Descripción propiedad de un AWS::Lambda::WebFunctionEndpoint recurso.

EndpointName

El nombre del punto de enlace. Al cambiar el nombre, se reemplaza el punto final. Cambiando EndpointType también reemplaza al punto final, así que cambia EndpointName al mismo tiempo. CloudFormation no puede reemplazar un recurso con nombre personalizado sin un nombre nuevo.

Tipo: cadena

Obligatorio: no

Valor predeterminado: prod

CloudFormation compatibilidad: Esta propiedad se pasa directamente al EndpointName propiedad de un AWS::Lambda::WebFunctionEndpoint recurso.

EndpointType

Dónde el punto final sirve al tráfico.

  • HomeRegion: sirve desde la región de la pila.

  • MultiRegion: replica la función en las regiones de ReplicaRegions y dirige cada solicitud a la región más cercana.

  • PerRegion: expone un punto final independiente en cada región de réplica.

MultiRegion y PerRegion requerir AutoDeploymentMode: Disabled.

Valores válidos: HomeRegion, MultiRegion, PerRegion

Tipo: cadena

Obligatorio: no

Valor predeterminado: HomeRegion

CloudFormation compatibilidad: Esta propiedad se pasa directamente al EndpointType propiedad de un AWS::Lambda::WebFunctionEndpoint recurso.

EntryPoint

El archivo que ejecuta el motor de ejecución, en relación con la raíz del paquete de implementación. AWS SAM lo pasa al tiempo de ejecución del archivo reservado AWS_LAMBDA_NODEJS_ENTRYPOINT variable de entorno.

No puede usar esta propiedad cuando EnvironmentVariables es una función intrínseca.

Tipo: cadena

Obligatorio: no

Valor predeterminado: index.js

CloudFormation compatibilidad: Esta propiedad es exclusiva de AWS SAM y no tiene un CloudFormation equivalente.

EnvironmentVariables

Key-value pares para establecer como variables de entorno para la revisión.

  • Las claves deben empezar por una letra y contener solo letras, números y guiones bajos.

  • Los valores no deben estar vacíos y tener un máximo de 4.096 caracteres.

  • AWS SAM convierte los valores numéricos y booleanos en cadenas.

Tipo: mapa

Obligatorio: no

CloudFormation compatibilidad: Esta propiedad se pasa directamente al ServiceConfig.EnvironmentVariables propiedad de un AWS::Lambda::WebFunctionRevision recurso.

ExecutionRoleArn

El ARN de la función de IAM que asume la función cuando se ejecuta. Si no especificas un rol, AWS SAM crea uno con el AWSLambdaBasicExecutionRole política gestionada y un identificador lógico de <resource-logical-id>Role.

Tipo: cadena

Obligatorio: no

CloudFormation compatibilidad: Esta propiedad se pasa directamente al ServiceConfig.ExecutionRoleArn propiedad de un AWS::Lambda::WebFunctionRevision recurso.

FunctionName

El nombre de la función. Los nombres de las funciones deben ser únicos en una cuenta en todas las regiones. Si no especificas un nombre, AWS SAM genera uno a partir del ID lógico y el ID de pila, con un máximo de 64 caracteres. Al cambiar el nombre, se sustituyen la función, su revisión y su punto final.

Tipo: cadena

Obligatorio: no

CloudFormation compatibilidad: Esta propiedad se pasa directamente al FunctionName propiedad de un AWS::Lambda::WebFunction recurso. El generado AWS::Lambda::WebFunctionRevision y AWS::Lambda::WebFunctionEndpoint uso de recursos Ref para hacer referencia a la función.

InlineCode

No se admite para AWS::Serverless::WebFunction. Utilice CodeUri.

Tipo: cadena

Obligatorio: no

CloudFormation compatibilidad: Esta propiedad es exclusiva de AWS SAM y no tiene un CloudFormation equivalente.

KmsKeyArn

El ARN del AWS KMS clave utilizada para cifrar las variables de entorno de la revisión.

Tipo: cadena

Obligatorio: no

CloudFormation compatibilidad: Esta propiedad se pasa directamente al KmsKeyArn propiedad de un AWS::Lambda::WebFunctionRevision recurso.

LoggingConfig

La configuración de registro para la revisión, como el grupo de registros y los niveles de registro.

Tipo: mapa

Obligatorio: no

CloudFormation compatibilidad: Esta propiedad se pasa directamente al ServiceConfig.TelemetryConfig.LoggingConfig propiedad de un AWS::Lambda::WebFunctionRevision recurso.

MaxConcurrencyPerEnvironment

El número máximo de solicitudes simultáneas que gestiona cada entorno de ejecución.

Tipo: entero

Obligatorio: no

CloudFormation compatibilidad: Esta propiedad se pasa directamente al ServiceConfig.MaxConcurrencyPerEnvironment propiedad de un AWS::Lambda::WebFunctionRevision recurso.

ReplicaRegions

Las regiones en las que replicar la función. Utilice esta propiedad con MultiRegion y PerRegion puntos finales. Especifique una lista de códigos de región y grupos de regiones, o un objeto con IncludeRegions y opcional ExcludeRegions.

Escriba: Lista | ReplicaRegions

Obligatorio: no

CloudFormation compatibilidad: Esta propiedad es similar a Regiones propiedad de un AWS::Lambda::WebFunctionEndpoint recurso. AWS SAM amplía los grupos de regiones y aplica ExcludeRegions para producir la lista de regiones.

RevisionDescription

Una descripción de la revisión que crea esta implementación.

Tipo: cadena

Obligatorio: no

CloudFormation compatibilidad: Esta propiedad se pasa directamente al Descripción propiedad de un AWS::Lambda::WebFunctionRevision recurso.

RevisionWeights

Un mapa de los ID de revisión y la ponderación del tráfico. Utilice esta propiedad cuando AutoDeploymentMode es Disabled. Especifique hasta dos revisiones. Cada peso es un número entero comprendido entre 1 y 100 y los pesos deben sumar 100.

Tipo: RevisionWeights

Obligatorio: condicional. Obligatorio cuando AutoDeploymentMode es Disabled y EndpointType es HomeRegion.

CloudFormation compatibilidad: Esta propiedad es similar a RevisionWeights propiedad de un AWS::Lambda::WebFunctionEndpoint recurso. AWS SAM convierte el mapa en una lista de RevisionId y Weight objetos.

Runtime

El tiempo de ejecución de la función, por ejemplo nodejs24.x.

Tipo: cadena

Obligatorio: sí

CloudFormation compatibilidad: Esta propiedad se pasa directamente al BuildConfig.RuntimeConfig.Runtime propiedad de un AWS::Lambda::WebFunctionRevision recurso.

ScalingConfig

La configuración de escalado del punto final, como el número máximo de entornos de ejecución.

Tipo: mapa

Obligatorio: no

CloudFormation compatibilidad: Esta propiedad se pasa directamente al ScalingConfig propiedad de un AWS::Lambda::WebFunctionEndpoint recurso.

Tags

Un mapa de pares clave-valor que especifica las etiquetas agregadas a la función y al rol de ejecución que AWS SAM genera.

Tipo: mapa

Obligatorio: no

CloudFormation compatibilidad: Esta propiedad es similar a Etiquetas propiedad de un AWS::Lambda::WebFunction recurso. El Tags propiedad en AWS SAM consiste en pares clave-valor (mientras que en CloudFormation esta propiedad consiste en una lista de Tag objetos). Además, AWS SAM añade automáticamente un lambda:createdBy:SAM etiqueta a la función y al rol predeterminado que se genera para ella.

ThrottleConfig

La configuración de limitación para el punto final, como la velocidad máxima de solicitudes.

Tipo: mapa

Obligatorio: no

CloudFormation compatibilidad: Esta propiedad se pasa directamente al ThrottleConfig propiedad de un AWS::Lambda::WebFunctionEndpoint recurso.

Timeout

El tiempo máximo, en segundos, que la función puede ejecutarse por solicitud. Los valores válidos van de 3 a 900.

Tipo: entero

Obligatorio: no

Valor predeterminado: 30

CloudFormation compatibilidad: Esta propiedad se pasa directamente al ServiceConfig.TimeoutSeconds propiedad de un AWS::Lambda::WebFunctionRevision recurso.

valores devueltos

Ref.

Cuando el identificador lógico de este recurso se proporciona al Ref función intrínseca, devuelve el ARN de la función web. Cuando necesite el nombre de la función, utilice el valor de FunctionName en su lugar.

Para obtener más información sobre el uso de la función Ref, consulta Ref en la Guía del usuario de AWS CloudFormation .

Diversión::GetAtt

Fn::GetAtt devuelve un valor para un atributo especificado de este tipo. A continuación se indican los atributos disponibles y los valores devueltos de muestra.

Para obtener más información acerca de cómo usar Fn::GetAtt, consulta Fn::GetAtt en la Guía del usuario de AWS CloudFormation .

FunctionArn

El nombre de recurso de Amazon (ARN) de la función web.

State

El estado actual de la función web.

StateReason

El motivo del estado actual de la función web.

CreatedAt

La hora en que se creó la función web.

UpdatedAt

Hora en la que se actualizó por última vez la función web.

Para hacer referencia a la revisión o al punto final que AWS SAM genera, usa sus ID lógicos, <resource-logical-id>Revision y <resource-logical-id>Endpoint. Por ejemplo, !GetAtt MyWebFunctionEndpoint.DomainName devuelve el nombre de dominio del punto final de una función web con el identificador lógico MyWebFunction. Para obtener más información, consulte CloudFormation recursos generados cuando AWS::Serverless::WebFunction está especificado.

Ejemplos

Función web básica

El siguiente ejemplo crea una función web con un IAM-authorized punto final en la región de la pila. AWS SAM genera el rol de ejecución y el punto final dirige todo el tráfico a la revisión que crea esta implementación.

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}

Divida el tráfico entre dos revisiones

El siguiente ejemplo desactiva la implementación automática y envía el 90% del tráfico a una revisión existente y el 10% a otra. Ambas revisiones ya deben existir.

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 Función web

El siguiente ejemplo replica la función en las regiones de EE. UU., excepto us-west-1 y dirige cada solicitud a la región más cercana. Porque RevisionWeights se omite, el punto final dirige todo el tráfico a la revisión creada en esta pila.

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

Función web con salida de VPC

En el siguiente ejemplo, se crea un conector de red para Web Functions y se dirige el tráfico saliente de la función a través de las subredes y los grupos de seguridad del conector.

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