BastionHostLinux¶
-
class
aws_cdk.aws_ec2.
BastionHostLinux
(scope, id, *, vpc, availability_zone=None, block_devices=None, init=None, init_options=None, instance_name=None, instance_type=None, machine_image=None, require_imdsv2=None, security_group=None, subnet_selection=None)¶ Bases:
aws_cdk.core.Resource
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
- ExampleMetadata
fixture=with-vpc infused
- Resource
AWS::EC2::Instance
Example:
host = ec2.BastionHostLinux(self, "BastionHost", vpc=vpc, block_devices=[ec2.BlockDevice( device_name="EBSBastionHost", volume=ec2.BlockDeviceVolume.ebs(10, encrypted=True ) )] )
- Parameters
scope (
Construct
) –id (
str
) –vpc (
IVpc
) – VPC to launch the instance in.availability_zone (
Optional
[str
]) – In which AZ to place the instance within the VPC. Default: - Random zone.block_devices (
Optional
[Sequence
[Union
[BlockDevice
,Dict
[str
,Any
]]]]) – 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 AMIinit (
Optional
[CloudFormationInit
]) – Apply the given CloudFormation Init configuration to the instance at startup. Default: - no CloudFormation initinit_options (
Union
[ApplyCloudFormationInitOptions
,Dict
[str
,Any
],None
]) – Use the given options for applying CloudFormation Init. Describes the configsets to use and the timeout to wait Default: - default optionsinstance_name (
Optional
[str
]) – The name of the instance. Default: ‘BastionHost’instance_type (
Optional
[InstanceType
]) – Type of instance to launch. Default: ‘t3.nano’machine_image (
Optional
[IMachineImage
]) – 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.require_imdsv2 (
Optional
[bool
]) – Whether IMDSv2 should be required on this instance. Default: - falsesecurity_group (
Optional
[ISecurityGroup
]) – Security Group to assign to this instance. Default: - create new security group with no inbound and all outbound traffic allowedsubnet_selection (
Union
[SubnetSelection
,Dict
[str
,Any
],None
]) – 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
Methods
-
allow_ssh_access_from
(*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 (
IPeer
) –- Return type
None
-
apply_removal_policy
(policy)¶ Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
).- Parameters
policy (
RemovalPolicy
) –- Return type
None
-
to_string
()¶ Returns a string representation of this construct.
- Return type
str
Attributes
-
connections
¶ Allows specify security group connections for the instance.
- Return type
-
env
¶ The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
- Return type
-
grant_principal
¶ The principal to grant permissions to.
- Return type
-
instance_availability_zone
¶ The availability zone the instance was launched in.
- Attribute
true
- Return type
str
-
instance_id
¶ The instance’s ID.
- Attribute
true
- Return type
str
-
instance_private_dns_name
¶ Private DNS name for this instance.
- Attribute
true
- Return type
str
-
instance_private_ip
¶ Private IP for this instance.
- Attribute
true
- Return type
str
-
instance_public_dns_name
¶ Publicly-routable DNS name for this instance.
(May be an empty string if the instance does not have a public name).
- Attribute
true
- Return type
str
-
instance_public_ip
¶ Publicly-routable IP address for this instance.
(May be an empty string if the instance does not have a public IP).
- Attribute
true
- Return type
str
-
node
¶ The construct tree node associated with this construct.
- Return type
Static Methods
-
classmethod
is_construct
(x)¶ Return whether the given object is a Construct.
- Parameters
x (
Any
) –- Return type
bool
-
classmethod
is_resource
(construct)¶ Check whether the given construct is a Resource.
- Parameters
construct (
IConstruct
) –- Return type
bool