Skip to content
This repository was archived by the owner on Jan 19, 2022. It is now read-only.

Commit 63349e6

Browse files
Document default credentials chain for auto-configuration.
Fixes gh-470
1 parent 752897b commit 63349e6

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

docs/src/main/asciidoc/spring-cloud-aws.adoc

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -307,25 +307,40 @@ Spring Boot provides a standard way to define properties with property file or Y
307307
AWS provides support to configure the credential information with the Spring Boot application configuration files.
308308
Spring Cloud AWS provides the following properties to configure the credentials setup for the whole application.
309309

310+
Unless `cloud.aws.credentials.use-default-aws-credentials-chain` is set to `true`, Spring Cloud AWS configures following
311+
credentials chain:
312+
313+
1. `AWSStaticCredentialsProvider` if `cloud.aws.credentials.access-key` is provided
314+
2. `EC2ContainerCredentialsProviderWrapper` unless `cloud.aws.credentials.instance-profile` is set to `false`
315+
3. `ProfileCredentialsProvider`
316+
310317
[cols="3*", options="header"]
311318
|===
312319
|property
313320
|example
314321
|description
315322

316-
|cloud.aws.credentials.accessKey
323+
|cloud.aws.credentials.access-key
317324
|AKIAIOSFODNN7EXAMPLE
318325
|The access key to be used with a static provider
319326

320-
|cloud.aws.credentials.secretKey
327+
|cloud.aws.credentials.secret-key
321328
|wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
322329
|The secret key to be used with a static provider
323330

324-
|cloud.aws.credentials.instanceProfile
331+
|cloud.aws.credentials.instance-profile
325332
|true
326333
|Configures an instance profile credentials provider with no further configuration
327334

328-
|cloud.aws.credentials.useDefaultAwsCredentialsChain
335+
|cloud.aws.credentials.profile-name
336+
|default
337+
|The name of a configuration profile in the specified configuration file
338+
339+
|cloud.aws.credentials.profile-path
340+
|`~/.aws/credentials`
341+
|The file path where the profile configuration file is located. Defaults to `~/.aws/credentials` if value is not provided
342+
343+
|cloud.aws.credentials.use-default-aws-credentials-chain
329344
|true
330345
|Use the DefaultAWSCredentials Chain instead of configuring a custom credentials chain
331346
|===
@@ -347,7 +362,7 @@ The properties to configure the region are shown below
347362
|true
348363
|Enables automatic region detection based on the EC2 meta data service
349364

350-
|cloud.aws.region.useDefaultAwsRegionChain
365+
|cloud.aws.region.use-default-aws-region-chain
351366
|true
352367
|Use the DefaultAWSRegion Chain instead of configuring a custom region chain
353368

0 commit comments

Comments
 (0)