Skip to content
play

GitHub Action

AWS SSM Port Forwarding Session

v1.0.0 Latest version

AWS SSM Port Forwarding Session

play

AWS SSM Port Forwarding Session

Start an SSM Port Forwarding Session in a github workflow

Installation

Copy and paste the following snippet into your .yml file.

              

- name: AWS SSM Port Forwarding Session

uses: gian2dchris/[email protected]

Learn more about this action in gian2dchris/aws-ssm-port-forwarding-session-action

Choose a version

AWS SSM Port Forwarding Session Action

This action starts a local port forwarding session for your github workflow and terminates it upon cleanup.

See also aws-ssm-port-forwarding-session.

Usage

See action.yml

Local Port Forward Example

Forward instance's i-1234 port 8888, on local port 8888:

steps:
...
- name: SSM Port Forward
  uses: skroutz-internal/[email protected]
  with:
    target-id: 'i-1234'
    portNumber: 8888
    localPortNumber:  8888
- name: Curl Test
  run: |
    curl -v http://127.0.0.1:8888

Limitations

As of current release the action only supports local port forwarding. Future releases may support remote or unix socket port forwarding SSM documents.

License

The scripts and documentation in this project are released under the MIT License