Api - Amazon Serverless Application Model
语法属性示例
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

Api

描述Api事件源类型的对象。如果定义了AWS::Serverless::Api资源，则路径和方法值必须对应于 API 的 OpenAPI 定义中的操作。

语法

要在Amazon Serverless Application Model (Amazon SAM) 模板中声明此实体，请使用以下语法。

YAML

  Auth: ApiStateMachineAuth
  Method: String
  Path: String
  RestApiId: String
  UnescapeMappingTemplate: Boolean

属性

Auth

此 API、路径和方法的授权配置。

当未DefaultAuthorizer指定路径时，使用此属性覆盖 API 对单个路径的DefaultAuthorizer设置，或覆盖默认ApiKeyRequired设置。

类型：ApiStateMachineAuth

必需：否

Amazon CloudFormation兼容性：此属性是唯一的Amazon SAM，没有Amazon CloudFormation等效属性。

Method

调用此函数的 HTTP 方法。

类型：字符串

必需：是

Amazon CloudFormation兼容性：此属性是唯一的Amazon SAM，没有Amazon CloudFormation等效属性。

Path

调用此函数的 URI 路径。该值必须以开头/。

类型：字符串

必需：是

Amazon CloudFormation兼容性：此属性是唯一的Amazon SAM，没有Amazon CloudFormation等效属性。

RestApiId

RestApi资源的标识符，它必须包含具有给定路径和方法的操作。通常，将其设置为引用此模板中定义的AWS::Serverless::Api资源。

如果您未定义此属性，则使用生成的OpenApi文档Amazon SAM创建默认AWS::Serverless::Api资源。该资源包含所有路径和方法的组合，这些路径和方法由同一模板中的Api事件定义，这些事件未指定RestApiId。

此属性无法引用在其他模板中定义的AWS::Serverless::Api资源。

类型：字符串

必需：否

Amazon CloudFormation兼容性：此属性是唯一的Amazon SAM，没有Amazon CloudFormation等效属性。

UnescapeMappingTemplate

通过替换\'为，在传递给状态机的输入上取消单引号的转义。'当您的输入包含单引号时使用。

注意

如果设置为，False并且您的输入包含单引号，则会出现错误。

类型：布尔值

必需：否

默认值：False

Amazon CloudFormation兼容性：此属性是唯一的Amazon SAM，没有Amazon CloudFormation等效属性。

示例

ApiEvent

以下是该Api类型事件的示例。

YAML

Events:
  ApiEvent:
    Type: Api
    Properties:
      Path: /path
      Method: get
      RequestParameters:
        - method.request.header.Authorization