feat: IMDS support for providing custom endpoint #2859
Merged
Conversation
This file contains 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
yenfryherrerafeliz
force-pushed
the
feat_imds_endpoint_support
branch
2 times, most recently
from
ef0e401
to
c4a0032
Compare
stobrien89
requested changes
Dec 19, 2023
yenfryherrerafeliz
force-pushed
the
feat_imds_endpoint_support
branch
2 times, most recently
from
24dd452
to
5f00d26
Compare
stobrien89
requested changes
Dec 22, 2023
yenfryherrerafeliz
force-pushed
the
feat_imds_endpoint_support
branch
3 times, most recently
from
5030383
to
dba5d78
Compare
yenfryherrerafeliz
force-pushed
the
feat_imds_endpoint_support
branch
2 times, most recently
from
6393d1e
to
5d6492f
Compare
stobrien89
requested changes
Jan 16, 2024
yenfryherrerafeliz
force-pushed
the
feat_imds_endpoint_support
branch
from
5d6492f
to
f0f10cc
Compare
yenfryherrerafeliz
force-pushed
the
feat_imds_endpoint_support
branch
2 times, most recently
from
0c6ec87
to
3454eb1
Compare
stobrien89
requested changes
Jan 18, 2024
yenfryherrerafeliz
force-pushed
the
feat_imds_endpoint_support
branch
from
3454eb1
to
462abd2
Compare
stobrien89
reviewed
Jan 22, 2024
yenfryherrerafeliz
force-pushed
the
feat_imds_endpoint_support
branch
from
462abd2
to
3468ae2
Compare
yenfryherrerafeliz
force-pushed
the
feat_imds_endpoint_support
branch
from
3468ae2
to
deeb6a9
Compare
When using IMDS for fetching credentials, customers should be able to provide their custom endpoint when desired, and that is what this change does. Basically, customer can provide a custom endpoint by doing one of the following options: Please note that a valid URI value needs to be provided as endpoint, otherwise a credential exception will be thrown. - Providing a parameter called 'ec2_metadata_service_endpoint' to the constructor of the InstanceProfileProvider. - By setting an environment variable called AWS_EC2_METADATA_SERVICE_ENDPOINT with the desired custom endpoint. - By defining a key-value config in the config file ~/.aws/config where its key is ec2_metadata_service_endpoint and its value is the desired custom endpoint. This commit also includes customizing the endpoint mode, which is used to change how the default endpoint is resolved. The valid endpoint mode are IPv4 and IPv6. Here are the different options for setting the endpoint mode: - Providing a parameter called 'ec2_metadata_service_endpoint_mode' in the constructor parameters for InstanceProfileProvider. - By setting an environment variable called AWS_EC2_METADATA_SERVICE_ENDPOINT_MODE with the desired custom endpoint mode. - By defining a key-value config in the config file ~/.aws/config where its key is ec2_metadata_service_endpoint_mode and its value is the desired custom endpoint mode. Please note that the reason why the parameter we pass in the constructor is not 'endpoint' is because the parameter name conflicts with service client configurations, and when using the default credential resolution internally we pass the client configuration to the credential provider, and if a custom endpoint was provided for the service client it will also pass this custom endpoint to the IMDS credential provider, which will make it to fail.
yenfryherrerafeliz
force-pushed
the
feat_imds_endpoint_support
branch
from
deeb6a9
to
21a1125
Compare
stobrien89
approved these changes
Jan 23, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
When using IMDS for fetching credentials, customers should be able to provide their custom endpoint when desired, and that is what this change does. Basically, customer can provide a custom endpoint by doing one of the following options: Please note that a valid URI value needs to be provided, otherwise a credential exception will be thrown.
Issue #2847
Description of changes:
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.