Package software.amazon.awscdk.services.ec2

Class BastionHostLinux.Builder

java.lang.Object
software.amazon.awscdk.services.ec2.BastionHostLinux.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<BastionHostLinux>
Enclosing class:
BastionHostLinux
@Stability(Stable) public static final class BastionHostLinux.Builder extends Object implements software.amazon.jsii.Builder<BastionHostLinux>
A fluent builder for BastionHostLinux.

  • Method Details

    • create

      @Stability(Stable) public static BastionHostLinux.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of BastionHostLinux.Builder.

    • vpc

      @Stability(Stable) 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

      @Stability(Stable) public BastionHostLinux.Builder availabilityZone(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

      @Stability(Stable) public BastionHostLinux.Builder blockDevices(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:

    • init

      @Stability(Stable) 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

      @Stability(Stable) 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

      @Stability(Stable) public BastionHostLinux.Builder instanceName(String instanceName)
      The name of the instance.

      Default: 'BastionHost'

      Parameters:
      instanceName - The name of the instance. This parameter is required.
      Returns:
      this

    • instanceType

      @Stability(Stable) 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

      @Stability(Stable) public BastionHostLinux.Builder machineImage(IMachineImage machineImage)
      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.

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

    • requireImdsv2

      @Stability(Stable) public BastionHostLinux.Builder requireImdsv2(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

      @Stability(Stable) 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

      @Stability(Stable) 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

    • userDataCausesReplacement

      @Stability(Stable) public BastionHostLinux.Builder userDataCausesReplacement(Boolean userDataCausesReplacement)
      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`.

      Parameters:
      userDataCausesReplacement - Determines whether changes to the UserData will force instance replacement. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public BastionHostLinux build()
      Specified by:
      build in interface software.amazon.jsii.Builder<BastionHostLinux>
      Returns:
      a newly built instance of BastionHostLinux.