[AWS] AWS CDK 시작하기 (1) | Javascript, AWS Configure, CDK Init, CDK deploy, lambda, api gateway

 

📄 목차

• 1. AWS & CDK 설정
  • AWS Configure
  • aws-cdk 설치
• 2. CDK 프로젝트 생성
  • cdk init
• 3.  스택에 lambda, API GW 추가
  • 스택초기화 
  • 람다 함수 만들기
  • lambda contruct library 설치
  • stack에 람다 정의
  •  
  • stack에 api gateway 추가 정의
• 4. AWS에 배포
  • bootstrap stack 설치 $cdk bootstrap$
  • cdk synth
  • cdk deploy

 

1. AWS & CDK 설정

AWS Configure

기존에 aws configure를 통해 AWS와 로컬이 연결되어 있다면 건너뛰어도 됩니다.
aws configure list

 

• AWS의 IAM에서 키페어$AWS Access Key, AWS Secret Access Key$ 발급 
  참고) 키페어 발급  https://docs.aws.amazon.com/ko_kr/cli/latest/userguide/cli-configure-quickstart.html#cli-configure-quickstart-creds 
• terminal에서 aws configure 커맨드를 통해 aws 계정 연결

$ aws configure
AWS Access Key ID: [aws 에서 IAM생성하여 입력]
AWS Secret Access Key : [aws 에서 IAM생성하여 입력]
Default region name [None]: ap-northeast-2
Default output format [None]: json

 

aws-cdk 설치

• npm을 통해 aws-cdk 설치

$ sudo npm i -g aws-cdk
$ cdk version # 2.15.0 (build 151055e)

 

2. CDK 프로젝트 생성

cdk init

• cdk init 커맨드로 cdk프로젝트가 생성

$ cdk init sample-app --language typescript

 

vsCode로 sample-app 프로젝트를 열어보면 파일 구조를 확인할 수 있습니다.

 

3.  스택에 lambda, API GW 추가

스택초기화 

lib 디렉토리를 보면 작성되어 있는 stack이 있습니다.

sample-app을 통해 프로젝트를 생성하였기에 queue 등 기본적으로 들어가있는 코드들이 있을텐데,

원래 있던 코드를 모두 날리고 아래와 같이 만들어줍니다. 

// lib/sample_cdk-stack.ts

import { Duration, Stack, StackProps } from 'aws-cdk-lib';
import { Construct } from 'constructs';

export class SampleCdkStack extends Stack {
  constructor(scope: Construct, id: string, props?: StackProps) {
    super(scope, id, props);
  }
}

 

람다 함수 만들기

• root디렉토리에 $bin, lib와 같은 계층에$ lambda 디렉토리 생성
• lambda 디렉토리 내 hello.js 파일 생성 

• hello.js에 아래와 같이 작성 

exports.handler = async function(event) {
    console.log('requests: ', JSON.stringify(event, undefined, 2))
    return {
        statusCode: 200,
        headers: { 'Content-Type' : 'text/plain' },
        body: `hello! ${event.path}\n`
    }
}

 

lambda contruct library 설치

• 아래 커맨드로 lambda construct libaray 설치
• 이게 설치되어 있어야 작성한 lambda 코드를 cdk에서 불러올 수 있음 

$ npm install @aws-cdk/aws-lambda

 

 

stack에 람다 정의

stack이 정의되어 있는 파일$lib/~~.stack.ts$에 lambda를 정의해줍니다.

// lib/sample_cdk-stack.ts
import { Duration, Stack, StackProps } from 'aws-cdk-lib';
import * as lambda from 'aws-cdk-lib/aws-lambda';
import { Construct } from 'constructs';

export class SampleCdkStack extends Stack {
  constructor(scope: Construct, id: string, props?: StackProps) {
    super(scope, id, props);

    // defines an AWS Lambda resource
    const hello = new lambda.Function(this, 'HelloHandler', {
      runtime: lambda.Runtime.NODEJS_14_X,    // execution environment
      code: lambda.Code.fromAsset('lambda'),  // code loaded from "lambda" directory
      handler: 'hello.handler'                // file is "hello", function is "handler"
    });
  }
}

 

 

stack에 api gateway 추가 정의

api gateway 도 stack 에 추가해줍니다. 

// lib/sample_cdk-stack.ts
import { Duration, Stack, StackProps } from 'aws-cdk-lib';
import * as lambda from 'aws-cdk-lib/aws-lambda';
import * as apigw from 'aws-cdk-lib/aws-apigateway';
import { Construct } from 'constructs';

export class SampleCdkStack extends Stack {
  constructor(scope: Construct, id: string, props?: StackProps) {
    super(scope, id, props);

    // defines an AWS Lambda resource
    const hello = new lambda.Function(this, 'HelloHandler', {
      runtime: lambda.Runtime.NODEJS_14_X,    // execution environment
      code: lambda.Code.fromAsset('lambda'),  // code loaded from "lambda" directory
      handler: 'hello.handler'                // file is "hello", function is "handler"
    });

    // defines an API Gateway REST API resource backed by our "hello" function.
    new apigw.LambdaRestApi(this, 'Endpoint', {
      handler: hello
    });
  }
}

 

 

4. AWS에 배포

bootstrap stack 설치 $cdk bootstrap$

AWS CDK 앱을 처음으로 디폴로이 할 때는, "bootstrap stack을 설치해주어야 합니다.

• bootstrap stack 설치 

$ cdk bootstrap

 

cdk synth

cdk synth 커맨드는 cdk프로젝트 코드를 cloudFormation 템플릿으로 변환해줍니다. 

• cdk synth 커맨드를 통해 cloudFormation이 어떻게 구성될 지 확인할 수 있음
• deploy를 위해 꼭 필요한 단계는 아님 

$ cdk synth
Resources:
  CdkworkshopQueue18864164:
    Type: AWS::SQS::Queue
    Properties:
      VisibilityTimeout: 300
    Metadata:
      aws:cdk:path: cdkworkshop/CdkworkshopQueue/Resource
  CdkworkshopQueuePolicy78D5BF45:
    Type: AWS::SQS::QueuePolicy
    Properties:
      PolicyDocument:
        Statement:
          - Action: sqs:SendMessage
            Condition:
              ArnEquals:
                aws:SourceArn:
                  Ref: CdkworkshopTopic58CFDD3D
            Effect: Allow
            Principal:
              Service: sns.amazonaws.com
            Resource:
              Fn::GetAtt:
                - CdkworkshopQueue18864164
                - Arn
        Version: "2012-10-17"
      Queues:
        - Ref: CdkworkshopQueue18864164
    Metadata:
      aws:cdk:path: cdkworkshop/CdkworkshopQueue/Policy/Resource
  CdkworkshopQueuecdkworkshopCdkworkshopTopic7642CC2FCF70B637:
    Type: AWS::SNS::Subscription
    Properties:
      Protocol: sqs
      TopicArn:
        Ref: CdkworkshopTopic58CFDD3D
      Endpoint:
        Fn::GetAtt:
          - CdkworkshopQueue18864164
          - Arn
    Metadata:
      aws:cdk:path: cdkworkshop/CdkworkshopQueue/cdkworkshopCdkworkshopTopic7642CC2F/Resource
  CdkworkshopTopic58CFDD3D:
    Type: AWS::SNS::Topic
    Metadata:
      aws:cdk:path: cdkworkshop/CdkworkshopTopic/Resource
  CDKMetadata:
    Type: AWS::CDK::Metadata
    Properties:
      Modules: aws-cdk=1.18.0,jsii-runtime=Python/3.7.3

 

cdk deploy

cdk deploy 커맨드를 실행하면 현재까지 작성한 스택이 aws에 배포됩니다. 

$ cdk deploy

 

디플로이가 완료되면 위처럼 api gateway url을 보여줍니다. 이 url로 들어가보면 api gateway -> lambda를 통해 response를 확인할 수 있습니다. 

 

 

AWS 계정에서도 리소스를 확인할 수 있습니다. 

AWS > cloudFormation에 가보니 잘 들어가 있네요

 

AWS > Lambda에도 hello handler를 확인할 수 있습니다.

 

혹시 디플로이가 정상적으로 되었는데, 계정에서 찾을 수 없다면,

• 다른 계정과 연결되었는지 확인해보세요
• 다른 리전에 배포하였는지 확인해보세요

aws configure list를 통해 디폴트로 설정된 aws 계정 및 리전을 확인할 수 있습니다. 

 

 

 

참고)

https://towardsthecloud.com/how-to-set-up-aws-cdk

https://cdkworkshop.com/20-typescript/20-create-project/500-deploy.html