RequestModel

특정 Api+Path+Method에 대한 요청 모델을 구성합니다.

구문

AWS Serverless Application Model (AWS SAM) 템플릿에서 이 엔티티를 선언하려면 다음 구문을 사용하십시오.

YAML

  Model: String
  Required: Boolean
  ValidateBody: Boolean
  ValidateParameters: Boolean

속성

Model

AWS::Serverless::Api의 Models 속성에 정의된 모델 이름입니다.

타입: 문자열

필수 항목 여부: 예

AWS CloudFormation 호환성: 이 속성은 AWS SAM 고유하며 AWS CloudFormation 이에 상응하는 속성이 없습니다.

Required

지정된 API 엔드포인트에 대한 OpenApi 정의의 매개변수 섹션에 required 속성을 추가합니다.

유형: 부울

필수 항목 여부: 아니요

AWS CloudFormation 호환성: 이 속성은 AWS SAM 고유하며 AWS CloudFormation 이에 상응하는 속성이 없습니다.

ValidateBody

API Gateway가 요청 본문을 검증하기 위해 Model을 사용할지 여부를 지정합니다. 자세한 내용은 API Gateway 개발자 가이드 내 API 게이트웨이에서 요청 검증 활성화를 참조하세요.

유형: 부울

필수 항목 여부: 아니요

AWS CloudFormation 호환성: 이 속성은 AWS SAM 고유하며 AWS CloudFormation 이에 상응하는 속성이 없습니다.

ValidateParameters

API 게이트웨이에서 Model를 사용하여 요청 경로 매개변수, 쿼리 문자열 및 헤더를 검증할지 여부를 지정합니다. 자세한 내용은 API Gateway 개발자 가이드 내 API 게이트웨이에서 요청 검증 활성화를 참조하세요.

유형: 부울

필수 항목 여부: 아니요

AWS CloudFormation 호환성: 이 속성은 AWS SAM 고유하며 AWS CloudFormation 이에 상응하는 속성이 없습니다.

예

요청 모델

요청 모델 예제

YAML

RequestModel:
  Model: User
  Required: true
  ValidateBody: true
  ValidateParameters: true