From 76928d61723740b78f91b606898281df5d1c4230 Mon Sep 17 00:00:00 2001 From: Menachem Hornbacher Date: Wed, 17 Aug 2022 14:47:57 -0400 Subject: [PATCH] chore: improve documentation --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index aae565a..f484198 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,8 @@ Either a string, or a list of strings with AWS account IDs that correspond to th ### `no-include-email` (optional) +> Obsolete if using AWS CLI version 1.17.10 or newer. + Add `--no-include-email` to ecr get-login. Required for docker 17.06+, but needs aws-cli 1.11.91+. ### `region` (optional) @@ -66,10 +68,14 @@ Retries login after a delay N times. Defaults to 0. ### `assume-role` (optional) +> Updates AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and AWS_SESSION_TOKEN environment variables. + Assume an AWS IAM role before ECR login. Supports `role-arn` and `duration-seconds` (optional) per the [associated AWS CLI command.](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/sts/assume-role.html) ### `profile` (optional) +> Requires AWS CLI version 1.17.10 or greater. + Use a different AWS profile from the default during ECR login. ## License