AWS_EC2_METADATA_DISABLED documentation fix
#3699
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…Provider with `AWS_EC2_METADATA_DISABLED` env var
A quick grep through the codebase[*] shows that `AWS_EC2_METADATA_DISABLED`
is not a CMake style flag where (one of ON or OFF) is expected, instead
it's an environment variable where only TRUE (case-insensitive) means it's
active. Update docs to reflect that.
[*]
```
> grep -r AWS_EC2_METADATA_DISABLED src
src/aws-cpp-sdk-core/source/auth/AWSCredentialsProviderChain.cpp:static const char AWS_EC2_METADATA_DISABLED[] = "AWS_EC2_METADATA_DISABLED";
src/aws-cpp-sdk-core/source/auth/AWSCredentialsProviderChain.cpp: const auto ec2MetadataDisabled = Aws::Environment::GetEnv(AWS_EC2_METADATA_DISABLED);
src/aws-cpp-sdk-core/source/auth/AWSCredentialsProviderChain.cpp: AWS_LOGSTREAM_DEBUG(DefaultCredentialsProviderChainTag, "The environment variable value " << AWS_EC2_METADATA_DISABLED
src/aws-cpp-sdk-core/source/auth/AWSCredentialsProviderChain.cpp: const auto ec2MetadataDisabled = Aws::Environment::GetEnv(AWS_EC2_METADATA_DISABLED);
src/aws-cpp-sdk-core/source/auth/AWSCredentialsProviderChain.cpp: AWS_LOGSTREAM_DEBUG(DefaultCredentialsProviderChainTag, "The environment variable value " << AWS_EC2_METADATA_DISABLED
src/aws-cpp-sdk-core/source/client/ClientConfiguration.cpp: Aws::Utils::StringUtils::ToLower(Aws::Environment::GetEnv("AWS_EC2_METADATA_DISABLED").c_str()) != "true")
src/aws-cpp-sdk-core/source/client/ClientConfiguration.cpp: Aws::Utils::StringUtils::ToLower(Aws::Environment::GetEnv("AWS_EC2_METADATA_DISABLED").c_str()) != "true")
src/aws-cpp-sdk-core/source/client/ClientConfiguration.cpp: Aws::Utils::StringUtils::ToLower(Aws::Environment::GetEnv("AWS_EC2_METADATA_DISABLED").c_str()) != "true") {
src/aws-cpp-sdk-core/source/client/ClientConfiguration.cpp: Aws::Utils::StringUtils::ToLower(Aws::Environment::GetEnv("AWS_EC2_METADATA_DISABLED").c_str()) != "true")
src/aws-cpp-sdk-core/source/config/defaults/ClientConfigurationDefaults.cpp: Aws::Utils::StringUtils::ToLower(Aws::Environment::GetEnv("AWS_EC2_METADATA_DISABLED").c_str()) != "true")
```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue #, if available:
Description of changes:
Fix the documentation surrounding
AWS_EC2_METADATA_DISABLED, it's treated as a CMake style flag when it isn't.Check all that applies:
(Explanation: Just doc changes)
(Unsure if I should tick this)
Check which platforms you have built SDK on to verify the correctness of this PR.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.