AWS Cloud9 の AWS CDK チュートリアル

AWS Cloud9 IDE のターミナルセッションで、最新のセキュリティ更新プログラムとバグ修正がインストールされていることを確認します。これを行うには、 yum update (Amazon Linux 用)または apt update コマンド (Ubuntu Server 用) を実行します。(新しいターミナルセッションを開始するには、メニューバーで、［Window (ウィンドウ)］、［New Terminal (新しいターミナル)］の順に選択します。)

Amazon Linux の場合:

sudo yum -y update

Ubuntu Server の場合:

sudo apt update

nvm がインストール済みであるかどうかを確認します。これを行うには、 --version オプションを使用して nvm コマンドを実行します。

nvm --version

成功すると、出力に nvm バージョン番号が表示されます。この場合、「ステップ 1.2: Node.js をインストールする」までスキップできます。

nvm をダウンロードしてインストールします。これを行うには、インストールスクリプトを実行します。この例では、v0.33.0 がインストールされていますが、nvm の最新バージョンはこちらで確認できます。

curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.0/install.sh | bash

nvm の使用を開始します。ターミナルセッションを閉じて再起動するか nvm をロードするコマンドを含む ~/.bashrc ファイルを入手してください。

. ~/.bashrc

Node.js がインストール済みであるかどうかを確認します。インストール済みである場合は、そのバージョンが 16.17.0 以上であることを確認します。このサンプルは Node.js 16.17.0 を使用してテスト済みです。IDE でターミナルセッションがまだ開いている状態でチェックするには、 --version オプションと共に node コマンドを実行します。

node --version

Node.js がインストール済みである場合は、出力にバージョン番号が表示されます。バージョン番号が v16.17.0 である場合は、「ステップ 1.3: TypeScript をインストールする」に進みます。

nvm コマンドを install アクションと共に実行して、Node.js 16 をインストールします。

nvm install v16

Node.js 16 の使用を開始します。これを行うには、nvm コマンドを実行します。次のように alias アクション、エイリアスを作成するバージョン番号、このエイリアスで使用するバージョンを指定します。

nvm alias default 16

Node.js 16 を使用していることを確認するには、node --version コマンドを再度実行します。正しいバージョンをインストールしている場合は、出力にバージョン v16 と表示されます。

TypeScript がインストール済みであるかどうかを確認します。これを行うには、IDE でターミナルセッションがまだ開いている状態で、 --version オプションを使ってコマンドライン TypeScript コンパイラーを実行します。

tsc --version

TypeScript がインストール済みである場合は、出力に TypeScript のバージョン番号が表示されます。TypeScript がインストール済みである場合は、手順 1.4: AWS CDK をインストールする に進みます。

TypeScript をインストールします。これを行うには、install アクション、-g オプション、および TypeScript パッケージの名前を指定して npm コマンドを実行します。これにより、TypeScript がグローバルパッケージとして環境 にインストールされます。

npm install -g typescript

TypeScript がインストールされていることを確認します。これを行うには、--version オプションを使用してコマンドライン TypeScript コンパイラーを実行します。

tsc --version

TypeScript がインストール済みである場合は、出力に TypeScript のバージョン番号が表示されます。

AWS CDK がインストール済みであるかどうかを確認します。これを行うには、IDE でターミナルセッションがまだ開いている状態で、 --version オプションを使って、 cdk コマンドを実行します。

cdk --version

AWS CDK がインストール済みである場合は、出力に AWS CDK のバージョン番号とビルド番号が表示されます。ステップ 2: コードを追加する に進んでください。

AWS CDK をインストールするには、npm コマンドを実行し、その際 install アクション、インストールする AWS CDK パッケージの名前、環境でグローバルにパッケージをインストールするための -g オプションを使用します。

npm install -g aws-cdk

AWS CDK がインストールされ、正しく参照されていることを確認します。これを行うには、 --version オプションを使用して cdk コマンドを実行します。

cdk --version

成功すると、AWS CDK のバージョン番号とビルド番号が表示されます。

IDE でターミナルセッションがまだ開いている状態で、プロジェクトのソースコードを保存するディレクトリ (例: ~/environment/hello-cdk ディレクトリ) を環境に作成します。次に、このディレクトリに切り替えます。

rm -rf ~/environment/hello-cdk # Remove this directory if it already exists.
mkdir ~/environment/hello-cdk  # Create the directory.
cd ~/environment/hello-cdk     # Switch to the directory.

このディレクトリを、AWS CDK の TypeScript 言語プロジェクトとして設定します。これを行うには、init アクション、sample-app テンプレート、--language オプション、およびプログラミング言語の名前を指定して cdk コマンドを実行します。

cdk init sample-app --language typescript

これにより、ディレクトリ内に以下のファイルとサブディレクトリが作成されます。

[Environment (環境)] ウィンドウで、lib/hello-cdk-stack.ts ファイルを開き、このファイル内で次のコードを参照します。

import sns = require('@aws-cdk/aws-sns');
import sqs = require('@aws-cdk/aws-sqs');
import cdk = require('@aws-cdk/cdk');

export class HelloCdkStack extends cdk.Stack {
  constructor(parent: cdk.App, name: string, props?: cdk.StackProps) {
    super(parent, name, props);

    const queue = new sqs.Queue(this, 'HelloCdkQueue', {
      visibilityTimeoutSec: 300
    });

    const topic = new sns.Topic(this, 'HelloCdkTopic');

    topic.subscribeQueue(queue);
  }
}

[Environment (環境)] ウィンドウで、bin/hello-cdk.ts ファイルを開き、このファイル内で次のコードを参照します。

#!/usr/bin/env node
import cdk = require('@aws-cdk/cdk');
import { HelloCdkStack } from '../lib/hello-cdk-stack';

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

このコードは、lib/hello-cdk-stack.ts の HelloCdkStack クラスをロードし、インスタンス化して、実行します。

npm を使用して TypeScript コンパイラーを実行し、コーディングエラーをチェックします。次に、AWS CDK を有効にしてプロジェクトの bin/hello-cdk.js ファイルを実行します。これを行うには、プロジェクトのルートディレクトリから、npm コマンドを run アクションで実行します。build コマンドの値は package.json ファイルで次のように指定します。

npm run build

上のコマンドは、TypeScript コンパイラーを実行します。このコンパイラーは、bin/hello-cdk.d.ts ファイルと lib/hello-cdk-stack.d.ts ファイルのサポートを追加します。また、このコンパイラーは、hello-cdk.js ファイルおよび hello-cdk-stack.js ファイルを、hello-cdk.ts ファイルおよび hello-cdk-stack.ts ファイルとしてトランスパイルします。

AWS CDK で AWS CloudFormation スタックテンプレートを作成します。これを行うには、 IDE でターミナルセッションがまだ開いている状態で、プロジェクトのルートディレクトリから、 synth アクションとスタック名を使って、 cdk コマンドを実行します。

cdk synth HelloCdkStack

成功すると、出力に AWS CloudFormation スタックテンプレートの Resources セクションが表示されます。

AWS CDK アプリケーションを、特定の AWS アカウントおよび AWS リージョンを組み合わせた環境に初めてデプロイする場合は、ブートストラップスタックをインストールする必要があります。このスタックには、AWS CDK でさまざまなオペレーションを実行するために必要な各種リソースが含まれています。例えば、このスタックには、デプロイプロセス中にテンプレートとアセットを保存するため AWS CDK が使用する Amazon S3 バケットが含まれます。ブートストラップスタックをインストールするには、 cdk コマンドを bootstrap アクションと共に実行します。

cdk bootstrap

cdk bootstrap --profile test 123456789012/us-east-1

AWS CDK で AWS CloudFormation スタックテンプレートを実行してスタックをデプロイします。これを行うには、プロジェクトのルートディレクトリから、cdk コマンドに deploy アクションとスタック名を指定して実行します。

cdk deploy HelloCdkStack

成功すると、エラーなしでデプロイされた HelloCdkStack スタックが出力に表示されます。

Amazon SNS トピックと Amazon SQS キューが正常にデプロイされたことを確認するには、トピックにメッセージを送信し、キューでメッセージが受信されたことをチェックします。これを行うには、AWS Command Line Interface (AWS CLI) や AWS CloudShell などのツールを使用できます。これらのツールの詳細については、AWS Cloud9 に関する AWS Command Line Interface および aws-shell のチュートリアル を参照してください。

たとえば、トピックにメッセージを送信するには、IDE でターミナルセッションがまだ開いている状態で、AWS CLI を使用して Amazon SNS publish コマンドを実行します。次のように、メッセージの件名と本文、トピックの AWS リージョン、トピックの Amazon リソースネーム (ARN) を指定します。

aws sns publish --subject "Hello from the AWS CDK" --message "This is a message from the AWS CDK." --topic-arn arn:aws:sns:us-east-2:123456789012:HelloCdkStack-HelloCdkTopic1A234567-8BCD9EFGHIJ0K

上のコマンドで、arn:aws:sns:us-east-2:123456789012:HelloCdkStack-HelloCdkTopic1A234567-8BCD9EFGHIJ0K は、AWS CloudFormation がトピックに割り当てる ARN に置き換えてください。この ID を取得するには、Amazon SNS list-topics コマンドを実行できます。

aws sns list-topics --output table --query 'Topics[*].TopicArn'

成功すると、publish コマンドの出力に、発行されたメッセージの MessageId 値が表示されます。

キューでメッセージが受信されたことをチェックするには、Amazon SQS receive-message コマンドを実行して、キューの URL を提供します。

aws sqs receive-message --queue-url https://queue.amazonaws.com/123456789012/HelloCdkStack-HelloCdkQueue1A234567-8BCD9EFGHIJ0K

上のコマンドで、https://queue.amazonaws.com/123456789012/HelloCdkStack-HelloCdkQueue1A234567-8BCD9EFGHIJ0K は、AWS CloudFormation がキューに割り当てる ARN に置き換えてください。この URL を取得するため、 Amazon SQS list-queues コマンドを実行できます。

aws sqs list-queues --output table --query 'QueueUrls[*]'

成功すると、receive-message コマンドの出力に、受信されたメッセージの情報が表示されます。