Skip to content

Commit 59cbcbc

Browse files
authored
fix documentation discrepancy with IMDS version (#55)
1 parent e32d736 commit 59cbcbc

File tree

1 file changed

+3
-3
lines changed
  • modules/bash-commons/src

1 file changed

+3
-3
lines changed

modules/bash-commons/src/aws.sh

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/log.sh"
3131
# https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-service.html
3232
#
3333
# If you prefer to use Instance Metadata service version 2, you can do so by setting the environment variable:
34-
# export GRUNTWORK_BASH_COMMONS_IMDSV="2"
34+
# export GRUNTWORK_BASH_COMMONS_IMDS_VERSION="2"
3535
function aws_get_instance_metadata_version_in_use {
3636
using=${GRUNTWORK_BASH_COMMONS_IMDS_VERSION:-$default_instance_metadata_version}
3737
assert_value_in_list "Instance Metadata service version in use" "$using" "1" "2"
@@ -50,7 +50,7 @@ function aws_get_instance_metadata_version_in_use {
5050
# modules are being updated to use IMDSv2.
5151
#
5252
# Version 1 is the default, but can be overridden by setting:
53-
# env var GRUNTWORK_BASH_COMMONS_IMDSV=2
53+
# env var GRUNTWORK_BASH_COMMONS_IMDS_VERSION=2
5454
function aws_lookup_path_in_instance_metadata {
5555
local -r path="$1"
5656
version_in_use=$(aws_get_instance_metadata_version_in_use)
@@ -66,7 +66,7 @@ function aws_lookup_path_in_instance_metadata {
6666
# modules are being updated to use IMDSv2.
6767
#
6868
# Version 1 is the default, but can be overridden by setting:
69-
# env var GRUNTWORK_BASH_COMMONS_IMDSV=2
69+
# env var GRUNTWORK_BASH_COMMONS_IMDS_VERSION=2
7070
function aws_lookup_path_in_instance_dynamic_data {
7171
local -r path="$1"
7272
version_in_use=$(aws_get_instance_metadata_version_in_use)

0 commit comments

Comments
 (0)