本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。 # AWS::Serverless::Function 创建触发该 AWS Lambda 函数的函数、 AWS Identity and Access Management (IAM) 执行角色和事件源映射。该[AWS::Serverless::Function](#sam-resource-function)资源还支持 r `Metadata` esource 属性，因此您可以指示 AWS SAM 构建应用程序所需的自定义运行时。有关构建自定义运行时系统的更多信息，请参阅 [在中使用自定义运行时构建 Lambda 函数 AWS SAM](building-custom-runtimes.md)。 **注意** 部署到时 AWS CloudFormation， AWS SAM 会将您的 AWS SAM 资源转换为 CloudFormation 资源。有关更多信息，请参阅 [生成的 CloudFormation 资源用于 AWS SAM](sam-specification-generated-resources.md)。 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` Type: AWS::Serverless::Function Properties: [Architectures](#sam-function-architectures): List [AssumeRolePolicyDocument](#sam-function-assumerolepolicydocument): JSON [AutoPublishAlias](#sam-function-autopublishalias): String AutoPublishAliasAllProperties: Boolean [AutoPublishCodeSha256](#sam-function-autopublishcodesha256): String [CapacityProviderConfig](#sam-function-capacityproviderconfig): CapacityProviderConfig [CodeSigningConfigArn](#sam-function-codesigningconfigarn): String [CodeUri](#sam-function-codeuri): String | FunctionCode [DeadLetterQueue](#sam-function-deadletterqueue): Map | DeadLetterQueue [DeploymentPreference](#sam-function-deploymentpreference): DeploymentPreference [Description](#sam-function-description): String [DurableConfig](#sam-function-durableconfig): DurableConfig [Environment](#sam-function-environment): [Environment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-environment.html) [EphemeralStorage](#sam-function-ephemeralstorage): [EphemeralStorage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-ephemeralstorage) [EventInvokeConfig](#sam-function-eventinvokeconfig): EventInvokeConfiguration [Events](#sam-function-events): EventSource [FileSystemConfigs](#sam-function-filesystemconfigs): List [FunctionName](#sam-function-functionname): String [FunctionScalingConfig](#sam-function-functionscalingconfig): FunctionScalingConfig [FunctionUrlConfig](#sam-function-functionurlconfig): FunctionUrlConfig [Handler](#sam-function-handler): String [ImageConfig](#sam-function-imageconfig): [ImageConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-imageconfig) [ImageUri](#sam-function-imageuri): String [InlineCode](#sam-function-inlinecode): String [KmsKeyArn](#sam-function-kmskeyarn): String [Layers](#sam-function-layers): List LoggingConfig: [LoggingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-loggingconfig.html) [MemorySize](#sam-function-memorysize): Integer [PackageType](#sam-function-packagetype): String [PermissionsBoundary](#sam-function-permissionsboundary): String [Policies](#sam-function-policies): String | List | Map [PublishToLatestPublished](#sam-function-publishtolatestpublished): Boolean PropagateTags: Boolean [ProvisionedConcurrencyConfig](#sam-function-provisionedconcurrencyconfig): [ProvisionedConcurrencyConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-provisionedconcurrencyconfig) RecursiveLoop: String [ReservedConcurrentExecutions](#sam-function-reservedconcurrentexecutions): Integer [Role](#sam-function-role): String [RolePath](#sam-function-rolepath): String [Runtime](#sam-function-runtime): String RuntimeManagementConfig: [RuntimeManagementConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-runtimemanagementconfig.html) SnapStart: [SnapStart](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-snapstart.html) [SourceKMSKeyArn](#sam-function-sourcekmskeyarn): String [Tags](#sam-function-tags): Map [TenancyConfig](#sam-function-tenancyconfig): TenancyConfig [Timeout](#sam-function-timeout): Integer [Tracing](#sam-function-tracing): String [VersionDescription](#sam-function-versiondescription): String [VersionDeletionPolicy](#sam-function-versiondeletionpolicy): String [VpcConfig](#sam-function-vpcconfig): [VpcConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html) ``` ## Properties `Architectures` 该函数的指令集架构。有关此属性更多信息，请参阅*《AWS Lambda 开发人员指南》*中的 [Lambda 指令集架构](https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html)。 *有效值*：`x86_64` 或 `arm64` 之一。 *类型*：列表 *必需*：否 *默认值*：`x86_64` *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function`资源的`[Architectures](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-architectures)`属性。 `AssumeRolePolicyDocument` AssumeRolePolicyDocument 为该函数创建`Role`的默认值添加一个。如果未指定此属性，则为该函数 AWS SAM 添加默认的代入角色。 *类型*：JSON *必需*：否 *CloudFormation 兼容性*：此属性类似于`AWS::IAM::Role`资源的`[AssumeRolePolicyDocument](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-assumerolepolicydocument)`属性。 AWS SAM 将此属性添加到为此函数生成的 IAM 角色中。如果为此函数提供了角色的 Amazon 资源名称（ARN），则此属性将不执行任何操作。 `AutoPublishAlias` Lambda 别名的名称。要了解有关 Lambda 别名的更多信息，请参阅*《AWS Lambda 开发人员指南》*中的 [Lambda 函数别名](https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html)。有关使用此属性的示例，请参见 [使用以下方法逐步部署无服务器应用程序 AWS SAM](automating-updates-to-serverless-apps.md)。 AWS SAM 设置此属性时生成[https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html)和[https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html)资源。有关此场景的更多信息，请参阅[AutoPublishAlias 属性已指定](sam-specification-generated-resources-function.md#sam-specification-generated-resources-function-autopublishalias)。有关生成的 CloudFormation 资源的一般信息，请参阅[生成的 CloudFormation 资源用于 AWS SAM](sam-specification-generated-resources.md)。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `AutoPublishAliasAllProperties` 指定何时创建新的 [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html)。当为 `true` 时，修改 Lambda 函数中的任何属性时，就会创建新的 Lambda 版本。当为 `false` 时，只有修改了以下任何属性时，才会创建新的 Lambda 版本： + `Environment`、`MemorySize` 或者 `SnapStart`。 + 导致 `Code` 属性更新的任何更改，例如 `CodeDict`、`ImageUri`、或 `InlineCode`。此属性需要定义 `AutoPublishAlias`。如果也指定 `AutoPublishCodeSha256`，则其行为优先于 `AutoPublishAliasAllProperties: true`。 *类型*：布尔值 *必需*：否 *默认值*：`false` *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `AutoPublishCodeSha256` 使用时，此字符串将与 `CodeUri` 值一起确定是否需要发布新的 Lambda 版本。此属性通常用于解决以下部署问题：部署包存储在 Amazon S3 位置，且被包含更新后的 Lambda 函数代码的新部署包取代，但 `CodeUri` 属性保持不变（相反情况是新的部署包上传到新的 Amazon S3 位置并且 `CodeUri` 更改为新位置）。此问题由具有以下特征的 AWS SAM 模板标记： + `DeploymentPreference` 对象配置为逐步部署（如[使用以下方法逐步部署无服务器应用程序 AWS SAM](automating-updates-to-serverless-apps.md)中所述） + `AutoPublishAlias` 属性已设置，且在部署之间不会更改 + `CodeUri` 属性已设置，且在部署之间不会更改。在这种情况下，更新 `AutoPublishCodeSha256` 会导致成功创建新的 Lambda 版本。但是，部署到 Amazon S3 的新函数代码将无法识别。要识别新的函数代码，请考虑在 Amazon S3 存储桶中使用版本控制。为 Lambda 函数指定 `Version` 属性，并将存储桶配置为始终使用最新的部署包。在这种情况下，要成功触发逐步部署，必须为 `AutoPublishCodeSha256` 提供一个唯一的值。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `CapacityProviderConfig` 配置要将函数的已发布版本附加到的容量提供商。这使该函数能够在由 Lambda 托管实例管理的客户拥有的 EC2 实例上运行。 *类型*：[CapacityProviderConfig](sam-property-function-capacityproviderconfig.md) *必需*：否 *CloudFormation 兼容性*：SAM 对传递给`AWS::Lambda::Function`资源属性的`[CapacityProviderConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-capacityproviderconfig)`属性进行扁平化并重建嵌套结构。 `CodeSigningConfigArn` [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html) 资源的 ARN，用于为此函数启用代码签名。有关代码签名的更多信息，请参阅 [为您的 AWS SAM 应用程序设置代码签名](authoring-codesigning.md)。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function`资源的`[CodeSigningConfigArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-codesigningconfigarn)`属性。 `CodeUri` 函数的代码。可接受的值包括： + 该函数的 Amazon S3 URI。例如 `s3://bucket-123456789/sam-app/1234567890abcdefg`。 + 函数的本地路径。例如 `hello_world/`。 + 一个 [FunctionCode](sam-property-function-functioncode.md) 对象。如果您提供函数的 Amazon S3 URI 或 [FunctionCode](sam-property-function-functioncode.md) 对象，则必须引用有效的 [Lambda 部署包](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html)。如果您提供本地文件路径，请在部署时使用 AWS SAM CLI 上传本地文件。要了解更多信息，请参阅[如何在 AWS SAM 部署时上传本地文件](deploy-upload-local-files.md)。如果你在`CodeUri`属性中使用内部函数， AWS SAM 将无法正确解析这些值。请考虑改用[AWS::Language扩展程序转换](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-languageextensions.html)。 *类型*：[ 字符串 \$1 [FunctionCode](sam-property-function-functioncode.md) ] *必填*：条件性。当 `PackageType` 设置为 `Zip` 时，则 `CodeUri` 或 `InlineCode` 中的一种为必需。 *CloudFormation 兼容性*：此属性类似于`AWS::Lambda::Function`资源的`[ Code](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-code)`属性。嵌套的 Amazon S3 属性的命名有所不同。 `DeadLetterQueue` 在 Lambda 发送无法处理的事件时配置 Amazon Simple Notiﬁcation Service (Amazon SNS)主题或 Amazon Simple Queue Service (Amazon SQS) 队列。有关死信队列功能的更多信息，请参阅《AWS Lambda 开发人员指南》**中的[死信队列](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async-retain-records.html#invocation-dlq)。如果您的 Lambda 函数的事件源是 Amazon SQS 队列，请为源队列而不是 Lambda 函数配置死信队列。您为函数配置的死信队列用于函数的[异步调用队列](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html)，而不是用于事件源队列。 *类型*：地图 \$1 [DeadLetterQueue](sam-property-function-deadletterqueue.md) *必需*：否 *CloudFormation 兼容性*：此属性类似于`AWS::Lambda::Function`资源的`[DeadLetterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-deadletterconfig.html)`属性。在 CloudFormation 中，类型是派生自的`TargetArn`，而在中， AWS SAM 你必须将类型与一起传递`TargetArn`。 `DeploymentPreference` 用于启用逐步 Lambda 部署的设置。如果指定了`DeploymentPreference`对象，则 AWS SAM 会创建一个[https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-application.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-application.html)被调用对象`ServerlessDeploymentApplication`（每个堆栈一个）、一个[https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html)被调用`DeploymentGroup`对象和一个[https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html)被调用对象`CodeDeployServiceRole`。 *类型*：[DeploymentPreference](sam-property-function-deploymentpreference.md) *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 *另请参阅*：有关此属性的更多信息，请参阅 [使用以下方法逐步部署无服务器应用程序 AWS SAM](automating-updates-to-serverless-apps.md)。 `Description` 该函数的描述。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function`资源的`[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-description)`属性。 `DurableConfig` 耐用功能的配置。通过自动检查点和重播功能启用有状态执行。 *类型*：[DurableConfig](sam-property-function-durableconfig.md) *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `Environment` 运行时系统环境的配置。 *类型*：[环境](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-environment.html) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function`资源的`[Environment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-environment.html)`属性。 `EphemeralStorage` 指定 `/tmp` 中 Lambda 函数可用的磁盘空间（以 MB 为单位）的对象。有关此属性的更多信息，请参阅*《AWS Lambda 开发人员指南》*中的 [Lambda 执行环境](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html)。 *类型*：[EphemeralStorage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-ephemeralstorage) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function`资源的`[EphemeralStorage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-ephemeralstorage)`属性。 `EventInvokeConfig` 描述 Lambda 函数的事件调用配置的对象。 *类型*：[EventInvokeConfiguration](sam-property-function-eventinvokeconfiguration.md) *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `Events` 指定触发此函数的事件。事件由一个类型和一组依赖于该类型的属性组成。 *类型*：[EventSource](sam-property-function-eventsource.md) *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `FileSystemConfigs` 指定亚马逊弹性文件系统 (Amazon EFS) 文件系统的连接设置的[FileSystemConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-filesystemconfig.html)对象列表。如果模板包含 [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html) 资源，您还必须指定一个 `DependsOn` 资源属性，以确保在函数之前创建或更新装载目标。 *类型*：列表 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function`资源的`[FileSystemConfigs](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-filesystemconfigs)`属性。 `FunctionName` 函数的名称。如果您没有指定名称，则系统为您生成唯一的名称。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function`资源的`[FunctionName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-functionname)`属性。 `FunctionScalingConfig` 为在容量提供程序上运行的 Lambda 函数配置扩展行为。定义执行环境的最小和最大数量。 *类型*：[FunctionScalingConfig](sam-property-function-functionscalingconfig.md) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function`资源的`[FunctionScalingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-functionscalingconfig)`属性。 `FunctionUrlConfig` 描述函数 URL 的对象。函数 URL 是可用于调用函数的 HTTPS 端点。有关更多信息，请参阅《*AWS Lambda 开发者指南*》URLs中的[函数](https://docs.aws.amazon.com/lambda/latest/dg/lambda-urls.html)。 *类型*：[FunctionUrlConfig](sam-property-function-functionurlconfig.md) *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `Handler` 代码中被调用以开始执行的函数。仅当属性 `PackageType` 为 `Zip` 时，该属性是必需属性。 *类型*：字符串 *必需*：条件 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function`资源的`[Handler](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-handler)`属性。 `ImageConfig` 用于配置 Lambda 容器映像设置的对象。有关更多信息，请参阅*《AWS Lambda 开发人员指南》*中的[将容器映像与 Lambda 结合使用](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html)。 *类型*：[ImageConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-imageconfig) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function`资源的`[ImageConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-imageconfig)`属性。 `ImageUri` Lambda 函数容器映像的 Amazon Elastic Container Registry (Amazon ECR) 存储库 URI 仅当 `PackageType` 属性设置为 `Image` 时，此属性才适用，否则将被忽略。有关更多信息，请参阅*《AWS Lambda 开发人员指南》*中的[将容器映像与 Lambda 结合使用](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html)。如果将该`PackageType`属性设置为`Image`，`ImageUri`则要么为必填项，要么必须使用 AWS SAM 模板文件中的必要`Metadata`条目来构建应用程序。有关更多信息，请参阅 [默认版本使用 AWS SAM](serverless-sam-cli-using-build.md)。使用必要的 `Metadata` 条目构建应用程序优先于 `ImageUri`，因此，如果您同时指定两者，则 `ImageUri` 会被忽略。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function``Code`数据类型的`[ImageUri](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-imageuri)`属性。 `InlineCode` 直接在模板中编写的 Lambda 函数代码。仅当 `PackageType` 属性设置为 `Zip` 时，此属性才适用，否则将被忽略。如果 `PackageType` 属性设置为 `Zip`（默认），则 `CodeUri` 或 `InlineCode` 中的一个为必需。 *类型*：字符串 *必需*：条件 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function``Code`数据类型的`[ZipFile](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-zipfile)`属性。 `KmsKeyArn` Lambda 用来加密和解密函数环境变量的 AWS Key Management Service (AWS KMS) 密钥的 ARN。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function`资源的`[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-kmskeyarn)`属性。 `Layers` 此函数应使用的列表。`LayerVersion` ARNs 此处指定的顺序是运行 Lambda 函数时它们的导入顺序。该版本要么是包含版本的完整 ARN，要么是对资源的引用。 LayerVersion 例如，对 `LayerVersion` 的引用为 `!Ref MyLayer`，而包含版本号的完整 ARN 为 `arn:aws:lambda:region:account-id:layer:layer-name:version`。 *类型*：列表 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function`资源的`[Layers](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-layers)`属性。 `LoggingConfig` 该函数的 Amazon CloudWatch 日志配置设置。 *类型*：[LoggingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-loggingconfig.html) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function`资源的[https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-loggingconfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-loggingconfig)属性。 `MemorySize` 每次调用函数时分配的内存大小（以 MB 为单位）。 *类型*：整数 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function`资源的`[MemorySize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-memorysize)`属性。 `PackageType` Lambda 函数的部署包类型。有关更多信息，请参阅*《AWS Lambda 开发人员指南》*中的[Lambda 部署包](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html)。 **备注**： 1. 如果此属性设置为 `Zip`（默认），则将应用 `CodeUri` 或 `InlineCode`，并忽略 `ImageUri`。 2. 如果此属性设置为 `Image`，则仅应用 `ImageUri`，并忽略 `CodeUri` 和 `InlineCode`。存储函数容器镜像所需的 Amazon ECR 存储库可以由自动创建。 AWS SAMCLI有关更多信息，请参阅 [sam deploy](sam-cli-command-reference-sam-deploy.md)。 *有效值*：`Zip` 或 `Image` *类型*：字符串 *必需*：否 *默认值*：`Zip` *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function`资源的`[PackageType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-packagetype)`属性。 `PermissionsBoundary` 用于此函数执行角色的权限边界的 ARN。仅当为您生成角色时，此属性才起作用。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::IAM::Role`资源的`[PermissionsBoundary](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-permissionsboundary)`属性。 `Policies` 此函数的权限策略。策略将附加到函数的默认 AWS Identity and Access Management (IAM) 执行角色中。此属性接受单个值或值列表。允许的值包括： + [AWS SAM策略模板](serverless-policy-templates.md). + [AWS 托管策略](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html#aws-managed-policies)或[客户管理型策略](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html#customer-managed-policies)的 ARN。 + 以下[列表](https://github.com/aws/serverless-application-model/blob/develop/samtranslator/internal/data/aws_managed_policies.json)中 AWS 托管策略的名称。 + 在 YAML 中格式化为映射的[内联 IAM policy](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html#inline-policies)。如果指定 `Role` 属性，则将忽略该属性。 *类型*：字符串 \$1 列表 \$1 映射 *必需*：否 *CloudFormation 兼容性*：此属性类似于`AWS::IAM::Role`资源的`[Policies](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-policies)`属性。 `PublishToLatestPublished` 指定在函数更新时是否发布最新的函数版本。 *类型*：布尔值 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function`资源的`[PublishToLatestPublished](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-publishtolatestpublished)`属性。 `PropagateTags` 指明是否将 `Tags` 属性中的标签传递给 [AWS::Serverless::Function](sam-specification-generated-resources-function.md) 生成的资源。指定 `True` 以在生成的资源中传播标签。 *类型*：布尔值 *必需*：否 *默认值*：`False` *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `ProvisionedConcurrencyConfig` 函数别名的预置并发配置。仅当设置 `AutoPublishAlias` 时才可以指定 `ProvisionedConcurrencyConfig`。否则将导致错误。 *类型*：[ProvisionedConcurrencyConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-provisionedconcurrencyconfig) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Alias`资源的`[ProvisionedConcurrencyConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-provisionedconcurrencyconfig)`属性。 `RecursiveLoop` 函数的递归循环检测配置的状态。当此值设置为 `Allow` 且 Lambda 检测到您的函数作为递归循环的一部分调用时，它不会采取任何操作。当此值设置为 `Terminate` 且 Lambda 检测到您的函数作为递归循环的一部分调用时，它会停止调用函数并通知您。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function`资源的`[RecursiveLoop](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-recursiveloop)`属性。 `ReservedConcurrentExecutions` 希望为函数预留的最大并发执行数。有关此属性更多信息，请参阅*《AWS Lambda 开发人员指南》*中的 [Lambda 函数扩展](https://docs.aws.amazon.com/lambda/latest/dg/scaling.html)。 *类型*：整数 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function`资源的`[ReservedConcurrentExecutions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-reservedconcurrentexecutions)`属性。 `Role` 要用作此函数执行角色的 IAM 角色的 ARN。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性类似于`AWS::Lambda::Function`资源的`[Role](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-role)`属性。这在中是必需的 CloudFormation ，但不是必填的 AWS SAM。如果未指定角色，则会为您创建一个逻辑 ID 为 `Role` 的角色。 `RolePath` 函数的 IAM 执行角色的路径。生成角色时请使用此属性。当使用 `Role` 属性指定角色时，请勿使用。 *类型*：字符串 *必需*：条件 *CloudFormation 兼容性*：此属性直接传递给`AWS::IAM::Role`资源的`[Path](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-path)`属性。 `Runtime` 函数的[运行时](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html)的标识符。仅当属性 `PackageType` 为 `Zip` 时，该属性是必需属性。如果为此属性指定标`provided`识符，则可以使用 res `Metadata` ource 属性 AWS SAM 来指示构建此函数所需的自定义运行时。有关构建自定义运行时系统的更多信息，请参阅 [在中使用自定义运行时构建 Lambda 函数 AWS SAM](building-custom-runtimes.md)。 *类型*：字符串 *必需*：条件 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function`资源的`[Runtime](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-runtime)`属性。 `RuntimeManagementConfig` 为 Lambda 函数配置运行时系统管理选项，例如运行时环境更新、回滚行为以及选择特定的运行时版本。要了解更多信息，请参阅*《AWS Lambda 开发人员指南》*中的 [Lambda 运行时系统更新](https://docs.aws.amazon.com//lambda/latest/dg/runtimes-update.html)。 *类型*：[RuntimeManagementConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-runtimemanagementconfig.html) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function`资源的`[ RuntimeManagementConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-runtimemanagementconfig.html)`属性。 `SnapStart` 创建任何新 Lambda 函数版本的快照。快照是初始化函数的缓存状态，包括其所有依赖项。函数仅被初始化一次，缓存的状态将在未来的所有调用中重复使用，从而通过减少必须初始化函数的次数来提高应用程序性能。要了解更多信息，请参阅*AWS Lambda 开发人员*指南SnapStart中的[使用 Lambda 提高启动性能](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html)。 *类型*：[SnapStart](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-snapstart.html) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function`资源的`[SnapStart](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-snapstart.html)`属性。 `SourceKMSKeyArn` 代表用于加密客户 ZIP 功能代码的 KMS 密钥 ARN。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function``Code`数据类型的`[SourceKMSKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-sourcekmskeyarn)`属性。 `Tags` 指定添加到此函数的标签的映射（字符串到字符串）。有关标签的有效键和值的详细信息，请参阅*《AWS Lambda 开发人员指南》*中的[标签键和值要求](https://docs.aws.amazon.com/lambda/latest/dg/configuration-tags.html#configuration-tags-restrictions)。创建堆栈后， AWS SAM 会自动向此 Lambda 函数以及为此函数生成的默认角色添加`lambda:createdBy:SAM`标签。 *类型*：映射 *必需*：否 *CloudFormation 兼容性*：此属性类似于`AWS::Lambda::Function`资源的`[Tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tags)`属性。中的`Tags`属性由键值对 AWS SAM 组成（而 CloudFormation 在此属性中则由`Tag`对象列表组成）。此外，还 AWS SAM 会自动向此 Lambda 函数以及为此函数生成的默认角色添加`lambda:createdBy:SAM`标签。 `TenancyConfig` Lambda 租户隔离模式的配置。确保不同租户之间永远不会共享执行环境 IDs，从而为多租户应用程序提供计算级隔离。 *类型*：[TenancyConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-tenancyconfig.html) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function`资源的`[TenancyConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tenancyconfig)`属性。 `Timeout` 函数在停止之前可以运行的最长时间（以秒为单位）。 *类型*：整数 *必需*：否 *原定设置值：*3 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function`资源的`[Timeout](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-timeout)`属性。 `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 与一起使用](https://docs.aws.amazon.com/lambda/latest/dg/lambda-x-ray.html)”。 *有效值*：[`Active`\$1`Disabled`\$1`PassThrough`] *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性类似于`AWS::Lambda::Function`资源的`[TracingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tracingconfig)`属性。 `VersionDescription` 指定在新的 Lambda 版本资源上添加的 `Description` 字段。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Version`资源的`[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-description)`属性。 `VersionDeletionPolicy` 为设置时`AutoPublishAlias`创建的 Lambda 版本资源指定删除策略。这控制了删除堆栈时是保留还是删除版本资源。 *有效值*：`Delete`、`Retain` 或 `Snapshot` *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。它在生成的`AWS::Lambda::Version`资源上设置`DeletionPolicy`属性。 `VpcConfig` 该配置使该函数能够访问您的虚拟私有云（VPC）中的私有资源。 *类型*：[VpcConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function`资源的`[VpcConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html)`属性。 ## 返回值 ### Ref 当向 `Ref` 内置函数提供此资源的逻辑 ID 时，将返回底层 Lambda 函数的资源名称。有关使用 `Ref` 函数的更多信息，请参阅*《AWS CloudFormation 用户指南》*中的 [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)。 ### Fn:: GetAtt `Fn::GetAtt` 返回一个此类型指定属性的值。以下为可用属性和示例返回值。有关使用 `Fn::GetAtt` 的更多信息，请参阅*《AWS CloudFormation 用户指南》*中的 [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html)。 `Arn` 底层 Lambda 函数的 ARN。 ## 示例 ### 简单函数以下是 Amazon S3 存储桶中包类型为 `Zip`（默认）的 [AWS::Serverless::Function](#sam-resource-function) 资源和函数代码的基本示例。 #### YAML ``` Type: AWS::Serverless::Function Properties: Handler: index.handler Runtime: python3.9 CodeUri: s3://bucket-name/key-name ``` ### 函数属性示例以下是使用 `InlineCode`、`Layers`、`Tracing`、`Policies`、`Amazon EFS`和 `Api` 事件源的包类型为 `Zip`（默认）的 [AWS::Serverless::Function](#sam-resource-function) 示例。 #### 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-name ImageConfig: 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 例子在未来版本中 SnapStart 启用的 Lambda 函数示例： ``` TestFunc Type: AWS::Serverless::Function Properties: ... SnapStart: ApplyOn: PublishedVersions ``` ### TenancyConfig 例子开启租户隔离模式的 Lambda 函数示例： ``` TestFunction Type: AWS::Serverless::Function Properties: ... TenancyConfig: TenantIsolationMode: PER_TENANT ``` # DeadLetterQueue 指定 ( AWS Lambda Lambda) 在无法处理事件时向其发送事件的 SQS 队列或 SNS 主题。有关死信队列功能的更多信息，请参阅《AWS Lambda 开发人员指南》**中的[死信队列](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async-retain-records.html#invocation-dlq)。 SAM 将自动为您的 Lambda 函数执行角色添加相应的权限，以授予 Lambda 服务访问资源的权限。将为 SQS 队列添加 sqs:，SendMessage 将为 SNS 主题添加 SNS: Publish。 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [TargetArn](#sam-function-deadletterqueue-targetarn): String [Type](#sam-function-deadletterqueue-type): String ``` ## Properties `TargetArn` Amazon SQS 队列或 Amazon SNS 主题的 Amazon 资源名称（ARN）。 *类型*：字符串 *是否必需*：是 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function``DeadLetterConfig`数据类型的`[TargetArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-deadletterconfig.html#cfn-lambda-function-deadletterconfig-targetarn)`属性。 `Type` 死信队列的类型。 *有效值*：`SNS`、`SQS` *类型*：字符串 *是否必需*：是 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 ## 示例 ### DeadLetterQueue SNS 主题的死信队列示例。 #### YAML ``` DeadLetterQueue: Type: SNS TargetArn: arn:aws:sns:us-east-2:123456789012:my-topic ``` # DeploymentPreference 指定启用逐步 Lambda 部署的配置。有关配置逐步 Lambda 部署的更多信息，请参阅 [使用以下方法逐步部署无服务器应用程序 AWS SAM](automating-updates-to-serverless-apps.md)。 **注意** 要使用 `DeploymentPreference` 对象，必须在 [AWS::Serverless::Function](sam-resource-function.md) 中指定 `AutoPublishAlias`，否则将导致错误。 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [Alarms](#sam-function-deploymentpreference-alarms): List [Enabled](#sam-function-deploymentpreference-enabled): Boolean [Hooks](#sam-function-deploymentpreference-hooks): Hooks [PassthroughCondition](#sam-function-deploymentpreference-passthroughcondition): Boolean [Role](#sam-function-deploymentpreference-role): String [TriggerConfigurations](#sam-function-deploymentpreference-triggerconfigurations): List [Type](#sam-function-deploymentpreference-type): String ``` ## Properties `Alarms` 您希望由部署引发的任何错误触发的 CloudWatch 警报列表。此属性接受 `Fn::If` 内置函数。有关使用 `Fn::If` 的示例模板，请参阅本主题底部的“示例”部分。 *类型*：列表 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `Enabled` 是否启用此部署首选项。 *类型*：布尔值 *必需*：否 *默认值*：True *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `Hooks` 流量转移之前和之后运行的验证 Lambda 函数。 *类型*：[钩子](sam-property-function-hooks.md) *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `PassthroughCondition` 如果为 True，并且启用了此部署首选项，则函数的 Condition 将传递给生成的 CodeDeploy 资源。通常，应将其设置为 True。否则，即使函数的条件解析为 False，也会创建 CodeDeploy 资源。 *类型*：布尔值 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `Role` 用于流量转移的 IAM 角色 ARN。 CodeDeploy 如有提供，则不会创建 IAM 角色。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `TriggerConfigurations` 要与部署组关联的触发器配置列表。用于通知有关生命周期事件的 SNS 主题。 *类型*：列表 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::CodeDeploy::DeploymentGroup`资源的`[TriggerConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html#cfn-codedeploy-deploymentgroup-triggerconfigurations)`属性。 `Type` 目前有两类部署类型：线性和金丝雀。有关可用部署类型的更多信息，请参阅 [使用以下方法逐步部署无服务器应用程序 AWS SAM](automating-updates-to-serverless-apps.md)。 *类型*：字符串 *是否必需*：是 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 ## 示例 ### DeploymentPreference 带有交通前和交通后的挂钩。包含流量前后钩子的部署首选项示例。 #### YAML ``` DeploymentPreference: Enabled: true Type: Canary10Percent10Minutes Alarms: - !Ref: AliasErrorMetricGreaterThanZeroAlarm - !Ref: LatestVersionErrorMetricGreaterThanZeroAlarm Hooks: PreTraffic: !Ref: PreTrafficLambdaFunction PostTraffic: !Ref: PostTrafficLambdaFunction ``` ### DeploymentPreference 使用 Fn:: If 内部函数使用 `Fn::If` 配置警报的部署首选项示例。在本示例中，如果 `MyCondition` 为 `true`，则将配置 `Alarm1`；如果 `MyCondition` 为 `false`，则将配置 `Alarm2` 和 `Alarm5`。 #### YAML ``` DeploymentPreference: Enabled: true Type: Canary10Percent10Minutes Alarms: Fn::If: - MyCondition - - Alarm1 - - Alarm2 - Alarm5 ``` # Hooks 流量转移之前和之后运行的验证 Lambda 函数。 **注意** 此属性中引用的 Lambda 函数会配置生成的 [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html) 资源的 `CodeDeployLambdaAliasUpdate` 对象。有关更多信息，请参阅《*AWS CloudFormation 用户指南*》中的[CodeDeployLambdaAliasUpdate 策略](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-codedeploylambdaaliasupdate)。 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [PostTraffic](#sam-function-hooks-posttraffic): String [PreTraffic](#sam-function-hooks-pretraffic): String ``` ## Properties `PostTraffic` 流量转移之后运行的 Lambda 函数。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `PreTraffic` 流量转移之前运行的 Lambda 函数。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 ## 示例 ### 挂钩示例钩子函数 #### YAML ``` Hooks: PreTraffic: Ref: PreTrafficLambdaFunction PostTraffic: Ref: PostTrafficLambdaFunction ``` # DurableConfig 为 AWS Lambda 函数配置持久执行设置。耐用的功能可以运行长达一年，并自动检查进度，从而支持长时间运行的工作流程和容错应用程序。有关耐久函数的更多信息，请参阅《*AWS Lambda 开发人员*指南》中的 [Lambda 耐久函数](https://docs.aws.amazon.com/lambda/latest/dg/durable-functions.html)。 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [ExecutionTimeout](#sam-function-durableconfig-executiontimeout): Integer [RetentionPeriodInDays](#sam-function-durableconfig-retentionperiodindays): Integer ``` ## Properties `ExecutionTimeout` Lambda 允许持久函数在停止之前运行的时间（以秒为单位）。最大值为一个 366 天的一年或 31,622,400 秒。 *类型*：整数 *是否必需*：是 *最小值*：1 *最大值*：31622400 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function``DurableConfig`数据类型的`[ExecutionTimeout](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-durableconfig.html#cfn-lambda-function-durableconfig-executiontimeout)`属性。 `RetentionPeriodInDays` 在持久执行结束后，Lambda 保留其历史记录的天数，从 1 到 90 天不等。默认值为 14 天。 *类型*：整数 *必需*：否 *默认值*：14 *最小值*：1 *最大值*：90 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function``DurableConfig`数据类型的`[RetentionPeriodInDays](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-durableconfig.html#cfn-lambda-function-durableconfig-retentionperiodindays)`属性。 ## 示例 ### DurableConfig 具有 1 小时执行超时和 7 天保留期的函数的持久配置示例。 #### YAML ``` DurableConfig: ExecutionTimeout: 3600 RetentionPeriodInDays: 7 ``` # EventInvokeConfiguration [异步](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html) Lambda 别名或版本调用的配置选项。 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [DestinationConfig](#sam-function-eventinvokeconfiguration-destinationconfig): EventInvokeDestinationConfiguration [MaximumEventAgeInSeconds](#sam-function-eventinvokeconfiguration-maximumeventageinseconds): Integer [MaximumRetryAttempts](#sam-function-eventinvokeconfiguration-maximumretryattempts): Integer ``` ## Properties `DestinationConfig` 一个配置对象，用于在 Lambda 处理事件后指定事件目的地。 *类型*：[EventInvokeDestinationConfiguration](sam-property-function-eventinvokedestinationconfiguration.md) *必需*：否 *CloudFormation 兼容性*：此属性类似于`AWS::Lambda::EventInvokeConfig`资源的`[DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-destinationconfig.html)`属性。SAM 需要一个在中不存在的额外参数 “类型” CloudFormation。 `MaximumEventAgeInSeconds` Lambda 发送到函数以进行处理的请求的最长期限。 *类型*：整数 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventInvokeConfig`资源的`[MaximumEventAgeInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-maximumeventageinseconds)`属性。 `MaximumRetryAttempts` 在函数返回错误前重试的最大次数。 *类型*：整数 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventInvokeConfig`资源的`[MaximumRetryAttempts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-maximumretryattempts)`属性。 ## 示例 ### MaximumEventAgeInSeconds MaximumEventAgeInSeconds 示例 #### YAML ``` EventInvokeConfig: MaximumEventAgeInSeconds: 60 MaximumRetryAttempts: 2 DestinationConfig: OnSuccess: Type: SQS Destination: arn:aws:sqs:us-west-2:012345678901:my-queue OnFailure: Type: Lambda Destination: !GetAtt DestinationLambda.Arn ``` # EventInvokeDestinationConfiguration 一个配置对象，用于在 Lambda 处理事件后指定事件目的地。 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [OnFailure](#sam-function-eventinvokedestinationconfiguration-onfailure): OnFailure [OnSuccess](#sam-function-eventinvokedestinationconfiguration-onsuccess): OnSuccess ``` ## Properties `OnFailure` 处理失败的事件的目的地。 *类型*：[OnFailure](sam-property-function-onfailure.md) *必需*：否 *CloudFormation 兼容性*：此属性类似于`AWS::Lambda::EventInvokeConfig`资源的`[OnFailure](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-onfailure.html)`属性。需要 `Type`（这是仅适用于 SAM 的附加属性）。 `OnSuccess` 已成功处理的事件的目的地。 *类型*：[OnSuccess](sam-property-function-onsuccess.md) *必需*：否 *CloudFormation 兼容性*：此属性类似于`AWS::Lambda::EventInvokeConfig`资源的`[OnSuccess](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-onsuccess)`属性。需要 `Type`（这是仅适用于 SAM 的附加属性）。 ## 示例 ### OnSuccess OnSuccess 示例 #### YAML ``` EventInvokeConfig: DestinationConfig: OnSuccess: Type: SQS Destination: arn:aws:sqs:us-west-2:012345678901:my-queue OnFailure: Type: Lambda Destination: !GetAtt DestinationLambda.Arn ``` # OnFailure 处理失败的事件的目的地。 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [Destination](#sam-function-onfailure-destination): String [Type](#sam-function-onfailure-type): String ``` ## Properties `Destination` 目标资源的 Amazon Resource Name (ARN)。 *类型*：字符串 *必需*：条件 *CloudFormation 兼容性*：此属性类似于`AWS::Lambda::EventInvokeConfig`资源的`[OnFailure](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-onfailure.html)`属性。SAM 将向与该函数关联的自动生成的 IAM 角色添加任何必要的权限，以访问此属性中引用的资源。 *其他说明*：如果类型为 Lambda/EventBridge，则必须填写目的地。 `Type` 目标中引用的资源类型。支持的类型有 `SQS`、`SNS`、`S3`、`Lambda` 和 `EventBridge`。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 *其他说明*：如果类型为 SQS/SNS 且`Destination`属性留空，则 SQS/SNS 资源由 SAM 自动生成。要引用该资源，请使用 `.DestinationQueue`（对于 SQS）或 `.DestinationTopic`（对于 SQS）。如果类型为 Lambda/EventBridge，`Destination`则为必填项。 ## 示例 ### EventInvoke 包含 SQS 和 Lambda 目标的配置示例在此示例中，没有给出 SQS OnSuccess 配置的目标，因此 SAM 隐式创建了一个 SQS 队列并添加了所有必要的权限。同样在本示例中，在 OnFailure 配置中指定了在模板文件中声明的 Lambda 资源的目标，因此 SAM 向此 Lambda 函数添加了调用目标 Lambda 函数所需的权限。 #### YAML ``` EventInvokeConfig: DestinationConfig: OnSuccess: Type: SQS OnFailure: Type: Lambda Destination: !GetAtt DestinationLambda.Arn # Arn of a Lambda function declared in the template file. ``` ### EventInvoke 带有 SNS 目标的配置示例在此示例中，为在 OnSuccess 配置的模板文件中声明的 SNS 主题提供了一个目标。 #### YAML ``` EventInvokeConfig: DestinationConfig: OnSuccess: Type: SNS Destination: Ref: DestinationSNS # Arn of an SNS topic declared in the tempate file ``` # OnSuccess 已成功处理的事件的目的地。 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [Destination](#sam-function-onsuccess-destination): String [Type](#sam-function-onsuccess-type): String ``` ## Properties `Destination` 目标资源的 Amazon 资源名称（ARN）。 *类型*：字符串 *必需*：条件 *CloudFormation 兼容性*：此属性类似于`AWS::Lambda::EventInvokeConfig`资源的`[OnSuccess](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-onsuccess)`属性。SAM 将向与该函数关联的自动生成的 IAM 角色添加任何必要的权限，以访问此属性中引用的资源。 *其他说明*：如果类型为 Lambda/EventBridge，则必须填写目的地。 `Type` 目标中引用的资源类型。支持的类型有 `SQS`、`SNS`、`S3`、`Lambda` 和 `EventBridge`。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 *其他说明*：如果类型为 SQS/SNS 且`Destination`属性留空，则 SQS/SNS 资源由 SAM 自动生成。要引用该资源，请使用 `.DestinationQueue`（对于 SQS）或 `.DestinationTopic`（对于 SQS）。如果类型为 Lambda/EventBridge，`Destination`则为必填项。 ## 示例 ### EventInvoke 包含 SQS 和 Lambda 目标的配置示例在此示例中，没有给出 SQS OnSuccess 配置的目标，因此 SAM 隐式创建了一个 SQS 队列并添加了所有必要的权限。同样在本示例中，在 OnFailure 配置中指定了在模板文件中声明的 Lambda 资源的目标，因此 SAM 向此 Lambda 函数添加了调用目标 Lambda 函数所需的权限。 #### YAML ``` EventInvokeConfig: DestinationConfig: OnSuccess: Type: SQS OnFailure: Type: Lambda Destination: !GetAtt DestinationLambda.Arn # Arn of a Lambda function declared in the template file. ``` ### EventInvoke 带有 SNS 目标的配置示例在此示例中，为在 OnSuccess 配置的模板文件中声明的 SNS 主题提供了一个目标。 #### YAML ``` EventInvokeConfig: DestinationConfig: OnSuccess: Type: SNS Destination: Ref: DestinationSNS # Arn of an SNS topic declared in the tempate file ``` # EventSource 描述触发函数的事件源的对象。每个事件都由一个类型和一组依赖于该类型的属性组成。有关每个事件源的属性的更多信息，请参阅与具体类型对应的主题。 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [Properties](#sam-function-eventsource-properties): AlexaSkill | Api | CloudWatchEvent | CloudWatchLogs | Cognito | DocumentDB | DynamoDB | EventBridgeRule | HttpApi | IoTRule | Kinesis | MQ | MSK | S3 | Schedule | ScheduleV2 | SelfManagedKafka | SNS | SQS [Type](#sam-function-eventsource-type): String ``` ## Properties `Properties` 描述此事件映射的属性的对象。这组属性必须符合定义的类型。 *类型* [[[[[：[AlexaSkill](sam-property-function-alexaskill.md)\$1 Ap [i](sam-property-function-api.md) \$1 \$1 \$1 Co [gnito [CloudWatchEvent[CloudWatchLogs](sam-property-function-cloudwatchlogs.md)](sam-property-function-cloudwatchevent.md)](sam-property-function-cognito.md)\$1 documentDB \$1 D [ynamo [DB](sam-property-function-documentdb.md) \$1 \$1 \$1 [Io](sam-property-function-iotrule.md) \$1 [Kinesis [EventBridgeRule](sam-property-function-eventbridgerule.md)\$1 MQ [HttpApi](sam-property-function-httpapi.md)\$1 MS](sam-property-function-kinesis.md) K TRule \$1 S3 \$1 日程](sam-property-function-dynamodb.md)安排 \$1 Schedu [leV2 \$1 \$1](sam-property-function-mq.md)[SNS \$1 SQ](sam-property-function-msk.md) S [SelfManagedKafka](sam-property-function-selfmanagedkafka.md)](sam-property-function-sqs.md)](sam-property-function-sns.md)](sam-property-function-schedulev2.md)](sam-property-function-schedule.md)](sam-property-function-s3.md) *是否必需*：是 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `Type` 事件类型。 *有效值*：`AlexaSkill`, `Api`, `CloudWatchEvent`, `CloudWatchLogs`, `Cognito`, `DocumentDB`, `DynamoDB`, `EventBridgeRule`, `HttpApi`, `IoTRule`, `Kinesis`, `MQ`, `MSK`, `S3`, `Schedule`, `ScheduleV2`, `SelfManagedKafka`, `SNS`, `SQS` *类型*：字符串 *是否必需*：是 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 ## 示例 ### APIEvent 使用 API 事件的示例 #### YAML ``` ApiEvent: Type: Api Properties: Method: get Path: /group/{user} RestApiId: Ref: MyApi ``` # AlexaSkill 描述 `AlexaSkill` 事件源类型的对象。 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [SkillId](#sam-function-alexaskill-skillid): String ``` ## Properties `SkillId` Alexa 技能的 ID。有关技能 ID 的更多信息，请参阅 Alexa Skills Kit 文档中的[为 Lambda 函数配置触发器](https://developer.amazon.com/docs/custom-skills/host-a-custom-skill-as-an-aws-lambda-function.html#configuring-the-alexa-skills-kit-trigger)。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 ## 示例 ### AlexaSkillTrigger Alexa Skill 事件示例 #### YAML ``` AlexaSkillEvent: Type: AlexaSkill ``` # Api 描述 `Api` 事件源类型的对象。如果定义了 [AWS::Serverless::Api](sam-resource-api.md) 资源，则路径和方法值必须与 API 的 OpenAPI 定义中的操作相对应。如果未定义 [AWS::Serverless::Api](sam-resource-api.md)，则函数的输入和输出表示 HTTP 请求和 HTTP 响应。例如，使用 JavaScript API，可以通过返回带有 statusCode 和 body 密钥的对象来控制响应的状态代码和正文。 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [Auth](#sam-function-api-auth): ApiFunctionAuth [Method](#sam-function-api-method): String [Path](#sam-function-api-path): String [RequestModel](#sam-function-api-requestmodel): RequestModel [RequestParameters](#sam-function-api-requestparameters): List of [ String | RequestParameter ] [RestApiId](#sam-function-api-restapiid): String [ResponseTransferMode](#sam-function-api-responsetransfermode): String TimeoutInMillis: Integer ``` ## Properties `Auth` 此特定 Api\$1路径\$1方法的身份验证配置。对于未指定 `DefaultAuthorizer` 时覆盖在单个路径上 API 的 `DefaultAuthorizer` 设置身份验证配置或覆盖默认 `ApiKeyRequired` 设置很有用。 *类型*：[ApiFunctionAuth](sam-property-function-apifunctionauth.md) *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `Method` 调用此函数的 HTTP 方法。选项包括 `DELETE`、`GET`、`HEAD`、`OPTIONS`、`PATCH`、`POST`、`PUT` 和 `ANY`。有关详细信息，请参阅*《API Gateway 开发人员指南》*中的[设置 HTTP 方法](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-settings-method-request.html#setup-method-add-http-method)。 *类型*：字符串 *是否必需*：是 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `Path` 调用此函数的 URI 路径。必须以 `/` 开头。 *类型*：字符串 *是否必需*：是 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `RequestModel` 用于此特定 Api\$1路径\$1方法的请求模型。这应该引用 [AWS::Serverless::Api](sam-resource-api.md) 资源 `Models` 部分中指定的模型的名称。 *类型*：[RequestModel](sam-property-function-requestmodel.md) *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `RequestParameters` 此特定 Api\$1Path\$1Method 的请求参数配置。所有参数名称必须以 `method.request` 开头，且必须限制为 `method.request.header`、`method.request.querystring`、或`method.request.path`。列表既可以包含参数名称字符串，也可以包含[RequestParameter](sam-property-function-requestparameter.md)对象。对于字符串，`Required` 和 `Caching` 属性将默认为 `false`。 *类型*：[字符串 \$1 [RequestParameter](sam-property-function-requestparameter.md)] 列表 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `RestApiId` RestApi 资源的标识符，必须包含具有给定路径和方法的操作。通常，将其设置为引用此模板中定义的 [AWS::Serverless::Api](sam-resource-api.md) 资源。如果未定义此属性，则使用生成的`OpenApi`文档 AWS SAM 创建默认[AWS::Serverless::Api](sam-resource-api.md)资源。该资源包含所有路径和方法的并集，这些路径和方法由同一模板中的 `Api` 事件定义，但未指定 `RestApiId`。这不能引用其他模板中定义的 [AWS::Serverless::Api](sam-resource-api.md) 资源。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `ResponseTransferMode` Lambda 函数集成的响应传输模式。设置`RESPONSE_STREAM`为可启用通过 API Gateway 进行的 Lambda 响应流式传输，从而允许该函数将响应流回客户端。设置为时`RESPONSE_STREAM`，API Gateway 使用 Lambda InvokeWithResponseStreaming API。 *类型*：字符串 *必需*：否 *有效值*：`BUFFERED` \$1 `RESPONSE_STREAM` *CloudFormation 兼容性*：此属性直接传递给的[https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integration.html#cfn-apigateway-method-integration-responsetransfermode](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integration.html#cfn-apigateway-method-integration-responsetransfermode)属性`AWS::ApiGateway::Method Integration`。 `TimeoutInMillis` 自定义超时值，范围在 50 到 29,000 毫秒之间。当您指定此属性时， AWS SAM 会修改您的 OpenAPI 定义。必须使用 `DefinitionBody` 属性内联指定 OpenAPI 定义。 *类型*：整数 *必需*：否 *默认值*：29,000 毫秒或 29 秒 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 ## 示例 ### 基本示例 #### YAML ``` Events: ApiEvent: Type: Api Properties: Path: /path Method: get RequestParameters: - method.request.header.Authorization - method.request.querystring.keyword: Required: true Caching: false ``` # ApiFunctionAuth 在事件级别为特定 API、路径和方法配置授权。 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [ApiKeyRequired](#sam-function-apifunctionauth-apikeyrequired): Boolean [AuthorizationScopes](#sam-function-apifunctionauth-authorizationscopes): List [Authorizer](#sam-function-apifunctionauth-authorizer): String [InvokeRole](#sam-function-apifunctionauth-invokerole): String OverrideApiAuth: Boolean [ResourcePolicy](#sam-function-apifunctionauth-resourcepolicy): ResourcePolicyStatement ``` ## Properties `ApiKeyRequired` 此 API、路径和方法需要 API 密钥。 *类型*：布尔值 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `AuthorizationScopes` 适用于此 API、路径和方法的授权范围。如果您已指定 `DefaultAuthorizer` 属性，则您指定的范围将覆盖该属性应用的所有范围。 *类型*：列表 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `Authorizer` 特定函数的`Authorizer`。如果您为 `AWS::Serverless::Api` 资源指定了全局授权方，则可以通过将 `Authorizer` 设置为 `NONE` 来覆盖该授权方。有关示例，请参阅[覆盖 Amazon API Gateway REST API 的全局授权方](#sam-property-function-apifunctionauth--examples--override)。如果您使用 `AWS::Serverless::Api` 资源的 `DefinitionBody` 属性来描述您的 API，则必须使用 `OverrideApiAuth` 和 `Authorizer` 来覆盖您的全局授权方。请参阅`OverrideApiAuth`了解更多信息。 *有效值*：`AWS_IAM``NONE`、或 AWS SAM 模板中定义的任何授权者的逻辑 ID。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `InvokeRole` 指定用于 `AWS_IAM` 授权的 `InvokeRole`。 *类型*：字符串 *必需*：否 *默认值*：`CALLER_CREDENTIALS` *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 *附加说明*：`CALLER_CREDENTIALS` 映射到 `arn:aws:iam:::/`，后者使用调用者凭证来调用端点。 `OverrideApiAuth` 指定为 `true` 以覆盖 `AWS::Serverless::Api` 资源的全局授权方配置。只有在您指定全局授权方并使用 `AWS::Serverless::Api` 资源的 `DefinitionBody` 属性来描述您的 API 时，才需要此属性。当你指定`OverrideApiAuth`为时`true`， AWS SAM 将使用为、或`ResourcePolicy`提供的任何值覆盖你的全局授权`ApiKeyRequired`者`Authorizer`。因此，使用 `OverrideApiAuth` 时还必须指定其中至少一个属性。有关示例，请参阅[指定 for 时 DefinitionBody 覆盖全局授权 AWS::Serverless::Api 方](#sam-property-function-apifunctionauth--examples--override2)。 *类型*：布尔值 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `ResourcePolicy` 在 API 上为此路径配置资源策略。 *类型*：[ResourcePolicyStatement](sam-property-function-resourcepolicystatement.md) *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 ## 示例 ### 函数身份验证以下示例指定了函数级别的授权。 #### YAML ``` Auth: ApiKeyRequired: true Authorizer: NONE ``` ### 覆盖 Amazon API Gateway REST API 的全局授权方您可以为 `AWS::Serverless::Api` 资源指定全局授权方。以下是配置全局默认授权方的示例： ``` AWSTemplateFormatVersion: '2010-09-09' Transform: AWS::Serverless-2016-10-31 ... Resources: MyApiWithLambdaRequestAuth: Type: AWS::Serverless::Api Properties: ... Auth: Authorizers: MyLambdaRequestAuth: FunctionArn: !GetAtt MyAuthFn.Arn DefaultAuthorizer: MyLambdaRequestAuth ``` 要覆盖 AWS Lambda 函数的默认授权者，可以指定`Authorizer`为`NONE`。以下是示例： ``` AWSTemplateFormatVersion: '2010-09-09' Transform: AWS::Serverless-2016-10-31 ... Resources: ... MyFn: Type: AWS::Serverless::Function Properties: ... Events: LambdaRequest: Type: Api Properties: RestApiId: !Ref MyApiWithLambdaRequestAuth Method: GET Auth: Authorizer: NONE ``` ### 指定 for 时 DefinitionBody 覆盖全局授权 AWS::Serverless::Api 方当使用 `DefinitionBody` 属性描述 `AWS::Serverless::Api` 资源时，之前的覆盖方法不起作用。以下是对 `AWS::Serverless::Api` 资源使用 `DefinitionBody` 属性的示例： ``` AWSTemplateFormatVersion: '2010-09-09' Transform: AWS::Serverless-2016-10-31 ... Resources: MyApiWithLambdaRequestAuth: Type: AWS::Serverless::Api Properties: ... DefinitionBody: swagger: 2.0 ... paths: /lambda-request: ... Auth: Authorizers: MyLambdaRequestAuth: FunctionArn: !GetAtt MyAuthFn.Arn DefaultAuthorizer: MyLambdaRequestAuth ``` 要覆盖全局授权方，请使用 `OverrideApiAuth` 属性。以下是使用 `OverrideApiAuth` 通过为 `Authorizer` 提供的值覆盖全局授权方的示例： ``` AWSTemplateFormatVersion: '2010-09-09' Transform: AWS::Serverless-2016-10-31 ... Resources: MyApiWithLambdaRequestAuth: Type: AWS::Serverless::Api Properties: ... DefinitionBody: swagger: 2-0 ... paths: /lambda-request: ... Auth: Authorizers: MyLambdaRequestAuth: FunctionArn: !GetAtt MyAuthFn.Arn DefaultAuthorizer: MyLambdaRequestAuth MyAuthFn: Type: AWS::Serverless::Function ... MyFn: Type: AWS::Serverless::Function Properties: ... Events: LambdaRequest: Type: Api Properties: RestApiId: !Ref MyApiWithLambdaRequestAuth Method: GET Auth: Authorizer: NONE OverrideApiAuth: true Path: /lambda-token ``` # ResourcePolicyStatement 为 API 的所有方法和路径配置资源策略。有关资源策略的更多信息，请参阅*《API Gateway 开发人员指南》*中的[使用 API Gateway 资源策略控制 API 的访问权限](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-resource-policies.html)。 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [AwsAccountBlacklist](#sam-function-resourcepolicystatement-awsaccountblacklist): List [AwsAccountWhitelist](#sam-function-resourcepolicystatement-awsaccountwhitelist): List [CustomStatements](#sam-function-resourcepolicystatement-customstatements): List [IntrinsicVpcBlacklist](#sam-function-resourcepolicystatement-intrinsicvpcblacklist): List [IntrinsicVpcWhitelist](#sam-function-resourcepolicystatement-intrinsicvpcwhitelist): List [IntrinsicVpceBlacklist](#sam-function-resourcepolicystatement-intrinsicvpceblacklist): List [IntrinsicVpceWhitelist](#sam-function-resourcepolicystatement-intrinsicvpcewhitelist): List [IpRangeBlacklist](#sam-function-resourcepolicystatement-iprangeblacklist): List [IpRangeWhitelist](#sam-function-resourcepolicystatement-iprangewhitelist): List [SourceVpcBlacklist](#sam-function-resourcepolicystatement-sourcevpcblacklist): List [SourceVpcWhitelist](#sam-function-resourcepolicystatement-sourcevpcwhitelist): List ``` ## Properties `AwsAccountBlacklist` 要封锁的 AWS 账户。 *类型*：字符串列表 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `AwsAccountWhitelist` 要允许的 AWS 账户。有关此属性的使用示例，请参阅本页底部的“示例”部分。 *类型*：字符串列表 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `CustomStatements` 适用于此 API 的自定义资源策略语句列表。有关此属性的使用示例，请参阅本页底部的“示例”部分。 *类型*：列表 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `IntrinsicVpcBlacklist` 要屏蔽的虚拟私有云列表 (VPCs)，其中每个 VPC 都指定为引用，例如[动态引用](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html)或`Ref`[内部函数](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)。有关此属性的使用示例，请参阅本页底部的“示例”部分。 *类型*：列表 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `IntrinsicVpcWhitelist` VPCs 要允许的列表，其中每个 VPC 都指定为引用，例如[动态引用](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html)或`Ref`[内部函数](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)。 *类型*：列表 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `IntrinsicVpceBlacklist` 要阻止的 VPC 端点列表，其中每个 VPC 端点都指定为引用，例如[动态引用](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html)或`Ref`[内置函数](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)。 *类型*：列表 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `IntrinsicVpceWhitelist` 要允许的 VPC 端点列表，其中每个 VPC 端点都指定为引用，例如[动态引用](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html)或`Ref`[内置函数](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)。有关此属性的使用示例，请参阅本页底部的“示例”部分。 *类型*：列表 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `IpRangeBlacklist` 要阻止的 IP 地址或地址范围。有关此属性的使用示例，请参阅本页底部的“示例”部分。 *类型*：列表 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `IpRangeWhitelist` 要允许的 IP 地址或地址范围。 *类型*：列表 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `SourceVpcBlacklist` 要阻止的源 VPC 或 VPC 端点。源 VPC 名称必须以 `"vpc-"` 开头，源 VPC 端点名称必须以 `"vpce-"` 开头。有关此属性的使用示例，请参阅本页底部的“示例”部分。 *类型*：列表 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `SourceVpcWhitelist` 要允许的源 VPC 或 VPC 端点。源 VPC 名称必须以 `"vpc-"` 开头，源 VPC 端点名称必须以 `"vpce-"` 开头。 *类型*：列表 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 ## 示例 ### 资源策略示例以下示例屏蔽两个 IP 地址和一个源 VPC，并允许一个 AWS 账户。 #### YAML ``` Auth: ResourcePolicy: CustomStatements: [{ "Effect": "Allow", "Principal": "*", "Action": "execute-api:Invoke", "Resource": "execute-api:/Prod/GET/pets", "Condition": { "IpAddress": { "aws:SourceIp": "1.2.3.4" } } }] IpRangeBlacklist: - "10.20.30.40" - "1.2.3.4" SourceVpcBlacklist: - "vpce-1a2b3c4d" AwsAccountWhitelist: - "111122223333" IntrinsicVpcBlacklist: - "{{resolve:ssm:SomeVPCReference:1}}" - !Ref MyVPC IntrinsicVpceWhitelist: - "{{resolve:ssm:SomeVPCEReference:1}}" - !Ref MyVPCE ``` # RequestModel 为特定 Api\$1Path\$1 方法配置请求模型。 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [Model](#sam-function-requestmodel-model): String [Required](#sam-function-requestmodel-required): Boolean [ValidateBody](#sam-function-requestmodel-validatebody): Boolean [ValidateParameters](#sam-function-requestmodel-validateparameters): Boolean ``` ## Properties `Model` 在 [AWS::Serverless::Api](sam-resource-api.md) Models 属性中定义的模型的名称。 *类型*：字符串 *是否必需*：是 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `Required` 在给定 API 端点的 OpenApi 定义的参数部分中添加一个`required`属性。 *类型*：布尔值 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `ValidateBody` 指定 API Gateway 是否使用 `Model` 验证请求正文。有关更多信息，请参阅*《API Gateway 开发人员指南》*中的[在 API Gateway 中启用请求验证](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html)。 *类型*：布尔值 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `ValidateParameters` 指定 API Gateway 是否使用 `Model` 验证请求路径参数、查询字符串和标头。有关更多信息，请参阅*《API Gateway 开发人员指南》*中的[在 API Gateway 中启用请求验证](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html)。 *类型*：布尔值 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 ## 示例 ### 请求模型请求模型示例 #### YAML ``` RequestModel: Model: User Required: true ValidateBody: true ValidateParameters: true ``` # RequestParameter 为特定 Api\$1路径\$1方法配置请求参数。需要为请求参数指定 `Required` 或 `Caching` 属性 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [Caching](#sam-function-requestparameter-caching): Boolean [Required](#sam-function-requestparameter-required): Boolean ``` ## Properties `Caching` 在 API Gateway OpenApi 定义中添加`cacheKeyParameters`章节 *类型*：布尔值 *必需*：条件 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `Required` 此字段指定是否需要参数。 *类型*：布尔值 *必需*：条件 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 ## 示例 ### 请求参数设置请求参数的示例 #### YAML ``` RequestParameters: - method.request.header.Authorization: Required: true Caching: true ``` # CloudWatchEvent 描述 `CloudWatchEvent` 事件源类型的对象。 AWS Serverless Application Model (AWS SAM) 在设置此事件类型时生成[https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html)资源。 **重要说明**：[EventBridgeRule](sam-property-function-eventbridgerule.md)是首选使用的事件源类型，而不是`CloudWatchEvent`。 `EventBridgeRule`并`CloudWatchEvent`使用相同的底层服务、API 和 CloudFormation 资源。但是， AWS SAM 将仅向添加对新功能的支持`EventBridgeRule`。 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [Enabled](#sam-function-cloudwatchevent-enabled): Boolean [EventBusName](#sam-function-cloudwatchevent-eventbusname): String [Input](#sam-function-cloudwatchevent-input): String [InputPath](#sam-function-cloudwatchevent-inputpath): String [Pattern](#sam-function-cloudwatchevent-pattern): [EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern) [State](#sam-function-cloudwatchevent-state): String ``` ## Properties `Enabled` 指示是否启用规则。要禁用该规则，请将此属性设置为 `false`。指定 `Enabled` 或 `State` 属性，但不能同时指定两者。 *类型*：布尔值 *必需*：否 *CloudFormation 兼容性*：此属性类似于`AWS::Events::Rule`资源的`[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state)`属性。如果此属性设置为，`true`则 AWS SAM 通过`ENABLED`，否则通过`DISABLED`。 `EventBusName` 要与该规则关联的事件总线。如果省略此属性，则 AWS SAM 使用默认的事件总线。 *类型*：字符串 *必需*：否 *默认*：默认事件总线 *CloudFormation 兼容性*：此属性直接传递给`AWS::Events::Rule`资源的`[EventBusName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventbusname)`属性。 `Input` 传递到目标的有效 JSON 文本。如果使用此属性，则不会将事件文本本身的任何内容传递到目标。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Events::Rule Target`资源的`[Input](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-input)`属性。 `InputPath` 当您不希望将整个匹配事件传递给目标时，请使用 `InputPath` 属性描述要传递事件的哪一部分。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Events::Rule Target`资源的`[InputPath](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputpath)`属性。 `Pattern` 描述哪些事件路由到指定目标。有关更多信息，请参阅 *Amazon EventBridge 用户指南 EventBridge*[中的事件和事件模式](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html)。 *类型*：[EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern) *是否必需*：是 *CloudFormation 兼容性*：此属性直接传递给`AWS::Events::Rule`资源的`[EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)`属性。 `State` 规则的状态。 *接受的值：*`DISABLED | ENABLED` 指定 `Enabled` 或 `State` 属性，但不能同时指定两者。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Events::Rule`资源的`[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state)`属性。 ## 示例 ### CloudWatchEvent 以下是 `CloudWatchEvent` 事件源类型的示例。 #### YAML ``` CWEvent: Type: CloudWatchEvent Properties: Enabled: false Input: '{"Key": "Value"}' Pattern: detail: state: - running ``` # CloudWatchLogs 描述 `CloudWatchLogs` 事件源类型的对象。此事件生成 [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html) 资源、指定订阅筛选器并将其与指定的日志组关联。 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [FilterPattern](#sam-function-cloudwatchlogs-filterpattern): String [LogGroupName](#sam-function-cloudwatchlogs-loggroupname): String ``` ## Properties `FilterPattern` 限制传送到目标 AWS 资源的内容的筛选表达式。有关筛选器模式语法的更多信息，请参阅[筛选器和模式语法](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html)。 *类型*：字符串 *是否必需*：是 *CloudFormation 兼容性*：此属性直接传递给`AWS::Logs::SubscriptionFilter`资源的`[FilterPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-cwl-subscriptionfilter-filterpattern)`属性。 `LogGroupName` 要与订阅筛选器关联的日志组。如果筛选模式与日志事件匹配，则所有上传到该日志组的日志事件都将被筛选并传送到指定的 AWS 资源。 *类型*：字符串 *是否必需*：是 *CloudFormation 兼容性*：此属性直接传递给`AWS::Logs::SubscriptionFilter`资源的`[LogGroupName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-cwl-subscriptionfilter-loggroupname)`属性。 ## 示例 ### Cloudwatchlogs 订阅筛选器 Cloudwatchlog 订阅筛选示例 #### YAML ``` CWLog: Type: CloudWatchLogs Properties: LogGroupName: Ref: CloudWatchLambdaLogsGroup FilterPattern: My pattern ``` # Cognito 描述 `Cognito` 事件源类型的对象。 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [Trigger](#sam-function-cognito-trigger): List [UserPool](#sam-function-cognito-userpool): String ``` ## Properties `Trigger` 新用户群体的 Lambda 触发器配置信息。 *类型*：列表 *是否必需*：是 *CloudFormation 兼容性*：此属性直接传递给`AWS::Cognito::UserPool`资源的`[LambdaConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html)`属性。 `UserPool` 对在同一模板中 UserPool 定义的引用 *类型*：字符串 *是否必需*：是 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 ## 示例 ### Cognito 事件 Cognito 事件示例 #### YAML ``` CognitoUserPoolPreSignup: Type: Cognito Properties: UserPool: Ref: MyCognitoUserPool Trigger: PreSignUp ``` # DocumentDB 描述 `DocumentDB` 事件源类型的对象。有关更多信息，请参阅*AWS Lambda 开发者*指南中的[AWS Lambda 与亚马逊 DocumentDB 配合使用](https://docs.aws.amazon.com/lambda/latest/dg/with-documentdb.html)。 ## 语法要在 AWS SAM 模板中声明此实体，请使用以下语法。 ### YAML ``` BatchSize: Integer Cluster: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html) CollectionName: String DatabaseName: String Enabled: Boolean FilterCriteria: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html) FullDocument: String KmsKeyArn: String MaximumBatchingWindowInSeconds: Integer SecretsManagerKmsKeyId: String SourceAccessConfigurations: List StartingPosition: String StartingPositionTimestamp: Double ``` ## Properties `BatchSize` 要在单个批次中检索的最大项目数。 *类型*：整数 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[ BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)`属性。 `Cluster` Amazon DocumentDB 集群的 Amazon 资源名称（ARN）。 *类型*：字符串 *是否必需*：是 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[ EventSourceArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn)`属性。 `CollectionName` 将使用的数据库中集合的名称。如果您未指定集合，Lambda 会使用所有集合。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping``DocumentDBEventSourceConfig`数据类型的`[ CollectionName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-documentdbeventsourceconfig.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig-collectionname)`属性。 `DatabaseName` 将使用的 Amazon DocumentDB 集群中数据库的名称。 *类型*：字符串 *是否必需*：是 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping``DocumentDBEventSourceConfig`数据类型的`[ DatabaseName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-documentdbeventsourceconfig.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig-databasename)`属性。 `Enabled` 如果为 `true`，则事件源映射处于活动状态。要暂停轮询和调用，设置为 `false`。 *类型*：布尔值 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[ Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)`属性。 `FilterCriteria` 定义用于确定 Lambda 是否应处理事件的条件的对象。有关更多信息，请参阅《AWS Lambda 开发人员指南》**中的 [Lambda 事件筛选](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html)。 *类型*：[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[ FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)`属性。 `FullDocument` 确定 Amazon DocumentDB 在文档更新操作期间将向您的事件流发送的内容。如果设置为 `UpdateLookup`，Amazon DocumentDB 将发送一个描述所发生更改的增量以及完整文档的副本。否则，Amazon DocumentDB 将仅发送包含更改的部分文档。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping``DocumentDBEventSourceConfig`数据类型的`[ FullDocument](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-documentdbeventsourceconfig.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig-fulldocument)`属性。 `KmsKeyArn` 用于加密与此事件相关信息的密钥的 Amazon 资源名称（ARN）。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)`属性。 `MaximumBatchingWindowInSeconds` 在调用函数之前收集记录的最长时间（以秒为单位）。 *类型*：整数 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[ MaximumBatchingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds)`属性。 `SecretsManagerKmsKeyId` 来自 Secrets Manager 的客户托管密钥的 AWS Key Management Service (AWS KMS) AWS 密钥 ID。当您以不包含 `kms:Decrypt` 权限的 Lambda 执行角色使用来自 Secrets Manager 的客户托管密钥时，此为必需。此属性的值为 UUID。例如：`1abc23d4-567f-8ab9-cde0-1fab234c5d67`。 *类型*：字符串 *必需*：条件 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `SourceAccessConfigurations` 身份验证协议或虚拟主机的数组。使用[SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html)数据类型进行指定。对于 `DocumentDB` 事件源类型，唯一有效的配置类型是 `BASIC_AUTH`。 + `BASIC_AUTH` – 存储您的代理凭证的 Secrets Manager 密钥。要使用此类型，凭证必须采用以下格式：`{"username": "your-username", "password": "your-password"}`。只允许使用一个类型为 `BASIC_AUTH` 的对象。 *类型*：列表 *是否必需*：是 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[ SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-sourceaccessconfigurations)`属性。 `StartingPosition` 在流中开始读取数据的位置。 + `AT_TIMESTAMP` – 指定开始读取记录的时间。 + `LATEST` - 仅读取新记录。 + `TRIM_HORIZON` - 处理所有可用的记录。 *类型*：字符串 *是否必需*：是 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[ StartingPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition)`属性。 `StartingPositionTimestamp` 开始读取的时间（以 Unix 时间秒为单位）在 `StartingPosition` 被指定为 `AT_TIMESTAMP` 的情况下定义 `StartingPositionTimestamp`。 *类型*：双精度 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[ StartingPositionTimestamp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp)`属性。 ## 示例 ### Amazon DocumentDB 事件源 ``` AWSTemplateFormatVersion: '2010-09-09' Transform: AWS::Serverless-2016-10-31 ... Resources: MyFunction: Type: AWS::Serverless::Function Properties: ... Events: MyDDBEvent: Type: DocumentDB Properties: Cluster: "arn:aws:rds:us-west-2:123456789012:cluster:docdb-2023-01-01" BatchSize: 10 MaximumBatchingWindowInSeconds: 5 DatabaseName: "db1" CollectionName: "collection1" FullDocument: "UpdateLookup" SourceAccessConfigurations: - Type: BASIC_AUTH URI: "arn:aws:secretsmanager:us-west-2:123456789012:secret:doc-db" ``` # DynamoDB 描述 `DynamoDB` 事件源类型的对象。*有关更多信息，请参阅开发者指南中的[AWS LambdaAWS Lambda 与亚马逊 DynamoDB 搭配使用](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html)。* AWS SAM 设置此事件类型时会生成[https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html)资源。 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [BatchSize](#sam-function-dynamodb-batchsize): Integer [BisectBatchOnFunctionError](#sam-function-dynamodb-bisectbatchonfunctionerror): Boolean [DestinationConfig](#sam-function-dynamodb-destinationconfig): [DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig) [Enabled](#sam-function-dynamodb-enabled): Boolean [FilterCriteria](#sam-function-dynamodb-filtercriteria): [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html) [FunctionResponseTypes](#sam-function-dynamodb-functionresponsetypes): List KmsKeyArn: String [MaximumBatchingWindowInSeconds](#sam-function-dynamodb-maximumbatchingwindowinseconds): Integer [MaximumRecordAgeInSeconds](#sam-function-dynamodb-maximumrecordageinseconds): Integer [MaximumRetryAttempts](#sam-function-dynamodb-maximumretryattempts): Integer [MetricsConfig](#sam-function-dynamodb-metricsconfig): [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig) [ParallelizationFactor](#sam-function-dynamodb-parallelizationfactor): Integer [StartingPosition](#sam-function-dynamodb-startingposition): String StartingPositionTimestamp: Double [Stream](#sam-function-dynamodb-stream): String [TumblingWindowInSeconds](#sam-function-dynamodb-tumblingwindowinseconds): Integer ``` ## Properties `BatchSize` 要在单个批次中检索的最大项目数。 *类型*：整数 *必需*：否 *默认值*：100 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)`属性。 *最小值*：`1` *最大值*：`1000` `BisectBatchOnFunctionError` 如果函数返回错误，则将批次拆分为两批并重试。 *类型*：布尔值 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[BisectBatchOnFunctionError](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-bisectbatchonfunctionerror)`属性。 `DestinationConfig` 丢弃的记录的 Amazon Simple Queue Service (Amazon SQS) 队列或 Amazon Simple Notiﬁcation Service (Amazon SNS)主题目标。 *类型*：[DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig)`属性。 `Enabled` 禁用事件源映射以暂停轮询和调用。 *类型*：布尔值 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)`属性。 `FilterCriteria` 定义用于确定 Lambda 是否应处理事件的条件的对象。有关更多信息，请参阅《AWS Lambda 开发人员指南》**中的 [AWS Lambda 事件筛选](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html)。 *类型*：[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)`属性。 `FunctionResponseTypes` 当前应用于事件源映射的响应类型的列表。有关详细信息，请参阅《AWS Lambda 开发人员指南》**中的[报告批处理项目失败](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-batchfailurereporting)。 *有效值*：`ReportBatchItemFailures` *类型*：列表 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[FunctionResponseTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionresponsetypes)`属性。 `KmsKeyArn` 用于加密与此事件相关信息的密钥的 Amazon 资源名称（ARN）。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)`属性。 `MaximumBatchingWindowInSeconds` 在调用函数之前收集记录的最长时间（以秒为单位）。 *类型*：整数 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[MaximumBatchingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds)`属性。 `MaximumRecordAgeInSeconds` Lambda 发送到函数以进行处理的记录的最长期限。 *类型*：整数 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[MaximumRecordAgeInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumrecordageinseconds)`属性。 `MaximumRetryAttempts` 在函数返回错误时重试的最大次数。 *类型*：整数 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[MaximumRetryAttempts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumretryattempts)`属性。 `MetricsConfig` 一种选择性配置，用于获取增强型指标，这些指标针对事件源映射进行捕获，涵盖处理过程的每个阶段。有关示例，请参阅[MetricsConfig 事件](#sam-property-function-dynamodb-example-metricsconfigevent)。 *类型*：[MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)`属性。 `ParallelizationFactor` 要从每个分片中同时处理的批次数。 *类型*：整数 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[ParallelizationFactor](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-parallelizationfactor)`属性。 `StartingPosition` 在流中开始读取数据的位置。 + `AT_TIMESTAMP` – 指定开始读取记录的时间。 + `LATEST` - 仅读取新记录。 + `TRIM_HORIZON` - 处理所有可用的记录。 *有效值*：`AT_TIMESTAMP` \$1 `LATEST` \$1 `TRIM_HORIZON` *类型*：字符串 *是否必需*：是 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[StartingPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition)`属性。 `StartingPositionTimestamp` 开始读取的时间（以 Unix 时间秒为单位）在 `StartingPosition` 被指定为 `AT_TIMESTAMP` 的情况下定义 `StartingPositionTimestamp`。 *类型*：双精度 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[StartingPositionTimestamp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp)`属性。 `Stream` DynamoDB 流的 Amazon 资源名称（ARN）。 *类型*：字符串 *是否必需*：是 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[EventSourceArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn)`属性。 `TumblingWindowInSeconds` 处理窗口的持续时间（以秒为单位）。有效范围为 1 到 900（15 分钟）。有关更多信息，请参阅《AWS Lambda 开发人员指南》**的[滚动窗口](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#streams-tumbling)。 *类型*：整数 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[TumblingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-tumblingwindowinseconds)`属性。 ## 示例 ### MetricsConfig 事件以下是一个资源示例，它使用 `MetricsConfig` 属性来捕获其事件源映射的每个处理阶段。 ``` Resources: FilteredEventsFunction: Type: AWS::Serverless::Function Properties: CodeUri: s3://sam-demo-bucket/metricsConfig.zip Handler: index.handler Runtime: nodejs16.x Events: KinesisStream: Type: Kinesis Properties: Stream: !GetAtt KinesisStream.Arn StartingPosition: LATEST MetricsConfig: Metrics: - EventCount ``` ### 现有 DynamoDB 表的 DynamoDB 事件源账户中已存在的 DynamoDB 表的 DynamoDB 事件源。 AWS #### YAML ``` Events: DDBEvent: Type: DynamoDB Properties: Stream: arn:aws:dynamodb:us-east-1:123456789012:table/TestTable/stream/2016-08-11T21:21:33.291 StartingPosition: TRIM_HORIZON BatchSize: 10 Enabled: false ``` ### 模板中声明的 DynamoDB 表的 DynamoDB 事件在同一模板文件中声明的 DynamoDB 表的 DynamoDB 事件。 #### YAML ``` Events: DDBEvent: Type: DynamoDB Properties: Stream: !GetAtt MyDynamoDBTable.StreamArn # This must be the name of a DynamoDB table declared in the same template file StartingPosition: TRIM_HORIZON BatchSize: 10 Enabled: false ``` # EventBridgeRule 描述`EventBridgeRule`事件源类型的对象，它将您的无服务器函数设置为 Amazon EventBridge 规则的目标。有关更多信息，请参阅[什么是亚马逊 EventBridge？](https://docs.aws.amazon.com/eventbridge/latest/userguide/what-is-amazon-eventbridge.html) 在《*亚马逊 EventBridge 用户指南》*中。 AWS SAM 设置此事件类型时会生成[https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html)资源。 AWS SAM 还会创建`AWS::Lambda::Permission`资源，该资源是调用 Lambda 所`EventBridgeRule`必需的。 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [DeadLetterConfig](#sam-function-eventbridgerule-deadletterconfig): DeadLetterConfig [EventBusName](#sam-function-eventbridgerule-eventbusname): String [Input](#sam-function-eventbridgerule-input): String [InputPath](#sam-function-eventbridgerule-inputpath): String InputTransformer: [InputTransformer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html) [Pattern](#sam-function-eventbridgerule-pattern): [EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern) [RetryPolicy](#sam-function-eventbridgerule-retrypolicy): [RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy) RuleName: String State: String [Target](#sam-function-eventbridgerule-target): Target ``` ## Properties `DeadLetterConfig` 配置亚马逊简单队列服务 (Amazon SQS) Simple Queue Service 队列，目标调用失败后 EventBridge 在该队列中发送事件。例如，当向不存在的 Lambda 函数发送事件时，或者没有足够的权限调用 Lambda 函数 EventBridge 时，调用可能会失败。有关更多信息，请参阅 A *ma EventBridge * zon 用户指南中的[事件重试策略和使用死信队列](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html)。 [AWS::Serverless::Function](sam-resource-function.md) 资源类型具有类似的数据类型 `DeadLetterQueue`，用于处理成功调用目标 Lambda 函数后发生的故障。这些类型的故障示例包括 Lambda 节流或 Lambda 目标函数返回的错误。有关函数 `DeadLetterQueue` 属性的更多信息，请参阅*《AWS Lambda 开发人员指南》*中的[死信队列](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq)。 *类型*：[DeadLetterConfig](sam-property-function-deadletterconfig.md) *必需*：否 *CloudFormation 兼容性*：此属性类似于`AWS::Events::Rule``Target`数据类型的`[DeadLetterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-deadletterconfig)`属性。此属性的 AWS SAM 版本包括其他子属性， AWS SAM 以备您想要创建死信队列时使用。 `EventBusName` 要与该规则关联的事件总线。如果省略此属性，则 AWS SAM 使用默认的事件总线。 *类型*：字符串 *必需*：否 *默认*：默认事件总线 *CloudFormation 兼容性*：此属性直接传递给`AWS::Events::Rule`资源的`[EventBusName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventbusname)`属性。 `Input` 传递到目标的有效 JSON 文本。如果使用此属性，则不会将事件文本本身的任何内容传递到目标。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Events::Rule Target`资源的`[Input](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-input)`属性。 `InputPath` 当您不希望将整个匹配事件传递给目标时，请使用 `InputPath` 属性描述要传递事件的哪一部分。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Events::Rule Target`资源的`[InputPath](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputpath)`属性。 `InputTransformer` 使您可以根据特定事件数据向目标提供自定义输入的设置。您可以从事件中提取一个或多个键值对，然后使用该数据将自定义输入发送到目标。有关更多信息，请参阅[亚马逊* EventBridge 用户指南中的亚马逊 EventBridge *输入转换](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-transform-target-input.html)。 *类型*：[InputTransformer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputtransformer) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Events::Rule``Target`数据类型的`[InputTransformer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html)`属性。 `Pattern` 描述哪些事件路由到指定目标。有关更多信息，请参阅[亚马逊* EventBridge 用户指南中的亚马逊 EventBridgeEventBridge *事件](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-events.html)[和事件模式](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html)。 *类型*：[EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern) *是否必需*：是 *CloudFormation 兼容性*：此属性直接传递给`AWS::Events::Rule`资源的`[EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)`属性。 `RetryPolicy` 包含有关重试策略设置的信息的 `RetryPolicy` 对象。有关更多信息，请参阅 A *ma EventBridge * zon 用户指南中的[事件重试策略和使用死信队列](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html)。 *类型*：[RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Events::Rule``Target`数据类型的`[RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)`属性。 `RuleName` 规则的名称。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Events::Rule`资源的`[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-name)`属性。 `State` 规则的状态。 *接受的值*：`DISABLED` \$1 `ENABLED` \$1 `ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS` *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Events::Rule`资源的`[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state) `属性。 `Target` 触发规则时 EventBridge 调用的 AWS 资源。您可以使用此属性来指定目标的逻辑 ID。如果未指定此属性，则 AWS SAM 生成目标的逻辑 ID。 *类型*：[目标](sam-property-function-target.md) *必需*：否 *CloudFormation 兼容性*：此属性类似于`AWS::Events::Rule`资源的`[Targets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-targets)`属性。 `Amazon EC2 RebootInstances API call`是目标属性的示例。此属性的 AWS SAM 版本仅允许您指定单个目标的逻辑 ID。 ## 示例 ### EventBridgeRule 以下是 `EventBridgeRule` 事件源类型的示例。 #### YAML ``` EBRule: Type: EventBridgeRule Properties: Input: '{"Key": "Value"}' Pattern: detail: state: - terminated RetryPolicy: MaximumRetryAttempts: 5 MaximumEventAgeInSeconds: 900 DeadLetterConfig: Type: SQS QueueLogicalId: EBRuleDLQ Target: Id: MyTarget ``` # DeadLetterConfig 该对象用于指定亚马逊简单队列服务 (Amazon SQS) Simple Queue Service 队列，目标调用失败后 EventBridge 在该队列中发送事件。例如，在向不存在的 Lambda 函数发送事件或调用 Lambda 函数的权限不足时，调用可能会失败。有关更多信息，请参阅 A *ma EventBridge * zon 用户指南中的[事件重试策略和使用死信队列](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html)。 **注意** [AWS::Serverless::Function](sam-resource-function.md) 资源类型具有类似的数据类型 `DeadLetterQueue`，用于处理成功调用目标 Lambda 函数后发生的故障。此类故障的示例包括 Lambda 节流或 Lambda 目标函数返回的错误。有关函数 `DeadLetterQueue` 属性的更多信息，请参阅*《AWS Lambda 开发人员指南》*中的[死信队列](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq)。 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [Arn](#sam-function-deadletterconfig-arn): String [QueueLogicalId](#sam-function-deadletterconfig-queuelogicalid): String [Type](#sam-function-deadletterconfig-type): String ``` ## Properties `Arn` 指定作为死信队列目标的 Amazon SQS 队列的 Amazon 资源名称（ARN）。指定 `Type` 属性或 `Arn` 属性，但不能同时指定两者。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Events::Rule``DeadLetterConfig`数据类型的`[Arn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-deadletterconfig.html#cfn-events-rule-deadletterconfig-arn)`属性。 `QueueLogicalId` 指定了 AWS SAM 创建的死信队列的自定义名称。`Type` 如果未设置 `Type` 属性，则将忽略该属性。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `Type` 队列的类型。设置此属性后， AWS SAM 会自动创建死信队列并附加必要的[基于资源的策略](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html#dlq-perms)，以授予规则资源向队列发送事件的权限。指定 `Type` 属性或 `Arn` 属性，但不能同时指定两者。 *有效值*：`SQS` *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 ## 示例 ### DeadLetterConfig DeadLetterConfig #### YAML ``` DeadLetterConfig: Type: SQS QueueLogicalId: MyDLQ ``` # Target 配置触发规则时 EventBridge 调用的 AWS 资源。 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [Id](#sam-function-target-id): String ``` ## Properties `Id` 目标的逻辑 ID。 `Id` 的值可以包含字母数字字符、句点 (`.`)、连字符 (`-`) 和下划线 (`_`)。 *类型*：字符串 *是否必需*：是 *CloudFormation 兼容性*：此属性直接传递给`AWS::Events::Rule``Target`数据类型的`[Id](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-id)`属性。 ## 示例 ### Target #### YAML ``` EBRule: Type: EventBridgeRule Properties: Target: Id: MyTarget ``` # HttpApi 描述带有类型的事件源的对象 HttpApi。如果 API 上存在指定路径和方法的 OpenApi 定义，SAM 将为您添加 Lambda 集成和安全部分（如果适用）。如果 API 上没有指定路径和方法的 OpenApi 定义，SAM 将为您创建此定义。 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [ApiId](#sam-function-httpapi-apiid): String [Auth](#sam-function-httpapi-auth): HttpApiFunctionAuth [Method](#sam-function-httpapi-method): String [Path](#sam-function-httpapi-path): String [PayloadFormatVersion](#sam-function-httpapi-payloadformatversion): String [RouteSettings](#sam-function-httpapi-routesettings): [RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings) [TimeoutInMillis](#sam-function-httpapi-timeoutinmillis): Integer ``` ## Properties `ApiId` 此模板中定义的 [AWS::Serverless::HttpApi](sam-resource-httpapi.md) 资源的标识符。如果未定义，则`ServerlessHttpApi`使用生成的 OpenApi 文档创建默认[AWS::Serverless::HttpApi](sam-resource-httpapi.md)资源，该文档包含由此模板中定义的 Api 事件定义的所有路径和方法的并集，这些路径和方法未指定`ApiId`。这不能引用其他模板中定义的 [AWS::Serverless::HttpApi](sam-resource-httpapi.md) 资源。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `Auth` 此特定 Api\$1路径\$1方法的身份验证配置。在未指定 `DefaultAuthorizer` 的情况下，对于覆盖 API 的 `DefaultAuthorizer` 或在各个路径中设置身份验证配置很有用。 *类型*：[HttpApiFunctionAuth](sam-property-function-httpapifunctionauth.md) *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `Method` 调用此函数的 HTTP 方法。如果未指定 `Path` 和 `Method`，SAM 会创建默认 API 路径，用于将未映射到其他端点的任何请求路由到此 Lambda 函数。每个 API 只能存在其中一个默认路径。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `Path` 调用此函数的 URI 路径。必须以 `/` 开头。如果未指定 `Path` 和 `Method`，SAM 会创建默认 API 路径，用于将未映射到其他端点的任何请求路由到此 Lambda 函数。每个 API 只能存在其中一个默认路径。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `PayloadFormatVersion` 指定发送到集成的有效负载的格式。注意： PayloadFormatVersion 需要 SAM 修改您的 OpenAPI 定义，因此它仅适用于属性中 OpenApi 定义的内联定义。`DefinitionBody` *类型*：字符串 *必需*：否 *默认值*：2.0 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `RouteSettings` 此 HTTP API 的每条路径的路由设置。有关路由设置的更多信息，请参阅 *API Gateway 开发者指南[AWS::ApiGatewayV2::Stage RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html)*中的。注意：如果 RouteSettings 在 HttpApi 资源和事件源中同时指定，则将其 AWS SAM 合并，优先使用事件源属性。 *类型*：[RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::ApiGatewayV2::Stage`资源的`[RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings)`属性。 `TimeoutInMillis` 自定义超时值，范围在 50 到 29,000 毫秒之间。注意： TimeoutInMillis 需要 SAM 修改您的 OpenAPI 定义，因此它仅适用于属性中 OpenApi 定义的内联定义。`DefinitionBody` *类型*：整数 *必需*：否 *默认值*：5000 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 ## 示例 ### 默认 HttpApi 事件 HttpApi 使用默认路径的事件。此 API 中所有未映射的路径和方法都将路由到此端点。 #### YAML ``` Events: HttpApiEvent: Type: HttpApi ``` ### HttpApi HttpApi 使用特定路径和方法的事件。 #### YAML ``` Events: HttpApiEvent: Type: HttpApi Properties: Path: / Method: GET ``` ### HttpApi 授权 HttpApi 使用授权者的事件。 #### YAML ``` Events: HttpApiEvent: Type: HttpApi Properties: Path: /authenticated Method: GET Auth: Authorizer: OpenIdAuth AuthorizationScopes: - scope1 - scope2 ``` # HttpApiFunctionAuth 在事件级别配置授权。为特定 API\$1路径\$1方法配置身份验证 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [AuthorizationScopes](#sam-function-httpapifunctionauth-authorizationscopes): List [Authorizer](#sam-function-httpapifunctionauth-authorizer): String ``` ## Properties `AuthorizationScopes` 适用于此 API、路径和方法的授权范围。此处列出的范围将覆盖`DefaultAuthorizer`应用的任何范围（如果存在）。 *类型*：列表 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `Authorizer` 特定函数的`Authorizer`。要使用 IAM 授权，请在模板的 `Globals` 部分指定 `AWS_IAM`，并为 `EnableIamAuthorizer` 指定 `true`。如果您已在 API 中指定了全局授权方并想公开特定函数，请通过将 `Authorizer` 设置为 `NONE` 来覆盖。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 ## 示例 ### 函数身份验证在函数级别指定授权 #### YAML ``` Auth: Authorizer: OpenIdAuth AuthorizationScopes: - scope1 - scope2 ``` ### IAM 授权在事件级别指定 IAM 授权。要在事件级别使用 `AWS_IAM` 授权，还必须在模板的 `Globals` 部分为 `EnableIamAuthorizer` 指定 `true`。有关更多信息，请参阅 [模板的 “全局” 部分 AWS SAM](sam-specification-template-anatomy-globals.md)。 #### YAML ``` Globals: HttpApi: Auth: EnableIamAuthorizer: true Resources: HttpApiFunctionWithIamAuth: Type: AWS::Serverless::Function Properties: Events: ApiEvent: Type: HttpApi Properties: Path: /iam-auth Method: GET Auth: Authorizer: AWS_IAM Handler: index.handler InlineCode: | def handler(event, context): return {'body': 'HttpApiFunctionWithIamAuth', 'statusCode': 200} Runtime: python3.9 ``` # IoTRule 描述 `IoTRule` 事件源类型的对象。创建用于声明 AWS IoT 规则的[https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-topicrule.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-topicrule.html)资源。有关更多信息，请参阅 [CloudFormation 文档](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-topicrule.html) ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [AwsIotSqlVersion](#sam-function-iotrule-awsiotsqlversion): String [Sql](#sam-function-iotrule-sql): String ``` ## Properties `AwsIotSqlVersion` 评估规则时使用的 SQL 规则引擎的版本。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::IoT::TopicRule TopicRulePayload`资源的`[AwsIotSqlVersion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-awsiotsqlversion)`属性。 `Sql` 用于查询主题的 SQL 语句。有关更多信息，请参阅《AWS IoT 开发人员指南》**中的[AWS IoT SQL 参考](https://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html#aws-iot-sql-reference)。 *类型*：字符串 *是否必需*：是 *CloudFormation 兼容性*：此属性直接传递给`AWS::IoT::TopicRule TopicRulePayload`资源的`[Sql](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-topicrulepayload.html#cfn-iot-topicrule-topicrulepayload-sql)`属性。 ## 示例 ### IoT 规则 IoT 规则示例 #### YAML ``` IoTRule: Type: IoTRule Properties: Sql: SELECT * FROM 'topic/test' ``` # Kinesis 描述 `Kinesis` 事件源类型的对象。有关更多信息，请参阅《*AWS Lambda 开发者*指南》中的[AWS Lambda 与 Amazon Kinesis 配合使用](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html)。 AWS SAM 设置此事件类型时会生成[https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html)资源。 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [BatchSize](#sam-function-kinesis-batchsize): Integer [BisectBatchOnFunctionError](#sam-function-kinesis-bisectbatchonfunctionerror): Boolean [DestinationConfig](#sam-function-kinesis-destinationconfig): [DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig) [Enabled](#sam-function-kinesis-enabled): Boolean [FilterCriteria](#sam-function-kinesis-filtercriteria): [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html) [FunctionResponseTypes](#sam-function-kinesis-functionresponsetypes): List KmsKeyArn: String [MaximumBatchingWindowInSeconds](#sam-function-kinesis-maximumbatchingwindowinseconds): Integer [MaximumRecordAgeInSeconds](#sam-function-kinesis-maximumrecordageinseconds): Integer [MaximumRetryAttempts](#sam-function-kinesis-maximumretryattempts): Integer [MetricsConfig](#sam-function-kinesis-metricsconfig): [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig) [ParallelizationFactor](#sam-function-kinesis-parallelizationfactor): Integer [StartingPosition](#sam-function-kinesis-startingposition): String StartingPositionTimestamp: Double [Stream](#sam-function-kinesis-stream): String [TumblingWindowInSeconds](#sam-function-kinesis-tumblingwindowinseconds): Integer ``` ## Properties `BatchSize` 要在单个批次中检索的最大项目数。 *类型*：整数 *必需*：否 *默认值*：100 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)`属性。 *最小值*：`1` *最大值*：`10000` `BisectBatchOnFunctionError` 如果函数返回错误，则将批次拆分为两批并重试。 *类型*：布尔值 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[BisectBatchOnFunctionError](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-bisectbatchonfunctionerror)`属性。 `DestinationConfig` 丢弃的记录的 Amazon Simple Queue Service (Amazon SQS) 队列或 Amazon Simple Notiﬁcation Service (Amazon SNS)主题目标。 *类型*：[DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig)`属性。 `Enabled` 禁用事件源映射以暂停轮询和调用。 *类型*：布尔值 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)`属性。 `FilterCriteria` 定义用于确定 Lambda 是否应处理事件的条件的对象。有关更多信息，请参阅《AWS Lambda 开发人员指南》**中的 [AWS Lambda 事件筛选](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html)。 *类型*：[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)`属性。 `FunctionResponseTypes` 当前应用于事件源映射的响应类型的列表。有关详细信息，请参阅《AWS Lambda 开发人员指南》**中的[报告批处理项目失败](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-batchfailurereporting)。 *有效值*：`ReportBatchItemFailures` *类型*：列表 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[FunctionResponseTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionresponsetypes)`属性。 `KmsKeyArn` 用于加密与此事件相关信息的密钥的 Amazon 资源名称（ARN）。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)`属性。 `MaximumBatchingWindowInSeconds` 在调用函数之前收集记录的最长时间（以秒为单位）。 *类型*：整数 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[MaximumBatchingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds)`属性。 `MaximumRecordAgeInSeconds` Lambda 发送到函数以进行处理的记录的最长期限。 *类型*：整数 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[MaximumRecordAgeInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumrecordageinseconds)`属性。 `MaximumRetryAttempts` 在函数返回错误时重试的最大次数。 *类型*：整数 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[MaximumRetryAttempts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumretryattempts)`属性。 `MetricsConfig` 一种选择性配置，用于获取增强型指标，这些指标针对事件源映射进行捕获，涵盖处理过程的每个阶段。有关示例，请参阅[MetricsConfig 事件](sam-property-function-dynamodb.md#sam-property-function-dynamodb-example-metricsconfigevent)。 *类型*：[MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)`属性。 `ParallelizationFactor` 要从每个分片中同时处理的批次数。 *类型*：整数 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[ParallelizationFactor](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-parallelizationfactor)`属性。 `StartingPosition` 在流中开始读取数据的位置。 + `AT_TIMESTAMP` – 指定开始读取记录的时间。 + `LATEST` - 仅读取新记录。 + `TRIM_HORIZON` - 处理所有可用的记录。 *有效值*：`AT_TIMESTAMP` \$1 `LATEST` \$1 `TRIM_HORIZON` *类型*：字符串 *是否必需*：是 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[StartingPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition)`属性。 `StartingPositionTimestamp` 开始读取的时间（以 Unix 时间秒为单位）在 `StartingPosition` 被指定为 `AT_TIMESTAMP` 的情况下定义 `StartingPositionTimestamp`。 *类型*：双精度 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[StartingPositionTimestamp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp)`属性。 `Stream` 数据流的 Amazon 资源名称（ARN）或流使用者。 *类型*：字符串 *是否必需*：是 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[EventSourceArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn)`属性。 `TumblingWindowInSeconds` 处理窗口的持续时间（以秒为单位）。有效范围为 1 到 900（15 分钟）。有关更多信息，请参阅《AWS Lambda 开发人员指南》**的[滚动窗口](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#streams-tumbling)。 *类型*：整数 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[TumblingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-tumblingwindowinseconds)`属性。 ## 示例 ### MetricsConfig 事件以下是一个资源示例，它使用 `MetricsConfig` 属性来捕获其事件源映射的每个处理阶段。 ``` Resources: FilteredEventsFunction: Type: AWS::Serverless::Function Properties: CodeUri: s3://sam-demo-bucket/metricsConfig.zip Handler: index.handler Runtime: nodejs16.x Events: KinesisStream: Type: Kinesis Properties: Stream: !GetAtt KinesisStream.Arn StartingPosition: LATEST MetricsConfig: Metrics: - EventCount ``` ### Kinesis 事件源下面是一个 Kinesis 事件源。 #### YAML ``` Events: KinesisEvent: Type: Kinesis Properties: Stream: arn:aws:kinesis:us-east-1:123456789012:stream/my-stream StartingPosition: TRIM_HORIZON BatchSize: 10 Enabled: false FilterCriteria: Filters: - Pattern: '{"key": ["val1", "val2"]}' ``` # MQ 描述 `MQ` 事件源类型的对象。有关更多信息，请参阅《AWS Lambda 开发人员指南》**中[结合 Amazon MQ 使用 Lambda](https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html)。 AWS Serverless Application Model (AWS SAM) 在设置此事件类型时生成[https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html)资源。 **注意** 要在虚拟私有云（VPC）中建立 Amazon MQ 队列并连接到公共网络中的 Lambda 函数，函数的执行角色必须包含以下权限： `ec2:CreateNetworkInterface` `ec2:DeleteNetworkInterface` `ec2:DescribeNetworkInterfaces` `ec2:DescribeSecurityGroups` `ec2:DescribeSubnets` `ec2:DescribeVpcs` 有关更多信息，请参阅《*AWS Lambda 开发人员指南*》中的[执行角色权限](https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#events-mq-permissions)。 ## 语法要在 AWS SAM 模板中声明此实体，请使用以下语法。 ### YAML ``` [BatchSize](#sam-function-mq-batchsize): Integer [Broker](#sam-function-mq-broker): String DynamicPolicyName: Boolean [Enabled](#sam-function-mq-enabled): Boolean [FilterCriteria](#sam-function-mq-filtercriteria): [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html) KmsKeyArn: String [MaximumBatchingWindowInSeconds](#sam-function-mq-maximumbatchingwindowinseconds): Integer [Queues](#sam-function-mq-queues): List [SecretsManagerKmsKeyId](#sam-function-mq-secretsmanagerkmskeyid): String [SourceAccessConfigurations](#sam-function-mq-sourceaccessconfigurations): List ``` ## Properties `BatchSize` 要在单个批次中检索的最大项目数。 *类型*：整数 *必需*：否 *默认值*：100 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)`属性。 *最小值*：`1` *最大值*：`10000` `Broker` Amazon MQ 代理的 Amazon 资源名称（ARN）。 *类型*：字符串 *是否必需*：是 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[EventSourceArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn)`属性。 `DynamicPolicyName` 默认情况下， AWS Identity and Access Management (IAM) 策略名称是`SamAutoGeneratedAMQPolicy`为了向后兼容。指定 `true` 对 IAM policy 使用自动生成的名称。此名称包含 Amazon MQ 事件源逻辑 ID。使用多个 Amazon MQ 事件源时，请指定 `true`，以避免重复的 IAM policy 名称。 *类型*：布尔值 *必需*：否 *默认值*：`false` *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `Enabled` 如果为 `true`，则事件源映射处于活动状态。要暂停轮询和调用，设置为 `false`。 *类型*：布尔值 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)`属性。 `FilterCriteria` 定义用于确定 Lambda 是否应处理事件的条件的对象。有关更多信息，请参阅《AWS Lambda 开发人员指南》**中的 [AWS Lambda 事件筛选](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html)。 *类型*：[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)`属性。 `KmsKeyArn` 用于加密与此事件相关信息的密钥的 Amazon 资源名称（ARN）。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)`属性。 `MaximumBatchingWindowInSeconds` 在调用函数之前收集记录的最长时间（以秒为单位）。 *类型*：整数 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[MaximumBatchingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds)`属性。 `Queues` 要使用的 Amazon MQ 代理目的地队列的名称。 *类型*：列表 *是否必需*：是 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[Queues](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-queues)`属性。 `SecretsManagerKmsKeyId` 来自的客户托管密钥的 AWS Key Management Service (AWS KMS) 密钥 ID AWS Secrets Manager。将来自 Secrets Manager 的客户托管密钥与不包含 `kms:Decrypt` 权限的 Lambda 执行角色一起使用时，此属性是必需的。此属性的值为 UUID。例如：`1abc23d4-567f-8ab9-cde0-1fab234c5d67`。 *类型*：字符串 *必需*：条件 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `SourceAccessConfigurations` 身份验证协议或虚拟主机的数组。使用[SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html)数据类型进行指定。对于 `MQ` 事件源类型，唯一有效的配置类型是 `BASIC_AUTH` 和 `VIRTUAL_HOST`。 + **`BASIC_AUTH`** – 存储您的代理凭证的 Secrets Manager 密钥。要使用此类型，凭证必须采用以下格式：`{"username": "your-username", "password": "your-password"}`。只允许使用一个类型为 `BASIC_AUTH` 的对象。 + **`VIRTUAL_HOST`** - 您的 RabbitMQ 代理中虚拟主机的名称。Lambda 将使用此 RabbitMQ 的主机作为事件源。只允许使用一个类型为 `VIRTUAL_HOST` 的对象。 *类型*：列表 *是否必需*：是 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-sourceaccessconfigurations)`属性。 ## 示例 ### Amazon MQ 事件源以下是 Amazon MQ 代理的 `MQ` 事件源类型示例。 #### YAML ``` Events: MQEvent: Type: MQ Properties: Broker: arn:aws:mq:us-east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9 Queues: List of queues SourceAccessConfigurations: - Type: BASIC_AUTH URI: arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName BatchSize: 200 Enabled: true ``` # MSK 描述 `MSK` 事件源类型的对象。有关更多信息，请参阅*AWS Lambda 开发者指南*中的[AWS Lambda 与 Amazon MSK 搭配使用](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html)。 AWS Serverless Application Model (AWS SAM) 在设置此事件类型时生成[https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html)资源。要使用架构注册表，您需要为函数定义特定的 IAM 角色权限。有关所需配置的示例，请参阅[使用 IAM 角色完成设置](#sam-property-function-msk-example-complete)。 ## 语法要在 AWS SAM 模板中声明此实体，请使用以下语法。 ### YAML ``` [BatchSize](#sam-function-msk-batchsize): Integer [BisectBatchOnFunctionError](#sam-function-msk-bisectbatchonfunctionerror): Boolean [ConsumerGroupId](#sam-function-msk-consumergroupid): String DestinationConfig: [DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-destinationconfig.html) [Enabled](#sam-function-msk-enabled): Boolean [FilterCriteria](#sam-function-msk-filtercriteria): [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html) [FunctionResponseTypes](#sam-function-msk-functionresponsetypes): List KmsKeyArn: String [MaximumBatchingWindowInSeconds](#sam-function-msk-maximumbatchingwindowinseconds): Integer [MaximumRecordAgeInSeconds](#sam-function-msk-maximumrecordageinseconds): Integer [MaximumRetryAttempts](#sam-function-msk-maximumretryattempts): Integer [LoggingConfig](#sam-function-msk-loggingconfig): [LoggingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-loggingconfig.html) [MetricsConfig](#sam-function-msk-metricsconfig): [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig.html) [ProvisionedPollerConfig](#sam-function-msk-provisionedpollerconfig): [ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig) [SchemaRegistryConfig](#sam-function-msk-schemaregistryconfig): [SchemaRegistryConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-schemaregistryconfig.html) SourceAccessConfigurations: [SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-sourceaccessconfigurations) [StartingPosition](#sam-function-msk-startingposition): String StartingPositionTimestamp: Double [Stream](#sam-function-msk-stream): String [Topics](#sam-function-msk-topics): List ``` ## Properties `BatchSize` Lambda 从流或队列中提取并发送到函数的每个批处理中的最大记录数。Lambda 在单次调用中将批处理中的所有记录传递给函数，最高可传递同步调用的负载上限 (6 MB)。 *默认值*：100 *有效范围*：最小值为 1。最大值为 10,000。 *类型*：整数 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)`属性。 `BisectBatchOnFunctionError` 如果函数返回错误，则将批次拆分为两批并重试。 *类型*：布尔值 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[BisectBatchOnFunctionError](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-bisectbatchonfunctionerror)`属性。 `ConsumerGroupId` 用于配置如何从 Kafka 主题中读取事件的字符串。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[AmazonManagedKafkaConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html)`属性。 `DestinationConfig` 一个配置对象，用于在 Lambda 处理事件后指定事件目的地。使用此属性指定来自 Amazon MSK 事件源的失败调用的目的地。 *类型*：[DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[ DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-destinationconfig.html)`属性。 `Enabled` 禁用事件源映射以暂停轮询和调用。 *类型*：布尔值 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)`属性。 `FilterCriteria` 定义用于确定 Lambda 是否应处理事件的条件的对象。有关更多信息，请参阅《AWS Lambda 开发人员指南》**中的 [AWS Lambda 事件筛选](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html)。 *类型*：[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)`属性。 `FunctionResponseTypes` 当前应用于事件源映射的响应类型的列表。有关详细信息，请参阅《AWS Lambda 开发人员指南》**中的[报告批处理项目失败](https://docs.aws.amazon.com/lambda/latest/dg/kafka-retry-configurations.html)。 *有效值*：`ReportBatchItemFailures` *类型*：列表 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[FunctionResponseTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionresponsetypes)`属性。 `KmsKeyArn` 用于加密与此事件相关信息的密钥的 Amazon 资源名称（ARN）。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)`属性。 `MaximumBatchingWindowInSeconds` 在调用函数之前收集记录的最长时间（以秒为单位）。 *类型*：整数 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[MaximumBatchingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds)`属性。 `MaximumRecordAgeInSeconds` Lambda 发送到函数以进行处理的记录的最长期限。 *类型*：整数 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[MaximumRecordAgeInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumrecordageinseconds)`属性。 `MaximumRetryAttempts` 在函数返回错误时重试的最大次数。 *类型*：整数 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[MaximumRetryAttempts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumretryattempts)`属性。 `LoggingConfig` 一个配置对象，用于指定事件源映射的日志配置。 *类型*：[LoggingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-loggingconfig.html) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[LoggingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-loggingconfig.html)`属性。 `MetricsConfig` 一个配置对象，它为事件源映射指定指标配置。 *类型*：[MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig.html) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig.html)`属性。 `ProvisionedPollerConfig` 用于增加计算事件源映射所使用的轮询器数量的配置。此配置允许最少 1 个轮询器和最多 2000 个轮询器。有关具体示例，请参阅 [ProvisionedPollerConfig 示例](#sam-property-function-msk-example-provisionedpollerconfig)。 *类型*：[ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)`属性。 `SchemaRegistryConfig` 将架构注册表与 Kafka 事件源配合使用的配置。此功能需要配置 `ProvisionedPollerConfig`。 *类型*: SchemaRegistryConfig *必需*：否 *CloudFormation 兼容性：*此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[AmazonManagedKafkaEventSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-amazonmanagedkafkaeventsourceconfig)`属性。 `SourceAccessConfigurations` 用于保护与定义事件源的身份验证协议数组 VPC 组件或虚拟化主机。 *有效值*：`CLIENT_CERTIFICATE_TLS_AUTH` *类型*：[SourceAccessConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html) 列表 *必需*：否 *CloudFormation 兼容性：*此属性是`AWS::Lambda::EventSourceMapping`资源[AmazonManagedKafkaEventSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-lambda-eventsourcemapping-amazonmanagedkafkaeventsourceconfig)属性的一部分。 `StartingPosition` 在流中开始读取数据的位置。 + `AT_TIMESTAMP` – 指定开始读取记录的时间。 + `LATEST` - 仅读取新记录。 + `TRIM_HORIZON` - 处理所有可用的记录。 *有效值*：`AT_TIMESTAMP` \$1 `LATEST` \$1 `TRIM_HORIZON` *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[StartingPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition)`属性。 `StartingPositionTimestamp` 开始读取的时间（以 Unix 时间秒为单位）在 `StartingPosition` 被指定为 `AT_TIMESTAMP` 的情况下定义 `StartingPositionTimestamp`。 *类型*：双精度 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[StartingPositionTimestamp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp)`属性。 `Stream` 数据流的 Amazon 资源名称（ARN）或流使用者。 *类型*：字符串 *是否必需*：是 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[EventSourceArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn)`属性。 `Topics` Kafka 主题的名称。 *类型*：列表 *是否必需*：是 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[Topics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-topics)`属性。 ## 示例 ### 通过 IAM 角色完成设置以下示例展示了完整的配置，包括使用架构注册表所需的 IAM 角色配置： ``` Parameters: PreCreatedSubnetOne: Type: String PreCreatedSubnetTwo: Type: String MskClusterName4: Type: String Resources: MyLambdaExecutionRole: Type: AWS::IAM::Role Properties: AssumeRolePolicyDocument: Version: '2012-10-17 ' Statement: - Action: [sts:AssumeRole] Effect: Allow Principal: Service: [lambda.amazonaws.com] Policies: - PolicyName: KafkaClusterPermissions PolicyDocument: Statement: - Action: [kafka:DescribeClusterV2, kafka:GetBootstrapBrokers] Effect: Allow Resource: 'arn:aws:kafka:us-east-1:123456789012:cluster/*' - PolicyName: KafkaAuthPolicy PolicyDocument: Statement: - Action: [secretsmanager:GetSecretValue, kms:Decrypt] Effect: "Allow" Resource: ['arn:aws:secretsmanager:us-west-2:123456789012:secret:kafkaSecret-******', 'arn:aws:kms:us-west-2:123456789012:key/keyId'] - PolicyName: ENIPolicy PolicyDocument: Statement: - Action: [ec2:CreateNetworkInterface, ec2:DescribeNetworkInterfaces, ec2:DescribeVpcs, ec2:DeleteNetworkInterface, ec2:DescribeSubnets, ec2:DescribeSecurityGroups] Effect: Allow Resource: '*' - PolicyName: SchemaRegistryPolicy PolicyDocument: Statement: - Action: [glue:GetRegistry] Effect: Allow Resource: 'arn:aws:glue:{region}:{account-id}:registry/{registry-name}' - PolicyName: SchemaVersionsPolicy PolicyDocument: Statement: - Action: [glue:GetSchemaVersions] Effect: Allow Resource: '*' ManagedPolicyArns: - !Sub arn:${AWS::Partition}:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole Tags: - {Value: SAM, Key: lambda:createdBy} MyMskCluster: Type: AWS::MSK::Cluster Properties: BrokerNodeGroupInfo: ClientSubnets: - Ref: PreCreatedSubnetOne - Ref: PreCreatedSubnetTwo InstanceType: kafka.t3.small StorageInfo: EBSStorageInfo: VolumeSize: 1 ClusterName: Ref: MskClusterName4 KafkaVersion: 3.8.x NumberOfBrokerNodes: 2 MyMskStreamProcessor: Type: AWS::Serverless::Function Properties: Runtime: nodejs18.x Handler: index.handler CodeUri: ${codeuri} Role: Fn::GetAtt: [MyLambdaExecutionRole, Arn] Events: MyMskEvent: Type: MSK Properties: StartingPosition: LATEST Stream: Ref: MyMskCluster SourceAccessConfigurations: - Type: SASL_SCRAM_512_AUTH URI: !Sub arn:${AWS::Partition}:secretsmanager:us-west-2:123456789012:secret:my-path/my-secret-name-1a2b3c Topics: - SchemaRegistryTestTopic ProvisionedPollerConfig: MinimumPollers: 1 SchemaRegistryConfig: AccessConfigs: - Type: BASIC_AUTH URI: !Sub arn:${AWS::Partition}:secretsmanager:us-west-2:123456789012:secret:my-path/my-secret-name-1a2b3c SchemaValidationConfigs: - Attribute: KEY EventRecordFormat: JSON SchemaRegistryURI: !Sub arn:${AWS::Partition}:glue:us-west-2:123456789012:registry/myregistry ``` ### ProvisionedPollerConfig 示例 ``` ProvisionedPollerConfig: MinimumPollers: 1 MaximumPollers: 200 ``` ### 现有集群的 Amazon MSK 示例以下示例显示了 AWS 账户中已存在的 Amazon MSK 集群的 `MSK` 事件源类型。 #### YAML ``` Events: MSKEvent: Type: MSK Properties: StartingPosition: LATEST Stream: arn:aws:kafka:us-east-1:012345678012:cluster/exampleClusterName/abcdefab-1234-abcd-5678-cdef0123ab01-2 Topics: - MyTopic ``` ### 在同一模板中声明的集群的 Amazon MSK 示例以下是在同一模板文件中声明的 Amazon MSK 集群的 `MSK` 事件源类型的示例。 #### YAML ``` Events: MSKEvent: Type: MSK Properties: StartingPosition: LATEST Stream: Ref: MyMskCluster # This must be the name of an MSK cluster declared in the same template file Topics: - MyTopic ``` #### 带架构注册表的 MSK 事件源以下是一个配置了架构注册表的 `MSK` 事件源类型的示例。 ``` Events: MSKEvent: Type: MSK Properties: StartingPosition: LATEST Stream: Ref: MyMskCluster Topics: - SchemaRegistryTestTopic ProvisionedPollerConfig: MinimumPollers: 1 SchemaRegistryConfig: SchemaRegistryURI: !Sub arn:${AWS::Partition}:glue:us-west-2:123456789012:registry/myregistry EventRecordFormat: JSON SchemaValidationConfigs: - Attribute: KEY - Attribute: VALUE ``` #### 带 Confluent 架构注册表的 MSK 事件源以下是一个配置了 Confluent 架构注册表的 `MSK` 事件源类型的示例。 ``` Events: MSKEvent: Type: MSK Properties: StartingPosition: LATEST Stream: Ref: MyMskCluster Topics: - SchemaRegistryTestTopic ProvisionedPollerConfig: MinimumPollers: 1 SchemaRegistryConfig: SchemaRegistryURI: https://my-schema-registry.confluent.cloud AccessConfigs: - Type: BASIC_AUTH URI: !Sub arn:${AWS::Partition}:secretsmanager:us-west-2:123456789012:secret:my-secret EventRecordFormat: JSON SchemaValidationConfigs: - Attribute: KEY - Attribute: VALUE ``` # S3 描述 `S3` 事件源类型的对象。 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [Bucket](#sam-function-s3-bucket): String [Events](#sam-function-s3-events): String | List [Filter](#sam-function-s3-filter): [NotificationFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter.html) ``` ## Properties `Bucket` S3 桶名称。此存储桶必须存在于同一模板中。 *类型*：字符串 *是否必需*：是 *CloudFormation 兼容性*：此属性类似于`AWS::S3::Bucket`资源的`[BucketName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-name)`属性。在 SAM 中此为必填字段。此字段仅接受对此模板中创建的 S3 存储桶的引用 `Events` 调用 Lambda 函数的 Amazon S3 桶事件。有关有效值的列表，请参阅 [Amazon S3 支持的事件类型](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html#supported-notification-event-types)。 *类型*：字符串 \$1 列表 *是否必需*：是 *CloudFormation 兼容性*：此属性直接传递给`AWS::S3::Bucket``LambdaConfiguration`数据类型的`[Event](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfig-lambdaconfig.html#cfn-s3-bucket-notificationconfig-lambdaconfig-event)`属性。 `Filter` 确定哪些 Amazon S3 对象调用 Lambda 函数的筛选规则。有关 Amazon S3 键名筛选的信息，请参阅*《Amazon Simple Storage Service 用户指南》*中的[配置 Amazon S3 事件通知](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html)。 *类型*：[NotificationFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter.html) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::S3::Bucket``LambdaConfiguration`数据类型的`[Filter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter.html)`属性。 ## 示例 ### S3 事件 S3 事件示例。 #### YAML ``` Events: S3Event: Type: S3 Properties: Bucket: Ref: ImagesBucket # This must be the name of an S3 bucket declared in the same template file Events: s3:ObjectCreated:* Filter: S3Key: Rules: - Name: prefix # or "suffix" Value: value # The value to search for in the S3 object key names ``` # Schedule 描述`Schedule`事件源类型的对象，它将您的无服务器函数设置为按计划触发的 Amazon EventBridge 规则的目标。有关更多信息，请参阅[什么是亚马逊 EventBridge？](https://docs.aws.amazon.com/eventbridge/latest/userguide/what-is-amazon-eventbridge.html) 在《*亚马逊 EventBridge 用户指南》*中。 AWS Serverless Application Model (AWS SAM) 在设置此事件类型时生成[https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html)资源。 **注意** EventBridge 现在提供了一种新的日程安排功能，即 [Amazon EventBridge Scheduler](https://docs.aws.amazon.com/scheduler/latest/UserGuide/what-is-scheduler.html)。Amazon EventBridge Scheduler 是一款无服务器调度程序，允许您通过一个中央托管服务创建、运行和管理任务。 EventBridge Scheduler具有高度可定制性，与 EventBridge 计划规则相比，可扩展性更高，具有更广泛的目标 API 操作和 AWS 服务。建议您使用 EventBridge Scheduler 按计划调用目标。要在 AWS SAM 模板中定义此事件源类型，请参阅[ScheduleV2](sam-property-function-schedulev2.md)。 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [DeadLetterConfig](#sam-function-schedule-deadletterconfig): DeadLetterConfig [Description](#sam-function-schedule-description): String [Enabled](#sam-function-schedule-enabled): Boolean [Input](#sam-function-schedule-input): String [Name](#sam-function-schedule-name): String [RetryPolicy](#sam-function-schedule-retrypolicy): [RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy) [Schedule](#sam-function-schedule-schedule): String [State](#sam-function-schedule-state): String ``` ## Properties `DeadLetterConfig` 配置亚马逊简单队列服务 (Amazon SQS) Simple Queue Service 队列，目标调用失败后 EventBridge 在该队列中发送事件。例如，当向不存在的 Lambda 函数发送事件时，或者没有足够的权限调用 Lambda 函数 EventBridge 时，调用可能会失败。有关更多信息，请参阅 A *ma EventBridge * zon 用户指南中的[事件重试策略和使用死信队列](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html)。 [AWS::Serverless::Function](sam-resource-function.md) 资源类型具有类似的数据类型 `DeadLetterQueue`，用于处理成功调用目标 Lambda 函数后发生的故障。这些类型的故障示例包括 Lambda 节流或 Lambda 目标函数返回的错误。有关函数 `DeadLetterQueue` 属性的更多信息，请参阅*《AWS Lambda 开发人员指南》*中的[死信队列](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq)。 *类型*：[DeadLetterConfig](sam-property-function-scheduledeadletterconfig.md) *必需*：否 *CloudFormation 兼容性*：此属性类似于`AWS::Events::Rule``Target`数据类型的`[DeadLetterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-deadletterconfig)`属性。此属性的 AWS SAM 版本包括其他子属性， AWS SAM 以备您想要创建死信队列时使用。 `Description` 规则的描述。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Events::Rule`资源的`[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-description)`属性。 `Enabled` 指示是否启用规则。要禁用该规则，请将此属性设置为 `false`。指定 `Enabled` 或 `State` 属性，但不能同时指定两者。 *类型*：布尔值 *必需*：否 *CloudFormation 兼容性*：此属性类似于`AWS::Events::Rule`资源的`[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state)`属性。如果此属性设置为，`true`则 AWS SAM 通过`ENABLED`，否则通过`DISABLED`。 `Input` 传递到目标的有效 JSON 文本。如果使用此属性，则不会将事件文本本身的任何内容传递到目标。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Events::Rule Target`资源的`[Input](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-input)`属性。 `Name` 规则的名称。如果您不指定名称，则 CloudFormation 会生成一个唯一的物理 ID 并将该 ID 用作规则名称。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Events::Rule`资源的`[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-name)`属性。 `RetryPolicy` 包含有关重试策略设置的信息的 `RetryPolicy` 对象。有关更多信息，请参阅 A *ma EventBridge * zon 用户指南中的[事件重试策略和使用死信队列](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html)。 *类型*：[RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Events::Rule``Target`数据类型的`[RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)`属性。 `Schedule` 决定运行规则的时间和频率的计划表达式。有关更多信息，请参阅[规则的计划表达式](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html)。 *类型*：字符串 *是否必需*：是 *CloudFormation 兼容性*：此属性直接传递给`AWS::Events::Rule`资源的`[ScheduleExpression](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-scheduleexpression)`属性。 `State` 规则的状态。 *接受的值：*`DISABLED | ENABLED` 指定 `Enabled` 或 `State` 属性，但不能同时指定两者。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Events::Rule`资源的`[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state)`属性。 ## 示例 ### CloudWatch 安排活动 CloudWatch 安排活动示例 #### YAML ``` CWSchedule: Type: Schedule Properties: Schedule: 'rate(1 minute)' Name: TestSchedule Description: test schedule Enabled: false ``` # DeadLetterConfig 用于指定亚马逊简单队列服务 (Amazon SQS) Simple Queue Service 队列的对象，目标调用失败后 EventBridge 在该队列中发送事件。例如，在向不存在的 Lambda 函数发送事件或调用 Lambda 函数的权限不足时，调用可能会失败。有关更多信息，请参阅 A *ma EventBridge * zon 用户指南中的[事件重试策略和使用死信队列](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html)。 **注意** [AWS::Serverless::Function](sam-resource-function.md) 资源类型具有类似的数据类型 `DeadLetterQueue`，用于处理成功调用目标 Lambda 函数后发生的故障。此类故障的示例包括 Lambda 节流或 Lambda 目标函数返回的错误。有关函数 `DeadLetterQueue` 属性的更多信息，请参阅*《AWS Lambda 开发人员指南》*中的[死信队列](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq)。 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [Arn](#sam-function-scheduledeadletterconfig-arn): String [QueueLogicalId](#sam-function-scheduledeadletterconfig-queuelogicalid): String [Type](#sam-function-scheduledeadletterconfig-type): String ``` ## Properties `Arn` 指定作为死信队列目标的 Amazon SQS 队列的 Amazon 资源名称（ARN）。指定 `Type` 属性或 `Arn` 属性，但不能同时指定两者。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Events::Rule``DeadLetterConfig`数据类型的`[Arn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-deadletterconfig.html#cfn-events-rule-deadletterconfig-arn)`属性。 `QueueLogicalId` 指定了 AWS SAM 创建的死信队列的自定义名称。`Type` 如果未设置 `Type` 属性，则将忽略该属性。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `Type` 队列的类型。设置此属性后， AWS SAM 会自动创建死信队列并附加必要的[基于资源的策略](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html#dlq-perms)，以授予规则资源向队列发送事件的权限。指定 `Type` 属性或 `Arn` 属性，但不能同时指定两者。 *有效值*：`SQS` *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 ## 示例 ### DeadLetterConfig DeadLetterConfig #### YAML ``` DeadLetterConfig: Type: SQS QueueLogicalId: MyDLQ ``` # ScheduleV2 描述`ScheduleV2`事件源类型的对象，它将您的无服务器函数设置为按计划触发的 Amazon S EventBridge cheduler 事件的目标。有关更多信息，请参阅[什么是 Amazon EventBridge 日程安排](https://docs.aws.amazon.com/scheduler/latest/UserGuide/what-is-scheduler.html)？在《*EventBridge 日程安排器用户指南》*中。 AWS Serverless Application Model (AWS SAM) 在设置此事件类型时生成[https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html)资源。 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [DeadLetterConfig](#sam-function-schedulev2-deadletterconfig): DeadLetterConfig [Description](#sam-function-schedulev2-description): String [EndDate](#sam-function-schedulev2-enddate): String [FlexibleTimeWindow](#sam-function-schedulev2-flexibletimewindow): FlexibleTimeWindow [GroupName](#sam-function-schedulev2-groupname): String [Input](#sam-function-schedulev2-input): String [KmsKeyArn](#sam-function-schedulev2-kmskeyarn): String [Name](#sam-function-schedulev2-name): String OmitName: Boolean [PermissionsBoundary](#sam-function-schedulev2-permissionsboundary): String [RetryPolicy](#sam-function-schedulev2-retrypolicy): RetryPolicy [RoleArn](#sam-function-schedulev2-rolearn): String [ScheduleExpression](#sam-function-schedulev2-schedule): String [ScheduleExpressionTimezone](#sam-function-schedulev2-scheduleexpressiontimezone): String [StartDate](#sam-function-schedulev2-startdate): String [State](#sam-function-schedulev2-state): String ``` ## Properties `DeadLetterConfig` 配置亚马逊简单队列服务 (Amazon SQS) Simple Queue Service 队列，目标调用失败后 EventBridge 在该队列中发送事件。例如，当向不存在的 Lambda 函数发送事件时，或者没有足够的权限调用 Lambda 函数 EventBridge 时，调用可能会失败。*有关更多信息，请参阅《日[ EventBridge 程安排器用户指南》中的为调度程序配置死信队列](https://docs.aws.amazon.com/scheduler/latest/UserGuide/configuring-schedule-dlq.html)。EventBridge * [AWS::Serverless::Function](sam-resource-function.md) 资源类型具有类似的数据类型 `DeadLetterQueue`，用于处理成功调用目标 Lambda 函数后发生的故障。这些类型的故障示例包括 Lambda 节流或 Lambda 目标函数返回的错误。有关函数 `DeadLetterQueue` 属性的更多信息，请参阅*《AWS Lambda 开发人员指南》*中的[死信队列](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq)。 *类型*：[DeadLetterConfig](sam-property-function-scheduledeadletterconfig.md) *必需*：否 *CloudFormation 兼容性*：此属性类似于`AWS::Scheduler::Schedule``Target`数据类型的`[DeadLetterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-deadletterconfig)`属性。此属性的 AWS SAM 版本包括其他子属性， AWS SAM 以备您想要创建死信队列时使用。 `Description` 计划的描述。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Scheduler::Schedule`资源的`[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-description)`属性。 `EndDate` 以 UTC 为单位的日期，在此日期之前计划可以调用其目标。根据计划的重复表达式，调用可能会在您指定的 **EndDate** 或之前停止。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Scheduler::Schedule`资源的`[EndDate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-enddate)`属性。 `FlexibleTimeWindow` 允许配置可以调用计划的窗口。 *类型*：[FlexibleTimeWindow](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-flexibletimewindow) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Scheduler::Schedule`资源的`[FlexibleTimeWindow](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-flexibletimewindow)`属性。 `GroupName` 将与此计划关联的计划组名称。如果未定义，则使用默认组。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Scheduler::Schedule`资源的`[GroupName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-groupname)`属性。 `Input` 传递到目标的有效 JSON 文本。如果使用此属性，则不会将事件文本本身的任何内容传递到目标。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Scheduler::Schedule Target`资源的`[Input](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-input)`属性。 `KmsKeyArn` 将用于加密客户数据的 KMS 密钥的 ARN。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Scheduler::Schedule`资源的`[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-kmskeyarn)`属性。 `Name` 计划的名称。如果您未指定名称，则 AWS SAM 会生成格式为的名称，`Function-Logical-IDEvent-Source-Name`并使用该 ID 作为计划名称。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Scheduler::Schedule`资源的`[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-name)`属性。 `OmitName` 默认情况下， AWS SAM 生成并使用格式为的计划名称*

*。将此属性设置`true`为 CloudFormation 生成唯一的物理 ID，然后改用该物理 ID 作为计划名称。 *类型*：布尔值 *必需*：否 *默认值*：`false` *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `PermissionsBoundary` 用于为角色设置权限边界的策略的 ARN。如果已定义，`PermissionsBoundary`则 AWS SAM 将对计划程序计划的目标 IAM 角色应用相同的边界。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::IAM::Role`资源的`[PermissionsBoundary](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#cfn-iam-role-permissionsboundary)`属性。 `RetryPolicy` 包含有关重试策略设置的信息的 **RetryPolicy** 对象。 *类型*：[RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-retrypolicy) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Scheduler::Schedule``Target`数据类型的`[RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-retrypolicy)`属性。 `RoleArn` 调用计划时， EventBridge 计划程序将用于目标的 IAM 角色的 ARN。 *类型*：[RoleArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-rolearn) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Scheduler::Schedule``Target`数据类型的`[RoleArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-rolearn)`属性。 `ScheduleExpression` 决定运行调度器计划事件的时间和频率的计划表达式。 *类型*：字符串 *是否必需*：是 *CloudFormation 兼容性*：此属性直接传递给`AWS::Scheduler::Schedule`资源的`[ScheduleExpression](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-scheduleexpression)`属性。 `ScheduleExpressionTimezone` 评估计划表达式的时区。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Scheduler::Schedule`资源的`[ScheduleExpressionTimezone](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-scheduleexpressiontimezone)`属性。 `StartDate` 以 UTC 为单位的日期，在此日期之后计划可以调用目标。根据计划的重复表达式，调用可能会在您指定的 **StartDate** 或之后发生。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Scheduler::Schedule`资源的`[StartDate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-startdate)`属性。 `State` 调度器计划的状态。 *接受的值：*`DISABLED | ENABLED` *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Scheduler::Schedule`资源的`[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html#cfn-scheduler-schedule-state)`属性。 ## 示例 ### 定义 ScheduleV2 资源的基本示例 ``` Resources: Function: Properties: ... Events: ScheduleEvent: Type: ScheduleV2 Properties: ScheduleExpression: "rate(1 minute)" ComplexScheduleEvent: Type: ScheduleV2 Properties: ScheduleExpression: rate(1 minute) FlexibleTimeWindow: Mode: FLEXIBLE MaximumWindowInMinutes: 5 StartDate: '2022-12-28T12:00:00.000Z' EndDate: '2023-01-28T12:00:00.000Z' ScheduleExpressionTimezone: UTC RetryPolicy: MaximumRetryAttempts: 5 MaximumEventAgeInSeconds: 300 DeadLetterConfig: Type: SQS ``` **注意** 生成的 ScheduleV2 物理 ID 不包括堆栈名称。 # SelfManagedKafka 描述 `SelfManagedKafka` 事件源类型的对象。*有关更多信息，请参阅《开发人员指南》中的[AWS Lambda 与自行管理的 Apache Kafka 配合使用](https://docs.aws.amazon.com/lambda/latest/dg/with-kafka.html)。AWS Lambda * AWS Serverless Application Model (AWS SAM) 在设置此事件类型时生成[https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html)资源。要使用架构注册表，您需要为函数定义特定的 IAM 角色权限。有关所需配置的示例，请参阅[使用 IAM 角色完成设置](sam-property-function-msk.md#sam-property-function-msk-example-complete)。 ## 语法要在 AWS SAM 模板中声明此实体，请使用以下语法。 ### YAML ``` [BatchSize](#sam-function-selfmanagedkafka-batchsize): Integer [BisectBatchOnFunctionError](#sam-function-selfmanagedkafka-bisectbatchonfunctionerror): Boolean [ConsumerGroupId](#sam-function-selfmanagedkafka-consumergroupid): String DestinationConfig: [DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-destinationconfig.html) [Enabled](#sam-function-selfmanagedkafka-enabled): Boolean [FilterCriteria](#sam-function-selfmanagedkafka-filtercriteria): [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html) [KafkaBootstrapServers](#sam-function-selfmanagedkafka-kafkabootstrapservers): List [FunctionResponseTypes](#sam-function-selfmanagedkafka-functionresponsetypes): List KmsKeyArn: String [LoggingConfig](#sam-function-selfmanagedkafka-loggingconfig): LoggingConfig [MaximumRecordAgeInSeconds](#sam-function-selfmanagedkafka-maximumrecordageinseconds): Integer [MaximumRetryAttempts](#sam-function-selfmanagedkafka-maximumretryattempts): Integer [MetricsConfig](#sam-function-selfmanagedkafka-metricsconfig): MetricsConfig [ProvisionedPollerConfig](#sam-function-selfmanagedkafka-provisionedpollerconfig): [ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig) [SchemaRegistryConfig](#sam-function-selfmanagedkafka-schemaregistryconfig): [SchemaRegistryConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-schemaregistryconfig.html) [SourceAccessConfigurations](#sam-function-selfmanagedkafka-sourceaccessconfigurations): [SourceAccessConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-sourceaccessconfigurations) StartingPosition: String StartingPositionTimestamp: Double [Topics](#sam-function-selfmanagedkafka-topics): List ``` ## Properties `BatchSize` Lambda 从流中提取并发送到函数的每个批处理中的最大记录数。 *类型*：整数 *必需*：否 *默认值*：100 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)`属性。 *最小值*：`1` *最大值*：`10000` `BisectBatchOnFunctionError` 如果函数返回错误，则将批次拆分为两批并重试。 *类型*：布尔值 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[BisectBatchOnFunctionError](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-bisectbatchonfunctionerror)`属性。 `ConsumerGroupId` 用于配置如何从 Kafka 主题中读取事件的字符串。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[SelfManagedKafkaEventSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig)`属性。 `DestinationConfig` 一个配置对象，用于在 Lambda 处理事件后指定事件目的地。使用此属性指定来自管理 Kafka 事件源的失败调用的目的地。 *类型*：[DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-destinationconfig.html) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[ DestinationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig)`属性。 `Enabled` 禁用事件源映射以暂停轮询和调用。 *类型*：布尔值 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)`属性。 `FilterCriteria` 定义用于确定 Lambda 是否应处理事件的条件的对象。有关更多信息，请参阅《AWS Lambda 开发人员指南》**中的 [AWS Lambda 事件筛选](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html)。 *类型*：[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-filtercriteria)`属性。 `KafkaBootstrapServers` Kafka 代理的引导服务器列表。包括端口，例如 `broker.example.com:xxxx` *类型*：列表 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `FunctionResponseTypes` 当前应用于事件源映射的响应类型的列表。有关详细信息，请参阅《AWS Lambda 开发人员指南》**中的[报告批处理项目失败](https://docs.aws.amazon.com/lambda/latest/dg/kafka-retry-configurations.html)。 *有效值*：`ReportBatchItemFailures` *类型*：列表 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[FunctionResponseTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionresponsetypes)`属性。 `KmsKeyArn` 用于加密与此事件相关信息的密钥的 Amazon 资源名称（ARN）。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)`属性。 `LoggingConfig` 您的事件源的日志配置。 *类型*：[LoggingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-loggingconfig) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[LoggingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-loggingconfig)`属性。 `MaximumRecordAgeInSeconds` Lambda 发送到函数以进行处理的记录的最长期限。 *类型*：整数 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[MaximumRecordAgeInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumrecordageinseconds)`属性。 `MetricsConfig` 您的事件源的指标配置。 *类型*：[MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-metricsconfig)`属性。 `MaximumRetryAttempts` 在函数返回错误时重试的最大次数。 *类型*：整数 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[MaximumRetryAttempts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumretryattempts)`属性。 `ProvisionedPollerConfig` 用于增加计算事件源映射所使用的轮询器数量的配置。此配置允许最少 1 个轮询器和最多 2000 个轮询器。有关具体示例，请参阅 [ProvisionedPollerConfig 示例](#sam-property-function-selfmanagedkafka-example-provisionedpollerconfig)。 *类型*：[ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-provisionedpollerconfig)`属性。 `SchemaRegistryConfig` 将架构注册表与自托管 Kafka 事件源配合使用的配置。此功能需要配置 `ProvisionedPollerConfig`。 *类型*：[SchemaRegistryConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-schemaregistryconfig) *必需*：否 *CloudFormation 兼容性：*此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[SelfManagedKafkaEventSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig)`属性。 `SourceAccessConfigurations` 用于保护与定义事件源的身份验证协议数组 VPC 组件或虚拟化主机。 *有效值*：`BASIC_AUTH | CLIENT_CERTIFICATE_TLS_AUTH | SASL_SCRAM_256_AUTH | SASL_SCRAM_512_AUTH | SERVER_ROOT_CA_CERTIFICATE` *类型*：[SourceAccessConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration) 列表 *是否必需*：是 *CloudFormation 兼容性：*此属性是`AWS::Lambda::EventSourceMapping`资源`[SelfManagedKafkaEventSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig)`属性的一部分。 `StartingPosition` 在流中开始读取数据的位置。 + `AT_TIMESTAMP` – 指定开始读取记录的时间。 + `LATEST` - 仅读取新记录。 + `TRIM_HORIZON` - 处理所有可用的记录。 *有效值*：`AT_TIMESTAMP` \$1 `LATEST` \$1 `TRIM_HORIZON` *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[StartingPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition)`属性。 `StartingPositionTimestamp` 开始读取的时间（以 Unix 时间秒为单位）在 `StartingPosition` 被指定为 `AT_TIMESTAMP` 的情况下定义 `StartingPositionTimestamp`。 *类型*：双精度 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[StartingPositionTimestamp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp)`属性。 `Topics` Kafka 主题的名称。 *类型*：列表 *是否必需*：是 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[Topics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-topics)`属性。 ## 示例 ### 通过 IAM 角色完成设置以下示例展示了完整的配置，包括使用架构注册表所需的 IAM 角色配置： ``` Parameters: PreCreatedSubnetOne: Type: String PreCreatedSubnetTwo: Type: String Resources: MyLambdaExecutionRole: Type: AWS::IAM::Role Properties: AssumeRolePolicyDocument: Version: '2012-10-17 ' Statement: - Action: [sts:AssumeRole] Effect: Allow Principal: Service: [lambda.amazonaws.com] Policies: - PolicyName: KafkaAuthPolicy PolicyDocument: Statement: - Action: [secretsmanager:GetSecretValue, kms:Decrypt] Effect: "Allow" Resource: ['arn:aws:secretsmanager:us-west-2:123456789012:secret:kafkaSecret-******', 'arn:aws:kms:us-west-2:123456789012:key/keyId'] - PolicyName: ENIPolicy PolicyDocument: Statement: - Action: [ec2:CreateNetworkInterface, ec2:DescribeNetworkInterfaces, ec2:DescribeVpcs, ec2:DeleteNetworkInterface, ec2:DescribeSubnets, ec2:DescribeSecurityGroups] Effect: Allow Resource: '*' - PolicyName: SchemaRegistryPolicy PolicyDocument: Statement: - Action: [glue:GetRegistry] Effect: Allow Resource: 'arn:aws:glue:{region}:{account-id}:registry/{registry-name}' - PolicyName: SchemaVersionsPolicy PolicyDocument: Statement: - Action: [glue:GetSchemaVersions] Effect: Allow Resource: '*' ManagedPolicyArns: - !Sub arn:${AWS::Partition}:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole Tags: - {Value: SAM, Key: lambda:createdBy} MyKafkaProcessor: Type: AWS::Serverless::Function Properties: Runtime: nodejs18.x Handler: index.handler CodeUri: ${codeuri} Role: Fn::GetAtt: [MyLambdaExecutionRole, Arn] Events: SelfManagedKafkaEvent: Type: SelfManagedKafka Properties: KafkaBootstrapServers: - my-kafka-broker-1:9092 - my-kafka-broker-2:9092 Topics: - SchemaRegistryTestTopic StartingPosition: LATEST SourceAccessConfigurations: - Type: VPC_SUBNET URI: subnet:subnet-12345678 - Type: VPC_SECURITY_GROUP URI: security_group:sg-12345678 - Type: BASIC_AUTH URI: !Sub arn:${AWS::Partition}:secretsmanager:us-west-2:123456789012:secret:my-path/my-secret-name-1a2b3c ProvisionedPollerConfig: MinimumPollers: 1 SchemaRegistryConfig: AccessConfigs: - Type: BASIC_AUTH URI: !Sub arn:${AWS::Partition}:secretsmanager:us-west-2:123456789012:secret:my-path/my-secret-name-1a2b3c SchemaValidationConfigs: - Attribute: KEY EventRecordFormat: JSON SchemaRegistryURI: !Sub arn:${AWS::Partition}:glue:us-west-2:123456789012:registry/myregistry ``` ### ProvisionedPollerConfig 示例 ``` ProvisionedPollerConfig: MinimumPollers: 1 MaximumPollers: 200 ``` ### 自行管理的 Kafka 事件源以下是 `SelfManagedKafka` 事件源类型的示例。 #### YAML ``` Events: SelfManagedKafkaEvent: Type: SelfManagedKafka Properties: BatchSize: 1000 Enabled: true KafkaBootstrapServers: - abc.xyz.com:xxxx SourceAccessConfigurations: - Type: BASIC_AUTH URI: arn:aws:secretsmanager:us-west-2:123456789012:secret:my-path/my-secret-name-1a2b3c Topics: - MyKafkaTopic ``` ### 带有 AWS Glue 架构注册表的自管理 Kafka 事件源以下是使用 AWS Glue 架构注册表配置`SelfManagedKafka`的事件源类型的示例。 ``` Events: SelfManagedKafkaEvent: Type: SelfManagedKafka Properties: KafkaBootstrapServers: - abc.xyz.com:9092 Topics: - SchemaRegistryTestTopic StartingPosition: LATEST ProvisionedPollerConfig: MinimumPollers: 1 SchemaRegistryConfig: SchemaRegistryURI: !Sub arn:${AWS::Partition}:glue:us-west-2:123456789012:registry/myregistry EventRecordFormat: JSON SchemaValidationConfigs: - Attribute: KEY - Attribute: VALUE SourceAccessConfigurations: - Type: VPC_SUBNET URI: subnet:subnet-12345678 - Type: VPC_SECURITY_GROUP URI: security_group:sg-12345678 ``` ### 自托管 Kafka 事件源与 Confluent 架构注册表以下是一个配置了 Confluent 架构注册表的 `SelfManagedKafka` 事件源类型的示例。 ``` Events: SelfManagedKafkaEvent: Type: SelfManagedKafka Properties: KafkaBootstrapServers: - abc.xyz.com:9092 Topics: - SchemaRegistryTestTopic StartingPosition: LATEST ProvisionedPollerConfig: MinimumPollers: 1 SchemaRegistryConfig: SchemaRegistryURI: https://my-schema-registry.confluent.cloud AccessConfigs: - Type: BASIC_AUTH URI: !Sub arn:${AWS::Partition}:secretsmanager:us-west-2:123456789012:secret:my-secret EventRecordFormat: JSON SchemaValidationConfigs: - Attribute: KEY - Attribute: VALUE SourceAccessConfigurations: - Type: VPC_SUBNET URI: subnet:subnet-12345678 - Type: VPC_SECURITY_GROUP URI: security_group:sg-12345678 - Type: BASIC_AUTH URI: !Sub arn:${AWS::Partition}:secretsmanager:us-west-2:123456789012:secret:kafka-secret ``` # SNS 描述 `SNS` 事件源类型的对象。如果设置了此事件类型，SAM 会生成 [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html) 资源 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [FilterPolicy](#sam-function-sns-filterpolicy): [SnsFilterPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicy) FilterPolicyScope: String RedrivePolicy: Json [Region](#sam-function-sns-region): String [SqsSubscription](#sam-function-sns-sqssubscription): Boolean | SqsSubscriptionObject [Topic](#sam-function-sns-topic): String ``` ## Properties `FilterPolicy` 分配给订阅的筛选策略 JSON。有关更多信息，请参阅[GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html)《亚马逊简单通知服务 API 参考》。 *类型*：[SnsFilterPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicy) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::SNS::Subscription`资源的`[FilterPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicy)`属性。 `FilterPolicyScope` 此属性允许您使用以下字符串值类型之一来选择筛选范围： + `MessageAttributes` – 筛选条件应用于消息属性。 + `MessageBody` – 筛选条件应用于消息正文。 *类型*：字符串 *必需*：否 *默认值*：`MessageAttributes` *CloudFormation 兼容性*：此属性直接传递给`AWS::SNS::Subscription`资源的` [ FilterPolicyScope](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicyscope)`属性。 `RedrivePolicy` 指定后，将无法传输的消息发送到指定的 Amazon SQS 死信队列。由于客户端错误（例如，在无法访问订阅的端点时）或服务器错误（例如，在支持订阅的端点的服务变得不可用时）而无法传输的消息将保留在死信队列中，以进行进一步分析或重新处理。有关重新驱动策略和死信队列的更多信息，请参阅*《Amazon Simple Queue Service 开发人员指南》*中的 [Amazon SQS 死信队列](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html)。 *类型*：Json *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::SNS::Subscription`资源的`[ RedrivePolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-redrivepolicy)`属性。 `Region` 对于跨区域订阅，为主题所在的区域。如果未指定区域，则 CloudFormation 使用呼叫者的区域作为默认区域。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::SNS::Subscription`资源的`[Region](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-region)`属性。 `SqsSubscription` 将此属性设置为 true，或指定 `SqsSubscriptionObject` 以在 SQS 队列中启用批处理 SNS 主题通知。将此属性设置为 `true` 可创建新的 SQS 队列，而指定 `SqsSubscriptionObject` 则使用现有的 SQS 队列。 *类型*：布尔值 \$1 [SqsSubscriptionObject](sam-property-function-sqssubscriptionobject.md) *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `Topic` 要订阅的主题的 ARN。 *类型*：字符串 *是否必需*：是 *CloudFormation 兼容性*：此属性直接传递给`AWS::SNS::Subscription`资源的`[TopicArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#topicarn)`属性。 ## 示例 ### SNS 事件源示例 SNS 事件源示例 #### YAML ``` Events: SNSEvent: Type: SNS Properties: Topic: arn:aws:sns:us-east-1:123456789012:my_topic SqsSubscription: true FilterPolicy: store: - example_corp price_usd: - numeric: - ">=" - 100 ``` # SqsSubscriptionObject 为 SNS 事件指定现有 SQS 队列选项 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [BatchSize](#sam-function-sqssubscriptionobject-batchsize): String [Enabled](#sam-function-sqssubscriptionobject-enabled): Boolean [QueueArn](#sam-function-sqssubscriptionobject-queuearn): String [QueuePolicyLogicalId](#sam-function-sqssubscriptionobject-queuepolicylogicalid): String [QueueUrl](#sam-function-sqssubscriptionobject-queueurl): String ``` ## Properties `BatchSize` 要在 SQS 队列单个批次中检索的最大项目数。 *类型*：字符串 *必需*：否 *默认值*：10 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `Enabled` 禁用 SQS 事件源映射以暂停轮询和调用。 *类型*：布尔值 *必需*：否 *默认值*：True *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `QueueArn` 指定现有 SQS 队列 arn。 *类型*：字符串 *是否必需*：是 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `QueuePolicyLogicalId` 为资源提供一个自定义 LogicalID 名称。[AWS::SQS::QueuePolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html) *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 `QueueUrl` 指定与 `QueueArn` 属性关联的队列 URL。 *类型*：字符串 *是否必需*：是 *CloudFormation 兼容性*：此属性是独有的 AWS SAM ，没有 CloudFormation 等效属性。 ## 示例 ### SNS 事件的现有 SQS 添加现有 SQS 队列以订阅 SNS 主题的示例。 #### YAML ``` QueuePolicyLogicalId: CustomQueuePolicyLogicalId QueueArn: Fn::GetAtt: MyCustomQueue.Arn QueueUrl: Ref: MyCustomQueue BatchSize: 5 ``` # SQS 描述 `SQS` 事件源类型的对象。有关更多信息，请参阅*AWS Lambda 开发者*指南中的[AWS Lambda 与 Amazon SQS 配合使用](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html)。如果设置了此事件类型，SAM 会生成 [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html) 资源 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [BatchSize](#sam-function-sqs-batchsize): Integer [Enabled](#sam-function-sqs-enabled): Boolean [FilterCriteria](#sam-function-sqs-filtercriteria): [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html) [FunctionResponseTypes](#sam-function-sqs-functionresponsetypes): List KmsKeyArn: String [MaximumBatchingWindowInSeconds](#sam-function-sqs-maximumbatchingwindowinseconds): Integer [MetricsConfig](#sam-function-sqs-metricsconfig): [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig) [ProvisionedPollerConfig](#sam-function-sqs-provisionedpollerconfig): [ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig) [Queue](#sam-function-sqs-queue): String ScalingConfig: [ScalingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-scalingconfig.html) ``` ## Properties `BatchSize` 要在单个批次中检索的最大项目数。 *类型*：整数 *必需*：否 *默认值*：10 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)`属性。 *最小值*：`1` *最大值*：`10000` `Enabled` 禁用事件源映射以暂停轮询和调用。 *类型*：布尔值 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)`属性。 `FilterCriteria` 定义用于确定 Lambda 是否应处理事件的条件的对象。有关更多信息，请参阅《AWS Lambda 开发人员指南》**中的 [AWS Lambda 事件筛选](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html)。 *类型*：[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)`属性。 `FunctionResponseTypes` 当前应用于事件源映射的响应类型的列表。有关详细信息，请参阅*《AWS Lambda 开发人员指南》*中的[报告批处理项目失败](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#services-sqs-batchfailurereporting)。 *有效值*：`ReportBatchItemFailures` *类型*：列表 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[FunctionResponseTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionresponsetypes)`属性。 `KmsKeyArn` 用于加密与此事件相关信息的密钥的 Amazon 资源名称（ARN）。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)`属性。 `MaximumBatchingWindowInSeconds` 在调用函数之前收集记录的最长时间（以秒为单位）。 *类型*：整数 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[MaximumBatchingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds)`属性。 `MetricsConfig` 一种选择性配置，用于获取增强型指标，这些指标针对事件源映射进行捕获，涵盖处理过程的每个阶段。有关示例，请参阅[MetricsConfig 事件](sam-property-function-dynamodb.md#sam-property-function-dynamodb-example-metricsconfigevent)。 *类型*：[MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)`属性。 `ProvisionedPollerConfig` 用于增加计算事件源映射所使用的轮询器数量的配置。此配置允许最少 2 个轮询器和最多 2000 个轮询器。有关具体示例，请参阅 [ProvisionedPollerConfig 示例](#sam-property-function-sqs-example-provisionedpollerconfig)。 *类型*：[ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)`属性。 `Queue` 队列的 ARN。 *类型*：字符串 *是否必需*：是 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[EventSourceArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn)`属性。 `ScalingConfig` 扩展 SQS 轮询器的配置，以控制调用速率并设置最大并发调用次数。 *类型*：`[ScalingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-scalingconfig.html)` *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::EventSourceMapping`资源的`[ ScalingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-scalingconfig.html)`属性。 ## 示例 ### MetricsConfig 事件以下是一个资源示例，它使用 `MetricsConfig` 属性来捕获其事件源映射的每个处理阶段。 ``` Resources: FilteredEventsFunction: Type: AWS::Serverless::Function Properties: CodeUri: s3://sam-demo-bucket/metricsConfig.zip Handler: index.handler Runtime: nodejs16.x Events: KinesisStream: Type: Kinesis Properties: Stream: !GetAtt KinesisStream.Arn StartingPosition: LATEST MetricsConfig: Metrics: - EventCount ``` ### 基本 SQS 事件 ``` Events: SQSEvent: Type: SQS Properties: Queue: arn:aws:sqs:us-west-2:012345678901:my-queue BatchSize: 10 Enabled: false FilterCriteria: Filters: - Pattern: '{"key": ["val1", "val2"]}' ``` ### 为您的 SQS 队列配置部分批量报告 ``` Events: SQSEvent: Type: SQS Properties: Enabled: true FunctionResponseTypes: - ReportBatchItemFailures Queue: !GetAtt MySqsQueue.Arn BatchSize: 10 ``` ### 带有配置了扩展的 SQS 事件的 Lambda 函数 ``` MyFunction: Type: AWS::Serverless::Function Properties: ... Events: MySQSEvent: Type: SQS Properties: ... ScalingConfig: MaximumConcurrency: 10 ``` ### ProvisionedPollerConfig 示例 ``` MyFunction: Type: AWS::Serverless::Function Properties: Handler: index.handler Runtime: nodejs18.x Timeout: 30 Events: SQSEvent: Type: SQS Properties: Queue: !GetAtt MyQueue.Arn BatchSize: 10 Enabled: True ProvisionedPollerConfig: MaximumPollers: 300 MinimumPollers: 10 ``` # FunctionCode Lambda 函数的[部署程序包](https://docs.aws.amazon.com/lambda/latest/dg/deployment-package-v2.html)。 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [Bucket](#sam-function-functioncode-bucket): String [Key](#sam-function-functioncode-key): String [Version](#sam-function-functioncode-version): String ``` ## Properties `Bucket` 与您的函数位于同一 AWS 区域的 Amazon S3 存储桶。 *类型*：字符串 *是否必需*：是 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function``Code`数据类型的`[S3Bucket](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-s3bucket)`属性。 `Key` 部署程序包的 Amazon S3 密钥。 *类型*：字符串 *是否必需*：是 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function``Code`数据类型的`[S3Key](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-s3key)`属性。 `Version` 对于版本控制的对象，指要使用的部署程序包对象的版本。 *类型*：字符串 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function``Code`数据类型的`[S3ObjectVersion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-s3objectversion)`属性。 ## 示例 ### FunctionCode `CodeUri`：函数代码示例 #### YAML ``` CodeUri: Bucket: sam-s3-demo-bucket-name Key: mykey-name Version: 121212 ``` # FunctionUrlConfig 使用指定的配置参数创建 AWS Lambda 函数 URL。Lambda 函数 URL 是一个 HTTPS 端点，可用于调用函数。默认情况下，您创建的函数 URL 使用 Lambda 函数的 `$LATEST` 版本。如果为 Lambda 函数指定 `AutoPublishAlias`，则端点会连接到指定的函数别名。有关更多信息，请参阅*AWS Lambda 开发人员*指南 URLs中的 [Lambda 函数](https://docs.aws.amazon.com/lambda/latest/dg/lambda-urls.html)。 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [AuthType](#sam-function-functionurlconfig-authtype): String [Cors](#sam-function-functionurlconfig-cors): [Cors](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-url-cors.html) [InvokeMode](#sam-function-functionurlconfig-invokemode): String ``` ## Properties `AuthType` 函数 URL 的身份验证类型。要使用 AWS Identity and Access Management (IAM) 来授权请求，请将设置为`AWS_IAM`。对于开放式访问，设置为 `NONE`。 *类型*：字符串 *是否必需*：是 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Url`资源的`[AuthType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-authtype)`属性。 `Cors` 适用于函数 URL 的 cross-origin resource sharing (CORS)（跨源资源共享）设置。 *类型*：[Cors](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-url-cors.html) *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Url`资源的`[Cors](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-url-cors.html)`属性。 `InvokeMode` 将会调用函数 URL 的模式。要让函数在调用完成后返回响应，请设置为 `BUFFERED`。要让函数流式传输响应，请设置为 `RESPONSE_STREAM`。默认值为 `BUFFERED`。 *有效值*：`BUFFERED` 或 `RESPONSE_STREAM` *类型*：字符串 *必需*：否 *AWS CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Url`资源的[https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-invokemode](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-invokemode)属性。 ## 示例 ### 函数 URL 以下示例创建了带函数 URL 的 Lambda 函数。函数 URL 使用 IAM 授权。 #### YAML ``` HelloWorldFunction: Type: AWS::Serverless::Function Properties: CodeUri: hello_world/ Handler: index.handler Runtime: nodejs20.x FunctionUrlConfig: AuthType: AWS_IAM InvokeMode: RESPONSE_STREAM Outputs: MyFunctionUrlEndpoint: Description: "My Lambda Function URL Endpoint" Value: Fn::GetAtt: HelloWorldFunctionUrl.FunctionUrl ``` # CapacityProviderConfig 配置要将函数的已发布版本附加到的容量提供商。这使该函数能够在 Lambda 管理的客户拥有的 EC2 实例上运行。 **注意** 此配置决定了函数的计算类型，需要在首次部署函数时进行指定。创建函数资源后，无法添加或删除它。 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [Arn](#sam-function-capacityproviderconfig-arn): String [ExecutionEnvironmentMemoryGiBPerVCpu](#sam-function-capacityproviderconfig-executionenvironmentmemorygibpervcpu): Float [PerExecutionEnvironmentMaxConcurrency](#sam-function-capacityproviderconfig-perexecutionenvironmentmaxconcurrency): Integer ``` ## Properties `Arn` 用于此功能的容量提供者的 ARN。 *类型*：字符串 *是否必需*：是 *CloudFormation 兼容性*：此属性是 SAM 所独有的。 `ExecutionEnvironmentMemoryGiBPerVCpu` 每个执行环境的内存（以 GiB 为单位）与 vCPU 的比例。每个 CPU 的内存比率不能超过函数的总内存 2048MB。支持的 memory-to-CPU比率为每个 CPU 2 GB、4GB 或 8GB。 *类型*：浮动 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function`资源的`[ExecutionEnvironmentMemoryGiBPerVCpu](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-lambdamanagedinstancescapacityproviderconfig)`属性。 `PerExecutionEnvironmentMaxConcurrency` 每个执行环境（沙箱）的最大并发执行数。 *类型*：整数 *必需*：否 *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function`资源的`[PerExecutionEnvironmentMaxConcurrency](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-lambdamanagedinstancescapacityproviderconfig)`属性。 ## 示例 ### 容量提供程序配置以下示例显示了引用容量提供程序资源的容量提供程序配置。 ``` CapacityProviderConfig: Arn: !GetAtt MyCapacityProvider.Arn ExecutionEnvironmentMemoryGiBPerVCpu: 4.0 PerExecutionEnvironmentMaxConcurrency: 100 ``` # FunctionScalingConfig 配置 Lambda 函数版本的扩展行为，控制可以创建的执行环境（沙箱）的数量。此配置适用于 \$1LATEST.PUBLISTED 和数字函数版本。 ## 语法要在 AWS Serverless Application Model (AWS SAM) 模板中声明此实体，请使用以下语法。 ### YAML ``` [MinExecutionEnvironments](#sam-function-functionscalingconfig-minexecutionenvironments): Integer [MaxExecutionEnvironments](#sam-function-functionscalingconfig-maxexecutionenvironments): Integer ``` ## Properties `MinExecutionEnvironments` 要为函数版本维护的最小执行环境数量。 *类型*：整数 *必需*：否 *默认值*：`3` *最小值*：`0` *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function`资源的`[MinExecutionEnvironments](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-functionscalingconfig-minexecutionenvironments)`属性。 `MaxExecutionEnvironments` 可以为该函数版本创建的最大执行环境数量。 *类型*：整数 *必需*：否 *默认值*：`3` *最小值*：`0` *CloudFormation 兼容性*：此属性直接传递给`AWS::Lambda::Function`资源的`[MaxExecutionEnvironments](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-functionscalingconfig-maxexecutionenvironments)`属性。 ## 示例 ### 函数缩放配置以下示例显示了具有最小和最大执行环境的函数扩展配置。 ``` FunctionScalingConfig: MinExecutionEnvironments: 5 MaxExecutionEnvironments: 100 ```