Package software.amazon.awscdk.services.ec2

Interface BastionHostLinuxProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
BastionHostLinuxProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2025-01-15T21:09:17.672Z") @Stability(Stable) public interface BastionHostLinuxProps extends software.amazon.jsii.JsiiSerializable
Properties of the bastion host.

Example: 

 BastionHostLinux host = BastionHostLinux.Builder.create(this, "BastionHost")
         .vpc(vpc)
         .blockDevices(List.of(BlockDevice.builder()
                 .deviceName("/dev/sdh")
                 .volume(BlockDeviceVolume.ebs(10, EbsDeviceOptions.builder()
                         .encrypted(true)
                         .build()))
                 .build()))
         .build();

  • Method Details

    • getVpc

      @Stability(Stable) @NotNull IVpc getVpc()
      VPC to launch the instance in.

    • getAvailabilityZone

      @Stability(Stable) @Nullable default String getAvailabilityZone()
      In which AZ to place the instance within the VPC.

      Default: - Random zone.

    • getBlockDevices

      @Stability(Stable) @Nullable default List<BlockDevice> getBlockDevices()
      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

      See Also:

    • getInit

      @Stability(Stable) @Nullable default CloudFormationInit getInit()
      Apply the given CloudFormation Init configuration to the instance at startup.

      Default: - no CloudFormation init

    • getInitOptions

      @Stability(Stable) @Nullable default ApplyCloudFormationInitOptions getInitOptions()
      Use the given options for applying CloudFormation Init.

      Describes the configsets to use and the timeout to wait

      Default: - default options

    • getInstanceName

      @Stability(Stable) @Nullable default String getInstanceName()
      The name of the instance.

      Default: 'BastionHost'

    • getInstanceType

      @Stability(Stable) @Nullable default InstanceType getInstanceType()
      Type of instance to launch.

      Default: 't3.nano'

    • getMachineImage

      @Stability(Stable) @Nullable default IMachineImage getMachineImage()
      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.

    • getRequireImdsv2

      @Stability(Stable) @Nullable default Boolean getRequireImdsv2()
      Whether IMDSv2 should be required on this instance.

      Default: - false

    • getSecurityGroup

      @Stability(Stable) @Nullable default ISecurityGroup getSecurityGroup()
      Security Group to assign to this instance.

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

    • getSubnetSelection

      @Stability(Stable) @Nullable default SubnetSelection getSubnetSelection()
      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

    • getUserDataCausesReplacement

      @Stability(Stable) @Nullable default Boolean getUserDataCausesReplacement()
      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`.

    • builder

      @Stability(Stable) static BastionHostLinuxProps.Builder builder()
      Returns:
      a BastionHostLinuxProps.Builder of BastionHostLinuxProps