software.amazon.awscdk.services.ec2

Class BastionHostLinux.Builder

java.lang.Object

software.amazon.awscdk.services.ec2.BastionHostLinux.Builder

Enclosing class:

BastionHostLinux

public static final class BastionHostLinux.Builder
extends java.lang.Object

A fluent builder for BastionHostLinux.

Method Summary

Modifier and Type	Method and Description
BastionHostLinux.Builder	availabilityZone(java.lang.String availabilityZone) In which AZ to place the instance within the VPC.
BastionHostLinux.Builder	blockDevices(java.util.List<? extends BlockDevice> blockDevices) Specifies how block devices are exposed to the instance.
BastionHostLinux	build()
static BastionHostLinux.Builder	create(software.constructs.Construct scope, java.lang.String id)
BastionHostLinux.Builder	init(CloudFormationInit init) Apply the given CloudFormation Init configuration to the instance at startup.
BastionHostLinux.Builder	initOptions(ApplyCloudFormationInitOptions initOptions) Use the given options for applying CloudFormation Init.
BastionHostLinux.Builder	instanceName(java.lang.String instanceName) The name of the instance.
BastionHostLinux.Builder	instanceType(InstanceType instanceType) Type of instance to launch.
BastionHostLinux.Builder	machineImage(IMachineImage machineImage) The machine image to use, assumed to have SSM Agent preinstalled.
BastionHostLinux.Builder	requireImdsv2(java.lang.Boolean requireImdsv2) Whether IMDSv2 should be required on this instance.
BastionHostLinux.Builder	securityGroup(ISecurityGroup securityGroup) Security Group to assign to this instance.
BastionHostLinux.Builder	subnetSelection(SubnetSelection subnetSelection) Select the subnets to run the bastion host in.
BastionHostLinux.Builder	vpc(IVpc vpc) VPC to launch the instance in.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static BastionHostLinux.Builder create(software.constructs.Construct scope,
                                              java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of BastionHostLinux.Builder.

vpc

public BastionHostLinux.Builder vpc(IVpc vpc)

VPC to launch the instance in.

Parameters:

vpc - VPC to launch the instance in. This parameter is required.

Returns:

this

availabilityZone

public BastionHostLinux.Builder availabilityZone(java.lang.String availabilityZone)

In which AZ to place the instance within the VPC.

Default: - Random zone.

Parameters:

availabilityZone - In which AZ to place the instance within the VPC. This parameter is required.

Returns:

this

blockDevices

public BastionHostLinux.Builder blockDevices(java.util.List<? extends BlockDevice> blockDevices)

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

Parameters:

blockDevices - Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html

init

public BastionHostLinux.Builder init(CloudFormationInit init)

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

Default: - no CloudFormation init

Parameters:

init - Apply the given CloudFormation Init configuration to the instance at startup. This parameter is required.

Returns:

this

initOptions

public BastionHostLinux.Builder initOptions(ApplyCloudFormationInitOptions initOptions)

Use the given options for applying CloudFormation Init.

Describes the configsets to use and the timeout to wait

Default: - default options

Parameters:

initOptions - Use the given options for applying CloudFormation Init. This parameter is required.

Returns:

this

instanceName

public BastionHostLinux.Builder instanceName(java.lang.String instanceName)

The name of the instance.

Default: 'BastionHost'

Parameters:

instanceName - The name of the instance. This parameter is required.

Returns:

this

instanceType

public BastionHostLinux.Builder instanceType(InstanceType instanceType)

Type of instance to launch.

Default: 't3.nano'

Parameters:

instanceType - Type of instance to launch. This parameter is required.

Returns:

this

machineImage

public BastionHostLinux.Builder machineImage(IMachineImage machineImage)

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

Default: - An Amazon Linux 2 image which is kept up-to-date automatically (the instance may be replaced on every deployment) and already has SSM Agent installed.

Parameters:

machineImage - The machine image to use, assumed to have SSM Agent preinstalled. This parameter is required.

Returns:

this

requireImdsv2

public BastionHostLinux.Builder requireImdsv2(java.lang.Boolean requireImdsv2)

Whether IMDSv2 should be required on this instance.

Default: - false

Parameters:

requireImdsv2 - Whether IMDSv2 should be required on this instance. This parameter is required.

Returns:

this

securityGroup

public BastionHostLinux.Builder securityGroup(ISecurityGroup securityGroup)

Security Group to assign to this instance.

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

Parameters:

securityGroup - Security Group to assign to this instance. This parameter is required.

Returns:

this

subnetSelection

public BastionHostLinux.Builder subnetSelection(SubnetSelection 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

Parameters:

subnetSelection - Select the subnets to run the bastion host in. This parameter is required.

Returns:

this

build

public BastionHostLinux build()