本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
AWS::Serverless:: 函数
这个 AWS::Serverless::Function 资源创建一个 Lambda 事件函数,一个 AWS Identity and Access Management
(IAM) 执行角色和触发该函数的事件源映射。
事件函数是原始 Lambda 函数类型(以前称为 Lambda 函数)的文档名称。这个 AWS::Serverless::Function 资源类型, AWS::Lambda::Function 它生成的资源,其属性仍在使用 功能,因此您无需更改模板。
这个 AWS::Serverless:: 函数 资源还支持 Metadata 资源属性,这样你就可以指示 AWS SAM 来构建您的应用程序所需的自定义运行时。有关构建自定义运行时系统的更多信息,请参阅 在中使用自定义运行时构建 Lambda 事件函数 AWS SAM。
此资源还支持 Connectors 资源 Attribute。有关更多信息,请参阅 使用管理资源权限 AWS SAM 连接器。
当你部署到时 AWS CloudFormation, AWS SAM 改变你的 AWS SAM 资源进入 CloudFormation 资源。有关更多信息,请参阅 生成 CloudFormation 的资源 AWS SAM。
语法
在您的 AWS Serverless Application Model (AWS SAM) 模板,使用以下语法。
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
Properties
-
Architectures -
该函数的指令集架构。
有关此属性更多信息,请参阅《AWS Lambda 开发人员指南》中的 Lambda 指令集架构。
有效值:
x86_64或arm64之一。类型:列表
必需:否
默认值:
x86_64CloudFormation 兼容性: 此属性直接传递给
Architectures的财产AWS::Lambda::Function资源。 -
AssumeRolePolicyDocument -
添加一个 AssumeRolePolicyDocument 以默认方式创建
Role用于此功能。如果未指定此属性, AWS SAM 为该函数添加默认代入角色。类型:JSON
必需:否
CloudFormation 兼容性: 此属性类似于
AssumeRolePolicyDocument的财产AWS::IAM::Role资源。 AWS SAM 将此属性添加到为此函数生成的 IAM 角色中。如果为此函数提供了角色的 Amazon 资源名称(ARN),则此属性将不执行任何操作。 -
AutoPublishAlias -
Lambda 别名的名称。要了解有关 Lambda 别名的更多信息,请参阅《AWS Lambda 开发人员指南》中的 Lambda 函数别名。有关使用此属性的示例,请参见 使用以下方法逐步部署无服务器应用程序 AWS SAM。
AWS SAM 生成 AWS::Lambda::Version 和 AWS::Lambda::Alias 设置此属性时的资源。有关此场景的更多信息,请参阅AutoPublishAlias 属性已指定。有关生成的基本信息 CloudFormation 资源,请参阅 生成 CloudFormation 的资源 AWS SAM。
版本发布和内部函数AWS SAM 通过比较不同部署之间模板中的属性值来确定是否发布新版本。对于通过内部函数提供的值, AWS SAM 比较未解析的引用,而不是解析的值。一个例子是环境变量设置为
!Ref的模板参数。如果部署仅更改堆栈参数的值,则模板本身保持不变。在这种情况下, AWS SAM 不发布新版本或更新别名。 AWS SAM 将更改应用于函数的
$LATEST仅限版本。有关变通方法,请参见使用示例 AWS::LanguageExtensions。类型:字符串
必需:否
CloudFormation 兼容性: 此属性是独有的 AWS SAM 而且没有 CloudFormation 等效。
-
AutoPublishAliasAllProperties -
指定何时创建新的
AWS::Lambda::Version。当为true时,修改 Lambda 函数中的任何属性时,就会创建新的 Lambda 版本。当为false时,只有修改了以下任何属性时,才会创建新的 Lambda 版本:-
Environment、MemorySize或者SnapStart。 -
导致
Code属性更新的任何更改,例如CodeDict、ImageUri、或InlineCode。
参数更改和版本发布AWS SAM 仅当模板中属性的值发生变化时才发布新版本。如果属性值来自内部函数, AWS SAM 看到未解析的参考文献。一个例子是一个环境变量,定义为
!Ref的模板参数。仅更改参数值的部署不会发布新版本,即使AutoPublishAliasAllProperties: true。 AWS SAM 将更改应用于$LATEST只有。使用以下解决方法之一来强制 AWS SAM 要在只有参数值发生变化时发布新版本:
-
标准 AWS SAM 和 CloudFormation 部署: 添加 AWS::LanguageExtensions 转变 以前
AWS::Serverless-2016-10-31在你的模板中Transform部分。 CloudFormation 之前解析对其实际值的引用 AWS SAM 计算版本哈希。然后,对参数值的更改会发布新版本并更新别名:Transform: - AWS::LanguageExtensions - AWS::Serverless-2016-10-31 -
AWS Serverless Application Repository 应用程序: 那个 AWS Serverless Application Repository 仅支持
AWS::Serverless-2016-10-31转换和拒绝声明的模板AWS::LanguageExtensions。对于您通过发布的应用程序 AWS Serverless Application Repository,直接在模板中以文字形式提供值,而不是引用参数。这使得更改在以下情况下可见 AWS SAM 计算版本哈希。
此属性需要定义
AutoPublishAlias。如果也指定
AutoPublishCodeSha256,则其行为优先于AutoPublishAliasAllProperties: true。类型:布尔值
必需:否
默认值:
falseCloudFormation 兼容性: 此属性是独有的 AWS SAM 而且没有 CloudFormation 等效。
-
-
AutoPublishCodeSha256 -
使用时,此字符串将与
CodeUri值一起确定是否需要发布新的 Lambda 版本。此属性通常用于解决以下部署问题:部署包存储在 Amazon S3 位置,且被包含更新后的 Lambda 函数代码的新部署包取代,但CodeUri属性保持不变(相反情况是新的部署包上传到新的 Amazon S3 位置并且CodeUri更改为新位置)。此问题由一个标记 AWS SAM 模板具有以下特征:
DeploymentPreference对象配置为逐步部署(如使用以下方法逐步部署无服务器应用程序 AWS SAM中所述)AutoPublishAlias属性已设置,且在部署之间不会更改CodeUri属性已设置,且在部署之间不会更改。
在这种情况下,更新
AutoPublishCodeSha256会导致成功创建新的 Lambda 版本。但是,部署到 Amazon S3 的新函数代码将无法识别。要识别新的函数代码,请考虑在 Amazon S3 存储桶中使用版本控制。为 Lambda 函数指定Version属性,并将存储桶配置为始终使用最新的部署包。在这种情况下,要成功触发逐步部署,必须为
AutoPublishCodeSha256提供一个唯一的值。类型:字符串
必需:否
CloudFormation 兼容性: 此属性是独有的 AWS SAM 而且没有 CloudFormation 等效。
-
CapacityProviderConfig -
配置要将该函数的已发布版本附加到的容量提供者。这使该函数能够在 Lambda 托管实例管理的客户拥有的 EC2 实例上运行。
必需:否
CloudFormation 兼容性: SAM 扁平传递给的属性
CapacityProviderConfig的财产AWS::Lambda::Function资源并重建嵌套结构。 -
CodeSigningConfigArn -
AWS::Lambda::CodeSigningConfig 资源的 ARN,用于为此函数启用代码签名。有关代码签名的更多信息,请参阅 为您设置代码签名 AWS SAM 应用程序。
类型:字符串
必需:否
CloudFormation 兼容性: 此属性直接传递给
CodeSigningConfigArn的财产AWS::Lambda::Function资源。 -
CodeUri -
函数的代码。可接受的值包括:
-
该函数的 Amazon S3 URI。例如
s3://bucket-123456789/sam-app/1234567890abcdefg。 -
函数的本地路径。例如
hello_world/。 -
一个 FunctionCode 对象。
注意如果您提供函数的 Amazon S3 URI 或 FunctionCode 对象,则必须引用有效的 Lambda 部署包。
如果您提供本地文件路径,请在部署时使用 AWS SAM CLI 上传本地文件。要了解更多信息,请参阅操作方法 AWS SAM 在部署时上传本地文件。
如果你在中使用内在函数
CodeUri财产, AWS SAM 将无法正确解析这些值。考虑使用 AWS::LanguageExtensions 转变 取而代之。类型:[ 字符串 | FunctionCode ]
必填:条件性。当
PackageType设置为Zip时,则CodeUri或InlineCode中的一种为必需。CloudFormation 兼容性: 此属性类似于
Code的财产AWS::Lambda::Function资源。嵌套的 Amazon S3 属性的命名有所不同。 -
-
DeadLetterQueue -
在 Lambda 发送无法处理的事件时配置 Amazon Simple Notification Service (Amazon SNS)主题或 Amazon Simple Queue Service (Amazon SQS) 队列。有关死信队列功能的更多信息,请参阅 Dead-letter 排队 在 AWS Lambda 开发者指南。
注意如果您的 Lambda 函数的事件源是 Amazon SQS 队列,请为源队列而不是 Lambda 函数配置死信队列。您为函数配置的死信队列用于函数的异步调用队列,而不是用于事件源队列。
类型: 地图 | DeadLetterQueue
必需:否
CloudFormation 兼容性: 此属性类似于
DeadLetterConfig的财产AWS::Lambda::Function资源。在 CloudFormation 该类型源自TargetArn,而在 AWS SAM 你必须将类型与TargetArn。 -
DeploymentPreference -
用于启用逐步 Lambda 部署的设置。
如果
DeploymentPreference对象已指定, AWS SAM 创建一个 AWS::CodeDeploy::Application 叫ServerlessDeploymentApplication(每堆一个),一个 AWS::CodeDeploy::DeploymentGroup 叫,还有一个 AWS::IAM::Role 叫<function-logical-id>DeploymentGroupCodeDeployServiceRole。必需:否
CloudFormation 兼容性: 此属性是独有的 AWS SAM 而且没有 CloudFormation 等效。
另请参阅:有关此属性的更多信息,请参阅 使用以下方法逐步部署无服务器应用程序 AWS SAM。
-
Description -
该函数的描述。
类型:字符串
必需:否
CloudFormation 兼容性: 此属性直接传递给
Description的财产AWS::Lambda::Function资源。 -
DurableConfig -
耐用功能的配置。通过自动检查点和重放功能实现有状态执行。
必需:否
CloudFormation 兼容性: 此属性是独有的 AWS SAM 而且没有 CloudFormation 等效。
-
Environment -
运行时系统环境的配置。
类型:环境
必需:否
CloudFormation 兼容性: 此属性直接传递给
Environment的财产AWS::Lambda::Function资源。 -
EphemeralStorage -
指定
/tmp中 Lambda 函数可用的磁盘空间(以 MB 为单位)的对象。有关此属性的更多信息,请参阅《AWS Lambda 开发人员指南》中的 Lambda 执行环境。
必需:否
CloudFormation 兼容性: 此属性直接传递给
EphemeralStorage的财产AWS::Lambda::Function资源。 -
EventInvokeConfig -
描述 Lambda 函数的事件调用配置的对象。
必需:否
CloudFormation 兼容性: 此属性是独有的 AWS SAM 而且没有 CloudFormation 等效。
-
Events -
指定触发此函数的事件。事件由一个类型和一组依赖于该类型的属性组成。
类型:EventSource
必需:否
CloudFormation 兼容性: 此属性是独有的 AWS SAM 而且没有 CloudFormation 等效。
-
FileSystemConfigs -
的清单 FileSystemConfig 为亚马逊弹性文件系统 (亚马逊 EFS) 文件系统或亚马逊 S3 文件系统指定连接设置的对象。您可以连接 Amazon EFS 接入点或 S3 文件访问点,但不能同时连接两者。
每个
FileSystemConfig对象包含一个Arn(接入点 ARN)和LocalMountPath(在函数中挂载文件系统的路径)。对于亚马逊 EFS 来说,ARN 是亚马逊 EFS 接入点 ARN。对于 S3 文件,ARN 是AWS::S3Files::AccessPointARN。如果模板包含 AWS::EFS::MountTarget 资源,您还必须指定一个
DependsOn资源属性,以确保在函数之前创建或更新装载目标。同样,如果您的模板包含AWS::S3Files::MountTarget资源,必须指定DependsOnS3 文件挂载目标的属性。类型:列表
必需:否
CloudFormation 兼容性: 此属性直接传递给
FileSystemConfigs的财产AWS::Lambda::Function资源。 -
FunctionName -
函数的名称。如果您没有指定名称,则系统为您生成唯一的名称。
类型:字符串
必需:否
CloudFormation 兼容性: 此属性直接传递给
FunctionName的财产AWS::Lambda::Function资源。 -
FunctionScalingConfig -
为在容量提供商上运行的 Lambda 函数配置扩展行为。定义执行环境的最小和最大数量。
必需:否
CloudFormation 兼容性: 此属性直接传递给
FunctionScalingConfig的财产AWS::Lambda::Function资源。 -
FunctionUrlConfig -
描述函数 URL 的对象。函数 URL 是可用于调用函数的 HTTPS 端点。
有关更多信息,请参阅《AWS Lambda 开发人员指南》中的函数 URL。
必需:否
CloudFormation 兼容性: 此属性是独有的 AWS SAM 而且没有 CloudFormation 等效。
-
Handler -
代码中被调用以开始执行的函数。仅当属性
PackageType为Zip时,该属性是必需属性。类型:字符串
必需:条件
CloudFormation 兼容性: 此属性直接传递给
Handler的财产AWS::Lambda::Function资源。 -
ImageConfig -
用于配置 Lambda 容器映像设置的对象。有关更多信息,请参阅《AWS Lambda 开发人员指南》中的将容器映像与 Lambda 结合使用。
类型:ImageConfig
必需:否
CloudFormation 兼容性: 此属性直接传递给
ImageConfig的财产AWS::Lambda::Function资源。 -
ImageUri -
Lambda 函数容器映像的 Amazon Elastic Container Registry (Amazon ECR) 存储库 URI 仅当
PackageType属性设置为Image时,此属性才适用,否则将被忽略。有关更多信息,请参阅《AWS Lambda 开发人员指南》中的将容器映像与 Lambda 结合使用。注意如果
PackageType属性设置为Image,然后要么ImageUri是必需的,或者你必须使用必要的方式构建应用程序Metadata中的条目 AWS SAM 模板文件。有关更多信息,请参阅 默认版本使用 AWS SAM。使用必要的
Metadata条目构建应用程序优先于ImageUri,因此,如果您同时指定两者,则ImageUri会被忽略。类型:字符串
必需:否
CloudFormation 兼容性: 此属性直接传递给
ImageUri的财产AWS::Lambda::FunctionCode数据类型。 -
InlineCode -
直接在模板中编写的 Lambda 函数代码。仅当
PackageType属性设置为Zip时,此属性才适用,否则将被忽略。注意如果
PackageType属性设置为Zip(默认),则CodeUri或InlineCode中的一个为必需。类型:字符串
必需:条件
CloudFormation 兼容性: 此属性直接传递给
ZipFile的财产AWS::Lambda::FunctionCode数据类型。 -
KmsKeyArn -
一个 ARN AWS Key Management Service (AWS KMS) 密钥,Lambda 使用该密钥加密和解密函数的环境变量。
类型:字符串
必需:否
CloudFormation 兼容性: 此属性直接传递给
KmsKeyArn的财产AWS::Lambda::Function资源。 -
Layers -
此函数应使用的
LayerVersionARN 列表。此处指定的顺序是运行 Lambda 函数时它们的导入顺序。该版本要么是包含版本的完整 ARN,要么是对版本的引用 LayerVersion 资源。例如,对LayerVersion的引用为!Ref MyLayer,而包含版本号的完整 ARN 为arn:aws:lambda:。region:account-id:layer:layer-name:version类型:列表
必需:否
CloudFormation 兼容性: 此属性直接传递给
Layers的财产AWS::Lambda::Function资源。 -
LoggingConfig -
该功能由亚马逊提供 CloudWatch 记录配置设置。
必需:否
CloudFormation 兼容性: 此属性直接传递给
LoggingConfig的财产AWS::Lambda::Function资源。 -
MemorySize -
每次调用函数时分配的内存大小(以 MB 为单位)。
类型:整数
必需:否
CloudFormation 兼容性: 此属性直接传递给
MemorySize的财产AWS::Lambda::Function资源。 -
PackageType -
Lambda 函数的部署包类型。有关更多信息,请参阅《AWS Lambda 开发人员指南》中的Lambda 部署包。
备注:
1. 如果此属性设置为
Zip(默认),则将应用CodeUri或InlineCode,并忽略ImageUri。2. 如果此属性设置为
Image,则仅应用ImageUri,并忽略CodeUri和InlineCode。存储函数容器映像所需的 Amazon ECR 存储库可由自动创建 AWS SAM CLI。有关更多信息,请参阅 sam deploy。有效值:
Zip或Image类型:字符串
必需:否
默认值:
ZipCloudFormation 兼容性: 此属性直接传递给
PackageType的财产AWS::Lambda::Function资源。 -
PermissionsBoundary -
用于此函数执行角色的权限边界的 ARN。仅当为您生成角色时,此属性才起作用。
类型:字符串
必需:否
CloudFormation 兼容性: 此属性直接传递给
PermissionsBoundary的财产AWS::IAM::Role资源。 -
Policies -
此函数的权限策略。策略将附加到该函数的默认值 AWS Identity and Access Management (IAM) 执行角色。
此属性接受单个值或值列表。允许的值包括:
-
一个的名字 AWS 来自以下内容的管理策略 列表
。 -
在 YAML 中格式化为映射的内联 IAM policy。
注意如果指定
Role属性,则将忽略该属性。类型:字符串 | 列表 | 映射
必需:否
CloudFormation 兼容性: 此属性类似于
Policies的财产AWS::IAM::Role资源。 -
PublishToLatestPublished -
指定函数更新时是否发布最新的函数版本。
类型:布尔值
必需:否
CloudFormation 兼容性: 此属性直接传递给
PublishToLatestPublished的财产AWS::Lambda::Function资源。 -
指明是否将
Tags属性中的标签传递给 AWS::Serverless::Function 生成的资源。指定True以在生成的资源中传播标签。类型:布尔值
必需:否
默认值:
FalseCloudFormation 兼容性: 此属性是独有的 AWS SAM 而且没有 CloudFormation 等效。
-
ProvisionedConcurrencyConfig -
函数别名的预置并发配置。
注意仅当设置
AutoPublishAlias时才可以指定ProvisionedConcurrencyConfig。否则将导致错误。类型:ProvisionedConcurrencyConfig
必需:否
CloudFormation 兼容性: 此属性直接传递给
ProvisionedConcurrencyConfig的财产AWS::Lambda::Alias资源。 -
RecursiveLoop -
函数的递归循环检测配置的状态。
当此值设置为
Allow且 Lambda 检测到您的函数作为递归循环的一部分调用时,它不会采取任何操作。当此值设置为
Terminate且 Lambda 检测到您的函数作为递归循环的一部分调用时,它会停止调用函数并通知您。类型:字符串
必需:否
CloudFormation 兼容性: 此属性直接传递给
RecursiveLoop的财产AWS::Lambda::Function资源。 -
ReservedConcurrentExecutions -
希望为函数预留的最大并发执行数。
有关此属性更多信息,请参阅《AWS Lambda 开发人员指南》中的 Lambda 函数扩展。
类型:整数
必需:否
CloudFormation 兼容性: 此属性直接传递给
ReservedConcurrentExecutions的财产AWS::Lambda::Function资源。 -
Role -
要用作此函数执行角色的 IAM 角色的 ARN。
类型:字符串
必需:否
CloudFormation 兼容性: 此属性类似于
Role的财产AWS::Lambda::Function资源。这是必填项 CloudFormation 但不在 AWS SAM。如果未指定角色,则会为您创建一个逻辑 ID 为的角色。<function-logical-id>Role -
RolePath -
函数的 IAM 执行角色的路径。
生成角色时请使用此属性。当使用
Role属性指定角色时,请勿使用。类型:字符串
必需:条件
CloudFormation 兼容性: 此属性直接传递给
Path的财产AWS::IAM::Role资源。 -
Runtime -
函数的运行时的标识符。仅当属性
PackageType为Zip时,该属性是必需属性。注意如果您指定
provided此属性的标识符,你可以使用Metadata要指示的资源属性 AWS SAM 来构建此函数所需的自定义运行时。有关构建自定义运行时系统的更多信息,请参阅 在中使用自定义运行时构建 Lambda 事件函数 AWS SAM。类型:字符串
必需:条件
CloudFormation 兼容性: 此属性直接传递给
Runtime的财产AWS::Lambda::Function资源。 -
RuntimeManagementConfig -
为 Lambda 函数配置运行时系统管理选项,例如运行时环境更新、回滚行为以及选择特定的运行时版本。要了解更多信息,请参阅《AWS Lambda 开发人员指南》中的 Lambda 运行时系统更新。
必需:否
CloudFormation 兼容性: 此属性直接传递给
RuntimeManagementConfig的财产AWS::Lambda::Function资源。 -
SnapStart -
创建任何新 Lambda 函数版本的快照。快照是初始化函数的缓存状态,包括其所有依赖项。函数仅被初始化一次,缓存的状态将在未来的所有调用中重复使用,从而通过减少必须初始化函数的次数来提高应用程序性能。要了解更多信息,请参阅 使用 Lambda 提高启动性能 SnapStart 在 AWS Lambda 开发者指南。
类型:SnapStart
必需:否
CloudFormation 兼容性: 此属性直接传递给
SnapStart的财产AWS::Lambda::Function资源。 -
SourceKMSKeyArn -
代表用于加密客户 ZIP 功能代码的 KMS 密钥 ARN。
类型:字符串
必需:否
CloudFormation 兼容性: 此属性直接传递给
SourceKMSKeyArn的财产AWS::Lambda::FunctionCode数据类型。 -
指定添加到此函数的标签的映射(字符串到字符串)。有关标签的有效键和值的详细信息,请参阅《AWS Lambda 开发人员指南》中的标签键和值要求。
创建堆栈时, AWS SAM 自动添加
lambda:createdBy:SAM标记到此 Lambda 函数以及为此函数生成的默认角色。类型:映射
必需:否
CloudFormation 兼容性: 此属性类似于
Tags的财产AWS::Lambda::Function资源。这个Tags中的财产 AWS SAM 由键值对组成(而在 CloudFormation 此属性由以下清单组成Tag对象)。另外, AWS SAM 自动添加lambda:createdBy:SAM标记到此 Lambda 函数以及为此函数生成的默认角色。 -
TenancyConfig -
Lambda 租户隔离模式的配置。确保执行环境永远不会在不同的租户 ID 之间共享,为多租户应用程序提供计算级隔离。
必需:否
CloudFormation 兼容性: 此属性直接传递给
TenancyConfig的财产AWS::Lambda::Function资源。 -
Timeout -
函数在停止之前可以运行的最长时间(以秒为单位)。
类型:整数
必需:否
原定设置值:3
CloudFormation 兼容性: 此属性直接传递给
Timeout的财产AWS::Lambda::Function资源。 -
Tracing -
指定函数的字符串 X-Ray 追踪模式。
-
Active— 激活 X-Ray 对函数进行跟踪。 -
Disabled— 停用 X-Ray 用于该功能。 -
PassThrough— 激活 X-Ray 对函数进行跟踪。采样决策委托给下游服务。
如果指定为
Active或PassThrough且未设置Role属性,则 AWS SAM 会将arn:aws:iam::aws:policy/AWSXrayWriteOnlyAccess策略添加到它为您创建的 Lambda 执行角色中。有关以下内容的更多信息 X-Ray,参见 使用 AWS Lambda 和 AWS X-Ray 在 AWS Lambda 开发者指南。
有效值:[
Active|Disabled|PassThrough]类型:字符串
必需:否
CloudFormation 兼容性: 此属性类似于
TracingConfig的财产AWS::Lambda::Function资源。 -
-
VersionDescription -
指定在新的 Lambda 版本资源上添加的
Description字段。类型:字符串
必需:否
CloudFormation 兼容性: 此属性直接传递给
Description的财产AWS::Lambda::Version资源。 -
VersionDeletionPolicy -
为 Lambda 版本资源指定删除策略,该资源是在以下情况下创建的
AutoPublishAlias已设置。这控制了删除堆栈时是保留还是删除版本资源。有效值:
Delete、Retain或Snapshot类型:字符串
必需:否
CloudFormation 兼容性: 此属性是独有的 AWS SAM 而且没有 CloudFormation 等效。它设置了
DeletionPolicy生成的属性AWS::Lambda::Version资源。 -
VpcConfig -
该配置使该函数能够访问您的虚拟私有云(VPC)中的私有资源。
类型:VpcConfig
必需:否
CloudFormation 兼容性: 此属性直接传递给
VpcConfig的财产AWS::Lambda::Function资源。
返回值
Ref
当向 Ref 内置函数提供此资源的逻辑 ID 时,将返回底层 Lambda 函数的资源名称。
有关使用 Ref 函数的更多信息,请参阅《AWS CloudFormation 用户指南》中的 Ref。
Fn::GetAtt
Fn::GetAtt 返回一个此类型指定属性的值。以下为可用属性和示例返回值。
有关使用 Fn::GetAtt 的更多信息,请参阅《AWS CloudFormation 用户指南》中的 Fn::GetAtt。
Arn-
底层 Lambda 函数的 ARN。
示例
简单函数
以下是 Amazon S3 存储桶中包类型为 Zip(默认)的 AWS::Serverless:: 函数 资源和函数代码的基本示例。
YAML
Type: AWS::Serverless::Function Properties: Handler: index.handler Runtime: python3.9 CodeUri: s3://bucket-name/key-name
函数属性示例
以下是示例 AWS::Serverless:: 函数 包裹类型 Zip (默认)它使用 InlineCode, Layers, Tracing, Policies, Amazon EFS 文件系统,以及 Api 事件源。
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 示例
以下是包类型为 Image 的 Lambda 函数的 ImageConfig 示例。
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 例子
配置为根据当前行为更新其运行时环境的 Lambda 函数:
TestFunction Type: AWS::Serverless::Function Properties: ... Runtime: python3.9 RuntimeManagementConfig: UpdateRuntimeOn: Auto
配置为在函数更新时更新其运行时环境的 Lambda 函数:
TestFunction Type: AWS::Serverless::Function Properties: ... Runtime: python3.9 RuntimeManagementConfig: UpdateRuntimeOn: FunctionUpdate
配置为手动更新其运行时环境的 Lambda 函数:
TestFunction Type: AWS::Serverless::Function Properties: ... Runtime: python3.9 RuntimeManagementConfig: RuntimeVersionArn: arn:aws:lambda:us-east-1::runtime:4c459dd0104ee29ec65dcad056c0b3ddbe20d6db76b265ade7eda9a066859b1e UpdateRuntimeOn: Manual
SnapStart 例子
带有 Lambda 函数的示例 SnapStart 在将来的版本中已启用:
TestFunc Type: AWS::Serverless::Function Properties: ... SnapStart: ApplyOn: PublishedVersions
TenancyConfig 例子
开启租户隔离模式的 Lambda 函数示例:
TestFunction Type: AWS::Serverless::Function Properties: ... TenancyConfig: TenantIsolationMode: PER_TENANT
S3 文件文件系统示例
以下示例创建了一个挂载 Amazon S3 文件系统的 Lambda 函数。该模板创建了一个 S3 存储桶、一个由该存储桶支持的 S3 文件系统、一个 VPC 子网中的挂载目标和一个接入点。该功能将接入点安装在 /mnt/s3files 并且可以读取和写入同步到 S3 存储桶的文件。
您可以将 Amazon EFS 文件系统或 S3 文件文件系统连接到 Lambda 函数,但不能同时连接两者。
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}