Skip to content

Commit 7428c13

Browse files
committed
minor doc changes
1 parent f918d23 commit 7428c13

File tree

1 file changed

+36
-6
lines changed

1 file changed

+36
-6
lines changed

hadoop-tools/hadoop-aws/src/site/markdown/tools/hadoop-aws/aws_sdk_upgrade.md

Lines changed: 36 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,20 +69,50 @@ implement `software.amazon.awssdk.auth.credentials.AwsCredentialsProvider` inste
6969
[HADOOP-18980](https://issues.apache.org/jira/browse/HADOOP-18980) introduces extended version of
7070
the credential provider remapping. `fs.s3a.aws.credentials.provider.mapping` can be used to
7171
list comma-separated key-value pairs of mapped credential providers that are separated by
72-
equal operator (=). The key can be used by `fs.s3a.aws.credentials.provider` config, and it
73-
will be translated into the specified value of credential provider class based on the key-value
74-
pair provided by this config.
72+
equal operator (=).
73+
The key can be used by `fs.s3a.aws.credentials.provider` or
74+
`fs.s3a.assumed.role.credentials.provider` configs, and the key will be translated into
75+
the specified value of credential provider class based on the key-value pair
76+
provided by the config `fs.s3a.aws.credentials.provider.mapping`.
7577

7678
For example, if `fs.s3a.aws.credentials.provider.mapping` is set with value:
7779

80+
```xml
81+
<property>
82+
<name>fs.s3a.aws.credentials.provider.mapping</name>
83+
<vale>
7884
com.amazonaws.auth.AnonymousAWSCredentials=org.apache.hadoop.fs.s3a.AnonymousAWSCredentialsProvider,
7985
com.amazonaws.auth.EC2ContainerCredentialsProviderWrapper=org.apache.hadoop.fs.s3a.auth.IAMInstanceCredentialsProvider,
8086
com.amazonaws.auth.InstanceProfileCredentialsProvider=org.apache.hadoop.fs.s3a.auth.IAMInstanceCredentialsProvider
87+
</vale>
88+
</property>
89+
```
90+
91+
and if `fs.s3a.aws.credentials.provider` is set with:
92+
93+
```xml
94+
<property>
95+
<name>fs.s3a.aws.credentials.provider</name>
96+
<vale>com.amazonaws.auth.AnonymousAWSCredentials</vale>
97+
</property>
98+
```
8199

82-
With the above key-value pairs, if `fs.s3a.aws.credentials.provider` specifies
83-
`com.amazonaws.auth.AnonymousAWSCredentials`, it will be remapped to
100+
`com.amazonaws.auth.AnonymousAWSCredentials` will be internally remapped to
84101
`org.apache.hadoop.fs.s3a.AnonymousAWSCredentialsProvider` by S3A while preparing
85-
AWS credential provider list.
102+
the AWS credential provider list.
103+
104+
Similarly, if `fs.s3a.assumed.role.credentials.provider` is set with:
105+
106+
```xml
107+
<property>
108+
<name>fs.s3a.assumed.role.credentials.provider</name>
109+
<vale>com.amazonaws.auth.InstanceProfileCredentialsProvider</vale>
110+
</property>
111+
```
112+
113+
`com.amazonaws.auth.InstanceProfileCredentialsProvider` will be internally
114+
remapped to `org.apache.hadoop.fs.s3a.auth.IAMInstanceCredentialsProvider` by
115+
S3A while preparing the assumed role AWS credential provider list.
86116

87117

88118
### Original V1 `AWSCredentialsProvider` interface

0 commit comments

Comments
 (0)