AWS::ApiGateway::RestAPI 리소스의 쓰기 전용 속성 문제를 해결하는 방법 - AWS CloudFormation

AWS::ApiGateway::RestAPI 리소스의 쓰기 전용 속성 문제를 해결하는 방법

이 주제에서는 IaC 생성기를 사용할 때 AWS::ApiGateway::RestApi 리소스의 쓰기 전용 속성 문제를 해결하는 방법을 설명합니다.

문제

생성된 템플릿에 AWS::ApiGateway::RestApi 리소스가 포함되어 있으면 Body, BodyS3Location, CloneFrom 속성이 UNSUPPORTED_PROPERTIES로 식별된다는 경고가 생성됩니다. 이는 해당 속성이 선택적인 쓰기 전용 속성이기 때문입니다. IaC 생성기는 해당 속성이 리소스에 적용되었는지 여부를 알지 못합니다. 따라서 생성된 템플릿에서 이러한 속성을 생략합니다.

해결 방법

REST API의 Body 속성을 설정하려면 생성된 템플릿을 업데이트하세요.

  1. Amazon API Gateway GetExport API 작업을 사용하여 API를 다운로드합니다. 예를 들어 aws apigateway get-export AWS CLI 명령을 사용합니다. 자세한 내용을 알아보려면 API Gateway 개발자 안내서의 API Gateway에서 REST API 내보내기를 참조하세요.

  2. GetExport API 작업의 응답에서 Body 속성을 검색합니다. Amazon S3 버킷에 업로드합니다.

  3. 생성된 템플릿을 다운로드합니다.

  4. 템플릿에 BodyS3Location/BucketBodyS3Location/Key 속성을 추가하고 Body가 저장되는 버킷 이름과 키를 지정합니다.

  5. IaC 생성기 콘솔에서 생성된 템플릿을 열고 편집한 템플릿 가져오기를 선택합니다.