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コードをコンパイルできます。

は、プロジェクトの仮想環境CDKCLIを自動的に作成します。.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()

スタックファイル を含むディレクトリ。は、ここで以下CDKCLIを作成します。

スタックファイルの例を次に示します。

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,
 })
}