Go로 AWS CDK 작업 - AWS Cloud Development Kit (AWS CDK) v2
Go 시작하기프로젝트 생성AWS Construct 라이브러리 모듈 관리Go에서 종속성 관리Go의 AWS CDK 관용구빌드, 합성 및 배포

v AWS CDK 2 개발자 안내서입니다. 이전 CDK v1은 2022년 6월 1일에 유지 관리에 들어갔으며 2023년 6월 1일에 지원을 종료했습니다.

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

Go로 AWS CDK 작업

Go는 AWS Cloud Development Kit (AWS CDK)에 대해 완전히 지원되는 클라이언트 언어이며 안정적인 것으로 간주됩니다. Go로 AWS CDK 작업 시 익숙한 도구를 사용할 수 있습니다. AWS CDK의 Go 버전은 Go 스타일 식별자를 사용합니다.

CDK가 지원하는 다른 언어와 달리 Go는 기존 객체 지향 프로그래밍 언어가 아닙니다. Go는 다른 언어가 상속을 자주 활용하는 구성을 사용합니다. 가능한 한 관용적 Go 접근 방식을 사용하려고 시도했지만 CDK가 다를 수 있는 장소가 있습니다.

이 주제에서는 Go로 AWS CDK 작업 시 지침을 제공합니다. AWS CDK에 대한 간단한 Go 프로젝트에 대한 안내는 공지 블로그 게시물을 참조하세요.

Go 시작하기

AWS CDK 작업을 진행하려면 AWS 계정과 자격 증명이 있어야 하며 Node.js와 AWS CDK Toolkit를 설치해야 합니다. AWS CDK 시작하기 섹션을 참조하세요.

AWS CDK에 대한 Go 바인딩은 표준 Go 도구 체인 v1.18 이상을 사용합니다. 원하는 편집기를 사용할 수 있습니다.

참고

타사 언어 사용 중단: 언어 버전은 공급업체 또는 커뮤니티에서 공유하는 수명 종료(EOL)까지만 지원되며 사전 공지와 함께 변경될 수 있습니다.

프로젝트 생성

빈 디렉터리에서 cdk init를 간접적으로 호출하여 새 AWS CDK 프로젝트를 생성합니다. --language 옵션을 사용하고 go를 지정합니다.

mkdir my-project
cd my-project
cdk init app --language go

cdk init는 프로젝트 폴더의 이름을 사용하여 클래스, 하위 폴더 및 파일을 포함한 프로젝트의 다양한 요소의 이름을 지정합니다. 폴더 이름의 하이픈은 밑줄로 변환됩니다. 하지만 이름은 Go 식별자의 형식을 따라야 합니다. 예를 들어 숫자로 시작하거나 공백을 포함해서는 안 됩니다.

결과 프로젝트에는 go.mod의 코어 AWS CDK Go 모듈인 github.com/aws/aws-cdk-go/awscdk/v2에 대한 참조가 포함되었습니다. 이 모듈과 다른 필수 모듈을 설치하려면 go get을 실행하세요.

AWS Construct 라이브러리 모듈 관리

대부분의 AWS CDK 설명서와 예에서 ‘모듈’이라는 단어는 AWS 서비스당 하나 이상의 AWS Construct 라이브러리 모듈을 나타내는 데 자주 사용되며, 이는 Go에서 관용적으로 사용하는 용어와 다릅니다. CDK Construct 라이브러리는 해당 모듈 내에서 Go 패키지로 제공되는 다양한 AWS 서비스를 지원하는 개별 Construct 라이브러리 모듈과 함께 하나의 Go 모듈로 제공됩니다.

일부 서비스의 AWS Construct 라이브러리 지원은 여러 Construct 라이브러리 모듈(Go 패키지)에서 제공됩니다. 예를 들어, Amazon Route 53에는 기본 awsroute53 패키지 외에도 awsroute53patterns, awsroute53resolver, awsroute53targets라는 세 개의 Construct 라이브러리 모듈이 있습니다.

대부분 AWS CDK 앱에 필요한 AWS CDK의 코어 패키지는 Go 코드에서 github.com/aws/aws-cdk-go/awscdk/v2로 가져왔습니다. AWS Construct 라이브러리의 다양한 서비스에 대한 패키지는 github.com/aws/aws-cdk-go/awscdk/v2 아래에 있습니다. 예를 들어 Amazon S3 모듈의 네임스페이스는 github.com/aws/aws-cdk-go/awscdk/v2/awss3입니다.


import (
        "github.com/aws/aws-cdk-go/awscdk/v2/awss3"
        // ...
)

앱에서 사용하려는 서비스에 대한 Construct 라이브러리 모듈(Go 패키지)을 가져온 후에는 awss3.Bucket 등을 사용하여 해당 모듈의 구문에 액세스합니다.

Go에서 종속성 관리

Go에서 종속성 버전은 go.mod에 정의되어 있습니다. 기본 go.mod는 여기에 표시된 것과 유사합니다.

module my-package

go 1.16

require (
  github.com/aws/aws-cdk-go/awscdk/v2 v2.16.0
  github.com/aws/constructs-go/constructs/v10 v10.0.5
  github.com/aws/jsii-runtime-go v1.29.0
)

패키지 이름(Go parlance: 모듈)은 필요한 버전 번호가 추가된 URL로 지정됩니다. Go의 모듈 시스템은 버전 범위를 지원하지 않습니다.

go get 명령을 실행하여 필요한 모든 모듈을 설치하고 go.mod를 업데이트합니다. 종속성에 사용 가능한 업데이트 목록을 보려면 go list -m -u all을 실행합니다.

Go의 AWS CDK 관용구

필드 및 메서드 이름

필드와 메서드 이름은 CDK의 원어인 TypeScript로 캐멀 대소문자(likeThis)를 사용합니다. Go에서는 Go 규칙을 따르며, 파스칼 대소문자(LikeThis)도 마찬가지입니다.

정리

main 메서드에서 defer jsii.Close()를 사용하여 CDK 앱이 자체적으로 정리되는지 확인합니다.

누락된 값 및 포인터 변환

Go에서 속성 번들과 같은 AWS CDK 객체의 누락된 값은 nil로 표시됩니다. Go에는 무효화할 수 있는 유형이 없습니다. nil을 포함할 수 있는 유일한 유형은 포인터입니다. 값을 선택 사항으로 허용하기 위해 모든 CDK 속성, 인수 및 반환 값은 기본 유형에 대해서도 포인터입니다. 이는 필수 값과 선택적 값에도 적용되므로 나중 필수 값이 선택 사항이 되는 경우 유형을 크게 변경할 필요가 없습니다.

리터럴 값 또는 표현식을 전달할 때 다음 도우미 함수를 사용하여 값에 대한 포인터를 생성합니다.

  • jsii.String

  • jsii.Number

  • jsii.Bool

  • jsii.Time

일관성을 위해, 예를 들어 문자열에 대한 포인터보다 문자열로 구문의 id를 받는 것이 더 편리해 보이더라도 구문을 직접 정의할 때 포인터를 비슷한 방식으로 사용하는 것이 좋습니다.

기본 값과 복합 유형을 포함한 선택적 AWS CDK 값을 다룰 때 포인터를 명시적으로 테스트하여 아무것도 하기 전에 nil이 아닌지 확인해야 합니다. Go에는 일부 다른 언어와 마찬가지로 비어 있거나 누락된 값을 처리하는 데 도움이 되는 '동기 설탕'이 없습니다. 그러나 속성 번들과 비슷한 구조에 필요한 값은 반드시 존재한다는 점이 보장됩니다. 그렇지 않으면 구성이 실패합니다. 따라서 이러한 값은 nil 검사가 필요 없습니다.

구문 및 속성

하나 이상의 AWS 리소스와 관련 속성을 나타내는 구문은 Go에서 인터페이스로 표현됩니다. 예를 들어 awss3.Bucket은 인터페이스입니다. 모든 구문에는 해당 인터페이스를 구현하는 구조체를 반환하는 awss3.NewBucket과 같은 팩토리 함수가 있습니다.

모든 팩토리 함수는 구문이 정의되는 scope(구문 트리에서 부모), id, 구문이 생성하는 리소스를 구성하는 데 사용하는 키/값 페어의 번들인 props라는 세 가지 인수를 사용합니다. '속성 번들' 패턴은 AWS CDK의 다른 곳에서도 사용됩니다.

Go에서 props는 각 구문에 대한 특정 구조체 유형으로 표현됩니다. 예를 들어 awss3.Bucket은 awss3.BucketProps 유형의 props 인수를 사용합니다. 구조체 리터럴을 사용하여 props 인수를 작성합니다.

var bucket = awss3.NewBucket(stack, jsii.String("amzn-s3-demo-bucket"), &awss3.BucketProps{
    Versioned: jsii.Bool(true),
})

일반 구조

경우에 따라 AWS CDK는 JavaScript 배열 또는 입력되지 않은 객체를 메서드에 대한 입력으로 사용합니다. (예: AWS CodeBuild의 BuildSpec.fromObject() 메서드 참조) Go에서 이러한 객체는 각각 슬라이스 및 빈 인터페이스로 표시됩니다.

CDK는 기본 유형을 포함하는 슬라이스를 작성하기 위한 jsii.Strings와 같은 가변형 도우미 함수를 제공합니다.

jsii.Strings("One", "Two", "Three")

사용자 지정 구문 개발

Go에서는 기존 구문을 확장하는 것보다 새 구문을 작성하는 것이 일반적으로 더 간단합니다. 먼저 익스텐션과 같은 의미 체계가 필요한 경우 하나 이상의 기존 유형을 익명으로 내장하여 새 구조체 유형을 정의합니다. 추가하려는 새 기능에 대한 메서드와 필요한 데이터를 보관하는 데 필요한 필드를 작성합니다. 구문에 필요한 경우 props 인터페이스를 정의합니다. 마지막으로, 구문의 인스턴스를 반환하는 팩토리 함수 NewMyConstruct()를 작성합니다.

기존 구문에서 일부 기본값을 변경하거나 인스턴스화 시 간단한 동작을 추가하는 경우 해당 배관이 모두 필요하지는 않습니다. 대신 ‘확장’하는 구문의 팩토리 함수를 직접적으로 호출하는 팩토리 함수를 작성합니다. 예를 들어 다른 CDK 언어에서는 s3.Bucket 유형을 재정의하고 새 유형의 이니셜라이저에서 지정된 파일 이름 확장자만 버킷에 추가하도록 허용하는 버킷 정책을 추가하여 Amazon S3 버킷의 객체 유형을 적용하는 TypedBucket 구문을 생성할 수 있습니다. Go에서는 적절한 버킷 정책을 추가한 s3.Bucket(s3.NewBucket을 사용하여 인스턴스화)을 반환하는 NewTypedBucket을 작성하는 것이 더 쉽습니다. 새로운 구문 유형은 필요하지 않습니다. 해당 기능은 이미 표준 버킷 구문에서 사용할 수 있기 때문입니다. 새로운 ‘구문’은 이를 구성하는 더 간단한 방법을 제공할 뿐입니다.

빌드, 합성 및 배포

AWS CDK는 실행하기 전에 앱을 자동으로 컴파일합니다. 그러나 오류를 확인하고 테스트를 실행하기 위해 앱을 수동으로 빌드하는 것이 유용할 수 있습니다. 프로젝트의 루트 디렉터리에 있는 동안 명령 프롬프트에서 go build를 실행하여 이 작업을 수행할 수 있습니다.

명령 프롬프트에서 go test를 실행하여 작성한 테스트를 실행합니다.