HttpApiDefinition

API를 정의하는 OpenAPI 문서.

구문

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

YAML

  Bucket: String
  Key: String
  Version: String

속성

Bucket

OpenAPI 파일이 저장되는 Amazon S3 버킷의 이름입니다.

타입: 문자열

필수 항목 여부: 예

AWS CloudFormation 호환성: 이 속성은 AWS::ApiGatewayV2::Api BodyS3Location 데이터 유형의 Bucket 속성으로 직접 전달됩니다.

Key

OpenAPI 파일의 Amazon S3 키.

타입: 문자열

필수 항목 여부: 예

AWS CloudFormation 호환성: 이 속성은 AWS::ApiGatewayV2::Api BodyS3Location 데이터 유형의 Key 속성에 직접 전달됩니다.

Version

버전이 지정된 객체의 경우 OpenAPI 파일의 버전.

타입: 문자열

필수 항목 여부: 아니요

AWS CloudFormation 호환성: 이 속성은 AWS::ApiGatewayV2::Api BodyS3Location 데이터 유형의 Version 속성에 직접 전달됩니다.

예

Uri 정의 예제

API 정의 예

YAML

DefinitionUri:
  Bucket: mybucket-name
  Key: mykey-name
  Version: 121212