Mac 환경의 VS Code에서 cfn-lint를 설치해서 CloudFormation 문법을 체크해 보기

안녕하세요 클래스메소드 김재욱(Kim Jaewook) 입니다. 이번에는 Mac 환경의 VS Code에서 cfn-lint를 설치해서 CloudFormation 문법을 체크해 보는 과정을 정리해 봤습니다.

cfn-lint란?

cfn-lint는 코드를 정밀 조사하여 해당 코드를 실행했을 때 오류를 발생시킬 수 있는 구문 오류나 버그가 없는지 찾는 프로그램을 말합니다.

AWS 블로그에서는 cfn-lint를 다음과 같이 설명하고 있습니다.

pip로 cfn-lint 설치

python3.9 -m pip install --upgrade pip
pip install cfn-lint
cfn-lint --version

명령어는 다음과 같습니다.

먼저 python 패키지인 pip를 업데이트 합니다.

그리고 cfn-lint를 설치하고, 제대로 설치가 되었는지 버전을 확인합니다.

VS Code에서 CloudFormation Linter 설치

이제 로컬에서 cfn-lint를 설치했기 때문에, VS Code에서 cfn-lint를 호출해서 사용하려면 CloudFormation Linter를 설치해야 합니다.

VS Code에서 확장 기능인「cfn-lint」를 검색해서 설치합니다.

※ 이미 cfn-lint를 설치한 상태이기 때문에 이미지에는 Uninsatll로 표시되고 있습니다.

cfn-lint가 적용된 후, CloudFormation 템플릿을 확인해 보면 다음과 같이 에러, 문법을 잡아주는 것을 확인할 수 있습니다.

CloudFormation 코드를 작성한 다음, 스택을 만들어 보면서 에러를 확인할 필요 없이 로컬 환경에서 체크 후 수정할 수 있다는 게 엄청난 메리트인 것 같습니다.

본 블로그 게시글을 보시고 문의 사항이 있으신 분들은 클래스메소드코리아 (info@classmethod.kr)로 연락 주시면 빠른 시일 내 담당자가 회신 드릴 수 있도록 하겠습니다 !