From 9afab1fa6c7ea2836ae8f92a81b1659d18462ebc Mon Sep 17 00:00:00 2001 From: Erik Kristensen Date: Thu, 22 Feb 2024 09:13:17 -0700 Subject: [PATCH] docs: updating usages for aws auth related cli options --- pkg/commands/nuke/command.go | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/pkg/commands/nuke/command.go b/pkg/commands/nuke/command.go index cee96669..45dc48a1 100644 --- a/pkg/commands/nuke/command.go +++ b/pkg/commands/nuke/command.go @@ -223,34 +223,42 @@ func init() { &cli.StringFlag{ Name: "default-region", EnvVars: []string{"AWS_DEFAULT_REGION"}, + Usage: "the default aws region to use when setting up the aws auth session", }, &cli.StringFlag{ Name: "access-key-id", EnvVars: []string{"AWS_ACCESS_KEY_ID"}, + Usage: "the aws access key id to use when setting up the aws auth session", }, &cli.StringFlag{ Name: "secret-access-key", EnvVars: []string{"AWS_SECRET_ACCESS_KEY"}, + Usage: "the aws secret access key to use when setting up the aws auth session", }, &cli.StringFlag{ Name: "session-token", EnvVars: []string{"AWS_SESSION_TOKEN"}, + Usage: "the aws session token to use when setting up the aws auth session, typically used for temporary credentials", }, &cli.StringFlag{ Name: "profile", EnvVars: []string{"AWS_PROFILE"}, + Usage: "the aws profile to use when setting up the aws auth session, typically used for shared credentials files", }, &cli.StringFlag{ Name: "assume-role-arn", EnvVars: []string{"AWS_ASSUME_ROLE_ARN"}, + Usage: "the role arn to assume using the credentials provided in the profile or statically set", }, &cli.StringFlag{ Name: "assume-role-session-name", EnvVars: []string{"AWS_ASSUME_ROLE_SESSION_NAME"}, + Usage: "the session name to provide for the assumed role", }, &cli.StringFlag{ Name: "assume-role-external-id", EnvVars: []string{"AWS_ASSUME_ROLE_EXTERNAL_ID"}, + Usage: "the external id to provide for the assumed role", }, }