AWS CDK プロジェクト

パッケージを npm レジストリに発行するときに無視するファイルおよびフォルダを指定するファイル。このファイルは .gitignore に似ていますが、npm パッケージに特化しています。

アプリケーションファイルは CDK アプリを定義します。CDK プロジェクトには、1 つ以上のアプリケーションファイルを含めることができます。アプリケーションファイルは bin フォルダに保存されます。

次の内容は、CDK アプリを定義する基本的なアプリケーションファイルの例です。

#!/usr/bin/env node
import 'source-map-support/register';
import * as cdk from 'aws-cdk-lib';
import { MyCdkTsProjectStack } from '../lib/my-cdk-ts-project-stack';

const app = new cdk.App();
new MyCdkTsProjectStack(app, 'MyCdkTsProjectStack');

Jest の設定ファイル。Jest は人気な JavaScript テストフレームワークです。

スタックファイルは CDK スタックを定義します。スタック内では、コンストラクトを使用して AWS リソースおよびプロパティを定義します。

次の内容は、CDK スタックを定義する基本的なスタックファイルの例です。

import * as cdk from 'aws-cdk-lib';
import { Construct } from 'constructs';

export class MyCdkTsProjectStack extends cdk.Stack {
 constructor(scope: Construct, id: string, props?: cdk.StackProps) {
  super(scope, id, props);
    
  // code that defines your resources and properties go here
 }
}

プロジェクトの依存関係を含む Node.js プロジェクト内の共通フォルダ。

package.json ファイルと連携して依存関係のバージョンを管理するメタデータファイル。

Node.js プロジェクトで一般的に使用されるメタデータファイル。このファイルには、プロジェクト名、スクリプト定義、依存関係、その他のインポートプロジェクトレベルの情報など、CDK プロジェクトに関する情報が含まれています。

CDK プロジェクトのテストを整理するため、テストフォルダが作成されます。サンプルテストファイルも作成されます。

テストを実行する前に TypeScript にテストを記述し、Jest を使用して TypeScript コードをコンパイルできます。

コンパイラオプションおよびプロジェクト設定を指定する TypeScript プロジェクトで使用される設定ファイル。

パッケージを npm レジストリに発行するときに無視するファイルおよびフォルダを指定するファイル。このファイルは .gitignore に似ていますが、npm パッケージに特化しています。

アプリケーションファイルは CDK アプリを定義します。CDK プロジェクトには、1 つ以上のアプリケーションファイルを含めることができます。アプリケーションファイルは bin フォルダに保存されます。

次の内容は、CDK アプリを定義する基本的なアプリケーションファイルの例です。

#!/usr/bin/env node

const cdk = require('aws-cdk-lib');
const { MyCdkJsProjectStack } = require('../lib/my-cdk-js-project-stack');

const app = new cdk.App();
new MyCdkJsProjectStack(app, 'MyCdkJsProjectStack');

Jest の設定ファイル。Jest は人気な JavaScript テストフレームワークです。

スタックファイルは CDK スタックを定義します。スタック内では、コンストラクトを使用して AWS リソースおよびプロパティを定義します。

次の内容は、CDK スタックを定義する基本的なスタックファイルの例です。

const { Stack, Duration } = require('aws-cdk-lib');

class MyCdkJsProjectStack extends Stack {
 constructor(scope, id, props) {
  super(scope, id, props);
    
  // code that defines your resources and properties go here
 }
}

module.exports = { MyCdkJsProjectStack }

プロジェクトの依存関係を含む Node.js プロジェクト内の共通フォルダ。

package.json ファイルと連携して依存関係のバージョンを管理するメタデータファイル。

Node.js プロジェクトで一般的に使用されるメタデータファイル。このファイルには、プロジェクト名、スクリプト定義、依存関係、その他のインポートプロジェクトレベルの情報など、CDK プロジェクトに関する情報が含まれています。

CDK プロジェクトのテストを整理するため、テストフォルダが作成されます。サンプルテストファイルも作成されます。

テストを実行する前に JavaScript にテストを記述し、Jest を使用して JavaScript コードをコンパイルできます。

CDK CLI は、プロジェクトの仮想環境を自動的に作成します。.venv ディレクトリはこの仮想環境を参照します。

アプリケーションファイルは CDK アプリを定義します。CDK プロジェクトには、1 つ以上のアプリケーションファイルを含めることができます。

次の内容は、CDK アプリを定義する基本的なアプリケーションファイルの例です。

#!/usr/bin/env python3
import os

import aws_cdk as cdk

from my_cdk_py_project.my_cdk_py_project_stack import MyCdkPyProjectStack

app = cdk.App()
MyCdkPyProjectStack(app, "MyCdkPyProjectStack")

app.synth()

スタックファイルが含まれまるスタックファイル。CDK CLI はこちらで次のものを作成します。

次の内容はスタックファイルの例です。

from aws_cdk import Stack

from constructs import Construct

class MyCdkPyProjectStack(Stack):
 def __init__(self, scope: Construct, construct_id: str, **kwargs) -> None:
  super().__init__(scope, construct_id, **kwargs)
        
  # code that defines your resources and properties go here

requirements.txt に似ていますが、本番ではなくて開発目的専用に依存関係を管理するために使用されます。

プロジェクトの依存関係を指定および管理するため、Python プロジェクトで使用される一般的なファイル。

Python 仮想環境のセットアップに使用される Windows のバッチファイル。

CDK プロジェクト用のテストを含むディレクトリ。

次の内容はユニットテストの例です。

import aws_cdk as core
import aws_cdk.assertions as assertions

from my_cdk_py_project.my_cdk_py_project_stack import MyCdkPyProjectStack

def test_sqs_queue_created():
 app = core.App()
 stack = MyCdkPyProjectStack(app, "my-cdk-py-project")
 template = assertions.Template.from_stack(stack)

 template.has_resource_properties("AWS::SQS::Queue", {
  "VisibilityTimeout": 300
 })

CDK プロジェクトに関する設定情報とメタデータを含むファイル。このファイルは Maven の一部です。

アプリケーションおよびスタックファイルを含むディレクトリ。

次の内容は、アプリケーションファイルの例です。

package com.myorg;

import software.amazon.awscdk.App;
import software.amazon.awscdk.Environment;
import software.amazon.awscdk.StackProps;

import java.util.Arrays;

public class MyCdkJavaProjectApp {
 public static void main(final String[] args) {
  App app = new App();

  new MyCdkJavaProjectStack(app, "MyCdkJavaProjectStack", StackProps.builder()
   .build());

  app.synth();
 }
}

次の内容は、スタックファイルの例です。

package com.myorg;

import software.constructs.Construct;
import software.amazon.awscdk.Stack;
import software.amazon.awscdk.StackProps;

public class MyCdkJavaProjectStack extends Stack {
 public MyCdkJavaProjectStack(final Construct scope, final String id) {
  this(scope, id, null);
 }

 public MyCdkJavaProjectStack(final Construct scope, final String id, final StackProps props) {
  super(scope, id, props);

  // code that defines your resources and properties go here
 }
}

テストファイルを含むディレクトリ。以下に例を示します。

package com.myorg;

import software.amazon.awscdk.App;
import software.amazon.awscdk.assertions.Template;
import java.io.IOException;

import java.util.HashMap;

import org.junit.jupiter.api.Test;

public class MyCdkJavaProjectTest {

 @Test
 public void testStack() throws IOException {
  App app = new App();
  MyCdkJavaProjectStack stack = new MyCdkJavaProjectStack(app, "test");

  Template template = Template.fromStack(stack);

  template.hasResourceProperties("AWS::SQS::Queue", new HashMap<String, Number>() {{
   put("VisibilityTimeout", 300);
  }});
 }
}

アプリケーションおよびスタックファイルを含むディレクトリ。

次の内容は、アプリケーションファイルの例です。

using Amazon.CDK;
using System;
using System.Collections.Generic;
using System.Linq;

namespace MyCdkCsharpProject
{
 sealed class Program
 {
  public static void Main(string[] args)
  {
   var app = new App();
   new MyCdkCsharpProjectStack(app, "MyCdkCsharpProjectStack", new StackProps{});
   app.Synth();
  }
 }
}

次の内容は、スタックファイルの例です。

using Amazon.CDK;
using Constructs;

namespace MyCdkCsharpProject
{
 public class MyCdkCsharpProjectStack : Stack
 {
  internal MyCdkCsharpProjectStack(Construct scope, string id, IStackProps props = null) : base(scope, id, props)
  {
   // code that defines your resources and properties go here
  }
 }
}

このディレクトリには、次のものも含まれています。

関連プロジェクトの整理および管理に使用される Microsoft Visual Studio Solution File。

モジュール情報を含めて、Go プロジェクトの依存関係およびバージョニングを管理するために使用されるファイル。

CDK アプリケーションおよびスタックを定義するファイル。

以下に例を示します。

package main
import (
 "github.com/aws/aws-cdk-go/awscdk/v2"
 "github.com/aws/constructs-go/constructs/v10"
 "github.com/aws/jsii-runtime-go"
)

type MyCdkGoProjectStackProps struct {
 awscdk.StackProps
}

func NewMyCdkGoProjectStack(scope constructs.Construct, id string, props *MyCdkGoProjectStackProps) awscdk.Stack {
 var sprops awscdk.StackProps
 if props != nil {
  sprops = props.StackProps
 }
 stack := awscdk.NewStack(scope, &id, &sprops)
 // The code that defines your resources and properties go here

  return stack
}

func main() {
 defer jsii.Close()
 app := awscdk.NewApp(nil)
 NewMyCdkGoProjectStack(app, "MyCdkGoProjectStack", &MyCdkGoProjectStackProps{
  awscdk.StackProps{
   Env: env(),
  },
 })
 app.Synth(nil)
}

func env() *awscdk.Environment {

 return nil
}

サンプルテストを定義するファイル。

以下に例を示します。

package main

import (
 "testing"

 "github.com/aws/aws-cdk-go/awscdk/v2"
 "github.com/aws/aws-cdk-go/awscdk/v2/assertions"
 "github.com/aws/jsii-runtime-go"
)

func TestMyCdkGoProjectStack(t *testing.T) {
    
 // GIVEN
 app := awscdk.NewApp(nil)
    
 // WHEN
 stack := NewMyCdkGoProjectStack(app, "MyStack", nil)
    
 // THEN
 template := assertions.Template_FromStack(stack, nil)
 template.HasResourceProperties(jsii.String("AWS::SQS::Queue"), map[string]interface{}{
  "VisibilityTimeout": 300,
 })
}