AWS Fundamentals Logo
AWS Fundamentals
L2 Construct

BastionHostLinux

This creates a linux bastion host you can use to connect to other instances or services in your VPC. The recommended way to connect to the bastion host is by using AWS Systems Manager Session Manager. The operating system is Amazon Linux 2 with the latest SSM agent installed You can also configure this bastion host to allow connections via SSH

Import

import { BastionHostLinux } from 'aws-cdk-lib/aws-ec2';

Or use the module namespace:

import * as ec2 from 'aws-cdk-lib/aws-ec2';
// ec2.BastionHostLinux

Properties

Configuration passed to the constructor as BastionHostLinuxProps.

vpcRequired
IVpc

VPC to launch the instance in.

availabilityZoneOptional
string

In which AZ to place the instance within the VPC.

Default: - Random zone.

blockDevicesOptional
BlockDevice[]

Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes. Each instance that is launched has an associated root device volume, either an Amazon EBS volume or an instance store volume. You can use block device mappings to specify additional EBS volumes or instance store volumes to attach to an instance when it is launched.

Default: - Uses the block device mapping of the AMI

initOptional
CloudFormationInit

Apply the given CloudFormation Init configuration to the instance at startup.

Default: - no CloudFormation init

initOptionsOptional
ApplyCloudFormationInitOptions

Use the given options for applying CloudFormation Init. Describes the configsets to use and the timeout to wait

Default: - default options

instanceNameOptional
string

The name of the instance.

Default: 'BastionHost'

instanceTypeOptional
InstanceType

Type of instance to launch.

Default: 't3.nano'

machineImageOptional
IMachineImage

The machine image to use, assumed to have SSM Agent preinstalled.

Default: - An Amazon Linux 2023 image if the `@aws-cdk/aws-ec2:bastionHostUseAmazonLinux2023ByDefault` feature flag is enabled. Otherwise, an Amazon Linux 2 image. In both cases, the image is kept up-to-date automatically (the instance may be replaced on every deployment) and already has SSM Agent installed.

requireImdsv2Optional
boolean

Whether IMDSv2 should be required on this instance.

Default: - false

securityGroupOptional
ISecurityGroup

Security Group to assign to this instance.

Default: - create new security group with no inbound and all outbound traffic allowed

subnetSelectionOptional
SubnetSelection

Select the subnets to run the bastion host in. Set this to PUBLIC if you need to connect to this instance via the internet and cannot use SSM. You have to allow port 22 manually by using the connections field

Default: - private subnets of the supplied VPC

userDataCausesReplacementOptional
boolean

Determines whether changes to the UserData will force instance replacement. Depending on the EC2 instance type, modifying the UserData may either restart or replace the instance: - Instance store-backed instances are replaced. - EBS-backed instances are restarted. Note that by default, restarting does not execute the updated UserData, so an alternative mechanism is needed to ensure the instance re-executes the UserData. When set to `true`, the instance's Logical ID will depend on the UserData, causing CloudFormation to replace the instance if the UserData changes.

Default: - `true` if `initOptions` is specified, otherwise `false`.

Get the Amazon EC2 Cheat Sheet

Everything you need to know about Amazon EC2 on one page. HD quality, print-friendly.

Download Free Infographic