AWS CDK tutorial for AWS Cloud9

In a terminal session in the AWS Cloud9 IDE, ensure the latest security updates and bug fixes are installed. To do this, run the yum update (for Amazon Linux) or apt update command (for Ubuntu Server). (To start a new terminal session, on the menu bar, choose Window, New Terminal.)

For Amazon Linux:

sudo yum -y update

For Ubuntu Server:

sudo apt update

Confirm whether nvm is already installed. To do this, run the nvm command with the --version option.

nvm --version

If successful, the output contains the nvm version number, and you can skip ahead to Step 1.2: Install Node.js.

Download and install nvm . To do this, run the install script. In this example, v0.33.0 is installed, but you can check for the latest version of nvm here.

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

Start using nvm . You can either close the terminal session and then restart it, or source the ~/.bashrc file that contains the commands to load nvm .

. ~/.bashrc

Confirm whether you already have Node.js installed, and if you do, confirm that the installed version is 16.17.0 or greater. This sample has been tested with Node.js 16.17.0. To check, with the terminal session still open in the IDE, run the node command with the --version option.

node --version

If you do have Node.js installed, the output contains the version number. If the version number is v16.17.0 skip ahead to Step 1.3: Install TypeScript.

Install Node.js 16 by running the nvm command with the install action.

nvm install v16

Start using Node.js 16. To do this, run the nvm command with the alias action, the version number to alias, and the version to use for that alias, as follows.

nvm alias default 16

To confirm that you're using Node.js 16 run the node --version command again. If the correct version is installed, the output contains version v16.

Confirm whether you already have TypeScript installed. To do this, with the terminal session still open in the IDE, run the command line TypeScript compiler with the --version option.

tsc --version

If you do have TypeScript installed, the output contains the TypeScript version number. If TypeScript is installed, skip ahead to Step 1.4: Install the AWS CDK.

Install TypeScript. To do this, run the npm command with the install action, the -g option, and the name of the TypeScript package. This installs TypeScript as a global package in the environment.

npm install -g typescript

Confirm that TypeScript is installed. To do this, run the command line TypeScript compiler with the --version option.

tsc --version

If TypeScript is installed, the output contains the TypeScript version number.

Confirm whether you already have the AWS CDK installed. To do this, with the terminal session still open in the IDE, run the cdk command with the --version option.

cdk --version

If the AWS CDK is installed, the output contains the AWS CDK version and build numbers. Skip ahead to Step 2: Add code.

Install the AWS CDK by running the npm command along with the install action, the name of the AWS CDK package to install, and the -g option to install the package globally in the environment.

npm install -g aws-cdk

Confirm that the AWS CDK is installed and correctly referenced. To do this, run the cdk command with the --version option.

cdk --version

If successful, the AWS CDK version and build numbers are displayed.

With the terminal session still open in the IDE, create a directory to store the project's source code, for example a ~/environment/hello-cdk directory in your environment. Then switch to that directory.

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.

Set up the directory as a TypeScript language project for the AWS CDK. To do this, run the cdk command with the init action, the sample-app template, and the --language option along with the name of the programming language.

cdk init sample-app --language typescript

This creates the following files and subdirectories in the directory.

In the Environment window, open the lib/hello-cdk-stack.ts file, and browse the following code in that file.

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

In the Environment window, open the bin/hello-cdk.ts file, and browse the following code in that file.

#!/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();

This code loads, instantiates, and then runs the HelloCdkStack class from the lib/hello-cdk-stack.ts file.

Use npm to run the TypeScript compiler to check for coding errors, and then enable the AWS CDK to execute the project's bin/hello-cdk.js file. To do this, from the project's root directory, run the npm command with the run action, specifying the build command value in the package.json file, as follows.

npm run build

The preceding command runs the TypeScript compiler, which adds supporting bin/hello-cdk.d.ts and lib/hello-cdk-stack.d.ts files. The compiler also transpiles the hello-cdk.ts and hello-cdk-stack.ts files into hello-cdk.js and hello-cdk-stack.js files.

Have the AWS CDK create the AWS CloudFormation stack template. To do this, with the terminal session still open in the IDE, from the project's root directory, run the cdk command with the synth action and the name of the stack.

cdk synth HelloCdkStack

If successful, the output displays the AWS CloudFormation stack template's Resources section.

The first time that you deploy an AWS CDK app into an environment for a specific AWS account and AWS Region combination, you must install a bootstrap stack. This stack includes various resources that the AWS CDK needs to complete its various operations. For example, this stack includes an Amazon S3 bucket that the AWS CDK uses to store templates and assets during its deployment processes. To install the bootstrap stack, run the cdk command with the bootstrap action.

cdk bootstrap

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

Have the AWS CDK run the AWS CloudFormation stack template to deploy the stack. To do this, from the project's root directory, run the cdk command with the deploy action and the name of the stack.

cdk deploy HelloCdkStack

If successful, the output displays that the HelloCdkStack stack deployed without errors.

To confirm that the Amazon SNS topic and Amazon SQS queue were successfully deployed, send a message to the topic, and then check the queue for the received message. To do this, you can use a tool such as the AWS Command Line Interface (AWS CLI) or the AWS CloudShell. For more information about these tools, see the AWS CLI and aws-shell tutorial for AWS Cloud9.

For example, to send a message to the topic, with the terminal session still open in the IDE, use the AWS CLI to run the Amazon SNS publish command, supplying the message's subject and body, the AWS Region for the topic, and the topic's Amazon Resource Name (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

In the preceding command, replace arn:aws:sns:us-east-2:123456789012:HelloCdkStack-HelloCdkTopic1A234567-8BCD9EFGHIJ0K with the ARN that AWS CloudFormation assigns to the topic. To get the ID, you can run the Amazon SNS list-topics command.

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

If successful, the output of the publish command displays the MessageId value for the message that was published.

To check the queue for the received message, run the Amazon SQS receive-message command, supplying the queue's URL.

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

In the preceding command, replace https://queue.amazonaws.com/123456789012/HelloCdkStack-HelloCdkQueue1A234567-8BCD9EFGHIJ0K with the ARN that AWS CloudFormation assigns to the queue. To get the URL, you can run the Amazon SQS list-queues command.

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

If successful, the output of the receive-message command displays information about the message that was received.