Skip to content

Commit

Permalink
minor doc changes
Browse files Browse the repository at this point in the history
  • Loading branch information
virajjasani committed Feb 1, 2024
1 parent f918d23 commit 7428c13
Showing 1 changed file with 36 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -69,20 +69,50 @@ implement `software.amazon.awssdk.auth.credentials.AwsCredentialsProvider` inste
[HADOOP-18980](https://issues.apache.org/jira/browse/HADOOP-18980) introduces extended version of
the credential provider remapping. `fs.s3a.aws.credentials.provider.mapping` can be used to
list comma-separated key-value pairs of mapped credential providers that are separated by
equal operator (=). The key can be used by `fs.s3a.aws.credentials.provider` config, and it
will be translated into the specified value of credential provider class based on the key-value
pair provided by this config.
equal operator (=).
The key can be used by `fs.s3a.aws.credentials.provider` or
`fs.s3a.assumed.role.credentials.provider` configs, and the key will be translated into
the specified value of credential provider class based on the key-value pair
provided by the config `fs.s3a.aws.credentials.provider.mapping`.

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

```xml
<property>
<name>fs.s3a.aws.credentials.provider.mapping</name>
<vale>
com.amazonaws.auth.AnonymousAWSCredentials=org.apache.hadoop.fs.s3a.AnonymousAWSCredentialsProvider,
com.amazonaws.auth.EC2ContainerCredentialsProviderWrapper=org.apache.hadoop.fs.s3a.auth.IAMInstanceCredentialsProvider,
com.amazonaws.auth.InstanceProfileCredentialsProvider=org.apache.hadoop.fs.s3a.auth.IAMInstanceCredentialsProvider
</vale>
</property>
```

and if `fs.s3a.aws.credentials.provider` is set with:

```xml
<property>
<name>fs.s3a.aws.credentials.provider</name>
<vale>com.amazonaws.auth.AnonymousAWSCredentials</vale>
</property>
```

With the above key-value pairs, if `fs.s3a.aws.credentials.provider` specifies
`com.amazonaws.auth.AnonymousAWSCredentials`, it will be remapped to
`com.amazonaws.auth.AnonymousAWSCredentials` will be internally remapped to
`org.apache.hadoop.fs.s3a.AnonymousAWSCredentialsProvider` by S3A while preparing
AWS credential provider list.
the AWS credential provider list.

Similarly, if `fs.s3a.assumed.role.credentials.provider` is set with:

```xml
<property>
<name>fs.s3a.assumed.role.credentials.provider</name>
<vale>com.amazonaws.auth.InstanceProfileCredentialsProvider</vale>
</property>
```

`com.amazonaws.auth.InstanceProfileCredentialsProvider` will be internally
remapped to `org.apache.hadoop.fs.s3a.auth.IAMInstanceCredentialsProvider` by
S3A while preparing the assumed role AWS credential provider list.


### Original V1 `AWSCredentialsProvider` interface
Expand Down

0 comments on commit 7428c13

Please sign in to comment.