Skip to content

Commit b3520b5

Browse files
authored
Merge pull request #4 from debugger24/feature/update-docs
Add Action Inputs and Action Outputs
2 parents e6ac62a + ac90e30 commit b3520b5

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,20 @@ Github Action for running commands on Linux or Windows machine managed using SSM
1717
ls
1818
echo "Executed by Github Actions Workflow #${{ github.run_id }}" >> test.txt
1919
```
20+
21+
## Action Inputs
22+
23+
| Input Name | Description | Required | Default Value |
24+
|-------------------|----------------------------------------------------------------|----------|-----------------------------------------------------------|
25+
| aws-region | AWS Region | true | |
26+
| instance-ids | List of Instance IDs to execute command | true | |
27+
| commands | Commands to be executed on instance | true | |
28+
| os | (Optional) Operating system to run commands (windows or linux) | false | linux |
29+
| working-directory | (Optional) Working directory for command execution | false | |
30+
| comment | (Optional) Comment | false | Executed by Github Actions Workflow #${{ github.run_id }} |
31+
32+
## Action Outputs
33+
34+
| Output Name | Description |
35+
|-------------|--------------------------------------------------------|
36+
| command-id | Execution command ID generated by AWS send command API |

0 commit comments

Comments
 (0)