[NestJS] AWS Parameter Store AWS-SDK 프로젝트 3탄

AWS

 

 

🤷‍♂️ 본론에 앞서

---

이전 글에서 AWS Parameter Store 생성하고 매개변수, 문자열 암호화 하는 방법에 대해서 알아봤습니다.

이번글에서는 AWS-SDK를 사용해서 Nest.js 프로젝트에 Parameter Store 접근하는 방법을 알아보겠습니다.

 

 

[NestJS] AWS Parameter Store AWS-SDK 프로젝트 2탄

2024.09.05 - [Nest.js] - [NestJS] AWS Parameter Store 프로젝트 2탄

[NestJS] AWS Parameter Store 프로젝트 2탄

 

[NestJS] AWS Parameter Store AWS-SDK 프로젝트 1탄

2024.09.04 - [Nest.js] - [NestJS] AWS Parameter Store 프로젝트 1탄

[NestJS] AWS Parameter Store 프로젝트 1탄

 

🤷‍♂️ AWS-SDK 세팅 및 Parameter Store 접근 방법

---

Nest.js 프로젝트에서 코드로 Parameter Store 접근하기 위해서는 먼저 AWS-SDK를 설치해야합니다.

 

1. AWS SDK 설치

npm install --save @aws-sdk/client-ssm

 

2. Nest.js config 구조 세팅

config.module.ts 생성

ConfigModule를 전역에서 사용할 수 있도록 서비스에 등록합니다.

// config.module.ts
import { Module } from '@nestjs/common';
import { ConfigModule } from '@nestjs/config';
import EnvConfig from './env.config';

@Module({
  imports: [
    ConfigModule.forRoot({
      isGlobal: true,
      envFilePath: `.env`,
      load: [EnvConfig],
    }),
  ],
})
export class AppConfigModule {}

 

env.config.ts 생성

import { AwsConfigService } from './aws-config.service';

export default async () => {
  const awsConfigService = new AwsConfigService();

  await awsConfigService.loadConfig();

  return awsConfigService.getConfig();
};

export default async () => {}는 익명 함수를 선언하고 다른 파일에서 함수를 import 시 바로 함수가 비동기적으로 실행되도록 합니다.

ConfigModule에 load 옵션에서 env.config.ts 함수가 비동기적으로 즉시 실행해서 설정 값을 세팅해주는 로직입니다.

 

aws-config.service.ts 생성

import { GetParametersByPathCommand, SSMClient } from '@aws-sdk/client-ssm';
import { Logger } from '@nestjs/common';

export class AwsConfigService {
  private readonly ssmClient: SSMClient;
  private config: Record<string, string> = {};
  private logger = new Logger(AwsConfigService.name);

  constructor() {
    this.ssmClient = new SSMClient({
      region: process.env.AWS_REGION,
      credentials: {
        accessKeyId: process.env.AWS_ENV_ACCESS_KEY,
        secretAccessKey: process.env.AWS_ENV_SECRET_ACCESS_KEY,
      },
    });
  }

  // 로컬 ENV / AWS 데이터 가져올 수 있도록 구성
  public async loadConfig() {
    try {
      const env = process.env.NODE_ENV || 'development';
      const path = `/YOUR PATH/${env}/`;

      const getAllParameters = async (path: string) => {
        let parameters = [];
        let nextToken: string | undefined;

        do {
          const command = new GetParametersByPathCommand({
            Path: path,
            Recursive: true,
            WithDecryption: true,
            NextToken: nextToken, // NextToken을 사용하여 페이지네이션 처리
          });

          const response = await this.ssmClient.send(command);

          if (response.Parameters) {
            parameters = parameters.concat(response.Parameters);
          }

          nextToken = response.NextToken; // 다음 페이지가 있으면 NextToken이 설정됨
        } while (nextToken);

        return parameters;
      };

      const result = await getAllParameters(path);

      if (result) {
        for (const param of result) {
          if (param.Name && param.Value) {
            const key = param.Name.replace(path, '');
            this.config[key] = param.Value.replace(/\\\\n/g, '\\n');
          }
        }
      }
    } catch (error) {
      this.logger.error('AWS SSM 접근 실패', error);
    }
  }

  get(key: string): string {
    // 로컬에서 실행할 경우
    if (process.env.ENV_LOCAL === 'true') {
      return process.env[key] || '';
    }

    return this.config[key] || process.env[key] || '';
  }

  getConfig() {
    return {
      redis: {
        url: `redis://${this.get('REDIS_URL')}:${this.get('REDIS_PORT')}`,
      },
      AWS_REGION: this.get('AWS_REGION'),
      AWS_S3_ACCESS_KEY: this.get('S3_ACCESS_KEY_ID'),
      AWS_S3_SECRET_ACCESS_KEY: this.get('S3_SECRET_ACCESS_KEY'),
      AWS_S3_BUCKET_NAME: this.get('AWS_S3_BUCKET_NAME'),
      NICE_API_KEY: this.get('NICE_API_KEY'),
      firebase: {
        type: this.get('FIREBASE_TYPE'),
        project_id: this.get('FIREBASE_PROJECT_ID'),
        private_key_id: this.get('FIREBASE_PRIVATE_KEY_ID'),
        private_key: this.get('FIREBASE_PRIVATE_KEY'),
        client_email: this.get('FIREBASE_CLIENT_EMAIL'),
        client_id: this.get('FIREBASE_CLIENT_ID'),
        auth_uri: this.get('FIREBASE_AUTH_URI'),
        token_uri: this.get('FIREBASE_TOKEN_URI'),
        auth_provider_x509_cert_url: this.get('FIREBASE_AUTH_PROVIDER_X509_CERT_URL'),
        client_x509_cert_url: this.get('FIREBASE_CLIENT_x509_CERT_URL'),
        universe_domain: this.get('FIREBASE_UNIVERSE_DOMAIN'),
      },
    };
  }
}

 

SSMClient 초기 셋팅

constructor() {
    this.ssmClient = new SSMClient({
      region: process.env.AWS_REGION,
      credentials: {
        accessKeyId: process.env.AWS_ENV_ACCESS_KEY,
        secretAccessKey: process.env.AWS_ENV_SECRET_ACCESS_KEY,
      },
    });
  }

• SSMClient 인스턴스를 설정합니다.
• 서비스 생성지역 region과 발급받은 accessKeyId, secretAccessKey를 작성합니다.
• accessKeyId, secretAccessKey 프로젝트 .env 파일에 추가합니다.

 

GetParametersByPathCommand API 활용

  const command = new GetParametersByPathCommand({
    Path: path,
    Recursive: true,
    WithDecryption: true, //암호화된 파라미터인 경우 true로 설정
    NextToken: nextToken, // NextToken을 사용하여 페이지네이션 처리
  });

• GetParametersByPathCommand API 활용해서 Parameter Store에 값들을 불러옵니다.
• GetParameterCommand 말고 GetParametersByPathCommand 사용한 이유는 Path 별로 Parameter Store 값들은 접근하기 위해서입니다.
• IAM 권한에 따라서 Parameter Store 접근 API 사용이 가능합니다.

 

GetParametersByPath 실무에서 사용법

const getAllParameters = async (path: string) => {
    let parameters = [];
    let nextToken: string | undefined;

    do {
      const command = new GetParametersByPathCommand({
        Path: path,
        Recursive: true,
        WithDecryption: true,
        NextToken: nextToken, // NextToken을 사용하여 페이지네이션 처리
      });

      const response = await this.ssmClient.send(command);

      if (response.Parameters) {
        parameters = parameters.concat(response.Parameters);
      }

      nextToken = response.NextToken; // 다음 페이지가 있으면 NextToken이 설정됨
    } while (nextToken);

    return parameters;
  };

 

GetParametersByPath API 사용 시 유의사항

1. 반환할 환경변수 항목 수: 이 API는 한 번의 요청으로 최대 10개의 환경변수 항목을 반환합니다. (최소 1개, 최대 10개)
2. NextToken 활용: 만약 요청 경로에 10개 이상의 환경변수가 존재하는 경우, 반환된 응답에 NextToken이 포함됩니다. 이 NextToken을 이용해 추가 요청을 보내면, 10개 이상의 환경변수를 순차적으로 가져올 수 있습니다.

 

GetParametersByPathCommand 공식문서

https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_GetParametersByPath.html#systemsmanager-GetParametersByPath-request-MaxResults

GetParametersByPath - AWS Systems Manager

 

 

 

🤷‍♂️ 마지막으로

---

환경 변수를 중앙에서 관리하는 과정과 AWS의 Parameter Store 기능, AWS SDK 사용 방법에 대해 다뤘습니다.

 

.env 파일 관리와 중앙 집중식 환경 변수 관리 중 어느 것이 더 좋은지는 정답이 없습니다.

각각의 방법에는 장단점이 있으며, 팀 문화와 프로젝트 운영 방식에 맞춰 선택하는 것이 최선입니다.

 

저는 Parameter Store의 안전성, 중앙 관리, 자동화 가능성에 대해 긍정적으로 평가하며 앞으로도 프로젝트에 적극 활용할 계획입니다.

 

 

---

 

재밌는 오늘의 띠별 운세 보고 가세요! 

 

 

https://cometruedream.tistory.com/247

[React] Tailwind 한줄, 두줄, 세줄 효과 className 커스텀

 

 

https://cometruedream.tistory.com/243

NestJS Lifecycle (생명주기) 개념

 

 

https://cometruedream.tistory.com/242

리액트 Vite Proxy 활용한 CORS 오류 해결

 

 

https://cometruedream.tistory.com/241

React 폴더구조 FSD 기능 분활 설계 아키텍처

 

 

https://cometruedream.tistory.com/244

쉽게 이해하고 사용할수 있는 Prisma 명령어 정리

 

 

https://itibiza.tistory.com/entry/%EB%8F%84%EC%BB%A4-%EC%9E%85%EB%AC%B8-%EC%8B%9C%EB%A6%AC%EC%A6%88-Dockerfile-%EA%B0%9C%EB%85%90-%EB%B0%8F-%EC%82%AC%EC%9A%A9%EB%B2%95

[도커 입문 시리즈] Dockerfile 개념 및 사용법