Skip to content

Commit

Permalink
Merge pull request #1847 from RanVaknin/documentation-update-config
Browse files Browse the repository at this point in the history
better description for Credentials object
  • Loading branch information
RanVaknin authored Sep 20, 2022
2 parents 3938bb7 + 72c90fe commit 4c9dc4d
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 4 deletions.
8 changes: 8 additions & 0 deletions .changelog/0bce3cb2c3d74dc7a87d4943339d1cec.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"id": "0bce3cb2-c3d7-4dc7-a87d-4943339d1cec",
"type": "documentation",
"description": "added clafirfication on the Credential object to show usage of loadDefaultConfig to load credentials",
"modules": [
"."
]
}
2 changes: 1 addition & 1 deletion .golangci.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ modules-download-mode = "readonly"
allow-parallel-runners = true
skip-dirs = ["internal/repotools"]
skip-dirs-use-default = true

skip-files = ["service/transcribestreaming/eventstream_test.go"]
[output]
format = "github-actions"

Expand Down
6 changes: 3 additions & 3 deletions aws/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ type Config struct {
// information on AWS regions.
Region string

// The credentials object to use when signing requests. Defaults to a
// chain of credential providers to search for credentials in environment
// variables, shared credential file, and EC2 Instance Roles.
// The credentials object to use when signing requests.
// Use the LoadDefaultConfig to load configuration from all the SDK's supported
// sources, and resolve credentials using the SDK's default credential chain.
Credentials CredentialsProvider

// The Bearer Authentication token provider to use for authenticating API
Expand Down

0 comments on commit 4c9dc4d

Please sign in to comment.