[BEAM-3986] Improve setAwsCredentialsProvider documentation

• Type: Improvement
• Status: Resolved
• Priority: P4
• Resolution: Fixed
• Affects Version/s: 2.4.0
• Fix Version/s: 2.5.0
• Component/s: io-java-aws
• Assignee: Paul Gerver
• Reporter: Paul Gerver
• Created: 02/Apr/18 20:52
• Updated: 16/May/20 14:22
• Resolved: 30/Apr/18 17:59

Description

I tried using --awsCredentialsProvider with a JSON string (i.e., --awsCredentialsProvider='{"awsAccessKeyId" : "<keyid>", "awsSecretKey" : "<secret>"}') and it was not clear from documentation that "@type" and an AWS credentials class was required.

We should improve the javadoc and PipelineOptions to include the following description/example:

@Description("The credential instance that should be used to authenticate against AWS services. " + "The option value must contain \"@type\" field and an AWS Credentials Provider class name as a value. " + "Refer to DefaultAWSCredentialsProviderChain Javadoc for usage help. " + "For example, to specify the AWS key ID and secret on the command line, specify the following: {\"@type\": \"AWSStaticCredentialsProvider\", \"awsAccessKeyId\":\"<key_id>\", \"awsSecretKey\":\"<secret_key>\"}

 

 

Issue Links

• links to: GitHub Pull Request #5248