software.amazon.awscdk.services.ec2

Class BastionHostLinux

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.ec2.BastionHostLinux

All Implemented Interfaces:

IResource, IConnectable, IInstance, IGrantable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.106Z")
 @Stability(value=Stable)
public class BastionHostLinux
extends Resource
implements IInstance

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

Example:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BastionHostLinux.Builder A fluent builder for BastionHostLinux.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.IInstance

IInstance.Jsii$Default, IInstance.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	BastionHostLinux(software.constructs.Construct scope, String id, BastionHostLinuxProps props)
protected	BastionHostLinux(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	BastionHostLinux(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	allowSshAccessFrom(IPeer... peer) Allow SSH access from the given peer or peers.
Connections	getConnections() Allows specify security group connections for the instance.
IPrincipal	getGrantPrincipal() The principal to grant permissions to.
Instance	getInstance() The underlying instance resource.
String	getInstanceAvailabilityZone() The availability zone the instance was launched in.
String	getInstanceId() The instance's ID.
String	getInstancePrivateDnsName() Private DNS name for this instance.
String	getInstancePrivateIp() Private IP for this instance.
String	getInstancePublicDnsName() Publicly-routable DNS name for this instance.
String	getInstancePublicIp() Publicly-routable IP address for this instance.
IRole	getRole() The IAM role assumed by the instance.
Stack	getStack() The stack in which this resource is defined.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

BastionHostLinux

protected BastionHostLinux(software.amazon.jsii.JsiiObjectRef objRef)

BastionHostLinux

protected BastionHostLinux(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

BastionHostLinux

@Stability(value=Stable)
public BastionHostLinux(@NotNull
                                                 software.constructs.Construct scope,
                                                 @NotNull
                                                 String id,
                                                 @NotNull
                                                 BastionHostLinuxProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

allowSshAccessFrom

@Stability(value=Stable)
public void allowSshAccessFrom(@NotNull
                                                        IPeer... peer)

Allow SSH access from the given peer or peers.

Necessary if you want to connect to the instance using ssh. If not called, you should use SSM Session Manager to connect to the instance.

Parameters:

peer - This parameter is required.

getConnections

@Stability(value=Stable)
 @NotNull
public Connections getConnections()

Allows specify security group connections for the instance.

Specified by:

getConnections in interface IConnectable

getGrantPrincipal

@Stability(value=Stable)
 @NotNull
public IPrincipal getGrantPrincipal()

The principal to grant permissions to.

Specified by:

getGrantPrincipal in interface IGrantable

getInstance

@Stability(value=Stable)
 @NotNull
public Instance getInstance()

The underlying instance resource.

getInstanceAvailabilityZone

@Stability(value=Stable)
 @NotNull
public String getInstanceAvailabilityZone()

The availability zone the instance was launched in.

Specified by:

getInstanceAvailabilityZone in interface IInstance

getInstanceId

@Stability(value=Stable)
 @NotNull
public String getInstanceId()

The instance's ID.

Specified by:

getInstanceId in interface IInstance

getInstancePrivateDnsName

@Stability(value=Stable)
 @NotNull
public String getInstancePrivateDnsName()

Private DNS name for this instance.

Specified by:

getInstancePrivateDnsName in interface IInstance

getInstancePrivateIp

@Stability(value=Stable)
 @NotNull
public String getInstancePrivateIp()

Private IP for this instance.

Specified by:

getInstancePrivateIp in interface IInstance

getInstancePublicDnsName

@Stability(value=Stable)
 @NotNull
public String getInstancePublicDnsName()

Publicly-routable DNS name for this instance.

(May be an empty string if the instance does not have a public name).

Specified by:

getInstancePublicDnsName in interface IInstance

getInstancePublicIp

@Stability(value=Stable)
 @NotNull
public String getInstancePublicIp()

Publicly-routable IP address for this instance.

(May be an empty string if the instance does not have a public IP).

Specified by:

getInstancePublicIp in interface IInstance

getRole

@Stability(value=Stable)
 @NotNull
public IRole getRole()

The IAM role assumed by the instance.

getStack

@Stability(value=Stable)
 @NotNull
public Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Overrides:

getStack in class Resource