HttpApiDefinition - AWS Serverless Application Model
구문속성예시

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

HttpApiDefinition

API를 정의하는 OpenAPI 문서.

구문

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

YAML

  Bucket: String
  Key: String
  Version: String

속성

Bucket

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

유형: 문자열

필수 항목 여부: 예

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

Key

OpenAPI 파일의 Amazon S3 키.

유형: 문자열

필수 항목 여부: 예

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

Version

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

유형: 문자열

필수 항목 여부: 아니요

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

예시

Uri 정의 예제

API 정의 예

YAML

DefinitionUri:
  Bucket: sam-s3-demo-bucket-name
  Key: mykey-name
  Version: 121212