Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
AWS::Serverless::Fonction
Le AWS::Serverless::Function la ressource crée une fonction événementielle Lambda, une Gestion des identités et des accès AWS
rôle d'exécution (IAM) et mappages de sources d'événements qui déclenchent la fonction.
Event Function est le nom de la documentation du type de fonction Lambda d'origine, précédemment connu sous le nom de fonctions Lambda. Le AWS::Serverless::Function type de ressource, le AWS::Lambda::Function ressource qu'il génère et que ses propriétés continuent d'utiliser fonction, vous n'avez donc pas besoin de modifier vos modèles.
Le AWS::Serverless::Fonction la ressource prend également en charge le Metadata attribut de ressource, afin que vous puissiez indiquer AWS SAM pour créer des environnements d'exécution personnalisés dont votre application a besoin. Pour plus d'informations sur la création d'une exécution personnalisée, consultez Création de fonctions d'événement Lambda avec des environnements d'exécution personnalisés dans AWS SAM.
Cette ressource soutient également le Connectors ressource Attribute. Pour plus d’informations, consultez Gérer les autorisations relatives aux ressources avec AWS SAM connectors.
Lorsque vous effectuez un déploiement sur AWS CloudFormation, AWS SAM transforme votre AWS SAM ressources dans CloudFormation ressources. Pour plus d’informations, consultez Générées CloudFormation ressources pour AWS SAM.
Syntaxe
Pour déclarer cette entité dans votre AWS Serverless Application Model (AWS SAM) modèle, utilisez la syntaxe suivante.
YAML
Type: AWS::Serverless::Function Properties: Architectures:ListAssumeRolePolicyDocument:JSONAutoPublishAlias:StringAutoPublishAliasAllProperties:BooleanAutoPublishCodeSha256:StringCapacityProviderConfig:CapacityProviderConfigCodeSigningConfigArn:StringCodeUri:String | FunctionCodeDeadLetterQueue:Map | DeadLetterQueueDeploymentPreference:DeploymentPreferenceDescription:StringDurableConfig:DurableConfigEnvironment:EnvironmentEphemeralStorage:EphemeralStorageEventInvokeConfig:EventInvokeConfigurationEvents:EventSourceFileSystemConfigs:ListFunctionName:StringFunctionScalingConfig:FunctionScalingConfigFunctionUrlConfig:FunctionUrlConfigHandler:StringImageConfig:ImageConfigImageUri:StringInlineCode:StringKmsKeyArn:StringLayers:ListLoggingConfig:LoggingConfigMemorySize:IntegerPackageType:StringPermissionsBoundary:StringPolicies:String | List | MapPublishToLatestPublished:BooleanPropagateTags:BooleanProvisionedConcurrencyConfig:ProvisionedConcurrencyConfigRecursiveLoop:StringReservedConcurrentExecutions:IntegerRole:StringRolePath:StringRuntime:StringRuntimeManagementConfig:RuntimeManagementConfigSnapStart:SnapStartSourceKMSKeyArn:StringTags:MapTenancyConfig:TenancyConfigTimeout:IntegerTracing:StringVersionDescription:StringVersionDeletionPolicy:StringVpcConfig:VpcConfig
Propriétés
-
Architectures -
Architecture du jeu d'instructions de la fonction.
Pour en savoir plus sur cette propriété, consultez Architectures du jeu d'instructions Lambda dans leguide du développeur AWS Lambda .
Valeurs valides : Une de
x86_64ouarm64Type : liste
Obligatoire : non
Par défaut :
x86_64CloudFormation compatibilité: Cette propriété est transmise directement au
Architecturespropriété d'unAWS::Lambda::Functionressource. -
AssumeRolePolicyDocument -
Ajoute un AssumeRolePolicyDocument pour la valeur par défaut créée
Rolepour cette fonction. Si cette propriété n'est pas spécifiée, AWS SAM ajoute un rôle d'assume par défaut pour cette fonction.Type : JSON
Obligatoire : non
CloudFormation compatibilité: Cette propriété est similaire à la
AssumeRolePolicyDocumentpropriété d'unAWS::IAM::Roleressource. AWS SAM ajoute cette propriété au rôle IAM généré pour cette fonction. Si l'Amazon Resource Name (ARN) d'un rôle est fourni pour cette fonction, cette propriété ne fait rien. -
AutoPublishAlias -
Le nom de l'alias Lambda. Pour plus d'informations sur l'utilisation des alias Lambda, consultez Alias de fonction Lambda dans le Guide du développeur AWS Lambda . Pour obtenir des exemples qui utilisent cette propriété, consultez Déploiement progressif d'applications sans serveur avec AWS SAM.
AWS SAM génère AWS::Lambda::Version et AWS::Lambda::Alias ressources lorsque cette propriété est définie. Pour plus d'informations sur ce scénario, consultez AutoPublishAlias la propriété est spécifiée. Pour des informations générales sur les produits générés CloudFormation ressources, voir Générées CloudFormation ressources pour AWS SAM.
Publication de versions et fonctions intrinsèquesAWS SAM détermine s'il faut publier une nouvelle version en comparant les valeurs des propriétés du modèle entre les déploiements. Pour les valeurs fournies par des fonctions intrinsèques, AWS SAM compare la référence non résolue, et non la valeur résolue. Un exemple est une variable d'environnement définie sur
!Refd'un paramètre de modèle.Si un déploiement modifie uniquement la valeur d'un paramètre de pile, le modèle lui-même reste inchangé. Dans ce cas, AWS SAM ne publie pas de nouvelle version et ne met pas à jour l'alias. AWS SAM applique la modification à la fonction
$LATESTversion uniquement. Pour les solutions de contournement, voir l'exemple utilisant AWS::LanguageExtensions.Type : chaîne
Obligatoire : non
CloudFormation compatibilité: Cette propriété est unique à AWS SAM et n'a pas de CloudFormation équivalent.
-
AutoPublishAliasAllProperties -
Spécifie quand une nouvelle version
AWS::Lambda::Versionest créée. Lorsque l'option esttrue, une nouvelle version Lambda est créée lorsqu'une propriété de la fonction Lambda est modifiée. Lorsque l'option estfalse, une nouvelle version Lambda est créée uniquement lorsque l'une des propriétés suivantes est modifiée :-
Environment,MemorySize, ouSnapStart. -
Toute modification entraînant une mise à jour de la propriété du
Code, telle queCodeDict,ImageUriouInlineCode.
Modifications des paramètres et publication des versionsAWS SAM publie une nouvelle version uniquement lorsque la valeur d'une propriété change dans le modèle. Si la valeur d'une propriété provient d'une fonction intrinsèque, AWS SAM voit la référence non résolue. Un exemple est une variable d'environnement définie comme
!Refd'un paramètre de modèle. Les déploiements qui modifient uniquement la valeur du paramètre ne publient pas de nouvelle version, même avecAutoPublishAliasAllProperties: true. AWS SAM applique la modification à$LATESTuniquement.Utilisez l'une des solutions suivantes pour forcer AWS SAM pour publier une nouvelle version lorsque seule la valeur d'un paramètre change :
-
Norme AWS SAM et CloudFormation déploiements: ajoutez le AWS::LanguageExtensions transformer avant
AWS::Serverless-2016-10-31dans votre modèleTransformsection. CloudFormation résout les références à leurs valeurs réelles avant AWS SAM calcule le hachage de version. Une modification de la valeur du paramètre permet ensuite de publier une nouvelle version et de mettre à jour l'alias :Transform: - AWS::LanguageExtensions - AWS::Serverless-2016-10-31 -
AWS Serverless Application Repository applications: le AWS Serverless Application Repository ne prend en charge que
AWS::Serverless-2016-10-31transformer et rejeter les modèles qui déclarentAWS::LanguageExtensions. Pour les applications que vous publiez via AWS Serverless Application Repository, fournissez la valeur directement sous forme de littéral dans le modèle au lieu de faire référence à un paramètre. Cela rend le changement visible lorsque AWS SAM calcule le hachage de version.
Cette propriété nécessite que
AutoPublishAliassoit défini.Si
AutoPublishCodeSha256est également spécifié, son comportement est prioritaire surAutoPublishAliasAllProperties: true.Type : valeur booléenne
Obligatoire : non
Valeur par défaut :
falseCloudFormation compatibilité: Cette propriété est unique à AWS SAM et n'a pas de CloudFormation équivalent.
-
-
AutoPublishCodeSha256 -
Lorsqu'elle est utilisée, cette chaîne fonctionne avec le
CodeUrivaleur pour déterminer si une nouvelle version de Lambda doit être publiée. Cette propriété est souvent utilisée pour résoudre le problème de déploiement suivant : Un package de déploiement est stocké dans un emplacement Amazon S3 et est remplacé par un nouveau package de déploiement avec un code de fonction Lambda mis à jour, maisCodeUrila propriété reste inchangée (par opposition au téléchargement du nouveau package de déploiement vers un nouvel emplacement Amazon S3 etCodeUrien cours de transfert vers le nouvel emplacement).Ce problème est marqué par un AWS SAM un modèle présentant les caractéristiques suivantes :
Le
DeploymentPreferencel'objet est configuré pour des déploiements progressifs (comme décrit dans Déploiement progressif d'applications sans serveur avec AWS SAM)Le
AutoPublishAliasla propriété est définie et ne change pas entre les déploiementsLe
CodeUrila propriété est définie et ne change pas entre les déploiements.
Dans ce scénario, la mise à jour des résultats
AutoPublishCodeSha256entraîne la création d'une nouvelle version Lambda. Toutefois, le nouveau code de fonction déployé sur Amazon S3 n'est pas reconnu. Pour reconnaître le nouveau code de fonction, pensez à utiliser la gestion des versions dans votre compartiment Amazon S3. Spécifiez la propriétéVersionde votre fonction Lambda et configurez votre compartiment pour qu'il utilise toujours le dernier Package de déploiement.Dans ce scénario, pour déclencher le déploiement progressif avec succès, vous devez fournir une valeur unique pour
AutoPublishCodeSha256.Type : chaîne
Obligatoire : non
CloudFormation compatibilité: Cette propriété est unique à AWS SAM et n'a pas de CloudFormation équivalent.
-
CapacityProviderConfig -
Configure le fournisseur de capacité auquel les versions publiées de la fonction seront jointes. Cela permet à la fonction de s'exécuter sur des instances EC2 appartenant au client et gérées par des instances gérées par Lambda Managed Instances.
Type : CapacityProviderConfig
Obligatoire : non
CloudFormation compatibilité: SAM aplatit la propriété transmise au
CapacityProviderConfigpropriété d'unAWS::Lambda::Functionressource et reconstruit la structure imbriquée. -
CodeSigningConfigArn -
L'ARN de la ressource AWS::Lambda::CodeSigningConfig, utilisée pour activer la signature de code pour cette fonction. Pour plus d'informations sur la signature de code, consultez Configurez la signature de code pour votre AWS SAM vigie.
Type : chaîne
Obligatoire : non
CloudFormation compatibilité: Cette propriété est transmise directement au
CodeSigningConfigArnpropriété d'unAWS::Lambda::Functionressource. -
CodeUri -
Code pour la fonction. Les valeurs acceptées incluent :
-
l'URI Amazon S3 de la fonction ; Par exemple :
s3://bucket-123456789/sam-app/1234567890abcdefg. -
le chemin local vers la fonction. Par exemple :
hello_world/. -
Un objet FunctionCode.
NoteSi vous fournissez l'URI Amazon S3 d'une fonction ou l'objet FunctionCode, vous devez référencer un package de déploiement Lambda valide.
Si vous fournissez un chemin de fichier local, utilisez la CLI AWS SAM pour charger le fichier local lors du déploiement. Pour en savoir plus, consultez Comment ? AWS SAM télécharge les fichiers locaux lors du déploiement.
Si vous utilisez des fonctions intrinsèques dans
CodeUripropriété, AWS SAM ne sera pas en mesure d'analyser correctement les valeurs. Pensez à utiliser AWS::LanguageExtensions transformer au lieu de cela.Type : [ chaîne de caractères | FunctionCode ]
Obligatoire : selon les conditions. Lorsque
PackageTypeest défini surZip, unCodeUriou unInlineCodeest requis.CloudFormation compatibilité: Cette propriété est similaire à la
Codepropriété d'unAWS::Lambda::Functionressource. Les propriétés imbriquées d'Amazon S3 sont nommées différemment. -
-
DeadLetterQueue -
Configure une rubrique Amazon Simple Notification Service (Amazon SNS) ou une file d'attente Amazon Simple Queue Service (Amazon SQS) où Lambda envoie les événements qu'il ne peut pas traiter. Pour plus d'informations sur la fonctionnalité des files d'attente de lettres mortes, voir Dead-letter files d'attente dans le AWS Lambda Guide du développeur.
NoteSi la source d'événements de votre fonction Lambda est une file d'attente Amazon SQS, configurez une file d'attente de lettres mortes pour la file d'attente source, et pas pour la fonction Lambda. La file d'attente de lettres mortes que vous configurez pour une fonction est utilisée pour la file d'attente d'invocations asynchrones de la fonction et pas pour les files d'attente source d'événement.
Tapez: Carte | DeadLetterQueue
Obligatoire : non
CloudFormation compatibilité: Cette propriété est similaire à la
DeadLetterConfigpropriété d'unAWS::Lambda::Functionressource. Dans CloudFormation le type est dérivé duTargetArn, alors que dans AWS SAM vous devez transmettre le type avec leTargetArn. -
DeploymentPreference -
Les paramètres permettant d’activer les déploiements Lambda progressifs.
Si un
DeploymentPreferencel'objet est spécifié, AWS SAM crée un AWS::CodeDeploy::Application appeléServerlessDeploymentApplication(un par pile), un AWS::CodeDeploy::DeploymentGroup appelé, et un AWS::IAM::Role appelé<function-logical-id>DeploymentGroupCodeDeployServiceRole.Type : DeploymentPreference
Obligatoire : non
CloudFormation compatibilité: Cette propriété est unique à AWS SAM et n'a pas de CloudFormation équivalent.
Voir aussi : pour plus d'informations sur cette propriété, consultez Déploiement progressif d'applications sans serveur avec AWS SAM.
-
Description -
Description de la fonction.
Type : chaîne
Obligatoire : non
CloudFormation compatibilité: Cette propriété est transmise directement au
Descriptionpropriété d'unAWS::Lambda::Functionressource. -
DurableConfig -
Configuration pour des fonctions durables. Permet une exécution dynamique avec des fonctions de contrôle et de relecture automatiques.
Type : DurableConfig
Obligatoire : non
CloudFormation compatibilité: Cette propriété est unique à AWS SAM et n'a pas de CloudFormation équivalent.
-
Environment -
La configuration de l'environnement d'exécution.
Type : Environment
Obligatoire : non
CloudFormation compatibilité: Cette propriété est transmise directement au
Environmentpropriété d'unAWS::Lambda::Functionressource. -
EphemeralStorage -
Objet qui spécifie l'espace disque, en Mo, disponible pour votre fonction Lambda dans
/tmp.Pour plus d'informations sur cette propriété, consultez Environnement d’exécution Lambda dans le Guide du développeur AWS Lambda .
Type : EphemeralStorage
Obligatoire : non
CloudFormation compatibilité: Cette propriété est transmise directement au
EphemeralStoragepropriété d'unAWS::Lambda::Functionressource. -
EventInvokeConfig -
L'objet qui décrit l'événement appelle la configuration sur une fonction Lambda.
Type : EventInvokeConfiguration
Obligatoire : non
CloudFormation compatibilité: Cette propriété est unique à AWS SAM et n'a pas de CloudFormation équivalent.
-
Events -
Spécifie les événements qui déclenchent cette fonction. Les événements sont constitués d'un type et d'un ensemble de propriétés qui dépendent du type.
Type : EventSource
Obligatoire : non
CloudFormation compatibilité: Cette propriété est unique à AWS SAM et n'a pas de CloudFormation équivalent.
-
FileSystemConfigs -
Liste des FileSystemConfig objets qui spécifient les paramètres de connexion pour un système de fichiers Amazon Elastic File System (Amazon EFS) ou un système de fichiers Amazon S3 Files. Vous pouvez associer un point d'accès Amazon EFS ou un point d'accès S3 Files, mais pas les deux.
Chaque
FileSystemConfigl'objet contient unArn(l'ARN du point d'accès) et unLocalMountPath(le chemin où le système de fichiers est monté dans la fonction). Pour Amazon EFS, l'ARN est un ARN de point d'accès Amazon EFS. Pour les fichiers S3, l'ARN est unAWS::S3Files::AccessPointARN.Si votre modèle contient une ressource AWS::EFS::MountTarget, vous devez également préciser un
DependsOnattribut pour vous assurer que la cible de montage est créée ou mise à jour avant la fonction. De même, si votre modèle contient unAWS::S3Files::MountTargetressource, vous devez spécifier unDependsOnattribut pour la cible de montage S3 Files.Type : liste
Obligatoire : non
CloudFormation compatibilité: Cette propriété est transmise directement au
FileSystemConfigspropriété d'unAWS::Lambda::Functionressource. -
FunctionName -
Nom de la fonction. Si vous ne spécifiez aucun nom, un nom unique sera généré pour vous.
Type : chaîne
Obligatoire : non
CloudFormation compatibilité: Cette propriété est transmise directement au
FunctionNamepropriété d'unAWS::Lambda::Functionressource. -
FunctionScalingConfig -
Configure le comportement de dimensionnement des fonctions Lambda exécutées sur des fournisseurs de capacité. Définit le nombre minimum et maximum d'environnements d'exécution.
Type : FunctionScalingConfig
Obligatoire : non
CloudFormation compatibilité: Cette propriété est transmise directement au
FunctionScalingConfigpropriété d'unAWS::Lambda::Functionressource. -
FunctionUrlConfig -
Objet qui décrit l'URL d'une fonction. Une URL de fonction est un point de terminaison HTTPS que vous pouvez utiliser pour appeler votre fonction.
Pour plus d'informations, veuillez consulter Function URLs (URL de fonction) dans le Guide du développeur AWS Lambda .
Type : FunctionUrlConfig
Obligatoire : non
CloudFormation compatibilité: Cette propriété est unique à AWS SAM et n'a pas de CloudFormation équivalent.
-
Handler -
La fonction dans votre code qui est appelée pour commencer l'exécution. Cette propriété n'est requise que si la propriété
PackageTypeest définie surZip.Type : chaîne
Obligatoire : Conditionnelle
CloudFormation compatibilité: Cette propriété est transmise directement au
Handlerpropriété d'unAWS::Lambda::Functionressource. -
ImageConfig -
Objet utilisé pour configurer les paramètres d'image du conteneur Lambda. Pour plus d'informations sur l'utilisation de Lambda, consultez la section Mise en route avec Lambda du Guide du développeur AWS Lambda .
Type : ImageConfig
Obligatoire : non
CloudFormation compatibilité: Cette propriété est transmise directement au
ImageConfigpropriété d'unAWS::Lambda::Functionressource. -
ImageUri -
L'URI du référentiel Amazon Elastic Container Registry (Amazon ECR) pour l'image de conteneur de la fonction Lambda. Cette propriété s'applique uniquement si la propriété
PackageTypeest définie surImage, sinon, elle est ignorée. Pour plus d'informations, consultez la section Utilisation d'images de conteneur avec Lambda dans le Guide du développeur AWS Lambda .NoteSi le
PackageTypela propriété est définie surImage, puis soitImageUriest obligatoire, ou vous devez créer votre application avec les éléments nécessairesMetadataentrées dans le AWS SAM fichier modèle. Pour plus d’informations, consultez Compilation par défaut avec AWS SAM.Créer votre application avec les
Metadatanécessaires, les entrées sont prioritaires surImageUri, donc si vous précisez les deux, alorsImageUrisera ignoré.Type : chaîne
Obligatoire : non
CloudFormation compatibilité: Cette propriété est transmise directement au
ImageUripropriété duAWS::Lambda::FunctionCodetype de données. -
InlineCode -
Le code de fonction Lambda qui est écrit directement dans le modèle. Cette propriété s'applique uniquement si la propriété
PackageTypeest définie surZip, sinon, elle est ignorée.NoteSi la propriété
PackageTypeest définie surZip(par défaut), alors l'un desCodeUriouInlineCodeest requis.Type : chaîne
Obligatoire : Conditionnelle
CloudFormation compatibilité: Cette propriété est transmise directement au
ZipFilepropriété duAWS::Lambda::FunctionCodetype de données. -
KmsKeyArn -
L'ARN d'un AWS Key Management Service (AWS KMS) clé que Lambda utilise pour chiffrer et déchiffrer les variables d'environnement de votre fonction.
Type : chaîne
Obligatoire : non
CloudFormation compatibilité: Cette propriété est transmise directement au
KmsKeyArnpropriété d'unAWS::Lambda::Functionressource. -
Layers -
Liste des éléments ARN
LayerVersionque cette fonction devrait utiliser. L'ordre spécifié ici est l'ordre dans lequel ils seront importés lors de l'exécution de la fonction Lambda. La version est soit un ARN complet, y compris la version, soit une référence à un LayerVersion ressource. Par exemple, une référence àLayerVersionsera!Ref MyLayertandis qu'un ARN complet, y compris la version, seraarn:aws:lambda:.region:account-id:layer:layer-name:versionType : liste
Obligatoire : non
CloudFormation compatibilité: Cette propriété est transmise directement au
Layerspropriété d'unAWS::Lambda::Functionressource. -
LoggingConfig -
La fonction est Amazon CloudWatch Consigne les paramètres de configuration.
Type : LoggingConfig
Obligatoire : non
CloudFormation compatibilité: Cette propriété est transmise directement au
LoggingConfigpropriété d'unAWS::Lambda::Functionressource. -
MemorySize -
La taille de la mémoire en Mo allouée par invocation de la fonction.
Type : entier
Obligatoire : non
CloudFormation compatibilité: Cette propriété est transmise directement au
MemorySizepropriété d'unAWS::Lambda::Functionressource. -
PackageType -
Le package de déploiement de la fonction Lambda. Pour plus d'informations, consultez Packages de déploiement M Lambda dans le Guide du développeur AWS Lambda .
Remarques :
1. Si cette propriété est définie sur
Zip(par défaut), alors soitCodeUriouInlineCodes'applique, etImageUriest ignoré.2. Si cette propriété est définie sur
Image, alors uniquementImageUris'applique, etCodeUrietInlineCodesont ignorés. Le référentiel Amazon ECR requis pour stocker l'image du conteneur de la fonction peut être créé automatiquement par AWS SAM CLI. Pour plus d’informations, consultez déploiement sam.Valeurs valides :
ZipouImageType : chaîne
Obligatoire : non
Par défaut :
ZipCloudFormation compatibilité: Cette propriété est transmise directement au
PackageTypepropriété d'unAWS::Lambda::Functionressource. -
PermissionsBoundary -
L'ARN d'une limite d'autorisations à utiliser pour le rôle d'exécution de cette fonction. Cette propriété ne fonctionne que si le rôle est généré pour vous.
Type : chaîne
Obligatoire : non
CloudFormation compatibilité: Cette propriété est transmise directement au
PermissionsBoundarypropriété d'unAWS::IAM::Roleressource. -
Policies -
Politiques d'autorisation pour cette fonction. Les politiques seront ajoutées à la valeur par défaut de la fonction Gestion des identités et des accès AWS rôle d'exécution (IAM).
Cette propriété accepte une valeur unique ou une liste de valeurs. Les valeurs autorisées sont les suivantes :
-
L'ARN d'une politique gérée par AWS ou d'une politique gérée par le client.
-
Le nom d'un AWS politique gérée à partir des éléments suivants lister
. -
Une politique IAM en ligne formatée dans YAML sous forme de mappage.
NoteSi vous définissez la propriété
Role, cette propriété est ignorée.Type : chaîne | liste | carte
Obligatoire : non
CloudFormation compatibilité: Cette propriété est similaire à la
Policiespropriété d'unAWS::IAM::Roleressource. -
PublishToLatestPublished -
Spécifie s'il faut publier la dernière version de la fonction lorsque celle-ci est mise à jour.
Type : valeur booléenne
Obligatoire : non
CloudFormation compatibilité: Cette propriété est transmise directement au
PublishToLatestPublishedpropriété d'unAWS::Lambda::Functionressource. -
Indiquez s'il faut ou non transmettre les balises de la propriété
Tagsaux ressources AWS::Serverless::Function que vous avez générées. SpécifiezTruepour la propagation des balises dans vos ressources générées.Type : valeur booléenne
Obligatoire : non
Par défaut :
FalseCloudFormation compatibilité: Cette propriété est unique à AWS SAM et n'a pas de CloudFormation équivalent.
-
ProvisionedConcurrencyConfig -
La configuration de la simultanéité allouée pour l'alias d'une fonction.
NoteProvisionedConcurrencyConfigpeut être spécifiée uniquement siAutoPublishAliasest définie. Si vous ne le faites pas, une erreur se produit.Type : ProvisionedConcurrencyConfig
Obligatoire : non
CloudFormation compatibilité: Cette propriété est transmise directement au
ProvisionedConcurrencyConfigpropriété d'unAWS::Lambda::Aliasressource. -
RecursiveLoop -
État de la configuration de détection de boucle récursive de votre fonction.
Lorsque cette valeur est définie sur
Allowet Lambda détecte que votre fonction est invoquée dans le cadre d'une boucle récursive, il n'entreprend aucune action.Lorsque cette valeur est définie sur
Terminateet Lambda détecte que votre fonction est invoquée dans le cadre d'une boucle récursive, il arrête l'appel de votre fonction et vous en informe.Type : chaîne
Obligatoire : non
CloudFormation compatibilité: Cette propriété est transmise directement au
RecursiveLooppropriété duAWS::Lambda::Functionressource. -
ReservedConcurrentExecutions -
Le nombre maximum d'exécutions simultanées à réserver pour la fonction.
Pour plus d'informations sur cette propriété, consultez Mise à échelle de fonction Lambda dans le Guide du développeur AWS Lambda .
Type : entier
Obligatoire : non
CloudFormation compatibilité: Cette propriété est transmise directement au
ReservedConcurrentExecutionspropriété d'unAWS::Lambda::Functionressource. -
Role -
L'ARN d'un rôle IAM à utiliser comme rôle d'exécution de cette fonction.
Type : chaîne
Obligatoire : non
CloudFormation compatibilité: Cette propriété est similaire à la
Rolepropriété d'unAWS::Lambda::Functionressource. Ceci est obligatoire dans CloudFormation mais pas dans AWS SAM. Si aucun rôle n'est spécifié, un rôle est créé pour vous avec une ID logique de.<function-logical-id>Role -
RolePath -
Chemin d'accès du rôle d'exécution IAM de la fonction.
Utilisez cette propriété lorsque le rôle est généré pour vous. Ne l'utilisez pas lorsque le rôle est spécifié avec la propriété
Role.Type : chaîne
Obligatoire : Conditionnelle
CloudFormation compatibilité: Cette propriété est transmise directement au
Pathpropriété d'unAWS::IAM::Roleressource. -
Runtime -
Identifiant de l’exécution de la fonction. Cette propriété n'est requise que si la propriété
PackageTypeest définie surZip.NoteSi vous spécifiez
providedidentifiant pour cette propriété, vous pouvez utiliser leMetadataattribut de ressource à instruire AWS SAM pour créer le runtime personnalisé requis par cette fonction. Pour plus d'informations sur la création d'une exécution personnalisée, consultez Création de fonctions d'événement Lambda avec des environnements d'exécution personnalisés dans AWS SAM.Type : chaîne
Obligatoire : Conditionnelle
CloudFormation compatibilité: Cette propriété est transmise directement au
Runtimepropriété d'unAWS::Lambda::Functionressource. -
RuntimeManagementConfig -
Configurez les options de gestion de l'exécution pour vos fonctions Lambda, telles que les mises à jour de l'environnement d'exécution, le comportement d'annulation et la sélection d'une version d'exécution spécifique. Pour en savoir plus, consultez les mises à jour du temps d'exécution Lambda dans le Guide du développeur AWS Lambda .
Type : RuntimeManagementConfig
Obligatoire : non
CloudFormation compatibilité: Cette propriété est transmise directement au
RuntimeManagementConfigpropriété d'unAWS::Lambda::Functionressource. -
SnapStart -
Créez un instantané de toute nouvelle version de fonction Lambda. Un instantané est un état mis en cache de votre fonction initialisée, y compris de toutes ses dépendances. La fonction n'est initialisée qu'une seule fois et l'état mis en cache est réutilisé pour tous les appels futurs, ce qui améliore les performances de l'application en réduisant le nombre de fois que votre fonction doit être initialisée. Pour en savoir plus, consultez Améliorer les performances de démarrage avec Lambda SnapStart dans le AWS Lambda Guide du développeur.
Type : SnapStart
Obligatoire : non
CloudFormation compatibilité: Cette propriété est transmise directement au
SnapStartpropriété d'unAWS::Lambda::Functionressource. -
SourceKMSKeyArn -
Représente un ARN de clé KMS utilisé pour chiffrer le code de fonction ZIP du client.
Type : chaîne
Obligatoire : non
CloudFormation compatibilité: Cette propriété est transmise directement au
SourceKMSKeyArnpropriété d'unAWS::Lambda::FunctionCodetype de données. -
Un mappage (chaîne à chaîne) qui spécifie les balises ajoutées à cette fonction. Pour en savoir plus sur les clés et les valeurs valides pour les étiquettes, consultez Exigences relatives à la clé et à la valeur des étiquettes dans le guide du développeur AWS Lambda .
Lorsque la pile est créée, AWS SAM ajoute automatiquement un
lambda:createdBy:SAMbalise à cette fonction Lambda et aux rôles par défaut générés pour cette fonction.Type: carte (map)
Obligatoire : non
CloudFormation compatibilité: Cette propriété est similaire à la
Tagspropriété d'unAWS::Lambda::Functionressource. LeTagspropriété en AWS SAM se compose de paires clé-valeur (alors que dans CloudFormation cette propriété se compose d'une liste deTagobjets). En outre, AWS SAM ajoute automatiquement unlambda:createdBy:SAMbalise à cette fonction Lambda et aux rôles par défaut générés pour cette fonction. -
TenancyConfig -
Configuration pour le mode d'isolation des locataires Lambda. Garantit que les environnements d'exécution ne sont jamais partagés entre différents identifiants de locataires, fournissant ainsi une isolation au niveau du calcul pour les applications multi-locataires.
Type : TenancyConfig
Obligatoire : non
CloudFormation compatibilité: Cette propriété est transmise directement au
TenancyConfigpropriété d'unAWS::Lambda::Functionressource. -
Timeout -
La durée maximale en secondes pendant laquelle la fonction peut s'exécuter avant qu'elle ne soit arrêtée.
Type : entier
Obligatoire : non
Par défaut : 3
CloudFormation compatibilité: Cette propriété est transmise directement au
Timeoutpropriété d'unAWS::Lambda::Functionressource. -
Tracing -
La chaîne qui spécifie la fonction X-Ray mode de traçage.
-
Active— Active X-Ray traçage de la fonction. -
Disabled— Désactive X-Ray pour la fonction. -
PassThrough— Active X-Ray traçage de la fonction. La décision d'échantillonnage est déléguée aux services en aval.
Si défini sur
ActiveouPassThroughet que la propriétéRolen'est pas spécifiée, AWS SAM ajoute la stratégiearn:aws:iam::aws:policy/AWSXrayWriteOnlyAccessau rôle d'exécution Lambda qu'il crée pour vous.Pour plus d'informations sur X-Ray, voir En utilisant AWS Lambda avec AWS X-Ray dans le AWS Lambda Guide du développeur.
Valeurs valides : [
Active|Disabled|PassThrough]Type : chaîne
Obligatoire : non
CloudFormation compatibilité: Cette propriété est similaire à la
TracingConfigpropriété d'unAWS::Lambda::Functionressource. -
-
VersionDescription -
Spécifie le champ
Descriptionqui est ajouté sur la nouvelle ressource de version Lambda.Type : chaîne
Obligatoire : non
CloudFormation compatibilité: Cette propriété est transmise directement au
Descriptionpropriété d'unAWS::Lambda::Versionressource. -
VersionDeletionPolicy -
Spécifie la politique de suppression pour la ressource de version Lambda qui est créée lorsque
AutoPublishAliasest réglé. Cela contrôle si la ressource de version est conservée ou supprimée lors de la suppression de la pile.Valeurs valides :
Delete,RetainouSnapshotType : chaîne
Obligatoire : non
CloudFormation compatibilité: Cette propriété est unique à AWS SAM et n'a pas de CloudFormation équivalent. Il définit le
DeletionPolicyattribut sur le produitAWS::Lambda::Versionressource. -
VpcConfig -
La configuration qui permet à cette fonction d'accéder aux ressources privées dans votre VPC (Virtual Private Cloud).
Type : VpcConfig
Obligatoire : non
CloudFormation compatibilité: Cette propriété est transmise directement au
VpcConfigpropriété d'unAWS::Lambda::Functionressource.
Valeurs renvoyées
Réf
Lorsque l'ID logique de cette ressource est fournie à la fonction intrinsèque Ref, elle renvoie le nom de la ressource Lambda sous-jacente.
Pour plus d'informations sur l'utilisation de la fonction Ref, consultez Ref dans le Guide de l'utilisateur AWS CloudFormation .
Ventilateur :GetAtt
Fn::GetAtt renvoie une valeur pour un attribut de ce type indiqué. Voici les attributs disponibles et des exemples de valeurs de retour.
Pour plus d'informations sur l'utilisation de Fn::GetAtt, consultez Fn::GetAtt dans le Guide de l'utilisateur AWS CloudFormation .
Arn-
L'ARN de la fonction Lambda sous-jacente.
Exemples
Fonction simple
Ce qui suit est un exemple basique d'une ressource AWS::Serverless::Fonction du type de package Zip (par défaut) et du code de fonction dans un compartiment Amazon S3.
YAML
Type: AWS::Serverless::Function Properties: Handler: index.handler Runtime: python3.9 CodeUri: s3://bucket-name/key-name
Exemple de propriétés de fonction
Voici un exemple de AWS::Serverless::Fonction du type de colis Zip (par défaut) qui utilise InlineCode, Layers, Tracing, Policies, Amazon EFS système de fichiers, et Api source de l'événement.
YAML
Type: AWS::Serverless::Function DependsOn: MyMountTarget # This is needed if an AWS::EFS::MountTarget resource is declared for EFS Properties: Handler: index.handler Runtime: python3.9 InlineCode: | def handler(event, context): print("Hello, world!") ReservedConcurrentExecutions: 30 Layers: - Ref: MyLayer Tracing: Active Timeout: 120 FileSystemConfigs: - Arn: !Ref MyEfsFileSystem LocalMountPath: /mnt/EFS Policies: - AWSLambdaExecute - Version: '2012-10-17' Statement: - Effect: Allow Action: - s3:GetObject - s3:GetObjectACL Resource: 'arn:aws:s3:::sam-s3-demo-bucket/*' Events: ApiEvent: Type: Api Properties: Path: /path Method: get
ImageConfig exemple
Voici un exemple d'ImageConfig pour une fonction Lambda de type de package Image.
YAML
HelloWorldFunction: Type: AWS::Serverless::Function Properties: PackageType: Image ImageUri:account-id.dkr.ecr.region.amazonaws.com/ecr-repo-name:image-nameImageConfig: Command: - "app.lambda_handler" EntryPoint: - "entrypoint1" WorkingDirectory: "workDir"
RuntimeManagementConfig exemples
Une fonction Lambda configurée pour mettre à jour son environnement d'exécution en fonction du comportement actuel :
TestFunction Type: AWS::Serverless::Function Properties: ... Runtime: python3.9 RuntimeManagementConfig: UpdateRuntimeOn: Auto
Une fonction Lambda configurée pour mettre à jour son environnement d'exécution lorsque la fonction est mise à jour :
TestFunction Type: AWS::Serverless::Function Properties: ... Runtime: python3.9 RuntimeManagementConfig: UpdateRuntimeOn: FunctionUpdate
Une fonction Lambda configurée pour mettre à jour manuellement son environnement d'exécution :
TestFunction Type: AWS::Serverless::Function Properties: ... Runtime: python3.9 RuntimeManagementConfig: RuntimeVersionArn: arn:aws:lambda:us-east-1::runtime:4c459dd0104ee29ec65dcad056c0b3ddbe20d6db76b265ade7eda9a066859b1e UpdateRuntimeOn: Manual
SnapStart exemples
Exemple de fonction Lambda avec SnapStart activé pour les versions futures :
TestFunc Type: AWS::Serverless::Function Properties: ... SnapStart: ApplyOn: PublishedVersions
TenancyConfig exemples
Exemple de fonction Lambda avec le mode d'isolation des locataires activé :
TestFunction Type: AWS::Serverless::Function Properties: ... TenancyConfig: TenantIsolationMode: PER_TENANT
Exemple de système de fichiers S3 Files
L'exemple suivant crée une fonction Lambda qui monte un système de fichiers Amazon S3 Files. Le modèle crée un compartiment S3, un système de fichiers S3 Files soutenu par ce compartiment, une cible de montage dans un sous-réseau VPC et un point d'accès. La fonction monte le point d'accès à /mnt/s3files et peut lire et écrire des fichiers synchronisés avec le compartiment S3.
Vous pouvez associer un système de fichiers Amazon EFS ou un système de fichiers S3 Files à une fonction Lambda, mais pas les deux en même temps.
YAML
AWSTemplateFormatVersion: '2010-09-09' Transform: AWS::Serverless-2016-10-31 Description: Lambda function with S3 Files file system Resources: # VPC and networking MyVpc: Type: AWS::EC2::VPC Properties: CidrBlock: 10.0.0.0/16 EnableDnsSupport: true EnableDnsHostnames: true MySubnet: Type: AWS::EC2::Subnet Properties: VpcId: !Ref MyVpc CidrBlock: 10.0.1.0/24 AvailabilityZone: !Select [0, !GetAZs ''] MySecurityGroup: Type: AWS::EC2::SecurityGroup Properties: GroupDescription: Security group for Lambda and S3 Files VpcId: !Ref MyVpc SecurityGroupIngress: - IpProtocol: tcp FromPort: 2049 ToPort: 2049 CidrIp: 10.0.0.0/16 # S3 bucket for file storage MyS3Bucket: Type: AWS::S3::Bucket # IAM role for S3 Files to access the bucket S3FilesRole: Type: AWS::IAM::Role Properties: AssumeRolePolicyDocument: Version: '2012-10-17' Statement: - Effect: Allow Principal: Service: elasticfilesystem.amazonaws.com Action: sts:AssumeRole Policies: - PolicyName: S3FilesBucketAccess PolicyDocument: Version: '2012-10-17' Statement: - Effect: Allow Action: - s3:GetObject - s3:PutObject - s3:DeleteObject - s3:ListBucket Resource: - !GetAtt MyS3Bucket.Arn - !Sub '${MyS3Bucket.Arn}/*' # S3 Files resources MyS3FilesFileSystem: Type: AWS::S3Files::FileSystem Properties: Bucket: !GetAtt MyS3Bucket.Arn RoleArn: !GetAtt S3FilesRole.Arn MyS3FilesMountTarget: Type: AWS::S3Files::MountTarget Properties: FileSystemId: !Ref MyS3FilesFileSystem SubnetId: !Ref MySubnet SecurityGroups: - !Ref MySecurityGroup MyS3FilesAccessPoint: Type: AWS::S3Files::AccessPoint Properties: FileSystemId: !Ref MyS3FilesFileSystem PosixUser: Uid: '1000' Gid: '1000' RootDirectory: Path: /lambda CreationInfo: OwnerUid: '1000' OwnerGid: '1000' Permissions: '750' # Lambda function with S3 Files mount MyFunction: Type: AWS::Serverless::Function DependsOn: MyS3FilesMountTarget Properties: Handler: index.handler Runtime: python3.12 Timeout: 120 VpcConfig: SecurityGroupIds: - !Ref MySecurityGroup SubnetIds: - !Ref MySubnet FileSystemConfigs: - Arn: !GetAtt MyS3FilesAccessPoint.AccessPointArn LocalMountPath: /mnt/s3files Policies: - Version: '2012-10-17' Statement: - Effect: Allow Action: - s3files:ClientMount - s3files:ClientWrite Resource: !GetAtt MyS3FilesAccessPoint.AccessPointArn InlineCode: | import os def handler(event, context): # Write a file to the S3 Files mount with open('/mnt/s3files/hello.txt', 'w') as f: f.write('Hello from Lambda!') # List files at the mount path files = os.listdir('/mnt/s3files') return {'files': files}