Api

Api 이벤트 소스 유형을 설명하는 객체. AWS::Serverless::Api 리소스가 정의된 경우 경로 및 메서드 값은 API의 OpenAPI 정의에 있는 작업과 일치해야 합니다.

정의된 AWS::Serverless::Api이 없는 경우, 함수 입력 및 출력은 HTTP 요청 및 HTTP 응답을 나타냅니다.

예를 들어, JavaScript API를 사용하면 StatusCode 및 body 키가 있는 객체를 반환하여 응답의 상태 코드와 본문을 제어할 수 있습니다.

구문

AWS Serverless Application Model (AWS SAM) 템플릿에서이 개체를 선언하려면 다음 구문을 사용합니다.

YAML

  Auth: ApiFunctionAuth
  Method: String
  Path: String
  RequestModel: RequestModel
  RequestParameters: List of [ String | RequestParameter ]
  RestApiId: String
  TimeoutInMillis: Integer

속성

Auth

이 특정 Api+Path+Method에 대한 인증 구성입니다.

지정된 DefaultAuthorizer가 없는 경우, 개별 경로에 대한 API의 DefaultAuthorizer 설정 인증 구성을 재정의하거나 기본 ApiKeyRequired 설정을 재정의하는 데 유용합니다.

유형: API/함수/권한부여

필수 항목 여부: 아니요

AWS CloudFormation 호환성:이 속성은에 고유 AWS SAM 하며 AWS CloudFormation 동등한 속성이 없습니다.

Method

이 함수가 간접 호출되는 HTTP 메서드입니다. 옵션에는 DELETE, GET, HEAD, OPTIONS, PATCH, POST, 및 PUT가 포함됩니다ANY. 자세한 내용은 API Gateway 개발자 안내서의 HTTP 메서드 설정을 참조하세요.

유형: 문자열

필수 항목 여부: 예

AWS CloudFormation 호환성:이 속성은에 고유 AWS SAM 하며 AWS CloudFormation 동등한 속성이 없습니다.

Path

이 함수가 호출되는 Uri 경로입니다. /로 시작해야 합니다.

유형: 문자열

필수 항목 여부: 예

AWS CloudFormation 호환성:이 속성은에 고유 AWS SAM 하며 AWS CloudFormation 동등한 속성이 없습니다.

RequestModel

이 특정 API+Path+메서드에 사용할 요청 모델입니다. 이것은 AWS::Serverless::Api 리소스의 Models 섹션에 지정된 모델 이름을 참조해야 합니다.

유형: 요청 모델

필수 항목 여부: 아니요

AWS CloudFormation 호환성:이 속성은에 고유 AWS SAM 하며 AWS CloudFormation 동등한 속성이 없습니다.

RequestParameters

이 특정 API+Path+메서드에 대한 파라미터 구성을 요청합니다. 모든 파라미터 이름은 method.request로 시작해야 하며, method.request.header, method.request.querystring, 혹은 method.request.path로 제한되어야 합니다.

목록에는 매개변수 이름 문자열과 RequestParameter 객체가 모두 포함될 수 있습니다. 문자열의 경우 Required 및 Caching 속성은 false에 기본적으로 설정됩니다.

유형: [문자열 | 요청 파라미터] 목록

필수 항목 여부: 아니요

AWS CloudFormation 호환성:이 속성은에 고유 AWS SAM 하며 AWS CloudFormation 동등한 속성이 없습니다.

RestApiId

지정된 경로와 메서드를 가진 작업을 포함해야 하는 RestAPI 리소스의 식별자. 이것은 일반적으로 이 템플릿에 정의된 AWS::Serverless::Api 리소스를 참조하도록 설정됩니다.

이 속성을 정의하지 않으면는 생성된 OpenApi 문서를 사용하여 기본 AWS::Serverless::Api 리소스를 AWS SAM 생성합니다. 해당 리소스에는 RestApiId를 지정하지 않은 동일한 템플릿의 Api 이벤트에 의해 정의된 모든 경로와 메서드가 통합되어 있습니다.

이것은 다른 템플릿에 정의된 AWS::Serverless::Api 리소스를 참조할 수 없습니다.

유형: 문자열

필수 항목 여부: 아니요

AWS CloudFormation 호환성:이 속성은에 고유 AWS SAM 하며 AWS CloudFormation 동등한 속성이 없습니다.

TimeoutInMillis

50~29,000밀리초 사이의 제한 시간 사용자 지정입니다.

참고

이 속성을 지정하면가 OpenAPI 정의를 AWS SAM 수정합니다. OpenAPI 정의는 DefinitionBody 속성을 사용하여 인라인으로 지정해야 합니다.

유형: 정수

필수 항목 여부: 아니요

기본값: 29,000밀리초(29초)입니다.

AWS CloudFormation 호환성:이 속성은에 고유 AWS SAM 하며 동등한 속성이 AWS CloudFormation 없습니다.

예시

기본 예제

YAML

Events:
  ApiEvent:
    Type: Api
    Properties:
      Path: /path
      Method: get
      RequestParameters:
        - method.request.header.Authorization
        - method.request.querystring.keyword:
            Required: true
            Caching: false