Skip to content

Commit 9d0b844

Browse files
hamstahhamstah
committed
Updated README for new CLI arguments.
1 parent 519444b commit 9d0b844

File tree

12 files changed

+225
-132
lines changed

12 files changed

+225
-132
lines changed

‎README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@ Collection of tools to make working with AWS a bit easier without having to depe
1919
| [ecr-get-login](ecr/get-login) | Prints out the command to run to auth with docker ECR. Check output flag for other options |
2020
| [ecs-dashboard](ecs/dashboard) | Shows ECS services and their version across multiple AWS accounts. |
2121
| [ecs-locate](ecs/locate) | Returns `ip:port` for containers of an ECS service |
22-
| [ecs-deploy](ecs/dashboard) | Update the container images of a task and update services to use it |
22+
| [ecs-deploy](ecs/deploy) | Update the container images of a task and update services to use it |
2323
| [ecs-run-task](ecs/run-task) | Runs a task definition |
2424
| `elb-resolve-elb-external-url` | ELB classic only (no ALB). Given a name returns the zone53 record associated with the ELB, including scheme (https returned if both available) and port.|
2525
| `elb-resolve-alb-external-url` | Both ELB classic and ALB. Given a name, returns route53 record associated with the ELB. Does not include scheme or port as it doesn't check listeners. |
2626
| `lambda-ping` | Pings a URL with lambda and publish a custom cloudwatch metric with the result. |
27-
| `s3-download` | Download a single file from s3. |
27+
| [s3-download](s3/download) | Download a single file from s3. |
2828
| [kms-env](kms/env/) | Decrypts environment variables from SSM, KMS or Secret Manager and runs a command. |
2929

3030
## Authentication

‎cloudwatch/put-metric-data/README.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# cloudwatch-put-metric-data
2+
3+
Put a single cloudwatch metric value.
4+
5+
```
6+
usage: cloudwatch-put-metric-data --metric-name=METRIC-NAME --namespace=NAMESPACE --value=VALUE [<flags>]
7+
8+
Put a cloudwatch metric value.
9+
10+
Flags:
11+
--help Show context-sensitive help (also try --help-long and --help-man).
12+
--metric-name=METRIC-NAME Name of the Cloudwatch metric
13+
--namespace=NAMESPACE Name of the Cloudwatch namespace
14+
--dimension=DIMENSION ... Dimensions name=value
15+
--value=VALUE Metric value
16+
--assume-role-arn=ASSUME-ROLE-ARN
17+
Role to assume
18+
--assume-role-external-id=ASSUME-ROLE-EXTERNAL-ID
19+
External ID of the role to assume
20+
--assume-role-session-name=ASSUME-ROLE-SESSION-NAME
21+
Role session name
22+
--region=REGION AWS Region
23+
--mfa-serial-number=MFA-SERIAL-NUMBER
24+
MFA Serial Number
25+
--mfa-token-code=MFA-TOKEN-CODE
26+
MFA Token Code
27+
--session-duration=1h Session Duration
28+
-v, --version Display the version
29+
--log-level=warn Log level
30+
--log-format=text Log format
31+
32+
```

‎ec2/describe-instances/README.md

+17-14
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,23 @@ usage: ec2-describe-instances [<flags>] [<identifiers>...]
88
Returns metadata of one or more EC2 instances
99
1010
Flags:
11-
--help Show context-sensitive help (also try --help-long and --help-man).
12-
--assume-role-arn=ASSUME-ROLE-ARN
13-
Role to assume
14-
--assume-role-external-id=ASSUME-ROLE-EXTERNAL-ID
15-
External ID of the role to assume
16-
--assume-role-session-name=ASSUME-ROLE-SESSION-NAME
17-
Role session name
18-
--region=REGION AWS Region
19-
--mfa-serial-number=MFA-SERIAL-NUMBER
20-
MFA Serial Number
21-
--mfa-token-code=MFA-TOKEN-CODE
22-
MFA Token Code
23-
-v, --version Display the version
24-
--filter=FILTER The filter to use for the identifiers. eg tag:Name
11+
--help Show context-sensitive help (also try --help-long and --help-man).
12+
--filter=FILTER The filter to use for the identifiers. eg tag:Name
13+
--assume-role-arn=ASSUME-ROLE-ARN
14+
Role to assume
15+
--assume-role-external-id=ASSUME-ROLE-EXTERNAL-ID
16+
External ID of the role to assume
17+
--assume-role-session-name=ASSUME-ROLE-SESSION-NAME
18+
Role session name
19+
--region=REGION AWS Region
20+
--mfa-serial-number=MFA-SERIAL-NUMBER
21+
MFA Serial Number
22+
--mfa-token-code=MFA-TOKEN-CODE
23+
MFA Token Code
24+
--session-duration=1h Session Duration
25+
-v, --version Display the version
26+
--log-level=warn Log level
27+
--log-format=text Log format
2528
2629
Args:
2730
[<identifiers>] If omitted the instance is fetched from the EC2 metadata.

‎ec2/ip-from-name/README.md

+18-15
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,22 @@ usage: ec2-ip-from-name --name=NAME [<flags>]
88
Returns a list of instances IP with a given name.
99
1010
Flags:
11-
--help Show context-sensitive help (also try --help-long and --help-man).
12-
--assume-role-arn=ASSUME-ROLE-ARN
13-
Role to assume
14-
--assume-role-external-id=ASSUME-ROLE-EXTERNAL-ID
15-
External ID of the role to assume
16-
--assume-role-session-name=ASSUME-ROLE-SESSION-NAME
17-
Role session name
18-
--region=REGION AWS Region
19-
--mfa-serial-number=MFA-SERIAL-NUMBER
20-
MFA Serial Number
21-
--mfa-token-code=MFA-TOKEN-CODE
22-
MFA Token Code
23-
-v, --version Display the version
24-
--name=NAME Name of the EC2 instance
25-
--max-results=9 Max number of IPs to return
11+
--help Show context-sensitive help (also try --help-long and --help-man).
12+
--name=NAME Name of the EC2 instance
13+
--max-results=9 Max number of IPs to return
14+
--assume-role-arn=ASSUME-ROLE-ARN
15+
Role to assume
16+
--assume-role-external-id=ASSUME-ROLE-EXTERNAL-ID
17+
External ID of the role to assume
18+
--assume-role-session-name=ASSUME-ROLE-SESSION-NAME
19+
Role session name
20+
--region=REGION AWS Region
21+
--mfa-serial-number=MFA-SERIAL-NUMBER
22+
MFA Serial Number
23+
--mfa-token-code=MFA-TOKEN-CODE
24+
MFA Token Code
25+
--session-duration=1h Session Duration
26+
-v, --version Display the version
27+
--log-level=warn Log level
28+
--log-format=text Log format
2629
```

‎ecr/get-login/README.md

+17-14
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,21 @@ usage: ecr-get-login [<flags>]
99
Returns an authorization token from ECR.
1010
1111
Flags:
12-
--help Show context-sensitive help (also try --help-long and --help-man).
13-
--assume-role-arn=ASSUME-ROLE-ARN
14-
Role to assume
15-
--assume-role-external-id=ASSUME-ROLE-EXTERNAL-ID
16-
External ID of the role to assume
17-
--assume-role-session-name=ASSUME-ROLE-SESSION-NAME
18-
Role session name
19-
--region=REGION AWS Region
20-
--mfa-serial-number=MFA-SERIAL-NUMBER
21-
MFA Serial Number
22-
--mfa-token-code=MFA-TOKEN-CODE
23-
MFA Token Code
24-
-v, --version Display the version
25-
--output=shell Return the credentials instead of docker command
12+
--help Show context-sensitive help (also try --help-long and --help-man).
13+
--output=shell Return the credentials instead of docker command
14+
--assume-role-arn=ASSUME-ROLE-ARN
15+
Role to assume
16+
--assume-role-external-id=ASSUME-ROLE-EXTERNAL-ID
17+
External ID of the role to assume
18+
--assume-role-session-name=ASSUME-ROLE-SESSION-NAME
19+
Role session name
20+
--region=REGION AWS Region
21+
--mfa-serial-number=MFA-SERIAL-NUMBER
22+
MFA Serial Number
23+
--mfa-token-code=MFA-TOKEN-CODE
24+
MFA Token Code
25+
--session-duration=1h Session Duration
26+
-v, --version Display the version
27+
--log-level=warn Log level
28+
--log-format=text Log format
2629
```

‎ecs/locate/README.md

+22-19
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,26 @@ usage: ecs-locate --container-name=CONTAINER-NAME --container-port=CONTAINER-POR
88
Find an instance/port for a service
99
1010
Flags:
11-
--help Show context-sensitive help (also try --help-long and --help-man).
12-
--assume-role-arn=ASSUME-ROLE-ARN
13-
Role to assume
14-
--assume-role-external-id=ASSUME-ROLE-EXTERNAL-ID
15-
External ID of the role to assume
16-
--assume-role-session-name=ASSUME-ROLE-SESSION-NAME
17-
Role session name
18-
--region=REGION AWS Region
19-
--mfa-serial-number=MFA-SERIAL-NUMBER
20-
MFA Serial Number
21-
--mfa-token-code=MFA-TOKEN-CODE
22-
MFA Token Code
23-
-v, --version Display the version
24-
--container-name=CONTAINER-NAME
25-
ECS container name
26-
--container-port=CONTAINER-PORT
27-
ECS container port
28-
--cluster=CLUSTER ECS cluster
29-
--service=SERVICE ECS service
11+
--help Show context-sensitive help (also try --help-long and --help-man).
12+
--container-name=CONTAINER-NAME
13+
ECS container name
14+
--container-port=CONTAINER-PORT
15+
ECS container port
16+
--cluster=CLUSTER ECS cluster
17+
--service=SERVICE ECS service
18+
--assume-role-arn=ASSUME-ROLE-ARN
19+
Role to assume
20+
--assume-role-external-id=ASSUME-ROLE-EXTERNAL-ID
21+
External ID of the role to assume
22+
--assume-role-session-name=ASSUME-ROLE-SESSION-NAME
23+
Role session name
24+
--region=REGION AWS Region
25+
--mfa-serial-number=MFA-SERIAL-NUMBER
26+
MFA Serial Number
27+
--mfa-token-code=MFA-TOKEN-CODE
28+
MFA Token Code
29+
--session-duration=1h Session Duration
30+
-v, --version Display the version
31+
--log-level=warn Log level
32+
--log-format=text Log format
3033
```

‎ecs/run-task/README.md

+19-16
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,23 @@ usage: ecs-run-task --task-definition=TASK-DEFINITION --cluster=CLUSTER [<flags>
88
Run a task on ECS.
99
1010
Flags:
11-
--help Show context-sensitive help (also try --help-long and --help-man).
12-
--assume-role-arn=ASSUME-ROLE-ARN
13-
Role to assume
14-
--assume-role-external-id=ASSUME-ROLE-EXTERNAL-ID
15-
External ID of the role to assume
16-
--assume-role-session-name=ASSUME-ROLE-SESSION-NAME
17-
Role session name
18-
--region=REGION AWS Region
19-
--mfa-serial-number=MFA-SERIAL-NUMBER
20-
MFA Serial Number
21-
--mfa-token-code=MFA-TOKEN-CODE
22-
MFA Token Code
23-
-v, --version Display the version
24-
--task-definition=TASK-DEFINITION
25-
ECS task definition
26-
--cluster=CLUSTER ECS cluster
11+
--help Show context-sensitive help (also try --help-long and --help-man).
12+
--task-definition=TASK-DEFINITION
13+
ECS task definition
14+
--cluster=CLUSTER ECS cluster
15+
--assume-role-arn=ASSUME-ROLE-ARN
16+
Role to assume
17+
--assume-role-external-id=ASSUME-ROLE-EXTERNAL-ID
18+
External ID of the role to assume
19+
--assume-role-session-name=ASSUME-ROLE-SESSION-NAME
20+
Role session name
21+
--region=REGION AWS Region
22+
--mfa-serial-number=MFA-SERIAL-NUMBER
23+
MFA Serial Number
24+
--mfa-token-code=MFA-TOKEN-CODE
25+
MFA Token Code
26+
--session-duration=1h Session Duration
27+
-v, --version Display the version
28+
--log-level=warn Log level
29+
--log-format=text Log format
2730
```

‎iam/public-ssh-keys/README.md

+20-15
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,26 @@ usage: iam-public-ssh-keys [<flags>]
66
Return public SSH keys for an IAM user.
77
88
Flags:
9-
--help Show context-sensitive help (also try --help-long and --help-man).
10-
--assume-role-arn=ASSUME-ROLE-ARN
11-
Role to assume
12-
--assume-role-external-id=ASSUME-ROLE-EXTERNAL-ID
13-
External ID of the role to assume
14-
--region=REGION AWS Region
15-
--mfa-serial-number=MFA-SERIAL-NUMBER
16-
MFA Serial Number
17-
--mfa-token-code=MFA-TOKEN-CODE
18-
MFA Token Code
19-
-u, --username=USERNAME Username to fetch the keys for, otherwise default to the logged in user.
20-
--key-encoding=SSH Encoding of the key to return (SSH or PEM)
21-
--allowed-group=ALLOWED-GROUP ...
22-
Fetch the keys only if the user is in this group. You can use --allowed-group multiple times.
23-
9+
--help Show context-sensitive help (also try --help-long and --help-man).
10+
-u, --username=USERNAME Username to fetch the keys for, otherwise default to the logged in user.
11+
--key-encoding=SSH Encoding of the key to return (SSH or PEM)
12+
--allowed-group=ALLOWED-GROUP ...
13+
Fetch the keys only if the user is in this group. You can use --allowed-group multiple times.
14+
--assume-role-arn=ASSUME-ROLE-ARN
15+
Role to assume
16+
--assume-role-external-id=ASSUME-ROLE-EXTERNAL-ID
17+
External ID of the role to assume
18+
--assume-role-session-name=ASSUME-ROLE-SESSION-NAME
19+
Role session name
20+
--region=REGION AWS Region
21+
--mfa-serial-number=MFA-SERIAL-NUMBER
22+
MFA Serial Number
23+
--mfa-token-code=MFA-TOKEN-CODE
24+
MFA Token Code
25+
--session-duration=1h Session Duration
26+
-v, --version Display the version
27+
--log-level=warn Log level
28+
--log-format=text Log format
2429
```
2530

2631
## IAM policy

‎iam/session/README.md

+20-14
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,26 @@ usage: iam-session [<flags>] [<command>...]
66
Start a new session under a different role.
77
88
Flags:
9-
--help Show context-sensitive help (also try --help-long and --help-man).
10-
--assume-role-arn=ASSUME-ROLE-ARN
11-
Role to assume
12-
--assume-role-external-id=ASSUME-ROLE-EXTERNAL-ID
13-
External ID of the role to assume
14-
--region=REGION AWS Region
15-
--mfa-serial-number=MFA-SERIAL-NUMBER
16-
MFA Serial Number
17-
--mfa-token-code=MFA-TOKEN-CODE
18-
MFA Token Code
19-
-q, --quiet Do not output anything
20-
-s, --save-profile=SAVE-PROFILE
21-
Save the profile in the AWS credentials storage
22-
--overwrite-profile Overwrite the profile if it already exists
9+
--help Show context-sensitive help (also try --help-long and --help-man).
10+
-q, --quiet Do not output anything
11+
-s, --save-profile=SAVE-PROFILE
12+
Save the profile in the AWS credentials storage
13+
--overwrite-profile Overwrite the profile if it already exists
14+
--assume-role-arn=ASSUME-ROLE-ARN
15+
Role to assume
16+
--assume-role-external-id=ASSUME-ROLE-EXTERNAL-ID
17+
External ID of the role to assume
18+
--assume-role-session-name=ASSUME-ROLE-SESSION-NAME
19+
Role session name
20+
--region=REGION AWS Region
21+
--mfa-serial-number=MFA-SERIAL-NUMBER
22+
MFA Serial Number
23+
--mfa-token-code=MFA-TOKEN-CODE
24+
MFA Token Code
25+
--session-duration=1h Session Duration
26+
-v, --version Display the version
27+
--log-level=warn Log level
28+
--log-format=text Log format
2329
2430
Args:
2531
[<command>] Command to run, prefix with -- to pass args

‎iam/sync-users/README.md

+7-8
Original file line numberDiff line numberDiff line change
@@ -12,28 +12,27 @@ Sync local users with IAM
1212
Flags:
1313
--help Show context-sensitive help (also try --help-long and --help-man).
1414
--group=GROUP ... Add users from this IAM group. You can use --group multiple times.
15-
--iam-tags-prefix="iam-sync-users"
15+
--iam-tags-prefix="iam-sync-users"
1616
Prefix for tags in IAM
1717
--lock-missing Lock local users not in IAM.
18-
--lock-ignore-user=LOCK-IGNORE-USER ...
18+
--lock-ignore-user=LOCK-IGNORE-USER ...
1919
Ignore local user when locking.
2020
--sudo Add users to sudoers file.
21-
--assume-role-arn=ASSUME-ROLE-ARN
21+
--assume-role-arn=ASSUME-ROLE-ARN
2222
Role to assume
23-
--assume-role-external-id=ASSUME-ROLE-EXTERNAL-ID
23+
--assume-role-external-id=ASSUME-ROLE-EXTERNAL-ID
2424
External ID of the role to assume
25-
--assume-role-session-name=ASSUME-ROLE-SESSION-NAME
25+
--assume-role-session-name=ASSUME-ROLE-SESSION-NAME
2626
Role session name
2727
--region=REGION AWS Region
28-
--mfa-serial-number=MFA-SERIAL-NUMBER
28+
--mfa-serial-number=MFA-SERIAL-NUMBER
2929
MFA Serial Number
30-
--mfa-token-code=MFA-TOKEN-CODE
30+
--mfa-token-code=MFA-TOKEN-CODE
3131
MFA Token Code
3232
--session-duration=1h Session Duration
3333
-v, --version Display the version
3434
--log-level=warn Log level
3535
--log-format=text Log format
36-
3736
```
3837

3938
## IAM policy

0 commit comments

Comments
 (0)