Skip to content

Commit

Permalink
Fix documentation method name
Browse files Browse the repository at this point in the history
  • Loading branch information
@maschwenk
maschwenk authored Feb 8, 2018
1 parent 43e211d commit 63a54f7
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion lib/vault/api/auth.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ def aws_ec2(role, pkcs7, nonce = nil)
# for future requests.
#
# @example
# Vault.auth.aws_ecs_iam("dev-role-iam", Aws::AssumeRoleCredentials.new, "vault.example.com", "https://sts.us-east-2.amazonaws.com") #=> #<Vault::Secret lease_id="">
# Vault.auth.aws_iam("dev-role-iam", Aws::AssumeRoleCredentials.new, "vault.example.com", "https://sts.us-east-2.amazonaws.com") #=> #<Vault::Secret lease_id="">
#
# @param [String] role
# @param [CredentialProvider] credentials_provider
Expand Down

1 comment on commit 63a54f7

@flyinbutrs
Copy link

@flyinbutrs flyinbutrs commented on 63a54f7 Feb 13, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this line I think Aws::AssumeRoleCredentials.new should be Aws::CredentialProviderChain.new.resolve. The former is included in the latter, along with the rest of the methods of getting AWS IAM credentials.

Also, should that be an optional param that defaults to Aws::CredentialProviderChain.new.resolve so that unless you're doing something abnormal, you don't have to manually provide a credentials resolver?

Please sign in to comment.