Smithy API to DynamoDB

connection 생성기는 Smithy API를 TypeScript DynamoDB 프로젝트에 연결하여, 두 프로젝트가 자동으로 함께 시작되도록 로컬 개발 환경을 구성합니다.

사전 요구 사항

이 생성기를 사용하기 전에 다음이 필요합니다:

1. Smithy TypeScript API 프로젝트 (ts#api를 --framework=smithy와 함께 사용하여 생성)
2. ts#dynamodb 프로젝트

사용법

생성기 실행

VSCode

1. 설치 Nx Console VSCode Plugin 아직 설치하지 않았다면
2. VSCode에서 Nx 콘솔 열기
3. 클릭 Generate (UI) "Common Nx Commands" 섹션에서
4. 검색 @aws/nx-plugin - connection
5. 필수 매개변수 입력
6. 클릭 Generate

CLI

pnpm

pnpm nx g @aws/nx-plugin:connection

yarn

yarn nx g @aws/nx-plugin:connection

npm

npx nx g @aws/nx-plugin:connection

bun

bunx nx g @aws/nx-plugin:connection

어떤 파일이 변경될지 확인하기 위해 드라이 런을 수행할 수도 있습니다

pnpm

pnpm nx g @aws/nx-plugin:connection --dry-run

yarn

yarn nx g @aws/nx-plugin:connection --dry-run

npm

npx nx g @aws/nx-plugin:connection --dry-run

bun

bunx nx g @aws/nx-plugin:connection --dry-run

Smithy API 백엔드 프로젝트를 소스로, DynamoDB 프로젝트를 타겟으로 선택하세요.

옵션

매개변수	타입	기본값	설명
sourceProject 필수	string	-	소스 프로젝트
targetProject 필수	string	-	연결할 대상 프로젝트
sourceComponent	string	-	연결을 시작할 소스 컴포넌트 (컴포넌트 이름, 소스 프로젝트 루트 기준 상대 경로, 또는 generator id). 프로젝트를 소스로 명시적으로 선택하려면 '.'을 사용하세요.
targetComponent	string	-	연결할 대상 컴포넌트 (컴포넌트 이름, 대상 프로젝트 루트 기준 상대 경로, 또는 generator id). 프로젝트를 대상으로 명시적으로 선택하려면 '.'을 사용하세요.
preferInstallDependencies	boolean	true	생성기 실행 후 의존성 설치를 선호할지 여부입니다. 여러 생성기를 일괄 처리할 때 설치를 연기하려면 false로 설정하세요 (후속 생성기가 Nx 프로젝트 그래프를 계산할 수 있도록 필요한 경우 설치는 여전히 실행됩니다); 마지막에 한 번만 설치합니다.

생성기 출력

생성기는 Smithy API의 project.json을 업데이트하여 dev 타겟에서 DynamoDB 프로젝트의 dev 타겟으로의 의존성을 추가합니다. 소스 파일은 수정되지 않습니다.

작업에서 DynamoDB 사용하기

DynamoDB 패키지에서 엔티티 팩토리를 가져와서 작업 구현 내부에서 사용하세요:

packages/api/src/operations/list-examples.ts

import { createExampleEntity } from ':my-scope/my-table';
import {
  ListExamplesOperationInput,
  ListExamplesOperationOutput,
} from '../generated/ssdk/index.js';
import { ServiceContext } from '../context.js';

export const listExamples = async (
  _input: ListExamplesOperationInput,
  _ctx: ServiceContext,
): Promise<ListExamplesOperationOutput> => {
  const entity = await createExampleEntity();
  const result = await entity.scan.go();
  return { items: result.data };
};

인프라

Lambda 함수가 DynamoDB 테이블에 액세스할 수 있도록 하려면 인프라에서 필요한 권한을 부여하세요.

CDK

테이블 구성에서 grantReadWriteData를 호출하세요. 이는 Lambda 실행 역할에 필요한 DynamoDB 및 KMS 권한을 모두 부여합니다:

packages/infra/src/stacks/application-stack.ts

import { MyTable } from ':my-scope/common-constructs';

const table = new MyTable(this, 'Table');

const api = new Api(this, 'Api', {
  integrations: Api.defaultIntegrations(this).build(),
});

Object.entries(api.integrations).forEach(([, integration]) => {
  table.grantReadWriteData(integration.handler);
});

참고

이 예제는 API의 모든 핸들러에 액세스 권한을 부여합니다. 일부 핸들러만 액세스가 필요한 경우 개별적으로 구성하세요.

Terraform

Lambda 실행 역할에 DynamoDB 테이블 및 KMS 암호화 키에 액세스할 수 있는 권한을 부여하세요:

packages/infra/src/main.tf

module "my_table" {
  source = "../../common/terraform/src/app/dynamodb/my-table"
}

resource "aws_iam_role_policy" "dynamodb_access" {
  role = module.my_api.lambda_role_name

  policy = jsonencode({
    Version = "2012-10-17"
    Statement = [
      {
        Effect = "Allow"
        Action = [
          "dynamodb:GetItem",
          "dynamodb:PutItem",
          "dynamodb:UpdateItem",
          "dynamodb:DeleteItem",
          "dynamodb:Query",
          "dynamodb:Scan",
          "dynamodb:BatchGetItem",
          "dynamodb:BatchWriteItem",
        ]
        Resource = [
          module.my_table.table_arn,
          "${module.my_table.table_arn}/index/*",
        ]
      },
      {
        Effect = "Allow"
        Action = [
          "kms:Encrypt",
          "kms:Decrypt",
          "kms:ReEncrypt*",
          "kms:GenerateDataKey*",
          "kms:DescribeKey"
        ]
        Resource = [module.my_table.kms_key_arn]
      },
    ]
  })
}

로컬 개발

connection 생성기는 프로젝트의 dev 타겟이 DynamoDB 프로젝트의 dev 타겟에 의존하도록 구성합니다. dev를 실행하면 DynamoDB Local이 프로젝트와 함께 자동으로 시작됩니다.

LOCAL_DEV=true 환경 변수가 자동으로 설정되므로, getDynamoDBClient()와 resolveTableName()은 AWS 대신 로컬 DynamoDB Local 인스턴스에 연결됩니다.