Skip to main content

CDK Preinstalled Amazon Linux EC2 Instance Construct

This is a CDK Construct for creating a preinstalled AmazonLinux EC2 instance.

You can use Node.js, Visual Studio Code, git and other software as soon as the EC2 instance starts.

View on Construct Hub

Open in Visual Studio Code npm version Build Status Release Status License npm downloads

Usage

Install the package:

npm install cdk-preinstalled-amazon-linux-ec2

Use it in your CDK stack:

import { PreinstalledAmazonLinuxInstance } from 'cdk-preinstalled-amazon-linux-ec2';
import * as ec2 from 'aws-cdk-lib/aws-ec2';

declare const vpc: ec2.IVpc;

// You can configure all properties of the EC2 instance
new PreinstalledAmazonLinuxInstance(this, 'Instance', {
  vpc,
  instanceType: ec2.InstanceType.of(ec2.InstanceClass.T3, ec2.InstanceSize.NANO),
  machineImage: new ec2.AmazonLinuxImage({
    generation: ec2.AmazonLinuxGeneration.AMAZON_LINUX_2023,
  }),
  // Specify preinstalled software
  preinstalledSoftware: {
    packages: [
      PreinstalledSoftwareType.NODEJS,
      PreinstalledSoftwareType.VSCODE,
      PreinstalledSoftwareType.GIT,
    ],
    others: ['rsyslog'], // You can specify other software packages. These parameters are used as `sudo dnf install ${parameter}`
});

After the stack is deployed, you can SSH into the EC2 instance and use Node.js:

$ ssh ec2-user@<public-ip>
$ node --version
v20.13.1
$ code --version
1.89.1
$ git --version
git version 2.39.3

user data

Installation of software is done by user data script. You can see the script in the src/index.ts file.

// Install Node.js
userData.addCommands(
  'touch ~/.bashrc',
  'curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash',
  'source ~/.bashrc',
  'export NVM_DIR="$HOME/.nvm"',
  '[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"',
  `nvm install ${props.nodeJsVersion ?? '--lts'}`,
  // Note that the above will install nvm, node and npm for the root user.
  // It will not add the correct ENV VAR in ec2-user's environment.
  `cat <<EOF >> /home/ec2-user/.bashrc
export NVM_DIR="/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
EOF`);

Ofcourse, you can customize the additional user data script by calling instance.userData.addCommands() method.

declare const instance: PreinstalledAmazonLinuxInstance;

// install yarn
instance.userData.addCommands(
  'npm install -g yarn'
);

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cdk_preinstalled_amazon_linux_ec2-0.0.15.tar.gz (46.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file cdk_preinstalled_amazon_linux_ec2-0.0.15.tar.gz.

File metadata

File hashes

Hashes for cdk_preinstalled_amazon_linux_ec2-0.0.15.tar.gz
Algorithm Hash digest
SHA256 203f05101ed2d63150c76e6d186ffb48d254bd651d29df43e927aec9b08474a3
MD5 7e0fa5919cd6489a9cdfb2315dfae41e
BLAKE2b-256 77b7399a72e1b4068dea5a224cb15152012f0c16c81e7b527dd942fd31c99851

See more details on using hashes here.

Provenance

The following attestation bundles were made for cdk_preinstalled_amazon_linux_ec2-0.0.15.tar.gz:

Publisher: release.yml on badmintoncryer/cdk-preinstalled-amazon-linux-ec2

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cdk_preinstalled_amazon_linux_ec2-0.0.15-py3-none-any.whl.

File metadata

File hashes

Hashes for cdk_preinstalled_amazon_linux_ec2-0.0.15-py3-none-any.whl
Algorithm Hash digest
SHA256 6fcd3619d54c9c3187c4b4225a10d662f8ee6801fb9133d2b61414603dc7bec8
MD5 7a2faa61cfd91c22bf84a0d876b3f3c2
BLAKE2b-256 08156bb8efefbab6aaebf13e856aad34661afad522f4cf144fe4692a4047c223

See more details on using hashes here.

Provenance

The following attestation bundles were made for cdk_preinstalled_amazon_linux_ec2-0.0.15-py3-none-any.whl:

Publisher: release.yml on badmintoncryer/cdk-preinstalled-amazon-linux-ec2

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.0.15 This release

2 files

0.0.14

2 files

0.0.13

2 files

0.0.12

2 files

0.0.11

2 files

0.0.10

2 files

0.0.9

2 files

0.0.8

2 files

0.0.7

2 files

0.0.6

2 files

0.0.5

2 files

0.0.4

2 files

0.0.3

2 files

0.0.2

2 files

0.0.1

2 files

0.0.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page