Skip to content

Commit f453486

Browse files
committed
chore(bastion-host): fix docs
1 parent 4eda3e2 commit f453486

File tree

1 file changed

+4
-7
lines changed

1 file changed

+4
-7
lines changed

lib/bastion-host/index.ts

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,9 @@ import { Construct } from "constructs";
2727
*
2828
* Add an entry to the `users` array with a username (likely matching your local systems username, which you can get by running the `whoami` command in your terminal) and a public key (likely your default public key, which you can get by running `cat ~/.ssh/id_*.pub` in your terminal).
2929
*
30-
* <details>
30+
* #### Tips & Tricks when using the Bastion Host
3131
*
32-
* <summary>Tips & Tricks when using the Bastion Host</summary>
33-
*
34-
* #### Connecting to RDS Instance via SSM
32+
* ##### Connecting to RDS Instance via SSM
3533
*
3634
* ```sh
3735
* aws ssm start-session --target $INSTANCE_ID \
@@ -60,7 +58,7 @@ import { Construct } from "constructs";
6058
* aws ssm start-session --target $INSTANCE_ID --profile $AWS_PROFILE
6159
* ```
6260
*
63-
* #### Setting up an SSH tunnel
61+
* ##### Setting up an SSH tunnel
6462
*
6563
* In your `~/.ssh/config` file, add an entry like:
6664
*
@@ -82,7 +80,7 @@ import { Construct } from "constructs";
8280
* psql -h 127.0.0.1 -p 5433 -U {username} -d {database}
8381
* ```
8482
*
85-
* #### Handling `REMOTE HOST IDENTIFICATION HAS CHANGED!` error
83+
* ##### Handling `REMOTE HOST IDENTIFICATION HAS CHANGED!` error
8684
*
8785
* If you've redeployed a bastion host that you've previously connected to, you may see an error like:
8886
*
@@ -108,7 +106,6 @@ import { Construct } from "constructs";
108106
* ssh-keygen -R 12.34.56.789
109107
* ```
110108
*
111-
* </details>
112109
*/
113110
export class BastionHost extends Construct {
114111
instance: ec2.Instance;

0 commit comments

Comments
 (0)