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

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

Api

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

语法

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

YAML

  Auth: ApiStateMachineAuth
  Method: String
  Path: String
  RestApiId: String

属性

Auth

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

使用此属性覆盖 APIDefaultAuthorizer设置单个路径，如果没有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在此模板中定义的资源。

如果不定义此属性，Amazon SAM创建默认设置AWS::Serverless::Api使用生成的资源OpenApi文档. 该资源包含所有路径和方法的联合Api同一模板中未指定RestApiId.

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

类型：字符串

必需：否

Amazon CloudFormation兼容性：此属性对是唯一的Amazon SAM而且没有Amazon CloudFormation等效项

示例

APEvent

下面是一个事件的示例：Api。

YAML

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