Documentaion about environment variable AWS_IAM_ROLE_ARN

[zhscn]

We have observed an inconsistency in source code that the environment variable AWS_IAM_ROLE_ARN is used to initialize the ClientConfiguration:

aws-sdk-cpp/src/aws-cpp-sdk-core/source/client/ClientConfiguration.cpp

Line 48 in 1122413

static const char* AWS_IAM_ROLE_ARN_ENV_VAR = "AWS_IAM_ROLE_ARN";

The STSCredentialsProvider, however, still uses the AWS_ROLE_ARN :

aws-sdk-cpp/src/aws-cpp-sdk-core/source/auth/STSCredentialsProvider.cpp

Line 82 in 1122413

GetLegacySettingFromEnvOrProfile("AWS_ROLE_ARN",

The problem is that AWS_IAM_ROLE_ARN appears to be completely undocumented in official AWS and SDK documentation. Searches (e.g., "AWS_IAM_ROLE_ARN" site:docs.aws.amazon.com) yield no helpful results.

Which variable is the current, officially recommended way to set the Role ARN using environment variables?

Thanks.

[sbiscigl]

i think this is just a bug and the incorrect env var is used, we should align to public documentation. We can push out a fix for this.

[zhscn]

Thank you for confirming the bug. The 'Legacy' naming convention is confusing. Another related env var is AWS_IAM_ROLE_SESSION_NAME (AWS_ROLE_SESSION_NAME).

[sbiscigl]

Created a PR

[sbiscigl]

merged now and is in main, will be tagged with a release tomorrow