[jira] [Resolved] (BEAM-3986) Improve setAwsCredentialsProvider documentation

["Luke Cwik (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/BEAM-3986?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Luke Cwik resolved BEAM-3986.
-----------------------------
       Resolution: Fixed
    Fix Version/s: 2.5.0

> Improve setAwsCredentialsProvider documentation
> -----------------------------------------------
>
>                 Key: BEAM-3986
>                 URL: https://issues.apache.org/jira/browse/BEAM-3986
>             Project: Beam
>          Issue Type: Improvement
>          Components: io-java-aws
>    Affects Versions: 2.4.0
>            Reporter: Paul Gerver
>            Assignee: Paul Gerver
>            Priority: Trivial
>             Fix For: 2.5.0
>
>          Time Spent: 20m
>  Remaining Estimate: 0h
>
> 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>\"}
>  
>  



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)