CDK Construct for creating an Amazon Linux EC2 instance with pre-installed software
Project description
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.
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'
);
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file cdk_preinstalled_amazon_linux_ec2-0.0.11.tar.gz
.
File metadata
- Download URL: cdk_preinstalled_amazon_linux_ec2-0.0.11.tar.gz
- Upload date:
- Size: 45.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 340eacbe0488665045427bbeedd8f713152f5a0dd5957fac35f0d1f9e69630f4 |
|
MD5 | 3bf64e805ee35b9bc2f729af84041aee |
|
BLAKE2b-256 | d07bb40885bcd007642c53aa7742029b83e41946ec46edeb234016179979b0db |
File details
Details for the file cdk_preinstalled_amazon_linux_ec2-0.0.11-py3-none-any.whl
.
File metadata
- Download URL: cdk_preinstalled_amazon_linux_ec2-0.0.11-py3-none-any.whl
- Upload date:
- Size: 43.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 89a1159b3b5b3cfb7bc9472705c8853b26b8cdfd624a45626f4cf46314910ce7 |
|
MD5 | ea41cd51b4b41005310d4b0230acbf5e |
|
BLAKE2b-256 | 76584ff64e8165e2a68f8fc89176065c7e2dd84332a2bc7a69bb87f0a5c5e75a |